BackgroundScanner::initFilesystemForUser() - Code Metrics - Inspection of "[WIP] Resolve path by fileId correctly" - owncloud/files_antivirus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#118)

by Victor

created 2016-08-22 19:37 UTC

BackgroundScanner::initFilesystemForUser() A

↳ Parent: BackgroundScanner

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	11
ccs	0
cts	11
cp	0
rs	9.4285
cc	3
eloc	8
nc	3
nop	1
crap	12

<?php
/**
 * Copyright (c) 2012 Bart Visscher <[email protected]>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */

namespace OCA\Files_Antivirus;

use OC\Files\Filesystem;
use OC\Files\View;
use OCP\IL10N;
use OCP\IUser;
use OCP\Files\IRootFolder;
use OCP\IUserSession;

class BackgroundScanner {

	const BATCH_SIZE = 10;

	/** @var IRootFolder */
	protected $rootFolder;

	/** @var \OCP\Files\Folder[] */
	protected $userFolders;

	/**
	 * @var ScannerFactory
	 */
	private $scannerFactory;

	
	/**
	 * @var IL10N
	 */
	private $l10n;

	/** @var string */
	protected $currentFilesystemUser;

	/** @var \OCP\IUserSession */
	protected $userSession;

	/**
	 * A constructor
	 *
	 * @param \OCA\Files_Antivirus\ScannerFactory $scannerFactory
	 * @param IL10N $l10n
	 * @param IRootFolder $rootFolder
	 * @param IUserSession $userSession
	 */
	public function __construct(ScannerFactory $scannerFactory,
								IL10N $l10n,
								IRootFolder $rootFolder,
								IUserSession $userSession
	){
		$this->rootFolder = $rootFolder;
		$this->scannerFactory = $scannerFactory;
		$this->l10n = $l10n;
		$this->userSession = $userSession;
	}
	
	/**
	 * Background scanner main job
	 * @return null
	 */
	public function run(){
		// locate files that are not checked yet
		$dirMimeTypeId = \OC::$server->getMimeTypeLoader()->getId('httpd/unix-directory');
		try {
			$qb = \OC::$server->getDatabaseConnection()->getQueryBuilder();
			$qb->select(['fc.fileid'])
				->from('filecache', 'fc')
				->leftJoin('fc', 'files_antivirus', 'fa', $qb->expr()->eq('fa.fileid', 'fc.fileid'))
				->innerJoin(
					'fc',
					'storages',
					'ss',
					$qb->expr()->andX(
						$qb->expr()->eq('fc.storage', 'ss.numeric_id'),
						$qb->expr()->orX(
							$qb->expr()->like('ss.id', $qb->expr()->literal('local::%')),
							$qb->expr()->like('ss.id', $qb->expr()->literal('home::%'))
						)
					)
				)
				->where(
					$qb->expr()->neq('fc.mimetype', $qb->expr()->literal($dirMimeTypeId))
				)
				->andWhere(
					$qb->expr()->orX(
						$qb->expr()->isNull('fa.fileid'),
						$qb->expr()->gt('fc.mtime', 'fa.check_time')
					)
				)
				->andWhere(
					$qb->expr()->like('fc.path', $qb->expr()->literal('files/%'))
				)
				->andWhere(
					$qb->expr()->neq('fc.size', $qb->expr()->literal('0'))
				)
				->setMaxResults(self::BATCH_SIZE)
			;
			$result = $qb->execute();
		} catch(\Exception $e) {
			\OC::$server->getLogger()->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
			return;
		}

		try {
			while ($row = $result->fetch()) {
				$fileId = $row['fileid'];
				$owner = $this->getOwner($fileId);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
				if (!$owner){
					continue;
				}
				$this->initFilesystemForUser($owner);
				$view = \OC\Files\Filesystem::getView();
				$path = $view->getPath($fileId);
				if (!is_null($path)) {
					$item = new Item($this->l10n, $view, $path, $fileId);
					$scanner = $this->scannerFactory->getScanner();
					$status = $scanner->scan($item);
					$status->dispatch($item, true);
				}
			}
		} catch (\Exception $e){
			\OC::$server->getLogger()->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
		}
		\OC_Util::tearDownFS();
	}

