6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This code provides various string manipulation functions that are
10 * used by the rest of the Squirrelmail code.
16 * SquirrelMail version number -- DO NOT CHANGE
19 $version = '1.3.2 [CVS-DEVEL]';
22 * Wraps text at $wrap characters
24 * Has a problem with special HTML characters, so call this before
25 * you do character translation.
27 * Specifically, ' comes up as 5 characters instead of 1.
28 * This should not add newlines to the end of lines.
30 function sqWordWrap(&$line, $wrap) {
31 ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
32 $beginning_spaces = $regs[1];
33 if (isset($regs[2])) {
34 $words = explode(' ', $regs[2]);
40 $line = $beginning_spaces;
42 while ($i < count($words)) {
43 /* Force one word to be on a line (minimum) */
45 $line_len = strlen($beginning_spaces) +
strlen($words[$i]) +
2;
46 if (isset($words[$i +
1]))
47 $line_len +
= strlen($words[$i +
1]);
50 /* Add more words (as long as they fit) */
51 while ($line_len < $wrap && $i < count($words)) {
52 $line .= ' ' . $words[$i];
54 if (isset($words[$i]))
55 $line_len +
= strlen($words[$i]) +
1;
60 /* Skip spaces if they are the first thing on a continued line */
61 while (!isset($words[$i]) && $i < count($words)) {
65 /* Go to the next line if we have more to process */
66 if ($i < count($words)) {
73 * Does the opposite of sqWordWrap()
75 function sqUnWordWrap(&$body) {
76 $lines = explode("\n", $body);
80 for ($i = 0; $i < $cnt; $i ++
) {
81 preg_match("/^([\t >]*)([^\t >].*)?$/", $lines[$i], $regs);
82 $CurrentSpaces = $regs[1];
83 if (isset($regs[2])) {
84 $CurrentRest = $regs[2];
90 $PreviousSpaces = $CurrentSpaces;
92 } else if (($PreviousSpaces == $CurrentSpaces) /* Do the beginnings match */
93 && (strlen($lines[$i - 1]) > 65) /* Over 65 characters long */
94 && strlen($CurrentRest)) { /* and there's a line to continue with */
95 $body .= ' ' . $CurrentRest;
97 $body .= "\n" . $lines[$i];
98 $PreviousSpaces = $CurrentSpaces;
105 * If $haystack is a full mailbox name and $needle is the mailbox
106 * separator character, returns the last part of the mailbox name.
108 function readShortMailboxName($haystack, $needle) {
113 $parts = explode($needle, $haystack);
114 $elem = array_pop($parts);
115 while ($elem == '' && count($parts)) {
116 $elem = array_pop($parts);
123 * Returns an array of email addresses.
124 * Be cautious of "user@host.com"
126 function parseAddrs($text) {
127 if (trim($text) == '')
129 $text = str_replace(' ', '', $text);
130 $text = ereg_replace('"[^"]*"', '', $text);
131 $text = ereg_replace('\\([^\\)]*\\)', '', $text);
132 $text = str_replace(',', ';', $text);
133 $array = explode(';', $text);
134 for ($i = 0; $i < count ($array); $i++
) {
135 $array[$i] = eregi_replace ('^.*[<]', '', $array[$i]);
136 $array[$i] = eregi_replace ('[>].*$', '', $array[$i]);
142 * Returns a line of comma separated email addresses from an array.
144 function getLineOfAddrs($array) {
145 if (is_array($array)) {
146 $to_line = implode(', ', $array);
147 $to_line = ereg_replace(', (, )+', ', ', $to_line);
148 $to_line = trim(ereg_replace('^, ', '', $to_line));
149 if( substr( $to_line, -1 ) == ',' )
150 $to_line = substr( $to_line, 0, -1 );
158 function php_self () {
159 global $PHP_SELF, $_SERVER;
161 if (isset($_SERVER['REQUEST_URI']) && !empty($_SERVER['REQUEST_URI']) ) {
162 return $_SERVER['REQUEST_URI'];
165 if (isset($PHP_SELF) && !empty($PHP_SELF)) {
167 } else if (isset($_SERVER['PHP_SELF']) &&
168 !empty($_SERVER['PHP_SELF'])) {
169 return $_SERVER['PHP_SELF'];
177 * This determines the location to forward to relative to your server.
178 * If this doesnt work correctly for you (although it should), you can
179 * remove all this code except the last two lines, and change the header()
180 * function to look something like this, customized to the location of
181 * SquirrelMail on your server:
183 * http://www.myhost.com/squirrelmail/src/login.php
185 function get_location () {
187 global $_SERVER, $imap_server_type;
189 /* Get the path, handle virtual directories */
190 $path = substr(php_self(), 0, strrpos(php_self(), '/'));
192 /* Check if this is a HTTPS or regular HTTP request. */
196 * If you have 'SSLOptions +StdEnvVars' in your apache config
197 * OR if you have HTTPS in your HTTP_SERVER_VARS
198 * OR if you are on port 443
200 $getEnvVar = getenv('HTTPS');
201 if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
202 (isset($_SERVER['HTTPS'])) ||
203 (isset($_SERVER['SERVER_PORT']) &&
204 $_SERVER['SERVER_PORT'] == 443)) {
208 /* Get the hostname from the Host header or server config. */
210 if (isset($_SERVER['HTTP_HOST']) && !empty($_SERVER['HTTP_HOST'])) {
211 $host = $_SERVER['HTTP_HOST'];
212 } else if (isset($_SERVER['SERVER_NAME']) &&
213 !empty($_SERVER['SERVER_NAME'])) {
218 if (! strstr($host, ':')) {
219 if (isset($_SERVER['SERVER_PORT'])) {
220 if (($_SERVER['SERVER_PORT'] != 80 && $proto == 'http://')
221 ||
($_SERVER['SERVER_PORT'] != 443 && $proto == 'https://')) {
222 $port = sprintf(':%d', $_SERVER['SERVER_PORT']);
227 /* this is a workaround for the weird macosx caching that
228 causes Apache to return 16080 as the port number, which causes
231 if ($imap_server_type == 'macosx' && $port == ':16080') {
235 /* Fallback is to omit the server name and use a relative */
236 /* URI, although this is not RFC 2616 compliant. */
237 return ($host ?
$proto . $host . $port . $path : $path);
242 * These functions are used to encrypt the passowrd before it is
243 * stored in a cookie.
245 function OneTimePadEncrypt ($string, $epad) {
246 $pad = base64_decode($epad);
248 for ($i = 0; $i < strlen ($string); $i++
) {
249 $encrypted .= chr (ord($string[$i]) ^
ord($pad[$i]));
252 return base64_encode($encrypted);
255 function OneTimePadDecrypt ($string, $epad) {
256 $pad = base64_decode($epad);
257 $encrypted = base64_decode ($string);
259 for ($i = 0; $i < strlen ($encrypted); $i++
) {
260 $decrypted .= chr (ord($encrypted[$i]) ^
ord($pad[$i]));
268 * Randomize the mt_rand() function. Toss this in strings or integers
269 * and it will seed the generator appropriately. With strings, it is
270 * better to get them long. Use md5() to lengthen smaller strings.
272 function sq_mt_seed($Val) {
273 /* if mt_getrandmax() does not return a 2^n - 1 number,
274 this might not work well. This uses $Max as a bitmask. */
275 $Max = mt_getrandmax();
277 if (! is_int($Val)) {
278 if (function_exists('crc32')) {
285 $HighBit = $Max ^
$Mask;
286 while ($Pos < strlen($Str)) {
287 if ($Val & $HighBit) {
288 $Val = (($Val & $Mask) << 1) +
1;
290 $Val = ($Val & $Mask) << 1;
306 mt_srand(($Val ^
mt_rand(0, $Max)) & $Max);
311 * This function initializes the random number generator fairly well.
312 * It also only initializes it once, so you don't accidentally get
313 * the same 'random' numbers twice in one session.
315 function sq_mt_randomize() {
324 sq_mt_seed((int)((double) microtime() * 1000000));
325 sq_mt_seed(md5($_SERVER['REMOTE_PORT'] . $_SERVER['REMOTE_ADDR'] . getmypid()));
328 if (function_exists('getrusage')) {
329 /* Avoid warnings with Win32 */
331 if (isset($dat) && is_array($dat)) {
333 foreach ($dat as $k => $v)
337 sq_mt_seed(md5($Str));
341 if(isset($_SERVER['UNIQUE_ID'])) {
342 sq_mt_seed(md5($_SERVER['UNIQUE_ID']));
348 function OneTimePadCreate ($length=100) {
352 for ($i = 0; $i < $length; $i++
) {
353 $pad .= chr(mt_rand(0,255));
356 return base64_encode($pad);
360 * Check if we have a required PHP-version. Return TRUE if we do,
361 * or FALSE if we don't.
363 * To check for 4.0.1, use sqCheckPHPVersion(4,0,1)
364 * To check for 4.0b3, use sqCheckPHPVersion(4,0,-3)
366 * Does not handle betas like 4.0.1b1 or development versions
368 function sqCheckPHPVersion($major, $minor, $release) {
371 eregi('^([0-9]+)\\.([0-9]+)(.*)', $ver, $regs);
373 /* Parse the version string. */
374 $vmajor = strval($regs[1]);
375 $vminor = strval($regs[2]);
377 if($vrel[0] == '.') {
378 $vrel = strval(substr($vrel, 1));
380 if($vrel[0] == 'b' ||
$vrel[0] == 'B') {
381 $vrel = - strval(substr($vrel, 1));
383 if($vrel[0] == 'r' ||
$vrel[0] == 'R') {
384 $vrel = - strval(substr($vrel, 2))/10;
387 /* Compare major version. */
388 if ($vmajor < $major) { return false; }
389 if ($vmajor > $major) { return true; }
391 /* Major is the same. Compare minor. */
392 if ($vminor < $minor) { return false; }
393 if ($vminor > $minor) { return true; }
395 /* Major and minor is the same as the required one. Compare release */
396 if ($vrel >= 0 && $release >= 0) { /* Neither are beta */
397 if($vrel < $release) return false;
398 } else if($vrel >= 0 && $release < 0) { /* This is not beta, required is beta */
400 } else if($vrel < 0 && $release >= 0){ /* This is beta, require not beta */
402 } else { /* Both are beta */
403 if($vrel > $release) return false;
410 * Returns a string showing the size of the message/attachment.
412 function show_readable_size($bytes) {
416 if ($bytes / 1024 > 1) {
423 settype($bytes, 'integer');
426 settype($bytes, 'integer');
429 return $bytes . '<small> ' . $type . '</small>';
433 * Generates a random string from the caracter set you pass in
436 * 1 = add lowercase a-z to $chars
437 * 2 = add uppercase A-Z to $chars
438 * 4 = add numbers 0-9 to $chars
441 function GenerateRandomString($size, $chars, $flags = 0) {
443 $chars .= 'abcdefghijklmnopqrstuvwxyz';
446 $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
449 $chars .= '0123456789';
452 if (($size < 1) ||
(strlen($chars) < 1)) {
456 sq_mt_randomize(); /* Initialize the random number generator */
459 $j = strlen( $chars ) - 1;
460 while (strlen($String) < $size) {
461 $String .= $chars{mt_rand(0, $j)};
467 function quoteIMAP($str) {
468 return ereg_replace('(["\\])', '\\\\1', $str);
472 * Trims every element in the array
474 function TrimArray(&$array) {
475 foreach ($array as $k => $v) {
478 foreach ($
$k as $k2 => $v2) {
479 $
$k[$k2] = substr($v2, 1);
485 /* Re-assign back to array. */
491 * Removes slashes from every element in the array
493 function RemoveSlashes(&$array) {
494 foreach ($array as $k => $v) {
497 foreach ($
$k as $k2 => $v2) {
498 $newArray[stripslashes($k2)] = stripslashes($v2);
502 $
$k = stripslashes($v);
505 /* Re-assign back to the array. */
510 $PHP_SELF = php_self();