addons/fetchmail/fetchmail.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 import time
  23
  24 from imaplib import IMAP4
  25 from imaplib import IMAP4_SSL
  26 from poplib import POP3
  27 from poplib import POP3_SSL
  28
  29 import netsvc
  30 from osv import osv, fields
  31
  32 logger = netsvc.Logger()
  33
  34
  35 class email_server(osv.osv):
  36
  37     _name = 'email.server'
  38     _description = "POP/IMAP Server"
  39
  40     _columns = {
  41         'name':fields.char('Name', size=256, required=True, readonly=False),
  42         'active':fields.boolean('Active', required=False),
  43         'state':fields.selection([
  44             ('draft', 'Not Confirmed'),
  45             ('waiting', 'Waiting for Verification'),
  46             ('done', 'Confirmed'),
  47         ], 'State', select=True, readonly=True),
  48         'server' : fields.char('Server', size=256, required=True, readonly=True, states={'draft':[('readonly', False)]}),
  49         'port' : fields.integer('Port', required=True, readonly=True, states={'draft':[('readonly', False)]}),
  50         'type':fields.selection([
  51             ('pop', 'POP Server'),
  52             ('imap', 'IMAP Server'),
  53         ], 'Server Type', select=True, readonly=False),
  54         'is_ssl':fields.boolean('SSL ?', required=False),
  55         'attach':fields.boolean('Add Attachments ?', required=False, help="Fetches mail with attachments if true."),
  56         'date': fields.date('Date', readonly=True, states={'draft':[('readonly', False)]}),
  57         'user' : fields.char('User Name', size=256, required=True, readonly=True, states={'draft':[('readonly', False)]}),
  58         'password' : fields.char('Password', size=1024, invisible=True, required=True, readonly=True, states={'draft':[('readonly', False)]}),
  59         'note': fields.text('Description'),
  60         'action_id':fields.many2one('ir.actions.server', 'Reply Email', required=False, domain="[('state','=','email')]",
  61                                     help="An Email Server Action. It will be run whenever an e-mail is fetched from server."),
  62         'object_id': fields.many2one('ir.model', "Model", required=True, help="OpenObject Model. Generates a record of this model."),
  63         'priority': fields.integer('Server Priority', readonly=True, states={'draft':[('readonly', False)]}, help="Priority between 0 to 10, select define the order of Processing"),
  64         'user_id':fields.many2one('res.users', 'User', required=False),
  65         'message_ids': fields.one2many('mailgate.message', 'server_id', 'Messages', readonly=True),
  66     }
  67     _defaults = {
  68         'state': lambda *a: "draft",
  69         'active': lambda *a: True,
  70         'priority': lambda *a: 5,
  71         'date': lambda *a: time.strftime('%Y-%m-%d'),
  72         'user_id': lambda self, cr, uid, ctx: uid,
  73     }
  74
  75     def check_duplicate(self, cr, uid, ids):
  76         # RFC *-* Why this limitation? why not in SQL constraint?
  77         vals = self.read(cr, uid, ids, ['user', 'password'])[0]
  78         cr.execute("select count(id) from email_server where user=%s and password=%s", (vals['user'], vals['password']))
  79         res = cr.fetchone()
  80         if res:
  81             if res[0] > 1:
  82                 return False
  83         return True
  84
  85     _constraints = [
  86         (check_duplicate, 'Warning! Can\'t have duplicate server configuration!', ['user', 'password'])
  87     ]
  88
  89     def onchange_server_type(self, cr, uid, ids, server_type=False, ssl=False):
  90         port = 0
  91         if server_type == 'pop':
  92             port = ssl and 995 or 110
  93         elif server_type == 'imap':
  94             port = ssl and 993 or 143
  95
  96         return {'value':{'port':port}}
  97
  98     def set_draft(self, cr, uid, ids, context={}):
  99         self.write(cr, uid, ids , {'state':'draft'})
 100         return True
 101
 102     def button_confirm_login(self, cr, uid, ids, context={}):
 103         for server in self.browse(cr, uid, ids, context):
 104             logger.notifyChannel('imap', netsvc.LOG_INFO, 'fetchmail start checking for new emails on %s' % (server.name))
 105             context.update({'server_id': server.id, 'server_type': server.type})
 106             count = 0
 107             try:
 108                 if server.type == 'imap':
 109                     imap_server = None
 110                     if server.is_ssl:
 111                         imap_server = IMAP4_SSL(server.server, int(server.port))
 112                     else:
 113                         imap_server = IMAP4(server.server, int(server.port))
 114
 115                     imap_server.login(server.user, server.password)
 116                     ret_server = imap_server
 117
 118                 elif server.type == 'pop':
 119                     pop_server = None
 120                     if server.is_ssl:
 121                         pop_server = POP3_SSL(server.server, int(server.port))
 122                     else:
 123                         pop_server = POP3(server.server, int(server.port))
 124
 125                     #TODO: use this to remove only unread messages
 126                     #pop_server.user("recent:"+server.user)
 127                     pop_server.user(server.user)
 128                     pop_server.pass_(server.password)
 129                     ret_server = pop_server
 130
 131                 self.write(cr, uid, [server.id], {'state':'done'})
 132                 if context.get('get_server',False):
 133                     return ret_server
 134             except Exception, e:
 135                 logger.notifyChannel(server.type, netsvc.LOG_WARNING, '%s' % (e))
 136         return True
 137
 138     def button_fetch_mail(self, cr, uid, ids, context={}):
 139         self.fetch_mail(cr, uid, ids, context=context)
 140         return True
 141
 142     def _fetch_mails(self, cr, uid, ids=False, context={}):
 143         if not ids:
 144             ids = self.search(cr, uid, [])
 145         return self.fetch_mail(cr, uid, ids, context=context)
 146
 147     def fetch_mail(self, cr, uid, ids, context={}):
 148         email_tool = self.pool.get('email.server.tools')
 149         action_pool = self.pool.get('ir.actions.server')
 150         context.update({'get_server': True})
 151         for server in self.browse(cr, uid, ids, context):
 152             count = 0
 153             user = server.user_id.id or uid
 154             try:
 155                 if server.type == 'imap':
 156                     imap_server = self.button_confirm_login(cr, uid, [server.id], context=context)
 157                     imap_server.select()
 158                     result, data = imap_server.search(None, '(UNSEEN)')
 159                     for num in data[0].split():
 160                         result, data = imap_server.fetch(num, '(RFC822)')
 161                         res_id = email_tool.process_email(cr, user, server.object_id.model, data[0][1], attach=server.attach, context=context)
 162                         if res_id and server.action_id:
 163                             action_pool.run(cr, uid, [server.action_id.id], {'active_id': res_id, 'active_ids':[res_id]})
 164
 165                             imap_server.store(num, '+FLAGS', '\\Seen')
 166                         count += 1
 167                     logger.notifyChannel('imap', netsvc.LOG_INFO, 'fetchmail fetch/process %s email(s) from %s' % (count, server.name))
 168
 169                     imap_server.close()
 170                     imap_server.logout()
 171                 elif server.type == 'pop':
 172                     pop_server = self.button_confirm_login(cr, uid, [server.id], context=context)
 173                     pop_server.list()
 174                     (numMsgs, totalSize) = pop_server.stat()
 175                     for num in range(1, numMsgs + 1):
 176                         (header, msges, octets) = pop_server.retr(num)
 177                         msg = '\n'.join(msges)
 178                         res_id = email_tool.process_email(cr, user, server.object_id.model, msg, attach=server.attach, context=context)
 179                         if res_id and server.action_id:
 180                             action_pool.run(cr, uid, [server.action_id.id], {'active_id': res_id, 'active_ids':[res_id]})
 181
 182                         pop_server.dele(num)
 183
 184                     pop_server.quit()
 185
 186                     logger.notifyChannel('imap', netsvc.LOG_INFO, 'fetchmail fetch %s email(s) from %s' % (numMsgs, server.name))
 187
 188             except Exception, e:
 189                 logger.notifyChannel(server.type, netsvc.LOG_WARNING, '%s' % (e))
 190
 191         return True
 192
 193 email_server()
 194
 195 class mailgate_message(osv.osv):
 196
 197     _inherit = "mailgate.message"
 198
 199     _columns = {
 200         'server_id': fields.many2one('email.server', "Mail Server", readonly=True, select=True),
 201         'server_type':fields.selection([
 202             ('pop', 'POP Server'),
 203             ('imap', 'IMAP Server'),
 204         ], 'Server Type', select=True, readonly=True),
 205     }
 206     _order = 'id desc'
 207
 208     def create(self, cr, uid, values, context=None):
 209         if not context:
 210             context={}
 211         server_id = context.get('server_id',False)
 212         server_type = context.get('server_type',False)
 213         if server_id:
 214             values['server_id'] = server_id
 215         if server_type:
 216             values['server_type'] = server_type
 217         res = super(mailgate_message,self).create(cr, uid, values, context=context)
 218         return res
 219
 220     def write(self, cr, uid, ids, values, context=None):
 221         if not context:
 222             context={}
 223         server_id = context.get('server_id',False)
 224         server_type = context.get('server_type',False)
 225         if server_id:
 226             values['server_id'] = server_id
 227         if server_type:
 228             values['server_type'] = server_type
 229         res = super(mailgate_message,self).write(cr, uid, ids, values, context=context)
 230         return res
 231
 232 mailgate_message()
 233
 234 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: