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
|
# Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman 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
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Add the message to the list's current digest."""
__all__ = [
'ToDigest',
'bump_digest_number_and_volume',
'maybe_send_digest_now',
]
import os
from mailman.config import config
from mailman.core.i18n import _
from mailman.email.message import Message
from mailman.interfaces.digests import DigestFrequency
from mailman.interfaces.handler import IHandler
from mailman.interfaces.listmanager import IListManager
from mailman.utilities.datetime import now as right_now
from mailman.utilities.mailbox import Mailbox
from zope.component import getUtility
from zope.interface import implementer
@implementer(IHandler)
class ToDigest:
"""Add the message to the digest, possibly sending it."""
name = 'to-digest'
description = _('Add the message to the digest, possibly sending it.')
def process(self, mlist, msg, msgdata):
"""See `IHandler`."""
# Short-circuit if digests are not enabled or if this message already
# is a digest.
if not mlist.digests_enabled or msgdata.get('isdigest'):
return
# Open the mailbox that will be used to collect the current digest.
mailbox_path = os.path.join(mlist.data_path, 'digest.mmdf')
# Lock the mailbox and append the message.
with Mailbox(mailbox_path, create=True) as mbox:
mbox.add(msg)
maybe_send_digest_now(mlist)
def bump_digest_number_and_volume(mlist):
"""Bump the digest number and volume."""
now = right_now()
if mlist.digest_last_sent_at is None:
# There has been no previous digest.
bump = False
elif mlist.digest_volume_frequency == DigestFrequency.yearly:
bump = (now.year > mlist.digest_last_sent_at.year)
elif mlist.digest_volume_frequency == DigestFrequency.monthly:
# Monthly.
this_month = now.year * 100 + now.month
digest_month = (mlist.digest_last_sent_at.year * 100 +
mlist.digest_last_sent_at.month)
bump = (this_month > digest_month)
elif mlist.digest_volume_frequency == DigestFrequency.quarterly:
# Quarterly.
this_quarter = now.year * 100 + (now.month - 1) // 4
digest_quarter = (mlist.digest_last_sent_at.year * 100 +
(mlist.digest_last_sent_at.month - 1) // 4)
bump = (this_quarter > digest_quarter)
elif mlist.digest_volume_frequency == DigestFrequency.weekly:
this_week = now.year * 100 + now.isocalendar()[1]
digest_week = (mlist.digest_last_sent_at.year * 100 +
mlist.digest_last_sent_at.isocalendar()[1])
bump = (this_week > digest_week)
elif mlist.digest_volume_frequency == DigestFrequency.daily:
bump = (now.toordinal() > mlist.digest_last_sent_at.toordinal())
else:
raise AssertionError(
'Bad DigestFrequency: {0}'.format(
mlist.digest_volume_frequency))
if bump:
mlist.volume += 1
mlist.next_digest_number = 1
else:
# Just bump the digest number.
mlist.next_digest_number += 1
mlist.digest_last_sent_at = now
def maybe_send_digest_now(mlist=None, force=False):
"""Send this mailing list's digest now.
If there are any messages in this mailing list's digest, the
digest is sent immediately, regardless of whether the size
threshold has been met. When called through the subcommand
`mailman send_digest` the value of .digest_send_periodic is
consulted.
:param mlist: The mailing list whose digest should be sent. If this is
None, all mailing lists with non-zero sized digests will have theirs
sent immediately.
:type mlist: IMailingList or None
:param force: Should the digest be sent even if the size threshold hasn't
been met?
:type force: boolean
"""
if mlist is None:
digestable_lists = getUtility(IListManager).mailing_lists
else:
digestable_lists = [mlist]
for mailing_list in digestable_lists:
mailbox_path = os.path.join(mailing_list.data_path, 'digest.mmdf')
# Calculate the current size of the mailbox file. This will not tell
# us exactly how big the resulting MIME and rfc1153 digest will
# actually be, but it's the most easily available metric to decide
# whether the size threshold has been reached.
size = os.path.getsize(mailbox_path)
if (size >= mailing_list.digest_size_threshold * 1024.0 or
(force and size > 0)):
# Send the digest. Because we don't want to hold up this process
# with crafting the digest, we're going to move the digest file to
# a safe place, then craft a fake message for the DigestRunner as
# a trigger for it to build and send the digest.
mailbox_dest = os.path.join(
mailing_list.data_path,
'digest.{0.volume}.{0.next_digest_number}.mmdf'.format(
mailing_list))
volume = mailing_list.volume
digest_number = mailing_list.next_digest_number
bump_digest_number_and_volume(mailing_list)
os.rename(mailbox_path, mailbox_dest)
config.switchboards['digest'].enqueue(
Message(),
listid=mailing_list.list_id,
digest_path=mailbox_dest,
volume=volume,
digest_number=digest_number)
|
