Passed
Push — integration_tests ( cc20ea )
by Branko
01:35
created

AddMissingImagesTask::getPicturesFromFolder()   B

Complexity

Conditions 7
Paths 6

Size

Total Lines 23
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 7
eloc 10
nc 6
nop 2
dl 0
loc 23
rs 8.8333
c 0
b 0
f 0
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\BackgroundJob\Tasks;
25
26
use OCP\IConfig;
27
use OCP\IUser;
28
29
use OCP\Files\File;
30
use OCP\Files\Folder;
31
use OCP\Files\IHomeStorage;
32
33
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionBackgroundTask;
34
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionContext;
35
use OCA\FaceRecognition\Db\Image;
36
use OCA\FaceRecognition\Db\ImageMapper;
37
use OCA\FaceRecognition\Helper\Requirements;
38
use OCA\FaceRecognition\Migration\AddDefaultFaceModel;
39
40
/**
41
 * Task that, for each user, crawls for all images in filesystem and insert them in database.
42
 * This is job that normally does file watcher, but this should be done at least once,
43
 * after app is installed (or re-enabled).
44
 */
45
class AddMissingImagesTask extends FaceRecognitionBackgroundTask {
46
	const FULL_IMAGE_SCAN_DONE_KEY = "full_image_scan_done";
47
48
	/** @var IConfig Config */
49
	private $config;
50
51
	/** @var ImageMapper Image mapper */
52
	private $imageMapper;
53
54
	/**
55
	 * @param IConfig $config Config
56
	 * @param ImageMapper $imageMapper Image mapper
57
	 */
58
	public function __construct(IConfig $config, ImageMapper $imageMapper) {
59
		parent::__construct();
60
		$this->config = $config;
61
		$this->imageMapper = $imageMapper;
62
	}
63
64
	/**
65
	 * @inheritdoc
66
	 */
67
	public function description() {
68
		return "Crawl for missing images for each user and insert them in DB";
69
	}
70
71
	/**
72
	 * @inheritdoc
73
	 */
74
	public function execute(FaceRecognitionContext $context) {
75
		$this->setContext($context);
76
77
		$fullImageScanDone = $this->config->getAppValue('facerecognition', AddMissingImagesTask::FULL_IMAGE_SCAN_DONE_KEY, 'false');
78
		if ($fullImageScanDone == 'true') {
79
			// Completely skip this task, seems that we already did full scan
80
			return true;
81
		}
82
83
		$model = intval($this->config->getAppValue('facerecognition', 'model', AddDefaultFaceModel::DEFAULT_FACE_MODEL_ID));
84
85
		// Check if we are called for one user only, or for all user in instance.
86
		$insertedImages = 0;
87
		$eligable_users = array();
88
		if (is_null($this->context->user)) {
89
			$this->context->userManager->callForSeenUsers(function (IUser $user) use (&$eligable_users) {
90
				$eligable_users[] = $user->getUID();
91
			});
92
		} else {
93
			$eligable_users[] = $this->context->user->getUID();
94
		}
95
96
		foreach($eligable_users as $user) {
97
			$insertedImages += $this->addMissingImagesForUser($user, $model);
98
			yield;
99
		}
100
101
		if (is_null($this->context->user)) {
102
			$this->config->setAppValue('facerecognition', AddMissingImagesTask::FULL_IMAGE_SCAN_DONE_KEY, 'true');
103
		}
104
105
		$this->context->propertyBag['AddMissingImagesTask_insertedImages'] = $insertedImages;
106
		return true;
107
	}
108
109
	/**
110
	 * Crawl filesystem for a given user
111
	 * TODO: duplicated from Queue.php, figure out how to merge
112
	 * (or delete this Queue.php when not needed)
113
	 *
114
	 * @param string $userId ID of the user for which to crawl images for
115
	 * @param int $model Used model
116
	 * @return int Number of missing images found
117
	 */
118
	private function addMissingImagesForUser(string $userId, int $model): int {
119
		$this->logInfo(sprintf('Finding missing images for user %s', $userId));
120
		\OC_Util::tearDownFS();
0 ignored issues
show
Bug introduced by
The type OC_Util 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...
121
		\OC_Util::setupFS($userId);
122
123
		$userFolder = $this->context->rootFolder->getUserFolder($userId);
124
		return $this->parseUserFolder($model, $userFolder);
125
	}
126
127
	/**
128
	 * Recursively crawls given folder for a given user
129
	 *
130
	 * @param int $model Used model
131
	 * @param Folder $folder Folder to recursively search images in
132
	 * @return int Number of missing images found
133
	 */
134
	private function parseUserFolder(int $model, Folder $folder): int {
135
		$insertedImages = 0;
136
		$nodes = $this->getPicturesFromFolder($folder);
137
		foreach ($nodes as $file) {
138
			$this->logDebug('Found ' . $file->getPath());
139
140
			$image = new Image();
141
			$image->setUser($file->getOwner()->getUid());
142
			$image->setFile($file->getId());
143
			$image->setModel($model);
144
			// todo: this check/insert logic for each image is so inefficient it hurts my mind
145
			if ($this->imageMapper->imageExists($image) == null) {
0 ignored issues
show
Bug Best Practice introduced by
It seems like you are loosely comparing $this->imageMapper->imageExists($image) of type integer|null against null; this is ambiguous if the integer can be zero. Consider using a strict comparison === instead.
Loading history...
146
				// todo: can we have larger transaction with bulk insert?
147
				$this->imageMapper->insert($image);
148
				$insertedImages++;
149
			}
150
		}
151
152
		return $insertedImages;
153
	}
154
155
	/**
156
	 * Return all images from a given folder.
157
	 *
158
	 * TODO: It is inefficient since it copies the array recursively.
159
	 *
160
	 * @param Folder $folder Folder to get images from
161
	 * @return array List of all images and folders to continue recursive crawling
162
	 */
163
	private function getPicturesFromFolder(Folder $folder, $results = array()) {
164
		// todo: should we also care about this too: instanceOfStorage(ISharedStorage::class);
165
		if ($folder->getStorage()->instanceOfStorage(IHomeStorage::class) === false) {
166
			return $results;
167
		}
168
169
		$nodes = $folder->getDirectoryListing();
170
171
		foreach ($nodes as $node) {
172
			//if ($node->isHidden())
173
			//	continue;
174
			// $previewImage = new \OC_Image();
175
			// $previewImage->loadFromData($preview->getContent());
176
			if ($node instanceof Folder and !$node->nodeExists('.nomedia')) {
177
				$results = $this->getPicturesFromFolder($node, $results);
178
			} else if ($node instanceof File) {
179
				if (Requirements::isImageTypeSupported($node->getMimeType())) {
180
					$results[] = $node;
181
				}
182
			}
183
		}
184
185
		return $results;
186
	}
187
}
188