New filters introduced for page header, obsolete template removed:
[mailer.git] / inc / filters.php
index b4970d71b897934a902db27fb937bc76b260219e..8636a3813b31c1e3470c8778971405520de60d5f 100644 (file)
@@ -18,6 +18,7 @@
  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -127,7 +128,7 @@ function FILTER_FLUSH_FILTERS () {
        // Should we rebuild cache?
        if (($inserted > 0) || ($removed > 0)) {
                // Destroy cache
-               rebuildCacheFile('filter', 'filter');
+               rebuildCache('filter', 'filter');
        } // END - if
 }
 
@@ -137,10 +138,10 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
        $content = $data;
 
        // Handle failed logins here if not in guest
-       //* DEBUG: */ outputHtml(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__."</font>):type={$data['type']},action={getAction()},what={getWhat()},level={$data['access_level']}<br />");
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "type=".$data['type'].",action=".getAction().",what=".getWhat().",level=".$data['access_level']."<br />");
        if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.0')))) {
                // Handle failure
-               $content['content'] .= handleLoginFailtures($data['access_level']);
+               $content['content'] .= handleLoginFailures($data['access_level']);
        } // END - if
 
        // Return the content
@@ -167,7 +168,7 @@ function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
        // Is this extension always activated?
        if (getExtensionAlwaysActive() == 'Y') {
                // Then activate the extension
-               //* DEBUG: */ outputHtml(__FUNCTION__ . '(<font color="#0000aa">' . __LINE__."</font>): ext_name={$data['ext_name']}<br />");
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "ext_name={$data['ext_name']}<br />");
                doActivateExtension($data['ext_name']);
        } // END - if
 
@@ -445,12 +446,12 @@ function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
 
 // Filter for compiling expression code
 function FILTER_COMPILE_EXPRESSION_CODE ($code) {
-       // Compile {%cmd=some_value%} to get expression code snippets
+       // Compile {%cmd,callback,extraFunction=some_value%} to get expression code snippets
        // See switch() command below for supported commands
        preg_match_all('/\{%(([a-zA-Z0-9-_,]+)(=([^\}]+)){0,1})*%\}/', $code, $matches);
        //* DEBUG: */ print('<pre>'.print_r($matches, true).'</pre>');
 
-       // Default is from OUTPUT_HTML
+       // Default is from outputHtml()
        $outputMode = getOutputMode();
 
        // Some entries found?
@@ -465,108 +466,30 @@ function FILTER_COMPILE_EXPRESSION_CODE ($code) {
                        // Extract command and call-back
                        $cmdArray = explode(',', $cmd);
                        $cmd = $cmdArray[0];
-                       if (isset($cmdArray[1])) $callback = $cmdArray[1];
+                       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 . "')";
-                                       }
-
-                                       // 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;
-
-                               case 'filter':
-                                       // Construct replacement
-                                       $replacer = "\" . runFilterChain('" . $matches[4][$key] . "') . \"";
-
-                                       // Run the filter and insert result
-                                       $code = str_replace($matches[0][$key], $replacer, $code);
-                                       break;
-
-                               default:
-                                       // Unsupported command detected
-                                       debug_report_bug('Command=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
-                                       break;
-                       } // END - switch
+                       // Construct call-back function name for the command
+                       $commandFunction = 'doExpression' . ucfirst(strtolower($cmd));
+
+                       // Is this function there?
+                       if (function_exists($commandFunction)) {
+                               // Prepare $matches, $key, $outputMode, etc.
+                               $data = array(
+                                       'matches'    => $matches,
+                                       'key'        => $key,
+                                       'mode'       => $outputMode,
+                                       'code'       => $code,
+                                       'callback'   => $callback,
+                                       'extra_func' => $extraFunction
+                               );
+
+                               // Call it
+                               $code = call_user_func($commandFunction, $data);
+                       } else {
+                               // Unsupported command detected
+                               debug_report_bug('Command=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
+                       }
                } // END - foreach
        } // END - if
 
