Fix HTTPS detection under Windows IIS (#2318118)
[squirrelmail.git] / functions / strings.php
index b95ff5923e2671f73b407213cbfd1c768d291f79..1fcbd6dc9b7bfc5c8484e4d87f69cb12755f1fde 100644 (file)
@@ -6,7 +6,7 @@
  * This code provides various string manipulation functions that are
  * used by the rest of the SquirrelMail code.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -460,18 +460,18 @@ function readShortMailboxName($haystack, $needle) {
  *
  * Determines the location to forward to, relative to your server.
  * This is used in HTTP Location: redirects.
- * If this doesnt work correctly for you (although it should), you can
- * remove all this code except the last two lines, and have it return
- * the right URL for your site, something like:
  *
- *   http://www.example.com/squirrelmail/
+ * If set, it uses $config_location_base as the first part of the URL,
+ * specifically, the protocol, hostname and port parts. The path is
+ * always autodetected.
  *
  * @return string the base url for this SquirrelMail installation
  * @since 1.0
  */
 function get_location () {
 
-    global $imap_server_type;
+    global $imap_server_type, $config_location_base,
+           $is_secure_connection, $sq_ignore_http_x_forwarded_headers;
 
     /* Get the path, handle virtual directories */
     if(strpos(php_self(), '?')) {
@@ -480,27 +480,26 @@ function get_location () {
         $path = php_self();
     }
     $path = substr($path, 0, strrpos($path, '/'));
+
+    // proto+host+port are already set in config:
+    if ( !empty($config_location_base) ) {
+        return $config_location_base . $path ;
+    }
+    // we computed it before, get it from the session:
     if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) {
       return $full_url . $path;
     }
+    // else: autodetect
 
     /* 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
-     *     OR if you are on port 443
-     */
-    $getEnvVar = getenv('HTTPS');
-    if ((isset($getEnvVar) && strcasecmp($getEnvVar, 'on') === 0) ||
-        (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && strcasecmp($https_on, 'on') === 0) ||
-        (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) &&  $server_port == 443)) {
+    if ($is_secure_connection)
         $proto = 'https://';
-    }
 
     /* Get the hostname from the Host header or server config. */
-    if ( !sqgetGlobalVar('HTTP_X_FORWARDED_HOST', $host, SQ_SERVER) || empty($host) ) {
+    if ($sq_ignore_http_x_forwarded_headers
+     || !sqgetGlobalVar('HTTP_X_FORWARDED_HOST', $host, SQ_SERVER)
+     || empty($host)) {
         if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) {
             if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) {
                 $host = '';
@@ -512,25 +511,52 @@ function get_location () {
     if (! strstr($host, ':')) {
         if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
             if (($server_port != 80 && $proto == 'http://') ||
-                ($server_port != 443 && $proto == 'https://')) {
+                ($server_port != 443 && $proto == 'https://' &&
+                 strcasecmp($forwarded_proto, 'https') !== 0)) {
                 $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 */
+    /* 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') {
+    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.          */
+    $full_url = ($host ? $proto . $host . $port : '');
+    sqsession_register($full_url, 'sq_base_url');
+    return $full_url . $path;
+}
+
+
+/**
+ * Get Message List URI
+ *
+ * @param string $mailbox      Current mailbox name (unencoded/raw)
+ * @param string $startMessage The mailbox page offset
+ * @param string $what         Any current search parameters (OPTIONAL; 
+ *                             default empty string)
+ *
+ * @return string The message list URI
+ *
+ * @since 1.5.2
+ *
+ */
+function get_message_list_uri($mailbox, $startMessage, $what='') {
+
+    global $base_uri;
+
+    $urlMailbox = urlencode($mailbox);
 
-   /* 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;
+    $list_xtra = "?where=read_body.php&what=$what&mailbox=" . $urlMailbox.
+                 "&startMessage=$startMessage";
+
+    return $base_uri .'src/right_main.php'. $list_xtra;
 }
 
 
@@ -598,83 +624,6 @@ function OneTimePadDecrypt ($string, $epad) {
     return $decrypted;
 }
 
-
-/**
- * Randomizes the mt_rand() function.
- *
- * Toss this in strings or integers and it will seed the generator
- * appropriately. With strings, it is better to get them long.
- * Use md5() to lengthen smaller strings.
- *
- * @param mixed $val a value to seed the random number generator. mixed = integer or string.
- * @return void
- * @since 1.0
- */
-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);
-}
-
-
-/**
- * Init random number generator
- *
- * This function initializes the random number generator fairly well.
- * It also only initializes it once, so you don't accidentally get
- * the same 'random' numbers twice in one session.
- *
- * @return void
- * @since 1.0
- */
-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 */
-        $dat = @getrusage();
-        if (isset($dat) && is_array($dat)) {
-            $Str = '';
-            foreach ($dat as $k => $v)
-                {
-                    $Str .= $k . $v;
-                }
-            sq_mt_seed(md5($Str));
-        }
-    }
-
-    if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) {
-        sq_mt_seed(md5($unique_id));
-    }
-
-    $randomized = 1;
-}
-
 /**
  * Creates encryption key
  *
@@ -687,8 +636,6 @@ function sq_mt_randomize() {
  * @since 1.0
  */
 function OneTimePadCreate ($length=100) {
-    sq_mt_randomize();
-
     $pad = '';
     for ($i = 0; $i < $length; $i++) {
         $pad .= chr(mt_rand(0,255));
@@ -706,11 +653,11 @@ function OneTimePadCreate ($length=100) {
  */
 function show_readable_size($bytes) {
     $bytes /= 1024;
-    $type = 'k';
+    $type = _("KiB");
 
     if ($bytes / 1024 > 1) {
         $bytes /= 1024;
-        $type = 'M';
+        $type = _("MiB");
     }
 
     if ($bytes < 10) {
@@ -752,8 +699,6 @@ function GenerateRandomString($size, $chars, $flags = 0) {
         return '';
     }
 
-    sq_mt_randomize(); /* Initialize the random number generator */
-
     $String = '';
     $j = strlen( $chars ) - 1;
     while (strlen($String) < $size) {
@@ -774,29 +719,6 @@ function quoteimap($str) {
     return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
 }
 
-/**
- * Trims array
- *
- * Trims every element in the array, ie. remove the first char of each element
- * @param array $array the array to trim
- * @since 1.2.0
- */
-function TrimArray(&$array) {
-    foreach ($array as $k => $v) {
-        global $$k;
-        if (is_array($$k)) {
-            foreach ($$k as $k2 => $v2) {
-                $$k[$k2] = substr($v2, 1);
-            }
-        } else {
-            $$k = substr($v, 1);
-        }
-
-        /* Re-assign back to array. */
-        $array[$k] = $$k;
-    }
-}
-
 /**
  * Create compose link
  *
@@ -809,7 +731,8 @@ function TrimArray(&$array) {
  * @since 1.4.2
  */
 function makeComposeLink($url, $text = null, $target='') {
-    global $compose_new_win,$javascript_on, $compose_width, $compose_height;
+    global $compose_new_win, $compose_width, 
+           $compose_height, $oTemplate;
 
     if(!$text) {
         $text = _("Compose");
@@ -825,55 +748,17 @@ function makeComposeLink($url, $text = null, $target='') {
 
 
     // if javascript is on, use onclick event to handle it
-    if($javascript_on) {
+    if(checkForJavascript()) {
         sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
         $compuri = SM_BASE_URI.$url;
-        return "<a href=\"javascript:void(0)\" onclick=\"comp_in_new('$compuri','$compose_width','$compose_height')\">$text</a>";
+
+        return create_hyperlink('javascript:void(0)', $text, '', "comp_in_new('$compuri','$compose_width','$compose_height')");
     }
 
     // otherwise, just open new window using regular HTML
     return makeInternalLink($url, $text, '_blank');
 }
 
-/**
- * Print variable
- *
- * 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.
- * Since 1.4.2 accepts unlimited number of arguments.
- * @since 1.4.1
- * @return void
- */
-function sm_print_r() {
-    ob_start();  // Buffer output
-    foreach(func_get_args() as $var) {
-        print_r($var);
-        echo "\n";
-        // php has get_class_methods function that can print class methods
-        if (is_object($var)) {
-            // get class methods if $var is object
-            $aMethods=get_class_methods(get_class($var));
-            // make sure that $aMethods is array and array is not empty
-            if (is_array($aMethods) && $aMethods!=array()) {
-                echo "Object methods:\n";
-                foreach($aMethods as $method) {
-                    echo '* ' . $method . "\n";
-                }
-            }
-            echo "\n";
-        }
-    }
-    $buffer = ob_get_contents(); // Grab the print_r output
-    ob_end_clean();  // Silently discard the output & stop buffering
-    print '<div align="left"><pre>';
-    print htmlentities($buffer);
-    print '</pre></div>';
-}
-
 /**
  * version of fwrite which checks for failure
  * @param resource $fp
@@ -1192,15 +1077,32 @@ function sq_str_pad($string, $width, $pad, $padtype, $charset='') {
  */
 function sq_substr($string,$start,$length,$charset='auto') {
     // use automatic charset detection, if function call asks for it
+    static $charset_auto, $bUse_mb;
+
     if ($charset=='auto') {
-        global $default_charset, $squirrelmail_language;
-        set_my_charset();
-        $charset=$default_charset;
-        if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
+        if (!isset($charset_auto)) {
+            global $default_charset, $squirrelmail_language;
+            set_my_charset();
+            $charset=$default_charset;
+            if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
+            $charset_auto = $charset;
+        } else {
+            $charset = $charset_auto;
+        }
     }
     $charset = strtolower($charset);
-    if (function_exists('mb_internal_encoding') &&
-        in_array($charset,sq_mb_list_encodings())) {
+
+    // in_array call is expensive => do it once and use a static var for
+    // storing the results
+    if (!isset($bUse_mb)) {
+        if (in_array($charset,sq_mb_list_encodings())) {
+            $bUse_mb = true;
+        } else {
+            $bUse_mb = false;
+        }
+    }
+
+    if ($bUse_mb) {
         return mb_substr($string,$start,$length,$charset);
     }
     // TODO: add mbstring independent code
@@ -1223,15 +1125,31 @@ function sq_substr($string,$start,$length,$charset='auto') {
  */
 function sq_strpos($haystack,$needle,$offset,$charset='auto') {
     // use automatic charset detection, if function call asks for it
+    static $charset_auto, $bUse_mb;
+
     if ($charset=='auto') {
-        global $default_charset, $squirrelmail_language;
-        set_my_charset();
-        $charset=$default_charset;
-        if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
+        if (!isset($charset_auto)) {
+            global $default_charset, $squirrelmail_language;
+            set_my_charset();
+            $charset=$default_charset;
+            if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
+            $charset_auto = $charset;
+        } else {
+            $charset = $charset_auto;
+        }
     }
     $charset = strtolower($charset);
-    if (function_exists('mb_internal_encoding') &&
-        in_array($charset,sq_mb_list_encodings())) {
+
+    // in_array call is expensive => do it once and use a static var for
+    // storing the results
+    if (!isset($bUse_mb)) {
+        if (in_array($charset,sq_mb_list_encodings())) {
+            $bUse_mb = true;
+        } else {
+            $bUse_mb = false;
+        }
+    }
+    if ($bUse_mb) {
         return mb_strpos($haystack,$needle,$offset,$charset);
     }
     // TODO: add mbstring independent code
@@ -1252,15 +1170,33 @@ function sq_strpos($haystack,$needle,$offset,$charset='auto') {
  */
 function sq_strtoupper($string,$charset='auto') {
     // use automatic charset detection, if function call asks for it
+    static $charset_auto, $bUse_mb;
+
     if ($charset=='auto') {
-        global $default_charset,$squirrelmail_language;
-        set_my_charset();
-        $charset=$default_charset;
-        if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
+        if (!isset($charset_auto)) {
+            global $default_charset, $squirrelmail_language;
+            set_my_charset();
+            $charset=$default_charset;
+            if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
+            $charset_auto = $charset;
+        } else {
+            $charset = $charset_auto;
+        }
     }
     $charset = strtolower($charset);
-    if (function_exists('mb_strtoupper') &&
-        in_array($charset,sq_mb_list_encodings())) {
+
+    // in_array call is expensive => do it once and use a static var for
+    // storing the results
+    if (!isset($bUse_mb)) {
+        if (function_exists('mb_strtoupper') &&
+            in_array($charset,sq_mb_list_encodings())) {
+            $bUse_mb = true;
+        } else {
+            $bUse_mb = false;
+        }
+    }
+
+    if ($bUse_mb) {
         return mb_strtoupper($string,$charset);
     }
     // TODO: add mbstring independent code
@@ -1290,5 +1226,3 @@ function sq_count8bit($string) {
 function sq_trim_value ( &$value ) {
     $value = trim($value);
 }
-
-?>