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 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
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 *
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. *
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. *
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, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
41 $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
45 // Init "generic filter system"
46 function INIT_FILTER_SYSTEM () {
47 // Is the filter already initialized?
48 if ((isset($GLOBALS['filters']['chains'])) && (is_array($GLOBALS['filters']['chains']))) {
50 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_INIT'));
54 // Init the filter system (just some ideas)
55 $GLOBALS['filters']['chains'] = array(
56 // Filters for pre-init phase
58 // Filters for post-init phase
59 'postinit' => array(),
60 // Filters for shutdown phase
64 // Init loaded filters and counter
65 $GLOBALS['filters']['loaded'] = array();
66 $GLOBALS['filters']['counter'] = array();
68 // Load all saved filers if sql_patches is updated
69 if (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
72 if (GET_EXT_VERSION('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
74 // Load all active filers
75 $result = SQL_QUERY("SELECT `filter_name`,`filter_function`,`filter_active`".$add."
76 FROM `{!_MYSQL_PREFIX!}_filters`
77 ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
80 if (SQL_NUMROWS($result) > 0) {
82 while ($filterArray = SQL_FETCHARRAY($result)) {
83 // Get filter name and function
84 $filterName = $filterArray['filter_name'];
85 $filterFunction = $filterArray['filter_function'];
87 // Set counter to default
88 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
90 // Mark this filter as loaded (from database)
91 $GLOBALS['filters']['loaded'][$filterName][$filterFunction] = true;
94 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
96 // Is the array element for counter there?
97 if (isset($filterArray['filter_counter'])) {
98 // Then use this value!
99 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = $filterArray['filter_counter'];
105 SQL_FREERESULT($result);
109 REGISTER_FILTER('init', 'UPDATE_LOGIN_DATA');
110 REGISTER_FILTER('init', 'INIT_RANDOMIZER');
112 // Login failures handler
113 REGISTER_FILTER('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
115 // Filters for pre-extension-registration
116 REGISTER_FILTER('pre_extension_installed', 'RUN_SQLS');
118 // Filters for post-extension-registration
119 REGISTER_FILTER('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
120 REGISTER_FILTER('post_extension_installed', 'SOLVE_TASK');
121 REGISTER_FILTER('post_extension_installed', 'loadIncludeLUDES');
122 REGISTER_FILTER('post_extension_installed', 'REMOVE_UPDATES');
125 REGISTER_FILTER('solve_task', 'SOLVE_TASK');
127 // Loading includes in general
128 REGISTER_FILTER('load_includes', 'loadIncludeLUDES');
131 REGISTER_FILTER('run_sqls', 'RUN_SQLS');
134 REGISTER_FILTER('check_admin_acl', 'CHECK_ADMIN_ACL');
136 // Register shutdown filters
137 REGISTER_FILTER('shutdown', 'FLUSH_FILTERS');
140 // "Registers" a new filter function
141 function REGISTER_FILTER ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
142 // Extend the filter function name
143 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
145 // Is that filter already there?
146 if ((isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
149 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
156 // Is the function there?
157 if (!function_exists($filterFunction)) {
159 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_FOUND'), array($filterFunction, $filterName));
165 // Simply add it to the array
166 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'Y';
167 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
171 // "Unregisters" a filter from the given chain
172 function UNREGISTER_FILTER ($filterName, $filterFunction, $force = false, $dry_run = false) {
173 // Extend the filter function name only if not loaded from database
174 if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
175 $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
178 // Is that filter there?
179 if ((!isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
180 // Not found, so abort here
181 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_REMOVED'), array($filterFunction, $filterName));
185 // Shall we remove? (default, not while just showing an extension removal)
187 // Mark for filter removal
188 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = "R";
189 unset($GLOBALS['filters']['counter'][$filterName][$filterFunction]);
193 // "Runs" the given filters, data is optional and can be any type of data
194 function runFilterChain ($filterName, $data = null, $silentAbort = true) {
195 // Is that filter chain there?
196 if (!isset($GLOBALS['filters']['chains'][$filterName])) {
197 // Then abort here (quick'N'dirty hack)
198 if ((!$silentAbort) && (defined('FILTER_FAILED_NO_FILTER_FOUND'))) {
200 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NO_FILTER_FOUND'), $filterName);
207 // Default return value
208 $returnValue = $data;
210 // Then run all filters
211 foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction=>$active) {
213 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): name={$filterName},func={$filterFunction},active={$active}<br />\n";
215 // Is the filter active?
216 if ($active == 'Y') {
217 // Is this filter there?
218 if (!function_exists($filterFunction)) {
220 UNREGISTER_FILTER($filterName, $filterFunction);
226 // Call the filter chain
227 $returnValue = call_user_func_array($filterFunction, array($returnValue));
229 // Update usage counter
230 $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
234 // Return the filtered content
238 // -----------------------------------------------------------------------------
239 // Generic filter functions we always need
240 // -----------------------------------------------------------------------------
242 // Filter for flushing all new filters to the database
243 function FILTER_FLUSH_FILTERS () {
244 // Clear all previous SQL queries
247 // Are we installing?
248 if ((isInstalling()) || (!isInstalled())) {
249 // Then silently skip this filter
253 // Is a database link here and not in installation mode?
254 if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
256 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
260 // Is the extension sql_patches updated?
261 if (EXT_VERSION_IS_OLDER('sql_patches', '0.5.9')) {
262 // Abort silently here
266 // Nothing is added/remove by default
267 $inserted = 0; $removed = 0;
269 // Prepare SQL queries
270 $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
271 $removeSQL = "DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_filters` WHERE";
273 // Write all filters to database
274 foreach ($GLOBALS['filters']['chains'] as $filterName => $filterArray) {
275 // Walk through all filters
276 foreach ($filterArray as $filterFunction => $active) {
277 // Is this filter loaded?
278 if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
279 // Add this filter (all filters are active by default)
280 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
282 } elseif ($active == "R") {
283 // Remove this filter
284 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
290 // Something has been added?
292 // Finish SQL command
293 $insertSQL = substr($insertSQL, 0, -1);
299 // Something has been removed?
301 // Finish SQL command
302 $removeSQL = substr($removeSQL, 0, -2) . "LIMIT ".$removed;
308 // Shall we update usage counters (ONLY FOR DEBUGGING!)
309 if (getConfig('update_filter_usage') == 'Y') {
310 // Update all counters
311 foreach ($GLOBALS['filters']['counter'] as $filterName => $filterArray) {
312 // Walk through all filters
313 foreach ($filterArray as $filterFunction => $cnt) {
314 // Construct and add the query
315 ADD_SQL(sprintf("UPDATE `{!_MYSQL_PREFIX!}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
324 // Run the run_sqls filter in non-dry mode
325 runFilterChain('run_sqls');
328 // Filter for calling the handler for login failures
329 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
333 // Handle failed logins here if not in guest
334 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={$GLOBALS['action']},what={$GLOBALS['what']},lvl={$data['access_level']}<br />\n";
335 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'))) {
337 $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
340 // Return the content
344 // Filter for redirecting to logout if sql_patches has been installed
345 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
346 // Remove this filter
347 UNREGISTER_FILTER('shutdown', __FUNCTION__);
349 // Is the element set?
350 if (isset($GLOBALS['ext_load_mode'])) {
352 redirectToUrl('modules.php?module=admin&logout=1&' . $GLOBALS['ext_load_mode'] . '=sql_patches');
355 // This should not happen!
356 DEBUG_LOG(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
359 // Filter for auto-activation of a extension
360 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
361 // Is this extension always activated?
362 if (EXT_GET_ALWAYS_ACTIVE() == 'Y') {
363 // Then activate the extension
364 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
365 ACTIVATE_EXTENSION($data['ext_name']);
372 // Filter for solving task given task
373 function FILTER_SOLVE_TASK ($data) {
374 // Don't solve anything if no admin!
375 if (!IS_ADMIN()) return $data;
377 // Is this a direct task id or array element task_id is found?
380 ADMIN_SOLVE_TASK($data);
381 } elseif ((is_array($data)) && (isset($data['task_id']))) {
383 ADMIN_SOLVE_TASK($data['task_id']);
390 // Filter to load include files
391 function FILTER_loadIncludeLUDES () {
392 // Default is $data as inclusion list
393 $data = GET_INC_POOL();
396 if ((!isset($data)) || (!is_array($data))) {
398 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
399 } elseif (isset($data['inc_pool'])) {
400 // Use this as new inclusion pool!
401 SET_INC_POOL($data['inc_pool']);
404 // Check for added include files
405 if (COUNT_INC_POOL() > 0) {
406 // Loads every include file
407 foreach (GET_INC_POOL() as $FQFN) {
408 loadIncludeOnce($FQFN);
415 // Continue with processing
419 // Filter for running SQL commands
420 function FILTER_RUN_SQLS ($data) {
422 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Entered!");
424 // Is the array there?
425 if ((IS_SQLS_VALID()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
427 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Found ".COUNT_SQLS()." queries to run.");
428 foreach (GET_SQLS() as $sql) {
432 // Is there still a query left?
434 // Do we have an "ALTER TABLE" command?
435 if (substr(strtolower($sql), 0, 11) == "alter table") {
436 // Analyse the alteration command
437 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
438 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
440 // Run regular SQL command
441 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
442 SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
449 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
452 // Filter for updating/validating login data
453 function FILTER_UPDATE_LOGIN_DATA () {
455 if ((!isset($GLOBALS['last'])) || (!is_array($GLOBALS['last']))) $GLOBALS['last'] = array();
457 // Recheck if logged in
458 if (!IS_MEMBER()) return false;
461 setUserId(getSession('userid'));
463 // Load last module and last online time
464 $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
465 array(getUserId()), __FUNCTION__, __LINE__);
468 if (SQL_NUMROWS($result) == 1) {
469 // Load last module and online time
470 list($mod, $onl) = SQL_FETCHROW($result);
472 // Maybe first login time?
473 if (empty($mod)) $mod = "login";
475 // This will be displayed on welcome page! :-)
476 if (empty($GLOBALS['last']['module'])) {
477 $GLOBALS['last']['module'] = $mod; $GLOBALS['last']['online'] = $onl;
481 if (empty($GLOBALS['what'])) {
483 $GLOBALS['what'] = "welcome";
484 if (getConfig('index_home') != '') $GLOBALS['what'] = getConfig('index_home');
487 // Update last module / online time
488 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
489 array($GLOBALS['what'], detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
491 // Destroy session, we cannot update!
492 destroyUserSession();
496 SQL_FREERESULT($result);
499 // Filter for checking admin ACL
500 function FILTER_CHECK_ADMIN_ACL () {
501 // Extension not installed so it's always allowed to access everywhere!
504 // Ok, Cookie-Update done
505 if (GET_EXT_VERSION('admins') >= '0.3.0') {
506 // Check if action GET variable was set
507 $action = SQL_ESCAPE($GLOBALS['action']);
508 if (!empty($GLOBALS['what'])) {
509 // Get action value by what-value
510 $action = getModeAction('admin', $GLOBALS['what']);
513 // Check for access control line of current menu entry
514 $ret = adminsCheckAdminAcl($action, $GLOBALS['what']);
521 // Filter for initializing randomizer
522 function FILTER_INIT_RANDOMIZER () {
523 // Simply init the randomizer with seed and _ADD value
524 mt_srand(generateSeed() + getConfig('_ADD'));
527 // Filter for removing updates
528 function FILTER_REMOVE_UPDATES () {
530 EXT_INIT_REMOVAL_LIST();
532 // Add the current extension to it
533 EXT_ADD_CURRENT_TO_REMOVAL_LIST();
538 // Do we need to remove update depency?
539 if (EXT_COUNT_UPDATE_DEPENDS() > 0) {
540 // Then find all updates we shall no longer execute
541 foreach (EXT_GET_UPDATE_DEPENDS() as $id=>$ext_name) {
542 // Shall we remove this update?
543 if (in_array($ext_name, EXT_GET_REMOVAL_LIST())) {
544 // Then remove this extension!
545 EXT_REMOVE_UPDATE_DEPENDS($ext_name);