]> git.mxchange.org Git - mailer.git/blobdiff - inc/filter-functions.php
ext-coupon is still unfinished
[mailer.git] / inc / filter-functions.php
index 39b7558bfd7e97c65d09e423c282a37e5ea49c9d..066ca223657ee8ccb5c9d0571ccdbb49e5c8fe6a 100644 (file)
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -47,7 +45,7 @@ function initFilterSystem () {
        // Is the filter already initialized?
        if (isset($GLOBALS['filter_init'])) {
                // Then abort here
-               debug_report_bug('Filter system already initialized.');
+               debug_report_bug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
        } // END - if
 
        // Load all saved filers if sql_patches is updated
@@ -63,15 +61,15 @@ function initFilterSystem () {
                if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) $add = ", `filter_counter`";
 
                // Load all filters
-               $result = SQL_QUERY("SELECT
-       `filter_name`,`filter_function`,`filter_active`".$add."
+               $result = SQL_QUERY('SELECT
+       `filter_name`,`filter_function`,`filter_active`' . $add . '
 FROM
        `{?_MYSQL_PREFIX?}_filters`
 ORDER BY
-       `filter_id` ASC", __FUNCTION__, __LINE__);
+       `filter_id` ASC', __FUNCTION__, __LINE__);
 
                // Are there entries?
-               if (SQL_NUMROWS($result) > 0) {
+               if (!SQL_HASZERONUMS($result)) {
                        // Load all filters
                        while ($filterArray = SQL_FETCHARRAY($result)) {
                                // Get filter name and function
@@ -104,8 +102,10 @@ ORDER BY
        registerFilter('init', 'INIT_RANDOMIZER');
        registerFilter('init', 'LOAD_RUNTIME_INCLUDES');
        registerFilter('init', 'INIT_EXTENSIONS');
+       registerFilter('init', 'SET_CURRENT_DATE');
        registerFilter('init', 'INIT_RANDOM_NUMBER');
-       registerFilter('init', 'CHECK_SVN_REVISION');
+       registerFilter('init', 'CHECK_REPOSITORY_REVISION');
+       registerFilter('init', 'RUN_HOURLY_RESET');
        registerFilter('init', 'RUN_DAILY_RESET');
        registerFilter('init', 'TRIGGER_SENDING_POOL');
        registerFilter('init', 'DETERMINE_USERNAME');
@@ -122,7 +122,7 @@ ORDER BY
        registerFilter('post_page_header', 'FINISH_PAGE_HEADER');
        // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
 
-       // Login failures handler
+       // 'You are here' navigation - post filter
        registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 
        // Filters for pre-extension-registration
@@ -159,6 +159,9 @@ ORDER BY
        // Generic extension update filters
        registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
 
+       // Do hourly reset stuff, keep this entry first in this chain:
+       registerFilter('hourly', 'RUN_HOURLY_INCLUDES');
+
        // Do reset stuff, keep this entry first in this chain:
        registerFilter('reset', 'RUN_RESET_INCLUDES');
 
@@ -195,7 +198,7 @@ function registerFilter ($filterName, $filterFunction, $silentAbort = true, $for
                // In installation phase we always want to abort
                if (($silentAbort === false) || (isInstallationPhase())) {
                        // Add fatal message
-                       debug_report_bug(sprintf("[%s:%s] Filter chain %s has already filter function %s registered!", __FUNCTION__, __LINE__, $filterName, $filterFunction));
+                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
                } // END - if
 
                // Abort here
@@ -221,8 +224,8 @@ function registerFilter ($filterName, $filterFunction, $silentAbort = true, $for
 }
 
 // "Unregisters" a filter from the given chain
-function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - ENTERED!');
+function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $dry_run = false) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - ENTERED!');
 
        // Extend the filter function name only if not loaded from database
        if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
@@ -239,11 +242,11 @@ function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_ru
        // Shall we remove? (default, not while just showing an extension removal)
        if ($dry_run === false) {
                // Mark for filter removal
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction);
                $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
        } // END - if
 
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - EXIT!');
 }
 
 // "Runs" the given filters, data is optional and can be any type of data
@@ -255,7 +258,7 @@ function runFilterChain ($filterName, $data = null) {
                // Log not found filters in debug-mode
                if (isDebugModeEnabled()) {
                        // Log it away...
-                       logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
+                       logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found.');
                } // END - if
 
                // Abort here and return content
@@ -275,7 +278,7 @@ function runFilterChain ($filterName, $data = null) {
                        // Is this filter there?
                        if (!function_exists($filterFunction)) {
                                // Unregister it
-                               unregisterFilter($filterName, $filterFunction);
+                               unregisterFilter(__FUNCTION__, __LINE__, $filterName, $filterFunction);
 
                                // Skip this entry
                                continue;
@@ -340,5 +343,30 @@ function prepareFilterArray () {
        $GLOBALS['cache_array']['filter'] = $filterArray;
 }
 
+// Loads filter for given extension if present. This function will silently
+// ignore absent filter files.
+function loadExtensionFilters ($ext_name) {
+       // Do we have cache entry?
+       if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
+               // Default is not found
+               $GLOBALS[__FUNCTION__][$ext_name] = false;
+
+               // Construct include file name
+               $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
+
+               // Is the include file readable?
+               if (isIncludeReadable($incFileName)) {
+                       // Load the include file
+                       loadIncludeOnce($incFileName);
+
+                       // Mark the file as loaded
+                       $GLOBALS[__FUNCTION__][$ext_name] = true;
+               } elseif (isDebugModeEnabled()) {
+                       // Log missing file
+                       logDebugMessage(__FUNCTION__, __LINE__, 'Include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
+               }
+       } // END - if
+}
+
 // [EOF]
 ?>