]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
web commit by http://ethan.betacantrips.com/: I think I like reST, can we improve...
[git.ikiwiki.info.git] / IkiWiki.pm
index dfd2240628141a08e6a9b0d538266b94015b73f6..dcb68bca6d525578fee12e7bdd25d5f92c1e51ef 100644 (file)
@@ -16,7 +16,9 @@ our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
                  bestlink htmllink readfile writefile pagetype srcfile pagename
                  displaytime will_render gettext
                  %config %links %renderedfiles %pagesources);
-our $VERSION = 1.01; # plugin interface version
+our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
+our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
+my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 
 # Optimisation.
 use Memoize;
@@ -24,13 +26,11 @@ memoize("abs2rel");
 memoize("pagespec_translate");
 memoize("file_pruned");
 
-my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
-our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
-
 sub defaultconfig () { #{{{
-       wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/,
+       wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
+               qr/\.x?html?$/, qr/\.ikiwiki-new$/,
                qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
-       wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
+       wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]#]+)(?:#([^\s\]]+))?\]\]/,
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
        web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
        verbose => 0,
@@ -38,6 +38,7 @@ sub defaultconfig () { #{{{
        wikiname => "wiki",
        default_pageext => "mdwn",
        cgi => 0,
+       post_commit => 0,
        rcs => '',
        notify => 0,
        url => '',
@@ -65,7 +66,8 @@ sub defaultconfig () { #{{{
        setup => undef,
        adminuser => undef,
        adminemail => undef,
-       plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit lockedit}],
+       plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit
+                     lockedit conditional}],
        timeformat => '%c',
        locale => undef,
        sslcookie => 0,
@@ -141,14 +143,19 @@ sub loadplugin ($) { #{{{
        }
 } #}}}
 
-sub error ($) { #{{{
+sub error ($;$) { #{{{
+       my $message=shift;
+       my $cleaner=shift;
        if ($config{cgi}) {
                print "Content-type: text/html\n\n";
                print misctemplate(gettext("Error"),
-                       "<p>".gettext("Error").": @_</p>");
+                       "<p>".gettext("Error").": $message</p>");
        }
-       log_message(error => @_);
-       exit(1);
+       log_message(debug => $message) if $config{syslog};
+       if (defined $cleaner) {
+               $cleaner->();
+       }
+       die $message."\n";
 } #}}}
 
 sub debug ($) { #{{{
@@ -168,7 +175,7 @@ sub log_message ($$) { #{{{
                        $log_open=1;
                }
                eval {
-                       Sys::Syslog::syslog($type, join(" ", @_));
+                       Sys::Syslog::syslog($type, "%s", join(" ", @_));
                }
        }
        elsif (! $config{cgi}) {
@@ -245,7 +252,7 @@ sub readfile ($;$$) { #{{{
        binmode(IN) if ($binary);
        return \*IN if $wantfd;
        my $ret=<IN>;
-       close IN;
+       close IN || error("failed to read $file: $!");
        return $ret;
 } #}}}
 
@@ -254,7 +261,7 @@ sub writefile ($$$;$$) { #{{{
        my $destdir=shift; # directory to put file in
        my $content=shift;
        my $binary=shift;
-       my $wantfd=shift;
+       my $writer=shift;
        
        my $test=$file;
        while (length $test) {
@@ -263,8 +270,12 @@ sub writefile ($$$;$$) { #{{{
                }
                $test=dirname($test);
        }
+       my $newfile="$destdir/$file.ikiwiki-new";
+       if (-l $newfile) {
+               error("cannot write to a symlink ($newfile)");
+       }
 
-       my $dir=dirname("$destdir/$file");
+       my $dir=dirname($newfile);
        if (! -d $dir) {
                my $d="";
                foreach my $s (split(m!/+!, $dir)) {
@@ -274,12 +285,21 @@ sub writefile ($$$;$$) { #{{{
                        }
                }
        }
-       
-       open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
+
+       my $cleanup = sub { unlink($newfile) };
+       open (OUT, ">$newfile") || error("failed to write $newfile: $!", $cleanup);
        binmode(OUT) if ($binary);
-       return \*OUT if $wantfd;
-       print OUT $content;
-       close OUT;
+       if ($writer) {
+               $writer->(\*OUT, $cleanup);
+       }
+       else {
+               if (length $content) {
+                       print OUT $content || error("failed writing to $newfile: $!", $cleanup);
+               }
+       }
+       close OUT || error("failed saving $newfile: $!", $cleanup);
+       rename($newfile, "$destdir/$file") || 
+               error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
 } #}}}
 
 my %cleared;
@@ -402,23 +422,27 @@ sub displaytime ($) { #{{{
                        $config{timeformat}, localtime($time)));
 } #}}}
 
