More rewrites to make use of (cached) wrapper functions

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

diff --git a/inc/filter-functions.php b/inc/filter-functions.php
index 7bc55f018c67f9880e6e7227a525e1321f526d93..d0e881ae8cd698d221e5faf3abc38f18174a3996 100644 (file)
--- a/inc/filter-functions.php
+++ b/inc/filter-functions.php
@@ -47,7 +47,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
@@ -62,7 +62,7 @@ function initFilterSystem () {
                $add = '';
                if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) $add = ", `filter_counter`";
 
-               // Load all active filers
+               // Load all filters
                $result = SQL_QUERY("SELECT
        `filter_name`,`filter_function`,`filter_active`".$add."
 FROM
@@ -71,7 +71,7 @@ ORDER BY
        `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
@@ -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
@@ -185,17 +185,17 @@ ORDER BY
 
 // "Registers" a new filter function
 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - ENTERED!');
 
        // Extend the filter function name
        $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 
        // Is that filter already there?
        if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
-               // Then abort here
-               if ($silentAbort === false) {
+               // In installation phase we always want to abort
+               if (($silentAbort === false) || (isInstallationPhase())) {
                        // Add fatal message
-                       addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
+                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
                } // END - if
 
                // Abort here
@@ -216,11 +216,13 @@ function registerFilter ($filterName, $filterFunction, $silentAbort = true, $for
                $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
                $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
        } // END - if
+
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - EXIT!');
 }
 
 // "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));
+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])) {
@@ -237,13 +239,17 @@ 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: 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
 function runFilterChain ($filterName, $data = null) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',data[]=' . gettype($data) . ' - ENTERED!');
+
        // Is that filter chain there?
        if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
                // Log not found filters in debug-mode
@@ -262,32 +268,33 @@ function runFilterChain ($filterName, $data = null) {
        // Then run all filters
        foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
                // Debug message
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
 
-               // Is the filter active?
+               // Is the filter active or newly added??
                if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
                        // Is this filter there?
                        if (!function_exists($filterFunction)) {
                                // Unregister it
-                               unregisterFilter($filterName, $filterFunction);
+                               unregisterFilter(__FUNCTION__, __LINE__, $filterName, $filterFunction);
 
                                // Skip this entry
                                continue;
                        } // END - if
 
                        // Call the filter chain
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName.'/'.$filterFunction.',[]='.gettype($returnValue));
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
                        $returnValue = call_user_func_array($filterFunction, array($returnValue));
 
                        // Update usage counter
                        countFilterUsage($filterName, $filterFunction);
                } elseif (isDebugModeEnabled()) {
                        // Debug message
-                       logDebugMessage(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
+                       logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
                }
        } // END - foreach
 
        // Return the filtered content
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',data[]=' . gettype($data) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
        return $returnValue;
 }