More fixes for installation and extension registration
[mailer.git] / inc / filters.php
index fab11f202f6bb03bcebe0187de8b31dfba784e04..1019759bdee08d74e290dda0760ec7cbc0122c71 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";
@@ -283,10 +283,10 @@ function FILTER_UPDATE_LOGIN_DATA () {
        if (!isMember()) return false;
 
        // Secure user id
-       setUserId(getSession('userid'));
+       setMemberId(getSession('userid'));
 
        // Found a userid?
-       if (fetchUserData(getUserId())) {
+       if (fetchUserData(getMemberId())) {
                // Load last module and online time
                $content = getUserDataArray();
 
@@ -307,15 +307,10 @@ 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();
        }
 }
 
@@ -348,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!
@@ -366,7 +361,7 @@ function FILTER_DETERMINE_USERNAME () {
        // Check if logged in
        if (isMember()) {
                // Is still logged in so we welcome him with his name
-               if (fetchUserData(getUserId())) {
+               if (fetchUserData(getMemberId())) {
                        // Load surname and family's name and build the username
                        $content = getUserDataArray();
 
@@ -383,10 +378,7 @@ function FILTER_DETERMINE_USERNAME () {
                        setUsername('<em>{--USERNAME_UNKNOWN--}</em>');
 
                        // Destroy session
-                       destroyUserSession();
-
-                       // Kill userid
-                       setUserId(0);
+                       destroyMemberSession();
                }
        } elseif (isAdmin()) {
                // Admin is there
@@ -398,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
@@ -439,30 +448,126 @@ function FILTER_COMPILE_EXTENSION ($code) {
        // Compile {%cmd=some_value%} to get extension data
        // Support cmd is:
        //   - version -> getExtensionVersion() call
-       preg_match_all('/\{%((([a-zA-Z0-9-_]+)=([a-zA-Z0-9-_]+))*)\%\}/', $code, $matches);
+       preg_match_all('/\{%(([a-zA-Z0-9-_,]+)(=([^\}]+)){0,1})*%\}/', $code, $matches);
+       //* DEBUG: */ print('<pre>'.print_r($matches, true).'</pre>');
+
+       // Default is from OUTPUT_HTML
+       $outputMode = getOutputMode();
 
        // Some entries found?
        if ((count($matches) > 0) && (count($matches[3]) > 0)) {
                // Replace all matches
-               foreach ($matches[3] as $key => $cmd) {
-                       // By default we have no extension installed, so 'false' is assumed
-                       $replacer = 'false';
-
-                       // Is the extension installed?
-                       if (isExtensionActive($matches[4][$key])) {
-                               // Construct call-back function name
-                               $functionName = 'getExtension' . ucfirst(strtolower($cmd));
-
-                               // Call the function
-                               $replacer = call_user_func_array($functionName, $matches[4][$key]);
-                       } // END - if
+               foreach ($matches[2] as $key => $cmd) {
+                       // Init replacer/call-back variable
+                       $replacer = '';
+                       $callback = '';
+                       $extraFunction = '';
+
+                       // Extract command and call-back
+                       $cmdArray = explode(',', $cmd);
+                       $cmd = $cmdArray[0];
+                       if (isset($cmdArray[1])) $callback = $cmdArray[1];
+                       if (isset($cmdArray[2])) $extraFunction = $cmdArray[2];
+
+                       // Is the extension installed or code provided?
+                       // @TODO This whole switch-block is very static
+                       switch ($cmd) {
+                               case 'code': // Code asked for
+                                       $code = str_replace($matches[0][$key], "\" . getCode('" . $matches[4][$key] . "') . \"", $code);
+                                       break;
+
+                               case 'url':
+                                       // Do we have JS-mode?
+                                       if (substr($cmd, -2, 2) == 'js') $outputMode = 1;
+
+                                       // Handle an URL here
+                                       $replacer = "\" . encodeUrl(\"" . $matches[4][$key] . "\", " . $outputMode . ") . \"";
+
+                                       // Replace it
+                                       $code = str_replace($matches[0][$key], $replacer, $code);
+                                       break;
+
+                               case 'server':
+                                       // This will make 'foo_bar' to detectFooBar()
+                                       $functionName = "'detect' . implode('', array_map('ucfirst', explode('_', '" . $callback . "')))";
+
+                                       // Replace it
+                                       $code = str_replace($matches[0][$key], "\" . call_user_func(" . $functionName . ") . \"", $code);
+                                       break;
+
+                               case 'user':
+                                       // Use current userid by default
+                                       $functionName = 'getMemberId()';
+
+                                       // User-related data, so is there a userid?
+                                       if (!empty($matches[4][$key])) {
+                                               // Do we have a userid or $userid?
+                                               if ($matches[4][$key] == '$userid') {
+                                                       // Use dynamic call
+                                                       $functionName = "getFetchedUserData('userid', \$userid, '" . $callback . "')";
+                                               } elseif ($matches[4][$key] > 0) {
+                                                       // User data found
+                                                       $functionName = "getFetchedUserData('userid', " . $matches[4][$key] . ", " . $callback . "')";
+                                               } // END - if
+                                       } elseif ((!empty($callback)) && (isUserDataValid())) {
+                                               // "Call-back" alias column for current logged in user's data
+                                               $functionName = "getUserData('" . $callback . "')";
+                                       }
 
-                       // 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);
+                                       // Do we have another function to run (e.g. translations)
+                                       if (!empty($extraFunction)) {
+                                               // Surround the original function call with it
+                                               $functionName = $extraFunction . '(' . $functionName . ')';
+                                       } // END - if
+
+                                       // Now replace the code
+                                       $code = str_replace($matches[0][$key], "\" . " . $functionName . " . \"", $code);
+                                       break;
+
+                               case 'ext':
+                                       // Not installed is default
+                                       $replacer = 'false';
+
+                                       // Is the extension installed?
+                                       if (isExtensionInstalled($matches[4][$key])) {
+                                               // Construct call-back function name
+                                               $functionName = 'getExtension' . ucfirst(strtolower($callback));
+
+                                               // Construct call of the function
+                                               $replacer = "\" . call_user_func_array('" . $functionName . "', array('" . $matches[4][$key] . "', true)) . \"";
+                                       } // END - if
+
+                                       // Replace it and insert parameter for GET request
+                                       $code = str_replace($matches[0][$key], sprintf("&amp;ext=%s&amp;ver=%s&amp;rev=\" . getConfig('CURR_SVN_REVISION') . \"", $matches[4][$key], $replacer), $code);
+                                       break;
+
+                               case 'config': // @TODO FILTER_COMPILE_CONFIG does not handle call-back functions so we handle it here again
+                                       // Read configuration
+                                       $configValue = getConfig($matches[4][$key]);
+
+                                       // Do we have a call-back?
+                                       if (!empty($callback)) {
+                                               // Parse it through this function
+                                               $configValue = call_user_func_array($callback, array($configValue));
+                                       } // END - if
+
+                                       // Replace the config entry
+                                       $code = str_replace($matches[0][$key], $configValue, $code);
+                                       break;
+
+                               default:
+                                       // Unsupported command detected
+                                       debug_report_bug('Command=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
+                                       break;
+                       } // END - switch
                } // END - foreach
        } // END - if
 
+       // Do we have non-HTML mode?
+       if ((getOutputMode() != '0') || ($outputMode != '0')) $code = decodeEntities($code);
+
        // Return compiled code
+       //* DEBUG: */ die('<pre>'.htmlentities($code).'</pre>');
        return $code;
 }
 
@@ -483,9 +588,9 @@ 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()) || (!isExtensionInstalled('sql_patches'))) && (getOutputMode() == 0)) {
+       if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (getOutputMode() == '0')) {
                // Then abort here
-               logDebugMessage(__FUNCTION__, __LINE__, 'Cannot run reset! Please report this bug. Thanks');
+               debug_report_bug('Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
        } // END - if
 
        // Get more daily reset scripts
@@ -580,9 +685,12 @@ function FILTER_DETERMINE_WHAT_ACTION () {
                        if (isGetRequestElementSet('module')) {
                                // Set module from request
                                setModule(getRequestElement('module'));
-                       } else {
+                       } elseif (getOutputMode() == '0') {
                                // Set default module 'index'
                                setModule('index');
+                       } else {
+                               // Unknown module
+                               setModule('unknown');
                        }
                } // END - if
 
@@ -621,7 +729,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');
@@ -651,10 +759,9 @@ function FILTER_CHECK_SVN_REVISION () {
 // Filter for running daily reset
 function FILTER_RUN_DAILY_RESET () {
        // Only execute this filter if installed
-       if ((!isInstalled()) || (!isAdminRegistered())) return;
+       if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalled('sql_patches'))) return;
 
        // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
-       // 012    3              4             43        3         4432    2         3             3       21    1                    221    1                 221    1                  2          21    1             22     10
        if (((date('d', getConfig('last_update')) != date('d', time())) || ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y'))) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (getOutputMode() != 1)) {
                // Tell every module we are in reset-mode!
                doReset();
@@ -705,7 +812,7 @@ function FILTER_INIT_RANDOM_NUMBER () {
        // Is the extension sql_patches installed and at least 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));
@@ -725,7 +832,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
@@ -826,7 +933,7 @@ 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
@@ -834,15 +941,60 @@ function FILTER_DISPLAY_PARSING_TIME () {
 
 // 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) {
+               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]
 ?>