OCA\Contacts\VObject\VCard

Complexity

Total Complexity

66

Size/Duplication

Total Lines	379
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

23.62%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
B	paramName()	0	27	4
C	decodeProperty()	0	26	7
A	fixPropertyParameters()	0	15	4
F	validate()	0	163	39
B	propertyGroups()	0	11	5
A	inGroup()	0	7	2
A	addToGroup()	0	7	2
A	removeFromGroup()	0	19	3

<?php
/**
 * ownCloud - VCard component
 *
 * This component represents the BEGIN:VCARD and END:VCARD found in every
 * vcard.
 *
 * @author Thomas Tanghus
 * @author Evert Pot (http://www.rooftopsolutions.nl/)
 * @copyright 2013-2014 Thomas Tanghus (thomas@tanghus.net)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Contacts\VObject;

use OCA\Contacts\Utils;
use Sabre\VObject;

/**
 * This class overrides \Sabre\VObject\Component\VCard::validate() to be add
 * to import partially invalid vCards by ignoring invalid lines and to
 * validate and upgrade using ....
 *
 * Satisfy PHP Analyzer:
 * @property \OC\VObject\CompoundProperty N
 * @property \OC\VObject\CompoundProperty ORG
 * @property \OC\VObject\CompoundProperty ADR
 * @property \OCA\Contacts\VObject\GroupProperty CATEGORIES
 * @property \Sabre\VObject\Property\Text FN
 * @property \Sabre\VObject\Property\Text EMAIL
 * @property \Sabre\VObject\Property\Text VERSION
 * @property \Sabre\VObject\Property\Text BDAY
 * @property \Sabre\VObject\Property\Text UID
 * @property \Sabre\VObject\Property\Text REV
 * @property \Sabre\VObject\Property\Binary PHOTO
 * @property \Sabre\VObject\Property\Binary LOGO
 * @property \Sabre\VObject\Property\FlatText PRODID
*/
class VCard extends VObject\Component\VCard {

	/**
	* The following constants are used by the validate() method.
	*/
    const REPAIR = 1;

Tabs must be used to indent lines; spaces are not allowed

	const UPGRADE = 2;

	/**
	 * The groups in the contained properties
	 *
	 * @var array
	 */
	protected $groups = array();

	/**
	* VCards with version 2.1, 3.0 and 4.0 are found.
	*
	* If the VCARD doesn't know its version, 3.0 is assumed and if
	* option UPGRADE is given it will be upgraded to version 3.0.
	*/
	const DEFAULT_VERSION = '3.0';

	/**
	* The vCard 2.1 specification allows parameter values without a name.
	* The parameter name is then determined from the unique parameter value.
	* In version 2.1 e.g. a phone can be formatted like: TEL;HOME;CELL:123456789
	* This has to be changed to either TEL;TYPE=HOME,CELL:123456789 or TEL;TYPE=HOME;TYPE=CELL:123456789 - both are valid.
	*
	* From: https://github.com/barnabywalters/vcard/blob/master/barnabywalters/VCard/VCard.php
	*
	* @param string value
	* @return string
	*/
	protected function paramName($value) {
		static $types = array (
				'DOM', 'INTL', 'POSTAL', 'PARCEL','HOME', 'WORK',
				'PREF', 'VOICE', 'FAX', 'MSG', 'CELL', 'PAGER',
				'BBS', 'MODEM', 'CAR', 'ISDN', 'VIDEO',
				'AOL', 'APPLELINK', 'ATTMAIL', 'CIS', 'EWORLD',
				'INTERNET', 'IBMMAIL', 'MCIMAIL',
				'POWERSHARE', 'PRODIGY', 'TLX', 'X400',
				'GIF', 'CGM', 'WMF', 'BMP', 'MET', 'PMB', 'DIB',
				'PICT', 'TIFF', 'PDF', 'PS', 'JPEG', 'QTIME',
				'MPEG', 'MPEG2', 'AVI',
				'WAVE', 'AIFF', 'PCM',
				'X509', 'PGP');
		static $values = array (
				'INLINE', 'URL', 'CID');
		static $encodings = array (
				'7BIT', 'QUOTED-PRINTABLE', 'BASE64');
		$name = 'UNKNOWN';
		if (in_array($value, $types)) {
			$name = 'TYPE';
		} elseif (in_array($value, $values)) {
			$name = 'VALUE';
		} elseif (in_array($value, $encodings)) {
			$name = 'ENCODING';
		}
		return $name;
	}

