AvirWrapper::fopen() - Code Metrics - Inspection of "Get uploaded file size correctly" - owncloud/files_antivirus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#196)

by Victor

created 2017-11-13 20:09 UTC

AvirWrapper::fopen() C

↳ Parent: AvirWrapper

Complexity

Conditions	9
Paths	5

Size

Total Lines	69
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
dl	0
loc	69
rs	6.2192
c	5
b	0
f	0
cc	9
eloc	47
nc	5
nop	2

How to fix Long Method

<?php
/**
 * Copyright (c) 2014 Viktar Dubiniuk <[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\Storage\Wrapper\Wrapper;
use \OCP\App;
use \OCP\IL10N;
use \OCP\ILogger;
use \OCP\Files\InvalidContentException;
use Icewind\Streams\CallbackWrapper;


class AvirWrapper extends Wrapper{
	
	/**
	 * Modes that are used for writing 
	 * @var array 
	 */
	private $writingModes = array('r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+');

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

	/**
	 * @var \OCA\Files_Antivirus\ScannerFactory
	 */
	protected $scannerFactory;
	
	/**
	 * @var IL10N 
	 */
	protected $l10n;
	
	/**
	 * @var ILogger;
	 */
	protected $logger;

	/** @var  RequestHelper */
	protected $requestHelper;

	/**
	 * @param array $parameters
	 */
	public function __construct($parameters) {
		parent::__construct($parameters);
		$this->appConfig = $parameters['appConfig'];
		$this->scannerFactory = $parameters['scannerFactory'];
		$this->l10n = $parameters['l10n'];
		$this->logger = $parameters['logger'];
		$this->requestHelper = $parameters['requestHelper'];
	}
	
	/**
	 * Asynchronously scan data that are written to the file
	 * @param string $path
	 * @param string $mode
	 * @return resource | bool
	 */
	public function fopen($path, $mode){
		$stream = $this->storage->fopen($path, $mode);

		if (is_resource($stream)
			&& $this->isWritingMode($mode)
			&& $this->isScannableSize()
			&& strpos($path, 'uploads/') !== 0
		) {
			try {
				$scanner = $this->scannerFactory->getScanner();
				$scanner->initScanner();
				return CallBackWrapper::wrap(
					$stream,
					null,
					function ($data) use ($scanner){
						$scanner->onAsyncData($data);
					}, 
					function () use ($scanner, $path) {
						$status = $scanner->completeAsyncScan();
						if (intval($status->getNumericStatus()) === \OCA\Files_Antivirus\Status::SCANRESULT_INFECTED){
							//prevent from going to trashbin
							if (App::isEnabled('files_trashbin')) {
								\OCA\Files_Trashbin\Storage::preRenameHook([
									Filesystem::signal_param_oldpath => '',
									Filesystem::signal_param_newpath => ''
								]);
							}
							
							$owner = $this->getOwner($path);
							$this->unlink($path);

							if (App::isEnabled('files_trashbin')) {
								\OCA\Files_Trashbin\Storage::postRenameHook([]);
							}
							$this->logger->warning(
								'Infected file deleted. ' . $status->getDetails()
								. ' Account: ' . $owner . ' Path: ' . $path,
								['app' => 'files_antivirus']
							);

							\OC::$server->getActivityManager()->publishActivity(
								'files_antivirus',
								Activity::SUBJECT_VIRUS_DETECTED,
								[$path, $status->getDetails()],
								Activity::MESSAGE_FILE_DELETED,
								[],
								$path,
								'',
								$owner,
								Activity::TYPE_VIRUS_DETECTED,
								Activity::PRIORITY_HIGH
							);
											
							throw new InvalidContentException(
								$this->l10n->t(
									'Virus %s is detected in the file. Upload cannot be completed.',
									$status->getDetails()
								)
							);
						}
					}
				);
			} catch (\Exception $e){
				$message = 	implode(' ', [ __CLASS__, __METHOD__, $e->getMessage()]);
				$this->logger->warning($message);
			}
		}
		return $stream;
	}
	
	/**
	 * Checks whether passed mode is suitable for writing 
	 * @param string $mode
	 * @return bool
	 */
	private function isWritingMode($mode){
		// Strip unessential binary/text flags
		$cleanMode = str_replace(
			['t', 'b'],
			['', ''],
			$mode
		);
		return in_array($cleanMode, $this->writingModes);
	}

	/**
	 * checks the size for webdav PUT requests. defaults to true
	 * @return bool
	 */
	private function isScannableSize() {
		$scanSizeLimit = intval($this->appConfig->getAvMaxFileSize());
		$size = $this->requestHelper->getUploadSize();

		return $scanSizeLimit === -1 || $size === null || $scanSizeLimit >= $size;
	}
}


