Renamed more:
[mailer.git] / inc / filter-functions.php
index f10ce83..50a4a65 100644 (file)
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -48,13 +48,13 @@ function initFilterSystem () {
                reportBug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
        } // END - if
 
-       // Load all saved filers if sql_patches is updated
+       // Load all saved filers if ext-sql_patches is updated
        if ((isset($GLOBALS['cache_array']['filter']['filter_name'])) && (!isset($GLOBALS['cache_array']['filter']['chains']))) {
                // Prepare filter array
                prepareFilterArray();
 
                // Mark it as initialized
-               $GLOBALS['filter_init'] = true;
+               $GLOBALS['filter_init'] = TRUE;
        } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
                // Init add
                $add = '';
@@ -63,7 +63,7 @@ function initFilterSystem () {
                } // END - if
 
                // Load all filters
-               $result = SQL_QUERY('SELECT
+               $result = sqlQuery('SELECT
        `filter_name`,
        `filter_function`,
        `filter_active`
@@ -74,9 +74,9 @@ ORDER BY
        `filter_id` ASC', __FUNCTION__, __LINE__);
 
                // Are there entries?
-               if (!SQL_HASZERONUMS($result)) {
+               if (!ifSqlHasZeroNums($result)) {
                        // Load all filters
-                       while ($filterArray = SQL_FETCHARRAY($result)) {
+                       while ($filterArray = sqlFetchArray($result)) {
                                // Get filter name and function
                                $filterName     = $filterArray['filter_name'];
                                $filterFunction = $filterArray['filter_function'];
@@ -85,7 +85,7 @@ ORDER BY
                                $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
 
                                // Mark this filter as loaded (from database)
-                               $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
+                               $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = TRUE;
 
                                // Set this filter
                                $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
@@ -99,7 +99,7 @@ ORDER BY
                } // END - if
 
                // Free result
-               SQL_FREERESULT($result);
+               sqlFreeResult($result);
        }
 
        // Init filters
@@ -107,17 +107,25 @@ ORDER BY
        registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOMIZER');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_RUNTIME_INCLUDES');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_EXTENSIONS');
+       registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_SESSION');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'SET_CURRENT_DATE');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOM_NUMBER');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'CHECK_REPOSITORY_REVISION');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_HOURLY_RESET');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_DAILY_RESET');
+       registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_WEEKLY_RESET');
+       registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_MONTHLY_RESET');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'TRIGGER_SENDING_POOL');
-       registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME');
+       // @TODO Remove this forced removal after a year or so
+       unregisterFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME', TRUE);
        registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
        registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
+       registerFilter(__FUNCTION__, __LINE__, 'init', 'REDIRECT_WRONG_SERVER_NAME');
+
+       // Post-initialization
+       registerFilter(__FUNCTION__, __LINE__, 'post_init', 'DETERMINE_USERNAME');
 
        // Page headers - pre-filter (normally, you want to register here)
        registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
@@ -169,8 +177,14 @@ ORDER BY
        // Do hourly reset stuff, keep this entry first in this chain:
        registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
 
-       // Do reset stuff, keep this entry first in this chain:
-       registerFilter(__FUNCTION__, __LINE__, 'reset', 'RUN_RESET_INCLUDES');
+       // Do daily stuff, keep this entry first in this chain:
+       registerFilter(__FUNCTION__, __LINE__, 'daily', 'RUN_DAILY_INCLUDES');
+
+       // Do weekly stuff, keep this entry first in this chain:
+       registerFilter(__FUNCTION__, __LINE__, 'weekly', 'RUN_WEEKLY_INCLUDES');
+
+       // Do monthly stuff, keep this entry first in this chain:
+       registerFilter(__FUNCTION__, __LINE__, 'monthly', 'RUN_MONTHLY_INCLUDES');
 
        // Remove extension
        registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
@@ -194,49 +208,62 @@ ORDER BY
 
        // Admin mail links
        registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
+
+       // Build mails
+       registerFilter(__FUNCTION__, __LINE__, 'send_build_mail', 'SEND_BUILD_MAIL');
+
+       // Handle referral banner click/view
+       registerFilter(__FUNCTION__, __LINE__, 'handle_click_php', 'HANDLE_REFERRER_BANNER_CLICK');
+       registerFilter(__FUNCTION__, __LINE__, 'handle_view_php', 'HANDLE_REFERRER_BANNER_VIEW');
+
+       // Generic filter to add hidden fields to formulars
+       registerFilter(__FUNCTION__, __LINE__, 'open_form_fields', 'ADD_INPUT_HIDDEN_SESSION_ID');
 }
 
 // "Registers" a new filter function
