blob: 933f97cc86f2b49c2994f4772b7d82d20a68633d [file] [log] [blame]
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +00001#!/usr/bin/env python
2# Copyright (c) 2012 The Chromium Authors. All rights reserved.
3# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
6"""Get stats about your activity.
7
8Example:
9 - my_activity.py for stats for the current week (last week on mondays).
10 - my_activity.py -Q for stats for last quarter.
11 - my_activity.py -Y for stats for this year.
12 - my_activity.py -b 4/5/12 for stats since 4/5/12.
13 - my_activity.py -b 4/5/12 -e 6/7/12 for stats between 4/5/12 and 6/7/12.
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +000014 - my_activity.py -jd to output stats for the week to json with deltas data.
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000015"""
16
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000017# TODO(vadimsh): This script knows too much about ClientLogin and cookies. It
18# will stop to work on ~20 Apr 2015.
19
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000020# These services typically only provide a created time and a last modified time
21# for each item for general queries. This is not enough to determine if there
22# was activity in a given time period. So, we first query for all things created
23# before end and modified after begin. Then, we get the details of each item and
24# check those details to determine if there was activity in the given period.
25# This means that query time scales mostly with (today() - begin).
26
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000027from datetime import datetime
28from datetime import timedelta
29from functools import partial
30import json
Tobias Sargeantffb3c432017-03-08 14:09:14 +000031import logging
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000032import optparse
33import os
34import subprocess
Tobias Sargeantffb3c432017-03-08 14:09:14 +000035from string import Formatter
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000036import sys
37import urllib
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +000038import re
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000039
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000040import auth
stevefung@chromium.org832d51e2015-05-27 12:52:51 +000041import fix_encoding
deymo@chromium.orgf8be2762013-11-06 01:01:59 +000042import gerrit_util
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000043import rietveld
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000044
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +000045from third_party import httplib2
46
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000047try:
Tobias Sargeantffb3c432017-03-08 14:09:14 +000048 import dateutil # pylint: disable=import-error
49 import dateutil.parser
50 from dateutil.relativedelta import relativedelta
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000051except ImportError:
Tobias Sargeantffb3c432017-03-08 14:09:14 +000052 logging.error('python-dateutil package required')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000053 exit(1)
54
Tobias Sargeantffb3c432017-03-08 14:09:14 +000055
56class DefaultFormatter(Formatter):
57 def __init__(self, default = ''):
58 super(DefaultFormatter, self).__init__()
59 self.default = default
60
61 def get_value(self, key, args, kwds):
62 if isinstance(key, basestring) and key not in kwds:
63 return self.default
64 return Formatter.get_value(self, key, args, kwds)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000065
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000066rietveld_instances = [
67 {
68 'url': 'codereview.chromium.org',
69 'shorturl': 'crrev.com',
70 'supports_owner_modified_query': True,
71 'requires_auth': False,
72 'email_domain': 'chromium.org',
Varun Khanejad9f97bc2017-08-02 12:55:01 -070073 'short_url_protocol': 'https',
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +000074 },
75 {
76 'url': 'chromereviews.googleplex.com',
77 'shorturl': 'go/chromerev',
78 'supports_owner_modified_query': True,
79 'requires_auth': True,
80 'email_domain': 'google.com',
81 },
82 {
83 'url': 'codereview.appspot.com',
84 'supports_owner_modified_query': True,
85 'requires_auth': False,
86 'email_domain': 'chromium.org',
87 },
88 {
89 'url': 'breakpad.appspot.com',
90 'supports_owner_modified_query': False,
91 'requires_auth': False,
92 'email_domain': 'chromium.org',
93 },
94]
95
96gerrit_instances = [
97 {
deymo@chromium.org6c039202013-09-12 12:28:12 +000098 'url': 'chromium-review.googlesource.com',
Jeremy Romanf475a472017-06-06 16:49:11 -040099 'shorturl': 'crrev.com/c',
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700100 'short_url_protocol': 'https',
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000101 },
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000102 {
103 'url': 'chrome-internal-review.googlesource.com',
Jeremy Romanf475a472017-06-06 16:49:11 -0400104 'shorturl': 'crrev.com/i',
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700105 'short_url_protocol': 'https',
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000106 },
deymo@chromium.org56dc57a2015-09-10 18:26:54 +0000107 {
108 'url': 'android-review.googlesource.com',
109 },
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000110]
111
112google_code_projects = [
113 {
114 'name': 'chromium',
115 'shorturl': 'crbug.com',
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700116 'short_url_protocol': 'https',
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000117 },
118 {
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000119 'name': 'google-breakpad',
120 },
121 {
122 'name': 'gyp',
enne@chromium.orgf01fad32012-11-26 18:09:38 +0000123 },
124 {
125 'name': 'skia',
126 },
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000127]
128
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000129def username(email):
130 """Keeps the username of an email address."""
131 return email and email.split('@', 1)[0]
132
133
cjhopman@chromium.org426557a2012-10-22 20:18:52 +0000134def datetime_to_midnight(date):
135 return date - timedelta(hours=date.hour, minutes=date.minute,
136 seconds=date.second, microseconds=date.microsecond)
137
138
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000139def get_quarter_of(date):
cjhopman@chromium.org426557a2012-10-22 20:18:52 +0000140 begin = (datetime_to_midnight(date) -
141 relativedelta(months=(date.month % 3) - 1, days=(date.day - 1)))
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000142 return begin, begin + relativedelta(months=3)
143
144
145def get_year_of(date):
cjhopman@chromium.org426557a2012-10-22 20:18:52 +0000146 begin = (datetime_to_midnight(date) -
147 relativedelta(months=(date.month - 1), days=(date.day - 1)))
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000148 return begin, begin + relativedelta(years=1)
149
150
151def get_week_of(date):
cjhopman@chromium.org426557a2012-10-22 20:18:52 +0000152 begin = (datetime_to_midnight(date) - timedelta(days=date.weekday()))
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000153 return begin, begin + timedelta(days=7)
154
155
156def get_yes_or_no(msg):
157 while True:
158 response = raw_input(msg + ' yes/no [no] ')
159 if response == 'y' or response == 'yes':
160 return True
161 elif not response or response == 'n' or response == 'no':
162 return False
163
164
deymo@chromium.org6c039202013-09-12 12:28:12 +0000165def datetime_from_gerrit(date_string):
166 return datetime.strptime(date_string, '%Y-%m-%d %H:%M:%S.%f000')
167
168
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000169def datetime_from_rietveld(date_string):
deymo@chromium.org29eb6e62014-03-20 01:55:55 +0000170 try:
171 return datetime.strptime(date_string, '%Y-%m-%d %H:%M:%S.%f')
172 except ValueError:
173 # Sometimes rietveld returns a value without the milliseconds part, so we
174 # attempt to parse those cases as well.
175 return datetime.strptime(date_string, '%Y-%m-%d %H:%M:%S')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000176
177
178def datetime_from_google_code(date_string):
179 return datetime.strptime(date_string, '%Y-%m-%dT%H:%M:%S.%fZ')
180
181
182class MyActivity(object):
183 def __init__(self, options):
184 self.options = options
185 self.modified_after = options.begin
186 self.modified_before = options.end
187 self.user = options.user
188 self.changes = []
189 self.reviews = []
190 self.issues = []
191 self.check_cookies()
192 self.google_code_auth_token = None
193
194 # Check the codereview cookie jar to determine which Rietveld instances to
195 # authenticate to.
196 def check_cookies(self):
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000197 filtered_instances = []
198
199 def has_cookie(instance):
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000200 auth_config = auth.extract_auth_config_from_options(self.options)
201 a = auth.get_authenticator_for_host(instance['url'], auth_config)
202 return a.has_cached_credentials()
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000203
204 for instance in rietveld_instances:
205 instance['auth'] = has_cookie(instance)
206
207 if filtered_instances:
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000208 logging.warning('No cookie found for the following Rietveld instance%s:',
209 's' if len(filtered_instances) > 1 else '')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000210 for instance in filtered_instances:
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000211 logging.warning('\t' + instance['url'])
212 logging.warning('Use --auth if you would like to authenticate to them.')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000213
214 def rietveld_search(self, instance, owner=None, reviewer=None):
215 if instance['requires_auth'] and not instance['auth']:
216 return []
217
218
219 email = None if instance['auth'] else ''
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000220 auth_config = auth.extract_auth_config_from_options(self.options)
221 remote = rietveld.Rietveld('https://' + instance['url'], auth_config, email)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000222
223 # See def search() in rietveld.py to see all the filters you can use.
224 query_modified_after = None
225
226 if instance['supports_owner_modified_query']:
227 query_modified_after = self.modified_after.strftime('%Y-%m-%d')
228
229 # Rietveld does not allow search by both created_before and modified_after.
230 # (And some instances don't allow search by both owner and modified_after)
231 owner_email = None
232 reviewer_email = None
233 if owner:
234 owner_email = owner + '@' + instance['email_domain']
235 if reviewer:
236 reviewer_email = reviewer + '@' + instance['email_domain']
237 issues = remote.search(
238 owner=owner_email,
239 reviewer=reviewer_email,
240 modified_after=query_modified_after,
241 with_messages=True)
242
243 issues = filter(
244 lambda i: (datetime_from_rietveld(i['created']) < self.modified_before),
245 issues)
246 issues = filter(
247 lambda i: (datetime_from_rietveld(i['modified']) > self.modified_after),
248 issues)
249
250 should_filter_by_user = True
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000251 issues = map(partial(self.process_rietveld_issue, remote, instance), issues)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000252 issues = filter(
253 partial(self.filter_issue, should_filter_by_user=should_filter_by_user),
254 issues)
255 issues = sorted(issues, key=lambda i: i['modified'], reverse=True)
256
257 return issues
258
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000259 def extract_bug_number_from_description(self, issue):
260 description = None
261
262 if 'description' in issue:
263 # Getting the description for Rietveld
264 description = issue['description']
265 elif 'revisions' in issue:
266 # Getting the description for REST Gerrit
267 revision = issue['revisions'][issue['current_revision']]
268 description = revision['commit']['message']
269
270 bugs = []
271 if description:
Nicolas Dossou-gbete903ea732017-07-10 16:46:59 +0100272 # Handle both "Bug: 99999" and "BUG=99999" bug notations
273 # Multiple bugs can be noted on a single line or in multiple ones.
274 matches = re.findall(r'BUG[=:]\s?(((\d+)(,\s?)?)+)', description,
275 flags=re.IGNORECASE)
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000276 if matches:
277 for match in matches:
278 bugs.extend(match[0].replace(' ', '').split(','))
279
280 return bugs
281
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000282 def process_rietveld_issue(self, remote, instance, issue):
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000283 ret = {}
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000284 if self.options.deltas:
285 patchset_props = remote.get_patchset_properties(
286 issue['issue'],
287 issue['patchsets'][-1])
288 ret['delta'] = '+%d,-%d' % (
289 sum(f['num_added'] for f in patchset_props['files'].itervalues()),
290 sum(f['num_removed'] for f in patchset_props['files'].itervalues()))
291
292 if issue['landed_days_ago'] != 'unknown':
293 ret['status'] = 'committed'
294 elif issue['closed']:
295 ret['status'] = 'closed'
296 elif len(issue['reviewers']) and issue['all_required_reviewers_approved']:
297 ret['status'] = 'ready'
298 else:
299 ret['status'] = 'open'
300
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000301 ret['owner'] = issue['owner_email']
302 ret['author'] = ret['owner']
303
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000304 ret['reviewers'] = set(issue['reviewers'])
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000305
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000306 if 'shorturl' in instance:
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700307 url = instance['shorturl']
308 protocol = instance.get('short_url_protocol', 'http')
309 else:
310 url = instance['url']
311 protocol = 'https'
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000312
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700313 ret['review_url'] = '%s://%s/%d' % (protocol, url, issue['issue'])
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000314
315 # Rietveld sometimes has '\r\n' instead of '\n'.
316 ret['header'] = issue['description'].replace('\r', '').split('\n')[0]
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000317
318 ret['modified'] = datetime_from_rietveld(issue['modified'])
319 ret['created'] = datetime_from_rietveld(issue['created'])
320 ret['replies'] = self.process_rietveld_replies(issue['messages'])
321
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000322 ret['bug'] = self.extract_bug_number_from_description(issue)
323 ret['landed_days_ago'] = issue['landed_days_ago']
324
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000325 return ret
326
327 @staticmethod
328 def process_rietveld_replies(replies):
329 ret = []
330 for reply in replies:
331 r = {}
332 r['author'] = reply['sender']
333 r['created'] = datetime_from_rietveld(reply['date'])
334 r['content'] = ''
335 ret.append(r)
336 return ret
337
deymo@chromium.org6c039202013-09-12 12:28:12 +0000338 @staticmethod
deymo@chromium.org6c039202013-09-12 12:28:12 +0000339 def gerrit_changes_over_rest(instance, filters):
Michael Achenbach6fbf12f2017-07-06 10:54:11 +0200340 # Convert the "key:value" filter to a list of (key, value) pairs.
341 req = list(f.split(':', 1) for f in filters)
deymo@chromium.org6c039202013-09-12 12:28:12 +0000342 try:
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000343 # Instantiate the generator to force all the requests now and catch the
344 # errors here.
345 return list(gerrit_util.GenerateAllChanges(instance['url'], req,
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000346 o_params=['MESSAGES', 'LABELS', 'DETAILED_ACCOUNTS',
347 'CURRENT_REVISION', 'CURRENT_COMMIT']))
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000348 except gerrit_util.GerritError, e:
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000349 logging.error('Looking up %r: %s', instance['url'], e)
deymo@chromium.org6c039202013-09-12 12:28:12 +0000350 return []
351
deymo@chromium.org6c039202013-09-12 12:28:12 +0000352 def gerrit_search(self, instance, owner=None, reviewer=None):
353 max_age = datetime.today() - self.modified_after
354 max_age = max_age.days * 24 * 3600 + max_age.seconds
355 user_filter = 'owner:%s' % owner if owner else 'reviewer:%s' % reviewer
356 filters = ['-age:%ss' % max_age, user_filter]
357
Aaron Gable2979a872017-09-05 17:38:32 -0700358 issues = self.gerrit_changes_over_rest(instance, filters)
359 issues = [self.process_gerrit_issue(instance, issue)
360 for issue in issues]
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000361
362 # TODO(cjhopman): should we filter abandoned changes?
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000363 issues = filter(self.filter_issue, issues)
364 issues = sorted(issues, key=lambda i: i['modified'], reverse=True)
365
366 return issues
367
Aaron Gable2979a872017-09-05 17:38:32 -0700368 def process_gerrit_issue(self, instance, issue):
deymo@chromium.org6c039202013-09-12 12:28:12 +0000369 ret = {}
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000370 if self.options.deltas:
371 ret['delta'] = DefaultFormatter().format(
372 '+{insertions},-{deletions}',
373 **issue)
374 ret['status'] = issue['status']
deymo@chromium.org6c039202013-09-12 12:28:12 +0000375 if 'shorturl' in instance:
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700376 protocol = instance.get('short_url_protocol', 'http')
377 url = instance['shorturl']
378 else:
379 protocol = 'https'
380 url = instance['url']
381 ret['review_url'] = '%s://%s/%s' % (protocol, url, issue['_number'])
382
deymo@chromium.org6c039202013-09-12 12:28:12 +0000383 ret['header'] = issue['subject']
384 ret['owner'] = issue['owner']['email']
385 ret['author'] = ret['owner']
386 ret['created'] = datetime_from_gerrit(issue['created'])
387 ret['modified'] = datetime_from_gerrit(issue['updated'])
388 if 'messages' in issue:
Aaron Gable2979a872017-09-05 17:38:32 -0700389 ret['replies'] = self.process_gerrit_issue_replies(issue['messages'])
deymo@chromium.org6c039202013-09-12 12:28:12 +0000390 else:
391 ret['replies'] = []
392 ret['reviewers'] = set(r['author'] for r in ret['replies'])
393 ret['reviewers'].discard(ret['author'])
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000394 ret['bug'] = self.extract_bug_number_from_description(issue)
deymo@chromium.org6c039202013-09-12 12:28:12 +0000395 return ret
396
397 @staticmethod
Aaron Gable2979a872017-09-05 17:38:32 -0700398 def process_gerrit_issue_replies(replies):
deymo@chromium.org6c039202013-09-12 12:28:12 +0000399 ret = []
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000400 replies = filter(lambda r: 'author' in r and 'email' in r['author'],
401 replies)
deymo@chromium.org6c039202013-09-12 12:28:12 +0000402 for reply in replies:
403 ret.append({
404 'author': reply['author']['email'],
405 'created': datetime_from_gerrit(reply['date']),
406 'content': reply['message'],
407 })
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000408 return ret
409
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000410 def project_hosting_issue_search(self, instance):
411 auth_config = auth.extract_auth_config_from_options(self.options)
412 authenticator = auth.get_authenticator_for_host(
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000413 'bugs.chromium.org', auth_config)
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000414 http = authenticator.authorize(httplib2.Http())
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000415 url = ('https://monorail-prod.appspot.com/_ah/api/monorail/v1/projects'
416 '/%s/issues') % instance['name']
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000417 epoch = datetime.utcfromtimestamp(0)
418 user_str = '%s@chromium.org' % self.user
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000419
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000420 query_data = urllib.urlencode({
421 'maxResults': 10000,
422 'q': user_str,
423 'publishedMax': '%d' % (self.modified_before - epoch).total_seconds(),
424 'updatedMin': '%d' % (self.modified_after - epoch).total_seconds(),
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000425 })
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000426 url = url + '?' + query_data
427 _, body = http.request(url)
428 content = json.loads(body)
429 if not content:
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000430 logging.error('Unable to parse %s response from projecthosting.',
431 instance['name'])
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000432 return []
433
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000434 issues = []
435 if 'items' in content:
436 items = content['items']
437 for item in items:
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000438 if instance.get('shorturl'):
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700439 protocol = instance.get('short_url_protocol', 'http')
440 item_url = '%s://%s/%d' % (protocol, instance['shorturl'], item['id'])
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000441 else:
442 item_url = 'https://bugs.chromium.org/p/%s/issues/detail?id=%d' % (
443 instance['name'], item['id'])
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000444 issue = {
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000445 'header': item['title'],
446 'created': dateutil.parser.parse(item['published']),
447 'modified': dateutil.parser.parse(item['updated']),
448 'author': item['author']['name'],
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000449 'url': item_url,
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000450 'comments': [],
451 'status': item['status'],
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000452 'labels': [],
453 'components': []
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000454 }
455 if 'owner' in item:
456 issue['owner'] = item['owner']['name']
457 else:
458 issue['owner'] = 'None'
459 if issue['owner'] == user_str or issue['author'] == user_str:
460 issues.append(issue)
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000461 if 'labels' in item:
462 issue['labels'] = item['labels']
463 if 'components' in item:
464 issue['components'] = item['components']
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000465
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000466 return issues
467
jsbell@chromium.orgc92f5822014-01-06 23:49:11 +0000468 def print_heading(self, heading):
469 print
470 print self.options.output_format_heading.format(heading=heading)
471
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000472 def match(self, author):
473 if '@' in self.user:
474 return author == self.user
475 return author.startswith(self.user + '@')
476
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000477 def print_change(self, change):
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000478 activity = len([
479 reply
480 for reply in change['replies']
481 if self.match(reply['author'])
482 ])
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000483 optional_values = {
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000484 'created': change['created'].date().isoformat(),
485 'modified': change['modified'].date().isoformat(),
486 'reviewers': ', '.join(change['reviewers']),
487 'status': change['status'],
488 'activity': activity,
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000489 }
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000490 if self.options.deltas:
491 optional_values['delta'] = change['delta']
492
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000493 self.print_generic(self.options.output_format,
494 self.options.output_format_changes,
495 change['header'],
496 change['review_url'],
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000497 change['author'],
498 optional_values)
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000499
500 def print_issue(self, issue):
501 optional_values = {
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000502 'created': issue['created'].date().isoformat(),
503 'modified': issue['modified'].date().isoformat(),
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000504 'owner': issue['owner'],
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000505 'status': issue['status'],
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000506 }
507 self.print_generic(self.options.output_format,
508 self.options.output_format_issues,
509 issue['header'],
510 issue['url'],
511 issue['author'],
512 optional_values)
513
514 def print_review(self, review):
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000515 activity = len([
516 reply
517 for reply in review['replies']
518 if self.match(reply['author'])
519 ])
520 optional_values = {
521 'created': review['created'].date().isoformat(),
522 'modified': review['modified'].date().isoformat(),
523 'activity': activity,
524 }
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000525 self.print_generic(self.options.output_format,
526 self.options.output_format_reviews,
527 review['header'],
528 review['review_url'],
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000529 review['author'],
530 optional_values)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000531
532 @staticmethod
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000533 def print_generic(default_fmt, specific_fmt,
534 title, url, author,
535 optional_values=None):
536 output_format = specific_fmt if specific_fmt is not None else default_fmt
537 output_format = unicode(output_format)
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000538 values = {
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000539 'title': title,
540 'url': url,
541 'author': author,
542 }
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000543 if optional_values is not None:
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000544 values.update(optional_values)
545 print DefaultFormatter().format(output_format, **values).encode(
546 sys.getdefaultencoding())
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000547
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000548
549 def filter_issue(self, issue, should_filter_by_user=True):
550 def maybe_filter_username(email):
551 return not should_filter_by_user or username(email) == self.user
552 if (maybe_filter_username(issue['author']) and
553 self.filter_modified(issue['created'])):
554 return True
555 if (maybe_filter_username(issue['owner']) and
556 (self.filter_modified(issue['created']) or
557 self.filter_modified(issue['modified']))):
558 return True
559 for reply in issue['replies']:
560 if self.filter_modified(reply['created']):
561 if not should_filter_by_user:
562 break
563 if (username(reply['author']) == self.user
564 or (self.user + '@') in reply['content']):
565 break
566 else:
567 return False
568 return True
569
570 def filter_modified(self, modified):
571 return self.modified_after < modified and modified < self.modified_before
572
573 def auth_for_changes(self):
574 #TODO(cjhopman): Move authentication check for getting changes here.
575 pass
576
577 def auth_for_reviews(self):
578 # Reviews use all the same instances as changes so no authentication is
579 # required.
580 pass
581
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000582 def get_changes(self):
583 for instance in rietveld_instances:
584 self.changes += self.rietveld_search(instance, owner=self.user)
585
586 for instance in gerrit_instances:
587 self.changes += self.gerrit_search(instance, owner=self.user)
588
589 def print_changes(self):
590 if self.changes:
jsbell@chromium.orgc92f5822014-01-06 23:49:11 +0000591 self.print_heading('Changes')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000592 for change in self.changes:
593 self.print_change(change)
594
595 def get_reviews(self):
596 for instance in rietveld_instances:
597 self.reviews += self.rietveld_search(instance, reviewer=self.user)
598
599 for instance in gerrit_instances:
600 reviews = self.gerrit_search(instance, reviewer=self.user)
601 reviews = filter(lambda r: not username(r['owner']) == self.user, reviews)
602 self.reviews += reviews
603
604 def print_reviews(self):
605 if self.reviews:
jsbell@chromium.orgc92f5822014-01-06 23:49:11 +0000606 self.print_heading('Reviews')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000607 for review in self.reviews:
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000608 self.print_review(review)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000609
610 def get_issues(self):
611 for project in google_code_projects:
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000612 self.issues += self.project_hosting_issue_search(project)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000613
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000614 def print_issues(self):
615 if self.issues:
jsbell@chromium.orgc92f5822014-01-06 23:49:11 +0000616 self.print_heading('Issues')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000617 for issue in self.issues:
618 self.print_issue(issue)
619
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000620 def print_activity(self):
621 self.print_changes()
622 self.print_reviews()
623 self.print_issues()
624
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000625 def dump_json(self, ignore_keys=None):
626 if ignore_keys is None:
627 ignore_keys = ['replies']
628
629 def format_for_json_dump(in_array):
630 output = {}
631 for item in in_array:
632 url = item.get('url') or item.get('review_url')
633 if not url:
634 raise Exception('Dumped item %s does not specify url' % item)
635 output[url] = dict(
636 (k, v) for k,v in item.iteritems() if k not in ignore_keys)
637 return output
638
639 class PythonObjectEncoder(json.JSONEncoder):
640 def default(self, obj): # pylint: disable=method-hidden
641 if isinstance(obj, datetime):
642 return obj.isoformat()
643 if isinstance(obj, set):
644 return list(obj)
645 return json.JSONEncoder.default(self, obj)
646
647 output = {
648 'reviews': format_for_json_dump(self.reviews),
649 'changes': format_for_json_dump(self.changes),
650 'issues': format_for_json_dump(self.issues)
651 }
652 print json.dumps(output, indent=2, cls=PythonObjectEncoder)
653
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000654
655def main():
656 # Silence upload.py.
657 rietveld.upload.verbosity = 0
658
659 parser = optparse.OptionParser(description=sys.modules[__name__].__doc__)
660 parser.add_option(
661 '-u', '--user', metavar='<email>',
662 default=os.environ.get('USER'),
663 help='Filter on user, default=%default')
664 parser.add_option(
665 '-b', '--begin', metavar='<date>',
wychen@chromium.org85cab632015-05-28 21:04:37 +0000666 help='Filter issues created after the date (mm/dd/yy)')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000667 parser.add_option(
668 '-e', '--end', metavar='<date>',
wychen@chromium.org85cab632015-05-28 21:04:37 +0000669 help='Filter issues created before the date (mm/dd/yy)')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000670 quarter_begin, quarter_end = get_quarter_of(datetime.today() -
671 relativedelta(months=2))
672 parser.add_option(
673 '-Q', '--last_quarter', action='store_true',
jsbell@chromium.org74bfde02014-04-09 17:14:54 +0000674 help='Use last quarter\'s dates, i.e. %s to %s' % (
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000675 quarter_begin.strftime('%Y-%m-%d'), quarter_end.strftime('%Y-%m-%d')))
676 parser.add_option(
677 '-Y', '--this_year', action='store_true',
678 help='Use this year\'s dates')
679 parser.add_option(
680 '-w', '--week_of', metavar='<date>',
wychen@chromium.org85cab632015-05-28 21:04:37 +0000681 help='Show issues for week of the date (mm/dd/yy)')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000682 parser.add_option(
wychen@chromium.org8ba1ddb2015-04-29 00:04:25 +0000683 '-W', '--last_week', action='count',
684 help='Show last week\'s issues. Use more times for more weeks.')
jsbell@chromium.org74bfde02014-04-09 17:14:54 +0000685 parser.add_option(
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000686 '-a', '--auth',
687 action='store_true',
688 help='Ask to authenticate for instances with no auth cookie')
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000689 parser.add_option(
690 '-d', '--deltas',
691 action='store_true',
692 help='Fetch deltas for changes (slow).')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000693
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000694 activity_types_group = optparse.OptionGroup(parser, 'Activity Types',
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000695 'By default, all activity will be looked up and '
696 'printed. If any of these are specified, only '
697 'those specified will be searched.')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000698 activity_types_group.add_option(
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000699 '-c', '--changes',
700 action='store_true',
701 help='Show changes.')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000702 activity_types_group.add_option(
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000703 '-i', '--issues',
704 action='store_true',
705 help='Show issues.')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000706 activity_types_group.add_option(
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000707 '-r', '--reviews',
708 action='store_true',
709 help='Show reviews.')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000710 parser.add_option_group(activity_types_group)
711
712 output_format_group = optparse.OptionGroup(parser, 'Output Format',
713 'By default, all activity will be printed in the '
714 'following format: {url} {title}. This can be '
715 'changed for either all activity types or '
716 'individually for each activity type. The format '
717 'is defined as documented for '
718 'string.format(...). The variables available for '
719 'all activity types are url, title and author. '
720 'Format options for specific activity types will '
721 'override the generic format.')
722 output_format_group.add_option(
723 '-f', '--output-format', metavar='<format>',
724 default=u'{url} {title}',
725 help='Specifies the format to use when printing all your activity.')
726 output_format_group.add_option(
727 '--output-format-changes', metavar='<format>',
728 default=None,
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000729 help='Specifies the format to use when printing changes. Supports the '
730 'additional variable {reviewers}')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000731 output_format_group.add_option(
732 '--output-format-issues', metavar='<format>',
733 default=None,
cjhopman@chromium.org53c1e562013-03-11 20:02:38 +0000734 help='Specifies the format to use when printing issues. Supports the '
735 'additional variable {owner}.')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000736 output_format_group.add_option(
737 '--output-format-reviews', metavar='<format>',
738 default=None,
739 help='Specifies the format to use when printing reviews.')
jsbell@chromium.orgc92f5822014-01-06 23:49:11 +0000740 output_format_group.add_option(
741 '--output-format-heading', metavar='<format>',
742 default=u'{heading}:',
743 help='Specifies the format to use when printing headings.')
744 output_format_group.add_option(
745 '-m', '--markdown', action='store_true',
746 help='Use markdown-friendly output (overrides --output-format '
747 'and --output-format-heading)')
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000748 output_format_group.add_option(
749 '-j', '--json', action='store_true',
750 help='Output json data (overrides other format options)')
nyquist@chromium.org18bc90d2012-12-20 19:26:47 +0000751 parser.add_option_group(output_format_group)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000752 auth.add_auth_options(parser)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000753
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000754 parser.add_option(
755 '-v', '--verbose',
756 action='store_const',
757 dest='verbosity',
758 default=logging.WARN,
759 const=logging.INFO,
760 help='Output extra informational messages.'
761 )
762 parser.add_option(
763 '-q', '--quiet',
764 action='store_const',
765 dest='verbosity',
766 const=logging.ERROR,
767 help='Suppress non-error messages.'
768 )
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000769 parser.add_option(
770 '-o', '--output', metavar='<file>',
771 help='Where to output the results. By default prints to stdout.')
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000772
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000773 # Remove description formatting
774 parser.format_description = (
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -0800775 lambda _: parser.description) # pylint: disable=no-member
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000776
777 options, args = parser.parse_args()
778 options.local_user = os.environ.get('USER')
779 if args:
780 parser.error('Args unsupported')
781 if not options.user:
782 parser.error('USER is not set, please use -u')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000783 options.user = username(options.user)
784
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000785 logging.basicConfig(level=options.verbosity)
786
787 # python-keyring provides easy access to the system keyring.
788 try:
789 import keyring # pylint: disable=unused-import,unused-variable,F0401
790 except ImportError:
791 logging.warning('Consider installing python-keyring')
792
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000793 if not options.begin:
794 if options.last_quarter:
795 begin, end = quarter_begin, quarter_end
796 elif options.this_year:
797 begin, end = get_year_of(datetime.today())
798 elif options.week_of:
799 begin, end = (get_week_of(datetime.strptime(options.week_of, '%m/%d/%y')))
jsbell@chromium.org74bfde02014-04-09 17:14:54 +0000800 elif options.last_week:
wychen@chromium.org8ba1ddb2015-04-29 00:04:25 +0000801 begin, end = (get_week_of(datetime.today() -
802 timedelta(days=1 + 7 * options.last_week)))
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000803 else:
804 begin, end = (get_week_of(datetime.today() - timedelta(days=1)))
805 else:
Daniel Cheng4b37ce62017-09-07 12:00:02 -0700806 begin = dateutil.parser.parse(options.begin)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000807 if options.end:
Daniel Cheng4b37ce62017-09-07 12:00:02 -0700808 end = dateutil.parser.parse(options.end)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000809 else:
810 end = datetime.today()
811 options.begin, options.end = begin, end
812
jsbell@chromium.orgc92f5822014-01-06 23:49:11 +0000813 if options.markdown:
814 options.output_format = ' * [{title}]({url})'
815 options.output_format_heading = '### {heading} ###'
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000816 logging.info('Searching for activity by %s', options.user)
817 logging.info('Using range %s to %s', options.begin, options.end)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000818
819 my_activity = MyActivity(options)
820
821 if not (options.changes or options.reviews or options.issues):
822 options.changes = True
823 options.issues = True
824 options.reviews = True
825
826 # First do any required authentication so none of the user interaction has to
827 # wait for actual work.
828 if options.changes:
829 my_activity.auth_for_changes()
830 if options.reviews:
831 my_activity.auth_for_reviews()
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000832
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000833 logging.info('Looking up activity.....')
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000834
seanmccullough@chromium.org3e4a5812015-06-11 17:48:47 +0000835 try:
836 if options.changes:
837 my_activity.get_changes()
838 if options.reviews:
839 my_activity.get_reviews()
840 if options.issues:
841 my_activity.get_issues()
842 except auth.AuthenticationError as e:
Tobias Sargeantffb3c432017-03-08 14:09:14 +0000843 logging.error('auth.AuthenticationError: %s', e)
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000844
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000845 output_file = None
846 try:
847 if options.output:
848 output_file = open(options.output, 'w')
849 logging.info('Printing output to "%s"', options.output)
850 sys.stdout = output_file
851 except (IOError, OSError) as e:
Varun Khanejad9f97bc2017-08-02 12:55:01 -0700852 logging.error('Unable to write output: %s', e)
Nicolas Dossou-gbetee5deedf2017-03-15 16:26:47 +0000853 else:
854 if options.json:
855 my_activity.dump_json()
856 else:
857 my_activity.print_changes()
858 my_activity.print_reviews()
859 my_activity.print_issues()
860 finally:
861 if output_file:
862 logging.info('Done printing to file.')
863 sys.stdout = sys.__stdout__
864 output_file.close()
865
cjhopman@chromium.org04d119d2012-10-17 22:41:53 +0000866 return 0
867
868
869if __name__ == '__main__':
stevefung@chromium.org832d51e2015-05-27 12:52:51 +0000870 # Fix encoding to support non-ascii issue titles.
871 fix_encoding.fix_encoding()
872
sbc@chromium.org013731e2015-02-26 18:28:43 +0000873 try:
874 sys.exit(main())
875 except KeyboardInterrupt:
876 sys.stderr.write('interrupted\n')
877 sys.exit(1)