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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# SPDX-License-Identifier: GPL-2.0-or-later
# Copyright (C) 2020 by the Linux Foundation
#
__author__ = 'Konstantin Ryabitsev <konstantin@linuxfoundation.org>'
import os
import sys
import b4
import re
import email
import email.message
import json
from string import Template
from email import utils
from pathlib import Path
logger = b4.logger
DEFAULT_PR_TEMPLATE = """
On ${sentdate}, ${fromname} wrote:
${quote}
Merged, thanks!
${summary}
Best regards,
--
${signature}
"""
DEFAULT_AM_TEMPLATE = """
On ${sentdate}, ${fromname} wrote:
${quote}
Applied, thanks!
${summary}
Best regards,
--
${signature}
"""
# Used to track commits created by current user
MY_COMMITS = None
# Used to track additional branch info
BRANCH_INFO = None
def git_get_merge_id(gitdir, commit_id, branch=None):
# get merge commit id
args = ['rev-list', '%s..' % commit_id, '--ancestry-path']
if branch is not None:
args += [branch]
lines = b4.git_get_command_lines(gitdir, args)
if not len(lines):
return None
return lines[-1]
def git_get_rev_diff(gitdir, rev):
args = ['diff', '%s~..%s' % (rev, rev)]
return b4.git_run_command(gitdir, args)
def git_get_commit_message(gitdir, rev):
args = ['log', '--format=%B', '-1', rev]
return b4.git_run_command(gitdir, args)
def make_reply(reply_template, jsondata):
body = Template(reply_template).safe_substitute(jsondata)
# Conform to email standards
body = body.replace('\n', '\r\n')
msg = email.message_from_string(body)
msg['From'] = '%s <%s>' % (jsondata['myname'], jsondata['myemail'])
allto = utils.getaddresses([jsondata['to']])
allcc = utils.getaddresses([jsondata['cc']])
# Remove ourselves and original sender from allto or allcc
for entry in list(allto):
if entry[1] == jsondata['myemail'] or entry[1] == jsondata['fromemail']:
allto.remove(entry)
for entry in list(allcc):
if entry[1] == jsondata['myemail'] or entry[1] == jsondata['fromemail']:
allcc.remove(entry)
# Add original sender to the To
allto.append((jsondata['fromname'], jsondata['fromemail']))
msg['To'] = b4.format_addrs(allto)
msg['Cc'] = b4.format_addrs(allcc)
msg['In-Reply-To'] = '<%s>' % jsondata['msgid']
if len(jsondata['references']):
msg['References'] = '%s <%s>' % (jsondata['references'], jsondata['msgid'])
else:
msg['References'] = '<%s>' % jsondata['msgid']
if jsondata['subject'].find('Re: ') < 0:
msg['Subject'] = 'Re: %s' % jsondata['subject']
else:
msg['Subject'] = jsondata['subject']
mydomain = jsondata['myemail'].split('@')[1]
msg['Message-Id'] = email.utils.make_msgid(idstring='b4-ty', domain=mydomain)
return msg
def auto_locate_pr(gitdir, jsondata, branch):
pr_commit_id = jsondata['pr_commit_id']
logger.debug('Checking %s', jsondata['pr_commit_id'])
if not b4.git_commit_exists(gitdir, pr_commit_id):
return None
onbranches = b4.git_branch_contains(gitdir, pr_commit_id)
if not len(onbranches):
logger.debug('%s is not on any branches', pr_commit_id)
return None
if branch not in onbranches:
logger.debug('%s is not on branch %s', pr_commit_id, branch)
return None
# Get the merge commit
merge_commit_id = git_get_merge_id(gitdir, pr_commit_id, branch)
if not merge_commit_id:
logger.debug('Could not get a merge commit-id for %s', pr_commit_id)
return None
# Check that we are the author of the merge commit
gitargs = ['show', '--format=%ae', merge_commit_id]
out = b4.git_get_command_lines(gitdir, gitargs)
if not out:
logger.debug('Could not get merge commit author for %s', pr_commit_id)
return None
usercfg = b4.get_user_config()
if usercfg['email'] not in out:
logger.debug('Merged by a different author, ignoring %s', pr_commit_id)
logger.debug('Author: %s', out[0])
return None
return merge_commit_id
def get_all_commits(gitdir, branch, since='1.week', committer=None):
global MY_COMMITS
if MY_COMMITS is not None:
return MY_COMMITS
MY_COMMITS = dict()
if committer is None:
usercfg = b4.get_user_config()
committer = usercfg['email']
gitargs = ['log', '--committer', committer, '--no-abbrev', '--oneline', '--since', since, branch]
lines = b4.git_get_command_lines(gitdir, gitargs)
if not len(lines):
logger.debug('No new commits from the current user --since=%s', since)
return MY_COMMITS
logger.info('Found %s of your commits since %s', len(lines), since)
logger.info('Calculating patch hashes, may take a moment...')
# Get patch hash of each commit
for line in lines:
commit_id, subject = line.split(maxsplit=1)
ecode, out = git_get_rev_diff(gitdir, commit_id)
pwhash = b4.LoreMessage.get_patchwork_hash(out)
logger.debug('phash=%s', pwhash)
# get all message-id or link trailers
ecode, out = git_get_commit_message(gitdir, commit_id)
matches = re.findall(r'^\s*(?:message-id|link):[ \t]+(\S+)\s*$', out, flags=re.I | re.M)
trackers = list()
if matches:
for tvalue in matches:
trackers.append(tvalue)
MY_COMMITS[pwhash] = (commit_id, subject, trackers)
return MY_COMMITS
def auto_locate_series(gitdir, jsondata, branch, since='1.week'):
commits = get_all_commits(gitdir, branch, since)
patchids = set(commits.keys())
# We need to find all of them in the commits
found = list()
matches = 0
for patch in jsondata['patches']:
logger.debug('Checking %s', patch)
if patch[1] in patchids:
logger.debug('Found: %s', patch[0])
found.append(commits[patch[1]])
matches += 1
else:
# try to locate by subject
success = False
for pwhash, commit in commits.items():
if commit[1] == patch[0]:
logger.debug('Matched using subject')
found.append(commit)
success = True
matches += 1
break
elif len(patch) > 2 and len(patch[2]) and len(commit[2]):
for tracker in commit[2]:
if tracker.find(patch[2]) >= 0:
logger.debug('Matched using recorded message-id')
found.append(commit)
success = True
matches += 1
break
if success:
break
if not success:
logger.debug(' Failed to find a match for: %s', patch[0])
found.append((None, patch[0]))
return found
def read_template(tptfile):
# bubbles up FileNotFound
tpt = ''
if tptfile.find('~') >= 0:
tptfile = os.path.expanduser(tptfile)
if tptfile.find('$') >= 0:
tptfile = os.path.expandvars(tptfile)
with open(tptfile, 'r', encoding='utf-8') as fh:
for line in fh:
if len(line) and line[0] == '#':
continue
tpt += line
return tpt
def set_branch_details(gitdir, branch, jsondata, config):
binfo = get_branch_info(gitdir, branch)
jsondata['branch'] = branch
for key, val in binfo.items():
if key == 'b4-treename':
config['thanks-treename'] = val
elif key == 'b4-commit-url-mask':
config['thanks-commit-url-mask'] = val
elif key == 'b4-pr-template':
config['thanks-pr-template'] = val
elif key == 'b4-am-template':
config['thanks-am-template'] = val
elif key == 'branch':
jsondata['branch'] = val
if 'thanks-treename' in config:
jsondata['treename'] = config['thanks-treename']
elif 'url' in binfo:
# noinspection PyBroadException
try:
# Try to grab the last two chunks of the path
purl = Path(binfo['url'])
jsondata['treename'] = os.path.join(purl.parts[-2], purl.parts[-1])
except:
# Something went wrong... just use the whole URL
jsondata['treename'] = binfo['url']
else:
jsondata['treename'] = 'local tree'
return jsondata, config
def generate_pr_thanks(gitdir, jsondata, branch):
config = b4.get_main_config()
jsondata, config = set_branch_details(gitdir, branch, jsondata, config)
thanks_template = DEFAULT_PR_TEMPLATE
if config['thanks-pr-template']:
# Try to load this template instead
try:
thanks_template = read_template(config['thanks-pr-template'])
except FileNotFoundError:
logger.critical('ERROR: thanks-pr-template says to use %s, but it does not exist',
config['thanks-pr-template'])
sys.exit(2)
if 'merge_commit_id' not in jsondata:
merge_commit_id = git_get_merge_id(gitdir, jsondata['pr_commit_id'])
if not merge_commit_id:
logger.critical('Could not get merge commit id for %s', jsondata['subject'])
logger.critical('Was it actually merged?')
sys.exit(1)
jsondata['merge_commit_id'] = merge_commit_id
# Make a summary
cidmask = config['thanks-commit-url-mask']
if not cidmask:
cidmask = 'merge commit: %s'
jsondata['summary'] = cidmask % jsondata['merge_commit_id']
msg = make_reply(thanks_template, jsondata)
return msg
def generate_am_thanks(gitdir, jsondata, branch, since):
config = b4.get_main_config()
jsondata, config = set_branch_details(gitdir, branch, jsondata, config)
thanks_template = DEFAULT_AM_TEMPLATE
if config['thanks-am-template']:
# Try to load this template instead
try:
thanks_template = read_template(config['thanks-am-template'])
except FileNotFoundError:
logger.critical('ERROR: thanks-am-template says to use %s, but it does not exist',
config['thanks-am-template'])
sys.exit(2)
if 'commits' not in jsondata:
commits = auto_locate_series(gitdir, jsondata, branch, since)
else:
commits = jsondata['commits']
cidmask = config['thanks-commit-url-mask']
if not cidmask:
cidmask = 'commit: %s'
slines = list()
counter = 0
nomatch = 0
padlen = len(str(len(commits)))
for commit in commits:
counter += 1
prefix = '[%s/%s] ' % (str(counter).zfill(padlen), len(commits))
slines.append('%s%s' % (prefix, commit[1]))
if commit[0] is None:
slines.append('%s(no commit info)' % (' ' * len(prefix)))
nomatch += 1
else:
slines.append('%s%s' % (' ' * len(prefix), cidmask % commit[0]))
jsondata['summary'] = '\n'.join(slines)
if nomatch == counter:
logger.critical(' WARNING: None of the patches matched for: %s', jsondata['subject'])
logger.critical(' Please review the resulting message')
elif nomatch > 0:
logger.critical(' WARNING: Could not match %s of %s patches in: %s', nomatch, counter, jsondata['subject'])
logger.critical(' Please review the resulting message')
msg = make_reply(thanks_template, jsondata)
return msg
def auto_thankanator(cmdargs):
gitdir = cmdargs.gitdir
wantbranch = get_wanted_branch(cmdargs)
logger.info('Auto-thankanating commits in %s', wantbranch)
tracked = list_tracked()
if not len(tracked):
logger.info('Nothing to do')
sys.exit(0)
applied = list()
for jsondata in tracked:
if 'pr_commit_id' in jsondata:
# this is a pull request
merge_commit_id = auto_locate_pr(gitdir, jsondata, wantbranch)
if merge_commit_id is None:
continue
jsondata['merge_commit_id'] = merge_commit_id
else:
# This is a patch series
commits = auto_locate_series(gitdir, jsondata, wantbranch, since=cmdargs.since)
if commits is None:
continue
jsondata['commits'] = commits
applied.append(jsondata)
logger.info(' Located: %s', jsondata['subject'])
if not len(applied):
logger.info('Nothing to do')
sys.exit(0)
logger.info('---')
send_messages(applied, cmdargs.gitdir, cmdargs.outdir, wantbranch, since=cmdargs.since)
sys.exit(0)
def send_messages(listing, gitdir, outdir, branch, since='1.week'):
# Not really sending, but writing them out to be sent on your own
# We'll probably gain ability to send these once the feature is
# more mature and we're less likely to mess things up
datadir = b4.get_data_dir()
logger.info('Generating %s thank-you letters', len(listing))
# Check if the outdir exists and if it has any .thanks files in it
if not os.path.exists(outdir):
os.mkdir(outdir)
usercfg = b4.get_user_config()
# Do we have a .signature file?
sigfile = os.path.join(str(Path.home()), '.signature')
if os.path.exists(sigfile):
with open(sigfile, 'r', encoding='utf-8') as fh:
signature = fh.read()
else:
signature = '%s <%s>' % (usercfg['name'], usercfg['email'])
outgoing = 0
for jsondata in listing:
slug_from = re.sub(r'\W', '_', jsondata['fromemail'])
slug_subj = re.sub(r'\W', '_', jsondata['subject'])
slug = '%s_%s' % (slug_from.lower(), slug_subj.lower())
slug = re.sub(r'_+', '_', slug)
jsondata['myname'] = usercfg['name']
jsondata['myemail'] = usercfg['email']
jsondata['signature'] = signature
if 'pr_commit_id' in jsondata:
# This is a pull request
msg = generate_pr_thanks(gitdir, jsondata, branch)
else:
# This is a patch series
msg = generate_am_thanks(gitdir, jsondata, branch, since)
if msg is None:
continue
outgoing += 1
outfile = os.path.join(outdir, '%s.thanks' % slug)
logger.info(' Writing: %s', outfile)
bout = msg.as_string(policy=b4.emlpolicy)
with open(outfile, 'wb') as fh:
fh.write(bout.encode('utf-8'))
logger.debug('Cleaning up: %s', jsondata['trackfile'])
fullpath = os.path.join(datadir, jsondata['trackfile'])
os.rename(fullpath, '%s.sent' % fullpath)
logger.info('---')
if not outgoing:
logger.info('No thanks necessary.')
return
logger.debug('Wrote %s thank-you letters', outgoing)
logger.info('You can now run:')
logger.info(' git send-email %s/*.thanks', outdir)
def list_tracked():
# find all tracked bits
tracked = list()
datadir = b4.get_data_dir()
paths = sorted(Path(datadir).iterdir(), key=os.path.getmtime)
for fullpath in paths:
if fullpath.suffix not in ('.pr', '.am'):
continue
with fullpath.open('r', encoding='utf-8') as fh:
jsondata = json.load(fh)
jsondata['trackfile'] = fullpath.name
if fullpath.suffix == '.pr':
jsondata['pr_commit_id'] = fullpath.stem
tracked.append(jsondata)
return tracked
def write_tracked(tracked):
counter = 1
config = b4.get_main_config()
logger.info('Currently tracking:')
for entry in tracked:
logger.info('%3d: %s', counter, entry['subject'])
logger.info(' From: %s <%s>', entry['fromname'], entry['fromemail'])
logger.info(' Date: %s', entry['sentdate'])
logger.info(' Link: %s', config['linkmask'] % entry['msgid'])
counter += 1
def send_selected(cmdargs):
tracked = list_tracked()
if not len(tracked):
logger.info('Nothing to do')
sys.exit(0)
if cmdargs.send == 'all':
listing = tracked
else:
listing = list()
for num in b4.parse_int_range(cmdargs.send, upper=len(tracked)):
try:
index = int(num) - 1
listing.append(tracked[index])
except ValueError:
logger.critical('Please provide the number of the message')
logger.info('---')
write_tracked(tracked)
sys.exit(1)
except IndexError:
logger.critical('Invalid index: %s', num)
logger.info('---')
write_tracked(tracked)
sys.exit(1)
if not len(listing):
logger.info('Nothing to do')
sys.exit(0)
wantbranch = get_wanted_branch(cmdargs)
send_messages(listing, cmdargs.gitdir, cmdargs.outdir, wantbranch, cmdargs.since)
sys.exit(0)
def discard_selected(cmdargs):
tracked = list_tracked()
if not len(tracked):
logger.info('Nothing to do')
sys.exit(0)
if cmdargs.discard == 'all':
listing = tracked
else:
listing = list()
for num in b4.parse_int_range(cmdargs.discard, upper=len(tracked)):
try:
index = int(num) - 1
listing.append(tracked[index])
except ValueError:
logger.critical('Please provide the number of the message')
logger.info('---')
write_tracked(tracked)
sys.exit(1)
except IndexError:
logger.critical('Invalid index: %s', num)
logger.info('---')
write_tracked(tracked)
sys.exit(1)
if not len(listing):
logger.info('Nothing to do')
sys.exit(0)
datadir = b4.get_data_dir()
logger.info('Discarding %s messages', len(listing))
for jsondata in listing:
fullpath = os.path.join(datadir, jsondata['trackfile'])
os.rename(fullpath, '%s.discarded' % fullpath)
logger.info(' Discarded: %s', jsondata['subject'])
sys.exit(0)
def check_stale_thanks(outdir):
if os.path.exists(outdir):
for entry in Path(outdir).iterdir():
if entry.suffix == '.thanks':
logger.critical('ERROR: Found existing .thanks files in: %s', outdir)
logger.critical(' Please send them first (or delete if already sent).')
logger.critical(' Refusing to run to avoid potential confusion.')
sys.exit(1)
def get_wanted_branch(cmdargs):
global BRANCH_INFO
gitdir = cmdargs.gitdir
if not cmdargs.branch:
# Find out our current branch
gitargs = ['symbolic-ref', '-q', 'HEAD']
ecode, out = b4.git_run_command(gitdir, gitargs)
if ecode > 0:
logger.critical('Not able to get current branch (git symbolic-ref HEAD)')
sys.exit(1)
wantbranch = re.sub(r'^refs/heads/', '', out.strip())
logger.debug('will check branch=%s', wantbranch)
else:
# Make sure it's a real branch
gitargs = ['branch', '--format=%(refname:short)', '--list', '--all']
lines = b4.git_get_command_lines(gitdir, gitargs)
if not len(lines):
logger.critical('Not able to get a list of branches (git branch --list --all)')
sys.exit(1)
if cmdargs.branch not in lines:
logger.critical('Requested branch %s not found in git branch --list --all', cmdargs.branch)
sys.exit(1)
wantbranch = cmdargs.branch
return wantbranch
def get_branch_info(gitdir, branch):
global BRANCH_INFO
if BRANCH_INFO is not None:
return BRANCH_INFO
BRANCH_INFO = dict()
remotecfg = b4.get_config_from_git('branch\\.%s\\.*' % branch)
if remotecfg is None or 'remote' not in remotecfg:
# Not found any matching remotes
return BRANCH_INFO
BRANCH_INFO['remote'] = remotecfg['remote']
if 'merge' in remotecfg:
BRANCH_INFO['branch'] = re.sub(r'^refs/heads/', '', remotecfg['merge'])
# Grab template overrides
remotecfg = b4.get_config_from_git('remote\\.%s\\..*' % remotecfg['remote'])
BRANCH_INFO.update(remotecfg)
return BRANCH_INFO
def main(cmdargs):
usercfg = b4.get_user_config()
if 'email' not in usercfg:
logger.critical('Please set user.email in gitconfig to use this feature.')
sys.exit(1)
if cmdargs.auto:
check_stale_thanks(cmdargs.outdir)
auto_thankanator(cmdargs)
elif cmdargs.send:
check_stale_thanks(cmdargs.outdir)
send_selected(cmdargs)
elif cmdargs.discard:
discard_selected(cmdargs)
else:
tracked = list_tracked()
if not len(tracked):
logger.info('No thanks necessary.')
sys.exit(0)
write_tracked(tracked)
logger.info('---')
logger.info('You can send them using number ranges, e.g:')
logger.info(' b4 ty -s 1-3,5,7-')
|