]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/cvs.pm
pagestats: rename disp to show, and document it
[git.ikiwiki.info.git] / IkiWiki / Plugin / cvs.pm
index 1a432c05248f2d8e74db1858d4c5b8271ec42310..841aec914f7208df52036379319f4bdfda7ddc01 100644 (file)
@@ -33,12 +33,17 @@ use warnings;
 use strict;
 use IkiWiki;
 
 use strict;
 use IkiWiki;
 
+use URI::Escape q{uri_escape_utf8};
 use File::chdir;
 
 use File::chdir;
 
+
+# GENERAL PLUGIN API CALLS
+
 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 => "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);
@@ -52,17 +57,6 @@ sub import {
        hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
 }
 
        hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
 }
 
-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";
@@ -132,39 +126,22 @@ sub getsetup () {
                },
 }
 
                },
 }
 
-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 genwrapper () {
+       return <<EOF;
+       {
+               int j;
+               for (j = 1; j < argc; j++)
+                       if (strstr(argv[j], "New directory") != NULL)
+                               exit(0);
+       }
+EOF
 }
 
 }
 
-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;
-}
-
-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;
+       return unless cvs_is_controlling();
        cvs_runcvs('update', '-dP');
 }
 
        cvs_runcvs('update', '-dP');
 }
 
@@ -175,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.
@@ -183,31 +160,13 @@ sub rcs_prepedit ($) {
        return defined $rev ? $rev : "";
 }
 
        return defined $rev ? $rev : "";
 }
 
-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 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.
        my %params=@_;
 
 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.
        my %params=@_;
 
-       return unless cvs_is_controlling;
+       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.
@@ -250,9 +209,6 @@ sub rcs_add ($) {
        my $parent=IkiWiki::dirname($file);
        my @files_to_add = ($file);
 
        my $parent=IkiWiki::dirname($file);
        my @files_to_add = ($file);
 
-       eval q{use File::MimeInfo};
-       error($@) if $@;
-
        until ((length($parent) == 0) || cvs_is_controlling("$config{srcdir}/$parent")){
                push @files_to_add, $parent;
                $parent = IkiWiki::dirname($parent);
        until ((length($parent) == 0) || cvs_is_controlling("$config{srcdir}/$parent")){
                push @files_to_add, $parent;
                $parent = IkiWiki::dirname($parent);
@@ -260,21 +216,12 @@ sub rcs_add ($) {
 
        while ($file = pop @files_to_add) {
                if (@files_to_add == 0) {
 
        while ($file = pop @files_to_add) {
                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");
-                       }
+                       cvs_runcvs('add', cvs_keyword_subst_args($file)) ||
+                               warn("cvs add file $file failed\n");
                }
                else {
                }
                else {
-                       # directory
                        cvs_runcvs('add', $file) ||
                        cvs_runcvs('add', $file) ||
-                               warn("cvs add $file failed\n");
+                               warn("cvs add dir $file failed\n");
                }
        }
 }
                }
        }
 }
@@ -283,7 +230,7 @@ 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) ||
                warn("cvs rm $file failed\n");
 
        cvs_runcvs('rm', '-f', $file) ||
                warn("cvs rm $file failed\n");
@@ -293,7 +240,7 @@ 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();
 
        local $CWD = $config{srcdir};
 
 
        local $CWD = $config{srcdir};
 
@@ -309,7 +256,7 @@ 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 $@;
 
        eval q{use Date::Parse};
        error($@) if $@;
@@ -367,7 +314,10 @@ 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 = join('/',
+                               map { uri_escape_utf8($_) } split('/', $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, {
@@ -436,8 +386,9 @@ sub rcs_recentchanges ($) {
        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;
 
        local $CWD = $config{srcdir};
 
 
        local $CWD = $config{srcdir};
 
@@ -445,11 +396,15 @@ sub rcs_diff ($) {
        my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;
        my $blank_lines_seen = 0;
 
        my @cvsps = `env TZ=UTC cvsps -q --cvs-direct -z 30 -g -s $rev`;
        my $blank_lines_seen = 0;
 
+       # skip log, get to the diff
        while (my $line = shift @cvsps) {
                $blank_lines_seen++ if ($line =~ /^$/);
                last if $blank_lines_seen == 2;
        }
 
        while (my $line = shift @cvsps) {
                $blank_lines_seen++ if ($line =~ /^$/);
                last if $blank_lines_seen == 2;
        }
 
+       @cvsps = @cvsps[0..$maxlines-1]
+               if defined $maxlines && @cvsps > $maxlines;
+
        if (wantarray) {
                return @cvsps;
        }
        if (wantarray) {
                return @cvsps;
        }
@@ -459,7 +414,9 @@ sub rcs_diff ($) {
 }
 
 sub rcs_getctime ($) {
 }
 
 sub rcs_getctime ($) {
-       my $file=$config{srcdir}."/".shift();
+       my $file=shift;
+
+       local $CWD = $config{srcdir};
 
        my $cvs_log_infoline=qr/^date: (.+);\s+author/;
 
 
        my $cvs_log_infoline=qr/^date: (.+);\s+author/;
 
@@ -490,4 +447,103 @@ sub rcs_getmtime ($) {
        error "rcs_getmtime is not implemented for cvs\n"; # TODO
 }
 
        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) {
+
+       defined($filemime) && $filemime eq 'text/plain'
+               ? return ('-kkv', $file)
+               : return ('-kb', $file);
+}
+
+sub cvs_runcvs(@) {
+       my @cmd = @_;
+       unshift @cmd, 'cvs', '-Q';
+
+       # CVS can't operate outside a srcdir, so we're always setting $CWD.
+       # "local $CWD" restores the previous value when we go out of scope.
+       # Usually that's correct. But if we're removing the last file from
+       # a directory, the post-commit hook will exec in a working directory
+       # that's about to not exist (CVS will prune it).
+       #
+       # chdir() manually here, so we can selectively not chdir() back.
+
+       my $oldcwd = $CWD;
+       chdir($config{srcdir});
+
+       eval q{
+               use IPC::Open3;
+               use Symbol qw(gensym);
+               use IO::File;
+       };
+       error($@) if $@;
+
+       my $cvsout = '';
+       my $cvserr = '';
+       local *CATCHERR = IO::File->new_tmpfile;
+       my $pid = open3(gensym(), \*CATCHOUT, ">&CATCHERR", @cmd);
+       while (my $l = <CATCHOUT>) {
+               $cvsout .= $l
+                       unless 1;
+       }
+       waitpid($pid, 0);
+       my $ret = $? >> 8;
+       seek CATCHERR, 0, 0;
+       while (my $l = <CATCHERR>) {
+               $cvserr .= $l
+                       unless $l =~ /^cvs commit: changing keyword expansion /;
+       }
+
+       print STDOUT $cvsout;
+       print STDERR $cvserr;
+
+       chdir($oldcwd) if -d $oldcwd;
+
+       return ($ret == 0) ? 1 : 0;
+}
+
 1
 1