git: Add test coverage for reverting attachments

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

diff --git a/IkiWiki/Plugin/cvs.pm b/IkiWiki/Plugin/cvs.pm
index 076af26f3b451f5627aa361012cc001ff8e36fd4..788f5116786f291d1543944c55522b6a758439e7 100644 (file)
--- a/IkiWiki/Plugin/cvs.pm
+++ b/IkiWiki/Plugin/cvs.pm
@@ -1,14 +1,49 @@
-#!/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 URI::Escape q{uri_escape_utf8};
+use File::chdir;
+
+
+# GENERAL PLUGIN API CALLS
+

 sub import {
 sub import {

-       hook(type => "getopt", id => "cvs", call => \&getopt);

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

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

        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
        hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
        hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);


@@ -19,13 +54,7 @@ sub import {
        hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
        hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
        hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
        hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);

-}
-
-sub getopt () {
-       # "cvs add dir" acts immediately on the repository.
-       # post-commit gets confused by this and doesn't need to act on it.
-       # If that's why we're here, terminate the process.
-       @ARGV == 3 && $ARGV[1] eq "NONE" && $ARGV[2] eq "NONE" && exit 0;
+       hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);

 }
 
 sub checkconfig () {
 }
 
 sub checkconfig () {


@@ -51,6 +80,7 @@ sub getsetup () {
                plugin => {
                        safe => 0, # rcs plugin
                        rebuild => undef,
                plugin => {
                        safe => 0, # rcs plugin
                        rebuild => undef,

+                       section => "rcs",

                },
                cvsrepo => {
                        type => "string",
                },
                cvsrepo => {
                        type => "string",


@@ -69,7 +99,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,
                },


@@ -96,59 +126,23 @@ sub getsetup () {
                },
 }
 
                },
 }
 

-sub cvs_info ($$) {
-       my $field=shift;
-       my $file=shift;
-
-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
-
-       my $info=`cvs status $file`;
-       my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
-       return $ret;
-}
-
-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}: $!");
-
-       debug("runcvs: " . join(" ", @$cmd));
-
-       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);
+sub genwrapper () {
+       return <<EOF;
+       {
+               int j;
+               for (j = 1; j < argc; j++)
+                       if (strstr(argv[j], "New directory") != NULL)
+                               exit(0);

        }
        }

-       return $success;
+EOF

 }
 
 }
 

-sub cvs_shquote_commit ($) {
-       my $message = shift;
-
-       eval q{
-               use String::ShellQuote;
-       };
-       error($@) if $@;
-
-       return shell_quote(IkiWiki::possibly_foolish_untaint($message));
-}

 
 