	protected function getOwner($fileId){
		$mountProviderCollection = \OC::$server->getMountProviderCollection();
		$mountCache = $mountProviderCollection->getMountCache();
		$mounts = $mountCache->getMountsForFileId($fileId);
		if (!empty($mounts)) {
			$user = $mounts[0]->getUser();
			if ($user instanceof IUser) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				return $user;
			}
		}
	}

	/**
	 * @param \OCP\IUser $user
	 * @return \OCP\Files\Folder
	 */
	protected function getUserFolder(IUser $user) {
		if (!isset($this->userFolders[$user->getUID()])) {
			$userFolder = $this->rootFolder->getUserFolder($user->getUID());
			$this->userFolders[$user->getUID()] = $userFolder;
		}
		return $this->userFolders[$user->getUID()];
	}

	/**
	 * @param IUser $user
	 */
	protected function initFilesystemForUser(IUser $user) {
		if ($this->currentFilesystemUser !== $user->getUID()) {
			if ($this->currentFilesystemUser !== '') {
				Filesystem::tearDown();
			}
			Filesystem::init($user->getUID(), '/' . $user->getUID() . '/files');
			$this->userSession->setUser($user);
			$this->currentFilesystemUser = $user->getUID();
			\OC\Files\Filesystem::initMountPoints($user->getUID());
		}
	}

	/**
	 * @deprecated since  v8.0.0
	 */
	public static function check(){
	}
}


