PersonMapper::isFaceInClusters() - Code Metrics - Inspection of "Adding more tests for create clusters" - matiasdelellis/facerecognition - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — create-clusters-test ( 0b8e8a...19354b )

by Branko

created 2019-04-06 13:49 UTC

PersonMapper::isFaceInClusters() A

↳ Parent: PersonMapper

Complexity

Conditions	3
Paths	3

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	4
nc	3
nop	2
dl	0
loc	7
ccs	5
cts	5
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2017, Matias De lellis <[email protected]>
 * @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
 *
 * @author Branko Kokanovic <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\FaceRecognition\Db;

use OC\DB\QueryBuilder\Literal;
filter:
    dependency_paths: ["lib/*"]

use OCP\IDBConnection;
use OCP\IUser;

use OCP\AppFramework\Db\QBMapper;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\DB\QueryBuilder\IQueryBuilder;

class PersonMapper extends QBMapper {

	public function __construct(IDBConnection $db) {
		parent::__construct($db, 'face_recognition_persons', '\OCA\FaceRecognition\Db\Person');
	}


	public function find(string $userId, int $personId): Person {
		$qb = $this->db->getQueryBuilder();
		$qb->select('id', 'name')
			->from('face_recognition_persons', 'p')
			->where($qb->expr()->eq('id', $qb->createNamedParameter($personId)))
			->andWhere($qb->expr()->eq('user', $qb->createNamedParameter($userId)));
		$person = $this->findEntity($qb);
		return $person;

	}

