9a2ca2d52640e2126baed7e5036553f24a8a45c4
[mailer.git] / inc / filters.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                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  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://www.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 // Filter for flushing all new filters to the database
44 function FILTER_FLUSH_FILTERS () {
45         // Clear all previous SQL queries
46         initSqls();
47
48         // Are we installing?
49         if ((isInstallationPhase())) {
50                 // Then silently skip this filter
51                 return true;
52         } // END - if
53
54         // Is a database link here and not in installation mode?
55         if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
56                 // Abort here
57                 addFatalMessage(__FUNCTION__, __LINE__, '{--FILTER_FLUSH_FAILED_NO_DATABASE--}');
58                 return false;
59         } // END - if
60
61         // Is the extension sql_patches updated?
62         if ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9'))) {
63                 // Abort silently here
64                 return false;
65         } // END - if
66
67         // Nothing is added/remove by default
68         $inserted = '0';
69         $removed = '0';
70
71         // Prepare SQL queries
72         $insertSQL = 'INSERT INTO `{?_MYSQL_PREFIX?}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES';
73         $removeSQL = 'DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_filters` WHERE';
74
75         // Write all filters to database
76         foreach ($GLOBALS['cache_array']['filter']['chains'] as $filterName => $filterArray) {
77                 // Walk through all filters
78                 foreach ($filterArray as $filterFunction => $active) {
79                         // Is this filter loaded?
80                         //* DEBUG: */ debugOutput('FOUND:'.$filterName.'/'.$filterFunction.'='.$active);
81                         if (((!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) && ($active != 'R')) || ($active == 'A')) {
82                                 // Add this filter (all filters are active by default)
83                                 //* DEBUG: */ debugOutput('ADD:'.$filterName.'/'.$filterFunction);
84                                 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
85                                 $inserted++;
86                         } elseif ($active == 'R') {
87                                 // Remove this filter
88                                 //* DEBUG: */ debugOutput('REMOVE:'.$filterName.'/'.$filterFunction);
89                                 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
90                                 $removed++;
91                         }
92                 } // END - foreach
93         } // END - foreach
94
95         // Something has been added?
96         if ($inserted > 0) {
97                 // Finish SQL command and add it
98                 addSql(substr($insertSQL, 0, -1));
99         } // END - if
100
101         // Something has been removed?
102         if ($removed > 0) {
103                 // Finish SQL command and add it
104                 addSql(substr($removeSQL, 0, -2) . 'LIMIT ' . $removed);
105         } // END - if
106
107         // Shall we update usage counters (ONLY FOR DEBUGGING!)
108         if (isFilterUsageUpdateEnabled()) {
109                 // Update all counters
110                 foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
111                         // Walk through all filters
112                         foreach ($filterArray as $filterFunction => $count) {
113                                 // Construct and add the query
114                                 addSql(sprintf("UPDATE `{?_MYSQL_PREFIX?}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
115                                         bigintval($count),
116                                         $filterName,
117                                         $filterFunction
118                                 ));
119                         } // END - foreach
120                 } // END - foreach
121         } // END - if
122
123         // Run the run_sqls filter in non-dry mode
124         runFilterChain('run_sqls');
125
126         // Should we rebuild cache?
127         if (($inserted > 0) || ($removed > 0)) {
128                 // Destroy cache
129                 rebuildCache('filter', 'filter');
130         } // END - if
131 }
132
133 // Filter for calling the handler for login failures
134 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
135         // Init content
136         $content = $data;
137
138         // Handle failed logins here if not in guest
139         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "type=".$data['type'].",action=".getAction().",what=".getWhat().",level=".$data['access_level']."<br />");
140         if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getIndexHome()))) && ($data['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.6')))) {
141                 // Handle failure
142                 $content['content'] .= handleLoginFailures($data['access_level']);
143         } // END - if
144
145         // Return the content
146         return $content;
147 }
148
149 // Filter for redirecting to logout if sql_patches has been installed
150 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
151         // Remove this filter
152         unregisterFilter(__FUNCTION__, __LINE__, 'shutdown', __FUNCTION__);
153
154         // Is the element set?
155         if (isset($GLOBALS['ext_load_mode'])) {
156                 // Redirect here
157                 redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
158         } // END - if
159
160         // This should not happen!
161         logDebugMessage(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
162 }
163
164 // Filter for auto-activation of a extension
165 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
166         // Debug message
167         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $data['ext_name'] . ',isThisExtensionAlwaysActive()=' . intval(isThisExtensionAlwaysActive()));
168
169         // Is this extension always activated?
170         if (isThisExtensionAlwaysActive()) {
171                 // Then activate the extension
172                 doActivateExtension($data['ext_name']);
173         } // END - if
174
175         // Return the data
176         return $data;
177 }
178
179 // Filter for solving task given task
180 function FILTER_SOLVE_TASK ($data) {
181         // Don't solve anything if no admin!
182         if (!isAdmin()) return $data;
183
184         // Is this a direct task id or array element task_id is found?
185         if (is_int($data)) {
186                 // Then solve it...
187                 adminSolveTask($data);
188         } elseif ((is_array($data)) && (isset($data['task_id']))) {
189                 // Solve it...
190                 adminSolveTask($data['task_id']);
191         } else {
192                 // Not detectable!
193                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($data), print_r($data, true)));
194         }
195
196         // Return the data
197         return $data;
198 }
199
200 // Filter to load include files
201 function FILTER_LOAD_INCLUDES ($pool) {
202         // Is it null?
203         if (is_null($pool)) {
204                 // This should not happen!
205                 debug_report_bug(__FUNCTION__, __LINE__, 'pool is null.');
206         } // END - if
207
208         // Is the pool an array and 'pool' set?
209         if ((is_array($pool)) && (isset($pool['pool']))) {
210                 // Then use it as pool
211                 $realPool = $pool['pool'];
212         } else {
213                 // Default is $data as inclusion list
214                 $realPool = $pool;
215         }
216
217         // Get inc pool
218         $data = getIncludePool($realPool);
219
220         // Is it an array?
221         if ((!isset($data)) || (!is_array($data))) {
222                 // Then abort here
223                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("INC_POOL is no array! Type: %s", gettype($data)));
224         } elseif (isset($data['inc_pool'])) {
225                 // Use this as new inclusion pool!
226                 setIncludePool($realPool, $data['inc_pool']);
227         }
228
229         // Check for added include files
230         if (countIncludePool($realPool) > 0) {
231                 // Loads every include file
232                 loadIncludePool($realPool);
233
234                 // Reset array
235                 initIncludePool($realPool);
236         } // END - if
237
238         // Continue with processing
239         return $pool;
240 }
241
242 // Filter for running SQL commands
243 function FILTER_RUN_SQLS ($data) {
244         // Debug message
245         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Entered!');
246
247         // Is the array there?
248         if ((isSqlsValid()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
249                 // Run SQL commands
250                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Found ' . countSqls() . ' queries to run.');
251                 foreach (getSqls() as $mode=>$sqls) {
252                         // Debug message
253                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mode=' . $mode . ',count()=' . count($sqls));
254
255                         // New cache format...
256                         foreach ($sqls as $sql) {
257                                 // Trim spaces away
258                                 $sql = trim($sql);
259
260                                 // Is 'enable_codes' not set? Then set it to true
261                                 if (!isset($data['enable_codes'])) {
262                                         $data['enable_codes'] = true;
263                                 } // END - if
264
265                                 // Is there still a query left?
266                                 if (!empty($sql)) {
267                                         // Do we have an "ALTER TABLE" command?
268                                         if (substr(strtolower($sql), 0, 11) == 'alter table') {
269                                                 // Analyse the alteration command
270                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Alterting table: ' . $sql . ',enable_codes=' . intval($data['enable_codes']));
271                                                 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__, $data['enable_codes']);
272                                         } else {
273                                                 // Run regular SQL command
274                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running regular query: ' . $sql . ',enable_codes=' . intval($data['enable_codes']));
275                                                 SQL_QUERY($sql, __FUNCTION__, __LINE__, $data['enable_codes']);
276                                         }
277                                 } // END - if
278                         } // END - foreach
279                 } // END - foreach
280         } // END - if
281
282         // Debug message
283         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
284 }
285
286 // Filter for updating/validating login data
287 function FILTER_UPDATE_LOGIN_DATA () {
288         // Add missing array
289         if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) {
290                 $GLOBALS['last_online'] = array();
291         } // END - if
292
293         // Recheck if logged in
294         if (!isMember()) {
295                 return false;
296         } // END - if
297
298         // Secure user id
299         setMemberId(getSession('userid'));
300
301         // Found a userid?
302         if (fetchUserData(getMemberId())) {
303                 // Load last module and online time
304                 $content = getUserDataArray();
305
306                 // Maybe first login time?
307                 if (empty($content['last_module'])) $content['last_module'] = 'login';
308
309                 // This will be displayed on welcome page! :-)
310                 if (empty($GLOBALS['last_online']['module'])) {
311                         $GLOBALS['last_online']['module'] = $content['last_module'];
312                         $GLOBALS['last_online']['online'] = $content['last_online'];
313                 } // END - if
314
315                 // 'what' not set?
316                 if (!isWhatSet()) {
317                         // Fix it to default
318                         setWhat('welcome');
319                         if (getIndexHome() != '') setWhatFromConfig('index_home');
320                 } // END - if
321
322                 // Update last module / online time
323                 updateLastActivity(getMemberId());
324         }  else {
325                 // Destroy session, we cannot update!
326                 destroyMemberSession();
327         }
328 }
329
330 // Filter for initializing randomizer
331 function FILTER_INIT_RANDOMIZER () {
332         // Only execute this filter if installed
333         if ((!isInstalled()) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) {
334                 return;
335         } // END - if
336
337         // Take a prime number which is long (if you know a longer one please try it out!)
338         setConfigEntry('_PRIME', 591623);
339
340         // Calculate "entropy" with the prime number (for code generation)
341         setConfigEntry('_ADD', (getPrime() * getPrime() / (pi() * getCodeLength() + 1)));
342
343         // Simply init the randomizer with seed and _ADD value
344         mt_srand(generateSeed() + getConfig('_ADD'));
345 }
346
347 // Filter for removing updates
348 function FILTER_REMOVE_UPDATES ($data) {
349         // Init removal list
350         initExtensionRemovalList();
351
352         // Add the current extension to it
353         addCurrentExtensionToRemovalList();
354
355         // Simply remove it
356         unsetExtensionSqls();
357
358         // Do we need to remove update depency?
359         if (countExtensionUpdateDependencies() > 0) {
360                 // Then find all updates we shall no longer execute
361                 foreach (getExtensionUpdateDependencies() as $id => $ext_name) {
362                         // Shall we remove this update?
363                         if (in_array($ext_name, getExtensionRemovalList())) {
364                                 // Then remove this extension!
365                                 removeExtensionDependency($ext_name);
366                         } // END - if
367                 } // END - foreach
368         } // END - if
369
370         // Return data
371         return $data;
372 }
373
374 // Determines username for current user state
375 function FILTER_DETERMINE_USERNAME () {
376         // Check if logged in
377         if (isMember()) {
378                 // Is still logged in so we welcome him with his name
379                 if (fetchUserData(getMemberId())) {
380                         // Load surname and family's name and build the username
381                         $content = getUserDataArray();
382
383                         // Prepare username
384                         setUsername($content['surname'] . ' ' . $content['family']);
385
386                         // Additionally admin?
387                         if (isAdmin()) {
388                                 // Add it
389                                 setUsername(getUsername() . ' ({--USERNAME_ADMIN_SHORT--})');
390                         } // END - if
391                 } else {
392                         // Hmmm, logged in and no valid userid?
393                         setUsername('<em>{--USERNAME_UNKNOWN--}</em>');
394
395                         // Destroy session
396                         destroyMemberSession();
397                 }
398         } elseif (isAdmin()) {
399                 // Admin is there
400                 setUsername('{--USERNAME_ADMIN--}');
401         } else {
402                 // He's a guest, hello there... ;-)
403                 setUsername('{--USERNAME_GUEST--}');
404         }
405 }
406
407 // Filter for compiling config entries
408 function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
409         // Save the uncompiled code
410         $uncompiled = $code;
411
412         // Do we have cache?
413         if (!isset($GLOBALS['compiled_config'][$code])) {
414                 // Compile {?some_var?} to getConfig('some_var')
415                 preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
416
417                 // Some entries found?
418                 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
419                         // Replace all matches
420                         foreach ($matches[0] as $key => $match) {
421                                 // Do we have cache?
422                                 if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
423                                         // Is the config valid?
424                                         if (isConfigEntrySet($matches[1][$key])) {
425                                                 // Set it for caching
426                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . $matches[1][$key] . '%}';
427                                         } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
428                                                 // Use default value
429                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . 'DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
430                                         } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
431                                                 // No config, try the language system
432                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '{%message,DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
433                                         } else {
434                                                 // Unhandled!
435                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
436                                         }
437                                 } // END - if
438
439                                 // Use this for replacing
440                                 $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
441                                 //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die(__FUNCTION__.'['.__LINE__.']:<pre>'.secureString($code).'</pre>');
442                         } // END - foreach
443                 } // END - if
444
445                 // Add it to cache
446                 $GLOBALS['compiled_config'][$uncompiled] = $code;
447         } // END - if
448
449         // Should we compile it?
450         if ($compiled === true) {
451                 // Run the code
452                 $eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . '";';
453                 //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>' . encodeEntities($eval) . '</pre>');
454                 eval($eval);
455         } // END - if
456
457         // Return compiled code
458         return $GLOBALS['compiled_config'][$uncompiled];
459 }
460
461 // Filter for compiling expression code
462 function FILTER_COMPILE_EXPRESSION_CODE ($code) {
463         // Compile {%cmd,callback,extraFunction=some_value%} to get expression code snippets
464         // See switch() command below for supported commands
465         preg_match_all('/\{%(([a-zA-Z0-9-_,]+)(=([^\}]+)){0,1})*%\}/', $code, $matches);
466         //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.print_r($matches, true).'</pre>');
467
468         // Default is from outputHtml()
469         $outputMode = getScriptOutputMode();
470
471         // Some entries found?
472         if ((count($matches) > 0) && (count($matches[3]) > 0)) {
473                 // Replace all matches
474                 foreach ($matches[2] as $key => $cmd) {
475                         // Init replacer/call-back variable
476                         $replacer       = '';
477                         $callback       = '';
478                         $extraFunction  = '';
479                         $extraFunction2 = '';
480                         $value          = null;
481
482                         // Extract command and call-back
483                         $cmdArray = explode(',', $cmd);
484                         $cmd = $cmdArray[0];
485
486                         // Detect call-back function
487                         if (isset($cmdArray[1])) {
488                                 // Call-back function detected
489                                 $callback = $cmdArray[1];
490                         } // END - if
491
492                         // Detect extra function
493                         if (isset($cmdArray[2])) {
494                                 // Also detected
495                                 $extraFunction = $cmdArray[2];
496                         } // END - if
497
498                         // Detect extra function 2
499                         if (isset($cmdArray[3])) {
500                                 // Also detected
501                                 $extraFunction2 = $cmdArray[3];
502                         } // END - if
503
504                         // And value
505                         if (isset($matches[4][$key])) {
506                                 // Use this as value
507                                 $value = $matches[4][$key];
508                         } // END - if
509
510                         // Construct call-back function name for the command
511                         $commandFunction = 'doExpression' . capitalizeUnderscoreString($cmd);
512
513                         // Is this function there?
514                         if (function_exists($commandFunction)) {
515                                 // Prepare $matches, $key, $outputMode, etc.
516                                 $data = array(
517                                         'matches'     => $matches,
518                                         'key'         => $key,
519                                         'mode'        => getScriptOutputMode(),
520                                         'code'        => $code,
521                                         'callback'    => $callback,
522                                         'extra_func'  => $extraFunction,
523                                         'extra_func2' => $extraFunction2,
524                                         'value'       => $value
525                                 );
526
527                                 // Call it
528                                 //* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: function=' . $commandFunction);
529                                 $code = call_user_func($commandFunction, $data);
530                         } else {
531                                 // Unsupported command detected
532                                 logDebugMessage(__FUNCTION__, __LINE__, 'Command cmd=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
533                         }
534                 } // END - foreach
535         } // END - if
536
537         // Do we have non-HTML mode?
538         if (!isHtmlOutputMode()) {
539                 $code = decodeEntities($code);
540         } // END - if
541
542         // Return compiled code
543         //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.($code).'</pre>');
544         return $code;
545 }
546
547 // Runs some generic filter update steps
548 function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
549         // Create task (we ignore the task id here)
550         createExtensionUpdateTask(getCurrentAdminId(), $ext_name, $GLOBALS['update_ver'][$ext_name], SQL_ESCAPE(getExtensionNotes(getExtensionNotes())));
551
552         // Update extension's version
553         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_version`='%s' WHERE `ext_name`='%s' LIMIT 1",
554                 array($GLOBALS['update_ver'][$ext_name], $ext_name), __FUNCTION__, __LINE__);
555
556         // Remove arrays
557         unsetSqls();
558         unset($GLOBALS['update_ver'][$ext_name]);
559 }
560
561 // Load more hourly reset scripts
562 function FILTER_RUN_HOURLY_INCLUDES () {
563         // Is the reset set or old sql_patches?
564         if (((!isHourlyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) && (isHtmlOutputMode())) {
565                 // Then abort here
566                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isHourlyResetEnabled()).',ext_newer[sql_patches:0.7.5]='.intval(isExtensionInstalledAndNewer('sql_patches', '0.7.5')).' Please report this bug. Thanks');
567         } // END - if
568
569         // Get more hourly reset scripts
570         setIncludePool('hourly', getArrayFromDirectory('inc/hourly/', 'hourly_'));
571
572         // Update database
573         if ((!isConfigEntrySet('DEBUG_RESET')) || (!isDebugResetEnabled())) {
574                 updateConfiguration('last_hour', getHour());
575         } // END - if
576
577         // Run the filter
578         runFilterChain('load_includes', 'hourly');
579 }
580
581 // Load more reset scripts
582 function FILTER_RUN_RESET_INCLUDES () {
583         // Is the reset set or old sql_patches?
584         if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (isHtmlOutputMode())) {
585                 // Then abort here
586                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
587         } // END - if
588
589         // Get more daily reset scripts
590         setIncludePool('reset', getArrayFromDirectory('inc/daily/', 'daily_'));
591
592         // Update database
593         if ((!isConfigEntrySet('DEBUG_RESET')) || (!isDebugResetEnabled())) {
594                 updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
595         } // END - if
596
597         // Is the config entry set?
598         if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
599                 // Create current week mark
600                 $currWeek = getWeek();
601
602                 // Has it changed?
603                 if ((getConfig('last_week') != $currWeek) || (isWeeklyResetDebugEnabled())) {
604                         // Include weekly reset scripts
605                         mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
606
607                         // Update config if not in debug mode
608                         if (!isWeeklyResetDebugEnabled()) updateConfiguration('last_week', $currWeek);
609                 } // END - if
610
611                 // Create current month mark
612                 $currMonth = getMonth();
613
614                 // Has it changed?
615                 if ((getLastMonth() != $currMonth) || (isMonthlyResetDebugEnabled())) {
616                         // Include monthly reset scripts
617                         mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
618
619                         // Update config
620                         if (!isMonthlyResetDebugEnabled()) {
621                                 updateConfiguration('last_month', $currMonth);
622                         } // END - if
623                 } // END - if
624         } // END - if
625
626         // Run the filter
627         runFilterChain('load_includes', 'reset');
628 }
629
630 // Filter for removing the given extension
631 function FILTER_REMOVE_EXTENSION () {
632         // Delete this extension (remember to remove it from your server *before* you click on welcome!
633         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
634                 array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
635
636         // Remove the extension from cache array as well
637         removeExtensionFromArray();
638
639         // Remove the cache
640         rebuildCache('extension', 'extension');
641 }
642
643 // Filter for flushing the output
644 function FILTER_FLUSH_OUTPUT () {
645         // Simple, he?
646         outputHtml('');
647 }
648
649 // Prepares an SQL statement part for HTML mail and/or holiday depency
650 function FILTER_HTML_INCLUDE_USERS ($mode) {
651         // Exclude no users by default
652         $MORE = '';
653
654         // HTML mail?
655         if ($mode == 'html') $MORE = " AND `html`='Y'";
656         if (isExtensionInstalledAndNewer('holiday', '0.1.3')) {
657                 // Add something for the holiday extension
658                 $MORE .= " AND `holiday_active`='N'";
659         } // END - if
660
661         // Return result
662         return $MORE;
663 }
664
665 // Filter for determining what/action/module
666 function FILTER_DETERMINE_WHAT_ACTION () {
667         // In installation phase we don't have what/action
668         if (isInstallationPhase()) {
669                 // Set both to empty
670                 setAction('');
671                 setWhat('');
672
673                 // Abort here
674                 return;
675         } // END - if
676
677         // Get all values
678         if ((!isCssOutputMode()) && (!isRawOutputMode())) {
679                 // Fix module
680                 if (!isModuleSet()) {
681                         // Is the request element set?
682                         if (isGetRequestParameterSet('module')) {
683                                 // Set module from request
684                                 setModule(getRequestParameter('module'));
685                         } elseif (isHtmlOutputMode()) {
686                                 // Set default module 'index'
687                                 setModule('index');
688                         } else {
689                                 // Unknown module
690                                 setModule('unknown');
691                         }
692                 } // END - if
693
694                 // Fix 'what' if not yet set
695                 if (!isWhatSet()) {
696                         setWhat(getWhatFromModule(getModule()));
697                 } // END - if
698
699                 // Fix 'action' if not yet set
700                 if (!isActionSet()) {
701                         setAction(getActionFromModuleWhat(getModule(), getWhat()));
702                 } // END - if
703         } else {
704                 // Set action/what to empty
705                 setAction('');
706                 setWhat('');
707         }
708
709         // Set default 'what' value
710         //* DEBUG: */ debugOutput('-' . getModule() . '/' . getWhat() . '-');
711         if ((!isWhatSet()) && (!isActionSet()) && (!isCssOutputMode()) && (!isRawOutputMode())) {
712                 if (getModule() == 'admin') {
713                         // Set 'action' value to 'login' in admin menu
714                         setAction(getActionFromModuleWhat(getModule(), getWhat()));
715                 } elseif ((getModule() == 'index') || (getModule() == 'login')) {
716                         // Set 'what' value to 'welcome' in guest and member menu
717                         setWhatFromConfig('index_home');
718                 } else {
719                         // Anything else like begging link
720                         setWhat('');
721                 }
722         } // END - if
723 }
724
725 // Sends out pooled mails
726 function FILTER_TRIGGER_SENDING_POOL () {
727         // Are we in normal output mode?
728         if (!isHtmlOutputMode()) {
729                 // Only in normal output mode to prevent race-conditons!
730         } // END - if
731
732         // Init counter
733         $GLOBALS['pool_cnt'] = '0';
734
735         // Init & set the include pool
736         initIncludePool('pool');
737         setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));
738
739         // Run the filter
740         runFilterChain('load_includes', 'pool');
741
742         // Remove the counter
743         unset($GLOBALS['pool_cnt']);
744 }
745
746 // Filter for checking and updating SVN revision
747 function FILTER_CHECK_REPOSITORY_REVISION () {
748         // Only execute this filter if installed and all config entries are there
749         if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) return;
750
751         // Check for patch level differences between database and current hard-coded
752         if ((getCurrentRepositoryRevision() > getConfig('patch_level')) || (getConfig('patch_level') == 'CURRENT_REPOSITORY_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
753                 // Update database and CONFIG array
754                 updateConfiguration(array('patch_level', 'patch_ctime'), array(getCurrentRepositoryRevision(), 'UNIX_TIMESTAMP()'));
755                 setConfigEntry('patch_level', getCurrentRepositoryRevision());
756                 setConfigEntry('patch_ctime', time());
757         } // END - if
758 }
759
760 // Filter for running daily reset
761 function FILTER_RUN_DAILY_RESET () {
762         // Only execute this filter if installed
763         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalled('sql_patches'))) {
764                 return;
765         } // END - if
766
767         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
768         if (((getDay(getConfig('last_update')) != getDay()) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestParameterSet('register')) && (!isCssOutputMode())) {
769                 // Tell every module we are in reset-mode!
770                 doReset();
771         } // END - if
772 }
773
774 // Filter for running hourly reset
775 function FILTER_RUN_HOURLY_RESET () {
776         // Only execute this filter if installed
777         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) {
778                 return;
779         } // END - if
780
781         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
782         if (((getConfig('last_hour') != getHour()) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestParameterSet('register')) && (!isCssOutputMode())) {
783                 // Tell every module we are in reset-mode!
784                 doHourly();
785         } // END - if
786 }
787
788 // Filter for loading more runtime includes (not for installation)
789 function FILTER_LOAD_RUNTIME_INCLUDES () {
790         // Load more includes
791         foreach (array('databases', 'session', 'versions') as $inc) {
792                 // Load the include
793                 loadIncludeOnce('inc/' . $inc . '.php');
794         } // END - foreach
795 }
796
797 // Filter for checking admin ACL
798 function FILTER_CHECK_ADMIN_ACL () {
799         // Extension not installed so it's always allowed to access everywhere!
800         $ret = true;
801
802         // Ok, Cookie-Update done
803         if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
804                 // Check if action GET variable was set
805                 $action = getAction();
806                 if (isWhatSet()) {
807                         // Get action value by what-value
808                         $action = getActionFromModuleWhat('admin', getWhat());
809                 } // END - if
810
811                 // Check for access control line of current menu entry
812                 $ret = adminsCheckAdminAcl($action, getWhat());
813         } // END - if
814
815         // Set it here
816         $GLOBALS['acl_allow'] = $ret;
817 }
818
819 // Init random number/cache buster
820 function FILTER_INIT_RANDOM_NUMBER () {
821         // Is the extension sql_patches installed and at least 0.3.6?
822         if ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
823                 // Generate random number
824                 setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 32766), getMemberId(), ''));
825         } else {
826                 // Generate *WEAK* code
827                 setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
828         }
829
830         // Copy it to CACHE_BUSTER
831         setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
832 }
833
834 // Update module counter
835 function FILTER_COUNT_MODULE () {
836         // Do count all other modules but not accesses on CSS file css.php!
837         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
838                 array(getModule()), __FUNCTION__, __LINE__);
839 }
840
841 // Handles fatal errors
842 function FILTER_HANDLE_FATAL_ERRORS () {
843         // Do we have errors to handle and right output mode?
844         if ((!ifFatalErrorsDetected()) || (!isHtmlOutputMode())) {
845                 // Abort executing here
846                 return false;
847         } // END - if
848
849         // Set content type
850         setContentType('text/html');
851
852         // Load config here
853         loadIncludeOnce('inc/load_config.php');
854
855         // Set unset variable
856         if (empty($check)) $check = '';
857
858         // Default is none
859         $content = '';
860
861         // Installation phase or regular mode?
862         if ((isInstallationPhase())) {
863                 // While we are installing ouput other header than while it is installed... :-)
864                 $OUT = '';
865                 foreach (getFatalArray() as $key => $value) {
866                         // Prepare content for the template
867                         $content = array(
868                                 'key'   => ($key + 1),
869                                 'value' => $value
870                         );
871
872                         // Load row template
873                         $OUT .= loadTemplate('install_fatal_row', true, $content);
874                 }
875
876                 // Load main template
877                 $content = loadTemplate('install_fatal_table', true, $OUT);
878         } elseif (isInstalled()) {
879                 // Display all runtime fatal errors
880                 $OUT = '';
881                 foreach (getFatalArray() as $key => $value) {
882                         // Prepare content for the template
883                         $content = array(
884                                 'key'   => ($key + 1),
885                                 'value' => $value
886                         );
887
888                         // Load row template
889                         $OUT .= loadTemplate('runtime_fatal_row', true, $content);
890                 }
891
892                 // Load main template
893                 $content = loadTemplate('runtime_fatal_table', true, $OUT);
894         }
895
896         // Message to regular users (non-admin)
897         $CORR = '{--FATAL_REPORT_ERRORS--}';
898
899         // PHP warnings fixed
900         if ($check == 'done') {
901                 if (isAdmin()) $CORR = '{--FATAL_CORRECT_ERRORS--}';
902         } // END - if
903
904         // Remember all in array
905         $content = array(
906                 'rows' => $content,
907                 'corr' => $CORR
908         );
909
910         // Load footer
911         loadIncludeOnce('inc/header.php');
912
913         // Load main template
914         loadTemplate('fatal_errors', false, $content);
915
916         // Delete all to prevent double-display
917         initFatalMessages();
918
919         // Load footer
920         loadIncludeOnce('inc/footer.php');
921
922         // Abort here
923         shutdown();
924 }
925
926 // Filter for displaying copyright line
927 function FILTER_DISPLAY_COPYRIGHT () {
928         // Shall we display the copyright notice?
929         if ((!isGetRequestParameterSet('frame')) && (basename($_SERVER['PHP_SELF']) != 'mailid_top.php') && ((getConfig('WRITE_FOOTER') == 'Y') || (isInstalling())) && ($GLOBALS['header_sent'] == 2)) {
930                 // Backlink enabled?
931                 if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
932                         // Copyright with backlink, thanks! :-)
933                         $GLOBALS['page_footer'] .= loadTemplate('copyright_backlink', true);
934                 } else {
935                         // No backlink in Copyright note
936                         $GLOBALS['page_footer'] .= loadTemplate('copyright', true);
937                 }
938         } // END - if
939 }
940
941 // Filter for displaying parsing time
942 function FILTER_DISPLAY_PARSING_TIME () {
943         // Shall we display the parsing time and number of queries?
944         // 1234                            5                      54    4         5              5       4    4                       5       543    3                   4432    2             33     2    2                              21
945         if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestParameterSet('frame'))) || (isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['header_sent'] == 2)) {
946                 // Then display it here
947                 displayParsingTime();
948         } // END - if
949 }
950
951 // Filter for flushing template cache
952 function FILTER_FLUSH_TEMPLATE_CACHE () {
953         // Do not flush when debugging the template cache
954         if (isDebuggingTemplateCache()) return;
955
956         // Do we have cached eval() data?
957         if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
958                 // Now flush all
959                 foreach ($GLOBALS['template_eval'] as $template => $eval) {
960                         // Flush the cache (if not yet found)
961                         flushTemplateCache($template, $eval);
962                 } // END - if
963         } // END - if
964 }
965
966 // Filter for loading user data
967 function FILTER_FETCH_USER_DATA ($userid = 0) {
968         // Is the userid not set? Then use member id
969         if (($userid == '0') || (is_null($userid))) $userid = getMemberId();
970
971         // Get user data
972         if (!fetchUserData($userid)) {
973                 // Userid is not valid
974                 debug_report_bug(__FUNCTION__, __LINE__, 'User id '.$userid . ' is invalid.');
975         } // END - if
976
977         // Set member id
978         setMemberId($userid);
979 }
980
981 // Filter for reseting users' last login failure, only available with latest ext-sql_patches
982 function FILTER_RESET_USER_LOGIN_FAILURE () {
983         // Is the user data valid?
984         if (!isMember()) {
985                 // Do only run for logged in members
986                 debug_report_bug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
987         } // END - if
988
989         // Remmeber login failures if available
990         if (isExtensionInstalledAndNewer('user', '0.3.7')) {
991                 // Reset login failures
992                 SQL_QUERY_ESC("UPDATE
993         `{?_MYSQL_PREFIX?}_user_data`
994 SET
995         `login_failures`=0,
996         `last_failure`=NULL
997 WHERE
998         `userid`=%s
999 LIMIT 1",
1000                         array(getMemberId()), __FUNCTION__, __LINE__);
1001
1002                 // Store it in session
1003                 setSession('mailer_member_failures' , getUserData('login_failures'));
1004                 setSession('mailer_member_last_failure', getUserData('last_failure'));
1005         } // END - if
1006 }
1007
1008 // Try to login the admin by setting some session/cookie variables
1009 function FILTER_DO_LOGIN_ADMIN ($data) {
1010         // Now set all session variables and store the result for later processing
1011         $GLOBALS['admin_login_success'] = ((
1012                 setAdminMd5(encodeHashForCookie($data['pass_hash']))
1013         ) && (
1014                 setAdminId($data['id'])
1015         ) && (
1016                 setAdminLast(time())
1017         ));
1018
1019         // Return the data¬†for further processing
1020         return $data;
1021 }
1022
1023 // Filter for loading page header, this should be ran first!
1024 function FILTER_LOAD_PAGE_HEADER () {
1025         // Output page header code
1026         $GLOBALS['page_header'] = loadTemplate('page_header', true);
1027
1028         // Include meta data in 'guest' module
1029         if (getModule() == 'index') {
1030                 // Load meta data template
1031                 $GLOBALS['page_header'] .= loadTemplate('metadata', true);
1032
1033                 // Add meta description to header
1034                 if ((isInstalled()) && (isAdminRegistered()) && (SQL_IS_LINK_UP())) {
1035                         // Add meta description not in admin and login module and when the script is installed
1036                         generateMetaDescriptionCode();
1037                 } // END - if
1038         } // END - if
1039 }
1040
1041 // Filter for adding style sheet, closing page header
1042 function FILTER_FINISH_PAGE_HEADER () {
1043         // Include stylesheet
1044         loadIncludeOnce('inc/stylesheet.php');
1045
1046         // Closing HEAD tag
1047         $GLOBALS['page_header'] .= '</head>';
1048 }
1049
1050 // Cleans up the DNS cache if sql_patches is at least 0.7.0
1051 function FILTER_CLEANUP_DNS_CACHE () {
1052         // Is the latest version installed?
1053         if (isExtensionInstalledAndNewer('sql_patches', '0.7.0')) {
1054                 // Load class file
1055                 loadIncludeOnce('inc/classes/resolver.class.php');
1056
1057                 // Instance the resolver
1058                 $resolver = new HostnameResolver();
1059
1060                 // Purge entries
1061                 $resolver->purgeEntries();
1062
1063                 // Cute, isn't it? ;-)
1064         } // END - if
1065 }
1066
1067 // Filter for setting CURRENT_DATE, this is required after initialization of extensions
1068 function FILTER_SET_CURRENT_DATE () {
1069         // Set current date
1070         setConfigEntry('CURRENT_DATE', generateDateTime(time(), '3'));
1071
1072         // Timestamp for yesterday, today ... all at 00:00 am
1073         setConfigEntry('START_YDAY', makeTime(0, 0, 0, time() - getOneDay()));
1074         setConfigEntry('START_TDAY', makeTime(0, 0, 0, time()));
1075 }
1076
1077 // [EOF]
1078 ?>