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', '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 registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME');
118 registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
119 registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
120 registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
121 registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
123 // Page headers - pre-filter (normally, you want to register here)
124 registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
126 // Page headers - post-filter (normally, you don't want to register here)
127 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
128 registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
129 //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
131 // 'You are here' navigation - post filter
132 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
133 registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
135 // Filters for pre-extension-registration
136 registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
138 // Filters for post-extension-registration
139 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
140 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
141 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
142 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
143 registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
146 registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
148 // Loading includes in general
149 registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
152 registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
155 registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
157 // Register shutdown filters
158 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
159 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
160 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
161 registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
164 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
165 registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
167 // Generic extension update filters
168 registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
170 // Do hourly reset stuff, keep this entry first in this chain:
171 registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
173 // Do reset stuff, keep this entry first in this chain:
174 registerFilter(__FUNCTION__, __LINE__, 'reset', 'RUN_RESET_INCLUDES');
177 registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
179 // Exclude some users
180 registerFilter(__FUNCTION__, __LINE__, 'exclude_users', 'HTML_INCLUDE_USERS');
182 // Handling of fatal errors
183 registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
185 // Page footer filters
186 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
187 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
188 registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
190 // Member login check. Always keep FETCH_USER_DATA as first entry!
191 registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
194 registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
197 registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
200 // "Registers" a new filter function
201 function registerFilter ($F, $L, $filterName, $filterFunction, $silentAbort = true, $force = false, $isDryRun = false) {
202 // Extend the filter function name
203 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
205 // Debug message with FILTER_ prefix
206 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - ENTERED!');
208 // Is that filter already there?
209 if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
210 // In installation phase we always want to abort
211 if (($silentAbort === false) || (isInstallationPhase())) {
213 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)));
221 if ($isDryRun === false) {
222 // Is the function there?
223 if (!function_exists($filterFunction)) {
225 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)));
229 // Simply add it to the array
230 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L);
231 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
232 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
235 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',F=' . basename($F) . ',L=' . $L . ' - EXIT!');
238 // "Unregisters" a filter from the given chain
239 function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $isDryRun = false) {
240 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
242 // Extend the filter function name only if not loaded from database
243 if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
244 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
247 // Is that filter there?
248 if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
249 // Not found, so abort here
250 addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
254 // Shall we remove? (default, not while just showing an extension removal)
255 if ($isDryRun === false) {
256 // Mark for filter removal
257 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
258 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
261 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
264 // "Runs" the given filters, filterData is optional and can be any type of data
265 function runFilterChain ($filterName, $filterData = NULL) {
266 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
268 // Is that filter chain there?
269 if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
270 // Log not found filters in debug-mode
271 if (isDebugModeEnabled()) {
273 logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
276 // Abort here and return content
280 // Default return value
281 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
282 $returnValue = $filterData;
284 // Then run all filters
285 foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
287 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
289 // Is the filter active or newly added??
290 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
291 // Is this filter there?
292 if (!function_exists($filterFunction)) {
294 reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - AUTO-UNREGISTERED!');
297 // Call the filter chain
298 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
299 $returnValue = call_user_func_array($filterFunction, array($returnValue));
301 // Update usage counter
302 countFilterUsage($filterName, $filterFunction);
303 } elseif (isDebugModeEnabled()) {
305 logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
309 // Return the filtered content
310 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
314 // Count the filter usage
315 function countFilterUsage ($filterName, $filterFunction) {
317 if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
318 // Yes, then increase
319 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
322 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
326 // Prepares the filter array for usage
327 function prepareFilterArray () {
328 // Abort here if array is absend (e.g. not cached)
329 if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
335 $filterArray = array(
341 // Found in cache so rewrite the array
342 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
343 // Get filter function
344 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
346 // Add the element with mapped index
347 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
348 $filterArray['loaded'][$filterName][$filterFunction] = true;
349 $filterArray['chains'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
353 $GLOBALS['cache_array']['filter'] = $filterArray;
357 * Loads filter for given extension if present. This function will silently
358 * ignore absent filter files.
360 * @param $ext_name Name of extension
363 function loadExtensionFilters ($ext_name) {
365 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
367 // Do we have cache entry?
368 if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
369 // Default is not found
370 $GLOBALS[__FUNCTION__][$ext_name] = false;
372 // Construct include file name
373 $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
375 // Is the include file readable?
376 if (isIncludeReadable($incFileName)) {
377 // Load the include file
378 loadIncludeOnce($incFileName);
380 // Mark the file as loaded
381 $GLOBALS[__FUNCTION__][$ext_name] = true;
382 } elseif (isDebugModeEnabled()) {
384 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
389 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');