New function fetchUserData() introduced to API, total rewrite (not all)
[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 : Generic filters                                  *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Allgemeine Filter                                *
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 - 2009 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         die();
42 } // END - if
43
44 // Filter for flushing all new filters to the database
45 function FILTER_FLUSH_FILTERS () {
46         // Clear all previous SQL queries
47         initSqls();
48
49         // Are we installing?
50         if ((isInstallationPhase())) {
51                 // Then silently skip this filter
52                 return true;
53         } // END - if
54
55         // Is a database link here and not in installation mode?
56         if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
57                 // Abort here
58                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
59                 return false;
60         } // END - if
61
62         // Is the extension sql_patches updated?
63         if ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9'))) {
64                 // Abort silently here
65                 return false;
66         } // END - if
67
68         // Nothing is added/remove by default
69         $inserted = 0;
70         $removed = 0;
71
72         // Prepare SQL queries
73         $insertSQL = "INSERT INTO `{?_MYSQL_PREFIX?}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
74         $removeSQL = "DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_filters` WHERE";
75
76         // Write all filters to database
77         foreach ($GLOBALS['cache_array']['filter']['chains'] as $filterName => $filterArray) {
78                 // Walk through all filters
79                 foreach ($filterArray as $filterFunction => $active) {
80                         // Is this filter loaded?
81                         //* DEBUG: */ print 'FOUND:'.$filterName.'/'.$filterFunction.'='.$active.'<br />';
82                         if (((!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) && ($active != 'R')) || ($active == 'A')) {
83                                 // Add this filter (all filters are active by default)
84                                 //* DEBUG: */ print 'ADD:'.$filterName.'/'.$filterFunction.'<br />';
85                                 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
86                                 $inserted++;
87                         } elseif ($active == 'R') {
88                                 // Remove this filter
89                                 //* DEBUG: */ print 'REMOVE:'.$filterName.'/'.$filterFunction.'<br />';
90                                 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
91                                 $removed++;
92                         }
93                 } // END - foreach
94         } // END - foreach
95
96         // Something has been added?
97         if ($inserted > 0) {
98                 // Finish SQL command and add it
99                 addSql(substr($insertSQL, 0, -1));
100         } // END - if
101
102         // Something has been removed?
103         if ($removed > 0) {
104                 // Finish SQL command and add it
105                 addSql(substr($removeSQL, 0, -2) . 'LIMIT ' . $removed);
106         } // END - if
107
108         // Shall we update usage counters (ONLY FOR DEBUGGING!)
109         if (getConfig('update_filter_usage') == 'Y') {
110                 // Update all counters
111                 foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
112                         // Walk through all filters
113                         foreach ($filterArray as $filterFunction => $cnt) {
114                                 // Construct and add the query
115                                 addSql(sprintf("UPDATE `{?_MYSQL_PREFIX?}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
116                                         bigintval($cnt),
117                                         $filterName,
118                                         $filterFunction
119                                 ));
120                         } // END - foreach
121                 } // END - foreach
122         } // END - if
123
124         // Run the run_sqls filter in non-dry mode
125         runFilterChain('run_sqls');
126
127         // Should we rebuild cache?
128         if (($inserted > 0) || ($removed > 0)) {
129                 // Destroy cache
130                 rebuildCacheFile('filter', 'filter');
131         } // END - if
132 }
133
134 // Filter for calling the handler for login failures
135 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
136         // Init content
137         $content = $data;
138
139         // Handle failed logins here if not in guest
140         //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={getAction()},what={getWhat()},level={$data['access_level']}<br />");
141         if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.0')))) {
142                 // Handle failure
143                 $content['content'] .= handleLoginFailtures($data['access_level']);
144         } // END - if
145
146         // Return the content
147         return $content;
148 }
149
150 // Filter for redirecting to logout if sql_patches has been installed
151 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
152         // Remove this filter
153         unregisterFilter('shutdown', __FUNCTION__);
154
155         // Is the element set?
156         if (isset($GLOBALS['ext_load_mode'])) {
157                 // Redirect here
158                 redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
159         } // END - if
160
161         // This should not happen!
162         logDebugMessage(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
163 }
164
165 // Filter for auto-activation of a extension
166 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
167         // Is this extension always activated?
168         if (getExtensionAlwaysActive() == 'Y') {
169                 // Then activate the extension
170                 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />");
171                 doActivateExtension($data['ext_name']);
172         } // END - if
173
174         // Return the data
175         return $data;
176 }
177
178 // Filter for solving task given task
179 function FILTER_SOLVE_TASK ($data) {
180         // Don't solve anything if no admin!
181         if (!isAdmin()) return $data;
182
183         // Is this a direct task id or array element task_id is found?
184         if (is_int($data)) {
185                 // Then solve it...
186                 adminSolveTask($data);
187         } elseif ((is_array($data)) && (isset($data['task_id']))) {
188                 // Solve it...
189                 adminSolveTask($data['task_id']);
190         } else {
191                 // Not detectable!
192                 debug_report_bug(sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($data), print_r($data, true)));
193         }
194
195         // Return the data
196         return $data;
197 }
198
199 // Filter to load include files
200 function FILTER_LOAD_INCLUDES ($pool) {
201         // Is it null?
202         if (is_null($pool)) {
203                 // This should not happen!
204                 debug_report_bug('pool is null.');
205         } // END - if
206
207         // Is the pool an array and 'pool' set?
208         if ((is_array($pool)) && (isset($pool['pool']))) {
209                 // Then use it as pool
210                 $realPool = $pool['pool'];
211         } else {
212                 // Default is $data as inclusion list
213                 $realPool = $pool;
214         }
215
216         // Get inc pool
217         $data = getIncludePool($realPool);
218
219         // Is it an array?
220         if ((!isset($data)) || (!is_array($data))) {
221                 // Then abort here
222                 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
223         } elseif (isset($data['inc_pool'])) {
224                 // Use this as new inclusion pool!
225                 setIncludePool($realPool, $data['inc_pool']);
226         }
227
228         // Check for added include files
229         if (countIncludePool($realPool) > 0) {
230                 // Loads every include file
231                 loadIncludePool($realPool);
232
233                 // Reset array
234                 initIncludePool($realPool);
235         } // END - if
236
237         // Continue with processing
238         return $pool;
239 }
240
241 // Filter for running SQL commands
242 function FILTER_RUN_SQLS ($data) {
243         // Debug message
244         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "- Entered!");
245
246         // Is the array there?
247         if ((isSqlsValid()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
248                 // Run SQL commands
249                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "- Found ".countSqls()." queries to run.");
250                 foreach (getSqls() as $sqls) {
251                         // New cache format...
252                         foreach ($sqls as $sql) {
253                                 // Trim spaces away
254                                 $sql = trim($sql);
255
256                                 // Is there still a query left?
257                                 if (!empty($sql)) {
258                                         // Do we have an "ALTER TABLE" command?
259                                         if (substr(strtolower($sql), 0, 11) == 'alter table') {
260                                                 // Analyse the alteration command
261                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
262                                                 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
263                                         } else {
264                                                 // Run regular SQL command
265                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
266                                                 SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
267                                         }
268                                 } // END - if
269                         } // END - foreach
270                 } // END - foreach
271         } // END - if
272
273         // Debug message
274         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "- Left!");
275 }
276
277 // Filter for updating/validating login data
278 function FILTER_UPDATE_LOGIN_DATA () {
279         // Add missing array
280         if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) $GLOBALS['last_online'] = array();
281
282         // Recheck if logged in
283         if (!isMember()) return false;
284
285         // Secure user id
286         setUserId(getSession('userid'));
287
288         // Found a userid?
289         if (fetchUserData(getUserId())) {
290                 // Load last module and online time
291                 $content = getUserDataArray();
292
293                 // Maybe first login time?
294                 if (empty($content['last_module'])) $content['last_module'] = 'login';
295
296                 // This will be displayed on welcome page! :-)
297                 if (empty($GLOBALS['last_online']['module'])) {
298                         $GLOBALS['last_online']['module'] = $content['last_module'];
299                         $GLOBALS['last_online']['online'] = $content['last_online'];
300                 } // END - if
301
302                 // 'what' not set?
303                 if (!isWhatSet()) {
304                         // Fix it to default
305                         setWhat('welcome');
306                         if (getConfig('index_home') != '') setWhatFromConfig('index_home');
307                 } // END - if
308
309                 // Update last module / online time
310                 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `last_module`='%s', `last_online`=UNIX_TIMESTAMP(), `REMOTE_ADDR`='%s' WHERE `userid`=%s LIMIT 1",
311                         array(
312                                 getWhat(),
313                                 detectRemoteAddr(),
314                                 getUserId()
315                         ), __FUNCTION__, __LINE__);
316         }  else {
317                 // Destroy session, we cannot update!
318                 destroyUserSession();
319         }
320 }
321
322 // Filter for initializing randomizer
323 function FILTER_INIT_RANDOMIZER () {
324         // Only execute this filter if installed
325         if ((!isInstalled()) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) return;
326
327         // Take a prime number which is long (if you know a longer one please try it out!)
328         setConfigEntry('_PRIME', 591623);
329
330         // Calculate "entropy" with the prime number (for code generation)
331         setConfigEntry('_ADD', (getConfig('_PRIME') * getConfig('_PRIME') / (pi() * getConfig('code_length') + 1)));
332
333         // Simply init the randomizer with seed and _ADD value
334         mt_srand(generateSeed() + getConfig('_ADD'));
335 }
336
337 // Filter for removing updates
338 function FILTER_REMOVE_UPDATES ($data) {
339         // Init removal list
340         initExtensionRemovalList();
341
342         // Add the current extension to it
343         addCurrentExtensionToRemovalList();
344
345         // Simply remove it
346         unsetExtensionSqls();
347
348         // Do we need to remove update depency?
349         if (countExtensionUpdateDependencies() > 0) {
350                 // Then find all updates we shall no longer execute
351                 foreach (getExtensionUpdateDependencies() as $id=>$ext_name) {
352                         // Shall we remove this update?
353                         if (in_array($ext_name, getExtensionRemovalList())) {
354                                 // Then remove this extension!
355                                 removeExtensionUpdateDependency($ext_name);
356                         } // END - if
357                 } // END - foreach
358         } // END - if
359
360         // Return data
361         return $data;
362 }
363
364 // Determines username for current user state
365 function FILTER_DETERMINE_USERNAME () {
366         // Check if logged in
367         if (isMember()) {
368                 // Is still logged in so we welcome him with his name
369                 if (fetchUserData(getUserId())) {
370                         // Load surname and family's name and build the username
371                         $content = getUserDataArray();
372
373                         // Prepare username
374                         setUsername($content['surname'] . ' ' . $content['family']);
375
376                         // Additionally admin?
377                         if (isAdmin()) {
378                                 // Add it
379                                 setUsername(getUsername() . ' ({--USERNAME_ADMIN_SHORT--})');
380                         } // END - if
381                 } else {
382                         // Hmmm, logged in and no valid userid?
383                         setUsername('<em>{--USERNAME_UNKNOWN--}</em>');
384
385                         // Destroy session
386                         destroyUserSession();
387
388                         // Kill userid
389                         setUserId(0);
390                 }
391         } elseif (isAdmin()) {
392                 // Admin is there
393                 setUsername('{--USERNAME_ADMIN--}');
394         } else {
395                 // He's a guest, hello there... ;-)
396                 setUsername('{--USERNAME_GUEST--}');
397         }
398 }
399
400 // Filter for compiling config entries
401 function FILTER_COMPILE_CONFIG ($code) {
402         // Compile {?some_var?} to getConfig('some_var')
403         preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
404
405         // Some entries found?
406         if ((count($matches) > 0) && (count($matches[0]) > 0)) {
407                 // Replace all matches
408                 foreach ($matches[0] as $key => $match) {
409                         // Do we have cache?
410                         if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
411                                 // Is the config valid?
412                                 if (isConfigEntrySet($matches[1][$key])) {
413                                         // Set it for caching
414                                         $GLOBALS['compile_config'][$matches[1][$key]] = getConfig($matches[1][$key]);
415                                 } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
416                                         // Use default value
417                                         $GLOBALS['compile_config'][$matches[1][$key]] = getConfig('DEFAULT_' . strtoupper($matches[1][$key]));
418                                 } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
419                                         // No config, try the language system
420                                         $GLOBALS['compile_config'][$matches[1][$key]] = getMessage('DEFAULT_' . strtoupper($matches[1][$key]));
421                                 } else {
422                                         // Unhandled!
423                                         $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
424                                 }
425                         } // END - if
426
427                         // Use this for replacing
428                         $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
429                         //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die('<pre>'.htmlentities($code).'</pre>');
430                 } // END - foreach
431         } // END - if
432
433         // Return compiled code
434         return $code;
435 }
436
437 // Filter for compiling extension data
438 function FILTER_COMPILE_EXTENSION ($code) {
439         // Compile {%cmd=some_value%} to get extension data
440         // Support cmd is:
441         //   - version -> getExtensionVersion() call
442         preg_match_all('/\{%((([a-zA-Z0-9-_]+)=([a-zA-Z0-9-_]+))*)\%\}/', $code, $matches);
443
444         // Some entries found?
445         if ((count($matches) > 0) && (count($matches[3]) > 0)) {
446                 // Replace all matches
447                 foreach ($matches[3] as $key => $cmd) {
448                         // By default we have no extension installed, so 'false' is assumed
449                         $replacer = 'false';
450
451                         // Is the extension installed?
452                         if (isExtensionActive($matches[4][$key])) {
453                                 // Construct call-back function name
454                                 $functionName = 'getExtension' . ucfirst(strtolower($cmd));
455
456                                 // Call the function
457                                 $replacer = call_user_func_array($functionName, $matches[4][$key]);
458                         } // END - if
459
460                         // Replace it and insert parameter for GET request
461                         $code = str_replace($matches[0][$key], sprintf("&amp;%s=%s&amp;rev=%s", $cmd, $replacer, getConfig('CURR_SVN_REVISION')), $code);
462                 } // END - foreach
463         } // END - if
464
465         // Return compiled code
466         return $code;
467 }
468
469 // Runs some generic filter update steps
470 function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
471         // Create task
472         createExtensionUpdateTask(getCurrentAdminId(), $ext_name, $GLOBALS['update_ver'][$ext_name], SQL_ESCAPE(getExtensionNotes(getExtensionNotes())));
473
474         // Update extension's version
475         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_version`='%s' WHERE `ext_name`='%s' LIMIT 1",
476                 array($GLOBALS['update_ver'][$ext_name], $ext_name), __FUNCTION__, __LINE__);
477
478         // Remove arrays
479         unsetSqls();
480         unset($GLOBALS['update_ver'][$ext_name]);
481 }
482
483 // Load more reset scripts
484 function FILTER_RUN_RESET_INCLUDES () {
485         // Is the reset set or old sql_patches?
486         if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (getOutputMode() == 0)) {
487                 // Then abort here
488                 logDebugMessage(__FUNCTION__, __LINE__, 'Cannot run reset! Please report this bug. Thanks');
489         } // END - if
490
491         // Get more daily reset scripts
492         setIncludePool('reset', getArrayFromDirectory('inc/reset/', 'reset_'));
493
494         // Update database
495         if ((!isConfigEntrySet('DEBUG_RESET')) || (getConfig('DEBUG_RESET') != 'Y')) updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
496
497         // Is the config entry set?
498         if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
499                 // Create current week mark
500                 $currWeek = date('W', time());
501
502                 // Has it changed?
503                 if ((getConfig('last_week') != $currWeek) || (getConfig('DEBUG_WEEKLY') == 'Y')) {
504                         // Include weekly reset scripts
505                         mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
506
507                         // Update config
508                         if ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') != 'Y')) updateConfiguration('last_week', $currWeek);
509                 } // END - if
510
511                 // Create current month mark
512                 $currMonth = date('m', time());
513
514                 // Has it changed?
515                 if ((getConfig('last_month') != $currMonth) || (getConfig('DEBUG_MONTHLY') == 'Y')) {
516                         // Include monthly reset scripts
517                         mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
518
519                         // Update config
520                         if ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
521                 } // END - if
522         } // END - if
523
524         // Run the filter
525         runFilterChain('load_includes', 'reset');
526 }
527
528 // Filter for removing the given extension
529 function FILTER_REMOVE_EXTENSION () {
530         // Delete this extension (remember to remove it from your server *before* you click on welcome!
531         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
532                 array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
533
534         // Remove the extension from global cache array as well
535         removeExtensionFromArray();
536
537         // Remove the cache
538         rebuildCacheFile('extension', 'extension');
539 }
540
541 // Filter for flushing the output
542 function FILTER_FLUSH_OUTPUT () {
543         // Simple, he?
544         outputHtml('');
545 }
546
547 // Prepares an SQL statement part for HTML mail and/or holiday depency
548 function FILTER_HTML_INCLUDE_USERS ($mode) {
549         // Exclude no users by default
550         $MORE = '';
551
552         // HTML mail?
553         if ($mode == 'html') $MORE = " AND `html`='Y'";
554         if ((isExtensionActive('holiday')) && (getExtensionVersion('holiday') >= '0.1.3')) {
555                 // Add something for the holiday extension
556                 $MORE .= " AND `holiday_active`='N'";
557         } // END - if
558
559         // Return result
560         return $MORE;
561 }
562
563 // Filter for determining what/action/module
564 function FILTER_DETERMINE_WHAT_ACTION () {
565         // In installation phase we don't have what/action
566         if (isInstallationPhase()) {
567                 // Set both to empty
568                 setAction('');
569                 setWhat('');
570
571                 // Abort here
572                 return;
573         } // END - if
574
575         // Get all values
576         if ((getOutputMode() != 1) && (getOutputMode() != -1)) {
577                 // Fix module
578                 if (!isModuleSet()) {
579                         // Is the request element set?
580                         if (isGetRequestElementSet('module')) {
581                                 // Set module from request
582                                 setModule(getRequestElement('module'));
583                         } else {
584                                 // Set default module 'index'
585                                 setModule('index');
586                         }
587                 } // END - if
588
589                 // Fix 'what' if not yet set
590                 if (!isWhatSet())   setWhat(getWhatFromModule(getModule()));
591
592                 // Fix 'action' if not yet set
593                 if (!isActionSet()) setAction(getModeAction(getModule(), getWhat()));
594         } else {
595                 // Set action/what to empty
596                 setAction('');
597                 setWhat('');
598         }
599
600         // Set default 'what' value
601         //* DEBUG: */ outputHtml('-'.getModule().'/'.getWhat()."-<br />");
602         if ((!isWhatSet()) && (!isActionSet()) && (getOutputMode() != 1) && (getOutputMode() != -1)) {
603                 if (getModule() == 'admin') {
604                         // Set 'action' value to 'login' in admin menu
605                         setAction(getModeAction(getModule(), getWhat()));
606                 } elseif ((getModule() == 'index') || (getModule() == 'login')) {
607                         // Set 'what' value to 'welcome' in guest and member menu
608                         setWhatFromConfig('index_home');
609                 } else {
610                         // Anything else like begging link
611                         setWhat('');
612                 }
613         } // END - if
614 }
615
616 // Sends out pooled mails
617 function FILTER_TRIGGER_SENDING_POOL () {
618         // Are we in normal output mode?
619         if (getOutputMode() != 0) {
620                 // Only in normal output mode to prevent race-conditons!
621         } // END - if
622
623         // Init counter
624         $GLOBALS['pool_cnt'] = 0;
625
626         // Init & set the include pool
627         initIncludePool('pool');
628         setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));
629
630         // Run the filter
631         runFilterChain('load_includes', 'pool');
632
633         // Remove the counter
634         unset($GLOBALS['pool_cnt']);
635 }
636
637 // Filter for checking and updating SVN revision
638 function FILTER_CHECK_SVN_REVISION () {
639         // Only execute this filter if installed and all config entries are there
640         if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) return;
641
642         // Check for patch level differences between databases and current hard-coded
643         if ((getConfig('CURR_SVN_REVISION') > getConfig('patch_level')) || (getConfig('patch_level') == 'CURR_SVN_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
644                 // Update database and CONFIG array
645                 updateConfiguration(array('patch_level', 'patch_ctime'), array(getConfig('CURR_SVN_REVISION'), 'UNIX_TIMESTAMP()'));
646                 setConfigEntry('patch_level', getConfig('CURR_SVN_REVISION'));
647                 setConfigEntry('patch_ctime', time());
648         } // END - if
649 }
650
651 // Filter for running daily reset
652 function FILTER_RUN_DAILY_RESET () {
653         // Only execute this filter if installed
654         if ((!isInstalled()) || (!isAdminRegistered())) return;
655
656         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
657         // 012    3              4             43        3         4432    2         3             3       21    1                    221    1                 221    1                  2          21    1             22     10
658         if (((date('d', getConfig('last_update')) != date('d', time())) || ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y'))) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (getOutputMode() != 1)) {
659                 // Tell every module we are in reset-mode!
660                 doReset();
661         } // END - if
662 }
663
664 // Filter for loading more runtime includes (not for installation)
665 function FILTER_LOAD_RUNTIME_INCLUDES () {
666         // Load more includes
667         foreach (array('inc/databases.php','inc/session.php','inc/versions.php') as $inc) {
668                 // Load the include
669                 loadIncludeOnce($inc);
670         } // END - foreach
671
672         // Load admin include file if he is admin
673         if (isAdmin()) {
674                 // Administrative functions
675                 loadIncludeOnce('inc/modules/admin/admin-inc.php');
676         } // END - if
677         //* DEBUG: */ addPointsThroughReferalSystem('test', 36, 1000);
678         //* DEBUG: */ die();
679 }
680
681 // Filter for checking admin ACL
682 function FILTER_CHECK_ADMIN_ACL () {
683         // Extension not installed so it's always allowed to access everywhere!
684         $ret = true;
685
686         // Ok, Cookie-Update done
687         if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
688                 // Check if action GET variable was set
689                 $action = getAction();
690                 if (isWhatSet()) {
691                         // Get action value by what-value
692                         $action = getModeAction('admin', getWhat());
693                 } // END - if
694
695                 // Check for access control line of current menu entry
696                 $ret = adminsCheckAdminAcl($action, getWhat());
697         } // END - if
698
699         // Set it here
700         $GLOBALS['acl_allow'] = $ret;
701 }
702
703 // Init random number/cache buster
704 function FILTER_INIT_RANDOM_NUMBER () {
705         // Is the extension sql_patches installed and at least 0.3.6?
706         if ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
707                 // Generate random number
708                 setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 32766), getUserId(), ''));
709         } else {
710                 // Generate weak (!!!) code
711                 setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
712         }
713
714         // Copy it to CACHE_BUSTER
715         setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
716 }
717
718 // Update module counter
719 function FILTER_COUNT_MODULE () {
720         // Do count all other modules but not accesses on CSS file css.php!
721         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
722                 array(getModule()), __FUNCTION__, __LINE__);
723 }
724
725 // Handles fatal errors
726 function FILTER_HANDLE_FATAL_ERRORS () {
727         // Do we have errors to handle and right output mode?
728         if ((getTotalFatalErrors() == 0) || (getOutputMode() != 0)) {
729                 // Abort executing here
730                 return false;
731         } // END - if
732
733         // Set content type
734         setContentType('text/html');
735
736         // Load config here
737         loadIncludeOnce('inc/load_config.php');
738
739         // Set unset variable
740         if (empty($check)) $check = '';
741
742         // Default is none
743         $content = '';
744
745         // Installation phase or regular mode?
746         if ((isInstallationPhase())) {
747                 // While we are installing ouput other header than while it is installed... :-)
748                 $OUT = '';
749                 foreach (getFatalArray() as $key => $value) {
750                         // Prepare content for the template
751                         $content = array(
752                                 'key'   => ($key + 1),
753                                 'value' => $value
754                         );
755
756                         // Load row template
757                         $OUT .= loadTemplate('install_fatal_row', true, $content);
758                 }
759
760                 // Load main template
761                 $content = loadTemplate('install_fatal_table', true, $OUT);
762         } elseif (isInstalled()) {
763                 // Display all runtime fatal errors
764                 $OUT = '';
765                 foreach (getFatalArray() as $key => $value) {
766                         // Prepare content for the template
767                         $content = array(
768                                 'key'   => ($key + 1),
769                                 'value' => $value
770                         );
771
772                         // Load row template
773                         $OUT .= loadTemplate('runtime_fatal_row', true, $content);
774                 }
775
776                 // Load main template
777                 $content = loadTemplate('runtime_fatal_table', true, $OUT);
778         }
779
780         // Message to regular users (non-admin)
781         $CORR = getMessage('FATAL_REPORT_ERRORS');
782
783         // PHP warnings fixed
784         if ($check == 'done') {
785                 if (isAdmin()) $CORR = getMessage('FATAL_CORRECT_ERRORS');
786         } // END - if
787
788         // Remember all in array
789         $content = array(
790                 'rows' => $content,
791                 'corr' => $CORR
792         );
793
794         // Load footer
795         loadIncludeOnce('inc/header.php');
796
797         // Load main template
798         loadTemplate('fatal_errors', false, $content);
799
800         // Delete all to prevent double-display
801         initFatalMessages();
802
803         // Load footer
804         loadIncludeOnce('inc/footer.php');
805
806         // Abort here
807         shutdown();
808 }
809
810 // Filter for displaying copyright line
811 function FILTER_DISPLAY_COPYRIGHT () {
812         // Shall we display the copyright notice?
813         if ((!isGetRequestElementSet('frame')) && (basename($_SERVER['PHP_SELF']) != 'mailid_top.php') && ((getConfig('WRITE_FOOTER') == 'Y') || (isInstalling())) && ($GLOBALS['header_sent'] == 2)) {
814                 // Backlink enabled?
815                 if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
816                         // Copyright with backlink, thanks! :-)
817                         loadTemplate('copyright_backlink');
818                 } else {
819                         // No backlink in Copyright note
820                         loadTemplate('copyright');
821                 }
822         } // END - if
823 }
824
825 // Filter for displaying parsing time
826 function FILTER_DISPLAY_PARSING_TIME () {
827         // Shall we display the parsing time and number of queries?
828         // 1234                            5                      54    4         5              5       4    4                       5       543    3                   4432    2             33     2    2                              21
829         if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestElementSet('frame'))) || (isInstallationPhase())) && (getOutputMode() == 0) && ($GLOBALS['header_sent'] == 2)) {
830                 // Then display it here
831                 displayParsingTime();
832         } // END - if
833 }
834
835 // [EOF]
836 ?>