inc/filter-functions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    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:: 1185                                                   $ *
  14  * $Date:: 2009-10-11 04:16:39 +0200 (Sun, 11 Oct 2009)               $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author:: quix0r                                                   $ *
  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  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  23  * This program is free software; you can redistribute it and/or modify *
  24  * it under the terms of the GNU General Public License as published by *
  25  * the Free Software Foundation; either version 2 of the License, or    *
  26  * (at your option) any later version.                                  *
  27  *                                                                      *
  28  * This program is distributed in the hope that it will be useful,      *
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  31  * GNU General Public License for more details.                         *
  32  *                                                                      *
  33  * You should have received a copy of the GNU General Public License    *
  34  * along with this program; if not, write to the Free Software          *
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38
  39 // Some security stuff...
  40 if (!defined('__SECURITY')) {
  41         die();
  42 } // END - if
  43
  44 // Init "generic filter system"
  45 function initFilterSystem () {
  46         // Is the filter already initialized?
  47         if (isset($GLOBALS['filter_init'])) {
  48                 // Then abort here
  49                 debug_report_bug('Filter system already initialized.');
  50         } // END - if
  51
  52         // Load all saved filers if sql_patches is updated
  53         if (isset($GLOBALS['cache_array']['filter']['filter_name'])) {
  54                 // Init dummy array
  55                 $filterArray = array(
  56                         'chains'  => array(),
  57                         'loaded'  => array(),
  58                         'counter' => array()
  59                 );
  60
  61                 // Found in cache so rewrite the array
  62                 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
  63                         // Get filter function
  64                         $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
  65
  66                         // Add the element with mapped index
  67                         $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
  68                         $filterArray['loaded'][$filterName][$filterFunction]  = true;
  69                         $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
  70                 } // END - foreach
  71
  72                 // Mark it as initialized
  73                 $GLOBALS['filter_init'] = true;
  74
  75                 // Remove the cache
  76                 $GLOBALS['cache_array']['filter'] = $filterArray;
  77         } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
  78                 // Init add
  79                 $add = '';
  80                 if (getExtensionVersion('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
  81
  82                 // Load all active filers
  83                 $result = SQL_QUERY("SELECT
  84         `filter_name`,`filter_function`,`filter_active`".$add."
  85 FROM
  86         `{?_MYSQL_PREFIX?}_filters`
  87 ORDER BY
  88         `filter_id` ASC", __FUNCTION__, __LINE__);
  89
  90                 // Are there entries?
  91                 if (SQL_NUMROWS($result) > 0) {
  92                         // Load all filters
  93                         while ($filterArray = SQL_FETCHARRAY($result)) {
  94                                 // Get filter name and function
  95                                 $filterName     = $filterArray['filter_name'];
  96                                 $filterFunction = $filterArray['filter_function'];
  97
  98                                 // Set counter to default
  99                                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 0;
 100
 101                                 // Mark this filter as loaded (from database)
 102                                 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
 103
 104                                 // Set this filter
 105                                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
 106
 107                                 // Is the array element for counter there?
 108                                 if (isset($filterArray['filter_counter'])) {
 109                                         // Then use this value!
 110                                         $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
 111                                 } // END - if
 112                         } // END - while
 113                 } // END - if
 114
 115                 // Free result
 116                 SQL_FREERESULT($result);
 117         }
 118
 119         // Init filters
 120         registerFilter('init', 'LOAD_CONFIGURATION');
 121         registerFilter('init', 'INIT_EXTENSIONS');
 122         registerFilter('init', 'INIT_RANDOMIZER');
 123         registerFilter('init', 'LOAD_RUNTIME_INCLUDES');
 124         registerFilter('init', 'INIT_RANDOM_NUMBER');
 125         registerFilter('init', 'CHECK_SVN_REVISION');
 126         registerFilter('init', 'RUN_DAILY_RESET');
 127         registerFilter('init', 'TRIGGER_SENDING_POOL');
 128         registerFilter('init', 'DETERMINE_USERNAME');
 129         registerFilter('init', 'DETERMINE_WHAT_ACTION');
 130         registerFilter('init', 'COUNT_MODULE');
 131         registerFilter('init', 'UPDATE_LOGIN_DATA');
 132         registerFilter('init', 'ACTIVATE_EXCHANGE');
 133
 134         // Login failures handler
 135         registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 136
 137         // Filters for pre-extension-registration
 138         registerFilter('pre_extension_installed', 'RUN_SQLS');
 139
 140         // Filters for post-extension-registration
 141         registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
 142         registerFilter('post_extension_installed', 'SOLVE_TASK');
 143         registerFilter('post_extension_installed', 'LOAD_INCLUDES');
 144         registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 145
 146         // Solving tasks
 147         registerFilter('solve_task', 'SOLVE_TASK');
 148
 149         // Loading includes in general
 150         registerFilter('load_includes', 'LOAD_INCLUDES');
 151
 152         // Run SQLs
 153         registerFilter('run_sqls', 'RUN_SQLS');
 154
 155         // Admin ACL check
 156         registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 157
 158         // Register shutdown filters
 159         registerFilter('shutdown', 'FLUSH_FILTERS');
 160         registerFilter('shutdown', 'FLUSH_STATS');
 161         registerFilter('shutdown', 'FLUSH_OUTPUT');
 162
 163         // Compiling code
 164         registerFilter('compile_code', 'COMPILE_CONFIG');
 165         registerFilter('compile_code', 'COMPILE_EXTENSION');
 166
 167         // Generic extension update filters
 168         registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
 169
 170         // Do reset stuff, keep this entry first in this chain:
 171         registerFilter('reset', 'RUN_RESET_INCLUDES');
 172
 173         // Remove extension
 174         registerFilter('extension_remove', 'REMOVE_EXTENSION');
 175
 176         // Exclude some users
 177         registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
 178
 179         // Handling of fatal errors
 180         registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
 181
 182         // Page footer filters
 183         registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
 184         registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
 185         registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
 186 }
 187
 188 // "Registers" a new filter function
 189 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
 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: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
 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         // Extend the filter function name only if not loaded from database
 224         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
 225                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 226         } // END - if
 227
 228         // Is that filter there?
 229         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 230                 // Not found, so abort here
 231                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
 232                 return false;
 233         } // END - if
 234
 235         // Shall we remove? (default, not while just showing an extension removal)
 236         if ($dry_run === false) {
 237                 // Mark for filter removal
 238                 //* DEBUG: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
 239                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
 240         } // END - if
 241 }
 242
 243 // "Runs" the given filters, data is optional and can be any type of data
 244 function runFilterChain ($filterName, $data = null) {
 245         // Is that filter chain there?
 246         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
 247                 // We should find all these non-existing filter chains
 248                 //* Only for tracking: */ if ($filterName != 'sql_admin_extra_data') {
 249                 //* Only for tracking: */ debug_report_bug('Filter chain <strong>' . $filterName . '</strong> not found!');
 250                 //* Only for tracking: */ }
 251                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
 252
 253                 // Abort here and return content
 254                 return $data;
 255         } // END - if
 256
 257         // Default return value
 258         $returnValue = $data;
 259
 260         // Then run all filters
 261         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
 262                 // Debug message
 263                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
 264
 265                 // Is the filter active?
 266                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
 267                         // Is this filter there?
 268                         if (!function_exists($filterFunction)) {
 269                                 // Unregister it
 270                                 unregisterFilter($filterName, $filterFunction);
 271
 272                                 // Skip this entry
 273                                 continue;
 274                         } // END - if
 275
 276                         // Call the filter chain
 277                         //* DEBUG: */ print $filterName.'/'.$filterFunction.',[]='.gettype($returnValue).'<br />';
 278                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
 279
 280                         // Update usage counter
 281                         countFilterUsage($filterName, $filterFunction);
 282                 } elseif (isDebugModeEnabled()) {
 283                         // Debug message
 284                         logDebugMessage(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
 285                 }
 286         } // END - foreach
 287
 288         // Return the filtered content
 289         return $returnValue;
 290 }
 291
 292 // Count the filter usage
 293 function countFilterUsage ($filterName, $filterFunction) {
 294         // Is it there?
 295         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
 296                 // Yes, then increase
 297                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
 298         } else {
 299                 // No, then create
 300                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
 301         }
 302 }
 303
 304 // [EOF]
 305 ?>