/usr/lib/python3/dist-packages/panoramisk/manager.py is in python3-panoramisk 1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | # -*- coding: utf-8 -*-
import logging
from collections import defaultdict
import re
import fnmatch
from .connection import Connection
from .utils import asyncio
from . import actions
from . import utils
class Manager(object):
"""Main object:
.. code-block:: python
>>> manager = Manager(
... host='127.0.0.1',
... port=5038,
... ssl=False,
... encoding='utf8')
"""
defaults = dict(
host='127.0.0.1',
port=5038,
events='on',
ssl=False,
encoding='utf8',
connection_class=Connection,
save_stream=None,
loop=None,
)
def __init__(self, **config):
self.config = dict(self.defaults, **config)
self.loop = self.config['loop']
self.log = config.get('log', logging.getLogger(__name__))
self.callbacks = defaultdict(list)
self.protocol = None
self.patterns = []
self.save_stream = self.config.get('save_stream')
self.authenticated = False
self.authenticated_future = None
self.pinger = None
def connection_made(self, f):
if getattr(self, 'protocol', None):
self.protocol.close()
try:
transport, protocol = f.result()
except OSError as e: # pragma: no cover
self.log.exception(e)
self.loop.call_later(2, self.connect)
else:
self.log.debug('Manager connected')
self.protocol = protocol
self.protocol.queue = utils.Queue(loop=self.loop)
self.protocol.factory = self
self.protocol.log = self.log
self.protocol.config = self.config
self.protocol.encoding = self.encoding = self.config['encoding']
self.responses = self.protocol.responses = {}
if 'username' in self.config:
self.authenticated = False
self.authenticated_future = self.send_action({
'Action': 'Login',
'Username': self.config['username'],
'Secret': self.config['secret'],
'Events': self.config['events']})
self.authenticated_future.add_done_callback(self.login)
self.pinger = self.loop.call_later(10, self.ping)
def login(self, future):
self.authenticated_future = None
resp = future.result()
self.authenticated = bool(resp.success)
return self.authenticated
def ping(self): # pragma: no cover
self.pinger = self.loop.call_later(10, self.ping)
self.protocol.send({'Action': 'Ping'})
def send_action(self, action, as_list=False, **kwargs):
"""Send an :class:`~panoramisk.actions.Action` to the server:
:param action: an Action or dict with action name and parameters to
send
:type action: Action or dict or Command
:param as_list: If True, the action Future will retrieve all responses
:type as_list: boolean
:return: a Future that will receive the response
:rtype: asyncio.Future
:Example:
To retrieve answer in a coroutine::
manager = Manager()
resp = yield from manager.send_action({'Action': 'Status'})
With a callback::
manager = Manager()
future = manager.send_action({'Action': 'Status'})
future.add_done_callback(handle_status_response)
See https://wiki.asterisk.org/wiki/display/AST/AMI+Actions for
more information on actions
"""
action.update(kwargs)
return self.protocol.send(action, as_list=as_list)
def send_command(self, command, as_list=False):
"""Send a :class:`~panoramisk.actions.Command` to the server::
manager = Manager()
resp = manager.send_command('http show status')
Return a response :class:`~panoramisk.message.Message`.
See https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Command
"""
action = actions.Action({'Command': command, 'Action': 'Command'},
as_list=as_list)
return self.send_action(action)
def send_agi_command(self, channel, command, as_list=False):
"""Send a :class:`~panoramisk.actions.Command` to the server:
:param channel: Channel name where to launch command. Ex: 'SIP/000000-00000a53'
:type channel: String
:param command: command to launch. Ex: 'GET VARIABLE async_agi_server'
:type command: String
:param as_list: If True, the action Future will retrieve all responses
:type as_list: boolean
:return: a Future that will receive the response
:rtype: asyncio.Future
:Example:
::
manager = Manager()
resp = manager.send_agi_command('SIP/000000-00000a53',
'GET VARIABLE async_agi_server')
Return a response :class:`~panoramisk.message.Message`.
See https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+ManagerAction_AGI
"""
action = actions.Command({'Action': 'AGI',
'Channel': channel,
'Command': command},
as_list=as_list)
return self.send_action(action)
def connect(self):
"""connect to the server"""
if self.loop is None: # pragma: no cover
self.loop = asyncio.get_event_loop()
t = asyncio.Task(
self.loop.create_connection(
self.config['connection_class'],
self.config['host'], self.config['port'],
ssl=self.config['ssl']),
loop=self.loop)
t.add_done_callback(self.connection_made)
return t
def register_event(self, pattern, callback=None):
"""register an event. See :class:`~panoramisk.message.Message`:
.. code-block:: python
>>> def callback(event, manager):
... print(event, manager)
>>> manager = Manager()
>>> manager.register_event('Meetme*', callback)
<function callback at 0x...>
You can also use the manager as a decorator:
.. code-block:: python
>>> manager = Manager()
>>> @manager.register_event('Meetme*')
... def callback(manager, event):
... print(manager, event)
"""
def _register_event(callback):
self.patterns.append((pattern,
re.compile(fnmatch.translate(pattern))))
self.callbacks[pattern].append(callback)
return callback
if callback is not None:
return _register_event(callback)
else:
return _register_event
def dispatch(self, event):
matches = []
event.manager = self
for pattern, regexp in self.patterns:
match = regexp.match(event.event)
if match is not None:
matches.append(pattern)
for callback in self.callbacks[pattern]:
ret = callback(self, event)
if (asyncio.iscoroutine(ret) or
isinstance(ret, asyncio.Future)):
asyncio.async(ret, loop=self.loop)
return matches
def close(self):
"""Close the connection"""
if self.pinger:
self.pinger.cancel()
self.pinger = None
if getattr(self, 'protocol', None):
self.protocol.close()
@classmethod
def from_config(cls, filename_or_fd, section='asterisk'):
return cls(**utils.config(filename_or_fd, section=section))
|