Local::shutdownScanner() - Code Metrics - Inspection of "add create-bucket command" - owncloud/files_antivirus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 74b39a...45a732 )

by Thomas

created 2018-07-20 06:03 UTC

Local::shutdownScanner() A

↳ Parent: Local

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	11
cts	11
cp	1
rs	9.8666
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?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 <[email protected]>
 *
 * @copyright Viktar Dubiniuk 2014-2018
 * @license AGPL-3.0
 */

namespace OCA\Files_Antivirus\Scanner;

use OCA\Files_Antivirus\AppConfig;
use OCP\ILogger;

class Local extends AbstractScanner {
	
	/**
	 * @var string
	 */
	protected $avPath;
	
	/**
	 * STDIN and STDOUT descriptors
	 *
	 * @var array of resources
	 */
	private $pipes = [];
	
	/**
	 * Process handle
	 *
	 * @var resource
	 */
	private $process;

	/**
	 * Local constructor.
	 *
	 * @param AppConfig $config
	 * @param ILogger $logger
	 *
	 * @throws InitException
	 */
	public function __construct(AppConfig $config, ILogger $logger) {
		parent::__construct($config, $logger);

		// get the path to the executable
		$this->avPath = \escapeshellcmd($this->appConfig->getAvPath());

		if (!\file_exists($this->avPath)) {
			throw new InitException(
				\sprintf(
					'The antivirus executable could not be found at path "%s"',
					$this->avPath
				)
			);
		}
	}
	
	public function initScanner() {
		parent::initScanner();
		
		// using 2>&1 to grab the full command-line output.
		$cmd = $this->avPath . " " . $this->appConfig->getCmdline() . " - 2>&1";
		$descriptorSpec = [
			0 => ["pipe","r"], // STDIN
			1 => ["pipe","w"]  // STDOUT
		];
		
		$this->process = \proc_open($cmd, $descriptorSpec, $this->pipes);
		if (!\is_resource($this->process)) {
			throw new InitException(
				\sprintf('Error starting process "%s"', $cmd)
			);
		}
		$this->writeHandle = $this->pipes[0];
	}
	
	protected function shutdownScanner() {
		@\fclose($this->pipes[0]);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		$output = \stream_get_contents($this->pipes[1]);
		@\fclose($this->pipes[1]);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		
		$result = \proc_close($this->process);
		$this->logger->debug(
			'Exit code :: ' . $result . ' Response :: ' . $output,
			['app' => 'files_antivirus']
		);
		$this->status->parseResponse($output, $result);
	}
}


1		<?php
2		/**
3		* ownCloud - Files_antivirus
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Viktar Dubiniuk <[email protected]>
9		*
10		* @copyright Viktar Dubiniuk 2014-2018
11		* @license AGPL-3.0
12		*/
13
14		namespace OCA\Files_Antivirus\Scanner;
15
16		use OCA\Files_Antivirus\AppConfig;
17		use OCP\ILogger;
18
19		class Local extends AbstractScanner {
20
21		/**
22		* @var string
23		*/
24		protected $avPath;
25
26		/**
27		* STDIN and STDOUT descriptors
28		*
29		* @var array of resources
30		*/
31		private $pipes = [];
32
33		/**
34		* Process handle
35		*
36		* @var resource
37		*/
38		private $process;
39
40		/**
41		* Local constructor.
42		*
43		* @param AppConfig $config
44		* @param ILogger $logger
45		*
46		* @throws InitException
47		*/
48	4	public function __construct(AppConfig $config, ILogger $logger) {
49	4	parent::__construct($config, $logger);
50
51		// get the path to the executable
52	4	$this->avPath = \escapeshellcmd($this->appConfig->getAvPath());
53
54	4	if (!\file_exists($this->avPath)) {
55	1	throw new InitException(
56	1	\sprintf(
57	1	'The antivirus executable could not be found at path "%s"',
58	1	$this->avPath
59	1	)
60	1	);
61		}
62	3	}
63
64	3	public function initScanner() {
65	3	parent::initScanner();
66
67		// using 2>&1 to grab the full command-line output.
68	3	$cmd = $this->avPath . " " . $this->appConfig->getCmdline() . " - 2>&1";
69		$descriptorSpec = [
70	3	0 => ["pipe","r"], // STDIN
71	3	1 => ["pipe","w"] // STDOUT
72	3	];
73
74	3	$this->process = \proc_open($cmd, $descriptorSpec, $this->pipes);
75	3	if (!\is_resource($this->process)) {
76		throw new InitException(
77		\sprintf('Error starting process "%s"', $cmd)
78		);
79		}
80	3	$this->writeHandle = $this->pipes[0];
81	3	}
82
83	3	protected function shutdownScanner() {
84	3	@\fclose($this->pipes[0]);
		0 ignored issues – show Security Best Practice introduced 2016-11-03 16:16 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...
85	3	$output = \stream_get_contents($this->pipes[1]);
86	3	@\fclose($this->pipes[1]);
		0 ignored issues – show Security Best Practice introduced 2016-11-03 16:16 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...
87
88	3	$result = \proc_close($this->process);
89	3	$this->logger->debug(
90	3	'Exit code :: ' . $result . ' Response :: ' . $output,
91	3	['app' => 'files_antivirus']
92	3	);
93	3	$this->status->parseResponse($output, $result);
94	3	}
95		}
96

owncloud / files_antivirus

Push — master ( 74b39a...45a732 )

Local::shutdownScanner() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like