| | |
| | | | program/include/rcube_vcard.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2011, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | Copyright (C) 2008-2012, The Roundcube Dev Team | |
| | | | | |
| | | | 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. | |
| | | | | |
| | | | PURPOSE: | |
| | | | Logical representation of a vcard address record | |
| | | +-----------------------------------------------------------------------+ |
| | | | Author: Thomas Bruederli <roundcube@gmail.com> | |
| | | | Author: Aleksander Machniak <alec@alec.pl> | |
| | | +-----------------------------------------------------------------------+ |
| | | |
| | | $Id$ |
| | | |
| | | */ |
| | | |
| | | |
| | |
| | | * Logical representation of a vcard-based address record |
| | | * Provides functions to parse and export vCard data format |
| | | * |
| | | * @package Addressbook |
| | | * @author Thomas Bruederli <roundcube@gmail.com> |
| | | * @package Framework |
| | | * @subpackage Addressbook |
| | | */ |
| | | class rcube_vcard |
| | | { |
| | |
| | | 'spouse' => 'X-SPOUSE', |
| | | 'edit' => 'X-AB-EDIT', |
| | | ); |
| | | private $typemap = array('iPhone' => 'mobile', 'CELL' => 'mobile', 'WORK,FAX' => 'workfax'); |
| | | private $typemap = array('IPHONE' => 'mobile', 'CELL' => 'mobile', 'WORK,FAX' => 'workfax'); |
| | | private $phonetypemap = array('HOME1' => 'HOME', 'BUSINESS1' => 'WORK', 'BUSINESS2' => 'WORK2', 'BUSINESSFAX' => 'WORK,FAX'); |
| | | private $addresstypemap = array('BUSINESS' => 'WORK'); |
| | | private $immap = array('X-JABBER' => 'jabber', 'X-ICQ' => 'icq', 'X-MSN' => 'msn', 'X-AIM' => 'aim', 'X-YAHOO' => 'yahoo', 'X-SKYPE' => 'skype', 'X-SKYPE-USERNAME' => 'skype'); |
| | |
| | | public $middlename; |
| | | public $nickname; |
| | | public $organization; |
| | | public $notes; |
| | | public $email = array(); |
| | | |
| | | public static $eol = "\r\n"; |
| | |
| | | |
| | | if (!empty($raw['type'])) { |
| | | $combined = join(',', self::array_filter((array)$raw['type'], 'internet,pref', true)); |
| | | $subtype = $typemap[$combined] ? $typemap[$combined] : ($typemap[$raw['type'][++$k]] ? $typemap[$raw['type'][$k]] : strtolower($raw['type'][$k])); |
| | | $combined = strtoupper($combined); |
| | | |
| | | if ($typemap[$combined]) { |
| | | $subtype = $typemap[$combined]; |
| | | } |
| | | else if ($typemap[$raw['type'][++$k]]) { |
| | | $subtype = $typemap[$raw['type'][$k]]; |
| | | } |
| | | else { |
| | | $subtype = strtolower($raw['type'][$k]); |
| | | } |
| | | |
| | | while ($k < count($raw['type']) && ($subtype == 'internet' || $subtype == 'pref')) |
| | | $subtype = $typemap[$raw['type'][++$k]] ? $typemap[$raw['type'][$k]] : strtolower($raw['type'][$k]); |
| | | } |
| | |
| | | // read vcard 2.1 subtype |
| | | if (!$subtype) { |
| | | foreach ($raw as $k => $v) { |
| | | if (!is_numeric($k) && $v === true && !in_array(strtolower($k), array('pref','internet','voice','base64'))) { |
| | | $subtype = $typemap[$k] ? $typemap[$k] : strtolower($k); |
| | | if (!is_numeric($k) && $v === true && ($k = strtolower($k)) |
| | | && !in_array($k, array('pref','internet','voice','base64')) |
| | | ) { |
| | | $k_uc = strtoupper($k); |
| | | $subtype = $typemap[$k_uc] ? $typemap[$k_uc] : $k; |
| | | break; |
| | | } |
| | | } |
| | |
| | | */ |
| | | public function set($field, $value, $type = 'HOME') |
| | | { |
| | | $field = strtolower($field); |
| | | $field = strtolower($field); |
| | | $type_uc = strtoupper($type); |
| | | $typemap = array_flip($this->typemap); |
| | | |
| | | switch ($field) { |
| | | case 'name': |
| | | case 'displayname': |
| | | $this->raw['FN'][0][0] = $value; |
| | | $this->raw['FN'][0][0] = $this->displayname = $value; |
| | | break; |
| | | |
| | | case 'surname': |
| | | $this->raw['N'][0][0] = $value; |
| | | $this->raw['N'][0][0] = $this->surname = $value; |
| | | break; |
| | | |
| | | case 'firstname': |
| | | $this->raw['N'][0][1] = $value; |
| | | $this->raw['N'][0][1] = $this->firstname = $value; |
| | | break; |
| | | |
| | | case 'middlename': |
| | | $this->raw['N'][0][2] = $value; |
| | | $this->raw['N'][0][2] = $this->middlename = $value; |
| | | break; |
| | | |
| | | case 'prefix': |
| | |
| | | break; |
| | | |
| | | case 'nickname': |
| | | $this->raw['NICKNAME'][0][0] = $value; |
| | | $this->raw['NICKNAME'][0][0] = $this->nickname = $value; |
| | | break; |
| | | |
| | | case 'organization': |
| | | $this->raw['ORG'][0][0] = $value; |
| | | $this->raw['ORG'][0][0] = $this->organization = $value; |
| | | break; |
| | | |
| | | case 'photo': |
| | | if (strpos($value, 'http:') === 0) { |
| | | // TODO: fetch file from URL and save it locally? |
| | | $this->raw['PHOTO'][0] = array(0 => $value, 'URL' => true); |
| | | $this->raw['PHOTO'][0] = array(0 => $value, 'url' => true); |
| | | } |
| | | else { |
| | | $encoded = !preg_match('![^a-z0-9/=+-]!i', $value); |
| | | $this->raw['PHOTO'][0] = array(0 => $encoded ? $value : base64_encode($value), 'BASE64' => true); |
| | | $this->raw['PHOTO'][0] = array(0 => $value, 'base64' => (bool) preg_match('![^a-z0-9/=+-]!i', $value)); |
| | | } |
| | | break; |
| | | |
| | |
| | | break; |
| | | |
| | | case 'birthday': |
| | | if ($val = rcube_strtotime($value)) |
| | | $this->raw['BDAY'][] = array(0 => date('Y-m-d', $val), 'value' => array('date')); |
| | | case 'anniversary': |
| | | if (($val = rcube_utils::strtotime($value)) && ($fn = self::$fieldmap[$field])) |
| | | $this->raw[$fn][] = array(0 => date('Y-m-d', $val), 'value' => array('date')); |
| | | break; |
| | | |
| | | case 'address': |
| | |
| | | if (($tag = self::$fieldmap[$field]) && (is_array($value) || strlen($value))) { |
| | | $index = count($this->raw[$tag]); |
| | | $this->raw[$tag][$index] = (array)$value; |
| | | if ($type) |
| | | $this->raw[$tag][$index]['type'] = explode(',', ($typemap[$type] ? $typemap[$type] : $type)); |
| | | if ($type) { |
| | | $typemap = array_flip($this->typemap); |
| | | $this->raw[$tag][$index]['type'] = explode(',', ($typemap[$type_uc] ? $typemap[$type_uc] : $type)); |
| | | } |
| | | } |
| | | break; |
| | | } |
| | |
| | | if (is_array($subnode) && (($charset = $force_charset) || ($subnode['charset'] && ($charset = $subnode['charset'][0])))) { |
| | | foreach ($subnode as $j => $value) { |
| | | if (is_numeric($j) && is_string($value)) |
| | | $card[$key][$i][$j] = rcube_charset_convert($value, $charset); |
| | | $card[$key][$i][$j] = rcube_charset::convert($value, $charset); |
| | | } |
| | | unset($card[$key][$i]['charset']); |
| | | } |
| | |
| | | $charset = null; |
| | | // detect charset and convert to utf-8 |
| | | else if (($charset = self::detect_encoding($data)) && $charset != RCMAIL_CHARSET) { |
| | | $data = rcube_charset_convert($data, $charset); |
| | | $data = rcube_charset::convert($data, $charset); |
| | | $data = preg_replace(array('/^[\xFE\xFF]{2}/', '/^\xEF\xBB\xBF/', '/^\x00+/'), '', $data); // also remove BOM |
| | | $charset = RCMAIL_CHARSET; |
| | | } |
| | |
| | | if (preg_match_all('/([^\\;]+);?/', $line[1], $regs2)) { |
| | | $entry = array(); |
| | | $field = strtoupper($regs2[1][0]); |
| | | $enc = null; |
| | | |
| | | foreach($regs2[1] as $attrid => $attr) { |
| | | if ((list($key, $value) = explode('=', $attr)) && $value) { |
| | | $value = trim($value); |
| | | if ($key == 'ENCODING') { |
| | | $value = strtoupper($value); |
| | | // add next line(s) to value string if QP line end detected |
| | | while ($value == 'QUOTED-PRINTABLE' && preg_match('/=$/', $lines[$i])) |
| | | if ($value == 'QUOTED-PRINTABLE') { |
| | | while (preg_match('/=$/', $lines[$i])) |
| | | $line[2] .= "\n" . $lines[++$i]; |
| | | |
| | | $line[2] = self::decode_value($line[2], $value); |
| | | } |
| | | $enc = $value; |
| | | } |
| | | else |
| | | $entry[strtolower($key)] = array_merge((array)$entry[strtolower($key)], (array)self::vcard_unquote($value, ',')); |
| | | else { |
| | | $lc_key = strtolower($key); |
| | | $entry[$lc_key] = array_merge((array)$entry[$lc_key], (array)self::vcard_unquote($value, ',')); |
| | | } |
| | | } |
| | | else if ($attrid > 0) { |
| | | $entry[$key] = true; // true means attr without =value |
| | | $entry[strtolower($key)] = true; // true means attr without =value |
| | | } |
| | | } |
| | | |
| | | $entry = array_merge($entry, (array)self::vcard_unquote($line[2])); |
| | | // decode value |
| | | if ($enc || !empty($entry['base64'])) { |
| | | // save encoding type (#1488432) |
| | | if ($enc == 'B') { |
| | | $entry['encoding'] = 'B'; |
| | | // should we use vCard 3.0 instead? |
| | | // $entry['base64'] = true; |
| | | } |
| | | $line[2] = self::decode_value($line[2], $enc ? $enc : 'base64'); |
| | | } |
| | | |
| | | if ($enc != 'B' && empty($entry['base64'])) { |
| | | $line[2] = self::vcard_unquote($line[2]); |
| | | } |
| | | |
| | | $entry = array_merge($entry, (array) $line[2]); |
| | | $data[$field][] = $entry; |
| | | } |
| | | } |
| | |
| | | return quoted_printable_decode($value); |
| | | |
| | | case 'base64': |
| | | case 'b': |
| | | self::$values_decoded = true; |
| | | return base64_decode($value); |
| | | |
| | |
| | | if (is_array($entry)) { |
| | | $value = array(); |
| | | foreach($entry as $attrname => $attrvalues) { |
| | | if (is_int($attrname)) |
| | | if (is_int($attrname)) { |
| | | if (!empty($entry['base64']) || $entry['encoding'] == 'B') { |
| | | $attrvalues = base64_encode($attrvalues); |
| | | } |
| | | $value[] = $attrvalues; |
| | | elseif ($attrvalues === true) |
| | | $attr .= ";$attrname"; // true means just tag, not tag=value, as in PHOTO;BASE64:... |
| | | } |
| | | else if (is_bool($attrvalues)) { |
| | | if ($attrvalues) { |
| | | $attr .= strtoupper(";$attrname"); // true means just tag, not tag=value, as in PHOTO;BASE64:... |
| | | } |
| | | } |
| | | else { |
| | | foreach((array)$attrvalues as $attrvalue) |
| | | $attr .= ";$attrname=" . self::vcard_quote($attrvalue, ','); |
| | | $attr .= strtoupper(";$attrname=") . self::vcard_quote($attrvalue, ','); |
| | | } |
| | | } |
| | | } |
| | |
| | | * |
| | | * @param string vCard string to split |
| | | * @param string Separator char/string |
| | | * @return array List with splitted values |
| | | * @return array List with splited values |
| | | */ |
| | | private static function vcard_unquote($s, $sep = ';') |
| | | { |
| | |
| | | */ |
| | | private static function detect_encoding($string) |
| | | { |
| | | if (substr($string, 0, 4) == "\0\0\xFE\xFF") return 'UTF-32BE'; // Big Endian |
| | | if (substr($string, 0, 4) == "\xFF\xFE\0\0") return 'UTF-32LE'; // Little Endian |
| | | if (substr($string, 0, 2) == "\xFE\xFF") return 'UTF-16BE'; // Big Endian |
| | | if (substr($string, 0, 2) == "\xFF\xFE") return 'UTF-16LE'; // Little Endian |
| | | if (substr($string, 0, 3) == "\xEF\xBB\xBF") return 'UTF-8'; |
| | | $fallback = rcube::get_instance()->config->get('default_charset', 'ISO-8859-1'); // fallback to Latin-1 |
| | | |
| | | // heuristics |
| | | if ($string[0] == "\0" && $string[1] == "\0" && $string[2] == "\0" && $string[3] != "\0") return 'UTF-32BE'; |
| | | if ($string[0] != "\0" && $string[1] == "\0" && $string[2] == "\0" && $string[3] == "\0") return 'UTF-32LE'; |
| | | if ($string[0] == "\0" && $string[1] != "\0" && $string[2] == "\0" && $string[3] != "\0") return 'UTF-16BE'; |
| | | if ($string[0] != "\0" && $string[1] == "\0" && $string[2] != "\0" && $string[3] == "\0") return 'UTF-16LE'; |
| | | |
| | | // use mb_detect_encoding() |
| | | $encodings = array('UTF-8', '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', 'BIG5', 'GB2312'); |
| | | |
| | | if (function_exists('mb_detect_encoding') && ($enc = mb_detect_encoding($string, $encodings))) |
| | | return $enc; |
| | | |
| | | // No match, check for UTF-8 |
| | | // from http://w3.org/International/questions/qa-forms-utf-8.html |
| | | if (preg_match('/\A( |
| | | [\x09\x0A\x0D\x20-\x7E] |
| | | | [\xC2-\xDF][\x80-\xBF] |
| | | | \xE0[\xA0-\xBF][\x80-\xBF] |
| | | | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} |
| | | | \xED[\x80-\x9F][\x80-\xBF] |
| | | | \xF0[\x90-\xBF][\x80-\xBF]{2} |
| | | | [\xF1-\xF3][\x80-\xBF]{3} |
| | | | \xF4[\x80-\x8F][\x80-\xBF]{2} |
| | | )*\z/xs', substr($string, 0, 2048))) |
| | | return 'UTF-8'; |
| | | |
| | | return rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1'); # fallback to Latin-1 |
| | | return rcube_charset::detect($string, $fallback); |
| | | } |
| | | |
| | | } |