git: Fix handling of utf-8 filenames in recentchanges.

[git.ikiwiki.info.git] / IkiWiki / Plugin / attachment.pm

diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
index 720078be15cfcd51399f375815b4d22e1a2e8d7b..f1a9b19394701ea82558513ecc423b451ba2ddc4 100644 (file)
--- a/IkiWiki/Plugin/attachment.pm
+++ b/IkiWiki/Plugin/attachment.pm
@@ -6,11 +6,36 @@ use strict;
 use IkiWiki 2.00;
 
 sub import { #{{{
 use IkiWiki 2.00;
 
 sub import { #{{{

+       hook(type => "getsetup", id => "attachment", call => \&getsetup);

        hook(type => "checkconfig", id => "attachment", call => \&checkconfig);
        hook(type => "formbuilder_setup", id => "attachment", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "attachment", call => \&formbuilder);
        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
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+               allowed_attachments => {
+                       type => "pagespec",
+                       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 ($$;$) { #{{{
        my $session=shift;
        my $dest=shift; # where it's going to be put, under the srcdir
 sub check_canattach ($$;$) { #{{{
        my $session=shift;
        my $dest=shift; # where it's going to be put, under the srcdir


@@ -18,25 +43,40 @@ sub check_canattach ($$;$) { #{{{
 
        # Don't allow an attachment to be uploaded with the same name as an
        # existing page.
 
        # 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));
        }
 
        # Use a special pagespec to test that the attachment is valid.
        my $allowed=1;
                error(sprintf(gettext("there is already a page named %s"), $dest));
        }
 
        # Use a special pagespec to test that the attachment is valid.
        my $allowed=1;

-       foreach my $admin (@{$config{adminuser}}) {
-               my $allowed_attachments=IkiWiki::userinfo_get($admin, "allowed_attachments");
-               if (defined $allowed_attachments &&
-                   length $allowed_attachments) {
-                       $allowed=pagespec_match($dest,
-                               $allowed_attachments,
-                               file => $file,
-                               user => $session->param("name"),
-                               ip => $ENV{REMOTE_ADDR},
-                       );
-                       last if $allowed;
+       if (defined $config{allowed_attachments} &&
+           length $config{allowed_attachments}) {
+               $allowed=pagespec_match($dest,
+                       $config{allowed_attachments},
+                       file => $file,
+                       user => $session->param("name"),
+                       ip => $ENV{REMOTE_ADDR},
+               );
+       }
+
+       # XXX deprecated, should be removed eventually
+       if ($allowed) {
+               foreach my $admin (@{$config{adminuser}}) {
+                       my $allowed_attachments=IkiWiki::userinfo_get($admin, "allowed_attachments");
+                       if (defined $allowed_attachments &&
+                           length $allowed_attachments) {
+                               $allowed=pagespec_match($dest,
+                                       $allowed_attachments,
+                                       file => $file,
+                                       user => $session->param("name"),
+                                       ip => $ENV{REMOTE_ADDR},
+                               );
+                               last if $allowed;
+                       }

                }
        }
                }
        }

+

        if (! $allowed) {
                error(gettext("prohibited by allowed_attachments")." ($allowed)");
        }
        if (! $allowed) {
                error(gettext("prohibited by allowed_attachments")." ($allowed)");
        }


@@ -79,30 +119,35 @@ sub formbuilder_setup (@) { #{{{
                }
        }
        elsif ($form->title eq "preferences") {
                }
        }
        elsif ($form->title eq "preferences") {

+               # XXX deprecated, should remove eventually

                my $session=$params{session};
                my $user_name=$session->param("name");
 
                $form->field(name => "allowed_attachments", size => 50,
                        fieldset => "admin",
                my $session=$params{session};
                my $user_name=$session->param("name");
 
                $form->field(name => "allowed_attachments", size => 50,
                        fieldset => "admin",

-                       comment => "(".
-                               htmllink("", "", 
-                                       "ikiwiki/PageSpec/attachment", 
-                                       noimageinline => 1,
-                                       linktext => "Enhanced PageSpec",
-                               ).")"
+                       comment => "deprecated; please move to allowed_attachments in setup file",

                );
                if (! IkiWiki::is_admin($user_name)) {
                        $form->field(name => "allowed_attachments", type => "hidden");
                }
                 if (! $form->submitted) {
                );
                if (! IkiWiki::is_admin($user_name)) {
                        $form->field(name => "allowed_attachments", type => "hidden");
                }
                 if (! $form->submitted) {

-                       $form->field(name => "allowed_attachments", force => 1,
-                               value => IkiWiki::userinfo_get($user_name, "allowed_attachments"));
+                       my $value=IkiWiki::userinfo_get($user_name, "allowed_attachments");
+                       if (length $value) {
+                               $form->field(name => "allowed_attachments", force => 1,
+                                       value => IkiWiki::userinfo_get($user_name, "allowed_attachments"));
+                       }
+                       else {
+                               $form->field(name => "allowed_attachments", type => "hidden");
+                       }

                 }
                if ($form->submitted && $form->submitted eq 'Save Preferences') {
                        if (defined $form->field("allowed_attachments")) {
                                IkiWiki::userinfo_set($user_name, "allowed_attachments",
                                $form->field("allowed_attachments")) ||
                                        error("failed to set allowed_attachments");
                 }
                if ($form->submitted && $form->submitted eq 'Save Preferences') {
                        if (defined $form->field("allowed_attachments")) {
                                IkiWiki::userinfo_set($user_name, "allowed_attachments",
                                $form->field("allowed_attachments")) ||
                                        error("failed to set allowed_attachments");

+                               if (! length $form->field("allowed_attachments")) {
+                                       $form->field(name => "allowed_attachments", type => "hidden");
+                               }

                        }
                }
        }
                        }
                }
        }


@@ -232,7 +277,7 @@ sub attachment_list ($) { #{{{
                        push @ret, {
                                "field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
                                link => htmllink($page, $page, $f, noimageinline => 1),
                        push @ret, {
                                "field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
                                link => htmllink($page, $page, $f, noimageinline => 1),

-                               size => humansize((stat(_))[7]),
+                               size => IkiWiki::Plugin::filecheck::humansize((stat(_))[7]),

                                mtime => displaytime($IkiWiki::pagemtime{$f}),
                                mtime_raw => $IkiWiki::pagemtime{$f},
                        };
                                mtime => displaytime($IkiWiki::pagemtime{$f}),
                                mtime_raw => $IkiWiki::pagemtime{$f},
                        };


@@ -244,205 +289,45 @@ sub attachment_list ($) { #{{{
        return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} } @ret;
 } #}}}
 
        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;
 
 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 ($$;@) { #{{{
+sub match_user ($$;@) { #{{{

        shift;
        shift;

-       my $wanted=shift;
-
+       my $user=shift;

        my %params=@_;
        my %params=@_;

-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
+       
+       if (! exists $params{user}) {
+               return IkiWiki::FailReason->new("no user 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";
+       if (defined $params{user} && lc $params{user} eq lc $user) {
+               return IkiWiki::SuccessReason->new("user is $user");

        }
        }

-
-       my $regexp=IkiWiki::glob2re($wanted);
-       if ($mimetype!~/^$regexp$/i) {
-               return IkiWiki::FailReason->new("file MIME type is $mimetype, not $wanted");
+       elsif (! defined $params{user}) {
+               return IkiWiki::FailReason->new("not logged in");

        }
        else {
        }
        else {

-               return IkiWiki::SuccessReason->new("file MIME type is $mimetype");
+               return IkiWiki::FailReason->new("user is $params{user}, not $user");

        }
 } #}}}
 
        }
 } #}}}
 

-sub match_virusfree ($$;@) { #{{{
+sub match_admin ($$;@) { #{{{

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

-       my $user=shift;

        my %params=@_;
        
        if (! exists $params{user}) {
                return IkiWiki::FailReason->new("no user specified");
        }
 
        my %params=@_;
        
        if (! exists $params{user}) {
                return IkiWiki::FailReason->new("no user specified");
        }
 

-       if (defined $params{user} && lc $params{user} eq lc $user) {
-               return IkiWiki::SuccessReason->new("user is $user");
+       if (defined $params{user} && IkiWiki::is_admin($params{user})) {
+               return IkiWiki::SuccessReason->new("user is an admin");

        }
        elsif (! defined $params{user}) {
                return IkiWiki::FailReason->new("not logged in");
        }
        else {
        }
        elsif (! defined $params{user}) {
                return IkiWiki::FailReason->new("not logged in");
        }
        else {

-               return IkiWiki::FailReason->new("user is $params{user}, not $user");
+               return IkiWiki::FailReason->new("user is not an admin");

        }
 } #}}}
 
        }
 } #}}}