#!/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 %oldpagemtime;
-my %renderedfiles;
-
-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", "<p>Error: @_</p>");
+ }
+ 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$/) {
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=<PAGE>;
- close PAGE;
+ open (IN, $file) || error("failed to read $file: $!");
+ binmode(IN) if $binary;
+ my $ret=<IN>;
+ 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)) {
}
}
- 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);
}
} 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! 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 "<a href=\"?\">?</a>$link"
+ return "<span><a href=\"".
+ cgiurl(do => "create", page => $link, from =>$page).
+ "\">?</a>$linktext</span>"
}
$bestlink=File::Spec->abs2rel($bestlink, dirname($page));
- if (isinlinableimage($bestlink)) {
- return "<img src=\"$bestlink\">";
+ if (! $noimageinline && isinlinableimage($bestlink)) {
+ return "<img src=\"$bestlink\" alt=\"$linktext\" />";
}
- return "<a href=\"$bestlink\">$link</a>";
-}
-
-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);
- }
- else {
- error("htmlization of $type not supported");
+ return "<a href=\"$bestlink\">$linktext</a>";
+} #}}}
+
+sub indexlink () { #{{{
+ return "<a href=\"$config{url}\">$config{wikiname}</a>";
+} #}}}
+
+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});
}
-}
-
-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="<a href=\"$path$dir.html\">$dir/</a> $pagelink";
- }
- else {
- $pagelink=$dir;
+ 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;
}
- $path.="../";
+ error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
}
- $path=~s/\.\.\/$/index.html/;
- $pagelink="<a href=\"$path\">$wikiname/</a> $pagelink";
-
- $content="<html>\n<head><title>$title</title></head>\n<body>\n".
- "<h1>$pagelink</h1>\n".
- $content.
- "</body>\n</html>\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=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 unlockwiki () { #{{{
+ close WIKILOCK;
+} #}}}
-sub loadindex () {
- open (IN, "$srcdir/.index") || return;
+sub loadindex () { #{{{
+ open (IN, "$config{wikistatedir}/index") || return;
while (<IN>) {
+ $_=possibly_foolish_untaint($_);
chomp;
- my ($mtime, $page, $rendered, @links)=split(' ', $_);
- $oldpagemtime{$page}=$mtime;
- $links{$page}=\@links;
- ($renderedfiles{$page})=$rendered=~m/(.*)/; # untaint
+ my %items;
+ $items{link}=[];
+ foreach my $i (split(/ /, $_)) {
+ my ($item, $val)=split(/=/, $i, 2);
+ push @{$items{$item}}, $val;
+ }
+
+ 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];
+ }
+ $pagectime{$page}=$items{ctime}[0];
}
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} $page $renderedfiles{$page} ".
- join(" ", @{$links{$page}})."\n"
- if $oldpagemtime{$page};
+ 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};
+ }
+ print OUT $line."\n";
}
close OUT;
-}
+} #}}}
-sub prune ($) {
- my $file=shift;
+sub misctemplate ($$) { #{{{
+ my $title=shift;
+ my $pagebody=shift;
+
+ 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;
- 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);
-
- # check for added or removed pages
- my @adddel;
- foreach my $file (@files) {
- my $page=pagename($file);
- if (! $oldpagemtime{$page}) {
- debug("new page $page");
- push @adddel, $page;
- $links{$page}=[];
- }
+ # 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);
}
- foreach my $page (keys %oldpagemtime) {
- if (! $exists{$page}) {
- debug("removing old page $page");
- prune($destdir."/".$renderedfiles{$page});
- delete $renderedfiles{$page};
- $oldpagemtime{$page}=0;
- push @adddel, $page;
- }
+
+ foreach my $glob (@globlist) {
+ return 1 if glob_match($page, $glob);
}
- # 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);
- }
- elsif ($rebuild) {
- debug("rebuilding unchanged file $file");
- render($file);
- }
- }
+ return 0;
+} #}}}
+
+sub register_plugin ($$$) { # {{{
+ my $type=shift;
+ my $command=shift;
+ my $function=shift;
- # if any files were added or removed, check to see if each page
- # needs an update due to linking to them
- if (@adddel) {
-FILE: foreach my $file (@files) {
- my $page=pagename($file);
- foreach my $p (@adddel) {
- foreach my $link (@{$links{$page}}) {
- if (bestlink($page, $link) eq $p) {
- debug("rendering $file, which links to $p");
- render($file);
- next FILE;
- }
- }
- }
- }
+ $plugins{$type}{$command}=$function;
+} # }}}
+
+sub main () { #{{{
+ getconfig();
+
+ if ($config{cgi}) {
+ lockwiki();
+ loadindex();
+ require IkiWiki::CGI;
+ cgi();
+ }
+ elsif ($config{setup}) {
+ require IkiWiki::Setup;
+ setup();
+ }
+ 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();
-refresh();
-saveindex();
+main;
sipb-www / ikiwiki.git / blobdiff