rename todo/merge_tincho-osm_branch.mdwn to todo/merge_tina-osm_branch.mdwn

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

diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
index b7ea1f312793b1ea61e44c890c720b537f6d0a6b..852769f60ea04f2f88a643fbac5645580e6da88f 100644 (file)
--- a/IkiWiki/Plugin/attachment.pm
+++ b/IkiWiki/Plugin/attachment.pm
@@ -6,11 +6,13 @@ use strict;
 use IkiWiki 3.00;
 
 sub import {
 use IkiWiki 3.00;
 
 sub import {

+       add_underlay("attachment");

        add_underlay("javascript");
        add_underlay("javascript");

+       add_underlay("jquery");

        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 => "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 => "formbuilder", id => "attachment", call => \&formbuilder, last => 1);

        IkiWiki::loadplugin("filecheck");
 }
 
        IkiWiki::loadplugin("filecheck");
 }
 


@@ -89,10 +91,20 @@ sub formbuilder_setup (@) {
                $form->tmpl_param("field-upload" => '<input name="_submit" type="submit" value="Upload Attachment" />');
                $form->tmpl_param("field-link" => '<input name="_submit" type="submit" value="Insert Links" />');
 
                $form->tmpl_param("field-upload" => '<input name="_submit" type="submit" value="Upload Attachment" />');
                $form->tmpl_param("field-link" => '<input name="_submit" type="submit" value="Insert Links" />');
 

-               # Add the toggle javascript; the attachments interface uses
-               # it to toggle visibility.
+               # Add all the javascript used by the attachments interface.

                require IkiWiki::Plugin::toggle;
                require IkiWiki::Plugin::toggle;

-               $form->tmpl_param("javascript" => IkiWiki::Plugin::toggle::include_javascript($params{page}));
+               my $js=IkiWiki::Plugin::toggle::include_javascript($params{page});
+               $js.='<link rel="stylesheet" href="'.urlto("ikiwiki/jquery-ui.min.css", $params{page}).'" id="theme">'."\n";
+               my @jsfiles=qw{jquery.min jquery-ui.min
+                       jquery.tmpl.min jquery.iframe-transport
+                       jquery.fileupload jquery.fileupload-ui
+               };
+               foreach my $file (@jsfiles) {
+                       $js.='<script src="'.urlto("ikiwiki/$file.js", $params{page}).
+                            '" type="text/javascript" charset="utf-8"></script>'."\n";
+               }
+               $form->tmpl_param("javascript" => $js);
+

                # Start with the attachments interface toggled invisible,
                # but if it was used, keep it open.
                if ($form->submitted ne "Upload Attachment" &&
                # Start with the attachments interface toggled invisible,
                # but if it was used, keep it open.
                if ($form->submitted ne "Upload Attachment" &&


@@ -103,6 +115,13 @@ sub formbuilder_setup (@) {
                else {
                        $form->tmpl_param("attachments-class" => "toggleable-open");
                }
                else {
                        $form->tmpl_param("attachments-class" => "toggleable-open");
                }

+               
+               # Save attachments in holding area before previewing and
+               # saving.
+               if ($form->submitted eq "Preview" ||
+                   $form->submitted eq "Save Page") {
+                       attachments_save($form, $params{session});
+               }

        }
 }
 
        }
 }
 


