class Executable in ClamAV 8

Hierarchy

• class \Drupal\clamav\Scanner\Executable implements ScannerInterface

1 string reference to 'Executable'

ClamAVConfigForm::buildForm in src/Form/ClamAVConfigForm.php

Form constructor.

File

src/Scanner/Executable.php, line 10

Namespace

Drupal\clamav\Scanner

class Executable implements ScannerInterface {
  private $_executable_path = '';
  private $_executable_parameters = '';
  private $_file = '';
  protected $_virus_name = '';

  /**
   * {@inheritdoc}
   */
  public function __construct(Config $config) {
    $this->_executable_path = $config
      ->get('mode_executable.executable_path');
    $this->_executable_parameters = $config
      ->get('mode_executable.executable_parameters');
  }

  /**
   * {@inheritdoc}
   */
  public function scan(FileInterface $file) {

    // Verify that the executable exists.
    if (!file_exists($this->_executable_path)) {
      \Drupal::logger('Clam AV')
        ->warning('Unable to find ClamAV executable at @executable_path', array(
        '@executable_path' => $this->_executable_path,
      ));
      return Scanner::FILE_IS_UNCHECKED;
    }

    // Redirect STDERR to STDOUT to capture the full output of the ClamAV script.
    $script = "{$this->_executable_path} {$this->_executable_parameters}";
    $filename = \Drupal::service('file_system')
      ->realpath($file
      ->getFileUri());
    $cmd = escapeshellcmd($script) . ' ' . escapeshellarg($filename) . ' 2>&1';

    // Text output from the executable is assigned to: $output
    // Return code from the executable is assigned to: $return_code.
    // Possible return codes (see `man clamscan`):
    // - 0 = No virus found.
    // - 1 = Virus(es) found.
    // - 2 = Some error(s) occured.
    // Note that older versions of clamscan (prior to 0.96) may have return
    // values greater than 2. Any value of 2 or greater means that the scan
    // failed, and the file has not been checked.
    exec($cmd, $output, $return_code);
    $output = implode("\n", $output);
    switch ($return_code) {
      case 0:
        return Scanner::FILE_IS_CLEAN;

      // return array(Scanner::FILE_IS_CLEAN, $return_code, $output);
      case 1:
        return Scanner::FILE_IS_INFECTED;

      // return array(Scanner::FILE_IS_INFECTED, $return_code, $output);
      default:
        return Scanner::FILE_IS_UNCHECKED;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function virus_name() {
    return $this->_virus_name;
  }

  /**
   * {@inheritdoc}
   */
  public function version() {
    if (file_exists($this->_executable_path)) {
      return exec(escapeshellcmd($this->_executable_path) . ' -V');
    }
    else {
      return NULL;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Executable::$_executable_parameters	private	property
Executable::$_executable_path	private	property
Executable::$_file	private	property
Executable::$_virus_name	protected	property
Executable::scan	public	function	Scan a file. Overrides ScannerInterface::scan
Executable::version	public	function	The version of the ClamAV service. Overrides ScannerInterface::version
Executable::virus_name	public	function
Executable::__construct	public	function	Constructor. Overrides ScannerInterface::__construct