]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/attachment.pm
filecheck: New plugin factoring out the PageSpec additions that were originally part...
[ikiwiki.git] / IkiWiki / Plugin / attachment.pm
index 63f0b73c3b330760fd5342657fa691bc421fc155..f1f792a5a56ffc4cdd5ec4547d614ddf98570de2 100644 (file)
@@ -10,25 +10,30 @@ sub import { #{{{
        hook(type => "checkconfig", id => "attachment", call => \&checkconfig);
        hook(type => "formbuilder_setup", id => "attachment", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "attachment", call => \&formbuilder);
+       IkiWiki::loadplugin("filecheck");
 } # }}}
 
 sub getsetup () { #{{{
        return
-               virus_checker => {
-                       type => "string",
-                       example => "clamdscan -",
-                       description => "virus checker program (reads STDIN, returns nonzero if virus found)",
-                       safe => 0, # executed
+               plugin => {
+                       safe => 1,
                        rebuild => 0,
                },
                allowed_attachments => {
                        type => "pagespec",
-                       example => "mimetype(image/*) and maxsize(50kb)",
+                       example => "virusfree() and mimetype(image/*) and maxsize(50kb)",
                        description => "enhanced PageSpec specifying what attachments are allowed",
                        link => "ikiwiki/PageSpec/attachment",
                        safe => 1,
                        rebuild => 0,
                },
+               virus_checker => {
+                       type => "string",
+                       example => "clamdscan -",
+                       description => "virus checker program (reads STDIN, returns nonzero if virus found)",
+                       safe => 0, # executed
+                       rebuild => 0,
+               },
 } #}}}
 
 sub check_canattach ($$;$) { #{{{
@@ -38,7 +43,8 @@ sub check_canattach ($$;$) { #{{{
 
        # Don't allow an attachment to be uploaded with the same name as an
        # existing page.
-       if (exists $pagesources{$dest} && $pagesources{$dest} ne $dest) {
+       if (exists $IkiWiki::pagesources{$dest} &&
+           $IkiWiki::pagesources{$dest} ne $dest) {
                error(sprintf(gettext("there is already a page named %s"), $dest));
        }
 
@@ -139,7 +145,7 @@ sub formbuilder_setup (@) { #{{{
                                IkiWiki::userinfo_set($user_name, "allowed_attachments",
                                $form->field("allowed_attachments")) ||
                                        error("failed to set allowed_attachments");
-                               if (length $form->field("allowed_attachments")) {
+                               if (length $form->field("allowed_attachments")) {
                                        $form->field(name => "allowed_attachments", type => "hidden");
                                }
                        }
@@ -283,188 +289,8 @@ sub attachment_list ($) { #{{{
        return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} } @ret;
 } #}}}
 
-my %units=( #{{{       # size in bytes
-       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
-); #}}}
-
-sub parsesize ($) { #{{{
-       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;
-} #}}}
-
-sub humansize ($) { #{{{
-       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
-} #}}}
-
 package IkiWiki::PageSpec;
 
-sub match_maxsize ($$;@) { #{{{
-       shift;
-       my $maxsize=eval{IkiWiki::Plugin::attachment::parsesize(shift)};
-       if ($@) {
-               return IkiWiki::FailReason->new("unable to parse maxsize (or number too large)");
-       }
-
-       my %params=@_;
-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
-       }
-
-       if (-s $params{file} > $maxsize) {
-               return IkiWiki::FailReason->new("file too large (".(-s $params{file})." >  $maxsize)");
-       }
-       else {
-               return IkiWiki::SuccessReason->new("file not too large");
-       }
-} #}}}
-
-sub match_minsize ($$;@) { #{{{
-       shift;
-       my $minsize=eval{IkiWiki::Plugin::attachment::parsesize(shift)};
-       if ($@) {
-               return IkiWiki::FailReason->new("unable to parse minsize (or number too large)");
-       }
-
-       my %params=@_;
-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
-       }
-
-       if (-s $params{file} < $minsize) {
-               return IkiWiki::FailReason->new("file too small");
-       }
-       else {
-               return IkiWiki::SuccessReason->new("file not too small");
-       }
-} #}}}
-
-sub match_mimetype ($$;@) { #{{{
-       shift;
-       my $wanted=shift;
-
-       my %params=@_;
-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
-       }
-
-       # 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 ($@) {
-               return IkiWiki::FailReason->new("failed to load File::MimeInfo::Magic ($@); cannot check MIME type");
-       }
-       my $mimetype=File::MimeInfo::Magic::magic($params{file});
-       if (! defined $mimetype) {
-               $mimetype="unknown";
-       }
-
-       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");
-       }
-} #}}}
-
-sub match_virusfree ($$;@) { #{{{
-       shift;
-       my $wanted=shift;
-
-       my %params=@_;
-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
-       }
-
-       if (! exists $IkiWiki::config{virus_checker} ||
-           ! length $IkiWiki::config{virus_checker}) {
-               return IkiWiki::FailReason->new("no virus_checker configured");
-       }
-
-       # 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 $@;
-       open (IN, "<", $params{file}) || return IkiWiki::FailReason->new("failed to read file");
-       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)");
-       }
-} #}}}
-
-sub match_ispage ($$;@) { #{{{
-       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");
-       }
-} #}}}
-
 sub match_user ($$;@) { #{{{
        shift;
        my $user=shift;