More misc fixes and rewrites (sorry, lame description)
[mailer.git] / inc / extensions.php
index d6c49ad67cf0eae33893234dbfae21fe3d0dfa00..5fb56a2765bebf70eacbcc594e2ac620be0b460a 100644 (file)
@@ -61,6 +61,8 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = '', $EXT_VER = '', $dry_run
        if ((isset($GLOBALS['ext_loaded']['ext'][$ext_name])) && (empty($EXT_LOAD_MODE))) {
                // Debug message
                DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
+
+               // Abort here
                return false;
        } // END - if
 
@@ -71,7 +73,7 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = '', $EXT_VER = '', $dry_run
        // Is the extension file NOT there?
        if (!isIncludeReadable($INC)) {
                // Debug message
-               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found.", $ext_name));
+               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found or not readable.", $ext_name));
 
                // Abort here
                return false;
@@ -86,7 +88,12 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = '', $EXT_VER = '', $dry_run
                //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Language loaded.");
                $GLOBALS['ext_loaded']['lang'][$ext_name] = true;
                loadIncludeOnce($langInclude);
-       } // END - if
+       } elseif ((isDebugModeEnabled()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme')) {
+               // No language file is not so good...
+               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("WARNING: Extension %s has no language file or we cannot read from it. lang=%s",
+                       $ext_name, getLanguage()
+               ));
+       }
 
        // Construct FQFN for functions file
        $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
@@ -97,6 +104,11 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = '', $EXT_VER = '', $dry_run
                //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Functions loaded.");
                $GLOBALS['ext_loaded']['funcs'][$ext_name] = true;
                loadIncludeOnce($funcsInclude);
+       } elseif ((isDebugModeEnabled()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme')) {
+               // No functions file is not so good...
+               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("WARNING: Extension %s has no own functions file or we cannot read from it.",
+                       $ext_name
+               ));
        } // END - if
 
        // Extensions are not deprecated by default
@@ -106,7 +118,7 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = '', $EXT_VER = '', $dry_run
        EXT_SET_ALWAYS_ACTIVE('N');
 
        // Extension update notes
-       EXT_SET_UPDATE_NOTES("");
+       EXT_SET_UPDATE_NOTES('');
 
        // Include the extension file
        //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Extension loaded.");
@@ -164,8 +176,8 @@ function REGISTER_EXTENSION ($ext_name, $task_id, $dry_run = false, $logout = tr
                if (($task_id == 0) && (!$dry_run)) {
                        // Then request a bug report
                        debug_report_bug(sprintf("%s: task_id is still zero after DETERMINE_EXTENSION_TASK_ID(%s)",
-                               __FUNCTION__,
-                               EXT_GET_CURR_NAME()
+                       __FUNCTION__,
+                       EXT_GET_CURR_NAME()
                        ));
                } // END - if
        } // END - if
