inc/extensions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    Start: 03/25/2004 *
   4  * ===============                              Last change: 09/29/2004 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : extensions.php                                   *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Extension management                             *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Erweiterungen-Management                         *
  12  * -------------------------------------------------------------------- *
  13  *                                                                      *
  14  * -------------------------------------------------------------------- *
  15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
  16  * For more information visit: http://www.mxchange.org                  *
  17  *                                                                      *
  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.                                  *
  22  *                                                                      *
  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.                         *
  27  *                                                                      *
  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,               *
  31  * MA  02110-1301  USA                                                  *
  32  ************************************************************************/
  33
  34 // Some security stuff...
  35 if (!defined('__SECURITY')) {
  36         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
  37         require($INC);
  38 }
  39
  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 $_CONFIG, $EXT_VER_HISTORY;
  43         global $INC_POOL, $EXT_UPDATE_DEPENDS, $EXT_DEPRECATED, $UPDATE_NOTES;
  44         global $EXT_VERSION, $EXT_ALWAYS_ACTIVE;
  45
  46         // Init array
  47         $INC_POOL = array();
  48
  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($GLOBALS['ext_loaded']['ext'][$ext_name])) && (empty($EXT_LOAD_MODE))) {
  52                 // Debug message
  53                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
  54                 return false;
  55         } // END - if
  56
  57         // Construct FQFN for extension file
  58         $FQFN = sprintf("%sinc/extensions/ext-%s.php",
  59                 constant('PATH'),
  60                 $ext_name
  61         );
  62
  63         // Is the extension file NOT there?
  64         if (!FILE_READABLE($FQFN)) {
  65                 // Debug message
  66                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found.", $ext_name));
  67
  68                 // Abort here
  69                 return false;
  70         } // END - if
  71
  72         // Construct FQFN for language file
  73         $langInclude = sprintf("inc/language/%s_%s.php", $ext_name, GET_LANGUAGE());
  74
  75         // Is this include there?
  76         if ((FILE_READABLE($langInclude)) && (!isset($GLOBALS['ext_loaded']['lang'][$ext_name]))) {
  77                 // Then load it
  78                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Language loaded.");
  79                 $GLOBALS['ext_loaded']['lang'][$ext_name] = true;
  80                 LOAD_INC_ONCE($langInclude);
  81         } // END - if
  82
  83         // Construct FQFN for functions file
  84         $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
  85
  86         // Is this include there?
  87         if ((FILE_READABLE($funcsInclude)) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name]))) {
  88                 // Then load it
  89                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Functions loaded.");
  90                 $GLOBALS['ext_loaded']['funcs'][$ext_name] = true;
  91                 LOAD_INC_ONCE($funcsInclude);
  92         } // END - if
  93
  94         // Extensions are not deprecated by default
  95         $EXT_DEPRECATED = "N";
  96
  97         // Extensions are not always active by default
  98         $EXT_ALWAYS_ACTIVE = "N";
  99
 100         // By default an extension update does not depend on other extensions
 101         $EXT_UPDATE_DEPENDS = "";
 102
 103         // Extension update notes
 104         $UPDATE_NOTES = "";
 105
 106         // Include the extension file
 107         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Extension loaded.");
 108         require($FQFN);
 109
 110         // Is this extension deprecated?
 111         if ($EXT_DEPRECATED == "Y") {
 112                 // Deactivate the extension
 113                 DEACTIVATE_EXTENSION($ext_name);
 114
 115                 // Abort here
 116                 return false;
 117         } // END - if
 118
 119         // Mark it as loaded in normal mode
 120         if (empty($EXT_LOAD_MODE)) {
 121                 // Mark it now...
 122                 $GLOBALS['ext_loaded']['ext'][$ext_name] = true;
 123         } // END - if
 124
 125         // All fine!
 126         return true;
 127 }
 128
 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;
 132         global $EXT_VER_HISTORY, $NOTES, $EXT_ALWAYS_ACTIVE, $EXT_VERSION;
 133         global $EXT_UPDATE_DEPENDS;
 134
 135         // This shall never do a non-admin user!
 136         if (!IS_ADMIN()) return false;
 137
 138         // Is this extension already installed?
 139         if (EXT_IS_ACTIVE($ext_name)) return false;
 140
 141         // Init variables
 142         $ret = false; $SQLs = array();
 143         $NOTES = "";
 144         $INC_POOL = array();
 145
 146         // By default we have no failures
 147         $EXT_REPORTS_FAILURE = false;
 148
 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);
 157
 158                         // Add update notes to our output
 159                         $NOTES .= ADD_EXTENSION_NOTES($ver, $UPDATE_NOTES);
 160                 } // END - foreach
 161
 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
 165                         $SQLs2 = $SQLs;
 166                         $SQLs  = array();
 167                         $test  = false;
 168                         $ext_update = $EXT_UPDATE_DEPENDS;
 169
 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);
 174
 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);
 179
 180                                         // Entry found?
 181                                         if ($task > 0) {
 182                                                 // Try to register the extension
 183                                                 $test = EXTENSION_REGISTER($ext_update, $task, $dry_run, false);
 184                                         } // END - if
 185                                 } elseif ($ext_ver != $EXT_VERSION) {
 186                                         // Ok, update this extension now
 187                                         EXTENSION_UPDATE($ext_update, $ext_ver, $dry_run);
 188
 189                                         // All okay!
 190                                         $test = true;
 191                                 } else {
 192                                         // Nothing to register / update before...
 193                                         $test = true;
 194                                 }
 195                         } else {
 196                                 // Required file for update does not exists!
 197                                 $test = true;
 198                                 // But this is fine for the first time...
 199                         }
 200
 201                         // Finally restore previous SQLs
 202                         $SQLs = $SQLs2; unset($SQLs2);
 203                 } else {
 204                         // Does not depend on an other extension
 205                         $test = true;
 206                 }
 207
 208                 // Switch back to register mode
 209                 $EXT_LOAD_MODE = "register";
 210
 211                 // Remains true if extension registration reports no failures
 212                 $test = ($test && !$EXT_REPORTS_FAILURE);
 213
 214                 // Does everthing before wents ok?
 215                 if ($test) {
 216                         // "Dry-run-mode" activated?
 217                         if (!$dry_run) {
 218                                 // Run installation pre-installation filters
 219                                 RUN_FILTER('pre_extension_installed', array('dry_run' => $dry_run, 'sqls' => $SQLs));
 220
 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__);
 224
 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));
 227
 228                                 // In normal mode return a true on success
 229                                 $ret = true;
 230                         } else {
 231                                 // Rewrite SQL command to keep { and } inside
 232                                 foreach ($SQLs as $key => $sql) {
 233                                         $sql = str_replace('{', "&#123;", str_replace('}', "&#125;", $sql));
 234                                         $SQLs[$key] = $sql;
 235                                 } // END - foreach
 236
 237                                 // In  "dry-run" mode return array with all SQL commands
 238                                 $ret = $SQLs;
 239
 240                                 // Remove all SQL commands
 241                                 unset($SQLs);
 242                         }
 243                 } else {
 244                         // No, an error occurs while registering extension :-(
 245                         $ret = false;
 246                 }
 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__);
 251         }
 252
 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!");
 257                 if ($logout) {
 258                         // Then redirect to logout
 259                         LOAD_URL("modules.php?module=admin&amp;logout=1&amp;".$EXT_LOAD_MODE."=sql_patches");
 260                 } else {
 261                         // Add temporary filter
 262                         REGISTER_FILTER('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true);
 263                         $GLOBALS['ext_load_mode'] = $EXT_LOAD_MODE;
 264                 }
 265         } // END - if
 266
 267         // Return status code
 268         return $ret;
 269 }
 270
 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         // This shall never do a non-admin user!
 275         if (!IS_ADMIN()) return false;
 276
 277         // Init array
 278         $SQLs = array();
 279
 280         // By default no SQL has been executed
 281         $sqlRan = false;
 282
 283         // Get extension's name
 284         $ext_name = GET_EXT_NAME($ext_id);
 285         // If it is not set then maybe there is no extension for that ID number
 286         if (empty($ext_name)) return false;
 287
 288         // Load extension in detected mode
 289         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]={$ext_name}");
 290         LOAD_EXTENSION($ext_name, $load_mode, "", false, $SQLs);
 291
 292         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".count($SQLs)."");
 293         if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
 294                 // Run SQL commands...
 295                 RUN_FILTER('run_sqls', array('dry_run' => false, 'sqls' => $SQLs));
 296
 297                 // Removal mode?
 298                 if ($load_mode == "remove") {
 299                         // Delete this extension (remember to remove it from your server *before* you click on welcome!
 300                         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
 301                                 array($ext_name), __FILE__, __LINE__);
 302                 } // END - if
 303         } // END - if
 304
 305         // Remove cache file(s) if extension is active
 306         if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == "activate") || ($load_mode == "deactivate"))) {
 307                 // Run filters
 308                 RUN_FILTER('post_extension_run_sql', $ext_name);
 309         } // END - if
 310
 311         // Is this the sql_patches?
 312         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": {$ext_id}/{$ext_name}/{$load_mode}");
 313         if (($ext_name == "sql_patches") && (($load_mode == "register") || ($load_mode == "remove"))) {
 314                 // Then redirect to logout
 315                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!");
 316                 LOAD_URL("modules.php?module=admin&amp;logout=1&amp;".$load_mode."=sql_patches");
 317         } // END - if
 318 }
 319
 320 // Check if given extension is active
 321 function EXT_IS_ACTIVE ($ext_name) {
 322         // Extensions are all inactive during installation
 323         if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isInstalling()) || (empty($ext_name))) return false;
 324
 325         // Not active is the default
 326         $active = "N";
 327
 328         // Check cache
 329         if (isset($GLOBALS['cache_array']['extensions']['ext_active'][$ext_name])) {
 330                 // Load from cache
 331                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "CACHE! ext_name={$ext_name}");
 332                 $active = $GLOBALS['cache_array']['extensions']['ext_active'][$ext_name];
 333
 334                 // Count cache hits
 335                 incrementConfigEntry('cache_hits');
 336         } elseif (isset($GLOBALS['ext_loaded'][$ext_name])) {
 337                 // Extension is loaded!
 338                 die("LOADED:$ext_name");
 339         } elseif (($ext_name == "cache") || (GET_EXT_VERSION("cache") == "")) {
 340                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}");
 341                 // Load from database
 342                 $result = SQL_QUERY_ESC("SELECT ext_active FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
 343                         array($ext_name), __FILE__, __LINE__);
 344
 345                 // Entry found?
 346                 if (SQL_NUMROWS($result) == 1) {
 347                         // Load entry
 348                         list($active) = SQL_FETCHROW($result);
 349                 } // END - if
 350
 351                 // Free result
 352                 SQL_FREERESULT($result);
 353
 354                 // Write cache array
 355                 //* DEBUG: */ echo $ext_name."[DB]: {$active}");
 356                 $GLOBALS['cache_array']['extensions']['ext_active'][$ext_name] = $active;
 357         } else {
 358                 // Extension not active!
 359                 //* DEBUG: */ echo $ext_name.": Not active!");
 360                 $GLOBALS['cache_array']['extensions']['ext_active'][$ext_name] = "N";
 361         }
 362
 363         // Debug message
 364         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name={$ext_name},active={$active}");
 365
 366         // Is this extension activated? (For admins we always have active extensions...)
 367         return ($active == "Y");
 368 }
 369 // Get version from extensions
 370 function GET_EXT_VERSION ($ext_name) {
 371         // By default no extension is found
 372         $ext_ver = false;
 373
 374         // Extensions are all inactive during installation
 375         if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isInstalling())) return "";
 376         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ext_name={$ext_name}");
 377
 378         // Is the cache written?
 379         if (isset($GLOBALS['cache_array']['extensions']['ext_version'][$ext_name])) {
 380                 // Load data from cache
 381                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": CACHE!");
 382                 $ext_ver = $GLOBALS['cache_array']['extensions']['ext_version'][$ext_name];
 383
 384                 // Count cache hits
 385                 incrementConfigEntry('cache_hits');
 386         } elseif ((!isset($GLOBALS['cache_instance'])) || (!is_object($GLOBALS['cache_instance']))) {
 387                 // Load from database
 388                 $result = SQL_QUERY_ESC("SELECT ext_version FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
 389                         array($ext_name), __FILE__, __LINE__);
 390
 391                 // Is the extension there?
 392                 if (SQL_NUMROWS($result) == 1) {
 393                         // Load entry
 394                         list($ext_ver) = SQL_FETCHROW($result);
 395                 } // END - if
 396
 397                 // Free result
 398                 SQL_FREERESULT($result);
 399
 400                 // Set cache
 401                 $GLOBALS['cache_array']['extensions']['ext_version'][$ext_name] = $ext_ver;
 402         }
 403
 404         // Return result
 405         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ret={$ext_ver}");
 406         return $ext_ver;
 407 }
 408
 409 // Updates a given extension with current extension version to latest version
 410 function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
 411         // This shall never do a non-admin user!
 412         global $UPDATE_NOTES, $NOTES, $EXT_VER_HISTORY;
 413         global $EXT_UPDATE_DEPENDS, $EXT_VERSION, $INC_POOL, $SQLs;
 414
 415         // Init arrays
 416         $SQLs = array(); $INC_POOL = array();
 417
 418         // Init notes
 419         $NOTES = "";
 420
 421         // Only admins are allowed to update extensions
 422         if ((!IS_ADMIN()) || (empty($ext_name))) return false;
 423
 424         // Load extension in test mode
 425         LOAD_EXTENSION($ext_name, "test", $ext_ver, $dry_run, $SQLs);
 426
 427         // Save version history
 428         $history = $EXT_VER_HISTORY;
 429
 430         // Remove old SQLs array to prevent possible bugs
 431         $SQLs = array();
 432
 433         // Check if version is updated
 434         if ((($EXT_VERSION != $ext_ver) || ($dry_run)) && (is_array($history))) {
 435                 // Search for starting point
 436                 $start = array_search($ext_ver, $history);
 437
 438                 // And load SQL queries in order of version history
 439                 for ($idx = ($start + 1); $idx < sizeof($history); $idx++) {
 440                         // Set extension version
 441                         $GLOBALS['cache_array']['update_ver'][$ext_name] = $history[$idx];
 442
 443                         // Load again...
 444                         LOAD_EXTENSION($ext_name, "update", $GLOBALS['cache_array']['update_ver'][$ext_name], $dry_run, $SQLs);
 445
 446                         if (!empty($EXT_UPDATE_DEPENDS)) {
 447                                 // Backup current SQL queries
 448                                 $GLOBALS['cache_array']['update_sqls'][$ext_name] = $SQLs;
 449
 450                                 // Is the extension there?
 451                                 if (GET_EXT_VERSION($EXT_UPDATE_DEPENDS) != "") {
 452                                         // Update another extension first!
 453                                         $test = EXTENSION_UPDATE($EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run);
 454                                 } else {
 455                                         // Register new extension
 456                                         $test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, 0, $dry_run, false);
 457                                 }
 458
 459                                 // Restore previous SQL queries
 460                                 $SQLs = $GLOBALS['cache_array']['update_sqls'][$ext_name];
 461                                 unset($GLOBALS['cache_array']['update_sqls'][$ext_name]);
 462                         } // END - if
 463
 464                         // Add notes
 465                         $NOTES .= ADD_EXTENSION_NOTES($GLOBALS['cache_array']['update_ver'][$ext_name], $UPDATE_NOTES);
 466                 } // END - for
 467
 468                 // In real-mode execute any existing includes
 469                 if (!$dry_run) {
 470                         $GLOBALS['cache_array']['inc_pool'][$ext_name] = $INC_POOL;
 471                         RUN_FILTER('load_includes', $INC_POOL);
 472                         $INC_POOL = $GLOBALS['cache_array']['inc_pool'][$ext_name];
 473                         unset($GLOBALS['cache_array']['inc_pool'][$ext_name]);
 474                 } // END - if
 475
 476                 // Run SQLs
 477                 RUN_FILTER('run_sqls', array('dry_run' => $dry_run, 'sqls' => $SQLs));
 478
 479                 if (!$dry_run) {
 480                         // Create task
 481                         CREATE_EXTENSION_UPDATE_TASK(GET_CURRENT_ADMIN_ID(), $ext_name, $GLOBALS['cache_array']['update_ver'][$ext_name], SQL_ESCAPE($NOTES));
 482
 483                         // Update extension's version
 484                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
 485                                 array($GLOBALS['cache_array']['update_ver'][$ext_name], $ext_name), __FILE__, __LINE__);
 486
 487                         // Remove arrays
 488                         unset($SQLs);
 489                         unset($GLOBALS['cache_array']['update_ver'][$ext_name]);
 490
 491                         // Run filters on success extension update
 492                         RUN_FILTER('extension_update', $ext_name);
 493                 } else {
 494                         // In "dry-run" mode return array with SQL commands
 495                         return $SQLs;
 496                 }
 497         } // END - if
 498 }
 499
 500 // Output verbose SQL table for extension
 501 function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = "", $dashed = "", $switch = false, $width = "100%") {
 502         global $SQLs;
 503
 504         // Empty title?
 505         if (empty($title)) {
 506                 // Then fix it to default
 507                 $title = getMessage('ADMIN_SQLS_EXECUTED_ON_REMOVAL');
 508         } // END - if
 509
 510         // Are there some queries in $queries?
 511         if (count($queries) > 0) {
 512                 // Then use them instead!
 513                 $SQLs = $queries;
 514         } // END - if
 515
 516         // Init variables
 517         $SW = 2; $i = 1;
 518         $OUT = "";
 519
 520         // Do we have queries?
 521         if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
 522                 foreach ($SQLs as $idx => $sql) {
 523                         // Trim out spaces
 524                         $sql = trim($sql);
 525
 526                         // Output command if set
 527                         if (!empty($sql)) {
 528                                 // Prepare output for template
 529                                 $content = array(
 530                                         'sw'  => $SW,
 531                                         'i'   => $i,
 532                                         'sql' => $sql
 533                                 );
 534
 535                                 // Load row template
 536                                 $OUT .= LOAD_TEMPLATE("admin_ext_sql_row", true, $content);
 537
 538                                 // Switch color and count up
 539                                 $SW = 3 - $SW;
 540                                 $i++;
 541                         } // END - if
 542                 } // END - foreach
 543
 544                 // Prepare content for template
 545                 $content = array(
 546                         'width'  => $width,
 547                         'dashed' => $dashed,
 548                         'title'  => $title,
 549                         'out'    => $OUT
 550                 );
 551
 552                 // Load main template
 553                 $OUT = LOAD_TEMPLATE("admin_ext_sql_table", true, $content);
 554         } elseif ((GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
 555                 // No addional SQL commands to run
 556                 $OUT = LOAD_TEMPLATE("admin_settings_saved", true, getMessage('ADMIN_NO_ADDITIONAL_SQLS'));
 557         } // END - if
 558
 559         // Return output
 560         return $OUT;
 561 }
 562
 563 // Get extension name from id
 564 function GET_EXT_NAME ($ext_id) {
 565         // Init extension name
 566         $ret = "";
 567
 568         // Is cache there?
 569         if (isset($GLOBALS['cache_array']['extensions']['ext_name'][$ext_id])) {
 570                 // Load from cache
 571                 $ret = $GLOBALS['cache_array']['extensions']['ext_name'][$ext_id];
 572
 573                 // Count cache hits
 574                 incrementConfigEntry('cache_hits');
 575         } elseif (!EXT_IS_ACTIVE("cache")) {
 576                 // Load from database
 577                 $result = SQL_QUERY_ESC("SELECT ext_name FROM `{!_MYSQL_PREFIX!}_extensions` WHERE id=%s LIMIT 1",
 578                         array(bigintval($ext_id)), __FILE__, __LINE__);
 579                 list($ret) = SQL_FETCHROW($result);
 580                 SQL_FREERESULT($result);
 581         }
 582         return $ret;
 583 }
 584
 585 // Get extension id from name
 586 function GET_EXT_ID ($ext_name) {
 587         // Init ID number
 588         $ret = 0;
 589         if (isset($GLOBALS['cache_array']['extensions']['ext_id'][$ext_name])) {
 590                 // Load from cache
 591                 $ret = $GLOBALS['cache_array']['extensions']['ext_id'][$ext_name];
 592
 593                 // Count cache hits
 594                 incrementConfigEntry('cache_hits');
 595         } elseif (!EXT_IS_ACTIVE("cache")) {
 596                 // Load from database
 597                 $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
 598                         array($ext_name), __FILE__, __LINE__);
 599                 list($ret) = SQL_FETCHROW($result);
 600                 SQL_FREERESULT($result);
 601         }
 602
 603         // Return value
 604         return $ret;
 605 }
 606
 607 // Activate given extension
 608 function ACTIVATE_EXTENSION ($ext_name) {
 609         // Activate the extension
 610         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_active='Y' WHERE ext_name='%s' LIMIT 1",
 611                 array($ext_name), __FILE__, __LINE__);
 612
 613         // Extension has been activated?
 614         if (SQL_AFFECTEDROWS() == 1) {
 615                 // Then run all queries
 616                 EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "activate");
 617         } // END - if
 618 }
 619
 620 // Deactivate given extension
 621 function DEACTIVATE_EXTENSION($ext_name) {
 622         // Activate the extension
 623         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_active='N' WHERE ext_name='%s' LIMIT 1",
 624                 array($ext_name), __FILE__, __LINE__);
 625
 626         // Extension has been activated?
 627         if (SQL_AFFECTEDROWS() == 1) {
 628                 // Then run all queries
 629                 EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "deactivate");
 630
 631                 // Create new task
 632                 CREATE_EXTENSION_DEACTIVATION_TASK($ext_name);
 633
 634                 // Notify the admin
 635                 SEND_ADMIN_NOTIFICATION(
 636                         getMessage('ADMIN_SUBJECT_EXTENSION_DEACTIVATED'),
 637                         "admin_ext_deactivated",
 638                         array('ext_name' => $ext_name)
 639                 );
 640         } // END - if
 641 }
 642
 643 // Checks wether the extension is older than given
 644 function EXT_VERSION_IS_OLDER ($ext_name, $ext_ver) {
 645         // Get current extension version
 646         $currVersion = GET_EXT_VERSION($ext_name);
 647
 648         // Remove all dots from both versions
 649         $currVersion = str_replace(".", "", $currVersion);
 650         $ext_ver = str_replace(".", "", $ext_ver);
 651
 652         // Now compare both and return the result
 653         return ($currVersion < $ext_ver);
 654 }
 655
 656 // Creates a new task for updated extension
 657 function CREATE_EXTENSION_UPDATE_TASK ($admin_id, $ext_name, $ext_ver, $notes) {
 658         // Create subject line
 659         $subject = "[UPDATE-".$ext_name."-".$ext_ver.":] {--ADMIN_UPDATE_EXT_SUBJ--}";
 660
 661         // Is the extension there?
 662         if (GET_EXT_VERSION($ext_name) != "") {
 663                 // Check if task is not there
 664                 if (DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) {
 665                         // Task not created so it's a brand-new extension which we need to register and create a task for!
 666                         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())",
 667                                 array($admin_id, $subject, $notes), __FILE__, __LINE__);
 668                 } // END - if
 669         } // END - if
 670 }
 671
 672 // Creates a new task for newly installed extension
 673 function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) {
 674         // Not installed and do we have created a task for the admin?
 675         if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) == "")) {
 676                 // Template file
 677                 $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
 678                         constant('PATH'),
 679                         GET_LANGUAGE(),
 680                         $ext
 681                 );
 682
 683                 // Load text for task
 684                 if (FILE_READABLE($tpl)) {
 685                         // Load extension's own text template (HTML!)
 686                         $msg = LOAD_TEMPLATE("ext_".$ext, true);
 687                 } else {
 688                         // Load default message
 689                         $msg = LOAD_TEMPLATE("admin_new_ext", "", 0);
 690                 }
 691
 692                 // Task not created so it's a brand-new extension which we need to register and create a task for!
 693                 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created)
 694 VALUES (%s,0,'NEW','EXTENSION','%s','%s',UNIX_TIMESTAMP())",
 695                         array(
 696                                 $admin_id,
 697                                 $subject,
 698                                 SQL_ESCAPE($msg),
 699                         ),  __FILE__, __LINE__, true, false
 700                 );
 701         } // END - if
 702 }
 703
 704 // Creates a task for automatically deactivated (deprecated) extension
 705 function CREATE_EXTENSION_DEACTIVATION_TASK ($ext) {
 706         // Create subject line
 707         $subject = sprintf("[%s:] %s", $ext, getMessage('TASK_SUBJ_EXTENSION_DEACTIVATED'));
 708
 709         // Not installed and do we have created a task for the admin?
 710         if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) != "")) {
 711                 // Task not created so add it
 712                 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created)
 713 VALUES (0,0,'NEW','EXTENSION_DEACTIVATION','%s','%s',UNIX_TIMESTAMP())",
 714                         array(
 715                                 $subject,
 716                                 SQL_ESCAPE(LOAD_TEMPLATE("task_ext_deactivated", true, $ext)),
 717                         ),  __FILE__, __LINE__, true, false
 718                 );
 719         } // END - if
 720 }
 721
 722 // Checks if the module has a menu
 723 function MODULE_HAS_MENU ($mod, $forceDb = false) {
 724         // All is false by default
 725         $ret = false;
 726
 727         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):mod={$mod},cache=".GET_EXT_VERSION("cache")."<br />\n";
 728         if (GET_EXT_VERSION("cache") >= "0.1.2") {
 729                 // Cache version is okay, so let's check the cache!
 730                 if (isset($GLOBALS['cache_array']['modules']['has_menu'][$mod])) {
 731                         // Check module cache and count hit
 732                         $ret = ($GLOBALS['cache_array']['modules']['has_menu'][$mod] == "Y");
 733                         incrementConfigEntry('cache_hits');
 734                 } elseif (isset($GLOBALS['cache_array']['extensions']['ext_menu'][$mod])) {
 735                         // Check cache and count hit
 736                         $ret = ($GLOBALS['cache_array']['extensions']['ext_menu'][$mod] == "Y");
 737                         incrementConfigEntry('cache_hits');
 738                 } elseif ((IS_ADMIN()) && ($mod == "admin")) {
 739                         // Admin module has always a menu!
 740                         $ret = true;
 741                 }
 742         } elseif ((GET_EXT_VERSION("sql_patches") >= "0.3.6") && ((!EXT_IS_ACTIVE("cache")) || ($forceDb === true))) {
 743                 // Check database for entry
 744                 $result = SQL_QUERY_ESC("SELECT has_menu FROM `{!_MYSQL_PREFIX!}_mod_reg` WHERE module='%s' LIMIT 1",
 745                         array($mod), __FILE__, __LINE__);
 746
 747                 // Entry found?
 748                 if (SQL_NUMROWS($result) == 1) {
 749                         // Load "has_menu" column
 750                         list($has_menu) = SQL_FETCHROW($result);
 751
 752                         // Fake cache... ;-)
 753                         $GLOBALS['cache_array']['extensions']['ext_menu'][$mod] = $has_menu;
 754
 755                         // Does it have a menu?
 756                         $ret = ($has_menu == "Y");
 757                 } // END  - if
 758
 759                 // Free memory
 760                 SQL_FREERESULT($result);
 761         } elseif (GET_EXT_VERSION("sql_patches") == "") {
 762                 // No sql_patches installed, so maybe in admin area?
 763                 $ret = ((IS_ADMIN()) && ($mod == "admin")); // Then there is a menu!
 764         }
 765
 766         // Return status
 767         //* DEBUG: */ var_dump($ret);
 768         return $ret;
 769 }
 770
 771 // Determines the task id for given extension
 772 function DETERMINE_EXTENSION_TASK_ID ($ext_name) {
 773         // Default is not found
 774         $task_id = 0;
 775
 776         // Search for extension task's id
 777         $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_task_system` WHERE task_type='EXTENSION' AND subject='[%s:]' LIMIT 1",
 778                 array($ext_name), __FILE__, __LINE__);
 779
 780         // Entry found?
 781         if (SQL_NUMROWS($result) == 1) {
 782                 // Task found so load task's ID and register extension...
 783                 list($task_id) = SQL_FETCHROW($result);
 784         } // END - if
 785
 786         // Free result
 787         SQL_FREERESULT($result);
 788
 789         // Return it
 790         return $task_id;
 791 }
 792
 793 // Determines the task id for given subject
 794 function DETERMINE_TASK_ID_BY_SUBJECT ($subject) {
 795         // Default is not found
 796         $task_id = 0;
 797
 798         // Search for task id
 799         $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_task_system` WHERE subject LIKE '%s%%' LIMIT 1",
 800                 array($subject), __FILE__, __LINE__);
 801
 802         // Entry found?
 803         if (SQL_NUMROWS($result) == 1) {
 804                 // Task found so load task's ID and register extension...
 805                 list($task_id) = SQL_FETCHROW($result);
 806         } // END - if
 807
 808         // Free result
 809         SQL_FREERESULT($result);
 810
 811         // Return it
 812         return $task_id;
 813 }
 814
 815 // Add updates notes for given version
 816 function ADD_EXTENSION_NOTES ($ver, &$UPDATE_NOTES) {
 817         // Init notes/content
 818         $out = ""; $content = array();
 819
 820         // Is do we have verbose output enabled?
 821         if ((getConfig('verbose_sql') == "Y") || (!EXT_IS_ACTIVE("sql_patches"))) {
 822
 823                 // Update notes found?
 824                 if (!empty($UPDATE_NOTES)) {
 825                         // Update notes found
 826                         $content = array(
 827                                 'ver'   => $ver,
 828                                 'notes' => $UPDATE_NOTES
 829                         );
 830                         $UPDATE_NOTES = "";
 831                 } elseif (($ver == "0.0") || ($ver == "0.0.0")) {
 832                         // Initial release
 833                         $content = array(
 834                                 'ver'   => $ver,
 835                                 'notes' => getMessage('INITIAL_RELEASE')
 836                         );
 837                 } else {
 838                         // No update notes found!
 839                         $content = array(
 840                                 'ver'   => $ver,
 841                                 'notes' => getMessage('NO_UPDATE_NOTES')
 842                         );
 843                 }
 844
 845                 // Load template
 846                 $out = LOAD_TEMPLATE("admin_ext_notes", true, $content);
 847         } // END - if
 848
 849         // Return the output
 850         return $out;
 851 }
 852
 853 // Getter for CSS files array
 854 function EXT_GET_CSS_FILES () {
 855         // By default no additional CSS files are found
 856         $cssFiles = array();
 857
 858         // Is the array there?
 859         if (isset($GLOBALS['css_files'])) {
 860                 // Then use it
 861                 $cssFiles = $GLOBALS['css_files'];
 862         } // END - if
 863
 864         // Return array
 865         return $cssFiles;
 866 }
 867
 868 // Init CSS files array
 869 function EXT_INIT_CSS_FILES () {
 870         // Simply init it
 871         $GLOBALS['css_files'] = array();
 872 }
 873
 874 // Add new entry
 875 function EXT_ADD_CSS_FILE ($file) {
 876         // Is the array there?
 877         if (!isset($GLOBALS['css_files'])) {
 878                 // Then auto-init them
 879                 EXT_INIT_CSS_FILES();
 880         } // END - if
 881
 882         // Add the entry
 883         $GLOBALS['css_files'][] = $file;
 884 }
 885
 886 //
 887 ?>