generalise folder_manip_dialog CSS into dialogbox CSS
[squirrelmail.git] / functions / strings.php
index 5817ad593ca8b7a96195ead75fd4bfd18bbf715c..eff1ba661af8900a0782cdc0dcbbdd5779b749c9 100644 (file)
@@ -6,35 +6,12 @@
  * This code provides various string manipulation functions that are
  * used by the rest of the SquirrelMail code.
  *
- * @copyright © 1999-2005 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
  */
 
-/** @ignore */
-if (!defined('SM_PATH')) define('SM_PATH','../');
-
-/**
- * SquirrelMail version number -- DO NOT CHANGE
- */
-global $version;
-$version = '1.5.1 [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,1);
-
-/**
- * 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.
- */
-include_once(SM_PATH . 'functions/global.php');
-
 /**
  * Appends citation markers to the string.
  * Also appends a trailing space.
@@ -477,23 +454,23 @@ function readShortMailboxName($haystack, $needle) {
     return( $elem );
 }
 
+
 /**
  * get_location
  *
  * 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;
 
     /* Get the path, handle virtual directories */
     if(strpos(php_self(), '?')) {
@@ -502,9 +479,16 @@ 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://';
@@ -515,17 +499,19 @@ function get_location () {
      *     OR if you are on port 443
      */
     $getEnvVar = getenv('HTTPS');
-    if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
-        (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && !strcasecmp($https_on, 'on')) ||
+    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)) {
         $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 = '';
-      }
+    if ( !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 = '';
+            }
+        }
     }
 
     $port = '';
@@ -538,19 +524,19 @@ function get_location () {
         }
     }
 
-   /* 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;
+    /* 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;
 }
 
 
@@ -726,11 +712,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) {
@@ -794,29 +780,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
  *
@@ -829,7 +792,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");
@@ -845,55 +809,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 = $base_uri.$url;
-        return "<a href=\"javascript:void(0)\" onclick=\"comp_in_new('$compuri','$compose_width','$compose_height')\">$text</a>";
+        $compuri = SM_BASE_URI.$url;
+
+        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
@@ -1047,7 +973,7 @@ function sq_is8bit($string,$charset='') {
  * If you want to test all mbstring encodings - fill $list_of_encodings
  * array.
  * @return array list of encodings supported by php mbstring extension
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.6
  */
 function sq_mb_list_encodings() {
     if (! function_exists('mb_internal_encoding'))
@@ -1117,7 +1043,7 @@ function sq_mb_list_encodings() {
  * Callback function used to lowercase array values.
  * @param string $val array value
  * @param mixed $key array key
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.6
  */
 function sq_lowercase_array_vals(&$val,$key) {
     $val = strtolower($val);
@@ -1133,7 +1059,7 @@ function sq_lowercase_array_vals(&$val,$key) {
  * vanilla string length function is used.
  * @param string $str string
  * @param string $charset charset
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.6
  * @return integer number of characters in string
  */
 function sq_strlen($str, $charset=null){
@@ -1145,9 +1071,10 @@ function sq_strlen($str, $charset=null){
 
     // use automatic charset detection, if function call asks for it
     if ($charset=='auto') {
-        global $default_charset;
+        global $default_charset, $squirrelmail_language;
         set_my_charset();
         $charset=$default_charset;
+        if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
     }
 
     // Use mbstring only with listed charsets
@@ -1211,14 +1138,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;
-        set_my_charset();
-        $charset=$default_charset;
+        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
@@ -1241,14 +1186,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;
-        set_my_charset();
-        $charset=$default_charset;
+        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
@@ -1269,14 +1231,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;
-        set_my_charset();
-        $charset=$default_charset;
+        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
@@ -1298,4 +1279,11 @@ function sq_count8bit($string) {
     return $count;
 }
 
-?>
\ No newline at end of file
+/**
+ * Callback function to trim whitespace from a value, to be used in array_walk
+ * @param string $value value to trim
+ * @since 1.5.2 and 1.4.7
+ */
+function sq_trim_value ( &$value ) {
+    $value = trim($value);
+}