]> git.mxchange.org Git - mailer.git/blobdiff - inc/functions.php
User tables are now moved to ext-user
[mailer.git] / inc / functions.php
index 5cbf2877c8667a11e2f8af886f1d91e3f74f4207..28748b0e569b1c1118ecf8c35d5d86e92110b472 100644 (file)
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
  * -------------------------------------------------------------------- *
- * $Revision:: 856                                                    $ *
- * $Date:: 2009-03-06 20:24:32 +0100 (Fr, 06. Mär 2009)              $ *
+ * $Revision::                                                        $ *
+ * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
- * $Author:: stelzi                                                   $ *
+ * $Author::                                                          $ *
  * Needs to be in all Files and every File needs "svn propset           *
  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
@@ -191,6 +191,7 @@ function getFatalArray () {
 
 // Add a fatal error message to the queue array
 function addFatalMessage ($F, $L, $message, $extra="") {
+       debug_report_bug($message);
        if (is_array($extra)) {
                // Multiple extras for a message with masks
                $message = call_user_func_array('sprintf', $extra);
@@ -661,8 +662,7 @@ function TRANSLATE_GENDER ($gender) {
 //
 function FRAMETESTER ($URL) {
        // Prepare frametester URL
-       $frametesterUrl = sprintf("%s/modules.php?module=frametester&url=%s",
-               URL,
+       $frametesterUrl = sprintf("{!URL!}/modules.php?module=frametester&url=%s",
                encodeString(compileUriCode($URL))
        );
        return $frametesterUrl;
@@ -699,7 +699,7 @@ function TRANSLATE_STATUS ($status) {
 
        default:
                DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
-               $ret = sprintf(getMessage('UNKNOWN_STATUS"'), $status);
+               $ret = sprintf(getMessage('UNKNOWN_STATUS'), $status);
                break;
        }
 
@@ -2040,8 +2040,6 @@ function CREATE_EMAIL_LINK ($email, $table = "admins") {
 
 // Generate a hash for extra-security for all passwords
 function generateHash ($plainText, $salt = "") {
-       global $_SERVER;
-
        // Is the required extension "sql_patches" there and a salt is not given?
        if (((EXT_VERSION_IS_OLDER("sql_patches", "0.3.6")) || (!EXT_IS_ACTIVE("sql_patches"))) && (empty($salt))) {
                // Extension sql_patches is missing/outdated so we hash the plain text with MD5
@@ -2353,8 +2351,6 @@ function getMessage ($messageId) {
 
 // Get current theme name
 function GET_CURR_THEME() {
-       global $INC_POOL;
-
        // The default theme is 'default'... ;-)
        $ret = "default";
 
@@ -2395,10 +2391,10 @@ function GET_CURR_THEME() {
        }
 
        // Add (maybe) found theme.php file to inclusion list
-       $theme = sprintf("%stheme/%s/theme.php", constant('PATH'), SQL_ESCAPE($ret));
+       $INC = sprintf("theme/%s/theme.php", SQL_ESCAPE($ret));
 
        // Try to load the requested include file
-       if (FILE_READABLE($theme)) $INC_POOL[] = $theme;
+       if (INCLUDE_READABLE($INC)) ADD_INC_TO_POOL($INC);
 
        // Return theme value
        return $ret;
@@ -2525,27 +2521,43 @@ function clearOutputBuffer () {
        } // END - if
 }
 
-// Function to search for the last modifikated file
-function searchDirsRecoursive ($dir, &$last_changed) {
-       $ds = scandir($dir); // Needs adjustment for PHP < 5.0.0!!
+// Function to search for the last modifified file
+function searchDirsRecursive ($dir, &$last_changed) {
+       // Get dir as array
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):dir=".$dir."<br />\n";
+       $ds = GET_DIR_AS_ARRAY($dir, "", true, false);
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):ds[]=".count($ds)."<br />\n";
+
+       // Walk through all entries
        foreach ($ds as $d) {
-               $f_name = $dir.'/'.$d; // makes a proper Filename
-               if (!preg_match('@(\.|\.\.|\.revision|\.svn|debug\.log|\.cache)$@',$d)) {       // no . or  ..  or .revision or .svn in the filename
-                       $is_dir = is_dir($f_name);
-                       if (!$is_dir) { // $f_name is a filename and no directory
-                               $time = filemtime($f_name);
-                               if ($last_changed['time'] < $time) { // This file is newer as the file before
-                                       $last_changed['path_name'] = $f_name;
+               // Generate proper FQFN
+               $FQFN = str_replace("//", "/", constant('PATH') . $dir. "/". $d);
+
+               // Does it match what we are looking for? (We skip a lot files already!)
+               if (!preg_match('@(\.|\.\.|\.revision|\.svn|debug\.log|\.cache)$@', $d)) {      // no . or  ..  or .revision or .svn in the filename
+                       // Is it a file and readable?
+                       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):FQFN={$FQFN}<br />\n";
+                       if (isDirectory($FQFN)) {
+                                // $FQFN is a directory so also crawl into this directory
+                               $newDir = $d;
+                               if (!empty($dir)) $newDir = $dir . "/". $d;
+                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):DESCENT: ".$newDir."<br />\n";
+                               searchDirsRecursive($newDir, $last_changed);
+                       } elseif (FILE_READABLE($FQFN)) {
+                               // $FQFN is a filename and no directory
+                               $time = filemtime($FQFN);
+                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):File: ".$d." found. (".($last_changed['time'] - $time).")<br />\n";
+                               if ($last_changed['time'] < $time) {
+                                       // This file is newer as the file before
+                                       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>) - NEWER!<br />\n";
+                                       $last_changed['path_name'] = $FQFN;
                                        $last_changed['time'] = $time;
-                               }
-                       } elseif ($is_dir) { // $f_name is a directory so also crawl into this directory
-                               searchDirsRecoursive($f_name, $last_changed);
+                               } // END - if
                        }
-               }
-       }
+               } // END - if
+       } // END - foreach
 }
 
-
 // "Getter" for revision/version data
 function getActualVersion ($type = 'Revision') {
        // By default nothing is new... ;-)
@@ -2558,28 +2570,30 @@ function getActualVersion ($type = 'Revision') {
                        || count($GLOBALS['cache_array']['revision']) < 3
                        || !$GLOBALS['cache_instance']->loadCacheFile("revision")) $new = true;
 
-               if ($new){
-
+               // Is the cache file outdated/invalid?
+               if ($new === true){
                        $GLOBALS['cache_instance']->destroyCacheFile(); // @TODO isn't it better to do $GLOBALS['cache_instance']->destroyCacheFile('revision')?
 
                        // @TODO shouldn't do the unset and the reloading $GLOBALS['cache_instance']->destroyCacheFile() Or a new methode like forceCacheReload('revision')?
                        unset($GLOBALS['cache_array']['revision']);
+
                        // Reload load_cach-revison.php
-                       LOAD_INC('inc/loader/load_cache-revision.php');
-               }
+                       LOAD_INC("inc/loader/load_cache-revision.php");
+               } // END - if
 
+               // Return found value
                return $GLOBALS['cache_array']['revision'][$type][0];
 
        } else {
-               // old Version without ext-cache aktive (depricated ?)
+               // Old Version without ext-cache active (deprecated ?)
 
                // FQFN of revision file
                $FQFN = sprintf("%sinc/cache/.revision", constant('PATH'));
 
                // Check if $_GET['check_revision_data'] is setted (switch for manually rewrite the .revision-File)
-               if (isset($_GET['check_revision_data']) && $_GET['check_revision_data'] == 'yes') {
+               if ((isset($_GET['check_revision_data'])) && ($_GET['check_revision_data'] == 'yes')) {
+                       // Has changed!
                        $new = true;
-
                } else {
                        // Check for revision file
                        if (!FILE_READABLE($FQFN)) {
@@ -2589,62 +2603,83 @@ function getActualVersion ($type = 'Revision') {
                                // Revision file found
                                $ins_vers = explode("\n", READ_FILE($FQFN));
 
+                               // Get array for mapping information
+                               $mapper = array_flip(getSearchFor());
+                               //* DEBUG: */ print("<pre>".print_r($mapper, true).print_r($ins_vers, true)."</pre>");
+
                                // Is the content valid?
-                               if ((!is_array($ins_vers)) || (count($ins_vers) <= 0) || (!isset($ins_vers[$type])) || (trim($ins_vers[$type]) == '') || ($ins_vers[0]) == "new") {
+                               if ((!is_array($ins_vers)) || (count($ins_vers) <= 0) || (!isset($ins_vers[$mapper[$type]])) || (trim($ins_vers[$mapper[$type]]) == "") || ($ins_vers[0]) == "new") {
                                        // File needs update!
                                        $new = true;
                                } else {
-                                       // Revision-File has valid Data and isn't 'new' so return the Rev-Number
-                                       $ttype = array_search ($type,array_keys(getSearchFor()));
-                                       if ($ttype || $ttype != null) return trim($ins_vers[$ttype]);
-                                       else return false;
+                                       // Return found value
+                                       return trim($ins_vers[$mapper[$type]]);
                                }
                        }
                }
+
                // Has it been updated?
                if ($new === true)  {
                        WRITE_FILE($FQFN, implode("\n", getAkt_vers()));
-               }
+               } // END - if
        }
 }
 
+// Repares an array we are looking for
 function getSearchFor () {
-       $searchFor[] = 'Revision';
-       $searchFor[] = 'Date';
-       $searchFor[] = 'Tag';
-       $searchFor[] = 'Author';
+       // Add Revision, Date, Tag and Author
+       $searchFor = array('Revision', 'Date', 'Tag', 'Author');
 
+       // Return the created array
        return $searchFor;
 }
 
 function getAkt_vers () {
-       $next_dir = '.';
-       $last_changed['path_name'] = '';
-       $last_changed['time'] = 0;
+       // Init variables
+       $next_dir = "";
+       $last_changed = array(
+               'path_name' => "",
+               'time'      => 0
+       );
        $akt_vers = array();
-       searchDirsRecoursive($next_dir, $last_changed); //Searches all Files and there date of the last modifikation and puts the newest File in $last_changed.
+       $res = 0;
+
+       // Searches all Files and there date of the last modifikation and puts the newest File in $last_changed.
+       searchDirsRecursive($next_dir, $last_changed);
+
+       // Get file
        $last_file = READ_FILE($last_changed['path_name']);
-       $ergeb = 0;
        $searchFor = getSearchFor();
 
+       // @TODO What does this loop/regex do? Document it, please.
        foreach ($searchFor as $search) {
-               $ergeb += preg_match('@\$'.$search.'(:|::) (.*) \$@U', $last_file, $t);
+               $res += preg_match('@\$'.$search.'(:|::) (.*) \$@U', $last_file, $t);
                if (isset($t[2])) $akt_vers[$search] = trim($t[2]);
-       }
+       } // END - foreach
 
-       if ($ergeb && $ergeb >= 3) {
+       if ($res && $res >= 3) {
                // Prepare content
-               preg_match('@(....)-(..)-(..) (..):(..):(..)@',$akt_vers['Date'],$match_d);
-               $akt_vers['Date'] = mktime($match_d[4],$match_d[5],$match_d[6],$match_d[2],$match_d[3],$match_d[1]);
-               if (isset($akt_vers['Author']) && $akt_vers['Author'] != 'quix0r') $akt_vers['Tag'] .= '-'.strtoupper($akt_vers['Author']);
+               preg_match('@(....)-(..)-(..) (..):(..):(..)@', $akt_vers['Date'], $match_d);
+
+               // Prepare timestamp for date
+               $akt_vers['Date'] = mktime($match_d[4], $match_d[5], $match_d[6], $match_d[2], $match_d[3], $match_d[1]);
+
+               // Add Tag if the author is set and is not quix0r (lead coder)
+               if ((isset($akt_vers['Author'])) && ($akt_vers['Author'] != "quix0r")) {
+                       $akt_vers['Tag'] .= '-'.strtoupper($akt_vers['Author']);
+               } // END - if
        } else {
-               // no valid Data from the last modificated file so read the Revision from the Server. FallbackSolution!! Could be removed I think.
+               // No valid Data from the last modificated file so read the Revision from the Server. Fallback-solution!! Could be removed I think.
                $version = GET_URL("check-updates3.php");
+
                // Prepare content
                $akt_vers['Revision'] = trim($version[10]);
-               $akt_vers['Date'] = trim($version[9]);
-               $akt_vers['Tag'] = trim($version[8]);
+               $akt_vers['Date']     = trim($version[9]);
+               $akt_vers['Tag']      = trim($version[8]);
+               $akt_vers['Author']   = "quix0r";
        }
+
+       // Return prepared array
        return $akt_vers;
 }
 
@@ -2714,11 +2749,12 @@ function debug_report_bug ($message = "") {
        } // END - if
 
        // Add output
-       $debug .= ("Please report this error at <a href=\"http://bugs.mxchange.org\" rel=\"external\" target=\"_blank\">bugs.mxchange.org</a>:<pre>");
-       $debug .= (debug_get_printable_backtrace());
-       $debug .= ("</pre>Thank you for your help finding bugs.");
+       $debug .= "Please report this error at <a href=\"http://bugs.mxchange.org\" rel=\"external\" target=\"_blank\">bugs.mxchange.org</a>:<pre>";
+       $debug .= debug_get_printable_backtrace();
+       $debug .= "</pre>Thank you for finding bugs.";
 
        // And abort here
+       // @TODO This cannot be rewritten to mxchange_die(), try to find a solution for this.
        die($debug);
 }
 
@@ -2760,7 +2796,15 @@ function convertCodeToMessage ($code) {
                case getCode('COOKIES_DISABLED') : $msg = getMessage('LOGIN_NO_COOKIES'); break;
                case getCode('BEG_SAME_AS_OWN')  : $msg = getMessage('BEG_SAME_UID_AS_OWN'); break;
                case getCode('LOGIN_FAILED')     : $msg = getMessage('LOGIN_FAILED_GENERAL'); break;
-               default                                : $msg = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code); break;
+               case getCode('MODULE_MEM_ONLY')  : $msg = sprintf(getMessage('MODULE_MEM_ONLY'), REQUEST_GET('mod')); break;
+
+               default:
+                       // Missing/invalid code
+                       $msg = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code);
+
+                       // Log it
+                       DEBUG_LOG(__FUNCTION__, __LINE__, $msg);
+                       break;
        } // END - switch
 
        // Return the message
@@ -3039,6 +3083,9 @@ function merge_array ($array1, $array2) {
 function DEBUG_LOG ($funcFile, $line, $message, $force=true) {
        // Is debug mode enabled?
        if ((isDebugModeEnabled()) || ($force === true)) {
+               // Remove CRLF
+               $message = str_replace("\r", "", str_replace("\n", "", $message));
+
                // Log this message away
                $fp = fopen(constant('PATH')."inc/cache/debug.log", 'a') or mxchange_die("Cannot write logfile debug.log!");
                fwrite($fp, date("d.m.Y|H:i:s", time())."|".basename($funcFile)."|".$line."|".strip_tags($message)."\n");
@@ -3047,7 +3094,8 @@ function DEBUG_LOG ($funcFile, $line, $message, $force=true) {
 }
 
 // Reads a directory with PHP files in and gets only files back
-function GET_DIR_AS_ARRAY ($baseDir, $prefix) {
+function GET_DIR_AS_ARRAY ($baseDir, $prefix, $includeDirs = false, $addBaseDir = true) {
+       // Init includes
        $INCs = array();
 
        // Open directory
@@ -3055,13 +3103,13 @@ function GET_DIR_AS_ARRAY ($baseDir, $prefix) {
 
        // Read all entries
        while ($baseFile = readdir($dirPointer)) {
-               // Load file only if extension is active
-               $INC = $baseDir.$baseFile;
+               // Construct include filename and FQFN
+               $INC = $baseDir . "/" . $baseFile;
                $FQFN = constant('PATH') . $INC;
 
                // Is this a valid reset file?
                //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}<br />\n";
-               if ((FILE_READABLE($FQFN)) && (substr($baseFile, 0, strlen($prefix)) == $prefix) && (substr($baseFile, -4, 4) == ".php")) {
+               if (((FILE_READABLE($FQFN)) && (substr($baseFile, 0, strlen($prefix)) == $prefix) && (substr($baseFile, -4, 4) == ".php")) || (($includeDirs) && (isDirectory($FQFN)))) {
                        // Remove both for extension name
                        $extName = substr($baseFile, strlen($prefix), -4);
 
@@ -3071,10 +3119,16 @@ function GET_DIR_AS_ARRAY ($baseDir, $prefix) {
                        // Is the extension valid and active?
                        if (($extId > 0) && (EXT_IS_ACTIVE($extName))) {
                                // Then add this file
+                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): Extension entry ".$baseFile." added.<br />\n";
                                $INCs[] = $INC;
                        } elseif ($extId == 0) {
                                // Add non-extension files as well
-                               $INCs[] = $INC;
+                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): Regular entry ".$baseFile." added.<br />\n";
+                               if ($addBaseDir) {
+                                       $INCs[] = $INC;
+                               } else {
+                                       $INCs[] = $baseFile;
+                               }
                        }
                } // END - if
        } // END - while
@@ -3098,7 +3152,7 @@ function runResetIncludes () {
        } // END - if
 
        // Get more daily reset scripts
-       $INC_POOL = GET_DIR_AS_ARRAY("inc/reset/", "reset_");
+       SET_INC_POOL(GET_DIR_AS_ARRAY("inc/reset/", "reset_"));
 
        // Update database
        if (!defined('DEBUG_RESET')) UPDATE_CONFIG("last_update", time());
@@ -3111,7 +3165,7 @@ function runResetIncludes () {
                // Has it changed?
                if (getConfig('last_week') != $currWeek) {
                        // Include weekly reset scripts
-                       $INC_POOL = merge_array($INC_POOL, GET_DIR_AS_ARRAY("inc/weekly/", "weekly_"));
+                       MERGE_INC_POOL(GET_DIR_AS_ARRAY("inc/weekly/", "weekly_"));
 
                        // Update config
                        if (!defined('DEBUG_WEEKLY')) UPDATE_CONFIG("last_week", $currWeek);
@@ -3123,7 +3177,7 @@ function runResetIncludes () {
                // Has it changed?
                if (getConfig('last_month') != $currMonth) {
                        // Include monthly reset scripts
-                       $INC_POOL = merge_array($INC_POOL, GET_DIR_AS_ARRAY("inc/monthly/", "monthly_"));
+                       MERGE_INC_POOL(GET_DIR_AS_ARRAY("inc/monthly/", "monthly_"));
 
                        // Update config
                        if (!defined('DEBUG_MONTHLY')) UPDATE_CONFIG("last_month", $currMonth);
@@ -3131,7 +3185,7 @@ function runResetIncludes () {
        } // END - if
 
        // Run the filter
-       runFilterChain('load_includes', $INC_POOL);
+       runFilterChain('load_includes');
 }
 
 // Handle extra values
@@ -3421,10 +3475,8 @@ function ADD_NEW_BONUS_MAIL ($data, $mode="", $output=true) {
 
 // Determines referal id and sets it
 function DETERMINE_REFID () {
-       global $CLICK, $_SERVER;
-
        // Check if refid is set
-       if ((!empty($_GET['user'])) && ($CLICK == 1) && (basename($_SERVER['PHP_SELF']) == "click.php")) {
+       if ((!empty($_GET['user'])) && (basename($_SERVER['PHP_SELF']) == "click.php")) {
                // The variable user comes from the click-counter script click.php and we only accept this here
                $GLOBALS['refid'] = bigintval($_GET['user']);
        } elseif (!empty($_POST['refid'])) {
@@ -3512,7 +3564,7 @@ function shutdown () {
        if (SQL_IS_LINK_UP()) {
                // Close link
                SQL_CLOSE(__FILE__, __LINE__);
-       } elseif (!isInstalling()) {
+       } elseif ((!isInstalling()) && (isInstalled())) {
                // No database link
                addFatalMessage(__FILE__, __LINE__, getMessage('NO_DB_LINK_SHUTDOWN'));
        }
@@ -3546,6 +3598,80 @@ function isUserIdSet () {
        return (isset($GLOBALS['userid']));
 }
 
+// Checks wether the given FQFN is a directory and not .,.. or .svn
+function isDirectory ($FQFN) {
+       // Generate baseName
+       $baseName = basename($FQFN);
+
+       // Check it
+       $isDirectory = ((is_dir($FQFN)) && ($baseName != ".") && ($baseName != "..") && ($baseName != ".svn"));
+
+       // Return the result
+       return $isDirectory;
+}
+
+// Init INC_POOL
+function INIT_INC_POOL () {
+       $GLOBALS['inc_pool'] = array();
+}
+
+// Setter for INC_POOL
+function SET_INC_POOL ($includePool) {
+       $GLOBALS['inc_pool'] = (array) $includePool;
+}
+
+// Getter for INC_POOL
+function GET_INC_POOL () {
+       return $GLOBALS['inc_pool'];
+}
+
+// Count INC_POOL
+function COUNT_INC_POOL () {
+       return count($GLOBALS['inc_pool']);
+}
+
+// Merge INC_POOL into given
+function MERGE_INC_POOL ($includePool) {
+       SET_INC_POOL(merge_array(GET_INC_POOL(), $includePool));
+}
+
+// Add single include file to INC_POOL
+function ADD_INC_TO_POOL ($INC) {
+       $GLOBALS['inc_pool'][] = (string) $INC;
+}
+
+// Remove an include file from INC_POOL
+function REMOVE_INC_FROM_POOL ($INC) {
+       // First look it up
+       $key = array_search($INC, GET_INC_POOL());
+
+       // Is it valid?
+       if ($key !== false) {
+               // Then remove it
+               unset($GLOBALS['inc_pool'][$key]);
+
+               // And sort the list
+               asort($GLOBALS['inc_pool']);
+       } // END - if
+}
+
+// Handle message codes from URL
+function handleCodeMessage () {
+       if (REQUEST_ISSET_GET(('msg'))) {
+               // Default extension is "unknown"
+               $ext = "unknown";
+
+               // Is extension given?
+               if (REQUEST_ISSET_GET(('ext'))) $ext = REQUEST_GET(('ext'));
+
+               // Convert the 'msg' parameter from URL to a human-readable message
+               $msg = convertCodeToMessage(REQUEST_GET('msg'));
+
+               // Load message template
+               LOAD_TEMPLATE("message", false, $msg);
+       } // END - if
+}
+
 //////////////////////////////////////////////////
 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
 //////////////////////////////////////////////////