X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/aa0afc56cb17934c4c62f179327489ae505549e9..3ea8c882f296dcf66163b0c9b58254a2b93e06ae:/ikiwiki?ds=sidebyside diff --git a/ikiwiki b/ikiwiki index 2808ccc78..8367e9118 100755 --- a/ikiwiki +++ b/ikiwiki @@ -1,74 +1,187 @@ #!/usr/bin/perl -T +$ENV{PATH}="/usr/local/bin:/usr/bin:/bin"; +package IkiWiki; use warnings; use strict; -use File::Find; -use Memoize; use File::Spec; +use HTML::Template; +use lib '.'; # For use without installation, removed by Makefile. -BEGIN { - $blosxom::version="is a proper perl module too much to ask?"; - do "/usr/bin/markdown"; -} +use vars qw{%config %links %oldlinks %oldpagemtime %pagectime + %renderedfiles %pagesources %depends %plugins}; -memoize('pagename'); -memoize('bestlink'); - -sub usage { +sub usage () { #{{{ die "usage: ikiwiki [options] source dest\n"; -} - -my $link=qr/\[\[([^\s]+)\]\]/; -my $verbose=0; -my $rebuild=0; -my $wikiname="wiki"; -if (grep /^-/, @ARGV) { - eval {use Getopt::Long}; - GetOptions( - "wikiname=s" => \$wikiname, - "verbose|v" => \$verbose, - "rebuild" => \$rebuild, - ) || usage(); -} -usage() unless @ARGV == 2; -my ($srcdir) = shift =~ /(.*)/; # untaint -my ($destdir) = shift =~ /(.*)/; # untaint - -my %links; -my %oldlinks; -my %oldpagemtime; -my %renderedfiles; -my %pagesources; - -sub error ($) { - die @_; -} +} #}}} + +sub getconfig () { #{{{ + if (! exists $ENV{WRAPPED_OPTIONS}) { + %config=( + wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)}, + wiki_link_regexp => qr/\[\[(?:([^\s\]\|]+)\|)?([^\s\]]+)\]\]/, + wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/, + wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/, + verbose => 0, + wikiname => "wiki", + default_pageext => ".mdwn", + cgi => 0, + svn => 1, + notify => 0, + url => '', + cgiurl => '', + historyurl => '', + diffurl => '', + anonok => 0, + rss => 0, + sanitize => 1, + rebuild => 0, + refresh => 0, + getctime => 0, + hyperestraier => 0, + wrapper => undef, + wrappermode => undef, + svnrepo => undef, + svnpath => "trunk", + srcdir => undef, + destdir => undef, + templatedir => "/usr/share/ikiwiki/templates", + underlaydir => "/usr/share/ikiwiki/basewiki", + setup => undef, + adminuser => undef, + adminemail => undef, + plugin => [qw{inline}], + ); + + eval q{use Getopt::Long}; + GetOptions( + "setup|s=s" => \$config{setup}, + "wikiname=s" => \$config{wikiname}, + "verbose|v!" => \$config{verbose}, + "rebuild!" => \$config{rebuild}, + "refresh!" => \$config{refresh}, + "getctime" => \$config{getctime}, + "wrappermode=i" => \$config{wrappermode}, + "svn!" => \$config{svn}, + "anonok!" => \$config{anonok}, + "hyperestraier" => \$config{hyperestraier}, + "rss!" => \$config{rss}, + "cgi!" => \$config{cgi}, + "notify!" => \$config{notify}, + "sanitize!" => \$config{sanitize}, + "url=s" => \$config{url}, + "cgiurl=s" => \$config{cgiurl}, + "historyurl=s" => \$config{historyurl}, + "diffurl=s" => \$config{diffurl}, + "svnrepo" => \$config{svnrepo}, + "svnpath" => \$config{svnpath}, + "adminemail=s" => \$config{adminemail}, + "exclude=s@" => sub { + $config{wiki_file_prune_regexp}=qr/$config{wiki_file_prune_regexp}|$_[1]/; + }, + "adminuser=s@" => sub { + push @{$config{adminuser}}, $_[1] + }, + "templatedir=s" => sub { + $config{templatedir}=possibly_foolish_untaint($_[1]) + }, + "underlaydir=s" => sub { + $config{underlaydir}=possibly_foolish_untaint($_[1]) + }, + "wrapper:s" => sub { + $config{wrapper}=$_[1] ? $_[1] : "ikiwiki-wrap" + }, + "plugin=s@" => sub { + push @{$config{plugin}}, $_[1]; + } + ) || usage(); -sub debug ($) { - print "@_\n" if $verbose; -} + if (! $config{setup}) { + usage() unless @ARGV == 2; + $config{srcdir} = possibly_foolish_untaint(shift @ARGV); + $config{destdir} = possibly_foolish_untaint(shift @ARGV); + checkconfig(); + } + } + else { + # wrapper passes a full config structure in the environment + # variable + eval possibly_foolish_untaint($ENV{WRAPPED_OPTIONS}); + checkconfig(); + } +} #}}} -sub mtime ($) { - my $page=shift; +sub checkconfig () { #{{{ + 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}; - return (stat($page))[9]; -} + if ($config{svn}) { + require IkiWiki::Rcs::SVN; + $config{rcs}=1; + } + else { + require IkiWiki::Rcs::Stub; + $config{rcs}=0; + } -sub basename { + foreach my $plugin (@{$config{plugin}}) { + my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin); + eval qq{use $mod}; + if ($@) { + error("Failed to load plugin $mod: $@"); + } + } +} #}}} + +sub error ($) { #{{{ + if ($config{cgi}) { + print "Content-type: text/html\n\n"; + print misctemplate("Error", "

