X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fstrings.php;h=944177d9d1523a3833522df5b89159eadbd0a90e;hb=10f4b19544bf2463810901485e5f430408ee52e8;hp=22f61f1b0459a4dc710c5c9eb0d4995d12a24aa8;hpb=31310ecde095e8697e96868adf549e7260dedb36;p=squirrelmail.git diff --git a/functions/strings.php b/functions/strings.php index 22f61f1b..944177d9 100644 --- a/functions/strings.php +++ b/functions/strings.php @@ -3,39 +3,15 @@ /** * 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-2009 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. @@ -478,52 +454,24 @@ 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 - * @since 1.2.3 - */ -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, + $is_secure_connection, $sq_ignore_http_x_forwarded_headers; /* Get the path, handle virtual directories */ if(strpos(php_self(), '?')) { @@ -532,55 +480,93 @@ 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')) || - (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && !strcasecmp($https_on, 'on')) || - (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_HOST', $host, SQ_SERVER) || empty($host) ) { - if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) { - $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 = ''; + } + } } $port = ''; if (! strstr($host, ':')) { + // Note: HTTP_X_FORWARDED_PROTO could be sent from the client and + // therefore possibly spoofed/hackable. Thus, SquirrelMail + // ignores such headers by default. The administrator + // can tell SM to use such header values by setting + // $sq_ignore_http_x_forwarded_headers to boolean FALSE + // in config/config.php or by using config/conf.pl. + global $sq_ignore_http_x_forwarded_headers; + if ($sq_ignore_http_x_forwarded_headers + || !sqgetGlobalVar('HTTP_X_FORWARDED_PROTO', $forwarded_proto, SQ_SERVER)) + $forwarded_proto = ''; 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; + /* 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); + + $list_xtra = "?where=read_body.php&what=$what&mailbox=" . $urlMailbox. + "&startMessage=$startMessage"; + + return $base_uri .'src/right_main.php'. $list_xtra; } @@ -648,83 +634,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 * @@ -737,8 +646,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)); @@ -748,19 +655,23 @@ function OneTimePadCreate ($length=100) { } /** - * Returns a string showing the size of the message/attachment. - * - * @param int $bytes the filesize in bytes - * @return string the filesize in human readable format - * @since 1.0 - */ + * Returns a string showing a byte size figure in + * a more easily digested (readable) format + * + * @param int $bytes the size in bytes + * + * @return string The size 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) { @@ -771,7 +682,8 @@ function show_readable_size($bytes) { settype($bytes, 'integer'); } - return $bytes . ' ' . $type; + global $nbsp; + return $bytes . $nbsp . $type; } /** @@ -802,8 +714,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) { @@ -824,42 +734,24 @@ 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 * * 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 $target (since 1.4.3) url target + * + * @param string $url The URL to the compose page + * @param string $text The link text, default "Compose" + * @param string $target URL target, if any (since 1.4.3) + * @param string $accesskey The access key to be used, if any + * * @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; +function makeComposeLink($url, $text = null, $target='', $accesskey='NONE') { + global $compose_new_win, $compose_width, + $compose_height, $oTemplate; if(!$text) { $text = _("Compose"); @@ -868,60 +760,27 @@ function makeComposeLink($url, $text = null, $target='') { // 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); + return makeInternalLink($url, $text, $target, $accesskey); } // build the compose in new window link... // 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')", + '', '', '', + ($accesskey == 'NONE' + ? array() + : array('accesskey' => $accesskey))); } // 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 '
'; + return makeInternalLink($url, $text, '_blank', $accesskey); } /** @@ -1077,7 +936,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')) @@ -1120,7 +979,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(); @@ -1144,7 +1006,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); @@ -1160,7 +1022,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){ @@ -1172,9 +1034,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 @@ -1238,14 +1101,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 @@ -1268,14 +1149,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 @@ -1296,14 +1194,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 @@ -1311,5 +1228,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); +}