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 - 2013 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 ((!isSqlLinkUp()) && (!isInstallationPhase())) {
  50                 // Abort here
  51                 reportBug(__FUNCTION__, __LINE__, 'No database link is up. Cannot flush filters.');
  52         } elseif ((isInstallationPhase()) && (!isSqlLinkUp())) {
  53                 // If the link is not up in installation phase, skip flushing filters
  54                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot flush filters: No link is up.');
  55                 return;
  56         }
  57
  58         // Is the extension ext-sql_patches updated?
  59         if (((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9'))) && (!isInstallationPhase())) {
  60                 // Log only in debug mode
  61                 if (isDebugModeEnabled()) {
  62                         logDebugMessage(__FUNCTION__, __LINE__, 'Cannot flush filters, ext-sql_patches might be missing. isExtensionInstalled()=' . intval(isExtensionInstalled('sql_patches')) . ',isExtensionInstalledAndOlder()=' . intval(isExtensionInstalledAndOlder('sql_patches', '0.5.9')));
  63                 } // END - if
  64
  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: */ logDebugMessage(__FUNCTION__, __LINE__, 'FOUND:'.$filterName.'/'.$filterFunction.'='.$active);
  83                         if (((!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) && ($active != 'R')) || ($active == 'A')) {
  84                                 // Is this filter already in database?
  85                                 if (countSumTotalData($filterFunction, 'filters', 'filter_name', 'filter_function', TRUE, sprintf(" AND `filter_name`='%s'", sqlEscapeString($filterName))) == 0) {
  86                                         // Add this filter (all filters are active by default)
  87                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD:'.$filterName.'/'.$filterFunction);
  88                                         $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
  89                                         $inserted++;
  90                                 } elseif (isDebugModeEnabled()) {
  91                                         // Log already registered filters
  92                                         logDebugMessage(__FUNCTION__, __LINE__, 'Already registered: filterName=' . $filterName . ',filterFunction=' . $filterFunction . ',active=' . $active);
  93                                 }
  94                         } elseif ($active == 'R') {
  95                                 // Remove this filter
  96                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'REMOVE:'.$filterName.'/'.$filterFunction);
  97                                 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
  98                                 $removed++;
  99                         }
 100                 } // END - foreach
 101         } // END - foreach
 102
 103         // Debug message
 104         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'inserted=' . $inserted . ',removed=' . $removed . ' - AFTER COLLECTION');
 105
 106         // Something has been added?
 107         if ($inserted > 0) {
 108                 // Finish SQL command and add it
 109                 addSql(substr($insertSQL, 0, -1));
 110         } // END - if
 111
 112         // Something has been removed?
 113         if ($removed > 0) {
 114                 // Finish SQL command and add it
 115                 addSql(substr($removeSQL, 0, -2) . 'LIMIT ' . $removed);
 116         } // END - if
 117
 118         // Shall we update usage counters (ONLY FOR DEBUGGING!)
 119         if (isFilterUsageUpdateEnabled()) {
 120                 // Update all counters
 121                 foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
 122                         // Walk through all filters
 123                         foreach ($filterArray as $filterFunction => $count) {
 124                                 // Construct and add the query
 125                                 addSql(sprintf("UPDATE `{?_MYSQL_PREFIX?}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
 126                                         bigintval($count),
 127                                         $filterName,
 128                                         $filterFunction
 129                                 ));
 130                         } // END - foreach
 131                 } // END - foreach
 132         } // END - if
 133
 134         // Run the run_sqls filter in non-dry mode
 135         runFilterChain('run_sqls');
 136
 137         // Should we rebuild cache?
 138         if (($inserted > 0) || ($removed > 0)) {
 139                 // Destroy cache
 140                 rebuildCache('filter', 'filter');
 141         } // END - if
 142 }
 143
 144 // Filter for calling the handler for login failures
 145 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($filterData) {
 146         // Init content
 147         $content = $filterData;
 148
 149         // Handle failed logins here if not in guest
 150         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'type=' . $filterData['type'] . ',action=' . getAction() . ',what=' . getWhat() . ',level=' . $filterData['access_level']);
 151         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')))) {
 152                 // Handle failure
 153                 $content['content'] .= handleLoginFailures($filterData['access_level']);
 154         } // END - if
 155
 156         // Return the content
 157         return $content;
 158 }
 159
 160 // Filter for auto-activation of a extension
 161 function FILTER_AUTO_ACTIVATE_EXTENSION ($filterData) {
 162         // Debug message
 163         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $filterData['ext_name'] . ',isThisExtensionAlwaysActive()=' . intval(isThisExtensionAlwaysActive()));
 164
 165         // Is this extension always activated?
 166         if (isThisExtensionAlwaysActive()) {
 167                 // Then activate the extension
 168                 doActivateExtension($filterData['ext_name']);
 169         } // END - if
 170
 171         // Return the data
 172         return $filterData;
 173 }
 174
 175 // Filter for solving task given task
 176 function FILTER_SOLVE_TASK ($filterData) {
 177         // Don't solve anything if no admin!
 178         if (!isAdmin()) {
 179                 return $filterData;
 180         } // END - if
 181
 182         // Is this a direct task id or array element task_id is found?
 183         if (is_int($filterData)) {
 184                 // Then solve it...
 185                 adminSolveTask($filterData);
 186         } elseif ((is_array($filterData)) && (isset($filterData['task_id']))) {
 187                 // Solve it...
 188                 adminSolveTask($filterData['task_id']);
 189         } else {
 190                 // Not detectable!
 191                 reportBug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($filterData), print_r($filterData, TRUE)));
 192         }
 193
 194         // Return the data
 195         return $filterData;
 196 }
 197
 198 // Filter to load include files
 199 function FILTER_LOAD_INCLUDES ($filterData) {
 200         // Is it null?
 201         if (is_null($filterData)) {
 202                 // This should not happen!
 203                 reportBug(__FUNCTION__, __LINE__, 'pool is null.');
 204         } // END - if
 205
 206         // Is the pool an array and 'pool' set?
 207         if ((is_array($filterData)) && (isset($filterData['pool']))) {
 208                 // Then use it as pool
 209                 $realPool = $filterData['pool'];
 210         } else {
 211                 // Default is $data as inclusion list
 212                 $realPool = $filterData;
 213         }
 214
 215         // Get inc pool
 216         $data = getIncludePool($realPool);
 217
 218         // Is it an array?
 219         if ((!isset($data)) || (!is_array($data))) {
 220                 // Then abort here
 221                 reportBug(__FUNCTION__, __LINE__, sprintf("INC_POOL is no array! Type: %s", gettype($data)));
 222         } elseif (isset($data['inc_pool'])) {
 223                 // Use this as new inclusion pool!
 224                 setIncludePool($realPool, $data['inc_pool']);
 225         }
 226
 227         // Check for added include files
 228         if (countIncludePool($realPool) > 0) {
 229                 // Loads every include file
 230                 loadIncludePool($realPool);
 231
 232                 // Reset array
 233                 initIncludePool($realPool);
 234         } // END - if
 235
 236         // Continue with processing
 237         return $filterData;
 238 }
 239
 240 // Filter for running SQL commands
 241 function FILTER_RUN_SQLS ($filterData) {
 242         // Init counter
 243         $count = 0;
 244
 245         // Debug message
 246         //* DEBUG: */ die('getSqls()=<pre>'.print_r(getSqls(), TRUE).'</pre>ext_update_depends=<pre>'.print_r($GLOBALS['ext_update_depends'], TRUE).'</pre>');
 247         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Entered!');
 248
 249         // Is the array there?
 250         if ((isSqlsValid()) && ((!isset($filterData['dry_run'])) || ($filterData['dry_run'] == FALSE))) {
 251                 // Run SQL commands
 252                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Found ' . countSqls() . ' queries to run.');
 253                 foreach (getSqls() as $mode => $sqls) {
 254                         // Debug message
 255                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mode=' . $mode . ',count()=' . count($sqls));
 256
 257                         // New cache format...
 258                         foreach ($sqls as $sql) {
 259                                 // Trim spaces away
 260                                 $sql = trim($sql);
 261
 262                                 // Is 'enable_codes' not set? Then set it to true
 263                                 if (!isset($filterData['enable_codes'])) {
 264                                         $filterData['enable_codes'] = TRUE;
 265                                 } // END - if
 266
 267                                 // Is there still a query left?
 268                                 if (!empty($sql)) {
 269                                         // Is there an "ALTER TABLE" command? Exclude installation phase here as it would cause this query to fail
 270                                         if ((substr(strtolower($sql), 0, 11) == 'alter table') && (!isset($filterData['ext_installing']))) {
 271                                                 // Analyse the alteration command
 272                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Alterting table: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
 273                                                 sqlQueryAlterTable($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
 274                                         } else {
 275                                                 // Run regular SQL command
 276                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running regular query: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
 277                                                 sqlQuery($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
 278                                         }
 279
 280                                         // Has a line changed?
 281                                         if (!ifSqlHasZeroAffectedRows()) {
 282                                                 // Add it to total account
 283                                                 $count += sqlAffectedRows();
 284                                         } // END - if
 285                                 } // END - if
 286                         } // END - foreach
 287                 } // END - foreach
 288         } // END - if
 289
 290         // Debug message
 291         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
 292
 293         // Return counter
 294         return $count;
 295 }
 296
 297 // Filter for updating/validating login data
 298 function FILTER_UPDATE_LOGIN_DATA () {
 299         // Add missing array
 300         if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) {
 301                 $GLOBALS['last_online'] = array();
 302         } // END - if
 303
 304         // Recheck if logged in
 305         if ((!isMember()) || ((isAdmin()) && (!isDebugModeEnabled()))) {
 306                 return FALSE;
 307         } // END - if
 308
 309         // Secure user id
 310         setMemberId(getSession('userid'));
 311
 312         // Found a userid?
 313         if (fetchUserData(getMemberId())) {
 314                 // Load last module and online time
 315                 $content = getUserDataArray();
 316
 317                 // Maybe first login time?
 318                 if (empty($content[getUserLastWhatName()])) {
 319                         $content[getUserLastWhatName()] = 'login';
 320                 } // END - if
 321
 322                 // This will be displayed on welcome page! :-)
 323                 if (empty($GLOBALS['last_online']['module'])) {
 324                         $GLOBALS['last_online']['module'] = $content[getUserLastWhatName()];
 325                         $GLOBALS['last_online']['online'] = $content['last_online'];
 326                 } // END - if
 327
 328                 // 'what' not set?
 329                 if (!isWhatSet()) {
 330                         // Fix it to default
 331                         setWhat('welcome');
 332                         if (getIndexHome() != '') {
 333                                 setWhatFromConfig('index_home');
 334                         } // END - if
 335                 } // END - if
 336
 337                 // Update last module / online time
 338                 updateLastActivity(getMemberId());
 339         }  else {
 340                 // Destroy session, we cannot update!
 341                 destroyMemberSession();
 342         }
 343 }
 344
 345 // Filter for initializing randomizer
 346 function FILTER_INIT_RANDOMIZER () {
 347         // Take a prime number which is long (if you know a longer one please try it out!)
 348         setConfigEntry('_PRIME', 591623);
 349
 350         // Initialize array with all allowed chars
 351         $GLOBALS['_abc'] = explode(',', 'a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,1,2,3,4,6,7,8,9,-,+,_,/,.');
 352
 353         // Only execute this filter if installed
 354         if ((!isInstalled()) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) {
 355                 // Set missing entry
 356                 setConfigEntry('_ADD', 0);
 357                 return;
 358         } // END - if
 359
 360         // Calculate "entropy" with the prime number (for code generation)
 361         setConfigEntry('_ADD', (getPrime() * getPrime() / (pi() * getCodeLength() + 1)));
 362
 363         // Simply init the randomizer with seed and _ADD value
 364         mt_srand(generateSeed() + getConfig('_ADD'));
 365 }
 366
 367 // Filter for removing updates
 368 function FILTER_REMOVE_UPDATES ($filterData) {
 369         // Init removal list
 370         initExtensionRemovalList();
 371
 372         // Add the current extension to it
 373         addCurrentExtensionToRemovalList();
 374
 375         // Simply remove it
 376         unsetExtensionSqls();
 377
 378         // Are there update dependencies to remove?
 379         if (countExtensionUpdateDependencies() > 0) {
 380                 // Then find all updates we shall no longer execute
 381                 foreach (getExtensionUpdateDependencies() as $id => $ext_name) {
 382                         // Shall we remove this update?
 383                         if (in_array($ext_name, getExtensionRemovalList())) {
 384                                 // Then remove this extension!
 385                                 removeExtensionDependency($ext_name);
 386                         } // END - if
 387                 } // END - foreach
 388         } // END - if
 389
 390         // Return data
 391         return $filterData;
 392 }
 393
 394 // Determines username for current user state
 395 function FILTER_DETERMINE_USERNAME () {
 396         // Check if logged in
 397         if (isMember()) {
 398                 // Is still logged in so we welcome him with his name
 399                 if (fetchUserData(getMemberId())) {
 400                         // Load surname and family's name and build the username
 401                         $content = getUserDataArray();
 402
 403                         // Prepare username
 404                         setUsername($content['surname'] . ' ' . $content['family']);
 405
 406                         // Additionally admin?
 407                         if (isAdmin()) {
 408                                 // Add it
 409                                 setUsername(getUsername() . ' ({--USERNAME_ADMIN_SHORT--})');
 410                         } // END - if
 411                 } else {
 412                         // Hmmm, logged in and no valid userid?
 413                         setUsername('<span class="bad">{--USERNAME_UNKNOWN--}</span>');
 414
 415                         // Destroy session
 416                         destroyMemberSession();
 417                 }
 418         } elseif (isAdmin()) {
 419                 // Admin is there
 420                 setUsername('{--USERNAME_ADMIN--}');
 421         } else {
 422                 // He's a guest, hello there... ;-)
 423                 setUsername('{--USERNAME_GUEST--}');
 424         }
 425 }
 426
 427 // Filter for compiling config entries
 428 function FILTER_COMPILE_CONFIG ($code, $compiled = FALSE) {
 429         // Save the uncompiled code
 430         $uncompiled = $code;
 431
 432         // Is there cache?
 433         if (!isset($GLOBALS['compiled_config'][$code])) {
 434                 // Compile {?some_var?} to getConfig('some_var')
 435                 preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
 436
 437                 // Some entries found?
 438                 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
 439                         // Replace all matches
 440                         foreach ($matches[0] as $key => $match) {
 441                                 // Is there cache?
 442                                 if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
 443                                         // Is the config valid?
 444                                         if (isConfigEntrySet($matches[1][$key])) {
 445                                                 // Set it for caching
 446                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . $matches[1][$key] . '%}';
 447                                         } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
 448                                                 // Use default value
 449                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '{%config=' . 'DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
 450                                         } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
 451                                                 // No config, try the language system
 452                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '{%message,DEFAULT_' . strtoupper($matches[1][$key]) . '%}';
 453                                         } else {
 454                                                 // Unhandled!
 455                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
 456                                         }
 457                                 } // END - if
 458
 459                                 // Use this for replacing
 460                                 $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
 461                                 //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die(__FUNCTION__.'['.__LINE__.']:<pre>'.secureString($code).'</pre>');
 462                         } // END - foreach
 463                 } // END - if
 464
 465                 // Add it to cache
 466                 $GLOBALS['compiled_config'][$uncompiled] = $code;
 467         } // END - if
 468
 469         // Should we compile it?
 470         if ($compiled === TRUE) {
 471                 // Run the code
 472                 $eval = "\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . '";';
 473                 //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>' . encodeEntities($eval) . '</pre>');
 474                 eval($eval);
 475         } // END - if
 476
 477         // Return compiled code
 478         return $GLOBALS['compiled_config'][$uncompiled];
 479 }
 480
 481 // Filter for compiling expression code
 482 function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
 483         // Compile {%cmd,callback,extraFunction=some_value%} to get expression code snippets
 484         // See switch() command below for supported commands
 485         preg_match_all('/\{%(([a-zA-Z0-9-_,]+)(=([^\}]+)){0,1})*%\}/', $filterData, $matches);
 486         //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.print_r($matches, TRUE).'</pre>');
 487
 488         // Default is from outputHtml()
 489         $outputMode = getScriptOutputMode();
 490
 491         // Some entries found?
 492         if ((count($matches) > 0) && (count($matches[3]) > 0)) {
 493                 // Replace all matches
 494                 foreach ($matches[2] as $key => $eti) {
 495                         // Init replacer/call-back variable
 496                         $replacer       = '';
 497                         $callback       = '';
 498                         $extraFunction  = '';
 499                         $extraFunction2 = '';
 500                         $value          = NULL;
 501
 502                         // Extract command and call-back
 503                         $etiArray = explode(',', $eti);
 504                         $eti = $etiArray[0];
 505
 506                         // Detect call-back function
 507                         if (isset($etiArray[1])) {
 508                                 // Call-back function detected
 509                                 $callback = $etiArray[1];
 510                         } // END - if
 511
 512                         // Detect extra function
 513                         if (isset($etiArray[2])) {
 514                                 // Also detected
 515                                 $extraFunction = $etiArray[2];
 516                         } // END - if
 517
 518                         // Detect extra function 2
 519                         if (isset($etiArray[3])) {
 520                                 // Also detected
 521                                 $extraFunction2 = $etiArray[3];
 522                         } // END - if
 523
 524                         // And value
 525                         if (isset($matches[4][$key])) {
 526                                 // Use this as value
 527                                 $value = $matches[4][$key];
 528                         } // END - if
 529
 530                         // Construct call-back function name for the command
 531                         $etiFunction = 'doExpression' . capitalizeUnderscoreString($eti);
 532
 533                         // Is this function there?
 534                         if (function_exists($etiFunction)) {
 535                                 // Prepare $matches, $key, $outputMode, etc.
 536                                 $data = array(
 537                                         'matches'     => $matches,
 538                                         'key'         => $key,
 539                                         'output_mode' => getScriptOutputMode(),
 540                                         'code'        => $filterData,
 541                                         'callback'    => $callback,
 542                                         'extra_func'  => $extraFunction,
 543                                         'extra_func2' => $extraFunction2,
 544                                         'value'       => $value
 545                                 );
 546
 547                                 // Call it
 548                                 //* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: etiFunction=' . $etiFunction);
 549                                 $filterData = call_user_func($etiFunction, $data);
 550                         } else {
 551                                 // Unsupported command detected
 552                                 logDebugMessage(__FUNCTION__, __LINE__, 'eti=' . $eti . ',etiFunction=' . $etiFunction . ',callback=' . $callback . ',extraFunction=' . $extraFunction . ',extraFunction2=' . $extraFunction2 . ' - UNSUPPORTED');
 553                         }
 554                 } // END - foreach
 555         } // END - if
 556
 557         // Is there non-HTML/AJAX mode?
 558         if ((!isHtmlOutputMode()) && (!isAjaxOutputMode())) {
 559                 $filterData = decodeEntities($filterData);
 560         } // END - if
 561
 562         // Return compiled code
 563         //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:<pre>'.($filterData).'</pre>');
 564         return $filterData;
 565 }
 566
 567 // Runs some generic filter update steps
 568 function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
 569         // Create task (we ignore the task id here)
 570         createExtensionUpdateTask(getCurrentAdminId(), $ext_name, $GLOBALS['update_ver'][$ext_name], sqlEscapeString(getExtensionNotes(getExtensionNotes())));
 571
 572         // Update extension's version
 573         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_version`='%s' WHERE `ext_name`='%s' LIMIT 1",
 574                 array($GLOBALS['update_ver'][$ext_name], $ext_name), __FUNCTION__, __LINE__);
 575
 576         // Remove arrays
 577         unsetSqls();
 578         unset($GLOBALS['update_ver'][$ext_name]);
 579 }
 580
 581 // Load more hourly reset scripts
 582 function FILTER_RUN_HOURLY_INCLUDES () {
 583         // Is the reset set or old sql_patches?
 584         if (((!isHourlyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) && (isHtmlOutputMode())) {
 585                 // Then abort here
 586                 reportBug(__FUNCTION__, __LINE__, 'Cannot run hourly reset! enabled='.intval(isHourlyResetEnabled()).',isExtensionInstalledAndNewer='.intval(isExtensionInstalledAndNewer('sql_patches', '0.9.8')).' Please report this bug. Thanks');
 587         } // END - if
 588
 589         // Is ext-sql_patches at least 0.9.8?
 590         if (isExtensionInstalledAndNewer('sql_patches', '0.9.8')) {
 591                 // Has it changed?
 592                 if ((getLastHourly() != getHour()) || (isDebugHourlyEnabled())) {
 593                         // Get more hourly reset scripts
 594                         setIncludePool('hourly', getArrayFromDirectory('inc/hourly/', 'hourly_'));
 595
 596                 // Run the filter
 597                 runFilterChain('load_includes', 'hourly');
 598                 } // END - if
 599         } // END - if
 600 }
 601
 602 // Load more daily scripts
 603 function FILTER_RUN_DAILY_INCLUDES () {
 604         // Is the reset set or old sql_patches?
 605         if (((!isDailyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) && (isHtmlOutputMode())) {
 606                 // Then abort here
 607                 reportBug(__FUNCTION__, __LINE__, 'Cannot run daily reset! enabled='.intval(isDailyResetEnabled()).',isExtensionInstalledAndNewer='.intval(isExtensionInstalledAndNewer('sql_patches', '0.9.8')).' Please report this bug. Thanks');
 608         } // END - if
 609
 610         // Is ext-sql_patches at least 0.9.8?
 611         if (isExtensionInstalledAndNewer('sql_patches', '0.9.8')) {
 612                 // Has it changed?
 613                 if ((getLastDaily() != getDay()) || (isDebugDailyEnabled())) {
 614                         // Get more daily reset scripts
 615                         setIncludePool('daily', getArrayFromDirectory('inc/daily/', 'daily_'));
 616
 617                         // Run the filter
 618                         runFilterChain('load_includes', 'daily');
 619                 } // END - if
 620         } // END - if
 621 }
 622
 623 // Load more weeklt scripts
 624 function FILTER_RUN_WEEKLY_INCLUDES () {
 625         // Is the reset set or old sql_patches?
 626         if (((!isWeeklyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) && (isHtmlOutputMode())) {
 627                 // Then abort here
 628                 reportBug(__FUNCTION__, __LINE__, 'Cannot run weekly reset! enabled='.intval(isWeeklyResetEnabled()).',isExtensionInstalledAndNewer()='.intval(isExtensionInstalledAndNewer('sql_patches', '0.9.8')).' Please report this bug. Thanks');
 629         } // END - if
 630
 631         // Is ext-sql_patches at least 0.9.8?
 632         if (isExtensionInstalledAndNewer('sql_patches', '0.9.8')) {
 633                 // Has it changed?
 634                 if ((getLastWeekly() != getWeek()) || (isDebugWeeklyEnabled())) {
 635                         // Include weekly reset scripts
 636                         setIncludePool('weekly', getArrayFromDirectory('inc/weekly/', 'weekly_'));
 637
 638                         // Run the filter
 639                         runFilterChain('load_includes', 'weekly');
 640                 } // END - if
 641         } // END - if
 642 }
 643
 644 // Load more monthly scripts
 645 function FILTER_RUN_MONTHLY_INCLUDES () {
 646         // Is the reset set or old sql_patches?
 647         if (((!isMonthlyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) && (isHtmlOutputMode())) {
 648                 // Then abort here
 649                 reportBug(__FUNCTION__, __LINE__, 'Cannot run monthly reset! enabled='.intval(isMonthlyResetEnabled()).',isExtensionInstalledAndNewer='.intval(isExtensionInstalledAndNewer('sql_patches', '0.9.8')).' Please report this bug. Thanks');
 650         } // END - if
 651
 652         // Is ext-sql_patches at least 0.9.8?
 653         if (isExtensionInstalledAndNewer('sql_patches', '0.9.8')) {
 654                 // Has it changed?
 655                 if ((getLastMonthly() != getMonth()) || (isDebugMonthlyEnabled())) {
 656                         // Include monthly reset scripts
 657                         setIncludePool('monthly', getArrayFromDirectory('inc/monthly/', 'monthly_'));
 658
 659                         // Run the filter
 660                         runFilterChain('load_includes', 'monthly');
 661                 } // END - if
 662         } // END - if
 663 }
 664
 665 // Filter for removing the given extension
 666 function FILTER_REMOVE_EXTENSION () {
 667         // Delete this extension (remember to remove it from your server *before* you click on welcome!
 668         sqlQueryEscaped("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
 669                 array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
 670
 671         // Remove the extension from cache array as well
 672         removeExtensionFromArray();
 673
 674         // Remove the cache
 675         rebuildCache('extension', 'extension');
 676 }
 677
 678 // Filter for flushing the output
 679 function FILTER_FLUSH_OUTPUT () {
 680         // Is this filter called?
 681         if (isset($GLOBALS[__FUNCTION__])) {
 682                 // Abort here
 683                 reportBug(__FUNCTION__, __LINE__, 'Double call of ' . __FUNCTION__ . ' causes problems with sent headers.');
 684         } // END - if
 685
 686         // Mark this filter as called
 687         $GLOBALS[__FUNCTION__] = TRUE;
 688
 689         // Simple, he?
 690         outputHtml();
 691 }
 692
 693 // Prepares an SQL statement part for HTML mail and/or holiday dependency
 694 function FILTER_HTML_INCLUDE_USERS ($mode) {
 695         // Exclude no users by default
 696         $MORE = '';
 697
 698         // HTML mail?
 699         if ($mode == 'html') {
 700                 $MORE = " AND `html`='Y'";
 701         } // END - if
 702
 703         if (isExtensionInstalledAndNewer('holiday', '0.1.3')) {
 704                 // Add something for the holiday extension
 705                 $MORE .= " AND `holiday_active`='N'";
 706         } // END - if
 707
 708         // Return result
 709         return $MORE;
 710 }
 711
 712 // Filter for determining what/action/module
 713 function FILTER_DETERMINE_WHAT_ACTION () {
 714         // In installation phase we don't have what/action
 715         if (isInstallationPhase()) {
 716                 // Set both to empty
 717                 setAction('');
 718                 setWhat('');
 719
 720                 // Abort here
 721                 return;
 722         } // END - if
 723
 724         // Get all values
 725         if ((!isCssOutputMode()) && (!isRawOutputMode())) {
 726                 // Fix module
 727                 if (!isModuleSet()) {
 728                         // Is the module registered?
 729                         if (!isModuleRegistered(getRequestElement('module'))) {
 730                                 // Is not a valid module
 731                                 redirectToUrl('modules.php?module=index');
 732                         } // END - if
 733
 734                         // Is the request element set?
 735                         if (isGetRequestElementSet('module')) {
 736                                 // Set module from request
 737                                 setModule(getRequestElement('module'));
 738                         } elseif (isHtmlOutputMode()) {
 739                                 // Set default module 'index'
 740                                 setModule('index');
 741                         } else {
 742                                 // Unknown module
 743                                 setModule('unknown');
 744                         }
 745                 } // END - if
 746
 747                 // Fix 'what' if not yet set
 748                 if (!isWhatSet()) {
 749                         setWhat(getWhatFromModule(getModule()));
 750                 } // END - if
 751
 752                 // Fix 'action' if not yet set
 753                 if (!isActionSet()) {
 754                         // Is 'what' set?
 755                         if (isWhatSet()) {
 756                                 // Set action
 757                                 setAction(getActionFromModuleWhat(getModule(), getWhat()));
 758                         } else {
 759                                 // Set action/what to empty
 760                                 setAction('');
 761                                 setWhat('');
 762                         }
 763                 } // END - if
 764         } else {
 765                 // Set action/what to empty
 766                 setAction('');
 767                 setWhat('');
 768         }
 769
 770         // Set default 'what' value
 771         //* DEBUG: */ debugOutput('-' . getModule() . '/' . getWhat() . '-');
 772         if ((!isWhatSet()) && (!isActionSet()) && (!isCssOutputMode()) && (!isRawOutputMode())) {
 773                 if (getModule() == 'admin') {
 774                         // Set 'action' value to 'login' in admin menu
 775                         setAction(getActionFromModuleWhat(getModule(), getWhat()));
 776                 } elseif ((getModule() == 'index') || (getModule() == 'login')) {
 777                         // Set 'what' value to 'welcome' in guest and member menu
 778                         setWhatFromConfig('index_home');
 779                 } else {
 780                         // Anything else like begging link
 781                         setWhat('');
 782                 }
 783         } // END - if
 784 }
 785
 786 // Sends out pooled mails
 787 function FILTER_TRIGGER_SENDING_POOL () {
 788         // Are we in normal output mode?
 789         if (!isHtmlOutputMode()) {
 790                 // Only in normal output mode to prevent race-conditons!
 791                 return;
 792         } // END - if
 793
 794         // Init counter
 795         $GLOBALS['pool_cnt'] = '0';
 796
 797         // Init & set the include pool
 798         initIncludePool('pool');
 799         setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));
 800
 801         // Run the filter
 802         runFilterChain('load_includes', 'pool');
 803
 804         // Remove the counter
 805         unset($GLOBALS['pool_cnt']);
 806 }
 807
 808 // Filter for checking and updating SVN revision
 809 function FILTER_CHECK_REPOSITORY_REVISION () {
 810         // Only execute this filter if installed and all config entries are there
 811         if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) {
 812                 return;
 813         } // END - if
 814
 815         // Check for patch level differences between database and current hard-coded
 816         if ((getCurrentRepositoryRevision() > getConfig('patch_level')) || (getConfig('patch_level') == 'CURRENT_REPOSITORY_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
 817                 // Update database and CONFIG array
 818                 updateConfiguration(array('patch_level', 'patch_ctime'), array(getCurrentRepositoryRevision(), 'UNIX_TIMESTAMP()'));
 819                 setConfigEntry('patch_level', getCurrentRepositoryRevision());
 820                 setConfigEntry('patch_ctime', time());
 821         } // END - if
 822 }
 823
 824 // Filter for running hourly reset
 825 function FILTER_RUN_HOURLY_RESET () {
 826         // Only execute this filter if installed
 827         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) {
 828                 return;
 829         } // END - if
 830
 831         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 832         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getLastHourly()=' . getLastHourly() . ',getHour()=' . getHour());
 833         if (((getLastHourly() != getHour()) || (isDebugHourlyEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('setup')) && (!isCssOutputMode())) {
 834                 // Tell every module we are in reset-mode!
 835                 doHourly();
 836         } // END - if
 837 }
 838
 839 // Filter for running daily reset
 840 function FILTER_RUN_DAILY_RESET () {
 841         // Only execute this filter if installed
 842         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) {
 843                 return;
 844         } // END - if
 845
 846         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 847         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getLastDaily()=' . getLastDaily() . ',getDay()=' . getDay());
 848         if (((getLastDaily() != getDay()) || (isDebugDailyEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('setup')) && (!isCssOutputMode())) {
 849                 // Tell every module we are in reset-mode!
 850                 doDaily();
 851         } // END - if
 852 }
 853
 854 // Filter for running weekly reset
 855 function FILTER_RUN_WEEKLY_RESET () {
 856         // Only execute this filter if installed
 857         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) {
 858                 return;
 859         } // END - if
 860
 861         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 862         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getLastWeekly()=' . getLastWeekly() . ',getWeek()=' . getWeek());
 863         if (((getLastWeekly() != getWeek()) || (isDebugWeeklyEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('setup')) && (!isCssOutputMode())) {
 864                 // Tell every module we are in reset-mode!
 865                 doWeekly();
 866         } // END - if
 867 }
 868
 869 // Filter for running monthly reset
 870 function FILTER_RUN_MONTHLY_RESET () {
 871         // Only execute this filter if installed
 872         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.9.8'))) {
 873                 return;
 874         } // END - if
 875
 876         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 877         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getLastMonthly()=' . getLastMonthly() . ',getMonth()=' . getMonth());
 878         if (((getLastMonthly() != getMonth()) || (isDebugMonthlyEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('setup')) && (!isCssOutputMode())) {
 879                 // Tell every module we are in reset-mode!
 880                 doMonthly();
 881         } // END - if
 882 }
 883
 884 // Filter for loading more runtime includes (not for installation)
 885 function FILTER_LOAD_RUNTIME_INCLUDES () {
 886         // Load more includes
 887         foreach (array('databases', 'session', 'versions') as $inc) {
 888                 // Load the include
 889                 loadIncludeOnce('inc/' . $inc . '.php');
 890         } // END - foreach
 891 }
 892
 893 // Filter for checking admin ACL
 894 function FILTER_CHECK_ADMIN_ACL () {
 895         // Extension not installed so it's always allowed to access everywhere!
 896         $ret = TRUE;
 897
 898         // Ok, Cookie-Update done
 899         if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
 900                 // Check if action GET variable was set
 901                 $action = getAction();
 902                 if (isWhatSet()) {
 903                         // Get action value by what-value
 904                         $action = getActionFromModuleWhat('admin', getWhat());
 905                 } // END - if
 906
 907                 // Check for access control line of current menu entry
 908                 $ret = isAdminsAllowedByAcl($action, getWhat());
 909         } // END - if
 910
 911         // Set it here
 912         $GLOBALS['acl_allow'] = $ret;
 913 }
 914
 915 // Init random number/cache buster
 916 function FILTER_INIT_RANDOM_NUMBER () {
 917         // Is the extension ext-sql_patches installed and at least 0.3.6?
 918         if (isSessionVariableSet('random_number')) {
 919                 // Then set it
 920                 setConfigEntry('RAND_NUMBER', getSession('random_number'));
 921         } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
 922                 // Generate random number
 923                 setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 99999), getMemberId(), ''));
 924         } else {
 925                 // Generate *WEAK* code
 926                 setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
 927         }
 928
 929         // Set it in session for faster script execusion
 930         setSession('random_number', getConfig('RAND_NUMBER'));
 931
 932         // Copy it to CACHE_BUSTER
 933         setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
 934 }
 935
 936 // Update module counter
 937 function FILTER_COUNT_MODULE () {
 938         // Is installation phase or no admin registered?
 939         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered())) {
 940                 // Then don't count any modules
 941                 return;
 942         } // END - if
 943
 944         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ' - ENTERED!');
 945         // Count module click
 946         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
 947                 array(getModule()), __FUNCTION__, __LINE__);
 948         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
 949 }
 950
 951 // Handles fatal errors
 952 function FILTER_HANDLE_FATAL_ERRORS () {
 953         // Is there errors to handle and right output mode?
 954         if ((!ifFatalErrorsDetected()) || (!isHtmlOutputMode())) {
 955                 // Abort executing here
 956                 return FALSE;
 957         } // END - if
 958
 959         // Set content type
 960         setContentType('text/html');
 961
 962         // Load config here
 963         loadIncludeOnce('inc/load_config.php');
 964
 965         // Default content is none
 966         $content = '';
 967
 968         // Installation phase or regular mode?
 969         if ((isInstallationPhase())) {
 970                 // While we are installing ouput other header than while it is installed... :-)
 971                 $OUT = '';
 972                 foreach (getFatalArray() as $key => $value) {
 973                         // Prepare content for the template
 974                         $content = array(
 975                                 'key'   => ($key + 1),
 976                                 'value' => $value
 977                         );
 978
 979                         // Load row template
 980                         $OUT .= loadTemplate('install_fatal_row', TRUE, $content);
 981                 }
 982
 983                 // Load main template
 984                 $content = loadTemplate('install_fatal_table', TRUE, $OUT);
 985         } elseif (isInstalled()) {
 986                 // Display all runtime fatal errors
 987                 $OUT = '';
 988                 foreach (getFatalArray() as $key => $value) {
 989                         // Prepare content for the template
 990                         $content = array(
 991                                 'key'   => ($key + 1),
 992                                 'value' => $value
 993                         );
 994
 995                         // Load row template
 996                         $OUT .= loadTemplate('runtime_fatal_row', TRUE, $content);
 997                 }
 998
 999                 // Load main template
1000                 $content = loadTemplate('runtime_fatal_table', TRUE, $OUT);
1001         }
1002
1003         // Message to regular users (non-admin)
1004         $CORR = '{--FATAL_REPORT_ERRORS--}';
1005
1006         // Maybe the admin wants to take a look?
1007         if (isAdmin()) {
1008                 $CORR = '{--FATAL_CORRECT_ERRORS--}';
1009         } // END - if
1010
1011         // Remember all in array
1012         $content = array(
1013                 'rows' => $content,
1014                 'corr' => $CORR
1015         );
1016
1017         // Load footer
1018         loadIncludeOnce('inc/header.php');
1019
1020         // Load main template
1021         loadTemplate('fatal_errors', FALSE, $content);
1022
1023         // Delete all to prevent double-display
1024         initFatalMessages();
1025
1026         // Load footer
1027         loadIncludeOnce('inc/footer.php');
1028
1029         // Abort here
1030         doShutdown();
1031 }
1032
1033 // Filter for displaying copyright line
1034 function FILTER_DISPLAY_COPYRIGHT () {
1035         // Shall we display the copyright notice?
1036         if ((isFullPage()) && ((getWriteFooter() == 'Y') || (isInstalling())) && ($GLOBALS['__header_sent'] == 2) && (ifCopyrightFooterEnabled())) {
1037                 // Backlink enabled?
1038                 if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
1039                         // Copyright with backlink, thanks! :-)
1040                         $GLOBALS['__page_footer'] .= loadTemplate('copyright_backlink', TRUE);
1041                 } else {
1042                         // No backlink in Copyright note
1043                         $GLOBALS['__page_footer'] .= loadTemplate('copyright', TRUE);
1044                 }
1045         } // END - if
1046 }
1047
1048 // Filter for displaying parsing time
1049 function FILTER_DISPLAY_PARSING_TIME () {
1050         // Shall we display the parsing time and number of queries?
1051         // 1234                            5                      54    4                    554    4          5543    3                    4432    2                332    2                              21
1052         if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (isShowTimingsEnabled()) && (isFullPage())) && (!isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['__header_sent'] == 2)) {
1053                 // Then display it here
1054                 displayParsingTime();
1055         } // END - if
1056 }
1057
1058 // Filter for flushing template cache
1059 function FILTER_FLUSH_TEMPLATE_CACHE () {
1060         // Do not flush when debugging the template cache
1061         if (isDebugTemplateCacheEnabled()) {
1062                 // Do not flush templates in debug-mode
1063                 return;
1064         } // END - if
1065
1066         // Is there cached eval() data?
1067         if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
1068                 // Flush all
1069                 foreach ($GLOBALS['template_eval'] as $prefix => $templateArray) {
1070                         foreach ($templateArray as $template => $eval) {
1071                                 // Flush the cache (if not yet found)
1072                                 flushTemplateCache($prefix, $template, $eval);
1073                         } // END - foreach
1074                 } // END - foreach
1075         } // END - if
1076 }
1077
1078 // Filter for loading user data
1079 function FILTER_FETCH_USER_DATA ($userid = NULL) {
1080         // Is the userid not set?
1081         if (!isValidId($userid)) {
1082                 // Then use member id
1083                 $userid = getMemberId();
1084         } // END - if
1085
1086         // Get user data
1087         if (!fetchUserData($userid)) {
1088                 // Userid is not valid
1089                 reportBug(__FUNCTION__, __LINE__, 'User id ' . $userid . ' is invalid.');
1090         } // END - if
1091
1092         // Set member id
1093         setMemberId($userid);
1094
1095         // Continue with next filter
1096         return $userid;
1097 }
1098
1099 // Filter for reseting users' last login failure, only available with latest ext-sql_patches
1100 function FILTER_RESET_USER_LOGIN_FAILURE () {
1101         // Is the user data valid?
1102         if (!isMember()) {
1103                 // Do only run for logged in members
1104                 reportBug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
1105         } // END - if
1106
1107         // Remmeber login failures if available
1108         if (isExtensionInstalledAndNewer('user', '0.3.7')) {
1109                 // Reset login failures
1110                 sqlQueryEscaped("UPDATE
1111         `{?_MYSQL_PREFIX?}_user_data`
1112 SET
1113         `login_failures`=0,
1114         `last_failure`=NULL
1115 WHERE
1116         `userid`=%s
1117 LIMIT 1",
1118                         array(getMemberId()), __FUNCTION__, __LINE__);
1119
1120                 // Store it in session
1121                 setSession('mailer_member_failures' , getUserData('login_failures'));
1122                 setSession('mailer_member_last_failure', getUserData('last_failure'));
1123         } // END - if
1124 }
1125
1126 // Try to login the admin by setting some session/cookie variables
1127 function FILTER_DO_LOGIN_ADMIN ($filterData) {
1128         // Now set all session variables and store the result for later processing
1129         $GLOBALS['admin_login_success'] = ((
1130                 setAdminMd5(encodeHashForCookie($filterData['pass_hash']))
1131         ) && (
1132                 setAdminId($filterData['id'])
1133         ) && (
1134                 setAdminLast(time())
1135         ));
1136
1137         // Return the data for further processing
1138         return $filterData;
1139 }
1140
1141 // Filter for loading page header, this should be ran first!
1142 function FILTER_LOAD_PAGE_HEADER () {
1143         // Output page header code
1144         $GLOBALS['__page_header'] = loadTemplate('page_header', TRUE);
1145
1146         // Include meta data in 'guest' module
1147         if (isModuleSet()) {
1148                 // Load meta data template
1149                 $GLOBALS['__page_header'] .= loadTemplate(getMenuModeFromModule() . '_metadata', TRUE);
1150
1151                 // Add meta description to header
1152                 if ((isInstalled()) && (isAdminRegistered()) && (isSqlLinkUp()) && (getModule() == 'index')) {
1153                         // Add meta description not in admin and login module and when the script is installed
1154                         generateMetaDescriptionCode();
1155                 } // END - if
1156         } // END - if
1157 }
1158
1159 // Filter for adding style sheet, closing page header
1160 function FILTER_FINISH_PAGE_HEADER () {
1161         // Include stylesheet
1162         loadIncludeOnce('inc/stylesheet.php');
1163
1164         // Closing HEAD tag
1165         $GLOBALS['__page_header'] .= '</head>';
1166 }
1167
1168 // Cleans up the DNS cache if ext-sql_patches is at least 0.7.0
1169 function FILTER_CLEANUP_DNS_CACHE () {
1170         // Is the latest version installed?
1171         if (isExtensionInstalledAndNewer('sql_patches', '0.7.0')) {
1172                 // Load class file
1173                 loadIncludeOnce('inc/classes/resolver.class.php');
1174
1175                 // Instance the resolver
1176                 $resolver = new HostnameResolver();
1177
1178                 // Purge entries
1179                 $resolver->purgeEntries();
1180
1181                 // Cute, isn't it? ;-)
1182         } // END - if
1183 }
1184
1185 // Filter for setting CURRENT_DATE, this is required after initialization of extensions
1186 function FILTER_SET_CURRENT_DATE () {
1187         // Set current date
1188         setConfigEntry('CURRENT_DATE', generateDateTime(time(), '3'));
1189
1190         // Epoche time for yesterday, today ... all at 00:00 am
1191         setConfigEntry('START_YDAY', makeTime(0, 0, 0, time() - getOneDay()));
1192         setConfigEntry('START_TDAY', makeTime(0, 0, 0, time()));
1193 }
1194
1195 // Filter for marking extension as installed
1196 function FILTER_EXTENSION_MARK_INSTALLED ($filterData) {
1197         // Mark it as installed
1198         $GLOBALS['ext_is_installed'][$filterData['ext_name']] = TRUE;
1199 }
1200
1201 // Filter for generating mails links for 'pool' mails
1202 function FILTER_GENERATE_POOL_MAIL_LINKS ($filterData) {
1203         // Is type 'normal'?
1204         if ($filterData['type'] == 'normal') {
1205                 // Load template
1206                 $filterData['__output'] .= loadTemplate('admin_links_' . strtolower($filterData['mail_status']) . '_pool_mail', TRUE, $filterData);
1207         } // END - if
1208
1209         // Return data
1210         return $filterData;
1211 }
1212
1213 // Filter to activate exchange
1214 function FILTER_ACTIVATE_EXCHANGE () {
1215         // Are the extension ext-user/other there?
1216         if ((!isExtensionActive('user')) || (!isExtensionActive('other')) || (getActivateXchange() == '0')) {
1217                 // Silently abort here
1218                 return FALSE;
1219         } // END - if
1220
1221         // Check total amount of users
1222         if (getTotalConfirmedUser() >= getActivateXchange()) {
1223                 // Activate System
1224                 addSql("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `locked`='N',`hidden`='N',`mem_only`='Y' WHERE `module`='order' LIMIT 1");
1225                 addSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `visible`='Y',`locked`='N' WHERE `what`='order' OR `what`='unconfirmed' LIMIT 2");
1226
1227                 // Run SQLs
1228                 runFilterChain('run_sqls');
1229
1230                 // Update configuration
1231                 updateConfiguration('activate_xchange' ,0);
1232
1233                 // Rebuild cache
1234                 rebuildCache('modules', 'modules');
1235         } // END - if
1236 }
1237
1238 // Filter to handle configuration
1239 function FILTER_HANDLE_HOME_IN_INDEX_SETTING ($filterData) {
1240         // Is ext-sql_patches up-to-date?
1241         if ((isExtensionInstalledAndNewer('sql_patches', '0.8.3')) && (isDisplayHomeInIndexEnabled())) {
1242                 // Is 'search' as same as 'index_home'?
1243                 if ($filterData['search'] == getIndexHome()) {
1244                         // Then set 'content' to link to index.php
1245                         $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>';
1246                 } // END - if
1247         } // END - if
1248
1249         // Return data
1250         return $filterData;
1251 }
1252
1253 // Filter to add history entry
1254 function FILTER_ADD_HISTORY_ENTRY ($filterData) {
1255         // Add the entry
1256         sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_history` (`history_subject`, `history_userid`, `history_value`) VALUES ('%s',%s,'%s')",
1257                 $filterData,
1258                 __FUNCTION__, __LINE__);
1259
1260         // Remember insert id for other filters
1261         $filterData['history_id'] = getSqlInsertId();
1262
1263         // Return data
1264         return $filterData;
1265 }
1266
1267 // Filter for initializing ext-sql_patches
1268 function FILTER_GENERATE_FILE_SECRET_HASH ($filterData) {
1269         // Transfer POINTS word
1270         if (isExtensionInstalledAndNewer('sql_patches', '0.0.3')) {
1271                 // Okay, recent enough, so transfer the word for POINTS
1272                 setConfigEntry('POINTS', getPointsWord());
1273         } // END - if
1274
1275         // Init key
1276         setConfigEntry('secret_key', '');
1277
1278         // Read key from secret file
1279         if ((getFileHash() == '') || (getMasterSalt() == '') || (getPassScramble() == '')) {
1280                 // Maybe need setup of secret key!
1281                 loadIncludeOnce('inc/gen_sql_patches.php');
1282         } // END - if
1283
1284         // Test again
1285         if ((getFileHash() != '') && (getMasterSalt() != '') && (getPassScramble() != '')) {
1286                 // File hash fas generated so we can also file the secret file... hopefully.
1287                 $hashFile = sprintf("%s%s.%s.cache", getPath(), getCachePath(), getFileHash());
1288
1289                 // Is the secret key file readable?
1290                 if (isFileReadable($hashFile)) {
1291                         // Read file
1292                         setConfigEntry('secret_key', readFromFile($hashFile));
1293                 } else {
1294                         // Remove it from database
1295                         updateConfiguration('file_hash', '');
1296
1297                         // Cannot read secret file!
1298                         reportBug(__FILE__, __LINE__, 'Cannot read secret file! Please try to reload.');
1299                 }
1300         } // END - if
1301
1302         // Return data
1303         return $filterData;
1304 }
1305
1306 // Filter to initialize session
1307 function FILTER_INIT_SESSION ($filterData) {
1308         // Determine and set referral id
1309         determineReferralId();
1310
1311         // Return data
1312         return $filterData;
1313 }
1314
1315 // Filter for sending "build mail" to admin
1316 function FILTER_SEND_BUILD_MAIL ($filterData) {
1317         // Was one line updated?
1318         if (($filterData['affected'] > 0) || (isDebugBuildMailsEnabled())) {
1319                 // Then call the proper function
1320                 call_user_func_array('sendGenericBuildMails', $filterData);
1321         } // END - if
1322
1323         // Return data
1324         return $filterData;
1325 }
1326
1327 // Handles click on referral banner
1328 function FILTER_HANDLE_REFERRER_BANNER_CLICK ($filterData) {
1329         // Check required parameters
1330         if ((isGetRequestElementSet('user')) && (isGetRequestElementSet('banner'))) {
1331                 // Update clicks counter...
1332                 sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_refbanner` SET `clicks`=`clicks`+1 WHERE `id`=%s LIMIT 1",
1333                         array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1334
1335                 // A line has been updated?
1336                 if ((!ifSqlHasZeroAffectedRows()) && (isGetRequestElementSet('user'))) {
1337                         // Redirect to the user's referral link
1338                         redirectToUrl('ref.php?refid=' . bigintval(getRequestElement('user')));
1339                 } // END - if
1340         } // END - if
1341
1342         // Return filter data
1343         return $filterData;
1344 }
1345
1346 // Filter for handling viewing of a referral banner
1347 function FILTER_HANDLE_REFERRER_BANNER_VIEW ($filterData) {
1348         // Are all required parameters set
1349         if ((isGetRequestElementSet('user')) && (isGetRequestElementSet('banner'))) {
1350                 // For later things... ;-)
1351                 $result = sqlQueryEscaped("SELECT `url` FROM `{?_MYSQL_PREFIX?}_refbanner` WHERE `id`=%s LIMIT 1",
1352                         array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1353
1354                 // Is there the banner?
1355                 if (sqlNumRows($result) == 1) {
1356                         // Load the URL
1357                         $data = sqlFetchArray($result);
1358
1359                         // Update counter
1360                         sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_refbanner` SET `counter`=`counter`+1 WHERE `id`=%s LIMIT 1",
1361                                 array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1362
1363                         // Set header and ...
1364                         setContentType('image/' . substr($data['url'], -3, 3));
1365
1366                         // Redirect
1367                         redirectToUrl($data['url'], FALSE);
1368                 } // END - if
1369
1370                 // @TODO No banner found, output some default banner
1371                 logDebugMessage(__FUNCTION__, __LINE__, 'Banner ' . bigintval(getRequestElement('banner')) . ' not found.');
1372
1373                 // Free memory
1374                 sqlFreeResult($result);
1375         } // END - if
1376
1377         // Do nothing for now
1378         redirectToUrl('modules.php?module=index');
1379 }
1380
1381 // Filter for redirecting on wrong server name (e.g. bad.your-server.tld will be redirected to your-server.tld)
1382 function FILTER_REDIRECT_WRONG_SERVER_NAME ($filterData) {
1383         // Get URL
1384         $url = getUrl();
1385
1386         // Is the configured URL same as SERVER_NAME?
1387         if (extractHostnameFromUrl($url) != detectServerName()) {
1388                 // Log all attempts
1389                 logWrongServerNameRedirect();
1390
1391                 // Then redirect to configured URL
1392                 redirectToRequestUri();
1393         } // END - if
1394
1395         // Return filter data
1396         return $filterData;
1397 }
1398
1399 // Filter for adding hidden session id
1400 function FILTER_ADD_INPUT_HIDDEN_SESSION_ID ($filterData) {
1401         // Is a spider detected?
1402         if ((!isSpider()) && (!isSessionValid()) && ($filterData['__form_method'] == 'get')) {
1403                 // No, then add the hidden field
1404                 $filterData['__replacer'] .= '<input type="hidden" name="' . session_name() . '" value="' . session_id() . '" />';
1405         } // END - if
1406
1407         // Return filter data
1408         return $filterData;
1409 }
1410
1411 // Filter for purging old SERVER_NAME entries
1412 function FILTER_SERVER_NAME_EXTRA_AUTOPURGE ($filterData) {
1413         // Is purging configured?
1414         if ((isApServerNameEnabled()) && (getApServerNameSince() > 0)) {
1415                 // Then start purging
1416                 sqlQuery('DELETE LOW_PRIORITY FROM
1417         `{?_MYSQL_PREFIX?}_server_name_log`
1418 WHERE
1419         (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`server_name_added`)) >= {?ap_server_name_since?}',
1420                         __FILE__, __LINE__);
1421
1422                 // Are some entries deleted?
1423                 if (sqlAffectedRows() > 0) {
1424                         // Okay, then send an email to the admin
1425                         sendAdminNotification('{--ADMIN_PURGE_USER_SERVER_NAME_LOG_SUBJECT--}', 'admin_purge_user_server_name_log', sqlAffectedRows());
1426                 } // END - if
1427         } // END - if
1428
1429         // Return filter data
1430         return $filterData;
1431 }
1432
1433 // Filter for detecting menu mode
1434 function FILTER_DETERMINE_MENU_MODE_GENERIC ($filterData) {
1435         // "Detect" it
1436         switch (getModule()) {
1437                 case 'confirm': // Login script is 'member'
1438                         $filterData = 'member';
1439                         break;
1440         } // END - switch
1441
1442         // Return filter data
1443         return $filterData;
1444 }
1445
1446 // Filter to exclude default referral id
1447 function FILTER_EXCLUDE_DEFAULT_REFID ($filterData = array()) {
1448         // Is it valid?
1449         if (isValidId(getDefRefid())) {
1450                 // Exclude it
1451                 array_push($filterData, '{?def_refid?}');
1452         } // END - if
1453
1454         // Return it
1455         return $filterData;
1456 }
1457
1458 // [EOF]
1459 ?>