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-2005 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 /** @ignore */
  16 if (!defined('SM_PATH')) define('SM_PATH','../');
  17
  18 /**
  19  * SquirrelMail version number -- DO NOT CHANGE
  20  */
  21 global $version;
  22 $version = '1.5.1 [CVS]';
  23
  24 /**
  25  * SquirrelMail internal version number -- DO NOT CHANGE
  26  * $sm_internal_version = array (release, major, minor)
  27  */
  28 global $SQM_INTERNAL_VERSION;
  29 $SQM_INTERNAL_VERSION = array(1,5,1);
  30
  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  */
  36 include_once(SM_PATH . 'functions/global.php');
  37
  38 /**
  39  * Appends citation markers to the string.
  40  * Also appends a trailing space.
  41  *
  42  * @author Justus Pendleton
  43  * @param string $str The string to append to
  44  * @param int $citeLevel the number of markers to append
  45  * @return null
  46  * @since 1.5.1
  47  */
  48 function 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
  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
  65  * @return null
  66  * @since 1.5.1
  67  */
  68 function 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 /**
  80  * Checks for spaces in strings - only used if PHP doesn't have native ctype support
  81  *
  82  * You might be able to rewrite the function by adding short evaluation form.
  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
  96  * @return bool true when only whitespace symbols are present in test string
  97  * @since 1.5.1
  98  */
  99 function sm_ctype_space($string) {
 100     if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) || $string=='') {
 101         return true;
 102     } else {
 103         return false;
 104     }
 105 }
 106
 107 /**
 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
 114  * @param string $body the entire body of text
 115  * @param int $wrap the maximum line length
 116  * @return string the wrapped text
 117  * @since 1.5.1
 118  */
 119 function &sqBodyWrap (&$body, $wrap) {
 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
 127     // the newly wrapped text
 128     $outString = '';
 129     // current column since the last newline in the outstring
 130     $outStringCol = 0;
 131     $length = sq_strlen($body);
 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
 143        while (($pos < $length) && (sq_substr($body,$pos,1) == '>')) {
 144            $newCiteLevel++;
 145            $pos++;
 146
 147            // skip over any spaces interleaved among the cite markers
 148            while (($pos < $length) && (sq_substr($body,$pos,1) == ' ')) {
 149
 150                $pos++;
 151
 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
 161        if ((sq_substr($body,$pos,1) == "\n" ) && (sq_strlen($outString) != 0)) {
 162            $outStringLast = $outString{sq_strlen($outString) - 1};
 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
 196        $nextNewline = sq_strpos ($body, "\n", $pos);
 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) {
 205            $outString .= sq_substr ($body, $pos, ($nextNewline - $pos));
 206            $outStringCol = $nextNewline - $pos;
 207            if ($nextNewline != $length) {
 208                sqMakeNewLine ($outString, 0, $outStringCol);
 209            }
 210            $pos = $nextNewline + 1;
 211            continue;
 212        }
 213        /**
 214         * Set this to false to stop appending short strings to previous lines
 215         */
 216        $smartwrap = true;
 217        // inner loop, (obviously) handles wrapping up to
 218        // the next newline
 219        while ($pos < $nextNewline) {
 220            // skip over initial spaces
 221            while (($pos < $nextNewline) && (ctype_space (sq_substr($body,$pos,1)))) {
 222                $pos++;
 223            }
 224            // if this is a short line then just append it and continue outer loop
 225            if (($outStringCol + $nextNewline - $pos) <= ($wrap - $citeLevel - 1) ) {
 226                // if this is the final line in the input string then include
 227                // any trailing newlines
 228                //      echo substr($body,$pos,$wrap). "<br />";
 229                if (($nextNewline + 1 == $length) && (sq_substr($body,$nextNewline,1) == "\n")) {
 230                    $nextNewline++;
 231                }
 232
 233                // trim trailing spaces
 234                $lastRealChar = $nextNewline;
 235                while (($lastRealChar > $pos && $lastRealChar < $length) && (ctype_space (sq_substr($body,$lastRealChar,1)))) {
 236                    $lastRealChar--;
 237                }
 238                // decide if appending the short string is what we want
 239                if (($nextNewline < $length && sq_substr($body,$nextNewline,1) == "\n") &&
 240                      isset($lastRealChar)) {
 241                    $mypos = $pos;
 242                    //check the first word:
 243                    while (($mypos < $length) && (sq_substr($body,$mypos,1) == '>')) {
 244                        $mypos++;
 245                        // skip over any spaces interleaved among the cite markers
 246                        while (($mypos < $length) && (sq_substr($body,$mypos,1) == ' ')) {
 247                            $mypos++;
 248                        }
 249                    }
 250 /*
 251                      $ldnspacecnt = 0;
 252                      if ($mypos == $nextNewline+1) {
 253                         while (($mypos < $length) && ($body{$mypos} == ' ')) {
 254                          $ldnspacecnt++;
 255                         }
 256                      }
 257 */
 258
 259                    $firstword = sq_substr($body,$mypos,sq_strpos($body,' ',$mypos) - $mypos);
 260                    //if ($dowrap || $ldnspacecnt > 1 || ($firstword && (
 261                    if (!$smartwrap || $firstword && (
 262                                         $firstword{0} == '-' ||
 263                                         $firstword{0} == '+' ||
 264                                         $firstword{0} == '*' ||
 265                                         sq_substr($firstword,0,1) == sq_strtoupper(sq_substr($firstword,0,1)) ||
 266                                         strpos($firstword,':'))) {
 267                         $outString .= sq_substr($body,$pos,($lastRealChar - $pos+1));
 268                         $outStringCol += ($lastRealChar - $pos);
 269                         sqMakeNewLine($outString,$citeLevel,$outStringCol);
 270                         $nextNewline++;
 271                         $pos = $nextNewline;
 272                         $outStringCol--;
 273                         continue;
 274                    }
 275
 276                }
 277
 278                $outString .= sq_substr ($body, $pos, ($lastRealChar - $pos + 1));
 279                $outStringCol += ($lastRealChar - $pos);
 280                $pos = $nextNewline + 1;
 281                continue;
 282            }
 283
 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) {
 291                sqMakeNewLine ($outString, $citeLevel, $outStringCol);
 292                continue;
 293            }
 294
 295            // start looking backwards for whitespace to break at.
 296            $breakPoint = $eol;
 297            while (($breakPoint > $pos) && (! ctype_space (sq_substr($body,$breakPoint,1)))) {
 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
 330            $substring = sq_substr ($body, $pos, ($breakPoint - $pos));
 331            $substring = rtrim ($substring); // do rtrim and ctype_space have the same ideas about whitespace?
 332            $outString .= $substring;
 333            $outStringCol += sq_strlen ($substring);
 334            // advance past the whitespace which caused the wrap
 335            $pos = $breakPoint;
 336            while (($pos < $length) && (ctype_space (sq_substr($body,$pos,1)))) {
 337                $pos++;
 338            }
 339            if ($pos < $length) {
 340                sqMakeNewLine ($outString, $citeLevel, $outStringCol);
 341            }
 342        }
 343     }
 344
 345     return $outString;
 346 }
 347
 348 /**
 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  *
 354  * Specifically, &amp;#039; comes up as 5 characters instead of 1.
 355  * This should not add newlines to the end of lines.
 356  *
 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.
 360  * @return void
 361  * @since 1.0
 362  */
 363 function sqWordWrap(&$line, $wrap, $charset='') {
 364     global $languages, $squirrelmail_language;
 365
 366     // Use custom wrapping function, if translation provides it
 367     if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
 368         function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap')) {
 369         if (mb_detect_encoding($line) != 'ASCII') {
 370             $line = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap', $line, $wrap);
 371             return;
 372         }
 373     }
 374
 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     }
 382
 383     $i = 0;
 384     $line = $beginning_spaces;
 385
 386     while ($i < count($words)) {
 387         /* Force one word to be on a line (minimum) */
 388         $line .= $words[$i];
 389         $line_len = strlen($beginning_spaces) + sq_strlen($words[$i],$charset) + 2;
 390         if (isset($words[$i + 1]))
 391             $line_len += sq_strlen($words[$i + 1],$charset);
 392         $i ++;
 393
 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]))
 399                 $line_len += sq_strlen($words[$i],$charset) + 1;
 400             else
 401                 $line_len += 1;
 402         }
 403
 404         /* Skip spaces if they are the first thing on a continued line */
 405         while (!isset($words[$i]) && $i < count($words)) {
 406             $i ++;
 407         }
 408
 409         /* Go to the next line if we have more to process */
 410         if ($i < count($words)) {
 411             $line .= "\n";
 412         }
 413     }
 414 }
 415
 416 /**
 417  * Does the opposite of sqWordWrap()
 418  * @param string $body the text to un-wordwrap
 419  * @return void
 420  * @since 1.0
 421  */
 422 function sqUnWordWrap(&$body) {
 423     global $squirrelmail_language;
 424
 425     if ($squirrelmail_language == 'ja_JP') {
 426         return;
 427     }
 428
 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];
 438         } else {
 439             $CurrentRest = '';
 440         }
 441
 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 /**
 458  * If $haystack is a full mailbox name and $needle is the mailbox
 459  * separator character, returns the last part of the mailbox name.
 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
 464  * @since 1.0
 465  */
 466 function readShortMailboxName($haystack, $needle) {
 467
 468     if ($needle == '') {
 469         $elem = $haystack;
 470     } else {
 471         $parts = explode($needle, $haystack);
 472         $elem = array_pop($parts);
 473         while ($elem == '' && count($parts)) {
 474             $elem = array_pop($parts);
 475         }
 476     }
 477     return( $elem );
 478 }
 479
 480 /**
 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  */
 489 function 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 /**
 504  * get_location
 505  *
 506  * Determines the location to forward to, relative to your server.
 507  * This is used in HTTP Location: redirects.
 508  * If this doesnt work correctly for you (although it should), you can
 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/
 513  *
 514  * @return string the base url for this SquirrelMail installation
 515  * @since 1.0
 516  */
 517 function get_location () {
 518
 519     global $imap_server_type;
 520
 521     /* Get the path, handle virtual directories */
 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, '/'));
 528     if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) {
 529       return $full_url . $path;
 530     }
 531
 532     /* Check if this is a HTTPS or regular HTTP request. */
 533     $proto = 'http://';
 534
 535     /*
 536      * If you have 'SSLOptions +StdEnvVars' in your apache config
 537      *     OR if you have HTTPS=on in your HTTP_SERVER_VARS
 538      *     OR if you are on port 443
 539      */
 540     $getEnvVar = getenv('HTTPS');
 541     if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
 542         (sqgetGlobalVar('HTTPS', $https_on, SQ_SERVER) && !strcasecmp($https_on, 'on')) ||
 543         (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) &&  $server_port == 443)) {
 544         $proto = 'https://';
 545     }
 546
 547     /* Get the hostname from the Host header or server config. */
 548     if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) {
 549       if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) {
 550         $host = '';
 551       }
 552     }
 553
 554     $port = '';
 555     if (! strstr($host, ':')) {
 556         if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
 557             if (($server_port != 80 && $proto == 'http://') ||
 558                 ($server_port != 443 && $proto == 'https://')) {
 559                 $port = sprintf(':%d', $server_port);
 560             }
 561         }
 562     }
 563
 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 */
 567
 568    if ($imap_server_type == 'macosx' && $port == ':16080') {
 569         $port = '';
 570    }
 571
 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;
 577 }
 578
 579
 580 /**
 581  * Encrypts password
 582  *
 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  *
 587  * @param string $string the (password)string to encrypt
 588  * @param string $epad the encryption key
 589  * @return string the base64-encoded encrypted password
 590  * @since 1.0
 591  */
 592 function OneTimePadEncrypt ($string, $epad) {
 593     $pad = base64_decode($epad);
 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
 604     $encrypted = '';
 605     for ($i = 0; $i < strlen ($string); $i++) {
 606         $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
 607     }
 608
 609     return base64_encode($encrypted);
 610 }
 611
 612 /**
 613  * Decrypts a password from the cookie
 614  *
 615  * Decrypts a password from the cookie, encrypted by OneTimePadEncrypt.
 616  * This uses the encryption key that is stored in the session.
 617  *
 618  * @param string $string the string to decrypt
 619  * @param string $epad the encryption key from the session
 620  * @return string the decrypted password
 621  * @since 1.0
 622  */
 623 function OneTimePadDecrypt ($string, $epad) {
 624     $pad = base64_decode($epad);
 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
 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     }
 640
 641     return $decrypted;
 642 }
 643
 644
 645 /**
 646  * Randomizes the mt_rand() function.
 647  *
 648  * Toss this in strings or integers and it will seed the generator
 649  * appropriately. With strings, it is better to get them long.
 650  * Use md5() to lengthen smaller strings.
 651  *
 652  * @param mixed $val a value to seed the random number generator. mixed = integer or string.
 653  * @return void
 654  * @since 1.0
 655  */
 656 function sq_mt_seed($Val) {
 657     /* if mt_getrandmax() does not return a 2^n - 1 number,
 658        this might not work well.  This uses $Max as a bitmask. */
 659     $Max = mt_getrandmax();
 660
 661     if (! is_int($Val)) {
 662             $Val = crc32($Val);
 663     }
 664
 665     if ($Val < 0) {
 666         $Val *= -1;
 667     }
 668
 669     if ($Val == 0) {
 670         return;
 671     }
 672
 673     mt_srand(($Val ^ mt_rand(0, $Max)) & $Max);
 674 }
 675
 676
 677 /**
 678  * Init random number generator
 679  *
 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.
 683  *
 684  * @return void
 685  * @since 1.0
 686  */
 687 function sq_mt_randomize() {
 688     static $randomized;
 689
 690     if ($randomized) {
 691         return;
 692     }
 693
 694     /* Global. */
 695     sqgetGlobalVar('REMOTE_PORT', $remote_port, SQ_SERVER);
 696     sqgetGlobalVar('REMOTE_ADDR', $remote_addr, SQ_SERVER);
 697     sq_mt_seed((int)((double) microtime() * 1000000));
 698     sq_mt_seed(md5($remote_port . $remote_addr . getmypid()));
 699
 700     /* getrusage */
 701     if (function_exists('getrusage')) {
 702         /* Avoid warnings with Win32 */
 703         $dat = @getrusage();
 704         if (isset($dat) && is_array($dat)) {
 705             $Str = '';
 706             foreach ($dat as $k => $v)
 707                 {
 708                     $Str .= $k . $v;
 709                 }
 710             sq_mt_seed(md5($Str));
 711         }
 712     }
 713
 714     if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) {
 715         sq_mt_seed(md5($unique_id));
 716     }
 717
 718     $randomized = 1;
 719 }
 720
 721 /**
 722  * Creates encryption key
 723  *
 724  * Creates an encryption key for encrypting the password stored in the cookie.
 725  * The encryption key itself is stored in the session.
 726  *
 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
 729  * @return string the encryption key
 730  * @since 1.0
 731  */
 732 function OneTimePadCreate ($length=100) {
 733     sq_mt_randomize();
 734
 735     $pad = '';
 736     for ($i = 0; $i < $length; $i++) {
 737         $pad .= chr(mt_rand(0,255));
 738     }
 739
 740     return base64_encode($pad);
 741 }
 742
 743 /**
 744  * Returns a string showing the size of the message/attachment.
 745  *
 746  * @param int $bytes the filesize in bytes
 747  * @return string the filesize in human readable format
 748  * @since 1.0
 749  */
 750 function show_readable_size($bytes) {
 751     $bytes /= 1024;
 752     $type = 'k';
 753
 754     if ($bytes / 1024 > 1) {
 755         $bytes /= 1024;
 756         $type = 'M';
 757     }
 758
 759     if ($bytes < 10) {
 760         $bytes *= 10;
 761         settype($bytes, 'integer');
 762         $bytes /= 10;
 763     } else {
 764         settype($bytes, 'integer');
 765     }
 766
 767     return $bytes . '&nbsp;' . $type;
 768 }
 769
 770 /**
 771  * Generates a random string from the character set you pass in
 772  *
 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:
 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
 781  * @since 1.0
 782  */
 783 function 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     }
 793
 794     if (($size < 1) || (strlen($chars) < 1)) {
 795         return '';
 796     }
 797
 798     sq_mt_randomize(); /* Initialize the random number generator */
 799
 800     $String = '';
 801     $j = strlen( $chars ) - 1;
 802     while (strlen($String) < $size) {
 803         $String .= $chars{mt_rand(0, $j)};
 804     }
 805
 806     return $String;
 807 }
 808
 809 /**
 810  * Escapes special characters for use in IMAP commands.
 811  *
 812  * @param string $str the string to escape
 813  * @return string the escaped string
 814  * @since 1.0.3
 815  */
 816 function quoteimap($str) {
 817     return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
 818 }
 819
 820 /**
 821  * Trims array
 822  *
 823  * Trims every element in the array, ie. remove the first char of each element
 824  * @param array $array the array to trim
 825  * @since 1.2.0
 826  */
 827 function 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);
 833             }
 834         } else {
 835             $$k = substr($v, 1);
 836         }
 837
 838         /* Re-assign back to array. */
 839         $array[$k] = $$k;
 840     }
 841 }
 842
 843 /**
 844  * Create compose link
 845  *
 846  * Returns a link to the compose-page, taking in consideration
 847  * the compose_in_new and javascript settings.
 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
 851  * @return string a link to the compose page
 852  * @since 1.4.2
 853  */
 854 function makeComposeLink($url, $text = null, $target='') {
 855     global $compose_new_win,$javascript_on, $compose_width, $compose_height;
 856
 857     if(!$text) {
 858         $text = _("Compose");
 859     }
 860
 861     // if not using "compose in new window", make
 862     // regular link and be done with it
 863     if($compose_new_win != '1') {
 864         return makeInternalLink($url, $text, $target);
 865     }
 866
 867     // build the compose in new window link...
 868
 869
 870     // if javascript is on, use onclick event to handle it
 871     if($javascript_on) {
 872         sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
 873         $compuri = $base_uri.$url;
 874         return "<a href=\"javascript:void(0)\" onclick=\"comp_in_new('$compuri','$compose_width','$compose_height')\">$text</a>";
 875     }
 876
 877     // otherwise, just open new window using regular HTML
 878     return makeInternalLink($url, $text, '_blank');
 879 }
 880
 881 /**
 882  * Print variable
 883  *
 884  * sm_print_r($some_variable, [$some_other_variable [, ...]]);
 885  *
 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.
 889  * The output is wrapped in <<pre>> and <</pre>> tags.
 890  * Since 1.4.2 accepts unlimited number of arguments.
 891  * @since 1.4.1
 892  * @return void
 893  */
 894 function sm_print_r() {
 895     ob_start();  // Buffer output
 896     foreach(func_get_args() as $var) {
 897         print_r($var);
 898         echo "\n";
 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));
 903             // make sure that $aMethods is array and array is not empty
 904             if (is_array($aMethods) && $aMethods!=array()) {
 905                 echo "Object methods:\n";
 906                 foreach($aMethods as $method) {
 907                     echo '* ' . $method . "\n";
 908                 }
 909             }
 910             echo "\n";
 911         }
 912     }
 913     $buffer = ob_get_contents(); // Grab the print_r output
 914     ob_end_clean();  // Silently discard the output & stop buffering
 915     print '<div align="left"><pre>';
 916     print htmlentities($buffer);
 917     print '</pre></div>';
 918 }
 919
 920 /**
 921  * version of fwrite which checks for failure
 922  * @param resource $fp
 923  * @param string $string
 924  * @return number of written bytes. false on failure
 925  * @since 1.4.3
 926  */
 927 function sq_fwrite($fp, $string) {
 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;
 936 }
 937
 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):
 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>
 948  * @param integer $quote_style quote encoding style. Possible values (without quotes):
 949  *              <ul>
 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>
 953  *              </ul>
 954  * @param string $charset charset used for encoding. default to us-ascii, 'auto' uses $default_charset global value.
 955  * @return array html translation array
 956  * @since 1.5.1
 957  */
 958 function 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,
 968                         array("<" => '&lt;',
 969                               ">" => '&gt;')
 970                         );
 971   // double quotes
 972   if ($quote_style == ENT_COMPAT)
 973      $sq_html_ent_table = array_merge($sq_html_ent_table,
 974                             array("\"" => '&quot;')
 975                             );
 976
 977   // double and single quotes
 978   if ($quote_style == ENT_QUOTES)
 979      $sq_html_ent_table = array_merge($sq_html_ent_table,
 980                             array("\"" => '&quot;',
 981                               "'" => '&#39;')
 982                             );
 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.
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.
1010  *
1011  * @param string $string string that has to be sanitized
1012  * @param integer $quote_style quote encoding style. Possible values (without quotes):
1013  *              <ul>
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>
1017  *              </ul>
1018  * @param string $charset charset used for encoding. defaults to 'us-ascii', 'auto' uses $default_charset global value.
1019  * @return string sanitized string
1020  * @since 1.5.1
1021  */
1022 function 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
1029 /**
1030  * Tests if string contains 8bit symbols.
1031  *
1032  * If charset is not set, function defaults to default_charset.
1033  * $default_charset global must be set correctly if $charset is
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
1038  * @since 1.5.1 and 1.4.4
1039  */
1040 function 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.
1047      * Don't use \200-\237 for iso-8859-x charsets. This range
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  *
1067  * Supported strings are stored in session in order to reduce number of
1068  * mb_internal_encoding function calls.
1069  *
1070  * If you want to test all mbstring encodings - fill $list_of_encodings
1071  * array.
1072  * @return array list of encodings supported by php mbstring extension
1073  * @since 1.5.1 and 1.4.6
1074  */
1075 function sq_mb_list_encodings() {
1076     if (! function_exists('mb_internal_encoding'))
1077         return array();
1078
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
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',
1110         'gb18030',
1111         'windows-1251',
1112         'windows-1255',
1113         'windows-1256',
1114         'tis-620',
1115         'iso-2022-jp',
1116         'euc-cn',
1117         'euc-kr',
1118         'euc-tw',
1119         'uhc',
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
1139 /**
1140  * Callback function used to lowercase array values.
1141  * @param string $val array value
1142  * @param mixed $key array key
1143  * @since 1.5.1 and 1.4.6
1144  */
1145 function sq_lowercase_array_vals(&$val,$key) {
1146     $val = strtolower($val);
1147 }
1148
1149
1150 /**
1151  * Function returns number of characters in string.
1152  *
1153  * Returned number might be different from number of bytes in string,
1154  * if $charset is multibyte charset. Detection depends on mbstring
1155  * functions. If mbstring does not support tested multibyte charset,
1156  * vanilla string length function is used.
1157  * @param string $str string
1158  * @param string $charset charset
1159  * @since 1.5.1 and 1.4.6
1160  * @return integer number of characters in string
1161  */
1162 function sq_strlen($str, $charset=null){
1163     // default option
1164     if (is_null($charset)) return strlen($str);
1165
1166     // lowercase charset name
1167     $charset=strtolower($charset);
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
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');
1178
1179     // calculate string length according to charset
1180     if (in_array($charset,$aList_of_mb_charsets) && in_array($charset,sq_mb_list_encodings())) {
1181         $real_length = mb_strlen($str,$charset);
1182     } else {
1183         // own strlen detection code is removed because missing strpos,
1184         // strtoupper and substr implementations break string wrapping.
1185         $real_length=strlen($str);
1186     }
1187     return $real_length;
1188 }
1189
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
1197  * @param integer $padtype padding type
1198  *  (internal php defines, see str_pad() description)
1199  * @param string $charset charset used in original string
1200  * @return string padded string
1201  */
1202 function 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 }
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  */
1235 function 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);
1243     if (function_exists('mb_internal_encoding') &&
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  */
1265 function 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);
1273     if (function_exists('mb_internal_encoding') &&
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  */
1293 function 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);
1301     if (function_exists('mb_strtoupper') &&
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 }
1310
1311 /**
1312  * Counts 8bit bytes in string
1313  * @param string $string tested string
1314  * @return integer number of 8bit bytes
1315  */
1316 function 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 }
1323
1324 ?>