AddressBookImpl::vCard2Array() - Code Metrics - Inspection of "Merge pull request #1207 from nextcloud/backport-1..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — stable10 ( 782c31...5fae9e )

by Roeland

created 2016-08-31 13:08 UTC

AddressBookImpl::vCard2Array() C

↳ Parent: AddressBookImpl

Complexity

Conditions	11
Paths	16

Size

Total Lines	49
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	30
c	1
b	0
f	0
nc	16
nop	2
dl	0
loc	49
rs	5.2653

How to fix Complexity

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Björn Schießle <[email protected]>
 * @author Georg Ehrke <[email protected]>
 * @author Thomas Müller <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\DAV\CardDAV;

use OCP\Constants;
use OCP\IAddressBook;
use OCP\IURLGenerator;
use Sabre\VObject\Component\VCard;
use Sabre\VObject\Property;
use Sabre\VObject\Property\Text;
use Sabre\VObject\Reader;
use Sabre\VObject\UUIDUtil;

class AddressBookImpl implements IAddressBook {

	/** @var CardDavBackend */
	private $backend;

	/** @var array */
	private $addressBookInfo;

	/** @var AddressBook */
	private $addressBook;

	/** @var IURLGenerator */
	private $urlGenerator;

	/**
	 * AddressBookImpl constructor.
	 *
	 * @param AddressBook $addressBook
	 * @param array $addressBookInfo
	 * @param CardDavBackend $backend
	 * @param IUrlGenerator $urlGenerator
	 */
	public function __construct(
			AddressBook $addressBook,
			array $addressBookInfo,
			CardDavBackend $backend,
			IURLGenerator $urlGenerator) {

		$this->addressBook = $addressBook;
		$this->addressBookInfo = $addressBookInfo;
		$this->backend = $backend;
		$this->urlGenerator = $urlGenerator;
	}

	/**
	 * @return string defining the technical unique key
	 * @since 5.0.0
	 */
	public function getKey() {
		return $this->addressBookInfo['id'];
	}

	/**
	 * In comparison to getKey() this function returns a human readable (maybe translated) name
	 *
	 * @return mixed
	 * @since 5.0.0
	 */
	public function getDisplayName() {
		return $this->addressBookInfo['{DAV:}displayname'];
	}

	/**
	 * @param string $pattern which should match within the $searchProperties
	 * @param array $searchProperties defines the properties within the query pattern should match
	 * @param array $options - for future use. One should always have options!
	 * @return array an array of contacts which are arrays of key-value-pairs
	 * @since 5.0.0
	 */
	public function search($pattern, $searchProperties, $options) {
		$results = $this->backend->search($this->getKey(), $pattern, $searchProperties);

		$vCards = [];
		foreach ($results as $result) {
			$vCards[] = $this->vCard2Array($result['uri'], $this->readCard($result['carddata']));
		}

		return $vCards;
	}

	/**
	 * @param array $properties this array if key-value-pairs defines a contact
	 * @return array an array representing the contact just created or updated
	 * @since 5.0.0
	 */
	public function createOrUpdate($properties) {
		$update = false;
		if (!isset($properties['URI'])) { // create a new contact
			$uid = $this->createUid();
			$uri = $uid . '.vcf';
			$vCard = $this->createEmptyVCard($uid);
		} else { // update existing contact
			$uri = $properties['URI'];
			$vCardData = $this->backend->getCard($this->getKey(), $uri);
			$vCard = $this->readCard($vCardData['carddata']);
			$update = true;
		}

		foreach ($properties as $key => $value) {
			$vCard->$key = $vCard->createProperty($key, $value);
		}

		if ($update) {
			$this->backend->updateCard($this->getKey(), $uri, $vCard->serialize());
		} else {
			$this->backend->createCard($this->getKey(), $uri, $vCard->serialize());
		}

		return $this->vCard2Array($uri, $vCard);

	}

	/**
	 * @return mixed
	 * @since 5.0.0
	 */
	public function getPermissions() {
		$permissions = $this->addressBook->getACL();
		$result = 0;
		foreach ($permissions as $permission) {
			switch($permission['privilege']) {
				case '{DAV:}read':
					$result |= Constants::PERMISSION_READ;
					break;
				case '{DAV:}write':
					$result |= Constants::PERMISSION_CREATE;
					$result |= Constants::PERMISSION_UPDATE;
					break;
				case '{DAV:}all':
					$result |= Constants::PERMISSION_ALL;
					break;
			}
		}

		return $result;
	}

