]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/git.pm
Merge commit 'upstream/master' into prv/po
[git.ikiwiki.info.git] / IkiWiki / Plugin / git.pm
index 6c9aca650ee3ab09751ef307aae2febd11a95280..1a39d87e5533bccb48e25d4382c72af43901e50d 100644 (file)
@@ -1,6 +1,5 @@
 #!/usr/bin/perl
-
-package IkiWiki;
+package IkiWiki::Plugin::git;
 
 use warnings;
 use strict;
@@ -10,31 +9,58 @@ 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 { #{{{
+       hook(type => "checkconfig", id => "git", call => \&checkconfig);
+       hook(type => "getsetup", id => "git", call => \&getsetup);
+       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_commit_staged", call => \&rcs_commit_staged);
+       hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
+       hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
+       hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
+       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);
+} #}}}
 
-hook(type => "checkconfig", id => "git", call => sub { #{{{
-       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 (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"),
+               };
+       }
+} #}}}
 
-hook(type => "getsetup", id => "git", call => sub { #{{{
+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,
                },
@@ -45,6 +71,20 @@ hook(type => "getsetup", id => "git", call => sub { #{{{
                        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]]",
@@ -55,7 +95,7 @@ hook(type => "getsetup", id => "git", call => sub { #{{{
                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)",
+                       description => "gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], [[sha1_commit]] and [[file]] substituted)",
                        safe => 1,
                        rebuild => 1,
                },
@@ -73,9 +113,9 @@ hook(type => "getsetup", id => "git", call => sub { #{{{
                        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).
 
@@ -88,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.
@@ -107,12 +149,12 @@ sub _safe_git (&@) { #{{{
        return wantarray ? @lines : ($? == 0);
 }
 # Convenient wrappers.
-sub run_or_die ($@) { _safe_git(\&error, @_) }
-sub run_or_cry ($@) { _safe_git(sub { warn @_ },  @_) }
-sub run_or_non ($@) { _safe_git(undef,            @_) }
+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
@@ -206,7 +248,7 @@ sub _merge_past ($$$) { #{{{
        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.
 
@@ -293,15 +335,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;
@@ -313,20 +361,20 @@ sub _parse_diff_tree ($@) { #{{{
 } #}}}
 
 sub git_commit_info ($;$) { #{{{
-       # Return an array of commit info hashes of num commits (default: 1)
+       # 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');
 
        my @ci;
-       while (my $parsed = _parse_diff_tree(($prefix or ""), \@raw_lines)) {
+       while (my $parsed = parse_diff_tree(($prefix or ""), \@raw_lines)) {
                push @ci, $parsed;
        }
 
@@ -337,7 +385,6 @@ sub git_commit_info ($;$) { #{{{
 
 sub git_sha1 (;$) { #{{{
        # Return head sha1sum (of given file).
-
        my $file = shift || q{--};
 
        # Ignore error since a non-existing file might be given.
@@ -360,7 +407,6 @@ sub rcs_update () { #{{{
 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);
@@ -379,7 +425,7 @@ sub rcs_commit ($$$;$$) { #{{{
        my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
 
        if (defined $cur && defined $prev && $cur ne $prev) {
-               my $conflict = _merge_past($prev, $file, $dummy_commit_msg);
+               my $conflict = merge_past($prev, $file, $dummy_commit_msg);
                return $conflict if defined $conflict;
        }
 
@@ -400,11 +446,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 = 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});
                }
@@ -445,7 +503,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);
 
@@ -458,11 +516,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),
@@ -528,11 +587,104 @@ sub rcs_getctime ($) { #{{{
        $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