Surfbar now has start/stop button
[mailer.git] / inc / extensions.php
index abad4d77ae24e30a68f3b0ad22cfe66616d0ced0..50820f59487c26cde3fe1cd6b96fba6b129bcdbe 100644 (file)
  ************************************************************************/
 
 // Some security stuff...
-if (ereg(basename(__FILE__), $_SERVER['PHP_SELF']))
-{
+if (!defined('__SECURITY')) {
        $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
        require($INC);
 }
+
 //
 function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
 {
@@ -55,7 +55,7 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
        $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
 
        // Does this extension exists?
-       if (file_exists($file) && is_readable($file))
+       if (FILE_READABLE($file))
        {
                // Extension was found so we can load it in registration mode
                require($file);
@@ -98,7 +98,7 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                        $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $EXT_UPDATE_DEPENDS);
 
                        // Check for required file
-                       if (file_exists($file) && is_readable($file))
+                       if (FILE_READABLE($file))
                        {
                                // File exists so let's load it
                                $VER_BACKUP = $EXT_VERSION;
@@ -165,8 +165,14 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
 
                                        // Is there still an SQL query?
                                        if (!empty($sql)) {
-                                               // Run SQL command
-                                               $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
+                                               // Do we have an "ALTER TABLE" command?
+                                               if (substr(strtolower($sql), 0, 11) == "alter table") {
+                                                       // Analyse the alteration command
+                                                       SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
+                                               } else {
+                                                       // Run regular SQL command
+                                                       $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
+                                               }
                                        } // END - if
                                } // END - foreach
 
@@ -185,18 +191,23 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                                        foreach ($INC_POOL as $inc) {
                                                require_once($inc);
                                        } // END - foreach
-                               }
+                               } // 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__);
 
                                // Update task management
-                               $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_task_system SET status='SOLVED' WHERE id=%d LIMIT 1",
-                                array(bigintval($id)), __FILE__, __LINE__);
+                               ADMIN_SOLVE_TASK($id);
+
+                               // @TODO This causes the whole (!) menu cache being purged
+                               CACHE_PURGE_ADMIN_MENU();
 
                                // In normal mode return a true on success
-                               $ret = true; unset($SQLs);
+                               $ret = true;
+
+                               // Remove SQLs
+                               unset($SQLs);
                        } else {
                                // Rewrite SQL command to keep { and } inside
                                foreach ($SQLs as $key => $sql) {
@@ -216,7 +227,7 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                }
        } elseif (($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=%d AND status='NEW' LIMIT 1",
+               $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%s AND status='NEW' LIMIT 1",
                 array(bigintval($id)), __FILE__, __LINE__);
        }
 
@@ -236,6 +247,9 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
        global $cacheInstance;
        $SQLs = array();
 
+       // By default no SQL has been executed
+       $sqlRan = false;
+
        // This shall never do a non-admin user!
        if (!IS_ADMIN()) return false;
 
@@ -244,9 +258,14 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
        if (empty($ext_name)) return false;
 
        // Load extension in detected mode
+       //* DEBUG: */ echo __FUNCTION__.":ext_name[{$id}]={$ext_name}<br />\n";
        $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
-       if (file_exists($file) && is_readable($file)) require($file);
+       if (FILE_READABLE($file)) {
+               // Load the include
+               require($file);
+       }
 
+       //* DEBUG: */ echo __FUNCTION__.":SQLs::count=".count($SQLs)."<br />\n";
        if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
                // Run SQL commands...
                foreach ($SQLs as $sql) {
@@ -255,25 +274,40 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
 
                        // Is there still an SQL query?
                        if (!empty($sql)) {
-                               // Run SQL command
-                               $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
+                               // Do we have an "ALTER TABLE" command?
+                               //* DEBUG: */ echo __FUNCTION__.":SQL={$SQL}<br />\n";
+                               if (substr(strtolower($sql), 0, 11) == "alter table") {
+                                       // Analyse the alteration command
+                                       SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
+                               } else {
+                                       // Run regular SQL command
+                                       $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
+                               }
+
+                               // An SQL has been executed
+                               $sqlRan = true;
                        } // END - if
                } // END - foreach
 
                // Removal mode?
                if ($EXT_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 id=%d LIMIT 1",
+                       $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
                         array($id), __FILE__, __LINE__);
                } // END - if
 
+               //* DEBUG: */ echo __FUNCTION__.":mode={$EXT_LOAD_MODE}<br />\n";
+
                // Remove cache file(s) if extension is active