1		<?php
2		/**
3		* Copyright (c) 2014 Viktar Dubiniuk <[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\Storage\Wrapper\Wrapper;
13		use \OCP\App;
14		use \OCP\IL10N;
15		use \OCP\ILogger;
16		use \OCP\Files\InvalidContentException;
17		use Icewind\Streams\CallbackWrapper;
18
19
20		class AvirWrapper extends Wrapper{
21
22		/**
23		* Modes that are used for writing
24		* @var array
25		*/
26		private $writingModes = array('r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+');
27
28		/**
29		* @var AppConfig
30		*/
31		protected $appConfig;
32
33		/**
34		* @var \OCA\Files_Antivirus\ScannerFactory
35		*/
36		protected $scannerFactory;
37
38		/**
39		* @var IL10N
40		*/
41		protected $l10n;
42
43		/**
44		* @var ILogger;
45		*/
46		protected $logger;
47
48		/** @var RequestHelper */
49		protected $requestHelper;
50
51	3	/**
52	3	* @param array $parameters
53	3	*/
54	3	public function __construct($parameters) {
55	3	parent::__construct($parameters);
56	3	$this->appConfig = $parameters['appConfig'];
57	3	$this->scannerFactory = $parameters['scannerFactory'];
58		$this->l10n = $parameters['l10n'];
59		$this->logger = $parameters['logger'];
60		$this->requestHelper = $parameters['requestHelper'];
61		}
62
63		/**
64		* Asynchronously scan data that are written to the file
65	4	* @param string $path
66	4	* @param string $mode
67	4	* @return resource \| bool
68	4	*/
69	4	public function fopen($path, $mode){
70	4	$stream = $this->storage->fopen($path, $mode);
71
72		if (is_resource($stream)
73	2	&& $this->isWritingMode($mode)
74	2	&& $this->isScannableSize()
75	2	&& strpos($path, 'uploads/') !== 0
76	2	) {
77	2	try {
78		$scanner = $this->scannerFactory->getScanner();
79	2	$scanner->initScanner();
80	2	return CallBackWrapper::wrap(
81	2	$stream,
82	2	null,
83	2	function ($data) use ($scanner){
84		$scanner->onAsyncData($data);
85	2	},
86	2	function () use ($scanner, $path) {
87	2	$status = $scanner->completeAsyncScan();
88		if (intval($status->getNumericStatus()) === \OCA\Files_Antivirus\Status::SCANRESULT_INFECTED){
89		//prevent from going to trashbin
90		if (App::isEnabled('files_trashbin')) {
91		\OCA\Files_Trashbin\Storage::preRenameHook([
92	2	Filesystem::signal_param_oldpath => '',
93	2	Filesystem::signal_param_newpath => ''
94		]);
95	2	}
96	2
97		$owner = $this->getOwner($path);
98	2	$this->unlink($path);
99	2
100	2	if (App::isEnabled('files_trashbin')) {
101	2	\OCA\Files_Trashbin\Storage::postRenameHook([]);
102		}
103		$this->logger->warning(
104	2	'Infected file deleted. ' . $status->getDetails()
105	2	. ' Account: ' . $owner . ' Path: ' . $path,
106	2	['app' => 'files_antivirus']
107	2	);
108	2
109	2	\OC::$server->getActivityManager()->publishActivity(
110	2	'files_antivirus',
111	2	Activity::SUBJECT_VIRUS_DETECTED,
112	2	[$path, $status->getDetails()],
113	2	Activity::MESSAGE_FILE_DELETED,
114	2	[],
115		$path,
116		'',
117	2	$owner,
118	2	Activity::TYPE_VIRUS_DETECTED,
119	2	Activity::PRIORITY_HIGH
120	2	);
121
122		throw new InvalidContentException(
123		$this->l10n->t(
124	2	'Virus %s is detected in the file. Upload cannot be completed.',
125		$status->getDetails()
126	2	)
127	2	);
128	2	}
129		}
130		);
131	4	} catch (\Exception $e){
132		$message = implode(' ', [ __CLASS__, __METHOD__, $e->getMessage()]);
133		$this->logger->warning($message);
134		}
135		}
136		return $stream;
137		}
138
139	4	/**
140		* Checks whether passed mode is suitable for writing
141	4	* @param string $mode
142	4	* @return bool
143	4	*/
144	4	private function isWritingMode($mode){
145		// Strip unessential binary/text flags
146	4	$cleanMode = str_replace(
147		['t', 'b'],
148		['', ''],
149		$mode
150		);
151		return in_array($cleanMode, $this->writingModes);
152		}
153
154	3	/**
155	3	* checks the size for webdav PUT requests. defaults to true
156	3	* @return bool
157		*/
158		private function isScannableSize() {
159	3	$scanSizeLimit = intval($this->appConfig->getAvMaxFileSize());
160		$size = $this->requestHelper->getUploadSize();
161
162		return $scanSizeLimit === -1 \|\| $size === null \|\| $scanSizeLimit >= $size;
163	3	}
164		}
165

owncloud / files_antivirus

Pull Request — master (#196)

AvirWrapper::fopen() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like