	/**
	 * @param object $id the unique identifier to a contact
	 * @return bool successful or not
	 * @since 5.0.0
	 */
	public function delete($id) {
		$uri = $this->backend->getCardUri($id);
		return $this->backend->deleteCard($this->addressBookInfo['id'], $uri);
	}

	/**
	 * read vCard data into a vCard object
	 *
	 * @param string $cardData
	 * @return VCard
	 */
	protected function readCard($cardData) {
		return  Reader::read($cardData);
	}

	/**
	 * create UID for contact
	 *
	 * @return string
	 */
	protected function createUid() {
		do {
			$uid = $this->getUid();
			$contact = $this->backend->getContact($this->getKey(), $uid . '.vcf');
		} while (!empty($contact));

		return $uid;
	}

	/**
	 * getUid is only there for testing, use createUid instead
	 */
	protected function getUid() {
		return UUIDUtil::getUUID();
	}

	/**
	 * create empty vcard
	 *
	 * @param string $uid
	 * @return VCard
	 */
	protected function createEmptyVCard($uid) {
		$vCard = new VCard();
		$vCard->add(new Text($vCard, 'UID', $uid));
		return $vCard;
	}

	/**
	 * create array with all vCard properties
	 *
	 * @param string $uri
	 * @param VCard $vCard
	 * @return array
	 */
	protected function vCard2Array($uri, VCard $vCard) {
		$result = [
			'URI' => $uri,
		];

		foreach ($vCard->children as $property) {
			/** @var \Sabre\VObject\Property\Unknown $property */
			if ($property->name === 'PHOTO' && $property->getValueType() === 'BINARY') {
				$url = $this->urlGenerator->getAbsoluteURL(
					$this->urlGenerator->linkTo('', 'remote.php') . '/dav/');
				$url .= implode('/', [
					'addressbooks',
					substr($this->addressBookInfo['principaluri'], 11), //cut off 'principals/'
					$this->addressBookInfo['uri'],
					$uri
				]) . '?photo';

				$result['PHOTO'] = 'VALUE=uri:' . $url;

			} else if ($property->name === 'X-SOCIALPROFILE') {
				$type = $this->getTypeFromProperty($property);

				// Type is the social network, when it's empty we don't need this.
				if ($type !== null) {
					if (!isset($result[$property->name])) {
						$result[$property->name] = [];
					}
					$result[$property->name][$type] = $property->getValue();
				}

			// The following properties can be set multiple times
			} else if (in_array($property->name, ['CLOUD', 'EMAIL', 'IMPP', 'TEL', 'URL'])) {
				if (!isset($result[$property->name])) {
					$result[$property->name] = [];
				}

				$result[$property->name][] = $property->getValue();

			} else {
				$result[$property->name] = $property->getValue();
			}
		}

		if ($this->addressBookInfo['principaluri'] === 'principals/system/system' &&
			$this->addressBookInfo['uri'] === 'system') {
			$result['isLocalSystemBook'] = true;
		}
		return $result;
	}

