CS fixes

Aleksander Machniak

2012-12-18 8cacecb2ff8b2c819f573bbd47f6bc8171d26ee8

CS fixes

 program/lib/Roundcube/rcube_vcard.php

@@ -48,10 +48,30 @@
    'spouse'      => 'X-SPOUSE',
    'edit'        => 'X-AB-EDIT',
  );
  private $typemap = array('IPHONE' => 'mobile', 'CELL' => 'mobile', 'WORK,FAX' => 'workfax');
  private $phonetypemap = array('HOME1' => 'HOME', 'BUSINESS1' => 'WORK', 'BUSINESS2' => 'WORK2', 'BUSINESSFAX' => 'WORK,FAX', 'MOBILE' => 'CELL');
  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');
    private $typemap = array(
        'IPHONE'   => 'mobile',
        'CELL'     => 'mobile',
        'WORK,FAX' => 'workfax',
    );
    private $phonetypemap = array(
        'HOME1'       => 'HOME',
        'BUSINESS1'   => 'WORK',
        'BUSINESS2'   => 'WORK2',
        'BUSINESSFAX' => 'WORK,FAX',
        'MOBILE'      => 'CELL',
    );
    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;
@@ -64,18 +84,20 @@

  public static $eol = "\r\n";


  /**
   * Constructor
   */
  public function __construct($vcard = null, $charset = RCUBE_CHARSET, $detect = false, $fieldmap = array())
  {
    if (!empty($fielmap))
        if (!empty($fielmap)) {
      $this->extend_fieldmap($fieldmap);

    if (!empty($vcard))
      $this->load($vcard, $charset, $detect);
  }

        if (!empty($vcard)) {
            $this->load($vcard, $charset, $detect);
        }
    }

  /**
   * Load record from (internal, unfolded) vcard 3.0 format
@@ -94,14 +116,17 @@
      $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 != RCUBE_CHARSET) {
        else if ($detect && self::$values_decoded
            && ($detected_charset = self::detect_encoding(self::vcard_encode($this->raw)))
            && $detected_charset != RCUBE_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])
        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];
@@ -112,8 +137,9 @@
    $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)
        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');
@@ -123,7 +149,6 @@
      $this->email[$pref_index] = $tmp;
    }
  }


  /**
   * Return vCard data as associative array to be unsed in Roundcube address books
@@ -137,8 +162,9 @@

    // copy name fields to output array
    foreach (array('firstname','surname','middlename','nickname','organization') as $col) {
      if (strlen($this->$col))
            if (strlen($this->$col)) {
        $out[$col] = $this->$col;
            }
    }

    if ($this->raw['N'][0][3])
@@ -168,8 +194,9 @@
                $subtype = strtolower($raw['type'][$k]);
            }

            while ($k < count($raw['type']) && ($subtype == 'internet' || $subtype == 'pref'))
                        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
@@ -186,19 +213,22 @@
          }

          // force subtype if none set
          if (!$subtype && preg_match('/^(email|phone|address|website)/', $key))
                    if (!$subtype && preg_match('/^(email|phone|address|website)/', $key)) {
            $subtype = 'other';
                    }

          if ($subtype)
                    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
                    else {
            $out[$key][] = $raw[0];
                    }
        }
        else {
          $out[$col][] = $raw;
@@ -214,12 +244,12 @@
    }

    // copy photo data
    if ($this->raw['PHOTO'])
        if ($this->raw['PHOTO']) {
      $out['photo'] = $this->raw['PHOTO'][0][0];
        }

    return $out;
  }


  /**
   * Convert the data structure into a vcard 3.0 string
@@ -230,7 +260,6 @@
    return $folded ? self::rfc2425_fold($vcard) : $vcard;
  }


  /**
   * Clear the given fields in the loaded vcard data
   *
@@ -238,20 +267,24 @@
   */
  public function reset($fields = null)
  {
    if (!$fields)
      $fields = array_merge(array_values(self::$fieldmap), array_keys($this->immap), array('FN','N','ORG','NICKNAME','EMAIL','ADR','BDAY'));
        if (!$fields) {
            $fields = array_merge(array_values(self::$fieldmap), array_keys($this->immap),
                array('FN','N','ORG','NICKNAME','EMAIL','ADR','BDAY'));
        }

    foreach ($fields as $f)
        foreach ($fields as $f) {
      unset($this->raw[$f]);
        }

    if (!$this->raw['N'])
        if (!$this->raw['N']) {
      $this->raw['N'] = array(array('','','','',''));
    if (!$this->raw['FN'])
        }
        if (!$this->raw['FN']) {
      $this->raw['FN'] = array();
        }

    $this->email = array();
  }


  /**
   * Setter for address record fields
@@ -317,29 +350,34 @@
      case 'im':
        // save IM subtypes into extension fields
        $typemap = array_flip($this->immap);
        if ($field = $typemap[strtolower($type)])
            if ($field = $typemap[strtolower($type)]) {
          $this->raw[$field][] = array(0 => $value);
            }
        break;

      case 'birthday':
      case 'anniversary':
        if (($val = rcube_utils::strtotime($value)) && ($fn = self::$fieldmap[$field]))
            if (($val = rcube_utils::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_uc])
            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']);

        // fall through if not empty
        if (!strlen(join('', $value)))
            if (!strlen(join('', $value))) {
          break;
            }

      default:
        if ($field == 'phone' && $this->phonetypemap[$type_uc])
            if ($field == 'phone' && $this->phonetypemap[$type_uc]) {
          $type = $this->phonetypemap[$type_uc];
             }

        if (($tag = self::$fieldmap[$field]) && (is_array($value) || strlen($value))) {
          $index = count($this->raw[$tag]);
@@ -366,7 +404,6 @@
    $this->raw[$tag][$index] = (array)$value;
  }


  /**
   * Find index with the '$type' attribute
   *
@@ -378,14 +415,14 @@
    $result = 0;
    if ($this->raw[$field]) {
      foreach ($this->raw[$field] as $i => $data) {
        if (is_array($data['type']) && in_array_nocase('pref', $data['type']))
                if (is_array($data['type']) && in_array_nocase('pref', $data['type'])) {
          $result = $i;
                }
      }
    }

    return $result;
  }


  /**
   * Convert a whole vcard (array) to UTF-8.
@@ -397,8 +434,9 @@
      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))
                        if (is_numeric($j) && is_string($value)) {
              $card[$key][$i][$j] = rcube_charset::convert($value, $charset);
                        }
          }
          unset($card[$key][$i]['charset']);
        }
@@ -408,21 +446,21 @@
    return $card;
  }


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

    }

  /**
   * Factory method to import a vcard file
   *
   * @param string vCard file content
     *
   * @return array List of rcube_vcard objects
   */
  public static function import($data)
