Comments (maybe not so helpful - sorry)

[git.ikiwiki.info.git] / IkiWiki / Plugin / cvs.pm

diff --git a/IkiWiki/Plugin/cvs.pm b/IkiWiki/Plugin/cvs.pm
index 66e9463be562a515b1c7665adb97e6bf6245d75b..f6db8bc98b0f723feb40363eb7978ffc469c9ab9 100644 (file)
--- a/IkiWiki/Plugin/cvs.pm
+++ b/IkiWiki/Plugin/cvs.pm
@@ -1,11 +1,42 @@
-#!/usr/pkg/bin/perl
+#!/usr/bin/perl

 package IkiWiki::Plugin::cvs;
 
 package IkiWiki::Plugin::cvs;
 

+# Copyright (c) 2009 Amitai Schlair
+# All rights reserved.
+#
+# This code is derived from software contributed to ikiwiki
+# by Amitai Schlair.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY IKIWIKI AND CONTRIBUTORS ``AS IS''
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION
+# OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+

 use warnings;
 use strict;
 use IkiWiki;
 
 use warnings;
 use strict;
 use IkiWiki;
 

+use File::chdir;
+

 sub import {
 sub import {

+       hook(type => "genwrapper", id => "cvs", call => \&genwrapper);

        hook(type => "checkconfig", id => "cvs", call => \&checkconfig);
        hook(type => "getsetup", id => "cvs", call => \&getsetup);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "checkconfig", id => "cvs", call => \&checkconfig);
        hook(type => "getsetup", id => "cvs", call => \&getsetup);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);


@@ -20,6 +51,17 @@ sub import {
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
 }
 
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
 }
 

