Login procedure rewritten to filters (internal TODO)
[mailer.git] / inc / filters.php
index 174dad1ad888c2abbceeb43db94aca371a59eda7..7b6891497d0beeb3d1f3849adcc8b5417f3b9f25 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 12/16/2008 *
- * ===============                              Last change: 12/16/2008 *
+ * Mailer v0.2.1-FINAL                                Start: 12/16/2008 *
+ * ===================                          Last change: 12/16/2008 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : filters.php                                      *
@@ -66,8 +66,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";
@@ -282,24 +282,21 @@ function FILTER_UPDATE_LOGIN_DATA () {
        // Recheck if logged in
        if (!isMember()) return false;
 
-       // Secure user ID
-       setUserId(getSession('userid'));
+       // Secure user id
+       setMemberId(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",
-               array(getUserId()), __FUNCTION__, __LINE__);
-
-       // Entry found?
-       if (SQL_NUMROWS($result) == 1) {
+       // Found a userid?
+       if (fetchUserData(getMemberId())) {
                // Load last module and online time
-               $content = SQL_FETCHARRAY($result);
+               $content = getUserDataArray();
 
                // Maybe first login time?
                if (empty($content['last_module'])) $content['last_module'] = 'login';
 
                // This will be displayed on welcome page! :-)
                if (empty($GLOBALS['last_online']['module'])) {
-                       $GLOBALS['last_online']['module'] = $content['last_module']; $GLOBALS['last_online']['online'] = $content['last_online'];
+                       $GLOBALS['last_online']['module'] = $content['last_module'];
+                       $GLOBALS['last_online']['online'] = $content['last_online'];
                } // END - if
 
                // 'what' not set?
@@ -310,19 +307,11 @@ function FILTER_UPDATE_LOGIN_DATA () {
                } // 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(
-                               getWhat(),
-                               detectRemoteAddr(),
-                               getUserId()
-                       ), __FUNCTION__, __LINE__);
+               updateLastActivity(getMemberId());
        }  else {
                // Destroy session, we cannot update!
-               destroyUserSession();
+               destroyMemberSession();
        }
-
-       // Free the result
-       SQL_FREERESULT($result);
 }
 
 // Filter for initializing randomizer
