Passed
Push — self-contained-model ( ef7b10...695739 )
by Matias
03:56
created

ImageMapper   A

Complexity

Total Complexity 21

Size/Duplication

Total Lines 263
Duplicated Lines 0 %

Test Coverage

Coverage 56.89%

Importance

Changes 8
Bugs 0 Features 0
Metric Value
eloc 160
c 8
b 0
f 0
dl 0
loc 263
ccs 95
cts 167
cp 0.5689
rs 10
wmc 21

15 Methods

Rating   Name   Duplication   Size   Complexity  
A deleteUserImages() 0 5 1
A __construct() 0 3 1
A findImagesWithoutFaces() 0 13 2
A countImages() 0 12 1
A countProcessedImages() 0 14 1
A avgProcessingDuration() 0 14 1
A findImages() 0 9 1
A find() 0 7 1
A imageProcessed() 0 36 4
A imageExists() 0 15 2
A resetImage() 0 10 1
A findFromFile() 0 12 2
A findImagesFromPerson() 0 16 1
A countUserProcessedImages() 0 16 1
A countUserImages() 0 14 1
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 OCP\IDBConnection;
27
use OCP\IUser;
28
29
use OCP\AppFramework\Db\QBMapper;
30
use OCP\AppFramework\Db\DoesNotExistException;
31
use OCP\DB\QueryBuilder\IQueryBuilder;
32
33
class ImageMapper extends QBMapper {
34
	/** @var FaceMapper Face mapper*/
35
	private $faceMapper;
36
37 1
	public function __construct(IDBConnection $db, FaceMapper $faceMapper) {
38 1
		parent::__construct($db, 'facerecog_images', '\OCA\FaceRecognition\Db\Image');
39 1
		$this->faceMapper = $faceMapper;
40 1
	}
41
42
	/**
43
	 * @param string $userId Id of user
44
	 * @param int $imageId Id of Image to get
45
	 * @return Image
46
	 */
47 4
	public function find(string $userId, int $imageId): Image {
48 4
		$qb = $this->db->getQueryBuilder();
49 4
		$qb->select('id', 'file', 'is_processed', 'error', 'last_processed_time', 'processing_duration')
50 4
			->from($this->getTableName(), 'i')
51 4
			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
52 4
			->andWhere($qb->expr()->eq('id', $qb->createNamedParameter($imageId)));
53 4
		return $this->findEntity($qb);
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this->findEntity($qb) returns the type OCP\AppFramework\Db\Entity which includes types incompatible with the type-hinted return OCA\FaceRecognition\Db\Image.
Loading history...
54
	}
55
56
	/**
57
	 * @param string $userId Id of user
58
	 * @param int $modelId Id of model
59
	 * @param int $fileId Id of file to get Image
60
	 * @return Image[]|null
61
	 */
62
	public function findFromFile(string $userId, int $modelId, int $fileId): ?Image {
63
		$qb = $this->db->getQueryBuilder();
64
		$qb->select('id', 'is_processed', 'error')
65
			->from($this->getTableName(), 'i')
66
			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
67
			->andwhere($qb->expr()->eq('model', $qb->createNamedParameter($modelId)))
68
			->andWhere($qb->expr()->eq('file', $qb->createNamedParameter($fileId)));
69
70
		try {
71
			return $this->findEntity($qb);
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this->findEntity($qb) returns the type OCP\AppFramework\Db\Entity which includes types incompatible with the type-hinted return OCA\FaceRecognition\Db\Image|null.
Loading history...
72
		} catch (DoesNotExistException $e) {
73
			return null;
74
		}
75
	}
76
77 7
	public function imageExists(Image $image) {
78 7
		$qb = $this->db->getQueryBuilder();
79
		$query = $qb
80 7
			->select(['id'])
81 7
			->from($this->getTableName())
82 7
			->where($qb->expr()->eq('user', $qb->createParameter('user')))
83 7
			->andWhere($qb->expr()->eq('file', $qb->createParameter('file')))
84 7
			->andWhere($qb->expr()->eq('model', $qb->createParameter('model')))
85 7
			->setParameter('user', $image->getUser())
86 7
			->setParameter('file', $image->getFile())
87 7
			->setParameter('model', $image->getModel());
88 7
		$resultStatement = $query->execute();
89 7
		$row = $resultStatement->fetch();
90 7
		$resultStatement->closeCursor();
91 7
		return $row ? (int)$row['id'] : null;
92
	}
93
94
	public function countImages(int $model): int {
95
		$qb = $this->db->getQueryBuilder();
96
		$query = $qb
97
			->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
98
			->from($this->getTableName())
99
			->where($qb->expr()->eq('model', $qb->createParameter('model')))
100
			->setParameter('model', $model);
101
		$resultStatement = $query->execute();
102
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
103
		$resultStatement->closeCursor();
104
105
		return (int)$data[0];
106
	}
107
108
	public function countProcessedImages(int $model): int {
109
		$qb = $this->db->getQueryBuilder();
110
		$query = $qb
111
			->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
112
			->from($this->getTableName())
113
			->where($qb->expr()->eq('model', $qb->createParameter('model')))
114
			->andWhere($qb->expr()->eq('is_processed', $qb->createParameter('is_processed')))
115
			->setParameter('model', $model)
116
			->setParameter('is_processed', True);
117
		$resultStatement = $query->execute();
118
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
119
		$resultStatement->closeCursor();
120
121
		return (int)$data[0];
122
	}
123
124
	public function avgProcessingDuration(int $model): int {
125
		$qb = $this->db->getQueryBuilder();
126
		$query = $qb
127
			->select($qb->createFunction('AVG(' . $qb->getColumnName('processing_duration') . ')'))
128
			->from($this->getTableName())
129
			->where($qb->expr()->eq('model', $qb->createParameter('model')))
130
			->andWhere($qb->expr()->eq('is_processed', $qb->createParameter('is_processed')))
131
			->setParameter('model', $model)
132
			->setParameter('is_processed', True);
133
		$resultStatement = $query->execute();
134
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
135
		$resultStatement->closeCursor();
136
137
		return (int)$data[0];
138
	}
139
140 3
	public function countUserImages(string $userId, $model): int {
141 3
		$qb = $this->db->getQueryBuilder();
142
		$query = $qb
143 3
			->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
144 3
			->from($this->getTableName())
145 3
			->where($qb->expr()->eq('user', $qb->createParameter('user')))
146 3
			->andWhere($qb->expr()->eq('model', $qb->createParameter('model')))
147 3
			->setParameter('user', $userId)
148 3
			->setParameter('model', $model);
149 3
		$resultStatement = $query->execute();
150 3
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
151 3
		$resultStatement->closeCursor();
152
153 3
		return (int)$data[0];
154
	}
155
156 1
	public function countUserProcessedImages(string $userId, $model): int {
157 1
		$qb = $this->db->getQueryBuilder();
158
		$query = $qb
159 1
			->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
160 1
			->from($this->getTableName())
161 1
			->where($qb->expr()->eq('user', $qb->createParameter('user')))
162 1
			->andWhere($qb->expr()->eq('model', $qb->createParameter('model')))
163 1
			->andWhere($qb->expr()->eq('is_processed', $qb->createParameter('is_processed')))
164 1
			->setParameter('user', $userId)
165 1
			->setParameter('model', $model)
166 1
			->setParameter('is_processed', True);
167 1
		$resultStatement = $query->execute();
168 1
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
169 1
		$resultStatement->closeCursor();
170
171 1
		return (int)$data[0];
172
	}
173
174
	/**
175
	 * @param IUser|null $user User for which to get images for. If not given, all images from instance are returned.
176
	 */
177 9
	public function findImagesWithoutFaces(IUser $user = null) {
178 9
		$qb = $this->db->getQueryBuilder();
179
		$query = $qb
180 9
			->select(['id', 'user', 'file', 'model'])
181 9
			->from($this->getTableName())
182 9
			->where($qb->expr()->eq('is_processed',  $qb->createParameter('is_processed')))
183 9
			->setParameter('is_processed', false, IQueryBuilder::PARAM_BOOL);
184 9
		if (!is_null($user)) {
185 9
			$query->andWhere($qb->expr()->eq('user', $qb->createNamedParameter($user->getUID())));
186
		}
187
188 9
		$images = $this->findEntities($qb);
189 9
		return $images;
190
	}
191
192 6
	public function findImages(string $userId, int $model): array {
193 6
		$qb = $this->db->getQueryBuilder();
194 6
		$qb->select('i.id', 'i.file')
195 6
			->from($this->getTableName(), 'i')
196 6
			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
197 6
			->andWhere($qb->expr()->eq('model', $qb->createNamedParameter($model)));
198
199 6
		$images = $this->findEntities($qb);
200 6
		return $images;
201
	}
202
203
	public function findImagesFromPerson(string $userId, string $name, int $model): array {
204
		$qb = $this->db->getQueryBuilder();
205
		$qb->select('i.id', 'i.file')
206
			->from($this->getTableName(), 'i')
207
			->innerJoin('i', 'facerecog_faces', 'f', $qb->expr()->eq('f.image', 'i.id'))
208
			->innerJoin('i', 'facerecog_persons', 'p', $qb->expr()->eq('f.person', 'p.id'))
209
			->where($qb->expr()->eq('p.user', $qb->createNamedParameter($userId)))
210
			->andWhere($qb->expr()->eq('model', $qb->createNamedParameter($model)))
211
			->andWhere($qb->expr()->eq('is_processed', $qb->createNamedParameter(True)))
212
			->andWhere($qb->expr()->like($qb->func()->lower('p.name'), $qb->createParameter('query')));
213
214
		$query = '%' . $this->db->escapeLikeParameter(strtolower($name)) . '%';
215
		$qb->setParameter('query', $query);
216
217
		$images = $this->findEntities($qb);
218
		return $images;
219
	}
220
221
	/**
222
	 * Writes to DB that image has been processed. Previously found faces are deleted and new ones are inserted.
223
	 * If there is exception, its stack trace is also updated.
224
	 *
225
	 * @param Image $image Image to be updated
226
	 * @param Face[] $faces Faces to insert
227
	 * @param int $duration Processing time, in milliseconds
228
	 * @param \Exception|null $e Any exception that happened during image processing
229
	 */
230 4
	public function imageProcessed(Image $image, array $faces, int $duration, \Exception $e = null) {
231 4
		$this->db->beginTransaction();
232
		try {
233
			// Update image itself
234
			//
235 4
			$error = null;
236 4
			if ($e !== null) {
237 1
				$error = substr($e->getMessage(), 0, 1024);
238
			}
239
240 4
			$qb = $this->db->getQueryBuilder();
241 4
			$qb->update($this->getTableName())
242 4
				->set("is_processed", $qb->createNamedParameter(true, IQueryBuilder::PARAM_BOOL))
243 4
				->set("error", $qb->createNamedParameter($error))
244 4
				->set("last_processed_time", $qb->createNamedParameter(new \DateTime(), IQueryBuilder::PARAM_DATE))
245 4
				->set("processing_duration", $qb->createNamedParameter($duration))
246 4
				->where($qb->expr()->eq('id', $qb->createNamedParameter($image->id)))
247 4
				->execute();
248
249
			// Delete all previous faces
250
			//
251 4
			$qb = $this->db->getQueryBuilder();
252 4
			$qb->delete('facerecog_faces')
253 4
				->where($qb->expr()->eq('image', $qb->createNamedParameter($image->id)))
254 4
				->execute();
255
256
			// Insert all faces
257
			//
258 4
			foreach ($faces as $face) {
259 1
				$this->faceMapper->insertFace($face, $this->db);
260
			}
261
262 4
			$this->db->commit();
263
		} catch (\Exception $e) {
264
			$this->db->rollBack();
265
			throw $e;
266
		}
267 4
	}
268
269
	/**
270
	 * Resets image by deleting all associated faces and prepares it to be processed again
271
	 *
272
	 * @param Image $image Image to reset
273
	 */
274
	public function resetImage(Image $image) {
275
		$qb = $this->db->getQueryBuilder();
276
		$qb->update($this->getTableName())
277
			->set("is_processed", $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL))
278
			->set("error", $qb->createNamedParameter(null))
279
			->set("last_processed_time", $qb->createNamedParameter(null))
280
			->where($qb->expr()->eq('user', $qb->createNamedParameter($image->getUser())))
281
			->andWhere($qb->expr()->eq('file', $qb->createNamedParameter($image->getFile())))
282
			->andWhere($qb->expr()->eq('model', $qb->createNamedParameter($image->getModel())))
283
			->execute();
284
	}
285
286
	/**
287
	 * Deletes all images from that user.
288
	 *
289
	 * @param string $userId User to drop images from table.
290
	 */
291 28
	public function deleteUserImages(string $userId) {
292 28
		$qb = $this->db->getQueryBuilder();
293 28
		$qb->delete($this->getTableName())
294 28
			->where($qb->expr()->eq('user', $qb->createNamedParameter($userId)))
295 28
			->execute();
296 28
	}
297
}
298