attachment:dropbox_mailimport-1.0.py of dropbox_mailimport.py

   1 """
   2     MoinMoin - dropbox_mailimport a modification of mailimport.py
   3 
   4     Version: 1.0, 12 June 2011
   5 
   6     For documentation and examples see:
   7 
   8     http://rileylink.local/pb/MoinMoin_Matters
   9 
  10     @copyright: 2011 Ian Riley <ian.riley@adelaide.edu.au>
  11     @license: GNU GPL, see COPYING for details.
  12 
  13     Modification of: 
  14 
  15     MoinMoin - E-Mail Import into wiki (mailimport.py)
  16 
  17     Just call this script with the URL of the wiki as a single argument
  18     and feed the mail into stdin.
  19 
  20     @copyright: 2006 MoinMoin:AlexanderSchremmer,
  21                 2006 MoinMoin:ThomasWaldmann
  22     @license: GNU GPL, see COPYING for details.
  23 """
  24 
  25 import sys, re, time
  26 import email
  27 from email.Utils import getaddresses, parsedate_tz, mktime_tz
  28 
  29 from MoinMoin import wikiutil, user
  30 from MoinMoin.action.AttachFile import add_attachment, AttachmentAlreadyExists
  31 from MoinMoin.Page import Page
  32 from MoinMoin.PageEditor import PageEditor
  33 # python, at least up to 2.4, ships a broken parser for headers
  34 from MoinMoin.support.HeaderFixed import decode_header
  35 # added to avoid duplication of unmodified things from builtin mailimport
  36 from MoinMoin.mail.mailimport import *
  37 # added to allow testing of membership to DropBoxGroup and WikiMailGroup
  38 from MoinMoin.datastruct.backends.wiki_groups import WikiGroup
  39 
  40 dropbox_tasks = ['DropFile', 'AddNote', 'MsgAdmin',]
  41 mail_tasks = ['DropFile', 'AddNote', 'MsgAdmin', 'WikiMail', ]
  42 mail_import_task_regex = r'<<([^>]*)>>'
  43 
  44 def full_address(address_parts):
  45     """Construct full email address from tuple [realname, mailaddr]."""
  46     if address_parts[0]:
  47         address = '"%s" <%s>' % address_parts
  48     else:
  49         address = address_parts[1]
  50     return address
  51 
  52 def mail_not_processed_reply(request, msg, error):
  53     """Reply to sender indicating mail to wiki could not be processed."""
  54 
  55     from MoinMoin.mail import sendmail
  56 
  57     _ = request.getText
  58 
  59     email = full_address(msg['from_addr'])
  60     subject = _('[%s] Mail not processed') % request.cfg.sitename or "Wiki"
  61     content = """The message to %s was not processed.
  62 Subject: %s
  63 Error: %s
  64 """ % (full_address(msg['to_addrs'][0]), msg['subject'], error, )
  65 
  66     mailok, sendmsg = sendmail.sendmail(request, [email], subject, content,
  67                                          mail_from=request.cfg.mail_from)
  68     return sendmsg
  69 
  70 def extract_mail_task(subject):
  71     """From subject find extract task, return task and cleaned subject."""
  72     mail_task = None
  73     cleaned_subject = subject.strip()
  74     re_subject = re.compile(mail_import_task_regex)
  75     t = re_subject.search(cleaned_subject)
  76     if t:
  77         mail_task = t.group(1)
  78         if mail_task in mail_tasks:
  79             cleaned_subject = cleaned_subject.replace('<<%s>>' % mail_task, '', 1)
  80         else:
  81             mail_task = None
  82     return [mail_task, cleaned_subject, ]
  83 
  84 def add_attachments(request, msg, pagename):
  85     """ Adds attachments, if present, renaming to avoid overwriting existing attachments """
  86     #XXX unmodified sub-section from import_mail_from_message in builtin mailimport.py script.
  87 
  88     attachments = []
  89 
  90     for att in msg['attachments']:
  91         i = 0
  92         while i < 1000: # do not create a gazillion attachments if something
  93                         # strange happens, give up after 1000.
  94             if i == 0:
  95                 fname = att.filename
  96             else:
  97                 components = att.filename.split(".")
  98                 new_suffix = "-" + str(i)
  99                 # add the counter before the file extension
 100                 if len(components) > 1:
 101                     fname = u"%s%s.%s" % (u".".join(components[:-1]), new_suffix, components[-1])
 102                 else:
 103                     fname = att.filename + new_suffix
 104             try:
 105                 # att.data can be None for forwarded message content - we can
 106                 # just ignore it, the forwarded message's text will be present
 107                 # nevertheless
 108                 if att.data is not None:
 109                     # get the fname again, it might have changed
 110                     fname, fsize = add_attachment(request, pagename, fname, att.data)
 111                     attachments.append(fname)
 112                 break
 113             except AttachmentAlreadyExists:
 114                 i += 1
 115     return attachments
 116                 
 117 def do_task_dropfile(request, msg, pagename):
 118     """Just add attachments to pagename."""
 119     return add_attachments(request, msg, pagename)
 120 
 121 def do_task_addnote(request, msg, pagename):
 122     """Just addd content to pagename as note."""
 123 
 124     d = get_pagename_content(request, msg)
 125     
 126     # ignore any pagename found by get_pagename_content
 127 
 128     comment = u"Mail: '%s'" % (msg['subject'], )
 129 
 130     page = PageEditor(request, pagename, do_editor_backup=0)
 131 
 132     # don't check if user can save as in do_task_wikimail
 133     # the checked credentials allow the user to add a note
 134 
 135     # assemble old page content and new mail body together
 136     old_content = Page(request, pagename).get_raw_body()
 137     old_content_top = ''
 138     old_content_bot = ''
 139     
 140     lines = old_content.split('\n')
 141     counter = 0
 142 
 143     for line in lines:
 144         if line:
 145             # find processing instuctions
 146             if (line[0] == '#'):
 147                 old_content_top += u"%s\n" % line
 148                 counter += 1
 149             else:
 150               continue
 151               
 152     old_content_bot = u"\n".join(lines[counter:-1])
 153 
 154     new_content = old_content_top
 155 
 156     new_content += u"'''Note: %s (%s, <<DateTime(%s)>>)'''\n\n" % \
 157                        (msg['subject'], 
 158                         email_to_markup(request, msg['from_addr']),
 159                         msg['date'])
 160 
 161     new_content += d['content']
 162 
 163     if old_content_bot:
 164         new_content += u"\n----\n%s" % old_content_bot
 165 
 166     try:
 167         page.saveText(new_content, 0, comment=comment)
 168     except page.AccessDenied:
 169         raise ProcessingError("Access denied for page %r" % pagename)
 170 
 171 def do_task_wikimail(request, msg):
 172     """ Processes message generated by the email package and imports it
 173         to the wiki as builtin mailimport.py script."""
 174     #XXX unmodified (with on exception) sub-section from import_mail_from_message in builtin mailimport.py script.
 175     # the code to find and add attachments was put in a separate function for reuse by DropBox tasks.
 176 
 177     d = get_pagename_content(request, msg)
 178     pagename = d['pagename']
 179     generate_summary = d['generate_summary']
 180 
 181     comment = u"Mail: '%s'" % (msg['subject'], )
 182 
 183     page = PageEditor(request, pagename, do_editor_backup=0)
 184 
 185     if not request.user.may.save(page, "", 0):
 186         raise ProcessingError("Access denied for page %r" % pagename)
 187 
 188     #XXX this sub-section was put in a separate function to be
 189     # reused by new code.
 190     attachments = add_attachments(request, msg, pagename)
 191     
 192     # build an attachment link table for the page with the e-mail
 193     attachment_links = [""] + [u'''[[attachment:%s|%s]]''' % ("%s/%s" % (pagename, att), att) for att in attachments]
 194 
 195     # assemble old page content and new mail body together
 196     old_content = Page(request, pagename).get_raw_body()
 197     if old_content:
 198         new_content = u"%s\n-----\n" % old_content
 199     else:
 200         new_content = ''
 201 
 202     # if not (generate_summary and "/" in pagename):
 203     # generate header in any case:
 204     new_content += u"'''Mail: %s (%s, <<DateTime(%s)>>)'''\n\n" % (msg['subject'], email_to_markup(request, msg['from_addr']), msg['date'])
 205 
 206     new_content += d['content']
 207     new_content += "\n" + u"\n * ".join(attachment_links)
 208 
 209     try:
 210         page.saveText(new_content, 0, comment=comment)
 211     except page.AccessDenied:
 212         raise ProcessingError("Access denied for page %r" % pagename)
 213 
 214     if generate_summary and "/" in pagename:
 215         parent_page = u"/".join(pagename.split("/")[:-1])
 216         old_content = Page(request, parent_page).get_raw_body().splitlines()
 217 
 218         found_table = None
 219         table_ends = None
 220         for lineno, line in enumerate(old_content):
 221             if line.startswith("## mail_overview") and old_content[lineno+1].startswith("||"):
 222                 found_table = lineno
 223             elif found_table is not None and line.startswith("||"):
 224                 table_ends = lineno + 1
 225             elif table_ends is not None and not line.startswith("||"):
 226                 break
 227 
 228         # in order to let the gettext system recognise the <<GetText>> calls used below,
 229         # we must repeat them here:
 230         [_("Date"), _("From"), _("To"), _("Content"), _("Attachments")]
 231 
 232         table_header = (u"\n\n## mail_overview (don't delete this line)\n" +
 233                         u"|| '''<<GetText(Date)>> ''' || '''<<GetText(From)>> ''' || '''<<GetText(To)>> ''' || '''<<GetText(Content)>> ''' || '''<<GetText(Attachments)>> ''' ||\n"
 234                        )
 235 
 236         from_col = email_to_markup(request, msg['from_addr'])
 237         to_col = ' '.join([email_to_markup(request, (realname, mailaddr))
 238                            for realname, mailaddr in msg['target_addrs'] if not mailaddr in wiki_addrs])
 239         subj_col = '[[%s|%s]]' % (pagename, msg['subject'])
 240         date_col = msg['date']
 241         attach_col = " ".join(attachment_links)
 242         new_line = u'|| <<DateTime(%s)>> || %s || %s || %s || %s ||' % (date_col, from_col, to_col, subj_col, attach_col)
 243         if found_table is not None:
 244             content = "\n".join(old_content[:table_ends] + [new_line] + old_content[table_ends:])
 245         else:
 246             content = "\n".join(old_content) + table_header + new_line
 247 
 248         page = PageEditor(request, parent_page, do_editor_backup=0)
 249         page.saveText(content, 0, comment=comment)
 250         
 251 def import_mail_from_string(request, string):
 252     """ Reads an RFC 822 compliant message from a string and imports it
 253         to the wiki. """
 254     return import_mail_from_message(request, email.message_from_string(string))
 255 
 256 def import_mail_from_file(request, infile):
 257     """ Reads an RFC 822 compliant message from the file `infile` and imports it to
 258         the wiki. """
 259     return import_mail_from_message(request, email.message_from_file(infile))
 260 
 261 def import_mail_from_message(request, message):
 262     """ Reads a message generated by the email package and imports it
 263         to the wiki, based on senders identity and requested task."""
 264 
 265     # from here to the next comment is unmodified from the builtin mailimport.py script
 266 
 267     _ = request.getText
 268 
 269     msg = process_message(message)
 270     wiki_addrs = request.cfg.mail_import_wiki_addrs #TODO consider moving as only used in do_task_wikimail
 271 
 272     request.user = user.get_by_email_address(request, msg['from_addr'][1])
 273 
 274     # validate username, email and group membership
 275 
 276     member = request.user.name
 277     membership = set(request.groups.groups_with_member(member))
 278     sender = (msg['from_addr'][0]).replace(' ','')
 279     receiver = msg['to_addrs'][0][0]
 280     site = request.cfg.sitename
 281 
 282     dropbox = ("%s/DropBox" % receiver)
 283     mailnotes = ("%s/MailNotes" % receiver)
 284     
 285     try:
 286         contact = request.cfg.mail_contact
 287     except AttributeError:
 288         contact = request.cfg.superuser[0]
 289         
 290     adminnotes = ("%s/MailNotes" % contact)
 291 
 292     in_DropBoxGroup = 'DropBoxGroup' in membership
 293     in_WikiMailGroup = 'WikiMailGroup' in membership
 294 
 295     receiver_has_pages = Page(request, receiver).isStandardPage(False) and \
 296                          Page(request, dropbox).isStandardPage(False) and \
 297                          Page(request, mailnotes).isStandardPage(False)
 298                 
 299     contact_has_notes = Page(request, adminnotes).isStandardPage(False)
 300 
 301     error = ''
 302     qualified = False
 303 
 304     try:
 305         strict = request.cfg.mail_sender_strict
 306     except AttributeError:
 307         strict = False
 308 
 309     if (member == sender) or \
 310        (member and not strict):
 311        # consistent mail address needed to qualify or
 312        # member needs to be known to qualifies
 313         if (member == receiver): # to self
 314             if in_DropBoxGroup and receiver_has_pages:
 315                 qualified = True # member to self and has target pages, so all clear
 316             else:
 317                 error = _("You are not permitted to submit by email.")
 318         else: # to other
 319             if in_WikiMailGroup and receiver_has_pages:
 320                 qualified = True # member appoved and receiver ready, so all clear
 321             elif in_WikiMailGroup and receiver == site:
 322                 qualified = True # member appoved, so all clear
 323             else:
 324                 error = _("You can only submit to your own pages.")
 325     else:
 326         error = _("Sender not recognised.")
 327 
 328     if error or not qualified:
 329         if not error:
 330             error = _("Unspecified error.")
 331         error += _(" Mail not processed reply status:: %s") % (mail_not_processed_reply(request, msg, error), )
 332         raise ProcessingError(error)
 333 
 334     # determine email purpose and validity for qualified sender
 335 
 336     task, subject = extract_mail_task(msg['subject'])
 337 
 338     error = ''
 339     valid_task = False
 340 
 341     if task in dropbox_tasks:
 342         valid_task = True
 343         if not in_DropBoxGroup:
 344             error = _("User not approved for DropBox task found in mail subject.")
 345         elif not receiver_has_pages:
 346             error = _("User does not have DropBox for task found in mail subject.")
 347         elif task == 'MsgAdmin' and not contact_has_notes:
 348             error = _("Contact person not set up to receive mail messages.")
 349     elif task == 'WikiMail':
 350         valid_task = True
 351         if not in_WikiMailGroup:
 352             error = _("User not approved for task found in mail subject.")
 353     else:
 354         error = _("No approved task found in mail subject.")
 355 
 356     if error or not valid_task:
 357         if not error:
 358             error = _("Unspecified error.")
 359         error += _(" Mail not processed reply status: %s") % (mail_not_processed_reply(request, msg, error), )
 360         raise ProcessingError(error)
 361 
 362     # process email according to requested task
 363 
 364     msg['subject'] = subject #give them a cleaned subject
 365 
 366     if task == 'DropFile':
 367         attachments = do_task_dropfile(request, msg, dropbox)
 368         
 369     if task in ('DropFile', 'AddNote', ):
 370         do_task_addnote(request, msg, mailnotes)
 371 
 372     if task == 'MsgAdmin':
 373         do_task_addnote(request, msg, adminnotes)
 374 
 375     if task == 'WikiMail':
 376         do_task_wikimail(request, msg)
 377 
 378 if __name__ == "__main__":
 379     if len(sys.argv) > 1:
 380         request_url = sys.argv[1]
 381     else:
 382         request_url = None
 383 
 384     from MoinMoin.web.contexts import ScriptContext
 385     request = ScriptContext(url=request_url)
 386 
 387     try:
 388         import_mail_from_file(request, infile)
 389     except ProcessingError, e:
 390         print >> sys.stderr, "An error occured while processing the message:", e.args