@@ -354,7 +343,7 @@ function FILTER_REMOVE_UPDATES ($data) {
        // Do we need to remove update depency?
        if (countExtensionUpdateDependencies() > 0) {
                // Then find all updates we shall no longer execute
-               foreach (getExtensionUpdateDependencies() as $id=>$ext_name) {
+               foreach (getExtensionUpdateDependencies() as $id => $ext_name) {
                        // Shall we remove this update?
                        if (in_array($ext_name, getExtensionRemovalList())) {
                                // Then remove this extension!
@@ -372,11 +361,9 @@ function FILTER_DETERMINE_USERNAME () {
        // Check if logged in
        if (isMember()) {
                // 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) {
+               if (fetchUserData(getMemberId())) {
                        // Load surname and family's name and build the username
-                       $content = SQL_FETCHARRAY($result);
+                       $content = getUserDataArray();
 
                        // Prepare username
                        setUsername($content['surname'] . ' ' . $content['family']);
@@ -391,14 +378,8 @@ function FILTER_DETERMINE_USERNAME () {
                        setUsername('<em>{--USERNAME_UNKNOWN--}</em>');
 
                        // Destroy session
-                       destroyUserSession();
-
-                       // Kill userid
-                       setUserId(0);
+                       destroyMemberSession();
                }
-
-               // Free memory
-               SQL_FREERESULT($result);
        } elseif (isAdmin()) {
                // Admin is there
                setUsername('{--USERNAME_ADMIN--}');
@@ -409,40 +390,57 @@ function FILTER_DETERMINE_USERNAME () {
 }
 
 // Filter for compiling config entries
-function FILTER_COMPILE_CONFIG ($code) {
-       // Compile {?some_var?} to getConfig('some_var')
-       preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
+function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
+       // Save the uncompiled code
+       $uncompiled = $code;
+
+       // Do we have cache?
+       if (!isset($GLOBALS['compiled_config'][$code])) {
+               // Compile {?some_var?} to getConfig('some_var')
+               preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
+
+               // Some entries found?
+               if ((count($matches) > 0) && (count($matches[0]) > 0)) {
+                       // Replace all matches
+                       foreach ($matches[0] as $key => $match) {
+                               // Do we have cache?
+                               if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
+                                       // Is the config valid?
+                                       if (isConfigEntrySet($matches[1][$key])) {
+                                               // Set it for caching
+                                               $GLOBALS['compile_config'][$matches[1][$key]] = "\".getConfig('" . $matches[1][$key] . "').\"";
+                                       } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
+                                               // Use default value
+                                               $GLOBALS['compile_config'][$matches[1][$key]] = "\".getConfig('" . 'DEFAULT_' . strtoupper($matches[1][$key]) . "').\"";
+                                       } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
+                                               // No config, try the language system
+                                               $GLOBALS['compile_config'][$matches[1][$key]] = "\".getMessage('". 'DEFAULT_' . strtoupper($matches[1][$key]) . "').\"";
+                                       } else {
+                                               // Unhandled!
+                                               $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
+                                       }
+                               } // END - if
 
-       // Some entries found?
-       if ((count($matches) > 0) && (count($matches[0]) > 0)) {
-               // Replace all matches
-               foreach ($matches[0] as $key => $match) {
-                       // Do we have cache?
-                       if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
-                               // Is the config valid?
-                               if (isConfigEntrySet($matches[1][$key])) {
-                                       // Set it for caching
-                                       $GLOBALS['compile_config'][$matches[1][$key]] = getConfig($matches[1][$key]);
-                               } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
-                                       // Use default value
-                                       $GLOBALS['compile_config'][$matches[1][$key]] = getConfig('DEFAULT_' . strtoupper($matches[1][$key]));
-                               } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
-                                       // No config, try the language system
-                                       $GLOBALS['compile_config'][$matches[1][$key]] = getMessage('DEFAULT_' . strtoupper($matches[1][$key]));
-                               } else {
-                                       // Unhandled!
-                                       $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
-                               }
-                       } // END - if
+                               // Use this for replacing
+                               $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
+                               //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die('<pre>'.secureString($code).'</pre>');
+                       } // END - foreach
+               } // END - if
 
-                       // Use this for replacing
-                       $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
-                       //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die('<pre>'.htmlentities($code).'</pre>');
-               } // END - foreach
+               // Add it to cache
+               $GLOBALS['compiled_config'][$uncompiled] = $code;
+       } // END - if
+
+       // Should we compile it?
+       if ($compiled === true) {
+               // Run the code
+               $eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . "\";";
+               //* DEBUG: */ print '<pre>' . str_replace('$', '&#36;', htmlentities($eval)) . '</pre>';
+               eval($eval);
        } // END - if
 
        // Return compiled code
-       return $code;
+       return $GLOBALS['compiled_config'][$uncompiled];
 }
 
 // Filter for compiling extension data
@@ -456,18 +454,28 @@ function FILTER_COMPILE_EXTENSION ($code) {
        if ((count($matches) > 0) && (count($matches[3]) > 0)) {
                // Replace all matches
                foreach ($matches[3] as $key => $cmd) {
-                       // Construct call-back function name
-                       $functionName = 'getExtension' . ucfirst(strtolower($cmd));
-
-                       // Call the function
-                       $replacer = call_user_func_array($functionName, $matches[4][$key]);
+                       // Init replacer variable
+                       $replacer = '';
+
+                       // Is the extension installed or code provided?
+                       if ($cmd == 'code') {
+                               // Code asked for
+                               $replacer = "\".getCode(\"" . $matches[4][$key] . "\").\"";
+                       } else {
+                               // Construct call-back function name
+                               $functionName = 'getExtension' . ucfirst(strtolower($cmd));
+
+                               // Construct call of the function
+                               $replacer = "\".call_user_func_array('" . $functionName . "', array('" . $matches[4][$key] . "', true)).\"";
+                       }
 
                        // Replace it and insert parameter for GET request
-                       $code = str_replace($matches[0][$key], sprintf("&amp;%s=%s&amp;rev=%s", $cmd, $replacer, getConfig('CURR_SVN_REVISION')), $code);
+                       $code = str_replace($matches[0][$key], sprintf("&amp;%s=%s&amp;rev=\".getConfig('CURR_SVN_REVISION').\"", $cmd, $replacer), $code);
                } // END - foreach
        } // END - if
 
        // Return compiled code
+       //* DEBUG: */ die('<pre>'.secureString($code).'</pre>');
        return $code;
 }
 
@@ -488,7 +496,7 @@ function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
 // Load more reset scripts
 function FILTER_RUN_RESET_INCLUDES () {
        // Is the reset set or old sql_patches?
-       if (((!isResetModeEnabled()) || (!isExtensionInstalledAndOlder('sql_patches', '0.4.5'))) && (getOutputMode() == 0)) {
+       if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (getOutputMode() == '0')) {
                // Then abort here
                logDebugMessage(__FUNCTION__, __LINE__, 'Cannot run reset! Please report this bug. Thanks');
        } // END - if
@@ -497,7 +505,7 @@ function FILTER_RUN_RESET_INCLUDES () {
        setIncludePool('reset', getArrayFromDirectory('inc/reset/', 'reset_'));
 
        // Update database
-       if ((!isConfigEntrySet('DEBUG_RESET')) || (getConfig('DEBUG_RESET') != 'Y')) updateConfiguration('last_update', time());
+       if ((!isConfigEntrySet('DEBUG_RESET')) || (getConfig('DEBUG_RESET') != 'Y')) updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
 
        // Is the config entry set?
        if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
@@ -510,7 +518,7 @@ function FILTER_RUN_RESET_INCLUDES () {
                        mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
 
                        // Update config
-                       if (getConfig('DEBUG_WEEKLY') != 'Y') updateConfiguration('last_week', $currWeek);
+                       if ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') != 'Y')) updateConfiguration('last_week', $currWeek);
                } // END - if
 
                // Create current month mark
@@ -522,7 +530,7 @@ function FILTER_RUN_RESET_INCLUDES () {
                        mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
 
                        // Update config
-                       if (getConfig('DEBUG_MONTHLY') != 'Y') updateConfiguration('last_month', $currMonth);
+                       if ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
                } // END - if
        } // END - if
 
@@ -580,7 +588,19 @@ function FILTER_DETERMINE_WHAT_ACTION () {
        // Get all values
        if ((getOutputMode() != 1) && (getOutputMode() != -1)) {
                // Fix module
-               if (!isModuleSet()) setModule('index');
+               if (!isModuleSet()) {
+                       // Is the request element set?
+                       if (isGetRequestElementSet('module')) {
+                               // Set module from request
+                               setModule(getRequestElement('module'));
+                       } elseif (getOutputMode() == '0') {
+                               // Set default module 'index'
+                               setModule('index');
+                       } else {
+                               // Unknown module
+                               setModule('unknown');
+                       }
+               } // END - if
 
                // Fix 'what' if not yet set
                if (!isWhatSet())   setWhat(getWhatFromModule(getModule()));
@@ -617,7 +637,7 @@ function FILTER_TRIGGER_SENDING_POOL () {
        } // END - if
 
        // Init counter
-       $GLOBALS['pool_cnt'] = 0;
+       $GLOBALS['pool_cnt'] = '0';
 
        // Init & set the include pool
        initIncludePool('pool');
@@ -699,9 +719,9 @@ function FILTER_CHECK_ADMIN_ACL () {
 // Init random number/cache buster
 function FILTER_INIT_RANDOM_NUMBER () {
        // Is the extension sql_patches installed and at least 0.3.6?
-       if ((isExtensionActive('sql_patches')) && (getExtensionVersion('sql_patches') >= '0.3.6')) {
+       if ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
                // Generate random number
-               setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 32766), getUserId(), ''));
+               setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 32766), getMemberId(), ''));
        } else {
                // Generate weak (!!!) code
                setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
@@ -721,7 +741,7 @@ function FILTER_COUNT_MODULE () {
 // Handles fatal errors
 function FILTER_HANDLE_FATAL_ERRORS () {
        // Do we have errors to handle and right output mode?
-       if ((getTotalFatalErrors() == 0) || (getOutputMode() != 0)) {
+       if ((getTotalFatalErrors() == '0') || (getOutputMode() != 0)) {
                // Abort executing here
                return false;
        } // END - if
@@ -822,11 +842,68 @@ function FILTER_DISPLAY_COPYRIGHT () {
 function FILTER_DISPLAY_PARSING_TIME () {
        // Shall we display the parsing time and number of queries?
        // 1234                            5                      54    4         5              5       4    4                       5       543    3                   4432    2             33     2    2                              21
-       if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestElementSet('frame'))) || (isInstallationPhase())) && (getOutputMode() == 0) && ($GLOBALS['header_sent'] == 2)) {
+       if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestElementSet('frame'))) || (isInstallationPhase())) && (getOutputMode() == '0') && ($GLOBALS['header_sent'] == 2)) {
                // Then display it here
                displayParsingTime();
        } // END - if
 }
 