@@ -430,8 +468,9 @@
    $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)))
        if (preg_match('/charset=/i', substr($data, 0, 2048))) {
      $charset = null;
        }
    // detect charset and convert to utf-8
    else if (($charset = self::detect_encoding($data)) && $charset != RCUBE_CHARSET) {
      $data = rcube_charset::convert($data, $charset);
@@ -443,16 +482,18 @@
    $in_vcard_block = false;

    foreach (preg_split("/[\r\n]+/", $data) as $i => $line) {
      if ($in_vcard_block && !empty($line))
            if ($in_vcard_block && !empty($line)) {
        $vcard_block .= $line . "\n";
            }

      $line = trim($line);

      if (preg_match('/^END:VCARD$/i', $line)) {
        // parse vcard
        $obj = new rcube_vcard(self::cleanup($vcard_block), $charset, true, self::$fieldmap);
        if (!empty($obj->displayname) || !empty($obj->email))
                if (!empty($obj->displayname) || !empty($obj->email)) {
          $out[] = $obj;
                }

        $in_vcard_block = false;
      }
@@ -465,11 +506,11 @@
    return $out;
  }


  /**
   * Normalize vcard data for better parsing
   *
   * @param string vCard block
     *
   * @return string Cleaned vcard block
   */
  private static function cleanup($vcard)
@@ -529,12 +570,12 @@
    return preg_replace_callback('/([^\n]{72,})/', array('self', 'rfc2425_fold_callback'), $val);
  }


  /**
   * Decodes a vcard block (vcard 3.0 format, unfolded)
   * into an array structure
   *
   * @param string vCard block to parse
     *
   * @return array Raw data structure
   */
  private static function vcard_decode($vcard)
