X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fextensions.php;h=2906fbf58aaee47e0e2cce0a31107e34a04d5c98;hb=395e641a3a1a991199c84bb1a2795c974faced4a;hp=fee99ba7a616044fd2c7f32970a484b32fd1e0f2;hpb=5f8c1a333627cd0145f778a6eebdb251f5bb40b6;p=mailer.git diff --git a/inc/extensions.php b/inc/extensions.php index fee99ba7a6..2906fbf58a 100644 --- a/inc/extensions.php +++ b/inc/extensions.php @@ -37,13 +37,76 @@ if (!defined('__SECURITY')) { require($INC); } +// Load the extension and maybe found language and function files. +function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "") { + global $EXT_LOADED, $_CONFIG, $CSS, $cacheMode; + + // Is the extension already loaded? + //* DEBUG: */ echo "Loading extension {$ext_name}.
\n"; + if ((isset($EXT_LOADED[$ext_name])) && (empty($EXT_LOAD_MODE))) { + // Debug message + DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name)); + return false; + } // END - if + + // Construct FQFN for extension file + $extInclude = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name); + + // Is the extension file NOT there? + if (!FILE_READABLE($extInclude)) { + // Debug message + DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found.", $ext_name)); + + // Abort here + return false; + } // END - if + + // Construct FQFN for language file + $langInclude = sprintf("%sinc/language/%s_%s.php", PATH, $ext_name, GET_LANGUAGE()); + + // Is this include there? + if (FILE_READABLE($langInclude)) { + // Then load it + //* DEBUG: */ echo "--- Language loaded.
\n"; + require($langInclude); + } // END - if + + // Construct FQFN for functions file + $funcsInclude = sprintf("%sinc/libs/%s_functions.php", PATH, $ext_name); + + // Is this include there? + if (FILE_READABLE($funcsInclude)) { + // Then load it + //* DEBUG: */ echo "--- Functions loaded.
\n"; + require($funcsInclude); + } // END - if + + // Extensions are not deprecated by default + $EXT_DEPRECATED = "N"; + + // Include the extension file + //* DEBUG: */ echo "Extension loaded.
\n"; + require($extInclude); + + // Is this extension deprecated? + if ($EXT_DEPRECATED == "Y") { + // Deactivate the extension + DEACTIVATE_EXTENSION($ext_name); + + // Abort here + return false; + } // END - if + + // Mark it as loaded + $EXT_LOADED[$ext_name] = true; + + // All fine! + return true; +} + // -function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) -{ +function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) { global $NOTES, $_CONFIG, $INC_POOL, $cacheInstance; - // We want to register an extension and registration status is by default "failed" (= false) - $EXT_LOAD_MODE = "register"; $ret = false; $SQLs = array(); - $INC_POOL = array(); // This shall never do a non-admin user! if (!IS_ADMIN()) return false; @@ -51,6 +114,15 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) // Is this extension already installed? if (EXT_IS_ACTIVE($ext_name)) return false; + // We want to register an extension and registration status is by default "failed" (= false) + $EXT_LOAD_MODE = "register"; $ret = false; $SQLs = array(); + $INC_POOL = array(); + + // By default the language prefix is the extension's name + // @TODO: Do we really need this one anymore? Can't we just take $ext_name and done? + // By default we have no failtures + $EXT_REPORTS_FAILURE = false; + // Generate file name $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name); @@ -89,25 +161,27 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) $SQLs = array(); $test = false; - // Backup language as well - $LANG_BCK = $EXT_LANG_PREFIX; - $EXT_ALWAYS_ACTIVE = "N"; - // Load required extension also in update mode $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $EXT_UPDATE_DEPENDS); // Check for required file if (FILE_READABLE($file)) { - // File exists so let's load it + // Bacup version number $VER_BACKUP = $EXT_VERSION; + + // Save the Parrent $EXT_ALWAYS_ACTIVE for later! + $EXT_ALWAYS_ACTIVE_PARRENT = $EXT_ALWAYS_ACTIVE; + + // Set EXT_ALWAYS_ACTIVE for update $EXT_ALWAYS_ACTIVE = "N"; + + // File exists so let's load it require($file); - $EXT_VERSION = $VER_BACKUP; // If versions mismatch update extension first $ext_ver = GET_EXT_VERSION($EXT_UPDATE_DEPENDS); - // Extension version set? + // Extension version set? If empty the extension is not registered if (empty($ext_ver)) { // Extension not registered so far so first load task's ID... $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE task_type='EXTENSION' AND subject LIKE '[%s:]%%' LIMIT 1", @@ -134,6 +208,12 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) // Nothing to register / update before... $test = true; } + + // Restore version number + $EXT_VERSION = $VER_BACKUP; + + // Restore $EXT_ALWAYS_ACTIVE with the value from parrent + $EXT_ALWAYS_ACTIVE = $EXT_ALWAYS_ACTIVE_PARRENT; } else { // Required file for update does not exists! $test = true; @@ -142,7 +222,6 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) // Finally restore previous SQLs $SQLs = $SQLs2; unset($SQLs2); - $EXT_LANG_PREFIX = $LANG_BCK; } else { // Does not depend on an other extension $test = true; @@ -151,6 +230,9 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) // Switch back to register mode $EXT_LOAD_MODE = "register"; + // Remains true if extension registration reports no failtures + $test = ($test && !$EXT_REPORTS_FAILURE); + // Does everthing before wents ok? if ($test) { // "Dry-run-mode" activated? @@ -174,13 +256,7 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) } // END - foreach // Remove cache file(s) if extension is active - if ((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) { - //* DEBUG: */ echo __LINE__.": DESTROY!
\n"; - // Remove cache files - if ($cacheInstance->cache_file("extensions", true)) $cacheInstance->cache_destroy(); - if ($cacheInstance->cache_file("mod_reg", true)) $cacheInstance->cache_destroy(); - if ($cacheInstance->cache_file("config", true)) $cacheInstance->cache_destroy(); - } // END - if + RUN_FILTER('post_extension_installed', $ext_name); // Check for added include files if (count($INC_POOL > 0)) { @@ -194,8 +270,8 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) } // END - if // Register extension - $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_lang_file, ext_active, ext_version) VALUES ('%s','%s','%s','%s')", - array($ext_name, $EXT_LANG_PREFIX, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__); + $result = 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__); // Update task management ADMIN_SOLVE_TASK($id); @@ -312,11 +388,8 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) { // Remove cache file(s) if extension is active if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($EXT_LOAD_MODE == "activate") || ($EXT_LOAD_MODE == "deactivate"))) { - //* DEBUG: */ echo __LINE__.": DESTROY!
\n"; - // Remove cache files - if ($cacheInstance->cache_file("extensions", true)) $cacheInstance->cache_destroy(); - if ($cacheInstance->cache_file("mod_reg", true)) $cacheInstance->cache_destroy(); - if ($cacheInstance->cache_file("config", true)) $cacheInstance->cache_destroy(); + // Run filters + RUN_FILTER('post_extension_run_sql', $ext_name); // @TODO This causes the whole (!) menu cache being purged CACHE_PURGE_ADMIN_MENU(); @@ -367,7 +440,7 @@ function EXT_IS_ACTIVE ($ext_name) { } // Debug message - //DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name={$ext_name},active={$active}"); + //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name={$ext_name},active={$active}"); // Is this extension activated? (For admins we always have active extensions...) return ($active == "Y"); @@ -405,8 +478,7 @@ function GET_EXT_VERSION ($ext_name) { return $ret; } // -function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false) -{ +function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false) { // This shall never do a non-admin user! global $cacheInstance, $_CONFIG, $NOTES; @@ -428,15 +500,13 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false) } // Check if version is updated - if ((($EXT_VERSION != $EXT_VER) || ($dry_run)) && (is_array($EXT_VER_HISTORY))) - { + if ((($EXT_VERSION != $EXT_VER) || ($dry_run)) && (is_array($EXT_VER_HISTORY))) { // Search for starting point $start = array_search($EXT_VER, $EXT_VER_HISTORY); $NOTES = ""; // And load SQL queries in order of version history - for ($idx = ($start + 1); $idx < sizeof($EXT_VER_HISTORY); $idx++) - { + for ($idx = ($start + 1); $idx < sizeof($EXT_VER_HISTORY); $idx++) { // Remove old SQLs array to prevent possible bugs if (!$dry_run) { unset($SQLs); $SQLs = array(); } @@ -447,25 +517,19 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false) include(PATH."inc/extensions/".$file); // Add notes - if ($_CONFIG['verbose_sql'] == "Y") - { + if ($_CONFIG['verbose_sql'] == "Y") { $EXT_VER = $EXT_VER_HISTORY[$idx]; - if (!empty($UPDATE_NOTES)) - { + if (!empty($UPDATE_NOTES)) { // Update notes found $NOTES .= "v".$EXT_VER.":
".$UPDATE_NOTES."

