summaryrefslogtreecommitdiff
path: root/Mailman/Digester.py
blob: f0dc9820739d8681bf8822a7361287b50ea6fce9 (plain)
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
import mm_utils, mm_err, mm_message, mm_cfg
import time, os, string

class Digester:
    def InitVars(self):
	# Configurable
	self.digestable = mm_cfg.DEFAULT_DIGESTABLE
	self.digest_is_default = mm_cfg.DEFAULT_DIGEST_IS_DEFAULT
	self.mime_is_default_digest = mm_cfg.DEFAULT_MIME_IS_DEFAULT_DIGEST
	self.digest_size_threshhold = mm_cfg.DEFAULT_DIGEST_SIZE_THRESHHOLD
	self.digest_send_periodic = mm_cfg.DEFAULT_DIGEST_SEND_PERIODIC
	self.next_post_number = 1
	self.digest_header = mm_cfg.DEFAULT_DIGEST_HEADER
	self.digest_footer = mm_cfg.DEFAULT_DIGEST_FOOTER
	
	# Non-configurable.
	self.digest_members = []
	self.next_digest_number = 1

    def GetConfigInfo(self):
	return [

	    ('digestable', mm_cfg.Toggle, ('No', 'Yes'), 1,
	     'Can list members choose to receive list traffic '
	     'bunched in digests?'),

	    ('digest_is_default', mm_cfg.Radio, 
	     ('Regular', 'Digest'), 0,
	     'Which delivery mode is the default for new users?'),

	    ('mime_is_default_digest', mm_cfg.Radio, 
	     ('Mime', 'Plain'), 0,
	     'When receiving digests, which format is default?'),

	    ('digest_size_threshhold', mm_cfg.Number, 3, 0,
	     'How big in Kb should a digest be before it gets sent out?'),

	    ('digest_send_periodic', mm_cfg.Number, 3, 0,
	     'Should a digest be dispatched daily when the size threshold '
	     "isn't reached?"),

	    ('digest_header', mm_cfg.Text, (4, 65), 0,
	     'Header added to every digest'),
	    # See msg_header option note.

	    ('digest_footer', mm_cfg.Text, (4, 65), 0,
	     'Footer added to every digest'),
	    # See msg_header option note.
	    ]


	
    def SetUserDigest(self, sender, value):
	self.IsListInitialized()
	addr = self.FindUser(sender)
	if not addr:
	    raise mm_err.MMNotAMemberError
	if addr in self.members:
	    if value == 0:
		raise mm_err.MMAlreadyUndigested
	    else:
		if not self.digestable:
		    raise mm_err.MMCantDigestError
		self.members.remove(addr)
		self.digest_members.append(addr)
	else:
	    if value == 1:
		raise mm_err.MMAlreadyDigested
	    else:
		if not self.nondigestable:
		    raise mm_err.MMMustDigestError
		self.digest_members.remove(addr)
		self.members.append(addr)
	self.Save()


# Internal function, don't call this.
    def SaveForDigest(self, post):
	"""Add message to index, and to the digest.  If the digest is large
	enough when we're done writing, send it out."""
	digest_file = open(os.path.join(self._full_path, "next-digest"),
			   "a+")
	topics_file = open(os.path.join(self._full_path,
					"next-digest-topics"), 
			   "a+")
	sender = self.QuoteMime(post.GetSenderName())
	fromline = self.QuoteMime(post.getheader("from"))
	subject = self.QuoteMime(post.getheader("subject"))
	date = self.QuoteMime(post.getheader("date"))
	body = self.QuoteMime(post.body)
	topics_file.write("  %d. %s (%s)\n" % (self.next_post_number,
					       subject, sender))
	digest_file.write("--%s\n\nMessage: %d"
			  "\nFrom: %s\nDate: %s\nSubject: %s\n\n%s" % 
			 (self._mime_separator, self.next_post_number,
			  fromline, date, subject,
			  body))
	self.next_post_number = self.next_post_number + 1
	topics_file.close()
	digest_file.close()    
	self.SendDigestOnSize(self.digest_size_threshhold)

    def SendDigestIfAny(self):
	"""Send the digest if there are any messages pending."""
	self.SendDigestOnSize(0)

    def SendDigestOnSize(self, threshhold):
	"""Call SendDigest if accumulated digest exceeds threshhold.

	(There must be some content, even if threshhold is 0.)"""
	try:
	    ndf = os.path.join(self._full_path, "next-digest")
	    size = os.stat(ndf)[6]
	    if size == 0:
		return
	    elif (size/1024.) >= threshhold:
		self.SendDigest()
	except os.error, err:
	    if err[0] == 2:
		# No such file or directory
		self.LogMsg("system", "mm_digest lost digest file %s, %s",
			    ndf, err)

