inc/filters.php

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