-sub cvs_is_controlling {
-       my $dir=shift;
-       $dir=$config{srcdir} unless defined($dir);
-       return (-d "$dir/CVS") ? 1 : 0;
-}
+# VCS PLUGIN API CALLS

 
 sub rcs_update () {
 
 sub rcs_update () {

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

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


@@ -158,7 +152,7 @@ sub rcs_prepedit ($) {
        # The file is relative to the srcdir.
        my $file=shift;
 
        # The file is relative to the srcdir.
        my $file=shift;
 

-       return unless cvs_is_controlling;
+       return unless cvs_is_controlling();

 
        # For cvs, return the revision of the file when
        # editing begins.
 
        # For cvs, return the revision of the file when
        # editing begins.


@@ -166,39 +160,29 @@ sub rcs_prepedit ($) {
        return defined $rev ? $rev : "";
 }
 
        return defined $rev ? $rev : "";
 }
 

-sub rcs_commit ($$$;$$) {
+sub rcs_commit (@) {

        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
        # The file is relative to the srcdir.
        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
        # The file is relative to the srcdir.

-       my $file=shift;
-       my $message=shift;
-       my $rcstoken=shift;
-       my $user=shift;
-       my $ipaddr=shift;
+       my %params=@_;

 
 

-       return unless cvs_is_controlling;
-
-       if (defined $user) {
-               $message="web commit by $user".(length $message ? ": $message" : "");
-       }
-       elsif (defined $ipaddr) {
-               $message="web commit from $ipaddr".(length $message ? ": $message" : "");
-       }
+       return unless cvs_is_controlling();

 
        # Check to see if the page has been changed by someone
        # else since rcs_prepedit was called.
 
        # Check to see if the page has been changed by someone
        # else since rcs_prepedit was called.

-       my ($oldrev)=$rcstoken=~/^([0-9]+)$/; # untaint
-       my $rev=cvs_info("Repository revision", "$config{srcdir}/$file");
+       my ($oldrev)=$params{token}=~/^([0-9]+)$/; # untaint
+       my $rev=cvs_info("Repository revision", "$config{srcdir}/$params{file}");

        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', $params{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])) {
-               my $conflict=readfile("$config{srcdir}/$file");
-               cvs_runcvs(['update', '-C', $file]) ||
+       if (! cvs_runcvs('commit', '-m',
+                        IkiWiki::possibly_foolish_untaint(commitmessage(%params)))) {
+               my $conflict=readfile("$config{srcdir}/$params{file}");
+               cvs_runcvs('update', '-C', $params{file}) ||

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


@@ -206,19 +190,13 @@ sub rcs_commit ($$$;$$) {
        return undef # success
 }
 
        return undef # success
 }
 

-sub rcs_commit_staged ($$$) {
+sub rcs_commit_staged (@) {

        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.
        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.

-       my ($message, $user, $ipaddr)=@_;
+       my %params=@_;

 
 

-       if (defined $user) {
-               $message="web commit by $user".(length $message ? ": $message" : "");
-       }
-       elsif (defined $ipaddr) {
-               $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(commitmessage(%params)))) {

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


@@ -237,8 +215,16 @@ sub rcs_add ($) {
        }
 
        while ($file = pop @files_to_add) {
        }
 
        while ($file = pop @files_to_add) {

-               cvs_runcvs(['add', $file]) ||
-                       warn("cvs add $file failed\n");
+               if (@files_to_add == 0) {
+                       # file
+                       cvs_runcvs('add', cvs_keyword_subst_args($file)) ||
+                               warn("cvs add $file failed\n");
+               }
+               else {
+                       # directory
+                       cvs_runcvs('add', $file) ||
+                               warn("cvs add $file failed\n");
+               }

        }
 }
 
        }
 }
 


@@ -246,9 +232,9 @@ sub rcs_remove ($) {
        # filename is relative to the root of the srcdir
        my $file=shift;
 
        # filename is relative to the root of the srcdir
        my $file=shift;
 

-       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");
 }
 


@@ -256,9 +242,9 @@ sub rcs_rename ($$) {
        # filenames relative to the root of the srcdir
        my ($src, $dest)=@_;
 
        # filenames relative to the root of the srcdir
        my ($src, $dest)=@_;
 

-       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");


@@ -268,24 +254,38 @@ sub rcs_rename ($$) {
        rcs_remove($src);
 }
 
        rcs_remove($src);
 }
 

-sub rcs_recentchanges($) {
+sub rcs_recentchanges ($) {

        my $num = shift;
        my @ret;
 
        my $num = shift;
        my @ret;
 

-       return unless cvs_is_controlling;
+       return unless cvs_is_controlling();
+
+       eval q{use Date::Parse};
+       error($@) if $@;
+
+       local $CWD = $config{srcdir};

 
 

-       eval q{
-               use Date::Parse;
-       };
+       # There's no cvsps option to get the last N changesets.
+       # Write full output to a temp file and read backwards.
+
+       eval q{use File::Temp qw/tempfile/};
+       error($@) if $@;
+       eval q{use File::ReadBackwards};

        error($@) if $@;
 
        error($@) if $@;
 

-       chdir $config{srcdir} || error("Cannot chdir to $config{srcdir}: $!");
+       my ($tmphandle, $tmpfile) = tempfile();
+       system("env TZ=UTC cvsps -q --cvs-direct -z 30 -x >$tmpfile");
+       if ($? == -1) {
+               error "couldn't run cvsps: $!\n";
+       }
+       elsif (($? >> 8) != 0) {
+               error "cvsps exited " . ($? >> 8) . ": $!\n";
+       }

 
 

-       open CVSPS, "env TZ=UTC cvsps -q --cvs-direct -z 30 -x |" || error "couldn't get cvsps output: $!\n";
-       my @spsvc = reverse <CVSPS>;            # is this great? no it is not
-       close CVSPS || error "couldn't close cvsps output: $!\n";
+       tie(*SPSVC, 'File::ReadBackwards', $tmpfile)
+               || error "couldn't open $tmpfile for read: $!\n";

 
 

-       while (my $line = shift @spsvc) {
+       while (my $line = <SPSVC>) {

                $line =~ /^$/ || error "expected blank line, got $line";
 
                my ($rev, $user, $committype, $when);
                $line =~ /^$/ || error "expected blank line, got $line";
 
                my ($rev, $user, $committype, $when);


@@ -305,7 +305,7 @@ sub rcs_recentchanges($) {
                #       @pages (and revisions)
                #
 
                #       @pages (and revisions)
                #
 

-               while ($line = shift @spsvc) {
+               while ($line = <SPSVC>) {

                        last if ($line =~ /^Members:/);
                        for ($line) {
                                s/^\s+//;
                        last if ($line =~ /^Members:/);
                        for ($line) {
                                s/^\s+//;


@@ -316,7 +316,8 @@ sub rcs_recentchanges($) {
                        $oldrev =~ s/INITIAL/0/;
                        $newrev =~ s/\(DEAD\)//;
                        my $diffurl = defined $config{diffurl} ? $config{diffurl} : "";
                        $oldrev =~ s/INITIAL/0/;
                        $newrev =~ s/\(DEAD\)//;
                        my $diffurl = defined $config{diffurl} ? $config{diffurl} : "";

-                       $diffurl=~s/\[\[file\]\]/$page/g;
+                       my $epage = uri_escape_utf8($page);
+                       $diffurl=~s/\[\[file\]\]/$epage/g;

                        $diffurl=~s/\[\[r1\]\]/$oldrev/g;
                        $diffurl=~s/\[\[r2\]\]/$newrev/g;
                        unshift @pages, {
                        $diffurl=~s/\[\[r1\]\]/$oldrev/g;
                        $diffurl=~s/\[\[r2\]\]/$newrev/g;
                        unshift @pages, {


@@ -325,7 +326,7 @@ sub rcs_recentchanges($) {
                        } if length $page;
                }
 
                        } if length $page;
                }
 

-               while ($line = shift @spsvc) {
+               while ($line = <SPSVC>) {

                        last if ($line =~ /^Log:$/);
                        chomp $line;
                        unshift @message, { line => $line };
                        last if ($line =~ /^Log:$/);
                        chomp $line;
                        unshift @message, { line => $line };


@@ -335,35 +336,39 @@ 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";
                }
 

-               $line = shift @spsvc;   # Tag
-               $line = shift @spsvc;   # Branch
+               $line = <SPSVC>;        # Tag
+               $line = <SPSVC>;        # Branch

 
 

-               $line = shift @spsvc;
+               $line = <SPSVC>;

                if ($line =~ /^Author: (.*)$/) {
                        $user = $1 unless defined $user && length $user;
                if ($line =~ /^Author: (.*)$/) {
                        $user = $1 unless defined $user && length $user;

-               } else {
+               }
+               else {

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

-               $line = shift @spsvc;
+               $line = <SPSVC>;

                if ($line =~ /^Date: (.*)$/) {
                        $when = str2time($1, 'UTC');
                if ($line =~ /^Date: (.*)$/) {
                        $when = str2time($1, 'UTC');

-               } else {
+               }
+               else {

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

-               $line = shift @spsvc;
+               $line = <SPSVC>;

                if ($line =~ /^PatchSet (.*)$/) {
                        $rev = $1;
                if ($line =~ /^PatchSet (.*)$/) {
                        $rev = $1;

-               } else {
+               }
+               else {

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

-               $line = shift @spsvc;   # ---------------------
+               $line = <SPSVC>;        # ---------------------

 
                push @ret, {
                        rev => $rev,
 
                push @ret, {
                        rev => $rev,


@@ -373,16 +378,19 @@ sub rcs_recentchanges($) {
                        message => [@message],
                        pages => [@pages],
                } if @pages;
                        message => [@message],
                        pages => [@pages],
                } if @pages;

-               return @ret if @ret >= $num;
+               last if @ret >= $num;

        }
 
        }
 

+       unlink($tmpfile) || error "couldn't unlink $tmpfile: $!\n";
+

        return @ret;
 }
 
        return @ret;
 }
 

-sub rcs_diff ($) {
+sub rcs_diff ($;$) {

        my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
        my $rev=IkiWiki::possibly_foolish_untaint(int(shift));

+       my $maxlines=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`;


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

-       } else {
+       }
+       else {

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


@@ -403,6 +412,8 @@ sub rcs_diff ($) {
 sub rcs_getctime ($) {
        my $file=shift;
 
 sub rcs_getctime ($) {
        my $file=shift;
 

+       local $CWD = $config{srcdir};
+

        my $cvs_log_infoline=qr/^date: (.+);\s+author/;
 
        open CVSLOG, "cvs -Q log -r1.1 '$file' |"
        my $cvs_log_infoline=qr/^date: (.+);\s+author/;
 
        open CVSLOG, "cvs -Q log -r1.1 '$file' |"


@@ -428,4 +439,78 @@ sub rcs_getctime ($) {
        return $date;
 }
 
        return $date;
 }
 

+sub rcs_getmtime ($) {
+       error "rcs_getmtime is not implemented for cvs\n"; # TODO
+}
+
+
+# INTERNAL SUPPORT ROUTINES
+
+sub commitmessage (@) {
+       my %params=@_;
+
+       if (defined $params{session}) {
+               if (defined $params{session}->param("name")) {
+                       return "web commit by ".
+                               $params{session}->param("name").
+                               (length $params{message} ? ": $params{message}" : "");
+               }
+               elsif (defined $params{session}->remote_addr()) {
+                       return "web commit from ".
+                               $params{session}->remote_addr().
+                               (length $params{message} ? ": $params{message}" : "");
+               }
+       }
+       return $params{message};
+}
+
+sub cvs_info ($$) {
+       my $field=shift;
+       my $file=shift;
+
+       local $CWD = $config{srcdir};
+
+       my $info=`cvs status $file`;
+       my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
+       return $ret;
+}
+
+sub cvs_is_controlling {
+       my $dir=shift;
+       $dir=$config{srcdir} unless defined($dir);
+       return (-d "$dir/CVS") ? 1 : 0;
+}
+
+sub cvs_keyword_subst_args ($) {
+       my $file = shift;
+
+       local $CWD = $config{srcdir};
+
+       eval q{use File::MimeInfo};
+       error($@) if $@;
+       my $filemime = File::MimeInfo::default($file);
+       # if (-T $file) {
+
+       if (defined($filemime) && $filemime eq 'text/plain') {
+               return ($file);
+       }
+       else {
+               return ('-kb', $file);
+       }
+}
+
+sub cvs_runcvs(@) {
+       my @cmd = @_;
+       unshift @cmd, 'cvs', '-Q';
+
+       local $CWD = $config{srcdir};
+
+       open(my $savedout, ">&STDOUT");
+       open(STDOUT, ">", "/dev/null");
+       my $ret = system(@cmd);
+       open(STDOUT, ">&", $savedout);
+
+       return ($ret == 0) ? 1 : 0;
+}
+

 1
 1