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 : Functions for filter system                      *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Funktionen fuer Filter-System                    *
  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 - 2008 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         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
  42         require($INC);
  43 }
  44
  45 // Init "generic filter system"
  46 function initFilterSystem () {
  47         // Is the filter already initialized?
  48         if ((isset($GLOBALS['filters']['chains'])) && (is_array($GLOBALS['filters']['chains']))) {
  49                 // Then abort here
  50                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_INIT'));
  51                 return false;
  52         } // END - if
  53
  54         // Init the filter system (just some ideas)
  55         $GLOBALS['filters']['chains'] = array(
  56                 'preinit'   => array(), // Filters for pre-init phase
  57                 'postinit'  => array(), // Filters for post-init phase
  58                 'shutdown'  => array()  // Filters for shutdown phase
  59         );
  60
  61         // Init loaded filters and counter
  62         $GLOBALS['filters']['loaded'] =  array();
  63         $GLOBALS['filters']['counter'] = array();
  64
  65         // Load all saved filers if sql_patches is updated
  66         if (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
  67                 // Init add
  68                 $add = '';
  69                 if (GET_EXT_VERSION('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
  70
  71                 // Load all active filers
  72                 $result = SQL_QUERY("SELECT `filter_name`,`filter_function`,`filter_active`".$add."
  73 FROM `{!_MYSQL_PREFIX!}_filters`
  74 ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
  75
  76                 // Are there entries?
  77                 if (SQL_NUMROWS($result) > 0) {
  78                         // Load all filters
  79                         while ($filterArray = SQL_FETCHARRAY($result)) {
  80                                 // Get filter name and function
  81                                 $filterName     = $filterArray['filter_name'];
  82                                 $filterFunction = $filterArray['filter_function'];
  83
  84                                 // Set counter to default
  85                                 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
  86
  87                                 // Mark this filter as loaded (from database)
  88                                 $GLOBALS['filters']['loaded'][$filterName][$filterFunction] = true;
  89
  90                                 // Set this filter
  91                                 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
  92
  93                                 // Is the array element for counter there?
  94                                 if (isset($filterArray['filter_counter'])) {
  95                                         // Then use this value!
  96                                         $GLOBALS['filters']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
  97                                 } // END - if
  98                         } // END - while
  99                 } // END - if
 100
 101                 // Free result
 102                 SQL_FREERESULT($result);
 103         } // END - if
 104
 105         // Init filters
 106         registerFilter('init', 'UPDATE_LOGIN_DATA');
 107         registerFilter('init', 'INIT_RANDOMIZER');
 108
 109         // Login failures handler
 110         registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 111
 112         // Filters for pre-extension-registration
 113         registerFilter('pre_extension_installed', 'RUN_SQLS');
 114
 115         // Filters for post-extension-registration
 116         registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
 117         registerFilter('post_extension_installed', 'SOLVE_TASK');
 118         registerFilter('post_extension_installed', 'LOAD_INCLUDES');
 119         registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 120
 121         // Solving tasks
 122         registerFilter('solve_task', 'SOLVE_TASK');
 123
 124         // Loading includes in general
 125         registerFilter('load_includes', 'LOAD_INCLUDES');
 126
 127         // Run SQLs
 128         registerFilter('run_sqls', 'RUN_SQLS');
 129
 130         // Admin ACL check
 131         registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 132
 133         // Register shutdown filters
 134         registerFilter('shutdown', 'FLUSH_FILTERS');
 135 }
 136
 137 // "Registers" a new filter function
 138 function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
 139         // Extend the filter function name
 140         $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 141
 142         // Is that filter already there?
 143         if ((isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
 144                 // Then abort here
 145                 if (!$silentAbort) {
 146                         addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
 147                 } // END - if
 148
 149                 // Abort here
 150                 return false;
 151         } // END - if
 152
 153         // Is the function there?
 154         if (!function_exists($filterFunction)) {
 155                 // Then abort here
 156                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_FOUND'), array($filterFunction, $filterName));
 157                 return false;
 158         } // END - if
 159
 160         // Shall we add it?
 161         if (!$dry_run) {
 162                 // Simply add it to the array
 163                 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'Y';
 164                 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
 165         } // END - if
 166 }
 167
 168 // "Unregisters" a filter from the given chain
 169 function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
 170         // Extend the filter function name only if not loaded from database
 171         if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
 172                 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 173         } // END - if
 174
 175         // Is that filter there?
 176         if ((!isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
 177                 // Not found, so abort here
 178                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
 179                 return false;
 180         } // END - if
 181
 182         // Shall we remove? (default, not while just showing an extension removal)
 183         if ($dry_run === false) {
 184                 // Mark for filter removal
 185                 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'R';
 186         } // END  - if
 187 }
 188
 189 // "Runs" the given filters, data is optional and can be any type of data
 190 function runFilterChain ($filterName, $data = null, $silentAbort = true) {
 191         // Is that filter chain there?
 192         if (!isset($GLOBALS['filters']['chains'][$filterName])) {
 193                 // We should find all these non-existing filter chains
 194                 debug_report_bug('Filter chain '.$filterName.' not found!');
 195         } // END - if
 196
 197         // Default return value
 198         $returnValue = $data;
 199
 200         // Then run all filters
 201         foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction => $active) {
 202                 // Debug message
 203                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running: name={$filterName},func={$filterFunction},active={$active}");
 204
 205                 // Is the filter active?
 206                 if (($active == 'Y') || ((in_array($filterName, array('extension_remove', 'post_extension_run_sql'))) && ($active == 'R'))) {
 207                         // Is this filter there?
 208                         if (!function_exists($filterFunction)) {
 209                                 // Unregister it
 210                                 unregisterFilter($filterName, $filterFunction);
 211
 212                                 // Skip this entry
 213                                 continue;
 214                         } // END - if
 215
 216                         // Call the filter chain
 217                         $returnValue = call_user_func_array($filterFunction, array($returnValue));
 218
 219                         // Update usage counter
 220                         countFilterUsage($filterName, $filterFunction);
 221                 } elseif (isDebugModeEnabled()) {
 222                         // Debug message
 223                         DEBUG_LOG(__FUNCTION__, __LINE__, "Skipped: name={$filterName},func={$filterFunction},active={$active}");
 224                 }
 225         } // END - foreach
 226
 227         // Return the filtered content
 228         return $returnValue;
 229 }
 230
 231 // Count the filter usage
 232 function countFilterUsage ($filterName, $filterFunction) {
 233         // Is it there?
 234         if (isset($GLOBALS['filters']['counter'][$filterName][$filterFunction])) {
 235                 // Yes, then increase
 236                 $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
 237         } else {
 238                 // No, then create
 239                 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 1;
 240         }
 241 }
 242
 243 // -----------------------------------------------------------------------------
 244 // Generic filter functions we always need
 245 // -----------------------------------------------------------------------------
 246
 247 // Filter for flushing all new filters to the database
 248 function FILTER_FLUSH_FILTERS () {
 249         // Clear all previous SQL queries
 250         INIT_SQLS();
 251
 252         // Are we installing?
 253         if ((isInstalling()) || (!isInstalled())) {
 254                 // Then silently skip this filter
 255                 return true;
 256         } // END - if
 257
 258         // Is a database link here and not in installation mode?
 259         if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
 260                 // Abort here
 261                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
 262                 return false;
 263         } // END - if
 264
 265         // Is the extension sql_patches updated?
 266         if (EXT_VERSION_IS_OLDER('sql_patches', '0.5.9')) {
 267                 // Abort silently here
 268                 return false;
 269         } // END - if
 270
 271         // Nothing is added/remove by default
 272         $inserted = 0;
 273         $removed = 0;
 274
 275         // Prepare SQL queries
 276         $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
 277         $removeSQL = "DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_filters` WHERE";
 278
 279         // Write all filters to database
 280         foreach ($GLOBALS['filters']['chains'] as $filterName => $filterArray) {
 281                 // Walk through all filters
 282                 foreach ($filterArray as $filterFunction => $active) {
 283                         // Is this filter loaded?
 284                         if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
 285                                 // Add this filter (all filters are active by default)
 286                                 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
 287                                 $inserted++;
 288                         } elseif ($active == "R") {
 289                                 // Remove this filter
 290                                 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
 291                                 $removed++;
 292                         }
 293                 } // END - foreach
 294         } // END - foreach
 295
 296         // Something has been added?
 297         if ($inserted > 0) {
 298                 // Finish SQL command
 299                 $insertSQL = substr($insertSQL, 0, -1);
 300
 301                 // And run it
 302                 ADD_SQL($insertSQL);
 303         } // END - if
 304
 305         // Something has been removed?
 306         if ($removed > 0) {
 307                 // Finish SQL command
 308                 $removeSQL = substr($removeSQL, 0, -2) . "LIMIT ".$removed;
 309
 310                 // And run it
 311                 ADD_SQL($removeSQL);
 312         } // END - if
 313
 314         // Shall we update usage counters (ONLY FOR DEBUGGING!)
 315         if (getConfig('update_filter_usage') == 'Y') {
 316                 // Update all counters
 317                 foreach ($GLOBALS['filters']['counter'] as $filterName => $filterArray) {
 318                         // Walk through all filters
 319                         foreach ($filterArray as $filterFunction => $cnt) {
 320                                 // Construct and add the query
 321                                 ADD_SQL(sprintf("UPDATE `{!_MYSQL_PREFIX!}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
 322                                 bigintval($cnt),
 323                                 $filterName,
 324                                 $filterFunction
 325                                 ));
 326                         } // END - foreach
 327                 } // END - foreach
 328         } // END - if
 329
 330         // Run the run_sqls filter in non-dry mode
 331         runFilterChain('run_sqls');
 332 }
 333
 334 // Filter for calling the handler for login failures
 335 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
 336         // Init content
 337         $content = $data;
 338
 339         // Handle failed logins here if not in guest
 340         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={getAction()},what={getWhat()},lvl={$data['access_level']}<br />\n";
 341         if ((($data['type'] == 'what') || ($data['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getConfig('index_home')))) && ($data['access_level'] != 'guest') && ((GET_EXT_VERSION('sql_patches') >= '0.4.7') || (GET_EXT_VERSION('admins') >= '0.7.0'))) {
 342                 // Handle failure
 343                 $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
 344         } // END - if
 345
 346         // Return the content
 347         return $content;
 348 }
 349
 350 // Filter for redirecting to logout if sql_patches has been installed
 351 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
 352         // Remove this filter
 353         unregisterFilter('shutdown', __FUNCTION__);
 354
 355         // Is the element set?
 356         if (isset($GLOBALS['ext_load_mode'])) {
 357                 // Redirect here
 358                 redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
 359         } // END - if
 360
 361         // This should not happen!
 362         DEBUG_LOG(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
 363 }
 364
 365 // Filter for auto-activation of a extension
 366 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
 367         // Is this extension always activated?
 368         if (EXT_GET_ALWAYS_ACTIVE() == 'Y') {
 369                 // Then activate the extension
 370                 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
 371                 ACTIVATE_EXTENSION($data['ext_name']);
 372         } // END - if
 373
 374         // Return the data
 375         return $data;
 376 }
 377
 378 // Filter for solving task given task
 379 function FILTER_SOLVE_TASK ($data) {
 380         // Don't solve anything if no admin!
 381         if (!IS_ADMIN()) return $data;
 382
 383         // Is this a direct task id or array element task_id is found?
 384         if (is_int($data)) {
 385                 // Then solve it...
 386                 ADMIN_SOLVE_TASK($data);
 387         } elseif ((is_array($data)) && (isset($data['task_id']))) {
 388                 // Solve it...
 389                 ADMIN_SOLVE_TASK($data['task_id']);
 390         }
 391
 392         // Return the data
 393         return $data;
 394 }
 395
 396 // Filter to load include files
 397 function FILTER_LOAD_INCLUDES () {
 398         // Default is $data as inclusion list
 399         $data = GET_INC_POOL();
 400
 401         // Is it an array?
 402         if ((!isset($data)) || (!is_array($data))) {
 403                 // Then abort here
 404                 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
 405         } elseif (isset($data['inc_pool'])) {
 406                 // Use this as new inclusion pool!
 407                 SET_INC_POOL($data['inc_pool']);
 408         }
 409
 410         // Check for added include files
 411         if (COUNT_INC_POOL() > 0) {
 412                 // Loads every include file
 413                 foreach (GET_INC_POOL() as $FQFN) {
 414                         loadIncludeOnce($FQFN);
 415                 } // END - foreach
 416
 417                 // Reset array
 418                 INIT_INC_POOL();
 419         } // END - if
 420
 421         // Continue with processing
 422         return $data;
 423 }
 424
 425 // Filter for running SQL commands
 426 function FILTER_RUN_SQLS ($data) {
 427         // Debug message
 428         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Entered!");
 429
 430         // Is the array there?
 431         if ((IS_SQLS_VALID()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
 432                 // Run SQL commands
 433                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Found ".COUNT_SQLS()." queries to run.");
 434                 foreach (GET_SQLS() as $sql) {
 435                         // Trim spaces away
 436                         $sql = trim($sql);
 437
 438                         // Is there still a query left?
 439                         if (!empty($sql)) {
 440                                 // Do we have an "ALTER TABLE" command?
 441                                 if (substr(strtolower($sql), 0, 11) == "alter table") {
 442                                         // Analyse the alteration command
 443                                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
 444                                         SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
 445                                 } else {
 446                                         // Run regular SQL command
 447                                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
 448                                         SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
 449                                 }
 450                         } // END - if
 451                 } // END - foreach
 452         } // END - if
 453
 454         // Debug message
 455         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
 456 }
 457
 458 // Filter for updating/validating login data
 459 function FILTER_UPDATE_LOGIN_DATA () {
 460         // Add missing array
 461         if ((!isset($GLOBALS['last'])) || (!is_array($GLOBALS['last']))) $GLOBALS['last'] = array();
 462
 463         // Recheck if logged in
 464         if (!IS_MEMBER()) return false;
 465
 466         // Secure user ID
 467         setUserId(getSession('userid'));
 468
 469         // Load last module and last online time
 470         $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
 471                 array(getUserId()), __FUNCTION__, __LINE__);
 472
 473         // Entry found?
 474         if (SQL_NUMROWS($result) == 1) {
 475                 // Load last module and online time
 476                 list($mod, $onl) = SQL_FETCHROW($result);
 477
 478                 // Maybe first login time?
 479                 if (empty($mod)) $mod = 'login';
 480
 481                 // This will be displayed on welcome page! :-)
 482                 if (empty($GLOBALS['last']['module'])) {
 483                         $GLOBALS['last']['module'] = $mod; $GLOBALS['last']['online'] = $onl;
 484                 } // END - if
 485
 486                 // 'what' not set?
 487                 if (!isWhatSet()) {
 488                         // Fix it to default
 489                         setWhat('welcome');
 490                         if (getConfig('index_home') != '') setWhatFromConfig('index_home');
 491                 } // END - if
 492
 493                 // Update last module / online time
 494                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
 495                         array(getWhat(), detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
 496         }  else {
 497                 // Destroy session, we cannot update!
 498                 destroyUserSession();
 499         }
 500
 501         // Free the result
 502         SQL_FREERESULT($result);
 503 }
 504
 505 // Filter for checking admin ACL
 506 function FILTER_CHECK_ADMIN_ACL () {
 507         // Extension not installed so it's always allowed to access everywhere!
 508         $ret = true;
 509
 510         // Ok, Cookie-Update done
 511         if ((GET_EXT_VERSION('admins') >= '0.3.0') && (EXT_IS_ACTIVE('admins'))) {
 512                 // Check if action GET variable was set
 513                 $action = getAction();
 514                 if (isWhatSet()) {
 515                         // Get action value by what-value
 516                         $action = getModeAction('admin', getWhat());
 517                 } // END - if
 518
 519                 // Check for access control line of current menu entry
 520                 $ret = adminsCheckAdminAcl($action, getWhat());
 521         } // END - if
 522
 523         // Return result
 524         return $ret;
 525 }
 526
 527 // Filter for initializing randomizer
 528 function FILTER_INIT_RANDOMIZER () {
 529         // Simply init the randomizer with seed and _ADD value
 530         mt_srand(generateSeed() + getConfig('_ADD'));
 531 }
 532
 533 // Filter for removing updates
 534 function FILTER_REMOVE_UPDATES () {
 535         // Init removal list
 536         EXT_INIT_REMOVAL_LIST();
 537
 538         // Add the current extension to it
 539         EXT_ADD_CURRENT_TO_REMOVAL_LIST();
 540
 541         // Simply remove it
 542         UNSET_EXT_SQLS();
 543
 544         // Do we need to remove update depency?
 545         if (EXT_COUNT_UPDATE_DEPENDS() > 0) {
 546                 // Then find all updates we shall no longer execute
 547                 foreach (EXT_GET_UPDATE_DEPENDS() as $id=>$ext_name) {
 548                         // Shall we remove this update?
 549                         if (in_array($ext_name, EXT_GET_REMOVAL_LIST())) {
 550                                 // Then remove this extension!
 551                                 EXT_REMOVE_UPDATE_DEPENDS($ext_name);
 552                         } // END - if
 553                 } // END - foreach
 554         } // END - if
 555 }
 556
 557 //
 558 ?>