Aleksander Machniak
2012-08-08 2bbc3da52aee81e920e46778d68278bd31f7bb6b
program/include/rcube_vcard.php
@@ -6,16 +6,16 @@
 |                                                                       |
 | 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                    |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+
 $Id$
*/
@@ -33,7 +33,7 @@
    'FN' => array(),
    'N' => array(array('','','','','')),
  );
  private $fieldmap = array(
  private static $fieldmap = array(
    'phone'    => 'TEL',
    'birthday' => 'BDAY',
    'website'  => 'URL',
@@ -50,8 +50,8 @@
    'spouse'      => 'X-SPOUSE',
    'edit'        => 'X-AB-EDIT',
  );
  private $typemap = array('iPhone' => 'mobile', 'CELL' => 'mobile');
  private $phonetypemap = array('HOME1' => 'HOME', 'BUSINESS1' => 'WORK', 'BUSINESS2' => 'WORK2', 'BUSINESSFAX' => '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');
@@ -65,12 +65,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);
  }
@@ -146,15 +150,19 @@
      $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 = '';
          $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]);
          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) {
@@ -167,7 +175,7 @@
          }
          // 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)
@@ -220,7 +228,7 @@
  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]);
@@ -244,7 +252,7 @@
  public function set($field, $value, $type = 'HOME')
  {
    $field = strtolower($field);
    $type = strtoupper($type);
    $type_uc = strtoupper($type);
    $typemap = array_flip($this->typemap);
    switch ($field) {
@@ -284,16 +292,15 @@
      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;
@@ -305,13 +312,14 @@
        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_strtotime($value)) && ($fn = self::$fieldmap[$field]))
          $this->raw[$fn][] = array(0 => date('Y-m-d', $val), 'value' => array('date'));
        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']);
@@ -320,14 +328,14 @@
          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;
    }
@@ -378,7 +386,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']);
        }
@@ -386,6 +394,16 @@
    }
    return $card;
  }
  /**
   * Extends fieldmap definition
   */
  public function extend_fieldmap($map)
  {
    if (is_array($map))
      self::$fieldmap = array_merge($map, self::$fieldmap);
  }
@@ -404,7 +422,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;
    }
@@ -420,7 +438,7 @@
      if (preg_match('/^END:VCARD$/i', $line)) {
        // parse vcard
        $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true);
        $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true, self::$fieldmap);
        if (!empty($obj->displayname) || !empty($obj->email))
          $out[] = $obj;
@@ -531,26 +549,45 @@
      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;
      }
    }
@@ -575,6 +612,7 @@
        return quoted_printable_decode($value);
      case 'base64':
      case 'b':
        self::$values_decoded = true;
        return base64_decode($value);
@@ -606,13 +644,20 @@
        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, ',');
            }
          }
        }
@@ -620,11 +665,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';
  }
@@ -672,6 +721,47 @@
  /**
   * 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)
   *
   * @param string Input string to test
@@ -714,7 +804,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
  }
}