X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/3b0fce93e40e5457b63ceda9692901539eb4fc82..584c998753ee44b489c85251e41922109bc61aaf:/IkiWiki.pm diff --git a/IkiWiki.pm b/IkiWiki.pm index 31228883f..4964f97a1 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -3,33 +3,82 @@ package IkiWiki; use warnings; use strict; -use File::Spec; -use HTML::Template; +use Encode; +use open qw{:utf8 :std}; -use vars qw{%config %links %oldlinks %oldpagemtime %pagectime - %renderedfiles %pagesources %depends %plugins}; +# Optimisation. +use Memoize; +memoize("abs2rel"); +use vars qw{%config %links %oldlinks %oldpagemtime %pagectime + %renderedfiles %pagesources %depends %hooks}; + +sub defaultconfig () { #{{{ + wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.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', +} #}}} + sub checkconfig () { #{{{ + 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; } foreach my $plugin (@{$config{plugin}}) { @@ -39,6 +88,12 @@ sub checkconfig () { #{{{ error("Failed to load plugin $mod: $@"); } } + + if (exists $hooks{checkconfig}) { + foreach my $id (keys %{$hooks{checkconfig}}) { + $hooks{checkconfig}{$id}{call}->(); + } + } } #}}} sub error ($) { #{{{ @@ -82,12 +137,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 +148,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 +176,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 +208,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 +274,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 +297,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 +309,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\""; @@ -339,13 +405,26 @@ sub saveindex () { #{{{ 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(), @@ -361,13 +440,27 @@ sub glob_match ($$) { #{{{ my $page=shift; my $glob=shift; - # turn glob into safe regexp - $glob=quotemeta($glob); - $glob=~s/\\\*/.*/g; - $glob=~s/\\\?/./g; - $glob=~s!\\/!/!g; - - $page=~/^$glob$/i; + if ($glob =~ /^link\((.+)\)$/) { + my $rev = $links{$page} or return undef; + foreach my $p (@$rev) { + return 1 if lc $p eq $1; + } + return 0; + } elsif ($glob =~ /^backlink\((.+)\)$/) { + my $rev = $links{$1} or return undef; + foreach my $p (@$rev) { + return 1 if lc $p eq $page; + } + return 0; + } else { + # turn glob into safe regexp + $glob=quotemeta($glob); + $glob=~s/\\\*/.*/g; + $glob=~s/\\\?/./g; + $glob=~s!\\/!/!g; + + return $page=~/^$glob$/i; + } } #}}} sub globlist_match ($$) { #{{{ @@ -386,12 +479,14 @@ sub globlist_match ($$) { #{{{ return 0; } #}}} -sub register_plugin ($$$) { # {{{ - my $type=shift; - my $command=shift; - my $function=shift; +sub hook (@) { # {{{ + my %param=@_; + + if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) { + error "hook requires type, call, and id parameters"; + } - $plugins{$type}{$command}=$function; + $hooks{$param{type}}{$param{id}}=\%param; } # }}} 1