X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f8a7fb227b59463b37180b1e525c5d19ec0e43cb..99bc53b83e87a5f26ac5250d6803bb2a62b9f325:/IkiWiki.pm?ds=sidebyside diff --git a/IkiWiki.pm b/IkiWiki.pm index 88d6d442b..e5d1c5c44 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -33,13 +33,28 @@ sub defaultconfig () { #{{{ qr/\.x?html?$/, qr/\.ikiwiki-new$/, qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//, qr/\.dpkg-tmp$/], - wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]#]+)(?:#([^\s\]]+))?\]\]/, + wiki_link_regexp => qr{ + \[\[ # beginning of link + (?: + ([^\]\|]+) # 1: link text + \| # followed by '|' + )? # optional + + ([^\s\]#]+) # 2: page to link to + (?: + \# # '#', beginning of anchor + ([^\s\]]+) # 3: anchor text + )? # optional + + \]\] # end of link + }x, wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/, web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/, verbose => 0, syslog => 0, wikiname => "wiki", default_pageext => "mdwn", + htmlext => "html", cgi => 0, post_commit => 0, rcs => '', @@ -69,15 +84,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 () { #{{{ @@ -111,7 +127,7 @@ sub checkconfig () { #{{{ unless exists $config{wikistatedir}; if ($config{rcs}) { - eval qq{require IkiWiki::Rcs::$config{rcs}}; + eval qq{use IkiWiki::Rcs::$config{rcs}}; if ($@) { error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@"); } @@ -178,7 +194,7 @@ sub log_message ($$) { #{{{ $log_open=1; } eval { - Sys::Syslog::syslog($type, "%s", join(" ", @_)); + Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_)); }; } elsif (! $config{cgi}) { @@ -191,7 +207,7 @@ sub log_message ($$) { #{{{ sub possibly_foolish_untaint ($) { #{{{ my $tainted=shift; - my ($untainted)=$tainted=~/(.*)/; + my ($untainted)=$tainted=~/(.*)/s; return $untainted; } #}}} @@ -241,7 +257,7 @@ sub targetpage ($$) { #{{{ sub htmlpage ($) { #{{{ my $page=shift; - return targetpage($page, "html"); + return targetpage($page, $config{htmlext}); } #}}} sub srcfile ($) { #{{{ @@ -362,8 +378,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"; @@ -445,7 +467,7 @@ sub displaytime ($) { #{{{ sub beautify_url ($) { #{{{ my $url=shift; - $url =~ s!/index.html$!/!; + $url =~ s!/index.$config{htmlext}$!/!; $url =~ s!^$!./!; # Browsers don't like empty links... return $url; @@ -585,14 +607,24 @@ sub preprocess ($$$;$$) { #{{{ my $command=shift; my $params=shift; if (length $escape) { - return "[[$command $params]]"; + return "\\[[$command $params]]"; } elsif (exists $hooks{preprocess}{$command}) { return "" if $scan && ! $hooks{preprocess}{$command}{scan}; # Note: preserve order of params, some plugins may # consider it significant. my @params; - while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) { + while ($params =~ m{ + (?:(\w+)=)? # 1: named parameter key? + (?: + """(.*?)""" # 2: triple-quoted value + | + "([^"]+)" # 3: single-quoted value + | + (\S+) # 4: unquoted value + ) + (?:\s+|$) # delimiter to next param + }sgx) { my $key=$1; my $val; if (defined $2) { @@ -636,20 +668,42 @@ sub preprocess ($$$;$$) { #{{{ return $ret; } else { - return "[[$command $params]]"; + return "\\[[$command $params]]"; } }; - $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg; + $content =~ s{ + (\\?) # 1: escape? + \[\[ # directive open + (\w+) # 2: command + \s+ + ( # 3: the parameters.. + (?: + (?:\w+=)? # named parameter key? + (?: + """.*?""" # triple-quoted value + | + "[^"]+" # single-quoted value + | + [^\s\]]+ # unquoted value + ) + \s* # whitespace or end + # of directive + ) + *) # 0 or more parameters + \]\] # directive closed + }{$handle->($1, $2, $3)}sexg; 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; @@ -659,7 +713,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}) { @@ -668,15 +723,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 () { #{{{ @@ -730,9 +791,9 @@ sub loadindex () { #{{{ $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; @@ -782,7 +843,6 @@ sub template_params (@) { #{{{ return ""; } - require HTML::Template; my @ret=( filter => sub { my $text_ref = shift; @@ -797,6 +857,7 @@ sub template_params (@) { #{{{ } #}}} sub template ($;@) { #{{{ + require HTML::Template; HTML::Template->new(template_params(@_)); } #}}} @@ -961,7 +1022,21 @@ sub pagespec_translate ($) { #{{{ # Convert spec to perl code. my $code=""; - while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) { + while ($spec=~m{ + \s* # ignore whitespace + ( # 1: match a single word + \! # ! + | + \( # ( + | + \) # ) + | + \w+\([^\)]+\) # command(params) + | + [^\s()]+ # any other text + ) + \s* # ignore whitespace + }igx) { my $word=$1; if (lc $word eq "and") { $code.=" &&"; @@ -1005,15 +1080,29 @@ sub pagespec_match ($$;@) { #{{{ package IkiWiki::FailReason; -use overload ( - '""' => sub { return ${$_[0]} }, - '0+' => sub { return 0 }, +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 { +sub new { #{{{ bless \$_[1], $_[0]; -} +}; #}}} package IkiWiki::PageSpec; @@ -1026,8 +1115,8 @@ sub match_glob ($$;@) { #{{{ # relative matching if ($glob =~ m!^\./!) { - $from=~s!/?[^/]+$!!; - $glob=~s!^\./!!; + $from=~s#/?[^/]+$##; + $glob=~s#^\./##; $glob="$from/$glob" if length $from; } @@ -1037,7 +1126,7 @@ sub match_glob ($$;@) { #{{{ $glob=~s/\\\?/./g; if ($page=~/^$glob$/i) { - return 1 + return IkiWiki::SuccessReason->new("$glob matches $page"); } else { return IkiWiki::FailReason->new("$glob does not match $page"); @@ -1053,17 +1142,23 @@ sub match_link ($$;@) { #{{{ # relative matching if ($link =~ m!^\.! && defined $from) { - $from=~s!/?[^/]+$!!; - $link=~s!^\./!!; + $from=~s#/?[^/]+$##; + $link=~s#^\./##; $link="$from/$link" if length $from; } my $links = $IkiWiki::links{$page} or return undef; 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); + if (length $bestlink) { + return IkiWiki::SuccessReason->new("$page links to $link") + if $bestlink eq IkiWiki::bestlink($page, $p); + } + else { + return IkiWiki::SuccessReason->new("$page links to page matching $link") + if match_glob($p, $link, %params); + } } return IkiWiki::FailReason->new("$page does not link to $link"); } #}}} @@ -1077,10 +1172,15 @@ sub match_created_before ($$;@) { #{{{ 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 IkiWiki::FailReason->new("$page not created before $testpage"); + return IkiWiki::FailReason->new("$testpage has no ctime"); } } #}}} @@ -1089,26 +1189,43 @@ sub match_created_after ($$;@) { #{{{ 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 IkiWiki::FailReason->new("$page not created after $testpage"); + return IkiWiki::FailReason->new("$testpage has no ctime"); } } #}}} sub match_creation_day ($$;@) { #{{{ - return 1 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift); - return IkiWiki::FailReason->new("creation_day did not match"); + 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 ($$;@) { #{{{ - return 1 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift); - return IkiWiki::FailReason->new("creation_month did not match"); + 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_year ($$;@) { #{{{ - return 1 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift); - return IkiWiki::FailReason->new("creation_year did not match"); + 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_user ($$;@) { #{{{ @@ -1117,8 +1234,12 @@ sub match_user ($$;@) { #{{{ my %params=@_; return IkiWiki::FailReason->new("cannot match user") unless exists $params{user}; - return 1 if $user eq $params{user}; - return IkiWiki::FailReason->new("user is not $user"); + if ($user eq $params{user}) { + return IkiWiki::SuccessReason->new("user is $user") + } + else { + return IkiWiki::FailReason->new("user is not $user"); + } } #}}} 1