Caching of XML/email templates finished:
[mailer.git] / inc / filters.php
index fcafc63c0ea18c7c25b6265986d489f6be06df24..634d0f1c00a306d515f5a03686b77aadcdf17b99 100644 (file)
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -45,21 +45,17 @@ function FILTER_FLUSH_FILTERS () {
        // Clear all previous SQL queries
        initSqls();
 
-       // Are we installing?
-       if ((isInstallationPhase())) {
-               // Then silently skip this filter
-               return true;
-       } // END - if
-
        // Is a database link here and not in installation mode?
-       if ((!SQL_IS_LINK_UP()) && (!isInstalling())) {
+       if ((!SQL_IS_LINK_UP()) && (!isInstallationPhase())) {
                // Abort here
-               debug_report_bug(__FUNCTION__, __LINE__, 'No database link is up. Cannot flush filters.');
-               return false;
-       } // END - if
+               reportBug(__FUNCTION__, __LINE__, 'No database link is up. Cannot flush filters.');
+       } elseif ((isInstallationPhase()) && (!SQL_IS_LINK_UP())) {
+               // If the link is not up in installation phase, skip flushing filters
+               return;
+       }
 
-       // Is the extension ext-sql_patches updated?
-       if ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9'))) {
+       // Is the extension ext-sql_patches updated and not in installation phase?
+       if ((!isInstallationPhase()) && ((!isExtensionInstalled('sql_patches')) || (isExtensionInstalledAndOlder('sql_patches', '0.5.9')))) {
                // Log only in debug mode
                if (isDebugModeEnabled()) {
                        logDebugMessage(__FUNCTION__, __LINE__, 'Cannot flush filters, sql_patches might be missing. isExtensionInstalled()=' . intval(isExtensionInstalled('sql_patches')) . ',isExtensionInstalledAndOlder()=' . intval(isExtensionInstalledAndOlder('sql_patches', '0.5.9')));
@@ -142,7 +138,7 @@ function FILTER_CALL_HANDLER_LOGIN_FAILTURES ($filterData) {
 
        // Handle failed logins here if not in guest
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'type=' . $filterData['type'] . ',action=' . getAction() . ',what=' . getWhat() . ',level=' . $filterData['access_level']);
-       if ((($filterData['type'] == 'what') || ($filterData['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'overview') || (getWhat() == getIndexHome()))) && ($filterData['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.6')))) {
+       if ((($filterData['type'] == 'what') || ($filterData['type'] == 'action') && ((!isWhatSet()) || (getWhat() == 'welcome') || (getWhat() == getIndexHome()))) && ($filterData['access_level'] != 'guest') && ((isExtensionInstalledAndNewer('sql_patches', '0.4.7')) || (isExtensionInstalledAndNewer('admins', '0.7.6')))) {
                // Handle failure
                $content['content'] .= handleLoginFailures($filterData['access_level']);
        } // END - if
@@ -197,7 +193,7 @@ function FILTER_SOLVE_TASK ($filterData) {
                adminSolveTask($filterData['task_id']);
        } else {
                // Not detectable!
-               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($filterData), print_r($filterData, true)));
+               reportBug(__FUNCTION__, __LINE__, sprintf("Cannot resolve task. data[%s]=<pre>%s</pre>", gettype($filterData), print_r($filterData, true)));
        }
 
        // Return the data
@@ -209,7 +205,7 @@ function FILTER_LOAD_INCLUDES ($filterData) {
        // Is it null?
        if (is_null($filterData)) {
                // This should not happen!
-               debug_report_bug(__FUNCTION__, __LINE__, 'pool is null.');
+               reportBug(__FUNCTION__, __LINE__, 'pool is null.');
        } // END - if
 
        // Is the pool an array and 'pool' set?
@@ -227,7 +223,7 @@ function FILTER_LOAD_INCLUDES ($filterData) {
        // Is it an array?
        if ((!isset($data)) || (!is_array($data))) {
                // Then abort here
-               debug_report_bug(__FUNCTION__, __LINE__, sprintf("INC_POOL is no array! Type: %s", gettype($data)));
+               reportBug(__FUNCTION__, __LINE__, sprintf("INC_POOL is no array! Type: %s", gettype($data)));
        } elseif (isset($data['inc_pool'])) {
                // Use this as new inclusion pool!
                setIncludePool($realPool, $data['inc_pool']);
@@ -248,6 +244,9 @@ function FILTER_LOAD_INCLUDES ($filterData) {
 
 // Filter for running SQL commands
 function FILTER_RUN_SQLS ($filterData) {
+       // Init counter
+       $count = 0;
+
        // Debug message
        //* DEBUG: */ die('getSqls()=<pre>'.print_r(getSqls(), true).'</pre>ext_update_depends=<pre>'.print_r($GLOBALS['ext_update_depends'], true).'</pre>');
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Entered!');
@@ -272,7 +271,7 @@ function FILTER_RUN_SQLS ($filterData) {
 
                                // Is there still a query left?
                                if (!empty($sql)) {
-                                       // Do we have an "ALTER TABLE" command?
+                                       // Is there an "ALTER TABLE" command?
                                        if (substr(strtolower($sql), 0, 11) == 'alter table') {
                                                // Analyse the alteration command
                                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Alterting table: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
@@ -282,6 +281,12 @@ function FILTER_RUN_SQLS ($filterData) {
                                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Running regular query: ' . $sql . ',enable_codes=' . intval($filterData['enable_codes']));
                                                SQL_QUERY($sql, __FUNCTION__, __LINE__, $filterData['enable_codes']);
                                        }
+
+                                       // Has a line changed?
+                                       if (!SQL_HASZEROAFFECTED()) {
+                                               // Add it to total account
+                                               $count += SQL_AFFECTEDROWS();
+                                       } // END - if
                                } // END - if
                        } // END - foreach
                } // END - foreach
@@ -289,6 +294,12 @@ function FILTER_RUN_SQLS ($filterData) {
 
        // Debug message
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
+
+       // Clear any SQL queries
+       //initSqls();
+
+       // Return counter
+       return $count;
 }
 
 // Filter for updating/validating login data
@@ -312,13 +323,13 @@ function FILTER_UPDATE_LOGIN_DATA () {
                $content = getUserDataArray();
 
                // Maybe first login time?
-               if (empty($content['last_module'])) {
-                       $content['last_module'] = 'login';
+               if (empty($content[getUserLastWhatName()])) {
+                       $content[getUserLastWhatName()] = 'login';
                } // END - if
 
                // This will be displayed on welcome page! :-)
                if (empty($GLOBALS['last_online']['module'])) {
-                       $GLOBALS['last_online']['module'] = $content['last_module'];
+                       $GLOBALS['last_online']['module'] = $content[getUserLastWhatName()];
                        $GLOBALS['last_online']['online'] = $content['last_online'];
                } // END - if
 
@@ -369,7 +380,7 @@ function FILTER_REMOVE_UPDATES ($filterData) {
        // Simply remove it
        unsetExtensionSqls();
 
-       // Do we need to remove update depency?
+       // Are there update dependencies to remove?
        if (countExtensionUpdateDependencies() > 0) {
                // Then find all updates we shall no longer execute
                foreach (getExtensionUpdateDependencies() as $id => $ext_name) {
@@ -423,7 +434,7 @@ function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
        // Save the uncompiled code
        $uncompiled = $code;
 
-       // Do we have cache?
+       // Is there cache?
        if (!isset($GLOBALS['compiled_config'][$code])) {
                // Compile {?some_var?} to getConfig('some_var')
                preg_match_all('/\{\?(([a-zA-Z0-9-_]+)*)\?\}/', $code, $matches);
@@ -432,7 +443,7 @@ function FILTER_COMPILE_CONFIG ($code, $compiled = false) {
                if ((count($matches) > 0) && (count($matches[0]) > 0)) {
                        // Replace all matches
                        foreach ($matches[0] as $key => $match) {
-                               // Do we have cache?
+                               // Is there cache?
                                if (!isset($GLOBALS['compile_config'][$matches[1][$key]])) {
                                        // Is the config valid?
                                        if (isConfigEntrySet($matches[1][$key])) {
@@ -485,7 +496,7 @@ function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
        // Some entries found?
        if ((count($matches) > 0) && (count($matches[3]) > 0)) {
                // Replace all matches
-               foreach ($matches[2] as $key => $cmd) {
+               foreach ($matches[2] as $key => $eti) {
                        // Init replacer/call-back variable
                        $replacer       = '';
                        $callback       = '';
@@ -494,25 +505,25 @@ function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
                        $value          = NULL;
 
                        // Extract command and call-back
-                       $cmdArray = explode(',', $cmd);
-                       $cmd = $cmdArray[0];
+                       $etiArray = explode(',', $eti);
+                       $eti = $etiArray[0];
 
                        // Detect call-back function
-                       if (isset($cmdArray[1])) {
+                       if (isset($etiArray[1])) {
                                // Call-back function detected
-                               $callback = $cmdArray[1];
+                               $callback = $etiArray[1];
                        } // END - if
 
                        // Detect extra function
-                       if (isset($cmdArray[2])) {
+                       if (isset($etiArray[2])) {
                                // Also detected
-                               $extraFunction = $cmdArray[2];
+                               $extraFunction = $etiArray[2];
                        } // END - if
 
                        // Detect extra function 2
-                       if (isset($cmdArray[3])) {
+                       if (isset($etiArray[3])) {
                                // Also detected
-                               $extraFunction2 = $cmdArray[3];
+                               $extraFunction2 = $etiArray[3];
                        } // END - if
 
                        // And value
@@ -522,10 +533,10 @@ function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
                        } // END - if
 
                        // Construct call-back function name for the command
-                       $commandFunction = 'doExpression' . capitalizeUnderscoreString($cmd);
+                       $etiFunction = 'doExpression' . capitalizeUnderscoreString($eti);
 
                        // Is this function there?
-                       if (function_exists($commandFunction)) {
+                       if (function_exists($etiFunction)) {
                                // Prepare $matches, $key, $outputMode, etc.
                                $data = array(
                                        'matches'     => $matches,
@@ -539,16 +550,16 @@ function FILTER_COMPILE_EXPRESSION_CODE ($filterData) {
                                );
 
                                // Call it
-                               //* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: function=' . $commandFunction);
-                               $filterData = call_user_func($commandFunction, $data);
+                               //* DEBUG: */ debugOutput(__FUNCTION__ . '[' . __LINE__ . ']: etiFunction=' . $etiFunction);
+                               $filterData = call_user_func($etiFunction, $data);
                        } else {
                                // Unsupported command detected
-                               logDebugMessage(__FUNCTION__, __LINE__, 'Command cmd=' . $cmd . ', callback=' . $callback . ', extra=' . $extraFunction . ' is unsupported.');
+                               logDebugMessage(__FUNCTION__, __LINE__, 'eti=' . $eti . ', callback=' . $callback . ', extra=' . $extraFunction . ' - unsupported');
                        }
                } // END - foreach
        } // END - if
 
-       // Do we have non-HTML mode?
+       // Is there non-HTML mode?
        if (!isHtmlOutputMode()) {
                $filterData = decodeEntities($filterData);
        } // END - if
@@ -577,7 +588,7 @@ function FILTER_RUN_HOURLY_INCLUDES () {
        // Is the reset set or old sql_patches?
        if (((!isHourlyResetEnabled()) || (!isExtensionInstalledAndNewer('sql_patches', '0.7.5'))) && (isHtmlOutputMode())) {
                // Then abort here
-               debug_report_bug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isHourlyResetEnabled()).',ext_newer[sql_patches:0.7.5]='.intval(isExtensionInstalledAndNewer('sql_patches', '0.7.5')).' Please report this bug. Thanks');
+               reportBug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isHourlyResetEnabled()).',ext_newer[sql_patches:0.7.5]='.intval(isExtensionInstalledAndNewer('sql_patches', '0.7.5')).' Please report this bug. Thanks');
        } // END - if
 
        // Get more hourly reset scripts
@@ -597,7 +608,7 @@ function FILTER_RUN_RESET_INCLUDES () {
        // Is the reset set or old sql_patches?
        if (((!isResetModeEnabled()) || (!isExtensionInstalled('sql_patches'))) && (isHtmlOutputMode())) {
                // Then abort here
-               debug_report_bug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
+               reportBug(__FUNCTION__, __LINE__, 'Cannot run reset! enabled='.intval(isResetModeEnabled()).',ext='.intval(isExtensionInstalled('sql_patches')).' Please report this bug. Thanks');
        } // END - if
 
        // Get more daily reset scripts
@@ -714,7 +725,15 @@ function FILTER_DETERMINE_WHAT_ACTION () {
 
                // Fix 'action' if not yet set
                if (!isActionSet()) {
-                       setAction(getActionFromModuleWhat(getModule(), getWhat()));
+                       // Is 'what' set?
+                       if (isWhatSet()) {
+                               // Set action
+                               setAction(getActionFromModuleWhat(getModule(), getWhat()));
+                       } else {
+                               // Set action/what to empty
+                               setAction('');
+                               setWhat('');
+                       }
                } // END - if
        } else {
                // Set action/what to empty
@@ -858,7 +877,7 @@ function FILTER_COUNT_MODULE () {
 
 // Handles fatal errors
 function FILTER_HANDLE_FATAL_ERRORS () {
-       // Do we have errors to handle and right output mode?
+       // Is there errors to handle and right output mode?
        if ((!ifFatalErrorsDetected()) || (!isHtmlOutputMode())) {
                // Abort executing here
                return false;
@@ -935,20 +954,20 @@ function FILTER_HANDLE_FATAL_ERRORS () {
        loadIncludeOnce('inc/footer.php');
 
        // Abort here
-       shutdown();
+       doShutdown();
 }
 
 // Filter for displaying copyright line
 function FILTER_DISPLAY_COPYRIGHT () {
        // Shall we display the copyright notice?
-       if ((!isGetRequestElementSet('frame')) && (basename($_SERVER['PHP_SELF']) != 'mailid_top.php') && ((getConfig('WRITE_FOOTER') == 'Y') || (isInstalling())) && ($GLOBALS['header_sent'] == 2)) {
+       if ((isFullPage()) && ((getConfig('WRITE_FOOTER') == 'Y') || (isInstalling())) && ($GLOBALS['__header_sent'] == 2) && (ifCopyrightFooterEnabled())) {
                // Backlink enabled?
                if (((isConfigEntrySet('ENABLE_BACKLINK')) && (getConfig('ENABLE_BACKLINK') == 'Y')) || (isInstalling())) {
                        // Copyright with backlink, thanks! :-)
-                       $GLOBALS['page_footer'] .= loadTemplate('copyright_backlink', true);
+                       $GLOBALS['__page_footer'] .= loadTemplate('copyright_backlink', true);
                } else {
                        // No backlink in Copyright note
-                       $GLOBALS['page_footer'] .= loadTemplate('copyright', true);
+                       $GLOBALS['__page_footer'] .= loadTemplate('copyright', true);
                }
        } // END - if
 }
@@ -956,8 +975,8 @@ function FILTER_DISPLAY_COPYRIGHT () {
 // Filter for displaying parsing time
 function FILTER_DISPLAY_PARSING_TIME () {
        // Shall we display the parsing time and number of queries?
-       // 1234                            5                      54    4         5              5       4    4                       5       543    3                   4432    2             33     2    2                              21
-       if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (!isGetRequestElementSet('frame'))) || (isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['header_sent'] == 2)) {
+       // 1234                            5                      54    4         5              5       4    4          5543    3                    4432    2                332    2                              21
+       if ((((isExtensionInstalledAndNewer('sql_patches', '0.4.1')) && (getConfig('show_timings') == 'Y') && (isFullPage())) && (!isInstallationPhase())) && (isHtmlOutputMode()) && ($GLOBALS['__header_sent'] == 2)) {
                // Then display it here
                displayParsingTime();
        } // END - if
@@ -966,15 +985,20 @@ function FILTER_DISPLAY_PARSING_TIME () {
 // Filter for flushing template cache
 function FILTER_FLUSH_TEMPLATE_CACHE () {
        // Do not flush when debugging the template cache
-       if (isDebuggingTemplateCache()) return;
+       if (isDebuggingTemplateCache()) {
+               // Do not flush templates in debug-mode
+               return;
+       } // END - if
 
-       // Do we have cached eval() data?
+       // Is there cached eval() data?
        if ((isset($GLOBALS['template_eval'])) && (count($GLOBALS['template_eval']) > 0)) {
                // Now flush all
-               foreach ($GLOBALS['template_eval'] as $template => $eval) {
-                       // Flush the cache (if not yet found)
-                       flushTemplateCache($template, $eval);
-               } // END - if
+               foreach ($GLOBALS['template_eval'] as $prefix => $templateArray) {
+                       foreach ($templateArray as $template => $eval) {
+                               // Flush the cache (if not yet found)
+                               flushTemplateCache($prefix, $template, $eval);
+                       } // END - foreach
+               } // END - foreach
        } // END - if
 }
 
@@ -988,7 +1012,7 @@ function FILTER_FETCH_USER_DATA ($userid = NULL) {
        // Get user data
        if (!fetchUserData($userid)) {
                // Userid is not valid
-               debug_report_bug(__FUNCTION__, __LINE__, 'User id '.$userid . ' is invalid.');
+               reportBug(__FUNCTION__, __LINE__, 'User id '.$userid . ' is invalid.');
        } // END - if
 
        // Set member id
@@ -1000,7 +1024,7 @@ function FILTER_RESET_USER_LOGIN_FAILURE () {
        // Is the user data valid?
        if (!isMember()) {
                // Do only run for logged in members
-               debug_report_bug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
+               reportBug(__FUNCTION__, __LINE__, 'Please only run this filter for logged in users.');
        } // END - if
 
        // Remmeber login failures if available
@@ -1040,12 +1064,12 @@ function FILTER_DO_LOGIN_ADMIN ($filterData) {
 // Filter for loading page header, this should be ran first!
 function FILTER_LOAD_PAGE_HEADER () {
        // Output page header code
-       $GLOBALS['page_header'] = loadTemplate('page_header', true);
+       $GLOBALS['__page_header'] = loadTemplate('page_header', true);
 
        // Include meta data in 'guest' module
-       if (getModule() == 'index') {
+       if ((isModuleSet()) && (getModule() == 'index')) {
                // Load meta data template
-               $GLOBALS['page_header'] .= loadTemplate('metadata', true);
+               $GLOBALS['__page_header'] .= loadTemplate('metadata', true);
 
                // Add meta description to header
                if ((isInstalled()) && (isAdminRegistered()) && (SQL_IS_LINK_UP())) {
@@ -1061,7 +1085,7 @@ function FILTER_FINISH_PAGE_HEADER () {
        loadIncludeOnce('inc/stylesheet.php');
 
        // Closing HEAD tag
-       $GLOBALS['page_header'] .= '</head>';
+       $GLOBALS['__page_header'] .= '</head>';
 }
 
 // Cleans up the DNS cache if sql_patches is at least 0.7.0
@@ -1163,5 +1187,65 @@ function FILTER_ADD_HISTORY_ENTRY ($filterData) {
        return $filterData;
 }
 
+// Filter for initializing ext-sql_patches
+function FILTER_GENERATE_FILE_SECRET_HASH ($filterData) {
+       // Transfer POINTS word
+       if (isExtensionInstalledAndNewer('sql_patches', '0.0.3')) {
+               // Okay, recent enough, so transfer the word for POINTS
+               setConfigEntry('POINTS', getPointsWord());
+       } // END - if
+
+       // Init key
+       setConfigEntry('secret_key', '');
+
+       // Read key from secret file
+       if ((getFileHash() == '') || (getMasterSalt() == '') || (getPassScramble() == '')) {
+               // Maybe need setup of secret key!
+               loadIncludeOnce('inc/gen_sql_patches.php');
+       } // END - if
+
+       // Test again
+       if ((getFileHash() != '') && (getMasterSalt() != '') && (getPassScramble() != '')) {
+               // File hash fas generated so we can also file the secret file... hopefully.
+               $hashFile = sprintf("%s%s.%s.cache", getPath(), getCachePath(), getFileHash());
+
+               // Is the secret key file readable?
+               if (isFileReadable($hashFile)) {
+                       // Read file
+                       setConfigEntry('secret_key', readFromFile($hashFile));
+               } else {
+                       // Remove it from database
+                       updateConfiguration('file_hash', '');
+
+                       // Cannot read secret file!
+                       reportBug(__FILE__, __LINE__, 'Cannot read secret file! Please try to reload.');
+               }
+       } // END - if
+
+       // Return data
+       return $filterData;
+}
+
+// Filter to initialize session
+function FILTER_INIT_SESSION ($filterData) {
+       // Determine and set referral id
+       determineReferralId();
+
+       // Return data
+       return $filterData;
+}
+
+// Filter for sending "build mail" to admin
+function FILTER_SEND_BUILD_MAIL ($filterData) {
+       // Was one line updated?
+       //if ($filterData['affected'] == 1) {
+               // Then call the proper function
+               call_user_func_array('sendGenericBuildMails', $filterData);
+       //} // END - if
+
+       // Return data
+       return $filterData;
+}
+
 // [EOF]
 ?>