program/include/rcube_shared.inc

   1 <?php
   2
   3 /*
   4  +-----------------------------------------------------------------------+
   5  | rcube_shared.inc                                                      |
   6  |                                                                       |
   7  | This file is part of the RoundCube PHP suite                          |
   8  | Copyright (C) 2005-2007, RoundCube Dev. - Switzerland                 |
   9  | Licensed under the GNU GPL                                            |
  10  |                                                                       |
  11  | CONTENTS:                                                             |
  12  |   Shared functions and classes used in PHP projects                   |
  13  |                                                                       |
  14  +-----------------------------------------------------------------------+
  15  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
  16  +-----------------------------------------------------------------------+
  17
  18  $Id: rcube_shared.inc 2789 2009-07-23 12:14:17Z alec $
  19
  20 */
  21
  22
  23 /**
  24  * RoundCube shared functions
  25  *
  26  * @package Core
  27  */
  28
  29
  30 /**
  31  * Send HTTP headers to prevent caching this page
  32  */
  33 function send_nocacheing_headers()
  34 {
  35   if (headers_sent())
  36     return;
  37
  38   header("Expires: ".gmdate("D, d M Y H:i:s")." GMT");
  39   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
  40   header("Cache-Control: private, must-revalidate, post-check=0, pre-check=0");
  41   header("Pragma: no-cache");
  42
  43   // We need to set the following headers to make downloads work using IE in HTTPS mode.
  44   if (isset($_SERVER['HTTPS'])) {
  45     header('Pragma: ');
  46     header('Cache-Control: ');
  47   }
  48 }
  49
  50
  51 /**
  52  * Send header with expire date 30 days in future
  53  *
  54  * @param int Expiration time in seconds
  55  */
  56 function send_future_expire_header($offset=2600000)
  57 {
  58   if (headers_sent())
  59     return;
  60
  61   header("Expires: ".gmdate("D, d M Y H:i:s", mktime()+$offset)." GMT");
  62   header("Cache-Control: max-age=$offset");
  63   header("Pragma: ");
  64 }
  65
  66
  67 /**
  68  * Check request for If-Modified-Since and send an according response.
  69  * This will terminate the current script if headers match the given values
  70  *
  71  * @param int Modified date as unix timestamp
  72  * @param string Etag value for caching
  73  */
  74 function send_modified_header($mdate, $etag=null, $skip_check=false)
  75 {
  76   if (headers_sent())
  77     return;
  78
  79   $iscached = false;
  80   $etag = $etag ? "\"$etag\"" : null;
  81
  82   if (!$skip_check)
  83   {
  84     if ($_SERVER['HTTP_IF_MODIFIED_SINCE'] && strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) >= $mdate)
  85       $iscached = true;
  86
  87     if ($etag)
  88       $iscached = ($_SERVER['HTTP_IF_NONE_MATCH'] == $etag);
  89   }
  90
  91   if ($iscached)
  92     header("HTTP/1.x 304 Not Modified");
  93   else
  94     header("Last-Modified: ".gmdate("D, d M Y H:i:s", $mdate)." GMT");
  95
  96   header("Cache-Control: max-age=0");
  97   header("Expires: ");
  98   header("Pragma: ");
  99
 100   if ($etag)
 101     header("Etag: $etag");
 102
 103   if ($iscached)
 104     {
 105     ob_end_clean();
 106     exit;
 107     }
 108 }
 109
 110
 111 /**
 112  * Returns whether an $str is a reserved word for any of the version of Javascript or ECMAScript
 113  * @param str String to check
 114  * @return boolean True if $str is a reserver word, False if not
 115  */
 116 function is_js_reserved_word($str)
 117 {
 118   return in_array($str, array(
 119     // ECMASript ver 4 reserved words
 120     'as','break','case','catch','class','const','continue',
 121     'default','delete','do','else','export','extends','false','finally','for','function',
 122     'if','import','in','instanceof','is','namespace','new','null','package','private',
 123     'public','return','super','switch','this','throw','true','try','typeof','use','var',
 124     'void','while','with',
 125     // ECMAScript ver 4 future reserved words
 126     'abstract','debugger','enum','goto','implements','interface','native','protected',
 127     'synchronized','throws','transient','volatile',
 128     // special meaning in some contexts
 129     'get','set',
 130     // were reserved in ECMAScript ver 3
 131     'boolean','byte','char','double','final','float','int','long','short','static'
 132   ));
 133 }
 134
 135
 136 /**
 137  * Convert a variable into a javascript object notation
 138  *
 139  * @param mixed Input value
 140  * @return string Serialized JSON string
 141  */
 142 function json_serialize($var)
 143 {
 144   if (is_object($var))
 145     $var = get_object_vars($var);
 146
 147   if (is_array($var))
 148   {
 149     // empty array
 150     if (!sizeof($var))
 151       return '[]';
 152     else
 153     {
 154       $keys_arr = array_keys($var);
 155       $is_assoc = $have_numeric = 0;
 156
 157       for ($i=0; $i<sizeof($keys_arr); ++$i)
 158       {
 159         if (is_numeric($keys_arr[$i]))
 160           $have_numeric = 1;
 161         if (!is_numeric($keys_arr[$i]) || $keys_arr[$i] != $i)
 162           $is_assoc = 1;
 163         if ($is_assoc && $have_numeric)
 164           break;
 165       }
 166
 167       $brackets = $is_assoc ? '{}' : '[]';
 168       $pairs = array();
 169
 170       foreach ($var as $key => $value)
 171       {
 172         // enclose key with quotes if it is not variable-name conform
 173         if (!preg_match('/^[_a-zA-Z]{1}[_a-zA-Z0-9]*$/', $key) || is_js_reserved_word($key))
 174           $key = "'$key'";
 175
 176         $pairs[] = sprintf("%s%s", $is_assoc ? "$key:" : '', json_serialize($value));
 177       }
 178
 179       return $brackets{0} . implode(',', $pairs) . $brackets{1};
 180     }
 181   }
 182   else if (!is_string($var) && strval(intval($var)) === strval($var))
 183     return $var;
 184   else if (is_bool($var))
 185     return $var ? '1' : '0';
 186   else
 187     return "'".JQ($var)."'";
 188 }
 189
 190
 191 /**
 192  * Function to convert an array to a javascript array
 193  * Actually an alias function for json_serialize()
 194  * @deprecated
 195  */
 196 function array2js($arr, $type='')
 197 {
 198   return json_serialize($arr);
 199 }
 200
 201
 202 /**
 203  * Similar function as in_array() but case-insensitive
 204  *
 205  * @param mixed Needle value
 206  * @param array Array to search in
 207  * @return boolean True if found, False if not
 208  */
 209 function in_array_nocase($needle, $haystack)
 210 {
 211   $needle = mb_strtolower($needle);
 212   foreach ($haystack as $value)
 213     if ($needle===mb_strtolower($value))
 214       return true;
 215
 216   return false;
 217 }
 218
 219
 220 /**
 221  * Find out if the string content means TRUE or FALSE
 222  *
 223  * @param string Input value
 224  * @return boolean Imagine what!
 225  */
 226 function get_boolean($str)
 227 {
 228   $str = strtolower($str);
 229   if (in_array($str, array('false', '0', 'no', 'nein', ''), TRUE))
 230     return FALSE;
 231   else
 232     return TRUE;
 233 }
 234
 235
 236 /**
 237  * Parse a human readable string for a number of bytes
 238  *
 239  * @param string Input string
 240  * @return float Number of bytes
 241  */
 242 function parse_bytes($str)
 243 {
 244   if (is_numeric($str))
 245     return floatval($str);
 246
 247   if (preg_match('/([0-9]+)([a-z])/i', $str, $regs))
 248   {
 249     $bytes = floatval($regs[1]);
 250     switch (strtolower($regs[2]))
 251     {
 252       case 'g':
 253         $bytes *= 1073741824;
 254         break;
 255       case 'm':
 256         $bytes *= 1048576;
 257         break;
 258       case 'k':
 259         $bytes *= 1024;
 260         break;
 261     }
 262   }
 263
 264   return floatval($bytes);
 265 }
 266
 267 /**
 268  * Create a human readable string for a number of bytes
 269  *
 270  * @param int Number of bytes
 271  * @return string Byte string
 272  */
 273 function show_bytes($bytes)
 274 {
 275   if ($bytes > 1073741824)
 276   {
 277     $gb = $bytes/1073741824;
 278     $str = sprintf($gb>=10 ? "%d " : "%.1f ", $gb) . rcube_label('GB');
 279   }
 280   else if ($bytes > 1048576)
 281   {
 282     $mb = $bytes/1048576;
 283     $str = sprintf($mb>=10 ? "%d " : "%.1f ", $mb) . rcube_label('MB');
 284   }
 285   else if ($bytes > 1024)
 286     $str = sprintf("%d ",  round($bytes/1024)) . rcube_label('KB');
 287   else
 288     $str = sprintf('%d ', $bytes) . rcube_label('B');
 289
 290   return $str;
 291 }
 292
 293
 294 /**
 295  * Convert paths like ../xxx to an absolute path using a base url
 296  *
 297  * @param string Relative path
 298  * @param string Base URL
 299  * @return string Absolute URL
 300  */
 301 function make_absolute_url($path, $base_url)
 302 {
 303   $host_url = $base_url;
 304   $abs_path = $path;
 305
 306   // check if path is an absolute URL
 307   if (preg_match('/^[fhtps]+:\/\//', $path))
 308     return $path;
 309
 310   // cut base_url to the last directory
 311   if (strrpos($base_url, '/')>7)
 312   {
 313     $host_url = substr($base_url, 0, strpos($base_url, '/'));
 314     $base_url = substr($base_url, 0, strrpos($base_url, '/'));
 315   }
 316
 317   // $path is absolute
 318   if ($path{0}=='/')
 319     $abs_path = $host_url.$path;
 320   else
 321   {
 322     // strip './' because its the same as ''
 323     $path = preg_replace('/^\.\//', '', $path);
 324
 325     if (preg_match_all('/\.\.\//', $path, $matches, PREG_SET_ORDER))
 326       foreach ($matches as $a_match)
 327       {
 328         if (strrpos($base_url, '/'))
 329           $base_url = substr($base_url, 0, strrpos($base_url, '/'));
 330
 331         $path = substr($path, 3);
 332       }
 333
 334     $abs_path = $base_url.'/'.$path;
 335   }
 336
 337   return $abs_path;
 338 }
 339
 340 /**
 341  * Wrapper function for wordwrap
 342  */
 343 function rc_wordwrap($string, $width=75, $break="\n", $cut=false)
 344 {
 345   $para = explode($break, $string);
 346   $string = '';
 347   while (count($para)) {
 348     $list = explode(' ', array_shift($para));
 349     $len = 0;
 350     while (count($list)) {
 351       $line = array_shift($list);
 352       $l = mb_strlen($line);
 353       $newlen = $len + $l + ($len ? 1 : 0);
 354
 355       if ($newlen <= $width) {
 356         $string .= ($len ? ' ' : '').$line;
 357         $len += (1 + $l);
 358       } else {
 359         if ($l > $width) {
 360           if ($cut) {
 361             $start = 0;
 362             while ($l) {
 363               $str = mb_substr($line, $start, $width);
 364               $strlen = mb_strlen($str);
 365               $string .= ($len ? $break : '').$str;
 366               $start += $strlen;
 367               $l -= $strlen;
 368               $len = $strlen;
 369             }
 370           } else {
 371             $string .= ($len ? $break : '').$line;
 372             if (count($list)) $string .= $break;
 373             $len = 0;
 374           }
 375         } else {
 376           $string .= $break.$line;
 377           $len = $l;
 378         }
 379       }
 380     }
 381     if (count($para)) $string .= $break;
 382   }
 383   return $string;
 384 }
 385
 386 /**
 387  * Read a specific HTTP request header
 388  *
 389  * @access static
 390  * @param  string $name Header name
 391  * @return mixed  Header value or null if not available
 392  */
 393 function rc_request_header($name)
 394 {
 395   if (function_exists('getallheaders'))
 396   {
 397     $hdrs = array_change_key_case(getallheaders(), CASE_UPPER);
 398     $key  = strtoupper($name);
 399   }
 400   else
 401   {
 402     $key  = 'HTTP_' . strtoupper(strtr($name, '-', '_'));
 403     $hdrs = array_change_key_case($_SERVER, CASE_UPPER);
 404   }
 405
 406   return $hdrs[$key];
 407   }
 408
 409
 410 /**
 411  * Make sure the string ends with a slash
 412  */
 413 function slashify($str)
 414 {
 415   return unslashify($str).'/';
 416 }
 417
 418
 419 /**
 420  * Remove slash at the end of the string
 421  */
 422 function unslashify($str)
 423 {
 424   return preg_replace('/\/$/', '', $str);
 425 }
 426
 427
 428 /**
 429  * Delete all files within a folder
 430  *
 431  * @param string Path to directory
 432  * @return boolean True on success, False if directory was not found
 433  */
 434 function clear_directory($dir_path)
 435 {
 436   $dir = @opendir($dir_path);
 437   if(!$dir) return FALSE;
 438
 439   while ($file = readdir($dir))
 440     if (strlen($file)>2)
 441       unlink("$dir_path/$file");
 442
 443   closedir($dir);
 444   return TRUE;
 445 }
 446
 447
 448 /**
 449  * Create a unix timestamp with a specified offset from now
 450  *
 451  * @param string String representation of the offset (e.g. 20min, 5h, 2days)
 452  * @param int Factor to multiply with the offset
 453  * @return int Unix timestamp
 454  */
 455 function get_offset_time($offset_str, $factor=1)
 456   {
 457   if (preg_match('/^([0-9]+)\s*([smhdw])/i', $offset_str, $regs))
 458   {
 459     $amount = (int)$regs[1];
 460     $unit = strtolower($regs[2]);
 461   }
 462   else
 463   {
 464     $amount = (int)$offset_str;
 465     $unit = 's';
 466   }
 467
 468   $ts = mktime();
 469   switch ($unit)
 470   {
 471     case 'w':
 472       $amount *= 7;
 473     case 'd':
 474       $amount *= 24;
 475     case 'h':
 476       $amount *= 60;
 477     case 'm':
 478       $amount *= 60;
 479     case 's':
 480       $ts += $amount * $factor;
 481   }
 482
 483   return $ts;
 484 }
 485
 486
 487 /**
 488  * Replace the middle part of a string with ...
 489  * if it is longer than the allowed length
 490  *
 491  * @param string Input string
 492  * @param int    Max. length
 493  * @param string Replace removed chars with this
 494  * @return string Abbreviated string
 495  */
 496 function abbreviate_string($str, $maxlength, $place_holder='...')
 497 {
 498   $length = mb_strlen($str);
 499   $first_part_length = floor($maxlength/2) - mb_strlen($place_holder);
 500
 501   if ($length > $maxlength)
 502   {
 503     $second_starting_location = $length - $maxlength + $first_part_length + 1;
 504     $str = mb_substr($str, 0, $first_part_length) . $place_holder . mb_substr($str, $second_starting_location, $length);
 505   }
 506
 507   return $str;
 508 }
 509
 510 /**
 511  * A method to guess the mime_type of an attachment.
 512  *
 513  * @param string $path     Path to the file.
 514  * @param string $name     File name (with suffix)
 515  * @param string $failover Mime type supplied for failover.
 516  *
 517  * @return string
 518  * @author Till Klampaeckel <till@php.net>
 519  * @see    http://de2.php.net/manual/en/ref.fileinfo.php
 520  * @see    http://de2.php.net/mime_content_type
 521  */
 522 function rc_mime_content_type($path, $name, $failover = 'application/octet-stream')
 523 {
 524     $mime_type = null;
 525     $mime_magic = rcmail::get_instance()->config->get('mime_magic');
 526     $mime_ext = @include(RCMAIL_CONFIG_DIR . '/mimetypes.php');
 527     $suffix = $name ? substr($name, strrpos($name, '.')+1) : '*';
 528
 529     // use file name suffix with hard-coded mime-type map
 530     if (is_array($mime_ext)) {
 531         $mime_type = $mime_ext[$suffix];
 532     }
 533     // try fileinfo extension if available
 534     if (!$mime_type) {
 535         if (!extension_loaded('fileinfo')) {
 536             @dl('fileinfo.' . PHP_SHLIB_SUFFIX);
 537         }
 538         if (function_exists('finfo_open')) {
 539             if ($finfo = finfo_open(FILEINFO_MIME, $mime_magic)) {
 540                 $mime_type = finfo_file($finfo, $path);
 541                 finfo_close($finfo);
 542             }
 543         }
 544     }
 545     // try PHP's mime_content_type
 546     if (!$mime_type && function_exists('mime_content_type')) {
 547       $mime_type = mime_content_type($path);
 548     }
 549     // fall back to user-submitted string
 550     if (!$mime_type) {
 551         $mime_type = $failover;
 552     }
 553
 554     return $mime_type;
 555 }
 556
 557
 558 /**
 559  * A method to guess encoding of a string.
 560  *
 561  * @param string $string        String.
 562  * @param string $failover      Default result for failover.
 563  *
 564  * @return string
 565  */
 566 function rc_detect_encoding($string, $failover='')
 567 {
 568     if (!function_exists('mb_detect_encoding')) {
 569         return $failover;
 570     }
 571
 572     // FIXME: the order is important, because sometimes
 573     // iso string is detected as euc-jp and etc.
 574     $enc = array(
 575       'UTF-8', 'SJIS', 'BIG5', 'GB2312',
 576       'ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
 577       'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', 'ISO-8859-9',
 578       'ISO-8859-10', 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'ISO-8859-16',
 579       'WINDOWS-1252', 'WINDOWS-1251', 'EUC-JP', 'EUC-TW', 'KOI8-R',
 580       'ISO-2022-KR', 'ISO-2022-JP'
 581     );
 582
 583     $result = mb_detect_encoding($string, join(',', $enc));
 584
 585     return $result ? $result : $failover;
 586 }
 587
 588
 589 /**
 590  * Explode quoted string
 591  *
 592  * @param string Delimiter expression string for preg_match()
 593  * @param string Input string
 594  */
 595 function rcube_explode_quoted_string($delimiter, $string)
 596 {
 597   $result = array();
 598   $strlen = strlen($string);
 599
 600   for ($q=$p=$i=0; $i < $strlen; $i++) {
 601     if ($string[$i] == "\"" && $string[$i-1] != "\\") {
 602       $q = $q ? false : true;
 603     }
 604     else if (!$q && preg_match("/$delimiter/", $string[$i])) {
 605       $result[] = substr($string, $p, $i - $p);
 606       $p = $i + 1;
 607     }
 608   }
 609
 610   $result[] = substr($string, $p);
 611   return $result;
 612 }
 613
 614
 615 /**
 616  * mbstring replacement functions
 617  */
 618
 619 if (!extension_loaded('mbstring'))
 620 {
 621     function mb_strlen($str)
 622     {
 623         return strlen($str);
 624     }
 625
 626     function mb_strtolower($str)
 627     {
 628         return strtolower($str);
 629     }
 630
 631     function mb_strtoupper($str)
 632     {
 633         return strtoupper($str);
 634     }
 635
 636     function mb_substr($str, $start, $len=null)
 637     {
 638         return substr($str, $start, $len);
 639     }
 640
 641     function mb_strpos($haystack, $needle, $offset=0)
 642     {
 643         return strpos($haystack, $needle, $offset);
 644     }
 645
 646     function mb_strrpos($haystack, $needle, $offset=0)
 647     {
 648         return strrpos($haystack, $needle, $offset);
 649     }
 650 }
 651
 652 ?>