Extension notes and verbose SQL table rewritten to templates. Resolved #13
[mailer.git] / inc / extensions.php
index 4cc56fb5b6e10863564df84147d4d68ade3ecaf0..a59e17b086ff61ef806d85a365349eb99dd11427 100644 (file)
@@ -127,7 +127,7 @@ function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run
 function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = true) {
        global $UPDATE_NOTES, $INC_POOL, $cacheInstance;
        global $EXT_VER_HISTORY, $NOTES, $EXT_ALWAYS_ACTIVE, $EXT_VERSION;
-       global $EXT_UPDATE_DEPENDS, $SQLs;
+       global $EXT_UPDATE_DEPENDS;
 
        // This shall never do a non-admin user!
        if (!IS_ADMIN()) return false;
@@ -140,8 +140,6 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr
        $NOTES = "";
        $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;
 
@@ -154,20 +152,8 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr
                        // Load extension in update mode
                        LOAD_EXTENSION($ext_name, "update", $ver, $dry_run, $SQLs);
 
-                       // Do we have an update?
-                       if (((GET_EXT_VERSION("sql_patches") != "") && (getConfig('verbose_sql') == "Y")) || (!EXT_IS_ACTIVE("sql_patches"))) {
-                               if (!empty($UPDATE_NOTES)) {
-                                       // Update notes found
-                                       $NOTES .= ("<div class=\"update_notes\"><strong>v".$ver.":</strong><br />".$UPDATE_NOTES."</div>");
-                                       $UPDATE_NOTES = "";
-                               } elseif (($ver == "0.0") || ($ver == "0.0.0")) {
-                                       // Initial release
-                                       $NOTES .= ("<div class=\"update_notes\"><strong>v".$ver.":</strong><br />".INITIAL_RELEASE."</div>");
-                               } else {
-                                       // No update notes found!
-                                       $NOTES .= ("<div class=\"update_notes\"><strong>v".$ver.":</strong><br /><I>".NO_UPDATE_NOTES."</I></div>");
-                               }
-                       } // END - if
+                       // Add update notes to our output
+                       $NOTES .= ADD_EXTENSION_NOTES($ver, $UPDATE_NOTES);
                } // END - foreach
 
                // Does this extension depends on an outstanding update of another update?
@@ -227,14 +213,14 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr
                        // "Dry-run-mode" activated?
                        if (!$dry_run) {
                                // Run installation pre-installation filters
-                               RUN_FILTER('pre_extension_installed', false);
+                               RUN_FILTER('pre_extension_installed', array('dry_run' => $dry_run, 'sqls' => $SQLs));
 
                                // Register extension
-                               $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_active, ext_version) VALUES ('%s','%s','%s')",
+                               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__);
 
                                // Remove cache file(s) if extension is active
-                               RUN_FILTER('post_extension_installed', array('ext_name' => $ext_name, 'task_id' => $task_id));
+                               RUN_FILTER('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;
@@ -257,7 +243,7 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr
                }
        } elseif (($task_id > 0) && (!empty($ext_name))) {
                // Remove task from system when id and extension's name is valid
-               $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%s AND status='NEW' LIMIT 1",
+               SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%s AND status='NEW' LIMIT 1",
                        array(bigintval($task_id)), __FILE__, __LINE__);
        }
 
@@ -282,7 +268,7 @@ function EXTENSION_REGISTER ($ext_name, $task_id, $dry_run = false, $logout = tr
 // Run SQL queries for given extension id
 // @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
 function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
-       global $cacheInstance, $SQLs;
+       global $cacheInstance;
 
        // This shall never do a non-admin user!
        if (!IS_ADMIN()) return false;
@@ -304,12 +290,12 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
        //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".count($SQLs)."");
        if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
                // Run SQL commands...
-               RUN_FILTER('run_sqls');
+               RUN_FILTER('run_sqls', array('dry_run' => false, 'sqls' => $SQLs));
 
                // Removal mode?
                if ($load_mode == "remove") {
                        // Delete this extension (remember to remove it from your server *before* you click on welcome!
-                       $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
+                       SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
                                array($ext_name), __FILE__, __LINE__);
                } // END - if
        } // END - if
