X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fstrings.php;h=68c607819bd9d230c41590d0e189109b252c9b49;hp=dca58dec0d6a842b55c6d207976b34eb6a8575e6;hb=83aff890068d5c8dc46f58b5dd1d6cc756e012fb;hpb=432db2fc4af6edc726e9a52f023cd3bd1d664667 diff --git a/functions/strings.php b/functions/strings.php index dca58dec..68c60781 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, &#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,50 +454,23 @@ 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 * * 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(), '?')) { @@ -523,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://'; @@ -536,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 = ''; @@ -559,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; } @@ -582,9 +547,10 @@ 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); @@ -612,9 +578,10 @@ 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); @@ -645,8 +612,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, @@ -677,6 +645,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; @@ -718,8 +687,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(); @@ -735,16 +706,17 @@ 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; - $type = 'k'; + $type = 'KiB'; if ($bytes / 1024 > 1) { $bytes /= 1024; - $type = 'M'; + $type = 'MiB'; } if ($bytes < 10) { @@ -761,14 +733,15 @@ function show_readable_size($bytes) { /** * 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) { @@ -799,46 +772,28 @@ 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); } -/** - * Trims array - * - * Trims every element in the array, ie. remove the first char of each element - * @param array array the array to trim - */ -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 * * 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, $compose_width, $compose_height; + global $compose_new_win, $compose_width, + $compose_height, $oTemplate; if(!$text) { $text = _("Compose"); @@ -854,58 +809,23 @@ 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 "$text"; + $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 to be displayed. - * The output is wrapped in <
> and <
> 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 '
';
-    print htmlentities($buffer);
-    print '
'; -} - /** * 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 @@ -936,6 +856,7 @@ function sq_fwrite($fp, $string) { * * @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; @@ -999,6 +920,7 @@ function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT,$charset=' * * @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 @@ -1051,12 +973,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; @@ -1087,7 +1016,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(); @@ -1107,6 +1039,17 @@ 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. * @@ -1116,23 +1059,24 @@ function sq_mb_list_encodings() { * 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=''){ +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'); @@ -1194,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 @@ -1224,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 @@ -1252,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 @@ -1267,5 +1265,25 @@ function sq_strtoupper($string,$charset='auto') { // use vanilla string functions as last option return strtoupper($string); } -$PHP_SELF = php_self(); -?> \ No newline at end of file + +/** + * 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 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); +}