]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/inline.pm
tag
[git.ikiwiki.info.git] / IkiWiki / Plugin / inline.pm
index 3c0c6f140709b9e91fdbb8b13fa86c08ee400d96..5d2ef5681b3d6ab84f16932f8e5efdbc030345a3 100644 (file)
@@ -10,21 +10,24 @@ use URI;
 
 my %knownfeeds;
 my %page_numfeeds;
+my @inline;
+my $nested=0;
 
 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 => "skeleton", call => \&sessioncgi);
+       hook(type => "sessioncgi", id => "inline", call => \&sessioncgi);
        hook(type => "preprocess", id => "inline", 
                call => \&IkiWiki::preprocess_inline);
        hook(type => "pagetemplate", id => "inline",
                call => \&IkiWiki::pagetemplate_inline);
+       hook(type => "format", id => "inline", call => \&format);
        # Hook to change to do pinging since it's called late.
        # This ensures each page only pings once and prevents slow
        # pings interrupting page builds.
        hook(type => "change", id => "inline", 
                call => \&IkiWiki::pingurl);
-
 } # }}}
 
 sub getopt () { #{{{
@@ -34,8 +37,56 @@ sub getopt () { #{{{
        GetOptions(
                "rss!" => \$config{rss},
                "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}) {
@@ -47,6 +98,20 @@ sub checkconfig () { #{{{
        if ($config{atom}) {
                push @{$config{wiki_file_prune_regexps}}, qr/\.atom$/;
        }
+       if (! exists $config{pingurl}) {
+               $config{pingurl}=[];
+       }
+} #}}}
+
+sub format (@) { #{{{
+        my %params=@_;
+
+       # Fill in the inline content generated earlier. This is actually an
+       # optimisation.
+       $params{content}=~s{<div class="inline" id="([^"]+)"></div>}{
+               delete @inline[$1,]
+       }eg;
+       return $params{content};
 } #}}}
 
 sub sessioncgi () { #{{{
@@ -54,19 +119,25 @@ sub sessioncgi () { #{{{
        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="";
-               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');
-               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;
        }
 }
@@ -78,32 +149,30 @@ package IkiWiki;
 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}) {
-               return "";
+               error gettext("missing pages parameter");
        }
        my $raw=yesno($params{raw});
        my $archive=yesno($params{archive});
