functions/strings.php

   1 <?php
   2    /**
   3     **  strings.php
   4     **
   5     **  Copyright (c) 1999-2001 The Squirrelmail Development Team
   6     **  Licensed under the GNU GPL. For full terms see the file COPYING.
   7     **
   8     **  This code provides various string manipulation functions that are
   9     **  used by the rest of the Squirrelmail code.
  10     **
  11     **  $Id$
  12     */
  13
  14    /**
  15     * SquirrelMail version number -- DO NOT CHANGE
  16     */
  17    global $version;
  18    $version = '1.2.0 [cvs]';
  19
  20    /**
  21     * Count the number of occurances of $needle are in $haystack.
  22     * $needle can be a character or string, and need not occur in $haystack
  23     */
  24    function countCharInString($haystack, $needle) {
  25       if ($needle == '') return 0;
  26       return count(explode($needle, $haystack));
  27    }
  28
  29    /**
  30     * Read from the back of $haystack until $needle is found, or the begining
  31     * of the $haystack is reached. $needle is a single character
  32     */
  33    function readShortMailboxName($haystack, $needle) {
  34       if ($needle == '') return $haystack;
  35       $parts = explode($needle, $haystack);
  36       $elem = array_pop($parts);
  37       while ($elem == '' && count($parts))
  38       {
  39           $elem = array_pop($parts);
  40       }
  41       return $elem;
  42    }
  43
  44    /**
  45     * Read from the back of $haystack until $needle is found, or the begining
  46     * of the $haystack is reached. $needle is a single character
  47     */
  48    function readMailboxParent($haystack, $needle) {
  49       if ($needle == '') return '';
  50       $parts = explode($needle, $haystack);
  51       $elem = array_pop($parts);
  52       while ($elem == '' && count($parts))
  53       {
  54           $elem = array_pop($parts);
  55       }
  56       return join($needle, $parts);
  57    }
  58
  59    /**
  60     * Searches for the next position in a string minus white space.
  61     */
  62    function next_pos_minus_white ($haystack, $pos) {
  63       while (substr($haystack, $pos, 1) == ' ' ||
  64              substr($haystack, $pos, 1) == "\t" ||
  65              substr($haystack, $pos, 1) == "\n" ||
  66              substr($haystack, $pos, 1) == "\r") {
  67          if ($pos >= strlen($haystack))
  68             return -1;
  69          $pos++;
  70       }
  71       return $pos;
  72    }
  73
  74    /**
  75     * Wraps text at $wrap characters
  76     *
  77     * Has a problem with special HTML characters, so call this before
  78     * you do character translation.
  79     *
  80     * Specifically, &#039 comes up as 5 characters instead of 1.
  81     * This should not add newlines to the end of lines.
  82     */
  83    function sqWordWrap(&$line, $wrap) {
  84       ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
  85       $beginning_spaces = $regs[1];
  86            if (isset($regs[2])) {
  87          $words = explode(' ', $regs[2]);
  88       } else {
  89          $words = "";
  90            }
  91
  92       $i = 0;
  93       $line = $beginning_spaces;
  94
  95       while ($i < count($words)) {
  96          // Force one word to be on a line (minimum)
  97          $line .= $words[$i];
  98          $line_len = strlen($beginning_spaces) + strlen($words[$i]) + 2;
  99           if (isset($words[$i + 1]))
 100               $line_len += strlen($words[$i + 1]);
 101          $i ++;
 102
 103          // Add more words (as long as they fit)
 104          while ($line_len < $wrap && $i < count($words)) {
 105             $line .= ' ' . $words[$i];
 106             $i++;
 107              if (isset($words[$i]))
 108                 $line_len += strlen($words[$i]) + 1;
 109              else
 110                  $line_len += 1;
 111          }
 112
 113          // Skip spaces if they are the first thing on a continued line
 114          while (!isset($words[$i]) && $i < count($words)) {
 115             $i ++;
 116          }
 117
 118          // Go to the next line if we have more to process
 119          if ($i < count($words)) {
 120             $line .= "\n" . $beginning_spaces;
 121          }
 122       }
 123    }
 124
 125
 126    /**
 127     * Does the opposite of sqWordWrap()
 128     */
 129    function sqUnWordWrap(&$body) {
 130        $lines = explode("\n", $body);
 131        $body = "";
 132        $PreviousSpaces = "";
 133        for ($i = 0; $i < count($lines); $i ++) {
 134            ereg("^([\t >]*)([^\t >].*)?$", $lines[$i], $regs);
 135            $CurrentSpaces = $regs[1];
 136            if (isset($regs[2])) {
 137                $CurrentRest = $regs[2];
 138            }
 139
 140            if ($i == 0) {
 141                $PreviousSpaces = $CurrentSpaces;
 142                $body = $lines[$i];
 143            } else if (($PreviousSpaces == $CurrentSpaces)   // Do the beginnings match
 144                         && (strlen($lines[$i - 1]) > 65)    // Over 65 characters long
 145                         && strlen($CurrentRest)) {          // and there's a line to continue with
 146                $body .= ' ' . $CurrentRest;
 147            } else {
 148                $body .= "\n" . $lines[$i];
 149                $PreviousSpaces = $CurrentSpaces;
 150            }
 151        }
 152        $body .= "\n";
 153    }
 154
 155
 156    /**
 157     * Returns an array of email addresses.
 158     * Be cautious of "user@host.com"
 159     */
 160    function parseAddrs($text) {
 161       if (trim($text) == "")
 162          return array();
 163       $text = str_replace(' ', '', $text);
 164       $text = ereg_replace('"[^"]*"', '', $text);
 165       $text = ereg_replace('\\([^\\)]*\\)', '', $text);
 166       $text = str_replace(',', ';', $text);
 167       $array = explode(';', $text);
 168       for ($i = 0; $i < count ($array); $i++) {
 169                                $array[$i] = eregi_replace ("^.*[<]", '', $array[$i]);
 170                                $array[$i] = eregi_replace ("[>].*$", '', $array[$i]);
 171                     }
 172       return $array;
 173    }
 174
 175    /**
 176     * Returns a line of comma separated email addresses from an array.
 177     */
 178    function getLineOfAddrs($array) {
 179       if (is_array($array)) {
 180         $to_line = implode(', ', $array);
 181         $to_line = ereg_replace(', (, )+', ', ', $to_line);
 182         $to_line = trim(ereg_replace('^, ', '', $to_line));
 183         if( substr( $to_line, -1 ) == ',' )
 184             $to_line = substr( $to_line, 0, -1 );
 185       } else {
 186         $to_line = '';
 187       }
 188
 189       return( $to_line );
 190    }
 191
 192    function translateText(&$body, $wrap_at, $charset) {
 193       global $where, $what; // from searching
 194       global $color; // color theme
 195
 196       require_once('../functions/url_parser.php');
 197
 198       $body_ary = explode("\n", $body);
 199       $PriorQuotes = 0;
 200       for ($i=0; $i < count($body_ary); $i++) {
 201          $line = $body_ary[$i];
 202          if (strlen($line) - 2 >= $wrap_at) {
 203             sqWordWrap($line, $wrap_at);
 204          }
 205          $line = charset_decode($charset, $line);
 206          $line = str_replace("\t", '        ', $line);
 207
 208          parseUrl ($line);
 209
 210          $Quotes = 0;
 211          $pos = 0;
 212          while (1) {
 213              if ($line[$pos] == ' ') {
 214                 $pos ++;
 215              } else if (strpos($line, '&gt;', $pos) === $pos) {
 216                 $pos += 4;
 217                 $Quotes ++;
 218              } else {
 219                  break;
 220              }
 221          }
 222
 223          if ($Quotes > 1) {
 224             if (! isset($color[14])) {
 225                $color[14] = '#FF0000';
 226             }
 227             $line = '<FONT COLOR="' . $color[14] . '">' . $line . '</FONT>';
 228          } elseif ($Quotes) {
 229             if (! isset($color[13])) {
 230                $color[13] = '#800000';
 231             }
 232             $line = '<FONT COLOR="' . $color[13] . '">' . $line . '</FONT>';
 233          }
 234
 235          $body_ary[$i] = $line;
 236       }
 237       $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
 238    }
 239
 240    function find_mailbox_name ($mailbox) {
 241       if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
 242           return $regs[1];
 243       ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
 244       return $regs[1];
 245
 246    }
 247
 248    /**
 249     * This determines the location to forward to relative to your server.
 250     * If this doesnt work correctly for you (although it should), you can
 251     * remove all this code except the last two lines, and change the header()
 252     * function to look something like this, customized to the location of
 253     * SquirrelMail on your server:
 254     *
 255     *   http://www.myhost.com/squirrelmail/src/login.php
 256     */
 257    function get_location () {
 258
 259       global $PHP_SELF, $SERVER_NAME, $HTTP_HOST, $SERVER_PORT,
 260          $HTTP_SERVER_VARS;
 261
 262       /* Get the path. */
 263       $path = substr($PHP_SELF, 0, strrpos($PHP_SELF, '/'));
 264
 265       /* Check if this is a HTTPS or regular HTTP request. */
 266       $proto = 'http://';
 267
 268       /*
 269        * If you have 'SSLOptions +StdEnvVars' in your apache config
 270        *     OR if you have HTTPS in your HTTP_SERVER_VARS
 271        *     OR if you are on port 443
 272        */
 273       $getEnvVar = getenv('HTTPS');
 274       if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) ||
 275           (isset($HTTP_SERVER_VARS['HTTPS'])) ||
 276           (isset($HTTP_SERVER_VARS['SERVER_PORT']) &&
 277            $HTTP_SERVER_VARS['SERVER_PORT'] == 443)) {
 278         $proto = 'https://';
 279       }
 280
 281       // Get the hostname from the Host header or server config.
 282       $host = '';
 283       if (isset($HTTP_HOST) && !empty($HTTP_HOST)) {
 284           $host = $HTTP_HOST;
 285       } else if (isset($SERVER_NAME) && !empty($SERVER_NAME)) {
 286           $host = $SERVER_NAME;
 287       }
 288
 289       $port = '';
 290       if (! strstr($host, ':')) {
 291           if (isset($SERVER_PORT)) {
 292               if (($SERVER_PORT != 80 && $proto == 'http://')
 293                       || ($SERVER_PORT != 443 && $proto == 'https://')) {
 294                   $port = sprintf(':%d', $SERVER_PORT);
 295               }
 296           }
 297       }
 298
 299       /* Fallback is to omit the server name and use a relative */
 300       /* URI, although this is not RFC 2616 compliant.          */
 301       return ($host ? $proto . $host . $port . $path : $path);
 302    }
 303
 304
 305    /**
 306     * These functions are used to encrypt the passowrd before it is
 307     * stored in a cookie.
 308     */
 309    function OneTimePadEncrypt ($string, $epad) {
 310        $pad = base64_decode($epad);
 311        $encrypted = '';
 312        for ($i = 0; $i < strlen ($string); $i++) {
 313            $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i]));
 314        }
 315
 316        return base64_encode($encrypted);
 317    }
 318
 319    function OneTimePadDecrypt ($string, $epad) {
 320       $pad = base64_decode($epad);
 321       $encrypted = base64_decode ($string);
 322       $decrypted = '';
 323       for ($i = 0; $i < strlen ($encrypted); $i++) {
 324           $decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i]));
 325       }
 326
 327       return $decrypted;
 328    }
 329
 330
 331    /**
 332     * Randomize the mt_rand() function.  Toss this in strings or integers
 333     * and it will seed the generator appropriately. With strings, it is
 334     * better to get them long. Use md5() to lengthen smaller strings.
 335     */
 336    function sq_mt_seed($Val) {
 337        // if mt_getrandmax() does not return a 2^n - 1 number,
 338        // this might not work well.  This uses $Max as a bitmask.
 339        $Max = mt_getrandmax();
 340
 341        if (! is_int($Val)) {
 342            if (function_exists('crc32')) {
 343                $Val = crc32($Val);
 344            } else {
 345                $Str = $Val;
 346                $Pos = 0;
 347                $Val = 0;
 348                $Mask = $Max / 2;
 349                $HighBit = $Max ^ $Mask;
 350                while ($Pos < strlen($Str)) {
 351                    if ($Val & $HighBit) {
 352                        $Val = (($Val & $Mask) << 1) + 1;
 353                    } else {
 354                        $Val = ($Val & $Mask) << 1;
 355                    }
 356                    $Val ^= $Str[$Pos];
 357                    $Pos ++;
 358                }
 359            }
 360        }
 361
 362        if ($Val < 0) {
 363            $Val *= -1;
 364        }
 365
 366        if ($Val = 0) {
 367            return;
 368        }
 369
 370        mt_srand(($Val ^ mt_rand(0, $Max)) & $Max);
 371    }
 372
 373
 374    /**
 375     * This function initializes the random number generator fairly well.
 376     * It also only initializes it once, so you don't accidentally get
 377     * the same 'random' numbers twice in one session.
 378     */
 379    function sq_mt_randomize() {
 380       global $REMOTE_PORT, $REMOTE_ADDR, $UNIQUE_ID;
 381       static $randomized;
 382
 383       if ($randomized) {
 384           return;
 385       }
 386
 387       /* Global. */
 388       sq_mt_seed((int)((double) microtime() * 1000000));
 389       sq_mt_seed(md5($REMOTE_PORT . $REMOTE_ADDR . getmypid()));
 390
 391       /* getrusage */
 392       if (function_exists('getrusage')) {
 393          // Avoid warnings with Win32
 394          $dat = @getrusage();
 395          if (isset($dat) && is_array($dat)) {
 396             $Str = '';
 397             foreach ($dat as $k => $v)
 398             {
 399                $Str .= $k . $v;
 400             }
 401             sq_mt_seed(md5($Str));
 402          }
 403       }
 404
 405       // Apache-specific
 406       sq_mt_seed(md5($UNIQUE_ID));
 407
 408       $randomized = 1;
 409    }
 410
 411    function OneTimePadCreate ($length=100) {
 412       sq_mt_randomize();
 413
 414       $pad = '';
 415       for ($i = 0; $i < $length; $i++) {
 416           $pad .= chr(mt_rand(0,255));
 417       }
 418
 419       return base64_encode($pad);
 420    }
 421
 422    /**
 423     * Check if we have a required PHP-version. Return TRUE if we do,
 424     * or FALSE if we don't.
 425     *
 426     *     To check for 4.0.1, use sqCheckPHPVersion(4,0,1)
 427     *     To check for 4.0b3, use sqCheckPHPVersion(4,0,-3)
 428     *
 429     * Does not handle betas like 4.0.1b1 or development versions
 430     */
 431    function sqCheckPHPVersion($major, $minor, $release) {
 432
 433       $ver = phpversion();
 434       eregi('^([0-9]+)\\.([0-9]+)(.*)', $ver, $regs);
 435
 436       /* Parse the version string. */
 437       $vmajor  = strval($regs[1]);
 438       $vminor  = strval($regs[2]);
 439       $vrel    = $regs[3];
 440       if($vrel[0] == ".") {
 441           $vrel = strval(substr($vrel, 1));
 442       }
 443       if($vrel[0] == 'b' || $vrel[0] == 'B') {
 444           $vrel = - strval(substr($vrel, 1));
 445       }
 446       if($vrel[0] == 'r' || $vrel[0] == 'R') {
 447           $vrel = - strval(substr($vrel, 2))/10;
 448       }
 449
 450       /* Compare major version. */
 451       if ($vmajor < $major) { return false; }
 452       if ($vmajor > $major) { return true; }
 453
 454       /* Major is the same. Compare minor. */
 455       if ($vminor < $minor) { return false; }
 456       if ($vminor > $minor) { return true; }
 457
 458       /* Major and minor is the same as the required one. Compare release */
 459       if ($vrel >= 0 && $release >= 0) {       // Neither are beta
 460           if($vrel < $release) return false;
 461       } else if($vrel >= 0 && $release < 0) {  // This is not beta, required is beta
 462           return true;
 463       } else if($vrel < 0 && $release >= 0){   // This is beta, require not beta
 464           return false;
 465       } else {                                 // Both are beta
 466           if($vrel > $release) return false;
 467       }
 468
 469       return true;
 470    }
 471
 472    /**
 473     *  Returns a string showing the size of the message/attachment.
 474     */
 475    function show_readable_size($bytes) {
 476        $bytes /= 1024;
 477        $type = 'k';
 478
 479        if ($bytes / 1024 > 1) {
 480            $bytes /= 1024;
 481            $type = 'm';
 482        }
 483
 484        if ($bytes < 10) {
 485            $bytes *= 10;
 486            settype($bytes, 'integer');
 487            $bytes /= 10;
 488        } else {
 489            settype($bytes, 'integer');
 490        }
 491
 492        return $bytes . '<small>&nbsp;' . $type . '</small>';
 493    }
 494
 495    /**
 496     * Generates a random string from the caracter set you pass in
 497     *
 498     * Flags:
 499     *   1 = add lowercase a-z to $chars
 500     *   2 = add uppercase A-Z to $chars
 501     *   4 = add numbers 0-9 to $chars
 502     */
 503
 504    function GenerateRandomString($size, $chars, $flags = 0) {
 505       if ($flags & 0x1) {
 506           $chars .= 'abcdefghijklmnopqrstuvwxyz';
 507       }
 508       if ($flags & 0x2) {
 509           $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
 510       }
 511       if ($flags & 0x4) {
 512           $chars .= '0123456789';
 513       }
 514
 515       if (($size < 1) || (strlen($chars) < 1)) {
 516           return '';
 517       }
 518
 519       sq_mt_randomize(); // Initialize the random number generator
 520
 521       $String = "";
 522       while (strlen($String) < $size) {
 523          $String .= $chars[mt_rand(0, strlen($chars))];
 524       }
 525
 526       return $String;
 527    }
 528
 529    function quoteIMAP($str) {
 530        return ereg_replace('(["\\])', '\\\\1', $str);
 531    }
 532
 533     /**
 534      * Trims every element in the array
 535      */
 536     function TrimArray(&$array) {
 537         foreach ($array as $k => $v) {
 538             global $$k;
 539             if (is_array($$k)) {
 540                 foreach ($$k as $k2 => $v2) {
 541                    $$k[$k2] = substr($v2, 1);
 542                 }
 543             } else {
 544                 $$k = substr($v, 1);
 545             }
 546
 547             /* Re-assign back to array. */
 548             $array[$k] = $$k;
 549         }
 550     }
 551
 552     /**
 553      * Removes slashes from every element in the array
 554      */
 555     function RemoveSlashes(&$array) {
 556         foreach ($array as $k => $v) {
 557             global $$k;
 558             if (is_array($$k)) {
 559                 foreach ($$k as $k2 => $v2) {
 560                     $newArray[stripslashes($k2)] = stripslashes($v2);
 561                 }
 562                 $$k = $newArray;
 563             } else {
 564                 $$k = stripslashes($v);
 565             }
 566
 567             /* Re-assign back to the array. */
 568             $array[$k] = $$k;
 569         }
 570     }
 571
 572 ?>