1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
#!/usr/bin/env perl
# Copyright (c) MediaTek USA Inc., 2020-2024
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or (at
# your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see
# <http://www.gnu.org/licenses/>.
#
#
# gitblame [--p4] [--prefix path] [--abbrev regexp] [--cache dir] [domain] pathname
#
# This script runs "git blame" for the specified file and formats the result
# to match the diffcov(1) age/ownership annotation specification.
#
# If the '--cache' flag is used:
# Goal is to improve runtime performance by not calling GIT if file is
# unchanged and previous result is available.
# - First look into the provided cache before calling GIT.
# Hope to find that we already have data for the file we wanted.
# - If we do call GIT - then store the result back into cache.
# Note that this callback uses the `--version-script' (if specified)
# to extract and compare file versions.
# Also note that ignoring "version" errors will disable version checking
# of cached files - and may result in out-of-sync annotated file data.
#
# If the '--p4' flag is used:
# we assume that the GIT repo is cloned from Perforce - and look for
# the line in the generated commit log message which tells us the perforce
# changelist ID that we actually want.
#
# If specified, 'path' is prependied to 'pathname' (as 'path/pathname')
# before processing.
#
# If passed a domain name (or domain regexp):
# strip that domain from the author's address, and treat all users outside
# the matching domain as "External".
# The --abbrev argument enables you to specify one or more regexp patterns
# which are used to compute the user name abbreviation that are applied.
package gitblame;
use strict;
use File::Basename qw(dirname basename);
use File::Spec;
use Getopt::Long qw(GetOptionsFromArray);
use Cwd qw(abs_path);
use annotateutil qw(not_in_repo
resolve_cache_dir find_in_cache store_in_cache);
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(new);
use constant {
P4 => 0,
ABBREV => 1,
PREFIX => 2,
SCRIPT => 3,
CACHE => 4,
};
sub new
{
my $class = shift;
my $script = shift;
my $mapP4;
my $cache_dir;
my $prefix;
my @args = @_;
my @abbrev;
my $exe = basename($script ? $script : $0);
my $standalone = $script eq $0;
my $help;
if (!GetOptionsFromArray(\@_,
("p4" => \$mapP4,
"prefix:s" => \$prefix,
'abbrev:s' => \@abbrev,
'cache:s' => \$cache_dir,
'help' => \$help)) ||
(scalar(@_) >= 2) ||
$help
) {
print(STDERR
"usage: $exe [--p4] [--abbrev regexp]* [--cache dir] [domain] pathname\n"
);
exit(scalar(@_) >= 2 && $help ? 0 : 1) if $standalone;
return undef;
}
my $internal_domain = shift;
if ($internal_domain) {
push(@abbrev, 's/^([^@]+)\@' . $internal_domain . '$/$1/');
push(@abbrev, 's/^([^@]+)\@.+$/External/');
# else leave domain in place
}
$cache_dir = resolve_cache_dir($cache_dir);
my @prefix;
push(@prefix, $prefix) if $prefix;
my $self = [$mapP4, \@abbrev, \@prefix, $exe, $cache_dir];
return bless $self, $class;
}
sub annotate
{
my ($self, $file) = @_;
# do we have a cached version of this file?
my ($cachepath, $version);
if ($self->[CACHE]) {
my $lines;
($cachepath, $version, $lines) = find_in_cache($self->[CACHE], $file);
return (0, $lines) if defined($lines); # cache hit
}
my $pathname = File::Spec->catfile(@{$self->[PREFIX]}, $file);
# if running as module, then context might be available
my $context = '';
eval { $context = MessageContext::context(); };
unless (defined($pathname) &&
(-f $pathname || -l $pathname) &&
-r $pathname) {
$context = ':' . $context if $context;
die($self->[SCRIPT] . $context . ' expected readable file, found \'' .
(defined($pathname) ? $pathname : '<undef>') . "'");
}
# set working directory to account for nested repos and submodules
my $dir = dirname($pathname);
my $basename = basename($pathname);
-d $dir or die("no such directory '$dir'$context");
my %changelists;
my $status = 0;
my @lines;
my $null = File::Spec->devnull();
if (0 == system("cd $dir ; git rev-parse --show-toplevel >$null 2>&1")) {
# in a git repo
if (0 == system(
"cd $dir ; git ls-files --error-unmatch $basename >$null 2>&1")
) {
# matched a tracked pathname
my $matched;
if (
open(HANDLE, "-|",
"cd $dir ; git blame -e $basename 2> /dev/null")
) {
my %abbrev; # user name abbreviations
while (my $line = <HANDLE>) {
chomp $line;
# Also remove CR from line-end
s/\015$//;
if ($line =~
m/^(\S+)[^(]+\(<([^>]*)>\s+([-0-9]+\s+[0-9:]+\s+[-+0-9]+)\s+([0-9]+)\) (.*)$/
) {
my $commit = $1;
my $owner = $2; # apparently, this can be empty
my $when = $3;
my $text = $5;
# found empty name in .../clang/include/AST/StmtOpenMP.h
$owner = 'unknown@nowhere.com' unless $owner;
if ($self->[P4]) {
if (!exists($changelists{$commit})) {
if (
open(GITLOG, '-|',
"cd $dir ; git show -s $commit")
) {
while (my $l = <GITLOG>) {
# p4sync puts special comment in commit log.
# pull the CL out of that.
if ($l =~ /git-p4:.+change = ([0-9]+)/)
{
$changelists{$commit} = $1;
$commit = $1;
last;
}
}
} else {
die("unable to execute 'git show -s $commit'$context: $!"
);
}
close(GITLOG) or die("unable to close$context");
} else {
$commit = $changelists{$commit};
}
}
# line owner filtering to canonical form
$owner =~ s/ dot /./g;
$owner =~ s/ at /\@/;
my $fullname = $owner;
if (exists($abbrev{$fullname})) {
$owner = $abbrev{$fullname};
} else {
# compute only once...
foreach my $re (@{$self->[ABBREV]}) {
## strip domain part for internal users...
eval '$owner =~ ' . $re . ';';
die("invalid domain pattern '$re'$context: $@")
if $@;
}
$abbrev{$fullname} = $owner;
}
# Convert Git date/time to diffcov canonical format
# replace space between date and time with 'T'
$when =~ s/\s/T/;
# remove space between time and zone offset
$when =~ s/\s//;
# insert ':' between hour and minute digits of zone offset
$when =~ s/([0-9][0-9])$/:$1/;
# ';' is not a legal character in an email address -
# so use it as a delimiter
push(@lines,
[$text, $owner, $fullname, $when, $commit]);
# expect all lines to eitehr match the git blame regexp
# or none of them to match
die("$basename has both matching and not matching lines$context"
) if defined($matched) && !$matched;
$matched = 1;
} else {
push(@lines, [$line, "NONE", undef, "NONE", "NONE"]);
# expect all lines to eitehr match the git blame regexp
# or none of them to match
die("$basename has both not matching and matching lines$context"
) if defined($matched) && $matched;
$matched = 0;
}
}
close(HANDLE) or
die("unable to close git blame pipe$context: $!\n");
$status = $?;
#if (0 != $?) {
# $? & 0x7F &
# die("git blame died from signal ", ($? & 0x7F), "\n");
# die("git blame exited with error ", ($? >> 8), "\n");
#}
if (0 == $status &&
defined($cachepath)) {
store_in_cache($cachepath, $file, $version, \@lines);
}
return ($status, \@lines);
}
}
}
# fallthrough from error conditions
not_in_repo($pathname, \@lines);
return ($status, \@lines);
}
1;
|