-               if ((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) {
+               if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1) && ($EXT_LOAD_MODE == "remove")) || ($sqlRan === true))) {
                        //* DEBUG: */ echo __LINE__.": DESTROY!<br />\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();
+
+                       // @TODO This causes the whole (!) menu cache being purged
+                       CACHE_PURGE_ADMIN_MENU();
                } // END - if
 
                // Is this the sql_patches?
@@ -286,28 +320,25 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
        } // END - if
 }
 // Check if given extension is active
-function EXT_IS_ACTIVE ($ext_name, $ignore_admin = false, $ignore_cache = false) {
+function EXT_IS_ACTIVE ($ext_name) {
        global $cacheArray, $_CONFIG;
 
        // Extensions are all inactive during installation
        if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing')) || (empty($ext_name))) return false;
 
-       // Extension's file name will also be checked
-       $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
-       if ((!file_exists($file)) && (!is_readable($file))) return false;
-       //* DEBUG: */ echo "*".$ext_name."(".count($cacheArray).")<br />";
+       // Not active is the default
+       $active = "N";
 
-       // Failed is the default
-       $ret = false;
-       if ((!empty($cacheArray['extensions']['ext_active'][$ext_name])) && (!$ignore_cache)) {
+       // Check cache
+       if (!empty($cacheArray['extensions']['ext_active'][$ext_name])) {
                // Load from cache
-               //* DEBUG: */ echo "CACHE!<br />\n";
+               //* DEBUG: */ echo "CACHE! ext_name={$ext_name}<br />\n";
                $active = $cacheArray['extensions']['ext_active'][$ext_name];
 
                // Count cache hits
                if (isset($_CONFIG['cache_hits'])) $_CONFIG['cache_hits']++;
-       } else {
-               //* DEBUG: */ echo "DB!<br />\n";
+       } elseif (($ext_name == "cache") || (GET_EXT_VERSION("cache") == "")) {
+               //* DEBUG: */ echo "DB! ext_name={$ext_name}<br />\n";
                // Load from database
                $result = SQL_QUERY_ESC("SELECT ext_active FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
                 array($ext_name), __FILE__, __LINE__);
@@ -316,28 +347,25 @@ function EXT_IS_ACTIVE ($ext_name, $ignore_admin = false, $ignore_cache = false)
                        return false;
                }
                list($active) = SQL_FETCHROW($result);
+               //* DEBUG: */ echo $ext_name."[DB]: {$active}<br />\n";
                SQL_FREERESULT($result);
 
                // Write cache array
                $cacheArray['extensions']['ext_active'][$ext_name] = $active;
+       } else {
+               // Extension not active!
+               //* DEBUG: */ echo $ext_name.": Not active!<br />\n";
+               $cacheArray['extensions']['ext_active'][$ext_name] = "N";
        }
 
-       // Is this extension activated? (For admins we always have active extensions...)
+       // Create FQFN for extension file
        $inc = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
-       // Shorter way
-       return (
-               (
-                       ($active == "Y") || (
-                               (IS_ADMIN()) &&
-                               (!$ignore_admin) &&
-                               (!empty($active))
-                       )
-               ) && (
-                       file_exists($inc)
-               ) && (
-                       is_readable($inc)
-               )
-       );
+
+       // Debug message
+       //DEBUG_LOG(__FUNCTION__.": ext_name={$ext_name},active={$active}");
+
+       // Is this extension activated? (For admins we always have active extensions...)
+       return ($active == "Y");
 }
 // Get version from extensions
 function GET_EXT_VERSION ($ext_name) {
@@ -346,10 +374,12 @@ function GET_EXT_VERSION ($ext_name) {
 
        // Extensions are all inactive during installation
        if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return "";
+       //* DEBUG: */ echo __FUNCTION__.": ext_name={$ext_name}<br />\n";
 
        // Is the cache written?
        if (!empty($cacheArray['extensions']['ext_version'][$ext_name])) {
                // Load data from cache
+               //* DEBUG: */ echo __FUNCTION__.": CACHE!<br />\n";
                $ret = $cacheArray['extensions']['ext_version'][$ext_name];
 
                // Count cache hits
@@ -364,6 +394,9 @@ function GET_EXT_VERSION ($ext_name) {
                // Set cache
                $cacheArray['extensions']['ext_version'][$ext_name] = $ret;
        }
+
+       // Return result
+       //* DEBUG: */ echo __FUNCTION__.": ret={$ret}<br />\n";
        return $ret;
 }
 //
@@ -431,8 +464,14 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
                                        $sql = trim($sql);
                                        if (!empty($sql))
                                        {
-                                               // Run SQL command...
-                                               $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
+                                               // Do we have an "ALTER TABLE" command?
+                                               if (substr(strtolower($sql), 0, 11) == "alter table") {
+                                                       // Analyse the alteration command
+                                                       SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
+                                               } else {
+                                                       // Run regular SQL command
+                                                       $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
+                                               }
                                        }
                                }
                        } elseif (GET_EXT_VERSION("sql_patches") == "") {
@@ -447,49 +486,34 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
                        $ext_subj = "[UPDATE-".$ext."-".$EXT_VERSION.":] ".ADMIN_UPDATE_EXT_SUBJ;
 
                        // Create task
-                       $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE subject='%s' LIMIT 1",
-                        array($ext_subj), __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(GET_ADMIN_ID(SQL_ESCAPE(get_session('admin_login'))), $ext_subj, addslashes($NOTES)), __FILE__, __LINE__);
-                       }
-
-                       // Free memory
-                       SQL_FREERESULT($result);
+                       CREATE_EXTENSION_UPDATE_TASK(GET_ADMIN_ID(get_session('admin_login')), $ext_subj, addslashes($NOTES));
 
                        // 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 (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
 
                        // Remove array
                        unset($SQLs);
