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