inc/filters.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 12/16/2008 *
   4  * ===================                          Last change: 12/16/2008 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : filters.php                                      *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Generic filters                                  *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Allgemeine Filter                                *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * -------------------------------------------------------------------- *
  18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  19  * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
  20  * For more information visit: http://mxchange.org                      *
  21  *                                                                      *
  22  * This program is free software; you can redistribute it and/or modify *
  23  * it under the terms of the GNU General Public License as published by *
  24  * the Free Software Foundation; either version 2 of the License, or    *
  25  * (at your option) any later version.                                  *
  26  *                                                                      *
  27  * This program is distributed in the hope that it will be useful,      *
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  30  * GNU General Public License for more details.                         *
  31  *                                                                      *
  32  * You should have received a copy of the GNU General Public License    *
  33  * along with this program; if not, write to the Free Software          *
  34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  35  * MA  02110-1301  USA                                                  *
  36  ************************************************************************/
  37
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         die();
  41 } // END - if
  42
  43 // Filter for flushing all new filters to the database
  44 function FILTER_FLUSH_FILTERS () {
  45         // Clear all previous SQL queries
  46         initSqls();
  47
  48         // Is a database link here and not in installation mode?
  49         if ((!SQL_IS_LINK_UP()) && (!isInstallationPhase())) {
  50                 // Abort here
  51                 reportBug(__FUNCTION__, __LINE__, 'No database link is up. Cannot flush filters.');
  52         } elseif ((isInstallationPhase()) && (!SQL_IS_LINK_UP())) {
  53                 // If the link is not up in installation phase, skip flushing filters
  54                 //* 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'", SQL_ESCAPE($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                                                 SQL_ALTER_TABLE($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                                                 SQL_QUERY($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
 278                                         }
 279
 280                                         // Has a line changed?
 281                                         if (!SQL_HASZEROAFFECTED()) {
 282                                                 // Add it to total account
 283                                                 $count += SQL_AFFECTEDROWS();
 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], SQL_ESCAPE(getExtensionNotes(getExtensionNotes())));
 571
 572         // Update extension's version
 573         SQL_QUERY_ESC("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.7.5'))) && (isHtmlOutputMode())) {
 585                 // Then abort here
 586                 reportBug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isHourlyResetEnabled()).',ext_newer[sql_patches:0.7.5]='.intval(isExtensionInstalledAndNewer('sql_patches', '0.7.5')).' Please report this bug. Thanks');
 587         } // END - if
 588
 589         // Get more hourly reset scripts
 590         setIncludePool('hourly', getArrayFromDirectory('inc/hourly/', 'hourly_'));
 591
 592         // Update database
 593         if ((!isConfigEntrySet('DEBUG_RESET')) || (!isDebugResetEnabled())) {
 594                 updateConfiguration('last_hour', getHour());
 595         } // END - if
 596
 597         // Run the filter
 598         runFilterChain('load_includes', 'hourly');
 599 }
 600
 601 // Load more reset scripts
 602 function FILTER_RUN_RESET_INCLUDES () {
 603         // Is the reset set or old sql_patches?
 604         if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (isHtmlOutputMode())) {
 605                 // Then abort here
 606                 reportBug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
 607         } // END - if
 608
 609         // Get more daily reset scripts
 610         setIncludePool('reset', getArrayFromDirectory('inc/daily/', 'daily_'));
 611
 612         // Update configuration if this reset is not being debugged
 613         if (!isDebugResetEnabled()) {
 614                 updateConfiguration('last_update', 'UNIX_TIMESTAMP()');
 615         } // END - if
 616
 617         // Is the config entry set?
 618         if (isExtensionInstalledAndNewer('sql_patches', '0.4.2')) {
 619                 // Has it changed?
 620                 if (((isConfigEntrySet('last_week')) && (getConfig('last_week') != getWeek())) || (isWeeklyResetDebugEnabled())) {
 621                         // Include weekly reset scripts
 622                         mergeIncludePool('reset', getArrayFromDirectory('inc/weekly/', 'weekly_'));
 623
 624                         // Update configuration if this reset is not being debugged
 625                         if (!isWeeklyResetDebugEnabled()) {
 626                                 updateConfiguration('last_week', getWeek());
 627                         } // END - if
 628                 } // END - if
 629
 630                 // Create current month mark
 631                 $currMonth = getMonth();
 632
 633                 // Has it changed?
 634                 if ((getLastMonth() != $currMonth) || (isMonthlyResetDebugEnabled())) {
 635                         // Include monthly reset scripts
 636                         mergeIncludePool('reset', getArrayFromDirectory('inc/monthly/', 'monthly_'));
 637
 638                         // Update configuration if this reset is not being debugged
 639                         if (!isMonthlyResetDebugEnabled()) {
 640                                 updateConfiguration('last_month', $currMonth);
 641                         } // END - if
 642                 } // END - if
 643         } // END - if
 644
 645         // Run the filter
 646         runFilterChain('load_includes', 'reset');
 647 }
 648
 649 // Filter for removing the given extension
 650 function FILTER_REMOVE_EXTENSION () {
 651         // Delete this extension (remember to remove it from your server *before* you click on welcome!
 652         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
 653                 array(getCurrentExtensionName()), __FUNCTION__, __LINE__);
 654
 655         // Remove the extension from cache array as well
 656         removeExtensionFromArray();
 657
 658         // Remove the cache
 659         rebuildCache('extension', 'extension');
 660 }
 661
 662 // Filter for flushing the output
 663 function FILTER_FLUSH_OUTPUT () {
 664         // Is this filter called?
 665         if (isset($GLOBALS[__FUNCTION__])) {
 666                 // Abort here
 667                 reportBug(__FUNCTION__, __LINE__, 'Double call of ' . __FUNCTION__ . ' causes problems with sent headers.');
 668         } // END - if
 669
 670         // Mark this filter as called
 671         $GLOBALS[__FUNCTION__] = TRUE;
 672
 673         // Simple, he?
 674         outputHtml();
 675 }
 676
 677 // Prepares an SQL statement part for HTML mail and/or holiday dependency
 678 function FILTER_HTML_INCLUDE_USERS ($mode) {
 679         // Exclude no users by default
 680         $MORE = '';
 681
 682         // HTML mail?
 683         if ($mode == 'html') {
 684                 $MORE = " AND `html`='Y'";
 685         } // END - if
 686
 687         if (isExtensionInstalledAndNewer('holiday', '0.1.3')) {
 688                 // Add something for the holiday extension
 689                 $MORE .= " AND `holiday_active`='N'";
 690         } // END - if
 691
 692         // Return result
 693         return $MORE;
 694 }
 695
 696 // Filter for determining what/action/module
 697 function FILTER_DETERMINE_WHAT_ACTION () {
 698         // In installation phase we don't have what/action
 699         if (isInstallationPhase()) {
 700                 // Set both to empty
 701                 setAction('');
 702                 setWhat('');
 703
 704                 // Abort here
 705                 return;
 706         } // END - if
 707
 708         // Get all values
 709         if ((!isCssOutputMode()) && (!isRawOutputMode())) {
 710                 // Fix module
 711                 if (!isModuleSet()) {
 712                         // Is the module registered?
 713                         if (!isModuleRegistered(getRequestElement('module'))) {
 714                                 // Is not a valid module
 715                                 redirectToUrl('modules.php?module=index');
 716                         } // END - if
 717
 718                         // Is the request element set?
 719                         if (isGetRequestElementSet('module')) {
 720                                 // Set module from request
 721                                 setModule(getRequestElement('module'));
 722                         } elseif (isHtmlOutputMode()) {
 723                                 // Set default module 'index'
 724                                 setModule('index');
 725                         } else {
 726                                 // Unknown module
 727                                 setModule('unknown');
 728                         }
 729                 } // END - if
 730
 731                 // Fix 'what' if not yet set
 732                 if (!isWhatSet()) {
 733                         setWhat(getWhatFromModule(getModule()));
 734                 } // END - if
 735
 736                 // Fix 'action' if not yet set
 737                 if (!isActionSet()) {
 738                         // Is 'what' set?
 739                         if (isWhatSet()) {
 740                                 // Set action
 741                                 setAction(getActionFromModuleWhat(getModule(), getWhat()));
 742                         } else {
 743                                 // Set action/what to empty
 744                                 setAction('');
 745                                 setWhat('');
 746                         }
 747                 } // END - if
 748         } else {
 749                 // Set action/what to empty
 750                 setAction('');
 751                 setWhat('');
 752         }
 753
 754         // Set default 'what' value
 755         //* DEBUG: */ debugOutput('-' . getModule() . '/' . getWhat() . '-');
 756         if ((!isWhatSet()) && (!isActionSet()) && (!isCssOutputMode()) && (!isRawOutputMode())) {
 757                 if (getModule() == 'admin') {
 758                         // Set 'action' value to 'login' in admin menu
 759                         setAction(getActionFromModuleWhat(getModule(), getWhat()));
 760                 } elseif ((getModule() == 'index') || (getModule() == 'login')) {
 761                         // Set 'what' value to 'welcome' in guest and member menu
 762                         setWhatFromConfig('index_home');
 763                 } else {
 764                         // Anything else like begging link
 765                         setWhat('');
 766                 }
 767         } // END - if
 768 }
 769
 770 // Sends out pooled mails
 771 function FILTER_TRIGGER_SENDING_POOL () {
 772         // Are we in normal output mode?
 773         if (!isHtmlOutputMode()) {
 774                 // Only in normal output mode to prevent race-conditons!
 775         } // END - if
 776
 777         // Init counter
 778         $GLOBALS['pool_cnt'] = '0';
 779
 780         // Init & set the include pool
 781         initIncludePool('pool');
 782         setIncludePool('pool', getArrayFromDirectory('inc/pool/', 'pool-'));
 783
 784         // Run the filter
 785         runFilterChain('load_includes', 'pool');
 786
 787         // Remove the counter
 788         unset($GLOBALS['pool_cnt']);
 789 }
 790
 791 // Filter for checking and updating SVN revision
 792 function FILTER_CHECK_REPOSITORY_REVISION () {
 793         // Only execute this filter if installed and all config entries are there
 794         if ((!isInstalled()) || (!isConfigEntrySet('patch_level'))) return;
 795
 796         // Check for patch level differences between database and current hard-coded
 797         if ((getCurrentRepositoryRevision() > getConfig('patch_level')) || (getConfig('patch_level') == 'CURRENT_REPOSITORY_REVISION') || (getConfig('patch_ctime') == 'UNIX_TIMES')) {
 798                 // Update database and CONFIG array
 799                 updateConfiguration(array('patch_level', 'patch_ctime'), array(getCurrentRepositoryRevision(), 'UNIX_TIMESTAMP()'));
 800                 setConfigEntry('patch_level', getCurrentRepositoryRevision());
 801                 setConfigEntry('patch_ctime', time());
 802         } // END - if
 803 }
 804
 805 // Filter for running daily reset
 806 function FILTER_RUN_DAILY_RESET () {
 807         // Only execute this filter if installed
 808         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalled('sql_patches'))) {
 809                 return;
 810         } // END - if
 811
 812         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 813         if (((getDay(getConfig('last_update')) != getDay()) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (!isCssOutputMode())) {
 814                 // Tell every module we are in reset-mode!
 815                 doReset();
 816         } // END - if
 817 }
 818
 819 // Filter for running hourly reset
 820 function FILTER_RUN_HOURLY_RESET () {
 821         // Only execute this filter if installed
 822         if ((isInstallationPhase()) || (!isInstalled()) || (!isAdminRegistered()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) {
 823                 return;
 824         } // END - if
 825
 826         // Shall we run the reset scripts? If a day has changed, maybe also a week/month has changed... Simple! :D
 827         if ((((isConfigEntrySet('last_hour')) && (getConfig('last_hour') != getHour())) || (isDebugResetEnabled())) && (!isInstallationPhase()) && (isAdminRegistered()) && (!isGetRequestElementSet('register')) && (!isCssOutputMode())) {
 828                 // Tell every module we are in reset-mode!
 829                 doHourly();
 830         } // END - if
 831 }
 832
 833 // Filter for loading more runtime includes (not for installation)
 834 function FILTER_LOAD_RUNTIME_INCLUDES () {
 835         // Load more includes
 836         foreach (array('databases', 'session', 'versions') as $inc) {
 837                 // Load the include
 838                 loadIncludeOnce('inc/' . $inc . '.php');
 839         } // END - foreach
 840 }
 841
 842 // Filter for checking admin ACL
 843 function FILTER_CHECK_ADMIN_ACL () {
 844         // Extension not installed so it's always allowed to access everywhere!
 845         $ret = TRUE;
 846
 847         // Ok, Cookie-Update done
 848         if ((isExtensionInstalledAndNewer('admins', '0.3.0')) && (isExtensionActive('admins'))) {
 849                 // Check if action GET variable was set
 850                 $action = getAction();
 851                 if (isWhatSet()) {
 852                         // Get action value by what-value
 853                         $action = getActionFromModuleWhat('admin', getWhat());
 854                 } // END - if
 855
 856                 // Check for access control line of current menu entry
 857                 $ret = isAdminsAllowedByAcl($action, getWhat());
 858         } // END - if
 859
 860         // Set it here
 861         $GLOBALS['acl_allow'] = $ret;
 862 }
 863
 864 // Init random number/cache buster
 865 function FILTER_INIT_RANDOM_NUMBER () {
 866         // Is the extension ext-sql_patches installed and at least 0.3.6?
 867         if (isSessionVariableSet('random_number')) {
 868                 // Then set it
 869                 setConfigEntry('RAND_NUMBER', getSession('random_number'));
 870         } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && (isExtensionInstalledAndNewer('other', '0.2.5'))) {
 871                 // Generate random number
 872                 setConfigEntry('RAND_NUMBER', generateRandomCode(10, mt_rand(10000, 99999), getMemberId(), ''));
 873         } else {
 874                 // Generate *WEAK* code
 875                 setConfigEntry('RAND_NUMBER', mt_rand(1000000, 9999999));
 876         }
 877
 878         // Set it in session for faster script execusion
 879         setSession('random_number', getConfig('RAND_NUMBER'));
 880
 881         // Copy it to CACHE_BUSTER
 882         setConfigEntry('CACHE_BUSTER', getConfig('RAND_NUMBER'));
 883 }
 884
 885 // Update module counter
 886 function FILTER_COUNT_MODULE () {
 887         // Is installation phase?
 888         if (isInstallationPhase()) {
 889                 // Then don't count any modules
 890                 return;
 891         } // END - if
 892
 893         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ' - ENTERED!');
 894         // Do count all other modules but not accesses on CSS file css.php!
 895         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `clicks`=`clicks`+1 WHERE `module`='%s' LIMIT 1",
 896                 array(getModule()), __FUNCTION__, __LINE__);
 897         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getModule()=' . getModule() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
 898 }
 899
 900 // Handles fatal errors
 901 function FILTER_HANDLE_FATAL_ERRORS () {
 902         // Is there errors to handle and right output mode?
 903         if ((!ifFatalErrorsDetected()) || (!isHtmlOutputMode())) {
 904                 // Abort executing here
 905                 return FALSE;
 906         } // END - if
 907
 908         // Set content type
 909         setContentType('text/html');
 910
 911         // Load config here
 912         loadIncludeOnce('inc/load_config.php');
 913
 914         // Default content is none
 915         $content = '';
 916
 917         // Installation phase or regular mode?
 918         if ((isInstallationPhase())) {
 919                 // While we are installing ouput other header than while it is installed... :-)
 920                 $OUT = '';
 921                 foreach (getFatalArray() as $key => $value) {
 922                         // Prepare content for the template
 923                         $content = array(
 924                                 'key'   => ($key + 1),
 925                                 'value' => $value
 926                         );
 927
 928                         // Load row template
 929                         $OUT .= loadTemplate('install_fatal_row', TRUE, $content);
 930                 }
 931
 932                 // Load main template
 933                 $content = loadTemplate('install_fatal_table', TRUE, $OUT);
 934         } elseif (isInstalled()) {
 935                 // Display all runtime fatal errors
 936                 $OUT = '';
 937                 foreach (getFatalArray() as $key => $value) {
 938                         // Prepare content for the template
 939                         $content = array(
 940                                 'key'   => ($key + 1),
 941                                 'value' => $value
 942                         );
 943
 944                         // Load row template
 945                         $OUT .= loadTemplate('runtime_fatal_row', TRUE, $content);
 946                 }
 947
 948                 // Load main template
 949                 $content = loadTemplate('runtime_fatal_table', TRUE, $OUT);
 950         }
 951
 952         // Message to regular users (non-admin)
 953         $CORR = '{--FATAL_REPORT_ERRORS--}';
 954
 955         // Maybe the admin wants to take a look?
 956         if (isAdmin()) {
 957                 $CORR = '{--FATAL_CORRECT_ERRORS--}';
 958         } // END - if
 959
 960         // Remember all in array
 961         $content = array(
 962                 'rows' => $content,
 963                 'corr' => $CORR
 964         );
 965
 966         // Load footer
 967         loadIncludeOnce('inc/header.php');
 968
 969         // Load main template
 970         loadTemplate('fatal_errors', FALSE, $content);
 971
 972         // Delete all to prevent double-display
 973         initFatalMessages();
 974
 975         // Load footer
 976         loadIncludeOnce('inc/footer.php');
 977
 978         // Abort here
 979         doShutdown();
 980 }
 981
 982 // Filter for displaying copyright line
 983 function FILTER_DISPLAY_COPYRIGHT () {
 984         // Shall we display the copyright notice?
 985         if ((isFullPage()) && ((getWriteFooter() == 'Y') || (isInstalling())) && ($GLOBALS['__header_sent'] == 2) && (ifCopyrightFooterEnabled())) {
 986                 // Backlink enabled?
 987                 if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
 988                         // Copyright with backlink, thanks! :-)
 989                         $GLOBALS['__page_footer'] .= loadTemplate('copyright_backlink', TRUE);
 990                 } else {
 991                         // No backlink in Copyright note
 992                         $GLOBALS['__page_footer'] .= loadTemplate('copyright', TRUE);
 993                 }
 994         } // END - if
 995 }
 996
 997 // Filter for displaying parsing time
 998 function FILTER_DISPLAY_PARSING_TIME () {
 999         // Shall we display the parsing time and number of queries?
1000         // 1234                            5                      54    4                    554    4          5543    3                    4432    2                332    2                              21
1001         if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (isShowTimingsEnabled()) && (isFullPage())) && (!isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['__header_sent'] == 2)) {
1002                 // Then display it here
1003                 displayParsingTime();
1004         } // END - if
1005 }
1006
1007 // Filter for flushing template cache
1008 function FILTER_FLUSH_TEMPLATE_CACHE () {
1009         // Do not flush when debugging the template cache
1010         if (isDebugTemplateCacheEnabled()) {
1011                 // Do not flush templates in debug-mode
1012                 return;
1013         } // END - if
1014
1015         // Is there cached eval() data?
1016         if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
1017                 // Flush all
1018                 foreach ($GLOBALS['template_eval'] as $prefix => $templateArray) {
1019                         foreach ($templateArray as $template => $eval) {
1020                                 // Flush the cache (if not yet found)
1021                                 flushTemplateCache($prefix, $template, $eval);
1022                         } // END - foreach
1023                 } // END - foreach
1024         } // END - if
1025 }
1026
1027 // Filter for loading user data
1028 function FILTER_FETCH_USER_DATA ($userid = NULL) {
1029         // Is the userid not set?
1030         if (!isValidId($userid)) {
1031                 // Then use member id
1032                 $userid = getMemberId();
1033         } // END - if
1034
1035         // Get user data
1036         if (!fetchUserData($userid)) {
1037                 // Userid is not valid
1038                 reportBug(__FUNCTION__, __LINE__, 'User id ' . $userid . ' is invalid.');
1039         } // END - if
1040
1041         // Set member id
1042         setMemberId($userid);
1043
1044         // Continue with next filter
1045         return $userid;
1046 }
1047
1048 // Filter for reseting users' last login failure, only available with latest ext-sql_patches
1049 function FILTER_RESET_USER_LOGIN_FAILURE () {
1050         // Is the user data valid?
1051         if (!isMember()) {
1052                 // Do only run for logged in members
1053                 reportBug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
1054         } // END - if
1055
1056         // Remmeber login failures if available
1057         if (isExtensionInstalledAndNewer('user', '0.3.7')) {
1058                 // Reset login failures
1059                 SQL_QUERY_ESC("UPDATE
1060         `{?_MYSQL_PREFIX?}_user_data`
1061 SET
1062         `login_failures`=0,
1063         `last_failure`=NULL
1064 WHERE
1065         `userid`=%s
1066 LIMIT 1",
1067                         array(getMemberId()), __FUNCTION__, __LINE__);
1068
1069                 // Store it in session
1070                 setSession('mailer_member_failures' , getUserData('login_failures'));
1071                 setSession('mailer_member_last_failure', getUserData('last_failure'));
1072         } // END - if
1073 }
1074
1075 // Try to login the admin by setting some session/cookie variables
1076 function FILTER_DO_LOGIN_ADMIN ($filterData) {
1077         // Now set all session variables and store the result for later processing
1078         $GLOBALS['admin_login_success'] = ((
1079                 setAdminMd5(encodeHashForCookie($filterData['pass_hash']))
1080         ) && (
1081                 setAdminId($filterData['id'])
1082         ) && (
1083                 setAdminLast(time())
1084         ));
1085
1086         // Return the data for further processing
1087         return $filterData;
1088 }
1089
1090 // Filter for loading page header, this should be ran first!
1091 function FILTER_LOAD_PAGE_HEADER () {
1092         // Output page header code
1093         $GLOBALS['__page_header'] = loadTemplate('page_header', TRUE);
1094
1095         // Include meta data in 'guest' module
1096         if (isModuleSet()) {
1097                 // Load meta data template
1098                 $GLOBALS['__page_header'] .= loadTemplate(getMenuModeFromModule() . '_metadata', TRUE);
1099
1100                 // Add meta description to header
1101                 if ((isInstalled()) && (isAdminRegistered()) && (SQL_IS_LINK_UP()) && (getModule() == 'index')) {
1102                         // Add meta description not in admin and login module and when the script is installed
1103                         generateMetaDescriptionCode();
1104                 } // END - if
1105         } // END - if
1106 }
1107
1108 // Filter for adding style sheet, closing page header
1109 function FILTER_FINISH_PAGE_HEADER () {
1110         // Include stylesheet
1111         loadIncludeOnce('inc/stylesheet.php');
1112
1113         // Closing HEAD tag
1114         $GLOBALS['__page_header'] .= '</head>';
1115 }
1116
1117 // Cleans up the DNS cache if ext-sql_patches is at least 0.7.0
1118 function FILTER_CLEANUP_DNS_CACHE () {
1119         // Is the latest version installed?
1120         if (isExtensionInstalledAndNewer('sql_patches', '0.7.0')) {
1121                 // Load class file
1122                 loadIncludeOnce('inc/classes/resolver.class.php');
1123
1124                 // Instance the resolver
1125                 $resolver = new HostnameResolver();
1126
1127                 // Purge entries
1128                 $resolver->purgeEntries();
1129
1130                 // Cute, isn't it? ;-)
1131         } // END - if
1132 }
1133
1134 // Filter for setting CURRENT_DATE, this is required after initialization of extensions
1135 function FILTER_SET_CURRENT_DATE () {
1136         // Set current date
1137         setConfigEntry('CURRENT_DATE', generateDateTime(time(), '3'));
1138
1139         // Epoche time for yesterday, today ... all at 00:00 am
1140         setConfigEntry('START_YDAY', makeTime(0, 0, 0, time() - getOneDay()));
1141         setConfigEntry('START_TDAY', makeTime(0, 0, 0, time()));
1142 }
1143
1144 // Filter for marking extension as installed
1145 function FILTER_EXTENSION_MARK_INSTALLED ($filterData) {
1146         // Mark it as installed
1147         $GLOBALS['ext_is_installed'][$filterData['ext_name']] = TRUE;
1148 }
1149
1150 // Filter for generating mails links for 'pool' mails
1151 function FILTER_GENERATE_POOL_MAIL_LINKS ($filterData) {
1152         // Is type 'mid'?
1153         if ($filterData['type'] == 'mid') {
1154                 // Load template
1155                 $filterData['__output'] .= loadTemplate('admin_links_' . strtolower($filterData['mail_status']) . '_pool_mail', TRUE, $filterData);
1156         } // END - if
1157
1158         // Return data
1159         return $filterData;
1160 }
1161
1162 // Filter to activate exchange
1163 function FILTER_ACTIVATE_EXCHANGE () {
1164         // Is the extension 'user' there?
1165         if ((!isExtensionActive('user')) || (getActivateXchange() == '0')) {
1166                 // Silently abort here
1167                 return FALSE;
1168         } // END - if
1169
1170         // Check total amount of users
1171         if (getTotalConfirmedUser() >= getActivateXchange()) {
1172                 // Activate System
1173                 addSql("UPDATE `{?_MYSQL_PREFIX?}_mod_reg` SET `locked`='N',`hidden`='N',`mem_only`='Y' WHERE `module`='order' LIMIT 1");
1174                 addSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `visible`='Y',`locked`='N' WHERE `what`='order' OR `what`='unconfirmed' LIMIT 2");
1175
1176                 // Run SQLs
1177                 runFilterChain('run_sqls');
1178
1179                 // Update configuration
1180                 updateConfiguration('activate_xchange' ,0);
1181
1182                 // Rebuild cache
1183                 rebuildCache('modules', 'modules');
1184         } // END - if
1185 }
1186
1187 // Filter to handle configuration
1188 function FILTER_HANDLE_HOME_IN_INDEX_SETTING ($filterData) {
1189         // Is ext-sql_patches up-to-date?
1190         if ((isExtensionInstalledAndNewer('sql_patches', '0.8.3')) && (isDisplayHomeInIndexEnabled())) {
1191                 // Is 'search' as same as 'index_home'?
1192                 if ($filterData['search'] == getIndexHome()) {
1193                         // Then set 'content' to link to index.php
1194                         $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>';
1195                 } // END - if
1196         } // END - if
1197
1198         // Return data
1199         return $filterData;
1200 }
1201
1202 // Filter to add history entry
1203 function FILTER_ADD_HISTORY_ENTRY ($filterData) {
1204         // Add the entry
1205         SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_history` (`history_subject`, `history_userid`, `history_value`) VALUES ('%s',%s,'%s')",
1206                 $filterData,
1207                 __FUNCTION__, __LINE__);
1208
1209         // Remember insert id for other filters
1210         $filterData['history_id'] = SQL_INSERTID();
1211
1212         // Return data
1213         return $filterData;
1214 }
1215
1216 // Filter for initializing ext-sql_patches
1217 function FILTER_GENERATE_FILE_SECRET_HASH ($filterData) {
1218         // Transfer POINTS word
1219         if (isExtensionInstalledAndNewer('sql_patches', '0.0.3')) {
1220                 // Okay, recent enough, so transfer the word for POINTS
1221                 setConfigEntry('POINTS', getPointsWord());
1222         } // END - if
1223
1224         // Init key
1225         setConfigEntry('secret_key', '');
1226
1227         // Read key from secret file
1228         if ((getFileHash() == '') || (getMasterSalt() == '') || (getPassScramble() == '')) {
1229                 // Maybe need setup of secret key!
1230                 loadIncludeOnce('inc/gen_sql_patches.php');
1231         } // END - if
1232
1233         // Test again
1234         if ((getFileHash() != '') && (getMasterSalt() != '') && (getPassScramble() != '')) {
1235                 // File hash fas generated so we can also file the secret file... hopefully.
1236                 $hashFile = sprintf("%s%s.%s.cache", getPath(), getCachePath(), getFileHash());
1237
1238                 // Is the secret key file readable?
1239                 if (isFileReadable($hashFile)) {
1240                         // Read file
1241                         setConfigEntry('secret_key', readFromFile($hashFile));
1242                 } else {
1243                         // Remove it from database
1244                         updateConfiguration('file_hash', '');
1245
1246                         // Cannot read secret file!
1247                         reportBug(__FILE__, __LINE__, 'Cannot read secret file! Please try to reload.');
1248                 }
1249         } // END - if
1250
1251         // Return data
1252         return $filterData;
1253 }
1254
1255 // Filter to initialize session
1256 function FILTER_INIT_SESSION ($filterData) {
1257         // Determine and set referral id
1258         determineReferralId();
1259
1260         // Return data
1261         return $filterData;
1262 }
1263
1264 // Filter for sending "build mail" to admin
1265 function FILTER_SEND_BUILD_MAIL ($filterData) {
1266         // Was one line updated?
1267         if (($filterData['affected'] > 0) || (isDebugBuildMailsEnabled())) {
1268                 // Then call the proper function
1269                 call_user_func_array('sendGenericBuildMails', $filterData);
1270         } // END - if
1271
1272         // Return data
1273         return $filterData;
1274 }
1275
1276 // Handles click on referral banner
1277 function FILTER_HANDLE_REFERRER_BANNER_CLICK ($filterData) {
1278         // Check required parameters
1279         if ((isGetRequestElementSet('user')) && (isGetRequestElementSet('banner'))) {
1280                 // Update clicks counter...
1281                 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_refbanner` SET `clicks`=`clicks`+1 WHERE `id`=%s LIMIT 1",
1282                         array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1283
1284                 // A line has been updated?
1285                 if ((!SQL_HASZEROAFFECTED()) && (isGetRequestElementSet('user'))) {
1286                         // Redirect to the user's referral link
1287                         redirectToUrl('ref.php?refid=' . bigintval(getRequestElement('user')));
1288                 } // END - if
1289         } // END - if
1290
1291         // Return filter data
1292         return $filterData;
1293 }
1294
1295 // Filter for handling viewing of a referral banner
1296 function FILTER_HANDLE_REFERRER_BANNER_VIEW ($filterData) {
1297         // Are all required parameters set
1298         if ((isGetRequestElementSet('user')) && (isGetRequestElementSet('banner'))) {
1299                 // For later things... ;-)
1300                 $result = SQL_QUERY_ESC("SELECT `url` FROM `{?_MYSQL_PREFIX?}_refbanner` WHERE `id`=%s LIMIT 1",
1301                         array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1302
1303                 // Is there the banner?
1304                 if (SQL_NUMROWS($result) == 1) {
1305                         // Load the URL
1306                         $data = SQL_FETCHARRAY($result);
1307
1308                         // Update counter
1309                         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_refbanner` SET `counter`=`counter`+1 WHERE `id`=%s LIMIT 1",
1310                                 array(bigintval(getRequestElement('banner'))), __FUNCTION__, __LINE__);
1311
1312                         // Set header and ...
1313                         setContentType('image/' . substr($data['url'], -3, 3));
1314
1315                         // Redirect
1316                         redirectToUrl($data['url'], FALSE);
1317                 } // END - if
1318
1319                 // @TODO No banner found, output some default banner
1320                 logDebugMessage(__FUNCTION__, __LINE__, 'Banner ' . bigintval(getRequestElement('banner')) . ' not found.');
1321
1322                 // Free memory
1323                 SQL_FREERESULT($result);
1324         } // END - if
1325
1326         // Do nothing for now
1327         redirectToUrl('modules.php?module=index');
1328 }
1329
1330 // Filter for redirecting on wrong server name (e.g. bad.your-server.tld will be redirected to your-server.tld)
1331 function FILTER_REDIRECT_WRONG_SERVER_NAME ($filterData) {
1332         // Get URL
1333         $url = getUrl();
1334
1335         // Is the configured URL same as SERVER_NAME?
1336         if (extractHostnameFromUrl($url) != detectServerName()) {
1337                 // Log all attempts
1338                 logWrongServerNameRedirect();
1339
1340                 // Then redirect to configured URL
1341                 redirectToRequestUri();
1342         } // END - if
1343
1344         // Return filter data
1345         return $filterData;
1346 }
1347
1348 // Filter for adding hidden session id
1349 function FILTER_ADD_INPUT_HIDDEN_SESSION_ID ($filterData) {
1350         // Is a spider detected?
1351         if ((!isSpider()) && (!isSessionValid()) && ($filterData['__form_method'] == 'get')) {
1352                 // No, then add the hidden field
1353                 $filterData['__replacer'] .= '<input type="hidden" name="' . session_name() . '" value="' . session_id() . '" />';
1354         } // END - if
1355
1356         // Return filter data
1357         return $filterData;
1358 }
1359
1360 // Filter for purging old SERVER_NAME entries
1361 function FILTER_SERVER_NAME_EXTRA_AUTOPURGE ($filterData) {
1362         // Is purging configured?
1363         if ((isApServerNameEnabled()) && (getApServerNameSince() > 0)) {
1364                 // Then start purging
1365                 SQL_QUERY('DELETE LOW_PRIORITY FROM
1366         `{?_MYSQL_PREFIX?}_server_name_log`
1367 WHERE
1368         (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`server_name_added`)) >= {?ap_server_name_since?}',
1369                         __FILE__, __LINE__);
1370
1371                 // Are some entries deleted?
1372                 if (SQL_AFFECTEDROWS() > 0) {
1373                         // Okay, then send an email to the admin
1374                         sendAdminNotification('{--ADMIN_PURGE_USER_SERVER_NAME_LOG_SUBJECT--}', 'admin_purge_user_server_name_log', SQL_AFFECTEDROWS());
1375                 } // END - if
1376         } // END - if
1377
1378         // Return filter data
1379         return $filterData;
1380 }
1381
1382 // Filter for detecting menu mode
1383 function FILTER_DETERMINE_MENU_MODE_GENERIC ($filterData) {
1384         // "Detect" it
1385         switch (getModule()) {
1386                 case 'confirm': // Login script is 'member'
1387                         $filterData = 'member';
1388                         break;
1389         } // END - switch
1390
1391         // Return filter data
1392         return $filterData;
1393 }
1394
1395 // [EOF]
1396 ?>