Error: @_

"); + } + die @_; +} #}}} + +sub possibly_foolish_untaint ($) { #{{{ + my $tainted=shift; + my ($untainted)=$tainted=~/(.*)/; + return $untainted; +} #}}} + +sub debug ($) { #{{{ + return unless $config{verbose}; + if (! $config{cgi}) { + print "@_\n"; + } + else { + print STDERR "@_\n"; + } +} #}}} + +sub basename ($) { #{{{ my $file=shift; - $file=~s!.*/!!; + $file=~s!.*/+!!; return $file; -} +} #}}} -sub dirname { +sub dirname ($) { #{{{ my $file=shift; - $file=~s!/?[^/]+$!!; + $file=~s!/*[^/]+$!!; return $file; -} +} #}}} -sub pagetype ($) { +sub pagetype ($) { #{{{ my $page=shift; if ($page =~ /\.mdwn$/) { @@ -77,38 +190,62 @@ sub pagetype ($) { else { return "unknown"; } -} +} #}}} -sub pagename ($) { +sub pagename ($) { #{{{ my $file=shift; my $type=pagetype($file); my $page=$file; $page=~s/\Q$type\E*$// unless $type eq 'unknown'; return $page; -} +} #}}} -sub htmlpage ($) { +sub htmlpage ($) { #{{{ my $page=shift; return $page.".html"; -} +} #}}} -sub readpage ($) { - my $page=shift; +sub srcfile ($) { #{{{ + my $file=shift; + 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"); +} #}}} + +sub readfile ($;$) { #{{{ + my $file=shift; + my $binary=shift; + + if (-l $file) { + error("cannot read a symlink ($file)"); + } + local $/=undef; - open (PAGE, "$srcdir/$page") || error("failed to read $page: $!"); - my $ret=; - close PAGE; + open (IN, $file) || error("failed to read $file: $!"); + binmode(IN) if $binary; + my $ret=; + close IN; return $ret; -} +} #}}} -sub writepage ($$) { - my $page=shift; +sub writefile ($$$;$) { #{{{ + my $file=shift; # can include subdirs + my $destdir=shift; # directory to put file in my $content=shift; + my $binary=shift; + + my $test=$file; + while (length $test) { + if (-l "$destdir/$test") { + error("cannot write to a symlink ($test)"); + } + $test=dirname($test); + } - my $dir=dirname("$destdir/$page"); + my $dir=dirname("$destdir/$file"); if (! -d $dir) { my $d=""; foreach my $s (split(m!/+!, $dir)) { @@ -119,26 +256,18 @@ sub writepage ($$) { } } - open (PAGE, ">$destdir/$page") || error("failed to write $page: $!"); - print PAGE $content; - close PAGE; -} - -sub findlinks { - my $content=shift; - - my @links; - while ($content =~ /$link/g) { - push @links, lc($1); - } - return @links; -} - -# Given a page and the text of a link on the page, determine which existing -# page that link best points to. Prefers pages under a subdirectory with -# the same name as the source page, failing that goes down the directory tree -# to the base looking for matching pages. -sub bestlink ($$) { + open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!"); + binmode(OUT) if $binary; + print OUT $content; + close OUT; +} #}}} + +sub bestlink ($$) { #{{{ + # Given a page and the text of a link on the page, determine which + # existing page that link best points to. Prefers pages under a + # subdirectory with the same name as the source page, failing that + # goes down the directory tree to the base looking for matching + # pages. my $page=shift; my $link=lc(shift); @@ -154,296 +283,247 @@ sub bestlink ($$) { } } while $cwd=~s!/?[^/]+$!!; - print STDERR "warning: page $page, broken link: $link\n"; + #print STDERR "warning: page $page, broken link: $link\n"; return ""; -} +} #}}} -sub isinlinableimage ($) { +sub isinlinableimage ($) { #{{{ my $file=shift; - $file=~/\.(png|gif|jpg|jpeg)$/; -} + $file=~/\.(png|gif|jpg|jpeg)$/i; +} #}}} + +sub pagetitle ($) { #{{{ + my $page=shift; + $page=~s/__(\d+)__/&#$1;/g; + $page=~y/_/ /; + return $page; +} #}}} + +sub titlepage ($) { #{{{ + my $title=shift; + $title=~y/ /_/; + $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg; + return $title; +} #}}} + +sub cgiurl (@) { #{{{ + my %params=@_; + + return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params); +} #}}} + +sub styleurl (;$) { #{{{ + my $page=shift; + + return "$config{url}/style.css" if ! defined $page; + + $page=~s/[^\/]+$//; + $page=~s/[^\/]+\//..\//g; + return $page."style.css"; +} #}}} -sub htmllink ($$) { +sub htmllink ($$;$$$) { #{{{ my $page=shift; 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 $bestlink=bestlink($page, $link); + my $bestlink; + if (! $forcesubpage) { + $bestlink=bestlink($page, $link); + } + else { + $bestlink="$page/".lc($link); + } - return $link if $page eq $bestlink; + $linktext=pagetitle(basename($link)) unless defined $linktext; + + return $linktext if length $bestlink && $page eq $bestlink; # TODO BUG: %renderedfiles may not have it, if the linked to page - # was also added and isn't yet rendered! + # 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. if (! grep { $_ eq $bestlink } values %renderedfiles) { $bestlink=htmlpage($bestlink); } if (! grep { $_ eq $bestlink } values %renderedfiles) { - return "?$link" + return " "create", page => $link, from =>$page). + "\">?$linktext" } $bestlink=File::Spec->abs2rel($bestlink, dirname($page)); - if (isinlinableimage($bestlink)) { - return ""; + if (! $noimageinline && isinlinableimage($bestlink)) { + return "\"$linktext\""; } - return "$link"; -} - -sub linkify ($$) { - my $content=shift; - my $file=shift; - - $content =~ s/$link/htmllink(pagename($file), $1)/eg; - - return $content; -} - -sub htmlize ($$) { - my $type=shift; - my $content=shift; - - if ($type eq '.mdwn') { - return Markdown::Markdown($content); + return "$linktext"; +} #}}} + +sub indexlink () { #{{{ + return "$config{wikiname}"; +} #}}} + +sub lockwiki () { #{{{ + # 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}) { + mkdir($config{wikistatedir}); } - else { - error("htmlization of $type not supported"); - } -} - -sub linkbacks ($$) { - my $content=shift; - my $page=shift; - - my @links; - foreach my $p (keys %links) { - if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) { - my $href=File::Spec->abs2rel(htmlpage($p), dirname($page)); - # TODO: if $p is joey/foo/bar and - # the $page is joey/foo/baz, make the link text - # just be "bar". - push @links, "$p"; + open(WIKILOCK, ">$config{wikistatedir}/lockfile") || + error ("cannot write to $config{wikistatedir}/lockfile: $!"); + if (! flock(WIKILOCK, 2 | 4)) { + 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) { + 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?)"); } +} #}}} - $content.="

