Convention applied
[mailer.git] / inc / filters.php
index 35f5d6d90bc387a17100f5d4f842d2532afcce2e..83438eab3ecbb3587dc0b9307c2ce7ac5d5d6c78 100644 (file)
@@ -43,7 +43,7 @@ if (!defined('__SECURITY')) {
 }
 
 // Init "generic filter system"
-function INIT_FILTER_SYSTEM () {
+function initFilterSystem () {
        // Is the filter already initialized?
        if ((isset($GLOBALS['filters']['chains'])) && (is_array($GLOBALS['filters']['chains']))) {
                // Then abort here
@@ -53,12 +53,9 @@ function INIT_FILTER_SYSTEM () {
 
        // Init the filter system (just some ideas)
        $GLOBALS['filters']['chains'] = array(
-               // Filters for pre-init phase
-               'preinit'   => array(),
-               // Filters for post-init phase
-               'postinit'  => array(),
-               // Filters for shutdown phase
-               'shutdown'  => array()
+               'preinit'   => array(), // Filters for pre-init phase
+               'postinit'  => array(), // Filters for post-init phase
+               'shutdown'  => array()  // Filters for shutdown phase
        );
 
        // Init loaded filters and counter
@@ -100,45 +97,45 @@ ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
                                } // END - if
                        } // END - while
                } // END - if
-       
+
                // Free result
                SQL_FREERESULT($result);
        } // END - if
 
        // Init filters
-       REGISTER_FILTER('init', 'UPDATE_LOGIN_DATA');
-       REGISTER_FILTER('init', 'INIT_RANDOMIZER');
+       registerFilter('init', 'UPDATE_LOGIN_DATA');
+       registerFilter('init', 'INIT_RANDOMIZER');
 
        // Login failures handler
