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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
|
"""functions that send email in askbot
these automatically catch email-related exceptions
"""
import os
import smtplib
import logging
from django.core import mail
from django.conf import settings as django_settings
from django.core.exceptions import PermissionDenied
from django.forms import ValidationError
from django.utils.translation import ugettext_lazy as _
from django.utils.translation import string_concat
from django.template import Context
from django.utils.html import strip_tags
from askbot import exceptions
from askbot import const
from askbot.conf import settings as askbot_settings
from askbot.utils import url_utils
from askbot.utils.file_utils import store_file
from bs4 import BeautifulSoup
#todo: maybe send_mail functions belong to models
#or the future API
def prefix_the_subject_line(subject):
"""prefixes the subject line with the
EMAIL_SUBJECT_LINE_PREFIX either from
from live settings, which take default from django
"""
prefix = askbot_settings.EMAIL_SUBJECT_PREFIX
if prefix != '':
subject = prefix.strip() + ' ' + subject.strip()
return subject
def extract_first_email_address(text):
"""extract first matching email address
from text string
returns ``None`` if there are no matches
"""
match = const.EMAIL_REGEX.search(text)
if match:
return match.group(0)
else:
return None
def thread_headers(post, orig_post, update):
"""modify headers for email messages, so
that emails appear as threaded conversations in gmail"""
suffix_id = django_settings.SERVER_EMAIL
if update == const.TYPE_ACTIVITY_ASK_QUESTION:
msg_id = "NQ-%s-%s" % (post.id, suffix_id)
headers = {'Message-ID': msg_id}
elif update == const.TYPE_ACTIVITY_ANSWER:
msg_id = "NA-%s-%s" % (post.id, suffix_id)
orig_id = "NQ-%s-%s" % (orig_post.id, suffix_id)
headers = {'Message-ID': msg_id,
'In-Reply-To': orig_id}
elif update == const.TYPE_ACTIVITY_UPDATE_QUESTION:
msg_id = "UQ-%s-%s-%s" % (post.id, post.last_edited_at, suffix_id)
orig_id = "NQ-%s-%s" % (orig_post.id, suffix_id)
headers = {'Message-ID': msg_id,
'In-Reply-To': orig_id}
elif update == const.TYPE_ACTIVITY_COMMENT_QUESTION:
msg_id = "CQ-%s-%s" % (post.id, suffix_id)
orig_id = "NQ-%s-%s" % (orig_post.id, suffix_id)
headers = {'Message-ID': msg_id,
'In-Reply-To': orig_id}
elif update == const.TYPE_ACTIVITY_UPDATE_ANSWER:
msg_id = "UA-%s-%s-%s" % (post.id, post.last_edited_at, suffix_id)
orig_id = "NQ-%s-%s" % (orig_post.id, suffix_id)
headers = {'Message-ID': msg_id,
'In-Reply-To': orig_id}
elif update == const.TYPE_ACTIVITY_COMMENT_ANSWER:
msg_id = "CA-%s-%s" % (post.id, suffix_id)
orig_id = "NQ-%s-%s" % (orig_post.id, suffix_id)
headers = {'Message-ID': msg_id,
'In-Reply-To': orig_id}
else:
# Unknown type -> Can't set headers
return {}
return headers
def clean_html_email(email_body):
'''needs more clenup might not work for other email templates
that does not use table layout'''
remove_linejump = lambda s: s.replace('\n', '')
soup = BeautifulSoup(email_body)
table_tds = soup.find('body')
phrases = map(lambda s: s.strip(),
filter(bool, table_tds.get_text().split('\n')))
return '\n\n'.join(phrases)
def send_mail(
subject_line = None,
body_text = None,
from_email = django_settings.DEFAULT_FROM_EMAIL,
recipient_list = None,
activity_type = None,
related_object = None,
headers = None,
raise_on_failure = False,
):
"""
todo: remove parameters not relevant to the function
sends email message
logs email sending activity
and any errors are reported as critical
in the main log file
related_object is not mandatory, other arguments
are. related_object (if given, will be saved in
the activity record)
if raise_on_failure is True, exceptions.EmailNotSent is raised
"""
try:
assert(subject_line is not None)
subject_line = prefix_the_subject_line(subject_line)
msg = mail.EmailMultiAlternatives(
subject_line,
clean_html_email(body_text),
from_email,
recipient_list,
headers = headers
)
msg.attach_alternative(body_text, "text/html")
msg.send()
if related_object is not None:
assert(activity_type is not None)
except Exception, error:
logging.critical(unicode(error))
if raise_on_failure == True:
raise exceptions.EmailNotSent(unicode(error))
def mail_moderators(
subject_line = '',
body_text = '',
raise_on_failure = False,
headers = None
):
"""sends email to forum moderators and admins
"""
from django.db.models import Q
from askbot.models import User
recipient_list = User.objects.filter(
Q(status='m') | Q(is_superuser=True)
).filter(
is_active = True
).values_list('email', flat=True)
recipient_list = set(recipient_list)
from_email = ''
if hasattr(django_settings, 'DEFAULT_FROM_EMAIL'):
from_email = django_settings.DEFAULT_FROM_EMAIL
try:
msg = mail.EmailMessage(
subject_line,
body_text,
from_email,
recipient_list,
headers = headers or {}
)
msg.content_subtype = 'html'
msg.send()
except smtplib.SMTPException, error:
logging.critical(unicode(error))
if raise_on_failure == True:
raise exceptions.EmailNotSent(unicode(error))
INSTRUCTIONS_PREAMBLE = _('<p>To ask by email, please:</p>')
QUESTION_TITLE_INSTRUCTION = _(
'<li>Type title in the subject line</li>'
)
QUESTION_DETAILS_INSTRUCTION = _(
'<li>Type details of your question into the email body</li>'
)
OPTIONAL_TAGS_INSTRUCTION = _(
"""<li>The beginning of the subject line can contain tags,
<em>enclosed in the square brackets</em> like so: [Tag1; Tag2]</li>"""
)
REQUIRED_TAGS_INSTRUCTION = _(
"""<li>In the beginning of the subject add at least one tag
<em>enclosed in the brackets</em> like so: [Tag1; Tag2].</li>"""
)
TAGS_INSTRUCTION_FOOTNOTE = _(
"""<p>Note that a tag may consist of more than one word, to separate
the tags, use a semicolon or a comma, for example, [One tag; Other tag]</p>"""
)
def bounce_email(
email, subject, reason = None, body_text = None, reply_to = None
):
"""sends a bounce email at address ``email``, with the subject
line ``subject``, accepts several reasons for the bounce:
* ``'problem_posting'``, ``unknown_user`` and ``permission_denied``
* ``body_text`` in an optional parameter that allows to append
extra text to the message
"""
if reason == 'problem_posting':
error_message = _(
'<p>Sorry, there was an error posting your question '
'please contact the %(site)s administrator</p>'
) % {'site': askbot_settings.APP_SHORT_NAME}
if askbot_settings.TAGS_ARE_REQUIRED:
error_message = string_concat(
INSTRUCTIONS_PREAMBLE,
'<ul>',
QUESTION_TITLE_INSTRUCTION,
REQUIRED_TAGS_INSTRUCTION,
QUESTION_DETAILS_INSTRUCTION,
'</ul>',
TAGS_INSTRUCTION_FOOTNOTE
)
else:
error_message = string_concat(
INSTRUCTIONS_PREAMBLE,
'<ul>',
QUESTION_TITLE_INSTRUCTION,
QUESTION_DETAILS_INSTRUCTION,
OPTIONAL_TAGS_INSTRUCTION,
'</ul>',
TAGS_INSTRUCTION_FOOTNOTE
)
elif reason == 'unknown_user':
error_message = _(
'<p>Sorry, in order to post questions on %(site)s '
'by email, please <a href="%(url)s">register first</a></p>'
) % {
'site': askbot_settings.APP_SHORT_NAME,
'url': url_utils.get_login_url()
}
elif reason == 'permission_denied' and body_text is None:
error_message = _(
'<p>Sorry, your question could not be posted '
'due to insufficient privileges of your user account</p>'
)
elif body_text:
error_message = body_text
else:
raise ValueError('unknown reason to bounce an email: "%s"' % reason)
#print 'sending email'
#print email
#print subject
#print error_message
headers = {}
if reply_to:
headers['Reply-To'] = reply_to
send_mail(
recipient_list = (email,),
subject_line = 'Re: ' + subject,
body_text = error_message,
headers = headers
)
def extract_reply(text):
"""take the part above the separator
and discard the last line above the separator"""
if const.REPLY_SEPARATOR_REGEX.search(text):
text = const.REPLY_SEPARATOR_REGEX.split(text)[0]
return '\n'.join(text.splitlines(True)[:-3])
else:
return text
def process_attachment(attachment):
"""will save a single
attachment and return
link to file in the markdown format and the
file storage object
"""
file_storage, file_name, file_url = store_file(attachment)
markdown_link = '[%s](%s) ' % (attachment.name, file_url)
file_extension = os.path.splitext(attachment.name)[1]
#todo: this is a hack - use content type
if file_extension.lower() in ('.png', '.jpg', '.jpeg', '.gif'):
markdown_link = '!' + markdown_link
return markdown_link, file_storage
def extract_user_signature(text, reply_code):
"""extracts email signature as text trailing
the reply code"""
if reply_code in text:
#extract the signature
tail = list()
for line in reversed(text.splitlines()):
#scan backwards from the end until the magic line
if reply_code in line:
break
tail.insert(0, line)
#strip off the leading quoted lines, there could be one or two
#also strip empty lines
while tail and (tail[0].startswith('>') or tail[0].strip() == ''):
tail.pop(0)
return '\n'.join(tail)
else:
return ''
def process_parts(parts, reply_code = None):
"""Process parts will upload the attachments and parse out the
body, if body is multipart. Secondly - links to attachments
will be added to the body of the question.
Returns ready to post body of the message and the list
of uploaded files.
"""
body_markdown = ''
stored_files = list()
attachments_markdown = ''
for (part_type, content) in parts:
if part_type == 'attachment':
markdown, stored_file = process_attachment(content)
stored_files.append(stored_file)
attachments_markdown += '\n\n' + markdown
elif part_type == 'body':
body_markdown += '\n\n' + content.strip('\n\t ')
elif part_type == 'inline':
markdown, stored_file = process_attachment(content)
stored_files.append(stored_file)
body_markdown += markdown
#if the response separator is present -
#split the body with it, and discard the "so and so wrote:" part
if reply_code:
signature = extract_user_signature(body_markdown, reply_code)
else:
signature = None
body_markdown = extract_reply(body_markdown)
body_markdown += attachments_markdown
return body_markdown.strip(), stored_files, signature
def process_emailed_question(
from_address, subject, body_text, stored_files,
tags=None, group_id=None
):
"""posts question received by email or bounces the message"""
#a bunch of imports here, to avoid potential circular import issues
from askbot.forms import AskByEmailForm
from askbot.models import ReplyAddress, User
from askbot.mail import messages
reply_to = None
try:
#todo: delete uploaded files when posting by email fails!!!
data = {
'sender': from_address,
'subject': subject,
'body_text': body_text
}
form = AskByEmailForm(data)
if form.is_valid():
email_address = form.cleaned_data['email']
user = User.objects.get(email__iexact = email_address)
if user.can_post_by_email() is False:
raise PermissionDenied(messages.insufficient_reputation(user))
body_text = form.cleaned_data['body_text']
stripped_body_text = user.strip_email_signature(body_text)
signature_not_detected = (
stripped_body_text == body_text and user.email_signature
)
#ask for signature response if user's email has not been
#validated yet or if email signature could not be found
if user.email_isvalid is False or signature_not_detected:
reply_to = ReplyAddress.objects.create_new(
user = user,
reply_action = 'validate_email'
).as_email_address()
message = messages.ask_for_signature(user, footer_code = reply_to)
raise PermissionDenied(message)
tagnames = form.cleaned_data['tagnames']
title = form.cleaned_data['title']
#defect - here we might get "too many tags" issue
if tags:
tagnames += ' ' + ' '.join(tags)
user.post_question(
title=title,
tags=tagnames.strip(),
body_text=stripped_body_text,
by_email=True,
email_address=from_address,
group_id=group_id
)
else:
raise ValidationError()
except User.DoesNotExist:
bounce_email(email_address, subject, reason = 'unknown_user')
except User.MultipleObjectsReturned:
bounce_email(email_address, subject, reason = 'problem_posting')
except PermissionDenied, error:
bounce_email(
email_address,
subject,
reason = 'permission_denied',
body_text = unicode(error),
reply_to = reply_to
)
except ValidationError:
if from_address:
bounce_email(
from_address,
subject,
reason = 'problem_posting',
)
|