X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/30afedcfe2799bb6cc4bf329bd273ad9d8dd6da3..9e05810f81a8fc2557876b510c8ab06cf1d56ab3:/IkiWiki/Rcs/git.pm diff --git a/IkiWiki/Rcs/git.pm b/IkiWiki/Rcs/git.pm index 374904fd3..46adf1657 100644 --- a/IkiWiki/Rcs/git.pm +++ b/IkiWiki/Rcs/git.pm @@ -1,21 +1,17 @@ #!/usr/bin/perl -# Git backend for IkiWiki. -# Copyright 2006 Recai Oktaş -# -# Licensed under the same terms as IkiWiki. use warnings; use strict; use IkiWiki; +use Encode; +use open qw{:utf8 :std}; package IkiWiki; my $origin_branch = 'origin'; # Git ref for main repository -my $master_branch = 'master'; # Working branch +my $master_branch = 'master'; # working branch my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums -my $dummy_commit_msg = 'dummy commit'; # will be used in all dummy commits - # and skipped in recent changes list -my $web_commit_msg = qr/^web commit by (\w+):?(.*)/; # pattern for web commits +my $dummy_commit_msg = 'dummy commit'; # message to skip in recent changes sub _safe_git (&@) { #{{{ # Start a child process safely without resorting /bin/sh. @@ -51,7 +47,7 @@ sub _safe_git (&@) { #{{{ return wantarray ? @lines : ($? == 0); } # Convenient wrappers. -sub run_or_die ($@) { _safe_git(\&IkiWiki::error, @_) } +sub run_or_die ($@) { _safe_git(\&error, @_) } sub run_or_cry ($@) { _safe_git(sub { warn @_ }, @_) } sub run_or_non ($@) { _safe_git(undef, @_) } #}}} @@ -105,7 +101,7 @@ sub _merge_past ($$$) { #{{{ push @undo, sub { return if ! -e "$hidden"; # already renamed rename($hidden, $target) - or debug("rename '$hidden' to '$target' failed: $!"); + or warn "rename '$hidden' to '$target' failed: $!"; }; my $branch = "throw_away_${sha1}"; # supposed to be unique @@ -160,10 +156,9 @@ sub _parse_diff_tree (@) { #{{{ return if !defined @{ $dt_ref } || !length @{ $dt_ref }[0]; my %ci; - # Header line. HEADER: while (my $line = shift @{ $dt_ref }) { - return if $line !~ m/^diff-tree (\S+)/; + return if $line !~ m/^(.+) ($sha1_pattern)/; my $sha1 = $1; $ci{'sha1'} = $sha1; @@ -217,14 +212,14 @@ sub _parse_diff_tree (@) { #{{{ # Modified files. FILE: while (my $line = shift @{ $dt_ref }) { - if ($line =~ m{^ - :([0-7]{6})[ ] # from mode - ([0-7]{6})[ ] # to mode - ([0-9a-fA-F]{40})[ ] # from sha1 - ([0-9a-fA-F]{40})[ ] # to sha1 - (.) # status - ([0-9]{0,3})\t # similarity - (.*) # file + if ($line =~ m{^: + ([0-7]{6})[ ] # from mode + ([0-7]{6})[ ] # to mode + ($sha1_pattern)[ ] # from sha1 + ($sha1_pattern)[ ] # to sha1 + (.) # status + ([0-9]{0,3})\t # similarity + (.*) # file $}xo) { my ($sha1_from, $sha1_to, $file) = ($3, $4, $7 ); @@ -234,7 +229,7 @@ sub _parse_diff_tree (@) { #{{{ } if (length $file) { push @{ $ci{'details'} }, { - 'file' => $file, + 'file' => decode_utf8($file), 'sha1_from' => $sha1_from, 'sha1_to' => $sha1_to, }; @@ -244,7 +239,7 @@ sub _parse_diff_tree (@) { #{{{ last FILE; } - error("No detail in diff-tree output") if !defined $ci{'details'}; + warn "No detail in diff-tree output" if !defined $ci{'details'}; return \%ci; } #}}} @@ -259,13 +254,15 @@ sub git_commit_info (;$$) { #{{{ my @raw_lines = run_or_die(qq{git-rev-list --max-count=$num $sha1 | - git-diff-tree --stdin --pretty=raw -c -M -r}); + git-diff-tree --stdin --pretty=raw -M -r}); my @ci; while (my $parsed = _parse_diff_tree(\@raw_lines)) { push @ci, $parsed; } + warn "Cannot parse commit info for '$sha1' commit" if !@ci; + return wantarray ? @ci : $ci[0]; } #}}} @@ -274,10 +271,12 @@ sub git_sha1 (;$) { #{{{ my $file = shift || q{--}; - my ($sha1) = run_or_die('git-rev-list', '--max-count=1', 'HEAD', $file); - ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1sum is untainted now - debug("Empty sha1sum for '$file'.") if !length $sha1; - return $sha1; + # Ignore error since a non-existing file might be given. + my ($sha1) = run_or_non('git-rev-list', '--max-count=1', 'HEAD', $file); + if ($sha1) { + ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now + } else { debug("Empty sha1sum for '$file'.") } + return defined $sha1 ? $sha1 : q{}; } #}}} sub rcs_update () { #{{{ @@ -292,8 +291,7 @@ sub rcs_prepedit ($) { #{{{ my ($file) = @_; - my $sha1 = git_sha1($file); - return defined $sha1 ? $sha1 : q{}; + return git_sha1($file); } #}}} sub rcs_commit ($$$) { #{{{ @@ -313,7 +311,7 @@ sub rcs_commit ($$$) { #{{{ # Check to see if the page has been changed by someone else since # rcs_prepedit was called. my $cur = git_sha1($file); - my ($prev) = $rcstoken =~ m/^$sha1_pattern$/; # untaint + my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint if (defined $cur && defined $prev && $cur ne $prev) { my $conflict = _merge_past($prev, $file, $dummy_commit_msg); @@ -322,6 +320,7 @@ sub rcs_commit ($$$) { #{{{ # git-commit(1) 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', '-m', $message, '-i', $file)) { unlockwiki(); run_or_cry('git-push', $origin_branch); @@ -343,9 +342,8 @@ sub rcs_recentchanges ($) { #{{{ my ($num) = @_; - eval q{use CGI 'escapeHTML'}; eval q{use Date::Parse}; - eval q{use Time::Duration}; + error($@) if $@; my ($sha1, $type, $when, $diffurl, $user, @pages, @message, @rets); INFO: foreach my $ci (git_commit_info('HEAD', $num)) { @@ -356,29 +354,29 @@ sub rcs_recentchanges ($) { #{{{ $sha1 = $ci->{'sha1'}; $type = "web"; - $when = concise(ago(time - $ci->{'author_epoch'})); + $when = time - $ci->{'author_epoch'}; - foreach my $bit (@{ $ci->{'details'} }) { + DETAIL: foreach my $detail (@{ $ci->{'details'} }) { my $diffurl = $config{'diffurl'}; - my $file = $bit->{'file'}; + my $file = $detail->{'file'}; $diffurl =~ s/\[\[file\]\]/$file/go; $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go; - $diffurl =~ s/\[\[sha1_from\]\]/$bit->{'sha1_from'}/go; - $diffurl =~ s/\[\[sha1_to\]\]/$bit->{'sha1_to'}/go; + $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go; + $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go; push @pages, { - link => htmllink("", pagename($file), 1), + page => pagename($file), diffurl => $diffurl, - }, + }; } - push @message, { line => escapeHTML($title) }; + push @message, { line => $title }; if (defined $message[0] && - $message[0]->{line} =~ m/$web_commit_msg/) { - $user = "$1"; - $message[0]->{line} = $2; + $message[0]->{line} =~ m/$config{web_commit_regexp}/) { + $user=defined $2 ? "$2" : "$3"; + $message[0]->{line}=$4; } else { $type ="git"; $user = $ci->{'author_username'}; @@ -386,7 +384,7 @@ sub rcs_recentchanges ($) { #{{{ push @rets, { rev => $sha1, - user => htmllink("", $user, 1), + user => $user, committype => $type, when => $when, message => [@message], @@ -420,59 +418,27 @@ sub rcs_notify () { #{{{ my $sha1 = 'HEAD'; # the commit which triggers this action my $ci = git_commit_info($sha1); - if (!defined $ci) { - warn "Cannot parse info for '$sha1' commit"; - return; - } + return if !defined $ci; my @changed_pages = map { $_->{'file'} } @{ $ci->{'details'} }; my ($user, $message); - if (@{ $ci->{'comment'} }[0] =~ m/$web_commit_msg/) { - $user = "$1"; - $message = $2; + if (@{ $ci->{'comment'} }[0] =~ m/$config{web_commit_regexp}/) { + $user = defined $2 ? "$2" : "$3"; + $message = $4; } else { $user = $ci->{'author_username'}; $message = join "\n", @{ $ci->{'comment'} }; } require IkiWiki::UserInfo; - my @email_recipients = commit_notify_list($user, @changed_pages); - return if !@email_recipients; - - # TODO: if a commit spans multiple pages, this will send - # subscribers a diff that might contain pages they did not - # sign up for. Should separate the diff per page and - # reassemble into one mail with just the pages subscribed to. - my $diff = join "\n", run_or_die('git-diff', "${sha1}^", $sha1); - - my $subject = "$config{wikiname} update of "; - if (@changed_pages > 2) { - $subject .= "$changed_pages[0] $changed_pages[1] etc"; - } else { - $subject .= join " ", @changed_pages; - } - $subject .= " by $user"; - - my $template = HTML::Template->new( - filename => "$config{templatedir}/notifymail.tmpl" - ); - $template->param( - wikiname => $config{wikiname}, - diff => $diff, - user => $user, - message => $message, - ); - - eval q{use Mail::Sendmail}; - foreach my $email (@email_recipients) { - sendmail( - To => $email, - From => "$config{wikiname} <$config{adminemail}>", - Subject => $subject, - Message => $template->output, - ) or error("Failed to send update notification mail: $!"); - } + send_commit_mails( + sub { + $message; + }, + sub { + join "\n", run_or_die('git-diff', "${sha1}^", $sha1); + }, $user, @changed_pages); } #}}} sub rcs_getctime ($) { #{{{