Way more usage of EL code:

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

diff --git a/inc/filter-functions.php b/inc/filter-functions.php
index f944978b242a1955e18164cc9c3bad4976347093..0ec69f0fb318f4701ebf997779aaae6aa08a2245 100644 (file)
--- a/inc/filter-functions.php
+++ b/inc/filter-functions.php
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * 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 *
@@ -58,7 +58,9 @@ function initFilterSystem () {
        } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
                // Init add
                $add = '';
-               if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) $add = ", `filter_counter`";
+               if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
+                       $add = ", `filter_counter`";
+               } // END - if
 
                // Load all filters
                $result = SQL_QUERY('SELECT
@@ -104,7 +106,8 @@ ORDER BY
        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');
@@ -132,6 +135,7 @@ ORDER BY
        registerFilter('post_extension_installed', 'SOLVE_TASK');
        registerFilter('post_extension_installed', 'LOAD_INCLUDES');
        registerFilter('post_extension_installed', 'REMOVE_UPDATES');
+       registerFilter('post_extension_installed', 'EXTENSION_MARK_INSTALLED');
 
        // Solving tasks
        registerFilter('solve_task', 'SOLVE_TASK');
@@ -158,6 +162,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');
 
@@ -221,7 +228,7 @@ function registerFilter ($filterName, $filterFunction, $silentAbort = true, $for
 
 // "Unregisters" a filter from the given chain
 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!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
 
        // Extend the filter function name only if not loaded from database
        if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
@@ -238,31 +245,31 @@ function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false,
        // Shall we remove? (default, not while just showing an extension removal)
        if ($dry_run === false) {
                // Mark for filter removal
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction);
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
                $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
        } // END - if
 
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - EXIT!');
 }
 
-// "Runs" the given filters, data is optional and can be any type of data
-function runFilterChain ($filterName, $data = null) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',data[]=' . gettype($data) . ' - ENTERED!');
+// "Runs" the given filters, filterData is optional and can be any type of data
+function runFilterChain ($filterName, $filterData = null) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
 
        // Is that filter chain there?
        if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
                // 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
-               return $data;
+               return $filterData;
        } // END - if
 
        // Default return value
-       $returnValue = $data;
+       $returnValue = $filterData;
 
        // Then run all filters
        foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
@@ -293,7 +300,7 @@ function runFilterChain ($filterName, $data = null) {
        } // END - foreach
 
        // Return the filtered content
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',data[]=' . gettype($data) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
        return $returnValue;
 }
 
@@ -339,5 +346,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]
 ?>