1: <?php
  2: /**
  3:  * This file contains Plugin Manager class.
  4:  *
  5:  * @package Plugin
  6:  * @subpackage PluginManager
  7:  * @version SVN Revision $Rev:$
  8:  *
  9:  * @author Frederic Schneider
 10:  * @copyright four for business AG <www.4fb.de>
 11:  * @license http://www.contenido.org/license/LIZENZ.txt
 12:  * @link http://www.4fb.de
 13:  * @link http://www.contenido.org
 14:  */
 15: 
 16: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 17: 
 18: /**
 19:  * Plugin Manager recipient class.
 20:  *
 21:  * @package     Plugin
 22:  * @subpackage  PluginManager
 23:  * @author Frederic Schneider
 24:  */
 25: class PimPluginCollection extends ItemCollection {
 26: 
 27:     /**
 28:      * Constructor Function
 29:      *
 30:      * @param none
 31:      */
 32:     public function __construct() {
 33:         global $cfg;
 34:         parent::__construct($cfg['tab']['plugins'], 'idplugin');
 35:         $this->_setItemClass('PimPlugin');
 36:     }
 37: 
 38:     /**
 39:      * Create a new plugin
 40:      *
 41:      * @param none
 42:      */
 43:     public function create($name, $description, $author, $copyright, $mail, $website, $version, $foldername, $uuId, $active, $execOrder = 0) {
 44:         global $client;
 45: 
 46:         $nextId = $this->_getNextId();
 47: 
 48:         // security checks
 49:         $client = cSecurity::toInteger($client);
 50:         $name = cSecurity::escapeString($name);
 51:         $description = cSecurity::escapeString($description);
 52:         $author = cSecurity::escapeString($author);
 53:         $copyright = cSecurity::escapeString($copyright);
 54:         $mail = cSecurity::escapeString($mail);
 55:         $website = cSecurity::escapeString($website);
 56:         $version = cSecurity::escapeString($version);
 57:         $foldername = cSecurity::escapeString($foldername);
 58:         $uuId = cSecurity::escapeString($uuId);
 59:         $active = cSecurity::toInteger($active);
 60: 
 61:         // create a new entry
 62:         $item = parent::createNewItem($nextId);
 63:         $item->set('idclient', $client);
 64:         $item->set('name', $name);
 65:         $item->set('description', $description);
 66:         $item->set('author', $author);
 67:         $item->set('copyright', $copyright);
 68:         $item->set('mail', $mail);
 69:         $item->set('website', $website);
 70:         $item->set('version', $version);
 71:         $item->set('folder', $foldername);
 72:         $item->set('uuid', $uuId);
 73:         $item->set('installed', date("Y-m-d H:i:s"), false);
 74:         $item->set('active', $active);
 75: 
 76:         // set execution order to the last of the list or to what was specified in create
 77:         if ($execOrder == 0) {
 78:             $this->select();
 79:             $execOrder = $this->count();
 80:         }
 81:         $item->set("executionorder", $execOrder);
 82: 
 83:         $item->store();
 84: 
 85:         return $item;
 86:     }
 87: 
 88:     /**
 89:      * Get the next id in table *_plugins
 90:      *
 91:      * @return int
 92:      */
 93:     protected function _getNextId() {
 94:         global $cfg;
 95: 
 96:         $sql = 'SELECT MAX(idplugin) AS id FROM ' . $cfg['tab']['plugins'];
 97:         $this->db->query($sql);
 98: 
 99:         if ($this->db->nextRecord()) {
100: 
101:             $result = $this->db->f('id');
102: 
103:             // id must be over 10.000
104:             if ($result < 10000) {
105:                 $result = 10000;
106:             }
107: 
108:             // add ten
109:             $result = $result + 10;
110: 
111:             // removed the last number
112:             $result = substr($result, 0, strlen($result) - 1);
113: 
114:             // last number is always zero
115:             return cSecurity::toInteger($result . 0);
116:         }
117:     }
118: 
119: }
120: 
121: /**
122:  * Single Plugin Manager Item
123:  */
124: class PimPlugin extends Item {
125: 
126:     /**
127:      * @var string Error storage
128:      */
129:     protected $_error;
130: 
131:     /**
132:      * Constructor Function
133:      *
134:      * @param  mixed  $id  Specifies the id of item to load
135:      */
136:     public function __construct($id = false) {
137:         global $cfg;
138:         parent::__construct($cfg['tab']['plugins'], 'idplugin');
139:         $this->_error = '';
140:         if ($id !== false) {
141:             $this->loadByPrimaryKey($id);
142:         }
143:     }
144: 
145:     /**
146:      * Change the execution order of this plugin and update the order for every other plugin
147:      *
148:      * @param int $newOrder New execution order for this plugin
149:      */
150:     public function updateExecOrder($newOrder) {
151:         $oldOrder = $this->get('executionorder'); // get the old value
152:         $idplugin = $this->get("idplugin");
153: 
154:         $this->set('executionorder', $newOrder); // update this plugin to the new value
155:         $this->store();
156: 
157:         // move the other plugins up or down
158:         $pluginColl = new PimPluginCollection();
159:         $pluginColl->select('executionorder >= "' . min($newOrder, $oldOrder) . '" AND executionorder <= "' . max($newOrder, $oldOrder) . '" AND idplugin != "' . $idplugin . '"', NULL, 'executionorder'); // select every plugin that needs to be updated
160: 
161:         while ($plugin = $pluginColl->next()) {
162:             if ($newOrder < $oldOrder) {
163:                 $plugin->set("executionorder", $plugin->get("executionorder") + 1); // increment the execution order after we moved the plugin up
164:                 $plugin->store();
165:             } else if ($oldOrder < $newOrder) {
166:                 $plugin->set("executionorder", $plugin->get("executionorder") - 1); // decrement the execution value after we moved the plugin down
167:                 $plugin->store();
168:             }
169:         }
170:     }
171: }
172: