using temporary array for sorting. linking with =& does not work
[squirrelmail.git] / functions / strings.php
index d4adfaa715b8b11ccdb4394cc4a93c52ef925bc6..9e137cab90a1ae271d4803faeb8dfe04cb127a3b 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 
-/** 
+/**
  * strings.php
  *
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * $Id$
  */
 
-require_once(SM_PATH . 'functions/global.php');
-
 /**
  * SquirrelMail version number -- DO NOT CHANGE
  */
 global $version;
-$version = '1.4.0 [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,4,0);
+$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
@@ -38,6 +42,16 @@ $SQM_INTERNAL_VERSION = array(1,4,0);
  * 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])) {
@@ -45,10 +59,10 @@ function sqWordWrap(&$line, $wrap) {
     } else {
         $words = '';
     }
-    
+
     $i = 0;
     $line = $beginning_spaces;
-    
+
     while ($i < count($words)) {
         /* Force one word to be on a line (minimum) */
         $line .= $words[$i];
@@ -56,7 +70,7 @@ function sqWordWrap(&$line, $wrap) {
         if (isset($words[$i + 1]))
             $line_len += strlen($words[$i + 1]);
         $i ++;
-        
+
         /* Add more words (as long as they fit) */
         while ($line_len < $wrap && $i < count($words)) {
             $line .= ' ' . $words[$i];
@@ -66,12 +80,12 @@ function sqWordWrap(&$line, $wrap) {
             else
                 $line_len += 1;
         }
-        
+
         /* Skip spaces if they are the first thing on a continued line */
         while (!isset($words[$i]) && $i < count($words)) {
             $i ++;
         }
-        
+
         /* Go to the next line if we have more to process */
         if ($i < count($words)) {
             $line .= "\n";
@@ -83,6 +97,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 = '';
@@ -93,9 +113,9 @@ function sqUnWordWrap(&$body) {
         if (isset($regs[2])) {
             $CurrentRest = $regs[2];
         } else {
-           $CurrentRest = '';
-       }
-        
+            $CurrentRest = '';
+        }
+
         if ($i == 0) {
             $PreviousSpaces = $CurrentSpaces;
             $body = $lines[$i];
@@ -120,60 +140,31 @@ function readShortMailboxName($haystack, $needle) {
     if ($needle == '') {
         $elem = $haystack;
     } else {
-           $parts = explode($needle, $haystack);
-           $elem = array_pop($parts);
-           while ($elem == '' && count($parts)) {
-               $elem = array_pop($parts);
-           }
+        $parts = explode($needle, $haystack);
+        $elem = array_pop($parts);
+        while ($elem == '' && count($parts)) {
+            $elem = array_pop($parts);
+        }
     }
     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 () {
     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) ) {
+
+      // need to add query string to end of PHP_SELF to match REQUEST_URI
+      //
+      if ( sqgetGlobalVar('QUERY_STRING', $query_string, SQ_SERVER) && !empty($query_string) ) {
+         $php_self .= '?' . $query_string;
+      }
+
       return $php_self;
-    }  
+    }
+
     return '';
 }
 
@@ -188,15 +179,23 @@ function php_self () {
  *   http://www.myhost.com/squirrelmail/src/login.php
  */
 function get_location () {
-    
+
     global $imap_server_type;
-    
+
     /* Get the path, handle virtual directories */
-    $path = substr(php_self(), 0, strrpos(php_self(), '/'));
-    
+    if(strpos(php_self(), '?')) {
+        $path = substr(php_self(), 0, strpos(php_self(), '?'));
+    } else {
+        $path = php_self();
+    }
+    $path = substr($path, 0, strrpos($path, '/'));
+    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=on in your HTTP_SERVER_VARS
@@ -208,35 +207,37 @@ function get_location () {
         (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) &&  $server_port == 443)) {
         $proto = 'https://';
     }
-    
+
     /* Get the hostname from the Host header or server config. */
     if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) {
       if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) {
         $host = '';
       }
     }
-    
+
     $port = '';
     if (! strstr($host, ':')) {
         if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
-            if (($server_port != 80 && $proto == 'http://') || 
+            if (($server_port != 80 && $proto == 'http://') ||
                 ($server_port != 443 && $proto == 'https://')) {
                 $port = sprintf(':%d', $server_port);
             }
         }
     }
-    
+
    /* this is a workaround for the weird macosx caching that
       causes Apache to return 16080 as the port number, which causes
       SM to bail */
-      
+
    if ($imap_server_type == 'macosx' && $port == ':16080') {
         $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;
 }
 
 
@@ -250,7 +251,7 @@ function OneTimePadEncrypt ($string, $epad) {
     for ($i = 0; $i < strlen ($string); $i++) {
         $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
     }
-    
+
     return base64_encode($encrypted);
 }
 
@@ -261,7 +262,7 @@ function OneTimePadDecrypt ($string, $epad) {
     for ($i = 0; $i < strlen ($encrypted); $i++) {
         $decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i]));
     }
-    
+
     return $decrypted;
 }
 
