Merge lp:~blr/lp-dev-utils/hide-bug-messages-by-user into lp:lp-dev-utils

[Kit Randel]

Add script hide-bug-comments-by-user.

Adds the script hide-bug-comments-by-user which iterates through searchTasks, setting bug comments visibility for the given user(s). Useful for dealing with spammers.

[William Grant (wgrant)]

review: Needs Fixing (code)

[lp:~blr/lp-dev-utils/hide-bug-messages-by-user]

127. By Kit Randel on 2015-10-20

* Call searchTasks with list of all bug statuses.
* Replace --timestamp with --since, allowing filtering by ISO 8601.

128. By Kit Randel on 2015-10-20

Remove unused imports.

[William Grant (wgrant)]

review: Needs Fixing (code)

[lp:~blr/lp-dev-utils/hide-bug-messages-by-user]

129. By Kit Randel on 2015-10-22

* Filter searchTasks by bug_commenter.
* Use more conventional -l/--launchpad cli argument for api url.

=== added file 'hide-bug-comments-by-user.py'
--- hide-bug-comments-by-user.py	1970-01-01 00:00:00 +0000
+++ hide-bug-comments-by-user.py	2015-10-22 02:05:39 +0000
@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+
+"""A utility to hide bug comments by usernames; particularly useful when
+dealing with spam.
+"""
+
+__all__ = [
+    'main',
+    ]
+
+import argparse
+import sys
+
+import iso8601
+
+from launchpadlib.launchpad import Launchpad
+
+
+BUG_STATUSES = ['New',
+                'Incomplete (with response)',
+                'Incomplete (without response)',
+                'Opinion',
+                'Invalid',
+                'Won\'t Fix',
+                'Expired',
+                'Confirmed',
+                'Triaged',
+                'In Progress',
+                'Fix Committed',
+                'Fix Released']
+
+
+def hideBugComments(user, filter_from_date=None):
+    count = 0
+    date_threshold = None
+    tasks = user.searchTasks(omit_duplicates=False,
+                             bug_commenter=user,
+                             status=BUG_STATUSES)
+    if filter_from_date:
+        date_threshold = iso8601.parse_date(filter_from_date)
+    for task in tasks:
+        for msg in task.bug.messages:
+            if msg.owner != user:
+                continue
+            if date_threshold and msg.date_created < date_threshold:
+                continue
+            comment_num = int(msg.self_link.rsplit('/', 1)[-1])
+            print('Hiding comment: %s' % msg.web_link)
+            task.bug.setCommentVisibility(
+                comment_number=comment_num, visible=False)
+            count += 1
+    print('%d comments hidden.' % count)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description='Hides bugtask comments for a given user(s).')
+    parser.add_argument('username', type=str, nargs='+',
+                        help='One or more launchpad usernames')
+    parser.add_argument('--since', metavar="ISO 8601 Date e.g. 2015-10-20",
+                        dest='since', type=str,
+                        help='Comments before this date will be ignored')
+    parser.add_argument(
+        "-l", "--launchpad", dest="launchpad_instance", default="production")
+
+    arg_vals = parser.parse_args()
+    usernames = arg_vals.username
+    date = arg_vals.since
+
+    launchpad = Launchpad.login_with(
+        'hidebugcomments', arg_vals.launchpad_instance, version='devel')
+    for username in usernames:
+        try:
+            user = launchpad.people[username]
+        except KeyError:
+            print('User %s not found.' % username)
+            sys.exit(1)
+
+        hideBugComments(user, date)
+
+if __name__ == '__main__':
+    main()