X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fstrings.php;h=5f99b3858ae5c01653d317c51e4d3ffe0c8de2ad;hb=5f817a0bc46fa47583ffce939e18c56570338bc3;hp=bd17965a1a74f65dad86d6e3354a5b7e701c6acb;hpb=68bd8d9282468ea51311614f3d9616addbe99f67;p=squirrelmail.git

diff --git a/functions/strings.php b/functions/strings.php
index bd17965a..5f99b385 100644
--- a/functions/strings.php
+++ b/functions/strings.php
@@ -3,45 +3,24 @@
 /**
  * strings.php
  *
- * Copyright (c) 1999-2005 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
  * used by the rest of the SquirrelMail code.
  *
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  */
 
-/**
- * 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.
- */
-require_once(SM_PATH . 'functions/global.php');
-
 /**
  * Appends citation markers to the string.
  * Also appends a trailing space.
  *
  * @author Justus Pendleton
- *
- * @param string str The string to append to
- * @param int citeLevel the number of markers to append
+ * @param string $str The string to append to
+ * @param int $citeLevel the number of markers to append
  * @return null
+ * @since 1.5.1
  */
 function sqMakeCite (&$str, $citeLevel) {
     for ($i = 0; $i < $citeLevel; $i++) {
@@ -57,11 +36,11 @@ function sqMakeCite (&$str, $citeLevel) {
  * markers to the newline as necessary.
  *
  * @author Justus Pendleton
- *
- * @param string str the string to make a newline in
- * @param int citeLevel the citation level the newline is at
- * @param int column starting column of the newline
+ * @param string $str the string to make a newline in
+ * @param int $citeLevel the citation level the newline is at
+ * @param int $column starting column of the newline
  * @return null
+ * @since 1.5.1
  */
 function sqMakeNewLine (&$str, $citeLevel, &$column) {
     $str .= "\n";
@@ -92,6 +71,7 @@ function sqMakeNewLine (&$str, $citeLevel, &$column) {
  *
  * @param string $string tested string
  * @return bool true when only whitespace symbols are present in test string
+ * @since 1.5.1
  */
 function sm_ctype_space($string) {
     if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) || $string=='') {
@@ -108,10 +88,10 @@ function sm_ctype_space($string) {
  * bit smarter and when and how to wrap.
  *
  * @author Justus Pendleton
- *
- * @param string body the entire body of text
- * @param int wrap the maximum line length
+ * @param string $body the entire body of text
+ * @param int $wrap the maximum line length
  * @return string the wrapped text
+ * @since 1.5.1
  */
 function &sqBodyWrap (&$body, $wrap) {
     //check for ctype support, and fake it if it doesn't exist
@@ -351,10 +331,11 @@ function &sqBodyWrap (&$body, $wrap) {
  * Specifically, &amp;#039; comes up as 5 characters instead of 1.
  * This should not add newlines to the end of lines.
  *
- * @param string line the line of text to wrap, by ref
- * @param int wrap the maximum line lenth
- * @param string charset name of charset used in $line string. Available since v.1.5.1.
+ * @param string $line the line of text to wrap, by ref
+ * @param int $wrap the maximum line lenth
+ * @param string $charset name of charset used in $line string. Available since v.1.5.1.
  * @return void
+ * @since 1.0
  */
 function sqWordWrap(&$line, $wrap, $charset='') {
     global $languages, $squirrelmail_language;
@@ -411,8 +392,9 @@ function sqWordWrap(&$line, $wrap, $charset='') {
 
 /**
  * Does the opposite of sqWordWrap()
- * @param string body the text to un-wordwrap
+ * @param string $body the text to un-wordwrap
  * @return void
+ * @since 1.0
  */
 function sqUnWordWrap(&$body) {
     global $squirrelmail_language;
@@ -456,6 +438,7 @@ function sqUnWordWrap(&$body) {
  * @param string haystack full mailbox name to search
  * @param string needle the mailbox separator character
  * @return string the last part of the mailbox name
+ * @since 1.0
  */
 function readShortMailboxName($haystack, $needle) {
 
@@ -471,33 +454,6 @@ function readShortMailboxName($haystack, $needle) {
     return( $elem );
 }
 
-/**
- * php_self
- *
- * Creates an URL for the page calling this function, using either the PHP global
- * REQUEST_URI, or the PHP global PHP_SELF with QUERY_STRING added.
- *
- * @return string the complete url for this page
- */
-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 '';
-}
-
 
 /**
  * get_location
@@ -511,6 +467,7 @@ function php_self () {
  *   http://www.example.com/squirrelmail/
  *
  * @return string the base url for this SquirrelMail installation
+ * @since 1.0
  */
 function get_location () {
 
@@ -582,12 +539,23 @@ function get_location () {
  * stored in a cookie. The encryption key is generated by
  * OneTimePadCreate();
  *
- * @param string string the (password)string to encrypt
- * @param string epad the encryption key
+ * @param string $string the (password)string to encrypt
+ * @param string $epad the encryption key
  * @return string the base64-encoded encrypted password
+ * @since 1.0
  */
 function OneTimePadEncrypt ($string, $epad) {
     $pad = base64_decode($epad);
+
+    if (strlen($pad)>0) {
+        // make sure that pad is longer than string
+        while (strlen($string)>strlen($pad)) {
+            $pad.=$pad;
+        }
+    } else {
+        // FIXME: what should we do when $epad is not base64 encoded or empty.
+    }
+
     $encrypted = '';
     for ($i = 0; $i < strlen ($string); $i++) {
         $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
@@ -602,12 +570,23 @@ function OneTimePadEncrypt ($string, $epad) {
  * Decrypts a password from the cookie, encrypted by OneTimePadEncrypt.
  * This uses the encryption key that is stored in the session.
  *
- * @param string string the string to decrypt
- * @param string epad the encryption key from the session
+ * @param string $string the string to decrypt
+ * @param string $epad the encryption key from the session
  * @return string the decrypted password
+ * @since 1.0
  */
 function OneTimePadDecrypt ($string, $epad) {
     $pad = base64_decode($epad);
+
+    if (strlen($pad)>0) {
+        // make sure that pad is longer than string
+        while (strlen($string)>strlen($pad)) {
+            $pad.=$pad;
+        }
+    } else {
+        // FIXME: what should we do when $epad is not base64 encoded or empty.
+    }
+
     $encrypted = base64_decode ($string);
     $decrypted = '';
     for ($i = 0; $i < strlen ($encrypted); $i++) {
@@ -625,8 +604,9 @@ function OneTimePadDecrypt ($string, $epad) {
  * 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
+ * @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,
@@ -657,6 +637,7 @@ function sq_mt_seed($Val) {
  * the same 'random' numbers twice in one session.
  *
  * @return void
+ * @since 1.0
  */
 function sq_mt_randomize() {
     static $randomized;
@@ -698,8 +679,10 @@ function sq_mt_randomize() {
  * Creates an encryption key for encrypting the password stored in the cookie.
  * The encryption key itself is stored in the session.
  *
- * @param int length optional, length of the string to generate
+ * Pad must be longer or equal to encoded string length in 1.4.4/1.5.0 and older.
+ * @param int $length optional, length of the string to generate
  * @return string the encryption key
+ * @since 1.0
  */
 function OneTimePadCreate ($length=100) {
     sq_mt_randomize();
@@ -715,8 +698,9 @@ function OneTimePadCreate ($length=100) {
 /**
  * Returns a string showing the size of the message/attachment.
  *
- * @param int bytes the filesize in bytes
+ * @param int $bytes the filesize in bytes
  * @return string the filesize in human readable format
+ * @since 1.0
  */
 function show_readable_size($bytes) {
     $bytes /= 1024;
@@ -735,20 +719,21 @@ function show_readable_size($bytes) {
         settype($bytes, 'integer');
     }
 
-    return $bytes . '<small>&nbsp;' . $type . '</small>';
+    return $bytes . '&nbsp;' . $type;
 }
 
 /**
  * Generates a random string from the character set you pass in
  *
- * @param int size the size of the string to generate
- * @param string chars a string containing the characters to use
- * @param int flags a flag to add a specific set to the characters to use:
+ * @param int $size the length of the string to generate
+ * @param string $chars a string containing the characters to use
+ * @param int $flags a flag to add a specific set to the characters to use:
  *     Flags:
  *       1 = add lowercase a-z to $chars
  *       2 = add uppercase A-Z to $chars
  *       4 = add numbers 0-9 to $chars
  * @return string the random string
+ * @since 1.0
  */
 function GenerateRandomString($size, $chars, $flags = 0) {
     if ($flags & 0x1) {
@@ -779,8 +764,9 @@ function GenerateRandomString($size, $chars, $flags = 0) {
 /**
  * Escapes special characters for use in IMAP commands.
  *
- * @param string the string to escape
+ * @param string $str the string to escape
  * @return string the escaped string
+ * @since 1.0.3
  */
 function quoteimap($str) {
     return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
@@ -790,7 +776,8 @@ function quoteimap($str) {
  * Trims array
  *
  * Trims every element in the array, ie. remove the first char of each element
- * @param array array the array to trim
+ * @param array $array the array to trim
+ * @since 1.2.0
  */
 function TrimArray(&$array) {
     foreach ($array as $k => $v) {
@@ -813,39 +800,37 @@ function TrimArray(&$array) {
  *
  * Returns a link to the compose-page, taking in consideration
  * the compose_in_new and javascript settings.
- * @param string url the URL to the compose page
- * @param string text the link text, default "Compose"
+ * @param string $url the URL to the compose page
+ * @param string $text the link text, default "Compose"
+ * @param string $target (since 1.4.3) url target
  * @return string a link to the compose page
+ * @since 1.4.2
  */
-function makeComposeLink($url, $text = null, $target='')
-{
-    global $compose_new_win,$javascript_on;
+function makeComposeLink($url, $text = null, $target='') {
+    global $compose_new_win,$javascript_on, $compose_width, $compose_height;
 
     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, $target);
     }
 
-
     // 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>';
+        $compuri = SM_BASE_URI.$url;
+        return "<a href=\"javascript:void(0)\" onclick=\"comp_in_new('$compuri','$compose_width','$compose_height')\">$text</a>";
     }
 
-
     // otherwise, just open new window using regular HTML
     return makeInternalLink($url, $text, '_blank');
-
 }
 
 /**
@@ -857,7 +842,8 @@ function makeComposeLink($url, $text = null, $target='')
  * 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() {
@@ -881,13 +867,17 @@ function sm_print_r() {
     }
     $buffer = ob_get_contents(); // Grab the print_r output
     ob_end_clean();  // Silently discard the output & stop buffering
-    print '<pre>';
+    print '<div align="left"><pre>';
     print htmlentities($buffer);
-    print '</pre>';
+    print '</pre></div>';
 }
 
 /**
  * version of fwrite which checks for failure
+ * @param resource $fp
+ * @param string $string
+ * @return number of written bytes. false on failure
+ * @since 1.4.3
  */
 function sq_fwrite($fp, $string) {
         // write to file
@@ -918,6 +908,7 @@ function sq_fwrite($fp, $string) {
  *              </ul>
  * @param string $charset charset used for encoding. default to us-ascii, 'auto' uses $default_charset global value.
  * @return array html translation array
+ * @since 1.5.1
  */
 function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT,$charset='us-ascii') {
   global $default_charset;
@@ -981,6 +972,7 @@ function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT,$charset='
  *              </ul>
  * @param string $charset charset used for encoding. defaults to 'us-ascii', 'auto' uses $default_charset global value.
  * @return string sanitized string
+ * @since 1.5.1
  */
 function sq_htmlentities($string,$quote_style=ENT_COMPAT,$charset='us-ascii') {
   // get translation table
@@ -1033,12 +1025,19 @@ 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'))
         return array();
 
+    // php 5+ function
+    if (function_exists('mb_list_encodings')) {
+        $ret = mb_list_encodings();
+        array_walk($ret,'sq_lowercase_array_vals');
+        return $ret;
+    }
+
     // don't try to test encodings, if they are already stored in session
     if (sqgetGlobalVar('mb_supported_encodings',$mb_supported_encodings,SQ_SESSION))
         return $mb_supported_encodings;
@@ -1069,7 +1068,10 @@ function sq_mb_list_encodings() {
         'windows-1256',
         'tis-620',
         'iso-2022-jp',
+        'euc-cn',
         'euc-kr',
+        'euc-tw',
+        'uhc',
         'utf7-imap');
 
     $supported_encodings=array();
@@ -1089,32 +1091,44 @@ function sq_mb_list_encodings() {
     return $supported_encodings;
 }
 
+/**
+ * Callback function used to lowercase array values.
+ * @param string $val array value
+ * @param mixed $key array key
+ * @since 1.5.1 and 1.4.6
+ */
+function sq_lowercase_array_vals(&$val,$key) {
+    $val = strtolower($val);
+}
+
+
 /**
  * Function returns number of characters in string.
  *
  * Returned number might be different from number of bytes in string,
- * if $charset is multibyte charset. Detection depends on mbstring 
+ * if $charset is multibyte charset. Detection depends on mbstring
  * functions. If mbstring does not support tested multibyte charset,
- * vanilla string length function is used. 
+ * vanilla string length function is used.
  * @param string $str string
  * @param string $charset charset
- * @since 1.5.1
- * @return integer number of characters in string 
+ * @since 1.5.1 and 1.4.6
+ * @return integer number of characters in string
  */
-function sq_strlen($str, $charset=''){
+function sq_strlen($str, $charset=null){
     // default option
-    if ($charset=='') return strlen($str);
+    if (is_null($charset)) return strlen($str);
+
+    // lowercase charset name
+    $charset=strtolower($charset);
 
     // 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';
     }
 
-    // lowercase charset name
-    $charset=strtolower($charset);
-
     // Use mbstring only with listed charsets
     $aList_of_mb_charsets=array('utf-8','big5','gb2312','gb18030','euc-jp','euc-cn','euc-tw','euc-kr');
 
@@ -1122,7 +1136,7 @@ function sq_strlen($str, $charset=''){
     if (in_array($charset,$aList_of_mb_charsets) && in_array($charset,sq_mb_list_encodings())) {
         $real_length = mb_strlen($str,$charset);
     } else {
-        // own strlen detection code is removed because missing strpos, 
+        // own strlen detection code is removed because missing strpos,
         // strtoupper and substr implementations break string wrapping.
         $real_length=strlen($str);
     }
@@ -1136,7 +1150,7 @@ function sq_strlen($str, $charset=''){
  * @param string $string original string
  * @param integer $width padded string width
  * @param string $pad padding symbols
- * @param integer $padtype padding type 
+ * @param integer $padtype padding type
  *  (internal php defines, see str_pad() description)
  * @param string $charset charset used in original string
  * @return string padded string
@@ -1177,12 +1191,13 @@ 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
     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';
     }
     $charset = strtolower($charset);
-    if (function_exists('mb_internal_encoding') && 
+    if (function_exists('mb_internal_encoding') &&
         in_array($charset,sq_mb_list_encodings())) {
         return mb_substr($string,$start,$length,$charset);
     }
@@ -1207,12 +1222,13 @@ 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
     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';
     }
     $charset = strtolower($charset);
-    if (function_exists('mb_internal_encoding') && 
+    if (function_exists('mb_internal_encoding') &&
         in_array($charset,sq_mb_list_encodings())) {
         return mb_strpos($haystack,$needle,$offset,$charset);
     }
@@ -1235,12 +1251,13 @@ function sq_strpos($haystack,$needle,$offset,$charset='auto') {
 function sq_strtoupper($string,$charset='auto') {
     // 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';
     }
     $charset = strtolower($charset);
-    if (function_exists('mb_strtoupper') && 
+    if (function_exists('mb_strtoupper') &&
         in_array($charset,sq_mb_list_encodings())) {
         return mb_strtoupper($string,$charset);
     }
@@ -1249,5 +1266,27 @@ function sq_strtoupper($string,$charset='auto') {
     // use vanilla string functions as last option
     return strtoupper($string);
 }
-$PHP_SELF = php_self();
+
+/**
+ * Counts 8bit bytes in string
+ * @param string $string tested string
+ * @return integer number of 8bit bytes
+ */
+function sq_count8bit($string) {
+    $count=0;
+    for ($i=0; $i<strlen($string); $i++) {
+        if (ord($string[$i]) > 127) $count++;
+    }
+    return $count;
+}
+
+/**
+ * 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);
+}
+
 ?>