org.craftercms.virusscanner.impl.ClamavVirusScannerImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crafter-virus-scanner Show documentation
Crafter Social Virus Scanner
There is a newer version: 4.3.1
Show newest version
package org.craftercms.virusscanner.impl;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

import clamavj.ClamScan;
import clamavj.ScanResult;
import org.craftercms.virusscanner.api.VirusScanner;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A virus scanner that uses ClamScan to scan input-streams/files
 */
public class ClamavVirusScannerImpl implements VirusScanner {

	public static final String THREAT_FOUND_MESSAGE = "Threat found";
	public static final String FILE_NOT_FOUND_MESSAGE = "File not found";
	public static final String SCAN_FAILED_MESSAGE = "Scan failed";

	private static Logger log = LoggerFactory.getLogger(ClamavVirusScannerImpl.class);

	private String host;
	private int port;
	private int timeout;

    public ClamavVirusScannerImpl() {
        this("localhost",3310,60000);
    }

    /**
     *
     * @param host the clamd server host
     * @param port the clamd server port
     * @param timeout milliseconds to wait for the connection
     */
	public ClamavVirusScannerImpl(String host, int port, int timeout) {
		this.host = host;
		this.port = port;
		this.timeout = timeout;
	}

    /**
     *
     * @param filename full path
     * @return  null for a successful scan (the file is clean) or an error message if the scan fails or a threat is found
     */
	public void scan(String filename) {
        try {
            scan(new FileInputStream(filename));
        } catch (FileNotFoundException e) {
            throw new VirusScannerException("Unable to read given file",e);
        }

    }

    /**
     *
     * @param inputStream
     * @return  null for a successful scan (the input stream is clean) or an error message if the scan fails or a threat is found
     */
	public void scan(InputStream inputStream) {
		ClamScan clamScan;
		ScanResult scanResult;

		if (inputStream != null) {

			String result;
			String statusName;
			String signature;

			clamScan = new ClamScan(this.host, this.port, this.timeout);

			scanResult = clamScan.scan(inputStream);

			result = scanResult.getResult();
			signature = scanResult.getSignature();
			statusName = scanResult.getStatus().name();

			if (scanResult.getStatus().compareTo(ScanResult.Status.ERROR) == 0) {
                final String msg = "STATUS: " + statusName + " - RESULT: " + result + " - EXCEPTION: " + scanResult
                    .getException() ;
				log.error(msg);
                throw new VirusScannerException(msg,scanResult.getException());
			} else if (scanResult.getStatus().compareTo(ScanResult.Status.FAILED) == 0) {
                final String msg = "STATUS: " + statusName + " - RESULT: " + result + " - SIGNATURE " + signature +
                    "" + " - USER ";
                throw new VirusScannerException(msg,scanResult.getException());
			} else {
				log.debug("STATUS: " + statusName + " - RESULT: " + result);
			}
		} else {
			throw new IllegalArgumentException("null inputStream");
		}
	}

    /**
     *
     * @param host the clamd server host
     */
    public void setHost(String host) {
        this.host = host;
    }

    /**
     *
     * @param port the clamd server port
     */
    public void setPort(int port) {
        this.port = port;
    }

    /**
     *
     * @param timeout milliseconds to wait for the connection
     */
    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }

    /**
     *
     * @return the clamd server host
     */
    public String getHost() {
        return host;
    }

    /**
     *
     * @return the clamd server port
     */
    public int getPort() {
        return port;
    }

    /**
     *
     * @return the milliseconds to wait for the connection
     */
    public int getTimeout() {
        return timeout;
    }


}