@@ -226,6 +238,9 @@ function REGISTER_EXTENSION ($ext_name, $task_id, $dry_run = false, $logout = tr
                                                // Try to register the extension
                                                //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().":ext_update=".$ext_update.",taskId=".$task."<br />\n";
                                                $test = REGISTER_EXTENSION($ext_update, $task, $dry_run, false);
+
+                                               // Reset extension name
+                                               EXT_SET_CURR_NAME($ext_name);
                                                //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().':'; var_dump($test);
                                        } // END - if
                                } elseif ($ext_ver != EXT_GET_VERSION()) {
@@ -266,7 +281,7 @@ function REGISTER_EXTENSION ($ext_name, $task_id, $dry_run = false, $logout = tr
                if ($test === true) {
                        // "Dry-run-mode" activated?
                        if ((!$dry_run) && (!EXT_IS_ON_REMOVAL_LIST())) {
-                               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name=".EXT_GET_CURR_NAME());
+                               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ext_name=".EXT_GET_CURR_NAME());
                                // Init SQLs and transfer ext->generic
                                INIT_SQLS();
                                SET_SQLS(GET_EXT_SQLS());
@@ -328,7 +343,7 @@ function REGISTER_EXTENSION ($ext_name, $task_id, $dry_run = false, $logout = tr
                        redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $EXT_LOAD_MODE . '=sql_patches');
                } else {
                        // Add temporary filter
-                       REGISTER_FILTER('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true);
+                       registerFilter('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true);
                        $GLOBALS['ext_load_mode'] = $EXT_LOAD_MODE;
                }
        } // END - if
@@ -349,7 +364,10 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
        $ext_name = GET_EXT_NAME($ext_id);
 
        // If it is not set then maybe there is no extension for that ID number
-       if ($ext_name == '') return false;
+       if (empty($ext_name)) {
+               // We should fix these all!
+               debug_report_bug(__FUNCTION__ . ': ext_name is empty. ext_id=' . $ext_id);
+       } // END - if
 
        // Set current SQL name
        EXT_SET_CURR_NAME($ext_name);
@@ -373,6 +391,9 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
 
        //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".COUNT_SQLS()."");
        if ((IS_SQLS_VALID() && (COUNT_SQLS() > 0))) {
+               // Run any filters depending on the action here
+               runFilterChain('extension_' . $load_mode, $ext_name);
+
                // Run SQL commands...
                runFilterChain('run_sqls');
 
@@ -421,7 +442,7 @@ function EXT_IS_ACTIVE ($ext_name) {
        } elseif (($ext_name == 'cache') || (GET_EXT_VERSION('cache') == '')) {
                //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}");
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT ext_active FROM `{!_MYSQL_PREFIX!}_extensions` WHERE `ext_name`='%s' LIMIT 1",
+               $result = SQL_QUERY_ESC("SELECT `ext_active` FROM `{!_MYSQL_PREFIX!}_extensions` WHERE `ext_name`='%s' LIMIT 1",
                        array($ext_name), __FUNCTION__, __LINE__);
 
                // Entry found?
@@ -443,7 +464,7 @@ function EXT_IS_ACTIVE ($ext_name) {
        }
 
        // Debug message
-       //* DEBUG: */ 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');
@@ -456,7 +477,7 @@ function GET_EXT_VERSION ($ext_name) {
        // Empty extension name should be fixed!
        if (empty($ext_name)) {
                // Please report this bug!
-               debug_report_bug(__FUNCTION__.": ext_name is empty which is not allowed here.");
+               debug_report_bug(__FUNCTION__ . ': ext_name is empty which is not allowed here.');
        } // END - if
 
        // Extensions are all inactive during installation
@@ -473,7 +494,7 @@ function GET_EXT_VERSION ($ext_name) {
                incrementConfigEntry('cache_hits');
        } elseif (!isCacheInstanceValid()) {
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT ext_version FROM `{!_MYSQL_PREFIX!}_extensions` WHERE `ext_name`='%s' LIMIT 1",
+               $result = SQL_QUERY_ESC("SELECT `ext_version` FROM `{!_MYSQL_PREFIX!}_extensions` WHERE `ext_name`='%s' LIMIT 1",
                        array($ext_name), __FUNCTION__, __LINE__);
                //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": DB - ".SQL_NUMROWS($result)."");
 
@@ -481,7 +502,10 @@ function GET_EXT_VERSION ($ext_name) {
                if (SQL_NUMROWS($result) == 1) {
                        // Load entry
                        list($ext_ver) = SQL_FETCHROW($result);
-               } // END - if
+               } elseif (isDebugModeEnabled()) {
+                       // Not found!
+                       DEBUG_LOG(__FUNCTION__, __LINE__, sprintf(": Cannot find extension %s in database!", $ext_name));
+               }
 
                // Free result
                SQL_FREERESULT($result);
@@ -524,21 +548,38 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
 
                // And load SQL queries in order of version history
                for ($idx = ($start + 1); $idx < count($history); $idx++) {
+                       // Set current extension name
+                       //* DEBUG: */ print __FUNCTION__.'['.__LINE__.':] ext_name='.$ext_name.'<br />';
+                       EXT_SET_CURR_NAME($ext_name);
+
                        // Set extension version
                        $GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()] = $history[$idx];
 
                        // Load again...
                        LOAD_EXTENSION(EXT_GET_CURR_NAME(), 'update', $GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()], $dry_run);
 
-                       if (EXT_GET_UPDATE_DEPENDS() != '') {
-                               // Is the extension there?
-                               if (GET_EXT_VERSION(EXT_GET_UPDATE_DEPENDS()) != '') {
-                                       // Update another extension first!
-                                       $test = EXTENSION_UPDATE(EXT_GET_UPDATE_DEPENDS(), GET_EXT_VERSION(EXT_GET_UPDATE_DEPENDS()), $dry_run);
-                               } else {
-                                       // Register new extension
-                                       $test = REGISTER_EXTENSION(EXT_GET_UPDATE_DEPENDS(), 0, $dry_run, false);
-                               }
+                       // Get all depencies
+                       $depencies = EXT_GET_UPDATE_DEPENDS();
+
+                       // Nothing to apply?
+                       if (count($depencies) > 0) {
+                               // Apply all extension depencies
+                               foreach ($depencies as $ext_depend) {
+                                       // Set it as current
+                                       EXT_SET_CURR_NAME($ext_depend);
+
+                                       // Is the extension there?
+                                       if (GET_EXT_VERSION($ext_depend) != '') {
+                                               // Update another extension first!
+                                               $test = EXTENSION_UPDATE($ext_depend, GET_EXT_VERSION($ext_depend), $dry_run);
+                                       } else {
+                                               // Register new extension
+                                               $test = REGISTER_EXTENSION($ext_depend, 0, $dry_run, false);
+                                       }
+                               } // END - foreach
+
+                               // Set name back
+                               EXT_SET_CURR_NAME($ext_name);
                        } // END - if
 
                        // Add notes
@@ -566,7 +607,7 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
 
                        // Update extension's version
                        SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_version='%s' WHERE `ext_name`='%s' LIMIT 1",
-                               array($GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()], EXT_GET_CURR_NAME()), __FUNCTION__, __LINE__);
+                       array($GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()], EXT_GET_CURR_NAME()), __FUNCTION__, __LINE__);
 
                        // Remove arrays
                        UNSET_SQLS();
@@ -579,7 +620,7 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
 }
 
 // Output verbose SQL table for extension
-function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = '', $dashed = '', $switch = false, $width = "100%") {
+function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = '', $dashed = '', $switch = false, $width = '100%') {
        // Empty title?
        if (empty($title)) {
                // Then fix it to default
@@ -658,6 +699,8 @@ function GET_EXT_NAME ($ext_id) {
                list($ret) = SQL_FETCHROW($result);
                SQL_FREERESULT($result);
        }
+
+       // Return the extension name
        return $ret;
 }
 
@@ -687,7 +730,7 @@ function GET_EXT_ID ($ext_name) {
 function ACTIVATE_EXTENSION ($ext_name) {
        // 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__);
+       array($ext_name), __FUNCTION__, __LINE__);
 
        // Extension has been activated?
        if (SQL_AFFECTEDROWS() == 1) {
@@ -700,7 +743,7 @@ function ACTIVATE_EXTENSION ($ext_name) {
 function DEACTIVATE_EXTENSION($ext_name) {
        // 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__);
+       array($ext_name), __FUNCTION__, __LINE__);
 
        // Extension has been activated?
        if (SQL_AFFECTEDROWS() == 1) {
@@ -712,9 +755,9 @@ function DEACTIVATE_EXTENSION($ext_name) {
 
                // Notify the admin
                sendAdminNotification(
-                       getMessage('ADMIN_SUBJECT_EXTENSION_DEACTIVATED'),
+               getMessage('ADMIN_SUBJECT_EXTENSION_DEACTIVATED'),
                        'admin_ext_deactivated',
-                       array('ext_name' => $ext_name)
+               array('ext_name' => $ext_name)
                );
        } // END - if
 }
@@ -742,8 +785,7 @@ function CREATE_EXTENSION_UPDATE_TASK ($admin_id, $ext_name, $ext_ver, $notes) {
                // Check if task is not there
                if (DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) {
                        // Task not created so it's a brand-new extension which we need to register and create a task for!
-                       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), __FUNCTION__, __LINE__);
+                       createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $admin_id);
                } // END - if
        } // END - if
 }
@@ -752,6 +794,9 @@ function CREATE_EXTENSION_UPDATE_TASK ($admin_id, $ext_name, $ext_ver, $notes) {
 function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) {
        // Not installed and do we have created a task for the admin?
        if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) == '')) {
+               // Set default message if ext-foo is missing
+               $message = sprintf(getMessage('ADMIN_EXT_TEXT_FILE_MISSING'), $ext);
+
                // Template file
                $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
                        constant('PATH'),
@@ -759,27 +804,17 @@ function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) {
                        $ext
                );
 
