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.
489 lines
21 KiB
489 lines
21 KiB
# -*- encoding: utf-8 -*-
|
|
##############################################################################
|
|
#
|
|
# Asterisk Click2dial module for OpenERP
|
|
# Copyright (C) 2010-2013 Alexis de Lattre <alexis@via.ecp.fr>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
##############################################################################
|
|
|
|
from openerp.osv import fields, orm
|
|
from openerp.tools.translate import _
|
|
import logging
|
|
# Lib for phone number reformating -> pip install phonenumbers
|
|
import phonenumbers
|
|
|
|
try:
|
|
# Lib py-asterisk from http://code.google.com/p/py-asterisk/
|
|
# -> pip install py-Asterisk
|
|
from Asterisk import Manager
|
|
except ImportError:
|
|
Manager = None
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
class asterisk_server(orm.Model):
|
|
'''Asterisk server object, stores the parameters of the Asterisk IPBXs'''
|
|
_name = "asterisk.server"
|
|
_description = "Asterisk Servers"
|
|
_columns = {
|
|
'name': fields.char('Asterisk Server Name', size=50, required=True),
|
|
'active': fields.boolean(
|
|
'Active', help="The active field allows you to hide the Asterisk "
|
|
"server without deleting it."),
|
|
'ip_address': fields.char(
|
|
'Asterisk IP address or DNS', size=50, required=True,
|
|
help="IP address or DNS name of the Asterisk server."),
|
|
'port': fields.integer(
|
|
'Port', required=True,
|
|
help="TCP port on which the Asterisk Manager Interface listens. "
|
|
"Defined in /etc/asterisk/manager.conf on Asterisk."),
|
|
'out_prefix': fields.char(
|
|
'Out Prefix', size=4, help="Prefix to dial to make outgoing "
|
|
"calls. If you don't use a prefix to make outgoing calls, "
|
|
"leave empty."),
|
|
'login': fields.char(
|
|
'AMI Login', size=30, required=True,
|
|
help="Login that OpenERP will use to communicate with the "
|
|
"Asterisk Manager Interface. Refer to /etc/asterisk/manager.conf "
|
|
"on your Asterisk server."),
|
|
'password': fields.char(
|
|
'AMI Password', size=30, required=True,
|
|
help="Password that OpenERP will use to communicate with the "
|
|
"Asterisk Manager Interface. Refer to /etc/asterisk/manager.conf "
|
|
"on your Asterisk server."),
|
|
'context': fields.char(
|
|
'Dialplan Context', size=50, required=True,
|
|
help="Asterisk dialplan context from which the calls will be "
|
|
"made. Refer to /etc/asterisk/extensions.conf on your Asterisk "
|
|
"server."),
|
|
'wait_time': fields.integer(
|
|
'Wait Time (sec)', required=True,
|
|
help="Amount of time (in seconds) Asterisk will try to reach "
|
|
"the user's phone before hanging up."),
|
|
'extension_priority': fields.integer(
|
|
'Extension Priority', required=True,
|
|
help="Priority of the extension in the Asterisk dialplan. Refer "
|
|
"to /etc/asterisk/extensions.conf on your Asterisk server."),
|
|
'alert_info': fields.char(
|
|
'Alert-Info SIP Header', size=255,
|
|
help="Set Alert-Info header in SIP request to user's IP Phone "
|
|
"for the click2dial feature. If empty, the Alert-Info header "
|
|
"will not be added. You can use it to have a special ring tone "
|
|
"for click2dial (a silent one !) or to activate auto-answer "
|
|
"for example."),
|
|
'company_id': fields.many2one(
|
|
'res.company', 'Company',
|
|
help="Company who uses the Asterisk server."),
|
|
}
|
|
|
|
_defaults = {
|
|
'active': True,
|
|
'port': 5038, # Default AMI port
|
|
'extension_priority': 1,
|
|
'wait_time': 15,
|
|
'company_id': lambda self, cr, uid, context:
|
|
self.pool['res.company']._company_default_get(
|
|
cr, uid, 'asterisk.server', context=context),
|
|
}
|
|
|
|
def _check_validity(self, cr, uid, ids):
|
|
for server in self.browse(cr, uid, ids):
|
|
out_prefix = ('Out prefix', server.out_prefix)
|
|
dialplan_context = ('Dialplan context', server.context)
|
|
alert_info = ('Alert-Info SIP header', server.alert_info)
|
|
login = ('AMI login', server.login)
|
|
password = ('AMI password', server.password)
|
|
|
|
if out_prefix[1] and not out_prefix[1].isdigit():
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("Only use digits for the '%s' on the Asterisk server "
|
|
"'%s'" % (out_prefix[0], server.name)))
|
|
if server.wait_time < 1 or server.wait_time > 120:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("You should set a 'Wait time' value between 1 and 120 "
|
|
"seconds for the Asterisk server '%s'" % server.name))
|
|
if server.extension_priority < 1:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("The 'extension priority' must be a positive value for "
|
|
"the Asterisk server '%s'" % server.name))
|
|
if server.port > 65535 or server.port < 1:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("You should set a TCP port between 1 and 65535 for the "
|
|
"Asterisk server '%s'" % server.name))
|
|
for check_str in [dialplan_context, alert_info, login, password]:
|
|
if check_str[1]:
|
|
try:
|
|
check_str[1].encode('ascii')
|
|
except UnicodeEncodeError:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("The '%s' should only have ASCII caracters for "
|
|
"the Asterisk server '%s'"
|
|
% (check_str[0], server.name)))
|
|
return True
|
|
|
|
_constraints = [(
|
|
_check_validity,
|
|
"Error message in raise",
|
|
[
|
|
'out_prefix', 'wait_time', 'extension_priority', 'port',
|
|
'context', 'alert_info', 'login', 'password']
|
|
)]
|
|
|
|
def _reformat_number(
|
|
self, cr, uid, erp_number, ast_server=None, context=None):
|
|
'''
|
|
This function is dedicated to the transformation of the number
|
|
available in OpenERP to the number that Asterisk should dial.
|
|
You may have to inherit this function in another module specific
|
|
for your company if you are not happy with the way I reformat
|
|
the OpenERP numbers.
|
|
'''
|
|
assert(erp_number), 'Missing phone number'
|
|
_logger.debug('Number before reformat = %s' % erp_number)
|
|
if not ast_server:
|
|
ast_server = self._get_asterisk_server_from_user(
|
|
cr, uid, context=context)
|
|
|
|
# erp_number are supposed to be in E.164 format, so no need to
|
|
# give a country code here
|
|
parsed_num = phonenumbers.parse(erp_number, None)
|
|
country_code = ast_server.company_id.country_id.code
|
|
assert(country_code), 'Missing country on company'
|
|
_logger.debug('Country code = %s' % country_code)
|
|
to_dial_number = phonenumbers.format_out_of_country_calling_number(
|
|
parsed_num, country_code.upper()).replace(' ', '').replace('-', '')
|
|
# Add 'out prefix' to all numbers
|
|
if ast_server.out_prefix:
|
|
_logger.debug('Out prefix = %s' % ast_server.out_prefix)
|
|
to_dial_number = '%s%s' % (ast_server.out_prefix, to_dial_number)
|
|
_logger.debug('Number to be sent to Asterisk = %s' % to_dial_number)
|
|
return to_dial_number
|
|
|
|
def _get_asterisk_server_from_user(self, cr, uid, context=None):
|
|
'''Returns an asterisk.server browse object'''
|
|
# We check if the user has an Asterisk server configured
|
|
user = self.pool['res.users'].browse(cr, uid, uid, context=context)
|
|
if user.asterisk_server_id.id:
|
|
ast_server = user.asterisk_server_id
|
|
else:
|
|
asterisk_server_ids = self.search(
|
|
cr, uid, [('company_id', '=', user.company_id.id)],
|
|
context=context)
|
|
# If the user doesn't have an asterisk server,
|
|
# we take the first one of the user's company
|
|
if not asterisk_server_ids:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("No Asterisk server configured for the company '%s'.")
|
|
% user.company_id.name)
|
|
else:
|
|
ast_server = self.browse(
|
|
cr, uid, asterisk_server_ids[0], context=context)
|
|
return ast_server
|
|
|
|
def _connect_to_asterisk(self, cr, uid, context=None):
|
|
'''
|
|
Open the connection to the Asterisk Manager
|
|
Returns an instance of the Asterisk Manager
|
|
|
|
'''
|
|
user = self.pool['res.users'].browse(cr, uid, uid, context=context)
|
|
|
|
ast_server = self._get_asterisk_server_from_user(
|
|
cr, uid, context=context)
|
|
# We check if the current user has a chan type
|
|
if not user.asterisk_chan_type:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_('No channel type configured for the current user.'))
|
|
|
|
# We check if the current user has an internal number
|
|
if not user.resource:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_('No resource name configured for the current user'))
|
|
|
|
_logger.debug(
|
|
"User's phone: %s/%s" % (user.asterisk_chan_type, user.resource))
|
|
_logger.debug(
|
|
"Asterisk server: %s:%d"
|
|
% (ast_server.ip_address, ast_server.port))
|
|
|
|
# Connect to the Asterisk Manager Interface
|
|
try:
|
|
ast_manager = Manager.Manager(
|
|
(ast_server.ip_address, ast_server.port),
|
|
ast_server.login, ast_server.password)
|
|
except Exception, e:
|
|
_logger.error(
|
|
"Error in the request to the Asterisk Manager Interface %s"
|
|
% ast_server.ip_address)
|
|
_logger.error("Here is the error message: %s" % e)
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("Problem in the request from OpenERP to Asterisk. "
|
|
"Here is the error message: %s" % e))
|
|
|
|
return (user, ast_server, ast_manager)
|
|
|
|
def test_ami_connection(self, cr, uid, ids, context=None):
|
|
assert len(ids) == 1, 'Only 1 ID'
|
|
ast_server = self.browse(cr, uid, ids[0], context=context)
|
|
try:
|
|
ast_manager = Manager.Manager(
|
|
(ast_server.ip_address, ast_server.port),
|
|
ast_server.login,
|
|
ast_server.password)
|
|
except Exception, e:
|
|
raise orm.except_orm(
|
|
_("Connection Test Failed!"),
|
|
_("Here is the error message: %s" % e))
|
|
finally:
|
|
try:
|
|
if ast_manager:
|
|
ast_manager.Logoff()
|
|
except Exception:
|
|
pass
|
|
raise orm.except_orm(
|
|
_("Connection Test Successfull!"),
|
|
_("OpenERP can successfully login to the Asterisk Manager "
|
|
"Interface."))
|
|
|
|
def _get_calling_number(self, cr, uid, context=None):
|
|
|
|
user, ast_server, ast_manager = self._connect_to_asterisk(
|
|
cr, uid, context=context)
|
|
calling_party_number = False
|
|
try:
|
|
list_chan = ast_manager.Status()
|
|
# from pprint import pprint
|
|
# pprint(list_chan)
|
|
_logger.debug("Result of Status AMI request: %s", list_chan)
|
|
for chan in list_chan.values():
|
|
sip_account = user.asterisk_chan_type + '/' + user.resource
|
|
# 4 = Ring
|
|
if (
|
|
chan.get('ChannelState') == '4' and
|
|
chan.get('ConnectedLineNum') == user.internal_number):
|
|
_logger.debug("Found a matching Event in 'Ring' state")
|
|
calling_party_number = chan.get('CallerIDNum')
|
|
break
|
|
# 6 = Up
|
|
if (
|
|
chan.get('ChannelState') == '6'
|
|
and sip_account in chan.get('BridgedChannel', '')):
|
|
_logger.debug("Found a matching Event in 'Up' state")
|
|
calling_party_number = chan.get('CallerIDNum')
|
|
break
|
|
# Compatibility with Asterisk 1.4
|
|
if (
|
|
chan.get('State') == 'Up'
|
|
and sip_account in chan.get('Link', '')):
|
|
_logger.debug("Found a matching Event in 'Up' state")
|
|
calling_party_number = chan.get('CallerIDNum')
|
|
break
|
|
except Exception, e:
|
|
_logger.error(
|
|
"Error in the Status request to Asterisk server %s"
|
|
% ast_server.ip_address)
|
|
_logger.error(
|
|
"Here are the details of the error: '%s'" % unicode(e))
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("Can't get calling number from Asterisk.\nHere is the "
|
|
"error: '%s'" % unicode(e)))
|
|
|
|
finally:
|
|
ast_manager.Logoff()
|
|
|
|
_logger.debug("Calling party number: '%s'" % calling_party_number)
|
|
return calling_party_number
|
|
|
|
def get_record_from_my_channel(self, cr, uid, context=None):
|
|
calling_number = self.pool['asterisk.server']._get_calling_number(
|
|
cr, uid, context=context)
|
|
# calling_number = "0641981246"
|
|
if calling_number:
|
|
record = self.pool['phone.common'].get_record_from_phone_number(
|
|
cr, uid, calling_number, context=context)
|
|
if record:
|
|
return record
|
|
else:
|
|
return calling_number
|
|
else:
|
|
return False
|
|
|
|
|
|
class res_users(orm.Model):
|
|
_inherit = "res.users"
|
|
|
|
_columns = {
|
|
'internal_number': fields.char(
|
|
'Internal Number', size=15,
|
|
help="User's internal phone number."),
|
|
'dial_suffix': fields.char(
|
|
'User-specific Dial Suffix', size=15,
|
|
help="User-specific dial suffix such as aa=2wb for SCCP "
|
|
"auto answer."),
|
|
'callerid': fields.char(
|
|
'Caller ID', size=50,
|
|
help="Caller ID used for the calls initiated by this user."),
|
|
# You'd probably think: Asterisk should reuse the callerID of sip.conf!
|
|
# But it cannot, cf
|
|
# http://lists.digium.com/pipermail/asterisk-users/2012-January/269787.html
|
|
'cdraccount': fields.char(
|
|
'CDR Account', size=50,
|
|
help="Call Detail Record (CDR) account used for billing this "
|
|
"user."),
|
|
'asterisk_chan_type': fields.selection([
|
|
('SIP', 'SIP'),
|
|
('IAX2', 'IAX2'),
|
|
('DAHDI', 'DAHDI'),
|
|
('Zap', 'Zap'),
|
|
('Skinny', 'Skinny'),
|
|
('MGCP', 'MGCP'),
|
|
('mISDN', 'mISDN'),
|
|
('H323', 'H323'),
|
|
('SCCP', 'SCCP'),
|
|
('Local', 'Local'),
|
|
], 'Asterisk Channel Type',
|
|
help="Asterisk channel type, as used in the Asterisk dialplan. "
|
|
"If the user has a regular IP phone, the channel type is 'SIP'."),
|
|
'resource': fields.char(
|
|
'Resource Name', size=64,
|
|
help="Resource name for the channel type selected. For example, "
|
|
"if you use 'Dial(SIP/phone1)' in your Asterisk dialplan to ring "
|
|
"the SIP phone of this user, then the resource name for this user "
|
|
"is 'phone1'. For a SIP phone, the phone number is often used as "
|
|
"resource name, but not always."),
|
|
'alert_info': fields.char(
|
|
'User-specific Alert-Info SIP Header', size=255,
|
|
help="Set a user-specific Alert-Info header in SIP request to "
|
|
"user's IP Phone for the click2dial feature. If empty, the "
|
|
"Alert-Info header will not be added. You can use it to have a "
|
|
"special ring tone for click2dial (a silent one !) or to "
|
|
"activate auto-answer for example."),
|
|
'variable': fields.char(
|
|
'User-specific Variable', size=255,
|
|
help="Set a user-specific 'Variable' field in the Asterisk "
|
|
"Manager Interface 'originate' request for the click2dial "
|
|
"feature. If you want to have several variable headers, separate "
|
|
"them with '|'."),
|
|
'asterisk_server_id': fields.many2one(
|
|
'asterisk.server', 'Asterisk Server',
|
|
help="Asterisk server on which the user's phone is connected. "
|
|
"If you leave this field empty, it will use the first Asterisk "
|
|
"server of the user's company."),
|
|
}
|
|
|
|
_defaults = {
|
|
'asterisk_chan_type': 'SIP',
|
|
}
|
|
|
|
def _check_validity(self, cr, uid, ids):
|
|
for user in self.browse(cr, uid, ids):
|
|
strings_to_check = [
|
|
(_('Resource Name'), user.resource),
|
|
(_('Internal Number'), user.internal_number),
|
|
(_('Caller ID'), user.callerid),
|
|
]
|
|
for check_string in strings_to_check:
|
|
if check_string[1]:
|
|
try:
|
|
check_string[1].encode('ascii')
|
|
except UnicodeEncodeError:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("The '%s' for the user '%s' should only have "
|
|
"ASCII caracters")
|
|
% (check_string[0], user.name))
|
|
return True
|
|
|
|
_constraints = [(
|
|
_check_validity,
|
|
"Error message in raise",
|
|
['resource', 'internal_number', 'callerid']
|
|
)]
|
|
|
|
|
|
class phone_common(orm.AbstractModel):
|
|
_inherit = 'phone.common'
|
|
|
|
def click2dial(self, cr, uid, erp_number, context=None):
|
|
if not erp_number:
|
|
orm.except_orm(
|
|
_('Error:'),
|
|
_('Missing phone number'))
|
|
|
|
user, ast_server, ast_manager = \
|
|
self.pool['asterisk.server']._connect_to_asterisk(
|
|
cr, uid, context=context)
|
|
ast_number = self.pool['asterisk.server']._reformat_number(
|
|
cr, uid, erp_number, ast_server, context=context)
|
|
|
|
# The user should have a CallerID
|
|
if not user.callerid:
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_('No callerID configured for the current user'))
|
|
|
|
variable = []
|
|
if user.asterisk_chan_type == 'SIP':
|
|
# We can only have one alert-info header in a SIP request
|
|
if user.alert_info:
|
|
variable.append(
|
|
'SIPAddHeader=Alert-Info: %s' % user.alert_info)
|
|
elif ast_server.alert_info:
|
|
variable.append(
|
|
'SIPAddHeader=Alert-Info: %s' % ast_server.alert_info)
|
|
if user.variable:
|
|
for user_variable in user.variable.split('|'):
|
|
variable.append(user_variable.strip())
|
|
channel = '%s/%s' % (user.asterisk_chan_type, user.resource)
|
|
if user.dial_suffix:
|
|
channel += '/%s' % user.dial_suffix
|
|
|
|
try:
|
|
ast_manager.Originate(
|
|
channel,
|
|
context=ast_server.context,
|
|
extension=ast_number,
|
|
priority=str(ast_server.extension_priority),
|
|
timeout=str(ast_server.wait_time * 1000),
|
|
caller_id=user.callerid,
|
|
account=user.cdraccount,
|
|
variable=variable)
|
|
except Exception, e:
|
|
_logger.error(
|
|
"Error in the Originate request to Asterisk server %s"
|
|
% ast_server.ip_address)
|
|
_logger.error(
|
|
"Here are the details of the error: '%s'" % unicode(e))
|
|
raise orm.except_orm(
|
|
_('Error:'),
|
|
_("Click to dial with Asterisk failed.\nHere is the error: "
|
|
"'%s'")
|
|
% unicode(e))
|
|
finally:
|
|
ast_manager.Logoff()
|
|
|
|
return {'dialed_number': ast_number}
|