X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fstrings.php;h=4ff54b898bfeb95e145ed5deb259da559bf41aa0;hp=00969df57dadfd64c1556553571229694a6d5d3a;hb=ab1df059d97dc80d52a7f932a7b431e558197844;hpb=e842b215cc74203501fe50e52497f9f0329e721b diff --git a/functions/strings.php b/functions/strings.php index 00969df5..4ff54b89 100644 --- a/functions/strings.php +++ b/functions/strings.php @@ -1,32 +1,37 @@ ].*$', '', $array[$i]); - } - return $array; -} - -/** - * Returns a line of comma separated email addresses from an array. + * 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 getLineOfAddrs($array) { - if (is_array($array)) { - $to_line = implode(', ', $array); - $to_line = ereg_replace(', (, )+', ', ', $to_line); - $to_line = trim(ereg_replace('^, ', '', $to_line)); - if( substr( $to_line, -1 ) == ',' ) - $to_line = substr( $to_line, 0, -1 ); - } else { - $to_line = ''; - } - - return( $to_line ); -} - 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 ''; } /** - * This determines the location to forward to relative to your server. + * 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 change the header() - * function to look something like this, customized to the location of - * SquirrelMail on your server: + * 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/ * - * http://www.myhost.com/squirrelmail/src/login.php + * @return string the base url for this SquirrelMail installation */ function get_location () { - + global $imap_server_type; /* Get the path, handle virtual directories */ - $path = substr(php_self(), 0, strrpos(php_self(), '/')); - + if(strpos(php_self(), '?')) { + $path = substr(php_self(), 0, strpos(php_self(), '?')); + } else { + $path = php_self(); + } + $path = substr($path, 0, strrpos($path, '/')); if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) { return $full_url . $path; } /* 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 @@ -228,32 +226,32 @@ function get_location () { (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 = ''; } } - + $port = ''; if (! strstr($host, ':')) { if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) { - if (($server_port != 80 && $proto == 'http://') || + if (($server_port != 80 && $proto == 'http://') || ($server_port != 443 && $proto == 'https://')) { $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 */ - + 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 : ''); @@ -263,8 +261,13 @@ function get_location () { /** - * These functions are used to encrypt the passowrd before it is - * stored in a cookie. + * These functions are used to encrypt the password before it is + * 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 + * @return string the base64-encoded encrypted password */ function OneTimePadEncrypt ($string, $epad) { $pad = base64_decode($epad); @@ -272,10 +275,18 @@ function OneTimePadEncrypt ($string, $epad) { for ($i = 0; $i < strlen ($string); $i++) { $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i])); } - + return base64_encode($encrypted); } +/** + * Decrypt 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 + * @return string the decrypted password + */ function OneTimePadDecrypt ($string, $epad) { $pad = base64_decode($epad); $encrypted = base64_decode ($string); @@ -283,7 +294,7 @@ function OneTimePadDecrypt ($string, $epad) { for ($i = 0; $i < strlen ($encrypted); $i++) { $decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i])); } - + return $decrypted; } @@ -292,24 +303,27 @@ function OneTimePadDecrypt ($string, $epad) { * Randomize 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 + * @return void */ 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); } @@ -318,20 +332,22 @@ function sq_mt_seed($Val) { * 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 */ 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 */ @@ -345,37 +361,47 @@ function sq_mt_randomize() { sq_mt_seed(md5($Str)); } } - + if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) { sq_mt_seed(md5($unique_id)); } - + $randomized = 1; } +/** + * 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 + * @return string the encryption key + */ function OneTimePadCreate ($length=100) { sq_mt_randomize(); - + $pad = ''; for ($i = 0; $i < $length; $i++) { $pad .= chr(mt_rand(0,255)); } - + return base64_encode($pad); } /** - * Returns a string showing the size of the message/attachment. + * 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 */ function show_readable_size($bytes) { $bytes /= 1024; $type = 'k'; - + if ($bytes / 1024 > 1) { $bytes /= 1024; $type = 'M'; } - + if ($bytes < 10) { $bytes *= 10; settype($bytes, 'integer'); @@ -383,17 +409,21 @@ function show_readable_size($bytes) { } else { settype($bytes, 'integer'); } - + return $bytes . ' ' . $type . ''; } /** * Generates a random string from the caracter set you pass in * - * Flags: - * 1 = add lowercase a-z to $chars - * 2 = add uppercase A-Z to $chars - * 4 = add numbers 0-9 to $chars + * @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: + * 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 */ function GenerateRandomString($size, $chars, $flags = 0) { @@ -406,7 +436,7 @@ function GenerateRandomString($size, $chars, $flags = 0) { if ($flags & 0x4) { $chars .= '0123456789'; } - + if (($size < 1) || (strlen($chars) < 1)) { return ''; } @@ -422,12 +452,18 @@ function GenerateRandomString($size, $chars, $flags = 0) { return $String; } +/** + * Escapes special characters for use in IMAP commands. + * @param string the string to escape + * @return string the escaped string + */ function quoteimap($str) { - return ereg_replace('(["\\])', '\\\\1', $str); + return preg_replace("/([\"\\\\])/", "\\\\$1", $str); } /** - * Trims every element in the 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) { @@ -439,32 +475,87 @@ function TrimArray(&$array) { } else { $$k = substr($v, 1); } - + /* Re-assign back to array. */ $array[$k] = $$k; } -} +} /** - * Removes slashes from every element in the 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" + * @return string a link to the compose page */ -function RemoveSlashes(&$array) { - foreach ($array as $k => $v) { - global $$k; - if (is_array($$k)) { - foreach ($$k as $k2 => $v2) { - $newArray[stripslashes($k2)] = stripslashes($v2); - } - $$k = $newArray; - } else { - $$k = stripslashes($v); - } - - /* Re-assign back to the array. */ - $array[$k] = $$k; +function makeComposeLink($url, $text = null, $target='') +{ + global $compose_new_win,$javascript_on; + + 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 ''. $text.''; } + + + // otherwise, just open new window using regular HTML + return makeInternalLink($url, $text, '_blank'); + } -$PHP_SELF = php_self(); +/** + * 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. + * + * @return void + */ +function sm_print_r() { + ob_start(); // Buffer output + foreach(func_get_args() as $var) { + print_r($var); + 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 '
'; +} -?> \ No newline at end of file +/** + * version of fwrite which checks for failure + */ +function sq_fwrite($fp, $string) { + // write to file + $count = @fwrite($fp,$string); + // the number of bytes written should be the length of the string + if($count != strlen($string)) { + return FALSE; + } + + return $count; +} + + + +$PHP_SELF = php_self(); +?>