@@ -275,19 +276,19 @@ function sq_mt_seed($Val) {
     /* if mt_getrandmax() does not return a 2^n - 1 number,
        this might not work well.  This uses $Max as a bitmask. */
     $Max = mt_getrandmax();
-    
+
     if (! is_int($Val)) {
             $Val = crc32($Val);
     }
-    
+
     if ($Val < 0) {
         $Val *= -1;
     }
-    
+
     if ($Val = 0) {
         return;
     }
-    
+
     mt_srand(($Val ^ mt_rand(0, $Max)) & $Max);
 }
 
@@ -299,17 +300,17 @@ function sq_mt_seed($Val) {
  */
 function sq_mt_randomize() {
     static $randomized;
-    
+
     if ($randomized) {
         return;
     }
-    
+
     /* 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()));
-    
+
     /* getrusage */
     if (function_exists('getrusage')) {
         /* Avoid warnings with Win32 */
@@ -323,22 +324,22 @@ function sq_mt_randomize() {
             sq_mt_seed(md5($Str));
         }
     }
-    
+
     if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) {
         sq_mt_seed(md5($unique_id));
     }
-    
+
     $randomized = 1;
 }
 
 function OneTimePadCreate ($length=100) {
     sq_mt_randomize();
-    
+
     $pad = '';
     for ($i = 0; $i < $length; $i++) {
         $pad .= chr(mt_rand(0,255));
     }
-    
+
     return base64_encode($pad);
 }
 
@@ -348,12 +349,12 @@ function OneTimePadCreate ($length=100) {
 function show_readable_size($bytes) {
     $bytes /= 1024;
     $type = 'k';
-    
+
     if ($bytes / 1024 > 1) {
         $bytes /= 1024;
         $type = 'M';
     }
-    
+
     if ($bytes < 10) {
         $bytes *= 10;
         settype($bytes, 'integer');
@@ -361,7 +362,7 @@ function show_readable_size($bytes) {
     } else {
         settype($bytes, 'integer');
     }
-    
+
     return $bytes . '<small>&nbsp;' . $type . '</small>';
 }
 
@@ -384,7 +385,7 @@ function GenerateRandomString($size, $chars, $flags = 0) {
     if ($flags & 0x4) {
         $chars .= '0123456789';
     }
-    
+
     if (($size < 1) || (strlen($chars) < 1)) {
         return '';
     }
@@ -400,7 +401,7 @@ function GenerateRandomString($size, $chars, $flags = 0) {
     return $String;
 }
 
-function quoteIMAP($str) {
+function quoteimap($str) {
     return ereg_replace('(["\\])', '\\\\1', $str);
 }
 
@@ -417,32 +418,71 @@ function TrimArray(&$array) {
         } else {
             $$k = substr($v, 1);
         }
-        
+
         /* Re-assign back to 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 not using "compose in new window", make 
+    // regular link and be done with it
+    //
+    if($compose_new_win != '1') {
+        return makeInternalLink($url, $text, 'right');
+    }
+
+
+    //
+    // build the compose in new window link...  
+    //
+
+
+    // if javascript is on, use onClick event to handle it
+    // 
+    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>';
+    }
+
+
+    // otherwise, just open new window using regular HTML
+    //
+    return makeInternalLink($url, $text, '_blank');
+
+}
 
 /**
- * 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;
+* 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();
-
 ?>