LocalClam::shutdownScanner() - Code Metrics - nextcloud/files_antivirus - Measure and Improve Code Quality continuously with Scrutinizer

LocalClam::shutdownScanner() A
last analyzed 2021-06-25 11:46 UTC

↳ Parent: LocalClam

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Copyright (c) 2014 Victor 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\Scanner;

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

class LocalClam extends ScannerBase {

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

	/**
	 * STDIN and STDOUT descriptors
	 * @var array of resources
	 */
	private $pipes = [];

	/**
	 * Process handle
	 * @var resource
	 */
	private $process;

	public function __construct(AppConfig $config, ILogger $logger, StatusFactory $statusFactory) {
		parent::__construct($config, $logger, $statusFactory);

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

		// check that the executable is available
		if (!file_exists($this->avPath)) {
			throw new \RuntimeException('The antivirus executable could not be found at ' . $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 \RuntimeException('Error starting process');
		}
		$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		* Copyright (c) 2014 Victor 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
10		namespace OCA\Files_Antivirus\Scanner;
11
12		use OCA\Files_Antivirus\AppConfig;
13		use OCA\Files_Antivirus\StatusFactory;
14		use OCP\ILogger;
15
16		class LocalClam extends ScannerBase {
17
18		/**
19		* @var string
20		*/
21		protected $avPath;
22
23		/**
24		* STDIN and STDOUT descriptors
25		* @var array of resources
26		*/
27		private $pipes = [];
28
29		/**
30		* Process handle
31		* @var resource
32		*/
33		private $process;
34
35	1	public function __construct(AppConfig $config, ILogger $logger, StatusFactory $statusFactory) {
36	1	parent::__construct($config, $logger, $statusFactory);
37
38		// get the path to the executable
39	1	$this->avPath = escapeshellcmd($this->appConfig->getAvPath());
40
41		// check that the executable is available
42	1	if (!file_exists($this->avPath)) {
43	1	throw new \RuntimeException('The antivirus executable could not be found at ' . $this->avPath);
44		}
45		}
46
47		public function initScanner() {
48		parent::initScanner();
49
50		// using 2>&1 to grab the full command-line output.
51		$cmd = $this->avPath . ' ' . $this->appConfig->getCmdline() . ' - 2>&1';
52		$descriptorSpec = [
53		0 => ['pipe', 'r'], // STDIN
54		1 => ['pipe', 'w'] // STDOUT
55		];
56
57		$this->process = proc_open($cmd, $descriptorSpec, $this->pipes);
58		if (!is_resource($this->process)) {
59		throw new \RuntimeException('Error starting process');
60		}
61		$this->writeHandle = $this->pipes[0];
62		}
63
64		protected function shutdownScanner() {
65		@fclose($this->pipes[0]);
		0 ignored issues – show Security Best Practice introduced 2017-02-07 20:56 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...
66		$output = stream_get_contents($this->pipes[1]);
67		@fclose($this->pipes[1]);
		0 ignored issues – show Security Best Practice introduced 2017-02-07 20:56 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...
68
69		$result = proc_close($this->process);
70		$this->logger->debug(
		0 ignored issues – show Deprecated Code introduced 2021-06-02 14:42 UTC by Report Bug Copy Issue Report The method `OCP\ILogger::debug()` has been deprecated with message: 20.0.0 use \Psr\Log\LoggerInterface::debug This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
71		'Exit code :: ' . $result . ' Response :: ' . $output,
72		['app' => 'files_antivirus']
73		);
74		$this->status->parseResponse($output, $result);
75		}
76		}
77

nextcloud / files_antivirus

LocalClam::shutdownScanner() A last analyzed 2021-06-25 11:46 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

LocalClam::shutdownScanner() A
last analyzed 2021-06-25 11:46 UTC