Manual:$wgAntivirusSetup
From mediawiki.org
| Antivirus: $wgAntivirusSetup | |
|---|---|
| Configuration for different virus scanners. |
|
| Introduced in version: | 1.5.0 |
| Removed in version: | Still in use |
| Allowed values: | Unspecified |
| Default value: | (see below) |
| Other settings: Alphabetical | By function | |
Details
[edit ]Configuration for different virus scanners. This is an associative array of associative arrays: it contains one setup array per known scanner type. The entry is selected by $wgAntivirus , i.e. valid values for $wgAntivirus are the keys defined in this array.
The configuration array for each scanner contains the following keys:
command- The full command to call the virus scanner - %f will be replaced with the name of the file to scan. If not present, the filename will be appended to the command.
- Note that this must be overwritten if the scanner is not in the system path; in that case, you should set
$wgAntivirusSetup[$wgAntivirus ]['command']to the desired command with full path. (This line should appear after the line that sets $wgAntivirus.) codemap- A mapping of exit code to return codes of the
detectVirus()function in "SpecialUpload.php".- An exit code mapped to
AV_SCAN_FAILEDcauses the function to consider the scan to be failed. This will pass the file if $wgAntivirusRequired is not set. - An exit code mapped to
AV_SCAN_ABORTEDcauses the function to consider the file to have an unsupported format, which is probably immune to viruses. This causes the file to pass. - An exit code mapped to
AV_NO_VIRUSwill cause the file to pass, meaning no virus was found. - All other codes (like
AV_VIRUS_FOUND) will cause the function to report a virus.
- An exit code mapped to
- You may use
"*"as a key in the array to catch all exit codes not mapped otherwise. messagepattern- A Perl regular expression to extract the meaningful part of the scanner's output. The relevant part should be matched as group one (
1円). - If not defined or the pattern does not match, the full message is shown to the user.
Default values
[edit ] MediaWiki version:
≥ 1.20
$wgAntivirusSetup = [ # setup for clamav 'clamav' => [ 'command' => 'clamscan --no-summary ', 'codemap' => [ "0" => AV_NO_VIRUS, # no virus "1" => AV_VIRUS_FOUND, # virus found "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune) "*" => AV_SCAN_FAILED, # else scan failed ], 'messagepattern' => '/.*?:(.*)/sim', ], ];
MediaWiki versions:
1.5 – 1.19
$wgAntivirusSetup = array( #setup for clamav 'clamav' => array ( 'command' => "clamscan --no-summary ", 'codemap' => array ( "0" => AV_NO_VIRUS, # no virus "1" => AV_VIRUS_FOUND, # virus found "52" => AV_SCAN_ABORTED, # unsupported file format (probably imune) "*" => AV_SCAN_FAILED, # else scan failed ), 'messagepattern' => '/.*?:(.*)/sim', ), #setup for f-prot 'f-prot' => array ( 'command' => "f-prot ", 'codemap' => array ( "0" => AV_NO_VIRUS, # no virus "3" => AV_VIRUS_FOUND, # virus found "6" => AV_VIRUS_FOUND, # virus found "*" => AV_SCAN_FAILED, # else scan failed ), 'messagepattern' => '/.*?Infection:(.*)$/m', ), );