# If the mime separator appears in the text anywhere, throw a space on
# both sides of it, so it doesn't get interpreted as a real mime separator.
    def QuoteMime(self, text):
	if not text:
	    return text
	return string.join(string.split(text, self._mime_separator), ' %s ' %
			   self._mime_separator)

    def FakeDigest(self):
	def DeliveryEnabled(x, s=self, v=mm_cfg.DisableDelivery):
	    return not s.GetUserOption(x, v)

	def LikesMime(x, s=self, v=mm_cfg.DisableMime):
	    return not s.GetUserOption(x, v)

	def HatesMime(x, s=self, v=mm_cfg.DisableMime):
	    return s.GetUserOption(x, v)

	recipients = filter(DeliveryEnabled, self.digest_members)
	mime_recipients = filter(LikesMime, recipients)
	text_recipients = filter(HatesMime, recipients)
	self.LogMsg("digest",
		    '%s digest %d log--',
		    self.real_name, self.next_digest_number)
	self.LogMsg("digest",
		    ('%d digesters, %d disabled.  '
		     'Active: %d MIMEers, %d non.'),
		    len(self.digest_members),
		    len(self.digest_members) - len(recipients),
		    len(mime_recipients), len(text_recipients))

    def SendDigest(self):
	msg = mm_message.OutgoingMessage()
	msg.SetSender(self.GetAdminEmail())
	msg.SetHeader('Subject', '%s digest, Volume %d #%d' % 
		       (self.real_name, self.volume, self.next_digest_number))
	msg.SetHeader('mime-version', '1.0')
	msg.SetHeader('content-type', 'multipart/digest; boundary="%s"' % 
		       self._mime_separator)
	msg.SetHeader('reply-to', self.GetListEmail())

        digest_file = open(os.path.join(self._full_path, 'next-digest'), 'r+')
	msg.SetBody(digest_file.read())
	digest_file.truncate(0)
	digest_file.close()

	# Create the header and footer... this is a mess!
	topics_file = open(os.path.join(self._full_path,
					'next-digest-topics'), 
			   'r+')
	topics_text = topics_file.read()
	topics_file.truncate(0)
	topics_file.close()

	digest_header = '''--%s

From: %s
Subject: Contents of %s digest, Volume %d #%d
Date: %s

Topics for this digest:
%s
''' % (self._mime_separator, msg.GetSender(), self.real_name, self.volume, 
            self.next_digest_number, time.ctime(time.time()), topics_text)

        if self.digest_header:
	    digest_header = digest_header + (self.digest_header
					     % self.__dict__)
	if self.digest_footer:
	    digest_footer = '''--%s

From: %s
Subject: Digest Footer
Date: %s

%s
--%s--''' % (self._mime_separator, msg.GetSender(), time.ctime(time.time()), 
	     (self.digest_footer % self.__dict__), self._mime_separator)
        else:
	    digest_footer = '''
--%s--''' % self._mime_separator


	def DeliveryEnabled(x, s=self, v=mm_cfg.DisableDelivery):
	    return not s.GetUserOption(x, v)

	def LikesMime(x, s=self, v=mm_cfg.DisableMime):
	    return not s.GetUserOption(x, v)

	def HatesMime(x, s=self, v=mm_cfg.DisableMime):
	    return s.GetUserOption(x, v)

	recipients = filter(DeliveryEnabled, self.digest_members)
	mime_recipients = filter(LikesMime, recipients)
	text_recipients = filter(HatesMime, recipients)
	self.LogMsg("digest",
		    '%s digest %d log--',
		    self.real_name, self.next_digest_number)
	self.LogMsg("digest",
		    ('%d digesters, %d disabled. '
		     'Active: %d MIMEers, %d non.'),
		    len(self.digest_members),
		    len(self.digest_members) - len(recipients),
		    len(mime_recipients),
		    len(text_recipients))
	self.DeliverToList(msg, mime_recipients, digest_header, 
	                   digest_footer, remove_to=1,
			   tmpfile_prefix = "mime.")
	msg.SetHeader('content-type', 'text/plain', crush_duplicates=1)
	self.DeliverToList(msg, text_recipients, digest_header,
			   digest_footer, remove_to=1)
	self.next_digest_number = self.next_digest_number + 1
	self.next_post_number = 1
	self.Save()