public function Executable::scan in ClamAV 8

Same name and namespace in other branches

1. 2.x src/Scanner/Executable.php \Drupal\clamav\Scanner\Executable::scan()

Scan a file.

Parameters

Drupal\file\FileInterface $file: The file to scan for viruses.

Return value

int

• Scanner::FILE_IS_CLEAN
• Scanner::FILE_IS_INFECTED
• Scanner::FILE_IS_UNCHECKED

Overrides ScannerInterface::scan

File

src/Scanner/Executable.php, line 27

Class

Executable

Namespace

Drupal\clamav\Scanner

Code

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;
  }
}