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 initFilterSystem () {
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 'preinit' => array(), // Filters for pre-init phase
57 'postinit' => array(), // Filters for post-init phase
58 'shutdown' => array() // Filters for shutdown phase
61 // Init loaded filters and counter
62 $GLOBALS['filters']['loaded'] = array();
63 $GLOBALS['filters']['counter'] = array();
65 // Load all saved filers if sql_patches is updated
66 if (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
69 if (GET_EXT_VERSION('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
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__);
77 if (SQL_NUMROWS($result) > 0) {
79 while ($filterArray = SQL_FETCHARRAY($result)) {
80 // Get filter name and function
81 $filterName = $filterArray['filter_name'];
82 $filterFunction = $filterArray['filter_function'];
84 // Set counter to default
85 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
87 // Mark this filter as loaded (from database)
88 $GLOBALS['filters']['loaded'][$filterName][$filterFunction] = true;
91 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = $filterArray['filter_active'];
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'];
102 SQL_FREERESULT($result);
106 registerFilter('init', 'UPDATE_LOGIN_DATA');
107 registerFilter('init', 'INIT_RANDOMIZER');
109 // Login failures handler
110 registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
112 // Filters for pre-extension-registration
113 registerFilter('pre_extension_installed', 'RUN_SQLS');
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', 'loadIncludeLUDES');
119 registerFilter('post_extension_installed', 'REMOVE_UPDATES');
122 registerFilter('solve_task', 'SOLVE_TASK');
124 // Loading includes in general
125 registerFilter('load_includes', 'loadIncludeLUDES');
128 registerFilter('run_sqls', 'RUN_SQLS');
131 registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
133 // Register shutdown filters
134 registerFilter('shutdown', 'FLUSH_FILTERS');
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));
142 // Is that filter already there?
143 if ((isset($GLOBALS['filters']['chains'][$filterName][$filterFunction])) && (!$force)) {
146 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_ALREADY_ADDED'), array($filterFunction, $filterName));
153 // Is the function there?
154 if (!function_exists($filterFunction)) {
156 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NOT_FOUND'), array($filterFunction, $filterName));
162 // Simply add it to the array
163 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'Y';
164 $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
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));
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));
182 // Shall we remove? (default, not while just showing an extension removal)
184 // Mark for filter removal
185 $GLOBALS['filters']['chains'][$filterName][$filterFunction] = "R";
186 unset($GLOBALS['filters']['counter'][$filterName][$filterFunction]);
190 // "Runs" the given filters, data is optional and can be any type of data
191 function runFilterChain ($filterName, $data = null, $silentAbort = true) {
192 // Is that filter chain there?
193 if (!isset($GLOBALS['filters']['chains'][$filterName])) {
194 // Then abort here (quick'N'dirty hack)
195 if ((!$silentAbort) && (defined('FILTER_FAILED_NO_FILTER_FOUND'))) {
197 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FAILED_NO_FILTER_FOUND'), $filterName);
204 // Default return value
205 $returnValue = $data;
207 // Then run all filters
208 foreach ($GLOBALS['filters']['chains'][$filterName] as $filterFunction=>$active) {
210 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): name={$filterName},func={$filterFunction},active={$active}<br />\n";
212 // Is the filter active?
213 if ($active == 'Y') {
214 // Is this filter there?
215 if (!function_exists($filterFunction)) {
217 unregisterFilter($filterName, $filterFunction);
223 // Call the filter chain
224 $returnValue = call_user_func_array($filterFunction, array($returnValue));
226 // Update usage counter
227 $GLOBALS['filters']['counter'][$filterName][$filterFunction]++;
231 // Return the filtered content
235 // -----------------------------------------------------------------------------
236 // Generic filter functions we always need
237 // -----------------------------------------------------------------------------
239 // Filter for flushing all new filters to the database
240 function FILTER_FLUSH_FILTERS () {
241 // Clear all previous SQL queries
244 // Are we installing?
245 if ((isInstalling()) || (!isInstalled())) {
246 // Then silently skip this filter
250 // Is a database link here and not in installation mode?
251 if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
253 addFatalMessage(__FUNCTION__, __LINE__, getMessage('FILTER_FLUSH_FAILED_NO_DATABASE'));
257 // Is the extension sql_patches updated?
258 if (EXT_VERSION_IS_OLDER('sql_patches', '0.5.9')) {
259 // Abort silently here
263 // Nothing is added/remove by default
267 // Prepare SQL queries
268 $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
269 $removeSQL = "DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_filters` WHERE";
271 // Write all filters to database
272 foreach ($GLOBALS['filters']['chains'] as $filterName => $filterArray) {
273 // Walk through all filters
274 foreach ($filterArray as $filterFunction => $active) {
275 // Is this filter loaded?
276 if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
277 // Add this filter (all filters are active by default)
278 $insertSQL .= sprintf("('%s','%s','Y'),", $filterName, $filterFunction);
280 } elseif ($active == "R") {
281 // Remove this filter
282 $removeSQL .= sprintf(" (`filter_name`='%s' AND `filter_function`='%s') OR", $filterName, $filterFunction);
288 // Something has been added?
290 // Finish SQL command
291 $insertSQL = substr($insertSQL, 0, -1);
297 // Something has been removed?
299 // Finish SQL command
300 $removeSQL = substr($removeSQL, 0, -2) . "LIMIT ".$removed;
306 // Shall we update usage counters (ONLY FOR DEBUGGING!)
307 if (getConfig('update_filter_usage') == 'Y') {
308 // Update all counters
309 foreach ($GLOBALS['filters']['counter'] as $filterName => $filterArray) {
310 // Walk through all filters
311 foreach ($filterArray as $filterFunction => $cnt) {
312 // Construct and add the query
313 ADD_SQL(sprintf("UPDATE `{!_MYSQL_PREFIX!}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
322 // Run the run_sqls filter in non-dry mode
323 runFilterChain('run_sqls');
326 // Filter for calling the handler for login failures
327 function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
331 // Handle failed logins here if not in guest
332 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={$GLOBALS['action']},what={$GLOBALS['what']},lvl={$data['access_level']}<br />\n";
333 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'))) {
335 $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
338 // Return the content
342 // Filter for redirecting to logout if sql_patches has been installed
343 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
344 // Remove this filter
345 unregisterFilter('shutdown', __FUNCTION__);
347 // Is the element set?
348 if (isset($GLOBALS['ext_load_mode'])) {
350 redirectToUrl('modules.php?module=admin&logout=1&' . $GLOBALS['ext_load_mode'] . '=sql_patches');
353 // This should not happen!
354 DEBUG_LOG(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
357 // Filter for auto-activation of a extension
358 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
359 // Is this extension always activated?
360 if (EXT_GET_ALWAYS_ACTIVE() == 'Y') {
361 // Then activate the extension
362 //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
363 ACTIVATE_EXTENSION($data['ext_name']);
370 // Filter for solving task given task
371 function FILTER_SOLVE_TASK ($data) {
372 // Don't solve anything if no admin!
373 if (!IS_ADMIN()) return $data;
375 // Is this a direct task id or array element task_id is found?
378 ADMIN_SOLVE_TASK($data);
379 } elseif ((is_array($data)) && (isset($data['task_id']))) {
381 ADMIN_SOLVE_TASK($data['task_id']);
388 // Filter to load include files
389 function FILTER_loadIncludeLUDES () {
390 // Default is $data as inclusion list
391 $data = GET_INC_POOL();
394 if ((!isset($data)) || (!is_array($data))) {
396 debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
397 } elseif (isset($data['inc_pool'])) {
398 // Use this as new inclusion pool!
399 SET_INC_POOL($data['inc_pool']);
402 // Check for added include files
403 if (COUNT_INC_POOL() > 0) {
404 // Loads every include file
405 foreach (GET_INC_POOL() as $FQFN) {
406 loadIncludeOnce($FQFN);
413 // Continue with processing
417 // Filter for running SQL commands
418 function FILTER_RUN_SQLS ($data) {
420 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Entered!");
422 // Is the array there?
423 if ((IS_SQLS_VALID()) && ((!isset($data['dry_run'])) || ($data['dry_run'] == false))) {
425 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Found ".COUNT_SQLS()." queries to run.");
426 foreach (GET_SQLS() as $sql) {
430 // Is there still a query left?
432 // Do we have an "ALTER TABLE" command?
433 if (substr(strtolower($sql), 0, 11) == "alter table") {
434 // Analyse the alteration command
435 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Alterting table: {$sql}");
436 SQL_ALTER_TABLE($sql, __FUNCTION__, __LINE__);
438 // Run regular SQL command
439 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
440 SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
447 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
450 // Filter for updating/validating login data
451 function FILTER_UPDATE_LOGIN_DATA () {
453 if ((!isset($GLOBALS['last'])) || (!is_array($GLOBALS['last']))) $GLOBALS['last'] = array();
455 // Recheck if logged in
456 if (!IS_MEMBER()) return false;
459 setUserId(getSession('userid'));
461 // Load last module and last online time
462 $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
463 array(getUserId()), __FUNCTION__, __LINE__);
466 if (SQL_NUMROWS($result) == 1) {
467 // Load last module and online time
468 list($mod, $onl) = SQL_FETCHROW($result);
470 // Maybe first login time?
471 if (empty($mod)) $mod = "login";
473 // This will be displayed on welcome page! :-)
474 if (empty($GLOBALS['last']['module'])) {
475 $GLOBALS['last']['module'] = $mod; $GLOBALS['last']['online'] = $onl;
479 if (empty($GLOBALS['what'])) {
481 $GLOBALS['what'] = "welcome";
482 if (getConfig('index_home') != '') $GLOBALS['what'] = getConfig('index_home');
485 // Update last module / online time
486 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
487 array($GLOBALS['what'], detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
489 // Destroy session, we cannot update!
490 destroyUserSession();
494 SQL_FREERESULT($result);
497 // Filter for checking admin ACL
498 function FILTER_CHECK_ADMIN_ACL () {
499 // Extension not installed so it's always allowed to access everywhere!
502 // Ok, Cookie-Update done
503 if ((GET_EXT_VERSION('admins') >= '0.3.0') && (EXT_IS_ACTIVE('admins'))) {
504 // Check if action GET variable was set
505 $action = SQL_ESCAPE($GLOBALS['action']);
506 if (!empty($GLOBALS['what'])) {
507 // Get action value by what-value
508 $action = getModeAction('admin', $GLOBALS['what']);
511 // Check for access control line of current menu entry
512 $ret = adminsCheckAdminAcl($action, $GLOBALS['what']);
519 // Filter for initializing randomizer
520 function FILTER_INIT_RANDOMIZER () {
521 // Simply init the randomizer with seed and _ADD value
522 mt_srand(generateSeed() + getConfig('_ADD'));
525 // Filter for removing updates
526 function FILTER_REMOVE_UPDATES () {
528 EXT_INIT_REMOVAL_LIST();
530 // Add the current extension to it
531 EXT_ADD_CURRENT_TO_REMOVAL_LIST();
536 // Do we need to remove update depency?
537 if (EXT_COUNT_UPDATE_DEPENDS() > 0) {
538 // Then find all updates we shall no longer execute
539 foreach (EXT_GET_UPDATE_DEPENDS() as $id=>$ext_name) {
540 // Shall we remove this update?
541 if (in_array($ext_name, EXT_GET_REMOVAL_LIST())) {
542 // Then remove this extension!
543 EXT_REMOVE_UPDATE_DEPENDS($ext_name);