addons/crm_channel/crm_channel.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         'partner_weight': fields.integer('Grade Weight',
  71             help="Gives the probability to assign a lead to this partner. (0 means no assignation.)"),
  72     }
  73     _defaults = {
  74         'active': lambda *args: 1,
  75         'partner_weight':1
  76     }
  77
  78 class res_partner_activation(osv.osv):
  79     _name = 'res.partner.activation'
  80     _order = 'sequence'
  81
  82     _columns = {
  83         'sequence' : fields.integer('Sequence'),
  84         'name' : fields.char('Name', size=32, required=True),
  85     }
  86
  87
  88 class res_partner(osv.osv):
  89     _inherit = "res.partner"
  90     _columns = {
  91         'partner_latitude': fields.float('Geo Latitude'),
  92         'partner_longitude': fields.float('Geo Longitude'),
  93         'date_localization': fields.date('Geo Localization Date'),
  94         'partner_weight': fields.integer('Grade Weight',
  95             help="Gives the probability to assign a lead to this partner. (0 means no assignation.)"),
  96         'opportunity_assigned_ids': fields.one2many('crm.lead', 'partner_assigned_id',\
  97             'Assigned Opportunities'),
  98         'grade_id': fields.many2one('res.partner.grade', 'Grade'),
  99         'activation' : fields.many2one('res.partner.activation', 'Activation', select=1),
 100         'date_partnership' : fields.date('Partnership Date'),
 101         'date_review' : fields.date('Latest Partner Review'),
 102         'date_review_next' : fields.date('Next Partner Review'),
 103     }
 104     _defaults = {
 105         'partner_weight': lambda *args: 0
 106     }
 107
 108     def onchange_grade_id(self, cr, uid, ids, grade_id, context=None):
 109         res = {'value' :{'partner_weight':0}}
 110         if grade_id:
 111             partner_grade = self.pool.get('res.partner.grade').browse(cr, uid, grade_id)
 112             res['value']['partner_weight'] = partner_grade.partner_weight
 113         return res
 114     def geo_localize(self, cr, uid, ids, context=None):
 115         # Don't pass context to browse()! We need country names in english below
 116         for partner in self.browse(cr, uid, ids):
 117             if not partner:
 118                 continue
 119             result = geo_find(geo_query_address(street=partner.street,
 120                                                 zip=partner.zip,
 121                                                 city=partner.city,
 122                                                 state=partner.state_id.name,
 123                                                 country=partner.country_id.name))
 124             if result:
 125                 self.write(cr, uid, [partner.id], {
 126                     'partner_latitude': result[0],
 127                     'partner_longitude': result[1],
 128                     'date_localization': fields.date.context_today(self,cr,uid,context=context)
 129                 }, context=context)
 130         return True
 131
 132 class crm_lead(osv.osv):
 133     _inherit = "crm.lead"
 134     _columns = {
 135         'partner_latitude': fields.float('Geo Latitude'),
 136         'partner_longitude': fields.float('Geo Longitude'),
 137         'partner_assigned_id': fields.many2one('res.partner', 'Assigned Partner',track_visibility='onchange' , help="Partner this case has been forwarded/assigned to.", select=True),
 138         'date_assign': fields.date('Assignation Date', help="Last date this case was forwarded/assigned to a partner"),
 139     }
 140     def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
 141         fields += ['partner_latitude', 'partner_longitude', 'partner_assigned_id', 'date_assign']
 142         return super(crm_lead, self)._merge_data(cr, uid, ids, oldest, fields, context=context)
 143
 144     def onchange_assign_id(self, cr, uid, ids, partner_assigned_id, context=None):
 145         """This function updates the "assignation date" automatically, when manually assign a partner in the geo assign tab
 146         """
 147
 148         if not partner_assigned_id:
 149             return {'value':{'date_assign': False}}
 150         else:
 151             partners = self.pool.get('res.partner').browse(cr, uid, [partner_assigned_id], context=context)
 152             user_id = partners[0] and partners[0].user_id.id or False
 153             return {'value':
 154                         {'date_assign': fields.date.context_today(self,cr,uid,context=context),
 155                          'user_id' : user_id}
 156                    }
 157
 158     def action_assign_partner(self, cr, uid, ids, context=None):
 159         return self.assign_partner(cr, uid, ids, partner_id=False, context=context)
 160
 161     def assign_partner(self, cr, uid, ids, partner_id=False, context=None):
 162         partner_ids = {}
 163         res = False
 164         res_partner = self.pool.get('res.partner')
 165         if not partner_id:
 166             partner_ids = self.search_geo_partner(cr, uid, ids, context=context)
 167         for lead in self.browse(cr, uid, ids, context=context):
 168             if not partner_id:
 169                 partner_id = partner_ids.get(lead.id, False)
 170             if not partner_id:
 171                 continue
 172             self.assign_geo_localize(cr, uid, [lead.id], lead.partner_latitude, lead.partner_longitude, context=context)
 173             partner = res_partner.browse(cr, uid, partner_id, context=context)
 174             if partner.user_id:
 175                 salesteam_id = partner.section_id and partner.section_id.id or False
 176                 for lead_id in ids:
 177                     self.allocate_salesman(cr, uid, [lead_id], [partner.user_id.id], team_id=salesteam_id, context=context)
 178             self.write(cr, uid, [lead.id], {'date_assign': fields.date.context_today(self,cr,uid,context=context), 'partner_assigned_id': partner_id}, context=context)
 179         return res
 180
 181     def assign_geo_localize(self, cr, uid, ids, latitude=False, longitude=False, context=None):
 182         # Don't pass context to browse()! We need country name in english below
 183         for lead in self.browse(cr, uid, ids):
 184             if not lead.country_id:
 185                 continue
 186             result = geo_find(geo_query_address(street=lead.street,
 187                                                 zip=lead.zip,
 188                                                 city=lead.city,
 189                                                 state=lead.state_id.name,
 190                                                 country=lead.country_id.name))
 191             if not latitude and result:
 192                 latitude = result[0]
 193             if not longitude and result:
 194                 longitude = result[1]
 195             self.write(cr, uid, [lead.id], {
 196                 'partner_latitude': latitude,
 197                 'partner_longitude': longitude
 198             }, context=context)
 199         return True
 200
 201     def search_geo_partner(self, cr, uid, ids, context=None):
 202         res_partner = self.pool.get('res.partner')
 203         res_partner_ids = {}
 204         self.assign_geo_localize(cr, uid, ids, context=context)
 205         for lead in self.browse(cr, uid, ids, context=context):
 206             partner_ids = []
 207             if not lead.country_id:
 208                 continue
 209             latitude = lead.partner_latitude
 210             longitude = lead.partner_longitude
 211             if latitude and longitude:
 212                 # 1. first way: in the same country, small area
 213                 partner_ids = res_partner.search(cr, uid, [
 214                     ('partner_weight', '>', 0),
 215                     ('partner_latitude', '>', latitude - 2), ('partner_latitude', '<', latitude + 2),
 216                     ('partner_longitude', '>', longitude - 1.5), ('partner_longitude', '<', longitude + 1.5),
 217                     ('country_id', '=', lead.country_id.id),
 218                 ], context=context)
 219
 220                 # 2. second way: in the same country, big area
 221                 if not partner_ids:
 222                     partner_ids = res_partner.search(cr, uid, [
 223                         ('partner_weight', '>', 0),
 224                         ('partner_latitude', '>', latitude - 4), ('partner_latitude', '<', latitude + 4),
 225                         ('partner_longitude', '>', longitude - 3), ('partner_longitude', '<' , longitude + 3),
 226                         ('country_id', '=', lead.country_id.id),
 227                     ], context=context)
 228
 229                 # 3. third way: in the same country, extra large area
 230                 if not partner_ids:
 231                     partner_ids = res_partner.search(cr, uid, [
 232                         ('partner_weight','>', 0),
 233                         ('partner_latitude','>', latitude - 8), ('partner_latitude','<', latitude + 8),
 234                         ('partner_longitude','>', longitude - 8), ('partner_longitude','<', longitude + 8),
 235                         ('country', '=', lead.country_id.id),
 236                     ], context=context)
 237
 238                 # 5. fifth way: anywhere in same country
 239                 if not partner_ids:
 240                     # still haven't found any, let's take all partners in the country!
 241                     partner_ids = res_partner.search(cr, uid, [
 242                         ('partner_weight', '>', 0),
 243                         ('country_id', '=', lead.country_id.id),
 244                     ], context=context)
 245
 246                 # 6. sixth way: closest partner whatsoever, just to have at least one result
 247                 if not partner_ids:
 248                     # warning: point() type takes (longitude, latitude) as parameters in this order!
 249                     cr.execute("""SELECT id, distance
 250                                   FROM  (select id, (point(partner_longitude, partner_latitude) <-> point(%s,%s)) AS distance FROM res_partner
 251                                   WHERE partner_longitude is not null
 252                                         AND partner_latitude is not null
 253                                         AND partner_weight > 0) AS d
 254                                   ORDER BY distance LIMIT 1""", (longitude, latitude))
 255                     res = cr.dictfetchone()
 256                     if res:
 257                         partner_ids.append(res['id'])
 258
 259                 total_weight = 0
 260                 toassign = []
 261                 for partner in res_partner.browse(cr, uid, partner_ids, context=context):
 262                     total_weight += partner.partner_weight
 263                     toassign.append( (partner.id, total_weight) )
 264
 265                 random.shuffle(toassign) # avoid always giving the leads to the first ones in db natural order!
 266                 nearest_weight = random.randint(0, total_weight)
 267                 for partner_id, weight in toassign:
 268                     if nearest_weight <= weight:
 269                         res_partner_ids[lead.id] = partner_id
 270                         break
 271         return res_partner_ids
 272
 273
 274 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: