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  * Needs to be in all Files and every File needs "svn propset           *
  18  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  19  * -------------------------------------------------------------------- *
  20  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  21  * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  22  * For more information visit: http://www.mxchange.org                  *
  23  *                                                                      *
  24  * This program is free software; you can redistribute it and/or modify *
  25  * it under the terms of the GNU General Public License as published by *
  26  * the Free Software Foundation; either version 2 of the License, or    *
  27  * (at your option) any later version.                                  *
  28  *                                                                      *
  29  * This program is distributed in the hope that it will be useful,      *
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  32  * GNU General Public License for more details.                         *
  33  *                                                                      *
  34  * You should have received a copy of the GNU General Public License    *
  35  * along with this program; if not, write to the Free Software          *
  36  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  37  * MA  02110-1301  USA                                                  *
  38  ************************************************************************/
  39
  40 // Some security stuff...
  41 if (!defined('__SECURITY')) {
  42         die();
  43 } // END - if
  44
  45 // Init "generic filter system"
  46 function initFilterSystem () {
  47         // Is the filter already initialized?
  48         if (isset($GLOBALS['filter_init'])) {
  49                 // Then abort here
  50                 debug_report_bug('Filter system already initialized.');
  51         } // END - if
  52
  53         // Load all saved filers if sql_patches is updated
  54         if ((isset($GLOBALS['cache_array']['filter']['filter_name'])) && (!isset($GLOBALS['cache_array']['filter']['chains']))) {
  55                 // Prepare filter array
  56                 prepareFilterArray();
  57
  58                 // Mark it as initialized
  59                 $GLOBALS['filter_init'] = true;
  60         } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
  61                 // Init add
  62                 $add = '';
  63                 if (getExtensionVersion('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
  64
  65                 // Load all active filers
  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_NUMROWS($result) > 0) {
  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', 'INIT_RANDOM_NUMBER');
 108         registerFilter('init', 'CHECK_SVN_REVISION');
 109         registerFilter('init', 'RUN_DAILY_RESET');
 110         registerFilter('init', 'TRIGGER_SENDING_POOL');
 111         registerFilter('init', 'DETERMINE_USERNAME');
 112         registerFilter('init', 'DETERMINE_WHAT_ACTION');
 113         registerFilter('init', 'COUNT_MODULE');
 114         registerFilter('init', 'UPDATE_LOGIN_DATA');
 115         registerFilter('init', 'ACTIVATE_EXCHANGE');
 116
 117         // Page headers - pre-filter (normally, you want to register here)
 118         registerFilter('pre_page_header', 'LOAD_PAGE_HEADER');
 119
 120         // Page headers - post-filter (normally, you don't want to register here)
 121         // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
 122         registerFilter('post_page_header', 'FINISH_PAGE_HEADER');
 123         // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
 124
 125         // Login failures handler
 126         registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 127
 128         // Filters for pre-extension-registration
 129         registerFilter('pre_extension_installed', 'RUN_SQLS');
 130
 131         // Filters for post-extension-registration
 132         registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
 133         registerFilter('post_extension_installed', 'SOLVE_TASK');
 134         registerFilter('post_extension_installed', 'LOAD_INCLUDES');
 135         registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 136
 137         // Solving tasks
 138         registerFilter('solve_task', 'SOLVE_TASK');
 139
 140         // Loading includes in general
 141         registerFilter('load_includes', 'LOAD_INCLUDES');
 142
 143         // Run SQLs
 144         registerFilter('run_sqls', 'RUN_SQLS');
 145
 146         // Admin ACL check
 147         registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 148
 149         // Register shutdown filters
 150         registerFilter('shutdown', 'FLUSH_FILTERS');
 151         registerFilter('shutdown', 'FLUSH_STATS');
 152         registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
 153         registerFilter('shutdown', 'FLUSH_OUTPUT');
 154
 155         // Compiling code
 156         registerFilter('compile_code', 'COMPILE_CONFIG');
 157         registerFilter('compile_code', 'COMPILE_EXPRESSION_CODE');
 158
 159         // Generic extension update filters
 160         registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
 161
 162         // Do reset stuff, keep this entry first in this chain:
 163         registerFilter('reset', 'RUN_RESET_INCLUDES');
 164
 165         // Remove extension
 166         registerFilter('extension_remove', 'REMOVE_EXTENSION');
 167
 168         // Exclude some users
 169         registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
 170
 171         // Handling of fatal errors
 172         registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
 173
 174         // Page footer filters
 175         registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
 176         registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
 177         registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
 178
 179         // Member login check. Always keep FETCH_USER_DATA as first entry!
 180         registerFilter('member_login_check', 'FETCH_USER_DATA');
 181
 182         // Admin login
 183         registerFilter('do_admin_login_done', 'DO_LOGIN_ADMIN');
 184 }
 185
 186 // "Registers" a new filter function
 187 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
 188         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
 189
 190         // Extend the filter function name
 191         $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 192
 193         // Is that filter already there?
 194         if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 195                 // Then abort here
 196                 if ($silentAbort === false) {
 197                         // Add fatal message
 198                         addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
 199                 } // END - if
 200
 201                 // Abort here
 202                 return false;
 203         } // END - if
 204
 205         // Shall we add it?
 206         if ($dry_run === false) {
 207                 // Is the function there?
 208                 if (!function_exists($filterFunction)) {
 209                         // Then abort here
 210                         addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s.", $filterFunction, $filterName));
 211                         return false;
 212                 } // END - if
 213
 214                 // Simply add it to the array
 215                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
 216                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
 217                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
 218         } // END - if
 219 }
 220
 221 // "Unregisters" a filter from the given chain
 222 function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
 223         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run));
 224
 225         // Extend the filter function name only if not loaded from database
 226         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
 227                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 228         } // END - if
 229
 230         // Is that filter there?
 231         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 232                 // Not found, so abort here
 233                 addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
 234                 return false;
 235         } // END - if
 236
 237         // Shall we remove? (default, not while just showing an extension removal)
 238         if ($dry_run === false) {
 239                 // Mark for filter removal
 240                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
 241                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
 242         } // END - if
 243 }
 244
 245 // "Runs" the given filters, data is optional and can be any type of data
 246 function runFilterChain ($filterName, $data = null) {
 247         // Is that filter chain there?
 248         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
 249                 // Log not found filters in debug-mode
 250                 if (isDebugModeEnabled()) {
 251                         // Log it away...
 252                         logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
 253                 } // END - if
 254
 255                 // Abort here and return content
 256                 return $data;
 257         } // END - if
 258
 259         // Default return value
 260         $returnValue = $data;
 261
 262         // Then run all filters
 263         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
 264                 // Debug message
 265                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
 266
 267                 // Is the filter active?
 268                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
 269                         // Is this filter there?
 270                         if (!function_exists($filterFunction)) {
 271                                 // Unregister it
 272                                 unregisterFilter($filterName, $filterFunction);
 273
 274                                 // Skip this entry
 275                                 continue;
 276                         } // END - if
 277
 278                         // Call the filter chain
 279                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName.'/'.$filterFunction.',[]='.gettype($returnValue));
 280                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
 281
 282                         // Update usage counter
 283                         countFilterUsage($filterName, $filterFunction);
 284                 } elseif (isDebugModeEnabled()) {
 285                         // Debug message
 286                         logDebugMessage(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
 287                 }
 288         } // END - foreach
 289
 290         // Return the filtered content
 291         return $returnValue;
 292 }
 293
 294 // Count the filter usage
 295 function countFilterUsage ($filterName, $filterFunction) {
 296         // Is it there?
 297         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
 298                 // Yes, then increase
 299                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
 300         } else {
 301                 // No, then create
 302                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
 303         }
 304 }
 305
 306 // Prepares the filter array for usage
 307 function prepareFilterArray () {
 308         // Abort here if array is absend (e.g. not cached)
 309         if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
 310                 // Abort silently
 311                 return false;
 312         } // END - if
 313
 314         // Init dummy array
 315         $filterArray = array(
 316                 'chains'  => array(),
 317                 'loaded'  => array(),
 318                 'counter' => array()
 319         );
 320
 321         // Found in cache so rewrite the array
 322         foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
 323                 // Get filter function
 324                 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
 325
 326                 // Add the element with mapped index
 327                 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
 328                 $filterArray['loaded'][$filterName][$filterFunction]  = true;
 329                 $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
 330         } // END - foreach
 331
 332         // Remove the cache
 333         $GLOBALS['cache_array']['filter'] = $filterArray;
 334 }
 335
 336 // [EOF]
 337 ?>