-sub htmllink ($$$;$$$) { #{{{
+sub htmllink ($$$;@) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)
        my $link=shift;
-       my $noimageinline=shift; # don't turn links into inline html images
-       my $forcesubpage=shift; # force a link to a subpage
-       my $linktext=shift; # set to force the link text to something
+       my %opts=@_;
 
        my $bestlink;
-       if (! $forcesubpage) {
+       if (! $opts{forcesubpage}) {
                $bestlink=bestlink($lpage, $link);
        }
        else {
                $bestlink="$lpage/".lc($link);
        }
 
-       $linktext=pagetitle(basename($link)) unless defined $linktext;
+       my $linktext;
+       if (defined $opts{linktext}) {
+               $linktext=$opts{linktext};
+       }
+       else {
+               $linktext=pagetitle(basename($link));
+       }
        
        return "<span class=\"selflink\">$linktext</span>"
                if length $bestlink && $page eq $bestlink;
@@ -435,9 +459,14 @@ sub htmllink ($$$;$$$) { #{{{
        
        $bestlink=abs2rel($bestlink, dirname($page));
        
-       if (! $noimageinline && isinlinableimage($bestlink)) {
+       if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
                return "<img src=\"$bestlink\" alt=\"$linktext\" />";
        }
+
+       if (defined $opts{anchor}) {
+               $bestlink.="#".$opts{anchor};
+       }
+
        return "<a href=\"$bestlink\">$linktext</a>";
 } #}}}
 
@@ -472,8 +501,9 @@ sub linkify ($$$) { #{{{
        my $content=shift;
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
-               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
-                  : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
+               defined $2
+                       ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), anchor => $4, linktext => pagetitle($2)))
+                       : ( $1 ? "[[$3]]"    : htmllink($lpage, $page, titlepage($3), anchor => $4))
        }eg;
        
        return $content;
@@ -572,11 +602,11 @@ sub lockwiki () { #{{{
        }
        open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
                error ("cannot write to $config{wikistatedir}/lockfile: $!");
