inc/filters.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    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  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  23  * This program is free software; you can redistribute it and/or modify *
  24  * it under the terms of the GNU General Public License as published by *
  25  * the Free Software Foundation; either version 2 of the License, or    *
  26  * (at your option) any later version.                                  *
  27  *                                                                      *
  28  * This program is distributed in the hope that it will be useful,      *
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  31  * GNU General Public License for more details.                         *
  32  *                                                                      *
  33  * You should have received a copy of the GNU General Public License    *
  34  * along with this program; if not, write to the Free Software          *
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38
  39 // Some security stuff...
  40 if (!defined('__SECURITY')) {
  41         die();
  42 } // END - if
  43
  44 // Filter for flushing all new filters to the database
  45 function FILTER_FLUSH_FILTERS () {
  46         // Clear all previous SQL queries
  47         initSqls();
  48
  49         // Are we installing?
  50         if ((isInstallationPhase())) {
  51                 // Then silently skip this filter
  52                 return true;
  53         } // END - if
  54
  55         // Is a database link here and not in installation mode?
  56         if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
  57                 // Abort here
  58                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
  59                 return false;
  60         } // END - if
  61
  62         // Is the extension sql_patches updated?
  63         if ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9'))) {
  64                 // Abort silently here
  65                 return false;
  66         } // END - if
  67
  68         // Nothing is added/remove by default
  69         $inserted = '0';
  70         $removed = '0';
  71
  72         // Prepare SQL queries
  73         $insertSQL = "INSERT INTO `{?_MYSQL_PREFIX?}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
  74         $removeSQL = "DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_filters` WHERE";
  75
  76         // Write all filters to database
  77         foreach ($GLOBALS['cache_array']['filter']['chains'] as $filterName => $filterArray) {
  78                 // Walk through all filters
  79                 foreach ($filterArray as $filterFunction => $active) {
  80                         // Is this filter loaded?
  81                         //* DEBUG: */ print 'FOUND:'.$filterName.'/'.$filterFunction.'='.$active.'<br />';
  82                         if (((!isset($GLOBALS['cache_array']['filter']['loaded'][$filterName][$filterFunction])) && ($active != 'R')) || ($active == 'A')) {
  83                                 // Add this filter (all filters are active by default)
  84                                 //* DEBUG: */ print 'ADD:'.$filterName.'/'.$filterFunction.'<br />';
  85                                 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
  86                                 $inserted++;
  87                         } elseif ($active == 'R') {
  88                                 // Remove this filter
  89                                 //* DEBUG: */ print 'REMOVE:'.$filterName.'/'.$filterFunction.'<br />';
  90                                 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
  91                                 $removed++;
  92                         }
  93                 } // END - foreach
  94         } // END - foreach
  95
  96         // Something has been added?
  97         if ($inserted > 0) {
  98                 // Finish SQL command and add it
  99                 addSql(substr($insertSQL, 0, -1));
 100         } // END - if
 101
 102         // Something has been removed?
 103         if ($removed > 0) {
 104                 // Finish SQL command and add it
 105                 addSql(substr($removeSQL, 0, -2) . 'LIMIT ' . $removed);
 106         } // END - if
 107
 108         // Shall we update usage counters (ONLY FOR DEBUGGING!)
 109         if (getConfig('update_filter_usage') == 'Y') {
 110                 // Update all counters
 111                 foreach ($GLOBALS['cache_array']['filter']['counter'] as $filterName => $filterArray) {
 112                         // Walk through all filters
 113                         foreach ($filterArray as $filterFunction => $cnt) {
 114                                 // Construct and add the query
 115                                 addSql(sprintf("UPDATE `{?_MYSQL_PREFIX?}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
 116                                         bigintval($cnt),
 117                                         $filterName,
 118                                         $filterFunction
 119                                 ));
 120                         } // END - foreach
 121                 } // END - foreach
 122         } // END - if
 123
 124         // Run the run_sqls filter in non-dry mode
 125         runFilterChain('run_sqls');
 126
 127         // Should we rebuild cache?
 128         if (($inserted > 0) || ($removed > 0)) {
 129                 // Destroy cache
 130                 rebuildCacheFile('filter', 'filter');
 131         } // END - if
 132 }
 133
 134 // Filter for calling the handler for login failures
 135 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
 136         // Init content
 137         $content = $data;
 138
 139         // Handle failed logins here if not in guest
 140         //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={getAction()},what={getWhat()},level={$data['access_level']}<br />");
 141         if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.0')))) {
 142                 // Handle failure
 143                 $content['content'] .= handleLoginFailtures($data['access_level']);
 144         } // END - if
 145
 146         // Return the content
 147         return $content;
 148 }
 149
 150 // Filter for redirecting to logout if sql_patches has been installed
 151 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
 152         // Remove this filter
 153         unregisterFilter('shutdown', __FUNCTION__);
 154
 155         // Is the element set?
 156         if (isset($GLOBALS['ext_load_mode'])) {
 157                 // Redirect here
 158                 redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
 159         } // END - if
 160
 161         // This should not happen!
 162         logDebugMessage(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
 163 }
 164
 165 // Filter for auto-activation of a extension
 166 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
 167         // Is this extension always activated?
 168         if (getExtensionAlwaysActive() == 'Y') {
 169                 // Then activate the extension
 170                 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />");
 171                 doActivateExtension($data['ext_name']);
 172         } // END - if
 173
 174         // Return the data
 175         return $data;
 176 }
 177
 178 // Filter for solving task given task
 179 function FILTER_SOLVE_TASK ($data) {
 180         // Don't solve anything if no admin!
 181         if (!isAdmin()) return $data;
 182
 183         // Is this a direct task id or array element task_id is found?
 184         if (is_int($data)) {
 185                 // Then solve it...
 186                 adminSolveTask($data);
 187         } elseif ((is_array($data)) && (isset($data['task_id']))) {
 188                 // Solve it...
 189                 adminSolveTask($data['task_id']);
 190         } else {
 191                 // Not detectable!
 192                 debug_report_bug(sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($data), print_r($data, true)));
 193         }
 194
 195         // Return the data
 196         return $data;
 197 }
 198
 199 // Filter to load include files
 200 function FILTER_LOAD_INCLUDES ($pool) {
 201         // Is it null?
 202         if (is_null($pool)) {
 203                 // This should not happen!
 204                 debug_report_bug('pool is null.');
 205         } // END - if
 206
 207         // Is the pool an array and 'pool' set?
 208         if ((is_array($pool)) && (isset($pool['pool']))) {
 209                 // Then use it as pool
 210                 $realPool = $pool['pool'];
 211         } else {
 212                 // Default is $data as inclusion list
 213                 $realPool = $pool;
 214         }
 215
 216         // Get inc pool
 217         $data = getIncludePool($realPool);
 218
 219         // Is it an array?
 220         if ((!isset($data)) || (!is_array($data))) {
 221                 // Then abort here
 222                 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
 223         } elseif (isset($data['inc_pool'])) {
 224                 // Use this as new inclusion pool!
 225                 setIncludePool($realPool, $data['inc_pool']);
 226         }
 227
 228         // Check for added include files
 229         if (countIncludePool($realPool) > 0) {
 230                 // Loads every include file
 231                 loadIncludePool($realPool);
 232
 233                 // Reset array
 234                 initIncludePool($realPool);
 235         } // END - if
 236
 237         // Continue with processing
 238         return $pool;
 239 }
 240
 241 // Filter for running SQL commands
 242 function FILTER_RUN_SQLS ($data) {
 243         // Debug message
 244         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "- Entered!");
 245
 246         // Is the array there?
 247         if ((isSqlsValid()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
 248                 // Run SQL commands
 249                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "- Found ".countSqls()." queries to run.");
 250                 foreach (getSqls() as $sqls) {
 251                         // New cache format...
 252                         foreach ($sqls as $sql) {
 253                                 // Trim spaces away
 254                                 $sql = trim($sql);
 255
 256                                 // Is there still a query left?
 257                                 if (!empty($sql)) {
 258                                         // Do we have an "ALTER TABLE" command?
 259                                         if (substr(strtolower($sql), 0, 11) == 'alter table') {
 260                                                 // Analyse the alteration command
 261                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
 262                                                 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
 263                                         } else {
 264                                                 // Run regular SQL command
 265                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
 266                                                 SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
 267                                         }
 268                                 } // END - if
 269                         } // END - foreach
 270                 } // END - foreach
 271         } // END - if
 272
 273         // Debug message
 274         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "- Left!");
 275 }
 276
 277 // Filter for updating/validating login data
 278 function FILTER_UPDATE_LOGIN_DATA () {
 279         // Add missing array
 280         if ((!isset($GLOBALS['last_online'])) || (!is_array($GLOBALS['last_online']))) $GLOBALS['last_online'] = array();
 281
 282         // Recheck if logged in
 283         if (!isMember()) return false;
 284
 285         // Secure user id
 286         setMemberId(getSession('userid'));
 287
 288         // Found a userid?
 289         if (fetchUserData(getMemberId())) {
 290                 // Load last module and online time
 291                 $content = getUserDataArray();
 292
 293                 // Maybe first login time?
 294                 if (empty($content['last_module'])) $content['last_module'] = 'login';
 295
 296                 // This will be displayed on welcome page! :-)
 297                 if (empty($GLOBALS['last_online']['module'])) {
 298                         $GLOBALS['last_online']['module'] = $content['last_module'];
 299                         $GLOBALS['last_online']['online'] = $content['last_online'];
 300                 } // END - if
 301
 302                 // 'what' not set?
 303                 if (!isWhatSet()) {
 304                         // Fix it to default
 305                         setWhat('welcome');
 306                         if (getConfig('index_home') != '') setWhatFromConfig('index_home');
 307                 } // END - if
 308
 309                 // Update last module / online time
 310                 updateLastActivity(getMemberId());
 311         }  else {
 312                 // Destroy session, we cannot update!
 313                 destroyMemberSession();
 314         }
 315 }
 316
 317 // Filter for initializing randomizer
 318 function FILTER_INIT_RANDOMIZER () {
 319         // Only execute this filter if installed
 320         if ((!isInstalled()) || (!isExtensionInstalledAndNewer('other', '0.2.5'))) return;
 321
 322         // Take a prime number which is long (if you know a longer one please try it out!)
 323         setConfigEntry('_PRIME', 591623);
 324
 325         // Calculate "entropy" with the prime number (for code generation)
 326         setConfigEntry('_ADD', (getConfig('_PRIME') * getConfig('_PRIME') / (pi() * getConfig('code_length') + 1)));
 327
 328         // Simply init the randomizer with seed and _ADD value
 329         mt_srand(generateSeed() + getConfig('_ADD'));
 330 }
 331
 332 // Filter for removing updates
 333 function FILTER_REMOVE_UPDATES ($data) {
 334         // Init removal list
 335         initExtensionRemovalList();
 336
 337         // Add the current extension to it
 338         addCurrentExtensionToRemovalList();
 339
 340         // Simply remove it
 341         unsetExtensionSqls();
 342
 343         // Do we need to remove update depency?
 344         if (countExtensionUpdateDependencies() > 0) {
 345                 // Then find all updates we shall no longer execute
 346                 foreach (getExtensionUpdateDependencies() as $id=>$ext_name) {
 347                         // Shall we remove this update?
 348                         if (in_array($ext_name, getExtensionRemovalList())) {
 349                                 // Then remove this extension!
 350                                 removeExtensionUpdateDependency($ext_name);
 351                         } // END - if
 352                 } // END - foreach
 353         } // END - if
 354
 355         // Return data
 356         return $data;
 357 }
 358
 359 // Determines username for current user state
 360 function FILTER_DETERMINE_USERNAME () {
 361         // Check if logged in
 362         if (isMember()) {
 363                 // Is still logged in so we welcome him with his name
 364                 if (fetchUserData(getMemberId())) {
 365                         // Load surname and family's name and build the username
 366                         $content = getUserDataArray();
 367
 368                         // Prepare username
 369                         setUsername($content['surname'] . ' ' . $content['family']);
 370
 371                         // Additionally admin?
 372                         if (isAdmin()) {
 373                                 // Add it
 374                                 setUsername(getUsername() . ' ({--USERNAME_ADMIN_SHORT--})');
 375                         } // END - if
 376                 } else {
 377                         // Hmmm, logged in and no valid userid?
 378                         setUsername('<em>{--USERNAME_UNKNOWN--}</em>');
 379
 380                         // Destroy session
 381                         destroyMemberSession();
 382                 }
 383         } elseif (isAdmin()) {
 384                 // Admin is there
 385                 setUsername('{--USERNAME_ADMIN--}');
 386         } else {
 387                 // He's a guest, hello there... ;-)
 388                 setUsername('{--USERNAME_GUEST--}');
 389         }
 390 }
 391
 392 // Filter for compiling config entries
 393 function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
 394         // Save the uncompiled code
 395         $uncompiled = $code;
 396
 397         // Do we have cache?
 398         if (!isset($GLOBALS['compiled_config'][$code])) {
 399                 // Compile {?some_var?} to getConfig('some_var')
 400                 preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
 401
 402                 // Some entries found?
 403                 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
 404                         // Replace all matches
 405                         foreach ($matches[0] as $key => $match) {
 406                                 // Do we have cache?
 407                                 if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
 408                                         // Is the config valid?
 409                                         if (isConfigEntrySet($matches[1][$key])) {
 410                                                 // Set it for caching
 411                                                 $GLOBALS['compile_config'][$matches[1][$key]] = "\".getConfig('" . $matches[1][$key] . "').\"";
 412                                         } elseif (isConfigEntrySet('default_' . strtoupper($matches[1][$key]))) {
 413                                                 // Use default value
 414                                                 $GLOBALS['compile_config'][$matches[1][$key]] = "\".getConfig('" . 'DEFAULT_' . strtoupper($matches[1][$key]) . "').\"";
 415                                         } elseif (isMessageIdValid('DEFAULT_' . strtoupper($matches[1][$key]))) {
 416                                                 // No config, try the language system
 417                                                 $GLOBALS['compile_config'][$matches[1][$key]] = "\".getMessage('". 'DEFAULT_' . strtoupper($matches[1][$key]) . "').\"";
 418                                         } else {
 419                                                 // Unhandled!
 420                                                 $GLOBALS['compile_config'][$matches[1][$key]] = '!' . $matches[1][$key] . '!';
 421                                         }
 422                                 } // END - if
 423
 424                                 // Use this for replacing
 425                                 $code = str_replace($match, $GLOBALS['compile_config'][$matches[1][$key]], $code);
 426                                 //* DEBUG: */ if (($match == '{?URL?}') && (strlen($code) > 10000)) die('<pre>'.htmlentities($code).'</pre>');
 427                         } // END - foreach
 428                 } // END - if
 429
 430                 // Add it to cache
 431                 $GLOBALS['compiled_config'][$uncompiled] = $code;
 432         } // END - if
 433
 434         // Should we compile it?
 435         if ($compiled === true) {
 436                 // Run the code
 437                 eval("\$GLOBALS['compiled_config'][\$uncompiled] = \"" . $GLOBALS['compiled_config'][$uncompiled] . "\";");
 438         } // END - if
 439
 440         // Return compiled code
 441         return $GLOBALS['compiled_config'][$uncompiled];
 442 }
 443
 444 // Filter for compiling extension data
 445 function FILTER_COMPILE_EXTENSION ($code) {
 446         // Compile {%cmd=some_value%} to get extension data
 447         // Support cmd is:
 448         //   - version -> getExtensionVersion() call
 449         preg_match_all('/\{%((([a-zA-Z0-9-_]+)=([a-zA-Z0-9-_]+))*)\%\}/', $code, $matches);
 450
 451         // Some entries found?
 452         if ((count($matches) > 0) && (count($matches[3]) > 0)) {
 453                 // Replace all matches
 454                 foreach ($matches[3] as $key => $cmd) {
 455                         // By default we have no extension installed, so 'false' is assumed
 456                         $replacer = 'false';
 457
 458                         // Is the extension installed or code provided?
 459                         if ($cmd == 'code') {
 460                                 // Code asked for
 461                                 $replacer = getCode($matches[4][$key]);
 462                         } elseif (isExtensionActive($matches[4][$key])) {
 463                                 // Construct call-back function name
 464                                 $functionName = 'getExtension' . ucfirst(strtolower($cmd));
 465
 466                                 // Call the function
 467                                 $replacer = call_user_func_array($functionName, $matches[4][$key]);
 468                         } // END - if
 469
 470                         // Replace it and insert parameter for GET request
 471                         $code = str_replace($matches[0][$key], sprintf("&amp;%s=%s&amp;rev=%s", $cmd, $replacer, getConfig('CURR_SVN_REVISION')), $code);
 472                 } // END - foreach
 473         } // END - if
 474
 475         // Return compiled code
 476         return $code;
 477 }
 478
 479 // Runs some generic filter update steps
 480 function FILTER_UPDATE_EXTENSION_DATA ($ext_name) {
 481         // Create task
 482         createExtensionUpdateTask(getCurrentAdminId(), $ext_name, $GLOBALS['update_ver'][$ext_name], SQL_ESCAPE(getExtensionNotes(getExtensionNotes())));
 483
 484         // Update extension's version
 485         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_version`='%s' WHERE `ext_name`='%s' LIMIT 1",
 486                 array($GLOBALS['update_ver'][$ext_name], $ext_name), __FUNCTION__, __LINE__);
 487
 488         // Remove arrays
 489         unsetSqls();
 490         unset($GLOBALS['update_ver'][$ext_name]);
 491 }
 492
 493 // Load more reset scripts
 494 function FILTER_RUN_RESET_INCLUDES () {
 495         // Is the reset set or old sql_patches?
 496         if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (getOutputMode() == '0')) {
 497                 // Then abort here
 498                 logDebugMessage(__FUNCTION__, __LINE__, 'Cannot run reset! Please report this bug. Thanks');
 499         } // END - if
 500
 501         // Get more daily reset scripts
 502         setIncludePool('reset', getArrayFromDirectory('inc/reset/', 'reset_'));
 503
 504         // Update database
 505         if ((!isConfigEntrySet('DEBUG_RESET')) || (getConfig('DEBUG_RESET') != 'Y')) updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
 506
 507         // Is the config entry set?
 508         if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
 509                 // Create current week mark
 510                 $currWeek = date('W', time());
 511
 512                 // Has it changed?
 513                 if ((getConfig('last_week') != $currWeek) || (getConfig('DEBUG_WEEKLY') == 'Y')) {
 514                         // Include weekly reset scripts
 515                         mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
 516
 517                         // Update config
 518                         if ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') != 'Y')) updateConfiguration('last_week', $currWeek);
 519                 } // END - if
 520
 521                 // Create current month mark
 522                 $currMonth = date('m', time());
 523
 524                 // Has it changed?
 525                 if ((getConfig('last_month') != $currMonth) || (getConfig('DEBUG_MONTHLY') == 'Y')) {
 526                         // Include monthly reset scripts
 527                         mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
 528
 529                         // Update config
 530                         if ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') != 'Y')) updateConfiguration('last_month', $currMonth);
 531                 } // END - if
 532         } // END - if
 533
 534         // Run the filter
 535         runFilterChain('load_includes', 'reset');
 536 }
 537
 538 // Filter for removing the given extension
 539 function FILTER_REMOVE_EXTENSION () {
 540         // Delete this extension (remember to remove it from your server *before* you click on welcome!
 541         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
 542                 array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
 543
 544         // Remove the extension from global cache array as well
 545         removeExtensionFromArray();
 546
 547         // Remove the cache
 548         rebuildCacheFile('extension', 'extension');
 549 }
 550
 551 // Filter for flushing the output
 552 function FILTER_FLUSH_OUTPUT () {
 553         // Simple, he?
 554         outputHtml('');
 555 }
 556
 557 // Prepares an SQL statement part for HTML mail and/or holiday depency
 558 function FILTER_HTML_INCLUDE_USERS ($mode) {
 559         // Exclude no users by default
 560         $MORE = '';
 561
 562         // HTML mail?
 563         if ($mode == 'html') $MORE = " AND `html`='Y'";
 564         if ((isExtensionActive('holiday')) && (getExtensionVersion('holiday') >= '0.1.3')) {
 565                 // Add something for the holiday extension
 566                 $MORE .= " AND `holiday_active`='N'";
 567         } // END - if
 568
 569         // Return result
 570         return $MORE;
 571 }
 572
 573 // Filter for determining what/action/module
 574 function FILTER_DETERMINE_WHAT_ACTION () {
 575         // In installation phase we don't have what/action
 576         if (isInstallationPhase()) {
 577                 // Set both to empty
 578                 setAction('');
 579                 setWhat('');
 580
 581                 // Abort here
 582                 return;
 583         } // END - if
 584
 585         // Get all values
 586         if ((getOutputMode() != 1) && (getOutputMode() != -1)) {
 587                 // Fix module
 588                 if (!isModuleSet()) {
 589                         // Is the request element set?
 590                         if (isGetRequestElementSet('module')) {
 591                                 // Set module from request
 592                                 setModule(getRequestElement('module'));
 593                         } else {
 594                                 // Set default module 'index'
 595                                 setModule('index');
 596                         }
 597                 } // END - if
 598
 599                 // Fix 'what' if not yet set
 600                 if (!isWhatSet())   setWhat(getWhatFromModule(getModule()));
 601
 602                 // Fix 'action' if not yet set
 603                 if (!isActionSet()) setAction(getModeAction(getModule(), getWhat()));
 604         } else {
 605                 // Set action/what to empty
 606                 setAction('');
 607                 setWhat('');
 608         }
 609
 610         // Set default 'what' value
 611         //* DEBUG: */ outputHtml('-'.getModule().'/'.getWhat()."-<br />");
 612         if ((!isWhatSet()) && (!isActionSet()) && (getOutputMode() != 1) && (getOutputMode() != -1)) {
 613                 if (getModule() == 'admin') {
 614                         // Set 'action' value to 'login' in admin menu
 615                         setAction(getModeAction(getModule(), getWhat()));
 616                 } elseif ((getModule() == 'index') || (getModule() == 'login')) {
 617                         // Set 'what' value to 'welcome' in guest and member menu
 618                         setWhatFromConfig('index_home');
 619                 } else {
 620                         // Anything else like begging link
 621                         setWhat('');
 622                 }
 623         } // END - if
 624 }
 625
 626 // Sends out pooled mails
 627 function FILTER_TRIGGER_SENDING_POOL () {
 628         // Are we in normal output mode?
 629         if (getOutputMode() != 0) {
 630                 // Only in normal output mode to prevent race-conditons!
 631         } // END - if
 632
 633         // Init counter
 634         $GLOBALS['pool_cnt'] = '0';
 635
 636         // Init & set the include pool
 637         initIncludePool('pool');
 638         setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));
 639
 640         // Run the filter
 641         runFilterChain('load_includes', 'pool');
 642
 643         // Remove the counter
 644         unset($GLOBALS['pool_cnt']);
 645 }
 646
 647 // Filter for checking and updating SVN revision
 648 function FILTER_CHECK_SVN_REVISION () {
 649         // Only execute this filter if installed and all config entries are there
 650         if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) return;
 651
 652         // Check for patch level differences between databases and current hard-coded
 653         if ((getConfig('CURR_SVN_REVISION') > getConfig('patch_level')) || (getConfig('patch_level') == 'CURR_SVN_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
 654                 // Update database and CONFIG array
 655                 updateConfiguration(array('patch_level', 'patch_ctime'), array(getConfig('CURR_SVN_REVISION'), 'UNIX_TIMESTAMP()'));
 656                 setConfigEntry('patch_level', getConfig('CURR_SVN_REVISION'));
 657                 setConfigEntry('patch_ctime', time());
 658         } // END - if
 659 }
 660
 661 // Filter for running daily reset
 662 function FILTER_RUN_DAILY_RESET () {
 663         // Only execute this filter if installed
 664         if ((!isInstalled()) || (!isAdminRegistered())) return;
 665
 666         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 667         // 012    3              4             43        3         4432    2         3             3       21    1                    221    1                 221    1                  2          21    1             22     10
 668         if (((date('d', getConfig('last_update')) != date('d', time())) || ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y'))) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (getOutputMode() != 1)) {
 669                 // Tell every module we are in reset-mode!
 670                 doReset();
 671         } // END - if
 672 }
 673
 674 // Filter for loading more runtime includes (not for installation)
 675 function FILTER_LOAD_RUNTIME_INCLUDES () {
 676         // Load more includes
 677         foreach (array('inc/databases.php','inc/session.php','inc/versions.php') as $inc) {
 678                 // Load the include
 679                 loadIncludeOnce($inc);
 680         } // END - foreach
 681
 682         // Load admin include file if he is admin
 683         if (isAdmin()) {
 684                 // Administrative functions
 685                 loadIncludeOnce('inc/modules/admin/admin-inc.php');
 686         } // END - if
 687         //* DEBUG: */ addPointsThroughReferalSystem('test', 36, 1000);
 688         //* DEBUG: */ die();
 689 }
 690
 691 // Filter for checking admin ACL
 692 function FILTER_CHECK_ADMIN_ACL () {
 693         // Extension not installed so it's always allowed to access everywhere!
 694         $ret = true;
 695
 696         // Ok, Cookie-Update done
 697         if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
 698                 // Check if action GET variable was set
 699                 $action = getAction();
 700                 if (isWhatSet()) {
 701                         // Get action value by what-value
 702                         $action = getModeAction('admin', getWhat());
 703                 } // END - if
 704
 705                 // Check for access control line of current menu entry
 706                 $ret = adminsCheckAdminAcl($action, getWhat());
 707         } // END - if
 708
 709         // Set it here
 710         $GLOBALS['acl_allow'] = $ret;
 711 }
 712
 713 // Init random number/cache buster
 714 function FILTER_INIT_RANDOM_NUMBER () {
 715         // Is the extension sql_patches installed and at least 0.3.6?
 716         if ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
 717                 // Generate random number
 718                 setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 32766), getMemberId(), ''));
 719         } else {
 720                 // Generate weak (!!!) code
 721                 setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
 722         }
 723
 724         // Copy it to CACHE_BUSTER
 725         setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
 726 }
 727
 728 // Update module counter
 729 function FILTER_COUNT_MODULE () {
 730         // Do count all other modules but not accesses on CSS file css.php!
 731         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
 732                 array(getModule()), __FUNCTION__, __LINE__);
 733 }
 734
 735 // Handles fatal errors
 736 function FILTER_HANDLE_FATAL_ERRORS () {
 737         // Do we have errors to handle and right output mode?
 738         if ((getTotalFatalErrors() == '0') || (getOutputMode() != 0)) {
 739                 // Abort executing here
 740                 return false;
 741         } // END - if
 742
 743         // Set content type
 744         setContentType('text/html');
 745
 746         // Load config here
 747         loadIncludeOnce('inc/load_config.php');
 748
 749         // Set unset variable
 750         if (empty($check)) $check = '';
 751
 752         // Default is none
 753         $content = '';
 754
 755         // Installation phase or regular mode?
 756         if ((isInstallationPhase())) {
 757                 // While we are installing ouput other header than while it is installed... :-)
 758                 $OUT = '';
 759                 foreach (getFatalArray() as $key => $value) {
 760                         // Prepare content for the template
 761                         $content = array(
 762                                 'key'   => ($key + 1),
 763                                 'value' => $value
 764                         );
 765
 766                         // Load row template
 767                         $OUT .= loadTemplate('install_fatal_row', true, $content);
 768                 }
 769
 770                 // Load main template
 771                 $content = loadTemplate('install_fatal_table', true, $OUT);
 772         } elseif (isInstalled()) {
 773                 // Display all runtime fatal errors
 774                 $OUT = '';
 775                 foreach (getFatalArray() as $key => $value) {
 776                         // Prepare content for the template
 777                         $content = array(
 778                                 'key'   => ($key + 1),
 779                                 'value' => $value
 780                         );
 781
 782                         // Load row template
 783                         $OUT .= loadTemplate('runtime_fatal_row', true, $content);
 784                 }
 785
 786                 // Load main template
 787                 $content = loadTemplate('runtime_fatal_table', true, $OUT);
 788         }
 789
 790         // Message to regular users (non-admin)
 791         $CORR = getMessage('FATAL_REPORT_ERRORS');
 792
 793         // PHP warnings fixed
 794         if ($check == 'done') {
 795                 if (isAdmin()) $CORR = getMessage('FATAL_CORRECT_ERRORS');
 796         } // END - if
 797
 798         // Remember all in array
 799         $content = array(
 800                 'rows' => $content,
 801                 'corr' => $CORR
 802         );
 803
 804         // Load footer
 805         loadIncludeOnce('inc/header.php');
 806
 807         // Load main template
 808         loadTemplate('fatal_errors', false, $content);
 809
 810         // Delete all to prevent double-display
 811         initFatalMessages();
 812
 813         // Load footer
 814         loadIncludeOnce('inc/footer.php');
 815
 816         // Abort here
 817         shutdown();
 818 }
 819
 820 // Filter for displaying copyright line
 821 function FILTER_DISPLAY_COPYRIGHT () {
 822         // Shall we display the copyright notice?
 823         if ((!isGetRequestElementSet('frame')) && (basename($_SERVER['PHP_SELF']) != 'mailid_top.php') && ((getConfig('WRITE_FOOTER') == 'Y') || (isInstalling())) && ($GLOBALS['header_sent'] == 2)) {
 824                 // Backlink enabled?
 825                 if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
 826                         // Copyright with backlink, thanks! :-)
 827                         loadTemplate('copyright_backlink');
 828                 } else {
 829                         // No backlink in Copyright note
 830                         loadTemplate('copyright');
 831                 }
 832         } // END - if
 833 }
 834
 835 // Filter for displaying parsing time
 836 function FILTER_DISPLAY_PARSING_TIME () {
 837         // Shall we display the parsing time and number of queries?
 838         // 1234                            5                      54    4         5              5       4    4                       5       543    3                   4432    2             33     2    2                              21
 839         if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestElementSet('frame'))) || (isInstallationPhase())) && (getOutputMode() == '0') && ($GLOBALS['header_sent'] == 2)) {
 840                 // Then display it here
 841                 displayParsingTime();
 842         } // END - if
 843 }
 844
 845 // Filter for flushing template cache
 846 function FILTER_FLUSH_TEMPLATE_CACHE () {
 847         // Do we have cached eval() data?
 848         if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
 849                 // Now flush all
 850                 foreach ($GLOBALS['template_eval'] as $template=>$eval) {
 851                         // Flush the cache (if not yet found)
 852                         flushTemplateCache($template, $eval);
 853                 } // END - if
 854         } // END - if
 855 }
 856
 857 // [EOF]
 858 ?>