1: <?php
  2: 
  3: /**
  4:  * This file contains the module synchronizer class.
  5:  * TODO: Rework comments of this class.
  6:  *
  7:  * @package    Core
  8:  * @subpackage Backend
  9:  * @version    SVN Revision $Rev:$
 10:  *
 11:  * @author     Rusmir Jusufovic
 12:  * @copyright  four for business AG <www.4fb.de>
 13:  * @license    http://www.contenido.org/license/LIZENZ.txt
 14:  * @link       http://www.4fb.de
 15:  * @link       http://www.contenido.org
 16:  */
 17: 
 18: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 19: 
 20: cInclude('includes', 'functions.api.string.php');
 21: cInclude('includes', 'functions.con.php');
 22: 
 23: /**
 24:  * This class synchronized the contents of modul dir with the table
 25:  * $cfg['tab']['mod']. If a modul exist in modul dir but not in
 26:  * $cfg['tab']['mod'] this class will insert the modul in the table.
 27:  *
 28:  * @package    Core
 29:  * @subpackage Backend
 30:  */
 31: class cModuleSynchronizer extends cModuleHandler {
 32: 
 33:     /**
 34:      * The last id of the module that had changed or had added.
 35:      *
 36:      * @var int
 37:      */
 38:     private $_lastIdMod = 0;
 39: 
 40:     /**
 41:      * This method insert a new modul in $cfg['tab']['mod'] table, if
 42:      * the name of modul dont exist
 43:      *
 44:      * @param string $dir
 45:      * @param string $oldModulName
 46:      * @param string $newModulName
 47:      */
 48:     private function _syncModule($dir, $oldModulName, $newModulName) {
 49:         global $client;
 50:         // if modul dont exist in the $cfg['tab']['mod'] table.
 51:         if ($this->_isExistInTable($oldModulName, $client) == false) {
 52:             // add new Module in db-tablle
 53:             $this->_addModul($newModulName, $client);
 54:             cRegistry::appendLastOkMessage(sprintf(i18n('Module %s successfully synchronized'), $newModulName));
 55:         } else {
 56:             // update the name of the module
 57:             if ($oldModulName != $newModulName) {
 58:                 $this->_updateModulnameInDb($oldModulName, $newModulName, $client);
 59:             }
 60:         }
 61:     }
 62: 
 63:     /**
 64:      * Rename css, js and input/output file
 65:      *
 66:      * @param string $dir
 67:      * @param string $oldModulName
 68:      * @param string $newModulName
 69:      */
 70:     private function _renameFiles($dir, $oldModulName, $newModulName) {
 71:         if (cFileHandler::exists($dir . $newModulName . '/' . $this->_directories['php'] . $oldModulName . '_input.php') == true) {
 72:             rename($dir . $newModulName . '/' . $this->_directories['php'] . $oldModulName . '_input.php', $dir . $newModulName . '/' . $this->_directories['php'] . $newModulName . '_input.php');
 73:         }
 74: 
 75:         if (cFileHandler::exists($dir . $newModulName . '/' . $this->_directories['php'] . $oldModulName . '_output.php') == true) {
 76:             rename($dir . $newModulName . '/' . $this->_directories['php'] . $oldModulName . '_output.php', $dir . $newModulName . '/' . $this->_directories['php'] . $newModulName . '_output.php');
 77:         }
 78: 
 79:         if (cFileHandler::exists($dir . $newModulName . '/' . $this->_directories['css'] . $oldModulName . '.css') == true) {
 80:             rename($dir . $newModulName . '/' . $this->_directories['css'] . $oldModulName . '.css', $dir . $newModulName . '/' . $this->_directories['css'] . $newModulName . '.css');
 81:         }
 82: 
 83:         if (cFileHandler::exists($dir . $newModulName . '/' . $this->_directories['js'] . $oldModulName . '.js') == true) {
 84:             rename($dir . $newModulName . '/' . $this->_directories['js'] . $oldModulName . '.js', $dir . $newModulName . '/' . $this->_directories['js'] . $newModulName . '.js');
 85:         }
 86:     }
 87: 
 88:     /**
 89:      * Rename the Modul files and Modul dir
 90:      *
 91:      * @param string $dir
 92:      *         path the the moduls
 93:      * @param string $dirNameOld
 94:      *         old dir name
 95:      * @param string $dirNameNew
 96:      *         new dir name
 97:      * @param int $client
 98:      *         idclient
 99:      * @return bool
100:      *         true if succes (rename file and directories)
101:      */
102:     private function _renameFileAndDir($dir, $dirNameOld, $dirNameNew, $client) {
103:         if (rename($dir . $dirNameOld, $dir . $dirNameNew) == FALSE) {
104:             return false;
105:         } else { // change names of the files
106:             $this->_renameFiles($dir, $dirNameOld, $dirNameNew);
107:         }
108:         return true;
109:     }
110: 
111:     /**
112:      * Compare file change timestemp and the timestemp in ['tab']['mod'].
113:      * If file had changed make new code :conGenerateCodeForAllArtsUsingMod
114:      *
115:      * @return int
116:      *         id of last update module
117:      */
118:     public function compareFileAndModuleTimestamp() {
119:         global $cfg, $cfgClient;
120: 
121:         $synchLock = 0;
122: 
123:         $sql = sprintf('SELECT UNIX_TIMESTAMP(mod1.lastmodified) AS lastmodified,mod1.idclient,description,type, mod1.name, mod1.alias, mod1.idmod FROM %s AS mod1 WHERE mod1.idclient = %s', $this->_cfg['tab']['mod'], $this->_client);
124:         $notification = new cGuiNotification();
125: 
126:         $db = cRegistry::getDb();
127:         $db->query($sql);
128:         $retIdMod = 0;
129: 
130:         while ($db->nextRecord()) {
131:             $showMessage = false;
132: 
133:             $modulePath = $cfgClient[$db->f('idclient')]['module']['path'] . $db->f('alias') . '/';
134:             $modulePHP = $modulePath . $this->_directories['php'] . $db->f('alias');
135: 
136:             $lastmodified = $db->f('lastmodified');
137: 
138:             $lastmodInput = $lastmodOutput = 0;
139: 
140:             if (cFileHandler::exists($modulePHP . '_input.php')) {
141:                 $lastmodInput = filemtime($modulePHP . '_input.php');
142:             }
143: 
144:             if (cFileHandler::exists($modulePHP . '_output.php')) {
145:                 $lastmodOutput = filemtime($modulePHP . '_output.php');
146:             }
147: 
148:             if (cFileHandler::exists($modulePath . "info.xml")) {
149:                 $lastModInfo = filemtime($modulePath . "info.xml");
150:                 if ($lastModInfo > $lastmodified) {
151:                     $modInfo = cXmlBase::xmlStringToArray(cFileHandler::read($modulePath . "info.xml"));
152:                     $mod = new cApiModule($db->f("idmod"));
153:                     if ($modInfo["description"] != $mod->get("description")) {
154:                         $mod->set("description", $modInfo["description"]);
155:                         $this->setLastModified($lastModInfo, $db->f('idmod'));
156:                     }
157:                     if ($modInfo["type"] != $mod->get("type")) {
158:                         $mod->set("type", $modInfo["type"]);
159:                         $this->setLastModified($lastModInfo, $db->f('idmod'));
160:                     }
161: 
162:                     if ($modInfo["name"] != $mod->get("name")) {
163:                         $mod->set("name", $modInfo["name"]);
164:                         $this->setLastModified($lastModInfo, $db->f('idmod'));
165:                     }
166: 
167:                     if ($modInfo["alias"] != $mod->get("alias")) {
168:                         $mod->set("alias", $modInfo["alias"]);
169:                         $this->setLastModified($lastModInfo, $db->f('idmod'));
170:                     }
171:                     $mod->store();
172:                     $synchLock = 1;
173:                     $showMessage = true;
174:                 }
175:             }
176: 
177:             $lastmodabsolute = max($lastmodInput, $lastmodOutput);
178:             if ($lastmodified < $lastmodabsolute) {
179:                 // update
180:                 $synchLock = 1;
181:                 $this->setLastModified($lastmodabsolute, $db->f('idmod'));
182:                 conGenerateCodeForAllArtsUsingMod($db->f('idmod'));
183:                 $showMessage = true;
184:             }
185: 
186:             if (($idmod = $this->_synchronizeFilesystemAndDb($db)) != 0) {
187:                 $retIdMod = $idmod;
188:             }
189: 
190:             if ($showMessage) {
191:                 cRegistry::appendLastOkMessage(sprintf(i18n('Module %s successfully synchronized'), $db->f('name')));
192:             }
193:         }
194: 
195:         if ($synchLock == 0) {
196:             cRegistry::addInfoMessage(i18n('All modules are already synchronized'));
197:         }
198: 
199:         // we need it for the update of moduls on the left site (module/backend)
200:         return $retIdMod;
201:     }
202: 
203:     /**
204:      * If someone delete a moduldir with ftp/ssh.
205:      * We have a modul
206:      * in db but not in directory, if the modul in use make a new modul in
207:      * fileystem but if not
208:      * clear it from filesystem.
209:      *
210:      * @param unknown_type $db
211:      * @return int
212:      *         id of last update module
213:      */
214:     private function _synchronizeFilesystemAndDb($db) {
215:         $returnIdMod = 0;
216:         $this->initWithDatabaseRow($db);
217:         // modul dont exist in filesystem
218:         if ($this->modulePathExists() == false) {
219:             $modul = new cApiModule($db->f('idmod'));
220:             $returnIdMod = $db->f('idmod');
221:             if ($modul->moduleInUse($db->f('idmod')) == true) {
222:                 // modul in use, make new modul in filesystem
223:                 if ($this->createModule() == false) {
224:                     $notification = new cGuiNotification();
225:                     $notification->displayNotification('error', i18n("Can not create module") . " " . $db->f('name'));
226:                 }
227:             } else {
228:                 // modul not in use, delete it
229:                 $sql = sprintf('DELETE  FROM %s WHERE idmod = %s AND idclient = %s', $this->_cfg['tab']['mod'], $db->f('idmod'), $this->_client);
230:                 $myDb = cRegistry::getDb();
231:                 $myDb->query($sql);
232:             }
233:         }
234:         return $returnIdMod;
235:     }
236: 
237:     /**
238:      * Depending on the client, this method
239:      * will check the modul dir of the client and if found
240:      * a Modul(Dir) that not exist in Db-table this method will
241:      * insert the Modul in Db-table ([tab][mod]).
242:      *
243:      * @return int
244:      *         last id of synchronized module
245:      */
246:     public function synchronize() {
247:         global $cfg, $cfgClient;
248: 
249:         // get the path to the modul dir from the client
250:         $dir = $cfgClient[$this->_client]['module']['path'];
251: 
252:         if (is_dir($dir)) {
253:             if (false !== ($handle = cDirHandler::read($dir))) {
254:                 foreach ($handle as $file) {
255:                     if (false === cFileHandler::fileNameBeginsWithDot($file) && is_dir($dir . $file . '/')) {
256:                         $newFile = cString::cleanURLCharacters($file);
257:                         // dir is ok
258:                         if ($newFile == $file) {
259:                             $this->_syncModule($dir, $file, $newFile);
260:                         } else { // dir not ok (with not allowed characters)
261:                             if (is_dir($dir . $newFile)) { // exist the new dir
262:                                 // name?
263:                                 // make new dirname
264:                                 $newDirName = $newFile . substr(md5(time() . rand(0, time())), 0, 4);
265: 
266:                                 // rename
267:                                 if ($this->_renameFileAndDir($dir, $file, $newDirName, $this->_client) != false) {
268:                                     $this->_syncModule($dir, $file, $newDirName);
269:                                 }
270:                             } else { // $newFile (dir) not exist
271:                                 // rename dir old
272:                                 if ($this->_renameFileAndDir($dir, $file, $newFile, $this->_client) != false) {
273:                                     $this->_syncModule($dir, $file, $newFile);
274:                                 }
275:                             }
276:                         }
277:                     }
278:                 }
279:             }
280:         }
281: 
282:         // last Modul Id that will refresh the windows /modul overview
283:         return $this->_lastIdMod;
284:     }
285: 
286:     /**
287:      * This method look in the db-table $cfg['tab']['mod'] for a modul
288:      * name.
289:      * If the modul name exist it will return true
290:      *
291:      * @param unknown_type $alias
292:      * @param int $idclient
293:      *         idclient
294:      * @return bool
295:      *         if a modul with the $name exist in the $cfg['tab']['mod'] table
296:      *         return true else false
297:      */
298:     private function _isExistInTable($alias, $idclient) {
299:         $db = cRegistry::getDb();
300: 
301:         // Select depending from idclient all moduls wiht the name $name
302:         $sql = sprintf("SELECT * FROM %s WHERE alias='%s' AND idclient=%s", $this->_cfg['tab']['mod'], $alias, $idclient);
303: 
304:         $db->query($sql);
305: 
306:         // a record is found
307:         if ($db->nextRecord()) {
308:             return true;
309:         } else {
310:             return false;
311:         }
312:     }
313: 
314:     /**
315:      * Update the name of module (if the name not allowes)
316:      *
317:      * @param string $oldName
318:      *         old name
319:      * @param string $newName
320:      *         new module name
321:      * @param int $idclient
322:      *         id of client
323:      */
324:     private function _updateModulnameInDb($oldName, $newName, $idclient) {
325:         $db = cRegistry::getDb();
326: 
327:         // Select depending from idclient all modules wiht the name $name
328:         $sql = sprintf("SELECT * FROM %s WHERE alias='%s' AND idclient=%s", $this->_cfg['tab']['mod'], $oldName, $idclient);
329: 
330:         $db->query($sql);
331: 
332:         // a record is found
333:         if ($db->nextRecord()) {
334:             $sqlUpdateName = sprintf("UPDATE %s SET alias='%s' WHERE idmod=%s", $this->_cfg['tab']['mod'], $newName, $db->f('idmod'));
335:             $db->query($sqlUpdateName);
336:             return;
337:         }
338:     }
339: 
340:     /**
341:      * This method add a new Modul in the table $cfg['tab']['mod'].
342:      *
343:      * @param string $name
344:      *         name of the new module
345:      * @param int $idclient
346:      *         client of the module
347:      */
348:     private function _addModul($name, $idclient) {
349:         // insert new modul in con_mod
350:         $oModColl = new cApiModuleCollection();
351:         $oMod = $oModColl->create($name, $idclient, $name);
352:         if (is_object($oMod)) {
353:             // save the last id from modul
354:             $this->_lastIdMod = $oMod->get('idmod');
355:         }
356:     }
357: 
358:     /**
359:      * Update the con_mod, the field lastmodified
360:      *
361:      * @param int $timestamp
362:      *         timestamp of last modification
363:      * @param int $idmod
364:      *         id of module
365:      */
366:     public function setLastModified($timestamp, $idmod) {
367:         $oMod = new cApiModule((int) $idmod);
368:         if ($oMod->isLoaded()) {
369:             $oMod->set('lastmodified', date('Y-m-d H:i:s', $timestamp));
370:             $oMod->store();
371:         }
372:     }
373: 
374: }
375: