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";
40 // Load the extension and maybe found language and function files.
41 function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run = false, &$SQLs = array()) {
42 global $EXT_LOADED, $_CONFIG, $CSS, $cacheMode, $EXT_VER_HISTORY;
43 global $INC_POOL, $EXT_UPDATE_DEPENDS, $EXT_DEPRECATED, $UPDATE_NOTES;
44 global $EXT_VERSION, $EXT_ALWAYS_ACTIVE;
49 // Is the extension already loaded?
50 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Loading extension {$ext_name}, mode={$EXT_LOAD_MODE}, ver={$EXT_VER}.");
51 if ((isset($EXT_LOADED['ext'][$ext_name])) && (empty($EXT_LOAD_MODE))) {
53 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
57 // Construct FQFN for extension file
58 $FQFN = sprintf("%sinc/extensions/ext-%s.php",
63 // Is the extension file NOT there?
64 if (!FILE_READABLE($extInclude)) {
66 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found.", $ext_name));
72 // Construct FQFN for language file
73 $langInclude = sprintf("inc/language/%s_%s.php", $ext_name, GET_LANGUAGE());
75 // Is this include there?
76 if ((FILE_READABLE($langInclude)) && (!isset($EXT_LOADED['lang'][$ext_name]))) {
78 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Language loaded.");
79 $EXT_LOADED['lang'][$ext_name] = true;
80 LOAD_INC_ONCE($langInclude);
83 // Construct FQFN for functions file
84 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
86 // Is this include there?
87 if ((FILE_READABLE($funcsInclude)) && (!isset($EXT_LOADED['funcs'][$ext_name]))) {
89 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Functions loaded.");
90 $EXT_LOADED['funcs'][$ext_name] = true;
91 LOAD_INC_ONCE($funcsInclude);
94 // Extensions are not deprecated by default
95 $EXT_DEPRECATED = "N";
97 // Extensions are not always active by default
98 $EXT_ALWAYS_ACTIVE = "N";
100 // By default an extension update does not depend on other extensions
101 $EXT_UPDATE_DEPENDS = "";
103 // Extension update notes
106 // Include the extension file
107 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Extension loaded.");
108 require($extInclude);
110 // Is this extension deprecated?
111 if ($EXT_DEPRECATED == "Y") {
112 // Deactivate the extension
113 DEACTIVATE_EXTENSION($ext_name);
119 // Mark it as loaded in normal mode
120 if (empty($EXT_LOAD_MODE)) {
122 $EXT_LOADED['ext'][$ext_name] = true;
129 // Registeres an extension and possible update depencies
130 function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = true) {
131 global $UPDATE_NOTES, $INC_POOL, $cacheInstance;
132 global $EXT_VER_HISTORY, $NOTES, $EXT_ALWAYS_ACTIVE, $EXT_VERSION;
133 global $EXT_UPDATE_DEPENDS;
135 // This shall never do a non-admin user!
136 if (!IS_ADMIN()) return false;
138 // Is this extension already installed?
139 if (EXT_IS_ACTIVE($ext_name)) return false;
142 $ret = false; $SQLs = array();
146 // By default we have no failures
147 $EXT_REPORTS_FAILURE = false;
149 // Does this extension exists?
150 if (LOAD_EXTENSION($ext_name, "register", "", $dry_run, $SQLs)) {
151 // And run possible updates
152 $history = $EXT_VER_HISTORY;
153 foreach ($history as $ver) {
154 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ext_name={$ext_name}, ext_ver={$ver}");
155 // Load extension in update mode
156 LOAD_EXTENSION($ext_name, "update", $ver, $dry_run, $SQLs);
158 // Add update notes to our output
159 $NOTES .= ADD_EXTENSION_NOTES($ver, $UPDATE_NOTES);
162 // Does this extension depends on an outstanding update of another update?
163 if (!empty($EXT_UPDATE_DEPENDS)) {
164 // Backup SQL commands and clear current
168 $ext_update = $EXT_UPDATE_DEPENDS;
170 // Check for required file
171 if (LOAD_EXTENSION($ext_update, "register", "", $dry_run, $SQLs)) {
172 // If versions mismatch update extension first
173 $ext_ver = GET_EXT_VERSION($ext_update);
175 // Extension version set? If empty the extension is not registered
176 if (empty($ext_ver)) {
177 // Extension not registered so far so first load task's ID...
178 $task = DETERMINE_EXTENSION_TASK_ID($ext_update);
182 // Try to register the extension
183 $test = EXTENSION_REGISTER($ext_update, $task, $dry_run, false);
185 } elseif ($ext_ver != $EXT_VERSION) {
186 // Ok, update this extension now
187 EXTENSION_UPDATE($ext_update, $ext_ver, $dry_run);
192 // Nothing to register / update before...
196 // Required file for update does not exists!
198 // But this is fine for the first time...
201 // Finally restore previous SQLs
202 $SQLs = $SQLs2; unset($SQLs2);
204 // Does not depend on an other extension
208 // Switch back to register mode
209 $EXT_LOAD_MODE = "register";
211 // Remains true if extension registration reports no failures
212 $test = ($test && !$EXT_REPORTS_FAILURE);
214 // Does everthing before wents ok?
216 // "Dry-run-mode" activated?
218 // Run installation pre-installation filters
219 RUN_FILTER('pre_extension_installed', array('dry_run' => $dry_run, 'sqls' => $SQLs));
221 // Register extension
222 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_extensions` (ext_name, ext_active, ext_version) VALUES ('%s','%s','%s')",
223 array($ext_name, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__);
225 // Remove cache file(s) if extension is active
226 RUN_FILTER('post_extension_installed', array('ext_name' => $ext_name, 'task_id' => $task_id, 'inc_pool' => $INC_POOL));
228 // In normal mode return a true on success
231 // Rewrite SQL command to keep { and } inside
232 foreach ($SQLs as $key => $sql) {
233 $sql = str_replace('{', "{", str_replace('}', "}", $sql));
237 // In "dry-run" mode return array with all SQL commands
240 // Remove all SQL commands
244 // No, an error occurs while registering extension :-(
247 } elseif (($task_id > 0) && (!empty($ext_name))) {
248 // Remove task from system when id and extension's name is valid
249 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_task_system` WHERE id=%s AND `status`='NEW' LIMIT 1",
250 array(bigintval($task_id)), __FILE__, __LINE__);
253 // Is this the sql_patches?
254 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":{$ext_name}/{$EXT_LOAD_MODE}");
255 if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove")) && (!$dry_run) && ($test)) {
256 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!");
258 // Then redirect to logout
259 LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
261 // Add temporary filter
262 REGISTER_FILTER('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true);
263 $GLOBALS['ext_load_mode'] = $EXT_LOAD_MODE;
267 // Return status code
271 // Run SQL queries for given extension id
272 // @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
273 function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
274 global $cacheInstance;
276 // This shall never do a non-admin user!
277 if (!IS_ADMIN()) return false;
282 // By default no SQL has been executed
285 // Get extension's name
286 $ext_name = GET_EXT_NAME($ext_id);
287 // If it is not set then maybe there is no extension for that ID number
288 if (empty($ext_name)) return false;
290 // Load extension in detected mode
291 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]={$ext_name}");
292 LOAD_EXTENSION($ext_name, $load_mode, "", false, $SQLs);
294 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".count($SQLs)."");
295 if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
296 // Run SQL commands...
297 RUN_FILTER('run_sqls', array('dry_run' => false, 'sqls' => $SQLs));
300 if ($load_mode == "remove") {
301 // Delete this extension (remember to remove it from your server *before* you click on welcome!
302 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
303 array($ext_name), __FILE__, __LINE__);
307 // Remove cache file(s) if extension is active
308 if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == "activate") || ($load_mode == "deactivate"))) {
310 RUN_FILTER('post_extension_run_sql', $ext_name);
313 // Is this the sql_patches?
314 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": {$ext_id}/{$ext_name}/{$load_mode}");
315 if (($ext_name == "sql_patches") && (($load_mode == "register") || ($load_mode == "remove"))) {
316 // Then redirect to logout
317 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!");
318 LOAD_URL("modules.php?module=admin&logout=1&".$load_mode."=sql_patches");
322 // Check if given extension is active
323 function EXT_IS_ACTIVE ($ext_name) {
326 // Extensions are all inactive during installation
327 if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing')) || (empty($ext_name))) return false;
329 // Not active is the default
333 if (isset($cacheArray['extensions']['ext_active'][$ext_name])) {
335 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "CACHE! ext_name={$ext_name}");
336 $active = $cacheArray['extensions']['ext_active'][$ext_name];
339 incrementConfigEntry('cache_hits');
340 } elseif (($ext_name == "cache") || (GET_EXT_VERSION("cache") == "")) {
341 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}");
342 // Load from database
343 $result = SQL_QUERY_ESC("SELECT ext_active FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
344 array($ext_name), __FILE__, __LINE__);
347 if (SQL_NUMROWS($result) == 1) {
349 list($active) = SQL_FETCHROW($result);
353 SQL_FREERESULT($result);
356 //* DEBUG: */ echo $ext_name."[DB]: {$active}");
357 $cacheArray['extensions']['ext_active'][$ext_name] = $active;
359 // Extension not active!
360 //* DEBUG: */ echo $ext_name.": Not active!");
361 $cacheArray['extensions']['ext_active'][$ext_name] = "N";
365 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name={$ext_name},active={$active}");
367 // Is this extension activated? (For admins we always have active extensions...)
368 return ($active == "Y");
370 // Get version from extensions
371 function GET_EXT_VERSION ($ext_name) {
372 global $cacheArray, $cacheInstance;
375 // Extensions are all inactive during installation
376 if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return "";
377 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ext_name={$ext_name}");
379 // Is the cache written?
380 if (isset($cacheArray['extensions']['ext_version'][$ext_name])) {
381 // Load data from cache
382 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": CACHE!");
383 $ext_ver = $cacheArray['extensions']['ext_version'][$ext_name];
386 incrementConfigEntry('cache_hits');
387 } elseif (!is_object($cacheInstance)) {
388 // Load from database
389 $result = SQL_QUERY_ESC("SELECT ext_version FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
390 array($ext_name), __FILE__, __LINE__);
392 // Is the extension there?
393 if (SQL_NUMROWS($result) == 1) {
395 list($ext_ver) = SQL_FETCHROW($result);
399 SQL_FREERESULT($result);
402 $cacheArray['extensions']['ext_version'][$ext_name] = $ext_ver;
406 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ret={$ext_ver}");
410 // Updates a given extension with current extension version to latest version
411 function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
412 // This shall never do a non-admin user!
413 global $cacheInstance, $UPDATE_NOTES, $NOTES, $EXT_VER_HISTORY;
414 global $EXT_UPDATE_DEPENDS, $EXT_VERSION, $INC_POOL, $cacheArray, $SQLs;
417 $SQLs = array(); $INC_POOL = array();
422 // Only admins are allowed to update extensions
423 if ((!IS_ADMIN()) || (empty($ext_name))) return false;
425 // Load extension in test mode
426 LOAD_EXTENSION($ext_name, "test", $ext_ver, $dry_run, $SQLs);
428 // Save version history
429 $history = $EXT_VER_HISTORY;
431 // Remove old SQLs array to prevent possible bugs
434 // Check if version is updated
435 if ((($EXT_VERSION != $ext_ver) || ($dry_run)) && (is_array($history))) {
436 // Search for starting point
437 $start = array_search($ext_ver, $history);
439 // And load SQL queries in order of version history
440 for ($idx = ($start + 1); $idx < sizeof($history); $idx++) {
441 // Set extension version
442 $cacheArray['update_ver'][$ext_name] = $history[$idx];
445 LOAD_EXTENSION($ext_name, "update", $cacheArray['update_ver'][$ext_name], $dry_run, $SQLs);
447 if (!empty($EXT_UPDATE_DEPENDS)) {
448 // Backup current SQL queries
449 $cacheArray['update_sqls'][$ext_name] = $SQLs;
451 // Is the extension there?
452 if (GET_EXT_VERSION($EXT_UPDATE_DEPENDS) != "") {
453 // Update another extension first!
454 $test = EXTENSION_UPDATE($EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run);
456 // Register new extension
457 $test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, 0, $dry_run, false);
460 // Restore previous SQL queries
461 $SQLs = $cacheArray['update_sqls'][$ext_name];
462 unset($cacheArray['update_sqls'][$ext_name]);
466 $NOTES .= ADD_EXTENSION_NOTES($cacheArray['update_ver'][$ext_name], $UPDATE_NOTES);
469 // In real-mode execute any existing includes
471 $cacheArray['inc_pool'][$ext_name] = $INC_POOL;
472 RUN_FILTER('load_includes', $INC_POOL);
473 $INC_POOL = $cacheArray['inc_pool'][$ext_name];
474 unset($cacheArray['inc_pool'][$ext_name]);
478 RUN_FILTER('run_sqls', array('dry_run' => $dry_run, 'sqls' => $SQLs));
482 CREATE_EXTENSION_UPDATE_TASK(GET_CURRENT_ADMIN_ID(), $ext_name, $cacheArray['update_ver'][$ext_name], addslashes($NOTES));
484 // Update extension's version
485 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
486 array($cacheArray['update_ver'][$ext_name], $ext_name), __FILE__, __LINE__);
490 unset($cacheArray['update_ver'][$ext_name]);
492 // Run filters on success extension update
493 RUN_FILTER('extension_update', $ext_name);
495 // In "dry-run" mode return array with SQL commands
501 // Output verbose SQL table for extension
502 function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed = "", $switch = false, $width = "100%") {
505 // Are there some queries in $queries?
506 if (count($queries) > 0) {
507 // Then use them instead!
515 // Do we have queries?
516 if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
517 foreach ($SQLs as $idx => $sql) {
521 // Output command if set
523 // Prepare output for template
531 $OUT .= LOAD_TEMPLATE("admin_ext_sql_row", true, $content);
533 // Switch color and count up
539 // Prepare content for template
547 // Load main template
548 $OUT = LOAD_TEMPLATE("admin_ext_sql_table", true, $content);
549 } elseif ((GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
550 // No addional SQL commands to run
551 $OUT = LOAD_TEMPLATE("admin_settings_saved", true, getMessage('ADMIN_NO_ADDITIONAL_SQLS'));
558 // Get extension name from id
559 function GET_EXT_NAME ($ext_id) {
562 // Init extension name
566 if (isset($cacheArray['extensions']['ext_name'][$ext_id])) {
568 $ret = $cacheArray['extensions']['ext_name'][$ext_id];
571 incrementConfigEntry('cache_hits');
572 } elseif (!EXT_IS_ACTIVE("cache")) {
573 // Load from database
574 $result = SQL_QUERY_ESC("SELECT ext_name FROM `{!_MYSQL_PREFIX!}_extensions` WHERE id=%s LIMIT 1",
575 array(bigintval($ext_id)), __FILE__, __LINE__);
576 list($ret) = SQL_FETCHROW($result);
577 SQL_FREERESULT($result);
582 // Get extension id from name
583 function GET_EXT_ID ($ext_name) {
588 if (isset($cacheArray['extensions']['ext_id'][$ext_name])) {
590 $ret = $cacheArray['extensions']['ext_id'][$ext_name];
593 incrementConfigEntry('cache_hits');
594 } elseif (!EXT_IS_ACTIVE("cache")) {
595 // Load from database
596 $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
597 array($ext_name), __FILE__, __LINE__);
598 list($ret) = SQL_FETCHROW($result);
599 SQL_FREERESULT($result);
606 // Activate given extension
607 function ACTIVATE_EXTENSION ($ext_name) {
608 // Activate the extension
609 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_active='Y' WHERE ext_name='%s' LIMIT 1",
610 array($ext_name), __FILE__, __LINE__);
612 // Extension has been activated?
613 if (SQL_AFFECTEDROWS() == 1) {
614 // Then run all queries
615 EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "activate");
619 // Deactivate given extension
620 function DEACTIVATE_EXTENSION($ext_name) {
621 // Activate the extension
622 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_active='N' WHERE ext_name='%s' LIMIT 1",
623 array($ext_name), __FILE__, __LINE__);
625 // Extension has been activated?
626 if (SQL_AFFECTEDROWS() == 1) {
627 // Then run all queries
628 EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "deactivate");
631 CREATE_EXTENSION_DEACTIVATION_TASK($ext_name);
634 SEND_ADMIN_NOTIFICATION(ADMIN_SUBJECT_EXTENSION_DEACTIVATED, "admin_ext_deactivated", array('ext_name' => $ext_name));
638 // Checks wether the extension is older than given
639 function EXT_VERSION_IS_OLDER ($ext_name, $ext_ver) {
640 // Get current extension version
641 $currVersion = GET_EXT_VERSION($ext_name);
643 // Remove all dots from both versions
644 $currVersion = str_replace(".", "", $currVersion);
645 $ext_ver = str_replace(".", "", $ext_ver);
647 // Now compare both and return the result
648 return ($currVersion < $ext_ver);
651 // Creates a new task for updated extension
652 function CREATE_EXTENSION_UPDATE_TASK ($admin_id, $ext_name, $ext_ver, $notes) {
653 // Create subject line
654 $subject = "[UPDATE-".$ext_name."-".$ext_ver.":] {!ADMIN_UPDATE_EXT_SUBJ!}";
656 // Is the extension there?
657 if (GET_EXT_VERSION($ext_name) != "") {
658 // Check if task is not there
659 if (DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) {
660 // Task not created so it's a brand-new extension which we need to register and create a task for!
661 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created) VALUES ('%s','0','NEW','EXTENSION_UPDATE','%s','%s', UNIX_TIMESTAMP())",
662 array($admin_id, $subject, $notes), __FILE__, __LINE__);
667 // Creates a new task for newly installed extension
668 function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) {
669 // Not installed and do we have created a task for the admin?
670 if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) == "")) {
672 $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
678 // Load text for task
679 if (FILE_READABLE($tpl)) {
680 // Load extension's own text template (HTML!)
681 $msg = LOAD_TEMPLATE("ext_".$ext, true);
683 // Load default message
684 $msg = LOAD_TEMPLATE("admin_new_ext", "", 0);
687 // Task not created so it's a brand-new extension which we need to register and create a task for!
688 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created)
689 VALUES (%s,0,'NEW','EXTENSION','%s','%s',UNIX_TIMESTAMP())",
694 ), __FILE__, __LINE__, true, false
699 // Creates a task for automatically deactivated (deprecated) extension
700 function CREATE_EXTENSION_DEACTIVATION_TASK ($ext) {
701 // Create subject line
702 $subject = sprintf("[%s:] %s", $ext, TASK_SUBJ_EXTENSION_DEACTIVATED);
704 // Not installed and do we have created a task for the admin?
705 if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) != "")) {
706 // Task not created so add it
707 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created)
708 VALUES (0,0,'NEW','EXTENSION_DEACTIVATION','%s','%s',UNIX_TIMESTAMP())",
711 addslashes(LOAD_TEMPLATE("task_ext_deactivated", true, $ext)),
712 ), __FILE__, __LINE__, true, false
717 // Checks if the module has a menu
718 function MODULE_HAS_MENU ($mod, $forceDb = false) {
721 // All is false by default
723 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):mod={$mod},cache=".GET_EXT_VERSION("cache")."<br />\n";
724 if (GET_EXT_VERSION("cache") >= "0.1.2") {
725 // Cache version is okay, so let's check the cache!
726 if (isset($cacheArray['modules']['has_menu'][$mod])) {
727 // Check module cache and count hit
728 $ret = ($cacheArray['modules']['has_menu'][$mod] == "Y");
729 incrementConfigEntry('cache_hits');
730 } elseif (isset($cacheArray['extensions']['ext_menu'][$mod])) {
731 // Check cache and count hit
732 $ret = ($cacheArray['extensions']['ext_menu'][$mod] == "Y");
733 incrementConfigEntry('cache_hits');
734 } elseif ((IS_ADMIN()) && ($mod == "admin")) {
735 // Admin module has always a menu!
738 } elseif ((GET_EXT_VERSION("sql_patches") >= "0.3.6") && ((!EXT_IS_ACTIVE("cache")) || ($forceDb === true))) {
739 // Check database for entry
740 $result = SQL_QUERY_ESC("SELECT has_menu FROM `{!_MYSQL_PREFIX!}_mod_reg` WHERE module='%s' LIMIT 1",
741 array($mod), __FILE__, __LINE__);
744 if (SQL_NUMROWS($result) == 1) {
745 // Load "has_menu" column
746 list($has_menu) = SQL_FETCHROW($result);
749 $cacheArray['extensions']['ext_menu'][$mod] = $has_menu;
751 // Does it have a menu?
752 $ret = ($has_menu == "Y");
756 SQL_FREERESULT($result);
757 } elseif (GET_EXT_VERSION("sql_patches") == "") {
758 // No sql_patches installed, so maybe in admin area?
759 $ret = ((IS_ADMIN()) && ($mod == "admin")); // Then there is a menu!
763 //* DEBUG: */ var_dump($ret);
767 // Determines the task id for given extension
768 function DETERMINE_EXTENSION_TASK_ID ($ext_name) {
769 // Default is not found
772 // Search for extension task's id
773 $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_task_system` WHERE task_type='EXTENSION' AND subject='[%s:]' LIMIT 1",
774 array($ext_name), __FILE__, __LINE__);
777 if (SQL_NUMROWS($result) == 1) {
778 // Task found so load task's ID and register extension...
779 list($task_id) = SQL_FETCHROW($result);
783 SQL_FREERESULT($result);
789 // Determines the task id for given subject
790 function DETERMINE_TASK_ID_BY_SUBJECT ($subject) {
791 // Default is not found
794 // Search for task id
795 $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_task_system` WHERE subject LIKE '%s%%' LIMIT 1",
796 array($subject), __FILE__, __LINE__);
799 if (SQL_NUMROWS($result) == 1) {
800 // Task found so load task's ID and register extension...
801 list($task_id) = SQL_FETCHROW($result);
805 SQL_FREERESULT($result);
811 // Add updates notes for given version
812 function ADD_EXTENSION_NOTES ($ver, &$UPDATE_NOTES) {
813 // Init notes/content
814 $out = ""; $content = array();
816 // Is do we have verbose output enabled?
817 if ((getConfig('verbose_sql') == "Y") || (!EXT_IS_ACTIVE("sql_patches"))) {
819 // Update notes found?
820 if (!empty($UPDATE_NOTES)) {
821 // Update notes found
824 'notes' => $UPDATE_NOTES
827 } elseif (($ver == "0.0") || ($ver == "0.0.0")) {
831 'notes' => INITIAL_RELEASE
834 // No update notes found!
837 'notes' => NO_UPDATE_NOTES
842 $out = LOAD_TEMPLATE("admin_ext_notes", true, $content);