2 /************************************************************************
3 * MXChange v0.2.1 Start: 12/16/2008 *
4 * =============== Last change: 12/16/2008 *
6 * -------------------------------------------------------------------- *
8 * -------------------------------------------------------------------- *
9 * Short description : Functions for filter system *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Funktionen fuer Filter-System *
12 * -------------------------------------------------------------------- *
14 * -------------------------------------------------------------------- *
15 * Copyright (c) 2003 - 2008 by Roland Haeder *
16 * For more information visit: http://www.mxchange.org *
18 * This program is free software; you can redistribute it and/or modify *
19 * it under the terms of the GNU General Public License as published by *
20 * the Free Software Foundation; either version 2 of the License, or *
21 * (at your option) any later version. *
23 * This program is distributed in the hope that it will be useful, *
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
26 * GNU General Public License for more details. *
28 * You should have received a copy of the GNU General Public License *
29 * along with this program; if not, write to the Free Software *
30 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
32 ************************************************************************/
34 // Some security stuff...
35 if (!defined('__SECURITY')) {
36 $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4)."/security.php";
40 // Init "generic filter system"
41 function INIT_FILTER_SYSTEM () {
42 // Is the filter already initialized?
43 if ((isset($GLOBALS['filters']['chains'])) && (is_array($GLOBALS['filters']['chains']))) {
45 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_INIT'));
49 // Init the filter system (just some ideas)
50 $GLOBALS['filters']['chains'] = array(
51 // Filters for pre-init phase
53 // Filters for post-init phase
54 'postinit' => array(),
55 // Filters for shutdown phase
59 // Init loaded filters and counter
60 $GLOBALS['filters']['loaded'] = array();
61 $GLOBALS['filters']['counter'] = array();
63 // Load all saved filers if sql_patches is updated
64 if (GET_EXT_VERSION("sql_patches") >= "0.5.9") {
67 if (GET_EXT_VERSION("sql_patches") >= "0.6.0") $ADD = ", `filter_counter`";
69 // Load all active filers
70 $result = SQL_QUERY("SELECT `filter_name`, `filter_function`, `filter_active`".$ADD."
71 FROM `{!_MYSQL_PREFIX!}_filters`
72 ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
75 if (SQL_NUMROWS($result) > 0) {
77 while ($filterArray = SQL_FETCHARRAY($result)) {
78 // Get filter name and function
79 $filterName = $filterArray['filter_name'];
80 $filterFunction = $filterArray['filter_function'];
82 // Set counter to default
83 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
85 // Mark this filter as loaded (from database)
86 $GLOBALS['filters']['loaded'][$filterName][$filterFunction] = true;
89 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
91 // Is the array element for counter there?
92 if (isset($filterArray['filter_counter'])) {
93 // Then use this value!
94 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
100 SQL_FREERESULT($result);
104 REGISTER_FILTER('init', 'UPDATE_LOGIN_DATA');
105 REGISTER_FILTER('init', 'INIT_RANDOMIZER');
107 // Login failures handler
108 REGISTER_FILTER('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
110 // Filters for pre-extension-registration
111 REGISTER_FILTER('pre_extension_installed', 'RUN_SQLS');
113 // Filters for post-extension-registration
114 REGISTER_FILTER('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
115 REGISTER_FILTER('post_extension_installed', 'SOLVE_TASK');
116 REGISTER_FILTER('post_extension_installed', 'LOAD_INCLUDES');
119 REGISTER_FILTER('solve_task', 'SOLVE_TASK');
121 // Loading includes in general
122 REGISTER_FILTER('load_includes', 'LOAD_INCLUDES');
125 REGISTER_FILTER('run_sqls', 'RUN_SQLS');
128 REGISTER_FILTER('check_admin_acl', 'CHECK_ADMIN_ACL');
130 // Register shutdown filters
131 REGISTER_FILTER('shutdown', 'FLUSH_FILTERS');
134 // "Registers" a new filter function
135 function REGISTER_FILTER ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
136 // Extend the filter function name
137 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
139 // Is that filter already there?
140 if ((isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
143 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
150 // Is the function there?
151 if (!function_exists($filterFunction)) {
153 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_FOUND'), array($filterFunction, $filterName));
159 // Simply add it to the array
160 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = "Y";
161 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
165 // "Unregisters" a filter from the given chain
166 function UNREGISTER_FILTER ($filterName, $filterFunction, $force = false, $dry_run = false) {
167 // Extend the filter function name only if not loaded from database
168 if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
169 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
172 // Is that filter there?
173 if ((!isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
174 // Not found, so abort here
175 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
179 // Shall we remove? (default, not while just showing an extension removal)
181 // Mark for filter removal
182 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = "R";
183 unset($GLOBALS['filters']['counter'][$filterName][$filterFunction]);
187 // "Runs" the given filters, data is optional and can be any type of data
188 function runFilterChain ($filterName, $data = null, $silentAbort = true) {
189 // Is that filter chain there?
190 if (!isset($GLOBALS['filters']['chains'][$filterName])) {
191 // Then abort here (quick'N'dirty hack)
192 if ((!$silentAbort) && (defined('FILTER_FAILED_NO_FILTER_FOUND'))) {
194 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NO_FILTER_FOUND'), $filterName);
201 // Default return value
202 $returnValue = $data;
204 // Then run all filters
205 foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction=>$active) {
207 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): name={$filterName},func={$filterFunction},active={$active}<br />\n";
209 // Is the filter active?
210 if ($active == "Y") {
211 // Is this filter there?
212 if (!function_exists($filterFunction)) {
214 UNREGISTER_FILTER($filterName, $filterFunction);
220 // Call the filter chain
221 $returnValue = call_user_func_array($filterFunction, array($returnValue));
223 // Update usage counter
224 $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
228 // Return the filtered content
232 // -----------------------------------------------------------------------------
233 // Generic filter functions we always need
234 // -----------------------------------------------------------------------------
236 // Filter for flushing all new filters to the database
237 function FILTER_FLUSH_FILTERS () {
238 // Clear all previous SQL queries
241 // Is a database link here and not in installation mode?
242 if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
244 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
248 // Is the extension sql_patches updated?
249 if (EXT_VERSION_IS_OLDER("sql_patches", "0.5.9")) {
250 // Abort silently here
254 // Nothing is added/remove by default
255 $inserted = 0; $removed = 0;
257 // Prepare SQL queries
258 $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
259 $removeSQL = "DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_filters` WHERE";
261 // Write all filters to database
262 foreach ($GLOBALS['filters']['chains'] as $filterName => $filterArray) {
263 // Walk through all filters
264 foreach ($filterArray as $filterFunction => $active) {
265 // Is this filter loaded?
266 if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
267 // Add this filter (all filters are active by default)
268 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
270 } elseif ($active == "R") {
271 // Remove this filter
272 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
278 // Something has been added?
280 // Finish SQL command
281 $insertSQL = substr($insertSQL, 0, -1);
287 // Something has been removed?
289 // Finish SQL command
290 $removeSQL = substr($removeSQL, 0, -2) . "LIMIT ".$removed;
296 // Shall we update usage counters (ONLY FOR DEBUGGING!)
297 if (getConfig('update_filter_usage') == "Y") {
298 // Update all counters
299 foreach ($GLOBALS['filters']['counter'] as $filterName => $filterArray) {
300 // Walk through all filters
301 foreach ($filterArray as $filterFunction => $cnt) {
302 // Construct and add the query
303 ADD_SQL(sprintf("UPDATE `{!_MYSQL_PREFIX!}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
312 // Run the run_sqls filter in non-dry mode
313 runFilterChain('run_sqls');
316 // Filter for calling the handler for login failures
317 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
321 // Handle failed logins here if not in guest
322 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={$GLOBALS['action']},what={$GLOBALS['what']},lvl={$data['access_level']}<br />\n";
323 if ((($data['type'] == "what") || ($data['type'] == "action") && ((!isset($GLOBALS['what'])) || ($GLOBALS['what'] == "overview") || ($GLOBALS['what'] == getConfig('index_home')))) && ($data['access_level'] != "guest") && ((GET_EXT_VERSION("sql_patches") >= "0.4.7") || (GET_EXT_VERSION("admins") >= "0.7.0"))) {
325 $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
328 // Return the content
332 // Filter for redirecting to logout if sql_patches has been installed
333 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
334 // Remove this filter
335 UNREGISTER_FILTER('shutdown', __FUNCTION__);
337 // Is the element set?
338 if (isset($GLOBALS['ext_load_mode'])) {
340 LOAD_URL("modules.php?module=admin&logout=1&".$GLOBALS['ext_load_mode']."=sql_patches");
343 // This should not happen!
344 DEBUG_LOG(__FUNCTION__, __LINE__, "Cannot auto-logout because no extension load-mode has been set.");
347 // Filter for auto-activation of a extension
348 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
349 // Is this extension always activated?
350 if (EXT_GET_ALWAYS_ACTIVE() == "Y") {
351 // Then activate the extension
352 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
353 ACTIVATE_EXTENSION($data['ext_name']);
360 // Filter for solving task given task
361 function FILTER_SOLVE_TASK ($data) {
362 // Don't solve anything if no admin!
363 if (!IS_ADMIN()) return $data;
365 // Is this a direct task id or array element task_id is found?
368 ADMIN_SOLVE_TASK($data);
369 } elseif ((is_array($data)) && (isset($data['task_id']))) {
371 ADMIN_SOLVE_TASK($data['task_id']);
378 // Filter to load include files
379 function FILTER_LOAD_INCLUDES ($data) {
380 // Default is $data as inclusion list
384 if ((!isset($data)) || (!is_array($data))) {
386 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($INC_POOL)));
387 } elseif (isset($data['inc_pool'])) {
388 // Use this as new inclusion pool!
389 $INC_POOL = $data['inc_pool'];
392 // Check for added include files
393 if (count($INC_POOL) > 0) {
394 // Loads every include file
395 foreach ($INC_POOL as $FQFN) {
396 LOAD_INC_ONCE($FQFN);
400 if (isset($data['inc_pool'])) $data['inc_pool'] = array();
403 // Continue with processing
407 // Filter for running SQL commands
408 function FILTER_RUN_SQLS ($data) {
410 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Entered!");
412 // Is the array there?
413 if ((IS_SQLS_VALID()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
415 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Found ".COUNT_SQLS()." queries to run.");
416 foreach (GET_SQLS() as $sql) {
420 // Is there still a query left?
422 // Do we have an "ALTER TABLE" command?
423 if (substr(strtolower($sql), 0, 11) == "alter table") {
424 // Analyse the alteration command
425 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
426 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
428 // Run regular SQL command
429 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
430 $result = SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
437 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
440 // Filter for updating/validating login data
441 function FILTER_UPDATE_LOGIN_DATA () {
443 if ((!isset($GLOBALS['last'])) || (!is_array($GLOBALS['last']))) $GLOBALS['last'] = array();
445 // Recheck if logged in
446 if (!IS_MEMBER()) return false;
449 $GLOBALS['userid'] = bigintval(get_session('userid'));
451 // Load last module and last online time
452 $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
453 array($GLOBALS['userid']), __FUNCTION__, __LINE__);
456 if (SQL_NUMROWS($result) == 1) {
457 // Load last module and online time
458 list($mod, $onl) = SQL_FETCHROW($result);
460 // Maybe first login time?
461 if (empty($mod)) $mod = "login";
463 // This will be displayed on welcome page! :-)
464 if (empty($GLOBALS['last']['module'])) {
465 $GLOBALS['last']['module'] = $mod; $GLOBALS['last']['online'] = $onl;
469 if (empty($GLOBALS['what'])) {
471 $GLOBALS['what'] = "welcome";
472 if (getConfig('index_home') != "") $GLOBALS['what'] = getConfig('index_home');
475 // Update last module / online time
476 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET last_module='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
477 array($GLOBALS['what'], GET_REMOTE_ADDR(), $GLOBALS['userid']), __FUNCTION__, __LINE__);
479 // Destroy session, we cannot update!
480 destroy_user_session();
484 SQL_FREERESULT($result);
487 // Filter for checking admin ACL
488 function FILTER_CHECK_ADMIN_ACL () {
489 // Extension not installed so it's always allowed to access everywhere!
492 // Ok, Cookie-Update done
493 if (GET_EXT_VERSION("admins") >= "0.3") {
494 // Check if action GET variable was set
495 $action = SQL_ESCAPE($GLOBALS['action']);
496 if (!empty($GLOBALS['what'])) {
497 // Get action value by what-value
498 $action = GET_ACTION("admin", $GLOBALS['what']);
501 // Check for access control line of current menu entry
502 $ret = ADMINS_CHECK_ACL($action, $GLOBALS['what']);
509 // Filter for initializing randomizer
510 function FILTER_INIT_RANDOMIZER () {
511 // Simply init the randomizer with seed and _ADD value
512 mt_srand(generateSeed() + constant('_ADD'));