+// Filter for flushing template cache
+function FILTER_FLUSH_TEMPLATE_CACHE () {
+       // Do not flush when debugging the template cache
+       if (isDebuggingTemplateCache()) return;
+
+       // Do we have cached eval() data?
+       if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
+               // Now flush all
+               foreach ($GLOBALS['template_eval'] as $template => $eval) {
+                       // Flush the cache (if not yet found)
+                       flushTemplateCache($template, $eval);
+               } // END - if
+       } // END - if
+}
+
+// Filter for loading user data
+function FILTER_FETCH_USER_DATA ($userid = 0) {
+       // Is the userid not set? Then use member id
+       if (($userid == '0') || (is_null($userid))) $userid = getMemberId();
+
+       // Get user data
+       if (!fetchUserData($userid)) {
+               // Userid is not valid
+               debug_report_bug('User id '.$userid . ' is invalid.');
+       } // END - if
+
+       // Set member id
+       setMemberId($userid);
+}
+
+// Filter for reseting users' last login failure, only available with latest ext-sql_patches
+function FILTER_RESET_USER_LOGIN_FAILURE () {
+       // Is the user data valid?
+       if (!isMember()) {
+               // Do only run for logged in members
+               debug_report_bug('Please only run this filter for logged in users.');
+       } // END - if
+
+       // Remmeber login failures if available
+       if (isExtensionInstalledAndNewer('sql_patches') >= '0.6.1') {
+               // Reset login failures
+               SQL_QUERY_ESC("UPDATE
+       `{?_MYSQL_PREFIX?}_user_data`
+SET
+       `login_failures`=0,
+       `last_failure`='0000-00-00 00:00:00'
+WHERE
+       `userid`=%s
+LIMIT 1",
+                       array(getMemberId()), __FILE__, __LINE__);
+
+               // Store it in session
+               setSession('mxchange_member_failures' , getUserData('login_failures'));
+               setSession('mxchange_member_last_fail', getUserData('last_failure'));
+       } // END - if
+}
+
 // [EOF]
 ?>