Links: ".join(" ", sort @links)."

\n" if @links; - return $content; -} +sub unlockwiki () { #{{{ + close WIKILOCK; +} #}}} -sub finalize ($$) { - my $content=shift; - my $page=shift; +sub loadindex () { #{{{ + open (IN, "$config{wikistatedir}/index") || return; + while () { + $_=possibly_foolish_untaint($_); + chomp; + my %items; + $items{link}=[]; + foreach my $i (split(/ /, $_)) { + my ($item, $val)=split(/=/, $i, 2); + push @{$items{$item}}, $val; + } - my $title=basename($page); - $title=~s/_/ /g; - - my $pagelink=""; - my $path=""; - foreach my $dir (reverse split("/", $page)) { - if (length($pagelink)) { - $pagelink="$dir/ $pagelink"; + next unless exists $items{src}; # skip bad lines for now + + my $page=pagename($items{src}[0]); + if (! $config{rebuild}) { + $pagesources{$page}=$items{src}[0]; + $oldpagemtime{$page}=$items{mtime}[0]; + $oldlinks{$page}=[@{$items{link}}]; + $links{$page}=[@{$items{link}}]; + $depends{$page}=join(" ", @{$items{depends}}) + if exists $items{depends}; + $renderedfiles{$page}=$items{dest}[0]; } - else { - $pagelink=$dir; + $pagectime{$page}=$items{ctime}[0]; + } + close IN; +} #}}} + +sub saveindex () { #{{{ + if (! -d $config{wikistatedir}) { + mkdir($config{wikistatedir}); + } + open (OUT, ">$config{wikistatedir}/index") || + error("cannot write to $config{wikistatedir}/index: $!"); + foreach my $page (keys %oldpagemtime) { + next unless $oldpagemtime{$page}; + my $line="mtime=$oldpagemtime{$page} ". + "ctime=$pagectime{$page} ". + "src=$pagesources{$page} ". + "dest=$renderedfiles{$page}"; + $line.=" link=$_" foreach @{$links{$page}}; + if (exists $depends{$page}) { + $line.=" depends=$_" foreach split " ", $depends{$page}; } - $path.="../"; + print OUT $line."\n"; } - $path=~s/\.\.\/$/index.html/; - $pagelink="$wikiname/ $pagelink"; - - $content="\n$title\n\n". - "

