X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d5566303d6b416fb4b0f49a4a7eae2c81bddf17e..07e68136bbc3d71c7c50b9526e13add37d8c7aee:/ikiwiki diff --git a/ikiwiki b/ikiwiki index cb8295cf9..3540f8667 100755 --- a/ikiwiki +++ b/ikiwiki @@ -1,57 +1,145 @@ #!/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. -$ENV{PATH}="/usr/local/bin:/usr/bin:/bin"; - -BEGIN { - $blosxom::version="is a proper perl module too much to ask?"; - do "/usr/bin/markdown"; -} - -my ($srcdir, $destdir, %links, %oldlinks, %oldpagemtime, %renderedfiles, - %pagesources); -my $link=qr/\[\[([^\s]+)\]\]/; -my $verbose=0; -my $wikiname="wiki"; +use vars qw{%config %links %oldlinks %oldpagemtime %renderedfiles %pagesources}; -sub usage { +sub usage () { #{{{ die "usage: ikiwiki [options] source dest\n"; -} - -sub error ($) { - die @_; -} - -sub debug ($) { - print "@_\n" if $verbose; -} +} #}}} + +sub getconfig () { #{{{ + if (! exists $ENV{WRAPPED_OPTIONS}) { + %config=( + wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$)}, + wiki_link_regexp => qr/\[\[([^\s\]]+)\]\]/, + wiki_file_regexp => qr/(^[-A-Za-z0-9_.\&;:\/+]+$)/, + verbose => 0, + wikiname => "wiki", + default_pageext => ".mdwn", + cgi => 0, + svn => 1, + url => '', + cgiurl => '', + historyurl => '', + diffurl => '', + anonok => 0, + rebuild => 0, + wrapper => undef, + wrappermode => undef, + srcdir => undef, + destdir => undef, + templatedir => "/usr/share/ikiwiki/templates", + setup => undef, + adminuser => undef, + ); + + eval q{use Getopt::Long}; + GetOptions( + "setup|s=s" => \$config{setup}, + "wikiname=s" => \$config{wikiname}, + "verbose|v!" => \$config{verbose}, + "rebuild!" => \$config{rebuild}, + "wrappermode=i" => \$config{wrappermode}, + "svn!" => \$config{svn}, + "anonok!" => \$config{anonok}, + "cgi!" => \$config{cgi}, + "url=s" => \$config{url}, + "cgiurl=s" => \$config{cgiurl}, + "historyurl=s" => \$config{historyurl}, + "diffurl=s" => \$config{diffurl}, + "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]) + }, + "wrapper:s" => sub { + $config{wrapper}=$_[1] ? $_[1] : "ikiwiki-wrap" + }, + ) || usage(); + + 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"); + } + + $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 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 { +sub basename ($) { #{{{ my $file=shift; $file=~s!.*/!!; return $file; -} +} #}}} -sub dirname { +sub dirname ($) { #{{{ my $file=shift; $file=~s!/?[^/]+$!!; return $file; -} +} #}}} -sub pagetype ($) { +sub pagetype ($) { #{{{ my $page=shift; if ($page =~ /\.mdwn$/) { @@ -60,38 +148,46 @@ 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 readfile ($) { #{{{ + my $file=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: $!"); + my $ret=; + close IN; return $ret; -} +} #}}} -sub writepage ($$) { - my $page=shift; +sub writefile ($$) { #{{{ + my $file=shift; my $content=shift; + + if (-l $file) { + error("cannot write to a symlink ($file)"); + } - my $dir=dirname("$destdir/$page"); + my $dir=dirname($file); if (! -d $dir) { my $d=""; foreach my $s (split(m!/+!, $dir)) { @@ -102,26 +198,17 @@ 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, ">$file") || error("failed to write $file: $!"); + 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); @@ -139,21 +226,38 @@ sub bestlink ($$) { #print STDERR "warning: page $page, broken link: $link\n"; return ""; -} +} #}}} -sub isinlinableimage ($) { +sub isinlinableimage ($) { #{{{ my $file=shift; $file=~/\.(png|gif|jpg|jpeg)$/; -} +} #}}} -sub htmllink ($$) { +sub pagetitle ($) { #{{{ + my $page=shift; + $page=~s/__(\d+)__/&#$1;/g; + $page=~y/_/ /; + return $page; +} #}}} + +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 $bestlink=bestlink($page, $link); + my $bestlink; + if (! $forcesubpage) { + $bestlink=bestlink($page, $link); + } + else { + $bestlink="$page/".lc($link); + } - return $link if $page eq $bestlink; + my $linktext=pagetitle($link); + + 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! Note that this bug is @@ -163,125 +267,49 @@ sub htmllink ($$) { $bestlink=htmlpage($bestlink); } if (! grep { $_ eq $bestlink } values %renderedfiles) { - return "?$link" + return "?$linktext" } $bestlink=File::Spec->abs2rel($bestlink, dirname($page)); - if (isinlinableimage($bestlink)) { + if (! $noimageinline && isinlinableimage($bestlink)) { return ""; } - 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) { - next if bestlink($page, $p) eq $page; - if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) { - my $href=File::Spec->abs2rel(htmlpage($p), dirname($page)); - - # Trim common dir prefixes from both pages. - my $p_trimmed=$p; - my $page_trimmed=$page; - my $dir; - 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) && - defined $dir && - $p_trimmed=~s/^\Q$dir\E// && - $page_trimmed=~s/^\Q$dir\E//; - - push @links, "$p_trimmed"; + 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; - - my $title=basename($page); - $title=~s/_/ /g; - - my $pagelink=""; - my $path=""; - foreach my $dir (reverse split("/", $page)) { - if (length($pagelink)) { - $pagelink="$dir/ $pagelink"; - } - else { - $pagelink=$dir; - } - $path.="../"; - } - $path=~s/\.\.\/$/index.html/; - $pagelink="$wikiname/ $pagelink"; - - $content="\n$title\n\n". - "

