6 * This code provides various string manipulation functions that are
7 * used by the rest of the SquirrelMail code.
9 * @copyright © 1999-2009 The SquirrelMail Project Team
10 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @package squirrelmail
16 * Appends citation markers to the string.
17 * Also appends a trailing space.
19 * @author Justus Pendleton
20 * @param string $str The string to append to
21 * @param int $citeLevel the number of markers to append
25 function sqMakeCite (&$str, $citeLevel) {
26 for ($i = 0; $i < $citeLevel; $i++
) {
29 if ($citeLevel != 0) {
35 * Create a newline in the string, adding citation
36 * markers to the newline as necessary.
38 * @author Justus Pendleton
39 * @param string $str the string to make a newline in
40 * @param int $citeLevel the citation level the newline is at
41 * @param int $column starting column of the newline
45 function sqMakeNewLine (&$str, $citeLevel, &$column) {
49 sqMakeCite ($str, $citeLevel);
50 $column = $citeLevel +
1;
57 * Checks for spaces in strings - only used if PHP doesn't have native ctype support
59 * You might be able to rewrite the function by adding short evaluation form.
62 * - iso-2022-xx charsets - hex 20 might be part of other symbol. I might
63 * be wrong. 0x20 is not used in iso-2022-jp. I haven't checked iso-2022-kr
64 * and iso-2022-cn mappings.
66 * - no-break space ( ) - it is 8bit symbol, that depends on charset.
67 * there are at least three different charset groups that have nbsp in
70 * I don't see any charset/nbsp options in php ctype either.
72 * @param string $string tested string
73 * @return bool true when only whitespace symbols are present in test string
76 function sm_ctype_space($string) {
77 if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) ||
$string=='') {
85 * Wraps text at $wrap characters. While sqWordWrap takes
86 * a single line of text and wraps it, this function works
87 * on the entire corpus at once, this allows it to be a little
88 * bit smarter and when and how to wrap.
90 * @author Justus Pendleton
91 * @param string $body the entire body of text
92 * @param int $wrap the maximum line length
93 * @return string the wrapped text
96 function &sqBodyWrap (&$body, $wrap) {
97 //check for ctype support, and fake it if it doesn't exist
98 if (!function_exists('ctype_space')) {
99 function ctype_space ($string) {
100 return sm_ctype_space($string);
104 // the newly wrapped text
106 // current column since the last newline in the outstring
108 $length = sq_strlen($body);
109 // where we are in the original string
111 // the number of >>> citation markers we are currently at
114 // the main loop, whenever we start a newline of input text
115 // we start from here
116 while ($pos < $length) {
117 // we're at the beginning of a line, get the new cite level
120 while (($pos < $length) && (sq_substr($body,$pos,1) == '>')) {
124 // skip over any spaces interleaved among the cite markers
125 while (($pos < $length) && (sq_substr($body,$pos,1) == ' ')) {
130 if ($pos >= $length) {
135 // special case: if this is a blank line then maintain it
136 // (i.e. try to preserve original paragraph breaks)
137 // unless they occur at the very beginning of the text
138 if ((sq_substr($body,$pos,1) == "\n" ) && (sq_strlen($outString) != 0)) {
139 $outStringLast = $outString{sq_strlen($outString) - 1};
140 if ($outStringLast != "\n") {
143 sqMakeCite ($outString, $newCiteLevel);
150 // if the cite level has changed, then start a new line
151 // with the new cite level.
152 if (($citeLevel != $newCiteLevel) && ($pos > ($newCiteLevel +
1)) && ($outStringCol != 0)) {
153 sqMakeNewLine ($outString, 0, $outStringCol);
156 $citeLevel = $newCiteLevel;
158 // prepend the quote level if necessary
159 if ($outStringCol == 0) {
160 sqMakeCite ($outString, $citeLevel);
161 // if we added a citation then move the column
162 // out by citelevel + 1 (the cite markers + the space)
163 $outStringCol = $citeLevel +
($citeLevel ?
1 : 0);
164 } else if ($outStringCol > $citeLevel) {
165 // not a cite and we're not at the beginning of a line
166 // in the output. add a space to separate the new text
167 // from previous text.
172 // find the next newline -- we don't want to go further than that
173 $nextNewline = sq_strpos ($body, "\n", $pos);
174 if ($nextNewline === FALSE) {
175 $nextNewline = $length;
178 // Don't wrap unquoted lines at all. For now the textarea
179 // will work fine for this. Maybe revisit this later though
180 // (for completeness more than anything else, I think)
181 if ($citeLevel == 0) {
182 $outString .= sq_substr ($body, $pos, ($nextNewline - $pos));
183 $outStringCol = $nextNewline - $pos;
184 if ($nextNewline != $length) {
185 sqMakeNewLine ($outString, 0, $outStringCol);
187 $pos = $nextNewline +
1;
191 * Set this to false to stop appending short strings to previous lines
194 // inner loop, (obviously) handles wrapping up to
196 while ($pos < $nextNewline) {
197 // skip over initial spaces
198 while (($pos < $nextNewline) && (ctype_space (sq_substr($body,$pos,1)))) {
201 // if this is a short line then just append it and continue outer loop
202 if (($outStringCol +
$nextNewline - $pos) <= ($wrap - $citeLevel - 1) ) {
203 // if this is the final line in the input string then include
204 // any trailing newlines
205 // echo substr($body,$pos,$wrap). "<br />";
206 if (($nextNewline +
1 == $length) && (sq_substr($body,$nextNewline,1) == "\n")) {
210 // trim trailing spaces
211 $lastRealChar = $nextNewline;
212 while (($lastRealChar > $pos && $lastRealChar < $length) && (ctype_space (sq_substr($body,$lastRealChar,1)))) {
215 // decide if appending the short string is what we want
216 if (($nextNewline < $length && sq_substr($body,$nextNewline,1) == "\n") &&
217 isset($lastRealChar)) {
219 //check the first word:
220 while (($mypos < $length) && (sq_substr($body,$mypos,1) == '>')) {
222 // skip over any spaces interleaved among the cite markers
223 while (($mypos < $length) && (sq_substr($body,$mypos,1) == ' ')) {
229 if ($mypos == $nextNewline+1) {
230 while (($mypos < $length) && ($body{$mypos} == ' ')) {
236 $firstword = sq_substr($body,$mypos,sq_strpos($body,' ',$mypos) - $mypos);
237 //if ($dowrap || $ldnspacecnt > 1 || ($firstword && (
238 if (!$smartwrap ||
$firstword && (
239 $firstword{0} == '-' ||
240 $firstword{0} == '+' ||
241 $firstword{0} == '*' ||
242 sq_substr($firstword,0,1) == sq_strtoupper(sq_substr($firstword,0,1)) ||
243 strpos($firstword,':'))) {
244 $outString .= sq_substr($body,$pos,($lastRealChar - $pos+
1));
245 $outStringCol +
= ($lastRealChar - $pos);
246 sqMakeNewLine($outString,$citeLevel,$outStringCol);
255 $outString .= sq_substr ($body, $pos, ($lastRealChar - $pos +
1));
256 $outStringCol +
= ($lastRealChar - $pos);
257 $pos = $nextNewline +
1;
261 $eol = $pos +
$wrap - $citeLevel - $outStringCol;
262 // eol is the tentative end of line.
263 // look backwards for there for a whitespace to break at.
264 // if it's already less than our current position then
265 // our current line is already too long, break immediately
266 // and restart outer loop
268 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
272 // start looking backwards for whitespace to break at.
274 while (($breakPoint > $pos) && (! ctype_space (sq_substr($body,$breakPoint,1)))) {
278 // if we didn't find a breakpoint by looking backward then we
279 // need to figure out what to do about that
280 if ($breakPoint == $pos) {
281 // if we are not at the beginning then end this line
282 // and start a new loop
283 if ($outStringCol > ($citeLevel +
1)) {
284 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
287 // just hard break here. most likely we are breaking
288 // a really long URL. could also try searching
289 // forward for a break point, which is what Mozilla
290 // does. don't bother for now.
295 // special case: maybe we should have wrapped last
296 // time. if the first breakpoint here makes the
297 // current line too long and there is already text on
298 // the current line, break and loop again if at
299 // beginning of current line, don't force break
301 if ((($outStringCol +
($breakPoint - $pos)) > ($wrap +
$SLOP)) && ($outStringCol > ($citeLevel +
1))) {
302 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
306 // skip newlines or whitespace at the beginning of the string
307 $substring = sq_substr ($body, $pos, ($breakPoint - $pos));
308 $substring = rtrim ($substring); // do rtrim and ctype_space have the same ideas about whitespace?
309 $outString .= $substring;
310 $outStringCol +
= sq_strlen ($substring);
311 // advance past the whitespace which caused the wrap
313 while (($pos < $length) && (ctype_space (sq_substr($body,$pos,1)))) {
316 if ($pos < $length) {
317 sqMakeNewLine ($outString, $citeLevel, $outStringCol);
326 * Wraps text at $wrap characters
328 * Has a problem with special HTML characters, so call this before
329 * you do character translation.
331 * Specifically, &#039; comes up as 5 characters instead of 1.
332 * This should not add newlines to the end of lines.
334 * @param string $line the line of text to wrap, by ref
335 * @param int $wrap the maximum line lenth
336 * @param string $charset name of charset used in $line string. Available since v.1.5.1.
340 function sqWordWrap(&$line, $wrap, $charset='') {
341 global $languages, $squirrelmail_language;
343 // Use custom wrapping function, if translation provides it
344 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
345 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap')) {
346 if (mb_detect_encoding($line) != 'ASCII') {
347 $line = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap', $line, $wrap);
352 ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
353 $beginning_spaces = $regs[1];
354 if (isset($regs[2])) {
355 $words = explode(' ', $regs[2]);
361 $line = $beginning_spaces;
363 while ($i < count($words)) {
364 /* Force one word to be on a line (minimum) */
366 $line_len = strlen($beginning_spaces) +
sq_strlen($words[$i],$charset) +
2;
367 if (isset($words[$i +
1]))
368 $line_len +
= sq_strlen($words[$i +
1],$charset);
371 /* Add more words (as long as they fit) */
372 while ($line_len < $wrap && $i < count($words)) {
373 $line .= ' ' . $words[$i];
375 if (isset($words[$i]))
376 $line_len +
= sq_strlen($words[$i],$charset) +
1;
381 /* Skip spaces if they are the first thing on a continued line */
382 while (!isset($words[$i]) && $i < count($words)) {
386 /* Go to the next line if we have more to process */
387 if ($i < count($words)) {
394 * Does the opposite of sqWordWrap()
395 * @param string $body the text to un-wordwrap
399 function sqUnWordWrap(&$body) {
400 global $squirrelmail_language;
402 if ($squirrelmail_language == 'ja_JP') {
406 $lines = explode("\n", $body);
408 $PreviousSpaces = '';
409 $cnt = count($lines);
410 for ($i = 0; $i < $cnt; $i ++
) {
411 preg_match("/^([\t >]*)([^\t >].*)?$/", $lines[$i], $regs);
412 $CurrentSpaces = $regs[1];
413 if (isset($regs[2])) {
414 $CurrentRest = $regs[2];
420 $PreviousSpaces = $CurrentSpaces;
422 } else if (($PreviousSpaces == $CurrentSpaces) /* Do the beginnings match */
423 && (strlen($lines[$i - 1]) > 65) /* Over 65 characters long */
424 && strlen($CurrentRest)) { /* and there's a line to continue with */
425 $body .= ' ' . $CurrentRest;
427 $body .= "\n" . $lines[$i];
428 $PreviousSpaces = $CurrentSpaces;
435 * If $haystack is a full mailbox name and $needle is the mailbox
436 * separator character, returns the last part of the mailbox name.
438 * @param string haystack full mailbox name to search
439 * @param string needle the mailbox separator character
440 * @return string the last part of the mailbox name
443 function readShortMailboxName($haystack, $needle) {
448 $parts = explode($needle, $haystack);
449 $elem = array_pop($parts);
450 while ($elem == '' && count($parts)) {
451 $elem = array_pop($parts);
461 * Determines the location to forward to, relative to your server.
462 * This is used in HTTP Location: redirects.
464 * If set, it uses $config_location_base as the first part of the URL,
465 * specifically, the protocol, hostname and port parts. The path is
466 * always autodetected.
468 * @return string the base url for this SquirrelMail installation
471 function get_location () {
473 global $imap_server_type, $config_location_base,
474 $is_secure_connection, $sq_ignore_http_x_forwarded_headers;
476 /* Get the path, handle virtual directories */
477 if(strpos(php_self(), '?')) {
478 $path = substr(php_self(), 0, strpos(php_self(), '?'));
482 $path = substr($path, 0, strrpos($path, '/'));
484 // proto+host+port are already set in config:
485 if ( !empty($config_location_base) ) {
486 return $config_location_base . $path ;
488 // we computed it before, get it from the session:
489 if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION
) ) {
490 return $full_url . $path;
494 /* Check if this is a HTTPS or regular HTTP request. */
496 if ($is_secure_connection)
499 /* Get the hostname from the Host header or server config. */
500 if ($sq_ignore_http_x_forwarded_headers
501 ||
!sqgetGlobalVar('HTTP_X_FORWARDED_HOST', $host, SQ_SERVER
)
503 if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER
) ||
empty($host) ) {
504 if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER
) ||
empty($host) ) {
511 if (! strstr($host, ':')) {
512 // Note: HTTP_X_FORWARDED_PROTO could be sent from the client and
513 // therefore possibly spoofed/hackable. Thus, SquirrelMail
514 // ignores such headers by default. The administrator
515 // can tell SM to use such header values by setting
516 // $sq_ignore_http_x_forwarded_headers to boolean FALSE
517 // in config/config.php or by using config/conf.pl.
518 global $sq_ignore_http_x_forwarded_headers;
519 if ($sq_ignore_http_x_forwarded_headers
520 ||
!sqgetGlobalVar('HTTP_X_FORWARDED_PROTO', $forwarded_proto, SQ_SERVER
))
521 $forwarded_proto = '';
522 if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER
)) {
523 if (($server_port != 80 && $proto == 'http://') ||
524 ($server_port != 443 && $proto == 'https://' &&
525 strcasecmp($forwarded_proto, 'https') !== 0)) {
526 $port = sprintf(':%d', $server_port);
531 /* this is a workaround for the weird macosx caching that
532 * causes Apache to return 16080 as the port number, which causes
535 if ($imap_server_type == 'macosx' && $port == ':16080') {
539 /* Fallback is to omit the server name and use a relative */
540 /* URI, although this is not RFC 2616 compliant. */
541 $full_url = ($host ?
$proto . $host . $port : '');
542 sqsession_register($full_url, 'sq_base_url');
543 return $full_url . $path;
548 * Get Message List URI
550 * @param string $mailbox Current mailbox name (unencoded/raw)
551 * @param string $startMessage The mailbox page offset
552 * @param string $what Any current search parameters (OPTIONAL;
553 * default empty string)
555 * @return string The message list URI
560 function get_message_list_uri($mailbox, $startMessage, $what='') {
564 $urlMailbox = urlencode($mailbox);
566 $list_xtra = "?where=read_body.php&what=$what&mailbox=" . $urlMailbox.
567 "&startMessage=$startMessage";
569 return $base_uri .'src/right_main.php'. $list_xtra;
576 * These functions are used to encrypt the password before it is
577 * stored in a cookie. The encryption key is generated by
578 * OneTimePadCreate();
580 * @param string $string the (password)string to encrypt
581 * @param string $epad the encryption key
582 * @return string the base64-encoded encrypted password
585 function OneTimePadEncrypt ($string, $epad) {
586 $pad = base64_decode($epad);
588 if (strlen($pad)>0) {
589 // make sure that pad is longer than string
590 while (strlen($string)>strlen($pad)) {
594 // FIXME: what should we do when $epad is not base64 encoded or empty.
598 for ($i = 0; $i < strlen ($string); $i++
) {
599 $encrypted .= chr (ord($string[$i]) ^
ord($pad[$i]));
602 return base64_encode($encrypted);
606 * Decrypts a password from the cookie
608 * Decrypts a password from the cookie, encrypted by OneTimePadEncrypt.
609 * This uses the encryption key that is stored in the session.
611 * @param string $string the string to decrypt
612 * @param string $epad the encryption key from the session
613 * @return string the decrypted password
616 function OneTimePadDecrypt ($string, $epad) {
617 $pad = base64_decode($epad);
619 if (strlen($pad)>0) {
620 // make sure that pad is longer than string
621 while (strlen($string)>strlen($pad)) {
625 // FIXME: what should we do when $epad is not base64 encoded or empty.
628 $encrypted = base64_decode ($string);
630 for ($i = 0; $i < strlen ($encrypted); $i++
) {
631 $decrypted .= chr (ord($encrypted[$i]) ^
ord($pad[$i]));
638 * Creates encryption key
640 * Creates an encryption key for encrypting the password stored in the cookie.
641 * The encryption key itself is stored in the session.
643 * Pad must be longer or equal to encoded string length in 1.4.4/1.5.0 and older.
644 * @param int $length optional, length of the string to generate
645 * @return string the encryption key
648 function OneTimePadCreate ($length=100) {
650 for ($i = 0; $i < $length; $i++
) {
651 $pad .= chr(mt_rand(0,255));
654 return base64_encode($pad);
658 * Returns a string showing a byte size figure in
659 * a more easily digested (readable) format
661 * @param int $bytes the size in bytes
663 * @return string The size in human readable format
668 function show_readable_size($bytes) {
672 if ($bytes / 1024 > 1) {
679 settype($bytes, 'integer');
682 settype($bytes, 'integer');
686 return $bytes . $nbsp . $type;
690 * Generates a random string from the character set you pass in
692 * @param int $size the length of the string to generate
693 * @param string $chars a string containing the characters to use
694 * @param int $flags a flag to add a specific set to the characters to use:
696 * 1 = add lowercase a-z to $chars
697 * 2 = add uppercase A-Z to $chars
698 * 4 = add numbers 0-9 to $chars
699 * @return string the random string
702 function GenerateRandomString($size, $chars, $flags = 0) {
704 $chars .= 'abcdefghijklmnopqrstuvwxyz';
707 $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
710 $chars .= '0123456789';
713 if (($size < 1) ||
(strlen($chars) < 1)) {
718 $j = strlen( $chars ) - 1;
719 while (strlen($String) < $size) {
720 $String .= $chars{mt_rand(0, $j)};
727 * Escapes special characters for use in IMAP commands.
729 * @param string $str the string to escape
730 * @return string the escaped string
733 function quoteimap($str) {
734 return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
738 * Create compose link
740 * Returns a link to the compose-page, taking in consideration
741 * the compose_in_new and javascript settings.
743 * @param string $url The URL to the compose page
744 * @param string $text The link text, default "Compose"
745 * @param string $target URL target, if any (since 1.4.3)
746 * @param string $accesskey The access key to be used, if any
748 * @return string a link to the compose page
752 function makeComposeLink($url, $text = null, $target='', $accesskey='NONE') {
753 global $compose_new_win, $compose_width,
754 $compose_height, $oTemplate;
757 $text = _("Compose");
760 // if not using "compose in new window", make
761 // regular link and be done with it
762 if($compose_new_win != '1') {
763 return makeInternalLink($url, $text, $target, $accesskey);
766 // build the compose in new window link...
769 // if javascript is on, use onclick event to handle it
770 if(checkForJavascript()) {
771 sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION
);
772 $compuri = SM_BASE_URI
.$url;
774 return create_hyperlink('javascript:void(0)', $text, '',
775 "comp_in_new('$compuri','$compose_width','$compose_height')",
777 ($accesskey == 'NONE'
779 : array('accesskey' => $accesskey)));
782 // otherwise, just open new window using regular HTML
783 return makeInternalLink($url, $text, '_blank', $accesskey);
787 * version of fwrite which checks for failure
788 * @param resource $fp
789 * @param string $string
790 * @return number of written bytes. false on failure
793 function sq_fwrite($fp, $string) {
795 $count = @fwrite
($fp,$string);
796 // the number of bytes written should be the length of the string
797 if($count != strlen($string)) {
805 * sq_get_html_translation_table
807 * Returns the translation table used by sq_htmlentities()
809 * @param integer $table html translation table. Possible values (without quotes):
811 * <li>HTML_ENTITIES - full html entities table defined by charset</li>
812 * <li>HTML_SPECIALCHARS - html special characters table</li>
814 * @param integer $quote_style quote encoding style. Possible values (without quotes):
816 * <li>ENT_COMPAT - (default) encode double quotes</li>
817 * <li>ENT_NOQUOTES - don't encode double or single quotes</li>
818 * <li>ENT_QUOTES - encode double and single quotes</li>
820 * @param string $charset charset used for encoding. default to us-ascii, 'auto' uses $default_charset global value.
821 * @return array html translation array
824 function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT
,$charset='us-ascii') {
825 global $default_charset;
827 if ($table == HTML_SPECIALCHARS
) $charset='us-ascii';
829 // Start array with ampersand
830 $sq_html_ent_table = array( "&" => '&' );
833 $sq_html_ent_table = array_merge($sq_html_ent_table,
838 if ($quote_style == ENT_COMPAT
)
839 $sq_html_ent_table = array_merge($sq_html_ent_table,
840 array("\"" => '"')
843 // double and single quotes
844 if ($quote_style == ENT_QUOTES
)
845 $sq_html_ent_table = array_merge($sq_html_ent_table,
846 array("\"" => '"',
850 if ($charset=='auto') $charset=$default_charset;
852 // add entities that depend on charset
855 include_once(SM_PATH
. 'functions/htmlentities/iso-8859-1.php');
858 include_once(SM_PATH
. 'functions/htmlentities/utf-8.php');
865 return $sq_html_ent_table;
871 * Convert all applicable characters to HTML entities.
872 * Minimal php requirement - v.4.0.5.
874 * Function is designed for people that want to use full power of htmlentities() in
877 * @param string $string string that has to be sanitized
878 * @param integer $quote_style quote encoding style. Possible values (without quotes):
880 * <li>ENT_COMPAT - (default) encode double quotes</li>
881 * <li>ENT_NOQUOTES - don't encode double or single quotes</li>
882 * <li>ENT_QUOTES - encode double and single quotes</li>
884 * @param string $charset charset used for encoding. defaults to 'us-ascii', 'auto' uses $default_charset global value.
885 * @return string sanitized string
888 function sq_htmlentities($string,$quote_style=ENT_COMPAT
,$charset='us-ascii') {
889 // get translation table
890 $sq_html_ent_table=sq_get_html_translation_table(HTML_ENTITIES
,$quote_style,$charset);
891 // convert characters
892 return str_replace(array_keys($sq_html_ent_table),array_values($sq_html_ent_table),$string);
896 * Tests if string contains 8bit symbols.
898 * If charset is not set, function defaults to default_charset.
899 * $default_charset global must be set correctly if $charset is
901 * @param string $string tested string
902 * @param string $charset charset used in a string
903 * @return bool true if 8bit symbols are detected
904 * @since 1.5.1 and 1.4.4
906 function sq_is8bit($string,$charset='') {
907 global $default_charset;
909 if ($charset=='') $charset=$default_charset;
912 * Don't use \240 in ranges. Sometimes RH 7.2 doesn't like it.
913 * Don't use \200-\237 for iso-8859-x charsets. This range
914 * stores control symbols in those charsets.
915 * Use preg_match instead of ereg in order to avoid problems
916 * with mbstring overloading
918 if (preg_match("/^iso-8859/i",$charset)) {
919 $needle='/\240|[\241-\377]/';
921 $needle='/[\200-\237]|\240|[\241-\377]/';
923 return preg_match("$needle",$string);
927 * Replacement of mb_list_encodings function
929 * This function provides replacement for function that is available only
930 * in php 5.x. Function does not test all mbstring encodings. Only the ones
931 * that might be used in SM translations.
933 * Supported strings are stored in session in order to reduce number of
934 * mb_internal_encoding function calls.
936 * If you want to test all mbstring encodings - fill $list_of_encodings
938 * @return array list of encodings supported by php mbstring extension
939 * @since 1.5.1 and 1.4.6
941 function sq_mb_list_encodings() {
942 if (! function_exists('mb_internal_encoding'))
946 if (function_exists('mb_list_encodings')) {
947 $ret = mb_list_encodings();
948 array_walk($ret,'sq_lowercase_array_vals');
952 // don't try to test encodings, if they are already stored in session
953 if (sqgetGlobalVar('mb_supported_encodings',$mb_supported_encodings,SQ_SESSION
))
954 return $mb_supported_encodings;
956 // save original encoding
957 $orig_encoding=mb_internal_encoding();
959 $list_of_encoding=array(
988 $supported_encodings=array();
990 foreach ($list_of_encoding as $encoding) {
991 // try setting encodings. suppress warning messages
992 if (@mb_internal_encoding
($encoding))
993 $supported_encodings[]=$encoding;
996 // restore original encoding
997 mb_internal_encoding($orig_encoding);
999 // register list in session
1000 sqsession_register($supported_encodings,'mb_supported_encodings');
1002 return $supported_encodings;
1006 * Callback function used to lowercase array values.
1007 * @param string $val array value
1008 * @param mixed $key array key
1009 * @since 1.5.1 and 1.4.6
1011 function sq_lowercase_array_vals(&$val,$key) {
1012 $val = strtolower($val);
1017 * Function returns number of characters in string.
1019 * Returned number might be different from number of bytes in string,
1020 * if $charset is multibyte charset. Detection depends on mbstring
1021 * functions. If mbstring does not support tested multibyte charset,
1022 * vanilla string length function is used.
1023 * @param string $str string
1024 * @param string $charset charset
1025 * @since 1.5.1 and 1.4.6
1026 * @return integer number of characters in string
1028 function sq_strlen($str, $charset=null){
1030 if (is_null($charset)) return strlen($str);
1032 // lowercase charset name
1033 $charset=strtolower($charset);
1035 // use automatic charset detection, if function call asks for it
1036 if ($charset=='auto') {
1037 global $default_charset, $squirrelmail_language;
1039 $charset=$default_charset;
1040 if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1043 // Use mbstring only with listed charsets
1044 $aList_of_mb_charsets=array('utf-8','big5','gb2312','gb18030','euc-jp','euc-cn','euc-tw','euc-kr');
1046 // calculate string length according to charset
1047 if (in_array($charset,$aList_of_mb_charsets) && in_array($charset,sq_mb_list_encodings())) {
1048 $real_length = mb_strlen($str,$charset);
1050 // own strlen detection code is removed because missing strpos,
1051 // strtoupper and substr implementations break string wrapping.
1052 $real_length=strlen($str);
1054 return $real_length;
1058 * string padding with multibyte support
1060 * @link http://www.php.net/str_pad
1061 * @param string $string original string
1062 * @param integer $width padded string width
1063 * @param string $pad padding symbols
1064 * @param integer $padtype padding type
1065 * (internal php defines, see str_pad() description)
1066 * @param string $charset charset used in original string
1067 * @return string padded string
1069 function sq_str_pad($string, $width, $pad, $padtype, $charset='') {
1071 $charset = strtolower($charset);
1072 $padded_string = '';
1080 * all multibyte charsets try to increase width value by
1081 * adding difference between number of bytes and real length
1083 $width = $width - sq_strlen($string,$charset) +
strlen($string);
1085 $padded_string=str_pad($string,$width,$pad,$padtype);
1087 return $padded_string;
1091 * Wrapper that is used to switch between vanilla and multibyte substr
1093 * @param string $string
1094 * @param integer $start
1095 * @param integer $length
1096 * @param string $charset
1099 * @link http://www.php.net/substr
1100 * @link http://www.php.net/mb_substr
1102 function sq_substr($string,$start,$length,$charset='auto') {
1103 // use automatic charset detection, if function call asks for it
1104 static $charset_auto, $bUse_mb;
1106 if ($charset=='auto') {
1107 if (!isset($charset_auto)) {
1108 global $default_charset, $squirrelmail_language;
1110 $charset=$default_charset;
1111 if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1112 $charset_auto = $charset;
1114 $charset = $charset_auto;
1117 $charset = strtolower($charset);
1119 // in_array call is expensive => do it once and use a static var for
1120 // storing the results
1121 if (!isset($bUse_mb)) {
1122 if (in_array($charset,sq_mb_list_encodings())) {
1130 return mb_substr($string,$start,$length,$charset);
1132 // TODO: add mbstring independent code
1134 // use vanilla string functions as last option
1135 return substr($string,$start,$length);
1139 * Wrapper that is used to switch between vanilla and multibyte strpos
1141 * @param string $haystack
1142 * @param mixed $needle
1143 * @param integer $offset
1144 * @param string $charset
1147 * @link http://www.php.net/strpos
1148 * @link http://www.php.net/mb_strpos
1150 function sq_strpos($haystack,$needle,$offset,$charset='auto') {
1151 // use automatic charset detection, if function call asks for it
1152 static $charset_auto, $bUse_mb;
1154 if ($charset=='auto') {
1155 if (!isset($charset_auto)) {
1156 global $default_charset, $squirrelmail_language;
1158 $charset=$default_charset;
1159 if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1160 $charset_auto = $charset;
1162 $charset = $charset_auto;
1165 $charset = strtolower($charset);
1167 // in_array call is expensive => do it once and use a static var for
1168 // storing the results
1169 if (!isset($bUse_mb)) {
1170 if (in_array($charset,sq_mb_list_encodings())) {
1177 return mb_strpos($haystack,$needle,$offset,$charset);
1179 // TODO: add mbstring independent code
1181 // use vanilla string functions as last option
1182 return strpos($haystack,$needle,$offset);
1186 * Wrapper that is used to switch between vanilla and multibyte strtoupper
1188 * @param string $string
1189 * @param string $charset
1192 * @link http://www.php.net/strtoupper
1193 * @link http://www.php.net/mb_strtoupper
1195 function sq_strtoupper($string,$charset='auto') {
1196 // use automatic charset detection, if function call asks for it
1197 static $charset_auto, $bUse_mb;
1199 if ($charset=='auto') {
1200 if (!isset($charset_auto)) {
1201 global $default_charset, $squirrelmail_language;
1203 $charset=$default_charset;
1204 if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1205 $charset_auto = $charset;
1207 $charset = $charset_auto;
1210 $charset = strtolower($charset);
1212 // in_array call is expensive => do it once and use a static var for
1213 // storing the results
1214 if (!isset($bUse_mb)) {
1215 if (function_exists('mb_strtoupper') &&
1216 in_array($charset,sq_mb_list_encodings())) {
1224 return mb_strtoupper($string,$charset);
1226 // TODO: add mbstring independent code
1228 // use vanilla string functions as last option
1229 return strtoupper($string);
1233 * Counts 8bit bytes in string
1234 * @param string $string tested string
1235 * @return integer number of 8bit bytes
1237 function sq_count8bit($string) {
1239 for ($i=0; $i<strlen($string); $i++
) {
1240 if (ord($string[$i]) > 127) $count++
;
1246 * Callback function to trim whitespace from a value, to be used in array_walk
1247 * @param string $value value to trim
1248 * @since 1.5.2 and 1.4.7
1250 function sq_trim_value ( &$value ) {
1251 $value = trim($value);