OCA\Files_Antivirus\BackgroundJob\BackgroundScanner::getUnscannedFiled()

Complexity

Conditions	1
Paths	1

Size

Total Lines

18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	BackgroundScanner::getBatchSize()	0	10	2

<?php
declare(strict_types=1);
/**
 * Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */

namespace OCA\Files_Antivirus\BackgroundJob;

use OC\BackgroundJob\TimedJob;
use OCA\Files_Antivirus\AppConfig;
use OCA\Files_Antivirus\ItemFactory;
use OCA\Files_Antivirus\Scanner\ScannerFactory;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\Files\File;
use OCP\Files\IMimeTypeLoader;
use OCP\IDBConnection;
use OCP\Files\IRootFolder;
use OCP\ILogger;
use OCP\IUser;
use OCP\IUserManager;

class BackgroundScanner extends TimedJob {
	/** @var IRootFolder */
	protected $rootFolder;

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

	/** @var  AppConfig  */
	private $appConfig;

	/** @var ILogger */
	protected $logger;

	/** @var IUserManager */
	protected $userManager;

	/** @var IDBConnection */
	protected $db;

	/** @var IMimeTypeLoader */
	protected $mimeTypeLoader;

	/** @var ItemFactory */
	protected $itemFactory;
	/** @var bool */
	private $isCLI;

	public function __construct(ScannerFactory $scannerFactory,
								AppConfig $appConfig,
								IRootFolder $rootFolder,
								ILogger $logger,
								IUserManager $userManager,
								IDBConnection $db,
								IMimeTypeLoader $mimeTypeLoader,
								ItemFactory $itemFactory,
								bool $isCLI
	){
		$this->rootFolder = $rootFolder;
		$this->scannerFactory = $scannerFactory;
		$this->appConfig = $appConfig;
		$this->logger = $logger;
		$this->userManager = $userManager;
		$this->db = $db;
		$this->mimeTypeLoader = $mimeTypeLoader;
		$this->itemFactory = $itemFactory;
		$this->isCLI = $isCLI;

		// Run once per 15 minutes
		$this->setInterval(60 * 15);
	}

	/**
	 * Background scanner main job
	 */
	public function run($args): void {
		// locate files that are not checked yet
		try {
			$result = $this->getUnscannedFiles();
		} catch(\Exception $e) {
			$this->logger->logException($e);
			return;
		}

		$this->logger->debug('Start background scan');
		$batchSize = $this->getBatchSize();

		// Run for unscanned files
		$cnt = 0;
		while (($row = $result->fetch()) && $cnt < $batchSize) {

This code seems to be duplicated across your project.

			try {
				$fileId = $row['fileid'];
				$users = $this->getUserWithAccessToStorage((int)$row['storage']);

				foreach ($users as $user) {
					/** @var IUser $owner */
					$owner = $this->userManager->get($user['user_id']);
					if (!$owner instanceof IUser){

The class OCP\IUser does not exist. Did you forget a USE statement, or did you not list all dependencies?

						continue;
					}

					$userFolder = $this->rootFolder->getUserFolder($owner->getUID());
					$files = $userFolder->getById($fileId);

					if ($files === []) {
						continue;
					}

					$file = array_pop($files);
					if ($file instanceof File) {

The class OCP\Files\File does not exist. Did you forget a USE statement, or did you not list all dependencies?

						$this->scanOneFile($file);
					} else {
						$this->logger->error('Tried to scan non file');
					}

					// increased only for successfully scanned files
					$cnt++;
					break;
				}
			} catch (\Exception $e) {
				$this->logger->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
			}
		}

		if ($cnt === $batchSize) {
			// we are done
			return;
		}

		// Run for updated files
		try {
			$result = $this->getToRescanFiles();
		} catch(\Exception $e) {
			$this->logger->logException($e);
			return;
		}

		while (($row = $result->fetch()) && $cnt < $batchSize) {

This code seems to be duplicated across your project.

			try {
				$fileId = $row['fileid'];
				$users = $this->getUserWithAccessToStorage((int)$row['storage']);

				foreach ($users as $user) {
					/** @var IUser $owner */
					$owner = $this->userManager->get($user['user_id']);
					if (!$owner instanceof IUser){

The class OCP\IUser does not exist. Did you forget a USE statement, or did you not list all dependencies?

						continue;
					}

					$userFolder = $this->rootFolder->getUserFolder($owner->getUID());
					$files = $userFolder->getById($fileId);

					if ($files === []) {
						continue;
					}

					$file = array_pop($files);
					if ($file instanceof File) {

The class OCP\Files\File does not exist. Did you forget a USE statement, or did you not list all dependencies?

						$this->scanOneFile($file);
					} else {
						$this->logger->error('Tried to scan non file');
					}

					// increased only for successfully scanned files
					$cnt++;
					break;
				}
			} catch (\Exception $e) {
				$this->logger->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
			}
		}


		// Run for files that have been scanned in the past. Just start to rescan them as the virus definitaions might have been updated
		try {
			$result = $this->getOutdatedFiles();
		} catch(\Exception $e) {
			$this->logger->logException($e);
			return;
		}

		while (($row = $result->fetch()) && $cnt < $batchSize) {

This code seems to be duplicated across your project.

			try {
				$fileId = $row['fileid'];
				$users = $this->getUserWithAccessToStorage((int)$row['storage']);

				foreach ($users as $user) {
					/** @var IUser $owner */
					$owner = $this->userManager->get($user['user_id']);
					if (!$owner instanceof IUser){

The class OCP\IUser does not exist. Did you forget a USE statement, or did you not list all dependencies?

						continue;
					}

					$userFolder = $this->rootFolder->getUserFolder($owner->getUID());
					$files = $userFolder->getById($fileId);

					if ($files === []) {
						continue;
					}

					$file = array_pop($files);
					if ($file instanceof File) {

The class OCP\Files\File does not exist. Did you forget a USE statement, or did you not list all dependencies?

						$this->scanOneFile($file);
					} else {
						$this->logger->error('Tried to scan non file');
					}

					// increased only for successfully scanned files
					$cnt++;
					break;
				}
			} catch (\Exception $e) {
				$this->logger->error( __METHOD__ . ', exception: ' . $e->getMessage(), ['app' => 'files_antivirus']);
			}
		}
	}

