Filter support added to template engine, functions renamed

[mailer.git] / inc / filter-functions.php

diff --git a/inc/filter-functions.php b/inc/filter-functions.php
index 274ded1875e60b1975ac21e9ee741694ffdaf913..e96ab005b547a10040be3c33188d53265b51db20 100644 (file)
--- a/inc/filter-functions.php
+++ b/inc/filter-functions.php
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 10/27/2009 *
- * ===============                              Last change: 10/27/2009 *
+ * Mailer v0.2.1-FINAL                                Start: 10/27/2009 *
+ * ===================                          Last change: 10/27/2009 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : filter-functions.php                             *
@@ -10,10 +10,10 @@
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Funktionen fuer Filter-System                    *
  * -------------------------------------------------------------------- *
- * $Revision:: 1185                                                   $ *
- * $Date:: 2009-10-11 04:16:39 +0200 (Sun, 11 Oct 2009)               $ *
+ * $Revision::                                                        $ *
+ * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
- * $Author:: quix0r                                                   $ *
+ * $Author::                                                          $ *
  * Needs to be in all Files and every File needs "svn propset           *
  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
@@ -44,9 +44,9 @@ if (!defined('__SECURITY')) {
 // Init "generic filter system"
 function initFilterSystem () {
        // Is the filter already initialized?
-       if (isset($GLOBALS['filters'])) {
+       if (isset($GLOBALS['filter_init'])) {
                // Then abort here
-               debug_report_bug(getMessage('FILTER_FAILED_ALREADY_INIT'));
+               debug_report_bug('Filter system already initialized.');
        } // END - if
 
        // Load all saved filers if sql_patches is updated
@@ -69,8 +69,8 @@ function initFilterSystem () {
                        $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
                } // END - foreach
 
-               // Mark filters as loaded
-               $GLOBALS['cache_array']['filter'] = true;
+               // Mark it as initialized
+               $GLOBALS['filter_init'] = true;
 
                // Remove the cache
                $GLOBALS['cache_array']['filter'] = $filterArray;
@@ -96,7 +96,7 @@ ORDER BY
                                $filterFunction = $filterArray['filter_function'];
 
                                // Set counter to default
-                               $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 0;
+                               $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
 
                                // Mark this filter as loaded (from database)
                                $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
@@ -119,13 +119,15 @@ ORDER BY
        // Init filters
        registerFilter('init', 'LOAD_CONFIGURATION');
        registerFilter('init', 'INIT_EXTENSIONS');
+       registerFilter('init', 'INIT_RANDOMIZER');
        registerFilter('init', 'LOAD_RUNTIME_INCLUDES');
+       registerFilter('init', 'INIT_RANDOM_NUMBER');
        registerFilter('init', 'CHECK_SVN_REVISION');
        registerFilter('init', 'RUN_DAILY_RESET');
-       registerFilter('init', 'INIT_RANDOMIZER');
        registerFilter('init', 'TRIGGER_SENDING_POOL');
        registerFilter('init', 'DETERMINE_USERNAME');
        registerFilter('init', 'DETERMINE_WHAT_ACTION');
+       registerFilter('init', 'COUNT_MODULE');
        registerFilter('init', 'UPDATE_LOGIN_DATA');
        registerFilter('init', 'ACTIVATE_EXCHANGE');
 
@@ -156,11 +158,12 @@ ORDER BY
        // Register shutdown filters
        registerFilter('shutdown', 'FLUSH_FILTERS');
        registerFilter('shutdown', 'FLUSH_STATS');
+       registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
        registerFilter('shutdown', 'FLUSH_OUTPUT');
 
        // Compiling code
        registerFilter('compile_code', 'COMPILE_CONFIG');
-       registerFilter('compile_code', 'COMPILE_EXTENSION');
+       registerFilter('compile_code', 'COMPILE_EXPRESSION_CODE');
 
        // Generic extension update filters
        registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
@@ -173,6 +176,17 @@ ORDER BY
 
        // Exclude some users
        registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
+
+       // Handling of fatal errors
+       registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
+
+       // Page footer filters
+       registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
+       registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
+       registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
+
+       // Member login check. Always keep FETCH_USER_DATA as first entry!
+       registerFilter('member_login_check', 'FETCH_USER_DATA');
 }
 
 // "Registers" a new filter function
@@ -184,7 +198,8 @@ function registerFilter ($filterName, $filterFunction, $silentAbort = true, $for
        if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
                // Then abort here
                if ($silentAbort === false) {
-                       addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
+                       // Add fatal message
+                       addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
                } // END - if
 
                // Abort here
@@ -196,14 +211,14 @@ function registerFilter ($filterName, $filterFunction, $silentAbort = true, $for
                // Is the function there?
                if (!function_exists($filterFunction)) {
                        // Then abort here
-                       addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_404'), $filterFunction, $filterName));
+                       addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s.", $filterFunction, $filterName));
                        return false;
                } // END - if
 
                // Simply add it to the array
                //* DEBUG: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
                $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
-               $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 0;
+               $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
        } // END - if
 }
 
@@ -217,7 +232,7 @@ function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_ru
        // Is that filter there?
        if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
                // Not found, so abort here
-               addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
+               addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
                return false;
        } // END - if
 
@@ -234,10 +249,10 @@ function runFilterChain ($filterName, $data = null) {
        // Is that filter chain there?
        if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
                // We should find all these non-existing filter chains
-               /* Only for tracking: */ if ($filterName != 'sql_admin_extra_data') {
-               /* Only for tracking: */ debug_report_bug('Filter chain <strong>' . $filterName . '</strong> not found!');
-               /* Only for tracking: */ }
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
+               //* Only for tracking: */ if ($filterName != 'sql_admin_extra_data') {
+               //* Only for tracking: */ debug_report_bug('Filter chain <strong>' . $filterName . '</strong> not found!');
+               //* Only for tracking: */ }
+               /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
 
                // Abort here and return content
                return $data;