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