| | |
| | | | program/include/rcube_vcard.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2009, Roundcube Dev. - Switzerland | |
| | | | Copyright (C) 2008-2011, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | */ |
| | | class rcube_vcard |
| | | { |
| | | private static $values_decoded = false; |
| | | private $raw = array( |
| | | 'FN' => array(), |
| | | 'N' => array(array('','','','','')), |
| | | ); |
| | | private $fieldmap = array( |
| | | 'phone' => 'TEL', |
| | | 'birthday' => 'BDAY', |
| | | 'website' => 'URL', |
| | | 'notes' => 'NOTE', |
| | | 'email' => 'EMAIL', |
| | | 'address' => 'ADR', |
| | | 'gender' => 'X-GENDER', |
| | | 'maidenname' => 'X-MAIDENNAME', |
| | | 'anniversary' => 'X-ANNIVERSARY', |
| | | 'assistant' => 'X-ASSISTANT', |
| | | 'manager' => 'X-MANAGER', |
| | | 'spouse' => 'X-SPOUSE', |
| | | ); |
| | | private $typemap = array('iPhone' => 'mobile', 'CELL' => 'mobile'); |
| | | private $phonetypemap = array('HOME1' => 'HOME', 'BUSINESS1' => 'WORK', 'BUSINESS2' => 'WORK2', 'WORKFAX' => 'BUSINESSFAX'); |
| | | 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 $business = false; |
| | | public $displayname; |
| | |
| | | /** |
| | | * Constructor |
| | | */ |
| | | public function __construct($vcard = null, $charset = RCMAIL_CHARSET) |
| | | public function __construct($vcard = null, $charset = RCMAIL_CHARSET, $detect = false) |
| | | { |
| | | if (!empty($vcard)) |
| | | $this->load($vcard, $charset); |
| | | $this->load($vcard, $charset, $detect); |
| | | } |
| | | |
| | | |
| | |
| | | * Load record from (internal, unfolded) vcard 3.0 format |
| | | * |
| | | * @param string vCard string to parse |
| | | * @param string Charset of string values |
| | | * @param boolean True if loading a 'foreign' vcard and extra heuristics for charset detection is required |
| | | */ |
| | | public function load($vcard, $charset = RCMAIL_CHARSET) |
| | | public function load($vcard, $charset = RCMAIL_CHARSET, $detect = false) |
| | | { |
| | | self::$values_decoded = false; |
| | | $this->raw = self::vcard_decode($vcard); |
| | | |
| | | |
| | | // resolve charset parameters |
| | | if ($charset == null) |
| | | $this->raw = $this->charset_convert($this->raw); |
| | | if ($charset == null) { |
| | | $this->raw = self::charset_convert($this->raw); |
| | | } |
| | | // vcard has encoded values and charset should be detected |
| | | else if ($detect && self::$values_decoded && |
| | | ($detected_charset = self::detect_encoding(self::vcard_encode($this->raw))) && $detected_charset != RCMAIL_CHARSET) { |
| | | $this->raw = self::charset_convert($this->raw, $detected_charset); |
| | | } |
| | | |
| | | // find well-known address fields |
| | | $this->displayname = $this->raw['FN'][0][0]; |
| | |
| | | |
| | | |
| | | /** |
| | | * Return vCard data as associative array to be unsed in Roundcube address books |
| | | * |
| | | * @return array Hash array with key-value pairs |
| | | */ |
| | | public function get_assoc() |
| | | { |
| | | $out = array('name' => $this->displayname); |
| | | $typemap = $this->typemap; |
| | | |
| | | // copy name fields to output array |
| | | foreach (array('firstname','surname','middlename','nickname','organization') as $col) { |
| | | if (strlen($this->$col)) |
| | | $out[$col] = $this->$col; |
| | | } |
| | | |
| | | if ($this->raw['N'][0][3]) |
| | | $out['prefix'] = $this->raw['N'][0][3]; |
| | | if ($this->raw['N'][0][4]) |
| | | $out['suffix'] = $this->raw['N'][0][4]; |
| | | |
| | | // convert from raw vcard data into associative data for Roundcube |
| | | foreach (array_flip($this->fieldmap) as $tag => $col) { |
| | | foreach ((array)$this->raw[$tag] as $i => $raw) { |
| | | if (is_array($raw)) { |
| | | $k = -1; |
| | | $key = $col; |
| | | |
| | | $subtype = $typemap[$raw['type'][++$k]] ? $typemap[$raw['type'][$k]] : 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); |
| | | break; |
| | | } |
| | | } |
| | | } |
| | | |
| | | if ($subtype) |
| | | $key .= ':' . $subtype; |
| | | |
| | | // split ADR values into assoc array |
| | | if ($tag == 'ADR') { |
| | | list(,, $value['street'], $value['locality'], $value['region'], $value['zipcode'], $value['country']) = $raw; |
| | | $out[$key][] = $value; |
| | | } |
| | | else |
| | | $out[$key][] = $raw[0]; |
| | | } |
| | | else { |
| | | $out[$col][] = $raw; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // handle special IM fields as used by Apple |
| | | foreach ($this->immap as $tag => $type) { |
| | | foreach ((array)$this->raw[$tag] as $i => $raw) { |
| | | $out['im:'.$type][] = $raw[0]; |
| | | } |
| | | } |
| | | |
| | | // copy photo data |
| | | if ($this->raw['PHOTO']) |
| | | $out['photo'] = $this->raw['PHOTO'][0][0]; |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Convert the data structure into a vcard 3.0 string |
| | | */ |
| | | public function export() |
| | | { |
| | | return self::rfc2425_fold(self::vcard_encode($this->raw)); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Clear the given fields in the loaded vcard data |
| | | * |
| | | * @param array List of field names to be reset |
| | | */ |
| | | public function reset($fields = null) |
| | | { |
| | | if (!$fields) |
| | | $fields = array_merge(array_values($this->fieldmap), array_keys($this->immap), array('FN','N','ORG','NICKNAME','EMAIL','ADR','BDAY')); |
| | | |
| | | foreach ($fields as $f) |
| | | unset($this->raw[$f]); |
| | | |
| | | if (!$this->raw['N']) |
| | | $this->raw['N'] = array(array('','','','','')); |
| | | if (!$this->raw['FN']) |
| | | $this->raw['FN'] = array(); |
| | | |
| | | $this->email = array(); |
| | | } |
| | | |
| | | |
| | |
| | | * |
| | | * @param string Field name |
| | | * @param string Field value |
| | | * @param string Section name |
| | | * @param string Type/section name |
| | | */ |
| | | public function set($field, $value, $section = 'HOME') |
| | | public function set($field, $value, $type = 'HOME') |
| | | { |
| | | $field = strtolower($field); |
| | | $type = strtoupper($type); |
| | | $typemap = array_flip($this->typemap); |
| | | |
| | | switch ($field) { |
| | | case 'name': |
| | | case 'displayname': |
| | | $this->raw['FN'][0][0] = $value; |
| | | break; |
| | | |
| | | case 'surname': |
| | | $this->raw['N'][0][0] = $value; |
| | | break; |
| | | |
| | | case 'firstname': |
| | | $this->raw['N'][0][1] = $value; |
| | | break; |
| | | |
| | | case 'surname': |
| | | $this->raw['N'][0][0] = $value; |
| | | case 'middlename': |
| | | $this->raw['N'][0][2] = $value; |
| | | break; |
| | | |
| | | |
| | | case 'prefix': |
| | | $this->raw['N'][0][3] = $value; |
| | | break; |
| | | |
| | | case 'suffix': |
| | | $this->raw['N'][0][4] = $value; |
| | | break; |
| | | |
| | | case 'nickname': |
| | | $this->raw['NICKNAME'][0][0] = $value; |
| | | break; |
| | |
| | | $this->raw['ORG'][0][0] = $value; |
| | | break; |
| | | |
| | | case 'photo': |
| | | $encoded = !preg_match('![^a-z0-9/=+-]!i', $value); |
| | | $this->raw['PHOTO'][0] = array(0 => $encoded ? $value : base64_encode($value), 'BASE64' => true); |
| | | break; |
| | | |
| | | case 'email': |
| | | $index = $this->get_type_index('EMAIL', $section); |
| | | if (!is_array($this->raw['EMAIL'][$index])) { |
| | | $this->raw['EMAIL'][$index] = array(0 => $value, 'type' => array('INTERNET', $section, 'pref')); |
| | | } |
| | | else { |
| | | $this->raw['EMAIL'][$index][0] = $value; |
| | | $this->raw['EMAIL'][] = array(0 => $value, 'type' => array_filter(array('INTERNET', $type))); |
| | | $this->email[] = $value; |
| | | break; |
| | | |
| | | case 'im': |
| | | // save IM subtypes into extension fields |
| | | $typemap = array_flip($this->immap); |
| | | if ($field = $typemap[strtolower($type)]) |
| | | $this->raw[$field][] = array(0 => $value); |
| | | break; |
| | | |
| | | case 'birthday': |
| | | if ($val = rcube_strtotime($value)) |
| | | $this->raw['BDAY'][] = array(0 => date('Y-m-d', $val), 'value' => array('date')); |
| | | break; |
| | | |
| | | case 'address': |
| | | if ($this->addresstypemap[$type]) |
| | | $type = $this->addresstypemap[$type]; |
| | | |
| | | $value = $value[0] ? $value : array('', '', $value['street'], $value['locality'], $value['region'], $value['zipcode'], $value['country']); |
| | | |
| | | // fall through if not empty |
| | | if (!strlen(join('', $value))) |
| | | break; |
| | | |
| | | default: |
| | | if ($field == 'phone' && $this->phonetypemap[$type]) |
| | | $type = $this->phonetypemap[$type]; |
| | | |
| | | if (($tag = $this->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'] = array(($typemap[$type] ? $typemap[$type] : $type)); |
| | | } |
| | | break; |
| | | } |
| | |
| | | |
| | | /** |
| | | * Convert a whole vcard (array) to UTF-8. |
| | | * Each member value that has a charset parameter will be converted. |
| | | * If $force_charset is null, each member value that has a charset parameter will be converted |
| | | */ |
| | | private function charset_convert($card) |
| | | private static function charset_convert($card, $force_charset = null) |
| | | { |
| | | foreach ($card as $key => $node) { |
| | | foreach ($node as $i => $subnode) { |
| | | if (is_array($subnode) && $subnode['charset'] && ($charset = $subnode['charset'][0])) { |
| | | 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); |
| | |
| | | |
| | | if (preg_match('/^END:VCARD$/i', $line)) { |
| | | // parse vcard |
| | | $obj = new rcube_vcard(self::cleanup($vcard_block), $charset); |
| | | $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true); |
| | | if (!empty($obj->displayname)) |
| | | $out[] = $obj; |
| | | |
| | |
| | | |
| | | // Remove cruft like item1.X-AB*, item1.ADR instead of ADR, and empty lines |
| | | $vcard = preg_replace(array('/^item\d*\.X-AB.*$/m', '/^item\d*\./m', "/\n+/"), array('', '', "\n"), $vcard); |
| | | |
| | | // convert X-WAB-GENDER to X-GENDER |
| | | if (preg_match('/X-WAB-GENDER:(\d)/', $vcard, $matches)) { |
| | | $value = $matches[1] == '2' ? 'male' : 'female'; |
| | | $vcard = preg_replace('/X-WAB-GENDER:\d/', 'X-GENDER:' . $value, $vcard); |
| | | } |
| | | |
| | | // if N doesn't have any semicolons, add some |
| | | $vcard = preg_replace('/^(N:[^;\R]*)$/m', '\1;;;;', $vcard); |
| | |
| | | { |
| | | switch (strtolower($encoding)) { |
| | | case 'quoted-printable': |
| | | self::$values_decoded = true; |
| | | return quoted_printable_decode($value); |
| | | |
| | | case 'base64': |
| | | self::$values_decoded = true; |
| | | return base64_decode($value); |
| | | |
| | | default: |