+sub genwrapper () {
+       return <<EOF;
+       {
+               int j;
+               for (j = 1; j < argc; j++)
+                       if (strstr(argv[j], "New directory") != NULL)
+                               exit(0);
+       }
+EOF
+}
+

 sub checkconfig () {
        if (! defined $config{cvspath}) {
                $config{cvspath}="ikiwiki";
 sub checkconfig () {
        if (! defined $config{cvspath}) {
                $config{cvspath}="ikiwiki";


@@ -61,7 +103,7 @@ sub getsetup () {
                cvs_wrapper => {
                        type => "string",
                        example => "/cvs/wikirepo/CVSROOT/post-commit",
                cvs_wrapper => {
                        type => "string",
                        example => "/cvs/wikirepo/CVSROOT/post-commit",

-                       description => "cvs post-commit hook to generate (triggered by CVSROOT/loginfo entry",
+                       description => "cvs post-commit hook to generate (triggered by CVSROOT/loginfo entry)",

                        safe => 0, # file
                        rebuild => 0,
                },
                        safe => 0, # file
                        rebuild => 0,
                },


@@ -92,7 +134,7 @@ sub cvs_info ($$) {
        my $field=shift;
        my $file=shift;
 
        my $field=shift;
        my $file=shift;
 

-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
+       local $CWD = $config{srcdir};

 
        my $info=`cvs status $file`;
        my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
 
        my $info=`cvs status $file`;
        my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;


@@ -100,30 +142,17 @@ sub cvs_info ($$) {
 }
 
 sub cvs_runcvs(@) {
 }
 
 sub cvs_runcvs(@) {

-       my ($cmd) = @_;
-       unshift @$cmd, 'cvs', '-Q';
-
-       eval q{use IPC::Cmd};
-       error($@) if $@;
-
-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
-
-       my ($success, $error_code, $full_buf, $stdout_buf, $stderr_buf) =
-               IPC::Cmd::run(command => $cmd, verbose => 0);
-       if (! $success) {
-               warn(join(" ", @$cmd) . " exited with code $error_code\n");
-               warn(join "", @$stderr_buf);
-       }
-       return $success;
-}
+       my @cmd = @_;
+       unshift @cmd, 'cvs', '-Q';

 
 

-sub cvs_shquote_commit ($) {
-       my $message = shift;
+       local $CWD = $config{srcdir};

 
 

-       eval q{use String::ShellQuote};
-       error($@) if $@;
+       open(my $savedout, ">&STDOUT");
+       open(STDOUT, ">", "/dev/null");
+       my $ret = system(@cmd);
+       open(STDOUT, ">&", $savedout);

 
 

-       return shell_quote(IkiWiki::possibly_foolish_untaint($message));
+       return ($ret == 0) ? 1 : 0;

 }
 
 sub cvs_is_controlling {
 }
 
 sub cvs_is_controlling {


@@ -134,7 +163,7 @@ sub cvs_is_controlling {
 
 sub rcs_update () {
        return unless cvs_is_controlling;
 
 sub rcs_update () {
        return unless cvs_is_controlling;

-       cvs_runcvs(['update', '-dP']);
+       cvs_runcvs('update', '-dP');

 }
 
 sub rcs_prepedit ($) {
 }
 
 sub rcs_prepedit ($) {


@@ -178,13 +207,14 @@ sub rcs_commit ($$$;$$) {
        if (defined $rev && defined $oldrev && $rev != $oldrev) {
                # Merge their changes into the file that we've
                # changed.
        if (defined $rev && defined $oldrev && $rev != $oldrev) {
                # Merge their changes into the file that we've
                # changed.

-               cvs_runcvs(['update', $file]) ||
+               cvs_runcvs('update', $file) ||

                        warn("cvs merge from $oldrev to $rev failed\n");
        }
 
                        warn("cvs merge from $oldrev to $rev failed\n");
        }
 

-       if (! cvs_runcvs(['commit', '-m', cvs_shquote_commit $message])) {
+       if (! cvs_runcvs('commit', '-m',
+                        IkiWiki::possibly_foolish_untaint $message)) {

                my $conflict=readfile("$config{srcdir}/$file");
                my $conflict=readfile("$config{srcdir}/$file");

-               cvs_runcvs(['update', '-C', $file]) ||
+               cvs_runcvs('update', '-C', $file) ||

                        warn("cvs revert failed\n");
                return $conflict;
        }
                        warn("cvs revert failed\n");
                return $conflict;
        }


@@ -204,7 +234,8 @@ sub rcs_commit_staged ($$$) {
                $message="web commit from $ipaddr".(length $message ? ": $message" : "");
        }
 
                $message="web commit from $ipaddr".(length $message ? ": $message" : "");
        }
 

-       if (! cvs_runcvs(['commit', '-m', cvs_shquote_commit $message])) {
+       if (! cvs_runcvs('commit', '-m',
+                        IkiWiki::possibly_foolish_untaint $message)) {

                warn "cvs staged commit failed\n";
                return 1; # failure
        }
                warn "cvs staged commit failed\n";
                return 1; # failure
        }


@@ -226,14 +257,21 @@ sub rcs_add ($) {
        }
 
        while ($file = pop @files_to_add) {
        }
 
        while ($file = pop @files_to_add) {

-               if ((@files_to_add == 0) &&
-                       (File::MimeInfo::default $file ne 'text/plain')) {
-                       # it's a binary file, add specially
-                       cvs_runcvs(['add', '-kb', $file]) ||
-                               warn("cvs add $file failed\n");
-               } else {
-                       # directory or regular file
-                       cvs_runcvs(['add', $file]) ||
+               if (@files_to_add == 0) {
+                       # file
+                       my $filemime = File::MimeInfo::default($file);
+                       if (defined($filemime) && $filemime eq 'text/plain') {
+                               cvs_runcvs('add', $file) ||
+                                       warn("cvs add $file failed\n");
+                       }
+                       else {
+                               cvs_runcvs('add', '-kb', $file) ||
+                                       warn("cvs add binary $file failed\n");
+                       }
+               }
+               else {
+                       # directory
+                       cvs_runcvs('add', $file) ||

                                warn("cvs add $file failed\n");
                }
        }
                                warn("cvs add $file failed\n");
                }
        }


@@ -245,7 +283,7 @@ sub rcs_remove ($) {
 
        return unless cvs_is_controlling;
 
 
        return unless cvs_is_controlling;
 

-       cvs_runcvs(['rm', '-f', $file]) ||
+       cvs_runcvs('rm', '-f', $file) ||

                warn("cvs rm $file failed\n");
 }
 
                warn("cvs rm $file failed\n");
 }
 


@@ -255,7 +293,7 @@ sub rcs_rename ($$) {
 
        return unless cvs_is_controlling;
 
 
        return unless cvs_is_controlling;
 

-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
+       local $CWD = $config{srcdir};

 
        if (system("mv", "$src", "$dest") != 0) {
                warn("filesystem rename failed\n");
 
        if (system("mv", "$src", "$dest") != 0) {
                warn("filesystem rename failed\n");


@@ -274,7 +312,7 @@ sub rcs_recentchanges($) {
        eval q{use Date::Parse};
        error($@) if $@;
 
        eval q{use Date::Parse};
        error($@) if $@;
 

-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
+       local $CWD = $config{srcdir};

 
        # There's no cvsps option to get the last N changesets.
        # Write full output to a temp file and read backwards.
 
        # There's no cvsps option to get the last N changesets.
        # Write full output to a temp file and read backwards.


@@ -284,11 +322,12 @@ sub rcs_recentchanges($) {
        eval q{use File::ReadBackwards};
        error($@) if $@;
 
        eval q{use File::ReadBackwards};
        error($@) if $@;
 

-       my (undef, $tmpfile) = tempfile(OPEN=>0);
+       my ($tmphandle, $tmpfile) = tempfile();

        system("env TZ=UTC cvsps -q --cvs-direct -z 30 -x >$tmpfile");
        if ($? == -1) {
                error "couldn't run cvsps: $!\n";
        system("env TZ=UTC cvsps -q --cvs-direct -z 30 -x >$tmpfile");
        if ($? == -1) {
                error "couldn't run cvsps: $!\n";

-       } elsif (($? >>8) != 0) {
+       }
+       elsif (($? >> 8) != 0) {

                error "cvsps exited " . ($? >> 8) . ": $!\n";
        }
 
                error "cvsps exited " . ($? >> 8) . ": $!\n";
        }
 


@@ -345,7 +384,8 @@ sub rcs_recentchanges($) {
                    $message[0]->{line}=~/$config{web_commit_regexp}/) {
                        $user=defined $2 ? "$2" : "$3";
                        $message[0]->{line}=$4;
                    $message[0]->{line}=~/$config{web_commit_regexp}/) {
                        $user=defined $2 ? "$2" : "$3";
                        $message[0]->{line}=$4;

-               } else {
+               }
+               else {

                        $committype="cvs";
                }
 
                        $committype="cvs";
                }
 


@@ -355,21 +395,24 @@ sub rcs_recentchanges($) {
                $line = <SPSVC>;
                if ($line =~ /^Author: (.*)$/) {
                        $user = $1 unless defined $user && length $user;
                $line = <SPSVC>;
                if ($line =~ /^Author: (.*)$/) {
                        $user = $1 unless defined $user && length $user;

-               } else {
+               }
+               else {

                        error "expected Author, got $line";
                }
 
                $line = <SPSVC>;
                if ($line =~ /^Date: (.*)$/) {
                        $when = str2time($1, 'UTC');
                        error "expected Author, got $line";
                }
 
                $line = <SPSVC>;
                if ($line =~ /^Date: (.*)$/) {
                        $when = str2time($1, 'UTC');

-               } else {
+               }
+               else {

                        error "expected Date, got $line";
                }
 
                $line = <SPSVC>;
                if ($line =~ /^PatchSet (.*)$/) {
                        $rev = $1;
                        error "expected Date, got $line";
                }
 
                $line = <SPSVC>;
                if ($line =~ /^PatchSet (.*)$/) {
                        $rev = $1;

-               } else {
+               }
+               else {

                        error "expected PatchSet, got $line";
                }
 
                        error "expected PatchSet, got $line";
                }
 


@@ -394,7 +437,7 @@ sub rcs_recentchanges($) {
 sub rcs_diff ($) {
        my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
 
 sub rcs_diff ($) {
        my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
 

-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
+       local $CWD = $config{srcdir};

 
        # diff output is unavoidably preceded by the cvsps PatchSet entry
        my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;
 
        # diff output is unavoidably preceded by the cvsps PatchSet entry
        my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;


@@ -407,7 +450,8 @@ sub rcs_diff ($) {
 
        if (wantarray) {
                return @cvsps;
 
        if (wantarray) {
                return @cvsps;

-       } else {
+       }
+       else {

                return join("", @cvsps);
        }
 }
                return join("", @cvsps);
        }
 }