\n"; $UPDATE_NOTES = ""; - } - elseif ($EXT_VER == "0.0") - { + } elseif ($EXT_VER == "0.0") { // Initial release $NOTES .= "v".$EXT_VER.":
".INITIAL_RELEASE."

\n"; - } - else - { + } else { $NOTES .= "v".$EXT_VER.":
".NO_UPDATE_NOTES."

\n"; } - } + } // END - if // In real-mode execute any existing includes if ((!$dry_run) && (count($INC_POOL) > 0)) { @@ -497,10 +561,9 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false) // Remove SQLs if extension is not installed $SQLs = array(); } - } + } // END - for - if (!$dry_run) - { + if (!$dry_run) { // In normal mode insert task and update extension's version... $ext_subj = "[UPDATE-".$ext."-".$EXT_VERSION.":] ".ADMIN_UPDATE_EXT_SUBJ; @@ -509,32 +572,29 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false) // Update extension's version $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1", - array($EXT_VERSION, $ext), __FILE__, __LINE__); - - // Update cache - if (EXT_IS_ACTIVE("cache")) { - if ($cacheInstance->cache_file("extensions", true) == true) $cacheInstance->cache_destroy(); - if ($cacheInstance->cache_file("config", true) == true) $cacheInstance->cache_destroy(); - if ($cacheInstance->cache_file("mod_reg", true) == true) $cacheInstance->cache_destroy(); - } // END - if + array($EXT_VERSION, $ext), __FILE__, __LINE__); // Remove array unset($SQLs); + + // Run filters on success extension update + RUN_FILTER('extension_update', $ext); } else { // In "dry-run" mode return array with SQL commands return $SQLs; } } } -// -function EXTENSION_VERBOSE_TABLE($SQLs, $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed = "", $switch = false, $WIDTH = "480") { + +// Output verbose SQL table for extension +function EXTENSION_VERBOSE_TABLE ($SQLs, $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed = "", $switch = false, $width = "480") { global $_CONFIG; $S = false; $SW = 2; $i = 1; $OUT = ""; if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && ($_CONFIG['verbose_sql'] == "Y")) { $OUT = "
- +
".$title.": @@ -574,6 +634,7 @@ function EXTENSION_VERBOSE_TABLE($SQLs, $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, // Return output return $OUT; } + // Get extension name from id function GET_EXT_NAME ($id) { $ret = ""; @@ -587,12 +648,13 @@ function GET_EXT_NAME ($id) { } elseif (!EXT_IS_ACTIVE("cache")) { // Load from database $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1", - array(bigintval($id)), __FILE__, __LINE__); + array(bigintval($id)), __FILE__, __LINE__); list($ret) = SQL_FETCHROW($result); SQL_FREERESULT($result); } return $ret; } + // Get extension id from name function GET_EXT_ID($name) { $ret = 0; @@ -606,7 +668,7 @@ function GET_EXT_ID($name) { } elseif (!EXT_IS_ACTIVE("cache")) { // Load from database $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1", - array($name), __FILE__, __LINE__); + array($name), __FILE__, __LINE__); list($ret) = SQL_FETCHROW($result); SQL_FREERESULT($result); } @@ -614,8 +676,9 @@ function GET_EXT_ID($name) { // Return value return $ret; } + // Activate given extension -function ACTIVATE_EXTENSION($ext_name) { +function ACTIVATE_EXTENSION ($ext_name) { // Activate the extension $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_active='Y' WHERE ext_name='%s' LIMIT 1", array($ext_name), __FILE__, __LINE__); @@ -626,6 +689,26 @@ function ACTIVATE_EXTENSION($ext_name) { EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "activate"); } // END - if } + +// Deactivate given extension +function DEACTIVATE_EXTENSION($ext_name) { + // Activate the extension + $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_active='N' WHERE ext_name='%s' LIMIT 1", + array($ext_name), __FILE__, __LINE__); + + // Extension has been activated? + if (SQL_AFFECTEDROWS() == 1) { + // Then run all queries + EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "deactivate"); + + // Create new task + CREATE_EXTENSION_DEACTIVATION_TASK($ext_name); + + // Notify the admin + SEND_ADMIN_NOTIFICATION(ADMIN_SUBJECT_EXTENSION_DEACTIVATED, "admin_ext_deactivated", array('ext_name' => $ext_name)); + } // END - if +} + // Checks wether the extension is older than given function EXT_VERSION_IS_OLDER ($ext_name, $ext_ver) { // Get current extension version @@ -639,5 +722,80 @@ function EXT_VERSION_IS_OLDER ($ext_name, $ext_ver) { return ($currVersion < $ext_ver); } +// Creates a new task for updated extension +function CREATE_EXTENSION_UPDATE_TASK ($admin_id, $subject, $notes) { + // Check if task is not there + $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE subject='%s' LIMIT 1", + array($subject), __FILE__, __LINE__); + if (SQL_NUMROWS($result) == 0) { + // Task not created so it's a brand-new extension which we need to register and create a task for! + $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_task_system (assigned_admin, userid, status, task_type, subject, text, task_created) VALUES ('%s','0','NEW','EXTENSION_UPDATE','%s','%s', UNIX_TIMESTAMP())", + array($admin_id, $subject, $notes), __FILE__, __LINE__); + } // END - if + + // Free memory + SQL_FREERESULT($result); +} + +// Creates a new task for newly installed extension +function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) { + // Not installed and do we have created a task for the admin? + $result = SQL_QUERY_ESC("SELECT `id` FROM `"._MYSQL_PREFIX."_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1", + array($subject), __FILE__, __LINE__); + if ((SQL_NUMROWS($result) == 0) && (GET_EXT_VERSION($ext) == "")) { + // Template file + $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl", + PATH, + GET_LANGUAGE(), + $ext + ); + + // Load text for task + if (FILE_READABLE($tpl)) { + // Load extension's own text template (HTML!) + $msg = LOAD_TEMPLATE("ext_".$ext, true); + } else { + // Load default message + $msg = LOAD_TEMPLATE("admin_new_ext", "", 0); + } + + // Task not created so it's a brand-new extension which we need to register and create a task for! + $result_insert = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_task_system (assigned_admin, userid, status, task_type, subject, text, task_created) +VALUES (%s,0,'NEW','EXTENSION','%s','%s',UNIX_TIMESTAMP())", + array( + $admin_id, + $subject, + addslashes($msg), + ), __FILE__, __LINE__, true, false + ); + } // END - if + + // Free memory + SQL_FREERESULT($result); +} + +// Creates a task for automatically deactivated (deprecated) extension +function CREATE_EXTENSION_DEACTIVATION_TASK ($ext) { + // Create subject line + $subject = sprintf("[%s:] %s", $ext, TASK_SUBJ_EXTENSION_DEACTIVATED); + + // Not installed and do we have created a task for the admin? + $result = SQL_QUERY_ESC("SELECT `id` FROM `"._MYSQL_PREFIX."_task_system` WHERE `subject` = '%s' LIMIT 1", + array($subject), __FILE__, __LINE__); + if ((SQL_NUMROWS($result) == 0) && (GET_EXT_VERSION($ext) != "")) { + // Task not created so add it + $result_insert = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_task_system (assigned_admin, userid, status, task_type, subject, text, task_created) +VALUES (0,0,'NEW','EXTENSION_DEACTIVATION','%s','%s',UNIX_TIMESTAMP())", + array( + $subject, + addslashes(LOAD_TEMPLATE("task_ext_deactivated", true, $ext)), + ), __FILE__, __LINE__, true, false + ); + } // END - if + + // Free memory + SQL_FREERESULT($result); +} + // ?>