inc/extensions-functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 10/25/2009 *
   4  * ===================                          Last change: 10/25/2009 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : extensions-functions.php                         *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Extension management                             *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Erweiterungen-Management                         *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * -------------------------------------------------------------------- *
  18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  20  * For more information visit: http://www.mxchange.org                  *
  21  *                                                                      *
  22  * This program is free software; you can redistribute it and/or modify *
  23  * it under the terms of the GNU General Public License as published by *
  24  * the Free Software Foundation; either version 2 of the License, or    *
  25  * (at your option) any later version.                                  *
  26  *                                                                      *
  27  * This program is distributed in the hope that it will be useful,      *
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  30  * GNU General Public License for more details.                         *
  31  *                                                                      *
  32  * You should have received a copy of the GNU General Public License    *
  33  * along with this program; if not, write to the Free Software          *
  34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  35  * MA  02110-1301  USA                                                  *
  36  ************************************************************************/
  37
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         die();
  41 } // END - if
  42
  43 // Load the extension and maybe found language and function files.
  44 function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = false) {
  45         // Loading an extension in same mode, but not test/update, twice is not
  46         // good, so is the extension $ext_name already loaded in mode $ext_mode?
  47         if ((isset($GLOBALS['loaded_extension'][$ext_name][$ext_mode])) && (!in_array($ext_mode, array('update', 'test')))) {
  48                 // If this happens twice, we need the bug report from you, except for updates/tests
  49                 debug_report_bug(__FUNCTION__, __LINE__, '() is called twice: ext_name=' . $ext_name . ', ext_mode='. $ext_mode . ',ext_sqls=' . print_r(getExtensionSqls(), true) . ', ext_register_running=' . print_r($GLOBALS['ext_register_running'], true) . ', ext_running_updates=' . print_r($GLOBALS['ext_running_updates'], true));
  50         } // END - if
  51
  52         // Make sure this situation can only happen once
  53         $GLOBALS['loaded_extension'][$ext_name][$ext_mode] = true;
  54
  55         // Set extension mode
  56         setExtensionMode($ext_mode);
  57
  58         // Set current extension name
  59         setCurrentExtensionName($ext_name);
  60
  61         // By default all extensions are in productive phase
  62         enableExtensionProductive();
  63
  64         if (!empty($ext_ver)) {
  65                 // Set current extension version
  66                 setCurrentExtensionVersion($ext_ver);
  67         } else {
  68                 // Set it to 0.0 by default
  69                 setCurrentExtensionVersion('0.0.0');
  70
  71                 // Is the extension installed?
  72                 if ((isExtensionInstalled($ext_name)) && ($ext_mode != 'register')) {
  73                         // Get extension's version
  74                         setCurrentExtensionVersion(getExtensionVersion($ext_name));
  75                 } // END - if
  76
  77                 // In all but test-mode we need these messages to debug! Please report all (together, e.g.)
  78                 if (($ext_mode != 'test') && (getCurrentExtensionVersion() == '0.0.0')) {
  79                         // Abort here, this must now always be set!
  80                         debug_report_bug(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0. ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', dry_run=' . intval($dry_run));
  81                 } // END - if
  82         }
  83
  84         // Set dry-run
  85         enableExtensionDryRun($dry_run);
  86
  87         // Init array
  88         initIncludePool('extension');
  89
  90         // Init EXT_UPDATE_DEPENDS if not yet done
  91         if (!isExtensionUpdateDependenciesInitialized()) {
  92                 // Init here...
  93                 initExtensionUpdateDependencies();
  94         } // END - if
  95
  96         // Init current extension name list
  97         initExtensionSqls();
  98
  99         // Is the extension already loaded?
 100         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loading extension ' . $ext_name . ', mode=' . getExtensionMode() . ', ver=' . getCurrentExtensionVersion());
 101         if ((isExtensionLoaded($ext_name)) && (getExtensionMode() == 'init')) {
 102                 // Debug message
 103                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
 104
 105                 // Abort here
 106                 return false;
 107         } // END - if
 108
 109         // Is the extension file NOT there?
 110         if (!isExtensionNameValid($ext_name)) {
 111                 // Debug message
 112                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s not found or not readable.", $ext_name));
 113
 114                 // Abort here
 115                 return false;
 116         } // END - if
 117
 118         // Load extension's own language file if not in test mode
 119         if ((getExtensionMode() != 'test') && (ifExtensionHasLanguageFile($ext_name))) {
 120                 // Load it
 121                 loadLanguageFile($ext_name);
 122         } // END - if
 123
 124         // Do we have cache?
 125         if (isExtensionFunctionFileReadable($ext_name)) {
 126                 // Not yet loaded?
 127                 if ((($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y') || (!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name]))) && (!isExtensionLibraryLoaded($ext_name))) {
 128                         // Construct IFN for functions file
 129                         $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
 130
 131                         // Mark it as loaded
 132                         markExtensionLibraryAsLoaded($ext_name);
 133
 134                         // Download functions file
 135                         loadIncludeOnce($funcsInclude);
 136                 } // END - if
 137         } elseif ((!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) && (isDebugModeEnabled()) && (isHtmlOutputMode()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme') && (getExtensionMode() == 'test')) {
 138                 // No functions file is not so good...
 139                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("NOTICE: Extension %s has no own functions file or we cannot read from it. mode=%s",
 140                         $ext_name,
 141                         getExtensionMode()
 142                 ));
 143         }
 144
 145         // Load extension's filter library if present
 146         loadExtensionFilters($ext_name);
 147
 148         // Extensions are not deprecated by default
 149         setExtensionDeprecated('N');
 150
 151         // Extensions are not always active by default
 152         setExtensionAlwaysActive('N');
 153
 154         // Extension update notes
 155         // @TODO Do we still need this? setExtensionUpdateNotes('');
 156
 157         // Include the extension file
 158         loadCurrentExtensionInclude();
 159
 160         // Is this extension deprecated?
 161         if (isExtensionDeprecated()) {
 162                 // Deactivate the extension
 163                 doDeactivateExtension($ext_name);
 164
 165                 // Abort here
 166                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension load aborted, ext_name=' . $ext_name);
 167                 return false;
 168         } // END - if
 169
 170         // Mark it as loaded in normal mode
 171         if (getExtensionMode() == '') {
 172                 // Mark it now...
 173                 markExtensionAsLoaded($ext_name);
 174         } // END - if
 175
 176         // All fine!
 177         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension successfully loaded, ext_name=' . $ext_name);
 178         return true;
 179 }
 180
 181 // Registers an extension and possible update dependencies
 182 function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates = false) {
 183         // Set current extension name
 184         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . $taskId . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
 185         setCurrentExtensionName($ext_name);
 186
 187         // Enable dry-run
 188         enableExtensionDryRun($dry_run);
 189
 190         // By default all extensions are in productive phase
 191         enableExtensionProductive();
 192
 193         // This shall never do a non-admin user or if the extension is active (already installed)
 194         if ((!isAdmin()) || (isExtensionInstalled($ext_name))) {
 195                 // Abort here with 'false'
 196                 return false;
 197         } // END - if
 198
 199         // When this extension is already in registration/update phase, all is fine
 200         if ((isExtensionRegistrationRunning($ext_name)) || ((isExtensionUpdateRunning($ext_name)) && ($ignoreUpdates === false))) {
 201                 // Then abort here with 'true' becaus it is fine
 202                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine.');
 203                 ///* BUG: */ debug_report_bug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . $taskId . ',dry_run=' . intval($dry_run) . ' - Please investigate!');
 204                 return true;
 205         } // END - if
 206
 207         // This registration is running
 208         addExtensionRunningRegistration($ext_name);
 209
 210         // Init EXT_UPDATE_DEPENDS if not yet done
 211         if (!isExtensionUpdateDependenciesInitialized()) {
 212                 // Init here...
 213                 initExtensionUpdateDependencies();
 214         } // END - if
 215
 216         // Is the task id zero? Then we need to auto-fix it here
 217         if ($taskId == '0') {
 218                 // Try to find the task
 219                 $taskId = determineExtensionTaskId(getCurrentExtensionName());
 220
 221                 // Still zero and not in dry-run?
 222                 if (($taskId == '0') && (!isExtensionDryRun())) {
 223                         // Now try to create a new task
 224                         $taskId = createNewExtensionTask(getCurrentExtensionName());
 225
 226                         // Is it still zero?
 227                         if ($taskId == '0') {
 228                                 // Then request a bug report
 229                                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId(%s)",
 230                                         __FUNCTION__,
 231                                         getCurrentExtensionName()
 232                                 ));
 233                         } // END - if
 234                 } // END - if
 235         } // END - if
 236
 237         // Init queries and notes
 238         initExtensionSqls();
 239         initExtensionNotes();
 240
 241         // Init variables
 242         $ret = false;
 243         $processResult = false;
 244         initIncludePool('extension');
 245
 246         // By default we have no failures
 247         enableExtensionReportingFailure();
 248
 249         // Does this extension exists?
 250         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
 251         if (loadExtension(getCurrentExtensionName(), 'register', '0.0.0', isExtensionDryRun())) {
 252                 // Set current extension name again
 253                 setCurrentExtensionName($ext_name);
 254
 255                 // And run possible updates
 256                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
 257                 $history = getExtensionVersionHistory();
 258                 foreach ($history as $ext_ver) {
 259                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $ext_ver);
 260                         // Load extension in update mode
 261                         loadExtension(getCurrentExtensionName(), 'update', $ext_ver, isExtensionDryRun());
 262
 263                         // Add update notes to our output
 264                         addExtensionNotes($ext_ver);
 265                 } // END - foreach
 266
 267                 // Does this extension depends on an outstanding update of another update?
 268                 for ($dmy = getExtensionUpdateIterator(); getExtensionUpdateIterator() < countExtensionUpdateDependencies();) {
 269                         // Get next update
 270                         $ext_update = getExtensionUpdateDependenciesIterator();
 271
 272                         // Increment here to avoid endless loop
 273                         incrementExtensionUpdateIterator();
 274
 275                         // Check if extension is not installed and not already in registration procedure and if loading it wents finally fine...
 276                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isExtensionRegistrationRunning(' . $ext_update . ')=' . intval(isExtensionRegistrationRunning($ext_update)));
 277                         if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', isExtensionDryRun()))) {
 278                                 // Set current extension name again
 279                                 setCurrentExtensionName($ext_name);
 280
 281                                 // If versions mismatch update extension first
 282                                 $ext_ver = '';
 283                                 if (isExtensionInstalled($ext_update)) {
 284                                         // Get version only if installed
 285                                         $ext_ver = getExtensionVersion($ext_update);
 286                                 } // END - if
 287
 288                                 // Extension version set? If empty the extension is not registered
 289                                 if (empty($ext_ver)) {
 290                                         // Extension not registered so far so first load task's id...
 291                                         $taskId = determineExtensionTaskId($ext_update);
 292
 293                                         // Entry found?
 294                                         if ($taskId > 0) {
 295                                                 // Try to register the extension
 296                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',taskId=' . $taskId . ',isExtensionDryRun()=' . isExtensionDryRun());
 297                                                 $processResult = registerExtension($ext_update, $taskId, isExtensionDryRun(), true);
 298
 299                                                 // Reset extension name
 300                                                 setCurrentExtensionName($ext_name);
 301                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',processResult=' . intval($processResult));
 302                                         } // END - if
 303                                 } elseif ($ext_ver != getCurrentExtensionVersion()) {
 304                                         // Ok, update this extension now
 305                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
 306                                         $GLOBALS['ext_backup_name'][$ext_update][$ext_ver] = getCurrentExtensionName();
 307                                         $GLOBALS['ext_backup_ver'][$ext_update][$ext_ver] = getCurrentExtensionVersion();
 308                                         updateExtension($ext_update, $ext_ver, isExtensionDryRun());
 309                                         setCurrentExtensionName($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]);
 310                                         setCurrentExtensionVersion($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]);
 311                                         unset($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]);
 312                                         unset($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]);
 313                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
 314
 315                                         // All okay!
 316                                         $processResult = true;
 317                                 } else {
 318                                         // Nothing to register / update before...
 319                                         $processResult = true;
 320                                 }
 321                         } else {
 322                                 // Required file for update does not exists!
 323                                 $processResult = true;
 324                                 // But this is fine for the first time...
 325                         }
 326
 327                         // Restore the current extension name
 328                         setCurrentExtensionName($ext_name);
 329                 } // END - for
 330
 331                 // Is there no update?
 332                 if (countExtensionUpdateDependencies(getCurrentExtensionName()) == 0) {
 333                         // Then test is passed!
 334                         $processResult = true;
 335                 } // END - if
 336
 337                 // Switch back to register mode
 338                 setExtensionMode('register');
 339
 340                 // Remains true if extension registration reports no failures
 341                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult));
 342                 $processResult = (($processResult === true) && (isExtensionReportingFailure() === false));
 343                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult));
 344
 345                 // Does everthing before wents ok?
 346                 if ($processResult === true) {
 347                         // "Dry-run-mode" activated?
 348                         if ((isExtensionDryRun() === false) && (!isExtensionOnRemovalList())) {
 349                                 // Init SQLs and transfer ext->generic
 350                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName());
 351                                 initSqls();
 352                                 setSqlsArray(getExtensionSqls());
 353
 354                                 // Run installation pre-installation filters
 355                                 runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false));
 356
 357                                 // Register extension
 358                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!');
 359                                 if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) {
 360                                         // New way, with CSS
 361                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss());
 362                                         SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`,`ext_has_css`) VALUES ('%s','%s','%s','%s')",
 363                                                 array(
 364                                                         getCurrentExtensionName(),
 365                                                         getThisExtensionAlwaysActive(),
 366                                                         getCurrentExtensionVersion(),
 367                                                         getExtensionHasCss()
 368                                                 ), __FUNCTION__, __LINE__);
 369                                 } else {
 370                                         // Old way, no CSS
 371                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion());
 372                                         SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`) VALUES ('%s','%s','%s')",
 373                                                 array(
 374                                                         getCurrentExtensionName(),
 375                                                         getThisExtensionAlwaysActive(),
 376                                                         getCurrentExtensionVersion()
 377                                                 ), __FUNCTION__, __LINE__);
 378                                 }
 379
 380                                 // Use the insert id as extension id and cache it for early usage
 381                                 $GLOBALS['cache_array']['extension']['ext_id'][getCurrentExtensionName()] = SQL_INSERTID();
 382                                 $GLOBALS['cache_array']['extension']['ext_name'][SQL_INSERTID()] = getCurrentExtensionName();
 383
 384                                 // Mark it as installed
 385                                 $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true;
 386
 387                                 // Remove cache file(s) if extension is active
 388                                 runFilterChain('post_extension_installed', array(
 389                                         'pool'     => 'extension',
 390                                         'ext_name' => getCurrentExtensionName(),
 391                                         'task_id'  => $taskId
 392                                 ));
 393
 394                                 // Re-init queries and notes
 395                                 initExtensionSqls(true);
 396                                 initExtensionNotes(true);
 397
 398                                 // In normal mode return a true on success
 399                                 $ret = true;
 400                         } elseif (isExtensionDryRun() === true) {
 401                                 // In  "dry-run" mode do always return a true
 402                                 $ret = true;
 403                         } else {
 404                                 // Extension has been removed for updates, so all is fine!
 405                                 $ret = true;
 406                         }
 407                 } else {
 408                         // No, an error occurs while registering extension :-(
 409                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
 410                         $ret = false;
 411                 }
 412         } elseif (($taskId > 0) && (getCurrentExtensionName() != '')) {
 413                 // Remove task from system when id and extension's name is valid
 414                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
 415                 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `status`='NEW' LIMIT 1",
 416                         array(bigintval($taskId)), __FUNCTION__, __LINE__);
 417         }
 418
 419         // Return status code
 420         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',processResult=' . intval($processResult) . ' - EXIT!');
 421         return $ret;
 422 }
 423
 424 // Run SQL queries for given extension id
 425 // @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
 426 function doExtensionSqls ($ext_id, $load_mode) {
 427         // This shall never do a non-admin user!
 428         if (!isAdmin()) {
 429                 return false;
 430         } // END - if
 431
 432         // Get extension's name
 433         $ext_name = getExtensionName($ext_id);
 434
 435         // Set current SQL name
 436         setCurrentExtensionName($ext_name);
 437
 438         // Init EXT_UPDATE_DEPENDS
 439         if (!isExtensionUpdateDependenciesInitialized()) {
 440                 // Init here...
 441                 initExtensionUpdateDependencies();
 442         } // END - if
 443
 444         // Init array
 445         initExtensionSqls(true);
 446
 447         // By default no SQL has been executed
 448         $sqlRan = false;
 449
 450         // Load extension in detected mode
 451         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name[' . $ext_id . ']=' . getCurrentExtensionName() . ',load_mode=' . $load_mode);
 452         loadExtension(getCurrentExtensionName(), $load_mode, '0.0.0', false);
 453
 454         // Init these SQLs
 455         initSqls();
 456         setSqlsArray(getExtensionSqls());
 457
 458         // Debug message
 459         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls());
 460
 461         // Do we have entries?
 462         if (isSqlsValid()) {
 463                 // Run SQL commands...
 464                 runFilterChain('run_sqls');
 465         } // END - if
 466
 467         // Run any filters depending on the action here
 468         runFilterChain('extension_' . $load_mode);
 469
 470         // Remove cache file(s) if extension is active
 471         if (((isExtensionActive('cache')) && ((!SQL_HASZEROAFFECTED())) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate'))) {
 472                 // Run filters
 473                 runFilterChain('post_extension_run_sql', getCurrentExtensionName());
 474         } // END - if
 475
 476         // Is this the sql_patches?
 477         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $ext_id . ',currName=' . getCurrentExtensionName() . ',loadMode=' . $load_mode);
 478         if ((getCurrentExtensionName() == 'sql_patches') && (($load_mode == 'register') || ($load_mode == 'remove'))) {
 479                 // Then redirect to logout
 480                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ': LOAD!');
 481                 redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $load_mode . '=sql_patches');
 482         } // END - if
 483 }
 484
 485 // Check wether the given extension is installed
 486 function isExtensionInstalled ($ext_name) {
 487         // We don't like empty extension names here
 488         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
 489         if (empty($ext_name)) {
 490                 // Please fix them all
 491                 debug_report_bug(__FUNCTION__, __LINE__, 'ext_name is empty.');
 492         } // END - if
 493
 494         // By default non is installed
 495         $isInstalled = false;
 496
 497         // Check if there is a cache entry
 498         if (isset($GLOBALS['ext_is_installed'][$ext_name])) {
 499                 // Use cache built from below queries
 500                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - CACHE!');
 501                 $isInstalled = $GLOBALS['ext_is_installed'][$ext_name];
 502         } elseif (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
 503                 // Found!
 504                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - FOUND!');
 505                 $isInstalled = true;
 506
 507                 // Count cache hits
 508                 incrementStatsEntry('cache_hits');
 509         } elseif ((isInstallationPhase())) {
 510                 // Extensions are all inactive/not installed during installation
 511                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - installion phase');
 512         } else {
 513                 // Look in database
 514                 $ext_id = getExtensionId($ext_name);
 515
 516                 // Do we have a record?
 517                 $isInstalled = ($ext_id > 0);
 518
 519                 // Log debug message
 520                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_id=' . $ext_id . ',isInstalled=' . intval($isInstalled));
 521
 522                 // Is it installed, then cache the entry
 523                 if ($isInstalled === true) {
 524                         // Dummy call (get is okay here)
 525                         getExtensionId($ext_name, true);
 526                 } // END - if
 527
 528                 // Remember the status
 529                 $GLOBALS['ext_is_installed'][$ext_name] = $isInstalled;
 530         }
 531
 532         // Return status
 533         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isInstalled=' . intval($isInstalled) . ' - EXIT!');
 534         return $isInstalled;
 535 }
 536
 537 // Check if given extension is active
 538 function isExtensionActive ($ext_name) {
 539         if (isInstallationPhase()) {
 540                 // Extensions are all inactive during installation
 541                 return false;
 542         } elseif (empty($ext_name)) {
 543                 // Empty extension names must befixed
 544                 debug_report_bug(__FUNCTION__, __LINE__, 'Empty extension name provided.');
 545         } elseif (!isExtensionInstalled($ext_name)) {
 546                 // Not installed extensions are always inactive
 547                 return false;
 548         }
 549
 550         // Not active is the default
 551         $data['ext_active'] = 'N';
 552
 553         // Check cache
 554         if (isset($GLOBALS['cache_array']['extension']['ext_active'][$ext_name])) {
 555                 // Load from cache
 556                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE! ext_name=' . $ext_name);
 557                 $data['ext_active'] = $GLOBALS['cache_array']['extension']['ext_active'][$ext_name];
 558
 559                 // Count cache hits
 560                 incrementStatsEntry('cache_hits');
 561         } elseif (isExtensionLoaded($ext_name)) {
 562                 // @TODO Extension is loaded, what next?
 563                 debug_report_bug(__FUNCTION__, __LINE__, 'LOADED:' . $ext_name);
 564         } elseif (($ext_name == 'cache') || (!isExtensionInstalled('cache'))) {
 565                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DB! ext_name=' . $ext_name);
 566                 // Load from database
 567                 $result = SQL_QUERY_ESC("SELECT `ext_active` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
 568                         array($ext_name), __FUNCTION__, __LINE__);
 569
 570                 // Entry found?
 571                 if (SQL_NUMROWS($result) == 1) {
 572                         // Load entry
 573                         $data = SQL_FETCHARRAY($result);
 574                 } // END - if
 575
 576                 // Free result
 577                 SQL_FREERESULT($result);
 578
 579                 // Write cache array
 580                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . '[DB]: ' . $data['ext_active']);
 581                 $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = $data['ext_active'];
 582         } else {
 583                 // Extension not active!
 584                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': Not active!');
 585                 $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = 'N';
 586         }
 587
 588         // Debug message
 589         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',active=' . $data['ext_active']);
 590
 591         // Is this extension activated? (For admins we always have active extensions...)
 592         return ($data['ext_active'] == 'Y');
 593 }
 594
 595 // Get version from extensions
 596 function getExtensionVersion ($ext_name, $force = false) {
 597         // By default no extension is found
 598         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
 599         $data['ext_version'] = 'false';
 600
 601         // Empty extension name should be fixed!
 602         if (empty($ext_name)) {
 603                 // Please report this bug!
 604                 debug_report_bug(__FUNCTION__, __LINE__, 'ext_name is empty which is not allowed here.');
 605         } // END - if
 606
 607         // Extensions are all inactive during installation
 608         if (isInstallationPhase()) {
 609                 return '';
 610         } // END - if
 611
 612         // Is the cache written?
 613         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - Checking cache ...');
 614         if (isset($GLOBALS['cache_array']['extension']['ext_version'][$ext_name])) {
 615                 // Load data from cache
 616                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': CACHE!');
 617                 $data['ext_version'] = $GLOBALS['cache_array']['extension']['ext_version'][$ext_name];
 618
 619                 // Count cache hits
 620                 incrementStatsEntry('cache_hits');
 621         } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (!isHtmlOutputMode())) {
 622                 // Load from database
 623                 $result = SQL_QUERY_ESC("SELECT `ext_version` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
 624                         array($ext_name), __FUNCTION__, __LINE__);
 625                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': DB - '.SQL_NUMROWS($result).'');
 626
 627                 // Is the extension there?
 628                 if (SQL_NUMROWS($result) == 1) {
 629                         // Load entry
 630                         $data = SQL_FETCHARRAY($result);
 631
 632                         // Set cache
 633                         $GLOBALS['cache_array']['extension']['ext_version'][$ext_name] = $data['ext_version'];
 634                 } elseif (isDebugModeEnabled()) {
 635                         // Not found, may happen while an extension is uninstalled
 636                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot find extension %s in database!", $ext_name));
 637                 }
 638
 639                 // Free result
 640                 SQL_FREERESULT($result);
 641         }
 642
 643         // Extension version should not be invalid
 644         if (($data['ext_version'] == 'false') && ($force === false)) {
 645                 // Please report this trouble
 646                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> has empty version!", $ext_name));
 647         } // END - if
 648
 649         // Return result
 650         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_version=' . $data['ext_version']);
 651         return $data['ext_version'];
 652 }
 653
 654 // Updates a given extension with current extension version to latest version
 655 function updateExtension ($ext_name, $ext_ver, $dry_run = false) {
 656         // Only admins are allowed to update extensions
 657         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
 658         if ((!isAdmin()) || (empty($ext_name))) {
 659                 // Called as non-admin or empty extension
 660                 debug_report_bug(__FUNCTION__, __LINE__, 'Called as non-admin (isAdmin()=' . intval(isAdmin()) . '), or empty extension name. ext_name=' . $ext_name);
 661         } // END - if
 662
 663         // Set current SQL name
 664         setCurrentExtensionName($ext_name);
 665
 666         // Is this extension update already running?
 667         if (isExtensionUpdateRunning($ext_name)) {
 668                 // This is fine but needs logging ATM
 669                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, all fine.');
 670                 return true;
 671         } // END - if
 672
 673         // Init arrays
 674         initExtensionSqls();
 675         initExtensionNotes();
 676         initIncludePool('extension');
 677
 678         // Load extension in test mode
 679         loadExtension($ext_name, 'test', $ext_ver, isExtensionDryRun());
 680
 681         // Save version history
 682         $history = getExtensionVersionHistory();
 683
 684         // Remove old SQLs array to prevent possible bugs
 685         initExtensionSqls();
 686
 687         // Check if version is updated
 688         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, getCurrentExtensionName() . '/' . $ext_name . ':' . getThisExtensionVersion() . '/' . $ext_ver . '/' . intval(is_array($history)));
 689         if (((getThisExtensionVersion() != $ext_ver) || (isExtensionDryRun())) && (is_array($history))) {
 690                 // Search for starting point (-1 for making 0.0 -> 0.0.0 switch work)
 691                 $start = -1;
 692                 if ($ext_ver != '0.0') {
 693                         $start = array_search($ext_ver, $history);
 694                 } // END - if
 695
 696                 // And load SQL queries in order of version history
 697                 for ($idx = ($start + 1); $idx < count($history); $idx++) {
 698                         // Set extension version
 699                         $GLOBALS['update_ver'][getCurrentExtensionName()] = $history[$idx];
 700
 701                         // Load again...
 702                         loadExtension(getCurrentExtensionName(), 'update', $GLOBALS['update_ver'][getCurrentExtensionName()], isExtensionDryRun());
 703
 704                         // Get all depencies
 705                         $depencies = getExtensionUpdateDependencies();
 706
 707                         // Nothing to apply?
 708                         if (count($depencies) > 0) {
 709                                 // Apply all extension depencies
 710                                 foreach ($depencies as $ext_depend) {
 711                                         // Did we already update/register this?
 712                                         if (!isset($GLOBALS['ext_updated'][$ext_depend])) {
 713                                                 // Set it as current
 714                                                 setCurrentExtensionName($ext_depend);
 715
 716                                                 // Mark it as already updated before we update it
 717                                                 $GLOBALS['ext_updated'][$ext_depend] = true;
 718
 719                                                 // Is the extension there?
 720                                                 if (isExtensionInstalled($ext_depend)) {
 721                                                         // Update another extension first!
 722                                                         $processResult = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun());
 723                                                 } else {
 724                                                         // Register new extension
 725                                                         $processResult = registerExtension($ext_depend, 0, isExtensionDryRun());
 726                                                 }
 727                                         } // END - if
 728                                 } // END - foreach
 729
 730                                 // Set extension version here
 731                                 setCurrentExtensionVersion($ext_ver);
 732
 733                                 // Set name back
 734                                 setCurrentExtensionName($ext_name);
 735                         } // END - if
 736
 737                         // Add notes
 738                         addExtensionNotes($history[$idx]);
 739                 } // END - for
 740
 741                 // In real-mode execute any existing includes
 742                 if (isExtensionDryRun() === false) {
 743                         $GLOBALS['ext_inc_pool'][getCurrentExtensionName()] = getIncludePool('extension');
 744                         runFilterChain('load_includes', 'extension');
 745                         setIncludePool('extension', $GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
 746                         unset($GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
 747                 } // END - if
 748
 749                 // Init these SQLs
 750                 initSqls();
 751                 setSqlsArray(getExtensionSqls());
 752
 753                 // Run SQLs
 754                 runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false));
 755
 756                 if (isExtensionDryRun() === false) {
 757                         // Run filters on success extension update
 758                         runFilterChain('extension_update', getCurrentExtensionName());
 759                 } // END - if
 760         } // END - if
 761
 762         //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ' - EXIT!');
 763 }
 764
 765 // Output verbose SQL table for extension
 766 function addExtensionVerboseSqlTable ($title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVAL--}', $dashed = '', $switch = false, $width = '100%') {
 767         // Empty title?
 768         if (empty($title)) {
 769                 // Then abort here
 770                 debug_report_bug(__FUNCTION__, __LINE__, 'title is empty.');
 771         } // END - if
 772
 773         // Init variables
 774         $OUT = '';
 775
 776         // Do we have queries?
 777         if (isVerboseSqlEnabled()) {
 778                 // Do we have entries?
 779                 if (countExtensionSqls() > 0) {
 780                         // Init counter
 781                         $idx = 0;
 782                         // Get all SQLs
 783                         foreach (getExtensionSqls() as $sqls) {
 784                                 // New array format is recursive
 785                                 foreach ($sqls as $sql) {
 786                                         // Trim out spaces
 787                                         $sql = trim($sql);
 788
 789                                         // Output command if set
 790                                         if (!empty($sql)) {
 791                                                 // Prepare output for template
 792                                                 $content = array(
 793                                                         'i'   => ($idx + 1),
 794                                                         'sql' => str_replace('{', '&#123;', str_replace('}', '&#125;', encodeEntities($sql)))
 795                                                 );
 796
 797                                                 // Load row template
 798                                                 $OUT .= loadTemplate('admin_extension_sql_row', true, $content);
 799
 800                                                 // Count up
 801                                                 $idx++;
 802                                         } // END - if
 803                                 } // END - foreach
 804                         } // END - foreach
 805
 806                         // Prepare content for template
 807                         $content = array(
 808                                 'width'  => $width,
 809                                 'dashed' => $dashed,
 810                                 'title'  => $title,
 811                                 'rows'   => $OUT
 812                         );
 813
 814                         // Load main template
 815                         $OUT = loadTemplate('admin_extension_sql_table', true, $content);
 816                 } else {
 817                         // No addional SQL commands to run
 818                         $OUT = displayMessage('{--ADMIN_NO_ADDITIONAL_SQLS--}', true);
 819                 }
 820         } // END - if
 821
 822         // Return output
 823         return $OUT;
 824 }
 825
 826 // Get extension name from id
 827 function getExtensionName ($ext_id) {
 828         // Init extension name
 829         $data['ext_name'] = '';
 830
 831         // Is cache there?
 832         if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
 833                 // Load from cache
 834                 $data['ext_name'] = $GLOBALS['cache_array']['extension']['ext_name'][$ext_id];
 835
 836                 // Count cache hits
 837                 incrementStatsEntry('cache_hits');
 838         } elseif (!isExtensionActive('cache')) {
 839                 // Load from database
 840                 $result = SQL_QUERY_ESC("SELECT `ext_name` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `id`=%s LIMIT 1",
 841                         array(bigintval($ext_id)), __FUNCTION__, __LINE__);
 842
 843                 // Is the entry there?
 844                 if (SQL_NUMROWS($result) == 1) {
 845                         // Get the extension's name from database
 846                         $data = SQL_FETCHARRAY($result);
 847                 } // END - if
 848
 849                 // Free result
 850                 SQL_FREERESULT($result);
 851         }
 852
 853         // Did we find some extension?
 854         if (empty($data['ext_name'])) {
 855                 // We should fix these all!
 856                 debug_report_bug(__FUNCTION__, __LINE__, 'ext_name is empty. ext_id=' . $ext_id);
 857         } // END - if
 858
 859         // Return the extension name
 860         return $data['ext_name'];
 861 }
 862
 863 // Get extension id from name
 864 function getExtensionId ($ext_name) {
 865         // Init id number
 866         $data['ext_id'] = '0';
 867
 868         // Do we have cache?
 869         if (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
 870                 // Load from cache
 871                 $data['ext_id'] = $GLOBALS['cache_array']['extension']['ext_id'][$ext_name];
 872
 873                 // Count cache hits
 874                 incrementStatsEntry('cache_hits');
 875         } else {
 876                 // Load from database
 877                 $result = SQL_QUERY_ESC("SELECT `id` AS `ext_id` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
 878                         array($ext_name), __FUNCTION__, __LINE__);
 879
 880                 // Is the entry there?
 881                 if (SQL_NUMROWS($result) == 1) {
 882                         // Get the extension's id from database
 883                         $data = SQL_FETCHARRAY($result);
 884                 } // END - if
 885
 886                 // Free result
 887                 SQL_FREERESULT($result);
 888
 889                 // Cache it
 890                 $GLOBALS['cache_array']['extension']['ext_id'][$ext_name] = $data['ext_id'];
 891         }
 892
 893         // Return value
 894         return $data['ext_id'];
 895 }
 896
 897 // Determines wether the given extension name is valid
 898 function isExtensionNameValid ($ext_name) {
 899         // Do we have cache?
 900         if (!isset($GLOBALS['ext_name_valid'][$ext_name])) {
 901                 // Generate include file name
 902                 $INC = sprintf("inc/extensions/ext-%s.php", $ext_name);
 903
 904                 // Is there a file in inc/extensions/ ?
 905                 $GLOBALS['ext_name_valid'][$ext_name] = isIncludeReadable($INC);
 906         } // END - if
 907
 908         // Return result
 909         return $GLOBALS['ext_name_valid'][$ext_name];
 910 }
 911
 912 // Determines wether the given extension id is valid
 913 function isExtensionIdValid ($ext_id) {
 914         // Default is nothing valid
 915         $isValid = false;
 916
 917         // Check in cache then in database
 918         if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
 919                 // Valid!
 920                 $isValid = true;
 921
 922                 // Count cache hits
 923                 incrementStatsEntry('cache_hits');
 924         } else {
 925                 // Query database
 926                 $isValid = (countSumTotalData($ext_id, 'extensions', 'id', 'id', true) == 1);
 927         }
 928
 929         // Return result
 930         return $isValid;
 931 }
 932
 933 // Activate given extension
 934 function doActivateExtension ($ext_name) {
 935         // Is the extension installed?
 936         if (!isExtensionInstalled($ext_name)) {
 937                 // Non-installed extensions cannot be activated
 938                 debug_report_bug(__FUNCTION__, __LINE__, 'Tried to activate non-installed extension ' . $ext_name);
 939         } // END - if
 940
 941         // Activate the extension
 942         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='Y' WHERE `ext_name`='%s' LIMIT 1",
 943                 array($ext_name), __FUNCTION__, __LINE__);
 944
 945         // Then run all queries
 946         doExtensionSqls(getExtensionId($ext_name), 'activate');
 947 }
 948
 949 // Deactivate given extension
 950 function doDeactivateExtension ($ext_name) {
 951         // Is the extension installed?
 952         if (!isExtensionInstalled($ext_name)) {
 953                 // Non-installed extensions cannot be activated
 954                 debug_report_bug(__FUNCTION__, __LINE__, 'Tried to deactivate non-installed extension ' . $ext_name);
 955         } // END - if
 956
 957         // Activate the extension
 958         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='N' WHERE `ext_name`='%s' LIMIT 1",
 959                 array($ext_name), __FUNCTION__, __LINE__);
 960
 961         // Then run all queries
 962         doExtensionSqls(getExtensionId($ext_name), 'deactivate');
 963
 964         // Create new task (we ignore the task id here)
 965         createExtensionDeactivationTask($ext_name);
 966
 967         // Notify the admin
 968         sendAdminNotification(
 969                 '{--ADMIN_EXTENSION_DEACTIVATED_SUBJECT--}',
 970                 'admin_extension_deactivated',
 971                 array('ext_name' => $ext_name)
 972         );
 973 }
 974
 975 // Checks wether the extension is older than given
 976 function isExtensionOlder ($ext_name, $ext_ver) {
 977         // Get current extension version
 978         $currVersion = getExtensionVersion($ext_name);
 979
 980         // Remove all dots from both versions
 981         $currVersion = str_replace('.', '', $currVersion);
 982         $ext_ver = str_replace('.', '', $ext_ver);
 983
 984         // Now compare both and return the result
 985         return ($currVersion < $ext_ver);
 986 }
 987
 988 // Creates a new task for updated extension
 989 function createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) {
 990         // Create subject line
 991         $subject = '[UPDATE-' . $ext_name . '-' . $ext_ver . ':] {--ADMIN_UPDATE_EXTENSION_SUBJECT--}';
 992
 993         // Get task id
 994         $taskId = determineTaskIdBySubject($subject);
 995
 996         // Is the extension there?
 997         if (isExtensionInstalled($ext_name)) {
 998                 // Check if task is not there
 999                 if ($taskId == '0') {
1000                         // Create extension update-task
1001                         $taskId = createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId);
1002                 } // END - if
1003         } else {
1004                 // Extension not there! :-(
1005                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> not found but should be updated?", $ext_name));
1006         }
1007
1008         // Return task id
1009         return $taskId;
1010 }
1011
1012 // Creates a new task for newly installed extension
1013 function createNewExtensionTask ($ext_name) {
1014         // Generate subject line
1015         $subject = sprintf("[%s:]", $ext_name);
1016
1017         // Get task id
1018         $taskId = determineTaskIdBySubject($subject);
1019
1020         // Not installed and do we have created a task for the admin?
1021         if (($taskId == '0') && (!isExtensionInstalled($ext_name))) {
1022                 // Set default message if ext-foo is missing
1023                 $message = '{%message,ADMIN_EXTENSION_TEXT_FILE_MISSING=' . $ext_name . '%}';
1024
1025                 // Template file
1026                 $FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
1027                         getPath(),
1028                         getLanguage(),
1029                         $ext_name
1030                 );
1031
1032                 // Load text for task if found
1033                 if (isFileReadable($FQFN)) {
1034                         // Load extension's description template (but do not compile the code)
1035                         $message = loadTemplate('ext_' . $ext_name, true, array(), false);
1036                 } else {
1037                         // Write this in debug.log as well
1038                         logDebugMessage(__FUNCTION__, __LINE__, $message);
1039                 }
1040
1041                 // Task not created so it's a brand-new extension which we need to register and create a task for!
1042                 $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), false);
1043         } // END - if
1044
1045         // Return task id
1046         return $taskId;
1047 }
1048
1049 // Creates a task for automatically deactivated (deprecated) extension
1050 function createExtensionDeactivationTask ($ext_name) {
1051         // Create subject line
1052         $subject = sprintf("[%s:] %s", $ext_name, '{--ADMIN_TASK_EXTENSION_DEACTIVATED_SUBJECT--}');
1053
1054         // Get task id
1055         $taskId = determineTaskIdBySubject($subject);
1056
1057         // Not installed and do we have created a task for the admin?
1058         if (($taskId == '0') && (isExtensionInstalled($ext_name))) {
1059                 // Task not created so add it
1060                 $taskId = createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', true, $ext_name)), 'EXTENSION_DEACTIVATION');
1061         } // END - if
1062
1063         // Return task id
1064         return $taskId;
1065 }
1066
1067 // Determines the task id for given extension
1068 function determineExtensionTaskId ($ext_name) {
1069         // Default is not found
1070         $data['task_id'] = '0';
1071
1072         // Search for extension task's id
1073         $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
1074                 array($ext_name), __FUNCTION__, __LINE__);
1075
1076         // Entry found?
1077         if (SQL_NUMROWS($result) == 1) {
1078                 // Task found so load task's id and register extension...
1079                 $data = SQL_FETCHARRAY($result);
1080         } // END - if
1081
1082         // Free result
1083         SQL_FREERESULT($result);
1084
1085         // Return it
1086         return $data['task_id'];
1087 }
1088
1089 // Determines the task id for given subject
1090 function determineTaskIdBySubject ($subject) {
1091         // Default is not found
1092         $data['task_id'] = '0';
1093
1094         // Search for task id
1095         $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
1096                 array($subject), __FUNCTION__, __LINE__);
1097
1098         // Entry found?
1099         if (SQL_NUMROWS($result) == 1) {
1100                 // Task found so load task's id and register extension...
1101                 $data = SQL_FETCHARRAY($result);
1102         } // END - if
1103
1104         // Free result
1105         SQL_FREERESULT($result);
1106
1107         // Return it
1108         return $data['task_id'];
1109 }
1110
1111 // Add updates notes for given version
1112 function addExtensionNotes ($ext_ver) {
1113         // Init notes/content
1114         $out = '';
1115         $content = array();
1116
1117         // Is do we have verbose output enabled?
1118         if ((!isExtensionActive('sql_patches')) || (isVerboseSqlEnabled())) {
1119                 // Update notes found?
1120                 if ((isExtensionUpdateNoteSet($ext_ver)) && ($ext_ver != '0.0.0')) {
1121                         // Update notes found
1122                         $content = array(
1123                                 'ver'   => $ext_ver,
1124                                 'notes' => getExtensionUpdateNotes($ext_ver)
1125                         );
1126
1127                         // Reset them
1128                         setExtensionUpdateNotes('', $ext_ver);
1129                 } elseif ($ext_ver == '0.0.0') {
1130                         // Is the extension productive?
1131                         if (isExtensionProductive(getCurrentExtensionName())) {
1132                                 // Initial release
1133                                 $content = array(
1134                                         'ver'   => $ext_ver,
1135                                         'notes' => '{--INITIAL_RELEASE--}'
1136                                 );
1137                         } else {
1138                                 // Not productive
1139                                 $content = array(
1140                                         'ver'   => $ext_ver,
1141                                         'notes' => '{--DEVELOPER_RELEASE--}'
1142                                 );
1143                         }
1144                 } else {
1145                         // No update notes found
1146                         $content = array(
1147                                 'ver'   => $ext_ver,
1148                                 'notes' => '{--NO_UPDATE_NOTES--}'
1149                         );
1150                 }
1151
1152                 // Load template
1153                 $out = loadTemplate('admin_extension_notes', true, $content);
1154         } // END - if
1155
1156         // Add the notes
1157         appendExtensionNotes($out);
1158 }
1159
1160 // Getter for CSS files array
1161 function getExtensionCssFiles () {
1162         // By default no additional CSS files are found
1163         $cssFiles = array();
1164
1165         // Is the array there?
1166         if (isset($GLOBALS['css_files'])) {
1167                 // Then use it
1168                 $cssFiles = $GLOBALS['css_files'];
1169         } // END - if
1170
1171         // Return array
1172         return $cssFiles;
1173 }
1174
1175 // Init CSS files array
1176 function initExtensionCssFiles () {
1177         // Simply init it
1178         $GLOBALS['css_files'] = array();
1179 }
1180
1181 // Add new entry
1182 function addExtensionCssFile ($file) {
1183         // Is the array there?
1184         if (!isset($GLOBALS['css_files'])) {
1185                 // Then auto-init them
1186                 initExtensionCssFiles();
1187         } // END - if
1188
1189         // Add the entry
1190         $GLOBALS['css_files'][] = $file;
1191 }
1192
1193 // Setter for EXT_ALWAYS_ACTIVE flag
1194 function setExtensionAlwaysActive ($active) {
1195         $GLOBALS['ext_always_active'][getCurrentExtensionName()] = (string) $active;
1196 }
1197
1198 // Getter for EXT_ALWAYS_ACTIVE flag
1199 function getThisExtensionAlwaysActive () {
1200         return $GLOBALS['ext_always_active'][getCurrentExtensionName()];
1201 }
1202
1203 // Checks wether the current extension is always active
1204 function isThisExtensionAlwaysActive () {
1205         return (getThisExtensionAlwaysActive() == 'Y');
1206 }
1207
1208 // Setter for EXT_VERSION flag
1209 function setThisExtensionVersion ($ext_version) {
1210         $GLOBALS['ext_version'][getCurrentExtensionName()] = (string) $ext_version;
1211 }
1212
1213 // Getter for EXT_VERSION flag
1214 function getThisExtensionVersion () {
1215         return $GLOBALS['ext_version'][getCurrentExtensionName()];
1216 }
1217
1218 // Setter for EXT_DEPRECATED flag
1219 function setExtensionDeprecated ($deprecated) {
1220         $GLOBALS['ext_deprecated'][getCurrentExtensionName()] = (string) $deprecated;
1221 }
1222
1223 // Getter for EXT_DEPRECATED flag
1224 function isExtensionDeprecated () {
1225         return ($GLOBALS['ext_deprecated'][getCurrentExtensionName()] == 'Y');
1226 }
1227
1228 // Setter for EXT_UPDATE_DEPENDS flag
1229 function addExtensionDependency ($updateDepends) {
1230         // Is the update depency empty? (NEED TO BE FIXED!)
1231         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - ENTERED!');
1232         if (empty($updateDepends)) {
1233                 // Please report this bug!
1234                 debug_report_bug(__FUNCTION__, __LINE__, 'updateDepends is empty: currentExtension=' . getCurrentExtensionName());
1235         } // END - if
1236
1237         // Is it not yet added?
1238         if ((isset($updateDepends, $GLOBALS['ext_running_updates'][getCurrentExtensionName()])) && (in_array($updateDepends, getExtensionUpdatesRunning()))) {
1239                 /*
1240                  * Double-adding happens when the extension and an update of the same
1241                  * extension requires the same other extension again.
1242                  */
1243                 logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
1244                 return;
1245         } // END - if
1246
1247         // Add it to the list of extension update depencies map
1248         $GLOBALS['ext_update_depends'][getCurrentExtensionName()][] = (string) $updateDepends;
1249
1250         // Remember it in the list of running updates
1251         $GLOBALS['ext_running_updates'][getCurrentExtensionName()][] = $updateDepends;
1252         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - EXIT!');
1253 }
1254
1255 // Getter for running updates
1256 function getExtensionUpdatesRunning () {
1257         return $GLOBALS['ext_running_updates'][getCurrentExtensionName()];
1258 }
1259
1260 // Checks wether the given extension registration is in progress
1261 function isExtensionRegistrationRunning ($ext_name) {
1262         // Simply check it
1263         $isRunning = ((isset($GLOBALS['ext_register_running'])) && (in_array($ext_name, $GLOBALS['ext_register_running'])));
1264
1265         // Return it
1266         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ', isRunning=' . intval($isRunning));
1267         return $isRunning;
1268 }
1269
1270 // Init EXT_UPDATE_DEPENDS flag
1271 function initExtensionUpdateDependencies () {
1272         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - ENTERED!');
1273
1274         // Init update depency map automatically if not found
1275         if (isExtensionUpdateDependenciesInitialized()) {
1276                 // We need these bug reports as well...
1277                 debug_report_bug(__FUNCTION__, __LINE__, '() is called twice: currName=' . getCurrentExtensionName());
1278         } // END - if
1279
1280         $GLOBALS['ext_update_depends'][getCurrentExtensionName()] = array();
1281
1282         // Init running updates array
1283         initExtensionRuningUpdates();
1284
1285         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - EXIT!');
1286 }
1287
1288 // Adds an extension as "registration in progress"
1289 function addExtensionRunningRegistration ($ext_name) {
1290         // Is it running?
1291         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - ENTERED!');
1292         if (isExtensionRegistrationRunning($ext_name)) {
1293                 // This is really bad and should not be quietly ignored
1294                 debug_report_bug(__FUNCTION__, __LINE__, '() already called! ext_name=' . $ext_name);
1295         } // END - if
1296
1297         // Then add it!
1298         $GLOBALS['ext_register_running'][] = $ext_name;
1299         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - EXIT!');
1300 }
1301
1302 // Checks wether EXT_UPDATE_DEPENDS is initialized
1303 function isExtensionUpdateDependenciesInitialized () {
1304         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1305         return (isset($GLOBALS['ext_update_depends'][getCurrentExtensionName()]));
1306 }
1307
1308 // Checks wether an update is already running for given extension
1309 function isExtensionUpdateRunning ($ext_name) {
1310         // Current and given extensions means whole array
1311         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ' - ENTERED!');
1312         if ($ext_name == getCurrentExtensionName()) {
1313                 // Default is not found
1314                 $isRunning = false;
1315
1316                 // Walk through whole array
1317                 foreach ($GLOBALS['ext_running_updates'] as $ext1=>$depends) {
1318                         // Is it found?
1319                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',depends=' . print_r($depends, true));
1320                         if (($ext1 == $ext_name) || (in_array($ext_name, $depends))) {
1321                                 // Found
1322                                 $isRunning = true;
1323                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=' . intval($isRunning) . ' - ADDED!');
1324                                 break;
1325                         } // END - if
1326                 } // END - foreach
1327
1328                 // Return result
1329                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ', isRunning=' . intval($isRunning) . ' - EXIT!');
1330                 return $isRunning;
1331         } // END - if
1332
1333         // Simply check it
1334         $isRunning = ((isExtensionUpdateDependenciesInitialized()) && (in_array($ext_name, getExtensionRunningUpdates())));
1335
1336         // Return it
1337         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ', isRunning=' . intval($isRunning) . ' - EXIT!');
1338         return $isRunning;
1339 }
1340
1341 // Initializes the list of running updates
1342 function initExtensionRuningUpdates () {
1343         // Auto-init ext_running_updates
1344         if (!isset($GLOBALS['ext_running_updates'])) {
1345                 $GLOBALS['ext_running_updates'] = array();
1346                 $GLOBALS['ext_register_running'] = array();
1347         } // END - if
1348 }
1349
1350 // Getter for EXT_UPDATE_DEPENDS flag
1351 function getExtensionUpdateDependencies () {
1352         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1353         return $GLOBALS['ext_update_depends'][getCurrentExtensionName()];
1354 }
1355
1356 // Getter for next iterator depency
1357 function getExtensionUpdateDependenciesIterator () {
1358         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1359         return ($GLOBALS['ext_update_depends'][getCurrentExtensionName()][getExtensionUpdateIterator()]);
1360 }
1361
1362 // Counter for extension update depencies
1363 function countExtensionUpdateDependencies () {
1364         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1365         return count($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1366 }
1367
1368 // Removes given extension from update denpency list
1369 function removeExtensionDependency ($ext_name) {
1370         // Look it up
1371         $key = array_search($ext_name, getExtensionUpdateDependencies());
1372
1373         // Is it valid?
1374         if ($key !== false) {
1375                 // Then remove it
1376                 unset($GLOBALS['ext_update_depends'][getCurrentExtensionName()][$key]);
1377
1378                 // And sort the array
1379                 ksort($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1380         } // END - if
1381 }
1382
1383 // Init iterator for update depencies
1384 function initExtensionUpdateIterator () {
1385         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1386         $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()] = '0';
1387 }
1388
1389 // Getter for depency iterator
1390 function getExtensionUpdateIterator () {
1391         // Auto-init iterator
1392         if (!isset($GLOBALS['ext_depend_iterator'][getCurrentExtensionName()])) initExtensionUpdateIterator();
1393
1394         // Return it
1395         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName().'/'.$GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]);
1396         return $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()];
1397 }
1398
1399 // Increments the update iterator
1400 function incrementExtensionUpdateIterator () {
1401         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1402         $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]++;
1403 }
1404
1405 // Setter for EXT_REPORTS_FAILURE flag
1406 function enableExtensionReportingFailure ($reportsFailure = false) {
1407         $GLOBALS['ext_reports_failure'] = (bool) $reportsFailure;
1408 }
1409
1410 // Getter for EXT_REPORTS_FAILURE flag
1411 function isExtensionReportingFailure () {
1412         return $GLOBALS['ext_reports_failure'];
1413 }
1414
1415 // Setter for EXT_VER_HISTORY flag
1416 function setExtensionVersionHistory ($versionHistory) {
1417         $GLOBALS['ext_ver_history'][getCurrentExtensionName()] = (array) $versionHistory;
1418 }
1419
1420 // Getter for EXT_VER_HISTORY array
1421 function getExtensionVersionHistory () {
1422         return $GLOBALS['ext_ver_history'][getCurrentExtensionName()];
1423 }
1424
1425 // Setter for EXT_UPDATE_NOTES
1426 function setExtensionUpdateNotes ($updateNotes, $ext_ver = '') {
1427         // . '/' . getCurrentExtensionVersion()
1428         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ',getExtensionMode()=' . getExtensionMode() . ',ext_ver=' . $ext_ver . ',updateNotes()=' . strlen($updateNotes));
1429         if (empty($ext_ver)) {
1430                 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][getCurrentExtensionVersion()] = (string) $updateNotes;
1431         } else {
1432                 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver] = (string) $updateNotes;
1433         }
1434 }
1435
1436 // Getter for EXT_UPDATE_NOTES
1437 function getExtensionUpdateNotes ($ext_ver) {
1438         return $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver];
1439 }
1440
1441 // Checks if ext_update_notes is set
1442 function isExtensionUpdateNoteSet ($ext_ver) {
1443         return isset($GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver]);
1444 }
1445
1446 // Init extension notice
1447 function initExtensionNotes ($force = false) {
1448         // Is it already initialized?
1449         if (($force === false) && (isset($GLOBALS['ext_notes'][getCurrentExtensionName()]))) {
1450                 // This is mostly not wanted, so please report it
1451                 debug_report_bug(__FUNCTION__, __LINE__, 'ext_notes already set for extension ' . getCurrentExtensionName());
1452         } // END - if
1453
1454         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName());
1455         $GLOBALS['ext_notes'][getCurrentExtensionName()] = '';
1456 }
1457
1458 // Append extension notice
1459 function appendExtensionNotes ($notes) {
1460         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ', notes()=' . strlen($notes));
1461         $GLOBALS['ext_notes'][getCurrentExtensionName()] .= (string) trim($notes);
1462 }
1463
1464 // Getter for extension notes
1465 function getExtensionNotes () {
1466         return $GLOBALS['ext_notes'][getCurrentExtensionName()];
1467 }
1468
1469 // Setter for current extension name
1470 function setCurrentExtensionName ($ext_name) {
1471         $GLOBALS['curr_extension_name'] = (string) trim($ext_name);
1472 }
1473
1474 // Getter for current extension name
1475 function getCurrentExtensionName () {
1476         if (!isset($GLOBALS['curr_extension_name'])) {
1477                 // Not set!
1478                 debug_report_bug(__FUNCTION__, __LINE__, 'curr_extension_name not initialized. Please execute initExtensionSqls() before calling this function.');
1479         } // END - if
1480
1481         // Return it
1482         return $GLOBALS['curr_extension_name'];
1483 }
1484
1485 // Init SQLs array for current extension
1486 function initExtensionSqls ($force = false) {
1487         // Auto-init the array or if forced
1488         if (($force === true) || (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()]))) {
1489                 // Set the array
1490                 $GLOBALS['ext_sqls'][getCurrentExtensionName()] = array();
1491
1492                 // Initialize the generic array
1493                 initSqls();
1494         } // END - if
1495 }
1496
1497 // Adds SQLs to the SQLs array but "assigns" it with current extension name
1498 function addExtensionSql ($sql) {
1499         // Add it
1500         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',ext_version=' . getCurrentExtensionVersion() . ',sql=' . $sql);
1501         $GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()][] = $sql;
1502 }
1503
1504 // Getter for SQLs array for current extension
1505 function getExtensionSqls () {
1506         // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1507         if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1508                 // Not found, should not happen
1509                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1510                         getCurrentExtensionName()
1511                 ));
1512         } // END - if
1513
1514         // Return the array
1515         return $GLOBALS['ext_sqls'][getCurrentExtensionName()];
1516 }
1517
1518 // Count SQLs for current extension
1519 function countExtensionSqls () {
1520         // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1521         if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1522                 // Not found, should not happen
1523                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1524                         getCurrentExtensionName()
1525                 ));
1526         } // END - if
1527
1528         // Count them all
1529         return count($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1530 }
1531
1532 // Removes SQLs for current extension
1533 function unsetExtensionSqls () {
1534         unset($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1535 }
1536
1537 // Auto-initializes the removal list
1538 function initExtensionRemovalList () {
1539         // Is the remove list there?
1540         if (!isset($GLOBALS['ext_update_remove'])) {
1541                 // Then create it
1542                 $GLOBALS['ext_update_remove'] = array();
1543         } // END - if
1544 }
1545
1546 // Checks wether the current extension is on the removal list
1547 function isExtensionOnRemovalList () {
1548         // Init removal list
1549         initExtensionRemovalList();
1550
1551         // Is it there?
1552         return (in_array(getCurrentExtensionName(), $GLOBALS['ext_update_remove']));
1553 }
1554
1555 // Adds the current extension to the removal list
1556 function addCurrentExtensionToRemovalList () {
1557         // Simply add it
1558         $GLOBALS['ext_update_remove'][] = getCurrentExtensionName();
1559 }
1560
1561 // Getter for removal list
1562 function getExtensionRemovalList () {
1563         // Return the removal list
1564         return $GLOBALS['ext_update_remove'];
1565 }
1566
1567 // Redirects if the provided extension is not installed
1568 function redirectOnUninstalledExtension ($ext_name) {
1569         // So is the extension there?
1570         if ((!isExtensionInstalled($ext_name)) || (!isExtensionActive($ext_name))) {
1571                 // Redirect to index
1572                 redirectToUrl('modules.php?module=index&amp;code=' . getCode('EXTENSION_PROBLEM') . '&amp;ext=' . $ext_name);
1573         } // END - if
1574 }
1575
1576 // Filter for initialization of all extensions by loading them in 'init' mode
1577 function FILTER_INIT_EXTENSIONS () {
1578         // Do we have some entries?
1579         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY!');
1580         if (isset($GLOBALS['cache_array']['extension']['ext_name'])) {
1581                 // Load all found extensions if found
1582                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!');
1583                 foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) {
1584                         // Load it
1585                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - START');
1586                         loadExtension($ext_name, 'init', getExtensionVersion($ext_name));
1587                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - END');
1588                 } // END - foreach
1589                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!');
1590         } // END - if
1591         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!');
1592 }
1593
1594 // Setter for extension mode
1595 function setExtensionMode ($ext_mode) {
1596         $GLOBALS['ext_mode'] = (string) $ext_mode;
1597 }
1598
1599 // Getter for extension mode
1600 function getExtensionMode () {
1601         return $GLOBALS['ext_mode'];
1602 }
1603
1604 // Setter for dry-run
1605 function enableExtensionDryRun ($dry_run = true) {
1606         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',dry_run='.intval($dry_run));
1607         $GLOBALS['ext_dry_run'] = (bool) $dry_run;
1608 }
1609
1610 // Getter for dry-run
1611 function isExtensionDryRun () {
1612         return $GLOBALS['ext_dry_run'];
1613 }
1614
1615 // Setter for current extension version
1616 function setCurrentExtensionVersion ($ext_ver) {
1617         // ext_ver should never be empty in other modes than 'test'
1618         if ((empty($ext_ver)) && (getExtensionMode() != 'test')) {
1619                 // Please report all these messages
1620                 debug_report_bug(__FUNCTION__, __LINE__, 'ext_ver is empty. Current extension name: ' . getCurrentExtensionName() . ', mode=' . getExtensionMode());
1621         } // END - if
1622
1623         // Add version
1624         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver);
1625         $GLOBALS['ext_current_version'][getCurrentExtensionName()] = (string) $ext_ver;
1626 }
1627
1628 // Getter for current extension version
1629 function getCurrentExtensionVersion () {
1630         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $GLOBALS['ext_current_version'][getCurrentExtensionName()]);
1631         return $GLOBALS['ext_current_version'][getCurrentExtensionName()];
1632 }
1633
1634 // Remove the extension from cache array
1635 function removeExtensionFromArray () {
1636         // "Cache" this name
1637         $ext_name = getCurrentExtensionName();
1638
1639         // Now loop through the whole cache
1640         foreach ($GLOBALS['cache_array']['extension'] as $cacheName => $cacheArray) {
1641                 // Is it an element?
1642                 if (isset($cacheArray[$ext_name])) {
1643                         // Array element
1644                         unset($cacheArray[$ext_name]);
1645                         $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1646                 } else {
1647                         // Maybe in array?
1648                         $key = array_search($ext_name, $cacheArray);
1649
1650                         // Is it there?
1651                         if ($key !== false) {
1652                                 // Found, so remove it
1653                                 unset($cacheArray[$key]);
1654                                 $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1655                         } // END - if
1656                 }
1657         } // END - foreach
1658
1659         // Remove from other caches as well
1660         unset($GLOBALS['ext_is_installed'][$ext_name]);
1661         unset($GLOBALS['loaded_extension'][$ext_name]);
1662 }
1663
1664 // "Getter" for 'extension has a CSS file' (with same name, of course)
1665 function getExtensionHasCss () {
1666         // Do we have cache?
1667         if (!isset($GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()])) {
1668                 // Construct FQFN for check
1669                 $FQFN = sprintf("%stheme/%s/css/%s.css",
1670                         getPath(),
1671                         getCurrentTheme(),
1672                         getCurrentExtensionName()
1673                 );
1674
1675                 // Is it there?
1676                 $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()] = convertBooleanToYesNo(isFileReadable($FQFN));
1677         } // END - if
1678
1679         // Return it
1680         return $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()];
1681 }
1682
1683 // Checks wether the given extension has a language file
1684 function ifExtensionHasLanguageFile ($ext_name) {
1685         // Do we have cache?
1686         if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) {
1687                 // Count cache hits
1688                 incrementStatsEntry('cache_hits');
1689         } else {
1690                 // Determine it and put it in cache
1691                 $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = convertBooleanToYesNo(isLanguageIncludeReadable($ext_name));
1692         }
1693
1694         // Return result
1695         return ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y');
1696 }
1697
1698 // Load current extension's include file
1699 function loadCurrentExtensionInclude () {
1700         // Is it readable?
1701         if (!isExtensionIncludeReadable()) {
1702                 // Not readable
1703                 debug_report_bug(__FUNCTION__, __LINE__, 'Extension ' . getCurrentExtensionName() . ' should be loaded, but is not readable.');
1704         } // END - if
1705
1706         // Generate INC name
1707         $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1708
1709         // Load it
1710         loadInclude($INC);
1711 }
1712
1713 // Checks wether an extension is readable
1714 function isExtensionIncludeReadable ($ext_name = '') {
1715         // If empty, use current
1716         if (empty($ext_name)) {
1717                 $ext_name = getCurrentExtensionName();
1718         } // END - if
1719
1720         // Array found?
1721         if (!isset($GLOBALS['ext_inc_readable'][$ext_name])) {
1722                 // Generate INC name
1723                 $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1724
1725                 // Is it readable?
1726                 $GLOBALS['ext_inc_readable'][$ext_name] = isIncludeReadable($INC);
1727         } // END - if
1728
1729         // Return result
1730         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',realable='.intval($GLOBALS['ext_inc_readable'][$ext_name]));
1731         return $GLOBALS['ext_inc_readable'][$ext_name];
1732 }
1733
1734 // Checks if an extension's function file is readable
1735 function isExtensionFunctionFileReadable ($ext_name) {
1736         // Is cache there?
1737         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name);
1738         if (isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) {
1739                 // Just count cache hits
1740                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] .' - CACHE!');
1741                 incrementStatsEntry('cache_hits');
1742         } else {
1743                 // Construct IFN for functions file
1744                 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
1745
1746                 // Is this include there?
1747                 $isIncludeFound = ((isFileReadable($funcsInclude)) && (!isExtensionLibraryLoaded($ext_name)) && (getExtensionMode() == 'test'));
1748
1749                 // And put in cache, converted
1750                 $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = convertBooleanToYesNo($isIncludeFound);
1751         }
1752
1753         // Return result
1754         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name]);
1755         return ($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y');
1756 }
1757
1758 // Adds a CREATE TABLE statement if the requested table is not there
1759 function addCreateTableSql ($tableName, $sql, $comment) {
1760         // Is the table not there?
1761         if (!isSqlTableCreated($tableName)) {
1762                 // Is not found, so add it
1763                 addExtensionSql('CREATE TABLE
1764         `{?_MYSQL_PREFIX?}_' . $tableName . '` (' . $sql . ')
1765 ENGINE = {?_TABLE_TYPE?}
1766 CHARACTER SET utf8
1767 COLLATE utf8_general_ci
1768 COMMENT ' . "'" . $comment . "'");
1769         } else {
1770                 // Is already there, which should not happen
1771                 debug_report_bug(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created which should not happen.');
1772         }
1773 }
1774
1775 // Adds a DROP TABLE statement if the requested tabled is there
1776 function addDropTableSql ($tableName) {
1777         // Is the table there?
1778         if (isSqlTableCreated($tableName)) {
1779                 // Then add it, non-existing tables can be ignored because it will
1780                 // happen with every newly installed extension.
1781                 addExtensionSql('DROP TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '`');
1782
1783                 // Mark it as gone
1784                 $GLOBALS['isSqlTableCreated'][$tableName] = false;
1785         } // END - if
1786 }
1787
1788 // Adds an admin menu to the SQL queue of the menu entry is not found
1789 function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
1790         // Now check if this menu is there
1791         if (!isMenuActionValid('admin', $action, $what)) {
1792                 // Is what null?
1793                 if (is_null($what)) {
1794                         // Add main menu
1795                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES('%s',NULL,'%s','%s',%s)",
1796                                 $action,
1797                                 $title,
1798                                 $descr,
1799                                 bigintval($sort)
1800                         );
1801                 } else {
1802                         // Add sub menu
1803                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES('%s','%s','%s','%s',%s)",
1804                                 $action,
1805                                 $what,
1806                                 $title,
1807                                 $descr,
1808                                 bigintval($sort)
1809                         );
1810                 }
1811
1812                 // Add it to the queue
1813                 addExtensionSql($sql);
1814         } elseif (isDebugModeEnabled()) {
1815                 // Double menus should be located and fixed!
1816                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double admin menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1817         }
1818 }
1819
1820 // Adds a guest menu to the SQL queue if the menu entry is not found
1821 function addGuestMenuSql ($action, $what, $title, $sort) {
1822         // Now check if this menu is there
1823         if (!isMenuActionValid('guest', $action, $what)) {
1824                 // Is what null?
1825                 if (is_null($what)) {
1826                         // Add main menu
1827                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s',NULL,'%s','N','Y',%s)",
1828                                 $action,
1829                                 $title,
1830                                 bigintval($sort)
1831                         );
1832                 } else {
1833                         // Add sub menu
1834                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s','%s','%s','N','Y',%s)",
1835                                 $action,
1836                                 $what,
1837                                 $title,
1838                                 bigintval($sort)
1839                         );
1840                 }
1841
1842                 // Add it to the queue
1843                 addExtensionSql($sql);
1844         } elseif (isDebugModeEnabled()) {
1845                 // Double menus should be located and fixed!
1846                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s,what=%s,title=%s,locked=%s,visible=%s detected.", $action, $what, $title, $locked, $visible));
1847         }
1848 }
1849
1850 // Adds a member menu to the SQL queue if the menu entry is not found
1851 function addMemberMenuSql ($action, $what, $title, $sort) {
1852         // Now check if this menu is there
1853         if (!isMenuActionValid('member', $action, $what)) {
1854                 // Is what null?
1855                 if (is_null($what)) {
1856                         // Add main menu
1857                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s',NULL,'%s','N','Y',%s)",
1858                                 $action,
1859                                 $title,
1860                                 bigintval($sort)
1861                         );
1862                 } else {
1863                         // Add sub menu
1864                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s','%s','%s','N','Y',%s)",
1865                                 $action,
1866                                 $what,
1867                                 $title,
1868                                 bigintval($sort)
1869                         );
1870                 }
1871
1872                 // Add it to the queue
1873                 addExtensionSql($sql);
1874         } elseif (isDebugModeEnabled()) {
1875                 // Double menus should be located and fixed!
1876                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double member menu action=%s,what=%s,title=%s,visivle=%s,locked=%s detected.", $action, $what, $title, $visible, $locked));
1877         }
1878 }
1879
1880 // Adds a sponsor menu to the SQL queue if the menu entry is not found
1881 function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
1882         // Now check if this menu is there, if no ext-sponsor is installed all is not yet added
1883         if ((!isExtensionInstalled('sponsor')) || (!isMenuActionValid('sponsor', $action, $what))) {
1884                 // Is what null?
1885                 if (is_null($what)) {
1886                         // Add main menu
1887                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES('%s',NULL,'%s','%s',%s)",
1888                                 $action,
1889                                 $title,
1890                                 $active,
1891                                 bigintval($sort)
1892                         );
1893                 } else {
1894                         // Add sub menu
1895                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES('%s','%s','%s','%s',%s)",
1896                                 $action,
1897                                 $what,
1898                                 $title,
1899                                 $active,
1900                                 bigintval($sort)
1901                         );
1902                 }
1903
1904                 // Add it to the queue
1905                 addExtensionSql($sql);
1906         } elseif (isDebugModeEnabled()) {
1907                 // Double menus should be located and fixed!
1908                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double sponsor menu action=%s,what=%s,title=%s,active=%s detected.", $action, $what, $title, $active));
1909         }
1910 }
1911
1912 // Add configuration entry if not found for actual extension
1913 function addConfigAddSql ($columnName, $columnSql) {
1914         // Is the column there?
1915         if (!isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) {
1916                 // Not found, so add it
1917                 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `' . $columnName . '` ' . $columnSql);
1918         } elseif (isDebugModeEnabled()) {
1919                 // Add debug line
1920                 logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql);
1921         }
1922 }
1923
1924 // Drop configuration entry if found for actual extension
1925 function addConfigDropSql ($columnName) {
1926         // Is the column there?
1927         if (isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) {
1928                 // Found, so add it
1929                 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` DROP `' . $columnName . '`');
1930         } elseif (isDebugModeEnabled()) {
1931                 // Add debug line, debug_report_bug() would cause some extenion updates fail
1932                 logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' not found.');
1933         }
1934 }
1935
1936 // Change configuration entry for actual extension
1937 function addConfigChangeSql ($oldColumnName, $newColumnName, $columnSql) {
1938         // Add the SQL statement
1939         addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` CHANGE `' . $oldColumnName . '` `' . $newColumnName . '` ' . $columnSql);
1940 }
1941
1942 // Enables/disables productive mode for current extension (used only while
1943 // registration).
1944 // @TODO This should be rewrittten to allow, more development states, e.g. 'planing','alpha','beta','beta2','stable'
1945 function enableExtensionProductive ($isProductive = true) {
1946         // Log debug message
1947         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%d", getCurrentExtensionName(), intval($isProductive)));
1948
1949         // Set it
1950         $GLOBALS['ext_productive'][getCurrentExtensionName()] = (bool) $isProductive;
1951 }
1952
1953 // Checks wether the extension is in productive phase. If not set, development
1954 // phase (=false) is assumed.
1955 function isExtensionProductive ($ext_name = '') {
1956         // Is the extension name empty? Then use current
1957         if (empty($ext_name)) {
1958                 // Get current extension name
1959                 $ext_name = getCurrentExtensionName();
1960         } // END - if
1961
1962         // Do we have cache?
1963         if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
1964                 // Load extension only if not yet loaded
1965                 if (!isset($GLOBALS['ext_productive'][$ext_name])) {
1966                         // Load extension in test mode
1967                         loadExtension($ext_name, 'test');
1968                 } // END - if
1969
1970                 // Determine it
1971                 $GLOBALS[__FUNCTION__][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === true));
1972         } // END - if
1973
1974         // Log debug message
1975         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%s", $ext_name, intval($GLOBALS[__FUNCTION__][$ext_name])));
1976
1977         // Return result
1978         return $GLOBALS[__FUNCTION__][$ext_name];
1979 }
1980
1981 // Mark extension file as loaded
1982 function markExtensionAsLoaded ($ext_name) {
1983         // Is it already loaded?
1984         if (isExtensionLoaded($ext_name)) {
1985                 // Then abort here
1986                 debug_report_bug(__FUNCTION__, __LINE__, 'Extension ' . $ext_name . ' is already marked as loaded!');
1987         } // END - if
1988
1989         // Mark it
1990         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,ext_loaded=true", $ext_name));
1991         $GLOBALS['ext_loaded']['ext_name'][$ext_name] = true;
1992 }
1993
1994 // Determine wether the given extension is already loaded
1995 function isExtensionLoaded ($ext_name) {
1996         // Is it there?
1997         return ((isset($GLOBALS['ext_loaded']['ext_name'][$ext_name])) && ($GLOBALS['ext_loaded']['ext_name'][$ext_name] === true));
1998 }
1999
2000 // Mark extension's library file as loaded
2001 function markExtensionLibraryAsLoaded ($ext_name) {
2002         // Is it already loaded?
2003         if (isExtensionLibraryLoaded($ext_name)) {
2004                 // Then abort here
2005                 debug_report_bug(__FUNCTION__, __LINE__, 'Extension library ' . $ext_name . ' is already marked as loaded!');
2006         } // END - if
2007
2008         // Mark it
2009         $GLOBALS['ext_loaded']['library'][$ext_name] = true;
2010 }
2011
2012 // Determine wether the given extension's library is already loaded
2013 function isExtensionLibraryLoaded ($ext_name) {
2014         // Is it there?
2015         return ((isset($GLOBALS['ext_loaded']['library'][$ext_name])) && ($GLOBALS['ext_loaded']['library'][$ext_name] === true));
2016 }
2017
2018 // [EOF]
2019 ?>