- Added possibility to extend rcube_vcard's fieldmap - Skip empty values in...

alecpl

2011-08-03 4d4a2fa32edffcca91822fe82363b71372048286

 program/include/rcube_vcard.php

@@ -33,7 +33,7 @@
    'FN' => array(),
    'N' => array(array('','','','','')),
  );
  private $fieldmap = array(
  static private $fieldmap = array(
    'phone'    => 'TEL',
    'birthday' => 'BDAY',
    'website'  => 'URL',
@@ -41,15 +41,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 $phonetypemap = array('HOME1' => 'HOME', 'BUSINESS1' => 'WORK', 'BUSINESS2' => 'WORK2', 'BUSINESSFAX' => 'WORKFAX');
  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');

@@ -67,8 +69,11 @@
  /**
   * 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 +100,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 +113,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 +136,32 @@
  {
    $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 = '';

          if (!empty($raw['type'])) {
            $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) {
@@ -168,9 +173,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 +192,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 +216,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 +226,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 +235,7 @@
      $this->raw['N'] = array(array('','','','',''));
    if (!$this->raw['FN'])
      $this->raw['FN'] = array();
      

    $this->email = array();
  }

@@ -247,41 +252,41 @@
    $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 '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?
@@ -292,12 +297,12 @@
            $this->raw['PHOTO'][0] = array(0 => $encoded ? $value : base64_encode($value), 'BASE64' => true);
        }
        break;
        

      case 'email':
        $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);
@@ -324,7 +329,7 @@
        if ($field == 'phone' && $this->phonetypemap[$type])
          $type = $this->phonetypemap[$type];

        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)
@@ -332,6 +337,19 @@
        }
        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 +368,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
@@ -374,6 +392,16 @@
    }

    return $card;
  }


  /**
   * Extends fieldmap definition
   */
  public function extend_fieldmap($map)
  {
    if (is_array($map))
      self::$fieldmap = array_merge($map, self::$fieldmap);
  }


@@ -408,8 +436,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 +474,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 +486,7 @@

    return $vcard;
  }
  

  private static function x_abrelatednames_callback($matches)
  {
    return 'X-' . strtoupper($matches[5]) . $matches[3] . ':'. $matches[4];
@@ -497,15 +525,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,7 +544,7 @@
          $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]);

@@ -525,7 +555,7 @@
              // 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);
            }
            else
@@ -543,28 +573,6 @@

    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", '\,' => ',', '\;' => ';', '\:' => ':'));
    }
  }


@@ -605,6 +613,10 @@
      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)) {
@@ -623,6 +635,10 @@
        else {
          $value = $entry;
        }

        // skip empty entries
        if (self::is_empty($value))
          continue;

        $vcard .= self::vcard_quote($type) . $attr . ':' . self::vcard_quote($value) . "\n";
      }
@@ -648,8 +664,50 @@
      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;
  }


@@ -700,5 +758,3 @@
  }

}