#!/usr/bin/perl -T
+$ENV{PATH}="/usr/local/bin:/usr/bin:/bin";
use warnings;
use strict;
-use File::Find;
use Memoize;
use File::Spec;
+use HTML::Template;
+use Getopt::Long;
-$ENV{PATH}="/usr/local/bin:/usr/bin:/bin";
+my (%links, %oldlinks, %oldpagemtime, %renderedfiles, %pagesources);
-BEGIN {
- $blosxom::version="is a proper perl module too much to ask?";
- do "/usr/bin/markdown";
-}
+my %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 => '',
+ anonok => 0,
+ rebuild => 0,
+ wrapper => undef,
+ wrappermode => undef,
+ srcdir => undef,
+ destdir => undef,
+ templatedir => undef,
+ setup => undef,
+); #}}}
-my ($srcdir, $destdir, %links, %oldlinks, %oldpagemtime, %renderedfiles,
- %pagesources);
-my $wiki_link_regexp=qr/\[\[([^\s]+)\]\]/;
-my $wiki_file_regexp=qr/(^[-A-Za-z0-9_.:\/+]+$)/;
-my $wiki_file_prune_regexp=qr!((^|/).svn/|\.\.)!;
-my $verbose=0;
-my $wikiname="wiki";
-my $default_pagetype=".mdwn";
-my $cgi=0;
-my $url="";
-my $svn=1;
-
-sub usage {
- die "usage: ikiwiki [options] source dest\n";
+GetOptions( #{{{
+ "setup=s" => \$config{setup},
+ "wikiname=s" => \$config{wikiname},
+ "verbose|v!" => \$config{verbose},
+ "rebuild!" => \$config{rebuild},
+ "wrapper=s" => sub { $config{wrapper}=$_[1] ? $_[1] : "ikiwiki-wrap" },
+ "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},
+ "exclude=s@" => sub {
+ $config{wiki_file_prune_regexp}=qr/$config{wiki_file_prune_regexp}|$_[1]/;
+ },
+) || usage();
+
+if (! $config{setup}) {
+ usage() unless @ARGV == 3;
+ $config{srcdir} = possibly_foolish_untaint(shift);
+ $config{templatedir} = possibly_foolish_untaint(shift);
+ $config{destdir} = possibly_foolish_untaint(shift);
+ if ($config{cgi} && ! length $config{url}) {
+ error("Must specify url to wiki with --url when using --cgi");
+ }
}
+#}}}
+
+sub usage { #{{{
+ die "usage: ikiwiki [options] source templates dest\n";
+} #}}}
-sub error ($) {
- if ($cgi) {
+sub error { #{{{
+ if ($config{cgi}) {
print "Content-type: text/html\n\n";
- print "Error: @_\n";
- exit 1;
+ print misctemplate("Error", "<p>Error: @_</p>");
+ }
+ die @_;
+} #}}}
+
+sub debug ($) { #{{{
+ return unless $config{verbose};
+ if (! $config{cgi}) {
+ print "@_\n";
}
else {
- die @_;
+ print STDERR "@_\n";
}
-}
+} #}}}
-sub debug ($) {
- print "@_\n" if $verbose;
-}
-
-sub mtime ($) {
+sub mtime ($) { #{{{
my $page=shift;
return (stat($page))[9];
-}
+} #}}}
-sub possibly_foolish_untaint ($) {
+sub possibly_foolish_untaint { #{{{
my $tainted=shift;
my ($untainted)=$tainted=~/(.*)/;
return $untainted;
-}
+} #}}}
-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$/) {
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 readfile ($) {
+sub readfile ($) { #{{{
my $file=shift;
local $/=undef;
my $ret=<IN>;
close IN;
return $ret;
-}
+} #}}}
-sub writefile ($$) {
+sub writefile ($$) { #{{{
my $file=shift;
my $content=shift;
open (OUT, ">$file") || error("failed to write $file: $!");
print OUT $content;
close OUT;
-}
+} #}}}
-sub findlinks {
+sub findlinks ($$) { #{{{
my $content=shift;
+ my $page=shift;
my @links;
- while ($content =~ /$wiki_link_regexp/g) {
+ while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
push @links, lc($1);
}
- return @links;
-}
+ # Discussion links are a special case since they're not in the text
+ # of the page, but on its template.
+ return @links, "$page/discussion";
+} #}}}
-# 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 ($$) {
+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);
#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 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;
+ return $link 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
$bestlink=htmlpage($bestlink);
}
if (! grep { $_ eq $bestlink } values %renderedfiles) {
- return "<a href=\"?\">?</a>$link"
+ return "<a href=\"$config{cgiurl}?do=create&page=$link&from=$page\">?</a>$link"
}
$bestlink=File::Spec->abs2rel($bestlink, dirname($page));
- if (isinlinableimage($bestlink)) {
+ if (! $noimageinline && isinlinableimage($bestlink)) {
return "<img src=\"$bestlink\">";
}
return "<a href=\"$bestlink\">$link</a>";
-}
+} #}}}
-sub linkify ($$) {
+sub linkify ($$) { #{{{
my $content=shift;
my $file=shift;
- $content =~ s/$wiki_link_regexp/htmllink(pagename($file), $1)/eg;
+ $content =~ s{(\\?)$config{wiki_link_regexp}}{
+ $1 ? "[[$2]]" : htmllink(pagename($file), $2)
+ }eg;
return $content;
-}
+} #}}}
-sub htmlize ($$) {
+sub htmlize ($$) { #{{{
my $type=shift;
my $content=shift;
+ if (! $INC{"/usr/bin/markdown"}) {
+ no warnings 'once';
+ $blosxom::version="is a proper perl module too much to ask?";
+ use warnings 'all';
+ do "/usr/bin/markdown";
+ }
+
if ($type eq '.mdwn') {
return Markdown::Markdown($content);
}
else {
error("htmlization of $type not supported");
}
-}
+} #}}}
-sub linkbacks ($$) {
- my $content=shift;
+sub backlinks ($) { #{{{
my $page=shift;
my @links;
$p_trimmed=~s/^\Q$dir\E// &&
$page_trimmed=~s/^\Q$dir\E//;
- push @links, "<a href=\"$href\">$p_trimmed</a>";
+ push @links, { url => $href, page => $p_trimmed };
}
}
- $content.="<hr><p>Links: ".join(" ", sort @links)."</p>\n" if @links;
- return $content;
-}
-
-sub finalize ($$) {
- my $content=shift;
+ return sort { $a->{page} cmp $b->{page} } @links;
+} #}}}
+
+sub parentlinks ($) { #{{{
my $page=shift;
-
- my $title=basename($page);
- $title=~s/_/ /g;
+ my @ret;
my $pagelink="";
my $path="";
+ my $skip=1;
foreach my $dir (reverse split("/", $page)) {
- if (length($pagelink)) {
- $pagelink="<a href=\"$path$dir.html\">$dir</a>/ $pagelink";
+ if (! $skip) {
+ $path.="../";
+ unshift @ret, { url => "$path$dir.html", page => $dir };
}
else {
- $pagelink=$dir;
+ $skip=0;
+ }
+ }
+ unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
+ return @ret;
+} #}}}
+
+sub indexlink () { #{{{
+ return "<a href=\"$config{url}\">$config{wikiname}</a>";
+} #}}}
+
+sub finalize ($$) { #{{{
+ my $content=shift;
+ my $page=shift;
+
+ my $title=basename($page);
+ $title=~s/_/ /g;
+
+ my $template=HTML::Template->new(blind_cache => 1,
+ filename => "$config{templatedir}/page.tmpl");
+
+ if (length $config{cgiurl}) {
+ $template->param(editurl => "$config{cgiurl}?do=edit&page=$page");
+ if ($config{svn}) {
+ $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges");
}
- $path.="../";
}
- $path=~s/\.\.\/$/index.html/;
- $pagelink="<a href=\"$path\">$wikiname</a>/ $pagelink";
+
+ if (length $config{historyurl}) {
+ my $u=$config{historyurl};
+ $u=~s/\[\[\]\]/$pagesources{$page}/g;
+ $template->param(historyurl => $u);
+ }
- $content="<html>\n<head><title>$title</title></head>\n<body>\n".
- "<h1>$pagelink</h1>\n".
- $content.
- "</body>\n</html>\n";
+ $template->param(
+ title => $title,
+ wikiname => $config{wikiname},
+ parentlinks => [parentlinks($page)],
+ content => $content,
+ backlinks => [backlinks($page)],
+ discussionlink => htmllink($page, "Discussion", 1, 1),
+ );
- return $content;
-}
+ return $template->output;
+} #}}}
-sub render ($) {
+sub check_overwrite ($$) { #{{{
+ # Important security check. Make sure to call this before saving
+ # any files to the source directory.
+ my $dest=shift;
+ my $src=shift;
+
+ if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
+ error("$dest already exists and was rendered from ".
+ join(" ",(grep { $renderedfiles{$_} eq $dest } keys
+ %renderedfiles)).
+ ", before, so not rendering from $src");
+ }
+} #}}}
+
+sub render ($) { #{{{
my $file=shift;
my $type=pagetype($file);
- my $content=readfile("$srcdir/$file");
+ my $content=readfile("$config{srcdir}/$file");
if ($type ne 'unknown') {
my $page=pagename($file);
- $links{$page}=[findlinks($content)];
+ $links{$page}=[findlinks($content, $page)];
$content=linkify($content, $file);
$content=htmlize($type, $content);
- $content=linkbacks($content, $page);
$content=finalize($content, $page);
- writefile("$destdir/".htmlpage($page), $content);
+ check_overwrite("$config{destdir}/".htmlpage($page), $page);
+ writefile("$config{destdir}/".htmlpage($page), $content);
$oldpagemtime{$page}=time;
$renderedfiles{$page}=htmlpage($page);
}
else {
$links{$file}=[];
- writefile("$destdir/$file", $content);
+ check_overwrite("$config{destdir}/$file", $file);
+ writefile("$config{destdir}/$file", $content);
$oldpagemtime{$file}=time;
$renderedfiles{$file}=$file;
}
-}
+} #}}}
-sub loadindex () {
- open (IN, "$srcdir/.index") || return;
+sub loadindex () { #{{{
+ open (IN, "$config{srcdir}/.ikiwiki/index") || return;
while (<IN>) {
$_=possibly_foolish_untaint($_);
chomp;
$renderedfiles{$page}=$rendered;
}
close IN;
-}
+} #}}}
-sub saveindex () {
- open (OUT, ">$srcdir/.index") || error("cannot write to .index: $!");
+sub saveindex () { #{{{
+ if (! -d "$config{srcdir}/.ikiwiki") {
+ mkdir("$config{srcdir}/.ikiwiki");
+ }
+ open (OUT, ">$config{srcdir}/.ikiwiki/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};
+ print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ".
+ join(" ", @{$links{$page}})."\n"
+ if $oldpagemtime{$page};
}
close OUT;
-}
+} #}}}
-sub rcs_update () {
- if (-d "$srcdir/.svn") {
- if (system("svn", "update", "--quiet", $srcdir) != 0) {
+sub rcs_update () { #{{{
+ if (-d "$config{srcdir}/.svn") {
+ if (system("svn", "update", "--quiet", $config{srcdir}) != 0) {
warn("svn update failed\n");
}
}
-}
+} #}}}
-sub rcs_commit ($) {
+sub rcs_commit ($) { #{{{
my $message=shift;
- if (-d "$srcdir/.svn") {
+ if (-d "$config{srcdir}/.svn") {
if (system("svn", "commit", "--quiet", "-m",
- possibly_foolish_untaint($message), $srcdir) != 0) {
+ possibly_foolish_untaint($message),
+ $config{srcdir}) != 0) {
warn("svn commit failed\n");
}
}
-}
+} #}}}
-sub rcs_ad ($) {
+sub rcs_add ($) { #{{{
my $file=shift;
- if (-d "$srcdir/.svn") {
- if (system("svn", "add", "--quiet", $file) != 0) {
+ if (-d "$config{srcdir}/.svn") {
+ my $parent=dirname($file);
+ while (! -d "$config{srcdir}/$parent/.svn") {
+ $file=$parent;
+ $parent=dirname($file);
+ }
+
+ if (system("svn", "add", "--quiet", "$config{srcdir}/$file") != 0) {
warn("svn add failed\n");
}
}
-}
+} #}}}
+
+sub rcs_recentchanges ($) { #{{{
+ my $num=shift;
+ my @ret;
+
+ eval q{use Date::Parse};
+ eval q{use Time::Duration};
+
+ if (-d "$config{srcdir}/.svn") {
+ my $info=`LANG=C svn info $config{srcdir}`;
+ my ($svn_url)=$info=~/^URL: (.*)$/m;
+
+ # FIXME: currently assumes that the wiki is somewhere
+ # under trunk in svn, doesn't support other layouts.
+ my ($svn_base)=$svn_url=~m!(/trunk(?:/.*)?)$!;
+
+ my $div=qr/^--------------------+$/;
+ my $infoline=qr/^r(\d+)\s+\|\s+([^\s]+)\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
+ my $state='start';
+ my ($rev, $user, $when, @pages, @message);
+ foreach (`LANG=C svn log -v '$svn_url'`) {
+ chomp;
+ if ($state eq 'start' && /$div/) {
+ $state='header';
+ }
+ elsif ($state eq 'header' && /$infoline/) {
+ $rev=$1;
+ $user=$2;
+ $when=concise(ago(time - str2time($3)));
+ }
+ elsif ($state eq 'header' && /^\s+[A-Z]\s+\Q$svn_base\E\/(.+)$/) {
+ push @pages, { link => htmllink("", pagename($1), 1) }
+ if length $1;
+ }
+ elsif ($state eq 'header' && /^$/) {
+ $state='body';
+ }
+ elsif ($state eq 'body' && /$div/) {
+ my $committype="web";
+ if (defined $message[0] &&
+ $message[0]->{line}=~/^web commit by (\w+):?(.*)/) {
+ $user="$1";
+ $message[0]->{line}=$2;
+ }
+ else {
+ $committype="svn";
+ }
+
+ push @ret, { rev => $rev,
+ user => htmllink("", $user, 1),
+ committype => $committype,
+ when => $when, message => [@message],
+ pages => [@pages] } if @pages;
+ return @ret if @ret >= $num;
+
+ $state='header';
+ $rev=$user=$when=undef;
+ @pages=@message=();
+ }
+ elsif ($state eq 'body') {
+ push @message, {line => $_},
+ }
+ }
+ }
+
+ return @ret;
+} #}}}
-sub prune ($) {
+sub prune ($) { #{{{
my $file=shift;
unlink($file);
while (rmdir($dir)) {
$dir=dirname($dir);
}
-}
+} #}}}
-sub refresh () {
+sub refresh () { #{{{
# Find existing pages.
my %exists;
my @files;
+
+ eval q{use File::Find};
find({
no_chdir => 1,
wanted => sub {
- if (/$wiki_file_prune_regexp/) {
+ if (/$config{wiki_file_prune_regexp}/) {
+ no warnings 'once';
$File::Find::prune=1;
+ use warnings "all";
}
- elsif (! -d $_ && ! /\.html$/ && ! /\/\./) {
- my ($f)=/$wiki_file_regexp/; # untaint
+ elsif (! -d $_) {
+ my ($f)=/$config{wiki_file_regexp}/; # untaint
if (! defined $f) {
warn("skipping bad filename $_\n");
}
else {
- $f=~s/^\Q$srcdir\E\/?//;
+ $f=~s/^\Q$config{srcdir}\E\/?//;
push @files, $f;
$exists{pagename($f)}=1;
}
}
},
- }, $srcdir);
+ }, $config{srcdir});
my %rendered;
if (! $exists{$page}) {
debug("removing old page $page");
push @del, $renderedfiles{$page};
- prune($destdir."/".$renderedfiles{$page});
+ prune($config{destdir}."/".$renderedfiles{$page});
delete $renderedfiles{$page};
$oldpagemtime{$page}=0;
delete $pagesources{$page};
my $page=pagename($file);
if (! exists $oldpagemtime{$page} ||
- mtime("$srcdir/$file") > $oldpagemtime{$page}) {
+ mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
debug("rendering changed file $file");
render($file);
$rendered{$file}=1;
}
}
- # handle linkbacks; if a page has added/removed links, update the
+ # handle backlinks; 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
+ # problem is the backlinks could be wrong in the first pass render
# above
if (%rendered) {
my %linkchanged;
foreach my $link (keys %linkchanged) {
my $linkfile=$pagesources{$link};
if (defined $linkfile) {
- debug("rendering $linkfile, to update its linkbacks");
+ debug("rendering $linkfile, to update its backlinks");
render($linkfile);
}
}
}
-}
-
-# Generates a C wrapper program for running ikiwiki in a specific way.
-# The wrapper may be safely made suid.
-sub gen_wrapper ($$) {
- my ($svn, $rebuild)=@_;
+} #}}}
- eval {use Cwd 'abs_path'};
- $srcdir=abs_path($srcdir);
- $destdir=abs_path($destdir);
+sub gen_wrapper (@) { #{{{
+ my %config=(@_);
+ eval q{use Cwd 'abs_path'};
+ $config{srcdir}=abs_path($config{srcdir});
+ $config{destdir}=abs_path($config{destdir});
my $this=abs_path($0);
if (! -x $this) {
error("$this doesn't seem to be executable");
}
+
+ if ($config{setup}) {
+ error("cannot create a wrapper that uses a setup file");
+ }
- my $call=qq{"$this", "$this", "$srcdir", "$destdir", "--wikiname=$wikiname"};
- $call.=', "--verbose"' if $verbose;
- $call.=', "--rebuild"' if $rebuild;
- $call.=', "--nosvn"' if !$svn;
- $call.=', "--cgi"' if $cgi;
- $call.=', "--url='.$url.'"' if $url;
+ my @params=($config{srcdir}, $config{templatedir}, $config{destdir},
+ "--wikiname=$config{wikiname}");
+ push @params, "--verbose" if $config{verbose};
+ push @params, "--rebuild" if $config{rebuild};
+ push @params, "--nosvn" if !$config{svn};
+ push @params, "--cgi" if $config{cgi};
+ push @params, "--url=$config{url}" if length $config{url};
+ push @params, "--cgiurl=$config{cgiurl}" if length $config{cgiurl};
+ push @params, "--historyurl=$config{historyurl}" if length $config{historyurl};
+ push @params, "--anonok" if $config{anonok};
+ my $params=join(" ", @params);
+ my $call='';
+ foreach my $p ($this, $this, @params) {
+ $call.=qq{"$p", };
+ }
+ $call.="NULL";
my @envsave;
push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
- CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE} if $cgi;
+ CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
+ HTTP_COOKIE} if $config{cgi};
my $envsave="";
foreach my $var (@envsave) {
$envsave.=<<"EOF"
- if ((s=getenv("$var")))
- asprintf(&newenviron[i++], "%s=%s", "$var", s);
+ if ((s=getenv("$var")))
+ asprintf(&newenviron[i++], "%s=%s", "$var", s);
EOF
}
extern char **environ;
-int main (void) {
+int main (int argc, char **argv) {
/* Sanitize environment. */
char *s;
char *newenviron[$#envsave+3];
int i=0;
- $envsave;
+$envsave
newenviron[i++]="HOME=$ENV{HOME}";
newenviron[i]=NULL;
environ=newenviron;
- execl($call, NULL);
+ if (argc == 2 && strcmp(argv[1], "--params") == 0) {
+ printf("$params\\n");
+ exit(0);
+ }
+
+ execl($call);
perror("failed to run $this");
exit(1);
}
EOF
close OUT;
- if (system("gcc", "ikiwiki-wrap.c", "-o", "ikiwiki-wrap") != 0) {
+ if (system("gcc", "ikiwiki-wrap.c", "-o", possibly_foolish_untaint($config{wrapper})) != 0) {
error("failed to compile ikiwiki-wrap.c");
}
unlink("ikiwiki-wrap.c");
- print "successfully generated ikiwiki-wrap\n";
- exit 0;
-}
+ if (defined $config{wrappermode} &&
+ ! chmod(oct($config{wrappermode}), possibly_foolish_untaint($config{wrapper}))) {
+ error("chmod $config{wrapper}: $!");
+ }
+ print "successfully generated $config{wrapper}\n";
+} #}}}
+
+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,
+ );
+ return $template->output;
+}#}}}
-sub cgi () {
- eval q{use CGI};
- my $q=CGI->new;
+sub cgi_recentchanges ($) { #{{{
+ my $q=shift;
+
+ my $template=HTML::Template->new(
+ filename => "$config{templatedir}/recentchanges.tmpl"
+ );
+ $template->param(
+ title => "RecentChanges",
+ indexlink => indexlink(),
+ wikiname => $config{wikiname},
+ changelog => [rcs_recentchanges(100)],
+ );
+ print $q->header, $template->output;
+} #}}}
- my $do=$q->param('do');
- if (! defined $do || ! length $do) {
- error("\"do\" parameter missing");
+sub userinfo_get ($$) { #{{{
+ my $user=shift;
+ my $field=shift;
+
+ eval q{use Storable};
+ my $userdata=eval{ Storable::lock_retrieve("$config{srcdir}/.ikiwiki/userdb") };
+ if (! defined $userdata || ! ref $userdata ||
+ ! exists $userdata->{$user} || ! ref $userdata->{$user}) {
+ return "";
+ }
+ return $userdata->{$user}->{$field};
+} #}}}
+
+sub userinfo_set ($$) { #{{{
+ my $user=shift;
+ my $info=shift;
+
+ eval q{use Storable};
+ my $userdata=eval{ Storable::lock_retrieve("$config{srcdir}/.ikiwiki/userdb") };
+ if (! defined $userdata || ! ref $userdata) {
+ $userdata={};
+ }
+ $userdata->{$user}=$info;
+ my $oldmask=umask(077);
+ my $ret=Storable::lock_store($userdata, "$config{srcdir}/.ikiwiki/userdb");
+ umask($oldmask);
+ return $ret;
+} #}}}
+
+sub cgi_signin ($$) { #{{{
+ my $q=shift;
+ my $session=shift;
+
+ eval q{use CGI::FormBuilder};
+ my $form = CGI::FormBuilder->new(
+ title => "$config{wikiname} signin",
+ fields => [qw(do page from name password confirm_password email)],
+ header => 1,
+ method => 'POST',
+ validate => {
+ confirm_password => {
+ perl => q{eq $form->field("password")},
+ },
+ email => 'EMAIL',
+ },
+ required => 'NONE',
+ javascript => 0,
+ params => $q,
+ action => $q->request_uri,
+ header => 0,
+ template => (-e "$config{templatedir}/signin.tmpl" ?
+ "$config{templatedir}/signin.tmpl" : "")
+ );
+
+ $form->field(name => "name", required => 0);
+ $form->field(name => "do", type => "hidden");
+ $form->field(name => "page", type => "hidden");
+ $form->field(name => "from", type => "hidden");
+ $form->field(name => "password", type => "password", required => 0);
+ $form->field(name => "confirm_password", type => "password", required => 0);
+ $form->field(name => "email", required => 0);
+ if ($q->param("do") ne "signin") {
+ $form->text("You need to log in before you can edit pages.");
+ }
+
+ if ($form->submitted) {
+ # Set required fields based on how form was submitted.
+ my %required=(
+ "Login" => [qw(name password)],
+ "Register" => [qw(name password confirm_password email)],
+ "Mail Password" => [qw(name)],
+ );
+ foreach my $opt (@{$required{$form->submitted}}) {
+ $form->field(name => $opt, required => 1);
+ }
+
+ # Validate password differently depending on how
+ # form was submitted.
+ if ($form->submitted eq 'Login') {
+ $form->field(
+ name => "password",
+ validate => sub {
+ length $form->field("name") &&
+ shift eq userinfo_get($form->field("name"), 'password');
+ },
+ );
+ $form->field(name => "name", validate => '/^\w+$/');
+ }
+ else {
+ $form->field(name => "password", validate => 'VALUE');
+ }
+ # And make sure the entered name exists when logging
+ # in or sending email, and does not when registering.
+ if ($form->submitted eq 'Register') {
+ $form->field(
+ name => "name",
+ validate => sub {
+ my $name=shift;
+ length $name &&
+ ! userinfo_get($name, "regdate");
+ },
+ );
+ }
+ else {
+ $form->field(
+ name => "name",
+ validate => sub {
+ my $name=shift;
+ length $name &&
+ userinfo_get($name, "regdate");
+ },
+ );
+ }
+ }
+ else {
+ # First time settings.
+ $form->field(name => "name", comment => "use FirstnameLastName");
+ $form->field(name => "confirm_password", comment => "(only needed");
+ $form->field(name => "email", comment => "for registration)");
+ if ($session->param("name")) {
+ $form->field(name => "name", value => $session->param("name"));
+ }
+ }
+
+ if ($form->submitted && $form->validate) {
+ if ($form->submitted eq 'Login') {
+ $session->param("name", $form->field("name"));
+ if (defined $form->field("do") &&
+ $form->field("do") ne 'signin') {
+ print $q->redirect(
+ "$config{cgiurl}?do=".$form->field("do").
+ "&page=".$form->field("page").
+ "&from=".$form->field("from"));;
+ }
+ else {
+ print $q->redirect($config{url});
+ }
+ }
+ elsif ($form->submitted eq 'Register') {
+ my $user_name=$form->field('name');
+ if (userinfo_set($user_name, {
+ 'email' => $form->field('email'),
+ 'password' => $form->field('password'),
+ 'regdate' => time
+ })) {
+ $form->field(name => "confirm_password", type => "hidden");
+ $form->field(name => "email", type => "hidden");
+ $form->text("Registration successful. Now you can Login.");
+ print $session->header();
+ print misctemplate($form->title, $form->render(submit => ["Login"]));
+ }
+ else {
+ error("Error saving registration.");
+ }
+ }
+ elsif ($form->submitted eq 'Mail Password') {
+ my $user_name=$form->field("name");
+ my $template=HTML::Template->new(
+ filename => "$config{templatedir}/passwordmail.tmpl"
+ );
+ $template->param(
+ user_name => $user_name,
+ user_password => userinfo_get($user_name, "password"),
+ wikiurl => $config{url},
+ wikiname => $config{wikiname},
+ REMOTE_ADDR => $ENV{REMOTE_ADDR},
+ );
+
+ eval q{use Mail::Sendmail};
+ my ($fromhost) = $config{cgiurl} =~ m!/([^/]+)!;
+ sendmail(
+ To => userinfo_get($user_name, "email"),
+ From => "$config{wikiname} admin <".(getpwuid($>))[0]."@".$fromhost.">",
+ Subject => "$config{wikiname} information",
+ Message => $template->output,
+ ) or error("Failed to send mail");
+
+ $form->text("Your password has been emailed to you.");
+ $form->field(name => "name", required => 0);
+ print $session->header();
+ print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
+ }
+ }
+ else {
+ print $session->header();
+ print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
}
+} #}}}
+
+sub cgi_editpage ($$) { #{{{
+ my $q=shift;
+ my $session=shift;
+
+ eval q{use CGI::FormBuilder};
+ my $form = CGI::FormBuilder->new(
+ fields => [qw(do from page content comments)],
+ header => 1,
+ method => 'POST',
+ validate => {
+ content => '/.+/',
+ },
+ required => [qw{content}],
+ javascript => 0,
+ params => $q,
+ action => $q->request_uri,
+ table => 0,
+ template => "$config{templatedir}/editpage.tmpl"
+ );
- my ($page)=$q->param('page')=~/$wiki_file_regexp/; # untaint
+ my ($page)=$form->param('page')=~/$config{wiki_file_regexp}/;
if (! defined $page || ! length $page || $page ne $q->param('page') ||
- $page=~/$wiki_file_prune_regexp/ || $page=~/^\//) {
+ $page=~/$config{wiki_file_prune_regexp}/ || $page=~/^\//) {
error("bad page name");
}
+ $page=lc($page);
+
+ $form->field(name => "do", type => 'hidden');
+ $form->field(name => "from", type => 'hidden');
+ $form->field(name => "page", value => "$page", force => 1);
+ $form->field(name => "comments", type => "text", size => 80);
+ $form->field(name => "content", type => "textarea", rows => 20,
+ cols => 80);
- my $action=$q->request_uri;
- $action=~s/\?.*//;
-
- if ($do eq 'edit') {
- my $content="";
- if (exists $pagesources{lc($page)}) {
- $content=readfile("$srcdir/$pagesources{lc($page)}");
- $content=~s/\n/\r\n/g;
- }
- $q->param("do", "save");
- print $q->header,
- $q->start_html("$wikiname: Editing $page"),
- $q->h1("$wikiname: Editing $page"),
- $q->start_form(-action => $action),
- $q->hidden('do'),
- $q->hidden('page'),
- $q->textarea(-name => 'content',
- -default => $content,
- -rows => 20,
- -columns => 80),
- $q->br,
- "Optional comment about this change",
- $q->br,
- $q->textfield(-name => "comments", -size => 80),
- $q->br,
- $q->submit("Save Changes"),
- $q->end_form,
- $q->end_html;
- }
- elsif ($do eq 'save') {
- my $file=$page.$default_pagetype;
+ if ($form->submitted eq "Cancel") {
+ print $q->redirect("$config{url}/".htmlpage($page));
+ return;
+ }
+ if (! $form->submitted || ! $form->validate) {
+ if ($form->field("do") eq "create") {
+ if (exists $pagesources{lc($page)}) {
+ # hmm, someone else made the page in the
+ # meantime?
+ print $q->redirect("$config{url}/".htmlpage($page));
+ return;
+ }
+
+ my @page_locs;
+ my $best_loc;
+ my ($from)=$form->param('from')=~/$config{wiki_file_regexp}/;
+ if (! defined $from || ! length $from ||
+ $from ne $form->param('from') ||
+ $from=~/$config{wiki_file_prune_regexp}/ || $from=~/^\//) {
+ @page_locs=$best_loc=$page;
+ }
+ else {
+ my $dir=$from."/";
+ $dir=~s![^/]+/$!!;
+ push @page_locs, $dir.$page;
+ push @page_locs, "$from/$page";
+ $best_loc="$from/$page";
+ while (length $dir) {
+ $dir=~s![^/]+/$!!;
+ push @page_locs, $dir.$page;
+ }
+
+ @page_locs = grep { ! exists
+ $pagesources{lc($_)} } @page_locs;
+ }
+
+ $form->tmpl_param("page_select", 1);
+ $form->field(name => "page", type => 'select',
+ options => \@page_locs, value => $best_loc);
+ $form->title("creating $page");
+ }
+ elsif ($form->field("do") eq "edit") {
+ my $content="";
+ if (exists $pagesources{lc($page)}) {
+ $content=readfile("$config{srcdir}/$pagesources{lc($page)}");
+ $content=~s/\n/\r\n/g;
+ }
+ $form->tmpl_param("page_select", 0);
+ $form->field(name => "content", value => $content,
+ force => 1);
+ $form->field(name => "page", type => 'hidden');
+ $form->title("editing $page");
+ }
+
+ $form->tmpl_param("can_commit", $config{svn});
+ $form->tmpl_param("indexlink", indexlink());
+ print $form->render(submit => ["Save Page", "Cancel"]);
+ }
+ else {
+ # save page
+ my $file=$page.$config{default_pageext};
my $newfile=1;
if (exists $pagesources{lc($page)}) {
$file=$pagesources{lc($page)};
$newfile=0;
}
- my $content=$q->param('content');
+ my $content=$form->field('content');
$content=~s/\r\n/\n/g;
$content=~s/\r/\n/g;
- writefile("$srcdir/$file", $content);
+ writefile("$config{srcdir}/$file", $content);
- my $message="web commit from $ENV{REMOTE_ADDR}";
- if (defined $q->param('comments')) {
- $message.=": ".$q->param('comments');
+ my $message="web commit ";
+ if ($session->param("name")) {
+ $message.="by ".$session->param("name");
+ }
+ else {
+ $message.="from $ENV{REMOTE_ADDR}";
+ }
+ if (defined $form->field('comments') &&
+ length $form->field('comments')) {
+ $message.=": ".$form->field('comments');
}
- if ($svn) {
+ if ($config{svn}) {
if ($newfile) {
rcs_add($file);
}
rcs_commit($message);
}
else {
+ loadindex();
refresh();
+ saveindex();
}
- print $q->redirect("$url/".htmlpage($page));
+ # The trailing question mark tries to avoid broken
+ # caches and get the most recent version of the page.
+ print $q->redirect("$config{url}/".htmlpage($page)."?updated");
+ }
+} #}}}
+
+sub cgi () { #{{{
+ eval q{use CGI};
+ eval q{use CGI::Session};
+
+ my $q=CGI->new;
+
+ my $do=$q->param('do');
+ if (! defined $do || ! length $do) {
+ error("\"do\" parameter missing");
+ }
+
+ # This does not need a session.
+ if ($do eq 'recentchanges') {
+ cgi_recentchanges($q);
+ return;
+ }
+
+ CGI::Session->name("ikiwiki_session");
+
+ my $oldmask=umask(077);
+ my $session = CGI::Session->new("driver:db_file", $q,
+ { FileName => "$config{srcdir}/.ikiwiki/sessions.db" });
+ umask($oldmask);
+
+ # Everything below this point needs the user to be signed in.
+ if ((! $config{anonok} && ! defined $session->param("name") ||
+ ! userinfo_get($session->param("name"), "regdate")) || $do eq 'signin') {
+ cgi_signin($q, $session);
+
+ # Force session flush with safe umask.
+ my $oldmask=umask(077);
+ $session->flush;
+ umask($oldmask);
+
+ return;
+ }
+
+ if ($do eq 'create' || $do eq 'edit') {
+ cgi_editpage($q, $session);
}
else {
error("unknown do parameter");
}
-}
+} #}}}
-my $rebuild=0;
-my $wrapper=0;
-if (grep /^-/, @ARGV) {
- eval {use Getopt::Long};
- GetOptions(
- "wikiname=s" => \$wikiname,
- "verbose|v" => \$verbose,
- "rebuild" => \$rebuild,
- "wrapper" => \$wrapper,
- "svn!" => \$svn,
- "cgi" => \$cgi,
- "url=s" => \$url,
- ) || usage();
-}
-usage() unless @ARGV == 2;
-($srcdir) = possibly_foolish_untaint(shift);
-($destdir) = possibly_foolish_untaint(shift);
+sub setup () { # {{{
+ my $setup=possibly_foolish_untaint($config{setup});
+ delete $config{setup};
+ open (IN, $setup) || error("read $setup: $!\n");
+ local $/=undef;
+ my $code=<IN>;
+ ($code)=$code=~/(.*)/s;
+ close IN;
-if ($cgi && ! length $url) {
- error("Must specify url to wiki with --url when using --cgi");
-}
+ my (%setup);
+ eval $code;
+ error($@) if $@;
+
+ gen_wrapper(%config, %setup, %{$setup{cgiwrapper}}) if $setup{cgiwrapper};
+ gen_wrapper(%config, %setup, %{$setup{svnwrapper}}) if $setup{svnwrapper};
+
+ print "$setup{wikiname} setup complete, now forcing a rebuild\n";
+ foreach my $c (keys %setup) {
+ $config{$c}=possibly_foolish_untaint($setup{$c})
+ if defined $setup{$c} && ! ref $setup{$c};
+ }
+ $config{rebuild}=1;
+ refresh();
+ saveindex();
+ exit;
+} #}}}
-gen_wrapper($svn, $rebuild) if $wrapper;
+# main {{{
+setup() if $config{setup};
+if ($config{wrapper}) {
+ gen_wrapper(%config);
+ exit;
+}
memoize('pagename');
memoize('bestlink');
-loadindex() unless $rebuild;
-if ($cgi) {
+loadindex() unless $config{rebuild};
+if ($config{cgi}) {
cgi();
}
else {
- rcs_update() if $svn;
+ rcs_update() if $config{svn};
refresh();
saveindex();
}
+#}}}