2 /************************************************************************
3 * MXChange v0.2.1 Start: 03/25/2004 *
4 * =============== Last change: 09/29/2004 *
6 * -------------------------------------------------------------------- *
7 * File : extensions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Extension management *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Erweiterungen-Management *
12 * -------------------------------------------------------------------- *
14 * -------------------------------------------------------------------- *
15 * Copyright (c) 2003 - 2008 by Roland Haeder *
16 * For more information visit: http://www.mxchange.org *
18 * This program is free software; you can redistribute it and/or modify *
19 * it under the terms of the GNU General Public License as published by *
20 * the Free Software Foundation; either version 2 of the License, or *
21 * (at your option) any later version. *
23 * This program is distributed in the hope that it will be useful, *
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
26 * GNU General Public License for more details. *
28 * You should have received a copy of the GNU General Public License *
29 * along with this program; if not, write to the Free Software *
30 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
32 ************************************************************************/
34 // Some security stuff...
35 if (!defined('__SECURITY')) {
36 $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
41 function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
43 global $NOTES, $_CONFIG, $INC_POOL, $cacheInstance;
44 // We want to register an extension and registration status is by default "failed" (= false)
45 $EXT_LOAD_MODE = "register"; $ret = false; $SQLs = array();
48 // This shall never do a non-admin user!
49 if (!IS_ADMIN()) return false;
51 // Is this extension already installed?
52 if (EXT_IS_ACTIVE($ext_name)) return false;
55 $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
57 // Does this extension exists?
58 if (FILE_READABLE($file))
60 // Extension was found so we can load it in registration mode
63 // And run possible updates
64 $EXT_LOAD_MODE = "update"; $EXT_UPDATE_DEPENDS = "";
65 foreach ($EXT_VER_HISTORY as $EXT_VER)
68 if (((GET_EXT_VERSION("sql_patches") != '') && ($_CONFIG['verbose_sql'] == "Y")) || (!EXT_IS_ACTIVE("sql_patches")))
70 if (!empty($UPDATE_NOTES))
73 $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".$UPDATE_NOTES."<br /><br />\n";
76 elseif (($EXT_VER == "0.0") || ($EXT_VER == "0.0.0"))
79 $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".INITIAL_RELEASE."<br /><br />\n";
83 $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br /><I>".NO_UPDATE_NOTES."</I><br /><br />\n";
88 // Does this extension depends on an outstanding update of another update?
89 if (!empty($EXT_UPDATE_DEPENDS))
91 // Backup SQL commands and clear current
92 $SQLs2 = $SQLs; $SQLs = array(); $test = false;
94 // Backup language as well
95 $LANG_BCK = $EXT_LANG_PREFIX; $EXT_ALWAYS_ACTIVE = "N";
97 // Load required extension also in update mode
98 $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $EXT_UPDATE_DEPENDS);
100 // Check for required file
101 if (FILE_READABLE($file))
103 // File exists so let's load it
104 $VER_BACKUP = $EXT_VERSION;
106 $EXT_VERSION = $VER_BACKUP;
108 // If versions mismatch update extension first
109 $ext_ver = GET_EXT_VERSION($EXT_UPDATE_DEPENDS);
112 // Extension not registered so far so first load task's ID...
113 $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE task_type='EXTENSION' AND subject LIKE '[%s:]%%' LIMIT 1",
114 array($EXT_UPDATE_DEPENDS), __FILE__, __LINE__);
115 if (SQL_NUMROWS($result) == 1)
117 // Task found so load task's ID and register extension...
118 list($task) = SQL_FETCHROW($result);
119 SQL_FREERESULT($result);
120 $test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, $task, $dry_run);
123 elseif ($ext_ver != $EXT_VERSION)
125 // Ok, update this extension now
126 EXTENSION_UPDATE(basename($file), $EXT_UPDATE_DEPENDS, $ext_ver, $dry_run);
133 // Nothing to register / update before...
139 // Required file for update does not exists!
141 // But this is fine for the first time...
144 // Finally restore previous SQLs
145 $SQLs = $SQLs2; unset($SQLs2);
146 $EXT_LANG_PREFIX = $LANG_BCK;
150 // Does not depend on an other extension
154 // Switch back to register mode
155 $EXT_LOAD_MODE = "register";
157 // Does everthing before wents ok?
159 // "Dry-run-mode" activated?
162 foreach ($SQLs as $sql) {
163 // Trim spaces away which we don't need
166 // Is there still an SQL query?
168 // Do we have an "ALTER TABLE" command?
169 if (substr(strtolower($sql), 0, 11) == "alter table") {
170 // Analyse the alteration command
171 SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
173 // Run regular SQL command
174 $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
179 // Remove cache file(s) if extension is active
180 if ((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) {
181 //* DEBUG: */ echo __LINE__.": DESTROY!<br />\n";
182 // Remove cache files
183 if ($cacheInstance->cache_file("extensions", true)) $cacheInstance->cache_destroy();
184 if ($cacheInstance->cache_file("mod_reg", true)) $cacheInstance->cache_destroy();
185 if ($cacheInstance->cache_file("config", true)) $cacheInstance->cache_destroy();
188 // Check for added include files
189 if (count($INC_POOL > 0)) {
190 // Loads every include file
191 foreach ($INC_POOL as $inc) {
196 // Register extension
197 $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_lang_file, ext_active, ext_version) VALUES ('%s', '%s', '%s', '%s')",
198 array($ext_name, $EXT_LANG_PREFIX, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__);
200 // Update task management
201 ADMIN_SOLVE_TASK($id);
203 // @TODO This causes the whole (!) menu cache being purged
204 CACHE_PURGE_ADMIN_MENU();
206 // In normal mode return a true on success
212 // Rewrite SQL command to keep { and } inside
213 foreach ($SQLs as $key => $sql) {
214 $sql = str_replace('{', "{", str_replace('}', "}", $sql));
218 // In "dry-run" mode return array with all SQL commands
221 // Remove all SQL commands
225 // No, an error occurs while registering extension :-(
228 } elseif (($id > 0) && (!empty($ext_name))) {
229 // Remove task from system when id and extension's name is valid
230 $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%s AND status='NEW' LIMIT 1",
231 array(bigintval($id)), __FILE__, __LINE__);
234 // Is this the sql_patches?
235 //* DEBUG: */ echo __LINE__.":{$ext_name}/{$EXT_LOAD_MODE}<br />\n";
236 if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove")) && (!$dry_run) && ($test)) {
237 // Then redirect to logout
238 //* DEBUG: */ echo __LINE__.": LOAD!<br />\n";
239 LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
242 // Return status code
246 function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
247 global $cacheInstance;
250 // By default no SQL has been executed
253 // This shall never do a non-admin user!
254 if (!IS_ADMIN()) return false;
256 // Get extension's name
257 $ext_name = GET_EXT_NAME($id);
258 if (empty($ext_name)) return false;
260 // Load extension in detected mode
261 //* DEBUG: */ echo __FUNCTION__.":ext_name[{$id}]={$ext_name}<br />\n";
262 $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
263 if (FILE_READABLE($file)) {
268 //* DEBUG: */ echo __FUNCTION__.":SQLs::count=".count($SQLs)."<br />\n";
269 if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
270 // Run SQL commands...
271 foreach ($SQLs as $sql) {
272 // Trim spaces away which we don't need
275 // Is there still an SQL query?
277 // Do we have an "ALTER TABLE" command?
278 //* DEBUG: */ echo __FUNCTION__.":SQL={$SQL}<br />\n";
279 if (substr(strtolower($sql), 0, 11) == "alter table") {
280 // Analyse the alteration command
281 SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
283 // Run regular SQL command
284 $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
287 // An SQL has been executed
293 if ($EXT_LOAD_MODE == "remove") {
294 // Delete this extension (remember to remove it from your server *before* you click on welcome!
295 $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
296 array($id), __FILE__, __LINE__);
299 //* DEBUG: */ echo __FUNCTION__.":mode={$EXT_LOAD_MODE}<br />\n";
301 // Remove cache file(s) if extension is active
302 if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1) && ($EXT_LOAD_MODE == "remove")) || ($sqlRan === true))) {
303 //* DEBUG: */ echo __LINE__.": DESTROY!<br />\n";
304 // Remove cache files
305 if ($cacheInstance->cache_file("extensions", true)) $cacheInstance->cache_destroy();
306 if ($cacheInstance->cache_file("mod_reg", true)) $cacheInstance->cache_destroy();
307 if ($cacheInstance->cache_file("config", true)) $cacheInstance->cache_destroy();
309 // @TODO This causes the whole (!) menu cache being purged
310 CACHE_PURGE_ADMIN_MENU();
313 // Is this the sql_patches?
314 //* DEBUG: */ echo __LINE__.": {$id}/{$ext_name}/{$EXT_LOAD_MODE}<br />\n";
315 if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove"))) {
316 // Then redirect to logout
317 //* DEBUG: */ echo __LINE__.": LOAD!<br />\n";
318 LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
322 // Check if given extension is active
323 function EXT_IS_ACTIVE ($ext_name, $ignore_admin = false, $ignore_cache = false) {
324 global $cacheArray, $_CONFIG;
326 // Extensions are all inactive during installation
327 if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing')) || (empty($ext_name))) return false;
329 // Extension's file name will also be checked
330 $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
331 if (!FILE_READABLE($file)) return false;
332 //* DEBUG: */ echo "*".$ext_name."(".count($cacheArray).")<br />";
334 // Not active is the default
338 if ((!empty($cacheArray['extensions']['ext_active'][$ext_name])) && (!$ignore_cache)) {
340 //* DEBUG: */ echo "CACHE! ext_name={$ext_name}<br />\n";
341 $active = $cacheArray['extensions']['ext_active'][$ext_name];
344 if (isset($_CONFIG['cache_hits'])) $_CONFIG['cache_hits']++;
345 } elseif (($ext_name == "cache") || (GET_EXT_VERSION("cache") == "")) {
346 //* DEBUG: */ echo "DB! ext_name={$ext_name}<br />\n";
347 // Load from database
348 $result = SQL_QUERY_ESC("SELECT ext_active FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
349 array($ext_name), __FILE__, __LINE__);
350 if (SQL_NUMROWS($result) == 0) {
351 // Extension was not found!
354 list($active) = SQL_FETCHROW($result);
355 //* DEBUG: */ echo $ext_name."[DB]: {$active}<br />\n";
356 SQL_FREERESULT($result);
359 $cacheArray['extensions']['ext_active'][$ext_name] = $active;
361 // Extension not active!
362 //* DEBUG: */ echo $ext_name.": Not active!<br />\n";
363 $cacheArray['extensions']['ext_active'][$ext_name] = "N";
366 // Create FQFN for extension file
367 $inc = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
370 //DEBUG_LOG(__FUNCTION__.": ext_name={$ext_name},active={$active}");
372 // Is this extension activated? (For admins we always have active extensions...)
381 // Get version from extensions
382 function GET_EXT_VERSION ($ext_name) {
383 global $cacheArray, $_CONFIG, $cacheInstance;
386 // Extensions are all inactive during installation
387 if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return "";
388 //* DEBUG: */ echo __FUNCTION__.": ext_name={$ext_name}<br />\n";
390 // Is the cache written?
391 if (!empty($cacheArray['extensions']['ext_version'][$ext_name])) {
392 // Load data from cache
393 //* DEBUG: */ echo __FUNCTION__.": CACHE!<br />\n";
394 $ret = $cacheArray['extensions']['ext_version'][$ext_name];
397 if (isset($_CONFIG['cache_hits'])) $_CONFIG['cache_hits']++; else $_CONFIG['cache_hits'] = 1;
398 } elseif (!is_object($cacheInstance)) {
399 // Load from database
400 $result = SQL_QUERY_ESC("SELECT ext_version FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
401 array($ext_name), __FILE__, __LINE__);
402 list($ret) = SQL_FETCHROW($result);
403 SQL_FREERESULT($result);
406 $cacheArray['extensions']['ext_version'][$ext_name] = $ret;
410 //* DEBUG: */ echo __FUNCTION__.": ret={$ret}<br />\n";
414 function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
416 // This shall never do a non-admin user!
417 global $cacheInstance, $_CONFIG, $NOTES; $SQLs = array();
418 if ((!IS_ADMIN()) || (empty($ext))) return false;
420 // Load extension in update mode
421 $EXT_LOAD_MODE = "update"; $EXT_UPDATE_DEPENDS = ""; $NOTES = "";
422 include(PATH."inc/extensions/".$file);
423 if (!empty($EXT_UPDATE_DEPENDS))
425 // Update another extension first!
426 $test = EXTENSION_UPDATE(("ext-".$EXT_UPDATE_DEPENDS.".php"), $EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run);
429 // Check if version is updated
430 if ((($EXT_VERSION != $EXT_VER) || ($dry_run)) && (is_array($EXT_VER_HISTORY)))
432 // Search for starting point
433 $start = array_search($EXT_VER, $EXT_VER_HISTORY);
436 // And load SQL queries in order of version history
437 for ($idx = ($start + 1); $idx < sizeof($EXT_VER_HISTORY); $idx++)
439 // Remove old SQLs array to prevent possible bugs
440 if (!$dry_run) { unset($SQLs); $SQLs = array(); }
443 $EXT_VER = $EXT_VER_HISTORY[$idx];
446 include(PATH."inc/extensions/".$file);
449 if ($_CONFIG['verbose_sql'] == "Y")
451 $EXT_VER = $EXT_VER_HISTORY[$idx];
452 if (!empty($UPDATE_NOTES))
454 // Update notes found
455 $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".$UPDATE_NOTES."<br /><br />\n";
458 elseif ($EXT_VER == "0.0")
461 $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".INITIAL_RELEASE."<br /><br />\n";
465 $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br /><I>".NO_UPDATE_NOTES."</I><br /><br />\n";
470 if ((is_array($SQLs)) && (!$dry_run))
473 foreach ($SQLs as $sql)
478 // Do we have an "ALTER TABLE" command?
479 if (substr(strtolower($sql), 0, 11) == "alter table") {
480 // Analyse the alteration command
481 SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
483 // Run regular SQL command
484 $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
488 } elseif (GET_EXT_VERSION("sql_patches") == "") {
489 // Remove SQLs if extension is not installed
496 // In normal mode insert task and update extension's version...
497 $ext_subj = "[UPDATE-".$ext."-".$EXT_VERSION.":] ".ADMIN_UPDATE_EXT_SUBJ;
500 CREATE_EXTENSION_UPDATE_TASK(GET_ADMIN_ID(get_session('admin_login')), $ext_subj, addslashes($NOTES));
502 // Update extension's version
503 $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
504 array($EXT_VERSION, $ext), __FILE__, __LINE__);
507 if (EXT_IS_ACTIVE("cache")) {
508 if ($cacheInstance->cache_file("extensions", true) == true) $cacheInstance->cache_destroy();
509 if ($cacheInstance->cache_file("config", true) == true) $cacheInstance->cache_destroy();
510 if ($cacheInstance->cache_file("mod_reg", true) == true) $cacheInstance->cache_destroy();
516 // In "dry-run" mode return array with SQL commands
522 function EXTENSION_VERBOSE_TABLE($SQLs, $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed = "", $switch = false, $WIDTH = "480") {
525 $S = false; $SW = 2; $i = 1;
527 if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y")) {
528 $OUT = "<DIV align=\"center\">
529 <TABLE border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"".$WIDTH."\" align=\"center\"".$dashed.">
531 <TD colspan=\"2\" align=\"center\" class=\"admin_title bottom2\" height=\"24\">
532 <STRONG>".$title.":</STRONG>
535 foreach ($SQLs as $idx => $sql) {
540 <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 2px\" width=\"30\">".$i.".</TD>
541 <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 5px; padding-right: 5px\">
545 if ($switch) $SW = 3 - $SW;
551 if ((!$S) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y")) {
552 // No addional SQL commands to run
554 <TD colspan=\"2\" align=\"center\" class=\"switch_sw2 bottom2\" height=\"24\">
555 <FONT class=\"admin_note\">".ADMIN_NO_ADDIONAL_SQLS."</FONT>
561 // Add missing close-table tag
569 // Get extension name from id
570 function GET_EXT_NAME ($id) {
572 global $cacheArray, $_CONFIG;
573 if (!empty($cacheArray['extensions']['ext_name'][$id])) {
575 $ret = $cacheArray['extensions']['ext_name'][$id];
578 $_CONFIG['cache_hits']++;
579 } elseif (!EXT_IS_ACTIVE("cache")) {
580 // Load from database
581 $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
582 array(bigintval($id)), __FILE__, __LINE__);
583 list($ret) = SQL_FETCHROW($result);
584 SQL_FREERESULT($result);
588 // Get extension id from name
589 function GET_EXT_ID($name) {
591 global $cacheArray, $_CONFIG;
592 if (isset($cacheArray['extensions']['ext_id'][$name])) {
594 $ret = $cacheArray['extensions']['ext_id'][$name];
597 $_CONFIG['cache_hits']++;
598 } elseif (!EXT_IS_ACTIVE("cache")) {
599 // Load from database
600 $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
601 array($name), __FILE__, __LINE__);
602 list($ret) = SQL_FETCHROW($result);
603 SQL_FREERESULT($result);