@@ -331,7 +317,7 @@ function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
 
 // Check if given extension is active
 function EXT_IS_ACTIVE ($ext_name) {
-       global $cacheArray, $_CONFIG;
+       global $cacheArray;
 
        // Extensions are all inactive during installation
        if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing')) || (empty($ext_name))) return false;
@@ -346,7 +332,7 @@ function EXT_IS_ACTIVE ($ext_name) {
                $active = $cacheArray['extensions']['ext_active'][$ext_name];
 
                // Count cache hits
-               if (getConfig('cache_hits') > 0) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
+               incrementConfigEntry('cache_hits');
        } elseif (($ext_name == "cache") || (GET_EXT_VERSION("cache") == "")) {
                //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}");
                // Load from database
@@ -379,7 +365,7 @@ function EXT_IS_ACTIVE ($ext_name) {
 }
 // Get version from extensions
 function GET_EXT_VERSION ($ext_name) {
-       global $cacheArray, $_CONFIG, $cacheInstance;
+       global $cacheArray, $cacheInstance;
        $ext_ver = false;
 
        // Extensions are all inactive during installation
@@ -393,7 +379,7 @@ function GET_EXT_VERSION ($ext_name) {
                $ext_ver = $cacheArray['extensions']['ext_version'][$ext_name];
 
                // Count cache hits
-               if (getConfig('cache_hits') > 0) $_CONFIG['cache_hits']++; else $_CONFIG['cache_hits'] = 1;
+               incrementConfigEntry('cache_hits');
        } elseif (!is_object($cacheInstance)) {
                // Load from database
                $result = SQL_QUERY_ESC("SELECT ext_version FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
@@ -421,11 +407,14 @@ function GET_EXT_VERSION ($ext_name) {
 function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
        // This shall never do a non-admin user!
        global $cacheInstance, $UPDATE_NOTES, $NOTES, $EXT_VER_HISTORY;
-       global $EXT_UPDATE_DEPENDS, $EXT_VERSION, $INC_POOL, $cacheArray;
+       global $EXT_UPDATE_DEPENDS, $EXT_VERSION, $INC_POOL, $cacheArray, $SQLs;
 
        // Init arrays
        $SQLs = array(); $INC_POOL = array();
 
+       // Init notes
+       $NOTES = "";
+
        // Only admins are allowed to update extensions
        if ((!IS_ADMIN()) || (empty($ext_name))) return false;
 
@@ -442,7 +431,6 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
        if ((($EXT_VERSION != $ext_ver) || ($dry_run)) && (is_array($history))) {
                // Search for starting point
                $start = array_search($ext_ver, $history);
-               $NOTES = "";
 
                // And load SQL queries in order of version history
                for ($idx = ($start + 1); $idx < sizeof($history); $idx++) {
@@ -471,37 +459,26 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
                        } // END - if
 
                        // Add notes
-                       if (getConfig('verbose_sql') == "Y") {
-                               if (!empty($UPDATE_NOTES)) {
-                                       // Update notes found
-                                       $NOTES .= ("<div class=\"update_notes\"><strong>v".$cacheArray['update_ver'][$ext_name].":</strong><br />".$UPDATE_NOTES."</div>");
-                                       $UPDATE_NOTES = "";
-                               } elseif ($cacheArray['update_ver'][$ext_name] == "0.0") {
-                                       // Initial release
-                                       $NOTES .= ("<div class=\"update_notes\"><strong>v".$cacheArray['update_ver'][$ext_name].":</strong><br />".INITIAL_RELEASE."</div>");
-                               } else {
-                                       $NOTES .= ("<div class=\"update_notes\"><strong>v".$cacheArray['update_ver'][$ext_name].":</strong><br /><I>".NO_UPDATE_NOTES."</I></div>");
-                               }
-                       } // END - if
+                       $NOTES .= ADD_EXTENSION_NOTES($cacheArray['update_ver'][$ext_name], $UPDATE_NOTES);
                } // END - for
 
                // In real-mode execute any existing includes
                if (!$dry_run) {
                        $cacheArray['inc_pool'][$ext_name] = $INC_POOL;
-                       RUN_FILTER('load_includes');
+                       RUN_FILTER('load_includes', $INC_POOL);
                        $INC_POOL = $cacheArray['inc_pool'][$ext_name];
                        unset($cacheArray['inc_pool'][$ext_name]);
                } // END - if
 
                // Run SQLs
-               RUN_FILTER('run_sqls', $dry_run);
+               RUN_FILTER('run_sqls', array('dry_run' => $dry_run, 'sqls' => $SQLs));
 
                if (!$dry_run) {
                        // Create task
                        CREATE_EXTENSION_UPDATE_TASK(GET_CURRENT_ADMIN_ID(), $ext_name, $cacheArray['update_ver'][$ext_name], addslashes($NOTES));
 
                        // Update extension's version
-                       $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
+                       SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
                                array($cacheArray['update_ver'][$ext_name], $ext_name), __FILE__, __LINE__);
 
                        // Remove arrays
@@ -514,7 +491,7 @@ function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
                        // In "dry-run" mode return array with SQL commands
                        return $SQLs;
                }
-       }
+       } // END - if
 }
 
 // Output verbose SQL table for extension
@@ -528,48 +505,47 @@ function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = ADMIN_SQLS_EXECUT
        } // END - if
 
        // Init variables
-       $S = false; $SW = 2; $i = 1;
+       $SW = 2; $i = 1;
        $OUT = "";
 
        // Do we have queries?
        if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
-               $OUT  = "<div align=\"center\">
-<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"".$width."\" align=\"center\"".$dashed.">
-<tr>
-  <td colspan=\"2\" align=\"center\" class=\"admin_title bottom2\" height=\"24\">
-    <strong>".$title.":</strong>
-  </td>
-</tr>\n";
                foreach ($SQLs as $idx => $sql) {
+                       // Trim out spaces
                        $sql = trim($sql);
+
+                       // Output command if set
                        if (!empty($sql)) {
-                               $S = true;
-                               $OUT .= "<tr>
-  <td class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 2px\" width=\"30\">".$i.".</td>
-  <td class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 5px; padding-right: 5px\">
-    ".$sql."
-  </td>
-</tr>\n";
-                               if ($switch) $SW = 3 - $SW;
+                               // Prepare output for template
+                               $content = array(
+                                       'sw'  => $SW,
+                                       'i'   => $i,
+                                       'sql' => $sql
+                               );
+
+                               // Load row template
+                               $OUT .= LOAD_TEMPLATE("admin_ext_sql_row", true, $content);
+
+                               // Switch color and count up
+                               $SW = 3 - $SW;
                                $i++;
-                       }
-               }
-       }
+                       } // END - if
+               } // END - foreach
 
