my $type=pagetype($file);
my $page=$file;
- $page=~s/\Q.$type\E*$//
+ $page=~s/\Q.$type\E*$//
if defined $type && !$hooks{htmlize}{$type}{keepextension}
&& !$hooks{htmlize}{$type}{noextension};
if ($config{indexpages} && $page=~/(.*)\/index$/) {
my $page=shift;
my $link=shift;
- return $page eq $link;
+ return $page eq $link;
}
sub htmllink ($$$;@) {
$hooks{rcs}{rcs_receive}{call}->();
}
+sub rcs_preprevert (@) {
+ $hooks{rcs}{rcs_preprevert}{call}->(@_);
+}
+
+sub rcs_revert (@) {
+ $hooks{rcs}{rcs_revert}{call}->(@_);
+}
+
+sub rcs_showpatch (@) {
+ $hooks{rcs}{rcs_showpatch}{call}->(@_);
+}
+
sub add_depends ($$;$) {
my $page=shift;
my $pagespec=shift;
hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
hook(type => "rcs", id => "rcs_receive", call => \&rcs_receive);
+ hook(type => "rcs", id => "rcs_preprevert", call => \&rcs_preprevert);
+ hook(type => "rcs", id => "rcs_revert", call => \&rcs_revert);
+ hook(type => "rcs", id => "rcs_showpatch", call => \&rcs_showpatch);
}
sub checkconfig () {
return findtimes($file, 0);
}
-sub rcs_receive () {
+{
+my $git_root;
+
+sub git_find_root {
# The wiki may not be the only thing in the git repo.
# Determine if it is in a subdirectory by examining the srcdir,
# and its parents, looking for the .git directory.
+
+ return $git_root if defined $git_root;
+
my $subdir="";
my $dir=$config{srcdir};
while (! -d "$dir/.git") {
}
}
+ return $git_root=$subdir;
+}
+
+}
+
+sub git_parse_changes {
+ my @changes = @_;
+
+ my $subdir = git_find_root();
+ my @rets;
+ foreach my $ci (@changes) {
+ foreach my $detail (@{ $ci->{'details'} }) {
+ my $file = $detail->{'file'};
+
+ # check that all changed files are in the subdir
+ if (length $subdir &&
+ ! ($file =~ s/^\Q$subdir\E//)) {
+ error sprintf(gettext("you are not allowed to change %s"), $file);
+ }
+
+ my ($action, $mode, $path);
+ if ($detail->{'status'} =~ /^[M]+\d*$/) {
+ $action="change";
+ $mode=$detail->{'mode_to'};
+ }
+ elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
+ $action="add";
+ $mode=$detail->{'mode_to'};
+ }
+ elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
+ $action="remove";
+ $mode=$detail->{'mode_from'};
+ }
+ else {
+ error "unknown status ".$detail->{'status'};
+ }
+
+ # test that the file mode is ok
+ if ($mode !~ /^100[64][64][64]$/) {
+ error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
+ }
+ if ($action eq "change") {
+ if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
+ error gettext("you are not allowed to change file modes");
+ }
+ }
+
+ # extract attachment to temp file
+ if (($action eq 'add' || $action eq 'change') &&
+ ! pagetype($file)) {
+ eval q{use File::Temp};
+ die $@ if $@;
+ my $fh;
+ ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
+ # Ensure we run this in the right place,
+ # see comments in rcs_receive.
+ my $cmd = ($no_chdir ? '' : "cd $config{srcdir} && ")
+ . "git show $detail->{sha1_to} > '$path'";
+ if (system($cmd) != 0) {
+ error("failed writing temp file '$path'.");
+ }
+ }
+
+ push @rets, {
+ file => $file,
+ action => $action,
+ path => $path,
+ };
+ }
+ }
+
+ return @rets;
+}
+
+sub rcs_receive () {
my @rets;
while (<>) {
chomp;
my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
-
+
# only allow changes to gitmaster_branch
if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
error sprintf(gettext("you are not allowed to change %s"), $refname);
}
-
+
# Avoid chdir when running git here, because the changes
# are in the master git repo, not the srcdir repo.
- # The pre-recieve hook already puts us in the right place.
+ # The pre-receive hook already puts us in the right place.
$no_chdir=1;
- my @changes=git_commit_info($oldrev."..".$newrev);
+ push @rets, git_parse_changes(git_commit_info($oldrev."..".$newrev));
$no_chdir=0;
+ }
- foreach my $ci (@changes) {
- foreach my $detail (@{ $ci->{'details'} }) {
- my $file = $detail->{'file'};
+ return reverse @rets;
+}
- # check that all changed files are in the
- # subdir
- if (length $subdir &&
- ! ($file =~ s/^\Q$subdir\E//)) {
- error sprintf(gettext("you are not allowed to change %s"), $file);
- }
+sub rcs_preprevert (@) {
+ my %params = @_;
+ my $rev = $params{rev};
- my ($action, $mode, $path);
- if ($detail->{'status'} =~ /^[M]+\d*$/) {
- $action="change";
- $mode=$detail->{'mode_to'};
- }
- elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
- $action="add";
- $mode=$detail->{'mode_to'};
- }
- elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
- $action="remove";
- $mode=$detail->{'mode_from'};
- }
- else {
- error "unknown status ".$detail->{'status'};
- }
-
- # test that the file mode is ok
- if ($mode !~ /^100[64][64][64]$/) {
- error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
- }
- if ($action eq "change") {
- if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
- error gettext("you are not allowed to change file modes");
- }
- }
-
- # extract attachment to temp file
- if (($action eq 'add' || $action eq 'change') &&
- ! pagetype($file)) {
- eval q{use File::Temp};
- die $@ if $@;
- my $fh;
- ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
- if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
- error("failed writing temp file");
- }
- }
+ # Note test_changes expects 'cgi' and 'session' parameters.
+ require IkiWiki::Receive;
+ IkiWiki::Receive::test_changes(%params, changes =>
+ [git_parse_changes(git_commit_info($rev, 1))]);
+}
- push @rets, {
- file => $file,
- action => $action,
- path => $path,
- };
- }
- }
+sub rcs_revert (@) {
+ # Try to revert the given patch; returns undef on _success_.
+ my %params = @_;
+ my $rev = $params{rev};
+
+ if (run_or_non('git', 'revert', '--no-commit', $rev)) {
+ debug "Committing revert for patch '$rev'.";
+ rcs_commit_staged(message =>
+ sprintf(gettext("This reverts commit %s"), $rev), @_);
+ }
+ else {
+ # No idea what is actually getting reverted, so all we can
+ # do is say we failed.
+ run_or_die('git', 'reset', '--hard');
+ return sprintf(gettext("Failed to revert commit %s"), $rev);
}
+}
- return reverse @rets;
+sub rcs_showpatch (@) {
+ # Show the patch with the given revision id.
+ my %params = @_;
+ my $rev = $params{rev};
+
+ return join "\n", run_or_die('git', 'show', $rev);
}
1
hook(type => "refresh", id => "recentchanges", call => \&refresh);
hook(type => "pagetemplate", id => "recentchanges", call => \&pagetemplate);
hook(type => "htmlize", id => "_change", call => \&htmlize);
+ hook(type => "sessioncgi", id => "recentchanges", call => \&sessioncgi);
# Load goto to fix up links from recentchanges
IkiWiki::loadplugin("goto");
}
}
}
+sub confirmation_form {
+ my ($q, $session, $rev) = @_;
+
+ eval q{use CGI::FormBuilder};
+ error($@) if $@;
+ my $f = CGI::FormBuilder->new(
+ name => "revert",
+ header => 0,
+ charset => "utf-8",
+ method => 'POST',
+ javascript => 0,
+ params => $q,
+ action => $config{cgiurl},
+ stylesheet => 1,
+ template => { template('revert.tmpl') },
+ );
+
+ $f->field(name => "sid", type => "hidden", value => $session->id,
+ force => 1);
+ $f->field(name => "do", type => "hidden", value => "revert",
+ force => 1);
+
+ return $f, ["Revert", "Cancel"];
+}
+
+sub sessioncgi ($$) {
+ my ($q, $session) = @_;
+ my $do = $q->param('do');
+ my $rev = $q->param('rev');
+
+ return unless $do eq 'revert' && $rev;
+
+ IkiWiki::rcs_preprevert(cgi => $q, session => $session, rev => $rev);
+
+ my ($form, $buttons) = confirmation_form($q, $session);
+ IkiWiki::decode_form_utf8($form);
+
+ if ($form->submitted eq 'Revert' && $form->validate) {
+ IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
+ IkiWiki::disable_commit_hook();
+ my $r = IkiWiki::rcs_revert(
+ session => $session,
+ rev => $rev);
+ IkiWiki::enable_commit_hook();
+
+ if ($r) {
+ die "Revert '$rev' failed.";
+ }
+ else {
+ require IkiWiki::Render;
+ IkiWiki::refresh();
+ IkiWiki::saveindex();
+ }
+ }
+ else {
+ $form->title(sprintf(gettext("confirm reversion of %s"), $rev));
+ my $patch_contents = IkiWiki::rcs_showpatch(rev => $rev);
+ $form->tmpl_param(patch_contents => encode_entities($patch_contents));
+ $form->field(name => "rev", type => "hidden", value => $rev, force => 1);
+ IkiWiki::showform($form, $buttons, $session, $q);
+ exit 0;
+ }
+
+ IkiWiki::redirect($q, urlto($config{recentchangespage}, ''));
+ exit 0;
+}
+
# Enable the recentchanges link.
sub pagetemplate (@) {
my %params=@_;
} @{$change->{pages}}
];
push @{$change->{pages}}, { link => '...' } if $is_excess;
+
+ if (length $config{cgiurl}) {
+ $change->{reverturl} = IkiWiki::cgiurl(
+ do => "revert",
+ rev => $change->{rev}
+ );
+ }
$change->{author}=$change->{user};
my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
sub test () {
exit 0 if trusted();
-
+
IkiWiki::lockwiki();
IkiWiki::loadindex();
-
+
# Dummy up a cgi environment to use when calling check_canedit
# and friends.
eval q{use CGI};
regdate => time,
}) || error("failed adding user");
}
-
- my %newfiles;
- foreach my $change (IkiWiki::rcs_receive()) {
+ test_changes(cgi => $cgi,
+ session => $session,
+ changes => [IkiWiki::rcs_receive()]
+ );
+ exit 0;
+}
+
+sub test_changes {
+ my %params = @_;
+ my $cgi = $params{cgi};
+ my $session = $params{session};
+ my @changes = @{$params{changes}};
+
+ my %newfiles;
+ foreach my $change (@changes) {
# This untaint is safe because we check file_pruned and
# wiki_file_regexp.
my ($file)=$change->{file}=~/$config{wiki_file_regexp}/;
my $type=pagetype($file);
my $page=pagename($file) if defined $type;
-
+
if ($change->{action} eq 'add') {
$newfiles{$file}=1;
}
else {
error "unknown action ".$change->{action};
}
-
+
error sprintf(gettext("you are not allowed to change %s"), $file);
}
-
- exit 0;
}
1
It should examine the incoming changes, and do any sanity
checks that are appropriate for the RCS to limit changes to safe file adds,
-removes, and changes. If something bad is found, it should exit
-nonzero, to abort the push. Otherwise, it should return a list of
-files that were changed, in the form:
+removes, and changes. If something bad is found, it should die, to abort
+the push. Otherwise, it should return a list of files that were changed,
+in the form:
{
file => # name of file that was changed
The list will then be checked to make sure that each change is one that
is allowed to be made via the web interface.
+#### `rcs_preprevert($)`
+
+This is called by the revert web interface. It is passed a RCS-specific
+change ID, and should determine what the effects would be of reverting
+that change, and return the same data structure as `rcs_receive`.
+
+Like `rcs_receive`, it should do whatever sanity checks are appropriate
+for the RCS to limit changes to safe changes, and die if a change would
+be unsafe to revert.
+
+#### `rcs_revert(@)`
+
+This is called by the revert web interface. It is passed a named
+parameter rev that is the RCS-specific change ID to revert.
+
+Addition named parameters: `message`, and `session` (optional).
+
+It should try to revert the specified rev, which includes committing
+the reversion, and returns undef on _success_ and an error message
+on failure.
+
+#### `rcs_showpatch(@)`
+
+This is passed a named parameter rev that is a RCS-specific
+change ID. It should generate a diff-style patch showing the changes
+made and return it.
+
### PageSpec plugins
It's also possible to write plugins that add new functions to
* `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
`editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
`editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,
- `passwordmail.tmpl`, `openid-selector.tmpl` - Parts of ikiwiki's user
+ `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user
interface; do not normally need to be customised.
[[!meta robots="noindex, follow"]]
<span class="committype"><TMPL_VAR COMMITTYPE></span>
<span class="desc"><br />Date:</span>
<span class="changedate"><TMPL_VAR COMMITDATE></span>
+<span class="desc"><br /></span>
+<span class="revert"><a href="<TMPL_VAR REVERTURL>" rel="nofollow">[[revert|wikiicons/revert.png]]</a></span>
</div>
<div class="changelog">
<TMPL_LOOP MESSAGE>
--- /dev/null
+<pre>
+<TMPL_VAR patch_contents>
+</pre>
+<TMPL_VAR FORM-START>
+<div>
+ <TMPL_VAR FIELD-DO>
+ <TMPL_VAR FIELD-SID>
+ <TMPL_VAR FIELD-REV>
+</div>
+<div class="revert buttons">
+ <TMPL_VAR form-submit>
+ <TMPL_VAR form-cancel>
+</div>
+<TMPL_VAR FORM-END>
