X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/0580cbbf40873a2d20da96b41f4b14f642cb108d..b33f69ab514f83d3fed1fd873f251d62f65d62a1:/IkiWiki/Plugin/cvs.pm

diff --git a/IkiWiki/Plugin/cvs.pm b/IkiWiki/Plugin/cvs.pm
index 18491d517..0a6cbfaf6 100644
--- a/IkiWiki/Plugin/cvs.pm
+++ b/IkiWiki/Plugin/cvs.pm
@@ -35,10 +35,14 @@ use IkiWiki;
 
 use File::chdir;
 
+
+# GENERAL PLUGIN API CALLS
+
 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 => "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);
@@ -52,17 +56,6 @@ sub import {
 	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";
@@ -132,39 +125,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 () {
-	return unless cvs_is_controlling;
+	return unless cvs_is_controlling();
 	cvs_runcvs('update', '-dP');
 }
 
@@ -175,7 +151,7 @@ sub rcs_prepedit ($) {
 	# 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.
@@ -183,40 +159,29 @@ sub rcs_prepedit ($) {
 	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.
-	my $file=shift;
-	my $message=shift;
-	my $rcstoken=shift;
-	my $user=shift;
-	my $ipaddr=shift;
-
-	return unless cvs_is_controlling;
+	my %params=@_;
 
-	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.
-	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.
-		cvs_runcvs('update', $file) ||
+		cvs_runcvs('update', $params{file}) ||
 			warn("cvs merge from $oldrev to $rev failed\n");
 	}
 
 	if (! cvs_runcvs('commit', '-m',
-			 IkiWiki::possibly_foolish_untaint $message)) {
-		my $conflict=readfile("$config{srcdir}/$file");
-		cvs_runcvs('update', '-C', $file) ||
+			 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;
 	}
@@ -224,20 +189,13 @@ sub rcs_commit ($$$;$$) {
 	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.
-	my ($message, $user, $ipaddr)=@_;
-
-	if (defined $user) {
-		$message="web commit by $user".(length $message ? ": $message" : "");
-	}
-	elsif (defined $ipaddr) {
-		$message="web commit from $ipaddr".(length $message ? ": $message" : "");
-	}
+	my %params=@_;
 
 	if (! cvs_runcvs('commit', '-m',
-			 IkiWiki::possibly_foolish_untaint $message)) {
+			 IkiWiki::possibly_foolish_untaint(commitmessage(%params)))) {
 		warn "cvs staged commit failed\n";
 		return 1; # failure
 	}
@@ -250,9 +208,6 @@ sub rcs_add ($) {
 	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);
@@ -261,15 +216,8 @@ sub rcs_add ($) {
 	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 failed\n");
 		}
 		else {
 			# directory
@@ -283,7 +231,7 @@ sub rcs_remove ($) {
 	# 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");
@@ -293,7 +241,7 @@ sub rcs_rename ($$) {
 	# 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};
 
@@ -309,7 +257,7 @@ sub rcs_recentchanges ($) {
 	my $num = shift;
 	my @ret;
 
-	return unless cvs_is_controlling;
+	return unless cvs_is_controlling();
 
 	eval q{use Date::Parse};
 	error($@) if $@;
@@ -436,8 +384,9 @@ sub rcs_recentchanges ($) {
 	return @ret;
 }
 
-sub rcs_diff ($) {
+sub rcs_diff ($;$) {
 	my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
+	my $maxlines=shift;
 
 	local $CWD = $config{srcdir};
 
@@ -461,6 +410,8 @@ sub rcs_diff ($) {
 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' |"
@@ -490,4 +441,74 @@ 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