po plugin: reworked available options

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

diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm
index 22f934f2e8becec79e9fc8dfae6f0f1ffbd90949..781e297230460bcae757f68ec79a593a4fb876c1 100644 (file)
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -4,8 +4,10 @@ package IkiWiki::Plugin::recentchanges;
 use warnings;
 use strict;
 use IkiWiki 2.00;
 use warnings;
 use strict;
 use IkiWiki 2.00;

+use Encode;

 
 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 => "checkconfig", id => "recentchanges", call => \&checkconfig);
        hook(type => "refresh", id => "recentchanges", call => \&refresh);
        hook(type => "pagetemplate", id => "recentchanges", call => \&pagetemplate);


@@ -13,6 +15,28 @@ sub import { #{{{
        hook(type => "cgi", id => "recentchanges", call => \&cgi);
 } #}}}
 
        hook(type => "cgi", id => "recentchanges", call => \&cgi);
 } #}}}
 

+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 checkconfig () { #{{{
        $config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
        $config{recentchangesnum}=100 unless defined $config{recentchangesnum};


@@ -28,7 +52,7 @@ sub refresh ($) { #{{{
        
        # delete old and excess changes
        foreach my $page (keys %pagesources) {
        
        # delete old and excess changes
        foreach my $page (keys %pagesources) {

-               if ($page =~ /\._change$/ && ! $seen{$page}) {
+               if ($pagesources{$page} =~ /\._change$/ && ! $seen{$page}) {

                        unlink($config{srcdir}.'/'.$pagesources{$page});
                }
        }
                        unlink($config{srcdir}.'/'.$pagesources{$page});
                }
        }


@@ -39,7 +63,9 @@ sub pagetemplate (@) { #{{{
        my %params=@_;
        my $template=$params{template};
        my $page=$params{page};
        my %params=@_;
        my $template=$params{template};
        my $page=$params{page};

-       if ($config{rcs} && $page ne $config{recentchangespage} &&
+
+       if (defined $config{recentchangespage} && $config{rcs} &&
+           $page ne $config{recentchangespage} &&

            $template->query(name => "recentchangesurl")) {
                $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
                $template->param(have_actions => 1);
            $template->query(name => "recentchangesurl")) {
                $template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
                $template->param(have_actions => 1);


@@ -61,7 +87,7 @@ sub cgi ($) { #{{{
                # page they link to is deleted, or newly created, or
                # changes for whatever reason. So this CGI handles that
                # dynamic linking stuff.
                # 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");
+               my $page=decode_utf8($cgi->param("page"));

                if (!defined $page) {
                        error("missing page parameter");
                }
                if (!defined $page) {
                        error("missing page parameter");
                }


@@ -78,7 +104,7 @@ sub cgi ($) { #{{{
                                "</p>");
                }
                else {
                                "</p>");
                }
                else {

-                       IkiWiki::redirect($cgi, $config{url}."/".htmlpage($link));
+                       IkiWiki::redirect($cgi, urlto($link, undef, 1));

                }
 
                exit;
                }
 
                exit;


@@ -88,7 +114,7 @@ sub cgi ($) { #{{{
 sub store ($$$) { #{{{
        my $change=shift;
 
 sub store ($$$) { #{{{
        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).


@@ -106,11 +132,11 @@ sub store ($$$) { #{{{
                                                page => $_->{page}
                                        ).
                                        "\">".
                                                page => $_->{page}
                                        ).
                                        "\">".

-                                       IkiWiki::pagetitle($_->{page}).
+                                       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};
 


@@ -133,7 +159,7 @@ sub store ($$$) { #{{{
                );
        }
 
                );
        }
 

-       # escape  wikilinks and preprocessor stuff in commit messages
+       # 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}) {


@@ -147,10 +173,16 @@ sub store ($$$) { #{{{
        $template->param(
                %$change,
                commitdate => displaytime($change->{when}, "%X %x"),
        $template->param(
                %$change,
                commitdate => displaytime($change->{when}, "%X %x"),

+               commitdate_raw => scalar localtime($change->{when}),

                wikiname => $config{wikiname},
        );
                wikiname => $config{wikiname},
        );

+       
+       $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});

        });
 
        my $file=$page."._change";
        });
 
        my $file=$page."._change";


@@ -160,10 +192,4 @@ sub store ($$$) { #{{{
        return $page;
 } #}}}
 
        return $page;
 } #}}}
 

-sub updatechanges ($$) { #{{{
-       my $subdir=shift;
-       my @changes=@{shift()};
-       
-} #}}}
-

 1
 1