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 * 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 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // Init "generic filter system"
46 function initFilterSystem () {
47 // Is the filter already initialized?
48 if (isset($GLOBALS['filter_init'])) {
50 debug_report_bug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
53 // Load all saved filers if sql_patches is updated
54 if ((isset($GLOBALS['cache_array']['filter']['filter_name'])) && (!isset($GLOBALS['cache_array']['filter']['chains']))) {
55 // Prepare filter array
58 // Mark it as initialized
59 $GLOBALS['filter_init'] = true;
60 } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
63 if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) $add = ", `filter_counter`";
66 $result = SQL_QUERY('SELECT
67 `filter_name`,`filter_function`,`filter_active`' . $add . '
69 `{?_MYSQL_PREFIX?}_filters`
71 `filter_id` ASC', __FUNCTION__, __LINE__);
74 if (!SQL_HASZERONUMS($result)) {
76 while ($filterArray = SQL_FETCHARRAY($result)) {
77 // Get filter name and function
78 $filterName = $filterArray['filter_name'];
79 $filterFunction = $filterArray['filter_function'];
81 // Set counter to default
82 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
84 // Mark this filter as loaded (from database)
85 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
88 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
90 // Is the array element for counter there?
91 if (isset($filterArray['filter_counter'])) {
92 // Then use this value!
93 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
99 SQL_FREERESULT($result);
103 registerFilter('init', 'LOAD_CONFIGURATION');
104 registerFilter('init', 'INIT_RANDOMIZER');
105 registerFilter('init', 'LOAD_RUNTIME_INCLUDES');
106 registerFilter('init', 'INIT_EXTENSIONS');
107 registerFilter('init', 'SET_CURRENT_DATE');
108 registerFilter('init', 'INIT_RANDOM_NUMBER');
109 registerFilter('init', 'CHECK_SVN_REVISION');
110 registerFilter('init', 'RUN_DAILY_RESET');
111 registerFilter('init', 'TRIGGER_SENDING_POOL');
112 registerFilter('init', 'DETERMINE_USERNAME');
113 registerFilter('init', 'DETERMINE_WHAT_ACTION');
114 registerFilter('init', 'COUNT_MODULE');
115 registerFilter('init', 'UPDATE_LOGIN_DATA');
116 registerFilter('init', 'ACTIVATE_EXCHANGE');
118 // Page headers - pre-filter (normally, you want to register here)
119 registerFilter('pre_page_header', 'LOAD_PAGE_HEADER');
121 // Page headers - post-filter (normally, you don't want to register here)
122 // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
123 registerFilter('post_page_header', 'FINISH_PAGE_HEADER');
124 // ------------------- LAST FILTER FOR THIS CHAIN! ------------------------
126 // 'You are here' navigation - post filter
127 registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
129 // Filters for pre-extension-registration
130 registerFilter('pre_extension_installed', 'RUN_SQLS');
132 // Filters for post-extension-registration
133 registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
134 registerFilter('post_extension_installed', 'SOLVE_TASK');
135 registerFilter('post_extension_installed', 'LOAD_INCLUDES');
136 registerFilter('post_extension_installed', 'REMOVE_UPDATES');
139 registerFilter('solve_task', 'SOLVE_TASK');
141 // Loading includes in general
142 registerFilter('load_includes', 'LOAD_INCLUDES');
145 registerFilter('run_sqls', 'RUN_SQLS');
148 registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
150 // Register shutdown filters
151 registerFilter('shutdown', 'FLUSH_FILTERS');
152 registerFilter('shutdown', 'FLUSH_STATS');
153 registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
154 registerFilter('shutdown', 'FLUSH_OUTPUT');
157 registerFilter('compile_code', 'COMPILE_CONFIG');
158 registerFilter('compile_code', 'COMPILE_EXPRESSION_CODE');
160 // Generic extension update filters
161 registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
163 // Do reset stuff, keep this entry first in this chain:
164 registerFilter('reset', 'RUN_RESET_INCLUDES');
167 registerFilter('extension_remove', 'REMOVE_EXTENSION');
169 // Exclude some users
170 registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
172 // Handling of fatal errors
173 registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
175 // Page footer filters
176 registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
177 registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
178 registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
180 // Member login check. Always keep FETCH_USER_DATA as first entry!
181 registerFilter('member_login_check', 'FETCH_USER_DATA');
184 registerFilter('do_admin_login_done', 'DO_LOGIN_ADMIN');
187 // "Registers" a new filter function
188 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
189 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - ENTERED!');
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)) {
196 // In installation phase we always want to abort
197 if (($silentAbort === false) || (isInstallationPhase())) {
199 debug_report_bug(__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: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
217 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
218 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
221 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - EXIT!');
224 // "Unregisters" a filter from the given chain
225 function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $dry_run = false) {
226 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - ENTERED!');
228 // Extend the filter function name only if not loaded from database
229 if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
230 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
233 // Is that filter there?
234 if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
235 // Not found, so abort here
236 addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
240 // Shall we remove? (default, not while just showing an extension removal)
241 if ($dry_run === false) {
242 // Mark for filter removal
243 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction);
244 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
247 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry=' . intval($dry_run) . ' - EXIT!');
250 // "Runs" the given filters, data is optional and can be any type of data
251 function runFilterChain ($filterName, $data = null) {
252 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',data[]=' . gettype($data) . ' - ENTERED!');
254 // Is that filter chain there?
255 if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
256 // Log not found filters in debug-mode
257 if (isDebugModeEnabled()) {
259 logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found!');
262 // Abort here and return content
266 // Default return value
267 $returnValue = $data;
269 // Then run all filters
270 foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
272 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
274 // Is the filter active or newly added??
275 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
276 // Is this filter there?
277 if (!function_exists($filterFunction)) {
279 unregisterFilter(__FUNCTION__, __LINE__, $filterName, $filterFunction);
285 // Call the filter chain
286 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
287 $returnValue = call_user_func_array($filterFunction, array($returnValue));
289 // Update usage counter
290 countFilterUsage($filterName, $filterFunction);
291 } elseif (isDebugModeEnabled()) {
293 logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
297 // Return the filtered content
298 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',data[]=' . gettype($data) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
302 // Count the filter usage
303 function countFilterUsage ($filterName, $filterFunction) {
305 if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
306 // Yes, then increase
307 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
310 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
314 // Prepares the filter array for usage
315 function prepareFilterArray () {
316 // Abort here if array is absend (e.g. not cached)
317 if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
323 $filterArray = array(
329 // Found in cache so rewrite the array
330 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
331 // Get filter function
332 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
334 // Add the element with mapped index
335 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
336 $filterArray['loaded'][$filterName][$filterFunction] = true;
337 $filterArray['chains'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
341 $GLOBALS['cache_array']['filter'] = $filterArray;