5 ** Copyright (c) 1999-2001 The Squirrelmail Development Team
6 ** Licensed under the GNU GPL. For full terms see the file COPYING.
8 ** This code provides various string manipulation functions that are
9 ** used by the rest of the Squirrelmail code.
15 * SquirrelMail version number -- DO NOT CHANGE
18 $version = '1.2.0 [cvs]';
21 * Count the number of occurances of $needle are in $haystack.
22 * $needle can be a character or string, and need not occur in $haystack
24 function countCharInString($haystack, $needle) {
25 if ($needle == '') return 0;
26 return count(explode($needle, $haystack));
30 * Read from the back of $haystack until $needle is found, or the begining
31 * of the $haystack is reached. $needle is a single character
33 function readShortMailboxName($haystack, $needle) {
34 if ($needle == '') return $haystack;
35 $parts = explode($needle, $haystack);
36 $elem = array_pop($parts);
37 while ($elem == '' && count($parts))
39 $elem = array_pop($parts);
45 * Read from the back of $haystack until $needle is found, or the begining
46 * of the $haystack is reached. $needle is a single character
48 function readMailboxParent($haystack, $needle) {
49 if ($needle == '') return '';
50 $parts = explode($needle, $haystack);
51 $elem = array_pop($parts);
52 while ($elem == '' && count($parts))
54 $elem = array_pop($parts);
56 return join($needle, $parts);
60 * Searches for the next position in a string minus white space.
62 function next_pos_minus_white ($haystack, $pos) {
63 while (substr($haystack, $pos, 1) == ' ' ||
64 substr($haystack, $pos, 1) == "\t" ||
65 substr($haystack, $pos, 1) == "\n" ||
66 substr($haystack, $pos, 1) == "\r") {
67 if ($pos >= strlen($haystack))
75 * Wraps text at $wrap characters
77 * Has a problem with special HTML characters, so call this before
78 * you do character translation.
80 * Specifically, ' comes up as 5 characters instead of 1.
81 * This should not add newlines to the end of lines.
83 function sqWordWrap(&$line, $wrap) {
84 ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
85 $beginning_spaces = $regs[1];
86 if (isset($regs[2])) {
87 $words = explode(' ', $regs[2]);
93 $line = $beginning_spaces;
95 while ($i < count($words)) {
96 // Force one word to be on a line (minimum)
98 $line_len = strlen($beginning_spaces) +
strlen($words[$i]) +
2;
99 if (isset($words[$i +
1]))
100 $line_len +
= strlen($words[$i +
1]);
103 // Add more words (as long as they fit)
104 while ($line_len < $wrap && $i < count($words)) {
105 $line .= ' ' . $words[$i];
107 if (isset($words[$i]))
108 $line_len +
= strlen($words[$i]) +
1;
113 // Skip spaces if they are the first thing on a continued line
114 while (!isset($words[$i]) && $i < count($words)) {
118 // Go to the next line if we have more to process
119 if ($i < count($words)) {
120 $line .= "\n" . $beginning_spaces;
127 * Does the opposite of sqWordWrap()
129 function sqUnWordWrap(&$body) {
130 $lines = explode("\n", $body);
132 $PreviousSpaces = "";
133 for ($i = 0; $i < count($lines); $i ++
) {
134 ereg("^([\t >]*)([^\t >].*)?$", $lines[$i], $regs);
135 $CurrentSpaces = $regs[1];
136 if (isset($regs[2])) {
137 $CurrentRest = $regs[2];
141 $PreviousSpaces = $CurrentSpaces;
143 } else if (($PreviousSpaces == $CurrentSpaces) // Do the beginnings match
144 && (strlen($lines[$i - 1]) > 65) // Over 65 characters long
145 && strlen($CurrentRest)) { // and there's a line to continue with
146 $body .= ' ' . $CurrentRest;
148 $body .= "\n" . $lines[$i];
149 $PreviousSpaces = $CurrentSpaces;
157 * Returns an array of email addresses.
158 * Be cautious of "user@host.com"
160 function parseAddrs($text) {
161 if (trim($text) == "")
163 $text = str_replace(' ', '', $text);
164 $text = ereg_replace('"[^"]*"', '', $text);
165 $text = ereg_replace('\\([^\\)]*\\)', '', $text);
166 $text = str_replace(',', ';', $text);
167 $array = explode(';', $text);
168 for ($i = 0; $i < count ($array); $i++
) {
169 $array[$i] = eregi_replace ("^.*[<]", '', $array[$i]);
170 $array[$i] = eregi_replace ("[>].*$", '', $array[$i]);
176 * Returns a line of comma separated email addresses from an array.
178 function getLineOfAddrs($array) {
179 if (is_array($array)) {
180 $to_line = implode(', ', $array);
181 $to_line = ereg_replace(', (, )+', ', ', $to_line);
182 $to_line = trim(ereg_replace('^, ', '', $to_line));
183 if( substr( $to_line, -1 ) == ',' )
184 $to_line = substr( $to_line, 0, -1 );
192 function translateText(&$body, $wrap_at, $charset) {
193 global $where, $what; // from searching
194 global $color; // color theme
196 require_once('../functions/url_parser.php');
198 $body_ary = explode("\n", $body);
200 for ($i=0; $i < count($body_ary); $i++
) {
201 $line = $body_ary[$i];
202 if (strlen($line) - 2 >= $wrap_at) {
203 sqWordWrap($line, $wrap_at);
205 $line = charset_decode($charset, $line);
206 $line = str_replace("\t", ' ', $line);
213 if ($line[$pos] == ' ') {
215 } else if (strpos($line, '>', $pos) === $pos) {
224 if (! isset($color[14])) {
225 $color[14] = '#FF0000';
227 $line = '<FONT COLOR="' . $color[14] . '">' . $line . '</FONT>';
229 if (! isset($color[13])) {
230 $color[13] = '#800000';
232 $line = '<FONT COLOR="' . $color[13] . '">' . $line . '</FONT>';
235 $body_ary[$i] = $line;
237 $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
240 function find_mailbox_name ($mailbox) {
241 if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
243 ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
249 * This determines the location to forward to relative to your server.
250 * If this doesnt work correctly for you (although it should), you can
251 * remove all this code except the last two lines, and change the header()
252 * function to look something like this, customized to the location of
253 * SquirrelMail on your server:
255 * http://www.myhost.com/squirrelmail/src/login.php
257 function get_location () {
259 global $PHP_SELF, $SERVER_NAME, $HTTP_HOST, $SERVER_PORT,
263 $path = substr($PHP_SELF, 0, strrpos($PHP_SELF, '/'));
265 /* Check if this is a HTTPS or regular HTTP request. */
269 * If you have 'SSLOptions +StdEnvVars' in your apache config
270 * OR if you have HTTPS in your HTTP_SERVER_VARS
271 * OR if you are on port 443
273 $getEnvVar = getenv('HTTPS');
274 if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
275 (isset($HTTP_SERVER_VARS['HTTPS'])) ||
276 (isset($HTTP_SERVER_VARS['SERVER_PORT']) &&
277 $HTTP_SERVER_VARS['SERVER_PORT'] == 443)) {
281 // Get the hostname from the Host header or server config.
283 if (isset($HTTP_HOST) && !empty($HTTP_HOST)) {
285 } else if (isset($SERVER_NAME) && !empty($SERVER_NAME)) {
286 $host = $SERVER_NAME;
290 if (! strstr($host, ':')) {
291 if (isset($SERVER_PORT)) {
292 if (($SERVER_PORT != 80 && $proto == 'http://')
293 ||
($SERVER_PORT != 443 && $proto == 'https://')) {
294 $port = sprintf(':%d', $SERVER_PORT);
299 /* Fallback is to omit the server name and use a relative */
300 /* URI, although this is not RFC 2616 compliant. */
301 return ($host ?
$proto . $host . $port . $path : $path);
306 * These functions are used to encrypt the passowrd before it is
307 * stored in a cookie.
309 function OneTimePadEncrypt ($string, $epad) {
310 $pad = base64_decode($epad);
312 for ($i = 0; $i < strlen ($string); $i++
) {
313 $encrypted .= chr (ord($string[$i]) ^
ord($pad[$i]));
316 return base64_encode($encrypted);
319 function OneTimePadDecrypt ($string, $epad) {
320 $pad = base64_decode($epad);
321 $encrypted = base64_decode ($string);
323 for ($i = 0; $i < strlen ($encrypted); $i++
) {
324 $decrypted .= chr (ord($encrypted[$i]) ^
ord($pad[$i]));
332 * Randomize the mt_rand() function. Toss this in strings or integers
333 * and it will seed the generator appropriately. With strings, it is
334 * better to get them long. Use md5() to lengthen smaller strings.
336 function sq_mt_seed($Val) {
337 // if mt_getrandmax() does not return a 2^n - 1 number,
338 // this might not work well. This uses $Max as a bitmask.
339 $Max = mt_getrandmax();
341 if (! is_int($Val)) {
342 if (function_exists('crc32')) {
349 $HighBit = $Max ^
$Mask;
350 while ($Pos < strlen($Str)) {
351 if ($Val & $HighBit) {
352 $Val = (($Val & $Mask) << 1) +
1;
354 $Val = ($Val & $Mask) << 1;
370 mt_srand(($Val ^
mt_rand(0, $Max)) & $Max);
375 * This function initializes the random number generator fairly well.
376 * It also only initializes it once, so you don't accidentally get
377 * the same 'random' numbers twice in one session.
379 function sq_mt_randomize() {
380 global $REMOTE_PORT, $REMOTE_ADDR, $UNIQUE_ID;
388 sq_mt_seed((int)((double) microtime() * 1000000));
389 sq_mt_seed(md5($REMOTE_PORT . $REMOTE_ADDR . getmypid()));
392 if (function_exists('getrusage')) {
393 // Avoid warnings with Win32
395 if (isset($dat) && is_array($dat)) {
397 foreach ($dat as $k => $v)
401 sq_mt_seed(md5($Str));
406 sq_mt_seed(md5($UNIQUE_ID));
411 function OneTimePadCreate ($length=100) {
415 for ($i = 0; $i < $length; $i++
) {
416 $pad .= chr(mt_rand(0,255));
419 return base64_encode($pad);
423 * Check if we have a required PHP-version. Return TRUE if we do,
424 * or FALSE if we don't.
426 * To check for 4.0.1, use sqCheckPHPVersion(4,0,1)
427 * To check for 4.0b3, use sqCheckPHPVersion(4,0,-3)
429 * Does not handle betas like 4.0.1b1 or development versions
431 function sqCheckPHPVersion($major, $minor, $release) {
434 eregi('^([0-9]+)\\.([0-9]+)(.*)', $ver, $regs);
436 /* Parse the version string. */
437 $vmajor = strval($regs[1]);
438 $vminor = strval($regs[2]);
440 if($vrel[0] == ".") {
441 $vrel = strval(substr($vrel, 1));
443 if($vrel[0] == 'b' ||
$vrel[0] == 'B') {
444 $vrel = - strval(substr($vrel, 1));
446 if($vrel[0] == 'r' ||
$vrel[0] == 'R') {
447 $vrel = - strval(substr($vrel, 2))/10;
450 /* Compare major version. */
451 if ($vmajor < $major) { return false; }
452 if ($vmajor > $major) { return true; }
454 /* Major is the same. Compare minor. */
455 if ($vminor < $minor) { return false; }
456 if ($vminor > $minor) { return true; }
458 /* Major and minor is the same as the required one. Compare release */
459 if ($vrel >= 0 && $release >= 0) { // Neither are beta
460 if($vrel < $release) return false;
461 } else if($vrel >= 0 && $release < 0) { // This is not beta, required is beta
463 } else if($vrel < 0 && $release >= 0){ // This is beta, require not beta
465 } else { // Both are beta
466 if($vrel > $release) return false;
473 * Returns a string showing the size of the message/attachment.
475 function show_readable_size($bytes) {
479 if ($bytes / 1024 > 1) {
486 settype($bytes, 'integer');
489 settype($bytes, 'integer');
492 return $bytes . '<small> ' . $type . '</small>';
496 * Generates a random string from the caracter set you pass in
499 * 1 = add lowercase a-z to $chars
500 * 2 = add uppercase A-Z to $chars
501 * 4 = add numbers 0-9 to $chars
504 function GenerateRandomString($size, $chars, $flags = 0) {
506 $chars .= 'abcdefghijklmnopqrstuvwxyz';
509 $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
512 $chars .= '0123456789';
515 if (($size < 1) ||
(strlen($chars) < 1)) {
519 sq_mt_randomize(); // Initialize the random number generator
522 while (strlen($String) < $size) {
523 $String .= $chars[mt_rand(0, strlen($chars))];
529 function quoteIMAP($str) {
530 return ereg_replace('(["\\])', '\\\\1', $str);
534 * Trims every element in the array
536 function TrimArray(&$array) {
537 foreach ($array as $k => $v) {
540 foreach ($
$k as $k2 => $v2) {
541 $
$k[$k2] = substr($v2, 1);
547 /* Re-assign back to array. */
553 * Removes slashes from every element in the array
555 function RemoveSlashes(&$array) {
556 foreach ($array as $k => $v) {
559 foreach ($
$k as $k2 => $v2) {
560 $newArray[stripslashes($k2)] = stripslashes($v2);
564 $
$k = stripslashes($v);
567 /* Re-assign back to the array. */