@@ -612,24 +535,24 @@ function FILTER_RUN_RESET_INCLUDES () {
                $currWeek = date('W', time());
 
                // Has it changed?
-               if ((getConfig('last_week') != $currWeek) || (getConfig('DEBUG_WEEKLY') == 'Y')) {
+               if ((getConfig('last_week') != $currWeek) || ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') == 'Y'))) {
                        // Include weekly reset scripts
                        mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
 
                        // Update config
-                       if ((isConfigEntrySet('DEBUG_WEEKLY')) && (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
                $currMonth = date('m', time());
 
                // Has it changed?
-               if ((getConfig('last_month') != $currMonth) || (getConfig('DEBUG_MONTHLY') == 'Y')) {
+               if ((getConfig('last_month') != $currMonth) || ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') == 'Y'))) {
                        // Include monthly reset scripts
                        mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
 
                        // Update config
-                       if ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
+                       if ((!isConfigEntrySet('DEBUG_MONTHLY')) || (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
                } // END - if
        } // END - if
 
@@ -643,11 +566,11 @@ function FILTER_REMOVE_EXTENSION () {
        SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
                array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
 
-       // Remove the extension from global cache array as well
+       // Remove the extension from cache array as well
        removeExtensionFromArray();
 
        // Remove the cache
-       rebuildCacheFile('extension', 'extension');
+       rebuildCache('extension', 'extension');
 }
 
 // Filter for flushing the output
@@ -705,7 +628,7 @@ function FILTER_DETERMINE_WHAT_ACTION () {
                if (!isWhatSet())   setWhat(getWhatFromModule(getModule()));
 
                // Fix 'action' if not yet set
-               if (!isActionSet()) setAction(getModeAction(getModule(), getWhat()));
+               if (!isActionSet()) setAction(getActionFromModuleWhat(getModule(), getWhat()));
        } else {
                // Set action/what to empty
                setAction('');
@@ -717,7 +640,7 @@ function FILTER_DETERMINE_WHAT_ACTION () {
        if ((!isWhatSet()) && (!isActionSet()) && (getOutputMode() != 1) && (getOutputMode() != -1)) {
                if (getModule() == 'admin') {
                        // Set 'action' value to 'login' in admin menu
-                       setAction(getModeAction(getModule(), getWhat()));
+                       setAction(getActionFromModuleWhat(getModule(), getWhat()));
                } elseif ((getModule() == 'index') || (getModule() == 'login')) {
                        // Set 'what' value to 'welcome' in guest and member menu
                        setWhatFromConfig('index_home');
@@ -782,14 +705,6 @@ function FILTER_LOAD_RUNTIME_INCLUDES () {
                // Load the include
                loadIncludeOnce($inc);
        } // END - foreach
-
-       // Load admin include file if he is admin
-       if (isAdmin()) {
-               // Administrative functions
-               loadIncludeOnce('inc/modules/admin/admin-inc.php');
-       } // END - if
-       //* DEBUG: */ addPointsThroughReferalSystem('test', 36, 1000);
-       //* DEBUG: */ die();
 }
 
 // Filter for checking admin ACL
@@ -803,7 +718,7 @@ function FILTER_CHECK_ADMIN_ACL () {
                $action = getAction();
                if (isWhatSet()) {
                        // Get action value by what-value
-                       $action = getModeAction('admin', getWhat());
+                       $action = getActionFromModuleWhat('admin', getWhat());
                } // END - if
 
                // Check for access control line of current menu entry
@@ -999,9 +914,55 @@ LIMIT 1",
 
                // Store it in session
                setSession('mxchange_member_failures' , getUserData('login_failures'));
-               setSession('mxchange_member_last_fail', getUserData('last_failure'));
+               setSession('mxchange_member_last_failure', getUserData('last_failure'));
        } // END - if
 }
 
+// Try to login the admin by setting some session/cookie variables
+function FILTER_DO_LOGIN_ADMIN ($data) {
+       // Now set all session variables and store the result for later processing
+       $GLOBALS['admin_login_success'] = ((
+               setSession('admin_md5', encodeHashForCookie($data['pass_hash']))
+       ) && (
+               setSession('admin_login', $data['login'])
+       ) && (
+               setSession('admin_last', time())
+       ));
+
+       // Return the data for further processing
+       return $data;
+}
+
+// Filter for loading page header, this should be ran first!
+function FILTER_LOAD_PAGE_HEADER () {
+       // Determine the page title
+       $content['header_title'] = determinePageTitle();
+
+       // Output page header code
+       $GLOBALS['page_header'] = loadTemplate('page_header', true, $content);
+
+       // Include meta data in 'guest' module
+       if (getModule() == 'index') {
+               // Load meta data template
+               $GLOBALS['page_header'] .= loadTemplate('metadata', true);
+
+               // Add meta description to header
+               if ((isInstalled()) && (isAdminRegistered()) && (SQL_IS_LINK_UP())) {
+                       // Add meta description not in admin and login module and when the script is installed
+                       generateMetaDescriptionCode();
+               } // END - if
+       } // END - if
+}
+
+// Filter for adding style sheet, closing page header
+function FILTER_FINISH_PAGE_HEADER () {
+       // Include stylesheet
+       loadIncludeOnce('inc/stylesheet.php');
+
+       // Closing HEAD tag
+       $GLOBALS['page_header'] .= '</head>';
+}
+
 // [EOF]
 ?>
+