Task.php

<?php
/**
 * ownCloud - Files_antivirus
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later.See the COPYING file.
 *
 * @author Viktar Dubiniuk <dubiniuk@owncloud.com>
 *
 * @copyright Viktar Dubiniuk 2015-2019
 * @license AGPL-3.0
 */

namespace OCA\Files_Antivirus\Cron;

use OC\BackgroundJob\TimedJob;
use OC\Files\Filesystem;
use OCA\Files_Antivirus\AppConfig;
use OCA\Files_Antivirus\Db\FileCollection;
use OCA\Files_Antivirus\Item;
use OCA\Files_Antivirus\ScannerFactory;
use OCP\IL10N;
use OCP\ILogger;
use OCP\Files\IRootFolder;
use OCP\IUser;
use OCP\IUserSession;

class Task extends TimedJob {
	public const BATCH_SIZE = 10;

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

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

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

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

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

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

	/**
	 * @var FileCollection
	 */
	protected $fileCollection;

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

	/**
	 * A constructor
	 *
	 * @param IUserSession $userSession
	 * @param ILogger $logger
	 * @param IRootFolder $rootFolder
	 * @param IL10N $l10n
	 * @param ScannerFactory $scannerFactory
	 * @param AppConfig $appConfig
	 * @param FileCollection $fileCollection
	 */
	public function __construct(
		IUserSession $userSession,
		ILogger $logger,
		IRootFolder $rootFolder,
		IL10N $l10n,
		ScannerFactory $scannerFactory,
		AppConfig $appConfig,
		FileCollection $fileCollection
	) {
		$this->userSession = $userSession;
		$this->logger = $logger;
		$this->rootFolder = $rootFolder;
		$this->l10n = $l10n;
		$this->scannerFactory = $scannerFactory;
		$this->appConfig = $appConfig;
		$this->fileCollection = $fileCollection;
		
		// Run once per 15 minutes
		$this->setInterval(60 * 15);
	}

	/**
	 * @param string $argument
	 *
	 * @return void
	 */
	protected function run($argument = '') {
		if (!\OCP\App::isEnabled('files_antivirus')
			|| $this->appConfig->getAvScanBackground() !== 'true'
		) {
			return;
		}

		// locate files that are not checked yet
		try {
			$result = $this->getFilesForScan();
		} catch (\Exception $e) {
			$this->logger->error(
				__METHOD__ . ', exception: ' . $e->getMessage(),
				['app' => 'files_antivirus']
			);
			return;
		}

		$cnt = 0;
		while (($row = $result->fetchAssociative()) && $cnt < self::BATCH_SIZE) {
			try {
				$fileId = $row['fileid'];
				$userId = $row['user_id'];
				$etag = $row['etag'];
				/** @var IUser $owner */
				$owner = \OC::$server->getUserManager()->get($userId);
				if (!$owner instanceof IUser) {
					continue;
				}
				if ($this->scanOneFile($owner, $fileId, $etag)) {
					// increased only for successfully scanned files
					$cnt = $cnt + 1;
				}
			} catch (\Exception $e) {
				$this->logger->error(
					__METHOD__ . ', exception: ' . $e->getMessage(),
					['app' => 'files_antivirus']
				);
			}
		}
		$this->tearDownFilesystem();
	}

	/**
	 * @return \Doctrine\DBAL\Result
	 */
	protected function getFilesForScan() {
		$fileSizeLimit = $this->appConfig->getAvMaxFileSize();
		return $this->fileCollection->getCollection($fileSizeLimit);
	}

	/**
	 * @param IUser $owner
	 * @param int $fileId
	 * @param string|null $etag
	 *
	 * @return bool
	 *
	 * @throws \OCP\Files\NotFoundException
	 */
	protected function scanOneFile($owner, $fileId, $etag) {
		$this->initFilesystemForUser($owner);
		$view = Filesystem::getView();
		$path = $view->getPath($fileId);
		$ownerUid = $owner->getUID();
		$this->logger->debug(
			"About to scan file of user {$ownerUid} with id {$fileId} and path {$path}",
			['app' => 'files_antivirus']
		);
		if ($path !== null) {
			$item = new Item($this->l10n, $view, $path, $fileId, $etag);
			$scanner = $this->scannerFactory->getScanner();
			$status = $scanner->scan($item);
			$status->dispatch($item, true);
			return true;
		}
		return false; // @phpstan-ignore-line
	}

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

	/**
	 * @return void
	 */
	protected function tearDownFilesystem() {
		$this->userSession->setUser(null);
		\OC_Util::tearDownFS();
	}
}