From ab0b51a1fef87bcc643c3aaf2e635c811b28ccd8 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Tue, 15 Feb 2011 06:10:59 -0500
Subject: [PATCH] - Use only one from IMAP authentication methods to prevent login delays (1487784)
---
program/include/rcube_vcard.php | 313 ++++++++++++++++++++++++++++++++++++++++++++-------
1 files changed, 267 insertions(+), 46 deletions(-)
diff --git a/program/include/rcube_vcard.php b/program/include/rcube_vcard.php
index 412582d..40544be 100644
--- a/program/include/rcube_vcard.php
+++ b/program/include/rcube_vcard.php
@@ -4,8 +4,8 @@
+-----------------------------------------------------------------------+
| program/include/rcube_vcard.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008, RoundCube Dev. - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2008-2011, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -14,7 +14,7 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: $
+ $Id$
*/
@@ -28,10 +28,29 @@
*/
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;
@@ -47,10 +66,10 @@
/**
* Constructor
*/
- public function __construct($vcard = null)
+ public function __construct($vcard = null, $charset = RCMAIL_CHARSET, $detect = false)
{
if (!empty($vcard))
- $this->load($vcard);
+ $this->load($vcard, $charset, $detect);
}
@@ -58,19 +77,32 @@
* 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)
+ 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 = 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];
+ $this->displayname = $this->raw['FN'][0][0];
$this->surname = $this->raw['N'][0][0];
$this->firstname = $this->raw['N'][0][1];
$this->middlename = $this->raw['N'][0][2];
- $this->nickname = $this->raw['NICKNAME'][0];
- $this->organization = $this->raw['ORG'][0];
- $this->business = ($this->raw['X-ABShowAs'][0] == 'COMPANY') || (join('', (array)$this->raw['N'][0]) == '' && !empty($this->organization));
+ $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;
@@ -82,6 +114,87 @@
$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], '@'))));
+ }
+ }
+
+
+ /**
+ * 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;
}
@@ -92,6 +205,28 @@
{
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();
+ }
/**
@@ -99,39 +234,89 @@
*
* @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] = $value;
+ $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] = $value;
+ $this->raw['NICKNAME'][0][0] = $value;
break;
case 'organization':
- $this->raw['ORG'][0] = $value;
+ $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;
}
@@ -156,6 +341,28 @@
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
+ */
+ private static function charset_convert($card, $force_charset = null)
+ {
+ foreach ($card as $key => $node) {
+ foreach ($node as $i => $subnode) {
+ 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);
+ }
+ unset($card[$key][$i]['charset']);
+ }
+ }
+ }
+
+ return $card;
+ }
/**
@@ -168,11 +375,14 @@
{
$out = array();
+ // check if charsets are specified (usually vcard version < 3.0 but this is not reliable)
+ if (preg_match('/charset=/i', substr($data, 0, 2048)))
+ $charset = null;
// detect charset and convert to utf-8
- $encoding = self::detect_encoding($data);
- if ($encoding && $encoding != RCMAIL_CHARSET) {
- $data = rcube_charset_convert($data, $encoding);
+ else if (($charset = self::detect_encoding($data)) && $charset != RCMAIL_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;
}
$vcard_block = '';
@@ -182,15 +392,17 @@
if ($in_vcard_block && !empty($line))
$vcard_block .= $line . "\n";
- if (trim($line) == 'END:VCARD') {
+ $line = trim($line);
+
+ if (preg_match('/^END:VCARD$/i', $line)) {
// parse vcard
- $obj = new rcube_vcard(self::cleanup($vcard_block));
+ $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true);
if (!empty($obj->displayname))
$out[] = $obj;
$in_vcard_block = false;
}
- else if (trim($line) == 'BEGIN:VCARD') {
+ else if (preg_match('/^BEGIN:VCARD$/i', $line)) {
$vcard_block = $line . "\n";
$in_vcard_block = true;
}
@@ -216,20 +428,27 @@
// 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);
-
- // remove vcard 2.1 charset definitions
- $vcard = preg_replace('/;CHARSET=[^:;]+/', '', $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);
return $vcard;
}
+ private static function rfc2425_fold_callback($matches)
+ {
+ return ":\n ".rtrim(chunk_split($matches[1], 72, "\n "));
+ }
private static function rfc2425_fold($val)
{
- return preg_replace('/:([^\n]{72,})/e', '":\n ".rtrim(chunk_split("\\1", 72, "\n "))', $val) . "\n";
+ return preg_replace_callback('/:([^\n]{72,})/', array('self', 'rfc2425_fold_callback'), $val) . "\n";
}
@@ -259,15 +478,16 @@
$line[1] .= ';' . (strpos($prop, '=') ? $prop : 'TYPE='.$prop);
}
- if (!preg_match('/^(BEGIN|END)$/', $line[1]) && preg_match_all('/([^\\;]+);?/', $line[1], $regs2)) {
- $entry = array('');
- $field = $regs2[1][0];
+ if (!preg_match('/^(BEGIN|END)$/i', $line[1]) && preg_match_all('/([^\\;]+);?/', $line[1], $regs2)) {
+ $entry = array();
+ $field = strtoupper($regs2[1][0]);
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' && ereg('=$', $lines[$i]))
+ // add next line(s) to value string if QP line end detected
+ while ($value == 'QUOTED-PRINTABLE' && preg_match('/=$/', $lines[$i]))
$line[2] .= "\n" . $lines[++$i];
$line[2] = self::decode_value($line[2], $value);
@@ -276,17 +496,16 @@
$entry[strtolower($key)] = array_merge((array)$entry[strtolower($key)], (array)self::vcard_unquote($value, ','));
}
else if ($attrid > 0) {
- $entry[$key] = true; # true means attr without =value
+ $entry[$key] = true; // true means attr without =value
}
}
- $entry[0] = self::vcard_unquote($line[2]);
- $data[$field][] = count($entry) > 1 ? $entry : $entry[0];
+ $entry = array_merge($entry, (array)self::vcard_unquote($line[2]));
+ $data[$field][] = $entry;
}
}
unset($data['VERSION']);
-
return $data;
}
@@ -324,9 +543,11 @@
{
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:
@@ -356,7 +577,7 @@
if (is_int($attrname))
$value[] = $attrvalues;
elseif ($attrvalues === true)
- $attr .= ";$attrname"; # true means just tag, not tag=value, as in PHOTO;BASE64:...
+ $attr .= ";$attrname"; // true means just tag, not tag=value, as in PHOTO;BASE64:...
else {
foreach((array)$attrvalues as $attrvalue)
$attr .= ";$attrname=" . self::vcard_quote($attrvalue, ',');
@@ -416,7 +637,7 @@
'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, join(',', $encodings))))
+ if (function_exists('mb_detect_encoding') && ($enc = mb_detect_encoding($string, $encodings)))
return $enc;
// No match, check for UTF-8
@@ -433,7 +654,7 @@
)*\z/xs', substr($string, 0, 2048)))
return 'UTF-8';
- return 'ISO-8859-1'; # fallback to Latin-1
+ return rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1'); # fallback to Latin-1
}
}
--
Gitblit v1.9.1