Uncomment the CVS keyword substitution mode tests, and make them pass:
[ikiwiki.git] / IkiWiki / Plugin / cvs.pm
1 #!/usr/bin/perl
2 package IkiWiki::Plugin::cvs;
3
4 # Copyright (c) 2009 Amitai Schlair
5 # All rights reserved.
6 #
7 # This code is derived from software contributed to ikiwiki
8 # by Amitai Schlair.
9 #
10 # Redistribution and use in source and binary forms, with or without
11 # modification, are permitted provided that the following conditions
12 # are met:
13 # 1. Redistributions of source code must retain the above copyright
14 #    notice, this list of conditions and the following disclaimer.
15 # 2. Redistributions in binary form must reproduce the above copyright
16 #    notice, this list of conditions and the following disclaimer in the
17 #    documentation and/or other materials provided with the distribution.
18 #
19 # THIS SOFTWARE IS PROVIDED BY IKIWIKI AND CONTRIBUTORS ``AS IS''
20 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22 # PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION
23 # OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 # SUCH DAMAGE.
31
32 use warnings;
33 use strict;
34 use IkiWiki;
35
36 use File::chdir;
37
38
39 # GENERAL PLUGIN API CALLS
40
41 sub import {
42         hook(type => "checkconfig", id => "cvs", call => \&checkconfig);
43         hook(type => "getsetup", id => "cvs", call => \&getsetup);
44         hook(type => "genwrapper", id => "cvs", call => \&genwrapper);
45
46         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
47         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
48         hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
49         hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
50         hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
51         hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
52         hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
53         hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
54         hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
55         hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
56         hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
57 }
58
59 sub checkconfig () {
60         if (! defined $config{cvspath}) {
61                 $config{cvspath}="ikiwiki";
62         }
63         if (exists $config{cvspath}) {
64                 # code depends on the path not having extraneous slashes
65                 $config{cvspath}=~tr#/#/#s;
66                 $config{cvspath}=~s/\/$//;
67                 $config{cvspath}=~s/^\///;
68         }
69         if (defined $config{cvs_wrapper} && length $config{cvs_wrapper}) {
70                 push @{$config{wrappers}}, {
71                         wrapper => $config{cvs_wrapper},
72                         wrappermode => (defined $config{cvs_wrappermode} ? $config{cvs_wrappermode} : "04755"),
73                 };
74         }
75 }
76
77 sub getsetup () {
78         return
79                 plugin => {
80                         safe => 0, # rcs plugin
81                         rebuild => undef,
82                         section => "rcs",
83                 },
84                 cvsrepo => {
85                         type => "string",
86                         example => "/cvs/wikirepo",
87                         description => "cvs repository location",
88                         safe => 0, # path
89                         rebuild => 0,
90                 },
91                 cvspath => {
92                         type => "string",
93                         example => "ikiwiki",
94                         description => "path inside repository where the wiki is located",
95                         safe => 0, # paranoia
96                         rebuild => 0,
97                 },
98                 cvs_wrapper => {
99                         type => "string",
100                         example => "/cvs/wikirepo/CVSROOT/post-commit",
101                         description => "cvs post-commit hook to generate (triggered by CVSROOT/loginfo entry)",
102                         safe => 0, # file
103                         rebuild => 0,
104                 },
105                 cvs_wrappermode => {
106                         type => "string",
107                         example => '04755',
108                         description => "mode for cvs_wrapper (can safely be made suid)",
109                         safe => 0,
110                         rebuild => 0,
111                 },
112                 historyurl => {
113                         type => "string",
114                         example => "http://cvs.example.org/cvsweb.cgi/ikiwiki/[[file]]",
115                         description => "cvsweb url to show file history ([[file]] substituted)",
116                         safe => 1,
117                         rebuild => 1,
118                 },
119                 diffurl => {
120                         type => "string",
121                         example => "http://cvs.example.org/cvsweb.cgi/ikiwiki/[[file]].diff?r1=text&tr1=[[r1]]&r2=text&tr2=[[r2]]",
122                         description => "cvsweb url to show a diff ([[file]], [[r1]], and [[r2]] substituted)",
123                         safe => 1,
124                         rebuild => 1,
125                 },
126 }
127
128 sub genwrapper () {
129         return <<EOF;
130         {
131                 int j;
132                 for (j = 1; j < argc; j++)
133                         if (strstr(argv[j], "New directory") != NULL)
134                                 exit(0);
135         }
136 EOF
137 }
138
139
140 # VCS PLUGIN API CALLS
141
142 sub rcs_update () {
143         return unless cvs_is_controlling();
144         cvs_runcvs('update', '-dP');
145 }
146
147 sub rcs_prepedit ($) {
148         # Prepares to edit a file under revision control. Returns a token
149         # that must be passed into rcs_commit when the file is ready
150         # for committing.
151         # The file is relative to the srcdir.
152         my $file=shift;
153
154         return unless cvs_is_controlling();
155
156         # For cvs, return the revision of the file when
157         # editing begins.
158         my $rev=cvs_info("Repository revision", "$file");
159         return defined $rev ? $rev : "";
160 }
161
162 sub rcs_commit (@) {
163         # Tries to commit the page; returns undef on _success_ and
164         # a version of the page with the rcs's conflict markers on failure.
165         # The file is relative to the srcdir.
166         my %params=@_;
167
168         return unless cvs_is_controlling();
169
170         # Check to see if the page has been changed by someone
171         # else since rcs_prepedit was called.
172         my ($oldrev)=$params{token}=~/^([0-9]+)$/; # untaint
173         my $rev=cvs_info("Repository revision", "$config{srcdir}/$params{file}");
174         if (defined $rev && defined $oldrev && $rev != $oldrev) {
175                 # Merge their changes into the file that we've
176                 # changed.
177                 cvs_runcvs('update', $params{file}) ||
178                         warn("cvs merge from $oldrev to $rev failed\n");
179         }
180
181         if (! cvs_runcvs('commit', '-m',
182                          IkiWiki::possibly_foolish_untaint(commitmessage(%params)))) {
183                 my $conflict=readfile("$config{srcdir}/$params{file}");
184                 cvs_runcvs('update', '-C', $params{file}) ||
185                         warn("cvs revert failed\n");
186                 return $conflict;
187         }
188
189         return undef # success
190 }
191
192 sub rcs_commit_staged (@) {
193         # Commits all staged changes. Changes can be staged using rcs_add,
194         # rcs_remove, and rcs_rename.
195         my %params=@_;
196
197         if (! cvs_runcvs('commit', '-m',
198                          IkiWiki::possibly_foolish_untaint(commitmessage(%params)))) {
199                 warn "cvs staged commit failed\n";
200                 return 1; # failure
201         }
202         return undef # success
203 }
204
205 sub cvs_keyword_subst_args ($) {
206         my $file = shift;
207
208         local $CWD = $config{srcdir};
209
210         eval q{use File::MimeInfo};
211         error($@) if $@;
212         my $filemime = File::MimeInfo::default($file);
213         # if (-T $file) {
214
215         if (defined($filemime) && $filemime eq 'text/plain') {
216                 return ($file);
217         }
218         else {
219                 return ('-kb', $file);
220         }
221 }
222
223 sub rcs_add ($) {
224         # filename is relative to the root of the srcdir
225         my $file=shift;
226         my $parent=IkiWiki::dirname($file);
227         my @files_to_add = ($file);
228
229         until ((length($parent) == 0) || cvs_is_controlling("$config{srcdir}/$parent")){
230                 push @files_to_add, $parent;
231                 $parent = IkiWiki::dirname($parent);
232         }
233
234         while ($file = pop @files_to_add) {
235                 if (@files_to_add == 0) {
236                         # file
237                         cvs_runcvs('add', cvs_keyword_subst_args($file)) ||
238                                 warn("cvs add $file failed\n");
239                 }
240                 else {
241                         # directory
242                         cvs_runcvs('add', $file) ||
243                                 warn("cvs add $file failed\n");
244                 }
245         }
246 }
247
248 sub rcs_remove ($) {
249         # filename is relative to the root of the srcdir
250         my $file=shift;
251
252         return unless cvs_is_controlling();
253
254         cvs_runcvs('rm', '-f', $file) ||
255                 warn("cvs rm $file failed\n");
256 }
257
258 sub rcs_rename ($$) {
259         # filenames relative to the root of the srcdir
260         my ($src, $dest)=@_;
261
262         return unless cvs_is_controlling();
263
264         local $CWD = $config{srcdir};
265
266         if (system("mv", "$src", "$dest") != 0) {
267                 warn("filesystem rename failed\n");
268         }
269
270         rcs_add($dest);
271         rcs_remove($src);
272 }
273
274 sub rcs_recentchanges ($) {
275         my $num = shift;
276         my @ret;
277
278         return unless cvs_is_controlling();
279
280         eval q{use Date::Parse};
281         error($@) if $@;
282
283         local $CWD = $config{srcdir};
284
285         # There's no cvsps option to get the last N changesets.
286         # Write full output to a temp file and read backwards.
287
288         eval q{use File::Temp qw/tempfile/};
289         error($@) if $@;
290         eval q{use File::ReadBackwards};
291         error($@) if $@;
292
293         my ($tmphandle, $tmpfile) = tempfile();
294         system("env TZ=UTC cvsps -q --cvs-direct -z 30 -x >$tmpfile");
295         if ($? == -1) {
296                 error "couldn't run cvsps: $!\n";
297         }
298         elsif (($? >> 8) != 0) {
299                 error "cvsps exited " . ($? >> 8) . ": $!\n";
300         }
301
302         tie(*SPSVC, 'File::ReadBackwards', $tmpfile)
303                 || error "couldn't open $tmpfile for read: $!\n";
304
305         while (my $line = <SPSVC>) {
306                 $line =~ /^$/ || error "expected blank line, got $line";
307
308                 my ($rev, $user, $committype, $when);
309                 my (@message, @pages);
310
311                 # We're reading backwards.
312                 # Forwards, an entry looks like so:
313                 # ---------------------
314                 # PatchSet $rev
315                 # Date: $when
316                 # Author: $user (or user CGI runs as, for web commits)
317                 # Branch: branch
318                 # Tag: tag
319                 # Log:
320                 # @message_lines
321                 # Members:
322                 #       @pages (and revisions)
323                 #
324
325                 while ($line = <SPSVC>) {
326                         last if ($line =~ /^Members:/);
327                         for ($line) {
328                                 s/^\s+//;
329                                 s/\s+$//;
330                         }
331                         my ($page, $revs) = split(/:/, $line);
332                         my ($oldrev, $newrev) = split(/->/, $revs);
333                         $oldrev =~ s/INITIAL/0/;
334                         $newrev =~ s/\(DEAD\)//;
335                         my $diffurl = defined $config{diffurl} ? $config{diffurl} : "";
336                         $diffurl=~s/\[\[file\]\]/$page/g;
337                         $diffurl=~s/\[\[r1\]\]/$oldrev/g;
338                         $diffurl=~s/\[\[r2\]\]/$newrev/g;
339                         unshift @pages, {
340                                 page => pagename($page),
341                                 diffurl => $diffurl,
342                         } if length $page;
343                 }
344
345                 while ($line = <SPSVC>) {
346                         last if ($line =~ /^Log:$/);
347                         chomp $line;
348                         unshift @message, { line => $line };
349                 }
350                 $committype = "web";
351                 if (defined $message[0] &&
352                     $message[0]->{line}=~/$config{web_commit_regexp}/) {
353                         $user=defined $2 ? "$2" : "$3";
354                         $message[0]->{line}=$4;
355                 }
356                 else {
357                         $committype="cvs";
358                 }
359
360                 $line = <SPSVC>;        # Tag
361                 $line = <SPSVC>;        # Branch
362
363                 $line = <SPSVC>;
364                 if ($line =~ /^Author: (.*)$/) {
365                         $user = $1 unless defined $user && length $user;
366                 }
367                 else {
368                         error "expected Author, got $line";
369                 }
370
371                 $line = <SPSVC>;
372                 if ($line =~ /^Date: (.*)$/) {
373                         $when = str2time($1, 'UTC');
374                 }
375                 else {
376                         error "expected Date, got $line";
377                 }
378
379                 $line = <SPSVC>;
380                 if ($line =~ /^PatchSet (.*)$/) {
381                         $rev = $1;
382                 }
383                 else {
384                         error "expected PatchSet, got $line";
385                 }
386
387                 $line = <SPSVC>;        # ---------------------
388
389                 push @ret, {
390                         rev => $rev,
391                         user => $user,
392                         committype => $committype,
393                         when => $when,
394                         message => [@message],
395                         pages => [@pages],
396                 } if @pages;
397                 last if @ret >= $num;
398         }
399
400         unlink($tmpfile) || error "couldn't unlink $tmpfile: $!\n";
401
402         return @ret;
403 }
404
405 sub rcs_diff ($;$) {
406         my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
407         my $maxlines=shift;
408
409         local $CWD = $config{srcdir};
410
411         # diff output is unavoidably preceded by the cvsps PatchSet entry
412         my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;
413         my $blank_lines_seen = 0;
414
415         while (my $line = shift @cvsps) {
416                 $blank_lines_seen++ if ($line =~ /^$/);
417                 last if $blank_lines_seen == 2;
418         }
419
420         if (wantarray) {
421                 return @cvsps;
422         }
423         else {
424                 return join("", @cvsps);
425         }
426 }
427
428 sub rcs_getctime ($) {
429         my $file=shift;
430
431         local $CWD = $config{srcdir};
432
433         my $cvs_log_infoline=qr/^date: (.+);\s+author/;
434
435         open CVSLOG, "cvs -Q log -r1.1 '$file' |"
436                 || error "couldn't get cvs log output: $!\n";
437
438         my $date;
439         while (<CVSLOG>) {
440                 if (/$cvs_log_infoline/) {
441                         $date=$1;
442                 }
443         }
444         close CVSLOG || warn "cvs log $file exited $?";
445
446         if (! defined $date) {
447                 warn "failed to parse cvs log for $file\n";
448                 return 0;
449         }
450
451         eval q{use Date::Parse};
452         error($@) if $@;
453         $date=str2time($date, 'UTC');
454         debug("found ctime ".localtime($date)." for $file");
455         return $date;
456 }
457
458 sub rcs_getmtime ($) {
459         error "rcs_getmtime is not implemented for cvs\n"; # TODO
460 }
461
462
463 # INTERNAL SUPPORT ROUTINES
464
465 sub commitmessage (@) {
466         my %params=@_;
467
468         if (defined $params{session}) {
469                 if (defined $params{session}->param("name")) {
470                         return "web commit by ".
471                                 $params{session}->param("name").
472                                 (length $params{message} ? ": $params{message}" : "");
473                 }
474                 elsif (defined $params{session}->remote_addr()) {
475                         return "web commit from ".
476                                 $params{session}->remote_addr().
477                                 (length $params{message} ? ": $params{message}" : "");
478                 }
479         }
480         return $params{message};
481 }
482
483 sub cvs_info ($$) {
484         my $field=shift;
485         my $file=shift;
486
487         local $CWD = $config{srcdir};
488
489         my $info=`cvs status $file`;
490         my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
491         return $ret;
492 }
493
494 sub cvs_is_controlling {
495         my $dir=shift;
496         $dir=$config{srcdir} unless defined($dir);
497         return (-d "$dir/CVS") ? 1 : 0;
498 }
499
500 sub cvs_runcvs(@) {
501         my @cmd = @_;
502         unshift @cmd, 'cvs', '-Q';
503
504         local $CWD = $config{srcdir};
505
506         open(my $savedout, ">&STDOUT");
507         open(STDOUT, ">", "/dev/null");
508         my $ret = system(@cmd);
509         open(STDOUT, ">&", $savedout);
510
511         return ($ret == 0) ? 1 : 0;
512 }
513
514 1