-       if ((!$S) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
-               // No addional SQL commands to run
-               $OUT .= "<tr>
-  <td colspan=\"2\" align=\"center\" class=\"switch_sw2 bottom2\" height=\"24\">
-    <font class=\"admin_note\">".ADMIN_NO_ADDIONAL_SQLS."</font>
-  </td>
-</tr>\n";
-       }
+               // Prepare content for template
+               $content = array(
+                       'width'  => $width,
+                       'dashed' => $dashed,
+                       'title'  => $title,
+                       'out'    => $OUT
+               );
 
-       if (!empty($OUT)) {
-               // Add missing close-table tag
-               $OUT .= "</table>
-</div>\n";
-       }
+               // Load main template
+               $OUT = LOAD_TEMPLATE("admin_ext_sql_table", true, $content);
+       } elseif ((GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
+               // No addional SQL commands to run
+               $OUT = LOAD_TEMPLATE("admin_settings_saved", true, ADMIN_NO_ADDITIONAL_SQLS);
+       } // END - if
 
        // Return output
        return $OUT;
@@ -577,7 +553,7 @@ function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = ADMIN_SQLS_EXECUT
 
 // Get extension name from id
 function GET_EXT_NAME ($ext_id) {
-       global $cacheArray, $_CONFIG;
+       global $cacheArray;
 
        // Init extension name
        $ret = "";
@@ -588,7 +564,7 @@ function GET_EXT_NAME ($ext_id) {
                $ret = $cacheArray['extensions']['ext_name'][$ext_id];
 
                // Count cache hits
-               if (getConfig('cache_hits') > 0) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
+               incrementConfigEntry('cache_hits');
        } elseif (!EXT_IS_ACTIVE("cache")) {
                // Load from database
                $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
@@ -601,7 +577,7 @@ function GET_EXT_NAME ($ext_id) {
 
 // Get extension id from name
 function GET_EXT_ID ($ext_name) {
-       global $cacheArray, $_CONFIG;
+       global $cacheArray;
 
        // Init ID number
        $ret = 0;
@@ -610,7 +586,7 @@ function GET_EXT_ID ($ext_name) {
                $ret = $cacheArray['extensions']['ext_id'][$ext_name];
 
                // Count cache hits
-               if (getConfig('cache_hits') > 0) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
+               incrementConfigEntry('cache_hits');
        } elseif (!EXT_IS_ACTIVE("cache")) {
                // Load from database
                $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
@@ -626,7 +602,7 @@ function GET_EXT_ID ($ext_name) {
 // Activate given extension
 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",
+       SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_active='Y' WHERE ext_name='%s' LIMIT 1",
                array($ext_name), __FILE__, __LINE__);
 
        // Extension has been activated?
@@ -639,7 +615,7 @@ function ACTIVATE_EXTENSION ($ext_name) {
 // 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",
+       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?
@@ -705,7 +681,7 @@ function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) {
                }
 
                // 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)
+               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,
@@ -724,7 +700,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
-               $result_insert = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_task_system (assigned_admin, userid, status, task_type, subject, text, task_created)
+               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,
@@ -732,14 +708,11 @@ VALUES (0,0,'NEW','EXTENSION_DEACTIVATION','%s','%s',UNIX_TIMESTAMP())",
                        ),  __FILE__, __LINE__, true, false
                );
        } // END - if
-
-       // Free memory
-       SQL_FREERESULT($result);
 }
 
 // Checks if the module has a menu
 function MODULE_HAS_MENU ($mod, $forceDb = false) {
-       global $cacheArray, $_CONFIG;
+       global $cacheArray;
 
        // All is false by default
        $ret = false;
@@ -749,11 +722,11 @@ function MODULE_HAS_MENU ($mod, $forceDb = false) {
                if (isset($cacheArray['modules']['has_menu'][$mod])) {
                        // Check module cache and count hit
                        $ret = ($cacheArray['modules']['has_menu'][$mod] == "Y");
-                       if (getConfig('cache_hits') > 0) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
+                       incrementConfigEntry('cache_hits');
                } elseif (isset($cacheArray['extensions']['ext_menu'][$mod])) {
                        // Check cache and count hit
                        $ret = ($cacheArray['extensions']['ext_menu'][$mod] == "Y");
-                       if (getConfig('cache_hits') > 0) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
+                       incrementConfigEntry('cache_hits');
                } elseif ((IS_ADMIN()) && ($mod == "admin")) {
                        // Admin module has always a menu!
                        $ret = true;
@@ -831,5 +804,43 @@ function DETERMINE_TASK_ID_BY_SUBJECT ($subject) {
        return $task_id;
 }
 
+// Add updates notes for given version
+function ADD_EXTENSION_NOTES ($ver, &$UPDATE_NOTES) {
+       // Init notes/content
+       $out = ""; $content = array();
+
+       // Is do we have verbose output enabled?
+       if ((getConfig('verbose_sql') == "Y") || (!EXT_IS_ACTIVE("sql_patches"))) {
+
+               // Update notes found?
+               if (!empty($UPDATE_NOTES)) {
+                       // Update notes found
+                       $content = array(
+                               'ver'   => $ver,
+                               'notes' => $UPDATE_NOTES
+                       );
+                       $UPDATE_NOTES = "";
+               } elseif (($ver == "0.0") || ($ver == "0.0.0")) {
+                       // Initial release
+                       $content = array(
+                               'ver'   => $ver,
+                               'notes' => INITIAL_RELEASE
+                       );
+               } else {
+                       // No update notes found!
+                       $content = array(
+                               'ver'   => $ver,
+                               'notes' => NO_UPDATE_NOTES
+                       );
+               }
+
+               // Load template
+               $out = LOAD_TEMPLATE("admin_ext_notes", true, $content);
+       } // END - if
+
+       // Return the output
+       return $out;
+}
+
 //
 ?>