Merge commit 'schmonz/master' into cvs
[ikiwiki.git] / IkiWiki / Plugin / cvs.pm
1 #!/usr/pkg/bin/perl
2 package IkiWiki::Plugin::cvs;
3
4 use warnings;
5 use strict;
6 use IkiWiki;
7
8 use File::chdir;
9
10 sub import {
11         hook(type => "wrapperargcheck", id => "cvs", call => \&wrapperargcheck);
12         hook(type => "checkconfig", id => "cvs", call => \&checkconfig);
13         hook(type => "getsetup", id => "cvs", call => \&getsetup);
14         hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
15         hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
16         hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
17         hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
18         hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
19         hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
20         hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
21         hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
22         hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
23         hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
24 }
25
26 sub wrapperargcheck () {
27         my $check_args=<<"EOF";
28         int j;
29         for (j = 1; j < argc; j++)
30                 if (strstr(argv[j], "New directory") != NULL)
31                         return 0;
32         return 1;
33 EOF
34         return $check_args;
35 }
36
37 sub checkconfig () {
38         if (! defined $config{cvspath}) {
39                 $config{cvspath}="ikiwiki";
40         }
41         if (exists $config{cvspath}) {
42                 # code depends on the path not having extraneous slashes
43                 $config{cvspath}=~tr#/#/#s;
44                 $config{cvspath}=~s/\/$//;
45                 $config{cvspath}=~s/^\///;
46         }
47         if (defined $config{cvs_wrapper} && length $config{cvs_wrapper}) {
48                 push @{$config{wrappers}}, {
49                         wrapper => $config{cvs_wrapper},
50                         wrappermode => (defined $config{cvs_wrappermode} ? $config{cvs_wrappermode} : "04755"),
51                 };
52         }
53 }
54
55 sub getsetup () {
56         return
57                 plugin => {
58                         safe => 0, # rcs plugin
59                         rebuild => undef,
60                 },
61                 cvsrepo => {
62                         type => "string",
63                         example => "/cvs/wikirepo",
64                         description => "cvs repository location",
65                         safe => 0, # path
66                         rebuild => 0,
67                 },
68                 cvspath => {
69                         type => "string",
70                         example => "ikiwiki",
71                         description => "path inside repository where the wiki is located",
72                         safe => 0, # paranoia
73                         rebuild => 0,
74                 },
75                 cvs_wrapper => {
76                         type => "string",
77                         example => "/cvs/wikirepo/CVSROOT/post-commit",
78                         description => "cvs post-commit hook to generate (triggered by CVSROOT/loginfo entry)",
79                         safe => 0, # file
80                         rebuild => 0,
81                 },
82                 cvs_wrappermode => {
83                         type => "string",
84                         example => '04755',
85                         description => "mode for cvs_wrapper (can safely be made suid)",
86                         safe => 0,
87                         rebuild => 0,
88                 },
89                 historyurl => {
90                         type => "string",
91                         example => "http://cvs.example.org/cvsweb.cgi/ikiwiki/[[file]]",
92                         description => "cvsweb url to show file history ([[file]] substituted)",
93                         safe => 1,
94                         rebuild => 1,
95                 },
96                 diffurl => {
97                         type => "string",
98                         example => "http://cvs.example.org/cvsweb.cgi/ikiwiki/[[file]].diff?r1=text&amp;tr1=[[r1]]&amp;r2=text&amp;tr2=[[r2]]",
99                         description => "cvsweb url to show a diff ([[file]], [[r1]], and [[r2]] substituted)",
100                         safe => 1,
101                         rebuild => 1,
102                 },
103 }
104
105 sub cvs_info ($$) {
106         my $field=shift;
107         my $file=shift;
108
109         local $CWD = $config{srcdir};
110
111         my $info=`cvs status $file`;
112         my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
113         return $ret;
114 }
115
116 sub cvs_runcvs(@) {
117         my @cmd = @_;
118         unshift @cmd, 'cvs', '-Q';
119
120         local $CWD = $config{srcdir};
121
122         open(my $savedout, ">&STDOUT");
123         open(STDOUT, ">", "/dev/null");
124         my $ret = system(@cmd);
125         open(STDOUT, ">&", $savedout);
126
127         return ($ret == 0) ? 1 : 0;
128 }
129
130 sub cvs_is_controlling {
131         my $dir=shift;
132         $dir=$config{srcdir} unless defined($dir);
133         return (-d "$dir/CVS") ? 1 : 0;
134 }
135
136 sub rcs_update () {
137         return unless cvs_is_controlling;
138         cvs_runcvs('update', '-dP');
139 }
140
141 sub rcs_prepedit ($) {
142         # Prepares to edit a file under revision control. Returns a token
143         # that must be passed into rcs_commit when the file is ready
144         # for committing.
145         # The file is relative to the srcdir.
146         my $file=shift;
147
148         return unless cvs_is_controlling;
149
150         # For cvs, return the revision of the file when
151         # editing begins.
152         my $rev=cvs_info("Repository revision", "$file");
153         return defined $rev ? $rev : "";
154 }
155
156 sub rcs_commit ($$$;$$) {
157         # Tries to commit the page; returns undef on _success_ and
158         # a version of the page with the rcs's conflict markers on failure.
159         # The file is relative to the srcdir.
160         my $file=shift;
161         my $message=shift;
162         my $rcstoken=shift;
163         my $user=shift;
164         my $ipaddr=shift;
165
166         return unless cvs_is_controlling;
167
168         if (defined $user) {
169                 $message="web commit by $user".(length $message ? ": $message" : "");
170         }
171         elsif (defined $ipaddr) {
172                 $message="web commit from $ipaddr".(length $message ? ": $message" : "");
173         }
174
175         # Check to see if the page has been changed by someone
176         # else since rcs_prepedit was called.
177         my ($oldrev)=$rcstoken=~/^([0-9]+)$/; # untaint
178         my $rev=cvs_info("Repository revision", "$config{srcdir}/$file");
179         if (defined $rev && defined $oldrev && $rev != $oldrev) {
180                 # Merge their changes into the file that we've
181                 # changed.
182                 cvs_runcvs('update', $file) ||
183                         warn("cvs merge from $oldrev to $rev failed\n");
184         }
185
186         if (! cvs_runcvs('commit', '-m',
187                          IkiWiki::possibly_foolish_untaint $message)) {
188                 my $conflict=readfile("$config{srcdir}/$file");
189                 cvs_runcvs('update', '-C', $file) ||
190                         warn("cvs revert failed\n");
191                 return $conflict;
192         }
193
194         return undef # success
195 }
196
197 sub rcs_commit_staged ($$$) {
198         # Commits all staged changes. Changes can be staged using rcs_add,
199         # rcs_remove, and rcs_rename.
200         my ($message, $user, $ipaddr)=@_;
201
202         if (defined $user) {
203                 $message="web commit by $user".(length $message ? ": $message" : "");
204         }
205         elsif (defined $ipaddr) {
206                 $message="web commit from $ipaddr".(length $message ? ": $message" : "");
207         }
208
209         if (! cvs_runcvs('commit', '-m',
210                          IkiWiki::possibly_foolish_untaint $message)) {
211                 warn "cvs staged commit failed\n";
212                 return 1; # failure
213         }
214         return undef # success
215 }
216
217 sub rcs_add ($) {
218         # filename is relative to the root of the srcdir
219         my $file=shift;
220         my $parent=IkiWiki::dirname($file);
221         my @files_to_add = ($file);
222
223         eval q{use File::MimeInfo};
224         error($@) if $@;
225
226         until ((length($parent) == 0) || cvs_is_controlling("$config{srcdir}/$parent")){
227                 push @files_to_add, $parent;
228                 $parent = IkiWiki::dirname($parent);
229         }
230
231         while ($file = pop @files_to_add) {
232                 if (@files_to_add == 0) {
233                         # file
234                         my $filemime = File::MimeInfo::default($file);
235                         if (defined($filemime) && $filemime eq 'text/plain') {
236                                 cvs_runcvs('add', $file) ||
237                                         warn("cvs add $file failed\n");
238                         }
239                         else {
240                                 cvs_runcvs('add', '-kb', $file) ||
241                                         warn("cvs add binary $file failed\n");
242                         }
243                 }
244                 else {
245                         # directory
246                         cvs_runcvs('add', $file) ||
247                                 warn("cvs add $file failed\n");
248                 }
249         }
250 }
251
252 sub rcs_remove ($) {
253         # filename is relative to the root of the srcdir
254         my $file=shift;
255
256         return unless cvs_is_controlling;
257
258         cvs_runcvs('rm', '-f', $file) ||
259                 warn("cvs rm $file failed\n");
260 }
261
262 sub rcs_rename ($$) {
263         # filenames relative to the root of the srcdir
264         my ($src, $dest)=@_;
265
266         return unless cvs_is_controlling;
267
268         local $CWD = $config{srcdir};
269
270         if (system("mv", "$src", "$dest") != 0) {
271                 warn("filesystem rename failed\n");
272         }
273
274         rcs_add($dest);
275         rcs_remove($src);
276 }
277
278 sub rcs_recentchanges($) {
279         my $num = shift;
280         my @ret;
281
282         return unless cvs_is_controlling;
283
284         eval q{use Date::Parse};
285         error($@) if $@;
286
287         local $CWD = $config{srcdir};
288
289         # There's no cvsps option to get the last N changesets.
290         # Write full output to a temp file and read backwards.
291
292         eval q{use File::Temp qw/tempfile/};
293         error($@) if $@;
294         eval q{use File::ReadBackwards};
295         error($@) if $@;
296
297         my (undef, $tmpfile) = tempfile(OPEN=>0);
298         system("env TZ=UTC cvsps -q --cvs-direct -z 30 -x >$tmpfile");
299         if ($? == -1) {
300                 error "couldn't run cvsps: $!\n";
301         } elsif (($? >> 8) != 0) {
302                 error "cvsps exited " . ($? >> 8) . ": $!\n";
303         }
304
305         tie(*SPSVC, 'File::ReadBackwards', $tmpfile)
306                 || error "couldn't open $tmpfile for read: $!\n";
307
308         while (my $line = <SPSVC>) {
309                 $line =~ /^$/ || error "expected blank line, got $line";
310
311                 my ($rev, $user, $committype, $when);
312                 my (@message, @pages);
313
314                 # We're reading backwards.
315                 # Forwards, an entry looks like so:
316                 # ---------------------
317                 # PatchSet $rev
318                 # Date: $when
319                 # Author: $user (or user CGI runs as, for web commits)
320                 # Branch: branch
321                 # Tag: tag
322                 # Log:
323                 # @message_lines
324                 # Members:
325                 #       @pages (and revisions)
326                 #
327
328                 while ($line = <SPSVC>) {
329                         last if ($line =~ /^Members:/);
330                         for ($line) {
331                                 s/^\s+//;
332                                 s/\s+$//;
333                         }
334                         my ($page, $revs) = split(/:/, $line);
335                         my ($oldrev, $newrev) = split(/->/, $revs);
336                         $oldrev =~ s/INITIAL/0/;
337                         $newrev =~ s/\(DEAD\)//;
338                         my $diffurl = defined $config{diffurl} ? $config{diffurl} : "";
339                         $diffurl=~s/\[\[file\]\]/$page/g;
340                         $diffurl=~s/\[\[r1\]\]/$oldrev/g;
341                         $diffurl=~s/\[\[r2\]\]/$newrev/g;
342                         unshift @pages, {
343                                 page => pagename($page),
344                                 diffurl => $diffurl,
345                         } if length $page;
346                 }
347
348                 while ($line = <SPSVC>) {
349                         last if ($line =~ /^Log:$/);
350                         chomp $line;
351                         unshift @message, { line => $line };
352                 }
353                 $committype = "web";
354                 if (defined $message[0] &&
355                     $message[0]->{line}=~/$config{web_commit_regexp}/) {
356                         $user=defined $2 ? "$2" : "$3";
357                         $message[0]->{line}=$4;
358                 }
359                 else {
360                         $committype="cvs";
361                 }
362
363                 $line = <SPSVC>;        # Tag
364                 $line = <SPSVC>;        # Branch
365
366                 $line = <SPSVC>;
367                 if ($line =~ /^Author: (.*)$/) {
368                         $user = $1 unless defined $user && length $user;
369                 }
370                 else {
371                         error "expected Author, got $line";
372                 }
373
374                 $line = <SPSVC>;
375                 if ($line =~ /^Date: (.*)$/) {
376                         $when = str2time($1, 'UTC');
377                 }
378                 else {
379                         error "expected Date, got $line";
380                 }
381
382                 $line = <SPSVC>;
383                 if ($line =~ /^PatchSet (.*)$/) {
384                         $rev = $1;
385                 }
386                 else {
387                         error "expected PatchSet, got $line";
388                 }
389
390                 $line = <SPSVC>;        # ---------------------
391
392                 push @ret, {
393                         rev => $rev,
394                         user => $user,
395                         committype => $committype,
396                         when => $when,
397                         message => [@message],
398                         pages => [@pages],
399                 } if @pages;
400                 last if @ret >= $num;
401         }
402
403         unlink($tmpfile) || error "couldn't unlink $tmpfile: $!\n";
404
405         return @ret;
406 }
407
408 sub rcs_diff ($) {
409         my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
410
411         local $CWD = $config{srcdir};
412
413         # diff output is unavoidably preceded by the cvsps PatchSet entry
414         my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;
415         my $blank_lines_seen = 0;
416
417         while (my $line = shift @cvsps) {
418                 $blank_lines_seen++ if ($line =~ /^$/);
419                 last if $blank_lines_seen == 2;
420         }
421
422         if (wantarray) {
423                 return @cvsps;
424         }
425         else {
426                 return join("", @cvsps);
427         }
428 }
429
430 sub rcs_getctime ($) {
431         my $file=shift;
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 1