	/**
	* Decode properties for upgrading from v. 2.1
	*
	* @param \Sabre\VObject\Property $property Reference to a \Sabre\VObject\Property.
	* The only encoding allowed in version 3.0 is 'b' for binary. All encoded strings
	* must therefore be decoded and the parameters removed.
	*/
	protected function decodeProperty(&$property) {
		foreach($property->parameters as $key=>&$parameter) {
			// Check for values without names which Sabre interprets
			// as names without values.
			if(trim($parameter->getValue()) === '') {
				$parameter->setValue($parameter->name);
				$parameter->name = $this->paramName($parameter->name);
			}
			// Check out for encoded string and decode them :-[
			if(strtoupper($parameter->name) == 'ENCODING') {
				if(strtoupper($parameter->getValue()) == 'QUOTED-PRINTABLE') {
					$property->setValue(str_replace(
						"\r\n", "\n",
						VObject\StringUtil::convertToUTF8(
							quoted_printable_decode($property->getValue())

The method getValue() does not seem to exist on object<Sabre\VObject\Property>.

						)
					));
					unset($property->parameters[$key]);
				} elseif(strtoupper($parameter->getValue()) == 'BASE64') {
					$parameter->setValue('b');
				}
			} elseif(strtoupper($parameter->name) == 'CHARSET') {
				unset($property->parameters[$key]);
			}
		}
	}

	/**
	* Work around issue in older VObject sersions
	* https://github.com/fruux/sabre-vobject/issues/24
	*
	* @param \Sabre\VObject\Property $property Reference to a \Sabre\VObject\Property.
	*/
	public function fixPropertyParameters(&$property) {
		// Work around issue in older VObject sersions
		// https://github.com/fruux/sabre-vobject/issues/24
		foreach($property->parameters as $key=>$parameter) {
			if(strpos($parameter->getValue(), ',') === false) {
				continue;
			}
			$values = explode(',', $parameter->getValue());
			$values = array_map('trim', $values);
			$parameter->setValue(array_shift($values));
			foreach($values as $value) {
				$property->add($parameter->name, $value);
			}
		}
	}

	/**
	* Validates the node for correctness.
	*
	* The following options are supported:
	*   - VCard::REPAIR - If something is broken, and automatic repair may
	*                    be attempted.
	*   - VCard::UPGRADE - If needed the vCard will be upgraded to version 3.0.
	*
	* An array is returned with warnings.
	*
	* Every item in the array has the following properties:
	*    * level - (number between 1 and 3 with severity information)
	*    * message - (human readable message)
	*    * node - (reference to the offending node)
	*
	* @param int $options
	* @return array
	*/
	public function validate($options = 0) {

		$warnings = array();
		$repaired = false;

		$version = $this->select('VERSION');
		if (count($version) !== 1) {
			$warnings[] = array(
				'level' => 1,
				'message' => 'The VERSION property must appear in the VCARD component exactly 1 time',
				'node' => $this,
			);
			if ($options & self::REPAIR) {
				if (count($version) > 1) {
					$version = (string) current($version);
					$this->remove('VERSION');

The method remove() does not exist on OCA\Contacts\VObject\VCard. Did you maybe mean removeFromGroup()?

					$this->VERSION = $version;
				} else {
					$this->VERSION = self::DEFAULT_VERSION;
				}
				$repaired = true;
			}
		} 

		$version = (string)$this->VERSION;
		if ($version!=='2.1' && $version!=='3.0' && $version!=='4.0') {
			$warnings[] = array(
				'level' => 1,
				'message' => 'Only vcard version 4.0 (RFC6350), version 3.0 (RFC2426) or version 2.1 (icm-vcard-2.1) are supported.',
				'node' => $this,
			);
			if ($options & self::REPAIR) {
				$this->VERSION = self::DEFAULT_VERSION;
				$repaired = true;
			}
		}

		# upgrade 2.1 cards to 3.0 cards.
		if ($options & self::UPGRADE && $version === '2.1') {
			$this->VERSION = self::DEFAULT_VERSION;
			$repaired = true;
			foreach($this->children as $idx => &$property) {

				$this->decodeProperty($property);
				$this->fixPropertyParameters($property);
				/* What exactly was I thinking here?
				switch((string)$property->name) {
					case 'LOGO':
					case 'SOUND':
					case 'PHOTO':
						if(isset($property['TYPE']) && strpos((string)$property['TYPE'], '/') === false) {
							$property['TYPE'] = 'image/' . strtolower($property['TYPE']);
						}
				}*/
			}
		}

		$fn = $this->select('FN');
		if (count($fn) !== 1 || trim((string)$this->FN) === '') {
			$warnings[] = array(
				'level' => 1,
				'message' => 'The FN property must appear in the VCARD component exactly 1 time',
				'node' => $this,
			);
			if ($options & self::REPAIR) {
				// We're going to try to see if we can use the contents of the
				// N property.
				$repaired = true;
				if (isset($this->N)
					&& substr((string)$this->N, 2) !== ';;'
					&& (string)$this->N !== ''
				) {
					$value = explode(';', (string)$this->N);
					if (isset($value[1]) && $value[1]) {
						$this->FN = $value[1] . ' ' . $value[0];
					} else {
						$this->FN = $value[0];
					}
				// Otherwise, the ORG property may work
				} elseif (isset($this->ORG)) {
					$this->FN = (string)$this->ORG;
				} elseif (isset($this->EMAIL)) {
					$this->FN = (string)$this->EMAIL;
				}

			}
		}

		if(isset($this->BDAY)) {
			if ($options & self::REPAIR) {
				// If the BDAY has a format of e.g. 19960401
				$bday = (string)$this->BDAY;
				if(strlen($bday) >= 8
					&& is_int(substr($bday, 0, 4))
					&& is_int(substr($bday, 4, 2))
					&& is_int(substr($bday, 6, 2))) {
					$this->BDAY = substr($bday, 0, 4).'-'.substr($bday, 4, 2).'-'.substr($bday, 6, 2);
					$this->BDAY->VALUE = 'DATE';
					$repaired = true;
				} else if($bday[5] !== '-' || $bday[7] !== '-') {
					try {
						// Skype exports as e.g. Jan 14, 1996
						$date = new \DateTime($bday);
						$this->BDAY = $date->format('Y-m-d');
						$this->BDAY->VALUE = 'DATE';
						$repaired = true;
					} catch(\Exception $e) {
						\OCP\Util::writeLog('contacts', __METHOD__.' Removing invalid BDAY: ' . $bday, \OCP\Util::DEBUG);
						unset($this->BDAY);
					}
				}
			}
		}

		$n = $this->select('N');
		if (count($n) !== 1) {
			$warnings[] = array(
				'level' => 1,
				'message' => 'The N property must appear in the VCARD component exactly 1 time',
				'node' => $this,
			);
			// TODO: Make a better effort parsing FN.
			if (($options & self::REPAIR) && count($n) === 0) {
				// Take 2 first name parts of 'FN' and reverse.
				$slice = array_reverse(array_slice(explode(' ', (string)$this->FN), 0, 2));
				if(count($slice) < 2) { // If not enought, add one more...
					$slice[] = "";
				}
				$this->N = $slice;
				$repaired = true;
			}
		}

		if (!isset($this->UID) || trim((string)$this->UID) === '') {
			$warnings[] = array(
				'level' => 1,
				'message' => 'Every vCard must have a UID',
				'node' => $this,
			);
			if ($options & self::REPAIR) {
				$this->UID = Utils\Properties::generateUID();
				$repaired = true;
			}
		}

		if ($repaired) {
			$now = new \DateTime;
			$this->REV = $now->format(\DateTime::W3C);

			if (count($this->select('PRODID')) > 1) {
				$this->remove('PRODID');

The method remove() does not exist on OCA\Contacts\VObject\VCard. Did you maybe mean removeFromGroup()?

			}
			$appInfo = \OCP\App::getAppInfo('contacts');
			$appVersion = \OCP\App::getAppVersion('contacts');
			$this->PRODID = '-//ownCloud//NONSGML '.$appInfo['name'].' '.$appVersion.'//EN';
		}

		return array_merge(
			parent::validate($options),
			$warnings
		);

	}