$pagelink

\n". - $content. - "\n\n"; + close OUT; +} #}}} + +sub misctemplate ($$) { #{{{ + my $title=shift; + my $pagebody=shift; - return $content; -} + my $template=HTML::Template->new( + filename => "$config{templatedir}/misc.tmpl" + ); + $template->param( + title => $title, + indexlink => indexlink(), + wikiname => $config{wikiname}, + pagebody => $pagebody, + styleurl => styleurl(), + baseurl => "$config{url}/", + ); + return $template->output; +}#}}} + +sub glob_match ($$) { #{{{ + my $page=shift; + my $glob=shift; -sub render ($) { - my $file=shift; + # turn glob into safe regexp + $glob=quotemeta($glob); + $glob=~s/\\\*/.*/g; + $glob=~s/\\\?/./g; + $glob=~s!\\/!/!g; - my $type=pagetype($file); - my $content=readpage($file); - if ($type ne 'unknown') { - my $page=pagename($file); - - $links{$page}=[findlinks($content)]; - - $content=linkify($content, $file); - $content=htmlize($type, $content); - $content=linkbacks($content, $page); - $content=finalize($content, $page); - - writepage(htmlpage($page), $content); - $oldpagemtime{$page}=time; - $renderedfiles{$page}=htmlpage($page); - } - else { - $links{$file}=[]; - writepage($file, $content); - $oldpagemtime{$file}=time; - $renderedfiles{$file}=$file; - } -} + $page=~/^$glob$/i; +} #}}} -sub loadindex () { - open (IN, "$srcdir/.index") || return; - while () { - ($_)=/(.*)/; # untaint - chomp; - my ($mtime, $file, $rendered, @links)=split(' ', $_); - my $page=pagename($file); - $pagesources{$page}=$file; - $oldpagemtime{$page}=$mtime; - $oldlinks{$page}=[@links]; - $links{$page}=[@links]; - $renderedfiles{$page}=$rendered; +sub globlist_match ($$) { #{{{ + my $page=shift; + my @globlist=split(" ", shift); + + # check any negated globs first + foreach my $glob (@globlist) { + return 0 if $glob=~/^!(.*)/ && glob_match($page, $1); } - close IN; -} -sub saveindex () { - open (OUT, ">$srcdir/.index") || error("cannot write to .index: $!"); - foreach my $page (keys %oldpagemtime) { - print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ". - join(" ", @{$links{$page}})."\n" - if $oldpagemtime{$page}; + foreach my $glob (@globlist) { + return 1 if glob_match($page, $glob); } - close OUT; -} + + return 0; +} #}}} -sub prune ($) { - my $file=shift; +sub register_plugin ($$$) { # {{{ + my $type=shift; + my $command=shift; + my $function=shift; + + $plugins{$type}{$command}=$function; +} # }}} - unlink($file); - my $dir=dirname($file); - while (rmdir($dir)) { - $dir=dirname($dir); - } -} - -sub refresh () { - # Find existing pages. - my %exists; - my @files; - find({ - no_chdir => 1, - wanted => sub { - if (/\/\.svn\//) { - $File::Find::prune=1; - } - elsif (! -d $_ && ! /\.html$/ && ! /\/\./) { - my ($f)=/(^[-A-Za-z0-9_.:\/+]+$)/; # untaint - if (! defined $f) { - warn("skipping bad filename $_\n"); - } - else { - $f=~s/^\Q$srcdir\E\/?//; - push @files, $f; - $exists{pagename($f)}=1; - } - } - }, - }, $srcdir); - - my %rendered; - - # check for added or removed pages - my @add; - foreach my $file (@files) { - my $page=pagename($file); - if (! $oldpagemtime{$page}) { - debug("new page $page"); - push @add, $file; - $links{$page}=[]; - $pagesources{$page}=$file; - } - } - my @del; - foreach my $page (keys %oldpagemtime) { - if (! $exists{$page}) { - debug("removing old page $page"); - push @del, $renderedfiles{$page}; - prune($destdir."/".$renderedfiles{$page}); - delete $renderedfiles{$page}; - $oldpagemtime{$page}=0; - delete $pagesources{$page}; - } - } +sub main () { #{{{ + getconfig(); - # render any updated files - foreach my $file (@files) { - my $page=pagename($file); - - if (! exists $oldpagemtime{$page} || - mtime("$srcdir/$file") > $oldpagemtime{$page}) { - debug("rendering changed file $file"); - render($file); - $rendered{$file}=1; - } + if ($config{cgi}) { + lockwiki(); + loadindex(); + require IkiWiki::CGI; + cgi(); } - - # if any files were added or removed, check to see if each page - # needs an update due to linking to them - # TODO: inefficient; pages may get rendered above and again here; - # problem is the bestlink may have changes and we won't know until - # now - if (@add || @del) { -FILE: foreach my $file (@files) { - my $page=pagename($file); - foreach my $f (@add, @del) { - my $p=pagename($f); - foreach my $link (@{$links{$page}}) { - if (bestlink($page, $link) eq $p) { - debug("rendering $file, which links to $p"); - render($file); - $rendered{$file}=1; - next FILE; - } - } - } - } + elsif ($config{setup}) { + require IkiWiki::Setup; + setup(); } - - # handle linkbacks; if a page has added/removed links, update the - # pages it links to - # TODO: inefficient; pages may get rendered above and again here; - # problem is the linkbacks could be wrong in the first pass render - # above. - if (%rendered) { - my %linkchanged; - foreach my $file (keys %rendered, @del) { - my $page=pagename($file); - if (exists $links{$page}) { - foreach my $link (@{$links{$page}}) { - $link=bestlink($page, $link); - if (length $link && - ! exists $oldlinks{$page} || - ! grep { $_ eq $link } @{$oldlinks{$page}}) { - $linkchanged{$link}=1; - } - } - } - if (exists $oldlinks{$page}) { - foreach my $link (@{$oldlinks{$page}}) { - $link=bestlink($page, $link); - if (length $link && - ! exists $links{$page} || - ! grep { $_ eq $link } @{$links{$page}}) { - $linkchanged{$link}=1; - } - } - } - } - foreach my $link (keys %linkchanged) { - my $linkfile=$pagesources{$link}; - if (defined $linkfile) { - debug("rendering $linkfile, to update its linkbacks"); - render($linkfile); - } - } + elsif ($config{wrapper}) { + lockwiki(); + require IkiWiki::Wrapper; + gen_wrapper(); + } + else { + lockwiki(); + loadindex(); + require IkiWiki::Render; + rcs_update(); + rcs_getctime() if $config{getctime}; + refresh(); + rcs_notify() if $config{notify}; + saveindex(); } -} +} #}}} -loadindex() unless $rebuild; -refresh(); -saveindex(); +main;