X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fextensions-functions.php;h=a6a2e372cc7487910e7451b10345dab6fcab9661;hb=9b8fe454a575a1f000b00bc7ca37eaad6d59d21a;hp=a7067ec00590ce869d5206c7b197117d10eb225a;hpb=ad6b1626cb65625166344063a3bb849029bed920;p=mailer.git diff --git a/inc/extensions-functions.php b/inc/extensions-functions.php index a7067ec005..a6a2e372cc 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, $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 @@ -65,13 +65,19 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '', $dry_run = false) { // 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 } @@ -92,7 +98,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '', $dry_run = false) { // 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)); @@ -118,17 +124,17 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '', $dry_run = false) { // 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]))) { + 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()) && (getScriptOutputMode() == '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, @@ -136,6 +142,9 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '', $dry_run = false) { )); } + // Load extension's filter library if present + loadExtensionFilters($ext_name); + // Extensions are not deprecated by default setExtensionDeprecated('N'); @@ -146,8 +155,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '', $dry_run = false) { // @TODO Do we still need this? setExtensionUpdateNotes(''); // Include the extension file - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension loaded.'); - loadExtensionInclude(); + loadCurrentExtensionInclude(); // Is this extension deprecated? if (isExtensionDeprecated()) { @@ -155,23 +163,25 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '', $dry_run = false) { doDeactivateExtension($ext_name); // Abort here + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension load aborted, ext_name=' . $ext_name); return false; } // END - if // 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! + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension successfully loaded, ext_name=' . $ext_name); return true; } // Registeres an extension and possible update depencies -function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true) { +function registerExtension ($ext_name, $taskId, $dry_run = false) { // Set current extension name - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . $taskId . ',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) . ' - ENTERED!'); setCurrentExtensionName($ext_name); // Enable dry-run @@ -189,7 +199,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true // When this extension is already in registration/update phase, all is fine if ((isExtensionRegistrationRunning($ext_name)) || (isExtensionUpdateRunning($ext_name))) { // Then abort here with 'true' becaus it is fine - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - ALREADY!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine.'); return true; } // END - if @@ -237,7 +247,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true // Does this extension exists? //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName()); - if (loadExtension(getCurrentExtensionName(), 'register', '', isExtensionDryRun())) { + if (loadExtension(getCurrentExtensionName(), 'register', '0.0', isExtensionDryRun())) { // Set current extension name again setCurrentExtensionName($ext_name); @@ -335,8 +345,8 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true if ($test === true) { // "Dry-run-mode" activated? if ((isExtensionDryRun() === false) && (!isExtensionOnRemovalList())) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName()); // Init SQLs and transfer ext->generic + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName()); initSqls(); setSqlsArray(getExtensionSqls()); @@ -346,28 +356,32 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true // 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( @@ -380,9 +394,6 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true initExtensionSqls(true); initExtensionNotes(true); - // Mark it as installed - $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true; - // In normal mode return a true on success $ret = true; } elseif (isExtensionDryRun() === true) { @@ -404,20 +415,6 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true 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')) && (!isExtensionDryRun()) && ($test)) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ': LOAD!'); - if ($logout === true) { - // Then redirect to logout - redirectToUrl('modules.php?module=admin&logout=1&' . getExtensionMode() . '=sql_patches'); - } else { - // Add temporary filter - registerFilter('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true); - $GLOBALS['ext_load_mode'] = getExtensionMode(); - } - } // END - if - // Return status code //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',test=' . intval($test) . ' - EXIT!'); return $ret; @@ -442,20 +439,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 message //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls()); + + // Do we have entries? if (isSqlsValid()) { // Run SQL commands... runFilterChain('run_sqls'); @@ -465,7 +465,7 @@ 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 @@ -506,6 +506,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); @@ -547,7 +550,7 @@ function isExtensionActive ($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'))) { @@ -584,6 +587,7 @@ function isExtensionActive ($ext_name) { // Get version from extensions function getExtensionVersion ($ext_name, $force = false) { // By default no extension is found + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!'); $data['ext_version'] = 'false'; // Empty extension name should be fixed! @@ -593,22 +597,24 @@ function getExtensionVersion ($ext_name, $force = false) { } // END - if // Extensions are all inactive during installation - if (isInstallationPhase()) return ''; - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name); + if (isInstallationPhase()) { + return ''; + } // END - if // Is the cache written? + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - Checking cache ...'); if (isset($GLOBALS['cache_array']['extension']['ext_version'][$ext_name])) { // Load data from cache - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $ext_name . ': CACHE!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': CACHE!'); $data['ext_version'] = $GLOBALS['cache_array']['extension']['ext_version'][$ext_name]; // Count cache hits incrementStatsEntry('cache_hits'); - } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (getScriptOutputMode() != 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__); - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $ext_name . ': DB - '.SQL_NUMROWS($result).''); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': DB - '.SQL_NUMROWS($result).''); // Is the extension there? if (SQL_NUMROWS($result) == 1) { @@ -640,7 +646,9 @@ function getExtensionVersion ($ext_name, $force = false) { // 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); @@ -660,7 +668,7 @@ 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))); + //* 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); @@ -785,7 +793,7 @@ function addExtensionVerboseSqlTable ($title = '', $dashed = '', $switch = false $OUT = loadTemplate('admin_extension_sql_table', true, $content); } else { // No addional SQL commands to run - $OUT = loadTemplate('admin_settings_saved', true, '{--ADMIN_NO_ADDITIONAL_SQLS--}'); + $OUT = displayMessage('{--ADMIN_NO_ADDITIONAL_SQLS--}', true); } } // END - if @@ -902,38 +910,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 (we ignore the task id here) - createExtensionDeactivationTask($ext_name); + // Create new task (we ignore the task id here) + createExtensionDeactivationTask($ext_name); - // Notify the admin - sendAdminNotification( - '{--ADMIN_EXTENSION_DEACTIVATED_SUBJECT--}', - 'admin_extension_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 @@ -987,16 +1001,16 @@ function createNewExtensionTask ($ext_name) { $message = getMaskedMessage('ADMIN_EXTENSION_TEXT_FILE_MISSING', $ext_name); // Template file - $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl", + $FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl", getPath(), getLanguage(), $ext_name ); // Load text for task if found - if (isFileReadable($tpl)) { - // Load extension's own text template (HTML!) - $message = loadTemplate('ext_' . $ext_name, 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); @@ -1097,7 +1111,7 @@ function addExtensionNotes ($ext_ver) { 'notes' => '{--INITIAL_RELEASE--}' ); } else { - // No update notes found! + // No update notes found $content = array( 'ver' => $ext_ver, 'notes' => '{--NO_UPDATE_NOTES--}' @@ -1151,13 +1165,13 @@ 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 @@ -1181,28 +1195,30 @@ function isExtensionDeprecated () { } // Setter for EXT_UPDATE_DEPENDS flag -function addExtensionUpdateDependency ($updateDepends) { - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - ENTERED!'); +function addExtensionDependency ($updateDepends) { // Is the update depency empty? (NEED TO BE FIXED!) + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - ENTERED!'); if (empty($updateDepends)) { // Please report this bug! debug_report_bug(__FUNCTION__, __LINE__, 'updateDepends is empty: currentExtension=' . getCurrentExtensionName()); } // END - if // Is it not yet added? - /* 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()); + /* + * Double-adding isn't fine, too. This may mean that + * addExtensionDependency() was called outside the switch() command in + * the extension's file which requires fixing. + */ + debug_report_bug(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - CALLED TWICE!'); } // END - if - */ // Add it to the list of extension update depencies map $GLOBALS['ext_update_depends'][getCurrentExtensionName()][] = (string) $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 . ',extensionMode=' . getExtensionMode() . ' - EXIT!'); } // Getter for running updates @@ -1269,9 +1285,9 @@ function isExtensionUpdateRunning ($ext_name) { foreach ($GLOBALS['ext_running_updates'] as $ext1=>$depends) { // Is it found? if (($ext1 == $ext_name) || ($isRunning === true)) { - // Found! - logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=' . intval($isRunning)); + // Found $isRunning = true; + logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=' . intval($isRunning)); break; } // END - if } // END - foreach @@ -1317,7 +1333,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()); @@ -1448,6 +1464,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; } @@ -1526,19 +1543,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 */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY!'); if (isset($GLOBALS['cache_array']['extension']['ext_name'])) { // Load all found extensions if found - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!'); foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) { // Load it - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - START'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - START'); loadExtension($ext_name, 'init', getExtensionVersion($ext_name)); - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - END'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - END'); } // END - foreach - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!'); } // END - if - //* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!'); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!'); } // Setter for extension mode @@ -1553,7 +1570,7 @@ function getExtensionMode () { // Setter for dry-run function enableExtensionDryRun ($dry_run = true) { - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',dry='.intval($dry_run)); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',dry_run='.intval($dry_run)); $GLOBALS['ext_dry_run'] = (bool) $dry_run; } @@ -1631,14 +1648,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 { @@ -1659,8 +1670,8 @@ function ifExtensionHasLanguageFile ($ext_name) { return ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y'); } -// Load an extension's include file -function loadExtensionInclude () { +// Load current extension's include file +function loadCurrentExtensionInclude () { // Is it readable? if (!isExtensionIncludeReadable()) { // Not readable @@ -1677,7 +1688,9 @@ function loadExtensionInclude () { // Checks wether an extension is readable function isExtensionIncludeReadable ($ext_name = '') { // If empty, use current - if (empty($ext_name)) $ext_name = getCurrentExtensionName(); + if (empty($ext_name)) { + $ext_name = getCurrentExtensionName(); + } // END - if // Array found? if (!isset($GLOBALS['ext_inc_readable'][$ext_name])) { @@ -1706,7 +1719,7 @@ function isExtensionFunctionFileReadable ($ext_name) { $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'; @@ -1722,6 +1735,31 @@ function isExtensionFunctionFileReadable ($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 @@ -1750,7 +1788,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)); } } @@ -1784,7 +1822,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)); } } @@ -1818,7 +1856,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)); } } @@ -1850,12 +1888,43 @@ 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); + } elseif (isDebugModeEnabled()) { + // Add debug line + logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql); + } +} + +// Drop configuration entry if found for actual extension +function addConfigDropSql ($columnName) { + // Is the column there? + if (isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) { + // Found, so add it + addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` DROP `' . $columnName . '`'); + } elseif (isDebugModeEnabled()) { + // Add debug line, debug_report_bug() would cause some extenion updates fail + logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' not found.'); } } +// Change configuration entry for actual extension +function addConfigChangeSql ($oldColumnName, $newColumnName, $columnSql) { + // Add the SQL statement + addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` CHANGE `' . $oldColumnName . '` `' . $newColumnName . '` ' . $columnSql); +} + // Enables/disables productive mode for current extension (used only while // registration). +// @TODO This should be rewrittten to allow, more development states, e.g. 'planing','alpha','beta','beta2','stable' function enableExtensionProductive ($isProductive = true) { // Log debug message //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%d", getCurrentExtensionName(), intval($isProductive))); @@ -1874,7 +1943,7 @@ function isExtensionProductive ($ext_name = '') { } // END - if // Do we have cache? - if (!isset($GLOBALS['ext_is_productive'][$ext_name])) { + 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 @@ -1882,14 +1951,51 @@ function isExtensionProductive ($ext_name = '') { } // END - if // Determine it - $GLOBALS['ext_is_productive'][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === true)); + $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['ext_is_productive'][$ext_name]))); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%s", $ext_name, intval($GLOBALS[__FUNCTION__][$ext_name]))); // Return result - return $GLOBALS['ext_is_productive'][$ext_name]; + 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 + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,ext_loaded=true", $ext_name)); + $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]