@@ -552,10 +593,14 @@
        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])) {
            if ($data['VERSION'][0] == "2.1"
                && preg_match('/^([^;]+);([^:]+)/', $line[1], $regs2)
                && !preg_match('/^TYPE=/i', $regs2[2])
            ) {
        $line[1] = $regs2[1];
        foreach (explode(';', $regs2[2]) as $prop)
                foreach (explode(';', $regs2[2]) as $prop) {
          $line[1] .= ';' . (strpos($prop, '=') ? $prop : 'TYPE='.$prop);
                }
      }

      if (preg_match_all('/([^\\;]+);?/', $line[1], $regs2)) {
@@ -570,8 +615,9 @@
              $value = strtoupper($value);
              // add next line(s) to value string if QP line end detected
              if ($value == 'QUOTED-PRINTABLE') {
                while (preg_match('/=$/', $lines[$i]))
                                while (preg_match('/=$/', $lines[$i])) {
                  $line[2] .= "\n" . $lines[++$i];
                                }
              }
              $enc = $value;
            }
@@ -609,12 +655,12 @@
    return $data;
  }


  /**
   * Decode a given string with the encoding rule from ENCODING attributes
   *
   * @param string String to decode
   * @param string Encoding type (quoted-printable and base64 supported)
     *
   * @return string Decoded 8bit value
   */
  private static function decode_value($value, $encoding)
@@ -634,23 +680,25 @@
    }
  }


  /**
   * Encodes an entry for storage in our database (vcard 3.0 format, unfolded)
   *
   * @param array Raw data structure to encode
     *
   * @return string vCard encoded string
   */
  static function vcard_encode($data)
  {
    foreach((array)$data as $type => $entries) {
      /* valid N has 5 properties */
      while ($type == "N" && is_array($entries[0]) && count($entries[0]) < 5)
            // valid N has 5 properties
            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))
            if ($type == "FN" && empty($entries)) {
        $entries[0] = $data['EMAIL'][0][0];
            }

      foreach((array)$entries as $entry) {
        $attr = '';
@@ -664,13 +712,15 @@
              $value[] = $attrvalues;
            }
            else if (is_bool($attrvalues)) {
                            // true means just tag, not tag=value, as in PHOTO;BASE64:...
              if ($attrvalues) {
                $attr .= strtoupper(";$attrname");    // true means just tag, not tag=value, as in PHOTO;BASE64:...
                                $attr .= strtoupper(";$attrname");
              }
            }
            else {
              foreach((array)$attrvalues as $attrvalue)
                            foreach((array)$attrvalues as $attrvalue) {
                $attr .= strtoupper(";$attrname=") . self::vcard_quote($attrvalue, ',');
                            }
            }
          }
        }
@@ -679,8 +729,9 @@
        }

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

        $vcard .= self::vcard_quote($type) . $attr . ':' . self::vcard_quote($value) . self::$eol;
      }
@@ -689,12 +740,12 @@
    return 'BEGIN:VCARD' . self::$eol . 'VERSION:3.0' . self::$eol . $vcard . 'END:VCARD';
  }


  /**
   * Join indexed data array to a vcard quoted string
   *
   * @param array Field data
   * @param string Separator
     *
   * @return string Joined and quoted string
   */
  private static function vcard_quote($s, $sep = ';')
@@ -705,17 +756,16 @@
      }
      return(implode($sep, (array)$r));
    }
    else {

      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 splited values
   */
  private static function vcard_unquote($s, $sep = ';')
@@ -727,11 +777,9 @@
      }
      return $result;
    }
    else {

      return strtr($s, array("\r" => '', '\\\\' => '\\', '\n' => "\n", '\N' => "\n", '\,' => ',', '\;' => ';', '\:' => ':'));
    }
  }


  /**
   * Check if vCard entry is empty: empty string or an array with
@@ -758,18 +806,23 @@
   * @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))
        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)]))

        foreach ($arr as $key => $val) {
            if ($inverse != isset($keep[strtolower($val)])) {
        $result[$key] = $val;
            }
        }

    return $result;
  }
@@ -778,6 +831,7 @@
   * Returns UNICODE type based on BOM (Byte Order Mark)
   *
   * @param string Input string to test
     *
   * @return string Detected encoding
   */
  private static function detect_encoding($string)
@@ -786,5 +840,4 @@

    return rcube_charset::detect($string, $fallback);
  }

}