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', 'LOAD_RUNTIME_INCLUDES');
 123         registerFilter('init', 'CHECK_SVN_REVISION');
 124         registerFilter('init', 'RUN_DAILY_RESET');
 125         registerFilter('init', 'INIT_RANDOMIZER');
 126         registerFilter('init', 'TRIGGER_SENDING_POOL');
 127         registerFilter('init', 'DETERMINE_USERNAME');
 128         registerFilter('init', 'DETERMINE_WHAT_ACTION');
 129         registerFilter('init', 'UPDATE_LOGIN_DATA');
 130         registerFilter('init', 'ACTIVATE_EXCHANGE');
 131
 132         // Login failures handler
 133         registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 134
 135         // Filters for pre-extension-registration
 136         registerFilter('pre_extension_installed', 'RUN_SQLS');
 137
 138         // Filters for post-extension-registration
 139         registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
 140         registerFilter('post_extension_installed', 'SOLVE_TASK');
 141         registerFilter('post_extension_installed', 'LOAD_INCLUDES');
 142         registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 143
 144         // Solving tasks
 145         registerFilter('solve_task', 'SOLVE_TASK');
 146
 147         // Loading includes in general
 148         registerFilter('load_includes', 'LOAD_INCLUDES');
 149
 150         // Run SQLs
 151         registerFilter('run_sqls', 'RUN_SQLS');
 152
 153         // Admin ACL check
 154         registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 155
 156         // Register shutdown filters
 157         registerFilter('shutdown', 'FLUSH_FILTERS');
 158         registerFilter('shutdown', 'FLUSH_STATS');
 159         registerFilter('shutdown', 'FLUSH_OUTPUT');
 160
 161         // Compiling code
 162         registerFilter('compile_code', 'COMPILE_CONFIG');
 163         registerFilter('compile_code', 'COMPILE_EXTENSION');
 164
 165         // Generic extension update filters
 166         registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
 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
 178 // "Registers" a new filter function
 179 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
 180         // Extend the filter function name
 181         $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 182
 183         // Is that filter already there?
 184         if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 185                 // Then abort here
 186                 if ($silentAbort === false) {
 187                         // Add fatal message
 188                         addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
 189                 } // END - if
 190
 191                 // Abort here
 192                 return false;
 193         } // END - if
 194
 195         // Shall we add it?
 196         if ($dry_run === false) {
 197                 // Is the function there?
 198                 if (!function_exists($filterFunction)) {
 199                         // Then abort here
 200                         addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_404'), $filterFunction, $filterName));
 201                         return false;
 202                 } // END - if
 203
 204                 // Simply add it to the array
 205                 //* DEBUG: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
 206                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
 207                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 0;
 208         } // END - if
 209 }
 210
 211 // "Unregisters" a filter from the given chain
 212 function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
 213         // Extend the filter function name only if not loaded from database
 214         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
 215                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 216         } // END - if
 217
 218         // Is that filter there?
 219         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
 220                 // Not found, so abort here
 221                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
 222                 return false;
 223         } // END - if
 224
 225         // Shall we remove? (default, not while just showing an extension removal)
 226         if ($dry_run === false) {
 227                 // Mark for filter removal
 228                 //* DEBUG: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
 229                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
 230         } // END - if
 231 }
 232
 233 // "Runs" the given filters, data is optional and can be any type of data
 234 function runFilterChain ($filterName, $data = null) {
 235         // Is that filter chain there?
 236         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
 237                 // We should find all these non-existing filter chains
 238                 //* Only for tracking: */ if ($filterName != 'sql_admin_extra_data') {
 239                 //* Only for tracking: */ debug_report_bug('Filter chain <strong>' . $filterName . '</strong> not found!');
 240                 //* Only for tracking: */ }
 241                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
 242
 243                 // Abort here and return content
 244                 return $data;
 245         } // END - if
 246
 247         // Default return value
 248         $returnValue = $data;
 249
 250         // Then run all filters
 251         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
 252                 // Debug message
 253                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
 254
 255                 // Is the filter active?
 256                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
 257                         // Is this filter there?
 258                         if (!function_exists($filterFunction)) {
 259                                 // Unregister it
 260                                 unregisterFilter($filterName, $filterFunction);
 261
 262                                 // Skip this entry
 263                                 continue;
 264                         } // END - if
 265
 266                         // Call the filter chain
 267                         //* DEBUG: */ print $filterName.'/'.$filterFunction.',[]='.gettype($returnValue).'<br />';
 268                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
 269
 270                         // Update usage counter
 271                         countFilterUsage($filterName, $filterFunction);
 272                 } elseif (isDebugModeEnabled()) {
 273                         // Debug message
 274                         logDebugMessage(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
 275                 }
 276         } // END - foreach
 277
 278         // Return the filtered content
 279         return $returnValue;
 280 }
 281
 282 // Count the filter usage
 283 function countFilterUsage ($filterName, $filterFunction) {
 284         // Is it there?
 285         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
 286                 // Yes, then increase
 287                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
 288         } else {
 289                 // No, then create
 290                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
 291         }
 292 }
 293
 294 // [EOF]
 295 ?>