	public function findAll(string $userId): array {
		$qb = $this->db->getQueryBuilder();
		$qb->select('id', 'name')
			->from('face_recognition_persons', 'p')
			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)));

		$person = $this->findEntities($qb);
		return $person;
	}

	/**
	 * Returns count of persons (clusters) found for a given user.
	 *
	 * @param string $userId ID of the user
	 * @param bool $onlyInvalid True if client wants count of invalid persons only,
	 *  false if client want count of all persons
	 * @return int Count of persons
	 */
	public function countPersons(string $userId, bool $onlyInvalid=false): int {
		$qb = $this->db->getQueryBuilder();
		$qb = $qb
			->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
			->from($this->getTableName())
			->where($qb->expr()->eq('user', $qb->createParameter('user')));
		if ($onlyInvalid) {
			$qb = $qb
				->andWhere($qb->expr()->eq('is_valid', $qb->createParameter('is_valid')))
				->setParameter('is_valid', false, IQueryBuilder::PARAM_BOOL);
		}
		$query = $qb->setParameter('user', $userId);
		$resultStatement = $query->execute();
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
		$resultStatement->closeCursor();

		return (int)$data[0];
	}

	/**
	 * Based on a given fileId, takes all person that belong to that image
	 * and return an array with that.
	 *
	 * @param string $userId ID of the user that clusters belong to
	 * @param int $fileId ID of file image for which to searh persons.
	 *
	 * @return array of persons
	 */
	public function findFromFile(string $userId, int $fileId): array {
		$qb = $this->db->getQueryBuilder();
		$qb->select('p.id', 'name');
		$qb->from("face_recognition_persons", "p")
			->innerJoin('p', 'face_recognition_faces' ,'f', $qb->expr()->eq('p.id', 'f.person'))
			->innerJoin('p', 'face_recognition_images' ,'i', $qb->expr()->eq('i.id', 'f.image'))
			->where($qb->expr()->eq('p.user', $qb->createNamedParameter($userId)))
			->andWhere($qb->expr()->eq('i.file', $qb->createNamedParameter($fileId)));
		$persons = $this->findEntities($qb);

		return $persons;
	}

	/**
	 * Based on a given image, takes all faces that belong to that image
	 * and invalidates all person that those faces belongs to.
	 *
	 * @param int $imageId ID of image for which to invalidate persons for
	 */
	public function invalidatePersons(int $imageId) {
		$sub = $this->db->getQueryBuilder();
		$tableNameWithPrefixWithoutQuotes = trim($sub->getTableName($this->getTableName()), '`');
		$sub->select(new Literal('1'));
		$sub->from("face_recognition_images", "i")
			->innerJoin('i', 'face_recognition_faces' ,'f', $sub->expr()->eq('i.id', 'f.image'))
			->where($sub->expr()->eq($tableNameWithPrefixWithoutQuotes . '.id', 'f.person'))
			->andWhere($sub->expr()->eq('i.id', $sub->createParameter('image_id')));

		$qb = $this->db->getQueryBuilder();
		$qb->update($this->getTableName())
			->set("is_valid", $qb->createParameter('is_valid'))
			->where('EXISTS (' . $sub->getSQL() . ')')
			->setParameter('image_id', $imageId)
			->setParameter('is_valid', false, IQueryBuilder::PARAM_BOOL)
			->execute();
	}

	/**
	 * Updates one face with $faceId to database to person ID $personId.
	 *
	 * @param int $faceId ID of the face
	 * @param int|null $personId ID of the person
	 */
	private function updateFace(int $faceId, $personId) {
		$qb = $this->db->getQueryBuilder();
		$qb->update('face_recognition_faces')
			->set("person", $qb->createNamedParameter($personId))
			->where($qb->expr()->eq('id', $qb->createNamedParameter($faceId)))
			->execute();
	}

	/**
	 * Based on current clusters and new clusters, do database reconciliation.
	 * It tries to do that in minimal number of SQL queries. Operation is atomic.
	 *
	 * Clusters are array, where keys are ID of persons, and values are indexed arrays
	 * with values that are ID of the faces for those persons.
	 *
	 * @param string $userId ID of the user that clusters belong to
	 * @param array $currentClusters Current clusters
	 * @param array $newClusters New clusters
	 */
	public function mergeClusterToDatabase(string $userId, $currentClusters, $newClusters) {
		$this->db->beginTransaction();
		$currentDateTime = new \DateTime();

		try {
			// Delete clusters that do not exist anymore
			foreach($currentClusters as $oldPerson => $oldFaces) {
				if (array_key_exists($oldPerson, $newClusters)) {
					continue;
				}

				// OK, we bumped into cluster that existed and now it does not exist.
				// We need to remove all references to it and to delete it.
				foreach ($oldFaces as $oldFace) {
					$this->updateFace($oldFace, null);
				}

				// todo: this is not very cool. What if user had associated linked user to this. And all lost?
				$qb = $this->db->getQueryBuilder();
				// todo: for extra safety, we should probably add here additional condition, where (user=$userId)
				$qb
					->delete($this->getTableName())
					->where($qb->expr()->eq('id', $qb->createNamedParameter($oldPerson)))
					->execute();
			}

			// Modify existing clusters
			foreach($newClusters as $newPerson=>$newFaces) {
				if (!array_key_exists($newPerson, $currentClusters)) {
					// This cluster didn't exist, there is nothing to modify
					// It will be processed during cluster adding operation
					continue;
				}

				$oldFaces = $currentClusters[$newPerson];
				if ($newFaces === $oldFaces) {
					continue;
				}

				// OK, set of faces do differ. Now, we could potentially go into finer grain details
				// and add/remove each individual face, but this seems too detailed. Enough is to
				// reset all existing faces to null and to add new faces to new person. That should
				// take care of both faces that are removed from cluster, as well as for newly added
				// faces to this cluster.

				// First remove all old faces from any cluster (reset them to null)
				foreach ($oldFaces as $oldFace) {
					// Reset face to null only if it wasn't moved to other cluster!
					// (if face is just moved to other cluster, do not reset to null, as some other
					// pass for some other cluster will eventually update it to proper cluster)
					if ($this->isFaceInClusters($oldFace, $newClusters) === false) {
						$this->updateFace($oldFace, null);
					}
				}

				// Then set all new faces to belong to this cluster
				foreach ($newFaces as $newFace) {
					$this->updateFace($newFace, $newPerson);
				}
			}

			// Add new clusters
			foreach($newClusters as $newPerson=>$newFaces) {
				if (array_key_exists($newPerson, $currentClusters)) {
					// This cluster already existed, nothing to add
					// It was already processed during modify cluster operation
					continue;
				}

				// Create new cluster and add all faces to it
				$qb = $this->db->getQueryBuilder();
				$qb
					->insert($this->getTableName())
					->values([
						'user' => $qb->createNamedParameter($userId),
						'name' => $qb->createNamedParameter(sprintf("New person %d", $newPerson)),
						'is_valid' => $qb->createNamedParameter(true),
						'last_generation_time' => $qb->createNamedParameter($currentDateTime, IQueryBuilder::PARAM_DATE),
						'linked_user' => $qb->createNamedParameter(null)])
					->execute();
				$insertedPersonId = $this->db->lastInsertId($this->getTableName());
				foreach ($newFaces as $newFace) {
					$this->updateFace($newFace, $insertedPersonId);
				}
			}

			$this->db->commit();
		} catch (\Exception $e) {
			$this->db->rollBack();
			throw $e;
		}
	}

	/**
	 * Deletes all persons from that user.
	 *
	 * @param string $userId User to drop persons from a table.
	 */
	public function deleteUserPersons(string $userId) {
		$qb = $this->db->getQueryBuilder();
		$qb->delete($this->getTableName())
			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
			->execute();
	}

	/**
	 * Checks if face with a given ID is in any cluster.
	 *
	 * @param int $faceId ID of the face to check
	 * @param array $cluster All clusters to check into
	 *
	 * @return bool True if face is found in any cluster, false otherwise.
	 */
	private function isFaceInClusters(int $faceId, array $clusters): bool {
		foreach ($clusters as $_=>$faces) {
			if (in_array($faceId, $faces)) {
				return true;
			}
		}
		return false;
	}
}