	protected function getBatchSize(): int {
		$batchSize = 10;
		if ($this->isCLI) {
			$batchSize = 100;
		}

		$this->logger->debug('Batch size is: ' . $batchSize);

		return $batchSize;
	}

	protected function getSizeLimitExpression(IQueryBuilder $qb)  {
		$sizeLimit = (int)$this->appConfig->getAvMaxFileSize();
		if ( $sizeLimit === -1 ){
			$sizeLimitExpr = $qb->expr()->neq('fc.size', $qb->expr()->literal('0'));
		} else {
			$sizeLimitExpr = $qb->expr()->andX(
				$qb->expr()->neq('fc.size', $qb->expr()->literal('0')),
				$qb->expr()->lt('fc.size', $qb->createNamedParameter($sizeLimit))
			);
		}

		return $sizeLimitExpr;
	}

	protected function getUserWithAccessToStorage(int $storageId): array {
		$qb = $this->db->getQueryBuilder();

		$qb->select('user_id')
			->from('mounts')
			->where($qb->expr()->eq('storage_id', $qb->createNamedParameter($storageId)));

		$cursor = $qb->execute();
		$data = $cursor->fetchAll();
		$cursor->closeCursor();
		return $data;
	}

	protected function getUnscannedFiles() {
		$dirMimeTypeId = $this->mimeTypeLoader->getId('httpd/unix-directory');

		$qb1 = $this->db->getQueryBuilder();
		$qb1->select('fileid')
			->from('files_antivirus');

		$qb2 = $this->db->getQueryBuilder();
		$qb2->select('fileid', 'storage')
			->from('filecache', 'fc')
			->where($qb2->expr()->notIn('fileid', $qb2->createFunction($qb1->getSQL())))
			->andWhere($qb2->expr()->neq('mimetype', $qb2->expr()->literal($dirMimeTypeId)))
			->andWhere($qb2->expr()->like('path', $qb2->expr()->literal('files/%')))
			->andWhere($this->getSizeLimitExpression($qb2))
			->setMaxResults($this->getBatchSize() * 10);

		return $qb2->execute();
	}

	protected function getToRescanFiles() {
		$qb = $this->db->getQueryBuilder();
		$qb->select('fc.fileid', 'fc.storage')
			->from('filecache', 'fc')
			->join('fc', 'files_antivirus', 'fa', $qb->expr()->eq('fc.fileid', 'fa.fileid'))
			->andWhere($qb->expr()->lt('fa.check_time', 'fc.mtime'))
			->andWhere($this->getSizeLimitExpression($qb))
			->setMaxResults($this->getBatchSize() * 10);

		return $qb->execute();
	}

	protected function getOutdatedFiles() {
		$dirMimeTypeId = $this->mimeTypeLoader->getId('httpd/unix-directory');

		// We do not want to keep scanning the same files. So only scan them once per 28 days at most.
		$yesterday = time() - (28 * 24 * 60 * 60);

		$qb1 = $this->db->getQueryBuilder();
		$qb2 = $this->db->getQueryBuilder();

		$qb1->select('fileid')
			->from('files_antivirus')
			->andWhere($qb2->expr()->lt('check_time', $qb2->createNamedParameter($yesterday)))
			->orderBy('check_time', 'ASC');

		$qb2->select('fileid', 'storage')
			->from('filecache', 'fc')
			->where($qb2->expr()->in('fileid', $qb2->createFunction($qb1->getSQL())))
			->andWhere($qb2->expr()->neq('mimetype', $qb2->expr()->literal($dirMimeTypeId)))
			->andWhere($qb2->expr()->like('path', $qb2->expr()->literal('files/%')))
			->andWhere($this->getSizeLimitExpression($qb2))
			->setMaxResults($this->getBatchSize() * 10);

		$x = $qb2->getSQL();

$x is not used, you could remove the assignment.

		return $qb2->execute();
	}

	protected function scanOneFile(File $file): void {
		$this->logger->debug('Scanning file with fileid: ' . $file->getId());

		$item = $this->itemFactory->newItem($file, true);
		$scanner = $this->scannerFactory->getScanner();
		$status = $scanner->scan($item);
		$status->dispatch($item);
	}
}