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