c8e74588e557eda94cd2b8fa00c2b1af6c793def
[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  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
14  * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
15  * For more information visit: http://mxchange.org                      *
16  *                                                                      *
17  * This program is free software; you can redistribute it and/or modify *
18  * it under the terms of the GNU General Public License as published by *
19  * the Free Software Foundation; either version 2 of the License, or    *
20  * (at your option) any later version.                                  *
21  *                                                                      *
22  * This program is distributed in the hope that it will be useful,      *
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
25  * GNU General Public License for more details.                         *
26  *                                                                      *
27  * You should have received a copy of the GNU General Public License    *
28  * along with this program; if not, write to the Free Software          *
29  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
30  * MA  02110-1301  USA                                                  *
31  ************************************************************************/
32
33 // Some security stuff...
34 if (!defined('__SECURITY')) {
35         die();
36 } // END - if
37
38 // Init "generic filter system"
39 function initFilterSystem () {
40         // Is the filter already initialized?
41         if (isset($GLOBALS['filter_init'])) {
42                 // Then abort here
43                 reportBug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
44         } // END - if
45
46         // Load all saved filers if ext-sql_patches is updated
47         if ((isset($GLOBALS['cache_array']['filter']['filter_name'])) && (!isset($GLOBALS['cache_array']['filter']['chains']))) {
48                 // Prepare filter array
49                 prepareFilterArray();
50
51                 // Mark it as initialized
52                 $GLOBALS['filter_init'] = TRUE;
53         } elseif ((!isInstaller()) && (isExtensionInstalledAndNewer('sql_patches', '0.5.9'))) {
54                 // Init add
55                 $add = '';
56                 if (isExtensionINstalledAndNewer('sql_patches', '0.6.0')) {
57                         $add = ',`filter_counter`';
58                 } // END - if
59
60                 // Load all filters
61                 $result = sqlQuery('SELECT
62         `filter_name`,
63         `filter_function`,
64         `filter_active`
65         ' . $add . '
66 FROM
67         `{?_MYSQL_PREFIX?}_filters`
68 ORDER BY
69         `filter_id` ASC', __FUNCTION__, __LINE__);
70
71                 // Are there entries?
72                 if (!ifSqlHasZeroNums($result)) {
73                         // Load all filters
74                         while ($filterArray = sqlFetchArray($result)) {
75                                 // Get filter name and function
76                                 $filterName     = $filterArray['filter_name'];
77                                 $filterFunction = $filterArray['filter_function'];
78
79                                 // Set counter to default
80                                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
81
82                                 // Mark this filter as loaded (from database)
83                                 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = TRUE;
84
85                                 // Set this filter
86                                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
87
88                                 // Is the array element for counter there?
89                                 if (isset($filterArray['filter_counter'])) {
90                                         // Then use this value!
91                                         $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
92                                 } // END - if
93                         } // END - while
94                 } // END - if
95
96                 // Free result
97                 sqlFreeResult($result);
98         }
99
100         // Init filters
101         registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_CONFIGURATION');
102         registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOMIZER');
103         registerFilter(__FUNCTION__, __LINE__, 'init', 'LOAD_RUNTIME_INCLUDES');
104         registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_EXTENSIONS');
105         registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_SESSION');
106         registerFilter(__FUNCTION__, __LINE__, 'init', 'SET_CURRENT_DATE');
107         registerFilter(__FUNCTION__, __LINE__, 'init', 'INIT_RANDOM_NUMBER');
108         registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_HOURLY_RESET');
109         registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_DAILY_RESET');
110         registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_WEEKLY_RESET');
111         registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_MONTHLY_RESET');
112         registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_YEARLY_RESET');
113         registerFilter(__FUNCTION__, __LINE__, 'init', 'TRIGGER_SENDING_POOL');
114         // @TODO Remove this forced removal after a year or so
115         unregisterFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME', TRUE);
116         registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
117         registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
118         registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
119         registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
120         registerFilter(__FUNCTION__, __LINE__, 'init', 'REDIRECT_WRONG_SERVER_NAME');
121
122         // Post-initialization
123         registerFilter(__FUNCTION__, __LINE__, 'post_init', 'DETERMINE_USERNAME');
124
125         // Page headers - pre-filter (normally, you want to register here)
126         registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
127
128         // Page headers - post-filter (normally, you don't want to register here)
129         //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
130         registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
131         //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
132
133         // 'You are here' navigation - post filter
134         registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
135         registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
136
137         // Filters for pre-extension-registration
138         registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
139
140         // Filters for post-extension-registration
141         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
142         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
143         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
144         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
145         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
146
147         // Solving tasks
148         registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
149
150         // Loading includes in general
151         registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
152
153         // Run SQLs
154         registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
155
156         // Admin ACL check
157         registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
158
159         // Register shutdown filters
160         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
161         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
162         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
163         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
164
165         // Compiling code
166         registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
167         registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
168
169         // Generic extension update filters
170         registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
171
172         // Do hourly reset stuff, keep this entry first in this chain:
173         registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
174
175         // Do daily stuff, keep this entry first in this chain:
176         registerFilter(__FUNCTION__, __LINE__, 'daily', 'RUN_DAILY_INCLUDES');
177
178         // Do weekly stuff, keep this entry first in this chain:
179         registerFilter(__FUNCTION__, __LINE__, 'weekly', 'RUN_WEEKLY_INCLUDES');
180
181         // Do monthly stuff, keep this entry first in this chain:
182         registerFilter(__FUNCTION__, __LINE__, 'monthly', 'RUN_MONTHLY_INCLUDES');
183
184         // Do yearly stuff, keep this entry first in this chain:
185         registerFilter(__FUNCTION__, __LINE__, 'yearly', 'RUN_YEARLY_INCLUDES');
186
187         // Remove extension
188         registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
189
190         // Handling of fatal errors
191         registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
192
193         // Page footer filters
194         registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
195         registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
196         registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
197
198         // Member login check. Always keep FETCH_USER_DATA as first entry!
199         registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
200
201         // Admin login
202         registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
203
204         // Admin mail links
205         registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
206
207         // Build mails
208         registerFilter(__FUNCTION__, __LINE__, 'send_build_mail', 'SEND_BUILD_MAIL');
209
210         // Handle referral banner click/view
211         registerFilter(__FUNCTION__, __LINE__, 'handle_click_php', 'HANDLE_REFERRER_BANNER_CLICK');
212         registerFilter(__FUNCTION__, __LINE__, 'handle_view_php', 'HANDLE_REFERRER_BANNER_VIEW');
213
214         // Generic filter to add hidden fields to formulars
215         registerFilter(__FUNCTION__, __LINE__, 'open_form_fields', 'ADD_INPUT_HIDDEN_SESSION_ID');
216 }
217
218 // "Registers" a new filter function
219 function registerFilter ($file, $line, $filterName, $filterFunction, $silentAbort = TRUE, $force = FALSE, $isDryRun = FALSE) {
220         // Extend the filter function name
221         $filterFunction = 'FILTER_' . strtoupper($filterFunction);
222
223         // Debug message with FILTER_ prefix
224         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - ENTERED!');
225
226         // Is that filter already there?
227         if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
228                 // In installation phase we always want to abort
229                 if (($silentAbort === FALSE) || (isInstaller())) {
230                         // Add fatal message
231                         reportBug(__FUNCTION__, __LINE__, sprintf('Filter chain %s has already filter function %s registered! file=%s,L=%s,force=%d', $filterName, $filterFunction, basename($file), $line, intval($force)));
232                 } // END - if
233
234                 // Abort here
235                 return FALSE;
236         } // END - if
237
238         // Shall we add it?
239         if ($isDryRun === FALSE) {
240                 // Is the function there?
241                 if (!function_exists($filterFunction)) {
242                         // Then abort here
243                         logDebugMessage(__FUNCTION__, __LINE__, sprintf('Filter function %s could not be added to filter chain %s. file=%s,L=%s,force=%d', $filterFunction, $filterName, basename($file), $line, intval($force)));
244                         return FALSE;
245                 } // END - if
246
247                 // Simply add it to the array
248                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',file=' . basename($file) . ',line=' . $line);
249                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
250                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
251         } // END - if
252
253         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - EXIT!');
254
255         // Worked
256         return TRUE;
257 }
258
259 // "Unregisters" a filter from the given chain
260 function unregisterFilter ($file, $line, $filterName, $filterFunction, $force = FALSE, $isDryRun = FALSE) {
261         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
262
263         // Extend the filter function name only if not loaded from database
264         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
265                 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
266         } // END - if
267
268         // Is that filter there?
269         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
270                 // Not found, so abort here
271                 logDebugMessage(__FUNCTION__, __LINE__, sprintf('Filter function %s cannot be unregistered from filter %s.', $filterFunction, $filterName));
272                 return FALSE;
273         } // END - if
274
275         // Shall we remove? (default, not while just showing an extension removal)
276         if (($isDryRun === FALSE) && (isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction]))) {
277                 // Mark for filter removal
278                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
279                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
280         } // END - if
281
282         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
283
284         // Worked
285         return TRUE;
286 }
287
288 // "Runs" the given filters, filterData is optional and can be any type of data
289 function runFilterChain ($filterName, $filterData = NULL) {
290         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
291
292         // Is that filter chain there?
293         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
294                 // Log not found filters in debug-mode
295                 if (isDebugModeEnabled()) {
296                         // Log it away...
297                         logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
298                 } // END - if
299
300                 // Abort here and return content
301                 return $filterData;
302         } // END - if
303
304         // Default return value
305         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
306         $returnValue = $filterData;
307
308         // Continue filter chain is default
309         continueFilterChain();
310
311         // Then run all filters
312         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
313                 // Debug message
314                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
315
316                 // Is the filter active or newly added??
317                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
318                         // Is this filter there?
319                         if (!function_exists($filterFunction)) {
320                                 // Should be fixed
321                                 reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',active=' . $active . ' - AUTO-UNREGISTERED!');
322                         } // END - if
323
324                         // Call the filter chain
325                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue) . ' - CALLING!');
326                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
327
328                         // Update usage counter
329                         countFilterUsage($filterName, $filterFunction);
330                 } elseif (isDebugModeEnabled()) {
331                         // Debug message
332                         logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
333                 }
334
335                 // Abort loop?
336                 if (isFilterChainAborted()) {
337                         // Yes, then abort here
338                         break;
339                 } // END - if
340         } // END - foreach
341
342         // Return the filtered content
343         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
344         return $returnValue;
345 }
346
347 // Count the filter usage
348 function countFilterUsage ($filterName, $filterFunction) {
349         // Is it there?
350         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
351                 // Yes, then increase
352                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
353         } else {
354                 // No, then create
355                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
356         }
357 }
358
359 // Prepares the filter array for usage
360 function prepareFilterArray () {
361         //¬†Abort here if array is absend (e.g. not cached)
362         if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
363                 // Abort silently
364                 return FALSE;
365         } // END - if
366
367         // Init dummy array
368         $filterArray = array(
369                 'chains'  => array(),
370                 'loaded'  => array(),
371                 'counter' => array()
372         );
373
374         // Found in cache so rewrite the array
375         foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
376                 // Get filter function
377                 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
378
379                 // Add the element with mapped index
380                 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
381                 $filterArray['loaded'][$filterName][$filterFunction]  = TRUE;
382                 $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
383         } // END - foreach
384
385         // Remove the cache
386         $GLOBALS['cache_array']['filter'] = $filterArray;
387 }
388
389 /**
390  * Loads filter for given extension if present. This function will silently
391  * ignore absent filter files.
392  *
393  * @param       $ext_name       Name of extension
394  * @return      void
395  */
396 function loadExtensionFilters ($ext_name) {
397         // Debug message
398         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
399
400         // Is there a cache entry?
401         if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
402                 // Default is not found
403                 $GLOBALS[__FUNCTION__][$ext_name] = FALSE;
404
405                 // Construct include file name
406                 $incFileName = sprintf('inc/filter/%s_filter.php', $ext_name);
407
408                 // Is the include file readable?
409                 if (isIncludeReadable($incFileName)) {
410                         // Load the include file
411                         loadIncludeOnce($incFileName);
412
413                         // Mark the file as loaded
414                         $GLOBALS[__FUNCTION__][$ext_name] = TRUE;
415                 } elseif (isDebugModeEnabled()) {
416                         // Log missing file
417                         //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
418                 }
419         } // END - if
420
421         // Debug message
422         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
423 }
424
425 // Checks whether the filter chain has been aborted
426 function isFilterChainAborted () {
427         // Determine it
428         return ((isset($GLOBALS['filter_chain_interrupted'])) && ($GLOBALS['filter_chain_interrupted'] === TRUE));
429 }
430
431 // Interrupts the filter chain by enabling flag 'filter_chain_aborted'
432 function interruptFilterChain () {
433         // Set it
434         $GLOBALS['filter_chain_interrupted'] = TRUE;
435 }
436
437 // Continues the filter chain by disabling flag 'filter_chain_aborted'
438 function continueFilterChain () {
439         // Set it
440         $GLOBALS['filter_chain_interrupted'] = FALSE;
441 }
442
443 // [EOF]
444 ?>