OCA\Files_Antivirus\Db\RuleMapper

Complexity

Total Complexity

8

Size/Duplication

Total Lines	251
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

95.04%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	deleteAll()	0	4	1
A	find()	0	4	1
A	findAll()	0	4	1
A	findByResult()	0	4	1
A	findAllMatchedByStatus()	0	4	1
B	populate()	0	179	2

<?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 <dubiniuk@owncloud.com>
 *
 * @copyright Viktar Dubiniuk 2015-2018
 * @license AGPL-3.0
 */

namespace OCA\Files_Antivirus\Db;

use OCA\Files_Antivirus\Status;
use OCP\IDb;
use OCP\AppFramework\Db\Mapper;

/**
 * Class RuleMapper
 *
 * @package OCA\Files_Antivirus\Db
 */
class RuleMapper extends Mapper {
	/**
	 * RuleMapper constructor.
	 *
	 * @param IDb $db
	 */
	public function __construct(IDb $db) {
		parent::__construct(
			$db,
			'files_avir_status',
			'\OCA\Files_Antivirus\Db\Rule'
		);
	}
	
	/**
	 * Empty the table
	 *
	 * @return bool
	 */
	public function deleteAll() {
		$sql = 'DELETE FROM `*PREFIX*files_avir_status`';
		return $this->execute($sql);
	}
	
	/**
	 * Find rule by id
	 *
	 * @param int $id
	 *
	 * @return Rule
	 */
	public function find($id) {
		$sql = 'SELECT * FROM `*PREFIX*files_avir_status` WHERE `id` = ?';
		return $this->findEntity($sql, [$id]);
	}
	
	/**
	 * Get all rules
	 */
	public function findAll() {
		$sql = 'SELECT * FROM `*PREFIX*files_avir_status`';
		return $this->findEntities($sql);
	}

	/**
	 * Get collection of rules by given exit code
	 *
	 * @param int $result
	 *
	 * @return array
	 */
	public function findByResult($result) {
		$sql = 'SELECT * FROM `*PREFIX*files_avir_status` WHERE `status_type`=? and `result`=?';
		return $this->findEntities($sql, [Rule::RULE_TYPE_CODE, $result]);
	}
	
	/**
	 * Get collection of rules of type Match
	 *
	 * @param int $status
	 *
	 * @return array
	 */
	public function findAllMatchedByStatus($status) {
		$sql = 'SELECT * FROM `*PREFIX*files_avir_status` WHERE `status_type`=? and `status`=?';
		return $this->findEntities($sql, [Rule::RULE_TYPE_MATCH, $status]);
	}
	
	/**
	 * Fill the table with rules used with clamav
	 */
	public function populate() {
		$descriptions = [
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 0,
				'match' => '',
				'description' => "",
				'status' => Status::SCANRESULT_CLEAN
			],

			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 1,
				'match' => '',
				'description' => "",
				'status' => Status::SCANRESULT_INFECTED
			],
		
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 40,
				'match' => '',
				'description' => "Unknown option passed.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 50,
				'match' => '',
				'description' => "Database initialization error.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 52,
				'match' => '',
				'description' => "Not supported file type.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 53,
				'match' => '',
				'description' => "Can't open directory.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 54,
				'match' => '',
				'description' => "Can't open file. (ofm)",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 55,
				'match' => '',
				'description' => "Error reading file. (ofm)",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 56,
				'match' => '',
				'description' => "Can't stat input file / directory.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 57,
				'match' => '',
				'description' => "Can't get absolute path name of current working directory.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 58,
				'match' => '',
				'description' => "I/O error, please check your file system.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 62,
				'match' => '',
				'description' => "Can't initialize logger.",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 63,
				'match' => '',
				'description' => "Can't create temporary files/directories (check permissions).",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 64,
				'match' => '',
				'description' => "Can't write to temporary directory (please specify another one).",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 70,
				'match' => '',
				'description' => "Can't allocate memory (calloc).",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_CODE,
				'result' => 71,
				'match' => '',
				'description' => "Can't allocate memory (malloc).",
				'status' => Status::SCANRESULT_UNCHECKED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_MATCH,
				'result' => 0,
				'match' => '/.*: OK$/',
				'description' => '',
				'status' => Status::SCANRESULT_CLEAN
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_MATCH,
				'result' => 0,
				'match' => '/.*: (.*) FOUND$/',
				'description' => '',
				'status' => Status::SCANRESULT_INFECTED
			],
			
			[
				'groupId' => 0,
				'statusType' => Rule::RULE_TYPE_MATCH,
				'result' => 0,
				'match' => '/.*: (.*) ERROR$/',
				'description' => '',
				'status' => Status::SCANRESULT_UNCHECKED
			],
		];
		
		foreach ($descriptions as $description) {
			$rule = Rule::fromParams($description);
			$this->insert($rule);
		}
	}
}