	/**
	 * Get all group names in the vCards properties
	 *
	 * NOTE: Not to confuse with CATEGORIES groups
	 *
	 * @return array
	 */
	public function propertyGroups() {
		foreach($this->children as $property) {
			if($property->group && !isset($this->groups[$property->group])) {
				$this->groups[] = $property->group;
			}
		}
		if(count($this->groups) > 1) {
			sort($this->groups);
		}
		return $this->groups;
	}

	/**
	* Test if vcard has group (CATEGORIES) $name
	*
	* @param string $name
	* @return bool
	*/
	public function inGroup($name) {
		if(!isset($this->CATEGORIES)) {
			return false;
		}

		return $this->CATEGORIES->hasGroup($name);
	}

	/**
	* Add group (CATEGORIES) $name to vcard
	*
	* Return true if contact wasn't already in group
	*
	* @param string $name
	* @return bool
	*/
	public function addToGroup($name) {
		if(!isset($this->CATEGORIES)) {
			$this->add('CATEGORIES');
		}

		return $this->CATEGORIES->addGroup($name);
	}

	/**
	* Remove group (CATEGORIES) $name from vcard
	*
	* Return true if vcard has been updated.
	*
	* @param string $name
	* @return bool
	*/
	public function removeFromGroup($name) {

		if(!isset($this->CATEGORIES)) {
			return false;
		}

		$updated = $this->CATEGORIES->removeGroup($name);
		// getParts() returns an array with an empty element if
		// CATEGORIES is empty
		$groups = $this->CATEGORIES->getParts();
		// Remove empty elements
		$groups = array_filter($groups, 'strlen');
		if(count($groups) === 0) {
			unset($this->{'CATEGORIES'});
			$updated = true;
		}

		return $updated;
	}


}