Scanner::writeChunk() - Code Metrics - Inspection of "[WIP]" - owncloud/files_antivirus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — stable8.2 (#145)

by Victor

created 2016-12-19 14:23 UTC

Scanner::writeChunk() A

↳ Parent: Scanner

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

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

<?php

/**
* ownCloud - files_antivirus
*
* @author Manuel Deglado
* @copyright 2012 Manuel Deglado [email protected]
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*
*/

namespace OCA\Files_Antivirus;

abstract class Scanner {
	
	/**
	 * Scan result
	 * @var \OCA\Files_Antivirus\Status
	 */
	protected $status;

	/** @var  int */
	protected $byteCount;

	/** @var  resource */
	protected $writeHandle;

	/** @var \OCA\Files_Antivirus\AppConfig */
	protected $appConfig;

	/** @var bool */
	protected $isLogUsed;

	/**
	 * Close used resources
	 */
	abstract protected function shutdownScanner();


	public function getStatus(){
		if ($this->status instanceof Status){
			return $this->status;
		}
		return new Status();
	}

	/**
	 * Synchronous scan
	 * @param IScannable $item
	 * @return Status
	 */
	public function scan(IScannable $item) {
		$this->initScanner();

		while (false !== ($chunk = $item->fread())) {
			$this->writeChunk($chunk);
		}
		
		$this->shutdownScanner();
		return $this->getStatus();
	}
	
	/**
	 * Async scan - new portion of data is available
	 * @param string $data
	 */
	public function onAsyncData($data){
		$this->writeChunk($data);
	}
	
	/**
	 * Async scan - resource is closed
	 * @return Status
	 */
	public function completeAsyncScan(){
		$this->shutdownScanner();
		return $this->getStatus();
	}
	
	/**
	 * Open write handle. etc
	 */
	public function initScanner(){
		$this->byteCount = 0;
		$this->status = new Status();
	}

	/**
	 * @param string $chunk
	 */
	protected function writeChunk($chunk){
		$this->fwrite(
			$this->prepareChunk($chunk)
		);
	}

	/**
	 * @param string $data
	 */
	protected final function fwrite($data){
		$dataLength = strlen($data);
		$fileSizeLimit = intval($this->appConfig->getAvMaxFileSize());
		if ($fileSizeLimit !== -1 && $this->byteCount + $dataLength > $fileSizeLimit){
			$this->shutdownScanner();
			$this->initScanner();
		}

		$bytesWritten = @fwrite($this->getWriteHandle(), $data);
		if ($bytesWritten === false || $bytesWritten < $dataLength){
			if (!$this->isLogUsed) {
				$this->isLogUsed = true;
				\OC::$server->getLogger()->warning(
					'Failed to write a chunk. File is too big?',
					['app' => 'files_antivirus']
				);
			}
			// retry
			$this->initScanner();
			@fwrite($this->getWriteHandle(), $data);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		} else {
			$this->byteCount += $bytesWritten;
		}
	}

	/**
	 * Get a resource to write data into
	 * @return resource
	 */
	protected function getWriteHandle(){
		return $this->writeHandle;
	}

	/**
	 * Prepare chunk (if required)
	 * @param string $data
	 * @return string
	 */
	protected function prepareChunk($data){
		return $data;
	}
}


1		<?php
2
3		/**
4		* ownCloud - files_antivirus
5		*
6		* @author Manuel Deglado
7		* @copyright 2012 Manuel Deglado [email protected]
8		*
9		* This library is free software; you can redistribute it and/or
10		* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
11		* License as published by the Free Software Foundation; either
12		* version 3 of the License, or any later version.
13		*
14		* This library is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
18		*
19		* You should have received a copy of the GNU Affero General Public
20		* License along with this library. If not, see <http://www.gnu.org/licenses/>.
21		*
22		*/
23
24		namespace OCA\Files_Antivirus;
25
26		abstract class Scanner {
27
28		/**
29		* Scan result
30		* @var \OCA\Files_Antivirus\Status
31		*/
32		protected $status;
33
34		/** @var int */
35		protected $byteCount;
36
37		/** @var resource */
38		protected $writeHandle;
39
40		/** @var \OCA\Files_Antivirus\AppConfig */
41		protected $appConfig;
42
43		/** @var bool */
44		protected $isLogUsed;
45
46		/**
47		* Close used resources
48		*/
49		abstract protected function shutdownScanner();
50
51
52	3	public function getStatus(){
53	3	if ($this->status instanceof Status){
54	3	return $this->status;
55		}
56		return new Status();
57		}
58
59		/**
60		* Synchronous scan
61		* @param IScannable $item
62		* @return Status
63		*/
64	3	public function scan(IScannable $item) {
65	3	$this->initScanner();
66
67	3	while (false !== ($chunk = $item->fread())) {
68	3	$this->writeChunk($chunk);
69	3	}
70
71	3	$this->shutdownScanner();
72	3	return $this->getStatus();
73		}
74
75		/**
76		* Async scan - new portion of data is available
77		* @param string $data
78		*/
79		public function onAsyncData($data){
80		$this->writeChunk($data);
81		}
82
83		/**
84		* Async scan - resource is closed
85		* @return Status
86		*/
87		public function completeAsyncScan(){
88		$this->shutdownScanner();
89		return $this->getStatus();
90		}
91
92		/**
93		* Open write handle. etc
94		*/
95	3	public function initScanner(){
96	3	$this->byteCount = 0;
97	3	$this->status = new Status();
98	3	}
99
100		/**
101		* @param string $chunk
102		*/
103	3	protected function writeChunk($chunk){
104	3	$this->fwrite(
105	3	$this->prepareChunk($chunk)
106	3	);
107	3	}
108
109		/**
110		* @param string $data
111		*/
112	3	protected final function fwrite($data){
113	3	$dataLength = strlen($data);
114	3	$fileSizeLimit = intval($this->appConfig->getAvMaxFileSize());
115	3	if ($fileSizeLimit !== -1 && $this->byteCount + $dataLength > $fileSizeLimit){
116	3	$this->shutdownScanner();
117	3	$this->initScanner();
118	3	}
119
120	3	$bytesWritten = @fwrite($this->getWriteHandle(), $data);
121	3	if ($bytesWritten === false \|\| $bytesWritten < $dataLength){
122		if (!$this->isLogUsed) {
123		$this->isLogUsed = true;
124		\OC::$server->getLogger()->warning(
125		'Failed to write a chunk. File is too big?',
126		['app' => 'files_antivirus']
127		);
128		}
129		// retry
130		$this->initScanner();
131		@fwrite($this->getWriteHandle(), $data);
		0 ignored issues – show Security Best Practice introduced 2016-11-03 17:22 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
132		} else {
133	3	$this->byteCount += $bytesWritten;
134		}
135	3	}
136
137		/**
138		* Get a resource to write data into
139		* @return resource
140		*/
141	3	protected function getWriteHandle(){
142	3	return $this->writeHandle;
143		}
144
145		/**
146		* Prepare chunk (if required)
147		* @param string $data
148		* @return string
149		*/
150	3	protected function prepareChunk($data){
151	3	return $data;
152		}
153		}
154

owncloud / files_antivirus

Pull Request — stable8.2 (#145)

Scanner::writeChunk() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like