Extend sm_print_r so you can do:
[squirrelmail.git] / functions / strings.php
index 6b6c4a74eb36f39c2fc52e32c1869cb733018c2d..af51b98745589b3c43d8acdae6e71520e65012ce 100644 (file)
@@ -3,7 +3,7 @@
 /** 
  * strings.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This code provides various string manipulation functions that are
  * $Id$
  */
 
+
 /**
  * SquirrelMail version number -- DO NOT CHANGE
  */
 global $version;
-$version = '1.3.2 [CVS-DEVEL]';
+$version = '1.5.0 [CVS]';
+
+/** 
+ * SquirrelMail internal version number -- DO NOT CHANGE
+ * $sm_internal_version = array (release, major, minor)
+ */
+global $SQM_INTERNAL_VERSION;
+$SQM_INTERNAL_VERSION = array(1,5,0);
+
+
+/**
+ * There can be a circular issue with includes, where the $version string is
+ * referenced by the include of global.php, etc. before it's defined.
+ * For that reason, bring in global.php AFTER we define the version strings.
+ */
+require_once(SM_PATH . 'functions/global.php');
 
 /**
  * Wraps text at $wrap characters
@@ -28,6 +44,16 @@ $version = '1.3.2 [CVS-DEVEL]';
  * This should not add newlines to the end of lines.
  */
 function sqWordWrap(&$line, $wrap) {
+    global $languages, $squirrelmail_language;
+
+    if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
+        function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
+        if (mb_detect_encoding($line) != 'ASCII') {
+            $line = $languages[$squirrelmail_language]['XTRA_CODE']('wordwrap', $line, $wrap);
+            return;
+        }
+    }
+
     ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
     $beginning_spaces = $regs[1];
     if (isset($regs[2])) {
@@ -73,6 +99,12 @@ function sqWordWrap(&$line, $wrap) {
  * Does the opposite of sqWordWrap()
  */
 function sqUnWordWrap(&$body) {
+    global $squirrelmail_language;
+    
+    if ($squirrelmail_language == 'ja_JP') {
+        return;
+    }
+
     $lines = explode("\n", $body);
     $body = '';
     $PreviousSpaces = '';
@@ -82,7 +114,9 @@ function sqUnWordWrap(&$body) {
         $CurrentSpaces = $regs[1];
         if (isset($regs[2])) {
             $CurrentRest = $regs[2];
-        }
+        } else {
+           $CurrentRest = '';
+       }
         
         if ($i == 0) {
             $PreviousSpaces = $CurrentSpaces;
@@ -117,57 +151,16 @@ function readShortMailboxName($haystack, $needle) {
     return( $elem );
 }
 
-/**
- * Returns an array of email addresses.
- * Be cautious of "user@host.com"
- */
-function parseAddrs($text) {
-    if (trim($text) == '')
-        return array();
-    $text = str_replace(' ', '', $text);
-    $text = ereg_replace('"[^"]*"', '', $text);
-    $text = ereg_replace('\\([^\\)]*\\)', '', $text);
-    $text = str_replace(',', ';', $text);
-    $array = explode(';', $text);
-    for ($i = 0; $i < count ($array); $i++) {
-        $array[$i] = eregi_replace ('^.*[<]', '', $array[$i]);
-        $array[$i] = eregi_replace ('[>].*$', '', $array[$i]);
-    }
-    return $array;
-}
-
-/**
- * Returns a line of comma separated email addresses from an array.
- */
-function getLineOfAddrs($array) {
-    if (is_array($array)) {
-        $to_line = implode(', ', $array);
-        $to_line = ereg_replace(', (, )+', ', ', $to_line);
-        $to_line = trim(ereg_replace('^, ', '', $to_line));
-        if( substr( $to_line, -1 ) == ',' )
-            $to_line = substr( $to_line, 0, -1 );
-    } else {
-        $to_line = '';
-    }
-    
-    return( $to_line );
-}
-
 function php_self () {
-    global $PHP_SELF, $HTTP_SERVER_VARS;
-    
-    if (isset($HTTP_SERVER_VARS['REQUEST_URI']) && !empty($HTTP_SERVER_VARS['REQUEST_URI']) ) {
-        return $HTTP_SERVER_VARS['REQUEST_URI'];
-    }
-
-    if (isset($PHP_SELF) && !empty($PHP_SELF)) {
-        return $PHP_SELF;
-    } else if (isset($HTTP_SERVER_VARS['PHP_SELF']) &&
-               !empty($HTTP_SERVER_VARS['PHP_SELF'])) {
-        return $HTTP_SERVER_VARS['PHP_SELF'];
-    } else {
-        return '';
+    if ( sqgetGlobalVar('REQUEST_URI', $req_uri, SQ_SERVER) && !empty($req_uri) ) {
+      return $req_uri;
     }
+    
+    if ( sqgetGlobalVar('PHP_SELF', $php_self, SQ_SERVER) && !empty($php_self) ) {
+      return $php_self;
+    }  
+    return '';
 }
 
 
@@ -182,46 +175,43 @@ function php_self () {
  */
 function get_location () {
     
-    global $PHP_SELF, $SERVER_NAME, $HTTP_HOST, $SERVER_PORT,
-        $HTTP_SERVER_VARS, $imap_server_type;
-    
+    global $imap_server_type;
+
     /* Get the path, handle virtual directories */
     $path = substr(php_self(), 0, strrpos(php_self(), '/'));
-    
+
+    if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) {
+      return $full_url . $path;
+    }
+
     /* Check if this is a HTTPS or regular HTTP request. */
     $proto = 'http://';
     
     /*
      * If you have 'SSLOptions +StdEnvVars' in your apache config
-     *     OR if you have HTTPS in your HTTP_SERVER_VARS
+     *     OR if you have HTTPS=on in your HTTP_SERVER_VARS
      *     OR if you are on port 443
      */
     $getEnvVar = getenv('HTTPS');
     if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
-        (isset($HTTP_SERVER_VARS['HTTPS'])) ||
-        (isset($HTTP_SERVER_VARS['SERVER_PORT']) &&
-         $HTTP_SERVER_VARS['SERVER_PORT'] == 443)) {
+        (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && !strcasecmp($https_on, 'on')) ||
+        (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) &&  $server_port == 443)) {
         $proto = 'https://';
     }
     
     /* Get the hostname from the Host header or server config. */
-    $host = '';
-    if (isset($HTTP_HOST) && !empty($HTTP_HOST)) {
-        $host = $HTTP_HOST;
-    } else if (isset($SERVER_NAME) && !empty($SERVER_NAME)) {
-        $host = $SERVER_NAME;
-    } else if (isset($HTTP_SERVER_VARS['SERVER_NAME']) &&
-               !empty($HTTP_SERVER_VARS['SERVER_NAME'])) {
-        $host = $HTTP_SERVER_VARS['SERVER_NAME'];
+    if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) {
+      if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) {
+        $host = '';
+      }
     }
-
     
     $port = '';
     if (! strstr($host, ':')) {
-        if (isset($SERVER_PORT)) {
-            if (($SERVER_PORT != 80 && $proto == 'http://')
-                || ($SERVER_PORT != 443 && $proto == 'https://')) {
-                $port = sprintf(':%d', $SERVER_PORT);
+        if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
+            if (($server_port != 80 && $proto == 'http://') || 
+                ($server_port != 443 && $proto == 'https://')) {
+                $port = sprintf(':%d', $server_port);
             }
         }
     }
@@ -234,9 +224,11 @@ function get_location () {
         $port = '';
    }
    
-    /* Fallback is to omit the server name and use a relative */
-    /* URI, although this is not RFC 2616 compliant.          */
-    return ($host ? $proto . $host . $port . $path : $path);
+   /* Fallback is to omit the server name and use a relative */
+   /* URI, although this is not RFC 2616 compliant.          */
+   $full_url = ($host ? $proto . $host . $port : '');
+   sqsession_register($full_url, 'sq_base_url');
+   return $full_url . $path;
 }
 
 
@@ -277,24 +269,7 @@ function sq_mt_seed($Val) {
     $Max = mt_getrandmax();
     
     if (! is_int($Val)) {
-        if (function_exists('crc32')) {
             $Val = crc32($Val);
-        } else {
-            $Str = $Val;
-            $Pos = 0;
-            $Val = 0;
-            $Mask = $Max / 2;
-            $HighBit = $Max ^ $Mask;
-            while ($Pos < strlen($Str)) {
-                if ($Val & $HighBit) {
-                    $Val = (($Val & $Mask) << 1) + 1;
-                } else {
-                    $Val = ($Val & $Mask) << 1;
-                }
-                $Val ^= $Str[$Pos];
-                $Pos ++;
-            }
-        }
     }
     
     if ($Val < 0) {
@@ -315,7 +290,6 @@ function sq_mt_seed($Val) {
  * the same 'random' numbers twice in one session.
  */
 function sq_mt_randomize() {
-    global $REMOTE_PORT, $REMOTE_ADDR, $UNIQUE_ID;
     static $randomized;
     
     if ($randomized) {
@@ -323,8 +297,10 @@ function sq_mt_randomize() {
     }
     
     /* Global. */
+    sqgetGlobalVar('REMOTE_PORT', $remote_port, SQ_SERVER);
+    sqgetGlobalVar('REMOTE_ADDR', $remote_addr, SQ_SERVER);
     sq_mt_seed((int)((double) microtime() * 1000000));
-    sq_mt_seed(md5($REMOTE_PORT . $REMOTE_ADDR . getmypid()));
+    sq_mt_seed(md5($remote_port . $remote_addr . getmypid()));
     
     /* getrusage */
     if (function_exists('getrusage')) {
@@ -340,8 +316,9 @@ function sq_mt_randomize() {
         }
     }
     
-    /* Apache-specific */
-    sq_mt_seed(md5($UNIQUE_ID));
+    if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) {
+        sq_mt_seed(md5($unique_id));
+    }
     
     $randomized = 1;
 }
@@ -357,56 +334,6 @@ function OneTimePadCreate ($length=100) {
     return base64_encode($pad);
 }
 
-/**
- * Check if we have a required PHP-version. Return TRUE if we do,
- * or FALSE if we don't.
- *
- *     To check for 4.0.1, use sqCheckPHPVersion(4,0,1)
- *     To check for 4.0b3, use sqCheckPHPVersion(4,0,-3)
- *
- * Does not handle betas like 4.0.1b1 or development versions
- */
-function sqCheckPHPVersion($major, $minor, $release) {
-    
-    $ver = phpversion();
-    eregi('^([0-9]+)\\.([0-9]+)(.*)', $ver, $regs);
-    
-    /* Parse the version string. */
-    $vmajor  = strval($regs[1]);
-    $vminor  = strval($regs[2]);
-    $vrel    = $regs[3];
-    if($vrel[0] == '.') {
-        $vrel = strval(substr($vrel, 1));
-    }
-    if($vrel[0] == 'b' || $vrel[0] == 'B') {
-        $vrel = - strval(substr($vrel, 1));
-    }
-    if($vrel[0] == 'r' || $vrel[0] == 'R') {
-        $vrel = - strval(substr($vrel, 2))/10;
-    }
-    
-    /* Compare major version. */
-    if ($vmajor < $major) { return false; }
-    if ($vmajor > $major) { return true; }
-    
-    /* Major is the same. Compare minor. */
-    if ($vminor < $minor) { return false; }
-    if ($vminor > $minor) { return true; }
-    
-    /* Major and minor is the same as the required one. Compare release */
-    if ($vrel >= 0 && $release >= 0) {       /* Neither are beta */
-        if($vrel < $release) return false;
-    } else if($vrel >= 0 && $release < 0) {  /* This is not beta, required is beta */
-        return true;
-    } else if($vrel < 0 && $release >= 0){   /* This is beta, require not beta */
-        return false;
-    } else {                                 /* Both are beta */
-        if($vrel > $release) return false;
-    }
-    
-    return true;
-}
-
 /**
  *  Returns a string showing the size of the message/attachment.
  */
@@ -416,7 +343,7 @@ function show_readable_size($bytes) {
     
     if ($bytes / 1024 > 1) {
         $bytes /= 1024;
-        $type = 'm';
+        $type = 'M';
     }
     
     if ($bytes < 10) {
@@ -465,7 +392,7 @@ function GenerateRandomString($size, $chars, $flags = 0) {
     return $String;
 }
 
-function quoteIMAP($str) {
+function quoteimap($str) {
     return ereg_replace('(["\\])', '\\\\1', $str);
 }
 
@@ -488,24 +415,47 @@ function TrimArray(&$array) {
     }
 }   
 
-/**
- * Removes slashes from every element in the array
- */
-function RemoveSlashes(&$array) {
-    foreach ($array as $k => $v) {
-        global $$k;
-        if (is_array($$k)) {
-            foreach ($$k as $k2 => $v2) {
-                $newArray[stripslashes($k2)] = stripslashes($v2);
-            }
-            $$k = $newArray;
-        } else {
-            $$k = stripslashes($v);
-        }
-        
-        /* Re-assign back to the array. */
-        $array[$k] = $$k;
+/* returns a link to the compose-page, taking in consideration
+ * the compose_in_new and javascript settings. */
+function makeComposeLink($url, $text = null)
+{
+    global $compose_new_win,$javascript_on;
+
+    if(!$text) {
+        $text = _("Compose");
+    }
+
+    if($compose_new_win != '1') {
+        return makeInternalLink($url, $text, 'right');
+    }
+
+    /* if we can use JS, use the fancy window, else just open a new one HTML-style */
+    if($javascript_on) {
+        sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
+        return '<a href="javascript:void(0)" onclick="comp_in_new(\''.$base_uri.$url.'\')">'. $text.'</a>';
     }
+
+    return makeInternalLink($url, $text, '_blank');
+}
+
+/** 
+* sm_print_r($some_variable, [$some_other_variable [, ...]]);
+* Debugging function - does the same as print_r, but makes sure special
+* characters are converted to htmlentities first.  This will allow
+* values like <some@email.address> to be displayed.
+* The output is wrapped in <pre> and </pre> tags.
+*/
+function sm_print_r() {
+    ob_start();  // Buffer output
+    foreach(func_get_args() as $var) {
+        print_r($var);
+        echo "\n";
+    }
+    $buffer = ob_get_contents(); // Grab the print_r output
+    ob_end_clean();  // Silently discard the output & stop buffering
+    print "<pre>";
+    print htmlentities($buffer);
+    print "</pre>";
 }
 
 $PHP_SELF = php_self();