Some double-quotes to single rewritten
[mailer.git] / inc / filters.php
index 098a2157f952ce2a53cd8b7a794d0a6c616f4012..db886a0d651df3c432abe16812a198e50baef5c9 100644 (file)
@@ -43,22 +43,18 @@ if (!defined('__SECURITY')) {
 }
 
 // Init "generic filter system"
-function INIT_FILTER_SYSTEM () {
+function initFilterSystem () {
        // Is the filter already initialized?
        if ((isset($GLOBALS['filters']['chains'])) && (is_array($GLOBALS['filters']['chains']))) {
                // Then abort here
-               addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_INIT'));
-               return false;
+               debug_report_bug(getMessage('FILTER_FAILED_ALREADY_INIT'));
        } // END - if
 
        // Init the filter system (just some ideas)
        $GLOBALS['filters']['chains'] = array(
-               // Filters for pre-init phase
-               'preinit'   => array(),
-               // Filters for post-init phase
-               'postinit'  => array(),
-               // Filters for shutdown phase
-               'shutdown'  => array()
+               'preinit'   => array(), // Filters for pre-init phase
+               'postinit'  => array(), // Filters for post-init phase
+               'shutdown'  => array()  // Filters for shutdown phase
        );
 
        // Init loaded filters and counter
@@ -66,7 +62,26 @@ function INIT_FILTER_SYSTEM () {
        $GLOBALS['filters']['counter'] = array();
 
        // Load all saved filers if sql_patches is updated
-       if (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
+       if (isset($GLOBALS['cache_array']['filter']['filter_name'])) {
+               // Found in cache so rewrite the array
+               $filterArray = array();
+               foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
+                       // Get filter function
+                       $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
+
+                       // Add the element with mapped index
+                       $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
+                       $filterArray['loaded'][$filterName][$filterFunction]  = true;
+                       $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
+               } // END - foreach
+
+               // Set the array
+               //die('<pre>'.print_r($filterArray, true).'</pre>');
+               $GLOBALS['filters'] = $filterArray;
+
+               // Remove the cache
+               unset($GLOBALS['cache_array']['filter']);
+       } elseif (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
                // Init add
                $add = '';
                if (GET_EXT_VERSION('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
@@ -100,52 +115,53 @@ ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
                                } // END - if
                        } // END - while
                } // END - if
-       
+
                // Free result
                SQL_FREERESULT($result);
-       } // END - if
+       }
 
        // Init filters
-       REGISTER_FILTER('init', 'UPDATE_LOGIN_DATA');
-       REGISTER_FILTER('init', 'INIT_RANDOMIZER');
+       registerFilter('init', 'UPDATE_LOGIN_DATA');
+       registerFilter('init', 'INIT_RANDOMIZER');
+       registerFilter('init', 'DETERMINE_USERNAME');
 
        // Login failures handler
-       REGISTER_FILTER('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
+       registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 
        // Filters for pre-extension-registration
-       REGISTER_FILTER('pre_extension_installed', 'RUN_SQLS');
+       registerFilter('pre_extension_installed', 'RUN_SQLS');
 
        // Filters for post-extension-registration
-       REGISTER_FILTER('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
-       REGISTER_FILTER('post_extension_installed', 'SOLVE_TASK');
-       REGISTER_FILTER('post_extension_installed', 'loadIncludeLUDES');
-       REGISTER_FILTER('post_extension_installed', 'REMOVE_UPDATES');
+       registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
+       registerFilter('post_extension_installed', 'SOLVE_TASK');
+       registerFilter('post_extension_installed', 'LOAD_INCLUDES');
+       registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 
        // Solving tasks
-       REGISTER_FILTER('solve_task', 'SOLVE_TASK');
+       registerFilter('solve_task', 'SOLVE_TASK');
 
        // Loading includes in general
-       REGISTER_FILTER('load_includes', 'loadIncludeLUDES');
+       registerFilter('load_includes', 'LOAD_INCLUDES');
 
        // Run SQLs
-       REGISTER_FILTER('run_sqls', 'RUN_SQLS');
+       registerFilter('run_sqls', 'RUN_SQLS');
 
        // Admin ACL check
-       REGISTER_FILTER('check_admin_acl', 'CHECK_ADMIN_ACL');
+       registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 
        // Register shutdown filters
-       REGISTER_FILTER('shutdown', 'FLUSH_FILTERS');
+       registerFilter('shutdown', 'FLUSH_FILTERS');
 }
 
 // "Registers" a new filter function
-function REGISTER_FILTER ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
+function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
        // Extend the filter function name
        $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 
        // Is that filter already there?
        if ((isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
                // Then abort here
-               if (!$silentAbort) {
+               if ($silentAbort === false) {
                        addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
                } // END - if
 
@@ -169,7 +185,7 @@ function REGISTER_FILTER ($filterName, $filterFunction, $silentAbort = true, $fo
 }
 
 // "Unregisters" a filter from the given chain
-function UNREGISTER_FILTER ($filterName, $filterFunction, $force = false, $dry_run = false) {
+function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
        // Extend the filter function name only if not loaded from database
        if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
                $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
@@ -183,22 +199,18 @@ function UNREGISTER_FILTER ($filterName, $filterFunction, $force = false, $dry_r
        } // END - if
 
        // Shall we remove? (default, not while just showing an extension removal)
-       if (!$dry_run) {
+       if ($dry_run === false) {
                // Mark for filter removal
-               $GLOBALS['filters']['chains'][$filterName][$filterFunction] = "R";
-               unset($GLOBALS['filters']['counter'][$filterName][$filterFunction]);
+               $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'R';
        } // END  - if
 }
 
 // "Runs" the given filters, data is optional and can be any type of data
-function runFilterChain ($filterName, $data = null, $silentAbort = true) {
+function runFilterChain ($filterName, $data = null) {
        // Is that filter chain there?
        if (!isset($GLOBALS['filters']['chains'][$filterName])) {
-               // Then abort here (quick'N'dirty hack)
-               if ((!$silentAbort) && (defined('FILTER_FAILED_NO_FILTER_FOUND'))) {
-                       // Add fatal message
-                       addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NO_FILTER_FOUND'), $filterName);
-               } // END - if
+               // We should find all these non-existing filter chains
+               DEBUG_LOG(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
 
                // Abort here
                return false;
@@ -208,16 +220,16 @@ function runFilterChain ($filterName, $data = null, $silentAbort = true) {
        $returnValue = $data;
 
        // Then run all filters
-       foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction=>$active) {
+       foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction => $active) {
                // Debug message
-               //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): name={$filterName},func={$filterFunction},active={$active}<br />\n";
+               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
 
                // Is the filter active?
-               if ($active == 'Y') {
+               if (($active == 'Y') || ((in_array($filterName, array('extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
                        // Is this filter there?
                        if (!function_exists($filterFunction)) {
                                // Unregister it
-                               UNREGISTER_FILTER($filterName, $filterFunction);
+                               unregisterFilter($filterName, $filterFunction);
 
                                // Skip this entry
                                continue;
@@ -227,14 +239,29 @@ function runFilterChain ($filterName, $data = null, $silentAbort = true) {
                        $returnValue = call_user_func_array($filterFunction, array($returnValue));
 
                        // Update usage counter
-                       $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
-               } // END - if
+                       countFilterUsage($filterName, $filterFunction);
+               } elseif (isDebugModeEnabled()) {
+                       // Debug message
+                       DEBUG_LOG(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
+               }
        } // END - foreach
 
        // Return the filtered content
        return $returnValue;
 }
 
+// Count the filter usage
+function countFilterUsage ($filterName, $filterFunction) {
+       // Is it there?
+       if (isset($GLOBALS['filters']['counter'][$filterName][$filterFunction])) {
+               // Yes, then increase
+               $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
+       } else {
+               // No, then create
+               $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 1;
+       }
+}
+
 // -----------------------------------------------------------------------------
 // Generic filter functions we always need
 // -----------------------------------------------------------------------------
@@ -264,7 +291,8 @@ function FILTER_FLUSH_FILTERS () {
        } // END - if
 
        // Nothing is added/remove by default
-       $inserted = 0; $removed = 0;
+       $inserted = 0;
+       $removed = 0;
 
        // Prepare SQL queries
        $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
@@ -279,7 +307,7 @@ function FILTER_FLUSH_FILTERS () {
                                // Add this filter (all filters are active by default)
                                $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
                                $inserted++;
-                       } elseif ($active == "R") {
+                       } elseif ($active == 'R') {
                                // Remove this filter
                                $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
                                $removed++;
@@ -299,7 +327,7 @@ function FILTER_FLUSH_FILTERS () {
        // Something has been removed?
        if ($removed > 0) {
                // Finish SQL command
-               $removeSQL = substr($removeSQL, 0, -2) . "LIMIT ".$removed;
+               $removeSQL = substr($removeSQL, 0, -2) . 'LIMIT '.$removed;
 
                // And run it
                ADD_SQL($removeSQL);
@@ -331,8 +359,8 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
        $content = $data;
 
        // Handle failed logins here if not in guest
-       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={$GLOBALS['action']},what={$GLOBALS['what']},lvl={$data['access_level']}<br />\n";
-       if ((($data['type'] == "what") || ($data['type'] == "action") && ((!isset($GLOBALS['what'])) || ($GLOBALS['what'] == "overview") || ($GLOBALS['what'] == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((GET_EXT_VERSION('sql_patches') >= '0.4.7') || (GET_EXT_VERSION('admins') >= '0.7.0'))) {
+       //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={getAction()},what={getWhat()},lvl={$data['access_level']}<br />");
+       if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((GET_EXT_VERSION('sql_patches') >= '0.4.7') || (GET_EXT_VERSION('admins') >= '0.7.0'))) {
                // Handle failure
                $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
        } // END - if
@@ -344,7 +372,7 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
 // Filter for redirecting to logout if sql_patches has been installed
 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
        // Remove this filter
-       UNREGISTER_FILTER('shutdown', __FUNCTION__);
+       unregisterFilter('shutdown', __FUNCTION__);
 
        // Is the element set?
        if (isset($GLOBALS['ext_load_mode'])) {
@@ -361,7 +389,7 @@ function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
        // Is this extension always activated?
        if (EXT_GET_ALWAYS_ACTIVE() == 'Y') {
                // Then activate the extension
-               //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
+               //* DEBUG: */ OUTPUT_HTML(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />");
                ACTIVATE_EXTENSION($data['ext_name']);
        } // END - if
 
@@ -388,7 +416,7 @@ function FILTER_SOLVE_TASK ($data) {
 }
 
 // Filter to load include files
-function FILTER_loadIncludeLUDES () {
+function FILTER_LOAD_INCLUDES () {
        // Default is $data as inclusion list
        $data = GET_INC_POOL();
 
@@ -419,12 +447,12 @@ function FILTER_loadIncludeLUDES () {
 // Filter for running SQL commands
 function FILTER_RUN_SQLS ($data) {
        // Debug message
-       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Entered!");
+       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "- Entered!");
 
        // Is the array there?
        if ((IS_SQLS_VALID()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
                // Run SQL commands
-               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Found ".COUNT_SQLS()." queries to run.");
+               //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "- Found ".COUNT_SQLS()." queries to run.");
                foreach (GET_SQLS() as $sql) {
                        // Trim spaces away
                        $sql = trim($sql);
@@ -446,7 +474,7 @@ function FILTER_RUN_SQLS ($data) {
        } // END - if
 
        // Debug message
-       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
+       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "- Left!");
 }
 
 // Filter for updating/validating login data
@@ -461,32 +489,36 @@ function FILTER_UPDATE_LOGIN_DATA () {
        setUserId(getSession('userid'));
 
        // Load last module and last online time
-       $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
+       $result = SQL_QUERY_ESC("SELECT `last_module`, `last_online` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
                array(getUserId()), __FUNCTION__, __LINE__);
 
        // Entry found?
        if (SQL_NUMROWS($result) == 1) {
                // Load last module and online time
-               list($mod, $onl) = SQL_FETCHROW($result);
+               $DATA = SQL_FETCHARRAY($result);
 
                // Maybe first login time?
-               if (empty($mod)) $mod = "login";
+               if (empty($DATA['last_module'])) $DATA['last_module'] = 'login';
 
                // This will be displayed on welcome page! :-)
                if (empty($GLOBALS['last']['module'])) {
-                       $GLOBALS['last']['module'] = $mod; $GLOBALS['last']['online'] = $onl;
+                       $GLOBALS['last']['module'] = $DATA['last_module']; $GLOBALS['last']['online'] = $DATA['last_online'];
                } // END - if
 
-               // "what" not set?
-               if (empty($GLOBALS['what'])) {
+               // 'what' not set?
+               if (!isWhatSet()) {
                        // Fix it to default
-                       $GLOBALS['what'] = "welcome";
-                       if (getConfig('index_home') != '') $GLOBALS['what'] = getConfig('index_home');
+                       setWhat('welcome');
+                       if (getConfig('index_home') != '') setWhatFromConfig('index_home');
                } // END - if
 
                // Update last module / online time
-               SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
-                       array($GLOBALS['what'], detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
+               SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', `last_online`=UNIX_TIMESTAMP(), `REMOTE_ADDR`='%s' WHERE `userid`=%s LIMIT 1",
+                       array(
+                               getWhat(),
+                               detectRemoteAddr(),
+                               getUserId()
+                       ), __FUNCTION__, __LINE__);
        }  else {
                // Destroy session, we cannot update!
                destroyUserSession();
@@ -502,16 +534,16 @@ function FILTER_CHECK_ADMIN_ACL () {
        $ret = true;
 
        // Ok, Cookie-Update done
-       if (GET_EXT_VERSION('admins') >= '0.3.0') {
+       if ((GET_EXT_VERSION('admins') >= '0.3.0') && (EXT_IS_ACTIVE('admins'))) {
                // Check if action GET variable was set
-               $action = SQL_ESCAPE($GLOBALS['action']);
-               if (!empty($GLOBALS['what'])) {
+               $action = getAction();
+               if (isWhatSet()) {
                        // Get action value by what-value
-                       $action = getModeAction('admin', $GLOBALS['what']);
+                       $action = getModeAction('admin', getWhat());
                } // END - if
 
                // Check for access control line of current menu entry
-               $ret = adminsCheckAdminAcl($action, $GLOBALS['what']);
+               $ret = adminsCheckAdminAcl($action, getWhat());
        } // END - if
 
        // Return result
@@ -548,5 +580,46 @@ function FILTER_REMOVE_UPDATES () {
        } // END - if
 }
 
+// Determines username for current user state
+function FILTER_DETERMINE_USERNAME () {
+       global $username;
+
+       // Check if logged in
+       if (IS_MEMBER()) {
+               // Is still logged in so we welcome him with his name
+               $result = SQL_QUERY_ESC("SELECT `surname`, `family` FROM `{!_MYSQL_PREFIX!}_user_data` WHERE `userid`=%s LIMIT 1",
+                       array(getUserId()), __FILE__, __LINE__);
+               if (SQL_NUMROWS($result) == 1) {
+                       // Load surname and family's name and build the username
+                       list($s, $f) = SQL_FETCHROW($result);
+                       $username = $s . ' ' . $f;
+
+                       // Additionally admin?
+                       if (IS_ADMIN()) {
+                               // Add it
+                               $username .= ' ({--_ADMIN_SHORT--})';
+                       } // END - if
+               } else {
+                       // Hmmm, logged in and no valid userid?
+                       $username = '<em>{--_UNKNOWN--}</em>';
+
+                       // Destroy session
+                       destroyUserSession();
+
+                       // Kill userid
+                       setUserId(0);
+               }
+
+               // Free memory
+               SQL_FREERESULT($result);
+       } elseif (IS_ADMIN()) {
+               // Admin is there
+               $username = getMessage('_ADMIN');
+       } else {
+               // He's a guest, hello there... ;-)
+               $username = getMessage('_GUEST');
+       }
+}
+
 //
 ?>