X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/6154dd03cb9f46f58c04f91c12ac9e42c696dbbb..c5642119f7fafdafdaff05c0d37e787de221e9e2:/IkiWiki/Plugin/git.pm?ds=sidebyside

diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm
index b20793d86..042c69f5a 100644
--- a/IkiWiki/Plugin/git.pm
+++ b/IkiWiki/Plugin/git.pm
@@ -9,8 +9,9 @@ use open qw{:utf8 :std};
 
 my $sha1_pattern     = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums
 my $dummy_commit_msg = 'dummy commit';      # message to skip in recent changes
+my $no_chdir=0;
 
-sub import { #{{{
+sub import {
 	hook(type => "checkconfig", id => "git", call => \&checkconfig);
 	hook(type => "getsetup", id => "git", call => \&getsetup);
 	hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
@@ -23,32 +24,43 @@ 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_receive", call => \&rcs_receive);
+}
 
-sub checkconfig () { #{{{
-	if (! defined $config{diffurl}) {
-		$config{diffurl}="";
-	}
+sub checkconfig () {
 	if (! defined $config{gitorigin_branch}) {
 		$config{gitorigin_branch}="origin";
 	}
 	if (! defined $config{gitmaster_branch}) {
 		$config{gitmaster_branch}="master";
 	}
-	if (defined $config{git_wrapper} && length $config{git_wrapper}) {
+	if (defined $config{git_wrapper} &&
+	    length $config{git_wrapper}) {
 		push @{$config{wrappers}}, {
 			wrapper => $config{git_wrapper},
 			wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
 		};
 	}
-} #}}}
+	if (defined $config{git_test_receive_wrapper} &&
+	    length $config{git_test_receive_wrapper}) {
+		push @{$config{wrappers}}, {
+			test_receive => 1,
+			wrapper => $config{git_test_receive_wrapper},
+			wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
+		};
+	}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
 	return
+		plugin => {
+			safe => 0, # rcs plugin
+			rebuild => undef,
+		},
 		git_wrapper => {
 			type => "string",
 			example => "/git/wiki.git/hooks/post-update",
-			description => "git post-update executable to generate",
+			description => "git hook to generate",
 			safe => 0, # file
 			rebuild => 0,
 		},
@@ -59,6 +71,20 @@ sub getsetup () { #{{{
 			safe => 0,
 			rebuild => 0,
 		},
+		git_test_receive_wrapper => {
+			type => "string",
+			example => "/git/wiki.git/hooks/pre-receive",
+			description => "git pre-receive hook to generate",
+			safe => 0, # file
+			rebuild => 0,
+		},
+		untrusted_committers => {
+			type => "string",
+			example => [],
+			description => "unix users whose commits should be checked by the pre-receive hook",
+			safe => 0,
+			rebuild => 0,
+		},
 		historyurl => {
 			type => "string",
 			example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
@@ -68,8 +94,8 @@ sub getsetup () { #{{{
 		},
 		diffurl => {
 			type => "string",
-			example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
-			description => "gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] substituted)",
+			example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]",
+			description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",
 			safe => 1,
 			rebuild => 1,
 		},
@@ -87,9 +113,9 @@ sub getsetup () { #{{{
 			safe => 0, # paranoia
 			rebuild => 0,
 		},
-} #}}}
+}
 
-sub safe_git (&@) { #{{{
+sub safe_git (&@) {
 	# Start a child process safely without resorting /bin/sh.
 	# Return command output or success state (in scalar context).
 
@@ -102,8 +128,10 @@ sub safe_git (&@) { #{{{
 	if (!$pid) {
 		# In child.
 		# Git commands want to be in wc.
-		chdir $config{srcdir}
-		    or error("Cannot chdir to $config{srcdir}: $!");
+		if (! $no_chdir) {
+			chdir $config{srcdir}
+			    or error("Cannot chdir to $config{srcdir}: $!");
+		}
 		exec @cmdline or error("Cannot exec '@cmdline': $!");
 	}
 	# In parent.
@@ -111,6 +139,12 @@ sub safe_git (&@) { #{{{
 	my @lines;
 	while (<$OUT>) {
 		chomp;
+		
+		# check for invalid utf-8, and toss it back to avoid crashes
+		if (! utf8::valid($_)) {
+			$_=encode_utf8($_);
+		}
+
 		push @lines, $_;
 	}
 
@@ -124,9 +158,9 @@ sub safe_git (&@) { #{{{
 sub run_or_die ($@) { safe_git(\&error, @_) }
 sub run_or_cry ($@) { safe_git(sub { warn @_ },  @_) }
 sub run_or_non ($@) { safe_git(undef,            @_) }
-#}}}
 
-sub merge_past ($$$) { #{{{
+
+sub merge_past ($$$) {
 	# Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
 	# Git merge commands work with the committed changes, except in the
 	# implicit case of '-m' of git checkout(1).  So we should invent a
@@ -218,9 +252,9 @@ sub merge_past ($$$) { #{{{
 	error("Git merge failed!\n$failure\n") if $failure;
 
 	return $conflict;
-} #}}}
+}
 
-sub parse_diff_tree ($@) { #{{{
+sub parse_diff_tree ($@) {
 	# Parse the raw diff tree chunk and return the info hash.
 	# See git-diff-tree(1) for the syntax.
 
@@ -307,15 +341,21 @@ sub parse_diff_tree ($@) { #{{{
 			my $sha1_to = shift(@tmp);
 			my $status = shift(@tmp);
 
+			# git does not output utf-8 filenames, but instead
+			# double-quotes them with the utf-8 characters
+			# escaped as \nnn\nnn.
 			if ($file =~ m/^"(.*)"$/) {
 				($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
 			}
 			$file =~ s/^\Q$prefix\E//;
 			if (length $file) {
 				push @{ $ci{'details'} }, {
-					'file'      => decode_utf8($file),
+					'file'      => decode("utf8", $file),
 					'sha1_from' => $sha1_from[0],
 					'sha1_to'   => $sha1_to,
+					'mode_from' => $mode_from[0],
+					'mode_to'   => $mode_to,
+					'status'    => $status,
 				};
 			}
 			next;
@@ -324,17 +364,17 @@ sub parse_diff_tree ($@) { #{{{
 	}
 
 	return \%ci;
-} #}}}
+}
 
-sub git_commit_info ($;$) { #{{{
-	# Return an array of commit info hashes of num commits (default: 1)
+sub git_commit_info ($;$) {
+	# Return an array of commit info hashes of num commits
 	# starting from the given sha1sum.
-
 	my ($sha1, $num) = @_;
 
-	$num ||= 1;
+	my @opts;
+	push @opts, "--max-count=$num" if defined $num;
 
-	my @raw_lines = run_or_die('git', 'log', "--max-count=$num", 
+	my @raw_lines = run_or_die('git', 'log', @opts,
 		'--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
 		'-r', $sha1, '--', '.');
 	my ($prefix) = run_or_die('git', 'rev-parse', '--show-prefix');
@@ -347,11 +387,10 @@ sub git_commit_info ($;$) { #{{{
 	warn "Cannot parse commit info for '$sha1' commit" if !@ci;
 
 	return wantarray ? @ci : $ci[0];
-} #}}}
+}
 
-sub git_sha1 (;$) { #{{{
+sub git_sha1 (;$) {
 	# Return head sha1sum (of given file).
-
 	my $file = shift || q{--};
 
 	# Ignore error since a non-existing file might be given.
@@ -361,26 +400,25 @@ sub git_sha1 (;$) { #{{{
 		($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
 	} else { debug("Empty sha1sum for '$file'.") }
 	return defined $sha1 ? $sha1 : q{};
-} #}}}
+}
 
-sub rcs_update () { #{{{
+sub rcs_update () {
 	# Update working directory.
 
 	if (length $config{gitorigin_branch}) {
 		run_or_cry('git', 'pull', $config{gitorigin_branch});
 	}
-} #}}}
+}
 
-sub rcs_prepedit ($) { #{{{
+sub rcs_prepedit ($) {
 	# Return the commit sha1sum of the file when editing begins.
 	# This will be later used in rcs_commit if a merge is required.
-
 	my ($file) = @_;
 
 	return git_sha1($file);
-} #}}}
+}
 
-sub rcs_commit ($$$;$$) { #{{{
+sub rcs_commit ($$$;$$) {
 	# Try to commit the page; returns undef on _success_ and
 	# a version of the page with the rcs's conflict markers on
 	# failure.
@@ -399,7 +437,7 @@ sub rcs_commit ($$$;$$) { #{{{
 
 	rcs_add($file);	
 	return rcs_commit_staged($message, $user, $ipaddr);
-} #}}}
+}
 
 sub rcs_commit_staged ($$$) {
 	# Commits all staged changes. Changes can be staged using rcs_add,
@@ -414,11 +452,23 @@ sub rcs_commit_staged ($$$) {
 		$ENV{GIT_AUTHOR_EMAIL}="$u\@web";
 	}
 
+	$message = IkiWiki::possibly_foolish_untaint($message);
+	my @opts;
+	if ($message !~ /\S/) {
+		# Force git to allow empty commit messages.
+		# (If this version of git supports it.)
+		my ($version)=`git --version` =~ /git version (.*)/;
+		if ($version ge "1.5.4") {
+			push @opts, '--cleanup=verbatim';
+		}
+		else {
+			$message.=".";
+		}
+	}
+	push @opts, '-q';
 	# git commit returns non-zero if file has not been really changed.
 	# so we should ignore its exit status (hence run_or_non).
-	$message = IkiWiki::possibly_foolish_untaint($message);
-	if (run_or_non('git', 'commit', '--cleanup=verbatim',
-	               '-q', '-m', $message)) {
+	if (run_or_non('git', 'commit', @opts, '-m', $message)) {
 		if (length $config{gitorigin_branch}) {
 			run_or_cry('git', 'push', $config{gitorigin_branch});
 		}
@@ -428,29 +478,29 @@ sub rcs_commit_staged ($$$) {
 	return undef; # success
 }
 
-sub rcs_add ($) { # {{{
+sub rcs_add ($) {
 	# Add file to archive.
 
 	my ($file) = @_;
 
 	run_or_cry('git', 'add', $file);
-} #}}}
+}
 
-sub rcs_remove ($) { # {{{
+sub rcs_remove ($) {
 	# Remove file from archive.
 
 	my ($file) = @_;
 
 	run_or_cry('git', 'rm', '-f', $file);
-} #}}}
+}
 
-sub rcs_rename ($$) { # {{{
+sub rcs_rename ($$) {
 	my ($src, $dest) = @_;
 
 	run_or_cry('git', 'mv', '-f', $src, $dest);
-} #}}}
+}
 
-sub rcs_recentchanges ($) { #{{{
+sub rcs_recentchanges ($) {
 	# List of recent changes.
 
 	my ($num) = @_;
@@ -459,7 +509,7 @@ sub rcs_recentchanges ($) { #{{{
 	error($@) if $@;
 
 	my @rets;
-	foreach my $ci (git_commit_info('HEAD', $num)) {
+	foreach my $ci (git_commit_info('HEAD', $num || 1)) {
 		# Skip redundant commits.
 		next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
 
@@ -472,11 +522,12 @@ sub rcs_recentchanges ($) { #{{{
 		foreach my $detail (@{ $ci->{'details'} }) {
 			my $file = $detail->{'file'};
 
-			my $diffurl = $config{'diffurl'};
+			my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
 			$diffurl =~ s/\[\[file\]\]/$file/go;
 			$diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
 			$diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
 			$diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
+			$diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
 
 			push @pages, {
 				page => pagename($file),
@@ -517,9 +568,9 @@ sub rcs_recentchanges ($) { #{{{
 	}
 
 	return @rets;
-} #}}}
+}
 
-sub rcs_diff ($) { #{{{
+sub rcs_diff ($) {
 	my $rev=shift;
 	my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
 	my @lines;
@@ -534,19 +585,112 @@ sub rcs_diff ($) { #{{{
 	else {
 		return join("", @lines);
 	}
-} #}}}
+}
 
-sub rcs_getctime ($) { #{{{
+sub rcs_getctime ($) {
 	my $file=shift;
 	# Remove srcdir prefix
 	$file =~ s/^\Q$config{srcdir}\E\/?//;
 
 	my $sha1  = git_sha1($file);
-	my $ci    = git_commit_info($sha1);
+	my $ci    = git_commit_info($sha1, 1);
 	my $ctime = $ci->{'author_epoch'};
 	debug("ctime for '$file': ". localtime($ctime));
 
 	return $ctime;
-} #}}}
+}
+
+sub rcs_receive () {
+	# The wiki may not be the only thing in the git repo.
+	# Determine if it is in a subdirectory by examining the srcdir,
+	# and its parents, looking for the .git directory.
+	my $subdir="";
+	my $dir=$config{srcdir};
+	while (! -d "$dir/.git") {
+		$subdir=IkiWiki::basename($dir)."/".$subdir;
+		$dir=IkiWiki::dirname($dir);
+		if (! length $dir) {
+			error("cannot determine root of git repo");
+		}
+	}
+
+	my @rets;
+	while (<>) {
+		chomp;
+		my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
+		
+		# only allow changes to gitmaster_branch
+		if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
+			error sprintf(gettext("you are not allowed to change %s"), $refname);
+		}
+		
+		# Avoid chdir when running git here, because the changes
+		# are in the master git repo, not the srcdir repo.
+		# The pre-recieve hook already puts us in the right place.
+		$no_chdir=1;
+		my @changes=git_commit_info($oldrev."..".$newrev);
+		$no_chdir=0;
+
+		foreach my $ci (@changes) {
+			foreach my $detail (@{ $ci->{'details'} }) {
+				my $file = $detail->{'file'};
+
+				# check that all changed files are in the
+				# subdir
+				if (length $subdir &&
+				    ! ($file =~ s/^\Q$subdir\E//)) {
+					error sprintf(gettext("you are not allowed to change %s"), $file);
+				}
+
+				my ($action, $mode, $path);
+				if ($detail->{'status'} =~ /^[M]+\d*$/) {
+					$action="change";
+					$mode=$detail->{'mode_to'};
+				}
+				elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
+					$action="add";
+					$mode=$detail->{'mode_to'};
+				}
+				elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
+					$action="remove";
+					$mode=$detail->{'mode_from'};
+				}
+				else {
+					error "unknown status ".$detail->{'status'};
+				}
+				
+				# test that the file mode is ok
+				if ($mode !~ /^100[64][64][64]$/) {
+					error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
+				}
+				if ($action eq "change") {
+					if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
+						error gettext("you are not allowed to change file modes");
+					}
+				}
+				
+				# extract attachment to temp file
+				if (($action eq 'add' || $action eq 'change') &&
+				     ! pagetype($file)) {
+					eval q{use File::Temp};
+					die $@ if $@;
+					my $fh;
+					($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
+					if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
+						error("failed writing temp file");
+					}
+				}
+
+				push @rets, {
+					file => $file,
+					action => $action,
+					path => $path,
+				};
+			}
+		}
+	}
+
+	return reverse @rets;
+}
 
 1