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