df511b32f36e5fec1cdf682a8fa134e62f1f8f9c
[squirrelmail.git] / functions / strings.php
1 <?php
2
3 /**
4 * strings.php
5 *
6 * This code provides various string manipulation functions that are
7 * used by the rest of the SquirrelMail code.
8 *
9 * @copyright &copy; 1999-2005 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @version $Id$
12 * @package squirrelmail
13 */
14
15 /** @ignore */
16 if (!defined('SM_PATH')) define('SM_PATH','../');
17
18 /**
19 * SquirrelMail version number -- DO NOT CHANGE
20 */
21 global $version;
22 $version = '1.5.1 [CVS]';
23
24 /**
25 * SquirrelMail internal version number -- DO NOT CHANGE
26 * $sm_internal_version = array (release, major, minor)
27 */
28 global $SQM_INTERNAL_VERSION;
29 $SQM_INTERNAL_VERSION = array(1,5,1);
30
31 /**
32 * There can be a circular issue with includes, where the $version string is
33 * referenced by the include of global.php, etc. before it's defined.
34 * For that reason, bring in global.php AFTER we define the version strings.
35 */
36 include_once(SM_PATH . 'functions/global.php');
37
38 /**
39 * Appends citation markers to the string.
40 * Also appends a trailing space.
41 *
42 * @author Justus Pendleton
43 * @param string $str The string to append to
44 * @param int $citeLevel the number of markers to append
45 * @return null
46 * @since 1.5.1
47 */
48 function sqMakeCite (&$str, $citeLevel) {
49 for ($i = 0; $i < $citeLevel; $i++) {
50 $str .= '>';
51 }
52 if ($citeLevel != 0) {
53 $str .= ' ';
54 }
55 }
56
57 /**
58 * Create a newline in the string, adding citation
59 * markers to the newline as necessary.
60 *
61 * @author Justus Pendleton
62 * @param string $str the string to make a newline in
63 * @param int $citeLevel the citation level the newline is at
64 * @param int $column starting column of the newline
65 * @return null
66 * @since 1.5.1
67 */
68 function sqMakeNewLine (&$str, $citeLevel, &$column) {
69 $str .= "\n";
70 $column = 0;
71 if ($citeLevel > 0) {
72 sqMakeCite ($str, $citeLevel);
73 $column = $citeLevel + 1;
74 } else {
75 $column = 0;
76 }
77 }
78
79 /**
80 * Checks for spaces in strings - only used if PHP doesn't have native ctype support
81 *
82 * You might be able to rewrite the function by adding short evaluation form.
83 *
84 * possible problems:
85 * - iso-2022-xx charsets - hex 20 might be part of other symbol. I might
86 * be wrong. 0x20 is not used in iso-2022-jp. I haven't checked iso-2022-kr
87 * and iso-2022-cn mappings.
88 *
89 * - no-break space (&nbsp;) - it is 8bit symbol, that depends on charset.
90 * there are at least three different charset groups that have nbsp in
91 * different places.
92 *
93 * I don't see any charset/nbsp options in php ctype either.
94 *
95 * @param string $string tested string
96 * @return bool true when only whitespace symbols are present in test string
97 * @since 1.5.1
98 */
99 function sm_ctype_space($string) {
100 if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) || $string=='') {
101 return true;
102 } else {
103 return false;
104 }
105 }
106
107 /**
108 * Wraps text at $wrap characters. While sqWordWrap takes
109 * a single line of text and wraps it, this function works
110 * on the entire corpus at once, this allows it to be a little
111 * bit smarter and when and how to wrap.
112 *
113 * @author Justus Pendleton
114 * @param string $body the entire body of text
115 * @param int $wrap the maximum line length
116 * @return string the wrapped text
117 * @since 1.5.1
118 */
119 function &sqBodyWrap (&$body, $wrap) {
120 //check for ctype support, and fake it if it doesn't exist
121 if (!function_exists('ctype_space')) {
122 function ctype_space ($string) {
123 return sm_ctype_space($string);
124 }
125 }
126
127 // the newly wrapped text
128 $outString = '';
129 // current column since the last newline in the outstring
130 $outStringCol = 0;
131 $length = sq_strlen($body);
132 // where we are in the original string
133 $pos = 0;
134 // the number of >>> citation markers we are currently at
135 $citeLevel = 0;
136
137 // the main loop, whenever we start a newline of input text
138 // we start from here
139 while ($pos < $length) {
140 // we're at the beginning of a line, get the new cite level
141 $newCiteLevel = 0;
142
143 while (($pos < $length) && (sq_substr($body,$pos,1) == '>')) {
144 $newCiteLevel++;
145 $pos++;
146
147 // skip over any spaces interleaved among the cite markers
148 while (($pos < $length) && (sq_substr($body,$pos,1) == ' ')) {
149
150 $pos++;
151
152 }
153 if ($pos >= $length) {
154 break;
155 }
156 }
157
158 // special case: if this is a blank line then maintain it
159 // (i.e. try to preserve original paragraph breaks)
160 // unless they occur at the very beginning of the text
161 if ((sq_substr($body,$pos,1) == "\n" ) && (sq_strlen($outString) != 0)) {
162 $outStringLast = $outString{sq_strlen($outString) - 1};
163 if ($outStringLast != "\n") {
164 $outString .= "\n";
165 }
166 sqMakeCite ($outString, $newCiteLevel);
167 $outString .= "\n";
168 $pos++;
169 $outStringCol = 0;
170 continue;
171 }
172
173 // if the cite level has changed, then start a new line
174 // with the new cite level.
175 if (($citeLevel != $newCiteLevel) && ($pos > ($newCiteLevel + 1)) && ($outStringCol != 0)) {
176 sqMakeNewLine ($outString, 0, $outStringCol);
177 }
178
179 $citeLevel = $newCiteLevel;
180
181 // prepend the quote level if necessary
182 if ($outStringCol == 0) {
183 sqMakeCite ($outString, $citeLevel);
184 // if we added a citation then move the column
185 // out by citelevel + 1 (the cite markers + the space)
186 $outStringCol = $citeLevel + ($citeLevel ? 1 : 0);
187 } else if ($outStringCol > $citeLevel) {
188 // not a cite and we're not at the beginning of a line
189 // in the output. add a space to separate the new text
190 // from previous text.
191 $outString .= ' ';
192 $outStringCol++;
193 }
194
195 // find the next newline -- we don't want to go further than that
196 $nextNewline = sq_strpos ($body, "\n", $pos);
197 if ($nextNewline === FALSE) {
198 $nextNewline = $length;
199 }
200
201 // Don't wrap unquoted lines at all. For now the textarea
202 // will work fine for this. Maybe revisit this later though
203 // (for completeness more than anything else, I think)
204 if ($citeLevel == 0) {
205 $outString .= sq_substr ($body, $pos, ($nextNewline - $pos));
206 $outStringCol = $nextNewline - $pos;
207 if ($nextNewline != $length) {
208 sqMakeNewLine ($outString, 0, $outStringCol);
209 }
210 $pos = $nextNewline + 1;
211 continue;
212 }
213 /**
214 * Set this to false to stop appending short strings to previous lines
215 */
216 $smartwrap = true;
217 // inner loop, (obviously) handles wrapping up to
218 // the next newline
219 while ($pos < $nextNewline) {
220 // skip over initial spaces
221 while (($pos < $nextNewline) && (ctype_space (sq_substr($body,$pos,1)))) {
222 $pos++;
223 }
224 // if this is a short line then just append it and continue outer loop
225 if (($outStringCol + $nextNewline - $pos) <= ($wrap - $citeLevel - 1) ) {
226 // if this is the final line in the input string then include
227 // any trailing newlines
228 // echo substr($body,$pos,$wrap). "<br />";
229 if (($nextNewline + 1 == $length) && (sq_substr($body,$nextNewline,1) == "\n")) {
230 $nextNewline++;
231 }
232
233 // trim trailing spaces
234 $lastRealChar = $nextNewline;
235 while (($lastRealChar > $pos && $lastRealChar < $length) && (ctype_space (sq_substr($body,$lastRealChar,1)))) {
236 $lastRealChar--;
237 }
238 // decide if appending the short string is what we want
239 if (($nextNewline < $length && sq_substr($body,$nextNewline,1) == "\n") &&
240 isset($lastRealChar)) {
241 $mypos = $pos;
242 //check the first word:
243 while (($mypos < $length) && (sq_substr($body,$mypos,1) == '>')) {
244 $mypos++;
245 // skip over any spaces interleaved among the cite markers
246 while (($mypos < $length) && (sq_substr($body,$mypos,1) == ' ')) {
247 $mypos++;
248 }
249 }
250 /*
251 $ldnspacecnt = 0;
252 if ($mypos == $nextNewline+1) {
253 while (($mypos < $length) && ($body{$mypos} == ' ')) {
254 $ldnspacecnt++;
255 }
256 }
257 */
258
259 $firstword = sq_substr($body,$mypos,sq_strpos($body,' ',$mypos) - $mypos);
260 //if ($dowrap || $ldnspacecnt > 1 || ($firstword && (
261 if (!$smartwrap || $firstword && (
262 $firstword{0} == '-' ||
263 $firstword{0} == '+' ||
264 $firstword{0} == '*' ||
265 sq_substr($firstword,0,1) == sq_strtoupper(sq_substr($firstword,0,1)) ||
266 strpos($firstword,':'))) {
267 $outString .= sq_substr($body,$pos,($lastRealChar - $pos+1));
268 $outStringCol += ($lastRealChar - $pos);
269 sqMakeNewLine($outString,$citeLevel,$outStringCol);
270 $nextNewline++;
271 $pos = $nextNewline;
272 $outStringCol--;
273 continue;
274 }
275
276 }
277
278 $outString .= sq_substr ($body, $pos, ($lastRealChar - $pos + 1));
279 $outStringCol += ($lastRealChar - $pos);
280 $pos = $nextNewline + 1;
281 continue;
282 }
283
284 $eol = $pos + $wrap - $citeLevel - $outStringCol;
285 // eol is the tentative end of line.
286 // look backwards for there for a whitespace to break at.
287 // if it's already less than our current position then
288 // our current line is already too long, break immediately
289 // and restart outer loop
290 if ($eol <= $pos) {
291 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
292 continue;
293 }
294
295 // start looking backwards for whitespace to break at.
296 $breakPoint = $eol;
297 while (($breakPoint > $pos) && (! ctype_space (sq_substr($body,$breakPoint,1)))) {
298 $breakPoint--;
299 }
300
301 // if we didn't find a breakpoint by looking backward then we
302 // need to figure out what to do about that
303 if ($breakPoint == $pos) {
304 // if we are not at the beginning then end this line
305 // and start a new loop
306 if ($outStringCol > ($citeLevel + 1)) {
307 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
308 continue;
309 } else {
310 // just hard break here. most likely we are breaking
311 // a really long URL. could also try searching
312 // forward for a break point, which is what Mozilla
313 // does. don't bother for now.
314 $breakPoint = $eol;
315 }
316 }
317
318 // special case: maybe we should have wrapped last
319 // time. if the first breakpoint here makes the
320 // current line too long and there is already text on
321 // the current line, break and loop again if at
322 // beginning of current line, don't force break
323 $SLOP = 6;
324 if ((($outStringCol + ($breakPoint - $pos)) > ($wrap + $SLOP)) && ($outStringCol > ($citeLevel + 1))) {
325 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
326 continue;
327 }
328
329 // skip newlines or whitespace at the beginning of the string
330 $substring = sq_substr ($body, $pos, ($breakPoint - $pos));
331 $substring = rtrim ($substring); // do rtrim and ctype_space have the same ideas about whitespace?
332 $outString .= $substring;
333 $outStringCol += sq_strlen ($substring);
334 // advance past the whitespace which caused the wrap
335 $pos = $breakPoint;
336 while (($pos < $length) && (ctype_space (sq_substr($body,$pos,1)))) {
337 $pos++;
338 }
339 if ($pos < $length) {
340 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
341 }
342 }
343 }
344
345 return $outString;
346 }
347
348 /**
349 * Wraps text at $wrap characters
350 *
351 * Has a problem with special HTML characters, so call this before
352 * you do character translation.
353 *
354 * Specifically, &amp;#039; comes up as 5 characters instead of 1.
355 * This should not add newlines to the end of lines.
356 *
357 * @param string $line the line of text to wrap, by ref
358 * @param int $wrap the maximum line lenth
359 * @param string $charset name of charset used in $line string. Available since v.1.5.1.
360 * @return void
361 * @since 1.0
362 */
363 function sqWordWrap(&$line, $wrap, $charset='') {
364 global $languages, $squirrelmail_language;
365
366 // Use custom wrapping function, if translation provides it
367 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
368 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap')) {
369 if (mb_detect_encoding($line) != 'ASCII') {
370 $line = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap', $line, $wrap);
371 return;
372 }
373 }
374
375 ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
376 $beginning_spaces = $regs[1];
377 if (isset($regs[2])) {
378 $words = explode(' ', $regs[2]);
379 } else {
380 $words = '';
381 }
382
383 $i = 0;
384 $line = $beginning_spaces;
385
386 while ($i < count($words)) {
387 /* Force one word to be on a line (minimum) */
388 $line .= $words[$i];
389 $line_len = strlen($beginning_spaces) + sq_strlen($words[$i],$charset) + 2;
390 if (isset($words[$i + 1]))
391 $line_len += sq_strlen($words[$i + 1],$charset);
392 $i ++;
393
394 /* Add more words (as long as they fit) */
395 while ($line_len < $wrap && $i < count($words)) {
396 $line .= ' ' . $words[$i];
397 $i++;
398 if (isset($words[$i]))
399 $line_len += sq_strlen($words[$i],$charset) + 1;
400 else
401 $line_len += 1;
402 }
403
404 /* Skip spaces if they are the first thing on a continued line */
405 while (!isset($words[$i]) && $i < count($words)) {
406 $i ++;
407 }
408
409 /* Go to the next line if we have more to process */
410 if ($i < count($words)) {
411 $line .= "\n";
412 }
413 }
414 }
415
416 /**
417 * Does the opposite of sqWordWrap()
418 * @param string $body the text to un-wordwrap
419 * @return void
420 * @since 1.0
421 */
422 function sqUnWordWrap(&$body) {
423 global $squirrelmail_language;
424
425 if ($squirrelmail_language == 'ja_JP') {
426 return;
427 }
428
429 $lines = explode("\n", $body);
430 $body = '';
431 $PreviousSpaces = '';
432 $cnt = count($lines);
433 for ($i = 0; $i < $cnt; $i ++) {
434 preg_match("/^([\t >]*)([^\t >].*)?$/", $lines[$i], $regs);
435 $CurrentSpaces = $regs[1];
436 if (isset($regs[2])) {
437 $CurrentRest = $regs[2];
438 } else {
439 $CurrentRest = '';
440 }
441
442 if ($i == 0) {
443 $PreviousSpaces = $CurrentSpaces;
444 $body = $lines[$i];
445 } else if (($PreviousSpaces == $CurrentSpaces) /* Do the beginnings match */
446 && (strlen($lines[$i - 1]) > 65) /* Over 65 characters long */
447 && strlen($CurrentRest)) { /* and there's a line to continue with */
448 $body .= ' ' . $CurrentRest;
449 } else {
450 $body .= "\n" . $lines[$i];
451 $PreviousSpaces = $CurrentSpaces;
452 }
453 }
454 $body .= "\n";
455 }
456
457 /**
458 * If $haystack is a full mailbox name and $needle is the mailbox
459 * separator character, returns the last part of the mailbox name.
460 *
461 * @param string haystack full mailbox name to search
462 * @param string needle the mailbox separator character
463 * @return string the last part of the mailbox name
464 * @since 1.0
465 */
466 function readShortMailboxName($haystack, $needle) {
467
468 if ($needle == '') {
469 $elem = $haystack;
470 } else {
471 $parts = explode($needle, $haystack);
472 $elem = array_pop($parts);
473 while ($elem == '' && count($parts)) {
474 $elem = array_pop($parts);
475 }
476 }
477 return( $elem );
478 }
479
480 /**
481 * get_location
482 *
483 * Determines the location to forward to, relative to your server.
484 * This is used in HTTP Location: redirects.
485 * If this doesnt work correctly for you (although it should), you can
486 * remove all this code except the last two lines, and have it return
487 * the right URL for your site, something like:
488 *
489 * http://www.example.com/squirrelmail/
490 *
491 * @return string the base url for this SquirrelMail installation
492 * @since 1.0
493 */
494 function get_location () {
495
496 global $imap_server_type;
497
498 /* Get the path, handle virtual directories */
499 if(strpos(php_self(), '?')) {
500 $path = substr(php_self(), 0, strpos(php_self(), '?'));
501 } else {
502 $path = php_self();
503 }
504 $path = substr($path, 0, strrpos($path, '/'));
505 if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) {
506 return $full_url . $path;
507 }
508
509 /* Check if this is a HTTPS or regular HTTP request. */
510 $proto = 'http://';
511
512 /*
513 * If you have 'SSLOptions +StdEnvVars' in your apache config
514 * OR if you have HTTPS=on in your HTTP_SERVER_VARS
515 * OR if you are on port 443
516 */
517 $getEnvVar = getenv('HTTPS');
518 if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
519 (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && !strcasecmp($https_on, 'on')) ||
520 (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) && $server_port == 443)) {
521 $proto = 'https://';
522 }
523
524 /* Get the hostname from the Host header or server config. */
525 if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) {
526 if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) {
527 $host = '';
528 }
529 }
530
531 $port = '';
532 if (! strstr($host, ':')) {
533 if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
534 if (($server_port != 80 && $proto == 'http://') ||
535 ($server_port != 443 && $proto == 'https://')) {
536 $port = sprintf(':%d', $server_port);
537 }
538 }
539 }
540
541 /* this is a workaround for the weird macosx caching that
542 causes Apache to return 16080 as the port number, which causes
543 SM to bail */
544
545 if ($imap_server_type == 'macosx' && $port == ':16080') {
546 $port = '';
547 }
548
549 /* Fallback is to omit the server name and use a relative */
550 /* URI, although this is not RFC 2616 compliant. */
551 $full_url = ($host ? $proto . $host . $port : '');
552 sqsession_register($full_url, 'sq_base_url');
553 return $full_url . $path;
554 }
555
556
557 /**
558 * Encrypts password
559 *
560 * These functions are used to encrypt the password before it is
561 * stored in a cookie. The encryption key is generated by
562 * OneTimePadCreate();
563 *
564 * @param string $string the (password)string to encrypt
565 * @param string $epad the encryption key
566 * @return string the base64-encoded encrypted password
567 * @since 1.0
568 */
569 function OneTimePadEncrypt ($string, $epad) {
570 $pad = base64_decode($epad);
571
572 if (strlen($pad)>0) {
573 // make sure that pad is longer than string
574 while (strlen($string)>strlen($pad)) {
575 $pad.=$pad;
576 }
577 } else {
578 // FIXME: what should we do when $epad is not base64 encoded or empty.
579 }
580
581 $encrypted = '';
582 for ($i = 0; $i < strlen ($string); $i++) {
583 $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
584 }
585
586 return base64_encode($encrypted);
587 }
588
589 /**
590 * Decrypts a password from the cookie
591 *
592 * Decrypts a password from the cookie, encrypted by OneTimePadEncrypt.
593 * This uses the encryption key that is stored in the session.
594 *
595 * @param string $string the string to decrypt
596 * @param string $epad the encryption key from the session
597 * @return string the decrypted password
598 * @since 1.0
599 */
600 function OneTimePadDecrypt ($string, $epad) {
601 $pad = base64_decode($epad);
602
603 if (strlen($pad)>0) {
604 // make sure that pad is longer than string
605 while (strlen($string)>strlen($pad)) {
606 $pad.=$pad;
607 }
608 } else {
609 // FIXME: what should we do when $epad is not base64 encoded or empty.
610 }
611
612 $encrypted = base64_decode ($string);
613 $decrypted = '';
614 for ($i = 0; $i < strlen ($encrypted); $i++) {
615 $decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i]));
616 }
617
618 return $decrypted;
619 }
620
621
622 /**
623 * Randomizes the mt_rand() function.
624 *
625 * Toss this in strings or integers and it will seed the generator
626 * appropriately. With strings, it is better to get them long.
627 * Use md5() to lengthen smaller strings.
628 *
629 * @param mixed $val a value to seed the random number generator. mixed = integer or string.
630 * @return void
631 * @since 1.0
632 */
633 function sq_mt_seed($Val) {
634 /* if mt_getrandmax() does not return a 2^n - 1 number,
635 this might not work well. This uses $Max as a bitmask. */
636 $Max = mt_getrandmax();
637
638 if (! is_int($Val)) {
639 $Val = crc32($Val);
640 }
641
642 if ($Val < 0) {
643 $Val *= -1;
644 }
645
646 if ($Val == 0) {
647 return;
648 }
649
650 mt_srand(($Val ^ mt_rand(0, $Max)) & $Max);
651 }
652
653
654 /**
655 * Init random number generator
656 *
657 * This function initializes the random number generator fairly well.
658 * It also only initializes it once, so you don't accidentally get
659 * the same 'random' numbers twice in one session.
660 *
661 * @return void
662 * @since 1.0
663 */
664 function sq_mt_randomize() {
665 static $randomized;
666
667 if ($randomized) {
668 return;
669 }
670
671 /* Global. */
672 sqgetGlobalVar('REMOTE_PORT', $remote_port, SQ_SERVER);
673 sqgetGlobalVar('REMOTE_ADDR', $remote_addr, SQ_SERVER);
674 sq_mt_seed((int)((double) microtime() * 1000000));
675 sq_mt_seed(md5($remote_port . $remote_addr . getmypid()));
676
677 /* getrusage */
678 if (function_exists('getrusage')) {
679 /* Avoid warnings with Win32 */
680 $dat = @getrusage();
681 if (isset($dat) && is_array($dat)) {
682 $Str = '';
683 foreach ($dat as $k => $v)
684 {
685 $Str .= $k . $v;
686 }
687 sq_mt_seed(md5($Str));
688 }
689 }
690
691 if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) {
692 sq_mt_seed(md5($unique_id));
693 }
694
695 $randomized = 1;
696 }
697
698 /**
699 * Creates encryption key
700 *
701 * Creates an encryption key for encrypting the password stored in the cookie.
702 * The encryption key itself is stored in the session.
703 *
704 * Pad must be longer or equal to encoded string length in 1.4.4/1.5.0 and older.
705 * @param int $length optional, length of the string to generate
706 * @return string the encryption key
707 * @since 1.0
708 */
709 function OneTimePadCreate ($length=100) {
710 sq_mt_randomize();
711
712 $pad = '';
713 for ($i = 0; $i < $length; $i++) {
714 $pad .= chr(mt_rand(0,255));
715 }
716
717 return base64_encode($pad);
718 }
719
720 /**
721 * Returns a string showing the size of the message/attachment.
722 *
723 * @param int $bytes the filesize in bytes
724 * @return string the filesize in human readable format
725 * @since 1.0
726 */
727 function show_readable_size($bytes) {
728 $bytes /= 1024;
729 $type = 'k';
730
731 if ($bytes / 1024 > 1) {
732 $bytes /= 1024;
733 $type = 'M';
734 }
735
736 if ($bytes < 10) {
737 $bytes *= 10;
738 settype($bytes, 'integer');
739 $bytes /= 10;
740 } else {
741 settype($bytes, 'integer');
742 }
743
744 return $bytes . '&nbsp;' . $type;
745 }
746
747 /**
748 * Generates a random string from the character set you pass in
749 *
750 * @param int $size the length of the string to generate
751 * @param string $chars a string containing the characters to use
752 * @param int $flags a flag to add a specific set to the characters to use:
753 * Flags:
754 * 1 = add lowercase a-z to $chars
755 * 2 = add uppercase A-Z to $chars
756 * 4 = add numbers 0-9 to $chars
757 * @return string the random string
758 * @since 1.0
759 */
760 function GenerateRandomString($size, $chars, $flags = 0) {
761 if ($flags & 0x1) {
762 $chars .= 'abcdefghijklmnopqrstuvwxyz';
763 }
764 if ($flags & 0x2) {
765 $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
766 }
767 if ($flags & 0x4) {
768 $chars .= '0123456789';
769 }
770
771 if (($size < 1) || (strlen($chars) < 1)) {
772 return '';
773 }
774
775 sq_mt_randomize(); /* Initialize the random number generator */
776
777 $String = '';
778 $j = strlen( $chars ) - 1;
779 while (strlen($String) < $size) {
780 $String .= $chars{mt_rand(0, $j)};
781 }
782
783 return $String;
784 }
785
786 /**
787 * Escapes special characters for use in IMAP commands.
788 *
789 * @param string $str the string to escape
790 * @return string the escaped string
791 * @since 1.0.3
792 */
793 function quoteimap($str) {
794 return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
795 }
796
797 /**
798 * Trims array
799 *
800 * Trims every element in the array, ie. remove the first char of each element
801 * @param array $array the array to trim
802 * @since 1.2.0
803 */
804 function TrimArray(&$array) {
805 foreach ($array as $k => $v) {
806 global $$k;
807 if (is_array($$k)) {
808 foreach ($$k as $k2 => $v2) {
809 $$k[$k2] = substr($v2, 1);
810 }
811 } else {
812 $$k = substr($v, 1);
813 }
814
815 /* Re-assign back to array. */
816 $array[$k] = $$k;
817 }
818 }
819
820 /**
821 * Create compose link
822 *
823 * Returns a link to the compose-page, taking in consideration
824 * the compose_in_new and javascript settings.
825 * @param string $url the URL to the compose page
826 * @param string $text the link text, default "Compose"
827 * @param string $target (since 1.4.3) url target
828 * @return string a link to the compose page
829 * @since 1.4.2
830 */
831 function makeComposeLink($url, $text = null, $target='') {
832 global $compose_new_win,$javascript_on, $compose_width, $compose_height;
833
834 if(!$text) {
835 $text = _("Compose");
836 }
837
838 // if not using "compose in new window", make
839 // regular link and be done with it
840 if($compose_new_win != '1') {
841 return makeInternalLink($url, $text, $target);
842 }
843
844 // build the compose in new window link...
845
846
847 // if javascript is on, use onclick event to handle it
848 if($javascript_on) {
849 sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
850 $compuri = $base_uri.$url;
851 return "<a href=\"javascript:void(0)\" onclick=\"comp_in_new('$compuri','$compose_width','$compose_height')\">$text</a>";
852 }
853
854 // otherwise, just open new window using regular HTML
855 return makeInternalLink($url, $text, '_blank');
856 }
857
858 /**
859 * Print variable
860 *
861 * sm_print_r($some_variable, [$some_other_variable [, ...]]);
862 *
863 * Debugging function - does the same as print_r, but makes sure special
864 * characters are converted to htmlentities first. This will allow
865 * values like <some@email.address> to be displayed.
866 * The output is wrapped in <<pre>> and <</pre>> tags.
867 * Since 1.4.2 accepts unlimited number of arguments.
868 * @since 1.4.1
869 * @return void
870 */
871 function sm_print_r() {
872 ob_start(); // Buffer output
873 foreach(func_get_args() as $var) {
874 print_r($var);
875 echo "\n";
876 // php has get_class_methods function that can print class methods
877 if (is_object($var)) {
878 // get class methods if $var is object
879 $aMethods=get_class_methods(get_class($var));
880 // make sure that $aMethods is array and array is not empty
881 if (is_array($aMethods) && $aMethods!=array()) {
882 echo "Object methods:\n";
883 foreach($aMethods as $method) {
884 echo '* ' . $method . "\n";
885 }
886 }
887 echo "\n";
888 }
889 }
890 $buffer = ob_get_contents(); // Grab the print_r output
891 ob_end_clean(); // Silently discard the output & stop buffering
892 print '<div align="left"><pre>';
893 print htmlentities($buffer);
894 print '</pre></div>';
895 }
896
897 /**
898 * version of fwrite which checks for failure
899 * @param resource $fp
900 * @param string $string
901 * @return number of written bytes. false on failure
902 * @since 1.4.3
903 */
904 function sq_fwrite($fp, $string) {
905 // write to file
906 $count = @fwrite($fp,$string);
907 // the number of bytes written should be the length of the string
908 if($count != strlen($string)) {
909 return FALSE;
910 }
911
912 return $count;
913 }
914
915 /**
916 * sq_get_html_translation_table
917 *
918 * Returns the translation table used by sq_htmlentities()
919 *
920 * @param integer $table html translation table. Possible values (without quotes):
921 * <ul>
922 * <li>HTML_ENTITIES - full html entities table defined by charset</li>
923 * <li>HTML_SPECIALCHARS - html special characters table</li>
924 * </ul>
925 * @param integer $quote_style quote encoding style. Possible values (without quotes):
926 * <ul>
927 * <li>ENT_COMPAT - (default) encode double quotes</li>
928 * <li>ENT_NOQUOTES - don't encode double or single quotes</li>
929 * <li>ENT_QUOTES - encode double and single quotes</li>
930 * </ul>
931 * @param string $charset charset used for encoding. default to us-ascii, 'auto' uses $default_charset global value.
932 * @return array html translation array
933 * @since 1.5.1
934 */
935 function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT,$charset='us-ascii') {
936 global $default_charset;
937
938 if ($table == HTML_SPECIALCHARS) $charset='us-ascii';
939
940 // Start array with ampersand
941 $sq_html_ent_table = array( "&" => '&amp;' );
942
943 // < and >
944 $sq_html_ent_table = array_merge($sq_html_ent_table,
945 array("<" => '&lt;',
946 ">" => '&gt;')
947 );
948 // double quotes
949 if ($quote_style == ENT_COMPAT)
950 $sq_html_ent_table = array_merge($sq_html_ent_table,
951 array("\"" => '&quot;')
952 );
953
954 // double and single quotes
955 if ($quote_style == ENT_QUOTES)
956 $sq_html_ent_table = array_merge($sq_html_ent_table,
957 array("\"" => '&quot;',
958 "'" => '&#39;')
959 );
960
961 if ($charset=='auto') $charset=$default_charset;
962
963 // add entities that depend on charset
964 switch($charset){
965 case 'iso-8859-1':
966 include_once(SM_PATH . 'functions/htmlentities/iso-8859-1.php');
967 break;
968 case 'utf-8':
969 include_once(SM_PATH . 'functions/htmlentities/utf-8.php');
970 break;
971 case 'us-ascii':
972 default:
973 break;
974 }
975 // return table
976 return $sq_html_ent_table;
977 }
978
979 /**
980 * sq_htmlentities
981 *
982 * Convert all applicable characters to HTML entities.
983 * Minimal php requirement - v.4.0.5.
984 *
985 * Function is designed for people that want to use full power of htmlentities() in
986 * i18n environment.
987 *
988 * @param string $string string that has to be sanitized
989 * @param integer $quote_style quote encoding style. Possible values (without quotes):
990 * <ul>
991 * <li>ENT_COMPAT - (default) encode double quotes</li>
992 * <li>ENT_NOQUOTES - don't encode double or single quotes</li>
993 * <li>ENT_QUOTES - encode double and single quotes</li>
994 * </ul>
995 * @param string $charset charset used for encoding. defaults to 'us-ascii', 'auto' uses $default_charset global value.
996 * @return string sanitized string
997 * @since 1.5.1
998 */
999 function sq_htmlentities($string,$quote_style=ENT_COMPAT,$charset='us-ascii') {
1000 // get translation table
1001 $sq_html_ent_table=sq_get_html_translation_table(HTML_ENTITIES,$quote_style,$charset);
1002 // convert characters
1003 return str_replace(array_keys($sq_html_ent_table),array_values($sq_html_ent_table),$string);
1004 }
1005
1006 /**
1007 * Tests if string contains 8bit symbols.
1008 *
1009 * If charset is not set, function defaults to default_charset.
1010 * $default_charset global must be set correctly if $charset is
1011 * not used.
1012 * @param string $string tested string
1013 * @param string $charset charset used in a string
1014 * @return bool true if 8bit symbols are detected
1015 * @since 1.5.1 and 1.4.4
1016 */
1017 function sq_is8bit($string,$charset='') {
1018 global $default_charset;
1019
1020 if ($charset=='') $charset=$default_charset;
1021
1022 /**
1023 * Don't use \240 in ranges. Sometimes RH 7.2 doesn't like it.
1024 * Don't use \200-\237 for iso-8859-x charsets. This range
1025 * stores control symbols in those charsets.
1026 * Use preg_match instead of ereg in order to avoid problems
1027 * with mbstring overloading
1028 */
1029 if (preg_match("/^iso-8859/i",$charset)) {
1030 $needle='/\240|[\241-\377]/';
1031 } else {
1032 $needle='/[\200-\237]|\240|[\241-\377]/';
1033 }
1034 return preg_match("$needle",$string);
1035 }
1036
1037 /**
1038 * Replacement of mb_list_encodings function
1039 *
1040 * This function provides replacement for function that is available only
1041 * in php 5.x. Function does not test all mbstring encodings. Only the ones
1042 * that might be used in SM translations.
1043 *
1044 * Supported strings are stored in session in order to reduce number of
1045 * mb_internal_encoding function calls.
1046 *
1047 * If you want to test all mbstring encodings - fill $list_of_encodings
1048 * array.
1049 * @return array list of encodings supported by php mbstring extension
1050 * @since 1.5.1 and 1.4.6
1051 */
1052 function sq_mb_list_encodings() {
1053 if (! function_exists('mb_internal_encoding'))
1054 return array();
1055
1056 // php 5+ function
1057 if (function_exists('mb_list_encodings')) {
1058 $ret = mb_list_encodings();
1059 array_walk($ret,'sq_lowercase_array_vals');
1060 return $ret;
1061 }
1062
1063 // don't try to test encodings, if they are already stored in session
1064 if (sqgetGlobalVar('mb_supported_encodings',$mb_supported_encodings,SQ_SESSION))
1065 return $mb_supported_encodings;
1066
1067 // save original encoding
1068 $orig_encoding=mb_internal_encoding();
1069
1070 $list_of_encoding=array(
1071 'pass',
1072 'auto',
1073 'ascii',
1074 'jis',
1075 'utf-8',
1076 'sjis',
1077 'euc-jp',
1078 'iso-8859-1',
1079 'iso-8859-2',
1080 'iso-8859-7',
1081 'iso-8859-9',
1082 'iso-8859-15',
1083 'koi8-r',
1084 'koi8-u',
1085 'big5',
1086 'gb2312',
1087 'gb18030',
1088 'windows-1251',
1089 'windows-1255',
1090 'windows-1256',
1091 'tis-620',
1092 'iso-2022-jp',
1093 'euc-cn',
1094 'euc-kr',
1095 'euc-tw',
1096 'uhc',
1097 'utf7-imap');
1098
1099 $supported_encodings=array();
1100
1101 foreach ($list_of_encoding as $encoding) {
1102 // try setting encodings. suppress warning messages
1103 if (@mb_internal_encoding($encoding))
1104 $supported_encodings[]=$encoding;
1105 }
1106
1107 // restore original encoding
1108 mb_internal_encoding($orig_encoding);
1109
1110 // register list in session
1111 sqsession_register($supported_encodings,'mb_supported_encodings');
1112
1113 return $supported_encodings;
1114 }
1115
1116 /**
1117 * Callback function used to lowercase array values.
1118 * @param string $val array value
1119 * @param mixed $key array key
1120 * @since 1.5.1 and 1.4.6
1121 */
1122 function sq_lowercase_array_vals(&$val,$key) {
1123 $val = strtolower($val);
1124 }
1125
1126
1127 /**
1128 * Function returns number of characters in string.
1129 *
1130 * Returned number might be different from number of bytes in string,
1131 * if $charset is multibyte charset. Detection depends on mbstring
1132 * functions. If mbstring does not support tested multibyte charset,
1133 * vanilla string length function is used.
1134 * @param string $str string
1135 * @param string $charset charset
1136 * @since 1.5.1 and 1.4.6
1137 * @return integer number of characters in string
1138 */
1139 function sq_strlen($str, $charset=null){
1140 // default option
1141 if (is_null($charset)) return strlen($str);
1142
1143 // lowercase charset name
1144 $charset=strtolower($charset);
1145
1146 // use automatic charset detection, if function call asks for it
1147 if ($charset=='auto') {
1148 global $default_charset;
1149 set_my_charset();
1150 $charset=$default_charset;
1151 }
1152
1153 // Use mbstring only with listed charsets
1154 $aList_of_mb_charsets=array('utf-8','big5','gb2312','gb18030','euc-jp','euc-cn','euc-tw','euc-kr');
1155
1156 // calculate string length according to charset
1157 if (in_array($charset,$aList_of_mb_charsets) && in_array($charset,sq_mb_list_encodings())) {
1158 $real_length = mb_strlen($str,$charset);
1159 } else {
1160 // own strlen detection code is removed because missing strpos,
1161 // strtoupper and substr implementations break string wrapping.
1162 $real_length=strlen($str);
1163 }
1164 return $real_length;
1165 }
1166
1167 /**
1168 * string padding with multibyte support
1169 *
1170 * @link http://www.php.net/str_pad
1171 * @param string $string original string
1172 * @param integer $width padded string width
1173 * @param string $pad padding symbols
1174 * @param integer $padtype padding type
1175 * (internal php defines, see str_pad() description)
1176 * @param string $charset charset used in original string
1177 * @return string padded string
1178 */
1179 function sq_str_pad($string, $width, $pad, $padtype, $charset='') {
1180
1181 $charset = strtolower($charset);
1182 $padded_string = '';
1183
1184 switch ($charset) {
1185 case 'utf-8':
1186 case 'big5':
1187 case 'gb2312':
1188 case 'euc-kr':
1189 /*
1190 * all multibyte charsets try to increase width value by
1191 * adding difference between number of bytes and real length
1192 */
1193 $width = $width - sq_strlen($string,$charset) + strlen($string);
1194 default:
1195 $padded_string=str_pad($string,$width,$pad,$padtype);
1196 }
1197 return $padded_string;
1198 }
1199
1200 /**
1201 * Wrapper that is used to switch between vanilla and multibyte substr
1202 * functions.
1203 * @param string $string
1204 * @param integer $start
1205 * @param integer $length
1206 * @param string $charset
1207 * @return string
1208 * @since 1.5.1
1209 * @link http://www.php.net/substr
1210 * @link http://www.php.net/mb_substr
1211 */
1212 function sq_substr($string,$start,$length,$charset='auto') {
1213 // use automatic charset detection, if function call asks for it
1214 if ($charset=='auto') {
1215 global $default_charset;
1216 set_my_charset();
1217 $charset=$default_charset;
1218 }
1219 $charset = strtolower($charset);
1220 if (function_exists('mb_internal_encoding') &&
1221 in_array($charset,sq_mb_list_encodings())) {
1222 return mb_substr($string,$start,$length,$charset);
1223 }
1224 // TODO: add mbstring independent code
1225
1226 // use vanilla string functions as last option
1227 return substr($string,$start,$length);
1228 }
1229
1230 /**
1231 * Wrapper that is used to switch between vanilla and multibyte strpos
1232 * functions.
1233 * @param string $haystack
1234 * @param mixed $needle
1235 * @param integer $offset
1236 * @param string $charset
1237 * @return string
1238 * @since 1.5.1
1239 * @link http://www.php.net/strpos
1240 * @link http://www.php.net/mb_strpos
1241 */
1242 function sq_strpos($haystack,$needle,$offset,$charset='auto') {
1243 // use automatic charset detection, if function call asks for it
1244 if ($charset=='auto') {
1245 global $default_charset;
1246 set_my_charset();
1247 $charset=$default_charset;
1248 }
1249 $charset = strtolower($charset);
1250 if (function_exists('mb_internal_encoding') &&
1251 in_array($charset,sq_mb_list_encodings())) {
1252 return mb_strpos($haystack,$needle,$offset,$charset);
1253 }
1254 // TODO: add mbstring independent code
1255
1256 // use vanilla string functions as last option
1257 return strpos($haystack,$needle,$offset);
1258 }
1259
1260 /**
1261 * Wrapper that is used to switch between vanilla and multibyte strtoupper
1262 * functions.
1263 * @param string $string
1264 * @param string $charset
1265 * @return string
1266 * @since 1.5.1
1267 * @link http://www.php.net/strtoupper
1268 * @link http://www.php.net/mb_strtoupper
1269 */
1270 function sq_strtoupper($string,$charset='auto') {
1271 // use automatic charset detection, if function call asks for it
1272 if ($charset=='auto') {
1273 global $default_charset;
1274 set_my_charset();
1275 $charset=$default_charset;
1276 }
1277 $charset = strtolower($charset);
1278 if (function_exists('mb_strtoupper') &&
1279 in_array($charset,sq_mb_list_encodings())) {
1280 return mb_strtoupper($string,$charset);
1281 }
1282 // TODO: add mbstring independent code
1283
1284 // use vanilla string functions as last option
1285 return strtoupper($string);
1286 }
1287
1288 /**
1289 * Counts 8bit bytes in string
1290 * @param string $string tested string
1291 * @return integer number of 8bit bytes
1292 */
1293 function sq_count8bit($string) {
1294 $count=0;
1295 for ($i=0; $i<strlen($string); $i++) {
1296 if (ord($string[$i]) > 127) $count++;
1297 }
1298 return $count;
1299 }
1300
1301 ?>