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 - 2012 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 ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
61 if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
62 $add = ',`filter_counter`';
66 $result = SQL_QUERY('SELECT
72 `{?_MYSQL_PREFIX?}_filters`
74 `filter_id` ASC', __FUNCTION__, __LINE__);
77 if (!SQL_HASZERONUMS($result)) {
79 while ($filterArray = SQL_FETCHARRAY($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 SQL_FREERESULT($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', 'TRIGGER_SENDING_POOL');
117 // @TODO Remove this forced removal after a year or so
118 unregisterFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME', TRUE);
119 registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
120 registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
121 registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
122 registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
123 registerFilter(__FUNCTION__, __LINE__, 'init', 'REDIRECT_WRONG_SERVER_NAME');
125 // Post-initialization
126 registerFilter(__FUNCTION__, __LINE__, 'post_init', 'DETERMINE_USERNAME');
128 // Page headers - pre-filter (normally, you want to register here)
129 registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
131 // Page headers - post-filter (normally, you don't want to register here)
132 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
133 registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
134 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
136 // 'You are here' navigation - post filter
137 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
138 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
140 // Filters for pre-extension-registration
141 registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
143 // Filters for post-extension-registration
144 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
145 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
146 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
147 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
148 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
151 registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
153 // Loading includes in general
154 registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
157 registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
160 registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
162 // Register shutdown filters
163 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
164 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
165 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
166 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
169 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
170 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
172 // Generic extension update filters
173 registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
175 // Do hourly reset stuff, keep this entry first in this chain:
176 registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
178 // Do reset stuff, keep this entry first in this chain:
179 registerFilter(__FUNCTION__, __LINE__, 'reset', 'RUN_RESET_INCLUDES');
182 registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
184 // Exclude some users
185 registerFilter(__FUNCTION__, __LINE__, 'exclude_users', 'HTML_INCLUDE_USERS');
187 // Handling of fatal errors
188 registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
190 // Page footer filters
191 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
192 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
193 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
195 // Member login check. Always keep FETCH_USER_DATA as first entry!
196 registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
199 registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
202 registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
205 registerFilter(__FUNCTION__, __LINE__, 'send_build_mail', 'SEND_BUILD_MAIL');
207 // Handle referral banner click/view
208 registerFilter(__FUNCTION__, __LINE__, 'handle_click_php', 'HANDLE_REFERRER_BANNER_CLICK');
209 registerFilter(__FUNCTION__, __LINE__, 'handle_view_php', 'HANDLE_REFERRER_BANNER_VIEW');
211 // Generic filter to add hidden fields to formulars
212 registerFilter(__FUNCTION__, __LINE__, 'open_form_fields', 'ADD_INPUT_HIDDEN_SESSION_ID');
215 // "Registers" a new filter function
216 function registerFilter ($F, $L, $filterName, $filterFunction, $silentAbort = TRUE, $force = FALSE, $isDryRun = FALSE) {
217 // Extend the filter function name
218 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
220 // Debug message with FILTER_ prefix
221 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',F=' . basename($F) . ',L=' . $L . ' - ENTERED!');
223 // Is that filter already there?
224 if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
225 // In installation phase we always want to abort
226 if (($silentAbort === FALSE) || (isInstallationPhase())) {
228 reportBug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered! F=%s,L=%s,force=%d", $filterName, $filterFunction, basename($F), $L, intval($force)));
236 if ($isDryRun === FALSE) {
237 // Is the function there?
238 if (!function_exists($filterFunction)) {
240 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s. F=%s,L=%s,force=%d", $filterFunction, $filterName, basename($F), $L, intval($force)));
244 // Simply add it to the array
245 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L);
246 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
247 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
250 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',F=' . basename($F) . ',L=' . $L . ' - EXIT!');
256 // "Unregisters" a filter from the given chain
257 function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = FALSE, $isDryRun = FALSE) {
258 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
260 // Extend the filter function name only if not loaded from database
261 if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
262 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
265 // Is that filter there?
266 if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
267 // Not found, so abort here
268 logDebugMessage(__FUNCTION__, __LINE__, sprintf('Filter function %s cannot be unregistered from filter %s.', $filterFunction, $filterName));
272 // Shall we remove? (default, not while just showing an extension removal)
273 if (($isDryRun === FALSE) && (isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction]))) {
274 // Mark for filter removal
275 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
276 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
279 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
285 // "Runs" the given filters, filterData is optional and can be any type of data
286 function runFilterChain ($filterName, $filterData = NULL) {
287 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
289 // Is that filter chain there?
290 if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
291 // Log not found filters in debug-mode
292 if (isDebugModeEnabled()) {
294 logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
297 // Abort here and return content
301 // Default return value
302 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
303 $returnValue = $filterData;
305 // Then run all filters
306 foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
308 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
310 // Is the filter active or newly added??
311 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
312 // Is this filter there?
313 if (!function_exists($filterFunction)) {
315 reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - AUTO-UNREGISTERED!');
318 // Call the filter chain
319 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue) . ' - CALLING!');
320 $returnValue = call_user_func_array($filterFunction, array($returnValue));
322 // Update usage counter
323 countFilterUsage($filterName, $filterFunction);
324 } elseif (isDebugModeEnabled()) {
326 logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
330 // Return the filtered content
331 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
335 // Count the filter usage
336 function countFilterUsage ($filterName, $filterFunction) {
338 if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
339 // Yes, then increase
340 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
343 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
347 // Prepares the filter array for usage
348 function prepareFilterArray () {
349 // Abort here if array is absend (e.g. not cached)
350 if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
356 $filterArray = array(
362 // Found in cache so rewrite the array
363 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
364 // Get filter function
365 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
367 // Add the element with mapped index
368 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
369 $filterArray['loaded'][$filterName][$filterFunction] = TRUE;
370 $filterArray['chains'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
374 $GLOBALS['cache_array']['filter'] = $filterArray;
378 * Loads filter for given extension if present. This function will silently
379 * ignore absent filter files.
381 * @param $ext_name Name of extension
384 function loadExtensionFilters ($ext_name) {
386 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
388 // Is there a cache entry?
389 if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
390 // Default is not found
391 $GLOBALS[__FUNCTION__][$ext_name] = FALSE;
393 // Construct include file name
394 $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
396 // Is the include file readable?
397 if (isIncludeReadable($incFileName)) {
398 // Load the include file
399 loadIncludeOnce($incFileName);
401 // Mark the file as loaded
402 $GLOBALS[__FUNCTION__][$ext_name] = TRUE;
403 } elseif (isDebugModeEnabled()) {
405 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
410 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');