From 66510e20d36cb8da4f3012ef063de7bfce9b51aa Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 09 May 2012 07:52:28 -0400
Subject: [PATCH] Merge pull request #1 from Brianetta/de-svn
---
program/include/rcube_vcard.php | 330 ++++++++++++++++++++++++++++++++++++------------------
1 files changed, 219 insertions(+), 111 deletions(-)
diff --git a/program/include/rcube_vcard.php b/program/include/rcube_vcard.php
index fe9777d..e453af7 100644
--- a/program/include/rcube_vcard.php
+++ b/program/include/rcube_vcard.php
@@ -6,7 +6,10 @@
| |
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2008-2011, 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. |
| |
| PURPOSE: |
| Logical representation of a vcard address record |
@@ -33,7 +36,7 @@
'FN' => array(),
'N' => array(array('','','','','')),
);
- private $fieldmap = array(
+ private static $fieldmap = array(
'phone' => 'TEL',
'birthday' => 'BDAY',
'website' => 'URL',
@@ -41,15 +44,17 @@
'email' => 'EMAIL',
'address' => 'ADR',
'jobtitle' => 'TITLE',
+ 'department' => 'X-DEPARTMENT',
'gender' => 'X-GENDER',
'maidenname' => 'X-MAIDENNAME',
'anniversary' => 'X-ANNIVERSARY',
'assistant' => 'X-ASSISTANT',
'manager' => 'X-MANAGER',
'spouse' => 'X-SPOUSE',
+ 'edit' => 'X-AB-EDIT',
);
- private $typemap = array('iPhone' => 'mobile', 'CELL' => 'mobile');
- private $phonetypemap = array('HOME1' => 'HOME', 'BUSINESS1' => 'WORK', 'BUSINESS2' => 'WORK2', 'WORKFAX' => 'BUSINESSFAX');
+ 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');
@@ -63,12 +68,16 @@
public $notes;
public $email = array();
+ public static $eol = "\r\n";
/**
* Constructor
*/
- public function __construct($vcard = null, $charset = RCMAIL_CHARSET, $detect = false)
+ public function __construct($vcard = null, $charset = RCMAIL_CHARSET, $detect = false, $fieldmap = array())
{
+ if (!empty($fielmap))
+ $this->extend_fieldmap($fieldmap);
+
if (!empty($vcard))
$this->load($vcard, $charset, $detect);
}
@@ -95,6 +104,10 @@
($detected_charset = self::detect_encoding(self::vcard_encode($this->raw))) && $detected_charset != RCMAIL_CHARSET) {
$this->raw = self::charset_convert($this->raw, $detected_charset);
}
+
+ // consider FN empty if the same as the primary e-mail address
+ if ($this->raw['FN'][0][0] == $this->raw['EMAIL'][0][0])
+ $this->raw['FN'][0][0] = '';
// find well-known address fields
$this->displayname = $this->raw['FN'][0][0];
@@ -104,23 +117,16 @@
$this->nickname = $this->raw['NICKNAME'][0][0];
$this->organization = $this->raw['ORG'][0][0];
$this->business = ($this->raw['X-ABSHOWAS'][0][0] == 'COMPANY') || (join('', (array)$this->raw['N'][0]) == '' && !empty($this->organization));
-
+
foreach ((array)$this->raw['EMAIL'] as $i => $raw_email)
$this->email[$i] = is_array($raw_email) ? $raw_email[0] : $raw_email;
-
+
// make the pref e-mail address the first entry in $this->email
$pref_index = $this->get_type_index('EMAIL', 'pref');
if ($pref_index > 0) {
$tmp = $this->email[0];
$this->email[0] = $this->email[$pref_index];
$this->email[$pref_index] = $tmp;
- }
-
- // make sure displayname is not empty (required by RFC2426)
- if (!strlen($this->displayname)) {
- // the same method is used in steps/mail/addcontact.inc
- $this->displayname = ucfirst(preg_replace('/[\.\-]/', ' ',
- substr($this->email[0], 0, strpos($this->email[0], '@'))));
}
}
@@ -134,29 +140,33 @@
{
$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_flip(self::$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]);
-
+ $subtype = '';
+
+ 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]));
+ 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) {
@@ -168,9 +178,9 @@
}
// force subtype if none set
- if (preg_match('/^(email|phone|address|website)/', $key) && !$subtype)
+ if (!$subtype && preg_match('/^(email|phone|address|website)/', $key))
$subtype = 'other';
-
+
if ($subtype)
$key .= ':' . $subtype;
@@ -187,18 +197,18 @@
}
}
}
-
+
// 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;
}
@@ -211,8 +221,8 @@
$vcard = self::vcard_encode($this->raw);
return $folded ? self::rfc2425_fold($vcard) : $vcard;
}
-
-
+
+
/**
* Clear the given fields in the loaded vcard data
*
@@ -221,8 +231,8 @@
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'));
-
+ $fields = array_merge(array_values(self::$fieldmap), array_keys($this->immap), array('FN','N','ORG','NICKNAME','EMAIL','ADR','BDAY'));
+
foreach ($fields as $f)
unset($this->raw[$f]);
@@ -230,7 +240,7 @@
$this->raw['N'] = array(array('','','','',''));
if (!$this->raw['FN'])
$this->raw['FN'] = array();
-
+
$this->email = array();
}
@@ -245,59 +255,58 @@
public function set($field, $value, $type = 'HOME')
{
$field = strtolower($field);
- $type = strtoupper($type);
+ $type_uc = 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 '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;
-
+
case 'organization':
$this->raw['ORG'][0][0] = $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;
-
+
case 'email':
- $this->raw['EMAIL'][] = array(0 => $value, 'type' => array_filter(array('INTERNET', $type)));
+ $this->raw['EMAIL'][] = array(0 => $value, 'type' => array_filter(array('INTERNET', $type_uc)));
$this->email[] = $value;
break;
-
+
case 'im':
// save IM subtypes into extension fields
$typemap = array_flip($this->immap);
@@ -311,8 +320,8 @@
break;
case 'address':
- if ($this->addresstypemap[$type])
- $type = $this->addresstypemap[$type];
+ if ($this->addresstypemap[$type_uc])
+ $type = $this->addresstypemap[$type_uc];
$value = $value[0] ? $value : array('', '', $value['street'], $value['locality'], $value['region'], $value['zipcode'], $value['country']);
@@ -321,17 +330,30 @@
break;
default:
- if ($field == 'phone' && $this->phonetypemap[$type])
- $type = $this->phonetypemap[$type];
+ if ($field == 'phone' && $this->phonetypemap[$type_uc])
+ $type = $this->phonetypemap[$type_uc];
- if (($tag = $this->fieldmap[$field]) && (is_array($value) || strlen($value))) {
+ 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'] = array(($typemap[$type] ? $typemap[$type] : $type));
+ $this->raw[$tag][$index]['type'] = explode(',', ($typemap[$type] ? $typemap[$type] : $type));
}
break;
}
+ }
+
+ /**
+ * Setter for individual vcard properties
+ *
+ * @param string VCard tag name
+ * @param array Value-set of this vcard property
+ * @param boolean Set to true if the value-set should be appended instead of replacing any existing value-set
+ */
+ public function set_raw($tag, $value, $append = false)
+ {
+ $index = $append ? count($this->raw[$tag]) : 0;
+ $this->raw[$tag][$index] = (array)$value;
}
@@ -350,11 +372,11 @@
$result = $i;
}
}
-
+
return $result;
}
-
-
+
+
/**
* Convert a whole vcard (array) to UTF-8.
* If $force_charset is null, each member value that has a charset parameter will be converted
@@ -366,7 +388,7 @@
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']);
}
@@ -374,6 +396,16 @@
}
return $card;
+ }
+
+
+ /**
+ * Extends fieldmap definition
+ */
+ public function extend_fieldmap($map)
+ {
+ if (is_array($map))
+ self::$fieldmap = array_merge($map, self::$fieldmap);
}
@@ -392,7 +424,7 @@
$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;
}
@@ -408,8 +440,8 @@
if (preg_match('/^END:VCARD$/i', $line)) {
// parse vcard
- $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true);
- if (!empty($obj->displayname))
+ $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true, self::$fieldmap);
+ if (!empty($obj->displayname) || !empty($obj->email))
$out[] = $obj;
$in_vcard_block = false;
@@ -446,7 +478,7 @@
// 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';
@@ -458,7 +490,7 @@
return $vcard;
}
-
+
private static function x_abrelatednames_callback($matches)
{
return 'X-' . strtoupper($matches[5]) . $matches[3] . ':'. $matches[4];
@@ -497,15 +529,17 @@
*/
private static function vcard_decode($vcard)
{
- // Perform RFC2425 line unfolding
+ // Perform RFC2425 line unfolding and split lines
$vcard = preg_replace(array("/\r/", "/\n\s+/"), '', $vcard);
-
- $lines = preg_split('/\r?\n/', $vcard);
- $data = array();
-
+ $lines = explode("\n", $vcard);
+ $data = array();
+
for ($i=0; $i < count($lines); $i++) {
- if (!preg_match('/^([^\\:]*):(.+)$/', $lines[$i], $line))
- continue;
+ if (!preg_match('/^([^:]+):(.+)$/', $lines[$i], $line))
+ continue;
+
+ if (preg_match('/^(BEGIN|END)$/i', $line[1]))
+ continue;
// convert 2.1-style "EMAIL;internet;home:" to 3.0-style "EMAIL;TYPE=internet;TYPE=home:"
if (($data['VERSION'][0] == "2.1") && preg_match('/^([^;]+);([^:]+)/', $line[1], $regs2) && !preg_match('/^TYPE=/i', $regs2[2])) {
@@ -514,57 +548,54 @@
$line[1] .= ';' . (strpos($prop, '=') ? $prop : 'TYPE='.$prop);
}
- if (!preg_match('/^(BEGIN|END)$/i', $line[1]) && preg_match_all('/([^\\;]+);?/', $line[1], $regs2)) {
+ 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') {
// 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;
}
}
unset($data['VERSION']);
return $data;
- }
-
-
- /**
- * Split quoted string
- *
- * @param string vCard string to split
- * @param string Separator char/string
- * @return array List with splitted values
- */
- private static function vcard_unquote($s, $sep = ';')
- {
- // break string into parts separated by $sep, but leave escaped $sep alone
- if (count($parts = explode($sep, strtr($s, array("\\$sep" => "\007")))) > 1) {
- foreach($parts as $s) {
- $result[] = self::vcard_unquote(strtr($s, array("\007" => "\\$sep")), $sep);
- }
- return $result;
- }
- else {
- return strtr($s, array("\r" => '', '\\\\' => '\\', '\n' => "\n", '\,' => ',', '\;' => ';', '\:' => ':'));
- }
}
@@ -583,6 +614,7 @@
return quoted_printable_decode($value);
case 'base64':
+ case 'b':
self::$values_decoded = true;
return base64_decode($value);
@@ -605,18 +637,29 @@
while ($type == "N" && is_array($entries[0]) && count($entries[0]) < 5)
$entries[0][] = "";
+ // make sure FN is not empty (required by RFC2426)
+ if ($type == "FN" && empty($entries))
+ $entries[0] = $data['EMAIL'][0][0];
+
foreach((array)$entries as $entry) {
$attr = '';
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, ',');
}
}
}
@@ -624,11 +667,15 @@
$value = $entry;
}
- $vcard .= self::vcard_quote($type) . $attr . ':' . self::vcard_quote($value) . "\n";
+ // skip empty entries
+ if (self::is_empty($value))
+ continue;
+
+ $vcard .= self::vcard_quote($type) . $attr . ':' . self::vcard_quote($value) . self::$eol;
}
}
- return "BEGIN:VCARD\nVERSION:3.0\n{$vcard}END:VCARD";
+ return 'BEGIN:VCARD' . self::$eol . 'VERSION:3.0' . self::$eol . $vcard . 'END:VCARD';
}
@@ -648,10 +695,73 @@
return(implode($sep, (array)$r));
}
else {
- return strtr($s, array('\\' => '\\\\', "\r" => '', "\n" => '\n', ';' => '\;', ':' => '\:'));
+ return strtr($s, array('\\' => '\\\\', "\r" => '', "\n" => '\n', ',' => '\,', ';' => '\;'));
}
}
+
+ /**
+ * Split quoted string
+ *
+ * @param string vCard string to split
+ * @param string Separator char/string
+ * @return array List with splitted values
+ */
+ private static function vcard_unquote($s, $sep = ';')
+ {
+ // break string into parts separated by $sep, but leave escaped $sep alone
+ if (count($parts = explode($sep, strtr($s, array("\\$sep" => "\007")))) > 1) {
+ foreach($parts as $s) {
+ $result[] = self::vcard_unquote(strtr($s, array("\007" => "\\$sep")), $sep);
+ }
+ return $result;
+ }
+ else {
+ return strtr($s, array("\r" => '', '\\\\' => '\\', '\n' => "\n", '\N' => "\n", '\,' => ',', '\;' => ';', '\:' => ':'));
+ }
+ }
+
+
+ /**
+ * Check if vCard entry is empty: empty string or an array with
+ * all entries empty.
+ *
+ * @param mixed $value Attribute value (string or array)
+ *
+ * @return bool True if the value is empty, False otherwise
+ */
+ private static function is_empty($value)
+ {
+ foreach ((array)$value as $v) {
+ if (((string)$v) !== '') {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Extract array values by a filter
+ *
+ * @param array Array to filter
+ * @param keys Array or comma separated list of values to keep
+ * @param boolean Invert key selection: remove the listed values
+ * @return array The filtered array
+ */
+ private static function array_filter($arr, $values, $inverse = false)
+ {
+ if (!is_array($values))
+ $values = explode(',', $values);
+
+ $result = array();
+ $keep = array_flip((array)$values);
+ foreach ($arr as $key => $val)
+ if ($inverse != isset($keep[strtolower($val)]))
+ $result[$key] = $val;
+
+ return $result;
+ }
/**
* Returns UNICODE type based on BOM (Byte Order Mark)
@@ -696,9 +806,7 @@
)*\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::get_instance()->config->get('default_charset', 'ISO-8859-1'); # fallback to Latin-1
}
}
-
-
--
Gitblit v1.9.1