addons/crm_partner_assign/crm_partner_assign.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 urllib
  23 import random
  24
  25 try:
  26     import simplejson as json
  27 except ImportError:
  28     import json     # noqa
  29
  30 from openerp.osv import osv
  31 from openerp.osv import fields
  32 from openerp.tools.translate import _
  33 from openerp import tools
  34
  35 def geo_find(addr):
  36     url = 'https://maps.googleapis.com/maps/api/geocode/json?sensor=false&address='
  37     url += urllib.quote(addr.encode('utf8'))
  38
  39     try:
  40         result = json.load(urllib.urlopen(url))
  41     except Exception, e:
  42         raise osv.except_osv(_('Network error'),
  43                              _('Cannot contact geolocation servers. Please make sure that your internet connection is up and running (%s).') % e)
  44     if result['status'] != 'OK':
  45         return None
  46
  47     try:
  48         geo = result['results'][0]['geometry']['location']
  49         return float(geo['lat']), float(geo['lng'])
  50     except (KeyError, ValueError):
  51         return None
  52
  53 def geo_query_address(street=None, zip=None, city=None, state=None, country=None):
  54     if country and ',' in country and (country.endswith(' of') or country.endswith(' of the')):
  55         # put country qualifier in front, otherwise GMap gives wrong results,
  56         # e.g. 'Congo, Democratic Republic of the' => 'Democratic Republic of the Congo'
  57         country = '{1} {0}'.format(*country.split(',',1))
  58     return tools.ustr(', '.join(filter(None, [street,
  59                                               ("%s %s" % (zip or '', city or '')).strip(),
  60                                               state,
  61                                               country])))
  62
  63 class res_partner_grade(osv.osv):
  64     _order = 'sequence'
  65     _name = 'res.partner.grade'
  66     _columns = {
  67         'sequence': fields.integer('Sequence'),
  68         'active': fields.boolean('Active'),
  69         'name': fields.char('Grade Name', size=32)
  70     }
  71     _defaults = {
  72         'active': lambda *args: 1
  73     }
  74
  75 class res_partner_activation(osv.osv):
  76     _name = 'res.partner.activation'
  77     _order = 'sequence'
  78
  79     _columns = {
  80         'sequence' : fields.integer('Sequence'),
  81         'name' : fields.char('Name', size=32, required=True),
  82     }
  83
  84
  85 class res_partner(osv.osv):
  86     _inherit = "res.partner"
  87     _columns = {
  88         'partner_latitude': fields.float('Geo Latitude'),
  89         'partner_longitude': fields.float('Geo Longitude'),
  90         'date_localization': fields.date('Geo Localization Date'),
  91         'partner_weight': fields.integer('Weight',
  92             help="Gives the probability to assign a lead to this partner. (0 means no assignation.)"),
  93         'opportunity_assigned_ids': fields.one2many('crm.lead', 'partner_assigned_id',\
  94             'Assigned Opportunities'),
  95         'grade_id': fields.many2one('res.partner.grade', 'Partner Level'),
  96         'activation' : fields.many2one('res.partner.activation', 'Activation', select=1),
  97         'date_partnership' : fields.date('Partnership Date'),
  98         'date_review' : fields.date('Latest Partner Review'),
  99         'date_review_next' : fields.date('Next Partner Review'),
 100     }
 101     _defaults = {
 102         'partner_weight': lambda *args: 0
 103     }
 104     def geo_localize(self, cr, uid, ids, context=None):
 105         # Don't pass context to browse()! We need country names in english below
 106         for partner in self.browse(cr, uid, ids):
 107             if not partner:
 108                 continue
 109             result = geo_find(geo_query_address(street=partner.street,
 110                                                 zip=partner.zip,
 111                                                 city=partner.city,
 112                                                 state=partner.state_id.name,
 113                                                 country=partner.country_id.name))
 114             if result:
 115                 self.write(cr, uid, [partner.id], {
 116                     'partner_latitude': result[0],
 117                     'partner_longitude': result[1],
 118                     'date_localization': fields.date.context_today(self,cr,uid,context=context)
 119                 }, context=context)
 120         return True
 121
 122 class crm_lead(osv.osv):
 123     _inherit = "crm.lead"
 124     _columns = {
 125         'partner_latitude': fields.float('Geo Latitude'),
 126         'partner_longitude': fields.float('Geo Longitude'),
 127         'partner_assigned_id': fields.many2one('res.partner', 'Assigned Partner', help="Partner this case has been forwarded/assigned to.", select=True),
 128         'date_assign': fields.date('Assignation Date', help="Last date this case was forwarded/assigned to a partner"),
 129     }
 130     def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
 131         fields += ['partner_latitude', 'partner_longitude', 'partner_assigned_id', 'date_assign']
 132         return super(crm_lead, self)._merge_data(cr, uid, ids, oldest, fields, context=context)
 133
 134     def onchange_assign_id(self, cr, uid, ids, partner_assigned_id, context=None):
 135         """This function updates the "assignation date" automatically, when manually assign a partner in the geo assign tab
 136         """
 137         if not partner_assigned_id:
 138             return {'value':{'date_assign': False}}
 139         else:
 140             partners = self.pool.get('res.partner').browse(cr, uid, [partner_assigned_id], context=context)
 141             user_id = partners[0] and partners[0].user_id.id or False
 142             return {'value':
 143                         {'date_assign': fields.date.context_today(self,cr,uid,context=context),
 144                          'user_id' : user_id}
 145                    }
 146
 147     def action_assign_partner(self, cr, uid, ids, context=None):
 148         return self.assign_partner(cr, uid, ids, partner_id=False, context=context)
 149
 150     def assign_partner(self, cr, uid, ids, partner_id=False, context=None):
 151         partner_ids = {}
 152         res = False
 153         res_partner = self.pool.get('res.partner')
 154         if not partner_id:
 155             partner_ids = self.search_geo_partner(cr, uid, ids, context=context)
 156         for lead in self.browse(cr, uid, ids, context=context):
 157             if not partner_id:
 158                 partner_id = partner_ids.get(lead.id, False)
 159             if not partner_id:
 160                 continue
 161             self.assign_geo_localize(cr, uid, [lead.id], lead.partner_latitude, lead.partner_longitude, context=context)
 162             partner = res_partner.browse(cr, uid, partner_id, context=context)
 163             if partner.user_id:
 164                 salesteam_id = partner.section_id and partner.section_id.id or False
 165                 for lead_id in ids:
 166                     self.allocate_salesman(cr, uid, [lead_id], [partner.user_id.id], team_id=salesteam_id, context=context)
 167             self.write(cr, uid, [lead.id], {'date_assign': fields.date.context_today(self,cr,uid,context=context), 'partner_assigned_id': partner_id}, context=context)
 168         return res
 169
 170     def assign_geo_localize(self, cr, uid, ids, latitude=False, longitude=False, context=None):
 171         # Don't pass context to browse()! We need country name in english below
 172         for lead in self.browse(cr, uid, ids):
 173             if not lead.country_id:
 174                 continue
 175             result = geo_find(geo_query_address(street=lead.street,
 176                                                 zip=lead.zip,
 177                                                 city=lead.city,
 178                                                 state=lead.state_id.name,
 179                                                 country=lead.country_id.name))
 180             if not latitude and result:
 181                 latitude = result[0]
 182             if not longitude and result:
 183                 longitude = result[1]
 184             self.write(cr, uid, [lead.id], {
 185                 'partner_latitude': latitude,
 186                 'partner_longitude': longitude
 187             }, context=context)
 188         return True
 189
 190     def search_geo_partner(self, cr, uid, ids, context=None):
 191         res_partner = self.pool.get('res.partner')
 192         res_partner_ids = {}
 193         self.assign_geo_localize(cr, uid, ids, context=context)
 194         for lead in self.browse(cr, uid, ids, context=context):
 195             partner_ids = []
 196             if not lead.country_id:
 197                 continue
 198             latitude = lead.partner_latitude
 199             longitude = lead.partner_longitude
 200             if latitude and longitude:
 201                 # 1. first way: in the same country, small area
 202                 partner_ids = res_partner.search(cr, uid, [
 203                     ('partner_weight', '>', 0),
 204                     ('partner_latitude', '>', latitude - 2), ('partner_latitude', '<', latitude + 2),
 205                     ('partner_longitude', '>', longitude - 1.5), ('partner_longitude', '<', longitude + 1.5),
 206                     ('country_id', '=', lead.country_id.id),
 207                 ], context=context)
 208
 209                 # 2. second way: in the same country, big area
 210                 if not partner_ids:
 211                     partner_ids = res_partner.search(cr, uid, [
 212                         ('partner_weight', '>', 0),
 213                         ('partner_latitude', '>', latitude - 4), ('partner_latitude', '<', latitude + 4),
 214                         ('partner_longitude', '>', longitude - 3), ('partner_longitude', '<' , longitude + 3),
 215                         ('country_id', '=', lead.country_id.id),
 216                     ], context=context)
 217
 218                 # 3. third way: in the same country, extra large area
 219                 if not partner_ids:
 220                     partner_ids = res_partner.search(cr, uid, [
 221                         ('partner_weight','>', 0),
 222                         ('partner_latitude','>', latitude - 8), ('partner_latitude','<', latitude + 8),
 223                         ('partner_longitude','>', longitude - 8), ('partner_longitude','<', longitude + 8),
 224                         ('country', '=', lead.country_id.id),
 225                     ], context=context)
 226
 227                 # 5. fifth way: anywhere in same country
 228                 if not partner_ids:
 229                     # still haven't found any, let's take all partners in the country!
 230                     partner_ids = res_partner.search(cr, uid, [
 231                         ('partner_weight', '>', 0),
 232                         ('country_id', '=', lead.country_id.id),
 233                     ], context=context)
 234
 235                 # 6. sixth way: closest partner whatsoever, just to have at least one result
 236                 if not partner_ids:
 237                     # warning: point() type takes (longitude, latitude) as parameters in this order!
 238                     cr.execute("""SELECT id, distance
 239                                   FROM  (select id, (point(partner_longitude, partner_latitude) <-> point(%s,%s)) AS distance FROM res_partner
 240                                   WHERE partner_longitude is not null
 241                                         AND partner_latitude is not null
 242                                         AND partner_weight > 0) AS d
 243                                   ORDER BY distance LIMIT 1""", (longitude, latitude))
 244                     res = cr.dictfetchone()
 245                     if res:
 246                         partner_ids.append(res['id'])
 247
 248                 total_weight = 0
 249                 toassign = []
 250                 for partner in res_partner.browse(cr, uid, partner_ids, context=context):
 251                     total_weight += partner.partner_weight
 252                     toassign.append( (partner.id, total_weight) )
 253
 254                 random.shuffle(toassign) # avoid always giving the leads to the first ones in db natural order!
 255                 nearest_weight = random.randint(0, total_weight)
 256                 for partner_id, weight in toassign:
 257                     if nearest_weight <= weight:
 258                         res_partner_ids[lead.id] = partner_id
 259                         break
 260         return res_partner_ids
 261
 262
 263 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 264