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 ($$$;@) {
return defined $ok ? $ok : 1;
}
+sub check_canchange (@) {
+ 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}/;
+ $file=possibly_foolish_untaint($file);
+ if (! defined $file || ! length $file ||
+ file_pruned($file)) {
+ error(gettext("bad file name %s"), $file);
+ }
+
+ my $type=pagetype($file);
+ my $page=pagename($file) if defined $type;
+
+ if ($change->{action} eq 'add') {
+ $newfiles{$file}=1;
+ }
+
+ if ($change->{action} eq 'change' ||
+ $change->{action} eq 'add') {
+ if (defined $page) {
+ check_canedit($page, $cgi, $session);
+ next;
+ }
+ else {
+ if (IkiWiki::Plugin::attachment->can("check_canattach")) {
+ IkiWiki::Plugin::attachment::check_canattach($session, $file, $change->{path});
+ check_canedit($file, $cgi, $session);
+ next;
+ }
+ }
+ }
+ elsif ($change->{action} eq 'remove') {
+ # check_canremove tests to see if the file is present
+ # on disk. This will fail when a single commit adds a
+ # file and then removes it again. Avoid the problem
+ # by not testing the removal in such pairs of changes.
+ # (The add is still tested, just to make sure that
+ # no data is added to the repo that a web edit
+ # could not add.)
+ next if $newfiles{$file};
+
+ if (IkiWiki::Plugin::remove->can("check_canremove")) {
+ IkiWiki::Plugin::remove::check_canremove(defined $page ? $page : $file, $cgi, $session);
+ check_canedit(defined $page ? $page : $file, $cgi, $session);
+ next;
+ }
+ }
+ else {
+ error "unknown action ".$change->{action};
+ }
+
+ error sprintf(gettext("you are not allowed to change %s"), $file);
+ }
+}
+
+
my $wikilock;
sub lockwiki () {
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);
}
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);
+ 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 $rev=shift;
+ my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
- 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");
- }
- }
+ return git_parse_changes(git_commit_info($sha1, 1));
+}
- push @rets, {
- file => $file,
- action => $action,
- path => $path,
- };
- }
- }
- }
+sub rcs_revert ($) {
+ # Try to revert the given rev; returns undef on _success_.
+ my $rev = shift;
+ my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
- return reverse @rets;
+ if (run_or_non('git', 'revert', '--no-commit', $sha1)) {
+ return undef;
+ }
+ else {
+ run_or_die('git', 'reset', '--hard');
+ return sprintf(gettext("Failed to revert commit %s"), $sha1);
+ }
}
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 sessioncgi ($$) {
+ my ($q, $session) = @_;
+ my $do = $q->param('do');
+ my $rev = $q->param('rev');
+
+ return unless $do eq 'revert' && $rev;
+
+ my @changes=$IkiWiki::hooks{rcs}{rcs_preprevert}{call}->($rev);
+ IkiWiki::check_canchange(
+ cgi => $q,
+ session => $session,
+ changes => \@changes,
+ );
+
+ eval q{use CGI::FormBuilder};
+ error($@) if $@;
+ my $form = 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') },
+ fields => [qw{revertmessage do sid rev}],
+ );
+ my $buttons=["Revert", "Cancel"];
+
+ $form->field(name => "revertmessage", type => "text", size => 80);
+ $form->field(name => "sid", type => "hidden", value => $session->id,
+ force => 1);
+ $form->field(name => "do", type => "hidden", value => "revert",
+ force => 1);
+
+ IkiWiki::decode_form_utf8($form);
+
+ if ($form->submitted eq 'Revert' && $form->validate) {
+ IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
+ my $message=sprintf(gettext("This reverts commit %s"), $rev);
+ if (defined $form->field('revertmessage') &&
+ length $form->field('revertmessage')) {
+ $message=$form->field('revertmessage')."\n\n".$message;
+ }
+ my $r = $IkiWiki::hooks{rcs}{rcs_revert}{call}->($rev);
+ error $r if defined $r;
+ IkiWiki::disable_commit_hook();
+ IkiWiki::rcs_commit_staged(
+ message => $message,
+ session => $session,
+ );
+ IkiWiki::enable_commit_hook();
+
+ require IkiWiki::Render;
+ IkiWiki::refresh();
+ IkiWiki::saveindex();
+ }
+ elsif ($form->submitted ne 'Cancel') {
+ $form->title(sprintf(gettext("confirm reversion of %s"), $rev));
+ $form->tmpl_param(diff => encode_entities(scalar IkiWiki::rcs_diff($rev)));
+ $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} &&
+ exists $IkiWiki::hooks{rcs}{rcs_preprevert} &&
+ exists $IkiWiki::hooks{rcs}{rcs_revert}) {
+ $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()) {
- # This untaint is safe because we check file_pruned and
- # wiki_file_regexp.
- my ($file)=$change->{file}=~/$config{wiki_file_regexp}/;
- $file=IkiWiki::possibly_foolish_untaint($file);
- if (! defined $file || ! length $file ||
- IkiWiki::file_pruned($file)) {
- error(gettext("bad file name %s"), $file);
- }
-
- my $type=pagetype($file);
- my $page=pagename($file) if defined $type;
-
- if ($change->{action} eq 'add') {
- $newfiles{$file}=1;
- }
-
- if ($change->{action} eq 'change' ||
- $change->{action} eq 'add') {
- if (defined $page) {
- IkiWiki::check_canedit($page, $cgi, $session);
- next;
- }
- else {
- if (IkiWiki::Plugin::attachment->can("check_canattach")) {
- IkiWiki::Plugin::attachment::check_canattach($session, $file, $change->{path});
- IkiWiki::check_canedit($file, $cgi, $session);
- next;
- }
- }
- }
- elsif ($change->{action} eq 'remove') {
- # check_canremove tests to see if the file is present
- # on disk. This will fail when a single commit adds a
- # file and then removes it again. Avoid the problem
- # by not testing the removal in such pairs of changes.
- # (The add is still tested, just to make sure that
- # no data is added to the repo that a web edit
- # could not add.)
- next if $newfiles{$file};
-
- if (IkiWiki::Plugin::remove->can("check_canremove")) {
- IkiWiki::Plugin::remove::check_canremove(defined $page ? $page : $file, $cgi, $session);
- IkiWiki::check_canedit(defined $page ? $page : $file, $cgi, $session);
- next;
- }
- }
- else {
- error "unknown action ".$change->{action};
- }
-
- error sprintf(gettext("you are not allowed to change %s"), $file);
- }
+ check_canchange(
+ cgi => $cgi,
+ session => $session,
+ changes => [IkiWiki::rcs_receive()]
+ );
exit 0;
}
* htmltidy: Allow configuring tidy parameters in setup file.
(W. Trevor King)
* Updated French program translation. Closes: #598918
+ * git: Added new rcs_revert and rcs_preprevert hooks.
+ * recentchanges: Add revert buttons to RecentChanges page, and
+ implement web-based reversion interface.
+ * Thanks to Peter Gammie for his assistance with the web-based reversion
+ feature.
-- Joey Hess <joeyh@debian.org> Wed, 29 Sep 2010 11:58:23 -0400
Perer Gammie and I are working on reversion over at [[todo/web_reversion]].
--[[Joey]]
+
+Update: Web reversion is now supported by ikiwiki. Only changes committed
+to your wiki after you upgrade to the version of ikiwiki that supports it
+will get revert buttons on the RecentChanges page. If you want to force
+adding buttons for older changes, you can delete `recentchanges/*._change`
+from your srcdir, and rebuild the wiki. --[[Joey]]
pages can be joined together with [[inline]] to generate the
[[RecentChanges]] page.
+This plugin also currently handles web-based reversion of changes.
+
Typically only the RecentChanges page will use the pages generated by this
plugin, but you can use it elsewhere too if you like. It's used like this:
This is used to get the page creation time for a file from the RCS, by looking
it up in the history.
-It's ok if this is not implemented, and throws an error.
-
If the RCS cannot determine a ctime for the file, return 0.
#### `rcs_getmtime($)`
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.
+
+It should try to revert the specified rev, and leave the reversion staged
+so `rcs_commit_staged` will complete it. It should return undef on _success_
+and an error message on failure.
+
+This hook and `rcs_preprevert` are optional, if not implemented, no revert
+web interface will be available.
+
### PageSpec plugins
It's also possible to write plugins that add new functions to
`rcs_diff` |yes |yes |yes |yes |no |yes |yes |yes
`rcs_getctime` |fast |slow |slow |slow |slow |slow |slow |slow
`rcs_getmtime` |fast |slow |slow |no |no |no |no |no
+`rcs_preprevert` |yes |no |no |no |no |no |no |no
+`rcs_revert` |yes |no |no |no |no |no |no |no
anonymous push |yes |no |no |no |no |no |no |no
conflict handling |yes |yes |yes |buggy |yes |yes |yes |yes
openid username |yes |no |no |no |no |no |no |no
width: 35%;
font-size: small;
}
-.recentchanges .pagelinks {
+.recentchanges .pagelinks,
+.recentchanges .revert {
float: right;
margin: 0;
width: 60%;
* `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"]]
> (The data from `rcs_preprevert` could also be used for a confirmation
> prompt -- it doesn't currently include enough info for diffs, but at
> least could have a list of changed files.)
->> I added `rcs_showpatch` which simply yields the output of `git show <patch-id>`. -- [[peteg]]
>
> Note that it's possible for a git repo to have commits that modify wiki
> files in a subdir, and code files elsewhere. `rcs_preprevert` should
>> Taken care of by refactoring `rcs_receive` in `git.pm`
>> I've tested it lightly in my single-user setup. It's a little nasty that the `attachment` plugin
>> gets used to check whether attachments are allowed -- there really should be a hook for that.
+>>> I agree, but have not figured out a way to make a hook work yet.
+>>> --[[Joey]]
>>
>> Please look it over and tell me what else needs fixing... -- [[peteg]]
>>> I have made my own revert branch and put a few fixes in there
>>> [[!template id=gitbranch branch=origin/revert author="[[joey]]"]]
->>> (and fixed all the indention..). Issues I noticed but have not gotten
->>> to: --[[Joey]]
+>>> (and fixed all the indention..). --[[Joey]]
>>>> Please change the git pointer above, then. I will work on your branch. -- [[peteg]]
->>>
->>> * `rcs_diff` already exists; why add `rcs_showpatch`?
->>>> If `rcs_diff` is intended for human consumption, by all means we can use that. -- [[peteg]]
->>> * Would it be better for `rcs_revert` to not commit, and
->>> `rcs_commit_staged` to then be used? This would work for git, but
->>> maybe other RCSs would be problimatic. It would simplifiy the
->>> interface and allow for future mulitple-revert interfaces.
->>> * I quite don't understand why one caller of `git_parse_changes`
->>> needs it to chdir, and not the other one. It's running
->>> in the same git repo either way, and git doesn't need
->>> `git show` to run in a subdir at all..
->>>> I was aping (preserving) what was already there. I don't understand what you say about `git show` - it must run under $srcdir, surely? And empirically the CGI process wasn't in the right place. By all means simplify that. -- [[peteg]]
-
->>> * Probably needs to untaint the revs passed in.
->>> * Seems backwards for `rcs_preprevert` to import and
->>> use `IkiWiki::Receive`.
->>>> Indeed. This is saying that the checking code in IkiWiki::Receive is in the wrong place. I think it would be better to set up some general hooks and shuffle it into a plugin, for then other plugins that maintain special files in the repo can have a say about validity. -- [[peteg]]
+[[done]]
<span class="desc"><br />Changed pages:</span>
<span class="pagelinks">
<TMPL_LOOP PAGES>
-<TMPL_IF DIFFURL><a href="<TMPL_VAR DIFFURL>">[[diff|wikiicons/diff.png]]</a><TMPL_VAR LINK>
-<TMPL_ELSE>
-<TMPL_VAR LINK>
-</TMPL_IF>
+<TMPL_IF DIFFURL><a href="<TMPL_VAR DIFFURL>" title="diff" rel="nofollow">[[diff|wikiicons/diff.png]]</a><TMPL_VAR LINK>
+<TMPL_ELSE><TMPL_VAR LINK></TMPL_IF>
</TMPL_LOOP>
</span>
<span class="desc"><br />Changed by:</span>
<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>
</div>
+<TMPL_IF REVERTURL>
+<span class="revert">
+<a href="<TMPL_VAR REVERTURL>" title="revert" rel="nofollow">[[revert|wikiicons/revert.png]]</a>
+</span>
+</TMPL_IF>
<div class="changelog">
<TMPL_LOOP MESSAGE>
<TMPL_IF LINE>
--- /dev/null
+<TMPL_VAR FORM-START>
+<div>
+ <TMPL_VAR FIELD-DO>
+ <TMPL_VAR FIELD-SID>
+ <TMPL_VAR FIELD-REV>
+<label for="revertmessage" class="block">Optional comment about this change:</label>
+ <TMPL_VAR FIELD-REVERTMESSAGE>
+</div>
+<div class="revert buttons">
+<TMPL_VAR form-submit>
+<TMPL_VAR form-cancel>
+</div>
+<TMPL_VAR FORM-END>
+<br \>
+<div class="header">
+<span>Diff being reverted:</span>
+</div>
+<div id="diff">
+<pre>
+<TMPL_VAR diff>
+</pre>
projects / ikiwiki.git / commitdiff
