X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fextensions.php;h=db279cffe9c2c3f5eff5b614d473f39759af26da;hp=dabaadb743c38acbbab7a797ed70faee229a1df2;hb=508228c85fba8448d00865b1639cb8cd7a69e457;hpb=8b3b0fae36adfa1ef72f436d107d11404b326ec5 diff --git a/inc/extensions.php b/inc/extensions.php index dabaadb743..db279cffe9 100644 --- a/inc/extensions.php +++ b/inc/extensions.php @@ -10,7 +10,12 @@ * -------------------------------------------------------------------- * * Kurzbeschreibung : Erweiterungen-Management * * -------------------------------------------------------------------- * - * * + * $Revision:: 856 $ * + * $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 - 2008 by Roland Haeder * * For more information visit: http://www.mxchange.org * @@ -38,10 +43,8 @@ if (!defined('__SECURITY')) { } // Load the extension and maybe found language and function files. -function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run = false, &$SQLs = array()) { - global $_CONFIG, $EXT_VER_HISTORY; - global $INC_POOL, $EXT_UPDATE_DEPENDS, $EXT_DEPRECATED, $UPDATE_NOTES; - global $EXT_VERSION, $EXT_ALWAYS_ACTIVE; +function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run = false) { + global $INC_POOL; // Init array $INC_POOL = array(); @@ -54,14 +57,12 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run return false; } // END - if - // Construct FQFN for extension file - $FQFN = sprintf("%sinc/extensions/ext-%s.php", - constant('PATH'), - $ext_name - ); + // Construct include filename and FQFN for extension file + $INC = sprintf("inc/extensions/ext-%s.php", $ext_name); + $FQFN = constant('PATH') . $INC; // Is the extension file NOT there? - if (!FILE_READABLE($FQFN)) { + if (!INCLUDE_READABLE($INC)) { // Debug message DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found.", $ext_name)); @@ -92,23 +93,23 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run } // END - if // Extensions are not deprecated by default - $EXT_DEPRECATED = "N"; + EXT_SET_DEPRECATED("N"); // Extensions are not always active by default - $EXT_ALWAYS_ACTIVE = "N"; + EXT_SET_ALWAYS_ACTIVE("N"); // By default an extension update does not depend on other extensions - $EXT_UPDATE_DEPENDS = ""; + EXT_SET_UPDATE_DEPENDS(""); // Extension update notes - $UPDATE_NOTES = ""; + EXT_SET_UPDATE_NOTES(""); // Include the extension file //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Extension loaded."); require($FQFN); // Is this extension deprecated? - if ($EXT_DEPRECATED == "Y") { + if (EXT_GET_DEPRECATED() == "Y") { // Deactivate the extension DEACTIVATE_EXTENSION($ext_name); @@ -128,9 +129,8 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run // Registeres an extension and possible update depencies function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = true) { - global $UPDATE_NOTES, $INC_POOL; - global $EXT_VER_HISTORY, $NOTES, $EXT_ALWAYS_ACTIVE, $EXT_VERSION; - global $EXT_UPDATE_DEPENDS; + global $INC_POOL; + global $NOTES; // This shall never do a non-admin user! if (!IS_ADMIN()) return false; @@ -138,37 +138,40 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr // Is this extension already installed? if (EXT_IS_ACTIVE($ext_name)) return false; + // Init queries + INIT_SQLS(); + // Init variables - $ret = false; $SQLs = array(); + $ret = false; $NOTES = ""; $INC_POOL = array(); // By default we have no failures - $EXT_REPORTS_FAILURE = false; + EXT_SET_REPORTS_FAILURE(false); // Does this extension exists? - if (LOAD_EXTENSION($ext_name, "register", "", $dry_run, $SQLs)) { + if (LOAD_EXTENSION($ext_name, "register", "", $dry_run)) { // And run possible updates - $history = $EXT_VER_HISTORY; + $history = EXT_GET_VER_HISTORY(); foreach ($history as $ver) { //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ext_name={$ext_name}, ext_ver={$ver}"); // Load extension in update mode - LOAD_EXTENSION($ext_name, "update", $ver, $dry_run, $SQLs); + LOAD_EXTENSION($ext_name, "update", $ver, $dry_run); // Add update notes to our output - $NOTES .= ADD_EXTENSION_NOTES($ver, $UPDATE_NOTES); + $NOTES .= ADD_EXTENSION_NOTES($ver); } // END - foreach // Does this extension depends on an outstanding update of another update? - if (!empty($EXT_UPDATE_DEPENDS)) { + if (EXT_GET_UPDATE_DEPENDS() != "") { // Backup SQL commands and clear current - $SQLs2 = $SQLs; - $SQLs = array(); + $SQLs2 = GET_SQLS(); + INIT_SQLS(); $test = false; - $ext_update = $EXT_UPDATE_DEPENDS; + $ext_update = EXT_GET_UPDATE_DEPENDS(); // Check for required file - if (LOAD_EXTENSION($ext_update, "register", "", $dry_run, $SQLs)) { + if (LOAD_EXTENSION($ext_update, "register", "", $dry_run)) { // If versions mismatch update extension first $ext_ver = GET_EXT_VERSION($ext_update); @@ -182,7 +185,7 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr // Try to register the extension $test = EXTENSION_REGISTER($ext_update, $task, $dry_run, false); } // END - if - } elseif ($ext_ver != $EXT_VERSION) { + } elseif ($ext_ver != EXT_GET_VERSION()) { // Ok, update this extension now EXTENSION_UPDATE($ext_update, $ext_ver, $dry_run); @@ -199,7 +202,7 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr } // Finally restore previous SQLs - $SQLs = $SQLs2; unset($SQLs2); + SET_SQLS($SQLs2); unset($SQLs2); } else { // Does not depend on an other extension $test = true; @@ -209,36 +212,36 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr $EXT_LOAD_MODE = "register"; // Remains true if extension registration reports no failures - $test = ($test && !$EXT_REPORTS_FAILURE); + $test = (($test === true) && (EXT_GET_REPORTS_FAILURE() === false)); // Does everthing before wents ok? if ($test) { // "Dry-run-mode" activated? if (!$dry_run) { // Run installation pre-installation filters - RUN_FILTER('pre_extension_installed', array('dry_run' => $dry_run, 'sqls' => $SQLs)); + runFilterChain('pre_extension_installed', array('dry_run' => $dry_run)); // Register extension SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_extensions` (ext_name, ext_active, ext_version) VALUES ('%s','%s','%s')", - array($ext_name, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__); + array($ext_name, EXT_GET_ALWAYS_ACTIVE(), EXT_GET_VERSION()), __FILE__, __LINE__); // Remove cache file(s) if extension is active - RUN_FILTER('post_extension_installed', array('ext_name' => $ext_name, 'task_id' => $task_id, 'inc_pool' => $INC_POOL)); + runFilterChain('post_extension_installed', array('ext_name' => $ext_name, 'task_id' => $task_id, 'inc_pool' => $INC_POOL)); // In normal mode return a true on success $ret = true; } else { // Rewrite SQL command to keep { and } inside - foreach ($SQLs as $key => $sql) { + foreach (GET_SQLS() as $key => $sql) { $sql = str_replace('{', "{", str_replace('}', "}", $sql)); - $SQLs[$key] = $sql; + SET_SQL_KEY($key, $sql); } // END - foreach // In "dry-run" mode return array with all SQL commands - $ret = $SQLs; + $ret = GET_SQLS(); // Remove all SQL commands - unset($SQLs); + UNSET_SQLS(); } } else { // No, an error occurs while registering extension :-( @@ -254,7 +257,7 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":{$ext_name}/{$EXT_LOAD_MODE}"); if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove")) && (!$dry_run) && ($test)) { //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!"); - if ($logout) { + if ($logout === true) { // Then redirect to logout LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches"); } else { @@ -275,7 +278,7 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) { if (!IS_ADMIN()) return false; // Init array - $SQLs = array(); + INIT_SQLS(); // By default no SQL has been executed $sqlRan = false; @@ -287,12 +290,12 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) { // Load extension in detected mode //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]={$ext_name}"); - LOAD_EXTENSION($ext_name, $load_mode, "", false, $SQLs); + LOAD_EXTENSION($ext_name, $load_mode, "", false); - //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".count($SQLs).""); - if ((is_array($SQLs) && (sizeof($SQLs) > 0))) { + //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".COUNT_SQLS().""); + if ((IS_SQLS_VALID() && (COUNT_SQLS() > 0))) { // Run SQL commands... - RUN_FILTER('run_sqls', array('dry_run' => false, 'sqls' => $SQLs)); + runFilterChain('run_sqls'); // Removal mode? if ($load_mode == "remove") { @@ -305,7 +308,7 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) { // Remove cache file(s) if extension is active if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == "activate") || ($load_mode == "deactivate"))) { // Run filters - RUN_FILTER('post_extension_run_sql', $ext_name); + runFilterChain('post_extension_run_sql', $ext_name); } // END - if // Is this the sql_patches? @@ -320,7 +323,7 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) { // Check if given extension is active function EXT_IS_ACTIVE ($ext_name) { // Extensions are all inactive during installation - if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isInstalling()) || (empty($ext_name))) return false; + if ((!isInstalled()) || (isInstalling()) || (empty($ext_name))) return false; // Not active is the default $active = "N"; @@ -372,7 +375,7 @@ function GET_EXT_VERSION ($ext_name) { $ext_ver = false; // Extensions are all inactive during installation - if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isInstalling())) return ""; + if ((!isInstalled()) || (isInstalling())) return ""; //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ext_name={$ext_name}"); // Is the cache written? @@ -383,10 +386,11 @@ function GET_EXT_VERSION ($ext_name) { // Count cache hits incrementConfigEntry('cache_hits'); - } elseif ((!isset($GLOBALS['cache_instance'])) || (!is_object($GLOBALS['cache_instance']))) { + } elseif (!isCacheInstanceValid()) { // Load from database $result = SQL_QUERY_ESC("SELECT ext_version FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1", array($ext_name), __FILE__, __LINE__); + //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": DB - ".SQL_NUMROWS($result).""); // Is the extension there? if (SQL_NUMROWS($result) == 1) { @@ -409,11 +413,12 @@ function GET_EXT_VERSION ($ext_name) { // Updates a given extension with current extension version to latest version function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) { // This shall never do a non-admin user! - global $UPDATE_NOTES, $NOTES, $EXT_VER_HISTORY; - global $EXT_UPDATE_DEPENDS, $EXT_VERSION, $INC_POOL, $SQLs; + global $NOTES; + global $INC_POOL; // Init arrays - $SQLs = array(); $INC_POOL = array(); + INIT_SQLS(); + $INC_POOL = array(); // Init notes $NOTES = ""; @@ -422,59 +427,59 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) { if ((!IS_ADMIN()) || (empty($ext_name))) return false; // Load extension in test mode - LOAD_EXTENSION($ext_name, "test", $ext_ver, $dry_run, $SQLs); + LOAD_EXTENSION($ext_name, "test", $ext_ver, $dry_run); // Save version history - $history = $EXT_VER_HISTORY; + $history = EXT_GET_VER_HISTORY(); // Remove old SQLs array to prevent possible bugs - $SQLs = array(); + INIT_SQLS(); // Check if version is updated - if ((($EXT_VERSION != $ext_ver) || ($dry_run)) && (is_array($history))) { + if (((EXT_GET_VERSION() != $ext_ver) || ($dry_run)) && (is_array($history))) { // Search for starting point $start = array_search($ext_ver, $history); // And load SQL queries in order of version history - for ($idx = ($start + 1); $idx < sizeof($history); $idx++) { + for ($idx = ($start + 1); $idx < count($history); $idx++) { // Set extension version $GLOBALS['cache_array']['update_ver'][$ext_name] = $history[$idx]; // Load again... - LOAD_EXTENSION($ext_name, "update", $GLOBALS['cache_array']['update_ver'][$ext_name], $dry_run, $SQLs); + LOAD_EXTENSION($ext_name, "update", $GLOBALS['cache_array']['update_ver'][$ext_name], $dry_run); - if (!empty($EXT_UPDATE_DEPENDS)) { + if (EXT_GET_UPDATE_DEPENDS() != "") { // Backup current SQL queries - $GLOBALS['cache_array']['update_sqls'][$ext_name] = $SQLs; + $GLOBALS['cache_array']['update_sqls'][$ext_name] = GET_SQLS(); // Is the extension there? - if (GET_EXT_VERSION($EXT_UPDATE_DEPENDS) != "") { + if (GET_EXT_VERSION(EXT_GET_UPDATE_DEPENDS()) != "") { // Update another extension first! - $test = EXTENSION_UPDATE($EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run); + $test = EXTENSION_UPDATE(EXT_GET_UPDATE_DEPENDS(), GET_EXT_VERSION(EXT_GET_UPDATE_DEPENDS()), $dry_run); } else { // Register new extension - $test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, 0, $dry_run, false); + $test = EXTENSION_REGISTER(EXT_GET_UPDATE_DEPENDS(), 0, $dry_run, false); } // Restore previous SQL queries - $SQLs = $GLOBALS['cache_array']['update_sqls'][$ext_name]; + SET_SQLS($GLOBALS['cache_array']['update_sqls'][$ext_name]); unset($GLOBALS['cache_array']['update_sqls'][$ext_name]); } // END - if // Add notes - $NOTES .= ADD_EXTENSION_NOTES($GLOBALS['cache_array']['update_ver'][$ext_name], $UPDATE_NOTES); + $NOTES .= ADD_EXTENSION_NOTES($GLOBALS['cache_array']['update_ver'][$ext_name]); } // END - for // In real-mode execute any existing includes if (!$dry_run) { $GLOBALS['cache_array']['inc_pool'][$ext_name] = $INC_POOL; - RUN_FILTER('load_includes', $INC_POOL); + runFilterChain('load_includes', $INC_POOL); $INC_POOL = $GLOBALS['cache_array']['inc_pool'][$ext_name]; unset($GLOBALS['cache_array']['inc_pool'][$ext_name]); } // END - if // Run SQLs - RUN_FILTER('run_sqls', array('dry_run' => $dry_run, 'sqls' => $SQLs)); + runFilterChain('run_sqls', array('dry_run' => $dry_run)); if (!$dry_run) { // Create task @@ -485,22 +490,17 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) { array($GLOBALS['cache_array']['update_ver'][$ext_name], $ext_name), __FILE__, __LINE__); // Remove arrays - unset($SQLs); + UNSET_SQLS(); unset($GLOBALS['cache_array']['update_ver'][$ext_name]); // Run filters on success extension update - RUN_FILTER('extension_update', $ext_name); - } else { - // In "dry-run" mode return array with SQL commands - return $SQLs; - } + runFilterChain('extension_update', $ext_name); + } // END - if } // END - if } // Output verbose SQL table for extension function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = "", $dashed = "", $switch = false, $width = "100%") { - global $SQLs; - // Empty title? if (empty($title)) { // Then fix it to default @@ -510,7 +510,7 @@ function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = "", $dashed = "", // Are there some queries in $queries? if (count($queries) > 0) { // Then use them instead! - $SQLs = $queries; + SET_SQLS($queries); } // END - if // Init variables @@ -518,8 +518,8 @@ function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = "", $dashed = "", $OUT = ""; // Do we have queries? - if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) { - foreach ($SQLs as $idx => $sql) { + if ((IS_SQLS_VALID()) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) { + foreach (GET_SQLS() as $idx => $sql) { // Trim out spaces $sql = trim($sql); @@ -759,8 +759,8 @@ function MODULE_HAS_MENU ($mod, $forceDb = false) { // Free memory SQL_FREERESULT($result); } elseif (GET_EXT_VERSION("sql_patches") == "") { - // No sql_patches installed, so maybe in admin area? - $ret = ((IS_ADMIN()) && ($mod == "admin")); // Then there is a menu! + // No sql_patches installed, so maybe in admin area or no admin registered? + $ret = (((IS_ADMIN()) || (!isAdminRegistered())) && ($mod == "admin")); // Then there is a menu! } // Return status @@ -813,7 +813,7 @@ function DETERMINE_TASK_ID_BY_SUBJECT ($subject) { } // Add updates notes for given version -function ADD_EXTENSION_NOTES ($ver, &$UPDATE_NOTES) { +function ADD_EXTENSION_NOTES ($ver) { // Init notes/content $out = ""; $content = array(); @@ -821,13 +821,13 @@ function ADD_EXTENSION_NOTES ($ver, &$UPDATE_NOTES) { if ((getConfig('verbose_sql') == "Y") || (!EXT_IS_ACTIVE("sql_patches"))) { // Update notes found? - if (!empty($UPDATE_NOTES)) { + if (EXT_GET_UPDATE_NOTES() != "") { // Update notes found $content = array( 'ver' => $ver, - 'notes' => $UPDATE_NOTES + 'notes' => EXT_GET_UPDATE_NOTES() ); - $UPDATE_NOTES = ""; + EXT_SET_UPDATE_NOTES(""); } elseif (($ver == "0.0") || ($ver == "0.0.0")) { // Initial release $content = array( @@ -883,5 +883,75 @@ function EXT_ADD_CSS_FILE ($file) { $GLOBALS['css_files'][] = $file; } +// Setter for EXT_ALWAYS_ACTIVE flag +function EXT_SET_ALWAYS_ACTIVE ($active) { + $GLOBALS['ext_always_active'] = $active; +} + +// Getter for EXT_ALWAYS_ACTIVE flag +function EXT_GET_ALWAYS_ACTIVE () { + return $GLOBALS['ext_always_active']; +} + +// Setter for EXT_VERSION flag +function EXT_SET_VERSION ($version) { + $GLOBALS['ext_version'] = $version; +} + +// Getter for EXT_VERSION flag +function EXT_GET_VERSION () { + return $GLOBALS['ext_version']; +} + +// Setter for EXT_DEPRECATED flag +function EXT_SET_DEPRECATED ($deprecated) { + $GLOBALS['ext_deprecated'] = $deprecated; +} + +// Getter for EXT_DEPRECATED flag +function EXT_GET_DEPRECATED () { + return $GLOBALS['ext_deprecated']; +} + +// Setter for EXT_UPDATE_DEPENDS flag +function EXT_SET_UPDATE_DEPENDS ($updateDepends) { + $GLOBALS['ext_update_depends'] = $updateDepends; +} + +// Getter for EXT_UPDATE_DEPENDS flag +function EXT_GET_UPDATE_DEPENDS () { + return $GLOBALS['ext_update_depends']; +} + +// Setter for EXT_REPORTS_FAILURE flag +function EXT_SET_REPORTS_FAILURE ($reportsFailure) { + $GLOBALS['ext_reports_failure'] = $reportsFailure; +} + +// Getter for EXT_REPORTS_FAILURE flag +function EXT_GET_REPORTS_FAILURE () { + return $GLOBALS['ext_reports_failure']; +} + +// Setter for EXT_VER_HISTORY flag +function EXT_SET_VER_HISTORY ($verHistory) { + $GLOBALS['ext_ver_history'] = (array) $verHistory; +} + +// Getter for EXT_VER_HISTORY flag +function EXT_GET_VER_HISTORY () { + return $GLOBALS['ext_ver_history']; +} + +// Setter for EXT_UPDATE_NOTES flag +function EXT_SET_UPDATE_NOTES ($updateNotes) { + $GLOBALS['ext_update_notes'] = (array) $updateNotes; +} + +// Getter for EXT_UPDATE_NOTES flag +function EXT_GET_UPDATE_NOTES () { + return $GLOBALS['ext_update_notes']; +} + // ?>