X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/02b9f69ba5da59cca9ff198b731d63d643fff4db..94a80b14891a735c56cff9e80642adb5f8a4ba72:/IkiWiki.pm?ds=sidebyside diff --git a/IkiWiki.pm b/IkiWiki.pm index c272a294e..761160eca 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -6,19 +6,22 @@ use strict; use Encode; use HTML::Entities; use URI::Escape q{uri_escape_utf8}; +use POSIX; use open qw{:utf8 :std}; use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase - %renderedfiles %oldrenderedfiles %pagesources %depends %hooks - %forcerebuild $gettext_obj}; + %renderedfiles %oldrenderedfiles %pagesources %destsources + %depends %hooks %forcerebuild $gettext_obj}; use Exporter q{import}; our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match bestlink htmllink readfile writefile pagetype srcfile pagename displaytime will_render gettext urlto targetpage - %config %links %renderedfiles %pagesources); -our $VERSION = 1.02; # plugin interface version, next is ikiwiki version -our $version="1.45";my $installdir="/usr"; + %config %links %renderedfiles %pagesources %destsources); +our $VERSION = 2.00; # 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; memoize("abs2rel"); @@ -28,7 +31,8 @@ memoize("file_pruned"); sub defaultconfig () { #{{{ wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/, qr/\.ikiwiki-new$/, - qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//], + qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//, + qr/\.dpkg-tmp$/], wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]#]+)(?:#([^\s\]]+))?\]\]/, wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/, web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/, @@ -65,15 +69,16 @@ sub defaultconfig () { #{{{ setup => undef, adminuser => undef, adminemail => undef, - plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit + plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit lockedit conditional}], timeformat => '%c', locale => undef, sslcookie => 0, httpauth => 0, userdir => "", - usedirs => 0, + usedirs => 1, numbacklinks => 10, + account_creation_password => "", } #}}} sub checkconfig () { #{{{ @@ -83,8 +88,6 @@ sub checkconfig () { #{{{ delete $ENV{LC_ALL}; } if (defined $config{locale}) { - eval q{use POSIX}; - error($@) if $@; if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) { $ENV{LANG}=$config{locale}; $gettext_obj=undef; @@ -152,7 +155,7 @@ sub error ($;$) { #{{{ print misctemplate(gettext("Error"), "

".gettext("Error").": $message