-               // Set default message if ext-foo is missing
-               $msg = sprintf(getMessage('ADMIN_EXT_TEXT_FILE_MISSING'), $ext);
-
                // Load text for task if found
                if (isFileReadable($tpl)) {
                        // Load extension's own text template (HTML!)
-                       $msg = LOAD_TEMPLATE('ext_' . $ext, true);
+                       $message = LOAD_TEMPLATE('ext_' . $ext, true);
                } else {
                        // Write this in debug.log as well
-                       DEBUG_LOG(__FUNCTION__, __LINE__, $msg);
+                       DEBUG_LOG(__FUNCTION__, __LINE__, $message);
                }
 
                // Task not created so it's a brand-new extension which we need to register and create a task for!
-               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,
-                               smartAddSlashes($msg),
-                       ),  __FUNCTION__, __LINE__, true, false, false
-               );
+               createNewTask($subject, $message, 'EXTENSION_UPDATE', 0, $admin_id, false);
        } // END - if
 }
 
@@ -791,13 +826,7 @@ function CREATE_EXTENSION_DEACTIVATION_TASK ($ext) {
        // Not installed and do we have created a task for the admin?
        if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) != '')) {
                // Task not created so add it
-               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,
-                               SQL_ESCAPE(LOAD_TEMPLATE('task_ext_deactivated', true, $ext)),
-                       ),  __FUNCTION__, __LINE__, true, false
-               );
+               createNewTask($subject, SQL_ESCAPE(LOAD_TEMPLATE('task_ext_deactivated', true, $ext)), 'EXTENSION_DEACTIVATION');
        } // END - if
 }
 
