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 37e45a05af65109bedb626eb56d6de8ae20ac3d1..2a78566e146f2e4b0bc2f321bd1fb0392e126dd5 100644 (file)
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -3,18 +3,21 @@ package IkiWiki::Plugin::recentchanges;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;
+use Encode;
+use HTML::Entities;

 
 

-sub import { #{{{
+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);
        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);

-       hook(type => "cgi", id => "recentchanges", call => \&cgi);
-} #}}}
+       # Load goto to fix up links from recentchanges
+       IkiWiki::loadplugin("goto");
+}

 
 

-sub getsetup () { #{{{
+sub getsetup () {

        return
                plugin => {
                        safe => 1,
        return
                plugin => {
                        safe => 1,


@@ -34,14 +37,14 @@ sub getsetup () { #{{{
                        safe => 1,
                        rebuild => 0,
                },
                        safe => 1,
                        rebuild => 0,
                },

-} #}}}
+}

 
 

-sub checkconfig () { #{{{
+sub checkconfig () {

        $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
        $config{recentchangesnum}=100 unless defined $config{recentchangesnum};
        $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
        $config{recentchangesnum}=100 unless defined $config{recentchangesnum};

-} #}}}
+}

 
 

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

        my %seen;
 
        # add new changes
        my %seen;
 
        # add new changes


@@ -55,70 +58,98 @@ sub refresh ($) { #{{{
                        unlink($config{srcdir}.'/'.$pagesources{$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);

 
 

-# Enable the recentchanges link on wiki pages.
-sub pagetemplate (@) { #{{{
+    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);
+
+    if($form->submitted eq 'Revert' && $form->validate) {
+        IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
+
+        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} &&
        my %params=@_;
        my $template=$params{template};
        my $page=$params{page};
 
        if (defined $config{recentchangespage} && $config{rcs} &&

-           $page ne $config{recentchangespage} &&
-           $template->query(name => "recentchangesurl")) {
+           $template->query(name => "recentchangesurl") &&
+           $page ne $config{recentchangespage}) {

                $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
                $template->param(have_actions => 1);
        }
                $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 cgi ($) { #{{{
-       my $cgi=shift;
-       if (defined $cgi->param('do') && $cgi->param('do') eq "recentchanges_link") {
-               # This is a link from a change page to some
-               # other page. Since the change pages are only generated
-               # once, statically, links on them won't be updated if the
-               # page they link to is deleted, or newly created, or
-               # changes for whatever reason. So this CGI handles that
-               # dynamic linking stuff.
-               my $page=$cgi->param("page");
-               if (!defined $page) {
-                       error("missing page parameter");
-               }
-
-               IkiWiki::loadindex();
-
-               my $link=bestlink("", $page);
-               if (! length $link) {
-                       print "Content-type: text/html\n\n";
-                       print IkiWiki::misctemplate(gettext(gettext("missing page")),
-                               "<p>".
-                               sprintf(gettext("The page %s does not exist."),
-                                       htmllink("", "", $page)).
-                               "</p>");
-               }
-               else {
-                       if (defined pagetype($link)) {
-                               IkiWiki::redirect($cgi, $config{url}.IkiWiki::beautify_urlpath("/".htmlpage($link)));
-                       }
-                       else {
-                               IkiWiki::redirect($cgi, $config{url}.IkiWiki::beautify_urlpath("/".$link));
-                       }
-               }
-
-               exit;
-       }

 }
 
 }
 

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

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

-       my $page="$config{recentchangespage}/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).


@@ -132,15 +163,15 @@ sub store ($$$) { #{{{
                        if (length $config{cgiurl}) {
                                $_->{link} = "<a href=\"".
                                        IkiWiki::cgiurl(
                        if (length $config{cgiurl}) {
                                $_->{link} = "<a href=\"".
                                        IkiWiki::cgiurl(

-                                               do => "recentchanges_link",
+                                               do => "goto",

                                                page => $_->{page}
                                        ).
                                                page => $_->{page}
                                        ).

-                                       "\">".
-                                       IkiWiki::pagetitle($_->{page}).
+                                       "\" rel=\"nofollow\">".
+                                       pagetitle($_->{page}).

                                        "</a>"
                        }
                        else {
                                        "</a>"
                        }
                        else {

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

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


@@ -149,25 +180,26 @@ sub store ($$$) { #{{{
        ];
        push @{$change->{pages}}, { link => '...' } if $is_excess;
 
        ];
        push @{$change->{pages}}, { link => '...' } if $is_excess;
 

-       # See if the committer is an openid.

        $change->{author}=$change->{user};
        my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
        if (defined $oiduser) {
                $change->{authorurl}=$change->{user};
        $change->{author}=$change->{user};
        my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
        if (defined $oiduser) {
                $change->{authorurl}=$change->{user};

-               $change->{user}=$oiduser;
+               $change->{user}=defined $change->{nickname} ? $change->{nickname} : $oiduser;

        }
        elsif (length $config{cgiurl}) {
                $change->{authorurl} = IkiWiki::cgiurl(
        }
        elsif (length $config{cgiurl}) {
                $change->{authorurl} = IkiWiki::cgiurl(

-                       do => "recentchanges_link",
-                       page => (length $config{userdir} ? "$config{userdir}/" : "").$change->{author},
+                       do => "goto",
+                       page => IkiWiki::userpage($change->{author}),

                );
        }
 
                );
        }
 

-       # escape wikilinks and preprocessor stuff in commit messages

        if (ref $change->{message}) {
                foreach my $field (@{$change->{message}}) {
                        if (exists $field->{line}) {
        if (ref $change->{message}) {
                foreach my $field (@{$change->{message}}) {
                        if (exists $field->{line}) {

-                               $field->{line} =~ s/(?<!\\)\[\[/\\\[\[/g;
+                               # escape html
+                               $field->{line} = encode_entities($field->{line});
+                               # escape links and preprocessor stuff
+                               $field->{line} = encode_entities($field->{line}, '\[\]');

                        }
                }
        }
                        }
                }
        }


@@ -179,6 +211,10 @@ sub store ($$$) { #{{{
                commitdate => displaytime($change->{when}, "%X %x"),
                wikiname => $config{wikiname},
        );
                commitdate => displaytime($change->{when}, "%X %x"),
                wikiname => $config{wikiname},
        );

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

        IkiWiki::run_hooks(pagetemplate => sub {
                shift->(page => $page, destpage => $page,
                        template => $template, rev => $change->{rev});
        IkiWiki::run_hooks(pagetemplate => sub {
                shift->(page => $page, destpage => $page,
                        template => $template, rev => $change->{rev});


@@ -189,6 +225,6 @@ sub store ($$$) { #{{{
        utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
 
        return $page;
        utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
 
        return $page;

-} #}}}
+}

 
 1
 
 1