X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fextensions-functions.php;h=90b2bd495df94252c973e6c72a9bd5241d997fd8;hp=8c52528550e4827bd31686598f57580e6a16d1f7;hb=be39a7fb887473487fd2c5f8d550aa03b720cb73;hpb=04b69ac9f33369cbf654396c4a42cb1fff710ff4 diff --git a/inc/extensions-functions.php b/inc/extensions-functions.php index 8c52528550..90b2bd495d 100644 --- a/inc/extensions-functions.php +++ b/inc/extensions-functions.php @@ -14,11 +14,9 @@ * $Date:: $ * * $Tag:: 0.2.1-FINAL $ * * $Author:: $ * - * Needs to be in all Files and every File needs "svn propset * - * svn:keywords Date Revision" (autoprobset!) at least!!!!!! * * -------------------------------------------------------------------- * * Copyright (c) 2003 - 2009 by Roland Haeder * - * Copyright (c) 2009, 2010 by Mailer Developer Team * + * Copyright (c) 2009 - 2011 by Mailer Developer Team * * For more information visit: http://www.mxchange.org * * * * This program is free software; you can redistribute it and/or modify * @@ -43,9 +41,11 @@ if (!defined('__SECURITY')) { } // END - if // Load the extension and maybe found language and function files. -function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = false) { - // If this happens twice, we need the bug report from you, except for updates/tests +function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0', $dry_run = false) { + // Loading an extension in same mode, but not test/update, twice is not + // good, so is the extension $ext_name already loaded in mode $ext_mode? if ((isset($GLOBALS['loaded_extension'][$ext_name][$ext_mode])) && (!in_array($ext_mode, array('update', 'test')))) { + // If this happens twice, we need the bug report from you, except for updates/tests 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)); } // END - if @@ -58,17 +58,26 @@ function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = // Set current extension name setCurrentExtensionName($ext_name); + // By default all extensions are in productive phase + enableExtensionProductive(); + if (!empty($ext_ver)) { // Set current extension version setCurrentExtensionVersion($ext_ver); } else { - // Set it to 0.0 + // Set it to 0.0 by default setCurrentExtensionVersion('0.0'); + // Is the extension installed? + if ((isExtensionInstalled($ext_name)) && ($ext_mode != 'register')) { + // Get extension's version + setCurrentExtensionVersion(getExtensionVersion($ext_name)); + } // END - if + // In all but test-mode we need these messages to debug! Please report all (together, e.g.) - if ($ext_mode != 'test') { - // Log empty versions not in test-mode, but maybe it is fine... - logDebugMessage(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0. ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', dry_run=' . intval($dry_run)); + if (($ext_mode != 'test') && (getCurrentExtensionVersion() == '0.0')) { + // Abort here, this must now always be set! + 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)); } // END - if } @@ -89,7 +98,7 @@ function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = // Is the extension already loaded? //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loading extension ' . $ext_name . ', mode=' . getExtensionMode() . ', ver=' . getCurrentExtensionVersion()); - if ((isset($GLOBALS['ext_loaded']['ext'][$ext_name])) && (getExtensionMode() == 'init')) { + if ((isExtensionLoaded($ext_name)) && (getExtensionMode() == 'init')) { // Debug message logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name)); @@ -115,17 +124,17 @@ function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = // Do we have cache? if (isExtensionFunctionFileReadable($ext_name)) { // Not yet loaded? - 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]))) { - // Construct FQFN for functions file + if ((($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y') || (!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name]))) && (!isExtensionLibraryLoaded($ext_name))) { + // Construct IFN for functions file $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name); // Mark it as loaded - $GLOBALS['ext_loaded']['funcs'][$ext_name] = true; + markExtensionLibraryAsLoaded($ext_name); // Download functions file loadIncludeOnce($funcsInclude); } // END - if - } 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')) { + } elseif ((!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) && (isDebugModeEnabled()) && (isHtmlOutputMode()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme') && (getExtensionMode() == 'test')) { // No functions file is not so good... logDebugMessage(__FUNCTION__, __LINE__, sprintf("NOTICE: Extension %s has no own functions file or we cannot read from it. mode=%s", $ext_name, @@ -133,6 +142,9 @@ function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = )); } + // Load extension's filter library if present + loadExtensionFilters($ext_name); + // Extensions are not deprecated by default setExtensionDeprecated('N'); @@ -158,7 +170,7 @@ function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = // Mark it as loaded in normal mode if (getExtensionMode() == '') { // Mark it now... - $GLOBALS['ext_loaded']['ext'][$ext_name] = true; + markExtensionAsLoaded($ext_name); } // END - if // All fine! @@ -166,9 +178,9 @@ function loadExtension ($ext_name, $ext_mode = 'init', $ext_ver = '', $dry_run = } // Registeres an extension and possible update depencies -function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = true) { +function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true) { // Set current extension name - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . $task_id . ',dry_run=' . intval($dry_run) . ',logout=' . intval($logout) . ' - ENTERED!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . $taskId . ',dry_run=' . intval($dry_run) . ',logout=' . intval($logout) . ' - ENTERED!'); setCurrentExtensionName($ext_name); // Enable dry-run @@ -200,17 +212,23 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru } // END - if // Is the task id zero? Then we need to auto-fix it here - if ($task_id == '0') { + if ($taskId == '0') { // Try to find the task - $task_id = determineExtensionTaskId(getCurrentExtensionName()); + $taskId = determineExtensionTaskId(getCurrentExtensionName()); // Still zero and not in dry-run? - if (($task_id == '0') && (!getExtensionDryRun())) { - // Then request a bug report - debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId(%s)", - __FUNCTION__, - getCurrentExtensionName() - )); + if (($taskId == '0') && (!isExtensionDryRun())) { + // Now try to create a new task + $taskId = createNewExtensionTask(getCurrentExtensionName()); + + // Is it still zero? + if ($taskId == '0') { + // Then request a bug report + debug_report_bug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId(%s)", + __FUNCTION__, + getCurrentExtensionName() + )); + } // END - if } // END - if } // END - if @@ -228,20 +246,20 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru // Does this extension exists? //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName()); - if (loadExtension(getCurrentExtensionName(), 'register', '', getExtensionDryRun())) { + if (loadExtension(getCurrentExtensionName(), 'register', '0.0', isExtensionDryRun())) { // Set current extension name again setCurrentExtensionName($ext_name); // And run possible updates //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName()); $history = getExtensionVersionHistory(); - foreach ($history as $ver) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $ver); + foreach ($history as $ext_ver) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $ext_ver); // Load extension in update mode - loadExtension(getCurrentExtensionName(), 'update', $ver, getExtensionDryRun()); + loadExtension(getCurrentExtensionName(), 'update', $ext_ver, isExtensionDryRun()); // Add update notes to our output - addExtensionNotes($ver); + addExtensionNotes($ext_ver); } // END - foreach // Does this extension depends on an outstanding update of another update? @@ -254,7 +272,7 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru // Check if extension is not installed and not already in registration procedure and if loading it wents finally fine... //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isExtensionRegistrationRunning(' . $ext_update . ')=' . intval(isExtensionRegistrationRunning($ext_update))); - if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', getExtensionDryRun()))) { + if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', isExtensionDryRun()))) { // Set current extension name again setCurrentExtensionName($ext_name); @@ -274,19 +292,18 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru if ($task > 0) { // Try to register the extension //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ':ext_update=' . $ext_update . ',taskId=' . $task); - $test = registerExtension($ext_update, $task, getExtensionDryRun(), false); + $test = registerExtension($ext_update, $task, isExtensionDryRun(), false); // Reset extension name setCurrentExtensionName($ext_name); - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName()); - //* DEBUG: */ debugOutput(getCurrentExtensionName().':
' . print_r($test, true) . '
'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',test=' . intval($test)); } // END - if } elseif ($ext_ver != getCurrentExtensionVersion()) { // Ok, update this extension now //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion()); $GLOBALS['ext_backup_name'][$ext_update][$ext_ver] = getCurrentExtensionName(); $GLOBALS['ext_backup_ver'][$ext_update][$ext_ver] = getCurrentExtensionVersion(); - updateExtension($ext_update, $ext_ver, getExtensionDryRun()); + updateExtension($ext_update, $ext_ver, isExtensionDryRun()); setCurrentExtensionName($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]); setCurrentExtensionVersion($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]); unset($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]); @@ -319,69 +336,68 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru setExtensionMode('register'); // Remains true if extension registration reports no failures - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName()); - //* DEBUG: */ debugOutput(getCurrentExtensionName().':
' . print_r($test, true) . '
'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',test=' . intval($test)); $test = (($test === true) && (getExtensionReportsFailure() === false)); - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName()); - //* DEBUG: */ debugOutput(getCurrentExtensionName().':
' . print_r($test, true) . '
'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',test=' . intval($test)); // Does everthing before wents ok? if ($test === true) { // "Dry-run-mode" activated? - if ((getExtensionDryRun() === false) && (!isExtensionOnRemovalList())) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName()); + if ((isExtensionDryRun() === false) && (!isExtensionOnRemovalList())) { // Init SQLs and transfer ext->generic + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName()); initSqls(); setSqlsArray(getExtensionSqls()); // Run installation pre-installation filters - runFilterChain('pre_extension_installed', array('dry_run' => getExtensionDryRun())); + runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false)); // Register extension //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!'); if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss()); // New way, with CSS + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss()); SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`,`ext_has_css`) VALUES ('%s','%s','%s','%s')", array( getCurrentExtensionName(), - getExtensionAlwaysActive(), + getThisExtensionAlwaysActive(), getCurrentExtensionVersion(), getExtensionHasCss() ), __FUNCTION__, __LINE__); } else { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion()); // Old way, no CSS + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion()); SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`) VALUES ('%s','%s','%s')", array( getCurrentExtensionName(), - getExtensionAlwaysActive(), + getThisExtensionAlwaysActive(), getCurrentExtensionVersion() ), __FUNCTION__, __LINE__); } + // Use the insert id as extension id and cache it for early usage + $GLOBALS['cache_array']['extension']['ext_id'][getCurrentExtensionName()] = SQL_INSERTID(); + $GLOBALS['cache_array']['extension']['ext_name'][SQL_INSERTID()] = getCurrentExtensionName(); + + // Mark it as installed + $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true; + // Remove cache file(s) if extension is active runFilterChain('post_extension_installed', array( 'pool' => 'extension', 'ext_name' => getCurrentExtensionName(), - 'task_id' => $task_id + 'task_id' => $taskId )); // Re-init queries and notes initExtensionSqls(true); - initExtensionNotes(); - - // Mark it as installed - $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true; + initExtensionNotes(true); // In normal mode return a true on success $ret = true; - } elseif (getExtensionDryRun() === true) { + } elseif (isExtensionDryRun() === true) { // In "dry-run" mode do always return a true $ret = true; - - // Re-init queries and notes - initExtensionNotes(); } else { // Extension has been removed for updates, so all is fine! $ret = true; @@ -391,16 +407,16 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName()); $ret = false; } - } elseif (($task_id > 0) && (getCurrentExtensionName() != '')) { + } elseif (($taskId > 0) && (getCurrentExtensionName() != '')) { //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName()); // Remove task from system when id and extension's name is valid SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `status`='NEW' LIMIT 1", - array(bigintval($task_id)), __FUNCTION__, __LINE__); + array(bigintval($taskId)), __FUNCTION__, __LINE__); } // Is this the sql_patches? //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . '/' . getExtensionMode()); - if ((getCurrentExtensionName() == 'sql_patches') && ((getExtensionMode() == 'register') || (getExtensionMode() == 'remove')) && (!getExtensionDryRun()) && ($test)) { + if ((getCurrentExtensionName() == 'sql_patches') && ((getExtensionMode() == 'register') || (getExtensionMode() == 'remove')) && (!isExtensionDryRun()) && ($test)) { //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ': LOAD!'); if ($logout === true) { // Then redirect to logout @@ -413,8 +429,7 @@ function registerExtension ($ext_name, $task_id, $dry_run = false, $logout = tru } // END - if // Return status code - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ' - EXIT!'); - //* DEBUG: */ debugOutput(getCurrentExtensionName().':
'.print_r($ret, true).'
'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',test=' . intval($test) . ' - EXIT!'); return $ret; } @@ -437,20 +452,23 @@ function doExtensionSqls ($ext_id, $load_mode) { } // END - if // Init array - initExtensionSqls(); + initExtensionSqls(true); // By default no SQL has been executed $sqlRan = false; // Load extension in detected mode - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]=".getCurrentExtensionName().""); - loadExtension(getCurrentExtensionName(), $load_mode, '', false); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name[' . $ext_id . ']=' . getCurrentExtensionName() . ',load_mode=' . $load_mode); + loadExtension(getCurrentExtensionName(), $load_mode, '0.0', false); // Init these SQLs initSqls(); setSqlsArray(getExtensionSqls()); - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ":SQLs::count=".countSqls().""); + // Debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls()); + + // Do we have entries? if (isSqlsValid()) { // Run SQL commands... runFilterChain('run_sqls'); @@ -460,16 +478,16 @@ function doExtensionSqls ($ext_id, $load_mode) { runFilterChain('extension_' . $load_mode); // Remove cache file(s) if extension is active - if (((isExtensionActive('cache')) && ((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate'))) { + if (((isExtensionActive('cache')) && ((!SQL_HASZEROAFFECTED())) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate'))) { // Run filters runFilterChain('post_extension_run_sql', getCurrentExtensionName()); } // END - if // Is this the sql_patches? - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": id=".$ext_id.",currName=".getCurrentExtensionName().",loadMode=".$load_mode); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $ext_id . ',currName=' . getCurrentExtensionName() . ',loadMode=' . $load_mode); if ((getCurrentExtensionName() == 'sql_patches') && (($load_mode == 'register') || ($load_mode == 'remove'))) { // Then redirect to logout - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": LOAD!"); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ': LOAD!'); redirectToUrl('modules.php?module=admin&logout=1&' . $load_mode . '=sql_patches'); } // END - if } @@ -479,7 +497,7 @@ function isExtensionInstalled ($ext_name) { // We don't like empty extension names here if (empty($ext_name)) { // Please fix them all - debug_report_bug(__FUNCTION__.': ext_name is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'ext_name is empty.'); } // END - if // By default non is installed @@ -501,6 +519,9 @@ function isExtensionInstalled ($ext_name) { // Look in database $ext_id = getExtensionId($ext_name); + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension ' . $ext_name . ' has ext_id=' . $ext_id); + // Do we have a record? $isInstalled = ($ext_id > 0); @@ -520,8 +541,16 @@ function isExtensionInstalled ($ext_name) { // Check if given extension is active function isExtensionActive ($ext_name) { - // Extensions are all inactive during installation - if ((isInstallationPhase()) || (empty($ext_name))) return false; + if (isInstallationPhase()) { + // Extensions are all inactive during installation + return false; + } elseif (empty($ext_name)) { + // Empty extension names must befixed + debug_report_bug(__FUNCTION__, __LINE__, 'Empty extension name provided.'); + } elseif (!isExtensionInstalled($ext_name)) { + // Not installed extensions are always inactive + return false; + } // Not active is the default $data['ext_active'] = 'N'; @@ -529,16 +558,16 @@ function isExtensionActive ($ext_name) { // Check cache if (isset($GLOBALS['cache_array']['extension']['ext_active'][$ext_name])) { // Load from cache - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "CACHE! ext_name={$ext_name}"); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE! ext_name=' . $ext_name); $data['ext_active'] = $GLOBALS['cache_array']['extension']['ext_active'][$ext_name]; // Count cache hits incrementStatsEntry('cache_hits'); - } elseif (isset($GLOBALS['ext_loaded'][$ext_name])) { + } elseif (isExtensionLoaded($ext_name)) { // @TODO Extension is loaded, what next? debug_report_bug(__FUNCTION__, __LINE__, 'LOADED:' . $ext_name); } elseif (($ext_name == 'cache') || (!isExtensionInstalled('cache'))) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}"); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DB! ext_name=' . $ext_name); // Load from database $result = SQL_QUERY_ESC("SELECT `ext_active` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1", array($ext_name), __FUNCTION__, __LINE__); @@ -553,16 +582,16 @@ function isExtensionActive ($ext_name) { SQL_FREERESULT($result); // Write cache array - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name=".$ext_name."[DB]: ".$data['ext_active'].""); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . '[DB]: ' . $data['ext_active']); $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = $data['ext_active']; } else { // Extension not active! - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name=".$ext_name.": Not active!"); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': Not active!'); $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = 'N'; } // Debug message - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name=".$ext_name.",active=".$data['ext_active'].""); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',active=' . $data['ext_active']); // Is this extension activated? (For admins we always have active extensions...) return ($data['ext_active'] == 'Y'); @@ -581,7 +610,7 @@ function getExtensionVersion ($ext_name, $force = false) { // Extensions are all inactive during installation if (isInstallationPhase()) return ''; - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": ext_name=".$ext_name.""); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name); // Is the cache written? if (isset($GLOBALS['cache_array']['extension']['ext_version'][$ext_name])) { @@ -591,7 +620,7 @@ function getExtensionVersion ($ext_name, $force = false) { // Count cache hits incrementStatsEntry('cache_hits'); - } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (getOutputMode() != 0)) { + } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (!isHtmlOutputMode())) { // Load from database $result = SQL_QUERY_ESC("SELECT `ext_version` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1", array($ext_name), __FUNCTION__, __LINE__); @@ -620,14 +649,16 @@ function getExtensionVersion ($ext_name, $force = false) { } // END - if // Return result - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ": ret={$data['ext_version']}"); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_version=' . $data['ext_version']); return $data['ext_version']; } // Updates a given extension with current extension version to latest version function updateExtension ($ext_name, $ext_ver, $dry_run = false) { // Only admins are allowed to update extensions - if ((!isAdmin()) || (empty($ext_name))) return false; + if ((!isAdmin()) || (empty($ext_name))) { + return false; + } // END - if // Set current SQL name setCurrentExtensionName($ext_name); @@ -638,7 +669,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { initIncludePool('extension'); // Load extension in test mode - loadExtension($ext_name, 'test', $ext_ver, getExtensionDryRun()); + loadExtension($ext_name, 'test', $ext_ver, isExtensionDryRun()); // Save version history $history = getExtensionVersionHistory(); @@ -647,8 +678,8 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { initExtensionSqls(); // Check if version is updated - //* DEBUG: */ debugOutput(getCurrentExtensionName().'/'.$ext_name.':'.getThisExtensionVersion().'/'.$ext_ver.'/'.intval(is_array($history))); - if (((getThisExtensionVersion() != $ext_ver) || (getExtensionDryRun())) && (is_array($history))) { + //* DEBUG: */ debugOutput(getCurrentExtensionName() . '/' . $ext_name . ':' . getThisExtensionVersion() . '/' . $ext_ver . '/' . intval(is_array($history))); + if (((getThisExtensionVersion() != $ext_ver) || (isExtensionDryRun())) && (is_array($history))) { // Search for starting point $start = array_search($ext_ver, $history); @@ -658,7 +689,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { $GLOBALS['update_ver'][getCurrentExtensionName()] = $history[$idx]; // Load again... - loadExtension(getCurrentExtensionName(), 'update', $GLOBALS['update_ver'][getCurrentExtensionName()], getExtensionDryRun()); + loadExtension(getCurrentExtensionName(), 'update', $GLOBALS['update_ver'][getCurrentExtensionName()], isExtensionDryRun()); // Get all depencies $depencies = getExtensionUpdateDependencies(); @@ -678,10 +709,10 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { // Is the extension there? if (isExtensionInstalled($ext_depend)) { // Update another extension first! - $test = updateExtension($ext_depend, getExtensionVersion($ext_depend), getExtensionDryRun()); + $test = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun()); } else { // Register new extension - $test = registerExtension($ext_depend, 0, getExtensionDryRun(), false); + $test = registerExtension($ext_depend, 0, isExtensionDryRun(), false); } } // END - if } // END - foreach @@ -698,7 +729,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { } // END - for // In real-mode execute any existing includes - if (getExtensionDryRun() === false) { + if (isExtensionDryRun() === false) { $GLOBALS['ext_inc_pool'][getCurrentExtensionName()] = getIncludePool('extension'); runFilterChain('load_includes', 'extension'); setIncludePool('extension', $GLOBALS['ext_inc_pool'][getCurrentExtensionName()]); @@ -710,9 +741,9 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { setSqlsArray(getExtensionSqls()); // Run SQLs - runFilterChain('run_sqls', array('dry_run' => getExtensionDryRun())); + runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false)); - if (getExtensionDryRun() === false) { + if (isExtensionDryRun() === false) { // Run filters on success extension update runFilterChain('extension_update', getCurrentExtensionName()); } // END - if @@ -724,55 +755,56 @@ function addExtensionVerboseSqlTable ($title = '', $dashed = '', $switch = false // Empty title? if (empty($title)) { // Then fix it to default - $title = getMessage('ADMIN_SQLS_EXECUTED_ON_REMOVAL'); + $title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVAL--}'; } // END - if // Init variables $OUT = ''; // Do we have queries? - if ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y')) { - // Init switch color - $SW = 2; - - // Get all SQLs - foreach (getExtensionSqls() as $sqls) { - // New array format is recursive - foreach ($sqls as $idx => $sql) { - // Trim out spaces - $sql = trim($sql); - - // Output command if set - if (!empty($sql)) { - // Prepare output for template - $content = array( - 'sw' => $SW, - 'i' => ($idx+1), - 'sql' => $sql - ); - - // Load row template - $OUT .= loadTemplate('admin_ext_sql_row', true, $content); - - // Switch color - $SW = 3 - $SW; - } // END - if + if (isVerboseSqlEnabled()) { + // Do we have entries? + if (countExtensionSqls() > 0) { + // Init counter + $idx = 0; + // Get all SQLs + foreach (getExtensionSqls() as $sqls) { + // New array format is recursive + foreach ($sqls as $sql) { + // Trim out spaces + $sql = trim($sql); + + // Output command if set + if (!empty($sql)) { + // Prepare output for template + $content = array( + 'i' => ($idx + 1), + 'sql' => str_replace('{', '{', str_replace('}', '}', encodeEntities($sql))) + ); + + // Load row template + $OUT .= loadTemplate('admin_extension_sql_row', true, $content); + + // Count up + $idx++; + } // END - if + } // END - foreach } // END - foreach - } // END - foreach - // Prepare content for template - $content = array( - 'width' => $width, - 'dashed' => $dashed, - 'title' => $title, - 'rows' => $OUT - ); + // Prepare content for template + $content = array( + 'width' => $width, + 'dashed' => $dashed, + 'title' => $title, + 'rows' => $OUT + ); - // Load main template - $OUT = loadTemplate('admin_ext_sql_table', true, $content); - } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y')) { - // No addional SQL commands to run - $OUT = loadTemplate('admin_settings_saved', true, '{--ADMIN_NO_ADDITIONAL_SQLS--}'); + // Load main template + $OUT = loadTemplate('admin_extension_sql_table', true, $content); + } else { + // No addional SQL commands to run + $OUT = displayMessage('{--ADMIN_NO_ADDITIONAL_SQLS--}', true); + } } // END - if // Return output @@ -888,38 +920,44 @@ function isExtensionIdValid ($ext_id) { // Activate given extension function doActivateExtension ($ext_name) { + // Is the extension installed? + if (!isExtensionInstalled($ext_name)) { + // Non-installed extensions cannot be activated + debug_report_bug(__FUNCTION__, __LINE__, 'Tried to activate non-installed extension ' . $ext_name); + } // END - if + // Activate the extension SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='Y' WHERE `ext_name`='%s' LIMIT 1", array($ext_name), __FUNCTION__, __LINE__); - // Extension has been activated? - if (SQL_AFFECTEDROWS() == 1) { - // Then run all queries - doExtensionSqls(getExtensionId($ext_name), 'activate'); - } // END - if + // Then run all queries + doExtensionSqls(getExtensionId($ext_name), 'activate'); } // Deactivate given extension -function doDeactivateExtension($ext_name) { +function doDeactivateExtension ($ext_name) { + // Is the extension installed? + if (!isExtensionInstalled($ext_name)) { + // Non-installed extensions cannot be activated + debug_report_bug(__FUNCTION__, __LINE__, 'Tried to deactivate non-installed extension ' . $ext_name); + } // END - if + // Activate the extension SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='N' WHERE `ext_name`='%s' LIMIT 1", array($ext_name), __FUNCTION__, __LINE__); - // Extension has been activated? - if (SQL_AFFECTEDROWS() == 1) { - // Then run all queries - doExtensionSqls(getExtensionId($ext_name), 'deactivate'); + // Then run all queries + doExtensionSqls(getExtensionId($ext_name), 'deactivate'); - // Create new task - createExtensionDeactivationTask($ext_name); + // Create new task (we ignore the task id here) + createExtensionDeactivationTask($ext_name); - // Notify the admin - sendAdminNotification( - getMessage('ADMIN_SUBJECT_EXTENSION_DEACTIVATED'), - 'admin_ext_deactivated', - array('ext_name' => $ext_name) - ); - } // END - if + // Notify the admin + sendAdminNotification( + '{--ADMIN_EXTENSION_DEACTIVATED_SUBJECT--}', + 'admin_extension_deactivated', + array('ext_name' => $ext_name) + ); } // Checks wether the extension is older than given @@ -938,110 +976,80 @@ function isExtensionOlder ($ext_name, $ext_ver) { // Creates a new task for updated extension function createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) { // Create subject line - $subject = '[UPDATE-' . $ext_name . '-' . $ext_ver . ':] {--ADMIN_UPDATE_EXTENSION_SUBJ--}'; + $subject = '[UPDATE-' . $ext_name . '-' . $ext_ver . ':] {--ADMIN_UPDATE_EXTENSION_SUBJECT--}'; + + // Get task id + $taskId = determineTaskIdBySubject($subject); // Is the extension there? if (isExtensionInstalled($ext_name)) { // Check if task is not there - if (determineTaskIdBySubject($subject) == '0') { + if ($taskId == '0') { // Create extension update-task - createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId); + $taskId = createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId); } // END - if } else { // Extension not there! :-( debug_report_bug(__FUNCTION__, __LINE__, sprintf("Extension %s not found but should be updated?", $ext_name)); } + + // Return task id + return $taskId; } // Creates a new task for newly installed extension -function createNewExtensionTask ($adminId, $subject, $ext) { +function createNewExtensionTask ($ext_name) { + // Generate subject line + $subject = sprintf("[%s:]", $ext_name); + + // Get task id + $taskId = determineTaskIdBySubject($subject); + // Not installed and do we have created a task for the admin? - if ((determineTaskIdBySubject($subject) == '0') && (!isExtensionInstalled($ext))) { + if (($taskId == '0') && (!isExtensionInstalled($ext_name))) { // Set default message if ext-foo is missing - $message = getMaskedMessage('ADMIN_EXTENSION_TEXT_FILE_MISSING', $ext); + $message = getMaskedMessage('ADMIN_EXTENSION_TEXT_FILE_MISSING', $ext_name); // Template file - $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl", - getConfig('PATH'), + $FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl", + getPath(), getLanguage(), - $ext + $ext_name ); // Load text for task if found - if (isFileReadable($tpl)) { - // Load extension's own text template (HTML!) - $message = loadTemplate('ext_' . $ext, true); + if (isFileReadable($FQFN)) { + // Load extension's description template (but do not compile the code) + $message = loadTemplate('ext_' . $ext_name, true, array(), false); } else { // Write this in debug.log as well logDebugMessage(__FUNCTION__, __LINE__, $message); } // Task not created so it's a brand-new extension which we need to register and create a task for! - createNewTask($subject, $message, 'EXTENSION', 0, $adminId, false); + $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), false); } // END - if + + // Return task id + return $taskId; } // Creates a task for automatically deactivated (deprecated) extension -function createExtensionDeactivationTask ($ext) { +function createExtensionDeactivationTask ($ext_name) { // Create subject line - $subject = sprintf("[%s:] %s", $ext, getMessage('TASK_SUBJ_EXTENSION_DEACTIVATED')); + $subject = sprintf("[%s:] %s", $ext_name, '{--ADMIN_TASK_EXTENSION_DEACTIVATED_SUBJECT--}'); + + // Get task id + $taskId = determineTaskIdBySubject($subject); // Not installed and do we have created a task for the admin? - if ((determineTaskIdBySubject($subject) == '0') && (isExtensionInstalled($ext))) { + if (($taskId == '0') && (isExtensionInstalled($ext_name))) { // Task not created so add it - createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', true, $ext)), 'EXTENSION_DEACTIVATION'); + $taskId = createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', true, $ext_name)), 'EXTENSION_DEACTIVATION'); } // END - if -} - -// Checks if the module has a menu -function ifModuleHasMenu ($mod, $forceDb = false) { - // All is false by default - $ret = false; - - // Extension installed and newer than or has version 0.1.2? - if (isExtensionInstalledAndNewer('cache', '0.1.2')) { - // Cache version is okay, so let's check the cache! - if (isset($GLOBALS['cache_array']['modules']['has_menu'][$mod])) { - // Check module cache and count hit - $ret = ($GLOBALS['cache_array']['modules']['has_menu'][$mod] == 'Y'); - incrementStatsEntry('cache_hits'); - } elseif (isset($GLOBALS['cache_array']['extension']['ext_menu'][$mod])) { - // Check cache and count hit - $ret = ($GLOBALS['cache_array']['extension']['ext_menu'][$mod] == 'Y'); - incrementStatsEntry('cache_hits'); - } else { - // Admin/guest/member/sponsor modules have always a menu! - $ret = in_array($mod, array('admin', 'index', 'login', 'sponsor')); - } - } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && ((!isExtensionActive('cache')) || ($forceDb === true))) { - // Check database for entry - $result = SQL_QUERY_ESC("SELECT `has_menu` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1", - array($mod), __FUNCTION__, __LINE__); - - // Entry found? - if (SQL_NUMROWS($result) == 1) { - // Load "has_menu" column - $data = SQL_FETCHARRAY($result); - - // Fake cache... ;-) - $GLOBALS['cache_array']['extension']['ext_menu'][$mod] = $data['has_menu']; - - // Does it have a menu? - $ret = ($data['has_menu'] == 'Y'); - } // END - if - - // Free memory - SQL_FREERESULT($result); - } elseif (!isExtensionInstalled('sql_patches')) { - // No sql_patches installed, so maybe in admin/guest/member/sponsor area or no admin registered? - $ret = in_array($mod, array('admin', 'index', 'login', 'sponsor')); // Then there is a menu! - } else { - // Unsupported state! - logDebugMessage(__FUNCTION__, __LINE__, 'This should never be reached.'); - } - // Return status - return $ret; + // Return task id + return $taskId; } // Determines the task id for given extension @@ -1089,38 +1097,39 @@ function determineTaskIdBySubject ($subject) { } // Add updates notes for given version -function addExtensionNotes ($ver) { +function addExtensionNotes ($ext_ver) { // Init notes/content - $out = ''; $content = array(); + $out = ''; + $content = array(); // Is do we have verbose output enabled? - if ((!isExtensionActive('sql_patches')) || (getConfig('verbose_sql') == 'Y')) { + if ((!isExtensionActive('sql_patches')) || (isVerboseSqlEnabled())) { // Update notes found? - if (isExtensionUpdateNoteSet($ver)) { + if (isExtensionUpdateNoteSet($ext_ver)) { // Update notes found $content = array( - 'ver' => $ver, - 'notes' => getExtensionUpdateNotes($ver) + 'ver' => $ext_ver, + 'notes' => getExtensionUpdateNotes($ext_ver) ); // Reset them - setExtensionUpdateNotes('', $ver); - } elseif (($ver == '0.0') || ($ver == '0.0.0')) { + setExtensionUpdateNotes('', $ext_ver); + } elseif (in_array($ext_ver, array('0.0', '0.0.0'))) { // Initial release $content = array( - 'ver' => $ver, - 'notes' => getMessage('INITIAL_RELEASE') + 'ver' => $ext_ver, + 'notes' => '{--INITIAL_RELEASE--}' ); } else { - // No update notes found! + // No update notes found $content = array( - 'ver' => $ver, - 'notes' => getMessage('NO_UPDATE_NOTES') + 'ver' => $ext_ver, + 'notes' => '{--NO_UPDATE_NOTES--}' ); } // Load template - $out = loadTemplate('admin_EXTENSION_notes', true, $content); + $out = loadTemplate('admin_extension_notes', true, $content); } // END - if // Add the notes @@ -1166,18 +1175,18 @@ function setExtensionAlwaysActive ($active) { } // Getter for EXT_ALWAYS_ACTIVE flag -function getExtensionAlwaysActive () { +function getThisExtensionAlwaysActive () { return $GLOBALS['ext_always_active'][getCurrentExtensionName()]; } // Checks wether the current extension is always active -function isExtensionAlwaysActive () { - return (getExtensionAlwaysActive() == 'Y'); +function isThisExtensionAlwaysActive () { + return (getThisExtensionAlwaysActive() == 'Y'); } // Setter for EXT_VERSION flag -function setThisExtensionVersion ($version) { - $GLOBALS['ext_version'][getCurrentExtensionName()] = (string) $version; +function setThisExtensionVersion ($ext_version) { + $GLOBALS['ext_version'][getCurrentExtensionName()] = (string) $ext_version; } // Getter for EXT_VERSION flag @@ -1196,8 +1205,8 @@ function isExtensionDeprecated () { } // Setter for EXT_UPDATE_DEPENDS flag -function addExtensionUpdateDependency ($updateDepends) { - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - ENTERED!'); +function addExtensionDependency ($updateDepends) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - ENTERED!'); // Is the update depency empty? (NEED TO BE FIXED!) if (empty($updateDepends)) { // Please report this bug! @@ -1205,7 +1214,7 @@ function addExtensionUpdateDependency ($updateDepends) { } // END - if // Is it not yet added? - /* DEBUG: + /* Only for debugging! if ((isset($updateDepends, $GLOBALS['ext_running_updates'][getCurrentExtensionName()])) && (in_array($updateDepends, getExtensionUpdatesRunning()))) { // Double-adding isn't fine, too debug_report_bug(__FUNCTION__, __LINE__, '() called twice: updateDepends=' . $updateDepends . ',currentExtension=' . getCurrentExtensionName()); @@ -1217,7 +1226,7 @@ function addExtensionUpdateDependency ($updateDepends) { // Remember it in the list of running updates $GLOBALS['ext_running_updates'][getCurrentExtensionName()][] = $updateDepends; - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - EXIT!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - EXIT!'); } // Getter for running updates @@ -1284,7 +1293,7 @@ function isExtensionUpdateRunning ($ext_name) { foreach ($GLOBALS['ext_running_updates'] as $ext1=>$depends) { // Is it found? if (($ext1 == $ext_name) || ($isRunning === true)) { - // Found! + // found logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=' . intval($isRunning)); $isRunning = true; break; @@ -1332,7 +1341,7 @@ function countExtensionUpdateDependencies () { } // Removes given extension from update denpency list -function removeExtensionUpdateDependency ($ext_name) { +function removeExtensionDependency ($ext_name) { // Look it up $key = array_search($ext_name, getExtensionUpdateDependencies()); @@ -1379,8 +1388,8 @@ function getExtensionReportsFailure () { } // Setter for EXT_VER_HISTORY flag -function setExtensionVersionHistory ($verHistory) { - $GLOBALS['ext_ver_history'][getCurrentExtensionName()] = (array) $verHistory; +function setExtensionVersionHistory ($versionHistory) { + $GLOBALS['ext_ver_history'][getCurrentExtensionName()] = (array) $versionHistory; } // Getter for EXT_VER_HISTORY array @@ -1389,33 +1398,41 @@ function getExtensionVersionHistory () { } // Setter for EXT_UPDATE_NOTES -function setExtensionUpdateNotes ($updateNotes, $ver='') { +function setExtensionUpdateNotes ($updateNotes, $ext_ver = '') { // . '/' . getCurrentExtensionVersion() - //* DEBUG: */ debug_report_bug(__FUNCTION__.':' . getCurrentExtensionName() . '/' . getExtensionMode() . '/' . $ver . '=' . $updateNotes); - if (empty($ver)) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ',getExtensionMode()=' . getExtensionMode() . ',ext_ver=' . $ext_ver . ',updateNotes()=' . strlen($updateNotes)); + if (empty($ext_ver)) { $GLOBALS['ext_update_notes'][getCurrentExtensionName()][getCurrentExtensionVersion()] = (string) $updateNotes; } else { - $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ver] = (string) $updateNotes; + $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver] = (string) $updateNotes; } } // Getter for EXT_UPDATE_NOTES -function getExtensionUpdateNotes ($ver) { - return $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ver]; +function getExtensionUpdateNotes ($ext_ver) { + return $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver]; } // Checks if ext_update_notes is set -function isExtensionUpdateNoteSet ($ver) { - return isset($GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ver]); +function isExtensionUpdateNoteSet ($ext_ver) { + return isset($GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver]); } // Init extension notice -function initExtensionNotes () { +function initExtensionNotes ($force = false) { + // Is it already initialized? + if (($force === false) && (isset($GLOBALS['ext_notes'][getCurrentExtensionName()]))) { + // This is mostly not wanted, so please report it + debug_report_bug(__FUNCTION__, __LINE__, 'ext_notes already set for extension ' . getCurrentExtensionName()); + } // END - if + + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName()); $GLOBALS['ext_notes'][getCurrentExtensionName()] = ''; } // Append extension notice function appendExtensionNotes ($notes) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ', notes()=' . strlen($notes)); $GLOBALS['ext_notes'][getCurrentExtensionName()] .= (string) trim($notes); } @@ -1426,23 +1443,24 @@ function getExtensionNotes () { // Setter for current extension name function setCurrentExtensionName ($ext_name) { - $GLOBALS['curr_EXTENSION_name'] = (string) trim($ext_name); + $GLOBALS['curr_extension_name'] = (string) trim($ext_name); } // Getter for current extension name function getCurrentExtensionName () { - if (isset($GLOBALS['curr_EXTENSION_name'])) { - return $GLOBALS['curr_EXTENSION_name']; + if (!isset($GLOBALS['curr_extension_name'])) { + // Not set! + debug_report_bug(__FUNCTION__, __LINE__, 'curr_extension_name not initialized. Please execute initExtensionSqls() before calling this function.'); } // END - if - // Not set! - debug_report_bug(__FUNCTION__.": curr_EXTENSION_name not initialized. Please execute initExtensionSqls() before calling this function."); + // Return it + return $GLOBALS['curr_extension_name']; } // Init SQLs array for current extension function initExtensionSqls ($force = false) { // Auto-init the array or if forced - if ((!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) || ($force === true)) { + if (($force === true) || (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()]))) { // Set the array $GLOBALS['ext_sqls'][getCurrentExtensionName()] = array(); @@ -1454,6 +1472,7 @@ function initExtensionSqls ($force = false) { // Adds SQLs to the SQLs array but "assigns" it with current extension name function addExtensionSql ($sql) { // Add it + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',ext_version=' . getCurrentExtensionVersion() . ',sql=' . $sql); $GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()][] = $sql; } @@ -1471,6 +1490,20 @@ function getExtensionSqls () { return $GLOBALS['ext_sqls'][getCurrentExtensionName()]; } +// Count SQLs for current extension +function countExtensionSqls () { + // Output debug backtrace if not found (SHOULD NOT HAPPEN!) + if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) { + // Not found, should not happen + debug_report_bug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s", + getCurrentExtensionName() + )); + } // END - if + + // Count them all + return count($GLOBALS['ext_sqls'][getCurrentExtensionName()]); +} + // Removes SQLs for current extension function unsetExtensionSqls () { unset($GLOBALS['ext_sqls'][getCurrentExtensionName()]); @@ -1518,19 +1551,19 @@ function redirectOnUninstalledExtension ($ext_name) { // Filter for initialization of all extensions by loading them in 'init' mode function FILTER_INIT_EXTENSIONS () { // Do we have some entries? - //* DEBUG */ print __FUNCTION__.': ENTRY!
'; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY!'); if (isset($GLOBALS['cache_array']['extension']['ext_name'])) { // Load all found extensions if found - //* DEBUG */ print __FUNCTION__.': CACHE - START!
'; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!'); foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) { // Load it - //* DEBUG */ print __FUNCTION__.': '.$ext_name.' - START
'; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - START'); loadExtension($ext_name, 'init', getExtensionVersion($ext_name)); - //* DEBUG */ print __FUNCTION__.': '.$ext_name.' - END
'; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - END'); } // END - foreach - //* DEBUG */ print __FUNCTION__.': CACHE - END!
'; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!'); } // END - if - //* DEBUG */ print __FUNCTION__.': EXIT!
'; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!'); } // Setter for extension mode @@ -1545,12 +1578,12 @@ function getExtensionMode () { // Setter for dry-run function enableExtensionDryRun ($dry_run = true) { - //* DEBUG: */ debugOutput(__FUNCTION__.': '.getCurrentExtensionName().'='.intval($dry_run)); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',dry='.intval($dry_run)); $GLOBALS['ext_dry_run'] = (bool) $dry_run; } // Getter for dry-run -function getExtensionDryRun () { +function isExtensionDryRun () { return $GLOBALS['ext_dry_run']; } @@ -1606,7 +1639,7 @@ function getExtensionHasCss () { // Construct FQFN for check $FQFN = sprintf("%stheme/%s/css/%s.css", - getConfig('PATH'), + getPath(), getCurrentTheme(), getCurrentExtensionName() ); @@ -1623,14 +1656,8 @@ function getExtensionHasCss () { // Checks wether the given extension has a language file function ifExtensionHasLanguageFile ($ext_name) { - // Default is no language file - $hasLanguage = false; - // Do we have cache? if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) { - // Then use it - $hasLanguage = ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y'); - // Count cache hits incrementStatsEntry('cache_hits'); } else { @@ -1644,7 +1671,7 @@ function ifExtensionHasLanguageFile ($ext_name) { } // END - if // Put it in cache - $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = 'Y'; + $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = $readable; } // Return result @@ -1687,27 +1714,58 @@ function isExtensionIncludeReadable ($ext_name = '') { // Checks if an extension's function file is readable function isExtensionFunctionFileReadable ($ext_name) { + // Is cache there? + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name); if (isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) { // Just count cache hits + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] .' - CACHE!'); incrementStatsEntry('cache_hits'); } else { - // Construct FQFN for functions file + // Construct IFN for functions file $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name); // Is this include there? - if ((isFileReadable($funcsInclude)) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name])) && (getExtensionMode() == 'test')) { + if ((isFileReadable($funcsInclude)) && (!isExtensionLibraryLoaded($ext_name)) && (getExtensionMode() == 'test')) { // Cache it! + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=Y - FOUND!'); $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = 'Y'; } else { // Cache it! + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=N - NOT FOUND!'); $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = 'N'; } } // Return result + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name]); return ($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y'); } +// Adds a CREATE TABLE statement if the requested table is not there +function addCreateTableSql ($tableName, $sql) { + // Is the table not there? + if (!isSqlTableCreated($tableName)) { + // Is not found, so add it + addExtensionSql('CREATE TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ' . $sql); + } else { + // Is already there, which should not happen + debug_report_bug(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created which should not happen.'); + } +} + +// Adds a DROP TABLE statement if the requested tabled is there +function addDropTableSql ($tableName) { + // Is the table there? + if (isSqlTableCreated($tableName)) { + // Then add it, non-existing tables can be ignored because it will + // happen with every newly installed extension. + addExtensionSql('DROP TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '`'); + + // Mark it as gone + $GLOBALS['isSqlTableCreated'][$tableName] = false; + } // END - if +} + // Adds an admin menu to the SQL queue of the menu entry is not found function addAdminMenuSql ($action, $what, $title, $descr, $sort) { // Now check if this menu is there @@ -1736,7 +1794,7 @@ function addAdminMenuSql ($action, $what, $title, $descr, $sort) { addExtensionSql($sql); } elseif (isDebugModeEnabled()) { // Double menus should be located and fixed! - logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double admin menu action=%s, what=%s detected.", $action, $what)); + logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double admin menu action=%s,what=%s,title=%s detected.", $action, $what, $title)); } } @@ -1770,7 +1828,7 @@ function addGuestMenuSql ($action, $what, $title, $visible, $locked, $sort) { addExtensionSql($sql); } elseif (isDebugModeEnabled()) { // Double menus should be located and fixed! - logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s, what=%s detected.", $action, $what)); + logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s,what=%s,title=%s,locked=%s,visible=%s detected.", $action, $what, $title, $locked, $visible)); } } @@ -1804,7 +1862,7 @@ function addMemberMenuSql ($action, $what, $title, $visible, $locked, $sort) { addExtensionSql($sql); } elseif (isDebugModeEnabled()) { // Double menus should be located and fixed! - logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double member menu action=%s, what=%s detected.", $action, $what)); + logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double member menu action=%s,what=%s,title=%s,visivle=%s,locked=%s detected.", $action, $what, $title, $visible, $locked)); } } @@ -1836,20 +1894,94 @@ function addSponsorMenuSql ($action, $what, $title, $active, $sort) { addExtensionSql($sql); } elseif (isDebugModeEnabled()) { // Double menus should be located and fixed! - logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double sponsor menu action=%s, what=%s detected.", $action, $what)); + logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double sponsor menu action=%s,what=%s,title=%s,active=%s detected.", $action, $what, $title, $active)); + } +} + +// Add configuration entry if not found for actual extension +function addConfigAddSql ($columnName, $columnSql) { + // Is the column there? + if (!isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) { + // Not found, so add it + addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `' . $columnName . '` ' . $columnSql); + } else { + // Add debug line + logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql); } } // Enables/disables productive mode for current extension (used only while // registration). function enableExtensionProductive ($isProductive = true) { + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%d", getCurrentExtensionName(), intval($isProductive))); + + // Set it $GLOBALS['ext_productive'][getCurrentExtensionName()] = (bool) $isProductive; } // Checks wether the extension is in productive phase. If not set, development // phase (=false) is assumed. -function isExtensionProductive () { - return ((isset($GLOBALS['ext_productive'][getCurrentExtensionName()])) && ($GLOBALS['ext_productive'][getCurrentExtensionName()] === true)); +function isExtensionProductive ($ext_name = '') { + // Is the extension name empty? Then use current + if (empty($ext_name)) { + // Get current extension name + $ext_name = getCurrentExtensionName(); + } // END - if + + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$ext_name])) { + // Load extension only if not yet loaded + if (!isset($GLOBALS['ext_productive'][$ext_name])) { + // Load extension in test mode + loadExtension($ext_name, 'test'); + } // END - if + + // Determine it + $GLOBALS[__FUNCTION__][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === true)); + } // END - if + + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%s", $ext_name, intval($GLOBALS[__FUNCTION__][$ext_name]))); + + // Return result + return $GLOBALS[__FUNCTION__][$ext_name]; +} + +// Mark extension file as loaded +function markExtensionAsLoaded ($ext_name) { + // Is it already loaded? + if (isExtensionLoaded($ext_name)) { + // Then abort here + debug_report_bug(__FUNCTION__, __LINE__, 'Extension ' . $ext_name . ' is already marked as loaded!'); + } // END - if + + // Mark it + $GLOBALS['ext_loaded']['ext_name'][$ext_name] = true; +} + +// Determine wether the given extension is already loaded +function isExtensionLoaded ($ext_name) { + // Is it there? + return ((isset($GLOBALS['ext_loaded']['ext_name'][$ext_name])) && ($GLOBALS['ext_loaded']['ext_name'][$ext_name] === true)); +} + +// Mark extension's library file as loaded +function markExtensionLibraryAsLoaded ($ext_name) { + // Is it already loaded? + if (isExtensionLibraryLoaded($ext_name)) { + // Then abort here + debug_report_bug(__FUNCTION__, __LINE__, 'Extension library ' . $ext_name . ' is already marked as loaded!'); + } // END - if + + // Mark it + $GLOBALS['ext_loaded']['library'][$ext_name] = true; +} + +// Determine wether the given extension's library is already loaded +function isExtensionLibraryLoaded ($ext_name) { + // Is it there? + return ((isset($GLOBALS['ext_loaded']['library'][$ext_name])) && ($GLOBALS['ext_loaded']['library'][$ext_name] === true)); } // [EOF]