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
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""BugTask expiration rules."""
__metaclass__ = type
__all__ = ['BugJanitor']
from logging import getLogger
from lazr.lifecycle.event import ObjectModifiedEvent
from lazr.lifecycle.snapshot import Snapshot
from zope.component import getUtility
from zope.event import notify
from zope.interface import providedBy
from canonical.config import config
from canonical.launchpad.interfaces.launchpad import ILaunchpadCelebrities
from canonical.launchpad.webapp.interaction import (
endInteraction,
setupInteraction,
)
from canonical.launchpad.webapp.interfaces import IPlacelessAuthUtility
from lp.bugs.interfaces.bugtask import (
BugTaskStatus,
IBugTaskSet,
)
class BugJanitor:
"""Expire Incomplete BugTasks that are older than a configurable period.
The BugTask must be unassigned, and the project it is associated with
must use Malone for bug tracking.
"""
def __init__(self, days_before_expiration=None, log=None, target=None,
limit=None):
"""Create a new BugJanitor.
:days_before_expiration: Days of inactivity before a question is
expired. Defaults to config.malone.days_before_expiration.
:log: A logger instance to use for logging. Defaults to the default
logger.
:target: The target for expiring bugs.
:limit: Expire no more than limit bugtasks.
"""
if days_before_expiration is None:
days_before_expiration = (config.malone.days_before_expiration)
if log is None:
log = getLogger()
self.days_before_expiration = days_before_expiration
self.log = log
self.target = target
self.limit = limit
self.janitor = getUtility(ILaunchpadCelebrities).janitor
def expireBugTasks(self, transaction_manager):
"""Expire old, unassigned, Incomplete BugTasks.
Only BugTasks for projects that use Malone are updated. This method
will login as the bug_watch_updater celebrity and logout after the
expiration is done.
"""
message_template = ('[Expired for %s because there has been no '
'activity for %d days.]')
self.log.info(
'Expiring unattended, INCOMPLETE bugtasks older than '
'%d days for projects that use Launchpad Bugs.' %
self.days_before_expiration)
self._login()
try:
expired_count = 0
bugtask_set = getUtility(IBugTaskSet)
incomplete_bugtasks = bugtask_set.findExpirableBugTasks(
self.days_before_expiration, user=self.janitor,
target=self.target, limit=self.limit)
self.log.info(
'Found %d bugtasks to expire.' % incomplete_bugtasks.count())
for bugtask in incomplete_bugtasks:
# We don't expire bugtasks with conjoined masters.
if bugtask.conjoined_master:
continue
bugtask_before_modification = Snapshot(
bugtask, providing=providedBy(bugtask))
bugtask.transitionToStatus(
BugTaskStatus.EXPIRED, self.janitor)
content = message_template % (
bugtask.bugtargetdisplayname, self.days_before_expiration)
bugtask.bug.newMessage(
owner=self.janitor,
subject=bugtask.bug.followup_subject(),
content=content)
bugtask.statusexplanation = content
notify(ObjectModifiedEvent(
bugtask, bugtask_before_modification,
['status', 'statusexplanation'], user=self.janitor))
# XXX sinzui 2007-08-02 bug=29744:
# We commit after each expiration because emails are sent
# immediately in zopeless. This minimize the risk of
# duplicate expiration emails being sent in case an error
# occurs later on.
transaction_manager.commit()
expired_count += 1
self.log.info('Expired %d bugtasks.' % expired_count)
finally:
self._logout()
self.log.info('Finished expiration run.')
def _login(self):
"""Setup an interaction as the bug janitor.
The role of bug janitor is usually played by bug_watch_updater.
"""
auth_utility = getUtility(IPlacelessAuthUtility)
janitor_email = self.janitor.preferredemail.email
setupInteraction(
auth_utility.getPrincipalByLogin(
janitor_email, want_password=False),
login=janitor_email)
def _logout(self):
"""End the bug janitor interaction."""
endInteraction()
|