2 /************************************************************************
3 * Mailer v0.2.1-FINAL 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 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2013 by Mailer Developer Team *
20 * For more information visit: http://mxchange.org *
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. *
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. *
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, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
43 // Init "generic filter system"
44 function initFilterSystem () {
45 // Is the filter already initialized?
46 if (isset($GLOBALS['filter_init'])) {
48 reportBug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
51 // Load all saved filers if ext-sql_patches is updated
52 if ((isset($GLOBALS['cache_array']['filter']['filter_name'])) && (!isset($GLOBALS['cache_array']['filter']['chains']))) {
53 // Prepare filter array
56 // Mark it as initialized
57 $GLOBALS['filter_init'] = TRUE;
58 } elseif ((!isInstaller()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
61 if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
62 $add = ',`filter_counter`';
66 $result = sqlQuery('SELECT
72 `{?_MYSQL_PREFIX?}_filters`
74 `filter_id` ASC', __FUNCTION__, __LINE__);
77 if (!ifSqlHasZeroNums($result)) {
79 while ($filterArray = sqlFetchArray($result)) {
80 // Get filter name and function
81 $filterName = $filterArray['filter_name'];
82 $filterFunction = $filterArray['filter_function'];
84 // Set counter to default
85 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
87 // Mark this filter as loaded (from database)
88 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = TRUE;
91 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
93 // Is the array element for counter there?
94 if (isset($filterArray['filter_counter'])) {
95 // Then use this value!
96 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
102 sqlFreeResult($result);
106 registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_CONFIGURATION');
107 registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOMIZER');
108 registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_RUNTIME_INCLUDES');
109 registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_EXTENSIONS');
110 registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_SESSION');
111 registerFilter(__FUNCTION__, __LINE__, 'init', 'SET_CURRENT_DATE');
112 registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOM_NUMBER');
113 registerFilter(__FUNCTION__, __LINE__, 'init', 'CHECK_REPOSITORY_REVISION');
114 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_HOURLY_RESET');
115 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_DAILY_RESET');
116 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_WEEKLY_RESET');
117 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_MONTHLY_RESET');
118 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_YEARLY_RESET');
119 registerFilter(__FUNCTION__, __LINE__, 'init', 'TRIGGER_SENDING_POOL');
120 // @TODO Remove this forced removal after a year or so
121 unregisterFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME', TRUE);
122 registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
123 registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
124 registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
125 registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
126 registerFilter(__FUNCTION__, __LINE__, 'init', 'REDIRECT_WRONG_SERVER_NAME');
128 // Post-initialization
129 registerFilter(__FUNCTION__, __LINE__, 'post_init', 'DETERMINE_USERNAME');
131 // Page headers - pre-filter (normally, you want to register here)
132 registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
134 // Page headers - post-filter (normally, you don't want to register here)
135 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
136 registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
137 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
139 // 'You are here' navigation - post filter
140 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
141 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
143 // Filters for pre-extension-registration
144 registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
146 // Filters for post-extension-registration
147 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
148 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
149 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
150 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
151 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
154 registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
156 // Loading includes in general
157 registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
160 registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
163 registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
165 // Register shutdown filters
166 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
167 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
168 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
169 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
172 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
173 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
175 // Generic extension update filters
176 registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
178 // Do hourly reset stuff, keep this entry first in this chain:
179 registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
181 // Do daily stuff, keep this entry first in this chain:
182 registerFilter(__FUNCTION__, __LINE__, 'daily', 'RUN_DAILY_INCLUDES');
184 // Do weekly stuff, keep this entry first in this chain:
185 registerFilter(__FUNCTION__, __LINE__, 'weekly', 'RUN_WEEKLY_INCLUDES');
187 // Do monthly stuff, keep this entry first in this chain:
188 registerFilter(__FUNCTION__, __LINE__, 'monthly', 'RUN_MONTHLY_INCLUDES');
190 // Do yearly stuff, keep this entry first in this chain:
191 registerFilter(__FUNCTION__, __LINE__, 'yearly', 'RUN_YEARLY_INCLUDES');
194 registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
196 // Exclude some users
197 registerFilter(__FUNCTION__, __LINE__, 'exclude_users', 'HTML_INCLUDE_USERS');
199 // Handling of fatal errors
200 registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
202 // Page footer filters
203 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
204 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
205 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
207 // Member login check. Always keep FETCH_USER_DATA as first entry!
208 registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
211 registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
214 registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
217 registerFilter(__FUNCTION__, __LINE__, 'send_build_mail', 'SEND_BUILD_MAIL');
219 // Handle referral banner click/view
220 registerFilter(__FUNCTION__, __LINE__, 'handle_click_php', 'HANDLE_REFERRER_BANNER_CLICK');
221 registerFilter(__FUNCTION__, __LINE__, 'handle_view_php', 'HANDLE_REFERRER_BANNER_VIEW');
223 // Generic filter to add hidden fields to formulars
224 registerFilter(__FUNCTION__, __LINE__, 'open_form_fields', 'ADD_INPUT_HIDDEN_SESSION_ID');
227 // "Registers" a new filter function
228 function registerFilter ($file, $line, $filterName, $filterFunction, $silentAbort = TRUE, $force = FALSE, $isDryRun = FALSE) {
229 // Extend the filter function name
230 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
232 // Debug message with FILTER_ prefix
233 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - ENTERED!');
235 // Is that filter already there?
236 if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
237 // In installation phase we always want to abort
238 if (($silentAbort === FALSE) || (isInstaller())) {
240 reportBug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered! file=%s,L=%s,force=%d", $filterName, $filterFunction, basename($file), $line, intval($force)));
248 if ($isDryRun === FALSE) {
249 // Is the function there?
250 if (!function_exists($filterFunction)) {
252 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s. file=%s,L=%s,force=%d", $filterFunction, $filterName, basename($file), $line, intval($force)));
256 // Simply add it to the array
257 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',file=' . basename($file) . ',line=' . $line);
258 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
259 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
262 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - EXIT!');
268 // "Unregisters" a filter from the given chain
269 function unregisterFilter ($file, $line, $filterName, $filterFunction, $force = FALSE, $isDryRun = FALSE) {
270 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
272 // Extend the filter function name only if not loaded from database
273 if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
274 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
277 // Is that filter there?
278 if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
279 // Not found, so abort here
280 logDebugMessage(__FUNCTION__, __LINE__, sprintf('Filter function %s cannot be unregistered from filter %s.', $filterFunction, $filterName));
284 // Shall we remove? (default, not while just showing an extension removal)
285 if (($isDryRun === FALSE) && (isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction]))) {
286 // Mark for filter removal
287 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
288 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
291 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
297 // "Runs" the given filters, filterData is optional and can be any type of data
298 function runFilterChain ($filterName, $filterData = NULL) {
299 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
301 // Is that filter chain there?
302 if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
303 // Log not found filters in debug-mode
304 if (isDebugModeEnabled()) {
306 logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
309 // Abort here and return content
313 // Default return value
314 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
315 $returnValue = $filterData;
317 // Remove any existing flag(s)
318 unset($GLOBALS['filter_chain_aborted']);
320 // Then run all filters
321 foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
323 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
325 // Is the filter active or newly added??
326 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
327 // Is this filter there?
328 if (!function_exists($filterFunction)) {
330 reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',active=' . $active . ' - AUTO-UNREGISTERED!');
333 // Call the filter chain
334 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue) . ' - CALLING!');
335 $returnValue = call_user_func_array($filterFunction, array($returnValue));
337 // Update usage counter
338 countFilterUsage($filterName, $filterFunction);
339 } elseif (isDebugModeEnabled()) {
341 logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
345 if (isFilterChainAborted()) {
346 // Yes, then abort here
351 // Return the filtered content
352 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
356 // Count the filter usage
357 function countFilterUsage ($filterName, $filterFunction) {
359 if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
360 // Yes, then increase
361 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
364 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
368 // Prepares the filter array for usage
369 function prepareFilterArray () {
370 // Abort here if array is absend (e.g. not cached)
371 if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
377 $filterArray = array(
383 // Found in cache so rewrite the array
384 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
385 // Get filter function
386 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
388 // Add the element with mapped index
389 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
390 $filterArray['loaded'][$filterName][$filterFunction] = TRUE;
391 $filterArray['chains'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
395 $GLOBALS['cache_array']['filter'] = $filterArray;
399 * Loads filter for given extension if present. This function will silently
400 * ignore absent filter files.
402 * @param $ext_name Name of extension
405 function loadExtensionFilters ($ext_name) {
407 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
409 // Is there a cache entry?
410 if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
411 // Default is not found
412 $GLOBALS[__FUNCTION__][$ext_name] = FALSE;
414 // Construct include file name
415 $incFileName = sprintf('inc/filter/%s_filter.php', $ext_name);
417 // Is the include file readable?
418 if (isIncludeReadable($incFileName)) {
419 // Load the include file
420 loadIncludeOnce($incFileName);
422 // Mark the file as loaded
423 $GLOBALS[__FUNCTION__][$ext_name] = TRUE;
424 } elseif (isDebugModeEnabled()) {
426 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
431 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
434 // Checks whether the filter chain has been aborted
435 function isFilterChainAborted () {
437 return ((isset($GLOBALS['filter_chain_aborted'])) && ($GLOBALS['filter_chain_aborted'] === TRUE));