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