-               }
-                else
-               {
+               } 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")
-{
+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")) && ($_CONFIG['verbose_sql'] == "Y"))
-       {
+       if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y")) {
                $OUT  = "<DIV align=\"center\">
 <TABLE border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"".$WIDTH."\" align=\"center\"".$dashed.">
 <TR>
@@ -497,11 +521,9 @@ function EXTENSION_VERBOSE_TABLE($SQLs, $title=ADMIN_SQLS_EXECUTED_ON_REMOVAL, $
     <STRONG>".$title.":</STRONG>
   </TD>
 </TR>\n";
-               foreach ($SQLs as $idx=>$sql)
-               {
+               foreach ($SQLs as $idx => $sql) {
                        $sql = trim($sql);
-                       if (!empty($sql))
-                       {
+                       if (!empty($sql)) {
                                $S = true;
                                $OUT .= "<TR>
   <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 2px\" width=\"30\">".$i.".</TD>
@@ -515,8 +537,7 @@ function EXTENSION_VERBOSE_TABLE($SQLs, $title=ADMIN_SQLS_EXECUTED_ON_REMOVAL, $
                }
        }
 
-       if ((!$S) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y"))
-       {
+       if ((!$S) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y")) {
                // No addional SQL commands to run
                $OUT .= "<TR>
   <TD colspan=\"2\" align=\"center\" class=\"switch_sw2 bottom2\" height=\"24\">
@@ -530,53 +551,61 @@ function EXTENSION_VERBOSE_TABLE($SQLs, $title=ADMIN_SQLS_EXECUTED_ON_REMOVAL, $
                $OUT .= "</TABLE>
 </DIV>\n";
        }
+
+       // Return output
        return $OUT;
 }
-//
-function GET_EXT_NAME($id)
-{
+// Get extension name from id
+function GET_EXT_NAME ($id) {
        $ret = "";
        global $cacheArray, $_CONFIG;
-       if (!empty($cacheArray['extensions']['ext_id'][$id]))
-       {
+       if (!empty($cacheArray['extensions']['ext_name'][$id])) {
                // Load from cache
-               $ret = $cacheArray['extensions']['ext_id'][$id];
+               $ret = $cacheArray['extensions']['ext_name'][$id];
 
                // Count cache hits
                $_CONFIG['cache_hits']++;
-       }
-        else
-       {
+       } elseif (!EXT_IS_ACTIVE("cache")) {
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%d LIMIT 1",
+               $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
                 array(bigintval($id)), __FILE__, __LINE__);
                list($ret) = SQL_FETCHROW($result);
                SQL_FREERESULT($result);
        }
        return $ret;
 }
-//
-function GET_EXT_ID($name)
-{
-       $ret = "0";
+// Get extension id from name
+function GET_EXT_ID($name) {
+       $ret = 0;
        global $cacheArray, $_CONFIG;
-       if ((isset($cacheArray['extensions']['ext_id'])) && (is_array($cacheArray['extensions']['ext_id'])))
-       {
+       if (isset($cacheArray['extensions']['ext_id'][$name])) {
                // Load from cache
-               $ret = array_search($name, $cacheArray['extensions']['ext_id']);
+               $ret = $cacheArray['extensions']['ext_id'][$name];
 
                // Count cache hits
                $_CONFIG['cache_hits']++;
-       }
-        else
-       {
+       } 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__);
                list($ret) = SQL_FETCHROW($result);
                SQL_FREERESULT($result);
        }
+
+       // Return value
        return $ret;
 }
+// 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",
+               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), "activate");
+       } // END - if
+}
 //
 ?>