1		<?php
2		/**
3		* Copyright (c) 2012 Bart Visscher <[email protected]>
4		* This file is licensed under the Affero General Public License version 3 or
5		* later.
6		* See the COPYING-README file.
7		*/
8
9		namespace OCA\Files_Antivirus;
10
11		use OC\Files\Filesystem;
12		use OC\Files\View;
13		use OCP\IL10N;
14		use OCP\IUser;
15		use OCP\Files\IRootFolder;
16		use OCP\IUserSession;
17
18		class BackgroundScanner {
19
20		const BATCH_SIZE = 10;
21
22		/** @var IRootFolder */
23		protected $rootFolder;
24
25		/** @var \OCP\Files\Folder[] */
26		protected $userFolders;
27
28		/**
29		* @var ScannerFactory
30		*/
31		private $scannerFactory;
32
33
34		/**
35		* @var IL10N
36		*/
37		private $l10n;
38
39		/** @var string */
40		protected $currentFilesystemUser;
41
42		/** @var \OCP\IUserSession */
43		protected $userSession;
44
45		/**
46		* A constructor
47		*
48		* @param \OCA\Files_Antivirus\ScannerFactory $scannerFactory
49		* @param IL10N $l10n
50		* @param IRootFolder $rootFolder
51		* @param IUserSession $userSession
52		*/
53	1	public function __construct(ScannerFactory $scannerFactory,
54		IL10N $l10n,
55		IRootFolder $rootFolder,
56		IUserSession $userSession
57		){
58	1	$this->rootFolder = $rootFolder;
59	1	$this->scannerFactory = $scannerFactory;
60	1	$this->l10n = $l10n;
61	1	$this->userSession = $userSession;
62	1	}
63
64		/**
65		* Background scanner main job
66		* @return null
67		*/
68	1	public function run(){
69		// locate files that are not checked yet
70	1	$dirMimeTypeId = \OC::$server->getMimeTypeLoader()->getId('httpd/unix-directory');
71		try {
72	1	$qb = \OC::$server->getDatabaseConnection()->getQueryBuilder();
73	1	$qb->select(['fc.fileid'])
74	1	->from('filecache', 'fc')
75	1	->leftJoin('fc', 'files_antivirus', 'fa', $qb->expr()->eq('fa.fileid', 'fc.fileid'))
76	1	->innerJoin(
77	1	'fc',
78	1	'storages',
79	1	'ss',
80	1	$qb->expr()->andX(
81	1	$qb->expr()->eq('fc.storage', 'ss.numeric_id'),
82	1	$qb->expr()->orX(
83	1	$qb->expr()->like('ss.id', $qb->expr()->literal('local::%')),
84	1	$qb->expr()->like('ss.id', $qb->expr()->literal('home::%'))
85	1	)
86	1	)
87	1	)
88	1	->where(
89	1	$qb->expr()->neq('fc.mimetype', $qb->expr()->literal($dirMimeTypeId))
90	1	)
91	1	->andWhere(
92	1	$qb->expr()->orX(
93	1	$qb->expr()->isNull('fa.fileid'),
94	1	$qb->expr()->gt('fc.mtime', 'fa.check_time')
95	1	)
96	1	)
97	1	->andWhere(
98	1	$qb->expr()->like('fc.path', $qb->expr()->literal('files/%'))
99	1	)
100	1	->andWhere(
101	1	$qb->expr()->neq('fc.size', $qb->expr()->literal('0'))
102	1	)
103	1	->setMaxResults(self::BATCH_SIZE)
104		;
105	1	$result = $qb->execute();
106	1	} catch(\Exception $e) {
107		\OC::$server->getLogger()->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
108		return;
109		}
110
111		try {
112	1	while ($row = $result->fetch()) {
113	1	$fileId = $row['fileid'];
114	1	$owner = $this->getOwner($fileId);
		0 ignored issues – show Bug introduced 2016-07-12 23:24 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$owner` is correct as `$this->getOwner($fileId)` (which targets `OCA\Files_Antivirus\BackgroundScanner::getOwner()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
115	1	if (!$owner){
116	1	continue;
117		}
118		$this->initFilesystemForUser($owner);
119		$view = \OC\Files\Filesystem::getView();
120		$path = $view->getPath($fileId);
121		if (!is_null($path)) {
122		$item = new Item($this->l10n, $view, $path, $fileId);
123		$scanner = $this->scannerFactory->getScanner();
124		$status = $scanner->scan($item);
125		$status->dispatch($item, true);
126		}
127		}
128	1	} catch (\Exception $e){
129		\OC::$server->getLogger()->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
130		}
131	1	\OC_Util::tearDownFS();
132	1	}
133
134	1	protected function getOwner($fileId){
135	1	$mountProviderCollection = \OC::$server->getMountProviderCollection();
136	1	$mountCache = $mountProviderCollection->getMountCache();
137	1	$mounts = $mountCache->getMountsForFileId($fileId);
138	1	if (!empty($mounts)) {
139		$user = $mounts[0]->getUser();
140		if ($user instanceof IUser) {
		0 ignored issues – show Bug introduced 2016-05-16 17:15 UTC by Report Bug Copy Issue Report The class `OCP\IUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
141		return $user;
142		}
143		}
144	1	}
145
146		/**
147		* @param \OCP\IUser $user
148		* @return \OCP\Files\Folder
149		*/
150		protected function getUserFolder(IUser $user) {
151		if (!isset($this->userFolders[$user->getUID()])) {
152		$userFolder = $this->rootFolder->getUserFolder($user->getUID());
153		$this->userFolders[$user->getUID()] = $userFolder;
154		}
155		return $this->userFolders[$user->getUID()];
156		}
157
158		/**
159		* @param IUser $user
160		*/
161		protected function initFilesystemForUser(IUser $user) {
162		if ($this->currentFilesystemUser !== $user->getUID()) {
163		if ($this->currentFilesystemUser !== '') {
164		Filesystem::tearDown();
165		}
166		Filesystem::init($user->getUID(), '/' . $user->getUID() . '/files');
167		$this->userSession->setUser($user);
168		$this->currentFilesystemUser = $user->getUID();
169		\OC\Files\Filesystem::initMountPoints($user->getUID());
170		}
171		}
172
173		/**
174		* @deprecated since v8.0.0
175		*/
176		public static function check(){
177		}
178		}
179

owncloud / files_antivirus

Pull Request — master (#118)

BackgroundScanner::initFilesystemForUser() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like