functions/strings.php

   1 <?php
   2
   3 /**
   4  * strings.php
   5  *
   6  * This code provides various string manipulation functions that are
   7  * used by the rest of the SquirrelMail code.
   8  *
   9  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
  10  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11  * @version $Id$
  12  * @package squirrelmail
  13  */
  14
  15 /**
  16  * Appends citation markers to the string.
  17  * Also appends a trailing space.
  18  *
  19  * @author Justus Pendleton
  20  * @param string $str The string to append to
  21  * @param int $citeLevel the number of markers to append
  22  * @return null
  23  * @since 1.5.1
  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
  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
  42  * @return null
  43  * @since 1.5.1
  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
  56 /**
  57  * Checks for spaces in strings - only used if PHP doesn't have native ctype support
  58  *
  59  * You might be able to rewrite the function by adding short evaluation form.
  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 (&nbsp;) - 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
  73  * @return bool true when only whitespace symbols are present in test string
  74  * @since 1.5.1
  75  */
  76 function sm_ctype_space($string) {
  77     if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) || $string=='') {
  78         return true;
  79     } else {
  80         return false;
  81     }
  82 }
  83
  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
  91  * @param string $body the entire body of text
  92  * @param int $wrap the maximum line length
  93  * @return string the wrapped text
  94  * @since 1.5.1
  95  */
  96 function &sqBodyWrap (&$body, $wrap) {
  97     //check for ctype support, and fake it if it doesn't exist
  98     if (!function_exists('ctype_space')) {
  99         function ctype_space ($string) {
 100             return sm_ctype_space($string);
 101         }
 102     }
 103
 104     // the newly wrapped text
 105     $outString = '';
 106     // current column since the last newline in the outstring
 107     $outStringCol = 0;
 108     $length = sq_strlen($body);
 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
 120        while (($pos < $length) && (sq_substr($body,$pos,1) == '>')) {
 121            $newCiteLevel++;
 122            $pos++;
 123
 124            // skip over any spaces interleaved among the cite markers
 125            while (($pos < $length) && (sq_substr($body,$pos,1) == ' ')) {
 126
 127                $pos++;
 128
 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
 138        if ((sq_substr($body,$pos,1) == "\n" ) && (sq_strlen($outString) != 0)) {
 139            $outStringLast = $outString{sq_strlen($outString) - 1};
 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
 173        $nextNewline = sq_strpos ($body, "\n", $pos);
 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) {
 182            $outString .= sq_substr ($body, $pos, ($nextNewline - $pos));
 183            $outStringCol = $nextNewline - $pos;
 184            if ($nextNewline != $length) {
 185                sqMakeNewLine ($outString, 0, $outStringCol);
 186            }
 187            $pos = $nextNewline + 1;
 188            continue;
 189        }
 190        /**
 191         * Set this to false to stop appending short strings to previous lines
 192         */
 193        $smartwrap = true;
 194        // inner loop, (obviously) handles wrapping up to
 195        // the next newline
 196        while ($pos < $nextNewline) {
 197            // skip over initial spaces
 198            while (($pos < $nextNewline) && (ctype_space (sq_substr($body,$pos,1)))) {
 199                $pos++;
 200            }
 201            // if this is a short line then just append it and continue outer loop
 202            if (($outStringCol + $nextNewline - $pos) <= ($wrap - $citeLevel - 1) ) {
 203                // if this is the final line in the input string then include
 204                // any trailing newlines
 205                //      echo substr($body,$pos,$wrap). "<br />";
 206                if (($nextNewline + 1 == $length) && (sq_substr($body,$nextNewline,1) == "\n")) {
 207                    $nextNewline++;
 208                }
 209
 210                // trim trailing spaces
 211                $lastRealChar = $nextNewline;
 212                while (($lastRealChar > $pos && $lastRealChar < $length) && (ctype_space (sq_substr($body,$lastRealChar,1)))) {
 213                    $lastRealChar--;
 214                }
 215                // decide if appending the short string is what we want
 216                if (($nextNewline < $length && sq_substr($body,$nextNewline,1) == "\n") &&
 217                      isset($lastRealChar)) {
 218                    $mypos = $pos;
 219                    //check the first word:
 220                    while (($mypos < $length) && (sq_substr($body,$mypos,1) == '>')) {
 221                        $mypos++;
 222                        // skip over any spaces interleaved among the cite markers
 223                        while (($mypos < $length) && (sq_substr($body,$mypos,1) == ' ')) {
 224                            $mypos++;
 225                        }
 226                    }
 227 /*
 228                      $ldnspacecnt = 0;
 229                      if ($mypos == $nextNewline+1) {
 230                         while (($mypos < $length) && ($body{$mypos} == ' ')) {
 231                          $ldnspacecnt++;
 232                         }
 233                      }
 234 */
 235
 236                    $firstword = sq_substr($body,$mypos,sq_strpos($body,' ',$mypos) - $mypos);
 237                    //if ($dowrap || $ldnspacecnt > 1 || ($firstword && (
 238                    if (!$smartwrap || $firstword && (
 239                                         $firstword{0} == '-' ||
 240                                         $firstword{0} == '+' ||
 241                                         $firstword{0} == '*' ||
 242                                         sq_substr($firstword,0,1) == sq_strtoupper(sq_substr($firstword,0,1)) ||
 243                                         strpos($firstword,':'))) {
 244                         $outString .= sq_substr($body,$pos,($lastRealChar - $pos+1));
 245                         $outStringCol += ($lastRealChar - $pos);
 246                         sqMakeNewLine($outString,$citeLevel,$outStringCol);
 247                         $nextNewline++;
 248                         $pos = $nextNewline;
 249                         $outStringCol--;
 250                         continue;
 251                    }
 252
 253                }
 254
 255                $outString .= sq_substr ($body, $pos, ($lastRealChar - $pos + 1));
 256                $outStringCol += ($lastRealChar - $pos);
 257                $pos = $nextNewline + 1;
 258                continue;
 259            }
 260
 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) {
 268                sqMakeNewLine ($outString, $citeLevel, $outStringCol);
 269                continue;
 270            }
 271
 272            // start looking backwards for whitespace to break at.
 273            $breakPoint = $eol;
 274            while (($breakPoint > $pos) && (! ctype_space (sq_substr($body,$breakPoint,1)))) {
 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
 307            $substring = sq_substr ($body, $pos, ($breakPoint - $pos));
 308            $substring = rtrim ($substring); // do rtrim and ctype_space have the same ideas about whitespace?
 309            $outString .= $substring;
 310            $outStringCol += sq_strlen ($substring);
 311            // advance past the whitespace which caused the wrap
 312            $pos = $breakPoint;
 313            while (($pos < $length) && (ctype_space (sq_substr($body,$pos,1)))) {
 314                $pos++;
 315            }
 316            if ($pos < $length) {
 317                sqMakeNewLine ($outString, $citeLevel, $outStringCol);
 318            }
 319        }
 320     }
 321
 322     return $outString;
 323 }
 324
 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  *
 331  * Specifically, &amp;#039; comes up as 5 characters instead of 1.
 332  * This should not add newlines to the end of lines.
 333  *
 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.
 337  * @return void
 338  * @since 1.0
 339  */
 340 function sqWordWrap(&$line, $wrap, $charset='') {
 341     global $languages, $squirrelmail_language;
 342
 343     // Use custom wrapping function, if translation provides it
 344     if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
 345         function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap')) {
 346         if (mb_detect_encoding($line) != 'ASCII') {
 347             $line = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap', $line, $wrap);
 348             return;
 349         }
 350     }
 351
 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     }
 359
 360     $i = 0;
 361     $line = $beginning_spaces;
 362
 363     while ($i < count($words)) {
 364         /* Force one word to be on a line (minimum) */
 365         $line .= $words[$i];
 366         $line_len = strlen($beginning_spaces) + sq_strlen($words[$i],$charset) + 2;
 367         if (isset($words[$i + 1]))
 368             $line_len += sq_strlen($words[$i + 1],$charset);
 369         $i ++;
 370
 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]))
 376                 $line_len += sq_strlen($words[$i],$charset) + 1;
 377             else
 378                 $line_len += 1;
 379         }
 380
 381         /* Skip spaces if they are the first thing on a continued line */
 382         while (!isset($words[$i]) && $i < count($words)) {
 383             $i ++;
 384         }
 385
 386         /* Go to the next line if we have more to process */
 387         if ($i < count($words)) {
 388             $line .= "\n";
 389         }
 390     }
 391 }
 392
 393 /**
 394  * Does the opposite of sqWordWrap()
 395  * @param string $body the text to un-wordwrap
 396  * @return void
 397  * @since 1.0
 398  */
 399 function sqUnWordWrap(&$body) {
 400     global $squirrelmail_language;
 401
 402     if ($squirrelmail_language == 'ja_JP') {
 403         return;
 404     }
 405
 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];
 415         } else {
 416             $CurrentRest = '';
 417         }
 418
 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
 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.
 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
 441  * @since 1.0
 442  */
 443 function readShortMailboxName($haystack, $needle) {
 444
 445     if ($needle == '') {
 446         $elem = $haystack;
 447     } else {
 448         $parts = explode($needle, $haystack);
 449         $elem = array_pop($parts);
 450         while ($elem == '' && count($parts)) {
 451             $elem = array_pop($parts);
 452         }
 453     }
 454     return( $elem );
 455 }
 456
 457
 458 /**
 459  * get_location
 460  *
 461  * Determines the location to forward to, relative to your server.
 462  * This is used in HTTP Location: redirects.
 463  *
 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.
 467  *
 468  * @return string the base url for this SquirrelMail installation
 469  * @since 1.0
 470  */
 471 function get_location () {
 472
 473     global $imap_server_type, $config_location_base;
 474
 475     /* Get the path, handle virtual directories */
 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, '/'));
 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:
 488     if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) {
 489       return $full_url . $path;
 490     }
 491     // else: autodetect
 492
 493     /* Check if this is a HTTPS or regular HTTP request. */
 494     $proto = 'http://';
 495
 496     /*
 497      * If you have 'SSLOptions +StdEnvVars' in your apache config
 498      *     OR if you have HTTPS=on in your HTTP_SERVER_VARS
 499      *     OR if you have HTTP_X_FORWARDED_PROTO=https in your HTTP_SERVER_VARS
 500      *     OR if you are on port 443
 501      */
 502     $getEnvVar = getenv('HTTPS');
 503     if (!sqgetGlobalVar('HTTP_X_FORWARDED_PROTO', $forwarded_proto, SQ_SERVER))
 504         $forwarded_proto = '';
 505     if ((isset($getEnvVar) && strcasecmp($getEnvVar, 'on') === 0) ||
 506         (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && strcasecmp($https_on, 'on') === 0) ||
 507         (strcasecmp($forwarded_proto, 'https') === 0) ||
 508         (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) &&  $server_port == 443)) {
 509         $proto = 'https://';
 510     }
 511
 512     /* Get the hostname from the Host header or server config. */
 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         }
 519     }
 520
 521     $port = '';
 522     if (! strstr($host, ':')) {
 523         if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
 524             if (($server_port != 80 && $proto == 'http://') ||
 525                 ($server_port != 443 && $proto == 'https://' &&
 526                  strcasecmp($forwarded_proto, 'https') !== 0)) {
 527                 $port = sprintf(':%d', $server_port);
 528             }
 529         }
 530     }
 531
 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 */
 535
 536     if ($imap_server_type == 'macosx' && $port == ':16080') {
 537         $port = '';
 538     }
 539
 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;
 545 }
 546
 547
 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
 574 /**
 575  * Encrypts password
 576  *
 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  *
 581  * @param string $string the (password)string to encrypt
 582  * @param string $epad the encryption key
 583  * @return string the base64-encoded encrypted password
 584  * @since 1.0
 585  */
 586 function OneTimePadEncrypt ($string, $epad) {
 587     $pad = base64_decode($epad);
 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
 598     $encrypted = '';
 599     for ($i = 0; $i < strlen ($string); $i++) {
 600         $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
 601     }
 602
 603     return base64_encode($encrypted);
 604 }
 605
 606 /**
 607  * Decrypts a password from the cookie
 608  *
 609  * Decrypts a password from the cookie, encrypted by OneTimePadEncrypt.
 610  * This uses the encryption key that is stored in the session.
 611  *
 612  * @param string $string the string to decrypt
 613  * @param string $epad the encryption key from the session
 614  * @return string the decrypted password
 615  * @since 1.0
 616  */
 617 function OneTimePadDecrypt ($string, $epad) {
 618     $pad = base64_decode($epad);
 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
 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     }
 634
 635     return $decrypted;
 636 }
 637
 638 /**
 639  * Creates encryption key
 640  *
 641  * Creates an encryption key for encrypting the password stored in the cookie.
 642  * The encryption key itself is stored in the session.
 643  *
 644  * Pad must be longer or equal to encoded string length in 1.4.4/1.5.0 and older.
 645  * @param int $length optional, length of the string to generate
 646  * @return string the encryption key
 647  * @since 1.0
 648  */
 649 function OneTimePadCreate ($length=100) {
 650     $pad = '';
 651     for ($i = 0; $i < $length; $i++) {
 652         $pad .= chr(mt_rand(0,255));
 653     }
 654
 655     return base64_encode($pad);
 656 }
 657
 658 /**
 659  * Returns a string showing the size of the message/attachment.
 660  *
 661  * @param int $bytes the filesize in bytes
 662  * @return string the filesize in human readable format
 663  * @since 1.0
 664  */
 665 function show_readable_size($bytes) {
 666     $bytes /= 1024;
 667     $type = _("KiB");
 668
 669     if ($bytes / 1024 > 1) {
 670         $bytes /= 1024;
 671         $type = _("MiB");
 672     }
 673
 674     if ($bytes < 10) {
 675         $bytes *= 10;
 676         settype($bytes, 'integer');
 677         $bytes /= 10;
 678     } else {
 679         settype($bytes, 'integer');
 680     }
 681
 682     return $bytes . '&nbsp;' . $type;
 683 }
 684
 685 /**
 686  * Generates a random string from the character set you pass in
 687  *
 688  * @param int $size the length of the string to generate
 689  * @param string $chars a string containing the characters to use
 690  * @param int $flags a flag to add a specific set to the characters to use:
 691  *     Flags:
 692  *       1 = add lowercase a-z to $chars
 693  *       2 = add uppercase A-Z to $chars
 694  *       4 = add numbers 0-9 to $chars
 695  * @return string the random string
 696  * @since 1.0
 697  */
 698 function GenerateRandomString($size, $chars, $flags = 0) {
 699     if ($flags & 0x1) {
 700         $chars .= 'abcdefghijklmnopqrstuvwxyz';
 701     }
 702     if ($flags & 0x2) {
 703         $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
 704     }
 705     if ($flags & 0x4) {
 706         $chars .= '0123456789';
 707     }
 708
 709     if (($size < 1) || (strlen($chars) < 1)) {
 710         return '';
 711     }
 712
 713     $String = '';
 714     $j = strlen( $chars ) - 1;
 715     while (strlen($String) < $size) {
 716         $String .= $chars{mt_rand(0, $j)};
 717     }
 718
 719     return $String;
 720 }
 721
 722 /**
 723  * Escapes special characters for use in IMAP commands.
 724  *
 725  * @param string $str the string to escape
 726  * @return string the escaped string
 727  * @since 1.0.3
 728  */
 729 function quoteimap($str) {
 730     return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
 731 }
 732
 733 /**
 734  * Create compose link
 735  *
 736  * Returns a link to the compose-page, taking in consideration
 737  * the compose_in_new and javascript settings.
 738  * @param string $url the URL to the compose page
 739  * @param string $text the link text, default "Compose"
 740  * @param string $target (since 1.4.3) url target
 741  * @return string a link to the compose page
 742  * @since 1.4.2
 743  */
 744 function makeComposeLink($url, $text = null, $target='') {
 745     global $compose_new_win, $compose_width,
 746            $compose_height, $oTemplate;
 747
 748     if(!$text) {
 749         $text = _("Compose");
 750     }
 751
 752     // if not using "compose in new window", make
 753     // regular link and be done with it
 754     if($compose_new_win != '1') {
 755         return makeInternalLink($url, $text, $target);
 756     }
 757
 758     // build the compose in new window link...
 759
 760
 761     // if javascript is on, use onclick event to handle it
 762     if(checkForJavascript()) {
 763         sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
 764         $compuri = SM_BASE_URI.$url;
 765
 766         return create_hyperlink('javascript:void(0)', $text, '', "comp_in_new('$compuri','$compose_width','$compose_height')");
 767     }
 768
 769     // otherwise, just open new window using regular HTML
 770     return makeInternalLink($url, $text, '_blank');
 771 }
 772
 773 /**
 774  * version of fwrite which checks for failure
 775  * @param resource $fp
 776  * @param string $string
 777  * @return number of written bytes. false on failure
 778  * @since 1.4.3
 779  */
 780 function sq_fwrite($fp, $string) {
 781         // write to file
 782         $count = @fwrite($fp,$string);
 783         // the number of bytes written should be the length of the string
 784         if($count != strlen($string)) {
 785                 return FALSE;
 786         }
 787
 788         return $count;
 789 }
 790
 791 /**
 792  * sq_get_html_translation_table
 793  *
 794  * Returns the translation table used by sq_htmlentities()
 795  *
 796  * @param integer $table html translation table. Possible values (without quotes):
 797  *             <ul>
 798  *                <li>HTML_ENTITIES - full html entities table defined by charset</li>
 799  *                <li>HTML_SPECIALCHARS - html special characters table</li>
 800  *             </ul>
 801  * @param integer $quote_style quote encoding style. Possible values (without quotes):
 802  *              <ul>
 803  *                <li>ENT_COMPAT - (default) encode double quotes</li>
 804  *                <li>ENT_NOQUOTES -  don't encode double or single quotes</li>
 805  *                <li>ENT_QUOTES - encode double and single quotes</li>
 806  *              </ul>
 807  * @param string $charset charset used for encoding. default to us-ascii, 'auto' uses $default_charset global value.
 808  * @return array html translation array
 809  * @since 1.5.1
 810  */
 811 function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT,$charset='us-ascii') {
 812   global $default_charset;
 813
 814   if ($table == HTML_SPECIALCHARS) $charset='us-ascii';
 815
 816   // Start array with ampersand
 817   $sq_html_ent_table = array( "&" => '&amp;' );
 818
 819   // < and >
 820   $sq_html_ent_table = array_merge($sq_html_ent_table,
 821                         array("<" => '&lt;',
 822                               ">" => '&gt;')
 823                         );
 824   // double quotes
 825   if ($quote_style == ENT_COMPAT)
 826      $sq_html_ent_table = array_merge($sq_html_ent_table,
 827                             array("\"" => '&quot;')
 828                             );
 829
 830   // double and single quotes
 831   if ($quote_style == ENT_QUOTES)
 832      $sq_html_ent_table = array_merge($sq_html_ent_table,
 833                             array("\"" => '&quot;',
 834                               "'" => '&#39;')
 835                             );
 836
 837   if ($charset=='auto') $charset=$default_charset;
 838
 839   // add entities that depend on charset
 840   switch($charset){
 841   case 'iso-8859-1':
 842     include_once(SM_PATH . 'functions/htmlentities/iso-8859-1.php');
 843     break;
 844   case 'utf-8':
 845     include_once(SM_PATH . 'functions/htmlentities/utf-8.php');
 846     break;
 847   case 'us-ascii':
 848   default:
 849     break;
 850   }
 851   // return table
 852   return $sq_html_ent_table;
 853 }
 854
 855 /**
 856  * sq_htmlentities
 857  *
 858  * Convert all applicable characters to HTML entities.
 859  * Minimal php requirement - v.4.0.5.
 860  *
 861  * Function is designed for people that want to use full power of htmlentities() in
 862  * i18n environment.
 863  *
 864  * @param string $string string that has to be sanitized
 865  * @param integer $quote_style quote encoding style. Possible values (without quotes):
 866  *              <ul>
 867  *                <li>ENT_COMPAT - (default) encode double quotes</li>
 868  *                <li>ENT_NOQUOTES - don't encode double or single quotes</li>
 869  *                <li>ENT_QUOTES - encode double and single quotes</li>
 870  *              </ul>
 871  * @param string $charset charset used for encoding. defaults to 'us-ascii', 'auto' uses $default_charset global value.
 872  * @return string sanitized string
 873  * @since 1.5.1
 874  */
 875 function sq_htmlentities($string,$quote_style=ENT_COMPAT,$charset='us-ascii') {
 876   // get translation table
 877   $sq_html_ent_table=sq_get_html_translation_table(HTML_ENTITIES,$quote_style,$charset);
 878   // convert characters
 879   return str_replace(array_keys($sq_html_ent_table),array_values($sq_html_ent_table),$string);
 880 }
 881
 882 /**
 883  * Tests if string contains 8bit symbols.
 884  *
 885  * If charset is not set, function defaults to default_charset.
 886  * $default_charset global must be set correctly if $charset is
 887  * not used.
 888  * @param string $string tested string
 889  * @param string $charset charset used in a string
 890  * @return bool true if 8bit symbols are detected
 891  * @since 1.5.1 and 1.4.4
 892  */
 893 function sq_is8bit($string,$charset='') {
 894     global $default_charset;
 895
 896     if ($charset=='') $charset=$default_charset;
 897
 898     /**
 899      * Don't use \240 in ranges. Sometimes RH 7.2 doesn't like it.
 900      * Don't use \200-\237 for iso-8859-x charsets. This range
 901      * stores control symbols in those charsets.
 902      * Use preg_match instead of ereg in order to avoid problems
 903      * with mbstring overloading
 904      */
 905     if (preg_match("/^iso-8859/i",$charset)) {
 906         $needle='/\240|[\241-\377]/';
 907     } else {
 908         $needle='/[\200-\237]|\240|[\241-\377]/';
 909     }
 910     return preg_match("$needle",$string);
 911 }
 912
 913 /**
 914  * Replacement of mb_list_encodings function
 915  *
 916  * This function provides replacement for function that is available only
 917  * in php 5.x. Function does not test all mbstring encodings. Only the ones
 918  * that might be used in SM translations.
 919  *
 920  * Supported strings are stored in session in order to reduce number of
 921  * mb_internal_encoding function calls.
 922  *
 923  * If you want to test all mbstring encodings - fill $list_of_encodings
 924  * array.
 925  * @return array list of encodings supported by php mbstring extension
 926  * @since 1.5.1 and 1.4.6
 927  */
 928 function sq_mb_list_encodings() {
 929     if (! function_exists('mb_internal_encoding'))
 930         return array();
 931
 932     // php 5+ function
 933     if (function_exists('mb_list_encodings')) {
 934         $ret = mb_list_encodings();
 935         array_walk($ret,'sq_lowercase_array_vals');
 936         return $ret;
 937     }
 938
 939     // don't try to test encodings, if they are already stored in session
 940     if (sqgetGlobalVar('mb_supported_encodings',$mb_supported_encodings,SQ_SESSION))
 941         return $mb_supported_encodings;
 942
 943     // save original encoding
 944     $orig_encoding=mb_internal_encoding();
 945
 946     $list_of_encoding=array(
 947         'pass',
 948         'auto',
 949         'ascii',
 950         'jis',
 951         'utf-8',
 952         'sjis',
 953         'euc-jp',
 954         'iso-8859-1',
 955         'iso-8859-2',
 956         'iso-8859-7',
 957         'iso-8859-9',
 958         'iso-8859-15',
 959         'koi8-r',
 960         'koi8-u',
 961         'big5',
 962         'gb2312',
 963         'gb18030',
 964         'windows-1251',
 965         'windows-1255',
 966         'windows-1256',
 967         'tis-620',
 968         'iso-2022-jp',
 969         'euc-cn',
 970         'euc-kr',
 971         'euc-tw',
 972         'uhc',
 973         'utf7-imap');
 974
 975     $supported_encodings=array();
 976
 977     foreach ($list_of_encoding as $encoding) {
 978         // try setting encodings. suppress warning messages
 979         if (@mb_internal_encoding($encoding))
 980             $supported_encodings[]=$encoding;
 981     }
 982
 983     // restore original encoding
 984     mb_internal_encoding($orig_encoding);
 985
 986     // register list in session
 987     sqsession_register($supported_encodings,'mb_supported_encodings');
 988
 989     return $supported_encodings;
 990 }
 991
 992 /**
 993  * Callback function used to lowercase array values.
 994  * @param string $val array value
 995  * @param mixed $key array key
 996  * @since 1.5.1 and 1.4.6
 997  */
 998 function sq_lowercase_array_vals(&$val,$key) {
 999     $val = strtolower($val);
1000 }
1001
1002
1003 /**
1004  * Function returns number of characters in string.
1005  *
1006  * Returned number might be different from number of bytes in string,
1007  * if $charset is multibyte charset. Detection depends on mbstring
1008  * functions. If mbstring does not support tested multibyte charset,
1009  * vanilla string length function is used.
1010  * @param string $str string
1011  * @param string $charset charset
1012  * @since 1.5.1 and 1.4.6
1013  * @return integer number of characters in string
1014  */
1015 function sq_strlen($str, $charset=null){
1016     // default option
1017     if (is_null($charset)) return strlen($str);
1018
1019     // lowercase charset name
1020     $charset=strtolower($charset);
1021
1022     // use automatic charset detection, if function call asks for it
1023     if ($charset=='auto') {
1024         global $default_charset, $squirrelmail_language;
1025         set_my_charset();
1026         $charset=$default_charset;
1027         if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1028     }
1029
1030     // Use mbstring only with listed charsets
1031     $aList_of_mb_charsets=array('utf-8','big5','gb2312','gb18030','euc-jp','euc-cn','euc-tw','euc-kr');
1032
1033     // calculate string length according to charset
1034     if (in_array($charset,$aList_of_mb_charsets) && in_array($charset,sq_mb_list_encodings())) {
1035         $real_length = mb_strlen($str,$charset);
1036     } else {
1037         // own strlen detection code is removed because missing strpos,
1038         // strtoupper and substr implementations break string wrapping.
1039         $real_length=strlen($str);
1040     }
1041     return $real_length;
1042 }
1043
1044 /**
1045  * string padding with multibyte support
1046  *
1047  * @link http://www.php.net/str_pad
1048  * @param string $string original string
1049  * @param integer $width padded string width
1050  * @param string $pad padding symbols
1051  * @param integer $padtype padding type
1052  *  (internal php defines, see str_pad() description)
1053  * @param string $charset charset used in original string
1054  * @return string padded string
1055  */
1056 function sq_str_pad($string, $width, $pad, $padtype, $charset='') {
1057
1058     $charset = strtolower($charset);
1059     $padded_string = '';
1060
1061     switch ($charset) {
1062     case 'utf-8':
1063     case 'big5':
1064     case 'gb2312':
1065     case 'euc-kr':
1066         /*
1067          * all multibyte charsets try to increase width value by
1068          * adding difference between number of bytes and real length
1069          */
1070         $width = $width - sq_strlen($string,$charset) + strlen($string);
1071     default:
1072         $padded_string=str_pad($string,$width,$pad,$padtype);
1073     }
1074     return $padded_string;
1075 }
1076
1077 /**
1078  * Wrapper that is used to switch between vanilla and multibyte substr
1079  * functions.
1080  * @param string $string
1081  * @param integer $start
1082  * @param integer $length
1083  * @param string $charset
1084  * @return string
1085  * @since 1.5.1
1086  * @link http://www.php.net/substr
1087  * @link http://www.php.net/mb_substr
1088  */
1089 function sq_substr($string,$start,$length,$charset='auto') {
1090     // use automatic charset detection, if function call asks for it
1091     static $charset_auto, $bUse_mb;
1092
1093     if ($charset=='auto') {
1094         if (!isset($charset_auto)) {
1095             global $default_charset, $squirrelmail_language;
1096             set_my_charset();
1097             $charset=$default_charset;
1098             if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1099             $charset_auto = $charset;
1100         } else {
1101             $charset = $charset_auto;
1102         }
1103     }
1104     $charset = strtolower($charset);
1105
1106     // in_array call is expensive => do it once and use a static var for
1107     // storing the results
1108     if (!isset($bUse_mb)) {
1109         if (in_array($charset,sq_mb_list_encodings())) {
1110             $bUse_mb = true;
1111         } else {
1112             $bUse_mb = false;
1113         }
1114     }
1115
1116     if ($bUse_mb) {
1117         return mb_substr($string,$start,$length,$charset);
1118     }
1119     // TODO: add mbstring independent code
1120
1121     // use vanilla string functions as last option
1122     return substr($string,$start,$length);
1123 }
1124
1125 /**
1126  * Wrapper that is used to switch between vanilla and multibyte strpos
1127  * functions.
1128  * @param string $haystack
1129  * @param mixed $needle
1130  * @param integer $offset
1131  * @param string $charset
1132  * @return string
1133  * @since 1.5.1
1134  * @link http://www.php.net/strpos
1135  * @link http://www.php.net/mb_strpos
1136  */
1137 function sq_strpos($haystack,$needle,$offset,$charset='auto') {
1138     // use automatic charset detection, if function call asks for it
1139     static $charset_auto, $bUse_mb;
1140
1141     if ($charset=='auto') {
1142         if (!isset($charset_auto)) {
1143             global $default_charset, $squirrelmail_language;
1144             set_my_charset();
1145             $charset=$default_charset;
1146             if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1147             $charset_auto = $charset;
1148         } else {
1149             $charset = $charset_auto;
1150         }
1151     }
1152     $charset = strtolower($charset);
1153
1154     // in_array call is expensive => do it once and use a static var for
1155     // storing the results
1156     if (!isset($bUse_mb)) {
1157         if (in_array($charset,sq_mb_list_encodings())) {
1158             $bUse_mb = true;
1159         } else {
1160             $bUse_mb = false;
1161         }
1162     }
1163     if ($bUse_mb) {
1164         return mb_strpos($haystack,$needle,$offset,$charset);
1165     }
1166     // TODO: add mbstring independent code
1167
1168     // use vanilla string functions as last option
1169     return strpos($haystack,$needle,$offset);
1170 }
1171
1172 /**
1173  * Wrapper that is used to switch between vanilla and multibyte strtoupper
1174  * functions.
1175  * @param string $string
1176  * @param string $charset
1177  * @return string
1178  * @since 1.5.1
1179  * @link http://www.php.net/strtoupper
1180  * @link http://www.php.net/mb_strtoupper
1181  */
1182 function sq_strtoupper($string,$charset='auto') {
1183     // use automatic charset detection, if function call asks for it
1184     static $charset_auto, $bUse_mb;
1185
1186     if ($charset=='auto') {
1187         if (!isset($charset_auto)) {
1188             global $default_charset, $squirrelmail_language;
1189             set_my_charset();
1190             $charset=$default_charset;
1191             if ($squirrelmail_language=='ja_JP') $charset='euc-jp';
1192             $charset_auto = $charset;
1193         } else {
1194             $charset = $charset_auto;
1195         }
1196     }
1197     $charset = strtolower($charset);
1198
1199     // in_array call is expensive => do it once and use a static var for
1200     // storing the results
1201     if (!isset($bUse_mb)) {
1202         if (function_exists('mb_strtoupper') &&
1203             in_array($charset,sq_mb_list_encodings())) {
1204             $bUse_mb = true;
1205         } else {
1206             $bUse_mb = false;
1207         }
1208     }
1209
1210     if ($bUse_mb) {
1211         return mb_strtoupper($string,$charset);
1212     }
1213     // TODO: add mbstring independent code
1214
1215     // use vanilla string functions as last option
1216     return strtoupper($string);
1217 }
1218
1219 /**
1220  * Counts 8bit bytes in string
1221  * @param string $string tested string
1222  * @return integer number of 8bit bytes
1223  */
1224 function sq_count8bit($string) {
1225     $count=0;
1226     for ($i=0; $i<strlen($string); $i++) {
1227         if (ord($string[$i]) > 127) $count++;
1228     }
1229     return $count;
1230 }
1231
1232 /**
1233  * Callback function to trim whitespace from a value, to be used in array_walk
1234  * @param string $value value to trim
1235  * @since 1.5.2 and 1.4.7
1236  */
1237 function sq_trim_value ( &$value ) {
1238     $value = trim($value);
1239 }