+// Back-ported from the new ship-simu engine. :-)
+function debug_get_printable_backtrace () {
+ // Init variable
+ $backtrace = "<ol>\n";
+
+ // Get and prepare backtrace for output
+ $backtraceArray = debug_backtrace();
+ foreach ($backtraceArray as $key => $trace) {
+ if (!isset($trace['file'])) $trace['file'] = __FILE__;
+ if (!isset($trace['line'])) $trace['line'] = __LINE__;
+ if (!isset($trace['args'])) $trace['args'] = array();
+ $backtrace .= "<li class=\"debug_list\"><span class=\"backtrace_file\">".basename($trace['file'])."</span>:".$trace['line'].", <span class=\"backtrace_function\">".$trace['function']."(".count($trace['args']).")</span></li>\n";
+ } // END - foreach
+
+ // Close it
+ $backtrace .= "</ol>\n";
+
+ // Return the backtrace
+ return $backtrace;
+}
+
+// Output a debug backtrace to the user
+function debug_report_bug ($message = "") {
+ // Init message
+ $debug = "";
+ // Is the optional message set?
+ if (!empty($message)) {
+ // Use and log it
+ $debug = sprintf("Note: %s<br />\n",
+ $message
+ );
+
+ // @TODO Add a little more infos here
+ DEBUG_LOG(__FUNCTION__, __LINE__, $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.");
+
+ // And abort here
+ die($debug);
+}
+
+// Generates a ***weak*** seed (taken from de.php.net/mt_srand)
+function generateSeed () {
+ list($usec, $sec) = explode(" ", microtime());
+ return ((float)$sec + (float)$usec);
+}
+
+// Converts a message code to a human-readable message
+function convertCodeToMessage ($code) {
+ $msg = "";
+ switch ($code) {
+ case constant('CODE_LOGOUT_DONE') : $msg = getMessage('LOGOUT_DONE'); break;
+ case constant('CODE_LOGOUT_FAILED') : $msg = "<span class=\"guest_failed\">{--LOGOUT_FAILED--}</span>"; break;
+ case constant('CODE_DATA_INVALID') : $msg = getMessage('MAIL_DATA_INVALID'); break;
+ case constant('CODE_POSSIBLE_INVALID') : $msg = getMessage('MAIL_POSSIBLE_INVALID'); break;
+ case constant('CODE_ACCOUNT_LOCKED') : $msg = getMessage('MEMBER_ACCOUNT_LOCKED_UNC'); break;
+ case constant('CODE_USER_404') : $msg = getMessage('USER_NOT_FOUND'); break;
+ case constant('CODE_STATS_404') : $msg = getMessage('MAIL_STATS_404'); break;
+ case constant('CODE_ALREADY_CONFIRMED'): $msg = getMessage('MAIL_ALREADY_CONFIRMED'); break;
+
+ case constant('CODE_ERROR_MAILID'):
+ if (EXT_IS_ACTIVE($ext, true)) {
+ $msg = getMessage('ERROR_CONFIRMING_MAIL');
+ } else {
+ $msg = sprintf(getMessage('EXTENSION_PROBLEM_NOT_INSTALLED'), "mailid");
+ }
+ break;
+
+ case constant('CODE_EXTENSION_PROBLEM'):
+ if (isset($_GET['ext'])) {
+ $msg = sprintf(getMessage('EXTENSION_PROBLEM_EXT_INACTIVE'), SQL_ESCAPE($_GET['ext']));
+ } else {
+ $msg = getMessage('EXTENSION_PROBLEM_UNSET_EXT');
+ }
+ break;
+
+ case constant('CODE_COOKIES_DISABLED') : $msg = getMessage('LOGIN_NO_COOKIES'); break;
+ case constant('CODE_BEG_SAME_AS_OWN') : $msg = getMessage('BEG_SAME_UID_AS_OWN'); break;
+ case constant('CODE_LOGIN_FAILED') : $msg = getMessage('LOGIN_FAILED_GENERAL'); break;
+ default : $msg = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code); break;
+ } // END - switch
+
+ // Return the message
+ return $msg;
+}
+
+// Checks wether the given extension is currently not installed
+// and redirects if so.
+function REDIRCT_ON_UNINSTALLED_EXTENSION ($ext_name) {
+ // Is the extension uninstalled/inactive?
+ if (!EXT_IS_ACTIVE($ext_name)) {
+ // Redirect to index
+ LOAD_URL("modules.php?module=index&msg=".constant('CODE_EXTENSION_PROBLEM')."&ext=".$ext_name);
+ } // END - if
+}
+
+// Generate a "link" for the given admin id (aid)
+function GENERATE_AID_LINK ($aid) {
+ // No assigned admin is default
+ $admin = "<div class=\"admin_note\">{--ADMIN_NO_ADMIN_ASSIGNED--}</div>";
+
+ // Zero? = Not assigned
+ if ($aid == "0") {
+ // Load admin's login
+ $login = GET_ADMIN_LOGIN($aid);
+ if ($login != "***") {
+ // Is the extension there?
+ if (EXT_IS_ACTIVE("admins")) {
+ // Admin found
+ $admin = "<a href=\"".ADMINS_CREATE_EMAIL_LINK(GET_ADMIN_EMAIL($aid))."\">".$login."</a>";
+ } else {
+ // Extension not found
+ $admin = sprintf(getMessage('EXTENSION_PROBLEM_NOT_INSTALLED'), "admins");
+ }
+ } else {
+ // Maybe deleted?
+ $admin = "<div class=\"admin_note\">".sprintf(getMessage('ADMIN_ID_404'), $aid)."</div>";
+ }
+ } // END - if
+
+ // Return result
+ return $admin;
+}
+
+// Checks wether an include file (non-FQFN better) is readable
+function INCLUDE_READABLE ($INC) {
+ // Construct FQFN
+ $FQFN = constant('PATH') . $INC;
+
+ // Is it readable?
+ return FILE_READABLE($FQFN);
+}
+
+// Encode strings
+// @TODO Implement $compress
+function encodeString ($str, $compress=true) {
+ $str = urlencode(base64_encode(compileUriCode($str)));
+ return $str;
+}
+
+// Decode strings encoded with encodeString()
+// @TODO Implement $decompress
+function decodeString ($str, $decompress=true) {
+ $str = compileUriCode(base64_decode(urldecode(compileUriCode($str))));
+ return $str;
+}
+
+// Compile characters which are allowed in URLs
+function compileUriCode ($code, $simple=true) {
+ // Compile constants
+ if (!$simple) $code = str_replace("{--", '".', str_replace("--}", '."', $code));
+
+ // Compile QUOT and other non-HTML codes
+ $code = str_replace("{DOT}", ".",
+ str_replace("{SLASH}", "/",
+ str_replace("{QUOT}", "'",
+ str_replace("{DOLLAR}", "$",
+ str_replace("{OPEN_ANCHOR}", "(",
+ str_replace("{CLOSE_ANCHOR}", ")",
+ str_replace("{OPEN_SQR}", "[",
+ str_replace("{CLOSE_SQR}", "]",
+ str_replace("{PER}", "%",
+ $code
+ )))))))));
+
+ // Return compiled code
+ return $code;
+}
+
+// Function taken from user comments on www.php.net / function eregi()
+function isUrlValid ($url) {
+ // Prepare URL
+ $url = strip_tags(str_replace("\\", "", compileUriCode(urldecode($url))));
+
+ // Allows http and https
+ $http = "(http|https)+(:\/\/)";
+ // Test domain
+ $domain1 = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
+ // Test double-domains (e.g. .de.vu)
+ $domain2 = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
+ // Test IP number
+ $ip = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
+ // ... directory
+ $dir = "((/)+([-_\.[:alnum:]])+)*";
+ // ... page
+ $page = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
+ // ... and the string after and including question character
+ $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
+ // Pattern for URLs like http://url/dir/doc.html?var=value
+ $pattern['d1dpg1'] = $http.$domain1.$dir.$page.$getstring1;
+ $pattern['d2dpg1'] = $http.$domain2.$dir.$page.$getstring1;
+ $pattern['ipdpg1'] = $http.$ip.$dir.$page.$getstring1;
+ // Pattern for URLs like http://url/dir/?var=value
+ $pattern['d1dg1'] = $http.$domain1.$dir."/".$getstring1;
+ $pattern['d2dg1'] = $http.$domain2.$dir."/".$getstring1;
+ $pattern['ipdg1'] = $http.$ip.$dir."/".$getstring1;
+ // Pattern for URLs like http://url/dir/page.ext
+ $pattern['d1dp'] = $http.$domain1.$dir.$page;
+ $pattern['d1dp'] = $http.$domain2.$dir.$page;
+ $pattern['ipdp'] = $http.$ip.$dir.$page;
+ // Pattern for URLs like http://url/dir
+ $pattern['d1d'] = $http.$domain1.$dir;
+ $pattern['d2d'] = $http.$domain2.$dir;
+ $pattern['ipd'] = $http.$ip.$dir;
+ // Pattern for URLs like http://url/?var=value
+ $pattern['d1g1'] = $http.$domain1."/".$getstring1;
+ $pattern['d2g1'] = $http.$domain2."/".$getstring1;
+ $pattern['ipg1'] = $http.$ip."/".$getstring1;
+ // Pattern for URLs like http://url?var=value
+ $pattern['d1g12'] = $http.$domain1.$getstring1;
+ $pattern['d2g12'] = $http.$domain2.$getstring1;
+ $pattern['ipg12'] = $http.$ip.$getstring1;
+ // Test all patterns
+ $reg = false;
+ foreach ($pattern as $key=>$pat) {
+ // Debug regex?
+ if (defined('DEBUG_REGEX')) {
+ $pat = str_replace("[:alnum:]", "0-9a-zA-Z", $pat);
+ $pat = str_replace("[:alpha:]", "a-zA-Z", $pat);
+ $pat = str_replace("[:digit:]", "0-9", $pat);
+ $pat = str_replace(".", "\.", $pat);
+ $pat = str_replace("@", "\@", $pat);
+ echo $key."= ".$pat."<br />";
+ }
+
+ // Check if expression matches
+ $reg = ($reg || preg_match(("^".$pat."^"), $url));
+
+ // Does it match?
+ if ($reg === true) break;
+ }
+
+ // Return true/false
+ return $reg;
+}
+
+// Smartly adds slashes
+function smartAddSlashes ($unquoted) {
+ $unquoted = str_replace("\\", "", $unquoted);
+ return addslashes($unquoted);
+}
+
+// Decode entities in a nicer way
+function decodeEntities ($str) {
+ // @TODO We may want to switch over to UTF-8 here!
+ $decodedString = html_entity_decode($str, ENT_NOQUOTES, "ISO-8859-15");
+
+ // Return decoded string
+ return $decodedString;
+}
+