You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

307 lines
13 KiB

  1. # -*- coding: utf-8 -*-
  2. ##############################################################################
  3. #
  4. # Base Phone module for Odoo
  5. # Copyright (C) 2010-2015 Alexis de Lattre <alexis@via.ecp.fr>
  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. from openerp import models, fields, api, _
  22. from openerp.tools.safe_eval import safe_eval
  23. from openerp.exceptions import UserError
  24. import logging
  25. # Lib for phone number reformating -> pip install phonenumbers
  26. import phonenumbers
  27. _logger = logging.getLogger(__name__)
  28. class PhoneCommon(models.AbstractModel):
  29. _name = 'phone.common'
  30. @api.model
  31. def _reformat_phonenumbers_create(self, vals):
  32. assert isinstance(self._phone_fields, list),\
  33. 'self._phone_fields must be a list'
  34. if any([vals.get(field) for field in self._phone_fields]):
  35. countrycode = self._get_countrycode_from_vals(vals)
  36. countrycode = self._countrycode_fallback(countrycode)
  37. vals = self._reformat_phonenumbers(vals, countrycode)
  38. return vals
  39. @api.multi
  40. def _reformat_phonenumbers_write(self, vals):
  41. assert isinstance(self._phone_fields, list),\
  42. 'self._phone_fields must be a list'
  43. if any([vals.get(field) for field in self._phone_fields]):
  44. countrycode = self._get_countrycode_from_vals(vals)
  45. if not countrycode:
  46. if self._country_field:
  47. country = safe_eval(
  48. 'self.' + self._country_field, {'self': self})
  49. countrycode = country and country.code or None
  50. elif self._partner_field:
  51. partner = safe_eval(
  52. 'self.' + self._partner_field, {'self': self})
  53. if partner:
  54. countrycode = partner.country_id and\
  55. partner.country_id.code or None
  56. countrycode = self._countrycode_fallback(countrycode)
  57. vals = self._reformat_phonenumbers(vals, countrycode)
  58. return vals
  59. @api.model
  60. def _get_countrycode_from_vals(self, vals):
  61. assert isinstance(self._country_field, (str, unicode, type(None))),\
  62. 'Wrong self._country_field'
  63. assert isinstance(self._partner_field, (str, unicode, type(None))),\
  64. 'Wrong self._partner_field'
  65. countrycode = None
  66. if self._country_field and vals.get(self._country_field):
  67. country = self.env['res.country'].browse(
  68. vals[self._country_field])
  69. countrycode = country.code
  70. elif self._partner_field and vals.get(self._partner_field):
  71. partner = self.env['res.partner'].browse(
  72. vals[self._partner_field])
  73. countrycode = partner.country_id.code or False
  74. return countrycode
  75. @api.model
  76. def _countrycode_fallback(self, countrycode):
  77. if not countrycode:
  78. if self.env.user.company_id.country_id:
  79. countrycode = self.env.user.company_id.country_id.code
  80. else:
  81. _logger.error(
  82. "You should set a country on the company '%s' "
  83. "to allow the reformat of phone numbers",
  84. self.env.user.company_id.name)
  85. return countrycode
  86. @api.model
  87. def _reformat_phonenumbers(self, vals, countrycode):
  88. for field in self._phone_fields:
  89. if vals.get(field):
  90. init_value = vals.get(field)
  91. try:
  92. res_parse = phonenumbers.parse(
  93. vals.get(field), countrycode.upper())
  94. vals[field] = phonenumbers.format_number(
  95. res_parse, phonenumbers.PhoneNumberFormat.E164)
  96. if init_value != vals[field]:
  97. _logger.info(
  98. "%s initial value: '%s' updated value: '%s'"
  99. % (field, init_value, vals[field]))
  100. except Exception, e:
  101. # I do BOTH logger and raise, because:
  102. # raise is usefull when the record is created/written
  103. # by a user via the Web interface
  104. # logger is usefull when the record is created/written
  105. # via the webservices
  106. _logger.error(
  107. "Cannot reformat the phone number '%s' to "
  108. "international format with region=%s",
  109. vals.get(field), countrycode)
  110. if self.env.context.get('raise_if_phone_parse_fails'):
  111. raise UserError(
  112. _("Cannot reformat the phone number '%s' to "
  113. "international format. Error message: %s")
  114. % (vals.get(field), e))
  115. return vals
  116. @api.model
  117. def get_name_from_phone_number(self, presented_number):
  118. '''Function to get name from phone number. Usefull for use from IPBX
  119. to add CallerID name to incoming calls.'''
  120. res = self.get_record_from_phone_number(presented_number)
  121. if res:
  122. return res[2]
  123. else:
  124. return False
  125. @api.model
  126. def get_record_from_phone_number(self, presented_number):
  127. '''If it finds something, it returns (object name, ID, record name)
  128. For example : ('res.partner', 42, u'Alexis de Lattre (Akretion)')
  129. '''
  130. _logger.debug(
  131. u"Call get_name_from_phone_number with number = %s"
  132. % presented_number)
  133. if not isinstance(presented_number, (str, unicode)):
  134. _logger.warning(
  135. u"Number '%s' should be a 'str' or 'unicode' but it is a '%s'"
  136. % (presented_number, type(presented_number)))
  137. return False
  138. if not presented_number.isdigit():
  139. _logger.warning(
  140. u"Number '%s' should only contain digits." % presented_number)
  141. nr_digits_to_match_from_end = \
  142. self.env.user.company_id.number_of_digits_to_match_from_end
  143. if len(presented_number) >= nr_digits_to_match_from_end:
  144. end_number_to_match = presented_number[
  145. -nr_digits_to_match_from_end:len(presented_number)]
  146. else:
  147. end_number_to_match = presented_number
  148. phoneobjects = self._get_phone_fields()
  149. phonefieldslist = [] # [('res.parter', 10), ('crm.lead', 20)]
  150. for objname in phoneobjects:
  151. if (
  152. '_phone_name_sequence' in dir(self.env[objname]) and
  153. self.env[objname]._phone_name_sequence):
  154. phonefieldslist.append(
  155. (objname, self.env[objname]._phone_name_sequence))
  156. phonefieldslist_sorted = sorted(
  157. phonefieldslist,
  158. key=lambda element: element[1])
  159. _logger.debug('phonefieldslist_sorted=%s' % phonefieldslist_sorted)
  160. for (objname, prio) in phonefieldslist_sorted:
  161. obj = self.with_context(callerid=True).env[objname]
  162. pg_search_number = str('%' + end_number_to_match)
  163. _logger.debug(
  164. "Will search phone and mobile numbers in %s ending with '%s'"
  165. % (objname, end_number_to_match))
  166. domain = []
  167. for phonefield in obj._phone_fields:
  168. domain.append((phonefield, '=like', pg_search_number))
  169. if len(obj._phone_fields) > 1:
  170. domain = ['|'] * (len(obj._phone_fields) - 1) + domain
  171. res_obj = obj.search(domain)
  172. if len(res_obj) > 1:
  173. _logger.warning(
  174. u"There are several %s (IDS = %s) with a phone number "
  175. "ending with '%s'. Taking the first one."
  176. % (objname, res_obj.ids, end_number_to_match))
  177. res_obj = res_obj[0]
  178. if res_obj:
  179. name = res_obj.name_get()[0][1]
  180. res = (objname, res_obj.id, name)
  181. _logger.debug(
  182. u"Answer get_record_from_phone_number: (%s, %d, %s)"
  183. % (res[0], res[1], res[2]))
  184. return res
  185. else:
  186. _logger.debug(
  187. u"No match on %s for end of phone number '%s'"
  188. % (objname, end_number_to_match))
  189. return False
  190. @api.model
  191. def _get_phone_fields(self):
  192. '''Returns a dict with key = object name
  193. and value = list of phone fields'''
  194. models = self.env['ir.model'].search([('transient', '=', False)])
  195. res = []
  196. for model in models:
  197. senv = False
  198. try:
  199. senv = self.env[model.model]
  200. except:
  201. continue
  202. if (
  203. '_phone_fields' in dir(senv) and
  204. isinstance(senv._phone_fields, list)):
  205. res.append(model.model)
  206. return res
  207. @api.model
  208. def click2dial(self, erp_number):
  209. '''This function is designed to be overridden in IPBX-specific
  210. modules, such as asterisk_click2dial or ovh_telephony_connector'''
  211. return {'dialed_number': erp_number}
  212. @api.model
  213. def convert_to_dial_number(self, erp_number):
  214. '''
  215. This function is dedicated to the transformation of the number
  216. available in Odoo to the number that can be dialed.
  217. You may have to inherit this function in another module specific
  218. for your company if you are not happy with the way I reformat
  219. the numbers.
  220. '''
  221. assert(erp_number), 'Missing phone number'
  222. _logger.debug('Number before reformat = %s' % erp_number)
  223. # erp_number are supposed to be in E.164 format, so no need to
  224. # give a country code here
  225. parsed_num = phonenumbers.parse(erp_number, None)
  226. country_code = self.env.user.company_id.country_id.code
  227. assert(country_code), 'Missing country on company'
  228. _logger.debug('Country code = %s' % country_code)
  229. to_dial_number = phonenumbers.format_out_of_country_calling_number(
  230. parsed_num, country_code.upper())
  231. to_dial_number = str(to_dial_number).translate(None, ' -.()/')
  232. _logger.debug('Number to be sent to phone system: %s' % to_dial_number)
  233. return to_dial_number
  234. class ResPartner(models.Model):
  235. _name = 'res.partner'
  236. _inherit = ['res.partner', 'phone.common']
  237. _phone_fields = ['phone', 'mobile', 'fax']
  238. _phone_name_sequence = 10
  239. _country_field = 'country_id'
  240. _partner_field = None
  241. @api.model
  242. def create(self, vals):
  243. vals_reformated = self._reformat_phonenumbers_create(vals)
  244. return super(ResPartner, self).create(vals_reformated)
  245. @api.multi
  246. def write(self, vals):
  247. vals_reformated = self._reformat_phonenumbers_write(vals)
  248. return super(ResPartner, self).write(vals_reformated)
  249. @api.multi
  250. def name_get(self):
  251. if self._context.get('callerid'):
  252. res = []
  253. for partner in self:
  254. if partner.parent_id and partner.parent_id.is_company:
  255. name = u'%s (%s)' % (partner.name, partner.parent_id.name)
  256. else:
  257. name = partner.name
  258. res.append((partner.id, name))
  259. return res
  260. else:
  261. return super(ResPartner, self).name_get()
  262. class ResCompany(models.Model):
  263. _inherit = 'res.company'
  264. number_of_digits_to_match_from_end = fields.Integer(
  265. string='Number of Digits To Match From End',
  266. default=8,
  267. help="In several situations, OpenERP will have to find a "
  268. "Partner/Lead/Employee/... from a phone number presented by the "
  269. "calling party. As the phone numbers presented by your phone "
  270. "operator may not always be displayed in a standard format, "
  271. "the best method to find the related Partner/Lead/Employee/... "
  272. "in OpenERP is to try to match the end of the phone number in "
  273. "OpenERP with the N last digits of the phone number presented "
  274. "by the calling party. N is the value you should enter in this "
  275. "field.")
  276. _sql_constraints = [(
  277. 'number_of_digits_to_match_from_end_positive',
  278. 'CHECK (number_of_digits_to_match_from_end > 0)',
  279. "The value of the field 'Number of Digits To Match From End' must "
  280. "be positive."),
  281. ]