2 /************************************************************************
3 * MXChange v0.2.1 Start: 10/27/2009 *
4 * =============== Last change: 10/27/2009 *
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 *
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. *
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. *
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, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
44 // Init "generic filter system"
45 function initFilterSystem () {
46 // Is the filter already initialized?
47 if (isset($GLOBALS['filter_init'])) {
49 debug_report_bug('Filter system already initialized.');
52 // Load all saved filers if sql_patches is updated
53 if (isset($GLOBALS['cache_array']['filter']['filter_name'])) {
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];
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];
72 // Mark it as initialized
73 $GLOBALS['filter_init'] = true;
76 $GLOBALS['cache_array']['filter'] = $filterArray;
77 } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
80 if (getExtensionVersion('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
82 // Load all active filers
83 $result = SQL_QUERY("SELECT
84 `filter_name`,`filter_function`,`filter_active`".$add."
86 `{?_MYSQL_PREFIX?}_filters`
88 `filter_id` ASC", __FUNCTION__, __LINE__);
91 if (SQL_NUMROWS($result) > 0) {
93 while ($filterArray = SQL_FETCHARRAY($result)) {
94 // Get filter name and function
95 $filterName = $filterArray['filter_name'];
96 $filterFunction = $filterArray['filter_function'];
98 // Set counter to default
99 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
101 // Mark this filter as loaded (from database)
102 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
105 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
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'];
116 SQL_FREERESULT($result);
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');
134 // Login failures handler
135 registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
137 // Filters for pre-extension-registration
138 registerFilter('pre_extension_installed', 'RUN_SQLS');
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');
147 registerFilter('solve_task', 'SOLVE_TASK');
149 // Loading includes in general
150 registerFilter('load_includes', 'LOAD_INCLUDES');
153 registerFilter('run_sqls', 'RUN_SQLS');
156 registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
158 // Register shutdown filters
159 registerFilter('shutdown', 'FLUSH_FILTERS');
160 registerFilter('shutdown', 'FLUSH_STATS');
161 registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
162 registerFilter('shutdown', 'FLUSH_OUTPUT');
165 registerFilter('compile_code', 'COMPILE_CONFIG');
166 registerFilter('compile_code', 'COMPILE_EXTENSION');
168 // Generic extension update filters
169 registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
171 // Do reset stuff, keep this entry first in this chain:
172 registerFilter('reset', 'RUN_RESET_INCLUDES');
175 registerFilter('extension_remove', 'REMOVE_EXTENSION');
177 // Exclude some users
178 registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
180 // Handling of fatal errors
181 registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
183 // Page footer filters
184 registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
185 registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
186 registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
189 // "Registers" a new filter function
190 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
191 // Extend the filter function name
192 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
194 // Is that filter already there?
195 if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
197 if ($silentAbort === false) {
199 addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
207 if ($dry_run === false) {
208 // Is the function there?
209 if (!function_exists($filterFunction)) {
211 addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s.", $filterFunction, $filterName));
215 // Simply add it to the array
216 //* DEBUG: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
217 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
218 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
222 // "Unregisters" a filter from the given chain
223 function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
224 // Extend the filter function name only if not loaded from database
225 if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
226 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
229 // Is that filter there?
230 if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
231 // Not found, so abort here
232 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
236 // Shall we remove? (default, not while just showing an extension removal)
237 if ($dry_run === false) {
238 // Mark for filter removal
239 //* DEBUG: */ print __FUNCTION__.': filterName='.$filterName.',filterFunction='.$filterFunction.'<br />';
240 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
244 // "Runs" the given filters, data is optional and can be any type of data
245 function runFilterChain ($filterName, $data = null) {
246 // Is that filter chain there?
247 if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
248 // We should find all these non-existing filter chains
249 //* Only for tracking: */ if ($filterName != 'sql_admin_extra_data') {
250 //* Only for tracking: */ debug_report_bug('Filter chain <strong>' . $filterName . '</strong> not found!');
251 //* Only for tracking: */ }
252 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
254 // Abort here and return content
258 // Default return value
259 $returnValue = $data;
261 // Then run all filters
262 foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
264 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
266 // Is the filter active?
267 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
268 // Is this filter there?
269 if (!function_exists($filterFunction)) {
271 unregisterFilter($filterName, $filterFunction);
277 // Call the filter chain
278 //* DEBUG: */ print $filterName.'/'.$filterFunction.',[]='.gettype($returnValue).'<br />';
279 $returnValue = call_user_func_array($filterFunction, array($returnValue));
281 // Update usage counter
282 countFilterUsage($filterName, $filterFunction);
283 } elseif (isDebugModeEnabled()) {
285 logDebugMessage(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
289 // Return the filtered content
293 // Count the filter usage
294 function countFilterUsage ($filterName, $filterFunction) {
296 if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
297 // Yes, then increase
298 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
301 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;