Renamed more:
[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 - 2013 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                 reportBug(__FUNCTION__, __LINE__, 'Filter system already initialized.');
49         } // END - if
50
51         // Load all saved filers if ext-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 = sqlQuery('SELECT
67         `filter_name`,
68         `filter_function`,
69         `filter_active`
70         ' . $add . '
71 FROM
72         `{?_MYSQL_PREFIX?}_filters`
73 ORDER BY
74         `filter_id` ASC', __FUNCTION__, __LINE__);
75
76                 // Are there entries?
77                 if (!ifSqlHasZeroNums($result)) {
78                         // Load all filters
79                         while ($filterArray = sqlFetchArray($result)) {
80                                 // Get filter name and function
81                                 $filterName     = $filterArray['filter_name'];
82                                 $filterFunction = $filterArray['filter_function'];
83
84                                 // Set counter to default
85                                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
86
87                                 // Mark this filter as loaded (from database)
88                                 $GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction] = TRUE;
89
90                                 // Set this filter
91                                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
92
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'];
97                                 } // END - if
98                         } // END - while
99                 } // END - if
100
101                 // Free result
102                 sqlFreeResult($result);
103         }
104
105         // Init filters
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', 'RUN_WEEKLY_RESET');
117         registerFilter(__FUNCTION__, __LINE__, 'init', 'RUN_MONTHLY_RESET');
118         registerFilter(__FUNCTION__, __LINE__, 'init', 'TRIGGER_SENDING_POOL');
119         // @TODO Remove this forced removal after a year or so
120         unregisterFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_USERNAME', TRUE);
121         registerFilter(__FUNCTION__, __LINE__, 'init', 'DETERMINE_WHAT_ACTION');
122         registerFilter(__FUNCTION__, __LINE__, 'init', 'COUNT_MODULE');
123         registerFilter(__FUNCTION__, __LINE__, 'init', 'UPDATE_LOGIN_DATA');
124         registerFilter(__FUNCTION__, __LINE__, 'init', 'ACTIVATE_EXCHANGE');
125         registerFilter(__FUNCTION__, __LINE__, 'init', 'REDIRECT_WRONG_SERVER_NAME');
126
127         // Post-initialization
128         registerFilter(__FUNCTION__, __LINE__, 'post_init', 'DETERMINE_USERNAME');
129
130         // Page headers - pre-filter (normally, you want to register here)
131         registerFilter(__FUNCTION__, __LINE__, 'pre_page_header', 'LOAD_PAGE_HEADER');
132
133         // Page headers - post-filter (normally, you don't want to register here)
134         //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
135         registerFilter(__FUNCTION__, __LINE__, 'post_page_header', 'FINISH_PAGE_HEADER');
136         //-------------------- LAST FILTER FOR THIS CHAIN! ------------------------
137
138         // 'You are here' navigation - post filter
139         registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
140         registerFilter(__FUNCTION__, __LINE__, 'post_youhere_line', 'HANDLE_HOME_IN_INDEX_SETTING');
141
142         // Filters for pre-extension-registration
143         registerFilter(__FUNCTION__, __LINE__, 'pre_extension_installed', 'RUN_SQLS');
144
145         // Filters for post-extension-registration
146         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
147         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'SOLVE_TASK');
148         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'LOAD_INCLUDES');
149         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'REMOVE_UPDATES');
150         registerFilter(__FUNCTION__, __LINE__, 'post_extension_installed', 'EXTENSION_MARK_INSTALLED');
151
152         // Solving tasks
153         registerFilter(__FUNCTION__, __LINE__, 'solve_task', 'SOLVE_TASK');
154
155         // Loading includes in general
156         registerFilter(__FUNCTION__, __LINE__, 'load_includes', 'LOAD_INCLUDES');
157
158         // Run SQLs
159         registerFilter(__FUNCTION__, __LINE__, 'run_sqls', 'RUN_SQLS');
160
161         // Admin ACL check
162         registerFilter(__FUNCTION__, __LINE__, 'check_admin_acl', 'CHECK_ADMIN_ACL');
163
164         // Register shutdown filters
165         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_FILTERS');
166         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_STATS');
167         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_TEMPLATE_CACHE');
168         registerFilter(__FUNCTION__, __LINE__, 'shutdown', 'FLUSH_OUTPUT');
169
170         // Compiling code
171         registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_CONFIG');
172         registerFilter(__FUNCTION__, __LINE__, 'compile_code', 'COMPILE_EXPRESSION_CODE');
173
174         // Generic extension update filters
175         registerFilter(__FUNCTION__, __LINE__, 'extension_update', 'UPDATE_EXTENSION_DATA');
176
177         // Do hourly reset stuff, keep this entry first in this chain:
178         registerFilter(__FUNCTION__, __LINE__, 'hourly', 'RUN_HOURLY_INCLUDES');
179
180         // Do daily stuff, keep this entry first in this chain:
181         registerFilter(__FUNCTION__, __LINE__, 'daily', 'RUN_DAILY_INCLUDES');
182
183         // Do weekly stuff, keep this entry first in this chain:
184         registerFilter(__FUNCTION__, __LINE__, 'weekly', 'RUN_WEEKLY_INCLUDES');
185
186         // Do monthly stuff, keep this entry first in this chain:
187         registerFilter(__FUNCTION__, __LINE__, 'monthly', 'RUN_MONTHLY_INCLUDES');
188
189         // Remove extension
190         registerFilter(__FUNCTION__, __LINE__, 'extension_remove', 'REMOVE_EXTENSION');
191
192         // Exclude some users
193         registerFilter(__FUNCTION__, __LINE__, 'exclude_users', 'HTML_INCLUDE_USERS');
194
195         // Handling of fatal errors
196         registerFilter(__FUNCTION__, __LINE__, 'handle_fatal_errors', 'HANDLE_FATAL_ERRORS');
197
198         // Page footer filters
199         registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'HANDLE_FATAL_ERRORS');
200         registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_COPYRIGHT');
201         registerFilter(__FUNCTION__, __LINE__, 'page_footer', 'DISPLAY_PARSING_TIME');
202
203         // Member login check. Always keep FETCH_USER_DATA as first entry!
204         registerFilter(__FUNCTION__, __LINE__, 'member_login_check', 'FETCH_USER_DATA');
205
206         // Admin login
207         registerFilter(__FUNCTION__, __LINE__, 'do_admin_login_done', 'DO_LOGIN_ADMIN');
208
209         // Admin mail links
210         registerFilter(__FUNCTION__, __LINE__, 'generate_admin_mail_links', 'GENERATE_POOL_MAIL_LINKS');
211
212         // Build mails
213         registerFilter(__FUNCTION__, __LINE__, 'send_build_mail', 'SEND_BUILD_MAIL');
214
215         // Handle referral banner click/view
216         registerFilter(__FUNCTION__, __LINE__, 'handle_click_php', 'HANDLE_REFERRER_BANNER_CLICK');
217         registerFilter(__FUNCTION__, __LINE__, 'handle_view_php', 'HANDLE_REFERRER_BANNER_VIEW');
218
219         // Generic filter to add hidden fields to formulars
220         registerFilter(__FUNCTION__, __LINE__, 'open_form_fields', 'ADD_INPUT_HIDDEN_SESSION_ID');
221 }
222
223 // "Registers" a new filter function
224 function registerFilter ($file, $line, $filterName, $filterFunction, $silentAbort = TRUE, $force = FALSE, $isDryRun = FALSE) {
225         // Extend the filter function name
226         $filterFunction = 'FILTER_' . strtoupper($filterFunction);
227
228         // Debug message with FILTER_ prefix
229         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - ENTERED!');
230
231         // Is that filter already there?
232         if ((isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
233                 // In installation phase we always want to abort
234                 if (($silentAbort === FALSE) || (isInstallationPhase())) {
235                         // Add fatal message
236                         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)));
237                 } // END - if
238
239                 // Abort here
240                 return FALSE;
241         } // END - if
242
243         // Shall we add it?
244         if ($isDryRun === FALSE) {
245                 // Is the function there?
246                 if (!function_exists($filterFunction)) {
247                         // Then abort here
248                         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)));
249                         return FALSE;
250                 } // END - if
251
252                 // Simply add it to the array
253                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REGISTER: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',file=' . basename($file) . ',line=' . $line);
254                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'A';
255                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = '0';
256         } // END - if
257
258         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ',file=' . basename($file) . ',line=' . $line . ' - EXIT!');
259
260         // Worked
261         return TRUE;
262 }
263
264 // "Unregisters" a filter from the given chain
265 function unregisterFilter ($file, $line, $filterName, $filterFunction, $force = FALSE, $isDryRun = FALSE) {
266         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
267
268         // Extend the filter function name only if not loaded from database
269         if (!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) {
270                 $filterFunction = 'FILTER_' . strtoupper($filterFunction);
271         } // END - if
272
273         // Is that filter there?
274         if ((!isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction])) && ($force === FALSE)) {
275                 // Not found, so abort here
276                 logDebugMessage(__FUNCTION__, __LINE__, sprintf('Filter function %s cannot be unregistered from filter %s.', $filterFunction, $filterName));
277                 return FALSE;
278         } // END - if
279
280         // Shall we remove? (default, not while just showing an extension removal)
281         if (($isDryRun === FALSE) && (isset($GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction]))) {
282                 // Mark for filter removal
283                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - REMOVE!');
284                 $GLOBALS['cache_array']['filter']['chains'][$filterName][$filterFunction] = 'R';
285         } // END - if
286
287         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . $file . ',line=' . $line . ',filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',force=' . intval($force) . ',isDryRun=' . intval($isDryRun) . ' - EXIT!');
288
289         // Worked
290         return TRUE;
291 }
292
293 // "Runs" the given filters, filterData is optional and can be any type of data
294 function runFilterChain ($filterName, $filterData = NULL) {
295         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ' - ENTERED!');
296
297         // Is that filter chain there?
298         if (!isset($GLOBALS['cache_array']['filter']['chains'][$filterName])) {
299                 // Log not found filters in debug-mode
300                 if (isDebugModeEnabled()) {
301                         // Log it away...
302                         logDebugMessage(__FUNCTION__, __LINE__, 'Filter chain ' . $filterName . ' does not exist.');
303                 } // END - if
304
305                 // Abort here and return content
306                 return $filterData;
307         } // END - if
308
309         // Default return value
310         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',count()=' . count($GLOBALS['cache_array']['filter']['chains'][$filterName]));
311         $returnValue = $filterData;
312
313         // Then run all filters
314         foreach ($GLOBALS['cache_array']['filter']['chains'][$filterName] as $filterFunction => $active) {
315                 // Debug message
316                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
317
318                 // Is the filter active or newly added??
319                 if (($active == 'Y') || ($active == 'A') || ((in_array($filterName, array('shutdown', 'extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
320                         // Is this filter there?
321                         if (!function_exists($filterFunction)) {
322                                 // Should be fixed
323                                 reportBug(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterFunction=' . $filterFunction . ' - AUTO-UNREGISTERED!');
324                         } // END - if
325
326                         // Call the filter chain
327                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $filterName . '/' . $filterFunction . ',[]=' . gettype($returnValue) . ' - CALLING!');
328                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
329
330                         // Update usage counter
331                         countFilterUsage($filterName, $filterFunction);
332                 } elseif (isDebugModeEnabled()) {
333                         // Debug message
334                         logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: name=' . $filterName . ',func=' . $filterFunction . ',active=' . $active);
335                 }
336         } // END - foreach
337
338         // Return the filtered content
339         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'filterName=' . $filterName . ',filterData[]=' . gettype($filterData) . ',returnValue[]=' . gettype($returnValue) . ' - EXIT!');
340         return $returnValue;
341 }
342
343 // Count the filter usage
344 function countFilterUsage ($filterName, $filterFunction) {
345         // Is it there?
346         if (isset($GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction])) {
347                 // Yes, then increase
348                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction]++;
349         } else {
350                 // No, then create
351                 $GLOBALS['cache_array']['filter']['counter'][$filterName][$filterFunction] = 1;
352         }
353 }
354
355 // Prepares the filter array for usage
356 function prepareFilterArray () {
357         //¬†Abort here if array is absend (e.g. not cached)
358         if (!isset($GLOBALS['cache_array']['filter']['filter_name'])) {
359                 // Abort silently
360                 return FALSE;
361         } // END - if
362
363         // Init dummy array
364         $filterArray = array(
365                 'chains'  => array(),
366                 'loaded'  => array(),
367                 'counter' => array()
368         );
369
370         // Found in cache so rewrite the array
371         foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
372                 // Get filter function
373                 $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
374
375                 // Add the element with mapped index
376                 $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
377                 $filterArray['loaded'][$filterName][$filterFunction]  = TRUE;
378                 $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
379         } // END - foreach
380
381         // Remove the cache
382         $GLOBALS['cache_array']['filter'] = $filterArray;
383 }
384
385 /**
386  * Loads filter for given extension if present. This function will silently
387  * ignore absent filter files.
388  *
389  * @param       $ext_name       Name of extension
390  * @return      void
391  */
392 function loadExtensionFilters ($ext_name) {
393         // Debug message
394         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
395
396         // Is there a cache entry?
397         if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
398                 // Default is not found
399                 $GLOBALS[__FUNCTION__][$ext_name] = FALSE;
400
401                 // Construct include file name
402                 $incFileName = sprintf("inc/filter/%s_filter.php", $ext_name);
403
404                 // Is the include file readable?
405                 if (isIncludeReadable($incFileName)) {
406                         // Load the include file
407                         loadIncludeOnce($incFileName);
408
409                         // Mark the file as loaded
410                         $GLOBALS[__FUNCTION__][$ext_name] = TRUE;
411                 } elseif (isDebugModeEnabled()) {
412                         // Log missing file
413                         //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Filter include file ' . $incFileName . ' for extension ' . $ext_name . ' is missing.');
414                 }
415         } // END - if
416
417         // Debug message
418         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',result=' . intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
419 }
420
421 // [EOF]
422 ?>