-       REGISTER_FILTER('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
+       registerFilter('post_youhere_line', 'CALL_HANDLER_LOGIN_FAILTURES');
 
        // Filters for pre-extension-registration
-       REGISTER_FILTER('pre_extension_installed', 'RUN_SQLS');
+       registerFilter('pre_extension_installed', 'RUN_SQLS');
 
        // Filters for post-extension-registration
-       REGISTER_FILTER('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
-       REGISTER_FILTER('post_extension_installed', 'SOLVE_TASK');
-       REGISTER_FILTER('post_extension_installed', 'LOAD_INCLUDES');
-       REGISTER_FILTER('post_extension_installed', 'REMOVE_UPDATES');
+       registerFilter('post_extension_installed', 'AUTO_ACTIVATE_EXTENSION');
+       registerFilter('post_extension_installed', 'SOLVE_TASK');
+       registerFilter('post_extension_installed', 'loadIncludeLUDES');
+       registerFilter('post_extension_installed', 'REMOVE_UPDATES');
 
        // Solving tasks
-       REGISTER_FILTER('solve_task', 'SOLVE_TASK');
+       registerFilter('solve_task', 'SOLVE_TASK');
 
        // Loading includes in general
-       REGISTER_FILTER('load_includes', 'LOAD_INCLUDES');
+       registerFilter('load_includes', 'loadIncludeLUDES');
 
        // Run SQLs
-       REGISTER_FILTER('run_sqls', 'RUN_SQLS');
+       registerFilter('run_sqls', 'RUN_SQLS');
 
        // Admin ACL check
-       REGISTER_FILTER('check_admin_acl', 'CHECK_ADMIN_ACL');
+       registerFilter('check_admin_acl', 'CHECK_ADMIN_ACL');
 
        // Register shutdown filters
-       REGISTER_FILTER('shutdown', 'FLUSH_FILTERS');
+       registerFilter('shutdown', 'FLUSH_FILTERS');
 }
 
 // "Registers" a new filter function
-function REGISTER_FILTER ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
+function registerFilter ($filterName, $filterFunction, $silentAbort = true, $force = false, $dry_run = false) {
        // Extend the filter function name
        $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
 
@@ -163,13 +160,13 @@ function REGISTER_FILTER ($filterName, $filterFunction, $silentAbort = true, $fo
        // Shall we add it?
        if (!$dry_run) {
                // Simply add it to the array
-               $GLOBALS['filters']['chains'][$filterName][$filterFunction] = "Y";
+               $GLOBALS['filters']['chains'][$filterName][$filterFunction] = 'Y';
                $GLOBALS['filters']['counter'][$filterName][$filterFunction] = 0;
        } // END - if
 }
 
 // "Unregisters" a filter from the given chain
-function UNREGISTER_FILTER ($filterName, $filterFunction, $force = false, $dry_run = false) {
+function unregisterFilter ($filterName, $filterFunction, $force = false, $dry_run = false) {
        // Extend the filter function name only if not loaded from database
        if (!isset($GLOBALS['filters']['loaded'][$filterName][$filterFunction])) {
                $filterFunction = sprintf("FILTER_%s", strtoupper($filterFunction));
@@ -217,7 +214,7 @@ function runFilterChain ($filterName, $data = null, $silentAbort = true) {
                        // Is this filter there?
                        if (!function_exists($filterFunction)) {
                                // Unregister it
-                               UNREGISTER_FILTER($filterName, $filterFunction);
+                               unregisterFilter($filterName, $filterFunction);
 
                                // Skip this entry
                                continue;
@@ -264,7 +261,8 @@ function FILTER_FLUSH_FILTERS () {
        } // END - if
 
        // Nothing is added/remove by default
-       $inserted = 0; $removed = 0;
+       $inserted = 0;
+       $removed = 0;
 
        // Prepare SQL queries
        $insertSQL = "INSERT INTO `{!_MYSQL_PREFIX!}_filters` (`filter_name`,`filter_function`,`filter_active`) VALUES";
@@ -313,9 +311,9 @@ function FILTER_FLUSH_FILTERS () {
                        foreach ($filterArray as $filterFunction => $cnt) {
                                // Construct and add the query
                                ADD_SQL(sprintf("UPDATE `{!_MYSQL_PREFIX!}_filters` SET `filter_counter`=%s WHERE `filter_name`='%s' AND `filter_function`='%s' LIMIT 1",
-                                       bigintval($cnt),
-                                       $filterName,
-                                       $filterFunction
+                               bigintval($cnt),
+                               $filterName,
+                               $filterFunction
                                ));
                        } // END - foreach
                } // END - foreach
@@ -344,12 +342,12 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
 // Filter for redirecting to logout if sql_patches has been installed
 function FILTER_REDIRECT_TO_LOGOUT_SQL_PATCHES () {
        // Remove this filter
-       UNREGISTER_FILTER('shutdown', __FUNCTION__);
+       unregisterFilter('shutdown', __FUNCTION__);
 
        // Is the element set?
        if (isset($GLOBALS['ext_load_mode'])) {
                // Redirect here
-               LOAD_URL('modules.php?module=admin&logout=1&' . $GLOBALS['ext_load_mode'] . '=sql_patches');
+               redirectToUrl('modules.php?module=admin&logout=1&' . $GLOBALS['ext_load_mode'] . '=sql_patches');
        } // END - if
 
        // This should not happen!
@@ -388,7 +386,7 @@ function FILTER_SOLVE_TASK ($data) {
 }
 
 // Filter to load include files
-function FILTER_LOAD_INCLUDES () {
+function FILTER_loadIncludeLUDES () {
        // Default is $data as inclusion list
        $data = GET_INC_POOL();
 
@@ -405,7 +403,7 @@ function FILTER_LOAD_INCLUDES () {
        if (COUNT_INC_POOL() > 0) {
                // Loads every include file
                foreach (GET_INC_POOL() as $FQFN) {
-                       LOAD_INC_ONCE($FQFN);
+                       loadIncludeOnce($FQFN);
                } // END - foreach
 
                // Reset array
@@ -458,7 +456,7 @@ function FILTER_UPDATE_LOGIN_DATA () {
        if (!IS_MEMBER()) return false;
 
        // Secure user ID
-       setUserId(get_session('userid'));
+       setUserId(getSession('userid'));
 
        // Load last module and last online time
        $result = SQL_QUERY_ESC("SELECT last_module, last_online FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
@@ -480,16 +478,16 @@ function FILTER_UPDATE_LOGIN_DATA () {
                // "what" not set?
                if (empty($GLOBALS['what'])) {
                        // Fix it to default
-                       $GLOBALS['what'] = "welcome";
-                       if (getConfig('index_home') != "") $GLOBALS['what'] = getConfig('index_home');
+                       $GLOBALS['what'] = "welcome";
+                       if (getConfig('index_home') != '') $GLOBALS['what'] = getConfig('index_home');
                } // END - if
 
                // Update last module / online time
                SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET `last_module`='%s', last_online=UNIX_TIMESTAMP(), REMOTE_ADDR='%s' WHERE userid=%s LIMIT 1",
-                       array($GLOBALS['what'], GET_REMOTE_ADDR(), getUserId()), __FUNCTION__, __LINE__);
+                       array($GLOBALS['what'], detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
        }  else {
                // Destroy session, we cannot update!
-               destroy_user_session();
+               destroyUserSession();
        }
 
        // Free the result
@@ -502,16 +500,16 @@ function FILTER_CHECK_ADMIN_ACL () {
        $ret = true;
 
        // Ok, Cookie-Update done
-       if (GET_EXT_VERSION('admins') >= '0.3.0') {
+       if ((GET_EXT_VERSION('admins') >= '0.3.0') && (EXT_IS_ACTIVE('admins'))) {
                // Check if action GET variable was set
                $action = SQL_ESCAPE($GLOBALS['action']);
                if (!empty($GLOBALS['what'])) {
                        // Get action value by what-value
-                       $action = GET_ACTION('admin', $GLOBALS['what']);
+                       $action = getModeAction('admin', $GLOBALS['what']);
                } // END - if
 
                // Check for access control line of current menu entry
-               $ret = ADMINS_CHECK_ACL($action, $GLOBALS['what']);
+               $ret = adminsCheckAdminAcl($action, $GLOBALS['what']);
        } // END - if
 
        // Return result
@@ -521,7 +519,7 @@ function FILTER_CHECK_ADMIN_ACL () {
 // Filter for initializing randomizer
 function FILTER_INIT_RANDOMIZER () {
        // Simply init the randomizer with seed and _ADD value
-       mt_srand(generateSeed() + constant('_ADD'));
+       mt_srand(generateSeed() + getConfig('_ADD'));
 }
 
 // Filter for removing updates