2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 10/25/2009 *
4 * =================== Last change: 10/25/2009 *
6 * -------------------------------------------------------------------- *
7 * File : extensions-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Extension management *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Erweiterungen-Management *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // Load the extension and maybe found language and function files.
46 function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = false) {
47 // If this happens twice, we need the bug report from you, except for updates/tests
48 if ((isset($GLOBALS['loaded_extension'][$ext_name][$ext_mode])) && (!in_array($ext_mode, array('update', 'test')))) {
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));
52 // Make sure this situation can only happen once
53 $GLOBALS['loaded_extension'][$ext_name][$ext_mode] = true;
56 setExtensionMode($ext_mode);
58 // Set current extension name
59 setCurrentExtensionName($ext_name);
61 if (!empty($ext_ver)) {
62 // Set current extension version
63 setCurrentExtensionVersion($ext_ver);
66 setCurrentExtensionVersion('0.0');
68 // In all but test-mode we need these messages to debug! Please report all (together, e.g.)
69 if ($ext_mode != 'test') {
70 // Log empty versions not in test-mode, but maybe it is fine...
71 logDebugMessage(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0. ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', dry_run=' . intval($dry_run));
76 enableExtensionDryRun($dry_run);
79 initIncludePool('extension');
81 // Init EXT_UPDATE_DEPENDS if not yet done
82 if (!isExtensionUpdateDependenciesInitialized()) {
84 initExtensionUpdateDependencies();
87 // Init current extension name list
90 // Is the extension already loaded?
91 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loading extension ' . $ext_name . ', mode=' . getExtensionMode() . ', ver=' . getCurrentExtensionVersion());
92 if ((isset($GLOBALS['ext_loaded']['ext'][$ext_name])) && (getExtensionMode() == 'init')) {
94 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
100 // Is the extension file NOT there?
101 if (!isExtensionNameValid($ext_name)) {
103 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s not found or not readable.", $ext_name));
109 // Load extension's own language file if not in test mode
110 if ((getExtensionMode() != 'test') && (ifExtensionHasLanguageFile($ext_name))) {
112 loadLanguageFile($ext_name);
116 if (isExtensionFunctionFileReadable($ext_name)) {
118 if ((($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y') || (!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name]))) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name]))) {
119 // Construct FQFN for functions file
120 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
123 $GLOBALS['ext_loaded']['funcs'][$ext_name] = true;
125 // Download functions file
126 loadIncludeOnce($funcsInclude);
128 } elseif ((!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) && (isDebugModeEnabled()) && (getOutputMode() == '0') && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme') && (getExtensionMode() == 'test')) {
129 // No functions file is not so good...
130 logDebugMessage(__FUNCTION__, __LINE__, sprintf("NOTICE: Extension %s has no own functions file or we cannot read from it. mode=%s",
136 // Extensions are not deprecated by default
137 setExtensionDeprecated('N');
139 // Extensions are not always active by default
140 setExtensionAlwaysActive('N');
142 // Extension update notes
143 // @TODO Do we still need this? setExtensionUpdateNotes('');
145 // Include the extension file
146 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension loaded.');
147 loadExtensionInclude();
149 // Is this extension deprecated?
150 if (isExtensionDeprecated()) {
151 // Deactivate the extension
152 doDeactivateExtension($ext_name);
158 // Mark it as loaded in normal mode
159 if (getExtensionMode() == '') {
161 $GLOBALS['ext_loaded']['ext'][$ext_name] = true;
168 // Registeres an extension and possible update depencies
169 function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true) {
170 // Set current extension name
171 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . $taskId . ',dry_run=' . intval($dry_run) . ',logout=' . intval($logout) . ' - ENTERED!');
172 setCurrentExtensionName($ext_name);
175 enableExtensionDryRun($dry_run);
177 // By default all extensions are in productive phase
178 enableExtensionProductive();
180 // This shall never do a non-admin user or if the extension is active (already installed)
181 if ((!isAdmin()) || (isExtensionInstalled($ext_name))) {
182 // Abort here with 'false'
186 // When this extension is already in registration/update phase, all is fine
187 if ((isExtensionRegistrationRunning($ext_name)) || (isExtensionUpdateRunning($ext_name))) {
188 // Then abort here with 'true' becaus it is fine
189 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - ALREADY!');
193 // This registration is running
194 addExtensionRunningRegistration($ext_name);
196 // Init EXT_UPDATE_DEPENDS if not yet done
197 if (!isExtensionUpdateDependenciesInitialized()) {
199 initExtensionUpdateDependencies();
202 // Is the task id zero? Then we need to auto-fix it here
203 if ($taskId == '0') {
204 // Try to find the task
205 $taskId = determineExtensionTaskId(getCurrentExtensionName());
207 // Still zero and not in dry-run?
208 if (($taskId == '0') && (!isExtensionDryRun())) {
209 // Now try to create a new task
210 $taskId = createNewExtensionTask(getCurrentExtensionName());
213 if ($taskId == '0') {
214 // Then request a bug report
215 debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId(%s)",
217 getCurrentExtensionName()
223 // Init queries and notes
225 initExtensionNotes();
230 initIncludePool('extension');
232 // By default we have no failures
233 setExtensionReportsFailure(false);
235 // Does this extension exists?
236 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
237 if (loadExtension(getCurrentExtensionName(), 'register', '', isExtensionDryRun())) {
238 // Set current extension name again
239 setCurrentExtensionName($ext_name);
241 // And run possible updates
242 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
243 $history = getExtensionVersionHistory();
244 foreach ($history as $ver) {
245 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $ver);
246 // Load extension in update mode
247 loadExtension(getCurrentExtensionName(), 'update', $ver, isExtensionDryRun());
249 // Add update notes to our output
250 addExtensionNotes($ver);
253 // Does this extension depends on an outstanding update of another update?
254 for ($dmy = getExtensionUpdateIterator(); getExtensionUpdateIterator() < countExtensionUpdateDependencies();) {
256 $ext_update = getExtensionUpdateDependenciesIterator();
258 // Increment here to avoid endless loop
259 incrementExtensionUpdateIterator();
261 // Check if extension is not installed and not already in registration procedure and if loading it wents finally fine...
262 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isExtensionRegistrationRunning(' . $ext_update . ')=' . intval(isExtensionRegistrationRunning($ext_update)));
263 if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', isExtensionDryRun()))) {
264 // Set current extension name again
265 setCurrentExtensionName($ext_name);
267 // If versions mismatch update extension first
269 if (isExtensionInstalled($ext_update)) {
270 // Get version only if installed
271 $ext_ver = getExtensionVersion($ext_update);
274 // Extension version set? If empty the extension is not registered
275 if (empty($ext_ver)) {
276 // Extension not registered so far so first load task's id...
277 $task = determineExtensionTaskId($ext_update);
281 // Try to register the extension
282 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ':ext_update=' . $ext_update . ',taskId=' . $task);
283 $test = registerExtension($ext_update, $task, isExtensionDryRun(), false);
285 // Reset extension name
286 setCurrentExtensionName($ext_name);
287 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
288 //* DEBUG: */ debugOutput(getCurrentExtensionName().':<pre>' . print_r($test, true) . '</pre>');
290 } elseif ($ext_ver != getCurrentExtensionVersion()) {
291 // Ok, update this extension now
292 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
293 $GLOBALS['ext_backup_name'][$ext_update][$ext_ver] = getCurrentExtensionName();
294 $GLOBALS['ext_backup_ver'][$ext_update][$ext_ver] = getCurrentExtensionVersion();
295 updateExtension($ext_update, $ext_ver, isExtensionDryRun());
296 setCurrentExtensionName($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]);
297 setCurrentExtensionVersion($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]);
298 unset($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]);
299 unset($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]);
300 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
305 // Nothing to register / update before...
309 // Required file for update does not exists!
311 // But this is fine for the first time...
314 // Restore the current extension name
315 setCurrentExtensionName($ext_name);
318 // Is there no update?
319 if (countExtensionUpdateDependencies(getCurrentExtensionName()) == 0) {
320 // Then test is passed!
324 // Switch back to register mode
325 setExtensionMode('register');
327 // Remains true if extension registration reports no failures
328 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
329 //* DEBUG: */ debugOutput(getCurrentExtensionName().':<pre>' . print_r($test, true) . '</pre>');
330 $test = (($test === true) && (getExtensionReportsFailure() === false));
331 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
332 //* DEBUG: */ debugOutput(getCurrentExtensionName().':<pre>' . print_r($test, true) . '</pre>');
334 // Does everthing before wents ok?
335 if ($test === true) {
336 // "Dry-run-mode" activated?
337 if ((isExtensionDryRun() === false) && (!isExtensionOnRemovalList())) {
338 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName());
339 // Init SQLs and transfer ext->generic
341 setSqlsArray(getExtensionSqls());
343 // Run installation pre-installation filters
344 runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun()));
346 // Register extension
347 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!');
348 if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) {
349 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss());
351 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`,`ext_has_css`) VALUES ('%s','%s','%s','%s')",
353 getCurrentExtensionName(),
354 getExtensionAlwaysActive(),
355 getCurrentExtensionVersion(),
357 ), __FUNCTION__, __LINE__);
359 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion());
361 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`) VALUES ('%s','%s','%s')",
363 getCurrentExtensionName(),
364 getExtensionAlwaysActive(),
365 getCurrentExtensionVersion()
366 ), __FUNCTION__, __LINE__);
369 // Remove cache file(s) if extension is active
370 runFilterChain('post_extension_installed', array(
371 'pool' => 'extension',
372 'ext_name' => getCurrentExtensionName(),
376 // Re-init queries and notes
377 initExtensionSqls(true);
378 initExtensionNotes();
380 // Mark it as installed
381 $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true;
383 // In normal mode return a true on success
385 } elseif (isExtensionDryRun() === true) {
386 // In "dry-run" mode do always return a true
389 // Re-init queries and notes
390 initExtensionNotes();
392 // Extension has been removed for updates, so all is fine!
396 // No, an error occurs while registering extension :-(
397 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
400 } elseif (($taskId > 0) && (getCurrentExtensionName() != '')) {
401 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
402 // Remove task from system when id and extension's name is valid
403 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `status`='NEW' LIMIT 1",
404 array(bigintval($taskId)), __FUNCTION__, __LINE__);
407 // Is this the sql_patches?
408 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . '/' . getExtensionMode());
409 if ((getCurrentExtensionName() == 'sql_patches') && ((getExtensionMode() == 'register') || (getExtensionMode() == 'remove')) && (!isExtensionDryRun()) && ($test)) {
410 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ': LOAD!');
411 if ($logout === true) {
412 // Then redirect to logout
413 redirectToUrl('modules.php?module=admin&logout=1&' . getExtensionMode() . '=sql_patches');
415 // Add temporary filter
416 registerFilter('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true);
417 $GLOBALS['ext_load_mode'] = getExtensionMode();
421 // Return status code
422 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ' - EXIT!');
423 //* DEBUG: */ debugOutput(getCurrentExtensionName().':<pre>'.print_r($ret, true).'</pre>');
427 // Run SQL queries for given extension id
428 // @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
429 function doExtensionSqls ($ext_id, $load_mode) {
430 // This shall never do a non-admin user!
431 if (!isAdmin()) return false;
433 // Get extension's name
434 $ext_name = getExtensionName($ext_id);
436 // Set current SQL name
437 setCurrentExtensionName($ext_name);
439 // Init EXT_UPDATE_DEPENDS
440 if (!isExtensionUpdateDependenciesInitialized()) {
442 initExtensionUpdateDependencies();
448 // By default no SQL has been executed
451 // Load extension in detected mode
452 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]=".getCurrentExtensionName()."");
453 loadExtension(getCurrentExtensionName(), $load_mode, '', false);
457 setSqlsArray(getExtensionSqls());
459 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ":SQLs::count=".countSqls()."");
461 // Run SQL commands...
462 runFilterChain('run_sqls');
465 // Run any filters depending on the action here
466 runFilterChain('extension_' . $load_mode);
468 // Remove cache file(s) if extension is active
469 if (((isExtensionActive('cache')) && ((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate'))) {
471 runFilterChain('post_extension_run_sql', getCurrentExtensionName());
474 // Is this the sql_patches?
475 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": id=".$ext_id.",currName=".getCurrentExtensionName().",loadMode=".$load_mode);
476 if ((getCurrentExtensionName() == 'sql_patches') && (($load_mode == 'register') || ($load_mode == 'remove'))) {
477 // Then redirect to logout
478 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": LOAD!");
479 redirectToUrl('modules.php?module=admin&logout=1&' . $load_mode . '=sql_patches');
483 // Check wether the given extension is installed
484 function isExtensionInstalled ($ext_name) {
485 // We don't like empty extension names here
486 if (empty($ext_name)) {
487 // Please fix them all
488 debug_report_bug(__FUNCTION__.': ext_name is empty.');
491 // By default non is installed
492 $isInstalled = false;
494 // Check if there is a cache entry
495 if (isset($GLOBALS['ext_is_installed'][$ext_name])) {
496 // Use cache built from below queries
497 $isInstalled = $GLOBALS['ext_is_installed'][$ext_name];
498 } elseif (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
503 incrementStatsEntry('cache_hits');
504 } elseif ((isInstallationPhase())) {
505 // Extensions are all inactive/not installed during installation
508 $ext_id = getExtensionId($ext_name);
510 // Do we have a record?
511 $isInstalled = ($ext_id > 0);
513 // Is it installed, then cache the entry
514 if ($isInstalled === true) {
515 // Dummy call (get is okay here)
516 getExtensionId($ext_name, true);
519 // Remember the status
520 $GLOBALS['ext_is_installed'][$ext_name] = $isInstalled;
527 // Check if given extension is active
528 function isExtensionActive ($ext_name) {
529 // Extensions are all inactive during installation
530 if ((isInstallationPhase()) || (empty($ext_name))) return false;
532 // Not active is the default
533 $data['ext_active'] = 'N';
536 if (isset($GLOBALS['cache_array']['extension']['ext_active'][$ext_name])) {
538 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "CACHE! ext_name={$ext_name}");
539 $data['ext_active'] = $GLOBALS['cache_array']['extension']['ext_active'][$ext_name];
542 incrementStatsEntry('cache_hits');
543 } elseif (isset($GLOBALS['ext_loaded'][$ext_name])) {
544 // @TODO Extension is loaded, what next?
545 debug_report_bug(__FUNCTION__, __LINE__, 'LOADED:' . $ext_name);
546 } elseif (($ext_name == 'cache') || (!isExtensionInstalled('cache'))) {
547 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}");
548 // Load from database
549 $result = SQL_QUERY_ESC("SELECT `ext_active` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
550 array($ext_name), __FUNCTION__, __LINE__);
553 if (SQL_NUMROWS($result) == 1) {
555 $data = SQL_FETCHARRAY($result);
559 SQL_FREERESULT($result);
562 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name=".$ext_name."[DB]: ".$data['ext_active']."");
563 $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = $data['ext_active'];
565 // Extension not active!
566 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name=".$ext_name.": Not active!");
567 $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = 'N';
571 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name=".$ext_name.",active=".$data['ext_active']."");
573 // Is this extension activated? (For admins we always have active extensions...)
574 return ($data['ext_active'] == 'Y');
577 // Get version from extensions
578 function getExtensionVersion ($ext_name, $force = false) {
579 // By default no extension is found
580 $data['ext_version'] = 'false';
582 // Empty extension name should be fixed!
583 if (empty($ext_name)) {
584 // Please report this bug!
585 debug_report_bug(__FUNCTION__, __LINE__, 'ext_name is empty which is not allowed here.');
588 // Extensions are all inactive during installation
589 if (isInstallationPhase()) return '';
590 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": ext_name=".$ext_name."");
592 // Is the cache written?
593 if (isset($GLOBALS['cache_array']['extension']['ext_version'][$ext_name])) {
594 // Load data from cache
595 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $ext_name . ': CACHE!');
596 $data['ext_version'] = $GLOBALS['cache_array']['extension']['ext_version'][$ext_name];
599 incrementStatsEntry('cache_hits');
600 } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (getOutputMode() != 0)) {
601 // Load from database
602 $result = SQL_QUERY_ESC("SELECT `ext_version` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
603 array($ext_name), __FUNCTION__, __LINE__);
604 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $ext_name . ': DB - '.SQL_NUMROWS($result).'');
606 // Is the extension there?
607 if (SQL_NUMROWS($result) == 1) {
609 $data = SQL_FETCHARRAY($result);
610 } elseif (isDebugModeEnabled()) {
611 // Not found, please report all
612 debug_report_bug(__FUNCTION__, __LINE__, sprintf(": Cannot find extension %s in database!", $ext_name));
616 SQL_FREERESULT($result);
619 $GLOBALS['cache_array']['extension']['ext_version'][$ext_name] = $data['ext_version'];
622 // Extension version should not be invalid
623 if (($data['ext_version'] == 'false') && ($force === false)) {
624 // Please report this trouble
625 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> has empty version!", $ext_name));
629 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": ret={$data['ext_version']}");
630 return $data['ext_version'];
633 // Updates a given extension with current extension version to latest version
634 function updateExtension ($ext_name, $ext_ver, $dry_run = false) {
635 // Only admins are allowed to update extensions
636 if ((!isAdmin()) || (empty($ext_name))) return false;
638 // Set current SQL name
639 setCurrentExtensionName($ext_name);
643 initExtensionNotes();
644 initIncludePool('extension');
646 // Load extension in test mode
647 loadExtension($ext_name, 'test', $ext_ver, isExtensionDryRun());
649 // Save version history
650 $history = getExtensionVersionHistory();
652 // Remove old SQLs array to prevent possible bugs
655 // Check if version is updated
656 //* DEBUG: */ debugOutput(getCurrentExtensionName().'/'.$ext_name.':'.getThisExtensionVersion().'/'.$ext_ver.'/'.intval(is_array($history)));
657 if (((getThisExtensionVersion() != $ext_ver) || (isExtensionDryRun())) && (is_array($history))) {
658 // Search for starting point
659 $start = array_search($ext_ver, $history);
661 // And load SQL queries in order of version history
662 for ($idx = ($start + 1); $idx < count($history); $idx++) {
663 // Set extension version
664 $GLOBALS['update_ver'][getCurrentExtensionName()] = $history[$idx];
667 loadExtension(getCurrentExtensionName(), 'update', $GLOBALS['update_ver'][getCurrentExtensionName()], isExtensionDryRun());
670 $depencies = getExtensionUpdateDependencies();
673 if (count($depencies) > 0) {
674 // Apply all extension depencies
675 foreach ($depencies as $ext_depend) {
676 // Did we already update/register this?
677 if (!isset($GLOBALS['ext_updated'][$ext_depend])) {
679 setCurrentExtensionName($ext_depend);
681 // Mark it as already updated before we update it
682 $GLOBALS['ext_updated'][$ext_depend] = true;
684 // Is the extension there?
685 if (isExtensionInstalled($ext_depend)) {
686 // Update another extension first!
687 $test = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun());
689 // Register new extension
690 $test = registerExtension($ext_depend, 0, isExtensionDryRun(), false);
695 // Set extension version here
696 setCurrentExtensionVersion($ext_ver);
699 setCurrentExtensionName($ext_name);
703 addExtensionNotes($history[$idx]);
706 // In real-mode execute any existing includes
707 if (isExtensionDryRun() === false) {
708 $GLOBALS['ext_inc_pool'][getCurrentExtensionName()] = getIncludePool('extension');
709 runFilterChain('load_includes', 'extension');
710 setIncludePool('extension', $GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
711 unset($GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
716 setSqlsArray(getExtensionSqls());
719 runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun()));
721 if (isExtensionDryRun() === false) {
722 // Run filters on success extension update
723 runFilterChain('extension_update', getCurrentExtensionName());
728 // Output verbose SQL table for extension
729 function addExtensionVerboseSqlTable ($title = '', $dashed = '', $switch = false, $width = '100%') {
732 // Then fix it to default
733 $title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVAL--}';
739 // Do we have queries?
740 if ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y')) {
745 foreach (getExtensionSqls() as $sqls) {
746 // New array format is recursive
747 foreach ($sqls as $idx => $sql) {
751 // Output command if set
753 // Prepare output for template
761 $OUT .= loadTemplate('admin_ext_sql_row', true, $content);
769 // Prepare content for template
777 // Load main template
778 $OUT = loadTemplate('admin_ext_sql_table', true, $content);
779 } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y')) {
780 // No addional SQL commands to run
781 $OUT = loadTemplate('admin_settings_saved', true, '{--ADMIN_NO_ADDITIONAL_SQLS--}');
788 // Get extension name from id
789 function getExtensionName ($ext_id) {
790 // Init extension name
791 $data['ext_name'] = '';
794 if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
796 $data['ext_name'] = $GLOBALS['cache_array']['extension']['ext_name'][$ext_id];
799 incrementStatsEntry('cache_hits');
800 } elseif (!isExtensionActive('cache')) {
801 // Load from database
802 $result = SQL_QUERY_ESC("SELECT `ext_name` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `id`=%s LIMIT 1",
803 array(bigintval($ext_id)), __FUNCTION__, __LINE__);
805 // Is the entry there?
806 if (SQL_NUMROWS($result) == 1) {
807 // Get the extension's name from database
808 $data = SQL_FETCHARRAY($result);
812 SQL_FREERESULT($result);
815 // Did we find some extension?
816 if (empty($data['ext_name'])) {
817 // We should fix these all!
818 debug_report_bug(__FUNCTION__, __LINE__, 'ext_name is empty. ext_id=' . $ext_id);
821 // Return the extension name
822 return $data['ext_name'];
825 // Get extension id from name
826 function getExtensionId ($ext_name) {
828 $data['ext_id'] = '0';
831 if (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
833 $data['ext_id'] = $GLOBALS['cache_array']['extension']['ext_id'][$ext_name];
836 incrementStatsEntry('cache_hits');
838 // Load from database
839 $result = SQL_QUERY_ESC("SELECT `id` AS ext_id FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
840 array($ext_name), __FUNCTION__, __LINE__);
842 // Is the entry there?
843 if (SQL_NUMROWS($result) == 1) {
844 // Get the extension's id from database
845 $data = SQL_FETCHARRAY($result);
849 SQL_FREERESULT($result);
852 $GLOBALS['cache_array']['extension']['ext_id'][$ext_name] = $data['ext_id'];
856 return $data['ext_id'];
859 // Determines wether the given extension name is valid
860 function isExtensionNameValid ($ext_name) {
862 if (!isset($GLOBALS['ext_name_valid'][$ext_name])) {
863 // Generate include file name
864 $INC = sprintf("inc/extensions/ext-%s.php", $ext_name);
866 // Is there a file in inc/extensions/ ?
867 $GLOBALS['ext_name_valid'][$ext_name] = isIncludeReadable($INC);
871 return $GLOBALS['ext_name_valid'][$ext_name];
874 // Determines wether the given extension id is valid
875 function isExtensionIdValid ($ext_id) {
876 // Default is nothing valid
879 // Check in cache then in database
880 if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
885 incrementStatsEntry('cache_hits');
888 $isValid = (countSumTotalData($ext_id, 'extensions', 'id', 'id', true) == 1);
895 // Activate given extension
896 function doActivateExtension ($ext_name) {
897 // Activate the extension
898 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='Y' WHERE `ext_name`='%s' LIMIT 1",
899 array($ext_name), __FUNCTION__, __LINE__);
901 // Extension has been activated?
902 if (SQL_AFFECTEDROWS() == 1) {
903 // Then run all queries
904 doExtensionSqls(getExtensionId($ext_name), 'activate');
908 // Deactivate given extension
909 function doDeactivateExtension($ext_name) {
910 // Activate the extension
911 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='N' WHERE `ext_name`='%s' LIMIT 1",
912 array($ext_name), __FUNCTION__, __LINE__);
914 // Extension has been activated?
915 if (SQL_AFFECTEDROWS() == 1) {
916 // Then run all queries
917 doExtensionSqls(getExtensionId($ext_name), 'deactivate');
919 // Create new task (we ignore the task id here)
920 createExtensionDeactivationTask($ext_name);
923 sendAdminNotification(
924 '{--ADMIN_EXTENSION_DEACTIVATED_SUBJECT--}',
925 'admin_ext_deactivated',
926 array('ext_name' => $ext_name)
931 // Checks wether the extension is older than given
932 function isExtensionOlder ($ext_name, $ext_ver) {
933 // Get current extension version
934 $currVersion = getExtensionVersion($ext_name);
936 // Remove all dots from both versions
937 $currVersion = str_replace('.', '', $currVersion);
938 $ext_ver = str_replace('.', '', $ext_ver);
940 // Now compare both and return the result
941 return ($currVersion < $ext_ver);
944 // Creates a new task for updated extension
945 function createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) {
946 // Create subject line
947 $subject = '[UPDATE-' . $ext_name . '-' . $ext_ver . ':] {--ADMIN_UPDATE_EXTENSION_SUBJECT--}';
950 $taskId = determineTaskIdBySubject($subject);
952 // Is the extension there?
953 if (isExtensionInstalled($ext_name)) {
954 // Check if task is not there
955 if ($taskId == '0') {
956 // Create extension update-task
957 $taskId = createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId);
960 // Extension not there! :-(
961 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> not found but should be updated?", $ext_name));
968 // Creates a new task for newly installed extension
969 function createNewExtensionTask ($ext_name) {
970 // Generate subject line
971 $subject = sprintf("[%s:]", $ext_name);
974 $taskId = determineTaskIdBySubject($subject);
976 // Not installed and do we have created a task for the admin?
977 if (($taskId == '0') && (!isExtensionInstalled($ext_name))) {
978 // Set default message if ext-foo is missing
979 $message = getMaskedMessage('ADMIN_EXTENSION_TEXT_FILE_MISSING', $ext_name);
982 $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
988 // Load text for task if found
989 if (isFileReadable($tpl)) {
990 // Load extension's own text template (HTML!)
991 $message = loadTemplate('ext_' . $ext_name, true);
993 // Write this in debug.log as well
994 logDebugMessage(__FUNCTION__, __LINE__, $message);
997 // Task not created so it's a brand-new extension which we need to register and create a task for!
998 $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), false);
1005 // Creates a task for automatically deactivated (deprecated) extension
1006 function createExtensionDeactivationTask ($ext_name) {
1007 // Create subject line
1008 $subject = sprintf("[%s:] %s", $ext_name, '{--ADMIN_TASK_EXTENSION_DEACTIVATED_SUBJECT--}');
1011 $taskId = determineTaskIdBySubject($subject);
1013 // Not installed and do we have created a task for the admin?
1014 if (($taskId == '0') && (isExtensionInstalled($ext_name))) {
1015 // Task not created so add it
1016 $taskId = createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', true, $ext_name)), 'EXTENSION_DEACTIVATION');
1023 // Checks if the module has a menu
1024 function ifModuleHasMenu ($mod, $forceDb = false) {
1025 // All is false by default
1028 // Extension installed and newer than or has version 0.1.2?
1029 if (isExtensionInstalledAndNewer('cache', '0.1.2')) {
1030 // Cache version is okay, so let's check the cache!
1031 if (isset($GLOBALS['cache_array']['modules']['has_menu'][$mod])) {
1032 // Check module cache and count hit
1033 $ret = ($GLOBALS['cache_array']['modules']['has_menu'][$mod] == 'Y');
1034 incrementStatsEntry('cache_hits');
1035 } elseif (isset($GLOBALS['cache_array']['extension']['ext_menu'][$mod])) {
1036 // Check cache and count hit
1037 $ret = ($GLOBALS['cache_array']['extension']['ext_menu'][$mod] == 'Y');
1038 incrementStatsEntry('cache_hits');
1040 // Admin/guest/member/sponsor modules have always a menu!
1041 $ret = in_array($mod, array('admin', 'index', 'login', 'sponsor'));
1043 } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && ((!isExtensionActive('cache')) || ($forceDb === true))) {
1044 // Check database for entry
1045 $result = SQL_QUERY_ESC("SELECT `has_menu` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
1046 array($mod), __FUNCTION__, __LINE__);
1049 if (SQL_NUMROWS($result) == 1) {
1050 // Load "has_menu" column
1051 $data = SQL_FETCHARRAY($result);
1053 // Fake cache... ;-)
1054 $GLOBALS['cache_array']['extension']['ext_menu'][$mod] = $data['has_menu'];
1056 // Does it have a menu?
1057 $ret = ($data['has_menu'] == 'Y');
1061 SQL_FREERESULT($result);
1062 } elseif (!isExtensionInstalled('sql_patches')) {
1063 // No sql_patches installed, so maybe in admin/guest/member/sponsor area or no admin registered?
1064 $ret = in_array($mod, array('admin', 'index', 'login', 'sponsor')); // Then there is a menu!
1066 // Unsupported state!
1067 logDebugMessage(__FUNCTION__, __LINE__, 'This should never be reached.');
1074 // Determines the task id for given extension
1075 function determineExtensionTaskId ($ext_name) {
1076 // Default is not found
1077 $data['task_id'] = '0';
1079 // Search for extension task's id
1080 $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
1081 array($ext_name), __FUNCTION__, __LINE__);
1084 if (SQL_NUMROWS($result) == 1) {
1085 // Task found so load task's id and register extension...
1086 $data = SQL_FETCHARRAY($result);
1090 SQL_FREERESULT($result);
1093 return $data['task_id'];
1096 // Determines the task id for given subject
1097 function determineTaskIdBySubject ($subject) {
1098 // Default is not found
1099 $data['task_id'] = '0';
1101 // Search for task id
1102 $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
1103 array($subject), __FUNCTION__, __LINE__);
1106 if (SQL_NUMROWS($result) == 1) {
1107 // Task found so load task's id and register extension...
1108 $data = SQL_FETCHARRAY($result);
1112 SQL_FREERESULT($result);
1115 return $data['task_id'];
1118 // Add updates notes for given version
1119 function addExtensionNotes ($ver) {
1120 // Init notes/content
1121 $out = ''; $content = array();
1123 // Is do we have verbose output enabled?
1124 if ((!isExtensionActive('sql_patches')) || (getConfig('verbose_sql') == 'Y')) {
1125 // Update notes found?
1126 if (isExtensionUpdateNoteSet($ver)) {
1127 // Update notes found
1130 'notes' => getExtensionUpdateNotes($ver)
1134 setExtensionUpdateNotes('', $ver);
1135 } elseif (($ver == '0.0') || ($ver == '0.0.0')) {
1139 'notes' => '{--INITIAL_RELEASE--}'
1142 // No update notes found!
1145 'notes' => '{--NO_UPDATE_NOTES--}'
1150 $out = loadTemplate('admin_EXTENSION_notes', true, $content);
1154 appendExtensionNotes($out);
1157 // Getter for CSS files array
1158 function getExtensionCssFiles () {
1159 // By default no additional CSS files are found
1160 $cssFiles = array();
1162 // Is the array there?
1163 if (isset($GLOBALS['css_files'])) {
1165 $cssFiles = $GLOBALS['css_files'];
1172 // Init CSS files array
1173 function initExtensionCssFiles () {
1175 $GLOBALS['css_files'] = array();
1179 function addExtensionCssFile ($file) {
1180 // Is the array there?
1181 if (!isset($GLOBALS['css_files'])) {
1182 // Then auto-init them
1183 initExtensionCssFiles();
1187 $GLOBALS['css_files'][] = $file;
1190 // Setter for EXT_ALWAYS_ACTIVE flag
1191 function setExtensionAlwaysActive ($active) {
1192 $GLOBALS['ext_always_active'][getCurrentExtensionName()] = (string) $active;
1195 // Getter for EXT_ALWAYS_ACTIVE flag
1196 function getExtensionAlwaysActive () {
1197 return $GLOBALS['ext_always_active'][getCurrentExtensionName()];
1200 // Checks wether the current extension is always active
1201 function isExtensionAlwaysActive () {
1202 return (getExtensionAlwaysActive() == 'Y');
1205 // Setter for EXT_VERSION flag
1206 function setThisExtensionVersion ($version) {
1207 $GLOBALS['ext_version'][getCurrentExtensionName()] = (string) $version;
1210 // Getter for EXT_VERSION flag
1211 function getThisExtensionVersion () {
1212 return $GLOBALS['ext_version'][getCurrentExtensionName()];
1215 // Setter for EXT_DEPRECATED flag
1216 function setExtensionDeprecated ($deprecated) {
1217 $GLOBALS['ext_deprecated'][getCurrentExtensionName()] = (string) $deprecated;
1220 // Getter for EXT_DEPRECATED flag
1221 function isExtensionDeprecated () {
1222 return ($GLOBALS['ext_deprecated'][getCurrentExtensionName()] == 'Y');
1225 // Setter for EXT_UPDATE_DEPENDS flag
1226 function addExtensionUpdateDependency ($updateDepends) {
1227 //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - ENTERED!');
1228 // Is the update depency empty? (NEED TO BE FIXED!)
1229 if (empty($updateDepends)) {
1230 // Please report this bug!
1231 debug_report_bug(__FUNCTION__, __LINE__, 'updateDepends is empty: currentExtension=' . getCurrentExtensionName());
1234 // Is it not yet added?
1236 if ((isset($updateDepends, $GLOBALS['ext_running_updates'][getCurrentExtensionName()])) && (in_array($updateDepends, getExtensionUpdatesRunning()))) {
1237 // Double-adding isn't fine, too
1238 debug_report_bug(__FUNCTION__, __LINE__, '() called twice: updateDepends=' . $updateDepends . ',currentExtension=' . getCurrentExtensionName());
1242 // Add it to the list of extension update depencies map
1243 $GLOBALS['ext_update_depends'][getCurrentExtensionName()][] = (string) $updateDepends;
1245 // Remember it in the list of running updates
1246 $GLOBALS['ext_running_updates'][getCurrentExtensionName()][] = $updateDepends;
1247 //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - EXIT!');
1250 // Getter for running updates
1251 function getExtensionUpdatesRunning () {
1252 return $GLOBALS['ext_running_updates'][getCurrentExtensionName()];
1255 // Checks wether the given extension registration is in progress
1256 function isExtensionRegistrationRunning ($ext_name) {
1258 $isRunning = ((isset($GLOBALS['ext_register_running'])) && (in_array($ext_name, $GLOBALS['ext_register_running'])));
1261 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ', isRunning=' . intval($isRunning));
1265 // Init EXT_UPDATE_DEPENDS flag
1266 function initExtensionUpdateDependencies () {
1267 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - ENTERED!');
1269 // Init update depency map automatically if not found
1270 if (isExtensionUpdateDependenciesInitialized()) {
1271 // We need these bug reports as well...
1272 debug_report_bug(__FUNCTION__, __LINE__, '() is called twice: currName=' . getCurrentExtensionName());
1275 $GLOBALS['ext_update_depends'][getCurrentExtensionName()] = array();
1277 // Init running updates array
1278 initExtensionRuningUpdates();
1280 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - EXIT!');
1283 // Adds an extension as "registration in progress"
1284 function addExtensionRunningRegistration ($ext_name) {
1286 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - ENTERED!');
1287 if (isExtensionRegistrationRunning($ext_name)) {
1288 // This is really bad and should not be quietly ignored
1289 debug_report_bug(__FUNCTION__, __LINE__, '() already called! ext_name=' . $ext_name);
1293 $GLOBALS['ext_register_running'][] = $ext_name;
1294 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - EXIT!');
1297 // Checks wether EXT_UPDATE_DEPENDS is initialized
1298 function isExtensionUpdateDependenciesInitialized () {
1299 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1300 return (isset($GLOBALS['ext_update_depends'][getCurrentExtensionName()]));
1303 // Checks wether an update is already running for given extension
1304 function isExtensionUpdateRunning ($ext_name) {
1305 // Current and given extensions means whole array
1306 if ($ext_name == getCurrentExtensionName()) {
1307 // Default is not found
1310 // Walk through whole array
1311 foreach ($GLOBALS['ext_running_updates'] as $ext1=>$depends) {
1313 if (($ext1 == $ext_name) || ($isRunning === true)) {
1315 logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=' . intval($isRunning));
1322 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ', isRunning=' . intval($isRunning));
1327 $isRunning = ((isExtensionUpdateDependenciesInitialized()) && (in_array($ext_name, getExtensionRunningUpdates())));
1330 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ', isRunning=' . intval($isRunning));
1334 // Initializes the list of running updates
1335 function initExtensionRuningUpdates () {
1336 // Auto-init ext_running_updates
1337 if (!isset($GLOBALS['ext_running_updates'])) {
1338 $GLOBALS['ext_running_updates'] = array();
1339 $GLOBALS['ext_register_running'] = array();
1343 // Getter for EXT_UPDATE_DEPENDS flag
1344 function getExtensionUpdateDependencies () {
1345 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1346 return $GLOBALS['ext_update_depends'][getCurrentExtensionName()];
1349 // Getter for next iterator depency
1350 function getExtensionUpdateDependenciesIterator () {
1351 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1352 return ($GLOBALS['ext_update_depends'][getCurrentExtensionName()][getExtensionUpdateIterator()]);
1355 // Counter for extension update depencies
1356 function countExtensionUpdateDependencies () {
1357 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1358 return count($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1361 // Removes given extension from update denpency list
1362 function removeExtensionUpdateDependency ($ext_name) {
1364 $key = array_search($ext_name, getExtensionUpdateDependencies());
1367 if ($key !== false) {
1369 unset($GLOBALS['ext_update_depends'][getCurrentExtensionName()][$key]);
1371 // And sort the array
1372 ksort($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1376 // Init iterator for update depencies
1377 function initExtensionUpdateIterator () {
1378 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1379 $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()] = '0';
1382 // Getter for depency iterator
1383 function getExtensionUpdateIterator () {
1384 // Auto-init iterator
1385 if (!isset($GLOBALS['ext_depend_iterator'][getCurrentExtensionName()])) initExtensionUpdateIterator();
1388 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName().'/'.$GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]);
1389 return $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()];
1392 // Increments the update iterator
1393 function incrementExtensionUpdateIterator () {
1394 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "currName=".getCurrentExtensionName());
1395 $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]++;
1398 // Setter for EXT_REPORTS_FAILURE flag
1399 function setExtensionReportsFailure ($reportsFailure) {
1400 $GLOBALS['ext_reports_failure'] = (bool) $reportsFailure;
1403 // Getter for EXT_REPORTS_FAILURE flag
1404 function getExtensionReportsFailure () {
1405 return $GLOBALS['ext_reports_failure'];
1408 // Setter for EXT_VER_HISTORY flag
1409 function setExtensionVersionHistory ($verHistory) {
1410 $GLOBALS['ext_ver_history'][getCurrentExtensionName()] = (array) $verHistory;
1413 // Getter for EXT_VER_HISTORY array
1414 function getExtensionVersionHistory () {
1415 return $GLOBALS['ext_ver_history'][getCurrentExtensionName()];
1418 // Setter for EXT_UPDATE_NOTES
1419 function setExtensionUpdateNotes ($updateNotes, $ver='') {
1420 // . '/' . getCurrentExtensionVersion()
1421 //* DEBUG: */ debug_report_bug(__FUNCTION__.':' . getCurrentExtensionName() . '/' . getExtensionMode() . '/' . $ver . '=' . $updateNotes);
1423 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][getCurrentExtensionVersion()] = (string) $updateNotes;
1425 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ver] = (string) $updateNotes;
1429 // Getter for EXT_UPDATE_NOTES
1430 function getExtensionUpdateNotes ($ver) {
1431 return $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ver];
1434 // Checks if ext_update_notes is set
1435 function isExtensionUpdateNoteSet ($ver) {
1436 return isset($GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ver]);
1439 // Init extension notice
1440 function initExtensionNotes () {
1441 $GLOBALS['ext_notes'][getCurrentExtensionName()] = '';
1444 // Append extension notice
1445 function appendExtensionNotes ($notes) {
1446 $GLOBALS['ext_notes'][getCurrentExtensionName()] .= (string) trim($notes);
1449 // Getter for extension notes
1450 function getExtensionNotes () {
1451 return $GLOBALS['ext_notes'][getCurrentExtensionName()];
1454 // Setter for current extension name
1455 function setCurrentExtensionName ($ext_name) {
1456 $GLOBALS['curr_EXTENSION_name'] = (string) trim($ext_name);
1459 // Getter for current extension name
1460 function getCurrentExtensionName () {
1461 if (isset($GLOBALS['curr_EXTENSION_name'])) {
1462 return $GLOBALS['curr_EXTENSION_name'];
1466 debug_report_bug(__FUNCTION__.": curr_EXTENSION_name not initialized. Please execute initExtensionSqls() before calling this function.");
1469 // Init SQLs array for current extension
1470 function initExtensionSqls ($force = false) {
1471 // Auto-init the array or if forced
1472 if ((!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) || ($force === true)) {
1474 $GLOBALS['ext_sqls'][getCurrentExtensionName()] = array();
1476 // Initialize the generic array
1481 // Adds SQLs to the SQLs array but "assigns" it with current extension name
1482 function addExtensionSql ($sql) {
1484 $GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()][] = $sql;
1487 // Getter for SQLs array for current extension
1488 function getExtensionSqls () {
1489 // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1490 if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1491 // Not found, should not happen
1492 debug_report_bug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1493 getCurrentExtensionName()
1498 return $GLOBALS['ext_sqls'][getCurrentExtensionName()];
1501 // Removes SQLs for current extension
1502 function unsetExtensionSqls () {
1503 unset($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1506 // Auto-initializes the removal list
1507 function initExtensionRemovalList () {
1508 // Is the remove list there?
1509 if (!isset($GLOBALS['ext_update_remove'])) {
1511 $GLOBALS['ext_update_remove'] = array();
1515 // Checks wether the current extension is on the removal list
1516 function isExtensionOnRemovalList () {
1517 // Init removal list
1518 initExtensionRemovalList();
1521 return (in_array(getCurrentExtensionName(), $GLOBALS['ext_update_remove']));
1524 // Adds the current extension to the removal list
1525 function addCurrentExtensionToRemovalList () {
1527 $GLOBALS['ext_update_remove'][] = getCurrentExtensionName();
1530 // Getter for removal list
1531 function getExtensionRemovalList () {
1532 // Return the removal list
1533 return $GLOBALS['ext_update_remove'];
1536 // Redirects if the provided extension is not installed
1537 function redirectOnUninstalledExtension ($ext_name) {
1538 // So is the extension there?
1539 if ((!isExtensionInstalled($ext_name)) || (!isExtensionActive($ext_name))) {
1540 // Redirect to index
1541 redirectToUrl('modules.php?module=index&code=' . getCode('EXTENSION_PROBLEM') . '&ext=' . $ext_name);
1545 // Filter for initialization of all extensions by loading them in 'init' mode
1546 function FILTER_INIT_EXTENSIONS () {
1547 // Do we have some entries?
1548 //* DEBUG */ print __FUNCTION__.': ENTRY!<br />';
1549 if (isset($GLOBALS['cache_array']['extension']['ext_name'])) {
1550 // Load all found extensions if found
1551 //* DEBUG */ print __FUNCTION__.': CACHE - START!<br />';
1552 foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) {
1554 //* DEBUG */ print __FUNCTION__.': '.$ext_name.' - START<br />';
1555 loadExtension($ext_name, 'init', getExtensionVersion($ext_name));
1556 //* DEBUG */ print __FUNCTION__.': '.$ext_name.' - END<br />';
1558 //* DEBUG */ print __FUNCTION__.': CACHE - END!<br />';
1560 //* DEBUG */ print __FUNCTION__.': EXIT!<br />';
1563 // Setter for extension mode
1564 function setExtensionMode ($ext_mode) {
1565 $GLOBALS['ext_mode'] = (string) $ext_mode;
1568 // Getter for extension mode
1569 function getExtensionMode () {
1570 return $GLOBALS['ext_mode'];
1573 // Setter for dry-run
1574 function enableExtensionDryRun ($dry_run = true) {
1575 //* DEBUG: */ debugOutput(__FUNCTION__.': '.getCurrentExtensionName().'='.intval($dry_run));
1576 $GLOBALS['ext_dry_run'] = (bool) $dry_run;
1579 // Getter for dry-run
1580 function isExtensionDryRun () {
1581 return $GLOBALS['ext_dry_run'];
1584 // Setter for current extension version
1585 function setCurrentExtensionVersion ($ext_ver) {
1586 // ext_ver should never be empty in other modes than 'test'
1587 if ((empty($ext_ver)) && (getExtensionMode() != 'test')) {
1588 // Please report all these messages
1589 debug_report_bug(__FUNCTION__, __LINE__, 'ext_ver is empty. Current extension name: ' . getCurrentExtensionName() . ', mode=' . getExtensionMode());
1593 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver);
1594 $GLOBALS['ext_current_version'][getCurrentExtensionName()] = (string) $ext_ver;
1597 // Getter for current extension version
1598 function getCurrentExtensionVersion () {
1599 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $GLOBALS['ext_current_version'][getCurrentExtensionName()]);
1600 return $GLOBALS['ext_current_version'][getCurrentExtensionName()];
1603 // Remove the extension from cache array
1604 function removeExtensionFromArray () {
1605 // "Cache" this name
1606 $ext_name = getCurrentExtensionName();
1608 // Now loop through the whole cache
1609 foreach ($GLOBALS['cache_array']['extension'] as $cacheName => $cacheArray) {
1610 // Is it an element?
1611 if (isset($cacheArray[$ext_name])) {
1613 unset($cacheArray[$ext_name]);
1614 $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1617 $key = array_search($ext_name, $cacheArray);
1620 if ($key !== false) {
1621 // Found, so remove it
1622 unset($cacheArray[$key]);
1623 $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1629 // "Getter" for 'extension has a CSS file' (with same name, of course)
1630 function getExtensionHasCss () {
1631 // Default is no CSS
1634 // Construct FQFN for check
1635 $FQFN = sprintf("%stheme/%s/css/%s.css",
1638 getCurrentExtensionName()
1642 if (isFileReadable($FQFN)) {
1643 // Readable, so it is there...
1651 // Checks wether the given extension has a language file
1652 function ifExtensionHasLanguageFile ($ext_name) {
1653 // Default is no language file
1654 $hasLanguage = false;
1656 // Do we have cache?
1657 if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) {
1659 $hasLanguage = ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y');
1662 incrementStatsEntry('cache_hits');
1664 // Not readable is default
1667 // Is the language file readable for this extension?
1668 if (isLanguageIncludeReadable($ext_name)) {
1674 $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = 'Y';
1678 return ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y');
1681 // Load an extension's include file
1682 function loadExtensionInclude () {
1684 if (!isExtensionIncludeReadable()) {
1686 debug_report_bug(__FUNCTION__, __LINE__, 'Extension ' . getCurrentExtensionName() . ' should be loaded, but is not readable.');
1689 // Generate INC name
1690 $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1696 // Checks wether an extension is readable
1697 function isExtensionIncludeReadable ($ext_name = '') {
1698 // If empty, use current
1699 if (empty($ext_name)) $ext_name = getCurrentExtensionName();
1702 if (!isset($GLOBALS['ext_inc_readable'][$ext_name])) {
1703 // Generate INC name
1704 $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1707 $GLOBALS['ext_inc_readable'][$ext_name] = isIncludeReadable($INC);
1711 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',realable='.intval($GLOBALS['ext_inc_readable'][$ext_name]));
1712 return $GLOBALS['ext_inc_readable'][$ext_name];
1715 // Checks if an extension's function file is readable
1716 function isExtensionFunctionFileReadable ($ext_name) {
1717 if (isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) {
1718 // Just count cache hits
1719 incrementStatsEntry('cache_hits');
1721 // Construct FQFN for functions file
1722 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
1724 // Is this include there?
1725 if ((isFileReadable($funcsInclude)) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name])) && (getExtensionMode() == 'test')) {
1727 $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = 'Y';
1730 $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = 'N';
1735 return ($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y');
1738 // Adds an admin menu to the SQL queue of the menu entry is not found
1739 function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
1740 // Now check if this menu is there
1741 if (!isMenuActionValid('admin', $action, $what)) {
1743 if (is_null($what)) {
1745 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES('%s',NULL,'%s','%s',%s)",
1753 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES('%s','%s','%s','%s',%s)",
1762 // Add it to the queue
1763 addExtensionSql($sql);
1764 } elseif (isDebugModeEnabled()) {
1765 // Double menus should be located and fixed!
1766 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double admin menu action=%s, what=%s detected.", $action, $what));
1770 // Adds a guest menu to the SQL queue if the menu entry is not found
1771 function addGuestMenuSql ($action, $what, $title, $visible, $locked, $sort) {
1772 // Now check if this menu is there
1773 if (!isMenuActionValid('guest', $action, $what)) {
1775 if (is_null($what)) {
1777 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s',NULL,'%s','%s','%s',%s)",
1786 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s','%s','%s','%s','%s',%s)",
1796 // Add it to the queue
1797 addExtensionSql($sql);
1798 } elseif (isDebugModeEnabled()) {
1799 // Double menus should be located and fixed!
1800 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s, what=%s detected.", $action, $what));
1804 // Adds a member menu to the SQL queue if the menu entry is not found
1805 function addMemberMenuSql ($action, $what, $title, $visible, $locked, $sort) {
1806 // Now check if this menu is there
1807 if (!isMenuActionValid('member', $action, $what)) {
1809 if (is_null($what)) {
1811 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s',NULL,'%s','%s','%s',%s)",
1820 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES('%s','%s','%s','%s','%s',%s)",
1830 // Add it to the queue
1831 addExtensionSql($sql);
1832 } elseif (isDebugModeEnabled()) {
1833 // Double menus should be located and fixed!
1834 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double member menu action=%s, what=%s detected.", $action, $what));
1838 // Adds a sponsor menu to the SQL queue if the menu entry is not found
1839 function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
1840 // Now check if this menu is there, if no ext-sponsor is installed all is not yet added
1841 if ((!isExtensionInstalled('sponsor')) || (!isMenuActionValid('sponsor', $action, $what))) {
1843 if (is_null($what)) {
1845 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES('%s',NULL,'%s','%s',%s)",
1853 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES('%s','%s','%s','%s',%s)",
1862 // Add it to the queue
1863 addExtensionSql($sql);
1864 } elseif (isDebugModeEnabled()) {
1865 // Double menus should be located and fixed!
1866 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double sponsor menu action=%s, what=%s detected.", $action, $what));
1870 // Enables/disables productive mode for current extension (used only while
1872 function enableExtensionProductive ($isProductive = true) {
1873 $GLOBALS['ext_productive'][getCurrentExtensionName()] = (bool) $isProductive;
1876 // Checks wether the extension is in productive phase. If not set, development
1877 // phase (=false) is assumed.
1878 function isExtensionProductive () {
1879 return ((isset($GLOBALS['ext_productive'][getCurrentExtensionName()])) && ($GLOBALS['ext_productive'][getCurrentExtensionName()] === true));