Caching of filters added (should work now)
[mailer.git] / inc / filters.php
1 <?php
2 /************************************************************************
3  * MXChange v0.2.1                                    Start: 12/16/2008 *
4  * ===============                              Last change: 12/16/2008 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : filters.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  * 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 - 2008 by Roland Haeder                           *
21  * For more information visit: http://www.mxchange.org                  *
22  *                                                                      *
23  * This program is free software; you can redistribute it and/or modify *
24  * it under the terms of the GNU General Public License as published by *
25  * the Free Software Foundation; either version 2 of the License, or    *
26  * (at your option) any later version.                                  *
27  *                                                                      *
28  * This program is distributed in the hope that it will be useful,      *
29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
31  * GNU General Public License for more details.                         *
32  *                                                                      *
33  * You should have received a copy of the GNU General Public License    *
34  * along with this program; if not, write to the Free Software          *
35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
36  * MA  02110-1301  USA                                                  *
37  ************************************************************************/
38
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
41         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
42         require($INC);
43 }
44
45 // Init "generic filter system"
46 function initFilterSystem () {
47         // Is the filter already initialized?
48         if ((isset($GLOBALS['filters']['chains'])) && (is_array($GLOBALS['filters']['chains']))) {
49                 // Then abort here
50                 debug_report_bug(getMessage('FILTER_FAILED_ALREADY_INIT'));
51         } // END - if
52
53         // Init the filter system (just some ideas)
54         $GLOBALS['filters']['chains'] = array(
55                 'preinit'   => array(), // Filters for pre-init phase
56                 'postinit'  => array(), // Filters for post-init phase
57                 'shutdown'  => array()  // Filters for shutdown phase
58         );
59
60         // Init loaded filters and counter
61         $GLOBALS['filters']['loaded'] =  array();
62         $GLOBALS['filters']['counter'] = array();
63
64         // Load all saved filers if sql_patches is updated
65         if (isset($GLOBALS['cache_array']['filter'])) {
66                 // Found in cache so rewrite the array
67                 $filterArray = array();
68                 foreach ($GLOBALS['cache_array']['filter']['filter_name'] as $idx => $filterName) {
69                         // Get filter function
70                         $filterFunction = $GLOBALS['cache_array']['filter']['filter_function'][$idx];
71
72                         // Add the element with mapped index
73                         $filterArray['counter'][$filterName][$filterFunction] = $GLOBALS['cache_array']['filter']['filter_counter'][$idx];
74                         $filterArray['loaded'][$filterName][$filterFunction]  = true;
75                         $filterArray['chains'][$filterName][$filterFunction]  = $GLOBALS['cache_array']['filter']['filter_active'][$idx];
76                 } // END - foreach
77
78                 // Set the array
79                 //die('<pre>'.print_r($filterArray, true).'</pre>');
80                 $GLOBALS['filters'] = $filterArray;
81
82                 // Remove the cache
83                 unset($GLOBALS['cache_array']['filter']);
84         } elseif (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
85                 // Init add
86                 $add = '';
87                 if (GET_EXT_VERSION('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
88
89                 // Load all active filers
90                 $result = SQL_QUERY("SELECT `filter_name`,`filter_function`,`filter_active`".$add."
91 FROM `{!_MYSQL_PREFIX!}_filters`
92 ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
93
94                 // Are there entries?
95                 if (SQL_NUMROWS($result) > 0) {
96                         // Load all filters
97                         while ($filterArray = SQL_FETCHARRAY($result)) {
98                                 // Get filter name and function
99                                 $filterName     = $filterArray['filter_name'];
100                                 $filterFunction = $filterArray['filter_function'];
101
102                                 // Set counter to default
103                                 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
104
105                                 // Mark this filter as loaded (from database)
106                                 $GLOBALS['filters']['loaded'][$filterName][$filterFunction] = true;
107
108                                 // Set this filter
109                                 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
110
111                                 // Is the array element for counter there?
112                                 if (isset($filterArray['filter_counter'])) {
113                                         // Then use this value!
114                                         $GLOBALS['filters']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
115                                 } // END - if
116                         } // END - while
117                 } // END - if
118
119                 // Free result
120                 SQL_FREERESULT($result);
121
122                 // Init filters
123                 registerFilter('init', 'UPDATE_LOGIN_DATA');
124                 registerFilter('init', 'INIT_RANDOMIZER');
125
126                 // Login failures handler
127                 registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
128
129                 // Filters for pre-extension-registration
130                 registerFilter('pre_extension_installed', 'RUN_SQLS');
131
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');
137
138                 // Solving tasks
139                 registerFilter('solve_task', 'SOLVE_TASK');
140
141                 // Loading includes in general
142                 registerFilter('load_includes', 'LOAD_INCLUDES');
143
144                 // Run SQLs
145                 registerFilter('run_sqls', 'RUN_SQLS');
146
147                 // Admin ACL check
148                 registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
149
150                 // Register shutdown filters
151                 registerFilter('shutdown', 'FLUSH_FILTERS');
152         } // END - if
153 }
154
155 // "Registers" a new filter function
156 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
157         // Extend the filter function name
158         $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
159
160         // Is that filter already there?
161         if ((isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
162                 // Then abort here
163                 if (!$silentAbort) {
164                         addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
165                 } // END - if
166
167                 // Abort here
168                 return false;
169         } // END - if
170
171         // Is the function there?
172         if (!function_exists($filterFunction)) {
173                 // Then abort here
174                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_FOUND'), array($filterFunction, $filterName));
175                 return false;
176         } // END - if
177
178         // Shall we add it?
179         if (!$dry_run) {
180                 // Simply add it to the array
181                 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'Y';
182                 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
183         } // END - if
184 }
185
186 // "Unregisters" a filter from the given chain
187 function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
188         // Extend the filter function name only if not loaded from database
189         if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
190                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
191         } // END - if
192
193         // Is that filter there?
194         if ((!isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
195                 // Not found, so abort here
196                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
197                 return false;
198         } // END - if
199
200         // Shall we remove? (default, not while just showing an extension removal)
201         if ($dry_run === false) {
202                 // Mark for filter removal
203                 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'R';
204         } // END  - if
205 }
206
207 // "Runs" the given filters, data is optional and can be any type of data
208 function runFilterChain ($filterName, $data = null, $silentAbort = true) {
209         // Is that filter chain there?
210         if (!isset($GLOBALS['filters']['chains'][$filterName])) {
211                 // We should find all these non-existing filter chains
212                 debug_report_bug('Filter chain '.$filterName.' not found!');
213         } // END - if
214
215         // Default return value
216         $returnValue = $data;
217
218         // Then run all filters
219         foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction => $active) {
220                 // Debug message
221                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
222
223                 // Is the filter active?
224                 if (($active == 'Y') || ((in_array($filterName, array('extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
225                         // Is this filter there?
226                         if (!function_exists($filterFunction)) {
227                                 // Unregister it
228                                 unregisterFilter($filterName, $filterFunction);
229
230                                 // Skip this entry
231                                 continue;
232                         } // END - if
233
234                         // Call the filter chain
235                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
236
237                         // Update usage counter
238                         countFilterUsage($filterName, $filterFunction);
239                 } elseif (isDebugModeEnabled()) {
240                         // Debug message
241                         DEBUG_LOG(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
242                 }
243         } // END - foreach
244
245         // Return the filtered content
246         return $returnValue;
247 }
248
249 // Count the filter usage
250 function countFilterUsage ($filterName, $filterFunction) {
251         // Is it there?
252         if (isset($GLOBALS['filters']['counter'][$filterName][$filterFunction])) {
253                 // Yes, then increase
254                 $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
255         } else {
256                 // No, then create
257                 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 1;
258         }
259 }
260
261 // -----------------------------------------------------------------------------
262 // Generic filter functions we always need
263 // -----------------------------------------------------------------------------
264
265 // Filter for flushing all new filters to the database
266 function FILTER_FLUSH_FILTERS () {
267         // Clear all previous SQL queries
268         INIT_SQLS();
269
270         // Are we installing?
271         if ((isInstalling()) || (!isInstalled())) {
272                 // Then silently skip this filter
273                 return true;
274         } // END - if
275
276         // Is a database link here and not in installation mode?
277         if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
278                 // Abort here
279                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
280                 return false;
281         } // END - if
282
283         // Is the extension sql_patches updated?
284         if (EXT_VERSION_IS_OLDER('sql_patches', '0.5.9')) {
285                 // Abort silently here
286                 return false;
287         } // END - if
288
289         // Nothing is added/remove by default
290         $inserted = 0;
291         $removed = 0;
292
293         // Prepare SQL queries
294         $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
295         $removeSQL = "DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_filters` WHERE";
296
297         // Write all filters to database
298         foreach ($GLOBALS['filters']['chains'] as $filterName => $filterArray) {
299                 // Walk through all filters
300                 foreach ($filterArray as $filterFunction => $active) {
301                         // Is this filter loaded?
302                         if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
303                                 // Add this filter (all filters are active by default)
304                                 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
305                                 $inserted++;
306                         } elseif ($active == "R") {
307                                 // Remove this filter
308                                 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
309                                 $removed++;
310                         }
311                 } // END - foreach
312         } // END - foreach
313
314         // Something has been added?
315         if ($inserted > 0) {
316                 // Finish SQL command
317                 $insertSQL = substr($insertSQL, 0, -1);
318
319                 // And run it
320                 ADD_SQL($insertSQL);
321         } // END - if
322
323         // Something has been removed?
324         if ($removed > 0) {
325                 // Finish SQL command
326                 $removeSQL = substr($removeSQL, 0, -2) . "LIMIT ".$removed;
327
328                 // And run it
329                 ADD_SQL($removeSQL);
330         } // END - if
331
332         // Shall we update usage counters (ONLY FOR DEBUGGING!)
333         if (getConfig('update_filter_usage') == 'Y') {
334                 // Update all counters
335                 foreach ($GLOBALS['filters']['counter'] as $filterName => $filterArray) {
336                         // Walk through all filters
337                         foreach ($filterArray as $filterFunction => $cnt) {
338                                 // Construct and add the query
339                                 ADD_SQL(sprintf("UPDATE `{!_MYSQL_PREFIX!}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
340                                         bigintval($cnt),
341                                         $filterName,
342                                         $filterFunction
343                                 ));
344                         } // END - foreach
345                 } // END - foreach
346         } // END - if
347
348         // Run the run_sqls filter in non-dry mode
349         runFilterChain('run_sqls');
350 }
351
352 // Filter for calling the handler for login failures
353 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
354         // Init content
355         $content = $data;
356
357         // Handle failed logins here if not in guest
358         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={getAction()},what={getWhat()},lvl={$data['access_level']}<br />\n";
359         if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((GET_EXT_VERSION('sql_patches') >= '0.4.7') || (GET_EXT_VERSION('admins') >= '0.7.0'))) {
360                 // Handle failure
361                 $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
362         } // END - if
363
364         // Return the content
365         return $content;
366 }
367
368 // Filter for redirecting to logout if sql_patches has been installed
369 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
370         // Remove this filter
371         unregisterFilter('shutdown', __FUNCTION__);
372
373         // Is the element set?
374         if (isset($GLOBALS['ext_load_mode'])) {
375                 // Redirect here
376                 redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
377         } // END - if
378
379         // This should not happen!
380         DEBUG_LOG(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
381 }
382
383 // Filter for auto-activation of a extension
384 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
385         // Is this extension always activated?
386         if (EXT_GET_ALWAYS_ACTIVE() == 'Y') {
387                 // Then activate the extension
388                 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
389                 ACTIVATE_EXTENSION($data['ext_name']);
390         } // END - if
391
392         // Return the data
393         return $data;
394 }
395
396 // Filter for solving task given task
397 function FILTER_SOLVE_TASK ($data) {
398         // Don't solve anything if no admin!
399         if (!IS_ADMIN()) return $data;
400
401         // Is this a direct task id or array element task_id is found?
402         if (is_int($data)) {
403                 // Then solve it...
404                 ADMIN_SOLVE_TASK($data);
405         } elseif ((is_array($data)) && (isset($data['task_id']))) {
406                 // Solve it...
407                 ADMIN_SOLVE_TASK($data['task_id']);
408         }
409
410         // Return the data
411         return $data;
412 }
413
414 // Filter to load include files
415 function FILTER_LOAD_INCLUDES () {
416         // Default is $data as inclusion list
417         $data = GET_INC_POOL();
418
419         // Is it an array?
420         if ((!isset($data)) || (!is_array($data))) {
421                 // Then abort here
422                 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
423         } elseif (isset($data['inc_pool'])) {
424                 // Use this as new inclusion pool!
425                 SET_INC_POOL($data['inc_pool']);
426         }
427
428         // Check for added include files
429         if (COUNT_INC_POOL() > 0) {
430                 // Loads every include file
431                 foreach (GET_INC_POOL() as $FQFN) {
432                         loadIncludeOnce($FQFN);
433                 } // END - foreach
434
435                 // Reset array
436                 INIT_INC_POOL();
437         } // END - if
438
439         // Continue with processing
440         return $data;
441 }
442
443 // Filter for running SQL commands
444 function FILTER_RUN_SQLS ($data) {
445         // Debug message
446         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Entered!");
447
448         // Is the array there?
449         if ((IS_SQLS_VALID()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
450                 // Run SQL commands
451                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Found ".COUNT_SQLS()." queries to run.");
452                 foreach (GET_SQLS() as $sql) {
453                         // Trim spaces away
454                         $sql = trim($sql);
455
456                         // Is there still a query left?
457                         if (!empty($sql)) {
458                                 // Do we have an "ALTER TABLE" command?
459                                 if (substr(strtolower($sql), 0, 11) == "alter table") {
460                                         // Analyse the alteration command
461                                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
462                                         SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
463                                 } else {
464                                         // Run regular SQL command
465                                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
466                                         SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
467                                 }
468                         } // END - if
469                 } // END - foreach
470         } // END - if
471
472         // Debug message
473         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
474 }
475
476 // Filter for updating/validating login data
477 function FILTER_UPDATE_LOGIN_DATA () {
478         // Add missing array
479         if ((!isset($GLOBALS['last'])) || (!is_array($GLOBALS['last']))) $GLOBALS['last'] = array();
480
481         // Recheck if logged in
482         if (!IS_MEMBER()) return false;
483
484         // Secure user ID
485         setUserId(getSession('userid'));
486
487         // Load last module and last online time
488         $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
489                 array(getUserId()), __FUNCTION__, __LINE__);
490
491         // Entry found?
492         if (SQL_NUMROWS($result) == 1) {
493                 // Load last module and online time
494                 list($mod, $onl) = SQL_FETCHROW($result);
495
496                 // Maybe first login time?
497                 if (empty($mod)) $mod = 'login';
498
499                 // This will be displayed on welcome page! :-)
500                 if (empty($GLOBALS['last']['module'])) {
501                         $GLOBALS['last']['module'] = $mod; $GLOBALS['last']['online'] = $onl;
502                 } // END - if
503
504                 // 'what' not set?
505                 if (!isWhatSet()) {
506                         // Fix it to default
507                         setWhat('welcome');
508                         if (getConfig('index_home') != '') setWhatFromConfig('index_home');
509                 } // END - if
510
511                 // Update last module / online time
512                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
513                         array(getWhat(), detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
514         }  else {
515                 // Destroy session, we cannot update!
516                 destroyUserSession();
517         }
518
519         // Free the result
520         SQL_FREERESULT($result);
521 }
522
523 // Filter for checking admin ACL
524 function FILTER_CHECK_ADMIN_ACL () {
525         // Extension not installed so it's always allowed to access everywhere!
526         $ret = true;
527
528         // Ok, Cookie-Update done
529         if ((GET_EXT_VERSION('admins') >= '0.3.0') && (EXT_IS_ACTIVE('admins'))) {
530                 // Check if action GET variable was set
531                 $action = getAction();
532                 if (isWhatSet()) {
533                         // Get action value by what-value
534                         $action = getModeAction('admin', getWhat());
535                 } // END - if
536
537                 // Check for access control line of current menu entry
538                 $ret = adminsCheckAdminAcl($action, getWhat());
539         } // END - if
540
541         // Return result
542         return $ret;
543 }
544
545 // Filter for initializing randomizer
546 function FILTER_INIT_RANDOMIZER () {
547         // Simply init the randomizer with seed and _ADD value
548         mt_srand(generateSeed() + getConfig('_ADD'));
549 }
550
551 // Filter for removing updates
552 function FILTER_REMOVE_UPDATES () {
553         // Init removal list
554         EXT_INIT_REMOVAL_LIST();
555
556         // Add the current extension to it
557         EXT_ADD_CURRENT_TO_REMOVAL_LIST();
558
559         // Simply remove it
560         UNSET_EXT_SQLS();
561
562         // Do we need to remove update depency?
563         if (EXT_COUNT_UPDATE_DEPENDS() > 0) {
564                 // Then find all updates we shall no longer execute
565                 foreach (EXT_GET_UPDATE_DEPENDS() as $id=>$ext_name) {
566                         // Shall we remove this update?
567                         if (in_array($ext_name, EXT_GET_REMOVAL_LIST())) {
568                                 // Then remove this extension!
569                                 EXT_REMOVE_UPDATE_DEPENDS($ext_name);
570                         } // END - if
571                 } // END - foreach
572         } // END - if
573 }
574
575 //
576 ?>