c8cabe18ce23530ad91a1ad904f1b19e9521a120
[ikiwiki.git] / IkiWiki / Plugin / attachment.pm
1 #!/usr/bin/perl
2 package IkiWiki::Plugin::attachment;
3
4 use warnings;
5 use strict;
6 use IkiWiki 3.00;
7
8 sub import {
9         add_underlay("javascript");
10         hook(type => "getsetup", id => "attachment", call => \&getsetup);
11         hook(type => "checkconfig", id => "attachment", call => \&checkconfig);
12         hook(type => "formbuilder_setup", id => "attachment", call => \&formbuilder_setup);
13         hook(type => "formbuilder", id => "attachment", call => \&formbuilder);
14         IkiWiki::loadplugin("filecheck");
15 }
16
17 sub getsetup () {
18         return
19                 plugin => {
20                         safe => 1,
21                         rebuild => 0,
22                         section => "web",
23                 },
24                 allowed_attachments => {
25                         type => "pagespec",
26                         example => "virusfree() and mimetype(image/*) and maxsize(50kb)",
27                         description => "enhanced PageSpec specifying what attachments are allowed",
28                         link => "ikiwiki/PageSpec/attachment",
29                         safe => 1,
30                         rebuild => 0,
31                 },
32                 virus_checker => {
33                         type => "string",
34                         example => "clamdscan -",
35                         description => "virus checker program (reads STDIN, returns nonzero if virus found)",
36                         safe => 0, # executed
37                         rebuild => 0,
38                 },
39 }
40
41 sub check_canattach ($$;$) {
42         my $session=shift;
43         my $dest=shift; # where it's going to be put, under the srcdir
44         my $file=shift; # the path to the attachment currently
45
46         # Don't allow an attachment to be uploaded with the same name as an
47         # existing page.
48         if (exists $IkiWiki::pagesources{$dest} &&
49             $IkiWiki::pagesources{$dest} ne $dest) {
50                 error(sprintf(gettext("there is already a page named %s"), $dest));
51         }
52
53         # Use a special pagespec to test that the attachment is valid.
54         my $allowed=1;
55         if (defined $config{allowed_attachments} &&
56             length $config{allowed_attachments}) {
57                 $allowed=pagespec_match($dest,
58                         $config{allowed_attachments},
59                         file => $file,
60                         user => $session->param("name"),
61                         ip => $session->remote_addr(),
62                 );
63         }
64
65         if (! $allowed) {
66                 error(gettext("prohibited by allowed_attachments")." ($allowed)");
67         }
68         else {
69                 return 1;
70         }
71 }
72
73 sub checkconfig () {
74         $config{cgi_disable_uploads}=0;
75 }
76
77 sub formbuilder_setup (@) {
78         my %params=@_;
79         my $form=$params{form};
80         my $q=$params{cgi};
81
82         if (defined $form->field("do") && ($form->field("do") eq "edit" ||
83             $form->field("do") eq "create")) {
84                 # Add attachment field, set type to multipart.
85                 $form->enctype(&CGI::MULTIPART);
86                 $form->field(name => 'attachment', type => 'file');
87                 # These buttons are not put in the usual place, so
88                 # are not added to the normal formbuilder button list.
89                 $form->tmpl_param("field-upload" => '<input name="_submit" type="submit" value="Upload Attachment" />');
90                 $form->tmpl_param("field-link" => '<input name="_submit" type="submit" value="Insert Links" />');
91
92                 # Add the toggle javascript; the attachments interface uses
93                 # it to toggle visibility.
94                 require IkiWiki::Plugin::toggle;
95                 $form->tmpl_param("javascript" => IkiWiki::Plugin::toggle::include_javascript($params{page}));
96                 # Start with the attachments interface toggled invisible,
97                 # but if it was used, keep it open.
98                 if ($form->submitted ne "Upload Attachment" &&
99                     (! defined $q->param("attachment_select") ||
100                     ! length $q->param("attachment_select"))) {
101                         $form->tmpl_param("attachments-class" => "toggleable");
102                 }
103                 else {
104                         $form->tmpl_param("attachments-class" => "toggleable-open");
105                 }
106         }
107 }
108
109 sub formbuilder (@) {
110         my %params=@_;
111         my $form=$params{form};
112         my $q=$params{cgi};
113
114         return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;
115
116         my $filename=Encode::decode_utf8($q->param('attachment'));
117         if (defined $filename && length $filename &&
118             ($form->submitted eq "Upload Attachment" || $form->submitted eq "Save Page")) {
119                 attachment_save($filename, $form, $q, $params{session});
120         }
121         elsif ($form->submitted eq "Insert Links") {
122                 my $page=quotemeta(Encode::decode_utf8($q->param("page")));
123                 my $add="";
124                 foreach my $f ($q->param("attachment_select")) {
125                         $f=Encode::decode_utf8($f);
126                         $f=~s/^$page\///;
127                         if (IkiWiki::isinlinableimage($f) &&
128                             UNIVERSAL::can("IkiWiki::Plugin::img", "import")) {
129                                 $add.='[[!img '.$f.' align="right" size="" alt=""]]';
130                         }
131                         else {
132                                 $add.="[[$f]]";
133                         }
134                         $add.="\n";
135                 }
136                 $form->field(name => 'editcontent',
137                         value => $form->field('editcontent')."\n\n".$add,
138                         force => 1) if length $add;
139         }
140         
141         # Generate the attachment list only after having added any new
142         # attachments.
143         $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);
144 }
145
146 sub attachment_save {
147         my $filename=shift;
148         my $form=shift;
149         my $q=shift;
150         my $session=shift;
151         
152         # This is an (apparently undocumented) way to get the name
153         # of the temp file that CGI writes the upload to.
154         my $tempfile=$q->tmpFileName($filename);
155         if (! defined $tempfile || ! length $tempfile) {
156                 # perl 5.8 needs an alternative, awful method
157                 if ($q =~ /HASH/ && exists $q->{'.tmpfiles'}) {
158                         foreach my $key (keys(%{$q->{'.tmpfiles'}})) {
159                                 $tempfile=$q->tmpFileName(\$key);
160                                 last if defined $tempfile && length $tempfile;
161                         }
162                 }
163                 if (! defined $tempfile || ! length $tempfile) {
164                         error("CGI::tmpFileName failed to return the uploaded file name");
165                 }
166         }
167
168         $filename=IkiWiki::basename($filename);
169         $filename=~s/.*\\+(.+)/$1/; # hello, windows
170         $filename=linkpage(IkiWiki::possibly_foolish_untaint(
171                 attachment_location($form->field('page')).
172                         $filename));
173         if (IkiWiki::file_pruned($filename)) {
174                 error(gettext("bad attachment filename"));
175         }
176                 
177         # Check that the user is allowed to edit a page with the
178         # name of the attachment.
179         IkiWiki::check_canedit($filename, $q, $session);
180         # And that the attachment itself is acceptable.
181         check_canattach($session, $filename, $tempfile);
182
183         # Needed for fast_file_copy and for rendering below.
184         require IkiWiki::Render;
185
186         # Move the attachment into place.
187         # Try to use a fast rename; fall back to copying.
188         IkiWiki::prep_writefile($filename, $config{srcdir});
189         unlink($config{srcdir}."/".$filename);
190         if (rename($tempfile, $config{srcdir}."/".$filename)) {
191                 # The temp file has tight permissions; loosen up.
192                 chmod(0666 & ~umask, $config{srcdir}."/".$filename);
193         }
194         else {
195                 my $fh=$q->upload('attachment');
196                 if (! defined $fh || ! ref $fh) {
197                         # needed by old CGI versions
198                         $fh=$q->param('attachment');
199                         if (! defined $fh || ! ref $fh) {
200                                 # even that doesn't always work,
201                                 # fall back to opening the tempfile
202                                 $fh=undef;
203                                 open($fh, "<", $tempfile) || error("failed to open \"$tempfile\": $!");
204                         }
205                 }
206                 binmode($fh);
207                 writefile($filename, $config{srcdir}, undef, 1, sub {
208                         IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
209                 });
210         }
211
212         # Check the attachment in and trigger a wiki refresh.
213         if ($config{rcs}) {
214                 IkiWiki::rcs_add($filename);
215                 IkiWiki::disable_commit_hook();
216                 IkiWiki::rcs_commit(
217                         file => $filename,
218                         message => gettext("attachment upload"),
219                         token => IkiWiki::rcs_prepedit($filename),
220                         session => $session,
221                 );
222                 IkiWiki::enable_commit_hook();
223                 IkiWiki::rcs_update();
224         }
225         IkiWiki::refresh();
226         IkiWiki::saveindex();
227 }
228
229 sub attachment_location ($) {
230         my $page=shift;
231         
232         # Put the attachment in a subdir of the page it's attached
233         # to, unless that page is an "index" page.
234         $page=~s/(^|\/)index//;
235         $page.="/" if length $page;
236         
237         return $page;
238 }
239
240 sub attachment_list ($) {
241         my $page=shift;
242         my $loc=attachment_location($page);
243
244         my @ret;
245         foreach my $f (values %pagesources) {
246                 if (! defined pagetype($f) &&
247                     $f=~m/^\Q$loc\E[^\/]+$/) {
248                         push @ret, {
249                                 "field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
250                                 link => htmllink($page, $page, $f, noimageinline => 1),
251                                 size => IkiWiki::Plugin::filecheck::humansize((stat($f))[7]),
252                                 mtime => displaytime($IkiWiki::pagemtime{$f}),
253                                 mtime_raw => $IkiWiki::pagemtime{$f},
254                         };
255                 }
256         }
257
258         # Sort newer attachments to the top of the list, so a newly-added
259         # attachment appears just before the form used to add it.
260         return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} } @ret;
261 }
262
263 1