-function registerFilter ($F, $L, $filterName, $filterFunction, $silentAbort = true, $force = false, $isDryRun = false) {
+function registerFilter ($file, $line, $filterName, $filterFunction, $silentAbort = TRUE, $force = FALSE, $isDryRun = FALSE) {
        // Extend the filter function name
        $filterFunction = 'FILTER_' . strtoupper($filterFunction);
 
        // Debug message with FILTER_ prefix
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - ENTERED!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - ENTERED!');
 
        // Is that filter already there?
-       if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
+       if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
                // In installation phase we always want to abort
-               if (($silentAbort === false) || (isInstallationPhase())) {
+               if (($silentAbort === FALSE) || (isInstallationPhase())) {
                        // Add fatal message
-                       reportBug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered! F=%s,L=%s,force=%d", $filterName, $filterFunction, basename($F), $L, intval($force)));
+                       reportBug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered! file=%s,L=%s,force=%d", $filterName, $filterFunction, basename($file), $line, intval($force)));
                } // END - if
 
                // Abort here
-               return false;
+               return FALSE;
        } // END - if
 
        // Shall we add it?
-       if ($isDryRun === false) {
+       if ($isDryRun === FALSE) {
                // Is the function there?
                if (!function_exists($filterFunction)) {
                        // Then abort here
-                       addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s. F=%s,L=%s,force=%d", $filterFunction, $filterName, basename($F), $L, intval($force)));
-                       return false;
+                       logDebugMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s. file=%s,L=%s,force=%d", $filterFunction, $filterName, basename($file), $line, intval($force)));
+                       return FALSE;
                } // END - if
 
                // Simply add it to the array
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L);
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',file=' . basename($file) . ',line=' . $line);
                $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 . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - EXIT!');
+
+       // Worked
+       return TRUE;
 }
 
 // "Unregisters" a filter from the given chain
-function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $isDryRun = false) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
+function unregisterFilter ($file, $line, $filterName, $filterFunction, $force = FALSE, $isDryRun = FALSE) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
 
        // Extend the filter function name only if not loaded from database
        if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
@@ -244,20 +271,23 @@ function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false,
        } // END - if
 
        // Is that filter there?
-       if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
+       if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
                // Not found, so abort here
-               addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
-               return false;
+               logDebugMessage(__FUNCTION__, __LINE__, sprintf('Filter function %s cannot be unregistered from filter %s.', $filterFunction, $filterName));
+               return FALSE;
        } // END - if
 
        // Shall we remove? (default, not while just showing an extension removal)
-       if ($isDryRun === false) {
+       if (($isDryRun === FALSE) && (isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction]))) {
                // Mark for filter removal
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
                $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
        } // END - if
 
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
+
+       // Worked
+       return TRUE;
 }
 
 // "Runs" the given filters, filterData is optional and can be any type of data
@@ -294,7 +324,7 @@ function runFilterChain ($filterName, $filterData = NULL) {
                        } // END - if
 
                        // Call the filter chain
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue) . ' - CALLING!');
                        $returnValue = call_user_func_array($filterFunction, array($returnValue));
 
                        // Update usage counter
@@ -327,7 +357,7 @@ function prepareFilterArray () {
        //¬†Abort here if array is absend (e.g. not cached)
        if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
                // Abort silently
-               return false;
+               return FALSE;
        } // END - if
 
        // Init dummy array
@@ -344,7 +374,7 @@ function prepareFilterArray () {
 
                // Add the element with mapped index
                $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
-               $filterArray['loaded'][$filterName][$filterFunction]  = true;
+               $filterArray['loaded'][$filterName][$filterFunction]  = TRUE;
                $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
        } // END - foreach
 
@@ -352,13 +382,21 @@ function prepareFilterArray () {
        $GLOBALS['cache_array']['filter'] = $filterArray;
 }
 
-// Loads filter for given extension if present. This function will silently
-// ignore absent filter files.
+/**
+ * Loads filter for given extension if present. This function will silently
+ * ignore absent filter files.
+ *
+ * @param      $ext_name       Name of extension
+ * @return     void
+ */
 function loadExtensionFilters ($ext_name) {
-       // Do we have cache entry?
+       // Debug message
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
+
+       // Is there a cache entry?
        if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
                // Default is not found
-               $GLOBALS[__FUNCTION__][$ext_name] = false;
+               $GLOBALS[__FUNCTION__][$ext_name] = FALSE;
 
                // Construct include file name
                $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
@@ -369,12 +407,15 @@ function loadExtensionFilters ($ext_name) {
                        loadIncludeOnce($incFileName);
 
                        // Mark the file as loaded
-                       $GLOBALS[__FUNCTION__][$ext_name] = true;
+                       $GLOBALS[__FUNCTION__][$ext_name] = TRUE;
                } elseif (isDebugModeEnabled()) {
                        // Log missing file
-                       logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
+                       //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
                }
        } // END - if
+
+       // Debug message
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
 }
 
 // [EOF]