AddressbookProvider - Code Metrics - owncloud/contacts - Measure and Improve Code Quality continuously with Scrutinizer

AddressbookProvider A
last analyzed 2016-02-29 12:21 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	232
Duplicated Lines	4.31 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

46.28%

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
wmc	27
c	1
b	1
f	0
lcom	2
cbo	4
dl	10
loc	232
ccs	56
cts	121
cp	0.4628
rs	10

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getAddressbook()	0	3	1
A	getKey()	0	4	1
A	getDisplayName()	0	3	1
A	getPermissions()	0	3	1
A	convertToSearchResult()	0	20	4
C	search()	5	84	8
B	createOrUpdate()	0	28	6
B	delete()	5	23	4

How to fix Duplicated Code

<?php
/**
 * ownCloud - AddressbookProvider
 *
 * @author Thomas Tanghus
 * @copyright 2012-2014 Thomas Tanghus ([email protected])
 *
 * 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;
use OCA\Contacts\Utils\JSONSerializer;
use OCA\Contacts\Utils\Properties;
use OCA\Contacts\VObject\VCard;

/**
 * This class manages our addressbooks.
 * TODO: Port this to use the new backend
 */
class AddressbookProvider implements \OCP\IAddressBook {

	const CONTACT_TABLE = '*PREFIX*contacts_cards';
	const PROPERTY_TABLE = '*PREFIX*contacts_cards_properties';
	const ADDRESSBOOK_TABLE = '*PREFIX*contacts_addressbooks';

	/**
	 * Addressbook id
	 * @var integer
	 */
	public $id;
	
	/**
	 * Addressbook info array
	 * @var AddressBook
	 */
	public $addressBook;

	/**
	 * Constructor
	 * @param AddressBook $addressBook
	 */
	public function __construct($addressBook) {
		$this->addressBook = $addressBook;
		$this->app = new App();
	}
	
	public function getAddressbook() {
		return $this->addressBook;
	}
	
	/**
	* @return string defining the technical unique key
	*/
	public function getKey() {
		$metaData = $this->addressBook->getMetaData();
		return $metaData['backend'].':'.$metaData['id'];
	}

	/**
	* In comparison to getKey() this function returns a human readable (maybe translated) name
	* @return string
	*/
	public function getDisplayName() {
		return $this->addressBook->getDisplayName();
	}

	/**
	* @return integer
	*/
	public function getPermissions() {
		return $this->addressBook->getPermissions();
	}

