| | |
| | | | | |
| | | | This file is part of the Roundcube PHP suite | |
| | | | Copyright (C) 2005-2007, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | Licensed under the GNU General Public License version 3 or | |
| | | | any later version with exceptions for skins & plugins. | |
| | | | See the README file for a full license statement. | |
| | | | | |
| | | | CONTENTS: | |
| | | | Shared functions and classes used in PHP projects | |
| | |
| | | |
| | | /** |
| | | * Roundcube shared functions |
| | | * |
| | | * |
| | | * @package Core |
| | | */ |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * Check request for If-Modified-Since and send an according response. |
| | | * This will terminate the current script if headers match the given values |
| | | * |
| | | * @param int Modified date as unix timestamp |
| | | * @param string Etag value for caching |
| | | */ |
| | | function send_modified_header($mdate, $etag=null, $skip_check=false) |
| | | { |
| | | if (headers_sent()) |
| | | return; |
| | | |
| | | $iscached = false; |
| | | $etag = $etag ? "\"$etag\"" : null; |
| | | |
| | | if (!$skip_check) |
| | | { |
| | | if ($_SERVER['HTTP_IF_MODIFIED_SINCE'] && strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) >= $mdate) |
| | | $iscached = true; |
| | | |
| | | if ($etag) |
| | | $iscached = ($_SERVER['HTTP_IF_NONE_MATCH'] == $etag); |
| | | } |
| | | |
| | | if ($iscached) |
| | | header("HTTP/1.x 304 Not Modified"); |
| | | else |
| | | header("Last-Modified: ".gmdate("D, d M Y H:i:s", $mdate)." GMT"); |
| | | |
| | | header("Cache-Control: private, must-revalidate, max-age=0"); |
| | | header("Expires: "); |
| | | header("Pragma: "); |
| | | |
| | | if ($etag) |
| | | header("Etag: $etag"); |
| | | |
| | | if ($iscached) |
| | | { |
| | | ob_end_clean(); |
| | | exit; |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Similar function as in_array() but case-insensitive |
| | | * |
| | | * @param mixed Needle value |
| | |
| | | foreach ($haystack as $value) |
| | | if ($needle===mb_strtolower($value)) |
| | | return true; |
| | | |
| | | |
| | | return false; |
| | | } |
| | | |
| | |
| | | function get_boolean($str) |
| | | { |
| | | $str = strtolower($str); |
| | | if (in_array($str, array('false', '0', 'no', 'nein', ''), TRUE)) |
| | | if (in_array($str, array('false', '0', 'no', 'off', 'nein', ''), TRUE)) |
| | | return FALSE; |
| | | else |
| | | return TRUE; |
| | |
| | | |
| | | return floatval($bytes); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Create a human readable string for a number of bytes |
| | | * |
| | |
| | | */ |
| | | function show_bytes($bytes) |
| | | { |
| | | if ($bytes > 1073741824) |
| | | if ($bytes >= 1073741824) |
| | | { |
| | | $gb = $bytes/1073741824; |
| | | $str = sprintf($gb>=10 ? "%d " : "%.1f ", $gb) . rcube_label('GB'); |
| | | } |
| | | else if ($bytes > 1048576) |
| | | else if ($bytes >= 1048576) |
| | | { |
| | | $mb = $bytes/1048576; |
| | | $str = sprintf($mb>=10 ? "%d " : "%.1f ", $mb) . rcube_label('MB'); |
| | | } |
| | | else if ($bytes > 1024) |
| | | else if ($bytes >= 1024) |
| | | $str = sprintf("%d ", round($bytes/1024)) . rcube_label('KB'); |
| | | else |
| | | $str = sprintf('%d ', $bytes) . rcube_label('B'); |
| | | |
| | | return $str; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Convert paths like ../xxx to an absolute path using a base url |
| | | * |
| | | * @param string Relative path |
| | | * @param string Base URL |
| | | * @return string Absolute URL |
| | | */ |
| | | function make_absolute_url($path, $base_url) |
| | | { |
| | | $host_url = $base_url; |
| | | $abs_path = $path; |
| | | |
| | | // check if path is an absolute URL |
| | | if (preg_match('/^[fhtps]+:\/\//', $path)) |
| | | return $path; |
| | | |
| | | // cut base_url to the last directory |
| | | if (strrpos($base_url, '/')>7) |
| | | { |
| | | $host_url = substr($base_url, 0, strpos($base_url, '/', 7)); |
| | | $base_url = substr($base_url, 0, strrpos($base_url, '/')); |
| | | } |
| | | |
| | | // $path is absolute |
| | | if ($path{0}=='/') |
| | | $abs_path = $host_url.$path; |
| | | else |
| | | { |
| | | // strip './' because its the same as '' |
| | | $path = preg_replace('/^\.\//', '', $path); |
| | | |
| | | if (preg_match_all('/\.\.\//', $path, $matches, PREG_SET_ORDER)) |
| | | foreach ($matches as $a_match) |
| | | { |
| | | if (strrpos($base_url, '/')) |
| | | $base_url = substr($base_url, 0, strrpos($base_url, '/')); |
| | | |
| | | $path = substr($path, 3); |
| | | } |
| | | |
| | | $abs_path = $base_url.'/'.$path; |
| | | } |
| | | |
| | | return $abs_path; |
| | | } |
| | | |
| | | /** |
| | |
| | | } |
| | | |
| | | return $hdrs[$key]; |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | |
| | | { |
| | | return preg_replace('/\/$/', '', $str); |
| | | } |
| | | |
| | | |
| | | |
| | | /** |
| | | * Delete all files within a folder |
| | |
| | | * @return int Unix timestamp |
| | | */ |
| | | function get_offset_time($offset_str, $factor=1) |
| | | { |
| | | { |
| | | if (preg_match('/^([0-9]+)\s*([smhdw])/i', $offset_str, $regs)) |
| | | { |
| | | $amount = (int)$regs[1]; |
| | |
| | | $amount = (int)$offset_str; |
| | | $unit = 's'; |
| | | } |
| | | |
| | | |
| | | $ts = mktime(); |
| | | switch ($unit) |
| | | { |
| | |
| | | function abbreviate_string($str, $maxlength, $place_holder='...', $ending=false) |
| | | { |
| | | $length = mb_strlen($str); |
| | | |
| | | |
| | | if ($length > $maxlength) |
| | | { |
| | | if ($ending) |
| | |
| | | |
| | | return $str; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * A method to guess the mime_type of an attachment. |
| | |
| | | $mime_type = null; |
| | | $mime_magic = rcmail::get_instance()->config->get('mime_magic'); |
| | | $mime_ext = @include(RCMAIL_CONFIG_DIR . '/mimetypes.php'); |
| | | $suffix = $name ? substr($name, strrpos($name, '.')+1) : '*'; |
| | | |
| | | // use file name suffix with hard-coded mime-type map |
| | | if (is_array($mime_ext)) { |
| | | $mime_type = $mime_ext[$suffix]; |
| | | if (is_array($mime_ext) && $name) { |
| | | if ($suffix = substr($name, strrpos($name, '.')+1)) { |
| | | $mime_type = $mime_ext[strtolower($suffix)]; |
| | | } |
| | | } |
| | | |
| | | // try fileinfo extension if available |
| | | if (!$mime_type && function_exists('finfo_open')) { |
| | | if ($finfo = finfo_open(FILEINFO_MIME, $mime_magic)) { |
| | |
| | | finfo_close($finfo); |
| | | } |
| | | } |
| | | |
| | | // try PHP's mime_content_type |
| | | if (!$mime_type && !$is_stream && function_exists('mime_content_type')) { |
| | | $mime_type = @mime_content_type($path); |
| | | } |
| | | |
| | | // fall back to user-submitted string |
| | | if (!$mime_type) { |
| | | $mime_type = $failover; |
| | |
| | | |
| | | |
| | | /** |
| | | * A method to guess encoding of a string. |
| | | * |
| | | * @param string $string String. |
| | | * @param string $failover Default result for failover. |
| | | * |
| | | * @return string |
| | | */ |
| | | function rc_detect_encoding($string, $failover='') |
| | | { |
| | | if (!function_exists('mb_detect_encoding')) { |
| | | return $failover; |
| | | } |
| | | |
| | | // FIXME: the order is important, because sometimes |
| | | // iso string is detected as euc-jp and etc. |
| | | $enc = array( |
| | | 'UTF-8', 'SJIS', 'BIG5', 'GB2312', |
| | | 'ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4', |
| | | 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', 'ISO-8859-9', |
| | | 'ISO-8859-10', 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'ISO-8859-16', |
| | | 'WINDOWS-1252', 'WINDOWS-1251', 'EUC-JP', 'EUC-TW', 'KOI8-R', |
| | | 'ISO-2022-KR', 'ISO-2022-JP' |
| | | ); |
| | | |
| | | $result = mb_detect_encoding($string, join(',', $enc)); |
| | | |
| | | return $result ? $result : $failover; |
| | | } |
| | | |
| | | /** |
| | | * Removes non-unicode characters from input |
| | | * |
| | | * @param mixed $input String or array. |
| | | * @return string |
| | | */ |
| | | function rc_utf8_clean($input) |
| | | { |
| | | // handle input of type array |
| | | if (is_array($input)) { |
| | | foreach ($input as $idx => $val) |
| | | $input[$idx] = rc_utf8_clean($val); |
| | | return $input; |
| | | } |
| | | |
| | | if (!is_string($input) || $input == '') |
| | | return $input; |
| | | |
| | | // iconv/mbstring are much faster (especially with long strings) |
| | | if (function_exists('mb_convert_encoding') && ($res = mb_convert_encoding($input, 'UTF-8', 'UTF-8')) !== false) |
| | | return $res; |
| | | |
| | | if (function_exists('iconv') && ($res = @iconv('UTF-8', 'UTF-8//IGNORE', $input)) !== false) |
| | | return $res; |
| | | |
| | | $regexp = '/^('. |
| | | // '[\x00-\x7F]'. // UTF8-1 |
| | | '|[\xC2-\xDF][\x80-\xBF]'. // UTF8-2 |
| | | '|\xE0[\xA0-\xBF][\x80-\xBF]'. // UTF8-3 |
| | | '|[\xE1-\xEC][\x80-\xBF][\x80-\xBF]'. // UTF8-3 |
| | | '|\xED[\x80-\x9F][\x80-\xBF]'. // UTF8-3 |
| | | '|[\xEE-\xEF][\x80-\xBF][\x80-\xBF]'. // UTF8-3 |
| | | '|\xF0[\x90-\xBF][\x80-\xBF][\x80-\xBF]'. // UTF8-4 |
| | | '|[\xF1-\xF3][\x80-\xBF][\x80-\xBF][\x80-\xBF]'.// UTF8-4 |
| | | '|\xF4[\x80-\x8F][\x80-\xBF][\x80-\xBF]'. // UTF8-4 |
| | | ')$/'; |
| | | |
| | | $seq = ''; |
| | | $out = ''; |
| | | |
| | | for ($i = 0, $len = strlen($input); $i < $len; $i++) { |
| | | $chr = $input[$i]; |
| | | $ord = ord($chr); |
| | | // 1-byte character |
| | | if ($ord <= 0x7F) { |
| | | if ($seq) |
| | | $out .= preg_match($regexp, $seq) ? $seq : ''; |
| | | $seq = ''; |
| | | $out .= $chr; |
| | | // first (or second) byte of multibyte sequence |
| | | } else if ($ord >= 0xC0) { |
| | | if (strlen($seq)>1) { |
| | | $out .= preg_match($regexp, $seq) ? $seq : ''; |
| | | $seq = ''; |
| | | } else if ($seq && ord($seq) < 0xC0) { |
| | | $seq = ''; |
| | | } |
| | | $seq .= $chr; |
| | | // next byte of multibyte sequence |
| | | } else if ($seq) { |
| | | $seq .= $chr; |
| | | } |
| | | } |
| | | |
| | | if ($seq) |
| | | $out .= preg_match($regexp, $seq) ? $seq : ''; |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Convert a variable into a javascript object notation |
| | | * |
| | | * @param mixed Input value |
| | | * @return string Serialized JSON string |
| | | */ |
| | | function json_serialize($input) |
| | | { |
| | | $input = rc_utf8_clean($input); |
| | | |
| | | // sometimes even using rc_utf8_clean() the input contains invalid UTF-8 sequences |
| | | // that's why we have @ here |
| | | return @json_encode($input); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Explode quoted string |
| | | * |
| | | * @param string Delimiter expression string for preg_match() |
| | |
| | | $p = $i + 1; |
| | | } |
| | | } |
| | | |
| | | |
| | | $result[] = substr($string, $p); |
| | | return $result; |
| | | } |
| | |
| | | function array_keys_recursive($array) |
| | | { |
| | | $keys = array(); |
| | | |
| | | |
| | | if (!empty($array)) |
| | | foreach ($array as $key => $child) { |
| | | $keys[] = $key; |
| | |
| | | $loaded = true; |
| | | } |
| | | |
| | | if ($idn && $domain && preg_match('/(^|@|\.)xn--/i', $domain)) { |
| | | if ($idn && $domain && preg_match('/(^|\.)xn--/i', $domain)) { |
| | | try { |
| | | $domain = $idn->decode($domain); |
| | | } |