X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/b93e189934c5f3abe39db070f0d9ed459007ddcf..e4d9da55d923cdd78cd07959de44edf17a9a5fe5:/ikiwiki diff --git a/ikiwiki b/ikiwiki index 40356f1d3..51f324d13 100755 --- a/ikiwiki +++ b/ikiwiki @@ -1,4 +1,7 @@ #!/usr/bin/perl -T + +eval 'exec /usr/bin/perl -T -S $0 ${1+"$@"}' + if 0; # not running under some shell $ENV{PATH}="/usr/local/bin:/usr/bin:/bin"; use warnings; @@ -13,7 +16,7 @@ my (%links, %oldlinks, %oldpagemtime, %renderedfiles, %pagesources); # Holds global config settings, also used by some modules. our %config=( #{{{ wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$)}, - wiki_link_regexp => qr/\[\[([^\s]+)\]\]/, + wiki_link_regexp => qr/\[\[([^\s\]]+)\]\]/, wiki_file_regexp => qr/(^[-A-Za-z0-9_.:\/+]+$)/, verbose => 0, wikiname => "wiki", @@ -23,14 +26,16 @@ our %config=( #{{{ url => '', cgiurl => '', historyurl => '', + diffurl => '', anonok => 0, rebuild => 0, wrapper => undef, wrappermode => undef, srcdir => undef, destdir => undef, - templatedir => undef, + templatedir => "/usr/share/ikiwiki/templates", setup => undef, + adminuser => undef, ); #}}} GetOptions( #{{{ @@ -46,24 +51,32 @@ GetOptions( #{{{ "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]) }, ) || usage(); if (! $config{setup}) { - usage() unless @ARGV == 3; + usage() unless @ARGV == 2; $config{srcdir} = possibly_foolish_untaint(shift); - $config{templatedir} = possibly_foolish_untaint(shift); $config{destdir} = possibly_foolish_untaint(shift); + checkoptions(); +} +#}}} + +sub checkoptions { #{{{ 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}; +} #}}} sub usage { #{{{ - die "usage: ikiwiki [options] source templates dest\n"; + die "usage: ikiwiki [options] source dest\n"; } #}}} sub error { #{{{ @@ -324,9 +337,10 @@ sub indexlink () { #{{{ return "$config{wikiname}"; } #}}} -sub finalize ($$) { #{{{ +sub finalize ($$$) { #{{{ my $content=shift; my $page=shift; + my $mtime=shift; my $title=basename($page); $title=~s/_/ /g; @@ -336,6 +350,7 @@ sub finalize ($$) { #{{{ if (length $config{cgiurl}) { $template->param(editurl => "$config{cgiurl}?do=edit&page=$page"); + $template->param(prefsurl => "$config{cgiurl}?do=prefs"); if ($config{svn}) { $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges"); } @@ -343,7 +358,7 @@ sub finalize ($$) { #{{{ if (length $config{historyurl}) { my $u=$config{historyurl}; - $u=~s/\[\[\]\]/$pagesources{$page}/g; + $u=~s/\[\[file\]\]/$pagesources{$page}/g; $template->param(historyurl => $u); } @@ -354,6 +369,7 @@ sub finalize ($$) { #{{{ content => $content, backlinks => [backlinks($page)], discussionlink => htmllink($page, "Discussion", 1, 1), + mtime => scalar(gmtime($mtime)), ); return $template->output; @@ -385,7 +401,8 @@ sub render ($) { #{{{ $content=linkify($content, $page); $content=htmlize($type, $content); - $content=finalize($content, $page); + $content=finalize($content, $page, + mtime("$config{srcdir}/$file")); check_overwrite("$config{destdir}/".htmlpage($page), $page); writefile("$config{destdir}/".htmlpage($page), $content); @@ -404,10 +421,11 @@ sub render ($) { #{{{ 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{srcdir}/.ikiwiki") { - mkdir("$config{srcdir}/.ikiwiki"); + if (! -d $config{wikistatedir}) { + mkdir($config{wikistatedir}); } - open(WIKILOCK, ">$config{srcdir}/.ikiwiki/lockfile") || error ("cannot write to lockfile: $!"); + 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 @@ -420,8 +438,12 @@ sub lockwiki () { #{{{ } } #}}} +sub unlockwiki () { #{{{ + close WIKILOCK; +} #}}} + sub loadindex () { #{{{ - open (IN, "$config{srcdir}/.ikiwiki/index") || return; + open (IN, "$config{wikistatedir}/index") || return; while () { $_=possibly_foolish_untaint($_); chomp; @@ -437,10 +459,11 @@ sub loadindex () { #{{{ } #}}} sub saveindex () { #{{{ - if (! -d "$config{srcdir}/.ikiwiki") { - mkdir("$config{srcdir}/.ikiwiki"); + if (! -d $config{wikistatedir}) { + mkdir($config{wikistatedir}); } - open (OUT, ">$config{srcdir}/.ikiwiki/index") || error("cannot write to index: $!"); + 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" @@ -457,19 +480,59 @@ sub rcs_update () { #{{{ } } #}}} -sub rcs_commit ($) { #{{{ +sub rcs_prepedit ($) { #{{{ + # Prepares to edit a file under revision control. Returns a token + # that must be passed into rcs_commit when the file is ready + # for committing. + # The file is relative to the srcdir. + my $file=shift; + + if (-d "$config{srcdir}/.svn") { + # For subversion, return the revision of the file when + # editing begins. + my $rev=svn_info("Revision", "$config{srcdir}/$file"); + return defined $rev ? $rev : ""; + } +} #}}} + +sub rcs_commit ($$$) { #{{{ + # Tries to commit the page; returns undef on _success_ and + # a version of the page with the rcs's conflict markers on failure. + # The file is relative to the srcdir. + my $file=shift; my $message=shift; + my $rcstoken=shift; if (-d "$config{srcdir}/.svn") { + # Check to see if the page has been changed by someone + # else since rcs_prepedit was called. + my ($oldrev)=$rcstoken=~/^([0-9]+)$/; # untaint + my $rev=svn_info("Revision", "$config{srcdir}/$file"); + if (defined $rev && defined $oldrev && $rev != $oldrev) { + # Merge their changes into the file that we've + # changed. + chdir($config{srcdir}); # svn merge wants to be here + if (system("svn", "merge", "--quiet", "-r$oldrev:$rev", + "$config{srcdir}/$file") != 0) { + warn("svn merge -r$oldrev:$rev failed\n"); + } + } + if (system("svn", "commit", "--quiet", "-m", possibly_foolish_untaint($message), - $config{srcdir}) != 0) { - warn("svn commit failed\n"); + "$config{srcdir}") != 0) { + my $conflict=readfile("$config{srcdir}/$file"); + if (system("svn", "revert", "--quiet", "$config{srcdir}/$file") != 0) { + warn("svn revert failed\n"); + } + return $conflict; } } + return undef # success } #}}} sub rcs_add ($) { #{{{ + # filename is relative to the root of the srcdir my $file=shift; if (-d "$config{srcdir}/.svn") { @@ -485,6 +548,15 @@ sub rcs_add ($) { #{{{ } } #}}} +sub svn_info ($$) { #{{{ + my $field=shift; + my $file=shift; + + my $info=`LANG=C svn info $file`; + my ($ret)=$info=~/^$field: (.*)$/m; + return $ret; +} #}}} + sub rcs_recentchanges ($) { #{{{ my $num=shift; my @ret; @@ -494,8 +566,7 @@ sub rcs_recentchanges ($) { #{{{ eval q{use Time::Duration}; if (-d "$config{srcdir}/.svn") { - my $info=`LANG=C svn info $config{srcdir}`; - my ($svn_url)=$info=~/^URL: (.*)$/m; + my $svn_url=svn_info("URL", $config{srcdir}); # FIXME: currently assumes that the wiki is somewhere # under trunk in svn, doesn't support other layouts. @@ -515,9 +586,16 @@ sub rcs_recentchanges ($) { #{{{ $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' && /^\s+[A-Z]\s+\Q$svn_base\E\/([^ ]+)(?:$|\s)/) { + my $file=$1; + my $diffurl=$config{diffurl}; + $diffurl=~s/\[\[file\]\]/$file/g; + $diffurl=~s/\[\[r1\]\]/$rev - 1/eg; + $diffurl=~s/\[\[r2\]\]/$rev/g; + push @pages, { + link => htmllink("", pagename($file), 1), + diffurl => $diffurl, + } if length $file; } elsif ($state eq 'header' && /^$/) { $state='body'; @@ -537,7 +615,8 @@ sub rcs_recentchanges ($) { #{{{ user => htmllink("", $user, 1), committype => $committype, when => $when, message => [@message], - pages => [@pages] } if @pages; + pages => [@pages], + } if @pages; return @ret if @ret >= $num; $state='header'; @@ -687,8 +766,7 @@ FILE: foreach my $file (@files) { } } #}}} -sub gen_wrapper (@) { #{{{ - my %config=(@_); +sub gen_wrapper () { #{{{ eval q{use Cwd 'abs_path'}; $config{srcdir}=abs_path($config{srcdir}); $config{destdir}=abs_path($config{destdir}); @@ -701,8 +779,9 @@ sub gen_wrapper (@) { #{{{ error("cannot create a wrapper that uses a setup file"); } - my @params=($config{srcdir}, $config{templatedir}, $config{destdir}, - "--wikiname=$config{wikiname}"); + my @params=($config{srcdir}, $config{destdir}, + "--wikiname=$config{wikiname}", + "--templatedir=$config{templatedir}"); push @params, "--verbose" if $config{verbose}; push @params, "--rebuild" if $config{rebuild}; push @params, "--nosvn" if !$config{svn}; @@ -710,7 +789,9 @@ sub gen_wrapper (@) { #{{{ 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, "--diffurl=$config{diffurl}" if length $config{diffurl}; push @params, "--anonok" if $config{anonok}; + push @params, "--adminuser=$_" foreach @{$config{adminuser}}; my $params=join(" ", @params); my $call=''; foreach my $p ($this, $this, @params) { @@ -809,26 +890,46 @@ sub userinfo_get ($$) { #{{{ my $field=shift; eval q{use Storable}; - my $userdata=eval{ Storable::lock_retrieve("$config{srcdir}/.ikiwiki/userdb") }; + my $userdata=eval{ Storable::lock_retrieve("$config{wikistatedir}/userdb") }; if (! defined $userdata || ! ref $userdata || - ! exists $userdata->{$user} || ! ref $userdata->{$user}) { + ! exists $userdata->{$user} || ! ref $userdata->{$user} || + ! exists $userdata->{$user}->{$field}) { return ""; } return $userdata->{$user}->{$field}; } #}}} -sub userinfo_set ($$) { #{{{ +sub userinfo_set ($$$) { #{{{ + my $user=shift; + my $field=shift; + my $value=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}) { + return ""; + } + + $userdata->{$user}->{$field}=$value; + my $oldmask=umask(077); + my $ret=Storable::lock_store($userdata, "$config{wikistatedir}/userdb"); + umask($oldmask); + return $ret; +} #}}} + +sub userinfo_setall ($$) { #{{{ my $user=shift; my $info=shift; eval q{use Storable}; - my $userdata=eval{ Storable::lock_retrieve("$config{srcdir}/.ikiwiki/userdb") }; + 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{srcdir}/.ikiwiki/userdb"); + my $ret=Storable::lock_store($userdata, "$config{wikistatedir}/userdb"); umask($oldmask); return $ret; } #}}} @@ -839,7 +940,7 @@ sub cgi_signin ($$) { #{{{ eval q{use CGI::FormBuilder}; my $form = CGI::FormBuilder->new( - title => "$config{wikiname} signin", + title => "signin", fields => [qw(do page from name password confirm_password email)], header => 1, method => 'POST', @@ -866,7 +967,7 @@ sub cgi_signin ($$) { #{{{ $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."); + $form->text("You need to log in first."); } if ($form->submitted) { @@ -944,7 +1045,7 @@ sub cgi_signin ($$) { #{{{ } elsif ($form->submitted eq 'Register') { my $user_name=$form->field('name'); - if (userinfo_set($user_name, { + if (userinfo_setall($user_name, { 'email' => $form->field('email'), 'password' => $form->field('password'), 'regdate' => time @@ -993,13 +1094,135 @@ sub cgi_signin ($$) { #{{{ } } #}}} +sub is_admin ($) { #{{{ + my $user_name=shift; + + return grep { $_ eq $user_name } @{$config{adminuser}}; +} #}}} + +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); + } + + foreach my $glob (@globlist) { + return 1 if glob_match($page, $glob); + } + + return 0; +} #}}} + +sub page_locked ($$;$) { #{{{ + my $page=shift; + my $session=shift; + my $nonfatal=shift; + + my $user=$session->param("name"); + return if length $user && is_admin($user); + + foreach my $admin (@{$config{adminuser}}) { + my $locked_pages=userinfo_get($admin, "locked_pages"); + if (globlist_match($page, userinfo_get($admin, "locked_pages"))) { + return 1 if $nonfatal; + error(htmllink("", $page, 1)." is locked by ". + htmllink("", $admin, 1)." and cannot be edited."); + } + } + + return 0; +} #}}} + +sub cgi_prefs ($$) { #{{{ + my $q=shift; + my $session=shift; + + eval q{use CGI::FormBuilder}; + my $form = CGI::FormBuilder->new( + title => "preferences", + fields => [qw(do name password confirm_password email locked_pages)], + header => 0, + method => 'POST', + validate => { + confirm_password => { + perl => q{eq $form->field("password")}, + }, + email => 'EMAIL', + }, + required => 'NONE', + javascript => 0, + params => $q, + action => $q->request_uri, + template => (-e "$config{templatedir}/prefs.tmpl" ? + "$config{templatedir}/prefs.tmpl" : "") + ); + my @buttons=("Save Preferences", "Logout", "Cancel"); + + my $user_name=$session->param("name"); + $form->field(name => "do", type => "hidden"); + $form->field(name => "name", disabled => 1, + value => $user_name, force => 1); + $form->field(name => "password", type => "password"); + $form->field(name => "confirm_password", type => "password"); + $form->field(name => "locked_pages", size => 50, + comment => "(".htmllink("", "GlobList", 1).")"); + + if (! is_admin($user_name)) { + $form->field(name => "locked_pages", type => "hidden"); + } + + if (! $form->submitted) { + $form->field(name => "email", force => 1, + value => userinfo_get($user_name, "email")); + $form->field(name => "locked_pages", force => 1, + value => userinfo_get($user_name, "locked_pages")); + } + + if ($form->submitted eq 'Logout') { + $session->delete(); + print $q->redirect($config{url}); + return; + } + elsif ($form->submitted eq 'Cancel') { + print $q->redirect($config{url}); + return; + } + elsif ($form->submitted eq "Save Preferences" && $form->validate) { + foreach my $field (qw(password email locked_pages)) { + if (length $form->field($field)) { + userinfo_set($user_name, $field, $form->field($field)) || error("failed to set $field"); + } + } + $form->text("Preferences saved."); + } + + print $session->header(); + print misctemplate($form->title, $form->render(submit => \@buttons)); +} #}}} + 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)], + fields => [qw(do rcsinfo from page content comments)], header => 1, method => 'POST', validate => { @@ -1012,6 +1235,7 @@ sub cgi_editpage ($$) { #{{{ table => 0, template => "$config{templatedir}/editpage.tmpl" ); + my @buttons=("Save Page", "Preview", "Cancel"); my ($page)=$form->param('page')=~/$config{wiki_file_regexp}/; if (! defined $page || ! length $page || $page ne $q->param('page') || @@ -1019,13 +1243,29 @@ sub cgi_editpage ($$) { #{{{ error("bad page name"); } $page=lc($page); + + my $file=$page.$config{default_pageext}; + my $newfile=1; + if (exists $pagesources{lc($page)}) { + $file=$pagesources{lc($page)}; + $newfile=0; + } $form->field(name => "do", type => 'hidden'); $form->field(name => "from", type => 'hidden'); + $form->field(name => "rcsinfo", 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); + $form->tmpl_param("can_commit", $config{svn}); + $form->tmpl_param("indexlink", indexlink()); + $form->tmpl_param("helponformattinglink", + htmllink("", "HelpOnFormatting", 1)); + if (! $form->submitted) { + $form->field(name => "rcsinfo", value => rcs_prepedit($file), + force => 1); + } if ($form->submitted eq "Cancel") { print $q->redirect("$config{url}/".htmlpage($page)); @@ -1039,6 +1279,7 @@ sub cgi_editpage ($$) { #{{{ else { $form->tmpl_param("page_preview", ""); } + $form->tmpl_param("page_conflict", ""); if (! $form->submitted || $form->submitted eq "Preview" || ! $form->validate) { @@ -1061,16 +1302,25 @@ sub cgi_editpage ($$) { #{{{ else { my $dir=$from."/"; $dir=~s![^/]+/$!!; + + if ($page eq 'discussion') { + $best_loc="$from/$page"; + } + else { + $best_loc=$dir.$page; + } + 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; + @page_locs = grep { + ! exists $pagesources{lc($_)} && + ! page_locked($_, $session, 1) + } @page_locs; } $form->tmpl_param("page_select", 1); @@ -1079,7 +1329,9 @@ sub cgi_editpage ($$) { #{{{ $form->title("creating $page"); } elsif ($form->field("do") eq "edit") { - if (! length $form->field('content')) { + page_locked($page, $session); + if (! defined $form->field('content') || + ! length $form->field('content')) { my $content=""; if (exists $pagesources{lc($page)}) { $content=readfile("$config{srcdir}/$pagesources{lc($page)}"); @@ -1093,18 +1345,11 @@ sub cgi_editpage ($$) { #{{{ $form->title("editing $page"); } - $form->tmpl_param("can_commit", $config{svn}); - $form->tmpl_param("indexlink", indexlink()); - print $form->render(submit => ["Save Page", "Preview", "Cancel"]); + print $form->render(submit => \@buttons); } else { # save page - my $file=$page.$config{default_pageext}; - my $newfile=1; - if (exists $pagesources{lc($page)}) { - $file=$pagesources{lc($page)}; - $newfile=0; - } + page_locked($page, $session); my $content=$form->field('content'); $content=~s/\r\n/\n/g; @@ -1112,7 +1357,7 @@ sub cgi_editpage ($$) { #{{{ writefile("$config{srcdir}/$file", $content); my $message="web commit "; - if ($session->param("name")) { + if (length $session->param("name")) { $message.="by ".$session->param("name"); } else { @@ -1127,9 +1372,25 @@ sub cgi_editpage ($$) { #{{{ if ($newfile) { rcs_add($file); } + # prevent deadlock with post-commit hook + unlockwiki(); # presumably the commit will trigger an update # of the wiki - rcs_commit($message); + my $conflict=rcs_commit($file, $message, + $form->field("rcsinfo")); + + if (defined $conflict) { + $form->field(name => "rcsinfo", value => rcs_prepedit($file), + force => 1); + $form->tmpl_param("page_conflict", 1); + $form->field("content", value => $conflict, force => 1); + $form->field("do", "edit)"); + $form->tmpl_param("page_select", 0); + $form->field(name => "page", type => 'hidden'); + $form->title("editing $page"); + print $form->render(submit => \@buttons); + return; + } } else { loadindex(); @@ -1164,12 +1425,13 @@ sub cgi () { #{{{ my $oldmask=umask(077); my $session = CGI::Session->new("driver:db_file", $q, - { FileName => "$config{srcdir}/.ikiwiki/sessions.db" }); + { FileName => "$config{wikistatedir}/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') { + ! defined $session->param("name") || + ! userinfo_get($session->param("name"), "regdate")) || $do eq 'signin') { cgi_signin($q, $session); # Force session flush with safe umask. @@ -1183,6 +1445,9 @@ sub cgi () { #{{{ if ($do eq 'create' || $do eq 'edit') { cgi_editpage($q, $session); } + elsif ($do eq 'prefs') { + cgi_prefs($q, $session); + } else { error("unknown do parameter"); } @@ -1203,10 +1468,10 @@ sub setup () { # {{{ } #}}} # main {{{ -lockwiki(); setup() if $config{setup}; +lockwiki(); if ($config{wrapper}) { - gen_wrapper(%config); + gen_wrapper(); exit; } memoize('pagename');