"); } - log_message(debug => $message) if $config{syslog}; + log_message('err' => $message) if $config{syslog}; if (defined $cleaner) { $cleaner->(); } @@ -176,8 +179,8 @@ sub log_message ($$) { #{{{ $log_open=1; } eval { - Sys::Syslog::syslog($type, "%s", join(" ", @_)); - } + Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_)); + }; } elsif (! $config{cgi}) { print "@_\n"; @@ -247,7 +250,7 @@ sub srcfile ($) { #{{{ return "$config{srcdir}/$file" if -e "$config{srcdir}/$file"; return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file"; - error("internal error: $file cannot be found"); + error("internal error: $file cannot be found in $config{srcdir} or $config{underlaydir}"); } #}}} sub readfile ($;$$) { #{{{ @@ -328,9 +331,13 @@ sub will_render ($$;$) { #{{{ $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}]; } else { + foreach my $old (@{$renderedfiles{$page}}) { + delete $destsources{$old}; + } $renderedfiles{$page}=[$dest]; $cleared{$page}=1; } + $destsources{$dest}=$page; } #}}} sub bestlink ($$) { #{{{ @@ -356,8 +363,14 @@ sub bestlink ($$) { #{{{ } } while $cwd=~s!/?[^/]+$!!; - if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) { - return "$config{userdir}/".lc($link); + if (length $config{userdir}) { + my $l = "$config{userdir}/".lc($link); + if (exists $links{$l}) { + return $l; + } + elsif (exists $pagecase{lc $l}) { + return $pagecase{lc $l}; + } } #print STDERR "warning: page $page, broken link: $link\n"; @@ -430,8 +443,6 @@ sub abs2rel ($$) { #{{{ sub displaytime ($) { #{{{ my $time=shift; - eval q{use POSIX}; - error($@) if $@; # strftime doesn't know about encodings, so make sure # its output is properly treated as utf8 return decode_utf8(POSIX::strftime( @@ -455,7 +466,7 @@ sub urlto ($$) { #{{{ return beautify_url(baseurl($from)); } - if (! grep { $_ eq $to } map { @{$_} } values %renderedfiles) { + if (! $destsources{$to}) { $to=htmlpage($to); } @@ -489,18 +500,19 @@ sub htmllink ($$$;@) { #{{{ return "$linktext" if length $bestlink && $page eq $bestlink; - if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) { + if (! $destsources{$bestlink}) { $bestlink=htmlpage($bestlink); - } - if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) { - return $linktext unless length $config{cgiurl}; - return " "create", - page => pagetitle(lc($link), 1), - from => $lpage - ). - "\">?$linktext" + + if (! $destsources{$bestlink}) { + return $linktext unless length $config{cgiurl}; + return " "create", + page => pagetitle(lc($link), 1), + from => $lpage + ). + "\">?$linktext" + } } $bestlink=abs2rel($bestlink, dirname(htmlpage($page))); @@ -549,8 +561,14 @@ sub linkify ($$$) { #{{{ $content =~ s{(\\?)$config{wiki_link_regexp}}{ defined $2 - ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, linkpage($3), anchor => $4, linktext => pagetitle($2))) - : ( $1 ? "[[$3]]" : htmllink($lpage, $page, linkpage($3), anchor => $4)) + ? ( $1 + ? "[[$2|$3".($4 ? "#$4" : "")."]]" + : htmllink($lpage, $page, linkpage($3), + anchor => $4, linktext => pagetitle($2))) + : ( $1 + ? "[[$3".($4 ? "#$4" : "")."]]" + : htmllink($lpage, $page, linkpage($3), + anchor => $4)) }eg; return $content; @@ -625,7 +643,7 @@ sub preprocess ($$$;$$) { #{{{ return $ret; } else { - return "[[$command $params]]"; + return "\\[[$command $params]]"; } }; @@ -633,12 +651,14 @@ sub preprocess ($$$;$$) { #{{{ return $content; } #}}} -sub filter ($$) { #{{{ +sub filter ($$$) { #{{{ my $page=shift; + my $destpage=shift; my $content=shift; run_hooks(filter => sub { - $content=shift->(page => $page, content => $content); + $content=shift->(page => $page, destpage => $destpage, + content => $content); }); return $content; @@ -648,7 +668,8 @@ sub indexlink () { #{{{ return "$config{wikiname}"; } #}}} -sub lockwiki () { #{{{ +sub lockwiki (;$) { #{{{ + my $wait=@_ ? shift : 1; # Take an exclusive lock on the wiki to prevent multiple concurrent # run issues. The lock will be dropped on program exit. if (! -d $config{wikistatedir}) { @@ -657,15 +678,21 @@ sub lockwiki () { #{{{ open(WIKILOCK, ">$config{wikistatedir}/lockfile") || error ("cannot write to $config{wikistatedir}/lockfile: $!"); 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..$wait) { - return if flock(WIKILOCK, 2 | 4); - sleep 1; + if ($wait) { + debug("wiki seems to be locked, waiting for lock"); + my $wait=600; # arbitrary, but don't hang forever to + # prevent process pileup + for (1..$wait) { + return if flock(WIKILOCK, 2 | 4); + sleep 1; + } + error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)"); + } + else { + return 0; } - error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)"); } + return 1; } #}}} sub unlockwiki () { #{{{ @@ -717,10 +744,11 @@ sub loadindex () { #{{{ $oldlinks{$page}=[@{$items{link}}]; $links{$page}=[@{$items{link}}]; $depends{$page}=$items{depends}[0] if exists $items{depends}; + $destsources{$_}=$page foreach @{$items{dest}}; $renderedfiles{$page}=[@{$items{dest}}]; - $oldrenderedfiles{$page}=[@{$items{dest}}]; $pagecase{lc $page}=$page; } + $oldrenderedfiles{$page}=[@{$items{dest}}]; $pagectime{$page}=$items{ctime}[0]; } close IN; @@ -962,38 +990,70 @@ sub pagespec_translate ($) { #{{{ } elsif ($word =~ /^(\w+)\((.*)\)$/) { if (exists $IkiWiki::PageSpec::{"match_$1"}) { - $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \$from)"; + $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)"; } else { $code.=" 0"; } } else { - $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)"; + $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)"; } } return $code; } #}}} -sub pagespec_match ($$;$) { #{{{ +sub pagespec_match ($$;@) { #{{{ my $page=shift; my $spec=shift; - my $from=shift; + my @params=@_; + + # Backwards compatability with old calling convention. + if (@params == 1) { + unshift @params, "location"; + } + + my $ret=eval pagespec_translate($spec); + return IkiWiki::FailReason->new("syntax error") if $@; + return $ret; +} #}}} + +package IkiWiki::FailReason; - return eval pagespec_translate($spec); +use overload ( #{{{ + '""' => sub { ${$_[0]} }, + '0+' => sub { 0 }, + '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'}, + fallback => 1, +); #}}} + +sub new { #{{{ + bless \$_[1], $_[0]; } #}}} +package IkiWiki::SuccessReason; + +use overload ( #{{{ + '""' => sub { ${$_[0]} }, + '0+' => sub { 1 }, + '!' => sub { bless $_[0], 'IkiWiki::FailReason'}, + fallback => 1, +); #}}} + +sub new { #{{{ + bless \$_[1], $_[0]; +}; #}}} + package IkiWiki::PageSpec; -sub match_glob ($$$) { #{{{ +sub match_glob ($$;@) { #{{{ my $page=shift; my $glob=shift; - my $from=shift; - if (! defined $from){ - $from = ""; - } - + my %params=@_; + + my $from=exists $params{location} ? $params{location} : ""; + # relative matching if ($glob =~ m!^\./!) { $from=~s!/?[^/]+$!!; @@ -1006,16 +1066,20 @@ sub match_glob ($$$) { #{{{ $glob=~s/\\\*/.*/g; $glob=~s/\\\?/./g; - return $page=~/^$glob$/i; + if ($page=~/^$glob$/i) { + return IkiWiki::SuccessReason->new("$glob matches $page"); + } + else { + return IkiWiki::FailReason->new("$glob does not match $page"); + } } #}}} -sub match_link ($$$) { #{{{ +sub match_link ($$;@) { #{{{ my $page=shift; my $link=lc(shift); - my $from=shift; - if (! defined $from){ - $from = ""; - } + my %params=@_; + + my $from=exists $params{location} ? $params{location} : ""; # relative matching if ($link =~ m!^\.! && defined $from) { @@ -1025,52 +1089,93 @@ sub match_link ($$$) { #{{{ } my $links = $IkiWiki::links{$page} or return undef; - return 0 unless @$links; + return IkiWiki::FailReason->new("$page has no links") unless @$links; my $bestlink = IkiWiki::bestlink($from, $link); + return IkiWiki::FailReason->new("no such link") unless length $bestlink; foreach my $p (@$links) { - return 1 if $bestlink eq IkiWiki::bestlink($page, $p); + return IkiWiki::SuccessReason->new("$page links to $link") + if $bestlink eq IkiWiki::bestlink($page, $p); } - return 0; + return IkiWiki::FailReason->new("$page does not link to $link"); } #}}} -sub match_backlink ($$$) { #{{{ - match_link($_[1], $_[0], $_[3]); +sub match_backlink ($$;@) { #{{{ + match_link($_[1], $_[0], @_); } #}}} -sub match_created_before ($$$) { #{{{ +sub match_created_before ($$;@) { #{{{ my $page=shift; my $testpage=shift; if (exists $IkiWiki::pagectime{$testpage}) { - return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}; + if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) { + IkiWiki::SuccessReason->new("$page created before $testpage"); + } + else { + IkiWiki::FailReason->new("$page not created before $testpage"); + } } else { - return 0; + return IkiWiki::FailReason->new("$testpage has no ctime"); } } #}}} -sub match_created_after ($$$) { #{{{ +sub match_created_after ($$;@) { #{{{ my $page=shift; my $testpage=shift; if (exists $IkiWiki::pagectime{$testpage}) { - return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}; + if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) { + IkiWiki::SuccessReason->new("$page created after $testpage"); + } + else { + IkiWiki::FailReason->new("$page not created after $testpage"); + } } else { - return 0; + return IkiWiki::FailReason->new("$testpage has no ctime"); } } #}}} -sub match_creation_day ($$$) { #{{{ - return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift); +sub match_creation_day ($$;@) { #{{{ + if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) { + return IkiWiki::SuccessReason->new("creation_day matched"); + } + else { + return IkiWiki::FailReason->new("creation_day did not match"); + } +} #}}} + +sub match_creation_month ($$;@) { #{{{ + if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) { + return IkiWiki::SuccessReason->new("creation_month matched"); + } + else { + return IkiWiki::FailReason->new("creation_month did not match"); + } } #}}} -sub match_creation_month ($$$) { #{{{ - return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift); +sub match_creation_year ($$;@) { #{{{ + if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) { + return IkiWiki::SuccessReason->new("creation_year matched"); + } + else { + return IkiWiki::FailReason->new("creation_year did not match"); + } } #}}} -sub match_creation_year ($$$) { #{{{ - return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift); +sub match_user ($$;@) { #{{{ + shift; + my $user=shift; + my %params=@_; + + return IkiWiki::FailReason->new("cannot match user") unless exists $params{user}; + if ($user eq $params{user}) { + return IkiWiki::SuccessReason->new("user is $user") + } + else { + return IkiWiki::FailReason->new("user is not $user"); + } } #}}} 1