	/**
	* @param string $pattern
	* @param string[] $searchProperties
	* @param $options
	* @return array|false
	*/
	public function search($pattern, $searchProperties, $options) {
		$propTable = self::PROPERTY_TABLE;
		$contTable = self::CONTACT_TABLE;
		$addrTable = self::ADDRESSBOOK_TABLE;
		$results = array();

		/**
		 * This query will fetch all contacts which match the $searchProperties
		 * It will look up the addressbookid of the contact and the user id of the owner of the contact app
		 */
		$query = <<<SQL
			SELECT
				DISTINCT
				`$propTable`.`contactid`,
				`$contTable`.`addressbookid`,
				`$addrTable`.`userid`

			FROM
				`$propTable`
			INNER JOIN
				`$contTable`
			ON `$contTable`.`id` = `$propTable`.`contactid`
  				INNER JOIN `$addrTable`
			ON `$addrTable`.id = `$contTable`.addressbookid
			WHERE
				(`$contTable`.addressbookid = ?) AND
				(
SQL;

		$params = array();
		$params[] = $this->addressBook->getMetaData()['id'];		
		foreach ($searchProperties as $property) {
			$params[] = $property;
			$params[] = '%' . $pattern . '%';
			$query .= '(`name` = ? AND `value` ILIKE ?) OR ';
		}
		$query = substr($query, 0, strlen($query) - 4);
		$query .= ')';

		$stmt = \OCP\DB::prepare($query);
		$result = $stmt->execute($params);
		if (\OCP\DB::isError($result)) {

			\OCP\Util::writeLog('contacts', __METHOD__ . 'DB error: ' . \OC_DB::getErrorMessage($result),
				\OCP\Util::ERROR);
			return false;
		}
		while ($row = $result->fetchRow()) {
			$id = $row['contactid'];
			$addressbookKey = $row['addressbookid'];
			// Check if we are the owner of the contact
			if ($row['userid'] !== \OC::$server->getUserSession()->getUser()->getUId()) {
				// we aren't the owner of the contact
				try {
					// it is possible that the contact is shared with us
					// if so, $contact will be an object
					// if not getContact will throw an Exception
					$contact = $this->app->getContact('shared', $addressbookKey, $id);
				} catch (\Exception $e){
					// the contact isn't shared with us
					$contact = null;
				}
			} else {
				// We are the owner of the contact
				// thus we can easily fetch it
				$contact = $this->app->getContact('local', $addressbookKey, $id);
			}
			if ($contact !== null) {
				$j = JSONSerializer::serializeContact($contact);
				$j['data']['id'] = $id;
				if (isset($contact->PHOTO)) {
					$url = \OCP\Util::linkToRoute('contacts_contact_photo',
						array(
							'backend' => $contact->getBackend()->name,
							'addressBookId' => $addressbookKey,
							'contactId' => $contact->getId()
						));
					$url = \OC::$server->getURLGenerator()->getAbsoluteURL($url);
					$j['data']['PHOTO'] = "VALUE=uri:$url";
				}
				$results[] = $this->convertToSearchResult($j);
			}
		}
		return $results;
	}

	/**
	* @param $properties
	* @return Contact|null
	*/
	public function createOrUpdate($properties) {
		$addressBook = $this->getAddressbook();

		if(array_key_exists('id', $properties)) {
			// we must "update" the contact by replacing the entire data set
			$id = $properties['id'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$contact = $this->addressBook->getChild($properties['id']);
			foreach(array_keys($properties) as $name) {
				if(isset($contact->{$name})) {
					unset($contact->{$name});
				 }
			}
		} else {
			// the contact doesn't exist
			// we must create a new one
			try {
				$id = $addressBook->addChild();
			} catch(\Exception $e) {

			}
			$contact = $addressBook->getChild($id);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}

		foreach($properties as $name => $value) {
			$contact->setPropertyByName($name, $value);
		}
		$contact->save();
		return $contact;
	}

	/**
	* @param $id
	* @return mixed
	*/
	public function delete($id) {
		try {
			$query = 'SELECT COUNT(*) as `count` FROM `*PREFIX*contacts_cards` WHERE `id` = ? AND `addressbookid` = ?';
			$stmt = \OCP\DB::prepare($query);
			$result = $stmt->execute(array($id, $this->id));
			if (\OCP\DB::isError($result)) {

				\OCP\Util::writeLog('contacts', __METHOD__ . 'DB error: ' . \OC_DB::getErrorMessage($result),
					\OCP\Util::ERROR);
				return false;
			}
			if((int)$result['count'] === 0) {
				\OCP\Util::writeLog('contacts', __METHOD__
					. 'Contact with id ' . $id . 'doesn\'t belong to addressbook with id ' . $this->id,
					\OCP\Util::ERROR);
				return false;
			}
		} catch(\Exception $e) {
			\OCP\Util::writeLog('contacts', __METHOD__ . ', exception: ' . $e->getMessage(),
				\OCP\Util::ERROR);
			return false;
		}
		return VCard::delete($id);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	/**
	 * @param $j
	 * @return array
	 */
	private function convertToSearchResult($j) {
		$data = $j['data'];
		$result = array();
		foreach( $data as $key => $d) {
			$d = $data[$key];
			if (in_array($key, Properties::$multiProperties)) {
				$result[$key] = array_map(function($v){
					return $v['value'];
				}, $d);
			} else {
				if (is_array($d)) {
					$result[$key] = $d[0]['value'];
				} else {
					$result[$key] = $d;
				}
			}
		}

		return $result;
	}

}


1			<?php
2			/**
3			* ownCloud - AddressbookProvider
4			*
5			* @author Thomas Tanghus
6			* @copyright 2012-2014 Thomas Tanghus ([email protected])
7			*
8			* This library is free software; you can redistribute it and/or
9			* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10			* License as published by the Free Software Foundation; either
11			* version 3 of the License, or any later version.
12			*
13			* This library is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public
19			* License along with this library. If not, see <http://www.gnu.org/licenses/>.
20			*
21			*/
22
23			namespace OCA\Contacts;
24			use OCA\Contacts\Utils\JSONSerializer;
25			use OCA\Contacts\Utils\Properties;
26			use OCA\Contacts\VObject\VCard;
27
28			/**
29			* This class manages our addressbooks.
30			* TODO: Port this to use the new backend
31			*/
32			class AddressbookProvider implements \OCP\IAddressBook {
33
34			const CONTACT_TABLE = 'PREFIXcontacts_cards';
35			const PROPERTY_TABLE = 'PREFIXcontacts_cards_properties';
36			const ADDRESSBOOK_TABLE = 'PREFIXcontacts_addressbooks';
37
38			/**
39			* Addressbook id
40			* @var integer
41			*/
42			public $id;
43
44			/**
45			* Addressbook info array
46			* @var AddressBook
47			*/
48			public $addressBook;
49
50			/**
51			* Constructor
52			* @param AddressBook $addressBook
53			*/
54	2		public function __construct($addressBook) {
55	2		$this->addressBook = $addressBook;
56	2		$this->app = new App();
57	2		}
58
59			public function getAddressbook() {
60			return $this->addressBook;
61			}
62
63			/**
64			* @return string defining the technical unique key
65			*/
66			public function getKey() {
67			$metaData = $this->addressBook->getMetaData();
68			return $metaData['backend'].':'.$metaData['id'];
69			}
70
71			/**
72			* In comparison to getKey() this function returns a human readable (maybe translated) name
73			* @return string
74			*/
75			public function getDisplayName() {
76			return $this->addressBook->getDisplayName();
77			}
78
79			/**
80			* @return integer
81			*/
82			public function getPermissions() {
83			return $this->addressBook->getPermissions();
84			}
85
86			/**
87			* @param string $pattern
88			* @param string[] $searchProperties
89			* @param $options
90			* @return array\|false
91			*/
92	2		public function search($pattern, $searchProperties, $options) {
93	2		$propTable = self::PROPERTY_TABLE;
94	2		$contTable = self::CONTACT_TABLE;
95	2		$addrTable = self::ADDRESSBOOK_TABLE;
96	2		$results = array();
97
98			/**
99			* This query will fetch all contacts which match the $searchProperties
100			* It will look up the addressbookid of the contact and the user id of the owner of the contact app
101			*/
102			$query = <<<SQL
103			SELECT
104			DISTINCT
105			`$propTable`.`contactid`,
106	2		`$contTable`.`addressbookid`,
107	2		`$addrTable`.`userid`
108
109			FROM
110	2		`$propTable`
111			INNER JOIN
112	2		`$contTable`
113	2		ON `$contTable`.`id` = `$propTable`.`contactid`
114	2		INNER JOIN `$addrTable`
115	2		ON `$addrTable`.id = `$contTable`.addressbookid
116			WHERE
117	2		(`$contTable`.addressbookid = ?) AND
118	2		(
119	2		SQL;
120
121	2		$params = array();
122	2		$params[] = $this->addressBook->getMetaData()['id'];
123	2		foreach ($searchProperties as $property) {
124	2		$params[] = $property;
125	2		$params[] = '%' . $pattern . '%';
126	2		$query .= '(`name` = ? AND `value` ILIKE ?) OR ';
127	2		}
128	2		$query = substr($query, 0, strlen($query) - 4);
129	2		$query .= ')';
130
131	2		$stmt = \OCP\DB::prepare($query);
132	2		$result = $stmt->execute($params);
133	2	View Code Duplication	if (\OCP\DB::isError($result)) {
			0 ignored issues – show Duplication introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
134			\OCP\Util::writeLog('contacts', __METHOD__ . 'DB error: ' . \OC_DB::getErrorMessage($result),
135			\OCP\Util::ERROR);
136			return false;
137			}
138	2		while ($row = $result->fetchRow()) {
139	2		$id = $row['contactid'];
140	2		$addressbookKey = $row['addressbookid'];
141			// Check if we are the owner of the contact
142	2		if ($row['userid'] !== \OC::$server->getUserSession()->getUser()->getUId()) {
143			// we aren't the owner of the contact
144			try {
145			// it is possible that the contact is shared with us
146			// if so, $contact will be an object
147			// if not getContact will throw an Exception
148			$contact = $this->app->getContact('shared', $addressbookKey, $id);
149			} catch (\Exception $e){
150			// the contact isn't shared with us
151			$contact = null;
152			}
153			} else {
154			// We are the owner of the contact
155			// thus we can easily fetch it
156	2		$contact = $this->app->getContact('local', $addressbookKey, $id);
157			}
158	2		if ($contact !== null) {
159	2		$j = JSONSerializer::serializeContact($contact);
160	2		$j['data']['id'] = $id;
161	2		if (isset($contact->PHOTO)) {
162			$url = \OCP\Util::linkToRoute('contacts_contact_photo',
163			array(
164			'backend' => $contact->getBackend()->name,
165			'addressBookId' => $addressbookKey,
166			'contactId' => $contact->getId()
167			));
168			$url = \OC::$server->getURLGenerator()->getAbsoluteURL($url);
169			$j['data']['PHOTO'] = "VALUE=uri:$url";
170			}
171	2		$results[] = $this->convertToSearchResult($j);
172	2		}
173	2		}
174	2		return $results;
175			}
176
177			/**
178			* @param $properties
179			* @return Contact\|null
180			*/
181			public function createOrUpdate($properties) {
182			$addressBook = $this->getAddressbook();
183
184			if(array_key_exists('id', $properties)) {
185			// we must "update" the contact by replacing the entire data set
186			$id = $properties['id'];
			0 ignored issues – show Unused Code introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report `$id` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
187			$contact = $this->addressBook->getChild($properties['id']);
188			foreach(array_keys($properties) as $name) {
189			if(isset($contact->{$name})) {
190			unset($contact->{$name});
191			}
192			}
193			} else {
194			// the contact doesn't exist
195			// we must create a new one
196			try {
197			$id = $addressBook->addChild();
198			} catch(\Exception $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
199			}
200			$contact = $addressBook->getChild($id);
			0 ignored issues – show Bug introduced 2016-02-10 05:51 UTC by Report Bug Copy Issue Report It seems like `$id` defined by `$addressBook->addChild()` on line `197` can also be of type `false` or `null`; however, `OCA\Contacts\Addressbook::getChild()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
201			}
202
203			foreach($properties as $name => $value) {
204			$contact->setPropertyByName($name, $value);
205			}
206			$contact->save();
207			return $contact;
208			}
209
210			/**
211			* @param $id
212			* @return mixed
213			*/
214			public function delete($id) {
215			try {
216			$query = 'SELECT COUNT() as `count` FROM `PREFIX*contacts_cards` WHERE `id` = ? AND `addressbookid` = ?';
217			$stmt = \OCP\DB::prepare($query);
218			$result = $stmt->execute(array($id, $this->id));
219		View Code Duplication	if (\OCP\DB::isError($result)) {
			0 ignored issues – show Duplication introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
220			\OCP\Util::writeLog('contacts', __METHOD__ . 'DB error: ' . \OC_DB::getErrorMessage($result),
221			\OCP\Util::ERROR);
222			return false;
223			}
224			if((int)$result['count'] === 0) {
225			\OCP\Util::writeLog('contacts', __METHOD__
226			. 'Contact with id ' . $id . 'doesn\'t belong to addressbook with id ' . $this->id,
227			\OCP\Util::ERROR);
228			return false;
229			}
230			} catch(\Exception $e) {
231			\OCP\Util::writeLog('contacts', __METHOD__ . ', exception: ' . $e->getMessage(),
232			\OCP\Util::ERROR);
233			return false;
234			}
235			return VCard::delete($id);
			0 ignored issues – show Bug introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `OCA\Contacts\VObject\VCard` as the method `delete()` does only exist in the following sub-classes of `OCA\Contacts\VObject\VCard`: `OCA\Contacts\Contact`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
236			}
237
238			/**
239			* @param $j
240			* @return array
241			*/
242	2		private function convertToSearchResult($j) {
243	2		$data = $j['data'];
244	2		$result = array();
245	2		foreach( $data as $key => $d) {
246	2		$d = $data[$key];
247	2		if (in_array($key, Properties::$multiProperties)) {
248			$result[$key] = array_map(function($v){
249			return $v['value'];
250			}, $d);
251			} else {
252	2		if (is_array($d)) {
253	2		$result[$key] = $d[0]['value'];
254	2		} else {
255	2		$result[$key] = $d;
256			}
257			}
258	2		}
259
260	2		return $result;
261			}
262
263			}
264

owncloud / contacts

AddressbookProvider A last analyzed 2016-02-29 12:21 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

AddressbookProvider A
last analyzed 2016-02-29 12:21 UTC