inc/filter-functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 10/27/2009 *
   4  * ===================                          Last change: 10/27/2009 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : filter-functions.php                             *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Functions for filter system                      *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Funktionen fuer Filter-System                    *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * -------------------------------------------------------------------- *
  18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  20  * For more information visit: http://www.mxchange.org                  *
  21  *                                                                      *
  22  * This program is free software; you can redistribute it and/or modify *
  23  * it under the terms of the GNU General Public License as published by *
  24  * the Free Software Foundation; either version 2 of the License, or    *
  25  * (at your option) any later version.                                  *
  26  *                                                                      *
  27  * This program is distributed in the hope that it will be useful,      *
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  30  * GNU General Public License for more details.                         *
  31  *                                                                      *
  32  * You should have received a copy of the GNU General Public License    *
  33  * along with this program; if not, write to the Free Software          *
  34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  35  * MA  02110-1301  USA                                                  *
  36  ************************************************************************/
  37
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         die();
  41 } // END - if
  42
  43 // Init "generic filter system"
  44 function initFilterSystem () {
  45         // Is the filter already initialized?
  46         if (isset($GLOBALS['filter_init'])) {
  47                 // Then abort here
  48                 debug_report_bug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
  49         } // END - if
  50
  51         // Load all saved filers if sql_patches is updated
  52         if ((isset($GLOBALS['cache_array']['filter']['filter_name'])) && (!isset($GLOBALS['cache_array']['filter']['chains']))) {
  53                 // Prepare filter array
  54                 prepareFilterArray();
  55
  56                 // Mark it as initialized
  57                 $GLOBALS['filter_init'] = true;
  58         } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
  59                 // Init add
  60                 $add = '';
  61                 if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
  62                         $add = ", `filter_counter`";
  63                 } // END - if
  64
  65                 // Load all filters
  66                 $result = SQL_QUERY('SELECT
  67         `filter_name`,`filter_function`,`filter_active`' . $add . '
  68 FROM
  69         `{?_MYSQL_PREFIX?}_filters`
  70 ORDER BY
  71         `filter_id` ASC', __FUNCTION__, __LINE__);
  72
  73                 // Are there entries?
  74                 if (!SQL_HASZERONUMS($result)) {
  75                         // Load all filters
  76                         while ($filterArray = SQL_FETCHARRAY($result)) {
  77                                 // Get filter name and function
  78                                 $filterName     = $filterArray['filter_name'];
  79                                 $filterFunction = $filterArray['filter_function'];
  80
  81                                 // Set counter to default
  82                                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
  83
  84                                 // Mark this filter as loaded (from database)
  85                                 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
  86
  87                                 // Set this filter
  88                                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
  89
  90                                 // Is the array element for counter there?
  91                                 if (isset($filterArray['filter_counter'])) {
  92                                         // Then use this value!
  93                                         $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
  94                                 } // END - if
  95                         } // END - while
  96                 } // END - if
  97
  98                 // Free result
  99                 SQL_FREERESULT($result);
 100         }
 101
 102         // Init filters
 103         registerFilter('init', 'LOAD_CONFIGURATION');
 104         registerFilter('init', 'INIT_RANDOMIZER');
 105         registerFilter('init', 'LOAD_RUNTIME_INCLUDES');
 106         registerFilter('init', 'INIT_EXTENSIONS');
 107         registerFilter('init', 'SET_CURRENT_DATE');
 108         registerFilter('init', 'INIT_RANDOM_NUMBER');
 109         registerFilter('init', 'CHECK_REPOSITORY_REVISION');
 110         registerFilter('init', 'RUN_HOURLY_RESET');
 111         registerFilter('init', 'RUN_DAILY_RESET');
 112         registerFilter('init', 'TRIGGER_SENDING_POOL');
 113         registerFilter('init', 'DETERMINE_USERNAME');
 114         registerFilter('init', 'DETERMINE_WHAT_ACTION');
 115         registerFilter('init', 'COUNT_MODULE');
 116         registerFilter('init', 'UPDATE_LOGIN_DATA');
 117         registerFilter('init', 'ACTIVATE_EXCHANGE');
 118
 119         // Page headers - pre-filter (normally, you want to register here)
 120         registerFilter('pre_page_header', 'LOAD_PAGE_HEADER');
 121
 122         // Page headers - post-filter (normally, you don't want to register here)
 123         // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
 124         registerFilter('post_page_header', 'FINISH_PAGE_HEADER');
 125         // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
 126
 127         // 'You are here' navigation - post filter
 128         registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 129
 130         // Filters for pre-extension-registration
 131         registerFilter('pre_extension_installed', 'RUN_SQLS');
 132
 133         // Filters for post-extension-registration
 134         registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
 135         registerFilter('post_extension_installed', 'SOLVE_TASK');
 136         registerFilter('post_extension_installed', 'LOAD_INCLUDES');
 137         registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 138         registerFilter('post_extension_installed', 'EXTENSION_MARK_INSTALLED');
 139
 140         // Solving tasks
 141         registerFilter('solve_task', 'SOLVE_TASK');
 142
 143         // Loading includes in general
 144         registerFilter('load_includes', 'LOAD_INCLUDES');
 145
 146         // Run SQLs
 147         registerFilter('run_sqls', 'RUN_SQLS');
 148
 149         // Admin ACL check
 150         registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 151
 152         // Register shutdown filters
 153         registerFilter('shutdown', 'FLUSH_FILTERS');
 154         registerFilter('shutdown', 'FLUSH_STATS');
 155         registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
 156         registerFilter('shutdown', 'FLUSH_OUTPUT');
 157
 158         // Compiling code
 159         registerFilter('compile_code', 'COMPILE_CONFIG');
 160         registerFilter('compile_code', 'COMPILE_EXPRESSION_CODE');
 161
 162         // Generic extension update filters
 163         registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
 164
 165         // Do hourly reset stuff, keep this entry first in this chain:
 166         registerFilter('hourly', 'RUN_HOURLY_INCLUDES');
 167
 168         // Do reset stuff, keep this entry first in this chain:
 169         registerFilter('reset', 'RUN_RESET_INCLUDES');
 170
 171         // Remove extension
 172         registerFilter('extension_remove', 'REMOVE_EXTENSION');
 173
 174         // Exclude some users
 175         registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
 176
 177         // Handling of fatal errors
 178         registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
 179
 180         // Page footer filters
 181         registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
 182         registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
 183         registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
 184
 185         // Member login check. Always keep FETCH_USER_DATA as first entry!
 186         registerFilter('member_login_check', 'FETCH_USER_DATA');
 187
 188         // Admin login
 189         registerFilter('do_admin_login_done', 'DO_LOGIN_ADMIN');
 190 }
 191
 192 // "Registers" a new filter function
 193 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
 194         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - ENTERED!');
 195
 196         // Extend the filter function name
 197         $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 198
 199         // Is that filter already there?
 200         if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 201                 // In installation phase we always want to abort
 202                 if (($silentAbort === false) || (isInstallationPhase())) {
 203                         // Add fatal message
 204                         debug_report_bug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
 205                 } // END - if
 206
 207                 // Abort here
 208                 return false;
 209         } // END - if
 210
 211         // Shall we add it?
 212         if ($dry_run === false) {
 213                 // Is the function there?
 214                 if (!function_exists($filterFunction)) {
 215                         // Then abort here
 216                         addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s.", $filterFunction, $filterName));
 217                         return false;
 218                 } // END - if
 219
 220                 // Simply add it to the array
 221                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
 222                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
 223                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
 224         } // END - if
 225
 226         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - EXIT!');
 227 }
 228
 229 // "Unregisters" a filter from the given chain
 230 function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $dry_run = false) {
 231         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
 232
 233         // Extend the filter function name only if not loaded from database
 234         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
 235                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 236         } // END - if
 237
 238         // Is that filter there?
 239         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 240                 // Not found, so abort here
 241                 addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
 242                 return false;
 243         } // END - if
 244
 245         // Shall we remove? (default, not while just showing an extension removal)
 246         if ($dry_run === false) {
 247                 // Mark for filter removal
 248                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
 249                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
 250         } // END - if
 251
 252         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - EXIT!');
 253 }
 254
 255 // "Runs" the given filters, filterData is optional and can be any type of data
 256 function runFilterChain ($filterName, $filterData = null) {
 257         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
 258
 259         // Is that filter chain there?
 260         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
 261                 // Log not found filters in debug-mode
 262                 if (isDebugModeEnabled()) {
 263                         // Log it away...
 264                         logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found.');
 265                 } // END - if
 266
 267                 // Abort here and return content
 268                 return $filterData;
 269         } // END - if
 270
 271         // Default return value
 272         $returnValue = $filterData;
 273
 274         // Then run all filters
 275         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
 276                 // Debug message
 277                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
 278
 279                 // Is the filter active or newly added??
 280                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
 281                         // Is this filter there?
 282                         if (!function_exists($filterFunction)) {
 283                                 // Unregister it
 284                                 unregisterFilter(__FUNCTION__, __LINE__, $filterName, $filterFunction);
 285
 286                                 // Skip this entry
 287                                 continue;
 288                         } // END - if
 289
 290                         // Call the filter chain
 291                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
 292                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
 293
 294                         // Update usage counter
 295                         countFilterUsage($filterName, $filterFunction);
 296                 } elseif (isDebugModeEnabled()) {
 297                         // Debug message
 298                         logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
 299                 }
 300         } // END - foreach
 301
 302         // Return the filtered content
 303         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
 304         return $returnValue;
 305 }
 306
 307 // Count the filter usage
 308 function countFilterUsage ($filterName, $filterFunction) {
 309         // Is it there?
 310         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
 311                 // Yes, then increase
 312                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
 313         } else {
 314                 // No, then create
 315                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
 316         }
 317 }
 318
 319 // Prepares the filter array for usage
 320 function prepareFilterArray () {
 321         // Abort here if array is absend (e.g. not cached)
 322         if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
 323                 // Abort silently
 324                 return false;
 325         } // END - if
 326
 327         // Init dummy array
 328         $filterArray = array(
 329                 'chains'  => array(),
 330                 'loaded'  => array(),
 331                 'counter' => array()
 332         );
 333
 334         // Found in cache so rewrite the array
 335         foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
 336                 // Get filter function
 337                 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
 338
 339                 // Add the element with mapped index
 340                 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
 341                 $filterArray['loaded'][$filterName][$filterFunction]  = true;
 342                 $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
 343         } // END - foreach
 344
 345         // Remove the cache
 346         $GLOBALS['cache_array']['filter'] = $filterArray;
 347 }
 348
 349 // Loads filter for given extension if present. This function will silently
 350 // ignore absent filter files.
 351 function loadExtensionFilters ($ext_name) {
 352         // Do we have cache entry?
 353         if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
 354                 // Default is not found
 355                 $GLOBALS[__FUNCTION__][$ext_name] = false;
 356
 357                 // Construct include file name
 358                 $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
 359
 360                 // Is the include file readable?
 361                 if (isIncludeReadable($incFileName)) {
 362                         // Load the include file
 363                         loadIncludeOnce($incFileName);
 364
 365                         // Mark the file as loaded
 366                         $GLOBALS[__FUNCTION__][$ext_name] = true;
 367                 } elseif (isDebugModeEnabled()) {
 368                         // Log missing file
 369                         logDebugMessage(__FUNCTION__, __LINE__, 'Include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
 370                 }
 371         } // END - if
 372 }
 373
 374 // [EOF]
 375 ?>