X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/3b0fce93e40e5457b63ceda9692901539eb4fc82..d8819689b1f7ffe80164f223b38f071c0783cd38:/IkiWiki.pm diff --git a/IkiWiki.pm b/IkiWiki.pm index 31228883f..5bb8ea1c9 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -3,35 +3,102 @@ package IkiWiki; use warnings; use strict; -use File::Spec; -use HTML::Template; +use Encode; +use HTML::Entities; +use open qw{:utf8 :std}; -use vars qw{%config %links %oldlinks %oldpagemtime %pagectime - %renderedfiles %pagesources %depends %plugins}; +# Optimisation. +use Memoize; +memoize("abs2rel"); +memoize("pagespec_translate"); +use vars qw{%config %links %oldlinks %oldpagemtime %pagectime + %renderedfiles %pagesources %depends %hooks %forcerebuild}; + +sub defaultconfig () { #{{{ + wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?html?$|\.rss$)}, + wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/, + wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/, + wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/, + verbose => 0, + wikiname => "wiki", + default_pageext => "mdwn", + cgi => 0, + rcs => 'svn', + notify => 0, + url => '', + cgiurl => '', + historyurl => '', + diffurl => '', + anonok => 0, + rss => 0, + discussion => 1, + rebuild => 0, + refresh => 0, + getctime => 0, + w3mmode => 0, + wrapper => undef, + wrappermode => undef, + svnrepo => undef, + svnpath => "trunk", + srcdir => undef, + destdir => undef, + pingurl => [], + templatedir => "/usr/share/ikiwiki/templates", + underlaydir => "/usr/share/ikiwiki/basewiki", + setup => undef, + adminuser => undef, + adminemail => undef, + plugin => [qw{mdwn inline htmlscrubber}], + timeformat => '%c', + locale => undef, +} #}}} + sub checkconfig () { #{{{ + # locale stuff; avoid LC_ALL since it overrides everything + if (defined $ENV{LC_ALL}) { + $ENV{LANG} = $ENV{LC_ALL}; + delete $ENV{LC_ALL}; + } + if (defined $config{locale}) { + eval q{use POSIX}; + $ENV{LANG} = $config{locale} + if POSIX::setlocale(&POSIX::LC_TIME, $config{locale}); + } + + if ($config{w3mmode}) { + eval q{use Cwd q{abs_path}}; + $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir})); + $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir})); + $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl} + unless $config{cgiurl} =~ m!file:///!; + $config{url}="file://".$config{destdir}; + } + if ($config{cgi} && ! length $config{url}) { error("Must specify url to wiki with --url when using --cgi\n"); } if ($config{rss} && ! length $config{url}) { error("Must specify url to wiki with --url when using --rss\n"); } - if ($config{hyperestraier} && ! length $config{url}) { - error("Must specify --url when using --hyperestraier\n"); - } $config{wikistatedir}="$config{srcdir}/.ikiwiki" unless exists $config{wikistatedir}; - if ($config{svn}) { - require IkiWiki::Rcs::SVN; - $config{rcs}=1; + if ($config{rcs}) { + eval qq{require IkiWiki::Rcs::$config{rcs}}; + if ($@) { + error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@"); + } } else { require IkiWiki::Rcs::Stub; - $config{rcs}=0; } + run_hooks(checkconfig => sub { shift->() }); +} #}}} + +sub loadplugins () { #{{{ foreach my $plugin (@{$config{plugin}}) { my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin); eval qq{use $mod}; @@ -39,6 +106,12 @@ sub checkconfig () { #{{{ error("Failed to load plugin $mod: $@"); } } + run_hooks(getopt => sub { shift->() }); + if (grep /^-/, @ARGV) { + print STDERR "Unknown option: $_\n" + foreach grep /^-/, @ARGV; + usage(); + } } #}}} sub error ($) { #{{{ @@ -82,12 +155,10 @@ sub dirname ($) { #{{{ sub pagetype ($) { #{{{ my $page=shift; - if ($page =~ /\.mdwn$/) { - return ".mdwn"; - } - else { - return "unknown"; + if ($page =~ /\.([^.]+)$/) { + return $1 if exists $hooks{htmlize}{$1}; } + return undef; } #}}} sub pagename ($) { #{{{ @@ -95,7 +166,7 @@ sub pagename ($) { #{{{ my $type=pagetype($file); my $page=$file; - $page=~s/\Q$type\E*$// unless $type eq 'unknown'; + $page=~s/\Q.$type\E*$// if defined $type; return $page; } #}}} @@ -123,7 +194,7 @@ sub readfile ($;$) { #{{{ local $/=undef; open (IN, $file) || error("failed to read $file: $!"); - binmode(IN) if $binary; + binmode(IN) if ($binary); my $ret=; close IN; return $ret; @@ -155,7 +226,7 @@ sub writefile ($$$;$) { #{{{ } open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!"); - binmode(OUT) if $binary; + binmode(OUT) if ($binary); print OUT $content; close OUT; } #}}} @@ -221,8 +292,22 @@ sub styleurl (;$) { #{{{ return $page."style.css"; } #}}} -sub htmllink ($$;$$$) { #{{{ - my $page=shift; +sub abs2rel ($$) { #{{{ + # Work around very innefficient behavior in File::Spec if abs2rel + # is passed two relative paths. It's much faster if paths are + # absolute! + my $path="/".shift; + my $base="/".shift; + + require File::Spec; + my $ret=File::Spec->abs2rel($path, $base); + $ret=~s/^// if defined $ret; + return $ret; +} #}}} + +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 @@ -230,10 +315,10 @@ sub htmllink ($$;$$$) { #{{{ my $bestlink; if (! $forcesubpage) { - $bestlink=bestlink($page, $link); + $bestlink=bestlink($lpage, $link); } else { - $bestlink="$page/".lc($link); + $bestlink="$lpage/".lc($link); } $linktext=pagetitle(basename($link)) unless defined $linktext; @@ -242,18 +327,17 @@ sub htmllink ($$;$$$) { #{{{ # TODO BUG: %renderedfiles may not have it, if the linked to page # was also added and isn't yet rendered! Note that this bug is - # masked by the bug mentioned below that makes all new files - # be rendered twice. + # masked by the bug that makes all new files be rendered twice. if (! grep { $_ eq $bestlink } values %renderedfiles) { $bestlink=htmlpage($bestlink); } if (! grep { $_ eq $bestlink } values %renderedfiles) { return " "create", page => $link, from =>$page). + cgiurl(do => "create", page => $link, from => $page). "\">?$linktext" } - $bestlink=File::Spec->abs2rel($bestlink, dirname($page)); + $bestlink=abs2rel($bestlink, dirname($page)); if (! $noimageinline && isinlinableimage($bestlink)) { return "\"$linktext\""; @@ -298,7 +382,7 @@ sub loadindex () { #{{{ $items{link}=[]; foreach my $i (split(/ /, $_)) { my ($item, $val)=split(/=/, $i, 2); - push @{$items{$item}}, $val; + push @{$items{$item}}, decode_entities($val); } next unless exists $items{src}; # skip bad lines for now @@ -309,8 +393,7 @@ sub loadindex () { #{{{ $oldpagemtime{$page}=$items{mtime}[0]; $oldlinks{$page}=[@{$items{link}}]; $links{$page}=[@{$items{link}}]; - $depends{$page}=join(" ", @{$items{depends}}) - if exists $items{depends}; + $depends{$page}=$items{depends}[0] if exists $items{depends}; $renderedfiles{$page}=$items{dest}[0]; } $pagectime{$page}=$items{ctime}[0]; @@ -319,6 +402,8 @@ sub loadindex () { #{{{ } #}}} sub saveindex () { #{{{ + run_hooks(savestate => sub { shift->() }); + if (! -d $config{wikistatedir}) { mkdir($config{wikistatedir}); } @@ -332,20 +417,33 @@ sub saveindex () { #{{{ "dest=$renderedfiles{$page}"; $line.=" link=$_" foreach @{$links{$page}}; if (exists $depends{$page}) { - $line.=" depends=$_" foreach split " ", $depends{$page}; + $line.=" depends=".encode_entities($depends{$page}, " \t\n"); } print OUT $line."\n"; } close OUT; } #}}} +sub template_params (@) { #{{{ + my $filename=shift; + + require HTML::Template; + return filter => sub { + my $text_ref = shift; + $$text_ref=&Encode::decode_utf8($$text_ref); + }, + filename => "$config{templatedir}/$filename", @_; +} #}}} + +sub template ($;@) { #{{{ + HTML::Template->new(template_params(@_)); +} #}}} + sub misctemplate ($$) { #{{{ my $title=shift; my $pagebody=shift; - my $template=HTML::Template->new( - filename => "$config{templatedir}/misc.tmpl" - ); + my $template=template("misc.tmpl"); $template->param( title => $title, indexlink => indexlink(), @@ -357,7 +455,123 @@ sub misctemplate ($$) { #{{{ return $template->output; }#}}} -sub glob_match ($$) { #{{{ +sub hook (@) { # {{{ + my %param=@_; + + if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) { + error "hook requires type, call, and id parameters"; + } + + $hooks{$param{type}}{$param{id}}=\%param; +} # }}} + +sub run_hooks ($$) { # {{{ + # Calls the given sub for each hook of the given type, + # passing it the hook function to call. + my $type=shift; + my $sub=shift; + + if (exists $hooks{$type}) { + foreach my $id (keys %{$hooks{$type}}) { + $sub->($hooks{$type}{$id}{call}); + } + } +} #}}} + +sub globlist_to_pagespec ($) { #{{{ + my @globlist=split(' ', shift); + + my (@spec, @skip); + foreach my $glob (@globlist) { + if ($glob=~/^!(.*)/) { + push @skip, $glob; + } + else { + push @spec, $glob; + } + } + + my $spec=join(" or ", @spec); + if (@skip) { + my $skip=join(" and ", @skip); + if (length $spec) { + $spec="$skip and ($spec)"; + } + else { + $spec=$skip; + } + } + return $spec; +} #}}} + +sub is_globlist ($) { #{{{ + my $s=shift; + $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or"; +} #}}} + +sub safequote ($) { #{{{ + my $s=shift; + $s=~s/[{}]//g; + return "q{$s}"; +} #}}} + +sub pagespec_merge ($$) { #{{{ + my $a=shift; + my $b=shift; + + # Support for old-style GlobLists. + if (is_globlist($a)) { + $a=globlist_to_pagespec($a); + } + if (is_globlist($b)) { + $b=globlist_to_pagespec($b); + } + + return "($a) or ($b)"; +} #}}} + +sub pagespec_translate ($) { #{{{ + # This assumes that $page is in scope in the function + # that evalulates the translated pagespec code. + my $spec=shift; + + # Support for old-style GlobLists. + if (is_globlist($spec)) { + $spec=globlist_to_pagespec($spec); + } + + # Convert spec to perl code. + my $code=""; + while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) { + my $word=$1; + if (lc $word eq "and") { + $code.=" &&"; + } + elsif (lc $word eq "or") { + $code.=" ||"; + } + 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).")"; + } + else { + $code.=" match_glob(\$page, ".safequote($word).")"; + } + } + + return $code; +} #}}} + +sub pagespec_match ($$) { #{{{ + my $page=shift; + my $spec=shift; + + return eval pagespec_translate($spec); +} #}}} + +sub match_glob ($$) { #{{{ my $page=shift; my $glob=shift; @@ -365,33 +579,59 @@ sub glob_match ($$) { #{{{ $glob=quotemeta($glob); $glob=~s/\\\*/.*/g; $glob=~s/\\\?/./g; - $glob=~s!\\/!/!g; - - $page=~/^$glob$/i; + + return $page=~/^$glob$/i; } #}}} -sub globlist_match ($$) { #{{{ +sub match_link ($$) { #{{{ my $page=shift; - my @globlist=split(" ", shift); + my $link=shift; - # check any negated globs first - foreach my $glob (@globlist) { - return 0 if $glob=~/^!(.*)/ && glob_match($page, $1); + my $links = $links{$page} or return undef; + foreach my $p (@$links) { + return 1 if lc $p eq $link; } + return 0; +} #}}} - foreach my $glob (@globlist) { - return 1 if glob_match($page, $glob); +sub match_backlink ($$) { #{{{ + match_link(pop, pop); +} #}}} + +sub match_created_before ($$) { #{{{ + my $page=shift; + my $testpage=shift; + + if (exists $pagectime{$testpage}) { + return $pagectime{$page} < $pagectime{$testpage}; + } + else { + return 0; } - - return 0; } #}}} -sub register_plugin ($$$) { # {{{ - my $type=shift; - my $command=shift; - my $function=shift; - - $plugins{$type}{$command}=$function; -} # }}} +sub match_created_after ($$) { #{{{ + my $page=shift; + my $testpage=shift; + + if (exists $pagectime{$testpage}) { + return $pagectime{$page} > $pagectime{$testpage}; + } + else { + return 0; + } +} #}}} + +sub match_creation_day ($$) { #{{{ + return ((gmtime($pagectime{shift()}))[3] == shift); +} #}}} + +sub match_creation_month ($$) { #{{{ + return ((gmtime($pagectime{shift()}))[4] + 1 == shift); +} #}}} + +sub match_creation_year ($$) { #{{{ + return ((gmtime($pagectime{shift()}))[5] + 1900 == shift); +} #}}} 1