@@ -113,23 +132,25 @@ sub formbuilder (@) {
 
        return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;
 
 
        return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;
 

-       my $filename=Encode::decode_utf8($q->param('attachment'));
-       if (defined $filename && length $filename &&
-            ($form->submitted eq "Upload Attachment" || $form->submitted eq "Save Page")) {
-               attachment_store($filename, $form, $q, $params{session});
+       my $filename=Encode::decode_utf8(scalar $q->param('attachment'));
+       my $handle=$q->upload('attachment');
+
+       if (defined $filename && length $filename) {
+               attachment_store($filename, $handle, $form, $q, $params{session});

        }
        }

+

        if ($form->submitted eq "Save Page") {
                attachments_save($form, $params{session});
        }
 
        if ($form->submitted eq "Insert Links") {
        if ($form->submitted eq "Save Page") {
                attachments_save($form, $params{session});
        }
 
        if ($form->submitted eq "Insert Links") {

-               my $page=quotemeta(Encode::decode_utf8($q->param("page")));
+               my $page=quotemeta(Encode::decode_utf8(scalar $q->param("page")));

                my $add="";
                my $add="";

-               foreach my $f ($q->param("attachment_select")) {
+               foreach my $f (@{$q->param_fetch("attachment_select")}) {

                        $f=Encode::decode_utf8($f);
                        $f=~s/^$page\///;
                        if (IkiWiki::isinlinableimage($f) &&
                        $f=Encode::decode_utf8($f);
                        $f=~s/^$page\///;
                        if (IkiWiki::isinlinableimage($f) &&

-                           UNIVERSAL::can("IkiWiki::Plugin::img", "import")) {
+                           IkiWiki::Plugin::img->can("import")) {

                                $add.='[[!img '.$f.' align="right" size="" alt=""]]';
                        }
                        else {
                                $add.='[[!img '.$f.' align="right" size="" alt=""]]';
                        }
                        else {


@@ -137,32 +158,55 @@ sub formbuilder (@) {
                        }
                        $add.="\n";
                }
                        }
                        $add.="\n";
                }

+               my $content = $form->field('editcontent');

                $form->field(name => 'editcontent',
                $form->field(name => 'editcontent',

-                       value => $form->field('editcontent')."\n\n".$add,
+                       value => $content."\n\n".$add,

                        force => 1) if length $add;
        }
        
        # Generate the attachment list only after having added any new
        # attachments.
                        force => 1) if length $add;
        }
        
        # Generate the attachment list only after having added any new
        # attachments.

-       $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);
+       $form->tmpl_param("attachment_list" => [attachment_list(scalar $form->field('page'))]);

 }
 
 }
 