-       my $rss=($config{rss} && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
-       my $atom=($config{atom} && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
+       my $rss=(($config{rss} || $config{allowrss}) && exists $params{rss}) ? yesno($params{rss}) : $config{rss};
+       my $atom=(($config{atom} || $config{allowatom}) && exists $params{atom}) ? yesno($params{atom}) : $config{atom};
        my $quick=exists $params{quick} ? yesno($params{quick}) : 0;
        my $feeds=exists $params{feeds} ? yesno($params{feeds}) : !$quick;
-       $feeds=0 if $params{preview};
        my $feedonly=yesno($params{feedonly});
        if (! exists $params{show} && ! $archive) {
                $params{show}=10;
        }
+       if (! exists $params{feedshow} && exists $params{show}) {
+               $params{feedshow}=$params{show};
+       }
        my $desc;
        if (exists $params{description}) {
                $desc = $params{description} 
-       } else {
+       }
+       else {
                $desc = $config{wikiname};
        }
        my $actions=yesno($params{actions});
@@ -123,7 +192,7 @@ sub preprocess_inline (@) { #{{{
        }
 
        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;
@@ -143,6 +212,17 @@ sub preprocess_inline (@) { #{{{
                @list=@list[$params{skip} .. scalar @list - 1];
        }
        
+       my @feedlist;
+       if ($feeds) {
+               if (exists $params{feedshow} &&
+                   $params{feedshow} && @list > $params{feedshow}) {
+                       @feedlist=@list[0..$params{feedshow} - 1];
+               }
+               else {
+                       @feedlist=@list;
+               }
+       }
+       
        if ($params{show} && @list > $params{show}) {
                @list=@list[0..$params{show} - 1];
        }
@@ -151,8 +231,8 @@ sub preprocess_inline (@) { #{{{
        # Explicitly add all currently displayed pages as dependencies, so
        # that if they are removed or otherwise changed, the inline will be
        # sure to be updated.
-       add_depends($params{page}, join(" or ", @list));
-       
+       add_depends($params{page}, join(" or ", $#list >= $#feedlist ? @list : @feedlist));
+
        my $feednum="";
 
        my $feedid=join("\0", map { $_."\0".$params{$_} } sort keys %params);
@@ -173,17 +253,27 @@ sub preprocess_inline (@) { #{{{
                }
        }
 
-       my $rssurl=basename(rsspage($params{destpage}).$feednum);
-       my $atomurl=basename(atompage($params{destpage}).$feednum);
+       my $rssurl=basename(rsspage($params{destpage}).$feednum) if $feeds && $rss;
+       my $atomurl=basename(atompage($params{destpage}).$feednum) if $feeds && $atom;
        my $ret="";
 
-       if ($config{cgiurl} && (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});
-               $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}) {
@@ -196,7 +286,7 @@ sub preprocess_inline (@) { #{{{
                }
                $ret.=$formtemplate->output;
        }
-       elsif ($feeds) {
+       elsif ($feeds && !$params{preview}) {
                # Add feed buttons.
                my $linktemplate=template("feedlink.tmpl", blind_cache => 1);
                $linktemplate->param(rssurl => $rssurl) if $rss;
@@ -226,6 +316,8 @@ 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(first => 1) if $page eq $list[0];
+                               $template->param(last => 1) if $page eq $list[$#list];
        
                                if ($actions) {
                                        my $file = $pagesources{$page};
@@ -246,7 +338,7 @@ sub preprocess_inline (@) { #{{{
                                        }
                                        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));
                                        }
                                }
        
@@ -271,32 +363,36 @@ sub preprocess_inline (@) { #{{{
        }
        
        if ($feeds) {
-               if (exists $params{feedshow} && @list > $params{feedshow}) {
-                       @list=@list[0..$params{feedshow} - 1];
-               }
                if (exists $params{feedpages}) {
-                       @list=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @list;
+                       @feedlist=grep { pagespec_match($_, $params{feedpages}, location => $params{page}) } @feedlist;
                }
        
                if ($rss) {
                        my $rssp=rsspage($params{destpage}).$feednum;
                        will_render($params{destpage}, $rssp);
-                       writefile($rssp, $config{destdir},
-                               genfeed("rss", $rssurl, $desc, $params{destpage}, @list));
-                       $toping{$params{destpage}}=1 unless $config{rebuild};
-                       $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
+                       if (! $params{preview}) {
+                               writefile($rssp, $config{destdir},
+                                       genfeed("rss",
+                                               $config{url}."/".$rssp, $desc, $params{guid}, $params{destpage}, @feedlist));
+                               $toping{$params{destpage}}=1 unless $config{rebuild};
+                               $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/rss+xml" title="RSS" href="$rssurl" />};
+                       }
                }
                if ($atom) {
                        my $atomp=atompage($params{destpage}).$feednum;
                        will_render($params{destpage}, $atomp);
-                       writefile($atomp, $config{destdir},
-                               genfeed("atom", $atomurl, $desc, $params{destpage}, @list));
-                       $toping{$params{destpage}}=1 unless $config{rebuild};
-                       $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
+                       if (! $params{preview}) {
+                               writefile($atomp, $config{destdir},
+                                       genfeed("atom", $config{url}."/".$atomp, $desc, $params{guid}, $params{destpage}, @feedlist));
+                               $toping{$params{destpage}}=1 unless $config{rebuild};
+                               $feedlinks{$params{destpage}}=qq{<link rel="alternate" type="application/atom+xml" title="Atom" href="$atomurl" />};
+                       }
                }
        }
        
-       return $ret;
+       return $ret if $raw || $nested;
+       push @inline, $ret;
+       return "<div class=\"inline\" id=\"$#inline\"></div>\n\n";
 } #}}}
 
 sub pagetemplate_inline (@) { #{{{
@@ -315,11 +411,14 @@ sub get_inline_content ($$) { #{{{
        my $file=$pagesources{$page};
        my $type=pagetype($file);
        if (defined $type) {
-               return htmlize($page, $type,
+               $nested++;
+               my $ret=htmlize($page, $destpage, $type,
                       linkify($page, $destpage,
                       preprocess($page, $destpage,
                       filter($page, $destpage,
                       readfile(srcfile($file))))));
+               $nested--;
+               return $ret;
        }
        else {
                return "";
@@ -353,10 +452,19 @@ sub absolute_urls ($$) { #{{{
 
        my $url=$baseurl;
        $url=~s/[^\/]+$//;
-       
+
+        # what is the non path part of the url?
+        my $top_uri = URI->new($url);
+        $top_uri->path_query(""); # reset the path
+        my $urltop = $top_uri->as_string;
+
        $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(#[^"]+)"/$1 href="$baseurl$2"/mig;
-       $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:\/\/)([^"]+)"/$1 href="$url$2"/mig;
-       $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:\/\/)([^"]+)"/$1 src="$url$2"/mig;
+        # relative to another wiki page
+       $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:)([^\/][^"]*)"/$1 href="$url$2"/mig;
+       $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:)([^\/][^"]*)"/$1 src="$url$2"/mig;
+        # relative to the top of the site
+       $content=~s/(<a(?:\s+(?:class|id)\s*="?\w+"?)?)\s+href=\s*"(?!\w+:)(\/[^"]*)"/$1 href="$urltop$2"/mig;
+       $content=~s/(<img(?:\s+(?:class|id|width|height)\s*="?\w+"?)*)\s+src=\s*"(?!\w+:)(\/[^"]*)"/$1 src="$urltop$2"/mig;
        return $content;
 } #}}}
 
@@ -368,20 +476,21 @@ sub atompage ($) { #{{{
        return targetpage(shift, "atom");
 } #}}}
 
-sub genfeed ($$$$@) { #{{{
+sub genfeed ($$$$$@) { #{{{
        my $feedtype=shift;
        my $feedurl=shift;
        my $feeddesc=shift;
+       my $guid=shift;
        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 $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(
@@ -394,6 +503,11 @@ sub genfeed ($$$$@) { #{{{
                        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);
@@ -401,7 +515,7 @@ sub genfeed ($$$$@) { #{{{
                                $itemtemplate->param(content => $pcontent);
                        }
                        else {
-                               my ($a, $b, $c, $d, $e, $f, $g, $size) = stat(srcfile($file));
+                               my $size=(srcfile_stat($file))[8];
                                my $mime="unknown";
                                eval q{use File::MimeInfo};
                                if (! $@) {
@@ -436,6 +550,7 @@ sub genfeed ($$$$@) { #{{{
                pageurl => $url,
                content => $content,
                feeddesc => $feeddesc,
+               guid => $guid,
                feeddate => date_3339($lasttime),
                feedurl => $feedurl,
                version => $IkiWiki::version,
@@ -461,7 +576,7 @@ sub pingurl (@) { #{{{
        defined(my $pid = fork) or error("Can't fork: $!");
        return if $pid;
        chdir '/';
-       setsid() or error("Can't start a new session: $!");
+       POSIX::setsid() or error("Can't start a new session: $!");
        open STDIN, '/dev/null';
        open STDOUT, '>/dev/null';
        open STDERR, '>&STDOUT' or error("Can't dup stdout: $!");
@@ -471,7 +586,7 @@ sub pingurl (@) { #{{{
 
        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 {
@@ -480,15 +595,15 @@ sub pingurl (@) { #{{{
                                        $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}) {
-                                       debug("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
+                                       error("Ping rejected: ".(exists $r->{message} ? $r->{message} : "[unknown reason]"));
                                }
                        };
                        if ($@) {
-                               debug "Ping failed: $@";
+                               error "Ping failed: $@";
                        }
                }
        }