-       if (! flock(WIKILOCK, 2 | 4)) {
+       if (! flock(WIKILOCK, 2 | 4)) { # LOCK_EX | LOCK_NB
                debug("wiki seems to be locked, waiting for lock");
                my $wait=600; # arbitrary, but don't hang forever to 
                              # prevent process pileup
-               for (1..600) {
+               for (1..$wait) {
                        return if flock(WIKILOCK, 2 | 4);
                        sleep 1;
                }
@@ -588,6 +618,29 @@ sub unlockwiki () { #{{{
        close WIKILOCK;
 } #}}}
 
+sub commit_hook_enabled () { #{{{
+       open(COMMITLOCK, "+>$config{wikistatedir}/commitlock") ||
+               error ("cannot write to $config{wikistatedir}/commitlock: $!");
+       if (! flock(COMMITLOCK, 1 | 4)) { # LOCK_SH | LOCK_NB to test
+               close COMMITLOCK;
+               return 0;
+       }
+       close COMMITLOCK;
+       return 1;
+} #}}}
+
+sub disable_commit_hook () { #{{{
+       open(COMMITLOCK, ">$config{wikistatedir}/commitlock") ||
+               error ("cannot write to $config{wikistatedir}/commitlock: $!");
+       if (! flock(COMMITLOCK, 2)) { # LOCK_EX
+               error("failed to get commit lock");
+       }
+} #}}}
+
+sub enable_commit_hook () { #{{{
+       close COMMITLOCK;
+} #}}}
+
 sub loadindex () { #{{{
        open (IN, "$config{wikistatedir}/index") || return;
        while (<IN>) {
@@ -625,8 +678,9 @@ sub saveindex () { #{{{
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }
-       open (OUT, ">$config{wikistatedir}/index") || 
-               error("cannot write to $config{wikistatedir}/index: $!");
+       my $newfile="$config{wikistatedir}/index.new";
+       my $cleanup = sub { unlink($newfile) };
+       open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup);
        foreach my $page (keys %oldpagemtime) {
                next unless $oldpagemtime{$page};
                my $line="mtime=$oldpagemtime{$page} ".
@@ -638,9 +692,11 @@ sub saveindex () { #{{{
                if (exists $depends{$page}) {
                        $line.=" depends=".encode_entities($depends{$page}, " \t\n");
                }
-               print OUT $line."\n";
+               print OUT $line."\n" || error("failed writing to $newfile: $!", $cleanup);
        }
-       close OUT;
+       close OUT || error("failed saving to $newfile: $!", $cleanup);
+       rename($newfile, "$config{wikistatedir}/index") ||
+               error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
 } #}}}
 
 sub template_file ($) { #{{{
@@ -850,27 +906,46 @@ sub pagespec_translate ($) { #{{{
                elsif ($word eq "(" || $word eq ")" || $word eq "!") {
                        $code.=" ".$word;
                }
-               elsif ($word =~ /^(link|backlink|created_before|created_after|creation_month|creation_year|creation_day)\((.+)\)$/) {
-                       $code.=" match_$1(\$page, ".safequote($2).")";
+               elsif ($word =~ /^(\w+)\((.*)\)$/) {
+                       if (exists $IkiWiki::PageSpec::{"match_$1"}) {
+                               $code.=" IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).")";
+                       }
+                       else {
+                               $code.=" 0";
+                       }
                }
                else {
-                       $code.=" match_glob(\$page, ".safequote($word).")";
+                       $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)";
                }
        }
 
        return $code;
 } #}}}
 
-sub pagespec_match ($$) { #{{{
+sub pagespec_match ($$;$) { #{{{
        my $page=shift;
        my $spec=shift;
+       my $from=shift;
 
        return eval pagespec_translate($spec);
 } #}}}
 
-sub match_glob ($$) { #{{{
+package IkiWiki::PageSpec;
+
+sub match_glob ($$$) { #{{{
        my $page=shift;
        my $glob=shift;
+       my $from=shift;
+       if (! defined $from){
+               $from = "";
+       }
+
+       # relative matching
+       if ($glob =~ m!^\./!) {
+               $from=~s!/?[^/]+$!!;
+               $glob=~s!^\./!!;
+               $glob="$from/$glob" if length $from;
+       }
 
        # turn glob into safe regexp
        $glob=quotemeta($glob);
@@ -884,7 +959,7 @@ sub match_link ($$) { #{{{
        my $page=shift;
        my $link=lc(shift);
 
-       my $links = $links{$page} or return undef;
+       my $links = $IkiWiki::links{$page} or return undef;
        foreach my $p (@$links) {
                return 1 if lc $p eq $link;
        }
@@ -899,8 +974,8 @@ sub match_created_before ($$) { #{{{
        my $page=shift;
        my $testpage=shift;
 
-       if (exists $pagectime{$testpage}) {
-               return $pagectime{$page} < $pagectime{$testpage};
+       if (exists $IkiWiki::pagectime{$testpage}) {
+               return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage};
        }
        else {
                return 0;
@@ -911,8 +986,8 @@ sub match_created_after ($$) { #{{{
        my $page=shift;
        my $testpage=shift;
 
-       if (exists $pagectime{$testpage}) {
-               return $pagectime{$page} > $pagectime{$testpage};
+       if (exists $IkiWiki::pagectime{$testpage}) {
+               return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage};
        }
        else {
                return 0;
@@ -920,15 +995,15 @@ sub match_created_after ($$) { #{{{
 } #}}}
 
 sub match_creation_day ($$) { #{{{
-       return ((gmtime($pagectime{shift()}))[3] == shift);
+       return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);
 } #}}}
 
 sub match_creation_month ($$) { #{{{
-       return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
+       return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
 } #}}}
 
 sub match_creation_year ($$) { #{{{
-       return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);
+       return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);
 } #}}}
 
 1