after tagging rel-1_1_2, this is now 1.1.3
[squirrelmail.git] / functions / strings.php
1 <?php
2
3 /* $Id$ */
4
5 if (defined('strings_php'))
6 return;
7 define('strings_php', true);
8
9
10 //*************************************************************************
11 // Count the number of occurances of $needle are in $haystack.
12 // $needle can be a character or string, and need not occur in $haystack
13 //*************************************************************************
14 function countCharInString($haystack, $needle) {
15 if ($needle == '') return 0;
16 return count(explode($needle, $haystack));
17 }
18
19 //*************************************************************************
20 // Read from the back of $haystack until $needle is found, or the begining
21 // of the $haystack is reached. $needle is a single character
22 //*************************************************************************
23 function readShortMailboxName($haystack, $needle) {
24 if ($needle == '') return $haystack;
25 $parts = explode($needle, $haystack);
26 $elem = array_pop($parts);
27 while ($elem == '' && count($parts))
28 {
29 $elem = array_pop($parts);
30 }
31 return $elem;
32 }
33
34 //*************************************************************************
35 // Read from the back of $haystack until $needle is found, or the begining
36 // of the $haystack is reached. $needle is a single character
37 //*************************************************************************
38 function readMailboxParent($haystack, $needle) {
39 if ($needle == '') return '';
40 $parts = explode($needle, $haystack);
41 $elem = array_pop($parts);
42 while ($elem == '' && count($parts))
43 {
44 $elem = array_pop($parts);
45 }
46 return join($needle, $parts);
47 }
48
49 // Searches for the next position in a string minus white space
50 function next_pos_minus_white ($haystack, $pos) {
51 while (substr($haystack, $pos, 1) == ' ' ||
52 substr($haystack, $pos, 1) == "\t" ||
53 substr($haystack, $pos, 1) == "\n" ||
54 substr($haystack, $pos, 1) == "\r") {
55 if ($pos >= strlen($haystack))
56 return -1;
57 $pos++;
58 }
59 return $pos;
60 }
61
62 // Wraps text at $wrap characters
63 // Has a problem with special HTML characters, so call this before
64 // you do character translation.
65 // Specifically, &#039 comes up as 5 characters instead of 1.
66 // This should not add newlines to the end of lines.
67 function sqWordWrap(&$line, $wrap) {
68 ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
69 $beginning_spaces = $regs[1];
70 if (isset($regs[2])) {
71 $words = explode(' ', $regs[2]);
72 } else {
73 $words = "";
74 }
75
76 $i = 0;
77 $line = $beginning_spaces;
78
79 while ($i < count($words)) {
80 // Force one word to be on a line (minimum)
81 $line .= $words[$i];
82 $line_len = strlen($beginning_spaces) + strlen($words[$i]) + 2;
83 if (isset($words[$i + 1]))
84 $line_len += strlen($words[$i + 1]);
85 $i ++;
86
87 // Add more words (as long as they fit)
88 while ($line_len < $wrap && $i < count($words)) {
89 $line .= ' ' . $words[$i];
90 $i++;
91 if (isset($words[$i]))
92 $line_len += strlen($words[$i]) + 1;
93 else
94 $line_len += 1;
95 }
96
97 // Skip spaces if they are the first thing on a continued line
98 while (!isset($words[$i]) && $i < count($words)) {
99 $i ++;
100 }
101
102 // Go to the next line if we have more to process
103 if ($i < count($words)) {
104 $line .= "\n" . $beginning_spaces;
105 }
106 }
107 }
108
109
110 // Does the opposite of sqWordWrap()
111 function sqUnWordWrap(&$body)
112 {
113 $lines = explode("\n", $body);
114 $body = "";
115 $PreviousSpaces = "";
116 for ($i = 0; $i < count($lines); $i ++)
117 {
118 ereg("^([\t >]*)([^\t >].*)?$", $lines[$i], $regs);
119 $CurrentSpaces = $regs[1];
120 if (isset($regs[2]))
121 $CurrentRest = $regs[2];
122 if ($i == 0)
123 {
124 $PreviousSpaces = $CurrentSpaces;
125 $body = $lines[$i];
126 }
127 else if ($PreviousSpaces == $CurrentSpaces && // Do the beginnings match
128 strlen($lines[$i - 1]) > 65 && // Over 65 characters long
129 strlen($CurrentRest)) // and there's a line to continue with
130 {
131 $body .= ' ' . $CurrentRest;
132 }
133 else
134 {
135 $body .= "\n" . $lines[$i];
136 $PreviousSpaces = $CurrentSpaces;
137 }
138 }
139 $body .= "\n";
140 }
141
142
143 /** Returns an array of email addresses **/
144 /* Be cautious of "user@host.com" */
145 function parseAddrs($text) {
146 if (trim($text) == "")
147 return array();
148 $text = str_replace(' ', '', $text);
149 $text = ereg_replace('"[^"]*"', '', $text);
150 $text = ereg_replace('\\([^\\)]*\\)', '', $text);
151 $text = str_replace(',', ';', $text);
152 $array = explode(';', $text);
153 for ($i = 0; $i < count ($array); $i++) {
154 $array[$i] = eregi_replace ("^.*[<]", '', $array[$i]);
155 $array[$i] = eregi_replace ("[>].*$", '', $array[$i]);
156 }
157 return $array;
158 }
159
160 /** Returns a line of comma separated email addresses from an array **/
161 function getLineOfAddrs($array) {
162 if (is_array($array)) {
163 $to_line = implode(', ', $array);
164 $to_line = trim(ereg_replace(', (, )+', ', ', $to_line));
165 } else {
166 $to_line = '';
167 }
168 return $to_line;
169 }
170
171 function translateText(&$body, $wrap_at, $charset) {
172 global $where, $what; // from searching
173
174 include '../functions/url_parser.php';
175
176 $body_ary = explode("\n", $body);
177 $PriorQuotes = 0;
178 for ($i=0; $i < count($body_ary); $i++) {
179 $line = $body_ary[$i];
180 if (strlen($line) - 2 >= $wrap_at) {
181 sqWordWrap($line, $wrap_at);
182 }
183 $line = charset_decode($charset, $line);
184 $line = str_replace("\t", ' ', $line);
185
186 parseUrl ($line);
187
188 $Quotes = 0;
189 $pos = 0;
190 while (1)
191 {
192 if ($line[$pos] == ' ')
193 {
194 $pos ++;
195 }
196 else if (strpos($line, '&gt;', $pos) === $pos)
197 {
198 $pos += 4;
199 $Quotes ++;
200 }
201 else
202 {
203 break;
204 }
205 }
206
207 if ($Quotes > 1)
208 $line = '<FONT COLOR="FF0000">'.$line.'</FONT>';
209 elseif ($Quotes)
210 $line = '<FONT COLOR="800000">'.$line.'</FONT>';
211
212 $body_ary[$i] = $line;
213 }
214 $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
215 }
216
217 /* SquirrelMail version number -- DO NOT CHANGE */
218 global $version;
219 $version = '1.1.3 [cvs]';
220
221
222 function find_mailbox_name ($mailbox) {
223 if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
224 return $regs[1];
225 ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
226 return $regs[1];
227
228 }
229
230 function get_location () {
231 # This determines the location to forward to relative
232 # to your server. If this doesnt work correctly for
233 # you (although it should), you can remove all this
234 # code except the last two lines, and change the header()
235 # function to look something like this, customized to
236 # the location of SquirrelMail on your server:
237 #
238 # http://www.myhost.com/squirrelmail/src/login.php
239
240 global $PHP_SELF, $SERVER_NAME, $HTTP_HOST, $SERVER_PORT,
241 $HTTP_SERVER_VARS;
242
243 // Get the path
244 $path = substr($PHP_SELF, 0, strrpos($PHP_SELF, '/'));
245
246 // Check if this is a HTTPS or regular HTTP request
247 $proto = 'http://';
248 // If you have 'SSLOptions +StdEnvVars' in your apache config
249 // OR if you have HTTPS in your HTTP_SERVER_VARS
250 // OR if you are on port 443
251 $getEnvVar = getenv('HTTPS');
252 if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
253 (isset($HTTP_SERVER_VARS['HTTPS'])) ||
254 (isset($HTTP_SERVER_VARS['SERVER_PORT']) &&
255 $HTTP_SERVER_VARS['SERVER_PORT'] == 443)) {
256 $proto = 'https://';
257 }
258
259 // Get the hostname from the Host header or server config.
260 $host = '';
261 if (isset($HTTP_HOST) && !empty($HTTP_HOST))
262 {
263 $host = $HTTP_HOST;
264 }
265 else if (isset($SERVER_NAME) && !empty($SERVER_NAME))
266 {
267 $host = $SERVER_NAME;
268 }
269
270 $port = '';
271 if (! strstr($host, ':'))
272 {
273 if (isset($SERVER_PORT)) {
274 if (($SERVER_PORT != 80 && $proto == 'http://')
275 || ($SERVER_PORT != 443 && $proto == 'https://')) {
276 $port = sprintf(':%d', $SERVER_PORT);
277 }
278 }
279 }
280
281 if ($host)
282 return $proto . $host . $port . $path;
283
284 // Fallback is to omit the server name and use a relative URI,
285 // although this is not RFC 2616 compliant.
286 return $path;
287 }
288
289
290 // These functions are used to encrypt the passowrd before it is
291 // stored in a cookie.
292 function OneTimePadEncrypt ($string, $epad) {
293 $pad = base64_decode($epad);
294 $encrypted = '';
295 for ($i = 0; $i < strlen ($string); $i++) {
296 $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
297 }
298
299 return base64_encode($encrypted);
300 }
301
302 function OneTimePadDecrypt ($string, $epad) {
303 $pad = base64_decode($epad);
304 $encrypted = base64_decode ($string);
305 $decrypted = '';
306 for ($i = 0; $i < strlen ($encrypted); $i++) {
307 $decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i]));
308 }
309
310 return $decrypted;
311 }
312
313
314 // Randomize the mt_rand() function. Toss this in strings or
315 // integers and it will seed the generator appropriately.
316 // With strings, it is better to get them long. Use md5() to
317 // lengthen smaller strings.
318 function sq_mt_seed($Val)
319 {
320 // if mt_getrandmax() does not return a 2^n - 1 number,
321 // this might not work well. This uses $Max as a bitmask.
322 $Max = mt_getrandmax();
323
324 if (! is_int($Val))
325 {
326 if (function_exists('crc32'))
327 {
328 $Val = crc32($Val);
329 }
330 else
331 {
332 $Str = $Val;
333 $Pos = 0;
334 $Val = 0;
335 $Mask = $Max / 2;
336 $HighBit = $Max ^ $Mask;
337 while ($Pos < strlen($Str))
338 {
339 if ($Val & $HighBit)
340 {
341 $Val = (($Val & $Mask) << 1) + 1;
342 }
343 else
344 {
345 $Val = ($Val & $Mask) << 1;
346 }
347 $Val ^= $Str[$Pos];
348 $Pos ++;
349 }
350 }
351 }
352
353 if ($Val < 0)
354 $Val *= -1;
355 if ($Val = 0)
356 return;
357
358 mt_srand(($Val ^ mt_rand(0, $Max)) & $Max);
359 }
360
361
362 // This function initializes the random number generator fairly well.
363 // It also only initializes it once, so you don't accidentally get
364 // the same 'random' numbers twice in one session.
365 function sq_mt_randomize()
366 {
367 global $REMOTE_PORT, $REMOTE_ADDR, $UNIQUE_ID;
368 static $randomized;
369
370 if ($randomized)
371 return;
372
373 // Global
374 sq_mt_seed((int)((double) microtime() * 1000000));
375 sq_mt_seed(md5($REMOTE_PORT . $REMOTE_ADDR . getmypid()));
376
377 // getrusage
378 if (function_exists('getrusage')) {
379 // Avoid warnings with Win32
380 $dat = @getrusage();
381 if (isset($dat) && is_array($dat))
382 {
383 $Str = '';
384 foreach ($dat as $k => $v)
385 {
386 $Str .= $k . $v;
387 }
388 sq_mt_seed(md5($Str));
389 }
390 }
391
392 // Apache-specific
393 sq_mt_seed(md5($UNIQUE_ID));
394
395 $randomized = 1;
396 }
397
398 function OneTimePadCreate ($length=100) {
399 sq_mt_randomize();
400
401 $pad = '';
402 for ($i = 0; $i < $length; $i++) {
403 $pad .= chr(mt_rand(0,255));
404 }
405
406 return base64_encode($pad);
407 }
408
409 // Check if we have a required PHP-version. Return TRUE if we do,
410 // or FALSE if we don't.
411 // To check for 4.0.1, use sqCheckPHPVersion(4,0,1)
412 // To check for 4.0b3, use sqCheckPHPVersion(4,0,-3)
413 // Does not handle betas like 4.0.1b1 or development versions
414 function sqCheckPHPVersion($major, $minor, $release) {
415
416 $ver = phpversion();
417 eregi('^([0-9]+)\\.([0-9]+)(.*)', $ver, $regs);
418
419 // Parse the version string
420 $vmajor = strval($regs[1]);
421 $vminor = strval($regs[2]);
422 $vrel = $regs[3];
423 if($vrel[0] == ".")
424 $vrel = strval(substr($vrel, 1));
425 if($vrel[0] == 'b' || $vrel[0] == 'B')
426 $vrel = - strval(substr($vrel, 1));
427 if($vrel[0] == 'r' || $vrel[0] == 'R')
428 $vrel = - strval(substr($vrel, 2))/10;
429
430 // Compare major version
431 if($vmajor < $major) return false;
432 if($vmajor > $major) return true;
433
434 // Major is the same. Compare minor
435 if($vminor < $minor) return false;
436 if($vminor > $minor) return true;
437
438 // Major and minor is the same as the required one.
439 // Compare release
440 if($vrel >= 0 && $release >= 0) { // Neither are beta
441 if($vrel < $release) return false;
442 } else if($vrel >= 0 && $release < 0){ // This is not beta, required is beta
443 return true;
444 } else if($vrel < 0 && $release >= 0){ // This is beta, require not beta
445 return false;
446 } else { // Both are beta
447 if($vrel > $release) return false;
448 }
449
450 return true;
451 }
452
453 /* Returns a string showing the size of the message/attachment */
454 function show_readable_size($bytes)
455 {
456 $bytes /= 1024;
457 $type = 'k';
458
459 if ($bytes / 1024 > 1)
460 {
461 $bytes /= 1024;
462 $type = 'm';
463 }
464
465 if ($bytes < 10)
466 {
467 $bytes *= 10;
468 settype($bytes, 'integer');
469 $bytes /= 10;
470 }
471 else
472 settype($bytes, 'integer');
473
474 return $bytes . '<small>&nbsp;' . $type . '</small>';
475 }
476
477 /* Generates a random string from the caracter set you pass in
478 *
479 * Flags:
480 * 1 = add lowercase a-z to $chars
481 * 2 = add uppercase A-Z to $chars
482 * 4 = add numbers 0-9 to $chars
483 */
484
485 function GenerateRandomString($size, $chars, $flags = 0)
486 {
487 if ($flags & 0x1)
488 $chars .= 'abcdefghijklmnopqrstuvwxyz';
489 if ($flags & 0x2)
490 $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
491 if ($flags & 0x4)
492 $chars .= '0123456789';
493
494 if ($size < 1 || strlen($chars) < 1)
495 return '';
496
497 sq_mt_randomize(); // Initialize the random number generator
498
499 $String = "";
500 while (strlen($String) < $size) {
501 $String .= $chars[mt_rand(0, strlen($chars))];
502 }
503
504 return $String;
505 }
506
507 function quoteIMAP($str)
508 {
509 return ereg_replace('(["\\])', '\\\\1', $str);
510 }
511
512 ?>