First cut at the revert plugin.

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

diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm
index 6b36ea4c853e5e95ff87df151d1a56483d9f710f..2a78566e146f2e4b0bc2f321bd1fb0392e126dd5 100644 (file)
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -3,95 +3,228 @@ package IkiWiki::Plugin::recentchanges;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
-
-sub import { #{{{
-       hook(type => "checkconfig", id => "recentchanges",
-               call => \&checkconfig);
-       hook(type => "needsbuild", id => "recentchanges",
-               call => \&needsbuild);
-       hook(type => "preprocess", id => "recentchanges",
-               call => \&preprocess);
-       hook(type => "htmlize", id => "_change",
-               call => \&htmlize);
-} #}}}
-
-sub checkconfig () { #{{{
-       my @changes=IkiWiki::rcs_recentchanges(100);
-       updatechanges("*", "recentchanges", \@changes);
-} #}}}
-
-sub needsbuild () { #{{{
-       # TODO
-} #}}}
-
-sub preprocess (@) { #{{{
-       my %params=@_;
+use IkiWiki 3.00;
+use Encode;
+use HTML::Entities;
+
+sub import {
+       hook(type => "getsetup", id => "recentchanges", call => \&getsetup);
+       hook(type => "checkconfig", id => "recentchanges", call => \&checkconfig);
+       hook(type => "refresh", id => "recentchanges", call => \&refresh);
+       hook(type => "pagetemplate", id => "recentchanges", call => \&pagetemplate);
+       hook(type => "htmlize", id => "_change", call => \&htmlize);
+       # Load goto to fix up links from recentchanges
+       IkiWiki::loadplugin("goto");
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+               },
+               recentchangespage => {
+                       type => "string",
+                       example => "recentchanges",
+                       description => "name of the recentchanges page",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               recentchangesnum => {
+                       type => "integer",
+                       example => 100,
+                       description => "number of changes to track",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
+
+sub checkconfig () {
+       $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
+       $config{recentchangesnum}=100 unless defined $config{recentchangesnum};
+}
+
+sub refresh ($) {
+       my %seen;
+
+       # add new changes
+       foreach my $change (IkiWiki::rcs_recentchanges($config{recentchangesnum})) {
+               $seen{store($change, $config{recentchangespage})}=1;
+       }
+       
+       # delete old and excess changes
+       foreach my $page (keys %pagesources) {
+               if ($pagesources{$page} =~ /\._change$/ && ! $seen{$page}) {
+                       unlink($config{srcdir}.'/'.$pagesources{$page});
+               }
+       }
+}
+
+sub confirmation_form {
+    my ($q, $session, $rev) = @_;
+
+    eval q{use CGI::FormBuilder};
+    error($@) if $@;
+    my $f = CGI::FormBuilder->new(
+               name => "revert",
+               header => 0,
+               charset => "utf-8",
+               method => 'POST',
+               javascript => 0,
+               params => $q,
+               action => $config{cgiurl},
+               stylesheet => 1,
+                template => { template('revert.tmpl') },
+       );
+
+    $f->field(name => "sid", type => "hidden", value => $session->id,
+              force => 1);
+    $f->field(name => "do", type => "hidden", value => "revert", force => 1);
+    $f->field(name => "rev", type => "hidden", value => $rev, force => 1);
+
+    return $f, ["Revert", "Cancel"];
+}
+
+sub sessioncgi ($$) {
+    my ($q, $session) = @_;
+    my $do = $q->param('do');
+    my $rev = $q->param('rev');
+
+    return unless $do eq 'revert' && $rev;
+
+    # FIXME rcs_preprevert ??
+    IkiWiki::check_canedit('FIXME', $q, $session);
+
+    my ($form, $buttons) = confirmation_form($q, $session);
+    IkiWiki::decode_form_utf8($form);

 
 

-       # TODO
+    if($form->submitted eq 'Revert' && $form->validate) {
+        IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));

 
 

-       return "";
-} #}}}
+        IkiWiki::disable_commit_hook();
+        my $r = IkiWiki::rcs_revert(
+                         session => $session,
+                         rev => $rev);
+        IkiWiki::enable_commit_hook();
+
+        if($r) {
+            die "FIXME revert '$rev' failed.";
+        } else {
+            IkiWiki::refresh();
+            IkiWiki::saveindex();
+            # FIXME indicate success.
+        }
+    } else {
+        $form->title(sprintf(gettext("confirm reversion of %s"), $rev));
+        my $patch_contents = IkiWiki::rcs_showpatch($rev);
+        $form->tmpl_param(patch_contents => encode_entities($patch_contents));
+        IkiWiki::showform($form, $buttons, $session, $q);
+        exit 0;
+    }
+
+    IkiWiki::redirect($q, urlto($config{recentchangespage}, ''));
+    exit 0;
+}
+
+# Enable the recentchanges link.
+sub pagetemplate (@) {
+       my %params=@_;
+       my $template=$params{template};
+       my $page=$params{page};
+
+       if (defined $config{recentchangespage} && $config{rcs} &&
+           $template->query(name => "recentchangesurl") &&
+           $page ne $config{recentchangespage}) {
+               $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
+               $template->param(have_actions => 1);
+       }
+}

 
 # Pages with extension _change have plain html markup, pass through.
 
 # Pages with extension _change have plain html markup, pass through.

