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
28 from email.utils import parsedate
31 from tools.translate import _
35 _logger = logging.getLogger('mailgate')
37 class mailgate_thread(osv.osv):
41 _name = 'mailgate.thread'
42 _description = 'Mailgateway Thread'
45 'message_ids': fields.one2many('mailgate.message', 'res_id', 'Messages', readonly=True),
48 def copy(self, cr, uid, id, default=None, context=None):
50 Overrides orm copy method.
51 @param self: the object pointer
52 @param cr: the current row, from the database cursor,
53 @param uid: the current user’s ID for security checks,
54 @param id: Id of mailgate thread
55 @param default: Dictionary of default values for copy.
56 @param context: A standard dictionary for contextual values
66 return super(mailgate_thread, self).copy(cr, uid, id, default, context=context)
68 def message_new(self, cr, uid, msg, context):
69 raise Exception, _('Method is not implemented')
71 def message_update(self, cr, uid, ids, vals={}, msg="", default_act='pending', context=None):
72 raise Exception, _('Method is not implemented')
74 def message_followers(self, cr, uid, ids, context=None):
75 """ Get a list of emails of the people following this thread
78 if isinstance(ids, (str, int, long)):
80 for thread in self.browse(cr, uid, ids, context=context):
82 for message in thread.message_ids:
83 l.append((message.user_id and message.user_id.email) or '')
84 l.append(message.email_from or '')
85 l.append(message.email_cc or '')
89 def msg_send(self, cr, uid, id, *args, **argv):
90 raise Exception, _('Method is not implemented')
92 def history(self, cr, uid, cases, keyword, history=False, subject=None, email=False, details=None, \
93 email_from=False, message_id=False, references=None, attach=None, email_cc=None, \
94 email_bcc=None, email_date=None, context=None):
96 @param self: The object pointer
97 @param cr: the current row, from the database cursor,
98 @param uid: the current user’s ID for security checks,
99 @param cases: a browse record list
100 @param keyword: Case action keyword e.g.: If case is closed "Close" keyword is used
101 @param history: Value True/False, If True it makes entry in case History otherwise in Case Log
102 @param email: Email-To / Recipient address
103 @param email_from: Email From / Sender address if any
104 @param email_cc: Comma-Separated list of Carbon Copy Emails To addresse if any
105 @param email_bcc: Comma-Separated list of Blind Carbon Copy Emails To addresses if any
106 @param email_date: Email Date string if different from now, in server Timezone
107 @param details: Description, Details of case history if any
108 @param atach: Attachment sent in email
109 @param context: A standard dictionary for contextual values"""
116 edate = parsedate(email_date)
117 if edate is not None:
118 email_date = time.strftime('%Y-%m-%d %H:%M:%S', edate)
120 # The mailgate sends the ids of the cases and not the object list
122 if all(isinstance(case_id, (int, long)) for case_id in cases):
123 cases = self.browse(cr, uid, cases, context=context)
125 att_obj = self.pool.get('ir.attachment')
126 obj = self.pool.get('mailgate.message')
131 attachments.append(att_obj.create(cr, uid, {'name': att[0], 'datas': base64.encodestring(att[1])}))
133 partner_id = hasattr(case, 'partner_id') and (case.partner_id and case.partner_id.id or False) or False
134 if not partner_id and case._name == 'res.partner':
139 'model' : case._name,
140 'partner_id': partner_id,
142 'date': time.strftime('%Y-%m-%d %H:%M:%S'),
143 'message_id': message_id,
144 'description': details or (hasattr(case, 'description') and case.description or False),
145 'attachment_ids': [(6, 0, attachments)]
149 for param in (email, email_cc, email_bcc):
150 if isinstance(param, list):
151 param = ", ".join(param)
154 'name': subject or _('History'),
157 'model' : case._name,
159 'date': email_date or time.strftime('%Y-%m-%d %H:%M:%S'),
160 'description': details or (hasattr(case, 'description') and case.description or False),
162 'email_from': email_from or \
163 (hasattr(case, 'user_id') and case.user_id and case.user_id.address_id and \
164 case.user_id.address_id.email),
165 'email_cc': email_cc,
166 'email_bcc': email_bcc,
167 'partner_id': partner_id,
168 'references': references,
169 'message_id': message_id,
170 'attachment_ids': [(6, 0, attachments)]
172 obj.create(cr, uid, data, context=context)
176 def format_date_tz(date, tz=None):
179 format = tools.DEFAULT_SERVER_DATETIME_FORMAT
180 return tools.server_to_local_timestamp(date, format, format, tz)
182 class mailgate_message(osv.osv):
186 def open_document(self, cr, uid, ids, context=None):
188 @param self: The object pointer.
189 @param cr: A database cursor
190 @param uid: ID of the user currently logged in
191 @param ids: the ID of messages
192 @param context: A standard dictionary
197 mailgate_data = self.browse(cr, uid, message_id, context=context)
198 model = mailgate_data.model
199 res_id = mailgate_data.res_id
201 action_pool = self.pool.get('ir.actions.act_window')
202 action_ids = action_pool.search(cr, uid, [('res_model', '=', model)])
204 action_data = action_pool.read(cr, uid, action_ids[0], context=context)
206 'domain' : "[('id','=',%d)]"%(res_id),
212 def open_attachment(self, cr, uid, ids, context=None):
213 """ To Open attachments
214 @param self: The object pointer.
215 @param cr: A database cursor
216 @param uid: ID of the user currently logged in
217 @param ids: the ID of messages
218 @param context: A standard dictionary
221 action_pool = self.pool.get('ir.actions.act_window')
222 message_pool = self.browse(cr ,uid, ids, context=context)[0]
223 action_ids = action_pool.search(cr, uid, [('res_model', '=', 'ir.attachment')])
225 action_data = action_pool.read(cr, uid, action_ids[0], context=context)
227 'domain': [('res_id','=',message_pool.res_id),('res_model','=',message_pool.model)],
232 def truncate_data(self, cr, uid, data, context=None):
233 data_list = data and data.split('\n') or []
234 if len(data_list) > 3:
235 res = '\n\t'.join(data_list[:3]) + '...'
237 res = '\n\t'.join(data_list)
240 def _get_display_text(self, cr, uid, ids, name, arg, context=None):
243 tz = context.get('tz')
245 for message in self.browse(cr, uid, ids, context=context):
248 msg_txt += (message.email_from or '/') + _(' wrote on ') + format_date_tz(message.date, tz) + ':\n\t'
249 if message.description:
250 msg_txt += self.truncate_data(cr, uid, message.description, context=context)
252 msg_txt = (message.user_id.name or '/') + _(' on ') + format_date_tz(message.date, tz) + ':\n\t'
253 if message.name == _('Opportunity'):
254 msg_txt += _("Converted to Opportunity")
255 elif message.name == _('Note'):
256 msg_txt = (message.user_id.name or '/') + _(' added note on ') + format_date_tz(message.date, tz) + ':\n\t'
257 msg_txt += self.truncate_data(cr, uid, message.description, context=context)
258 elif message.name == _('Stage'):
259 msg_txt += _("Changed Stage to: ") + message.description
261 msg_txt += _("Changed Status to: ") + message.name
262 result[message.id] = msg_txt
265 _name = 'mailgate.message'
266 _description = 'Mailgateway Message'
269 'name':fields.text('Subject', readonly=True),
270 'model': fields.char('Object Name', size=128, select=1, readonly=True),
271 'res_id': fields.integer('Resource ID', select=1, readonly=True),
272 'ref_id': fields.char('Reference Id', size=256, readonly=True, help="Message Id in Email Server.", select=True),
273 'date': fields.datetime('Date', readonly=True),
274 'history': fields.boolean('Is History?', readonly=True),
275 'user_id': fields.many2one('res.users', 'User Responsible', readonly=True),
276 'message': fields.text('Description', readonly=True),
277 'email_from': fields.char('From', size=128, help="Email From", readonly=True),
278 'email_to': fields.char('To', help="Email Recipients", size=256, readonly=True),
279 'email_cc': fields.char('Cc', help="Carbon Copy Email Recipients", size=256, readonly=True),
280 'email_bcc': fields.char('Bcc', help='Blind Carbon Copy Email Recipients', size=256, readonly=True),
281 'message_id': fields.char('Message Id', size=1024, readonly=True, help="Message Id on Email.", select=True),
282 'references': fields.text('References', readonly=True, help="References emails."),
283 'description': fields.text('Description', readonly=True),
284 'partner_id': fields.many2one('res.partner', 'Partner', required=False),
285 'attachment_ids': fields.many2many('ir.attachment', 'message_attachment_rel', 'message_id', 'attachment_id', 'Attachments', readonly=True),
286 'display_text': fields.function(_get_display_text, method=True, type='text', size="512", string='Display Text'),
290 cr.execute("""SELECT indexname
292 WHERE indexname = 'mailgate_message_res_id_model_idx'""")
293 if not cr.fetchone():
294 cr.execute("""CREATE INDEX mailgate_message_res_id_model_idx
295 ON mailgate_message (model, res_id)""")
299 class mailgate_tool(osv.osv_memory):
301 _name = 'email.server.tools'
302 _description = "Email Server Tools"
304 def _decode_header(self, text):
305 """Returns unicode() string conversion of the the given encoded smtp header"""
307 text = decode_header(text.replace('\r', ''))
308 return ''.join([tools.ustr(x[0], x[1]) for x in text])
310 def to_email(self,text):
311 return re.findall(r'([^ ,<@]+@[^> ,]+)',text)
313 def history(self, cr, uid, model, res_ids, msg, attach, context=None):
314 """This function creates history for mails fetched
315 @param self: The object pointer
316 @param cr: the current row, from the database cursor,
317 @param uid: the current user’s ID for security checks,
318 @param model: OpenObject Model
319 @param res_ids: Ids of the record of OpenObject model created
320 @param msg: Email details
321 @param attach: Email attachments
323 if isinstance(res_ids, (int, long)):
326 msg_pool = self.pool.get('mailgate.message')
327 for res_id in res_ids:
328 case = self.pool.get(model).browse(cr, uid, res_id, context=context)
329 partner_id = hasattr(case, 'partner_id') and (case.partner_id and case.partner_id.id or False) or False
330 if not partner_id and model == 'res.partner':
333 'name': msg.get('subject', 'No subject'),
334 'date': msg.get('date'),
335 'description': msg.get('body', msg.get('from')),
337 'partner_id': partner_id,
339 'email_cc': msg.get('cc'),
340 'email_from': msg.get('from'),
341 'email_to': msg.get('to'),
342 'message_id': msg.get('message-id'),
343 'references': msg.get('references') or msg.get('in-reply-to'),
346 'attachment_ids': [(6, 0, attach)]
348 msg_pool.create(cr, uid, msg_data, context=context)
351 def email_forward(self, cr, uid, model, res_ids, msg, email_error=False, context=None):
352 """Sends an email to all people following the thread
353 @param res_id: Id of the record of OpenObject model created from the email message
354 @param msg: email.message.Message to forward
355 @param email_error: Default Email address in case of any Problem
357 model_pool = self.pool.get(model)
359 for res in model_pool.browse(cr, uid, res_ids, context=context):
360 message_followers = model_pool.message_followers(cr, uid, [res.id])[res.id]
361 message_followers_emails = self.to_email(','.join(filter(None, message_followers)))
362 message_recipients = self.to_email(','.join(filter(None,
363 [self._decode_header(msg['from']),
364 self._decode_header(msg['to']),
365 self._decode_header(msg['cc'])])))
366 message_forward = [i for i in message_followers_emails if (i and (i not in message_recipients))]
369 # TODO: we need an interface for this for all types of objects, not just leads
370 if hasattr(res, 'section_id'):
372 msg['reply-to'] = res.section_id.reply_to
374 smtp_from = self.to_email(msg['from'])
375 if not tools.misc._email_send(smtp_from, message_forward, msg, openobject_id=res.id) and email_error:
376 subj = msg['subject']
377 del msg['subject'], msg['to'], msg['cc'], msg['bcc']
378 msg['subject'] = '[OpenERP-Forward-Failed] %s' % subj
379 msg['to'] = email_error
380 tools.misc._email_send(smtp_from, self.to_email(email_error), msg, openobject_id=res.id)
382 def process_email(self, cr, uid, model, message, custom_values=None, attach=True, context=None):
383 """This function Processes email and create record for given OpenERP model
384 @param self: The object pointer
385 @param cr: the current row, from the database cursor,
386 @param uid: the current user’s ID for security checks,
387 @param model: OpenObject Model
388 @param message: Email details, passed as a string or an xmlrpclib.Binary
389 @param attach: Email attachments
390 @param context: A standard dictionary for contextual values"""
392 # extract message bytes, we are forced to pass the message as binary because
393 # we don't know its encoding until we parse its headers and hence can't
394 # convert it to utf-8 for transport between the mailgate script and here.
395 if isinstance(message, xmlrpclib.Binary):
396 message = str(message.data)
401 if custom_values is None or not isinstance(custom_values, dict):
404 model_pool = self.pool.get(model)
407 # Create New Record into particular model
408 def create_record(msg):
410 if hasattr(model_pool, 'message_new'):
411 res_id = model_pool.message_new(cr, uid, msg, context=context)
413 model_pool.write(cr, uid, [res_id], custom_values, context=context)
416 'name': msg.get('subject'),
417 'email_from': msg.get('from'),
418 'email_cc': msg.get('cc'),
420 'description': msg.get('body'),
423 data.update(self.get_partner(cr, uid, msg.get('from'), context=context))
424 res_id = model_pool.create(cr, uid, data, context=context)
427 for attachment in msg.get('attachments', []):
430 'datas': binascii.b2a_base64(str(attachments.get(attachment))),
431 'datas_fname': attachment,
432 'description': 'Mail attachment',
436 att_ids.append(self.pool.get('ir.attachment').create(cr, uid, data_attach))
438 return res_id, att_ids
440 # Warning: message_from_string doesn't always work correctly on unicode,
441 # we must use utf-8 strings here :-(
442 if isinstance(message, unicode):
443 message = message.encode('utf-8')
444 msg_txt = email.message_from_string(message)
445 message_id = msg_txt.get('message-id', False)
449 # Very unusual situation, be we should be fault-tolerant here
450 message_id = time.time()
451 msg_txt['message-id'] = message_id
452 _logger.info('Message without message-id, generating a random one: %s', message_id)
454 fields = msg_txt.keys()
455 msg['id'] = message_id
456 msg['message-id'] = message_id
458 if 'Subject' in fields:
459 msg['subject'] = self._decode_header(msg_txt.get('Subject'))
461 if 'Content-Type' in fields:
462 msg['content-type'] = msg_txt.get('Content-Type')
465 msg['from'] = self._decode_header(msg_txt.get('From'))
467 if 'Delivered-To' in fields:
468 msg['to'] = self._decode_header(msg_txt.get('Delivered-To'))
471 msg['cc'] = self._decode_header(msg_txt.get('CC'))
473 if 'Reply-to' in fields:
474 msg['reply'] = self._decode_header(msg_txt.get('Reply-To'))
477 msg['date'] = self._decode_header(msg_txt.get('Date'))
479 if 'Content-Transfer-Encoding' in fields:
480 msg['encoding'] = msg_txt.get('Content-Transfer-Encoding')
482 if 'References' in fields:
483 msg['references'] = msg_txt.get('References')
485 if 'In-Reply-To' in fields:
486 msg['in-reply-to'] = msg_txt.get('In-Reply-To')
488 if 'X-Priority' in fields:
489 msg['priority'] = msg_txt.get('X-Priority', '3 (Normal)').split(' ')[0]
491 if not msg_txt.is_multipart() or 'text/plain' in msg.get('Content-Type', ''):
492 encoding = msg_txt.get_content_charset()
493 body = msg_txt.get_payload(decode=True)
494 if 'text/html' in msg_txt.get('Content-Type', ''):
495 body = tools.html2plaintext(body)
496 msg['body'] = tools.ustr(body, encoding)
499 has_plain_text = False
500 if msg_txt.is_multipart() or 'multipart/alternative' in msg.get('content-type', ''):
502 for part in msg_txt.walk():
503 if part.get_content_maintype() == 'multipart':
506 encoding = part.get_content_charset()
507 filename = part.get_filename()
508 if part.get_content_maintype()=='text':
509 content = part.get_payload(decode=True)
511 attachments[filename] = content
512 elif not has_plain_text:
513 # main content parts should have 'text' maintype
514 # and no filename. we ignore the html part if
515 # there is already a plaintext part without filename,
516 # because presumably these are alternatives.
517 content = tools.ustr(content, encoding)
518 if part.get_content_subtype() == 'html':
519 body = tools.ustr(tools.html2plaintext(content))
520 elif part.get_content_subtype() == 'plain':
522 has_plain_text = True
523 elif part.get_content_maintype() in ('application', 'image'):
525 attachments[filename] = part.get_payload(decode=True)
527 res = part.get_payload(decode=True)
528 body += tools.ustr(res, encoding)
531 msg['attachments'] = attachments
535 if msg.get('references') or msg.get('in-reply-to'):
536 references = msg.get('references') or msg.get('in-reply-to')
537 if '\r\n' in references:
538 references = references.split('\r\n')
540 references = references.split(' ')
541 for ref in references:
543 res_id = tools.misc.reference_re.search(ref)
545 res_id = res_id.group(1)
547 res_id = tools.misc.res_re.search(msg['subject'])
549 res_id = res_id.group(1)
552 model_pool = self.pool.get(model)
553 if model_pool.exists(cr, uid, res_id):
554 res_ids.append(res_id)
555 if hasattr(model_pool, 'message_update'):
556 model_pool.message_update(cr, uid, [res_id], {}, msg, context=context)
558 raise NotImplementedError('model %s does not support updating records, mailgate API method message_update() is missing'%model)
561 new_res_id, attachment_ids = create_record(msg)
562 res_ids = [new_res_id]
565 context.update({'model' : model})
566 if hasattr(model_pool, 'history'):
567 model_pool.history(cr, uid, res_ids, _('receive'), history=True,
568 subject = msg.get('subject'),
569 email = msg.get('to'),
570 details = msg.get('body'),
571 email_from = msg.get('from'),
572 email_cc = msg.get('cc'),
573 message_id = msg.get('message-id'),
574 references = msg.get('references', False) or msg.get('in-reply-to', False),
575 attach = attachments.items(),
576 email_date = msg.get('date'),
579 self.history(cr, uid, model, res_ids, msg, attachment_ids, context=context)
580 self.email_forward(cr, uid, model, res_ids, msg_txt)
583 def get_partner(self, cr, uid, from_email, context=None):
584 """This function returns partner Id based on email passed
585 @param self: The object pointer
586 @param cr: the current row, from the database cursor,
587 @param uid: the current user’s ID for security checks
588 @param from_email: email address based on that function will search for the correct
590 address_pool = self.pool.get('res.partner.address')
592 'partner_address_id': False,
595 from_email = self.to_email(from_email)[0]
596 address_ids = address_pool.search(cr, uid, [('email', 'like', from_email)])
598 address = address_pool.browse(cr, uid, address_ids[0])
599 res['partner_address_id'] = address_ids[0]
600 res['partner_id'] = address.partner_id.id
606 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: