addons/mail_gateway/mail_gateway.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>)
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>
  19 #
  20 ##############################################################################
  21
  22 from osv import osv, fields
  23 import time
  24 import tools
  25 import binascii
  26 import email
  27 from email.header import decode_header
  28 import base64
  29 import re
  30 from tools.translate import _
  31 import logging
  32 import xmlrpclib
  33
  34 _logger = logging.getLogger('mailgate')
  35
  36 class mailgate_thread(osv.osv):
  37     '''
  38     Mailgateway Thread
  39     '''
  40     _name = 'mailgate.thread'
  41     _description = 'Mailgateway Thread'
  42
  43     _columns = {
  44         'message_ids': fields.one2many('mailgate.message', 'res_id', 'Messages', readonly=True),
  45     }
  46
  47     def copy(self, cr, uid, id, default=None, context=None):
  48         """
  49         Overrides orm copy method.
  50         @param self: the object pointer
  51         @param cr: the current row, from the database cursor,
  52         @param uid: the current user’s ID for security checks,
  53         @param id: Id of mailgate thread
  54         @param default: Dictionary of default values for copy.
  55         @param context: A standard dictionary for contextual values
  56         """
  57         if context is None:
  58             context = {}
  59         if default is None:
  60             default = {}
  61
  62         default.update({
  63             'message_ids': [],
  64             'date_closed': False,
  65             'date_open': False
  66         })
  67         return super(mailgate_thread, self).copy(cr, uid, id, default, context=context)
  68
  69     def message_new(self, cr, uid, msg, context):
  70         raise Exception, _('Method is not implemented')
  71
  72     def message_update(self, cr, uid, ids, vals={}, msg="", default_act='pending', context={}):
  73         raise Exception, _('Method is not implemented')
  74
  75     def message_followers(self, cr, uid, ids, context=None):
  76         """ Get a list of emails of the people following this thread
  77         """
  78         res = {}
  79         if isinstance(ids, (str, int, long)):
  80             ids = [long(ids)]
  81         for thread in self.browse(cr, uid, ids, context=context):
  82             l=[]
  83             for message in thread.message_ids:
  84                 l.append((message.user_id and message.user_id.email) or '')
  85                 l.append(message.email_from or '')
  86                 l.append(message.email_cc or '')
  87             res[thread.id] = l
  88         return res
  89
  90     def msg_send(self, cr, uid, id, *args, **argv):
  91         raise Exception, _('Method is not implemented')
  92
  93     def history(self, cr, uid, cases, keyword, history=False, subject=None, email=False, details=None, \
  94                     email_from=False, message_id=False, references=None, attach=None, email_cc=None, \
  95                     email_bcc=None, email_date=None, context=None):
  96         """
  97         @param self: The object pointer
  98         @param cr: the current row, from the database cursor,
  99         @param uid: the current user’s ID for security checks,
 100         @param cases: a browse record list
 101         @param keyword: Case action keyword e.g.: If case is closed "Close" keyword is used
 102         @param history: Value True/False, If True it makes entry in case History otherwise in Case Log
 103         @param email: Email-To / Recipient address
 104         @param email_from: Email From / Sender address if any
 105         @param email_cc: Comma-Separated list of Carbon Copy Emails To addresse if any
 106         @param email_bcc: Comma-Separated list of Blind Carbon Copy Emails To addresses if any
 107         @param email_date: Email Date string if different from now, in server Timezone
 108         @param details: Description, Details of case history if any
 109         @param atach: Attachment sent in email
 110         @param context: A standard dictionary for contextual values"""
 111         if context is None:
 112             context = {}
 113         if attach is None:
 114             attach = []
 115
 116         # The mailgate sends the ids of the cases and not the object list
 117
 118         if all(isinstance(case_id, (int, long)) for case_id in cases):
 119             cases = self.browse(cr, uid, cases, context=context)
 120
 121         att_obj = self.pool.get('ir.attachment')
 122         obj = self.pool.get('mailgate.message')
 123
 124         for case in cases:
 125             attachments = []
 126             for att in attach:
 127                     attachments.append(att_obj.create(cr, uid, {'name': att[0], 'datas': base64.encodestring(att[1])}))
 128
 129             partner_id = hasattr(case, 'partner_id') and (case.partner_id and case.partner_id.id or False) or False
 130             if not partner_id and case._name == 'res.partner':
 131                 partner_id = case.id
 132             data = {
 133                 'name': keyword,
 134                 'user_id': uid,
 135                 'model' : case._name,
 136                 'partner_id': partner_id,
 137                 'res_id': case.id,
 138                 'date': time.strftime('%Y-%m-%d %H:%M:%S'),
 139                 'message_id': message_id,
 140                 'description': details or (hasattr(case, 'description') and case.description or False),
 141                 'attachment_ids': [(6, 0, attachments)]
 142             }
 143
 144             if history:
 145                 for param in (email, email_cc, email_bcc):
 146                     if isinstance(param, list):
 147                         param = ", ".join(param)
 148
 149                 data = {
 150                     'name': subject or _('History'),
 151                     'history': True,
 152                     'user_id': uid,
 153                     'model' : case._name,
 154                     'res_id': case.id,
 155                     'date': email_date or time.strftime('%Y-%m-%d %H:%M:%S'),
 156                     'description': details or (hasattr(case, 'description') and case.description or False),
 157                     'email_to': email,
 158                     'email_from': email_from or \
 159                         (hasattr(case, 'user_id') and case.user_id and case.user_id.address_id and \
 160                          case.user_id.address_id.email),
 161                     'email_cc': email_cc,
 162                     'email_bcc': email_bcc,
 163                     'partner_id': partner_id,
 164                     'references': references,
 165                     'message_id': message_id,
 166                     'attachment_ids': [(6, 0, attachments)]
 167                 }
 168             obj.create(cr, uid, data, context=context)
 169         return True
 170 mailgate_thread()
 171
 172 def format_date_tz(date, tz=None):
 173     if not date:
 174         return 'n/a'
 175     format = tools.DEFAULT_SERVER_DATETIME_FORMAT
 176     return tools.server_to_local_timestamp(date, format, format, tz)
 177
 178 class mailgate_message(osv.osv):
 179     '''
 180     Mailgateway Message
 181     '''
 182     def truncate_data(self, cr, uid, data, context=None):
 183         data_list = data and data.split('\n') or []
 184         if len(data_list) > 3:
 185             res = '\n\t'.join(data_list[:3]) + '...'
 186         else:
 187             res = '\n\t'.join(data_list)
 188         return res
 189
 190     def _get_display_text(self, cr, uid, ids, name, arg, context=None):
 191         if context is None:
 192             context = {}
 193         tz = context.get('tz')
 194         result = {}
 195         for message in self.browse(cr, uid, ids, context=context):
 196             msg_txt = ''
 197             if message.history:
 198                 msg_txt += (message.email_from or '/') + _(' wrote on ') + format_date_tz(message.date, tz) + ':\n\t'
 199                 if message.description:
 200                     msg_txt += self.truncate_data(cr, uid, message.description, context=context)
 201             else:
 202                 msg_txt = (message.user_id.name or '/') + _(' on ') + format_date_tz(message.date, tz) + ':\n\t'
 203                 if message.name == _('Opportunity'):
 204                     msg_txt += _("Converted to Opportunity")
 205                 elif message.name == _('Note'):
 206                     msg_txt = (message.user_id.name or '/') + _(' added note on ') + format_date_tz(message.date, tz) + ':\n\t'
 207                     msg_txt += self.truncate_data(cr, uid, message.description, context=context)
 208                 else:
 209                     msg_txt += _("Changed Status to: ") + message.name
 210             result[message.id] = msg_txt
 211         return result
 212
 213     _name = 'mailgate.message'
 214     _description = 'Mailgateway Message'
 215     _order = 'date desc'
 216     _columns = {
 217         'name':fields.text('Subject', readonly=True),
 218         'model': fields.char('Object Name', size=128, select=1, readonly=True),
 219         'res_id': fields.integer('Resource ID', select=1, readonly=True),
 220         'ref_id': fields.char('Reference Id', size=256, readonly=True, help="Message Id in Email Server.", select=True),
 221         'date': fields.datetime('Date', readonly=True),
 222         'history': fields.boolean('Is History?', readonly=True),
 223         'user_id': fields.many2one('res.users', 'User Responsible', readonly=True),
 224         'message': fields.text('Description', readonly=True),
 225         'email_from': fields.char('From', size=128, help="Email From", readonly=True),
 226         'email_to': fields.char('To', help="Email Recipients", size=256, readonly=True),
 227         'email_cc': fields.char('Cc', help="Carbon Copy Email Recipients", size=256, readonly=True),
 228         'email_bcc': fields.char('Bcc', help='Blind Carbon Copy Email Recipients', size=256, readonly=True),
 229         'message_id': fields.char('Message Id', size=1024, readonly=True, help="Message Id on Email.", select=True),
 230         'references': fields.text('References', readonly=True, help="References emails."),
 231         'description': fields.text('Description', readonly=True),
 232         'partner_id': fields.many2one('res.partner', 'Partner', required=False),
 233         'attachment_ids': fields.many2many('ir.attachment', 'message_attachment_rel', 'message_id', 'attachment_id', 'Attachments', readonly=True),
 234         'display_text': fields.function(_get_display_text, method=True, type='text', size="512", string='Display Text'),
 235     }
 236
 237     def init(self, cr):
 238         cr.execute("""SELECT indexname
 239                       FROM pg_indexes
 240                       WHERE indexname = 'mailgate_message_res_id_model_idx'""")
 241         if not cr.fetchone():
 242             cr.execute("""CREATE INDEX mailgate_message_res_id_model_idx
 243                           ON mailgate_message (model, res_id)""")
 244
 245 mailgate_message()
 246
 247 class mailgate_tool(osv.osv_memory):
 248
 249     _name = 'email.server.tools'
 250     _description = "Email Server Tools"
 251
 252     def _decode_header(self, text):
 253         """Returns unicode() string conversion of the the given encoded smtp header"""
 254         if text:
 255             text = decode_header(text.replace('\r', ''))
 256             return ''.join([tools.ustr(x[0], x[1]) for x in text])
 257
 258     def to_email(self,text):
 259         return re.findall(r'([^ ,<@]+@[^> ,]+)',text)
 260
 261     def history(self, cr, uid, model, res_ids, msg, attach, context=None):
 262         """This function creates history for mails fetched
 263         @param self: The object pointer
 264         @param cr: the current row, from the database cursor,
 265         @param uid: the current user’s ID for security checks,
 266         @param model: OpenObject Model
 267         @param res_ids: Ids of the record of OpenObject model created
 268         @param msg: Email details
 269         @param attach: Email attachments
 270         """
 271         if isinstance(res_ids, (int, long)):
 272             res_ids = [res_ids]
 273
 274         msg_pool = self.pool.get('mailgate.message')
 275         for res_id in res_ids:
 276             case = self.pool.get(model).browse(cr, uid, res_id, context=context)
 277             partner_id = hasattr(case, 'partner_id') and (case.partner_id and case.partner_id.id or False) or False
 278             if not partner_id and model == 'res.partner':
 279                 partner_id = res_id
 280             msg_data = {
 281                 'name': msg.get('subject', 'No subject'),
 282                 'date': msg.get('date'),
 283                 'description': msg.get('body', msg.get('from')),
 284                 'history': True,
 285                 'partner_id': partner_id,
 286                 'model': model,
 287                 'email_cc': msg.get('cc'),
 288                 'email_from': msg.get('from'),
 289                 'email_to': msg.get('to'),
 290                 'message_id': msg.get('message-id'),
 291                 'references': msg.get('references') or msg.get('in-reply-to'),
 292                 'res_id': res_id,
 293                 'user_id': uid,
 294                 'attachment_ids': [(6, 0, attach)]
 295             }
 296             msg_pool.create(cr, uid, msg_data, context=context)
 297         return True
 298
 299     def email_forward(self, cr, uid, model, res_ids, msg, email_error=False, context=None):
 300         """Sends an email to all people following the thread
 301         @param res_id: Id of the record of OpenObject model created from the email message
 302         @param msg: email.message.Message to forward
 303         @param email_error: Default Email address in case of any Problem
 304         """
 305         model_pool = self.pool.get(model)
 306
 307         for res in model_pool.browse(cr, uid, res_ids, context=context):
 308             message_followers = model_pool.message_followers(cr, uid, [res.id])[res.id]
 309             message_followers_emails = self.to_email(','.join(filter(None, message_followers)))
 310             message_recipients = self.to_email(','.join(filter(None,
 311                                                          [self._decode_header(msg['from']),
 312                                                          self._decode_header(msg['to']),
 313                                                          self._decode_header(msg['cc'])])))
 314             message_forward = [i for i in message_followers_emails if (i and (i not in message_recipients))]
 315
 316             if message_forward:
 317                 # TODO: we need an interface for this for all types of objects, not just leads
 318                 if hasattr(res, 'section_id'):
 319                     del msg['reply-to']
 320                     msg['reply-to'] = res.section_id.reply_to
 321
 322                 smtp_from = self.to_email(msg['from'])
 323                 if not tools.misc._email_send(smtp_from, message_forward, msg, openobject_id=res.id) and email_error:
 324                     subj = msg['subject']
 325                     del msg['subject'], msg['to'], msg['cc'], msg['bcc']
 326                     msg['subject'] = '[OpenERP-Forward-Failed] %s' % subj
 327                     msg['to'] = email_error
 328                     tools.misc._email_send(smtp_from, self.to_email(email_error), msg, openobject_id=res.id)
 329
 330     def process_email(self, cr, uid, model, message, attach=True, context=None):
 331         """This function Processes email and create record for given OpenERP model
 332         @param self: The object pointer
 333         @param cr: the current row, from the database cursor,
 334         @param uid: the current user’s ID for security checks,
 335         @param model: OpenObject Model
 336         @param message: Email details, passed as a string or an xmlrpclib.Binary
 337         @param attach: Email attachments
 338         @param context: A standard dictionary for contextual values"""
 339
 340         # extract message bytes, we are forced to pass the message as binary because
 341         # we don't know its encoding until we parse its headers and hence can't
 342         # convert it to utf-8 for transport between the mailgate script and here.
 343         if isinstance(message, xmlrpclib.Binary):
 344             message = str(message.data)
 345
 346         if not context:
 347             context = {}
 348
 349         model_pool = self.pool.get(model)
 350         res_id = False
 351
 352         # Create New Record into particular model
 353         def create_record(msg):
 354             att_ids = []
 355             if hasattr(model_pool, 'message_new'):
 356                 res_id = model_pool.message_new(cr, uid, msg, context)
 357             else:
 358                 data = {
 359                     'name': msg.get('subject'),
 360                     'email_from': msg.get('from'),
 361                     'email_cc': msg.get('cc'),
 362                     'user_id': False,
 363                     'description': msg.get('body'),
 364                     'state' : 'draft',
 365                 }
 366                 data.update(self.get_partner(cr, uid, msg.get('from'), context=context))
 367                 res_id = model_pool.create(cr, uid, data, context=context)
 368
 369                 if attach:
 370                     for attachment in msg.get('attachments', []):
 371                         data_attach = {
 372                             'name': attachment,
 373                             'datas': binascii.b2a_base64(str(attachments.get(attachment))),
 374                             'datas_fname': attachment,
 375                             'description': 'Mail attachment',
 376                             'res_model': model,
 377                             'res_id': res_id,
 378                         }
 379                         att_ids.append(self.pool.get('ir.attachment').create(cr, uid, data_attach))
 380
 381             return res_id, att_ids
 382
 383         # Warning: message_from_string doesn't always work correctly on unicode,
 384         # we must use utf-8 strings here :-(
 385         if isinstance(message, unicode):
 386             message = message.encode('utf-8')
 387         msg_txt = email.message_from_string(message)
 388         message_id = msg_txt.get('message-id', False)
 389         msg = {}
 390
 391         if not message_id:
 392             # Very unusual situation, be we should be fault-tolerant here
 393             message_id = time.time()
 394             msg_txt['message-id'] = message_id
 395             _logger.info('Message without message-id, generating a random one: %s', message_id)
 396
 397         fields = msg_txt.keys()
 398         msg['id'] = message_id
 399         msg['message-id'] = message_id
 400
 401         if 'Subject' in fields:
 402             msg['subject'] = self._decode_header(msg_txt.get('Subject'))
 403
 404         if 'Content-Type' in fields:
 405             msg['content-type'] = msg_txt.get('Content-Type')
 406
 407         if 'From' in fields:
 408             msg['from'] = self._decode_header(msg_txt.get('From'))
 409
 410         if 'Delivered-To' in fields:
 411             msg['to'] = self._decode_header(msg_txt.get('Delivered-To'))
 412
 413         if 'CC' in fields:
 414             msg['cc'] = self._decode_header(msg_txt.get('CC'))
 415
 416         if 'Reply-to' in fields:
 417             msg['reply'] = self._decode_header(msg_txt.get('Reply-To'))
 418
 419         if 'Date' in fields:
 420             msg['date'] = self._decode_header(msg_txt.get('Date'))
 421
 422         if 'Content-Transfer-Encoding' in fields:
 423             msg['encoding'] = msg_txt.get('Content-Transfer-Encoding')
 424
 425         if 'References' in fields:
 426             msg['references'] = msg_txt.get('References')
 427
 428         if 'In-Reply-To' in fields:
 429             msg['in-reply-to'] = msg_txt.get('In-Reply-To')
 430
 431         if 'X-Priority' in fields:
 432             msg['priority'] = msg_txt.get('X-Priority', '3 (Normal)').split(' ')[0]
 433
 434         if not msg_txt.is_multipart() or 'text/plain' in msg.get('Content-Type', ''):
 435             encoding = msg_txt.get_content_charset()
 436             body = msg_txt.get_payload(decode=True)
 437             msg['body'] = tools.ustr(body, encoding)
 438
 439         attachments = {}
 440         has_plain_text = False
 441         if msg_txt.is_multipart() or 'multipart/alternative' in msg.get('content-type', ''):
 442             body = ""
 443             for part in msg_txt.walk():
 444                 if part.get_content_maintype() == 'multipart':
 445                     continue
 446
 447                 encoding = part.get_content_charset()
 448                 filename = part.get_filename()
 449                 if part.get_content_maintype()=='text':
 450                     content = part.get_payload(decode=True)
 451                     if filename:
 452                         attachments[filename] = content
 453                     elif not has_plain_text:
 454                         # main content parts should have 'text' maintype
 455                         # and no filename. we ignore the html part if
 456                         # there is already a plaintext part without filename,
 457                         # because presumably these are alternatives.
 458                         content = tools.ustr(content, encoding)
 459                         if part.get_content_subtype() == 'html':
 460                             body = tools.ustr(tools.html2plaintext(content))
 461                         elif part.get_content_subtype() == 'plain':
 462                             body = content
 463                             has_plain_text = True
 464                 elif part.get_content_maintype() in ('application', 'image'):
 465                     if filename :
 466                         attachments[filename] = part.get_payload(decode=True)
 467                     else:
 468                         res = part.get_payload(decode=True)
 469                         body += tools.ustr(res, encoding)
 470
 471             msg['body'] = body
 472             msg['attachments'] = attachments
 473         res_ids = []
 474         attachment_ids = []
 475         new_res_id = False
 476         if msg.get('references') or msg.get('in-reply-to'):
 477             references = msg.get('references') or msg.get('in-reply-to')
 478             if '\r\n' in references:
 479                 references = references.split('\r\n')
 480             else:
 481                 references = references.split(' ')
 482             for ref in references:
 483                 ref = ref.strip()
 484                 res_id = tools.misc.reference_re.search(ref)
 485                 if res_id:
 486                     res_id = res_id.group(1)
 487                 else:
 488                     res_id = tools.misc.res_re.search(msg['subject'])
 489                     if res_id:
 490                         res_id = res_id.group(1)
 491                 if res_id:
 492                     res_id = int(res_id)
 493                     model_pool = self.pool.get(model)
 494                     if model_pool.exists(cr, uid, res_id):
 495                         res_ids.append(res_id)
 496                         if hasattr(model_pool, 'message_update'):
 497                             model_pool.message_update(cr, uid, [res_id], {}, msg, context=context)
 498                         else:
 499                             raise NotImplementedError('model %s does not support updating records, mailgate API method message_update() is missing'%model)
 500
 501         if not len(res_ids):
 502             new_res_id, attachment_ids = create_record(msg)
 503             res_ids = [new_res_id]
 504
 505         # Store messages
 506         context.update({'model' : model})
 507         if hasattr(model_pool, 'history'):
 508             model_pool.history(cr, uid, res_ids, _('receive'), history=True,
 509                             subject = msg.get('subject'),
 510                             email = msg.get('to'),
 511                             details = msg.get('body'),
 512                             email_from = msg.get('from'),
 513                             email_cc = msg.get('cc'),
 514                             message_id = msg.get('message-id'),
 515                             references = msg.get('references', False) or msg.get('in-reply-to', False),
 516                             attach = attachments.items(),
 517                             context = context)
 518         else:
 519             self.history(cr, uid, model, res_ids, msg, attachment_ids, context=context)
 520         self.email_forward(cr, uid, model, res_ids, msg_txt)
 521         return new_res_id
 522
 523     def get_partner(self, cr, uid, from_email, context=None):
 524         """This function returns partner Id based on email passed
 525         @param self: The object pointer
 526         @param cr: the current row, from the database cursor,
 527         @param uid: the current user’s ID for security checks
 528         @param from_email: email address based on that function will search for the correct
 529         """
 530         address_pool = self.pool.get('res.partner.address')
 531         res = {
 532             'partner_address_id': False,
 533             'partner_id': False
 534         }
 535         from_email = self.to_email(from_email)[0]
 536         address_ids = address_pool.search(cr, uid, [('email', 'like', from_email)])
 537         if address_ids:
 538             address = address_pool.browse(cr, uid, address_ids[0])
 539             res['partner_address_id'] = address_ids[0]
 540             res['partner_id'] = address.partner_id.id
 541
 542         return res
 543
 544 mailgate_tool()