Completed
Pull Request — master (#197)
by Thomas
12:08 queued 07:01
created

AvirWrapper   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 167
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 4

Test Coverage

Coverage 94.38%

Importance

Changes 6
Bugs 0 Features 0
Metric Value
wmc 14
lcom 1
cbo 4
dl 0
loc 167
ccs 84
cts 89
cp 0.9438
rs 10
c 6
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 8 1
A isWritingMode() 0 9 1
C fopen() 0 69 8
B isScannableSize() 0 26 4
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
	/**
52
	 * @param array $parameters
53
	 */
54 5
	public function __construct($parameters) {
55 5
		parent::__construct($parameters);
56 5
		$this->appConfig = $parameters['appConfig'];
57 5
		$this->scannerFactory = $parameters['scannerFactory'];
58 5
		$this->l10n = $parameters['l10n'];
59 5
		$this->logger = $parameters['logger'];
60 5
		$this->requestHelper = $parameters['requestHelper'];
61 5
	}
62
	
63
	/**
64
	 * Asynchronously scan data that are written to the file
65
	 * @param string $path
66
	 * @param string $mode
67
	 * @return resource | bool
68
	 */
69 4
	public function fopen($path, $mode){
70 4
		$stream = $this->storage->fopen($path, $mode);
71
72
		if (
73 4
			is_resource($stream)
74 4
			&& $this->isWritingMode($mode)
75 4
			&& $this->isScannableSize($path)
76 4
		) {
77
			try {
78 2
				$scanner = $this->scannerFactory->getScanner();
79 2
				$scanner->initScanner();
80 2
				return CallBackWrapper::wrap(
81 2
					$stream,
82 2
					null,
83
					function ($data) use ($scanner){
84 2
						$scanner->onAsyncData($data);
85 2
					}, 
86 2
					function () use ($scanner, $path) {
87 2
						$status = $scanner->completeAsyncScan();
88 2
						if (intval($status->getNumericStatus()) === \OCA\Files_Antivirus\Status::SCANRESULT_INFECTED){
89
							//prevent from going to trashbin
90 2
							if (App::isEnabled('files_trashbin')) {
91 2
								\OCA\Files_Trashbin\Storage::preRenameHook([
92 2
									Filesystem::signal_param_oldpath => '',
93 2
									Filesystem::signal_param_newpath => ''
94 2
								]);
95 2
							}
96
							
97 2
							$owner = $this->getOwner($path);
98 2
							$this->unlink($path);
99
100 2
							if (App::isEnabled('files_trashbin')) {
101 2
								\OCA\Files_Trashbin\Storage::postRenameHook([]);
102 2
							}
103 2
							$this->logger->warning(
104 2
								'Infected file deleted. ' . $status->getDetails()
105 2
								. ' Account: ' . $owner . ' Path: ' . $path,
106 2
								['app' => 'files_antivirus']
107 2
							);
108
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 2
								$path,
116 2
								'',
117 2
								$owner,
118 2
								Activity::TYPE_VIRUS_DETECTED,
119
								Activity::PRIORITY_HIGH
120 2
							);
121
											
122 2
							throw new InvalidContentException(
123 2
								$this->l10n->t(
124 2
									'Virus %s is detected in the file. Upload cannot be completed.',
125 2
									$status->getDetails()
126 2
								)
127 2
							);
128
						}
129
					}
130 2
				);
131
			} catch (\Exception $e){
132
				$message = 	implode(' ', [ __CLASS__, __METHOD__, $e->getMessage()]);
133
				$this->logger->warning($message);
134
			}
135
		}
136 3
		return $stream;
137
	}
138
	
139
	/**
140
	 * Checks whether passed mode is suitable for writing 
141
	 * @param string $mode
142
	 * @return bool
143
	 */
144 4
	private function isWritingMode($mode){
145
		// Strip unessential binary/text flags
146 4
		$cleanMode = str_replace(
147 4
			['t', 'b'],
148 4
			['', ''],
149
			$mode
150 4
		);
151 4
		return in_array($cleanMode, $this->writingModes);
152
	}
153
154
	/**
155
	 * Checks upload size against the av_max_file_size config option
156
	 *
157
	 * @param string $path
158
	 * @return bool
159
	 */
160 3
	private function isScannableSize($path) {
161 3
		$scanSizeLimit = intval($this->appConfig->getAvMaxFileSize());
162 3
		$size = $this->requestHelper->getUploadSize($path);
163
164
		// No upload in progress. Skip this file.
165 3
		if (is_null($size)){
166 2
			$this->logger->debug(
167 2
				'No upload in progress or chunk is being uploaded. Scanning is skipped.',
168 2
				['app' => 'files_antivirus']
169 2
			);
170 2
			return false;
171
		}
172
173 2
		$matchesLimit = $scanSizeLimit === -1 || $scanSizeLimit >= $size;
174 2
		$action = $matchesLimit ? 'Scanning is scheduled.' : 'Scanning is skipped.';
175 2
		$this->logger->debug(
176 2
			'File size is {filesize}. av_max_file_size is {av_max_file_size}. {action}',
177
			[
178 2
				'app' => 'files_antivirus',
179 2
				'av_max_file_size' => $scanSizeLimit,
180 2
				'filesize' => $size,
181
				'action' => $action
182 2
			]
183 2
		);
184 2
		return $matchesLimit;
185
	}
186
}
187