-sub attachment_holding_dir {
-       my $page=shift;
+sub attachment_holding_location {
+       my $page=attachment_location(shift);

 
 

-       return $config{wikistatedir}."/attachments/$page";
+       my $dir=$config{wikistatedir}."/attachments/".
+               IkiWiki::possibly_foolish_untaint(linkpage($page));
+       $dir=~s/\/$//;
+       return $dir;
+}
+
+sub is_held_attachment {
+       my $attachment=shift;
+
+       my $f=attachment_holding_location($attachment);
+       if (-f $f) {
+               return $f
+       }
+       else {
+               return undef;
+       }

 }
 
 # Stores the attachment in a holding area, not yet in the wiki proper.
 sub attachment_store {
        my $filename=shift;
 }
 
 # Stores the attachment in a holding area, not yet in the wiki proper.
 sub attachment_store {
        my $filename=shift;

+       my $handle=shift;

        my $form=shift;
        my $q=shift;
        my $session=shift;
        my $form=shift;
        my $q=shift;
        my $session=shift;

-       
-       # This is an (apparently undocumented) way to get the name
-       # of the temp file that CGI writes the upload to.
-       my $tempfile=$q->tmpFileName($filename);
+
+       my $tempfile;
+       if (defined $handle) {
+               # This is what works in CGI.pm 4.09+: $q->tmpFileName($q->upload('attachment'))
+               $tempfile=$q->tmpFileName($handle);
+       }
+       if (! defined $tempfile || ! length $tempfile) {
+               # This is what is *documented* in CGI.pm 4.09: $q->tmpFileName($q->param('attachment'))
+               $tempfile=$q->tmpFileName($filename);
+       }

        if (! defined $tempfile || ! length $tempfile) {
                # perl 5.8 needs an alternative, awful method
                if ($q =~ /HASH/ && exists $q->{'.tmpfiles'}) {
        if (! defined $tempfile || ! length $tempfile) {
                # perl 5.8 needs an alternative, awful method
                if ($q =~ /HASH/ && exists $q->{'.tmpfiles'}) {


@@ -171,28 +215,38 @@ sub attachment_store {
                                last if defined $tempfile && length $tempfile;
                        }
                }
                                last if defined $tempfile && length $tempfile;
                        }
                }

-               if (! defined $tempfile || ! length $tempfile) {
-                       error("CGI::tmpFileName failed to return the uploaded file name");
-               }
+       }
+       if (! defined $tempfile || ! length $tempfile) {
+               error("CGI::tmpFileName failed to return the uploaded file name");

        }
 
        $filename=IkiWiki::basename($filename);
        $filename=~s/.*\\+(.+)/$1/; # hello, windows
        }
 
        $filename=IkiWiki::basename($filename);
        $filename=~s/.*\\+(.+)/$1/; # hello, windows

+       $filename=IkiWiki::possibly_foolish_untaint(linkpage($filename));
+       my $dest=attachment_holding_location(scalar $form->field('page'));

        
        # Check that the user is allowed to edit the attachment.
        
        # Check that the user is allowed to edit the attachment.

-       my $final_filename=linkpage(IkiWiki::possibly_foolish_untaint(
-               attachment_location($form->field('page')).
-               $filename));
-       if (IkiWiki::file_pruned($final_filename)) {
-               error(gettext("bad attachment filename"));
+       my $final_filename=
+               linkpage(IkiWiki::possibly_foolish_untaint(
+                       attachment_location(scalar $form->field('page')))).
+               $filename;
+       eval {
+               if (IkiWiki::file_pruned($final_filename)) {
+                       error(gettext("bad attachment filename"));
+               }
+               IkiWiki::check_canedit($final_filename, $q, $session);
+               # And that the attachment itself is acceptable.
+               check_canattach($session, $final_filename, $tempfile);
+       };
+       if ($@) {
+               # save error in case called functions clobber $@
+               my $error = $@;
+               json_response($q, $form, $dest."/".$filename, $error);
+               error $error;

        }
        }

-       IkiWiki::check_canedit($final_filename, $q, $session);
-       # And that the attachment itself is acceptable.
-       check_canattach($session, $final_filename, $tempfile);

 
        # Move the attachment into holding directory.
        # Try to use a fast rename; fall back to copying.
 
        # Move the attachment into holding directory.
        # Try to use a fast rename; fall back to copying.

-       my $dest=attachment_holding_dir($form->field('page'));

        IkiWiki::prep_writefile($filename, $dest);
        unlink($dest."/".$filename);
        if (rename($tempfile, $dest."/".$filename)) {
        IkiWiki::prep_writefile($filename, $dest);
        unlink($dest."/".$filename);
        if (rename($tempfile, $dest."/".$filename)) {


@@ -212,12 +266,13 @@ sub attachment_store {
                        }
                }
                binmode($fh);
                        }
                }
                binmode($fh);

-               # Needed for fast_file_copy.
-               require IkiWiki::Render;
+               require IkiWiki::Render; 

                writefile($filename, $dest, undef, 1, sub {
                        IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
                });
        }
                writefile($filename, $dest, undef, 1, sub {
                        IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
                });
        }

+
+       json_response($q, $form, $dest."/".$filename, stored_msg());

 }
 
 # Save all stored attachments for a page.
 }
 
 # Save all stored attachments for a page.