-sub htmlize (@) { #{{{
+sub htmlize (@) {

        my %params=@_;
        return $params{content};
        my %params=@_;
        return $params{content};

-} #}}}
+}

 
 

-sub store ($$) { #{{{
+sub store ($$$) {

        my $change=shift;
        my $change=shift;

-       my $subdir=shift;
-       
-       my $page="$subdir/change_".IkiWiki::titlepage($change->{rev});
+
+       my $page="$config{recentchangespage}/change_".titlepage($change->{rev});

 
        # Optimisation to avoid re-writing pages. Assumes commits never
        # change (or that any changes are not important).
 
        # Optimisation to avoid re-writing pages. Assumes commits never
        # change (or that any changes are not important).

-       return if exists $pagesources{$page} && ! $config{rebuild};
+       return $page if exists $pagesources{$page} && ! $config{rebuild};

 
        # Limit pages to first 10, and add links to the changed pages.
        my $is_excess = exists $change->{pages}[10];
        delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
        $change->{pages} = [
                map {
 
        # Limit pages to first 10, and add links to the changed pages.
        my $is_excess = exists $change->{pages}[10];
        delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
        $change->{pages} = [
                map {

-                       if (length $config{url}) {
-                               $_->{link} = "<a href=\"$config{url}/".
-                                       urlto($_->{page},"")."\">".
-                                       IkiWiki::pagetitle($_->{page})."</a>";
+                       if (length $config{cgiurl}) {
+                               $_->{link} = "<a href=\"".
+                                       IkiWiki::cgiurl(
+                                               do => "goto",
+                                               page => $_->{page}
+                                       ).
+                                       "\" rel=\"nofollow\">".
+                                       pagetitle($_->{page}).
+                                       "</a>"

                        }
                        else {
                        }
                        else {

-                               $_->{link} = IkiWiki::pagetitle($_->{page});
+                               $_->{link} = pagetitle($_->{page});

                        }
                        }

+                       $_->{baseurl}="$config{url}/" if length $config{url};
+

                        $_;
                } @{$change->{pages}}
        ];
        push @{$change->{pages}}, { link => '...' } if $is_excess;
 
                        $_;
                } @{$change->{pages}}
        ];
        push @{$change->{pages}}, { link => '...' } if $is_excess;
 

+       $change->{author}=$change->{user};
+       my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
+       if (defined $oiduser) {
+               $change->{authorurl}=$change->{user};
+               $change->{user}=defined $change->{nickname} ? $change->{nickname} : $oiduser;
+       }
+       elsif (length $config{cgiurl}) {
+               $change->{authorurl} = IkiWiki::cgiurl(
+                       do => "goto",
+                       page => IkiWiki::userpage($change->{author}),
+               );
+       }
+
+       if (ref $change->{message}) {
+               foreach my $field (@{$change->{message}}) {
+                       if (exists $field->{line}) {
+                               # escape html
+                               $field->{line} = encode_entities($field->{line});
+                               # escape links and preprocessor stuff
+                               $field->{line} = encode_entities($field->{line}, '\[\]');
+                       }
+               }
+       }
+

        # Fill out a template with the change info.
        my $template=template("change.tmpl", blind_cache => 1);
        $template->param(
        # Fill out a template with the change info.
        my $template=template("change.tmpl", blind_cache => 1);
        $template->param(

-               user => IkiWiki::userlink($change->{user}),
-               when => IkiWiki::displaytime($change->{when}, "%X %x"),
-               pages => $change->{pages},
-               message => $change->{message},
+               %$change,
+               commitdate => displaytime($change->{when}, "%X %x"),
+               wikiname => $config{wikiname},

        );
        );

-       $template->param(baseurl => "$config{url}/") if length $config{url};
+       
+       $template->param(permalink => "$config{url}/$config{recentchangespage}/#change-".titlepage($change->{rev}))
+               if exists $config{url};
+       

        IkiWiki::run_hooks(pagetemplate => sub {
        IkiWiki::run_hooks(pagetemplate => sub {

-               shift->(page => $page, destpage => $page, template => $template);
+               shift->(page => $page, destpage => $page,
+                       template => $template, rev => $change->{rev});

        });
 
        });
 

-       writefile($page."._change", $config{srcdir}, $template->output);
-       utime $change->{when}, $change->{when}, "$config{srcdir}/$page._change";
-} #}}}
+       my $file=$page."._change";
+       writefile($file, $config{srcdir}, $template->output);
+       utime $change->{when}, $change->{when}, "$config{srcdir}/$file";

 
 

-sub updatechanges ($$) { #{{{
-       my $pagespec=shift;
-       my $subdir=shift;
-       my @changes=@{shift()};
-       foreach my $change (@changes) {
-               store($change, $subdir);
-       }
-       # TODO: delete old
-} #}}}
+       return $page;
+}

 
 1
 
 1