Convention applied
[mailer.git] / inc / filters.php
index df664c279ed92e2b75b909f8745215d5e41baf4b..83438eab3ecbb3587dc0b9307c2ce7ac5d5d6c78 100644 (file)
@@ -10,7 +10,7 @@
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Funktionen fuer Filter-System                    *
  * -------------------------------------------------------------------- *
- * $Revision:: 856                                                    $ *
+ * $Revision::                                                        $ *
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
 
 // Some security stuff...
 if (!defined('__SECURITY')) {
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4)."/security.php";
+       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
        require($INC);
 }
 
 // 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
@@ -66,13 +63,13 @@ function INIT_FILTER_SYSTEM () {
        $GLOBALS['filters']['counter'] = array();
 
        // Load all saved filers if sql_patches is updated
-       if (GET_EXT_VERSION("sql_patches") >= "0.5.9") {
+       if (GET_EXT_VERSION('sql_patches') >= '0.5.9') {
                // Init add
-               $ADD = "";
-               if (GET_EXT_VERSION("sql_patches") >= "0.6.0") $ADD = ", `filter_counter`";
+               $add = '';
+               if (GET_EXT_VERSION('sql_patches') >= '0.6.0') $add = ", `filter_counter`";
 
                // Load all active filers
-               $result = SQL_QUERY("SELECT `filter_name`, `filter_function`, `filter_active`".$ADD."
+               $result = SQL_QUERY("SELECT `filter_name`,`filter_function`,`filter_active`".$add."
 FROM `{!_MYSQL_PREFIX!}_filters`
 ORDER BY `filter_id` ASC", __FUNCTION__, __LINE__);
 
@@ -100,44 +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');
+       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));
 
@@ -162,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));
@@ -212,11 +210,11 @@ function runFilterChain ($filterName, $data = null, $silentAbort = true) {
                //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): name={$filterName},func={$filterFunction},active={$active}<br />\n";
 
                // Is the filter active?
-               if ($active == "Y") {
+               if ($active == 'Y') {
                        // Is this filter there?
                        if (!function_exists($filterFunction)) {
                                // Unregister it
-                               UNREGISTER_FILTER($filterName, $filterFunction);
+                               unregisterFilter($filterName, $filterFunction);
 
                                // Skip this entry
                                continue;
@@ -244,7 +242,7 @@ function FILTER_FLUSH_FILTERS () {
        INIT_SQLS();
 
        // Are we installing?
-       if (isInstalling()) {
+       if ((isInstalling()) || (!isInstalled())) {
                // Then silently skip this filter
                return true;
        } // END - if
@@ -257,13 +255,14 @@ function FILTER_FLUSH_FILTERS () {
        } // END - if
 
        // Is the extension sql_patches updated?
-       if (EXT_VERSION_IS_OLDER("sql_patches", "0.5.9")) {
+       if (EXT_VERSION_IS_OLDER('sql_patches', '0.5.9')) {
                // Abort silently here
                return false;
        } // 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";
@@ -305,16 +304,16 @@ function FILTER_FLUSH_FILTERS () {
        } // END - if
 
        // Shall we update usage counters (ONLY FOR DEBUGGING!)
-       if (getConfig('update_filter_usage') == "Y") {
+       if (getConfig('update_filter_usage') == 'Y') {
                // Update all counters
                foreach ($GLOBALS['filters']['counter'] as $filterName => $filterArray) {
                        // Walk through all 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
@@ -331,7 +330,7 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($data) {
 
        // Handle failed logins here if not in guest
        //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):type={$data['type']},action={$GLOBALS['action']},what={$GLOBALS['what']},lvl={$data['access_level']}<br />\n";
-       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"))) {
+       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'))) {
                // Handle failure
                $content['content'] .= HANDLE_LOGIN_FAILTURES($data['access_level']);
        } // END - if
@@ -343,22 +342,22 @@ 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&amp;logout=1&amp;".$GLOBALS['ext_load_mode']."=sql_patches");
+               redirectToUrl('modules.php?module=admin&amp;logout=1&amp;' . $GLOBALS['ext_load_mode'] . '=sql_patches');
        } // END - if
 
        // This should not happen!
-       DEBUG_LOG(__FUNCTION__, __LINE__, "Cannot auto-logout because no extension load-mode has been set.");
+       DEBUG_LOG(__FUNCTION__, __LINE__, 'Cannot auto-logout because no extension load-mode has been set.');
 }
 
 // Filter for auto-activation of a extension
 function FILTER_AUTO_ACTIVATE_EXTENSION ($data) {
        // Is this extension always activated?
-       if (EXT_GET_ALWAYS_ACTIVE() == "Y") {
+       if (EXT_GET_ALWAYS_ACTIVE() == 'Y') {
                // Then activate the extension
                //* DEBUG: */ echo __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$data['ext_name']}<br />\n";
                ACTIVATE_EXTENSION($data['ext_name']);
@@ -387,28 +386,28 @@ function FILTER_SOLVE_TASK ($data) {
 }
 
 // Filter to load include files
-function FILTER_LOAD_INCLUDES ($data) {
+function FILTER_loadIncludeLUDES () {
        // Default is $data as inclusion list
-       $INC_POOL = $data;
+       $data = GET_INC_POOL();
 
        // Is it an array?
        if ((!isset($data)) || (!is_array($data))) {
                // Then abort here
-               debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($INC_POOL)));
+               debug_report_bug(sprintf("INC_POOL is no array! Type: %s", gettype($data)));
        } elseif (isset($data['inc_pool'])) {
                // Use this as new inclusion pool!
-               $INC_POOL = $data['inc_pool'];
+               SET_INC_POOL($data['inc_pool']);
        }
 
        // Check for added include files
-       if (count($INC_POOL) > 0) {
+       if (COUNT_INC_POOL() > 0) {
                // Loads every include file
-               foreach ($INC_POOL as $FQFN) {
-                       LOAD_INC_ONCE($FQFN);
+               foreach (GET_INC_POOL() as $FQFN) {
+                       loadIncludeOnce($FQFN);
                } // END - foreach
 
                // Reset array
-               if (isset($data['inc_pool'])) $data['inc_pool'] = array();
+               INIT_INC_POOL();
        } // END - if
 
        // Continue with processing
@@ -438,7 +437,7 @@ function FILTER_RUN_SQLS ($data) {
                                } else {
                                        // Run regular SQL command
                                        //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Running regular query: {$sql}");
-                                       $result = SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
+                                       SQL_QUERY($sql, __FUNCTION__, __LINE__, false);
                                }
                        } // END - if
                } // END - foreach
@@ -457,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",
@@ -479,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__);
+               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'], detectRemoteAddr(), getUserId()), __FUNCTION__, __LINE__);
        }  else {
                // Destroy session, we cannot update!
-               destroy_user_session();
+               destroyUserSession();
        }
 
        // Free the result
@@ -501,16 +500,16 @@ function FILTER_CHECK_ADMIN_ACL () {
        $ret = true;
 
        // Ok, Cookie-Update done
-       if (GET_EXT_VERSION("admins") >= "0.3") {
+       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
@@ -520,7 +519,31 @@ 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
+function FILTER_REMOVE_UPDATES () {
+       // Init removal list
+       EXT_INIT_REMOVAL_LIST();
+
+       // Add the current extension to it
+       EXT_ADD_CURRENT_TO_REMOVAL_LIST();
+
+       // Simply remove it
+       UNSET_EXT_SQLS();
+
+       // Do we need to remove update depency?
+       if (EXT_COUNT_UPDATE_DEPENDS() > 0) {
+               // Then find all updates we shall no longer execute
+               foreach (EXT_GET_UPDATE_DEPENDS() as $id=>$ext_name) {
+                       // Shall we remove this update?
+                       if (in_array($ext_name, EXT_GET_REMOVAL_LIST())) {
+                               // Then remove this extension!
+                               EXT_REMOVE_UPDATE_DEPENDS($ext_name);
+                       } // END - if
+               } // END - foreach
+       } // END - if
 }
 
 //