po: add comments

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

diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
index 7d81e918271809c3d6acd5ded979b1255233cc09..7fe5a4dcf5c2f0543bef836067820133b2014405 100644 (file)
--- a/IkiWiki/Plugin/inline.pm
+++ b/IkiWiki/Plugin/inline.pm
@@ -15,6 +15,7 @@ my $nested=0;
 
 sub import { #{{{
        hook(type => "getopt", id => "inline", call => \&getopt);
 
 sub import { #{{{
        hook(type => "getopt", id => "inline", call => \&getopt);

+       hook(type => "getsetup", id => "inline", call => \&getsetup);

        hook(type => "checkconfig", id => "inline", call => \&checkconfig);
        hook(type => "sessioncgi", id => "inline", call => \&sessioncgi);
        hook(type => "preprocess", id => "inline", 
        hook(type => "checkconfig", id => "inline", call => \&checkconfig);
        hook(type => "sessioncgi", id => "inline", call => \&sessioncgi);
        hook(type => "preprocess", id => "inline", 


@@ -27,7 +28,6 @@ sub import { #{{{
        # pings interrupting page builds.
        hook(type => "change", id => "inline", 
                call => \&IkiWiki::pingurl);
        # pings interrupting page builds.
        hook(type => "change", id => "inline", 
                call => \&IkiWiki::pingurl);

-

 } # }}}
 
 sub getopt () { #{{{
 } # }}}
 
 sub getopt () { #{{{


@@ -39,8 +39,54 @@ sub getopt () { #{{{
                "atom!" => \$config{atom},
                "allowrss!" => \$config{allowrss},
                "allowatom!" => \$config{allowatom},
                "atom!" => \$config{atom},
                "allowrss!" => \$config{allowrss},
                "allowatom!" => \$config{allowatom},

+               "pingurl=s" => sub {
+                       push @{$config{pingurl}}, $_[1];
+               },      

        );
        );

-}
+} #}}}
+
+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+               rss => {
+                       type => "boolean",
+                       example => 0,
+                       description => "enable rss feeds by default?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               atom => {
+                       type => "boolean",
+                       example => 0,
+                       description => "enable atom feeds by default?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               allowrss => {
+                       type => "boolean",
+                       example => 0,
+                       description => "allow rss feeds to be used?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               allowatom => {
+                       type => "boolean",
+                       example => 0,
+                       description => "allow atom feeds to be used?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               pingurl => {
+                       type => "string",
+                       example => "http://rpc.technorati.com/rpc/ping",
+                       description => "urls to ping (using XML-RPC) on feed update",
+                       safe => 1,
+                       rebuild => 0,
+               },
+} #}}}

 
 sub checkconfig () { #{{{
        if (($config{rss} || $config{atom}) && ! length $config{url}) {
 
 sub checkconfig () { #{{{
        if (($config{rss} || $config{atom}) && ! length $config{url}) {


@@ -52,6 +98,9 @@ sub checkconfig () { #{{{
        if ($config{atom}) {
                push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
        }
        if ($config{atom}) {
                push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
        }

+       if (! exists $config{pingurl}) {
+               $config{pingurl}=[];
+       }

 } #}}}
 
 sub format (@) { #{{{
 } #}}}
 
 sub format (@) { #{{{


@@ -65,24 +114,30 @@ sub format (@) { #{{{
        return $params{content};
 } #}}}
 
        return $params{content};
 } #}}}
 

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

        my $q=shift;
        my $session=shift;
 
        if ($q->param('do') eq 'blog') {
        my $q=shift;
        my $session=shift;
 
        if ($q->param('do') eq 'blog') {

-               my $page=decode_utf8($q->param('title'));
-               $page=~s/\///g; # no slashes in blog posts
+               my $page=titlepage(decode_utf8($q->param('title')));
+               $page=~s/(\/)/"__".ord($1)."__"/eg; # don't create subdirs

                # if the page already exists, munge it to be unique
                my $from=$q->param('from');
                my $add="";
                # if the page already exists, munge it to be unique
                my $from=$q->param('from');
                my $add="";

-               while (exists $IkiWiki::pagecase{lc($from."/".IkiWiki::titlepage($page).$add)}) {
+               while (exists $IkiWiki::pagecase{lc($from."/".$page.$add)}) {

                        $add=1 unless length $add;
                        $add++;
                }
                $q->param('page', $page.$add);
                # now go create the page
                $q->param('do', 'create');
                        $add=1 unless length $add;
                        $add++;
                }
                $q->param('page', $page.$add);
                # now go create the page
                $q->param('do', 'create');

-               IkiWiki::cgi_editpage($q, $session);
+               # make sure the editpage plugin in loaded
+               if (IkiWiki->can("cgi_editpage")) {
+                       IkiWiki::cgi_editpage($q, $session);
+               }
+               else {
+                       error(gettext("page editing not allowed"));
+               }

                exit;
        }
 }
                exit;
        }
 }


@@ -94,16 +149,11 @@ package IkiWiki;
 my %toping;
 my %feedlinks;
 
 my %toping;
 my %feedlinks;
 

-sub yesno ($) { #{{{
-       my $val=shift;
-       return (defined $val && lc($val) eq "yes");
-} #}}}
-

 sub preprocess_inline (@) { #{{{
        my %params=@_;
        
        if (! exists $params{pages}) {
 sub preprocess_inline (@) { #{{{
        my %params=@_;
        
        if (! exists $params{pages}) {

-               return "[[inline ".gettext("missing pages parameter")."]]";
+               error gettext("missing pages parameter");

        }
        my $raw=yesno($params{raw});
        my $archive=yesno($params{archive});
        }
        my $raw=yesno($params{raw});
        my $archive=yesno($params{archive});


@@ -142,7 +192,7 @@ sub preprocess_inline (@) { #{{{
        }
 
        if (exists $params{sort} && $params{sort} eq 'title') {
        }
 
        if (exists $params{sort} && $params{sort} eq 'title') {

-               @list=sort @list;
+               @list=sort { pagetitle(basename($a)) cmp pagetitle(basename($b)) } @list;

        }
        elsif (exists $params{sort} && $params{sort} eq 'mtime') {
                @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;
        }
        elsif (exists $params{sort} && $params{sort} eq 'mtime') {
                @list=sort { $pagemtime{$b} <=> $pagemtime{$a} } @list;


@@ -151,7 +201,7 @@ sub preprocess_inline (@) { #{{{
                @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
        }
        else {
                @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
        }
        else {

-               return sprintf(gettext("unknown sort type %s"), $params{sort});
+               error sprintf(gettext("unknown sort type %s"), $params{sort});

        }
 
        if (yesno($params{reverse})) {
        }
 
        if (yesno($params{reverse})) {


@@ -207,13 +257,23 @@ sub preprocess_inline (@) { #{{{
        my $atomurl=basename(atompage($params{destpage}).$feednum) if $feeds && $atom;
        my $ret="";
 
        my $atomurl=basename(atompage($params{destpage}).$feednum) if $feeds && $atom;
        my $ret="";
 

-       if ($config{cgiurl} && ! $params{preview} && (exists $params{rootpage} ||
-                       (exists $params{postform} && yesno($params{postform})))) {
+       if (length $config{cgiurl} && ! $params{preview} && (exists $params{rootpage} ||
+           (exists $params{postform} && yesno($params{postform}))) &&
+           IkiWiki->can("cgi_editpage")) {

                # Add a blog post form, with feed buttons.
                my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
                $formtemplate->param(cgiurl => $config{cgiurl});
                # Add a blog post form, with feed buttons.
                my $formtemplate=template("blogpost.tmpl", blind_cache => 1);
                $formtemplate->param(cgiurl => $config{cgiurl});

-               $formtemplate->param(rootpage => 
-                       exists $params{rootpage} ? $params{rootpage} : $params{page});
+               my $rootpage;
+               if (exists $params{rootpage}) {
+                       $rootpage=bestlink($params{page}, $params{rootpage});
+                       if (!length $rootpage) {
+                               $rootpage=$params{rootpage};
+                       }
+               }
+               else {
+                       $rootpage=$params{page};
+               }
+               $formtemplate->param(rootpage => $rootpage);

                $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
                $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
                if (exists $params{postformtext}) {
                $formtemplate->param(rssurl => $rssurl) if $feeds && $rss;
                $formtemplate->param(atomurl => $atomurl) if $feeds && $atom;
                if (exists $params{postformtext}) {


@@ -238,7 +298,7 @@ sub preprocess_inline (@) { #{{{
                require HTML::Template;
                my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
                if (! @params) {
                require HTML::Template;
                my @params=IkiWiki::template_params($params{template}.".tmpl", blind_cache => 1);
                if (! @params) {

-                       return sprintf(gettext("nonexistant template %s"), $params{template});
+                       error sprintf(gettext("nonexistant template %s"), $params{template});

                }
                my $template=HTML::Template->new(@params) unless $raw;
        
                }
                my $template=HTML::Template->new(@params) unless $raw;
        


@@ -256,6 +316,7 @@ sub preprocess_inline (@) { #{{{
                                $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
                                $template->param(title => pagetitle(basename($page)));
                                $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));
                                $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage}));
                                $template->param(title => pagetitle(basename($page)));
                                $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat}));

+                               $template->param(mtime => displaytime($pagemtime{$page}, $params{timeformat}));

                                $template->param(first => 1) if $page eq $list[0];
                                $template->param(last => 1) if $page eq $list[$#list];
        
                                $template->param(first => 1) if $page eq $list[0];
                                $template->param(last => 1) if $page eq $list[$#list];
        


@@ -278,7 +339,7 @@ sub preprocess_inline (@) { #{{{
                                        }
                                        if (length $config{cgiurl} && defined $type) {
                                                $template->param(have_actions => 1);
                                        }
                                        if (length $config{cgiurl} && defined $type) {
                                                $template->param(have_actions => 1);

-                                               $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
+                                               $template->param(editurl => cgiurl(do => "edit", page => $page));

                                        }
                                }
        
                                        }
                                }
        


@@ -313,9 +374,9 @@ sub preprocess_inline (@) { #{{{
                        if (! $params{preview}) {
                                writefile($rssp, $config{destdir},
                                        genfeed("rss",
                        if (! $params{preview}) {
                                writefile($rssp, $config{destdir},
                                        genfeed("rss",

-                                               $config{url}."/".rsspage($params{destpage}).$feednum, $desc, $params{destpage}, @feedlist));
+                                               $config{url}."/".$rssp, $desc, $params{guid}, $params{destpage}, @feedlist));

                                $toping{$params{destpage}}=1 unless $config{rebuild};
                                $toping{$params{destpage}}=1 unless $config{rebuild};

-                               $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
+                               $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/rss+xml" title="$desc (RSS)" href="$rssurl" />};

                        }
                }
                if ($atom) {
                        }
                }
                if ($atom) {


@@ -323,9 +384,9 @@ sub preprocess_inline (@) { #{{{
                        will_render($params{destpage}, $atomp);
                        if (! $params{preview}) {
                                writefile($atomp, $config{destdir},
                        will_render($params{destpage}, $atomp);
                        if (! $params{preview}) {
                                writefile($atomp, $config{destdir},

-                                       genfeed("atom", $config{url}."/".atompage($params{destpage}).$feednum, $desc, $params{destpage}, @feedlist));
+                                       genfeed("atom", $config{url}."/".$atomp, $desc, $params{guid}, $params{destpage}, @feedlist));

                                $toping{$params{destpage}}=1 unless $config{rebuild};
                                $toping{$params{destpage}}=1 unless $config{rebuild};

-                               $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
+                               $feedlinks{$params{destpage}}.=qq{<link rel="alternate" type="application/atom+xml" title="$desc (Atom)" href="$atomurl" />};

                        }
                }
        }
                        }
                }
        }


@@ -352,7 +413,7 @@ sub get_inline_content ($$) { #{{{
        my $type=pagetype($file);
        if (defined $type) {
                $nested++;
        my $type=pagetype($file);
        if (defined $type) {
                $nested++;

-               my $ret=htmlize($page, $type,
+               my $ret=htmlize($page, $destpage, $type,

                       linkify($page, $destpage,
                       preprocess($page, $destpage,
                       filter($page, $destpage,
                       linkify($page, $destpage,
                       preprocess($page, $destpage,
                       filter($page, $destpage,


@@ -416,20 +477,21 @@ sub atompage ($) { #{{{
        return targetpage(shift, "atom");
 } #}}}
 
        return targetpage(shift, "atom");
 } #}}}
 

-sub genfeed ($$$$@) { #{{{
+sub genfeed ($$$$$@) { #{{{

        my $feedtype=shift;
        my $feedurl=shift;
        my $feeddesc=shift;
        my $feedtype=shift;
        my $feedurl=shift;
        my $feeddesc=shift;

+       my $guid=shift;

        my $page=shift;
        my @pages=@_;
        
        my $page=shift;
        my @pages=@_;
        

-       my $url=URI->new(encode_utf8($config{url}."/".urlto($page,"")));
+       my $url=URI->new(encode_utf8(urlto($page,"",1)));

        
        my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
        my $content="";
        my $lasttime = 0;
        foreach my $p (@pages) {
        
        my $itemtemplate=template($feedtype."item.tmpl", blind_cache => 1);
        my $content="";
        my $lasttime = 0;
        foreach my $p (@pages) {

-               my $u=URI->new(encode_utf8($config{url}."/".urlto($p, "")));
+               my $u=URI->new(encode_utf8(urlto($p, "", 1)));

                my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
 
                $itemtemplate->param(
                my $pcontent = absolute_urls(get_inline_content($p, $page), $url);
 
                $itemtemplate->param(


@@ -442,6 +504,11 @@ sub genfeed ($$$$@) { #{{{
                        mdate_3339 => date_3339($pagemtime{$p}),
                );
 
                        mdate_3339 => date_3339($pagemtime{$p}),
                );
 

+               if (exists $pagestate{$p} &&
+                   exists $pagestate{$p}{meta}{guid}) {
+                       $itemtemplate->param(guid => $pagestate{$p}{meta}{guid});
+               }
+

                if ($itemtemplate->query(name => "enclosure")) {
                        my $file=$pagesources{$p};
                        my $type=pagetype($file);
                if ($itemtemplate->query(name => "enclosure")) {
                        my $file=$pagesources{$p};
                        my $type=pagetype($file);


@@ -484,6 +551,7 @@ sub genfeed ($$$$@) { #{{{
                pageurl => $url,
                content => $content,
                feeddesc => $feeddesc,
                pageurl => $url,
                content => $content,
                feeddesc => $feeddesc,

+               guid => $guid,

                feeddate => date_3339($lasttime),
                feedurl => $feedurl,
                version => $IkiWiki::version,
                feeddate => date_3339($lasttime),
                feedurl => $feedurl,
                version => $IkiWiki::version,


@@ -519,7 +587,7 @@ sub pingurl (@) { #{{{
 
        foreach my $page (keys %toping) {
                my $title=pagetitle(basename($page), 0);
 
        foreach my $page (keys %toping) {
                my $title=pagetitle(basename($page), 0);

-               my $url="$config{url}/".urlto($page, "");
+               my $url=urlto($page, "", 1);

                foreach my $pingurl (@{$config{pingurl}}) {
                        debug("Pinging $pingurl for $page");
                        eval {
                foreach my $pingurl (@{$config{pingurl}}) {
                        debug("Pinging $pingurl for $page");
                        eval {


@@ -528,15 +596,15 @@ sub pingurl (@) { #{{{
                                        $title, $url);
                                my $res = $client->send_request($req);
                                if (! ref $res) {
                                        $title, $url);
                                my $res = $client->send_request($req);
                                if (! ref $res) {

-                                       debug("Did not receive response to ping");
+                                       error("Did not receive response to ping");

                                }
                                my $r=$res->value;
                                if (! exists $r->{flerror} || $r->{flerror}) {
                                }
                                my $r=$res->value;
                                if (! exists $r->{flerror} || $r->{flerror}) {

-                                       debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
+                                       error("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));

                                }
                        };
                        if ($@) {
                                }
                        };
                        if ($@) {

-                               debug "Ping failed: $@";
+                               error "Ping failed: $@";

                        }
                }
        }
                        }
                }
        }