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 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', 'SET_CURRENT_DATE');
111 registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOM_NUMBER');
112 registerFilter(__FUNCTION__, __LINE__, 'init', 'CHECK_REPOSITORY_REVISION');
113 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_HOURLY_RESET');
114 registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_DAILY_RESET');
115 registerFilter(__FUNCTION__, __LINE__, 'init', 'TRIGGER_SENDING_POOL');
116 registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME');
117 registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
118 registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
119 registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
120 registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
122 // Page headers - pre-filter (normally, you want to register here)
123 registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
125 // Page headers - post-filter (normally, you don't want to register here)
126 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
127 registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
128 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
130 // 'You are here' navigation - post filter
131 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
132 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
134 // Filters for pre-extension-registration
135 registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
137 // Filters for post-extension-registration
138 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
139 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
140 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
141 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
142 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
145 registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
147 // Loading includes in general
148 registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
151 registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
154 registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
156 // Register shutdown filters
157 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
158 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
159 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
160 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
163 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
164 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
166 // Generic extension update filters
167 registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
169 // Do hourly reset stuff, keep this entry first in this chain:
170 registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
172 // Do reset stuff, keep this entry first in this chain:
173 registerFilter(__FUNCTION__, __LINE__, 'reset', 'RUN_RESET_INCLUDES');
176 registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
178 // Exclude some users
179 registerFilter(__FUNCTION__, __LINE__, 'exclude_users', 'HTML_INCLUDE_USERS');
181 // Handling of fatal errors
182 registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
184 // Page footer filters
185 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
186 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
187 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
189 // Member login check. Always keep FETCH_USER_DATA as first entry!
190 registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
193 registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
196 registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
199 // "Registers" a new filter function
200 function registerFilter ($F, $L, $filterName, $filterFunction, $silentAbort = true, $force = false, $isDryRun = false) {
201 // Extend the filter function name
202 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
204 // Debug message with FILTER_ prefix
205 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - ENTERED!');
207 // Is that filter already there?
208 if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
209 // In installation phase we always want to abort
210 if (($silentAbort === false) || (isInstallationPhase())) {
212 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)));
220 if ($isDryRun === false) {
221 // Is the function there?
222 if (!function_exists($filterFunction)) {
224 addFatalMessage(__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)));
228 // Simply add it to the array
229 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L);
230 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
231 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
234 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - EXIT!');
237 // "Unregisters" a filter from the given chain
238 function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $isDryRun = false) {
239 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
241 // Extend the filter function name only if not loaded from database
242 if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
243 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
246 // Is that filter there?
247 if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
248 // Not found, so abort here
249 addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
253 // Shall we remove? (default, not while just showing an extension removal)
254 if ($isDryRun === false) {
255 // Mark for filter removal
256 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
257 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
260 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
263 // "Runs" the given filters, filterData is optional and can be any type of data
264 function runFilterChain ($filterName, $filterData = NULL) {
265 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
267 // Is that filter chain there?
268 if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
269 // Log not found filters in debug-mode
270 if (isDebugModeEnabled()) {
272 logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
275 // Abort here and return content
279 // Default return value
280 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
281 $returnValue = $filterData;
283 // Then run all filters
284 foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
286 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
288 // Is the filter active or newly added??
289 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
290 // Is this filter there?
291 if (!function_exists($filterFunction)) {
293 reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - AUTO-UNREGISTERED!');
296 // Call the filter chain
297 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
298 $returnValue = call_user_func_array($filterFunction, array($returnValue));
300 // Update usage counter
301 countFilterUsage($filterName, $filterFunction);
302 } elseif (isDebugModeEnabled()) {
304 logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
308 // Return the filtered content
309 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
313 // Count the filter usage
314 function countFilterUsage ($filterName, $filterFunction) {
316 if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
317 // Yes, then increase
318 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
321 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
325 // Prepares the filter array for usage
326 function prepareFilterArray () {
327 // Abort here if array is absend (e.g. not cached)
328 if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
334 $filterArray = array(
340 // Found in cache so rewrite the array
341 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
342 // Get filter function
343 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
345 // Add the element with mapped index
346 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
347 $filterArray['loaded'][$filterName][$filterFunction] = true;
348 $filterArray['chains'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
352 $GLOBALS['cache_array']['filter'] = $filterArray;
355 // Loads filter for given extension if present. This function will silently
356 // ignore absent filter files.
357 function loadExtensionFilters ($ext_name) {
358 // Do we have cache entry?
359 if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
360 // Default is not found
361 $GLOBALS[__FUNCTION__][$ext_name] = false;
363 // Construct include file name
364 $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
366 // Is the include file readable?
367 if (isIncludeReadable($incFileName)) {
368 // Load the include file
369 loadIncludeOnce($incFileName);
371 // Mark the file as loaded
372 $GLOBALS[__FUNCTION__][$ext_name] = true;
373 } elseif (isDebugModeEnabled()) {
375 logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');