@@ -823,7 +852,7 @@ function MODULE_HAS_MENU ($mod, $forceDb = false) {
                }
        } elseif ((GET_EXT_VERSION('sql_patches') >= '0.3.6') && ((!EXT_IS_ACTIVE('cache')) || ($forceDb === true))) {
                // Check database for entry
-               $result = SQL_QUERY_ESC("SELECT has_menu FROM `{!_MYSQL_PREFIX!}_mod_reg` WHERE `module`='%s' LIMIT 1",
+               $result = SQL_QUERY_ESC("SELECT `has_menu` FROM `{!_MYSQL_PREFIX!}_mod_reg` WHERE `module`='%s' LIMIT 1",
                        array($mod), __FUNCTION__, __LINE__);
 
                // Entry found?
@@ -856,7 +885,7 @@ function DETERMINE_EXTENSION_TASK_ID ($ext_name) {
        $task_id = 0;
 
        // Search for extension task's id
-       $result = SQL_QUERY_ESC("SELECT `id` FROM `{!_MYSQL_PREFIX!}_task_system` WHERE task_type='EXTENSION' AND subject='[%s:]' LIMIT 1",
+       $result = SQL_QUERY_ESC("SELECT `id` FROM `{!_MYSQL_PREFIX!}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
                array($ext_name), __FUNCTION__, __LINE__);
 
        // Entry found?
@@ -878,7 +907,7 @@ function DETERMINE_TASK_ID_BY_SUBJECT ($subject) {
        $task_id = 0;
 
        // Search for task id
-       $result = SQL_QUERY_ESC("SELECT `id` FROM `{!_MYSQL_PREFIX!}_task_system` WHERE subject LIKE '%s%%' LIMIT 1",
+       $result = SQL_QUERY_ESC("SELECT `id` FROM `{!_MYSQL_PREFIX!}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
                array($subject), __FUNCTION__, __LINE__);
 
        // Entry found?
@@ -901,7 +930,6 @@ function ADD_EXTENSION_NOTES ($ver) {
 
        // Is do we have verbose output enabled?
        if ((getConfig('verbose_sql') == 'Y') || (!EXT_IS_ACTIVE('sql_patches'))) {
-
                // Update notes found?
                if (EXT_GET_UPDATE_NOTES() != '') {
                        // Update notes found
@@ -911,7 +939,7 @@ function ADD_EXTENSION_NOTES ($ver) {
                        );
 
                        // Reset them
-                       EXT_SET_UPDATE_NOTES("");
+                       EXT_SET_UPDATE_NOTES('');
                } elseif (($ver == '0.0') || ($ver == '0.0.0')) {
                        // Initial release
                        $content = array(
@@ -1193,7 +1221,7 @@ function GET_EXT_SQLS () {
        if (!isset($GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()])) {
                // Not found, should not happen
                debug_report_bug(sprintf("ext_sqls is empty, current extension: %s",
-                       EXT_GET_CURR_NAME()
+               EXT_GET_CURR_NAME()
                ));
        } // END - if
 
@@ -1237,13 +1265,25 @@ function EXT_GET_REMOVAL_LIST () {
 }
 
 // Redirects if the provided extension is not installed
-function REDIRECT_ON_UNINSTALLED_EXTENSION ($ext_name) {
+function redirectOnUninstalledExtension ($ext_name) {
        // So is the extension there?
-       if (!EXT_IS_ACTIVE($ext_name)) {
+       if ((!isExtensionInstalled($ext_name)) || (!EXT_IS_ACTIVE($ext_name))) {
                // Redirect to index
                redirectToUrl('modules.php?module=index&amp;msg=' . getCode('EXTENSION_PROBLEM') . '&amp;ext=' . $ext_name);
        } // END - if
 }
 
+// Determines wether the given extension is installed
+function isExtensionInstalled ($ext_name) {
+       // Default is not installed
+       $isInstalled = false;
+
+       // Check cache ext_version
+       $isInstalled = isset($GLOBALS['cache_array']['extensions']['ext_version'][$ext_name]);
+
+       // Return status
+       return $isInstalled;
+}
+
 //
 ?>