X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fextensions-functions.php;h=9aca9cf4141a34308c0e1864be12ac31ec312c21;hp=ee5ff4908fc385e56f38c08793343a316683917c;hb=500f1a8d2913512f1f5621c2a0320ad81f5133a1;hpb=c72268213d4d4829d845d39c101bb08fbe4ed79a diff --git a/inc/extensions-functions.php b/inc/extensions-functions.php index ee5ff4908f..9aca9cf414 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]))) { + 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, @@ -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! @@ -234,7 +246,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); @@ -332,39 +344,43 @@ 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()); // Run installation pre-installation filters - runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun())); + 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( @@ -377,9 +393,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) { @@ -439,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 message //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls()); + + // Do we have entries? if (isSqlsValid()) { // Run SQL commands... runFilterChain('run_sqls'); @@ -462,7 +478,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 @@ -481,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 @@ -503,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); @@ -522,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'; @@ -536,7 +563,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'))) { @@ -593,7 +620,7 @@ function getExtensionVersion ($ext_name, $force = false) { // 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__); @@ -629,7 +656,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); @@ -649,7 +678,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); @@ -712,7 +741,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) { setSqlsArray(getExtensionSqls()); // Run SQLs - runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun())); + runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false)); if (isExtensionDryRun() === false) { // Run filters on success extension update @@ -733,7 +762,7 @@ function addExtensionVerboseSqlTable ($title = '', $dashed = '', $switch = false $OUT = ''; // Do we have queries? - if ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y')) { + if (isVerboseSqlEnabled()) { // Do we have entries? if (countExtensionSqls() > 0) { // Init counter @@ -750,7 +779,7 @@ function addExtensionVerboseSqlTable ($title = '', $dashed = '', $switch = false // Prepare output for template $content = array( 'i' => ($idx + 1), - 'sql' => $sql + 'sql' => str_replace('{', '{', str_replace('}', '}', encodeEntities($sql))) ); // Load row template @@ -774,7 +803,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 @@ -891,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 (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 @@ -976,16 +1011,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); @@ -1068,7 +1103,7 @@ function addExtensionNotes ($ext_ver) { $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($ext_ver)) { // Update notes found @@ -1086,7 +1121,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--}' @@ -1140,13 +1175,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 @@ -1170,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! @@ -1191,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 @@ -1258,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; @@ -1306,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()); @@ -1437,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; } @@ -1515,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 */ 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 @@ -1620,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 { @@ -1641,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 @@ -1695,7 +1725,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'; @@ -1711,6 +1741,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 @@ -1739,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)); } } @@ -1773,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)); } } @@ -1807,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)); } } @@ -1839,20 +1894,113 @@ 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); + } +} + +// 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 . '`'); + } else { + // 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))); + + // 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]