	/**
	 * Get the type of the current property
	 *
	 * @param Property $property
	 * @return null|string
	 */
	protected function getTypeFromProperty(Property $property) {
		$parameters = $property->parameters();
		// Type is the social network, when it's empty we don't need this.
		if (isset($parameters['TYPE'])) {
			/** @var \Sabre\VObject\Parameter $type */
			$type = $parameters['TYPE'];
			return $type->getValue();
		}

		return null;
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Björn Schießle <[email protected]>
6			* @author Georg Ehrke <[email protected]>
7			* @author Thomas Müller <[email protected]>
8			*
9			* @license AGPL-3.0
10			*
11			* This code is free software: you can redistribute it and/or modify
12			* it under the terms of the GNU Affero General Public License, version 3,
13			* as published by the Free Software Foundation.
14			*
15			* This program is distributed in the hope that it will be useful,
16			* but WITHOUT ANY WARRANTY; without even the implied warranty of
17			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			* GNU Affero General Public License for more details.
19			*
20			* You should have received a copy of the GNU Affero General Public License, version 3,
21			* along with this program. If not, see <http://www.gnu.org/licenses/>
22			*
23			*/
24
25			namespace OCA\DAV\CardDAV;
26
27			use OCP\Constants;
28			use OCP\IAddressBook;
29			use OCP\IURLGenerator;
30			use Sabre\VObject\Component\VCard;
31			use Sabre\VObject\Property;
32			use Sabre\VObject\Property\Text;
33			use Sabre\VObject\Reader;
34			use Sabre\VObject\UUIDUtil;
35
36			class AddressBookImpl implements IAddressBook {
37
38			/** @var CardDavBackend */
39			private $backend;
40
41			/** @var array */
42			private $addressBookInfo;
43
44			/** @var AddressBook */
45			private $addressBook;
46
47			/** @var IURLGenerator */
48			private $urlGenerator;
49
50			/**
51			* AddressBookImpl constructor.
52			*
53			* @param AddressBook $addressBook
54			* @param array $addressBookInfo
55			* @param CardDavBackend $backend
56			* @param IUrlGenerator $urlGenerator
57			*/
58			public function __construct(
59			AddressBook $addressBook,
60			array $addressBookInfo,
61			CardDavBackend $backend,
62			IURLGenerator $urlGenerator) {
63
64			$this->addressBook = $addressBook;
65			$this->addressBookInfo = $addressBookInfo;
66			$this->backend = $backend;
67			$this->urlGenerator = $urlGenerator;
68			}
69
70			/**
71			* @return string defining the technical unique key
72			* @since 5.0.0
73			*/
74			public function getKey() {
75			return $this->addressBookInfo['id'];
76			}
77
78			/**
79			* In comparison to getKey() this function returns a human readable (maybe translated) name
80			*
81			* @return mixed
82			* @since 5.0.0
83			*/
84			public function getDisplayName() {
85			return $this->addressBookInfo['{DAV:}displayname'];
86			}
87
88			/**
89			* @param string $pattern which should match within the $searchProperties
90			* @param array $searchProperties defines the properties within the query pattern should match
91			* @param array $options - for future use. One should always have options!
92			* @return array an array of contacts which are arrays of key-value-pairs
93			* @since 5.0.0
94			*/
95			public function search($pattern, $searchProperties, $options) {
96			$results = $this->backend->search($this->getKey(), $pattern, $searchProperties);
97
98			$vCards = [];
99			foreach ($results as $result) {
100			$vCards[] = $this->vCard2Array($result['uri'], $this->readCard($result['carddata']));
101			}
102
103			return $vCards;
104			}
105
106			/**
107			* @param array $properties this array if key-value-pairs defines a contact
108			* @return array an array representing the contact just created or updated
109			* @since 5.0.0
110			*/
111			public function createOrUpdate($properties) {
112			$update = false;
113			if (!isset($properties['URI'])) { // create a new contact
114			$uid = $this->createUid();
115			$uri = $uid . '.vcf';
116			$vCard = $this->createEmptyVCard($uid);
117			} else { // update existing contact
118			$uri = $properties['URI'];
119			$vCardData = $this->backend->getCard($this->getKey(), $uri);
120			$vCard = $this->readCard($vCardData['carddata']);
121			$update = true;
122			}
123
124			foreach ($properties as $key => $value) {
125			$vCard->$key = $vCard->createProperty($key, $value);
126			}
127
128			if ($update) {
129			$this->backend->updateCard($this->getKey(), $uri, $vCard->serialize());
130			} else {
131			$this->backend->createCard($this->getKey(), $uri, $vCard->serialize());
132			}
133
134			return $this->vCard2Array($uri, $vCard);
135
136			}
137
138			/**
139			* @return mixed
140			* @since 5.0.0
141			*/
142			public function getPermissions() {
143			$permissions = $this->addressBook->getACL();
144			$result = 0;
145			foreach ($permissions as $permission) {
146			switch($permission['privilege']) {
147			case '{DAV:}read':
148			$result \|= Constants::PERMISSION_READ;
149			break;
150			case '{DAV:}write':
151			$result \|= Constants::PERMISSION_CREATE;
152			$result \|= Constants::PERMISSION_UPDATE;
153			break;
154			case '{DAV:}all':
155			$result \|= Constants::PERMISSION_ALL;
156			break;
157			}
158			}
159
160			return $result;
161			}
162
163			/**
164			* @param object $id the unique identifier to a contact
165			* @return bool successful or not
166			* @since 5.0.0
167			*/
168			public function delete($id) {
169			$uri = $this->backend->getCardUri($id);
170			return $this->backend->deleteCard($this->addressBookInfo['id'], $uri);
171			}
172
173			/**
174			* read vCard data into a vCard object
175			*
176			* @param string $cardData
177			* @return VCard
178			*/
179			protected function readCard($cardData) {
180			return Reader::read($cardData);
181			}
182
183			/**
184			* create UID for contact
185			*
186			* @return string
187			*/
188			protected function createUid() {
189			do {
190			$uid = $this->getUid();
191			$contact = $this->backend->getContact($this->getKey(), $uid . '.vcf');
192			} while (!empty($contact));
193
194			return $uid;
195			}
196
197			/**
198			* getUid is only there for testing, use createUid instead
199			*/
200			protected function getUid() {
201			return UUIDUtil::getUUID();
202			}
203
204			/**
205			* create empty vcard
206			*
207			* @param string $uid
208			* @return VCard
209			*/
210			protected function createEmptyVCard($uid) {
211			$vCard = new VCard();
212			$vCard->add(new Text($vCard, 'UID', $uid));
213			return $vCard;
214			}
215
216			/**
217			* create array with all vCard properties
218			*
219			* @param string $uri
220			* @param VCard $vCard
221			* @return array
222			*/
223			protected function vCard2Array($uri, VCard $vCard) {
224			$result = [
225			'URI' => $uri,
226			];
227
228			foreach ($vCard->children as $property) {
229			/** @var \Sabre\VObject\Property\Unknown $property */
230			if ($property->name === 'PHOTO' && $property->getValueType() === 'BINARY') {
231			$url = $this->urlGenerator->getAbsoluteURL(
232			$this->urlGenerator->linkTo('', 'remote.php') . '/dav/');
233			$url .= implode('/', [
234			'addressbooks',
235			substr($this->addressBookInfo['principaluri'], 11), //cut off 'principals/'
236			$this->addressBookInfo['uri'],
237			$uri
238			]) . '?photo';
239
240			$result['PHOTO'] = 'VALUE=uri:' . $url;
241
242			} else if ($property->name === 'X-SOCIALPROFILE') {
243			$type = $this->getTypeFromProperty($property);
244
245			// Type is the social network, when it's empty we don't need this.
246			if ($type !== null) {
247			if (!isset($result[$property->name])) {
248			$result[$property->name] = [];
249			}
250			$result[$property->name][$type] = $property->getValue();
251			}
252
253			// The following properties can be set multiple times
254			} else if (in_array($property->name, ['CLOUD', 'EMAIL', 'IMPP', 'TEL', 'URL'])) {
255			if (!isset($result[$property->name])) {
256			$result[$property->name] = [];
257			}
258
259			$result[$property->name][] = $property->getValue();
260
261			} else {
262			$result[$property->name] = $property->getValue();
263			}
264			}
265
266			if ($this->addressBookInfo['principaluri'] === 'principals/system/system' &&
267			$this->addressBookInfo['uri'] === 'system') {
268			$result['isLocalSystemBook'] = true;
269			}
270			return $result;
271			}
272
273			/**
274			* Get the type of the current property
275			*
276			* @param Property $property
277			* @return null\|string
278			*/
279			protected function getTypeFromProperty(Property $property) {
280			$parameters = $property->parameters();
281			// Type is the social network, when it's empty we don't need this.
282			if (isset($parameters['TYPE'])) {
283			/** @var \Sabre\VObject\Parameter $type */
284			$type = $parameters['TYPE'];
285			return $type->getValue();
286			}
287
288			return null;
289			}
290			}
291

nextcloud / server

Push — stable10 ( 782c31...5fae9e )

AddressBookImpl::vCard2Array() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like