www is out-dated
[mailer.git] / inc / filter-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 10/27/2009 *
4  * ===================                          Last change: 10/27/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : filter-functions.php                             *
8  * -------------------------------------------------------------------- *
9  * Short description : Functions for filter system                      *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Funktionen fuer Filter-System                    *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://mxchange.org                      *
21  *                                                                      *
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.                                  *
26  *                                                                      *
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.                         *
31  *                                                                      *
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,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Init "generic filter system"
44 function initFilterSystem () {
45         // Is the filter already initialized?
46         if (isset($GLOBALS['filter_init'])) {
47                 // Then abort here
48                 debug_report_bug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
49         } // END - if
50
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
54                 prepareFilterArray();
55
56                 // Mark it as initialized
57                 $GLOBALS['filter_init'] = true;
58         } elseif ((!isInstallationPhase()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
59                 // Init add
60                 $add = '';
61                 if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
62                         $add = ", `filter_counter`";
63                 } // END - if
64
65                 // Load all filters
66                 $result = SQL_QUERY('SELECT
67         `filter_name`,`filter_function`,`filter_active`' . $add . '
68 FROM
69         `{?_MYSQL_PREFIX?}_filters`
70 ORDER BY
71         `filter_id` ASC', __FUNCTION__, __LINE__);
72
73                 // Are there entries?
74                 if (!SQL_HASZERONUMS($result)) {
75                         // Load all filters
76                         while ($filterArray = SQL_FETCHARRAY($result)) {
77                                 // Get filter name and function
78                                 $filterName     = $filterArray['filter_name'];
79                                 $filterFunction = $filterArray['filter_function'];
80
81                                 // Set counter to default
82                                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
83
84                                 // Mark this filter as loaded (from database)
85                                 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = true;
86
87                                 // Set this filter
88                                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
89
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'];
94                                 } // END - if
95                         } // END - while
96                 } // END - if
97
98                 // Free result
99                 SQL_FREERESULT($result);
100         }
101
102         // Init filters
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_REPOSITORY_REVISION');
110         registerFilter('init', 'RUN_HOURLY_RESET');
111         registerFilter('init', 'RUN_DAILY_RESET');
112         registerFilter('init', 'TRIGGER_SENDING_POOL');
113         registerFilter('init', 'DETERMINE_USERNAME');
114         registerFilter('init', 'DETERMINE_WHAT_ACTION');
115         registerFilter('init', 'COUNT_MODULE');
116         registerFilter('init', 'UPDATE_LOGIN_DATA');
117         registerFilter('init', 'ACTIVATE_EXCHANGE');
118
119         // Page headers - pre-filter (normally, you want to register here)
120         registerFilter('pre_page_header', 'LOAD_PAGE_HEADER');
121
122         // Page headers - post-filter (normally, you don't want to register here)
123         //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
124         registerFilter('post_page_header', 'FINISH_PAGE_HEADER');
125         //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
126
127         // 'You are here' navigation - post filter
128         registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
129         registerFilter('post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
130
131         // Filters for pre-extension-registration
132         registerFilter('pre_extension_installed', 'RUN_SQLS');
133
134         // Filters for post-extension-registration
135         registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
136         registerFilter('post_extension_installed', 'SOLVE_TASK');
137         registerFilter('post_extension_installed', 'LOAD_INCLUDES');
138         registerFilter('post_extension_installed', 'REMOVE_UPDATES');
139         registerFilter('post_extension_installed', 'EXTENSION_MARK_INSTALLED');
140
141         // Solving tasks
142         registerFilter('solve_task', 'SOLVE_TASK');
143
144         // Loading includes in general
145         registerFilter('load_includes', 'LOAD_INCLUDES');
146
147         // Run SQLs
148         registerFilter('run_sqls', 'RUN_SQLS');
149
150         // Admin ACL check
151         registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
152
153         // Register shutdown filters
154         registerFilter('shutdown', 'FLUSH_FILTERS');
155         registerFilter('shutdown', 'FLUSH_STATS');
156         registerFilter('shutdown', 'FLUSH_TEMPLATE_CACHE');
157         registerFilter('shutdown', 'FLUSH_OUTPUT');
158
159         // Compiling code
160         registerFilter('compile_code', 'COMPILE_CONFIG');
161         registerFilter('compile_code', 'COMPILE_EXPRESSION_CODE');
162
163         // Generic extension update filters
164         registerFilter('extension_update', 'UPDATE_EXTENSION_DATA');
165
166         // Do hourly reset stuff, keep this entry first in this chain:
167         registerFilter('hourly', 'RUN_HOURLY_INCLUDES');
168
169         // Do reset stuff, keep this entry first in this chain:
170         registerFilter('reset', 'RUN_RESET_INCLUDES');
171
172         // Remove extension
173         registerFilter('extension_remove', 'REMOVE_EXTENSION');
174
175         // Exclude some users
176         registerFilter('exclude_users', 'HTML_INCLUDE_USERS');
177
178         // Handling of fatal errors
179         registerFilter('handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
180
181         // Page footer filters
182         registerFilter('page_footer', 'HANDLE_FATAL_ERRORS');
183         registerFilter('page_footer', 'DISPLAY_COPYRIGHT');
184         registerFilter('page_footer', 'DISPLAY_PARSING_TIME');
185
186         // Member login check. Always keep FETCH_USER_DATA as first entry!
187         registerFilter('member_login_check', 'FETCH_USER_DATA');
188
189         // Admin login
190         registerFilter('do_admin_login_done', 'DO_LOGIN_ADMIN');
191
192         // Admin mail links
193         registerFilter('generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
194 }
195
196 // "Registers" a new filter function
197 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
198         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - ENTERED!');
199
200         // Extend the filter function name
201         $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
202
203         // Is that filter already there?
204         if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
205                 // In installation phase we always want to abort
206                 if (($silentAbort === false) || (isInstallationPhase())) {
207                         // Add fatal message
208                         debug_report_bug(__FUNCTION__, __LINE__, sprintf("Filter chain %s has already filter function %s registered!", $filterName, $filterFunction));
209                 } // END - if
210
211                 // Abort here
212                 return false;
213         } // END - if
214
215         // Shall we add it?
216         if ($dry_run === false) {
217                 // Is the function there?
218                 if (!function_exists($filterFunction)) {
219                         // Then abort here
220                         addFatalMessage(__FUNCTION__, __LINE__, sprintf("Filter function %s could not be added to filter chain %s.", $filterFunction, $filterName));
221                         return false;
222                 } // END - if
223
224                 // Simply add it to the array
225                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction);
226                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
227                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
228         } elseif (($silentAbort === false) && (!function_exists($filterFunction))) {
229                 // Please report them all!
230                 debug_report_bug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',silentAbort=false,force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - NOT FOUND!');
231         }
232
233         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - EXIT!');
234 }
235
236 // "Unregisters" a filter from the given chain
237 function unregisterFilter ($F, $L, $filterName, $filterFunction, $force = false, $dry_run = false) {
238         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
239
240         // Extend the filter function name only if not loaded from database
241         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
242                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
243         } // END - if
244
245         // Is that filter there?
246         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === false)) {
247                 // Not found, so abort here
248                 addFatalMessage(__FUNCTION__, __LINE__, sprintf(getMessage('FILTER_FAILED_NOT_REMOVED'), $filterFunction, $filterName));
249                 return false;
250         } // END - if
251
252         // Shall we remove? (default, not while just showing an extension removal)
253         if ($dry_run === false) {
254                 // Mark for filter removal
255                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
256                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
257         } // END - if
258
259         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . $F . ',L=' . $L . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',dry_run=' . intval($dry_run) . ' - EXIT!');
260 }
261
262 // "Runs" the given filters, filterData is optional and can be any type of data
263 function runFilterChain ($filterName, $filterData = NULL) {
264         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
265
266         // Is that filter chain there?
267         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
268                 // Log not found filters in debug-mode
269                 if (isDebugModeEnabled()) {
270                         // Log it away...
271                         logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' not found.');
272                 } // END - if
273
274                 // Abort here and return content
275                 return $filterData;
276         } // END - if
277
278         // Default return value
279         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
280         $returnValue = $filterData;
281
282         // Then run all filters
283         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
284                 // Debug message
285                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
286
287                 // Is the filter active or newly added??
288                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown','extension_remove','post_extension_run_sql'))) && ($active == 'R'))) {
289                         // Is this filter there?
290                         if (!function_exists($filterFunction)) {
291                                 // Unregister it
292                                 unregisterFilter(__FUNCTION__, __LINE__, $filterName, $filterFunction);
293
294                                 // Skip this entry
295                                 continue;
296                         } // END - if
297
298                         // Call the filter chain
299                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue));
300                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
301
302                         // Update usage counter
303                         countFilterUsage($filterName, $filterFunction);
304                 } elseif (isDebugModeEnabled()) {
305                         // Debug message
306                         logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
307                 }
308         } // END - foreach
309
310         // Return the filtered content
311         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
312         return $returnValue;
313 }
314
315 // Count the filter usage
316 function countFilterUsage ($filterName, $filterFunction) {
317         // Is it there?
318         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
319                 // Yes, then increase
320                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
321         } else {
322                 // No, then create
323                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
324         }
325 }
326
327 // Prepares the filter array for usage
328 function prepareFilterArray () {
329         //¬†Abort here if array is absend (e.g. not cached)
330         if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
331                 // Abort silently
332                 return false;
333         } // END - if
334
335         // Init dummy array
336         $filterArray = array(
337                 'chains'  => array(),
338                 'loaded'  => array(),
339                 'counter' => array()
340         );
341
342         // Found in cache so rewrite the array
343         foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
344                 // Get filter function
345                 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
346
347                 // Add the element with mapped index
348                 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
349                 $filterArray['loaded'][$filterName][$filterFunction]  = true;
350                 $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
351         } // END - foreach
352
353         // Remove the cache
354         $GLOBALS['cache_array']['filter'] = $filterArray;
355 }
356
357 // Loads filter for given extension if present. This function will silently
358 // ignore absent filter files.
359 function loadExtensionFilters ($ext_name) {
360         // Do we have cache entry?
361         if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
362                 // Default is not found
363                 $GLOBALS[__FUNCTION__][$ext_name] = false;
364
365                 // Construct include file name
366                 $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
367
368                 // Is the include file readable?
369                 if (isIncludeReadable($incFileName)) {
370                         // Load the include file
371                         loadIncludeOnce($incFileName);
372
373                         // Mark the file as loaded
374                         $GLOBALS[__FUNCTION__][$ext_name] = true;
375                 } elseif (isDebugModeEnabled()) {
376                         // Log missing file
377                         logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
378                 }
379         } // END - if
380 }
381
382 // [EOF]
383 ?>