1		<?php
2		/**
3		* @copyright Copyright (c) 2017, Matias De lellis <[email protected]>
4		* @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
5		*
6		* @author Branko Kokanovic <[email protected]>
7		*
8		* @license GNU AGPL version 3 or any later version
9		*
10		* This program is free software: you can redistribute it and/or modify
11		* it under the terms of the GNU Affero General Public License as
12		* published by the Free Software Foundation, either version 3 of the
13		* License, or (at your option) any later version.
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
21		* along with this program. If not, see <http://www.gnu.org/licenses/>.
22		*
23		*/
24		namespace OCA\FaceRecognition\Db;
25
26		use OC\DB\QueryBuilder\Literal;
		0 ignored issues – show Bug introduced 2018-11-21 10:16 UTC by Report Bug Copy Issue Report The type `OC\DB\QueryBuilder\Literal` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
27
28		use OCP\IDBConnection;
29		use OCP\IUser;
30
31		use OCP\AppFramework\Db\QBMapper;
32		use OCP\AppFramework\Db\DoesNotExistException;
33		use OCP\DB\QueryBuilder\IQueryBuilder;
34
35		class PersonMapper extends QBMapper {
36
37	26	public function __construct(IDBConnection $db) {
38	26	parent::__construct($db, 'face_recognition_persons', '\OCA\FaceRecognition\Db\Person');
39	26	}
40
41
42	8	public function find(string $userId, int $personId): Person {
43	8	$qb = $this->db->getQueryBuilder();
44	8	$qb->select('id', 'name')
45	8	->from('face_recognition_persons', 'p')
46	8	->where($qb->expr()->eq('id', $qb->createNamedParameter($personId)))
47	8	->andWhere($qb->expr()->eq('user', $qb->createNamedParameter($userId)));
48	8	$person = $this->findEntity($qb);
49	5	return $person;
		0 ignored issues – show Bug Best Practice introduced 2018-12-04 18:24 UTC by Report Bug Copy Issue Report The expression `return $person` returns the type `OCP\AppFramework\Db\Entity` which includes types incompatible with the type-hinted return `OCA\FaceRecognition\Db\Person`. Loading history...
50		}
51
52	13	public function findAll(string $userId): array {
53	13	$qb = $this->db->getQueryBuilder();
54	13	$qb->select('id', 'name')
55	13	->from('face_recognition_persons', 'p')
56	13	->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)));
57
58	13	$person = $this->findEntities($qb);
59	13	return $person;
60		}
61
62		/**
63		* Returns count of persons (clusters) found for a given user.
64		*
65		* @param string $userId ID of the user
66		* @param bool $onlyInvalid True if client wants count of invalid persons only,
67		* false if client want count of all persons
68		* @return int Count of persons
69		*/
70	15	public function countPersons(string $userId, bool $onlyInvalid=false): int {
71	15	$qb = $this->db->getQueryBuilder();
72		$qb = $qb
73	15	->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
74	15	->from($this->getTableName())
75	15	->where($qb->expr()->eq('user', $qb->createParameter('user')));
76	15	if ($onlyInvalid) {
77		$qb = $qb
78		->andWhere($qb->expr()->eq('is_valid', $qb->createParameter('is_valid')))
79		->setParameter('is_valid', false, IQueryBuilder::PARAM_BOOL);
80		}
81	15	$query = $qb->setParameter('user', $userId);
82	15	$resultStatement = $query->execute();
83	15	$data = $resultStatement->fetch(\PDO::FETCH_NUM);
84	15	$resultStatement->closeCursor();
85
86	15	return (int)$data[0];
87		}
88
89		/**
90		* Based on a given fileId, takes all person that belong to that image
91		* and return an array with that.
92		*
93		* @param string $userId ID of the user that clusters belong to
94		* @param int $fileId ID of file image for which to searh persons.
95		*
96		* @return array of persons
97		*/
98		public function findFromFile(string $userId, int $fileId): array {
99		$qb = $this->db->getQueryBuilder();
100		$qb->select('p.id', 'name');
101		$qb->from("face_recognition_persons", "p")
102		->innerJoin('p', 'face_recognition_faces' ,'f', $qb->expr()->eq('p.id', 'f.person'))
103		->innerJoin('p', 'face_recognition_images' ,'i', $qb->expr()->eq('i.id', 'f.image'))
104		->where($qb->expr()->eq('p.user', $qb->createNamedParameter($userId)))
105		->andWhere($qb->expr()->eq('i.file', $qb->createNamedParameter($fileId)));
106		$persons = $this->findEntities($qb);
107
108		return $persons;
109		}
110
111		/**
112		* Based on a given image, takes all faces that belong to that image
113		* and invalidates all person that those faces belongs to.
114		*
115		* @param int $imageId ID of image for which to invalidate persons for
116		*/
117	2	public function invalidatePersons(int $imageId) {
118	2	$sub = $this->db->getQueryBuilder();
119	2	$tableNameWithPrefixWithoutQuotes = trim($sub->getTableName($this->getTableName()), '`');
120	2	$sub->select(new Literal('1'));
121	2	$sub->from("face_recognition_images", "i")
122	2	->innerJoin('i', 'face_recognition_faces' ,'f', $sub->expr()->eq('i.id', 'f.image'))
123	2	->where($sub->expr()->eq($tableNameWithPrefixWithoutQuotes . '.id', 'f.person'))
124	2	->andWhere($sub->expr()->eq('i.id', $sub->createParameter('image_id')));
125
126	2	$qb = $this->db->getQueryBuilder();
127	2	$qb->update($this->getTableName())
128	2	->set("is_valid", $qb->createParameter('is_valid'))
129	2	->where('EXISTS (' . $sub->getSQL() . ')')
130	2	->setParameter('image_id', $imageId)
131	2	->setParameter('is_valid', false, IQueryBuilder::PARAM_BOOL)
132	2	->execute();
133	2	}
134
135		/**
136		* Updates one face with $faceId to database to person ID $personId.
137		*
138		* @param int $faceId ID of the face
139		* @param int\|null $personId ID of the person
140		*/
141	12	private function updateFace(int $faceId, $personId) {
142	12	$qb = $this->db->getQueryBuilder();
143	12	$qb->update('face_recognition_faces')
144	12	->set("person", $qb->createNamedParameter($personId))
145	12	->where($qb->expr()->eq('id', $qb->createNamedParameter($faceId)))
146	12	->execute();
147	12	}
148
149		/**
150		* Based on current clusters and new clusters, do database reconciliation.
151		* It tries to do that in minimal number of SQL queries. Operation is atomic.
152		*
153		* Clusters are array, where keys are ID of persons, and values are indexed arrays
154		* with values that are ID of the faces for those persons.
155		*
156		* @param string $userId ID of the user that clusters belong to
157		* @param array $currentClusters Current clusters
158		* @param array $newClusters New clusters
159		*/
160	14	public function mergeClusterToDatabase(string $userId, $currentClusters, $newClusters) {
161	14	$this->db->beginTransaction();
162	14	$currentDateTime = new \DateTime();
163
164		try {
165		// Delete clusters that do not exist anymore
166	14	foreach($currentClusters as $oldPerson => $oldFaces) {
167	11	if (array_key_exists($oldPerson, $newClusters)) {
168	6	continue;
169		}
170
171		// OK, we bumped into cluster that existed and now it does not exist.
172		// We need to remove all references to it and to delete it.
173	7	foreach ($oldFaces as $oldFace) {
174	7	$this->updateFace($oldFace, null);
175		}
176
177		// todo: this is not very cool. What if user had associated linked user to this. And all lost?
178	7	$qb = $this->db->getQueryBuilder();
179		// todo: for extra safety, we should probably add here additional condition, where (user=$userId)
180		$qb
181	7	->delete($this->getTableName())
182	7	->where($qb->expr()->eq('id', $qb->createNamedParameter($oldPerson)))
183	7	->execute();
184		}
185
186		// Modify existing clusters
187	14	foreach($newClusters as $newPerson=>$newFaces) {
188	12	if (!array_key_exists($newPerson, $currentClusters)) {
189		// This cluster didn't exist, there is nothing to modify
190		// It will be processed during cluster adding operation
191	9	continue;
192		}
193
194	6	$oldFaces = $currentClusters[$newPerson];
195	6	if ($newFaces === $oldFaces) {
196	2	continue;
197		}
198
199		// OK, set of faces do differ. Now, we could potentially go into finer grain details
200		// and add/remove each individual face, but this seems too detailed. Enough is to
201		// reset all existing faces to null and to add new faces to new person. That should
202		// take care of both faces that are removed from cluster, as well as for newly added
203		// faces to this cluster.
204
205		// First remove all old faces from any cluster (reset them to null)
206	5	foreach ($oldFaces as $oldFace) {
207		// Reset face to null only if it wasn't moved to other cluster!
208		// (if face is just moved to other cluster, do not reset to null, as some other
209		// pass for some other cluster will eventually update it to proper cluster)
210	5	if ($this->isFaceInClusters($oldFace, $newClusters) === false) {
211	1	$this->updateFace($oldFace, null);
212		}
213		}
214
215		// Then set all new faces to belong to this cluster
216	5	foreach ($newFaces as $newFace) {
217	5	$this->updateFace($newFace, $newPerson);
218		}
219		}
220
221		// Add new clusters
222	14	foreach($newClusters as $newPerson=>$newFaces) {
223	12	if (array_key_exists($newPerson, $currentClusters)) {
224		// This cluster already existed, nothing to add
225		// It was already processed during modify cluster operation
226	6	continue;
227		}
228
229		// Create new cluster and add all faces to it
230	9	$qb = $this->db->getQueryBuilder();
231		$qb
232	9	->insert($this->getTableName())
233	9	->values([
234	9	'user' => $qb->createNamedParameter($userId),
235	9	'name' => $qb->createNamedParameter(sprintf("New person %d", $newPerson)),
236	9	'is_valid' => $qb->createNamedParameter(true),
237	9	'last_generation_time' => $qb->createNamedParameter($currentDateTime, IQueryBuilder::PARAM_DATE),
238	9	'linked_user' => $qb->createNamedParameter(null)])
239	9	->execute();
240	9	$insertedPersonId = $this->db->lastInsertId($this->getTableName());
241	9	foreach ($newFaces as $newFace) {
242	9	$this->updateFace($newFace, $insertedPersonId);
243		}
244		}
245
246	14	$this->db->commit();
247		} catch (\Exception $e) {
248		$this->db->rollBack();
249		throw $e;
250		}
251	14	}
252
253		/**
254		* Deletes all persons from that user.
255		*
256		* @param string $userId User to drop persons from a table.
257		*/
258	26	public function deleteUserPersons(string $userId) {
259	26	$qb = $this->db->getQueryBuilder();
260	26	$qb->delete($this->getTableName())
261	26	->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
262	26	->execute();
263	26	}
264
265		/**
266		* Checks if face with a given ID is in any cluster.
267		*
268		* @param int $faceId ID of the face to check
269		* @param array $cluster All clusters to check into
270		*
271		* @return bool True if face is found in any cluster, false otherwise.
272		*/
273	5	private function isFaceInClusters(int $faceId, array $clusters): bool {
274	5	foreach ($clusters as $_=>$faces) {
275	5	if (in_array($faceId, $faces)) {
276	5	return true;
277		}
278		}
279	1	return false;
280		}
281		}
282

matiasdelellis / facerecognition

Push — create-clusters-test ( 0b8e8a...19354b )

PersonMapper::isFaceInClusters() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like