functions/strings.php

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