1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>)
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
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
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/>
20 ##############################################################################
22 from osv import osv, fields
27 from email.header import decode_header
30 from tools.translate import _
34 _logger = logging.getLogger('mailgate')
36 class mailgate_thread(osv.osv):
40 _name = 'mailgate.thread'
41 _description = 'Mailgateway Thread'
44 'message_ids': fields.one2many('mailgate.message', 'res_id', 'Messages', readonly=True),
47 def copy(self, cr, uid, id, default=None, context=None):
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
67 return super(mailgate_thread, self).copy(cr, uid, id, default, context=context)
69 def message_new(self, cr, uid, msg, context):
70 raise Exception, _('Method is not implemented')
72 def message_update(self, cr, uid, ids, vals={}, msg="", default_act='pending', context={}):
73 raise Exception, _('Method is not implemented')
75 def message_followers(self, cr, uid, ids, context=None):
76 """ Get a list of emails of the people following this thread
79 if isinstance(ids, (str, int, long)):
81 for thread in self.browse(cr, uid, ids, context=context):
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 '')
90 def msg_send(self, cr, uid, id, *args, **argv):
91 raise Exception, _('Method is not implemented')
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):
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"""
116 # The mailgate sends the ids of the cases and not the object list
118 if all(isinstance(case_id, (int, long)) for case_id in cases):
119 cases = self.browse(cr, uid, cases, context=context)
121 att_obj = self.pool.get('ir.attachment')
122 obj = self.pool.get('mailgate.message')
127 attachments.append(att_obj.create(cr, uid, {'name': att[0], 'datas': base64.encodestring(att[1])}))
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':
135 'model' : case._name,
136 'partner_id': partner_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)]
145 for param in (email, email_cc, email_bcc):
146 if isinstance(param, list):
147 param = ", ".join(param)
150 'name': subject or _('History'),
153 'model' : case._name,
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),
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)]
168 obj.create(cr, uid, data, context=context)
172 def format_date_tz(date, tz=None):
175 format = tools.DEFAULT_SERVER_DATETIME_FORMAT
176 return tools.server_to_local_timestamp(date, format, format, tz)
178 class mailgate_message(osv.osv):
182 def open_document(self, cr, uid, ids, context):
184 @param self: The object pointer.
185 @param cr: A database cursor
186 @param uid: ID of the user currently logged in
187 @param ids: the ID of messages
188 @param context: A standard dictionary
193 mailgate_data = self.browse(cr, uid, message_id)
194 model = mailgate_data.model
195 res_id = mailgate_data.res_id
197 action_pool = self.pool.get('ir.actions.act_window')
198 action_ids = action_pool.search(cr, uid, [('res_model', '=', model)])
200 action_data = action_pool.read(cr, uid, action_ids[0], context=context)
202 'domain' : "[('id','=',%d)]"%(res_id),
207 def open_attachment(self, cr, uid, ids, context):
208 """ To Open attachments
209 @param self: The object pointer.
210 @param cr: A database cursor
211 @param uid: ID of the user currently logged in
212 @param ids: the ID of messages
213 @param context: A standard dictionary
216 action_pool = self.pool.get('ir.actions.act_window')
217 message_pool = self.browse(cr ,uid, ids)[0]
218 action_ids = action_pool.search(cr, uid, [('res_model', '=', 'ir.attachment')])
220 action_data = action_pool.read(cr, uid, action_ids[0], context=context)
222 'domain': [('res_id','=',message_pool.res_id),('res_model','=',message_pool.model)],
227 def truncate_data(self, cr, uid, data, context=None):
228 data_list = data and data.split('\n') or []
229 if len(data_list) > 3:
230 res = '\n\t'.join(data_list[:3]) + '...'
232 res = '\n\t'.join(data_list)
235 def _get_display_text(self, cr, uid, ids, name, arg, context=None):
238 tz = context.get('tz')
240 for message in self.browse(cr, uid, ids, context=context):
243 msg_txt += (message.email_from or '/') + _(' wrote on ') + format_date_tz(message.date, tz) + ':\n\t'
244 if message.description:
245 msg_txt += self.truncate_data(cr, uid, message.description, context=context)
247 msg_txt = (message.user_id.name or '/') + _(' on ') + format_date_tz(message.date, tz) + ':\n\t'
248 if message.name == _('Opportunity'):
249 msg_txt += _("Converted to Opportunity")
250 elif message.name == _('Note'):
251 msg_txt = (message.user_id.name or '/') + _(' added note on ') + format_date_tz(message.date, tz) + ':\n\t'
252 msg_txt += self.truncate_data(cr, uid, message.description, context=context)
254 msg_txt += _("Changed Status to: ") + message.name
255 result[message.id] = msg_txt
258 _name = 'mailgate.message'
259 _description = 'Mailgateway Message'
262 'name':fields.text('Subject', readonly=True),
263 'model': fields.char('Object Name', size=128, select=1, readonly=True),
264 'res_id': fields.integer('Resource ID', select=1, readonly=True),
265 'ref_id': fields.char('Reference Id', size=256, readonly=True, help="Message Id in Email Server.", select=True),
266 'date': fields.datetime('Date', readonly=True),
267 'history': fields.boolean('Is History?', readonly=True),
268 'user_id': fields.many2one('res.users', 'User Responsible', readonly=True),
269 'message': fields.text('Description', readonly=True),
270 'email_from': fields.char('From', size=128, help="Email From", readonly=True),
271 'email_to': fields.char('To', help="Email Recipients", size=256, readonly=True),
272 'email_cc': fields.char('Cc', help="Carbon Copy Email Recipients", size=256, readonly=True),
273 'email_bcc': fields.char('Bcc', help='Blind Carbon Copy Email Recipients', size=256, readonly=True),
274 'message_id': fields.char('Message Id', size=1024, readonly=True, help="Message Id on Email.", select=True),
275 'references': fields.text('References', readonly=True, help="References emails."),
276 'description': fields.text('Description', readonly=True),
277 'partner_id': fields.many2one('res.partner', 'Partner', required=False),
278 'attachment_ids': fields.many2many('ir.attachment', 'message_attachment_rel', 'message_id', 'attachment_id', 'Attachments', readonly=True),
279 'display_text': fields.function(_get_display_text, method=True, type='text', size="512", string='Display Text'),
283 cr.execute("""SELECT indexname
285 WHERE indexname = 'mailgate_message_res_id_model_idx'""")
286 if not cr.fetchone():
287 cr.execute("""CREATE INDEX mailgate_message_res_id_model_idx
288 ON mailgate_message (model, res_id)""")
292 class mailgate_tool(osv.osv_memory):
294 _name = 'email.server.tools'
295 _description = "Email Server Tools"
297 def _decode_header(self, text):
298 """Returns unicode() string conversion of the the given encoded smtp header"""
300 text = decode_header(text.replace('\r', ''))
301 return ''.join([tools.ustr(x[0], x[1]) for x in text])
303 def to_email(self,text):
304 return re.findall(r'([^ ,<@]+@[^> ,]+)',text)
306 def history(self, cr, uid, model, res_ids, msg, attach, context=None):
307 """This function creates history for mails fetched
308 @param self: The object pointer
309 @param cr: the current row, from the database cursor,
310 @param uid: the current user’s ID for security checks,
311 @param model: OpenObject Model
312 @param res_ids: Ids of the record of OpenObject model created
313 @param msg: Email details
314 @param attach: Email attachments
316 if isinstance(res_ids, (int, long)):
319 msg_pool = self.pool.get('mailgate.message')
320 for res_id in res_ids:
321 case = self.pool.get(model).browse(cr, uid, res_id, context=context)
322 partner_id = hasattr(case, 'partner_id') and (case.partner_id and case.partner_id.id or False) or False
323 if not partner_id and model == 'res.partner':
326 'name': msg.get('subject', 'No subject'),
327 'date': msg.get('date'),
328 'description': msg.get('body', msg.get('from')),
330 'partner_id': partner_id,
332 'email_cc': msg.get('cc'),
333 'email_from': msg.get('from'),
334 'email_to': msg.get('to'),
335 'message_id': msg.get('message-id'),
336 'references': msg.get('references') or msg.get('in-reply-to'),
339 'attachment_ids': [(6, 0, attach)]
341 msg_pool.create(cr, uid, msg_data, context=context)
344 def email_forward(self, cr, uid, model, res_ids, msg, email_error=False, context=None):
345 """Sends an email to all people following the thread
346 @param res_id: Id of the record of OpenObject model created from the email message
347 @param msg: email.message.Message to forward
348 @param email_error: Default Email address in case of any Problem
350 model_pool = self.pool.get(model)
352 for res in model_pool.browse(cr, uid, res_ids, context=context):
353 message_followers = model_pool.message_followers(cr, uid, [res.id])[res.id]
354 message_followers_emails = self.to_email(','.join(filter(None, message_followers)))
355 message_recipients = self.to_email(','.join(filter(None,
356 [self._decode_header(msg['from']),
357 self._decode_header(msg['to']),
358 self._decode_header(msg['cc'])])))
359 message_forward = [i for i in message_followers_emails if (i and (i not in message_recipients))]
362 # TODO: we need an interface for this for all types of objects, not just leads
363 if hasattr(res, 'section_id'):
365 msg['reply-to'] = res.section_id.reply_to
367 smtp_from = self.to_email(msg['from'])
368 if not tools.misc._email_send(smtp_from, message_forward, msg, openobject_id=res.id) and email_error:
369 subj = msg['subject']
370 del msg['subject'], msg['to'], msg['cc'], msg['bcc']
371 msg['subject'] = '[OpenERP-Forward-Failed] %s' % subj
372 msg['to'] = email_error
373 tools.misc._email_send(smtp_from, self.to_email(email_error), msg, openobject_id=res.id)
375 def process_email(self, cr, uid, model, message, custom_values=None, attach=True, context=None):
376 """This function Processes email and create record for given OpenERP model
377 @param self: The object pointer
378 @param cr: the current row, from the database cursor,
379 @param uid: the current user’s ID for security checks,
380 @param model: OpenObject Model
381 @param message: Email details, passed as a string or an xmlrpclib.Binary
382 @param attach: Email attachments
383 @param context: A standard dictionary for contextual values"""
385 # extract message bytes, we are forced to pass the message as binary because
386 # we don't know its encoding until we parse its headers and hence can't
387 # convert it to utf-8 for transport between the mailgate script and here.
388 if isinstance(message, xmlrpclib.Binary):
389 message = str(message.data)
394 if custom_values is None or not isinstance(custom_values, dict):
397 model_pool = self.pool.get(model)
400 # Create New Record into particular model
401 def create_record(msg):
403 if hasattr(model_pool, 'message_new'):
404 res_id = model_pool.message_new(cr, uid, msg, context)
406 model_pool.write(cr, uid, [res_id], custom_values, context=context)
409 'name': msg.get('subject'),
410 'email_from': msg.get('from'),
411 'email_cc': msg.get('cc'),
413 'description': msg.get('body'),
416 data.update(self.get_partner(cr, uid, msg.get('from'), context=context))
417 res_id = model_pool.create(cr, uid, data, context=context)
420 for attachment in msg.get('attachments', []):
423 'datas': binascii.b2a_base64(str(attachments.get(attachment))),
424 'datas_fname': attachment,
425 'description': 'Mail attachment',
429 att_ids.append(self.pool.get('ir.attachment').create(cr, uid, data_attach))
431 return res_id, att_ids
433 # Warning: message_from_string doesn't always work correctly on unicode,
434 # we must use utf-8 strings here :-(
435 if isinstance(message, unicode):
436 message = message.encode('utf-8')
437 msg_txt = email.message_from_string(message)
438 message_id = msg_txt.get('message-id', False)
442 # Very unusual situation, be we should be fault-tolerant here
443 message_id = time.time()
444 msg_txt['message-id'] = message_id
445 _logger.info('Message without message-id, generating a random one: %s', message_id)
447 fields = msg_txt.keys()
448 msg['id'] = message_id
449 msg['message-id'] = message_id
451 if 'Subject' in fields:
452 msg['subject'] = self._decode_header(msg_txt.get('Subject'))
454 if 'Content-Type' in fields:
455 msg['content-type'] = msg_txt.get('Content-Type')
458 msg['from'] = self._decode_header(msg_txt.get('From'))
460 if 'Delivered-To' in fields:
461 msg['to'] = self._decode_header(msg_txt.get('Delivered-To'))
464 msg['cc'] = self._decode_header(msg_txt.get('CC'))
466 if 'Reply-to' in fields:
467 msg['reply'] = self._decode_header(msg_txt.get('Reply-To'))
470 msg['date'] = self._decode_header(msg_txt.get('Date'))
472 if 'Content-Transfer-Encoding' in fields:
473 msg['encoding'] = msg_txt.get('Content-Transfer-Encoding')
475 if 'References' in fields:
476 msg['references'] = msg_txt.get('References')
478 if 'In-Reply-To' in fields:
479 msg['in-reply-to'] = msg_txt.get('In-Reply-To')
481 if 'X-Priority' in fields:
482 msg['priority'] = msg_txt.get('X-Priority', '3 (Normal)').split(' ')[0]
484 if not msg_txt.is_multipart() or 'text/plain' in msg.get('Content-Type', ''):
485 encoding = msg_txt.get_content_charset()
486 body = msg_txt.get_payload(decode=True)
487 msg['body'] = tools.ustr(body, encoding)
490 has_plain_text = False
491 if msg_txt.is_multipart() or 'multipart/alternative' in msg.get('content-type', ''):
493 for part in msg_txt.walk():
494 if part.get_content_maintype() == 'multipart':
497 encoding = part.get_content_charset()
498 filename = part.get_filename()
499 if part.get_content_maintype()=='text':
500 content = part.get_payload(decode=True)
502 attachments[filename] = content
503 elif not has_plain_text:
504 # main content parts should have 'text' maintype
505 # and no filename. we ignore the html part if
506 # there is already a plaintext part without filename,
507 # because presumably these are alternatives.
508 content = tools.ustr(content, encoding)
509 if part.get_content_subtype() == 'html':
510 body = tools.ustr(tools.html2plaintext(content))
511 elif part.get_content_subtype() == 'plain':
513 has_plain_text = True
514 elif part.get_content_maintype() in ('application', 'image'):
516 attachments[filename] = part.get_payload(decode=True)
518 res = part.get_payload(decode=True)
519 body += tools.ustr(res, encoding)
522 msg['attachments'] = attachments
526 if msg.get('references') or msg.get('in-reply-to'):
527 references = msg.get('references') or msg.get('in-reply-to')
528 if '\r\n' in references:
529 references = references.split('\r\n')
531 references = references.split(' ')
532 for ref in references:
534 res_id = tools.misc.reference_re.search(ref)
536 res_id = res_id.group(1)
538 res_id = tools.misc.res_re.search(msg['subject'])
540 res_id = res_id.group(1)
543 model_pool = self.pool.get(model)
544 if model_pool.exists(cr, uid, res_id):
545 res_ids.append(res_id)
546 if hasattr(model_pool, 'message_update'):
547 model_pool.message_update(cr, uid, [res_id], {}, msg, context=context)
549 raise NotImplementedError('model %s does not support updating records, mailgate API method message_update() is missing'%model)
552 new_res_id, attachment_ids = create_record(msg)
553 res_ids = [new_res_id]
556 context.update({'model' : model})
557 if hasattr(model_pool, 'history'):
558 model_pool.history(cr, uid, res_ids, _('receive'), history=True,
559 subject = msg.get('subject'),
560 email = msg.get('to'),
561 details = msg.get('body'),
562 email_from = msg.get('from'),
563 email_cc = msg.get('cc'),
564 message_id = msg.get('message-id'),
565 references = msg.get('references', False) or msg.get('in-reply-to', False),
566 attach = attachments.items(),
569 self.history(cr, uid, model, res_ids, msg, attachment_ids, context=context)
570 self.email_forward(cr, uid, model, res_ids, msg_txt)
573 def get_partner(self, cr, uid, from_email, context=None):
574 """This function returns partner Id based on email passed
575 @param self: The object pointer
576 @param cr: the current row, from the database cursor,
577 @param uid: the current user’s ID for security checks
578 @param from_email: email address based on that function will search for the correct
580 address_pool = self.pool.get('res.partner.address')
582 'partner_address_id': False,
585 from_email = self.to_email(from_email)[0]
586 address_ids = address_pool.search(cr, uid, [('email', 'like', from_email)])
588 address = address_pool.browse(cr, uid, address_ids[0])
589 res['partner_address_id'] = address_ids[0]
590 res['partner_id'] = address.partner_id.id
596 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: