2008-08-26 01:52:34 +02:00
|
|
|
#!/usr/bin/perl
|
|
|
|
package IkiWiki::Plugin::filecheck;
|
|
|
|
|
|
|
|
use warnings;
|
|
|
|
use strict;
|
2008-12-23 22:34:19 +01:00
|
|
|
use IkiWiki 3.00;
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2010-03-25 19:23:16 +01:00
|
|
|
my %units=( # size in bytes
|
2008-08-26 01:52:34 +02:00
|
|
|
B => 1,
|
|
|
|
byte => 1,
|
|
|
|
KB => 2 ** 10,
|
|
|
|
kilobyte => 2 ** 10,
|
|
|
|
K => 2 ** 10,
|
|
|
|
KB => 2 ** 10,
|
|
|
|
kilobyte => 2 ** 10,
|
|
|
|
M => 2 ** 20,
|
|
|
|
MB => 2 ** 20,
|
|
|
|
megabyte => 2 ** 20,
|
|
|
|
G => 2 ** 30,
|
|
|
|
GB => 2 ** 30,
|
|
|
|
gigabyte => 2 ** 30,
|
|
|
|
T => 2 ** 40,
|
|
|
|
TB => 2 ** 40,
|
|
|
|
terabyte => 2 ** 40,
|
|
|
|
P => 2 ** 50,
|
|
|
|
PB => 2 ** 50,
|
|
|
|
petabyte => 2 ** 50,
|
|
|
|
E => 2 ** 60,
|
|
|
|
EB => 2 ** 60,
|
|
|
|
exabyte => 2 ** 60,
|
|
|
|
Z => 2 ** 70,
|
|
|
|
ZB => 2 ** 70,
|
|
|
|
zettabyte => 2 ** 70,
|
|
|
|
Y => 2 ** 80,
|
|
|
|
YB => 2 ** 80,
|
|
|
|
yottabyte => 2 ** 80,
|
|
|
|
# ikiwiki, if you find you need larger data quantities, either modify
|
|
|
|
# yourself to add them, or travel back in time to 2008 and kill me.
|
|
|
|
# -- Joey
|
2008-12-17 21:22:16 +01:00
|
|
|
);
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2010-07-14 20:47:29 +02:00
|
|
|
sub import {
|
|
|
|
hook(type => "getsetup", id => "filecheck", call => \&getsetup);
|
|
|
|
}
|
|
|
|
|
|
|
|
sub getsetup () {
|
|
|
|
return
|
|
|
|
plugin => {
|
|
|
|
safe => 1,
|
|
|
|
rebuild => undef,
|
|
|
|
section => "misc",
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
2008-12-17 21:22:16 +01:00
|
|
|
sub parsesize ($) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $size=shift;
|
|
|
|
|
|
|
|
no warnings;
|
|
|
|
my $base=$size+0; # force to number
|
|
|
|
use warnings;
|
|
|
|
foreach my $unit (sort keys %units) {
|
|
|
|
if ($size=~/[0-9\s]\Q$unit\E$/i) {
|
|
|
|
return $base * $units{$unit};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $base;
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2008-08-27 21:31:48 +02:00
|
|
|
# This is provided for other plugins that want to convert back the other way.
|
2008-12-17 21:22:16 +01:00
|
|
|
sub humansize ($) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $size=shift;
|
|
|
|
|
|
|
|
foreach my $unit (reverse sort { $units{$a} <=> $units{$b} || $b cmp $a } keys %units) {
|
|
|
|
if ($size / $units{$unit} > 0.25) {
|
|
|
|
return (int($size / $units{$unit} * 10)/10).$unit;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $size; # near zero, or negative
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
|
|
|
|
package IkiWiki::PageSpec;
|
|
|
|
|
2008-12-17 21:22:16 +01:00
|
|
|
sub match_maxsize ($$;@) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $page=shift;
|
2008-08-28 19:04:45 +02:00
|
|
|
my $maxsize=eval{IkiWiki::Plugin::filecheck::parsesize(shift)};
|
2008-08-26 01:52:34 +02:00
|
|
|
if ($@) {
|
2009-04-23 20:07:28 +02:00
|
|
|
return IkiWiki::ErrorReason->new("unable to parse maxsize (or number too large)");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
my %params=@_;
|
2010-03-25 19:39:09 +01:00
|
|
|
my $file=exists $params{file} ? $params{file} : IkiWiki::srcfile($IkiWiki::pagesources{$page});
|
2008-08-26 01:52:34 +02:00
|
|
|
if (! defined $file) {
|
2010-03-25 19:39:09 +01:00
|
|
|
return IkiWiki::ErrorReason->new("file does not exist");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (-s $file > $maxsize) {
|
|
|
|
return IkiWiki::FailReason->new("file too large (".(-s $file)." > $maxsize)");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return IkiWiki::SuccessReason->new("file not too large");
|
|
|
|
}
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2008-12-17 21:22:16 +01:00
|
|
|
sub match_minsize ($$;@) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $page=shift;
|
2008-08-28 19:04:45 +02:00
|
|
|
my $minsize=eval{IkiWiki::Plugin::filecheck::parsesize(shift)};
|
2008-08-26 01:52:34 +02:00
|
|
|
if ($@) {
|
2009-04-23 20:07:28 +02:00
|
|
|
return IkiWiki::ErrorReason->new("unable to parse minsize (or number too large)");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
my %params=@_;
|
2010-03-25 19:39:09 +01:00
|
|
|
my $file=exists $params{file} ? $params{file} : IkiWiki::srcfile($IkiWiki::pagesources{$page});
|
2008-08-26 01:52:34 +02:00
|
|
|
if (! defined $file) {
|
2010-03-25 19:39:09 +01:00
|
|
|
return IkiWiki::ErrorReason->new("file does not exist");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (-s $file < $minsize) {
|
|
|
|
return IkiWiki::FailReason->new("file too small");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return IkiWiki::SuccessReason->new("file not too small");
|
|
|
|
}
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2008-12-17 21:22:16 +01:00
|
|
|
sub match_mimetype ($$;@) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $page=shift;
|
|
|
|
my $wanted=shift;
|
|
|
|
|
|
|
|
my %params=@_;
|
2010-03-25 19:39:09 +01:00
|
|
|
my $file=exists $params{file} ? $params{file} : IkiWiki::srcfile($IkiWiki::pagesources{$page});
|
2008-08-26 01:52:34 +02:00
|
|
|
if (! defined $file) {
|
2010-03-25 19:39:09 +01:00
|
|
|
return IkiWiki::ErrorReason->new("file does not exist");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
# Use ::magic to get the mime type, the idea is to only trust
|
|
|
|
# data obtained by examining the actual file contents.
|
|
|
|
eval q{use File::MimeInfo::Magic};
|
|
|
|
if ($@) {
|
2009-04-23 20:07:28 +02:00
|
|
|
return IkiWiki::ErrorReason->new("failed to load File::MimeInfo::Magic ($@); cannot check MIME type");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
my $mimetype=File::MimeInfo::Magic::magic($file);
|
|
|
|
if (! defined $mimetype) {
|
2008-09-01 21:00:15 +02:00
|
|
|
$mimetype=File::MimeInfo::Magic::default($file);
|
|
|
|
if (! defined $mimetype) {
|
|
|
|
$mimetype="unknown";
|
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
my $regexp=IkiWiki::glob2re($wanted);
|
|
|
|
if ($mimetype!~/^$regexp$/i) {
|
|
|
|
return IkiWiki::FailReason->new("file MIME type is $mimetype, not $wanted");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return IkiWiki::SuccessReason->new("file MIME type is $mimetype");
|
|
|
|
}
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2008-12-17 21:22:16 +01:00
|
|
|
sub match_virusfree ($$;@) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $page=shift;
|
|
|
|
my $wanted=shift;
|
|
|
|
|
|
|
|
my %params=@_;
|
2010-03-25 19:39:09 +01:00
|
|
|
my $file=exists $params{file} ? $params{file} : IkiWiki::srcfile($IkiWiki::pagesources{$page});
|
2008-08-26 01:52:34 +02:00
|
|
|
if (! defined $file) {
|
2010-03-25 19:39:09 +01:00
|
|
|
return IkiWiki::ErrorReason->new("file does not exist");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (! exists $IkiWiki::config{virus_checker} ||
|
|
|
|
! length $IkiWiki::config{virus_checker}) {
|
2009-04-23 20:07:28 +02:00
|
|
|
return IkiWiki::ErrorReason->new("no virus_checker configured");
|
2008-08-26 01:52:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
# The file needs to be fed into the virus checker on stdin,
|
|
|
|
# because the file is not world-readable, and if clamdscan is
|
|
|
|
# used, clamd would fail to read it.
|
|
|
|
eval q{use IPC::Open2};
|
|
|
|
error($@) if $@;
|
2009-04-23 20:07:28 +02:00
|
|
|
open (IN, "<", $file) || return IkiWiki::ErrorReason->new("failed to read file");
|
2008-08-26 01:52:34 +02:00
|
|
|
binmode(IN);
|
|
|
|
my $sigpipe=0;
|
|
|
|
$SIG{PIPE} = sub { $sigpipe=1 };
|
|
|
|
my $pid=open2(\*CHECKER_OUT, "<&IN", $IkiWiki::config{virus_checker});
|
|
|
|
my $reason=<CHECKER_OUT>;
|
|
|
|
chomp $reason;
|
|
|
|
1 while (<CHECKER_OUT>);
|
|
|
|
close(CHECKER_OUT);
|
|
|
|
waitpid $pid, 0;
|
|
|
|
$SIG{PIPE}="DEFAULT";
|
|
|
|
if ($sigpipe || $?) {
|
|
|
|
if (! length $reason) {
|
|
|
|
$reason="virus checker $IkiWiki::config{virus_checker}; failed with no output";
|
|
|
|
}
|
|
|
|
return IkiWiki::FailReason->new("file seems to contain a virus ($reason)");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return IkiWiki::SuccessReason->new("file seems virusfree ($reason)");
|
|
|
|
}
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|
2008-08-26 01:52:34 +02:00
|
|
|
|
2008-12-17 21:22:16 +01:00
|
|
|
sub match_ispage ($$;@) {
|
2008-08-26 01:52:34 +02:00
|
|
|
my $filename=shift;
|
|
|
|
|
|
|
|
if (defined IkiWiki::pagetype($filename)) {
|
|
|
|
return IkiWiki::SuccessReason->new("file is a wiki page");
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return IkiWiki::FailReason->new("file is not a wiki page");
|
|
|
|
}
|
2008-12-17 21:22:16 +01:00
|
|
|
}
|