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