$pagelink

\n". - $content. - "\n\n"; - - return $content; -} - -sub render ($) { - my $file=shift; - - 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; - } -} - -sub loadindex () { - open (IN, "$srcdir/.index") || return; +sub loadindex () { #{{{ + open (IN, "$config{wikistatedir}/index") || return; while () { - ($_)=/(.*)/; # untaint + $_=possibly_foolish_untaint($_); chomp; my ($mtime, $file, $rendered, @links)=split(' ', $_); my $page=pagename($file); @@ -292,221 +320,147 @@ sub loadindex () { $renderedfiles{$page}=$rendered; } close IN; -} +} #}}} -sub saveindex () { - open (OUT, ">$srcdir/.index") || error("cannot write to .index: $!"); +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) { - print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ". - join(" ", @{$links{$page}})."\n" - if $oldpagemtime{$page}; + print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ". + join(" ", @{$links{$page}})."\n" + if $oldpagemtime{$page}; } close OUT; -} - -sub prune ($) { - my $file=shift; - - 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 misctemplate ($$) { #{{{ + my $title=shift; + my $pagebody=shift; - # 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; - } + my $template=HTML::Template->new( + filename => "$config{templatedir}/misc.tmpl" + ); + $template->param( + title => $title, + indexlink => indexlink(), + wikiname => $config{wikiname}, + pagebody => $pagebody, + ); + return $template->output; +}#}}} + +sub userinfo_get ($$) { #{{{ + my $user=shift; + my $field=shift; + + eval q{use Storable}; + my $userdata=eval{ Storable::lock_retrieve("$config{wikistatedir}/userdb") }; + if (! defined $userdata || ! ref $userdata || + ! exists $userdata->{$user} || ! ref $userdata->{$user} || + ! exists $userdata->{$user}->{$field}) { + return ""; } + return $userdata->{$user}->{$field}; +} #}}} + +sub userinfo_set ($$$) { #{{{ + my $user=shift; + my $field=shift; + my $value=shift; - # 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 changed 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; - } - } - } - } + eval q{use Storable}; + my $userdata=eval{ Storable::lock_retrieve("$config{wikistatedir}/userdb") }; + if (! defined $userdata || ! ref $userdata || + ! exists $userdata->{$user} || ! ref $userdata->{$user}) { + return ""; } + + $userdata->{$user}->{$field}=$value; + my $oldmask=umask(077); + my $ret=Storable::lock_store($userdata, "$config{wikistatedir}/userdb"); + umask($oldmask); + return $ret; +} #}}} - # 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); - } - } +sub userinfo_setall ($$) { #{{{ + my $user=shift; + my $info=shift; + + eval q{use Storable}; + my $userdata=eval{ Storable::lock_retrieve("$config{wikistatedir}/userdb") }; + if (! defined $userdata || ! ref $userdata) { + $userdata={}; } -} + $userdata->{$user}=$info; + my $oldmask=umask(077); + my $ret=Storable::lock_store($userdata, "$config{wikistatedir}/userdb"); + umask($oldmask); + return $ret; +} #}}} + +sub is_admin ($) { #{{{ + my $user_name=shift; + + return grep { $_ eq $user_name } @{$config{adminuser}}; +} #}}} -# Generates a C wrapper program for running ikiwiki in a specific way. -# The wrapper may be safely made suid. -sub gen_wrapper ($$) { - my ($offline, $rebuild)=@_; +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; +} #}}} + +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); + } - eval {use Cwd 'abs_path'}; - $srcdir=abs_path($srcdir); - $destdir=abs_path($destdir); - my $this=abs_path($0); - if (! -x $this) { - error("$this doesn't seem to be executable"); + foreach my $glob (@globlist) { + return 1 if glob_match($page, $glob); } - my $call=qq{"$this", "$this", "$srcdir", "$destdir", "--wikiname=$wikiname"}; - $call.=', "--verbose"' if $verbose; - $call.=', "--rebuild"' if $rebuild; - $call.=', "--offline"' if $offline; + return 0; +} #}}} + +sub main () { #{{{ + getconfig(); - open(OUT, ">ikiwiki-wrap.c") || error("failed to write ikiwiki-wrap.c: $!");; - print OUT <<"EOF"; -/* A suid wraper for ikiwiki */ -#include -#include -#include - -int main (void) { - clearenv(); - execl($call, NULL); - perror("failed to run $this"); - exit(1); -} -EOF - close OUT; - if (system("gcc", "ikiwiki-wrap.c", "-o", "ikiwiki-wrap") != 0) { - error("failed to compile ikiwiki-wrap.c"); - } - unlink("ikiwiki-wrap.c"); - print "successfully generated ikiwiki-wrap\n"; - exit 0; -} - -sub update () { - if (-d "$srcdir/.svn") { - if (system("svn", "update", "--quiet", $srcdir) != 0) { - warn("svn update failed\n"); - } + if ($config{setup}) { + require IkiWiki::Setup; + setup(); + } + elsif ($config{wrapper}) { + lockwiki(); + require IkiWiki::Wrapper; + gen_wrapper(); + } + elsif ($config{cgi}) { + lockwiki(); + require IkiWiki::CGI; + cgi(); } -} - -my $rebuild=0; -my $offline=0; -my $gen_wrapper=0; -if (grep /^-/, @ARGV) { - eval {use Getopt::Long}; - GetOptions( - "wikiname=s" => \$wikiname, - "verbose|v" => \$verbose, - "rebuild" => \$rebuild, - "gen-wrapper" => \$gen_wrapper, - "offline" => \$offline, - ) || usage(); -} -usage() unless @ARGV == 2; -($srcdir) = shift =~ /(.*)/; # untaint -($destdir) = shift =~ /(.*)/; # untaint - -gen_wrapper($offline, $rebuild) if $gen_wrapper; -memoize('pagename'); -memoize('bestlink'); -update() unless $offline; -loadindex() unless $rebuild; -refresh(); -saveindex(); + else { + lockwiki(); + loadindex() unless $config{rebuild}; + require IkiWiki::Render; + rcs_update(); + refresh(); + saveindex(); + } +} #}}} + +main;