@@ -227,19 +282,23 @@ sub attachments_save {
 
        # Move attachments out of holding directory.
        my @attachments;
 
        # Move attachments out of holding directory.
        my @attachments;

-       my $dir=attachment_holding_dir($form->field('page'));
+       my $dir=attachment_holding_location(scalar $form->field('page'));

        foreach my $filename (glob("$dir/*")) {
        foreach my $filename (glob("$dir/*")) {

+               $filename=Encode::decode_utf8($filename);

                next unless -f $filename;
                next unless -f $filename;

-               my $dest=$config{srcdir}."/".
-                       linkpage(IkiWiki::possibly_foolish_untaint(
-                               attachment_location($form->field('page')).
-                               $filename));
+               my $destdir=linkpage(IkiWiki::possibly_foolish_untaint(
+                       attachment_location(scalar $form->field('page'))));
+               my $absdestdir=$config{srcdir}."/".$destdir;
+               my $destfile=IkiWiki::basename($filename);
+               my $dest=$absdestdir.$destfile;

                unlink($dest);
                unlink($dest);

+               IkiWiki::prep_writefile($destfile, $absdestdir);

                rename($filename, $dest);
                rename($filename, $dest);

-               push @attachments, $dest;
+               push @attachments, $destdir.$destfile;

        }
        return unless @attachments;
        }
        return unless @attachments;

-       rmdir($dir);
+       require IkiWiki::Render;
+       IkiWiki::prune($dir, $config{wikistatedir}."/attachments");

 
        # Check the attachments in and trigger a wiki refresh.
        if ($config{rcs}) {
 
        # Check the attachments in and trigger a wiki refresh.
        if ($config{rcs}) {


@@ -260,8 +319,8 @@ sub attachment_location ($) {
        my $page=shift;
        
        # Put the attachment in a subdir of the page it's attached
        my $page=shift;
        
        # Put the attachment in a subdir of the page it's attached

-       # to, unless that page is an "index" page.
-       $page=~s/(^|\/)index//;
+       # to, unless that page is the "index" page.
+       return "" if $page eq 'index';

        $page.="/" if length $page;
        
        return $page;
        $page.="/" if length $page;
        
        return $page;


@@ -271,23 +330,76 @@ sub attachment_list ($) {
        my $page=shift;
        my $loc=attachment_location($page);
 
        my $page=shift;
        my $loc=attachment_location($page);
 

-       my @ret;
+       my $std=sub {
+               my $file=shift;
+               my $mtime=shift;
+               my $date=shift;
+               my $size=shift;
+
+               name => $file,
+               size => IkiWiki::Plugin::filecheck::humansize($size),
+               mtime => $date,
+               mtime_raw => $mtime,
+       };
+
+       # attachments already in the wiki
+       my %attachments;

        foreach my $f (values %pagesources) {
                if (! defined pagetype($f) &&
                    $f=~m/^\Q$loc\E[^\/]+$/) {
        foreach my $f (values %pagesources) {
                if (! defined pagetype($f) &&
                    $f=~m/^\Q$loc\E[^\/]+$/) {

-                       push @ret, {
-                               "field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
+                       $attachments{$f}={
+                               $std->($f, $IkiWiki::pagemtime{$f}, displaytime($IkiWiki::pagemtime{$f}), (stat($f))[7]),

                                link => htmllink($page, $page, $f, noimageinline => 1),
                                link => htmllink($page, $page, $f, noimageinline => 1),

-                               size => IkiWiki::Plugin::filecheck::humansize((stat($f))[7]),
-                               mtime => displaytime($IkiWiki::pagemtime{$f}),
-                               mtime_raw => $IkiWiki::pagemtime{$f},

                        };
                }
        }
                        };
                }
        }

+       
+       # attachments in holding directory
+       my $dir=attachment_holding_location($page);
+       my $heldmsg=gettext("this attachment is not yet saved");
+       foreach my $file (glob("$dir/*")) {
+               $file=Encode::decode_utf8($file);
+               next unless -f $file;
+               my $base=IkiWiki::basename($file);
+               my $f=$loc.$base;
+               $attachments{$f}={
+                       $std->($f, (stat($file))[9]*2, stored_msg(), (stat(_))[7]),
+                       link => $base,
+               }
+       }
+
+       # Sort newer attachments to the end of the list.
+       return sort { $a->{mtime_raw} <=> $b->{mtime_raw} || $a->{link} cmp $b->{link} }
+               values %attachments;
+}
+
+sub stored_msg {
+       gettext("just uploaded");
+}

 
 

-       # Sort newer attachments to the top of the list, so a newly-added
-       # attachment appears just before the form used to add it.
-       return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} } @ret;
+sub json_response ($$$$) {
+       my $q=shift;
+       my $form=shift;
+       my $filename=shift;
+       my $stored_msg=shift;
+
+       if (! defined $form->submitted ||
+           $form->submitted ne "Upload Attachment") {
+               eval q{use JSON};
+               error $@ if $@;
+               print "Content-type: text/html\n\n";
+               my $size=-s $filename;
+               print to_json([
+                       {
+                               name => IkiWiki::basename($filename),
+                               size => $size,
+                               humansize => IkiWiki::Plugin::filecheck::humansize($size),
+                               stored_msg => $stored_msg,
+                               
+                       }
+               ]);
+               exit 0;
+       }

 }
 
 1
 }
 
 1