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