2 package IkiWiki::Plugin::cvs;
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);
24 if (! defined $config{cvspath}) {
25 $config{cvspath}="ikiwiki";
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/^\///;
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"),
44 safe => 0, # rcs plugin
49 example => "/cvs/wikirepo",
50 description => "cvs repository location",
57 description => "path inside repository where the wiki is located",
63 example => "/cvs/wikirepo/CVSROOT/post-commit",
64 description => "cvs post-commit hook to generate (triggered by CVSROOT/loginfo entry)",
71 description => "mode for cvs_wrapper (can safely be made suid)",
77 example => "http://cvs.example.org/cvsweb.cgi/ikiwiki/[[file]]",
78 description => "cvsweb url to show file history ([[file]] substituted)",
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)",
95 chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
97 my $info=`cvs status $file`;
98 my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
104 unshift @$cmd, 'cvs', '-Q';
106 eval q{use IPC::Cmd};
109 chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
111 my ($success, $error_code, $full_buf, $stdout_buf, $stderr_buf) =
112 IPC::Cmd::run(command => $cmd, verbose => 0);
114 warn(join(" ", @$cmd) . " exited with code $error_code\n");
115 warn(join "", @$stderr_buf);
120 sub cvs_shquote_commit ($) {
122 my $test_message = "CVS autodiscover quoting CVS";
124 eval q{use String::ShellQuote};
126 eval q{use IPC::Cmd};
129 my $cmd = ['echo', shell_quote($test_message)];
130 my ($success, $error_code, $full_buf, $stdout_buf, $stderr_buf) =
131 IPC::Cmd::run(command => $cmd, verbose => 0);
132 if ((grep /'$test_message'/, @$stdout_buf) > 0) {
133 return IkiWiki::possibly_foolish_untaint($message);
136 return shell_quote(IkiWiki::possibly_foolish_untaint($message));
140 sub cvs_is_controlling {
142 $dir=$config{srcdir} unless defined($dir);
143 return (-d "$dir/CVS") ? 1 : 0;
147 return unless cvs_is_controlling;
148 cvs_runcvs(['update', '-dP']);
151 sub rcs_prepedit ($) {
152 # Prepares to edit a file under revision control. Returns a token
153 # that must be passed into rcs_commit when the file is ready
155 # The file is relative to the srcdir.
158 return unless cvs_is_controlling;
160 # For cvs, return the revision of the file when
162 my $rev=cvs_info("Repository revision", "$file");
163 return defined $rev ? $rev : "";
166 sub rcs_commit ($$$;$$) {
167 # Tries to commit the page; returns undef on _success_ and
168 # a version of the page with the rcs's conflict markers on failure.
169 # The file is relative to the srcdir.
176 return unless cvs_is_controlling;
179 $message="web commit by $user".(length $message ? ": $message" : "");
181 elsif (defined $ipaddr) {
182 $message="web commit from $ipaddr".(length $message ? ": $message" : "");
185 # Check to see if the page has been changed by someone
186 # else since rcs_prepedit was called.
187 my ($oldrev)=$rcstoken=~/^([0-9]+)$/; # untaint
188 my $rev=cvs_info("Repository revision", "$config{srcdir}/$file");
189 if (defined $rev && defined $oldrev && $rev != $oldrev) {
190 # Merge their changes into the file that we've
192 cvs_runcvs(['update', $file]) ||
193 warn("cvs merge from $oldrev to $rev failed\n");
196 if (! cvs_runcvs(['commit', '-m', cvs_shquote_commit $message])) {
197 my $conflict=readfile("$config{srcdir}/$file");
198 cvs_runcvs(['update', '-C', $file]) ||
199 warn("cvs revert failed\n");
203 return undef # success
206 sub rcs_commit_staged ($$$) {
207 # Commits all staged changes. Changes can be staged using rcs_add,
208 # rcs_remove, and rcs_rename.
209 my ($message, $user, $ipaddr)=@_;
212 $message="web commit by $user".(length $message ? ": $message" : "");
214 elsif (defined $ipaddr) {
215 $message="web commit from $ipaddr".(length $message ? ": $message" : "");
218 if (! cvs_runcvs(['commit', '-m', cvs_shquote_commit $message])) {
219 warn "cvs staged commit failed\n";
222 return undef # success
226 # filename is relative to the root of the srcdir
228 my $parent=IkiWiki::dirname($file);
229 my @files_to_add = ($file);
231 eval q{use File::MimeInfo};
234 until ((length($parent) == 0) || cvs_is_controlling("$config{srcdir}/$parent")){
235 push @files_to_add, $parent;
236 $parent = IkiWiki::dirname($parent);
239 while ($file = pop @files_to_add) {
240 if (@files_to_add == 0) {
242 my $filemime = File::MimeInfo::default($file);
243 if (defined($filemime) && $filemime eq 'text/plain') {
244 cvs_runcvs(['add', $file]) ||
245 warn("cvs add $file failed\n");
248 cvs_runcvs(['add', '-kb', $file]) ||
249 warn("cvs add binary $file failed\n");
254 cvs_runcvs(['add', $file]) ||
255 warn("cvs add $file failed\n");
261 # filename is relative to the root of the srcdir
264 return unless cvs_is_controlling;
266 cvs_runcvs(['rm', '-f', $file]) ||
267 warn("cvs rm $file failed\n");
270 sub rcs_rename ($$) {
271 # filenames relative to the root of the srcdir
274 return unless cvs_is_controlling;
276 chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
278 if (system("mv", "$src", "$dest") != 0) {
279 warn("filesystem rename failed\n");
286 sub rcs_recentchanges($) {
290 return unless cvs_is_controlling;
292 eval q{use Date::Parse};
295 chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
297 # There's no cvsps option to get the last N changesets.
298 # Write full output to a temp file and read backwards.
300 eval q{use File::Temp qw/tempfile/};
302 eval q{use File::ReadBackwards};
305 my (undef, $tmpfile) = tempfile(OPEN=>0);
306 system("env TZ=UTC cvsps -q --cvs-direct -z 30 -x >$tmpfile");
308 error "couldn't run cvsps: $!\n";
309 } elsif (($? >> 8) != 0) {
310 error "cvsps exited " . ($? >> 8) . ": $!\n";
313 tie(*SPSVC, 'File::ReadBackwards', $tmpfile)
314 || error "couldn't open $tmpfile for read: $!\n";
316 while (my $line = <SPSVC>) {
317 $line =~ /^$/ || error "expected blank line, got $line";
319 my ($rev, $user, $committype, $when);
320 my (@message, @pages);
322 # We're reading backwards.
323 # Forwards, an entry looks like so:
324 # ---------------------
327 # Author: $user (or user CGI runs as, for web commits)
333 # @pages (and revisions)
336 while ($line = <SPSVC>) {
337 last if ($line =~ /^Members:/);
342 my ($page, $revs) = split(/:/, $line);
343 my ($oldrev, $newrev) = split(/->/, $revs);
344 $oldrev =~ s/INITIAL/0/;
345 $newrev =~ s/\(DEAD\)//;
346 my $diffurl = defined $config{diffurl} ? $config{diffurl} : "";
347 $diffurl=~s/\[\[file\]\]/$page/g;
348 $diffurl=~s/\[\[r1\]\]/$oldrev/g;
349 $diffurl=~s/\[\[r2\]\]/$newrev/g;
351 page => pagename($page),
356 while ($line = <SPSVC>) {
357 last if ($line =~ /^Log:$/);
359 unshift @message, { line => $line };
362 if (defined $message[0] &&
363 $message[0]->{line}=~/$config{web_commit_regexp}/) {
364 $user=defined $2 ? "$2" : "$3";
365 $message[0]->{line}=$4;
371 $line = <SPSVC>; # Tag
372 $line = <SPSVC>; # Branch
375 if ($line =~ /^Author: (.*)$/) {
376 $user = $1 unless defined $user && length $user;
379 error "expected Author, got $line";
383 if ($line =~ /^Date: (.*)$/) {
384 $when = str2time($1, 'UTC');
387 error "expected Date, got $line";
391 if ($line =~ /^PatchSet (.*)$/) {
395 error "expected PatchSet, got $line";
398 $line = <SPSVC>; # ---------------------
403 committype => $committype,
405 message => [@message],
408 last if @ret >= $num;
411 unlink($tmpfile) || error "couldn't unlink $tmpfile: $!\n";
417 my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
419 chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
421 # diff output is unavoidably preceded by the cvsps PatchSet entry
422 my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;
423 my $blank_lines_seen = 0;
425 while (my $line = shift @cvsps) {
426 $blank_lines_seen++ if ($line =~ /^$/);
427 last if $blank_lines_seen == 2;
434 return join("", @cvsps);
438 sub rcs_getctime ($) {
441 my $cvs_log_infoline=qr/^date: (.+);\s+author/;
443 open CVSLOG, "cvs -Q log -r1.1 '$file' |"
444 || error "couldn't get cvs log output: $!\n";
448 if (/$cvs_log_infoline/) {
452 close CVSLOG || warn "cvs log $file exited $?";
454 if (! defined $date) {
455 warn "failed to parse cvs log for $file\n";
459 eval q{use Date::Parse};
461 $date=str2time($date, 'UTC');
462 debug("found ctime ".localtime($date)." for $file");