/usr/lib/python2.7/dist-packages/starpy/manager.py is in python-starpy 1.0.1.0.git.20140806-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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 | #
# StarPy -- Asterisk Protocols for Twisted
#
# Copyright (c) 2006, Michael C. Fletcher
#
# Michael C. Fletcher <mcfletch@vrplumber.com>
#
# See http://asterisk-org.github.com/starpy/ for more information about the
# StarPy project. Please do not directly contact any of the maintainers of this
# project for assistance; the project provides a web site, mailing lists and
# IRC channels for your use.
#
# This program is free software, distributed under the terms of the
# BSD 3-Clause License. See the LICENSE file at the top of the source tree for
# details.
"""Asterisk Manager Interface for the Twisted networking framework
The Asterisk Manager Interface is a simple line-oriented protocol that allows
for basic control of the channels active on a given Asterisk server.
Module defines a standard Python logging module log 'AMI'
"""
from twisted.internet import protocol, reactor, defer
from twisted.protocols import basic
from twisted.internet import error as tw_error
import socket
import logging
from hashlib import md5
from starpy import error
log = logging.getLogger('AMI')
class deferredErrorResp(defer.Deferred):
"""A subclass of defer.Deferred that adds a registerError method
to handle function callback when an Error response happens"""
_errorRespCallback = None
def registerError(self, function ):
"""Add function for Error response callback"""
self._errorRespCallback = function
log.debug('Registering function %s to handle Error response'
% (function))
class AMIProtocol(basic.LineOnlyReceiver):
"""Protocol for the interfacing with the Asterisk Manager Interface (AMI)
Provides most of the AMI Action interfaces.
Auto-generates ActionID fields for all calls.
Events and messages are passed around as simple dictionaries with
all-lowercase keys. Values are case-sensitive.
XXX Want to allow for timeouts
Attributes:
count -- total count of messages sent from this protocol
hostName -- used along with count and ID to produce unique IDs
messageCache -- stores incoming message fragments from the manager
id -- An identifier for this instance
"""
count = 0
amiVersion = None
id = None
def __init__(self, *args, **named):
"""Initialise the AMIProtocol, arguments are ignored"""
self.messageCache = []
self.actionIDCallbacks = {}
self.eventTypeCallbacks = {}
self.hostName = socket.gethostname()
def registerEvent(self, event, function):
"""Register callback for the given event-type
event -- string name for the event, None to match all events, or
a tuple of string names to match multiple events.
See http://www.voip-info.org/wiki/view/asterisk+manager+events
for list of events and the data they bear. Includes:
Newchannel -- note that you can receive multiple Newchannel
events for a single channel!
Hangup
Newexten
Newstate
Reload
Shutdown
ExtensionStatus
Rename
Newcallerid
Alarm
AlarmClear
Agentcallbacklogoff
Agentcallbacklogin
Agentlogin
Agentlogoff
MeetmeJoin
MeetmeLeave
MessageWaiting
Join
Leave
AgentCalled
ParkedCall
UnParkedCall
ParkedCalls
Cdr
ParkedCallsComplete
QueueParams
QueueMember
among other standard events. Also includes user-defined events.
function -- function taking (protocol,event) as arguments or None
to deregister the current function.
Multiple functions may be registered for a given event
"""
log.debug('Registering function %s to handle events of type %r',
function, event)
if isinstance(event, (str, unicode, type(None))):
event = (event,)
for ev in event:
self.eventTypeCallbacks.setdefault(ev, []).append(function)
def deregisterEvent(self, event, function=None):
"""Deregister callback for the given event-type
event -- event name (or names) to be deregistered, see registerEvent
function -- the function to be removed from the callbacks or None to
remove all callbacks for the event
returns success boolean
"""
log.debug('Deregistering handler %s for events of type %r',
function, event)
if isinstance(event, (str, unicode, type(None))):
event = (event,)
success = True
for ev in event:
try:
set = self.eventTypeCallbacks[ev]
except KeyError, err:
success = False
else:
try:
while function in set:
set.remove(function)
except (ValueError, KeyError), err:
success = False
if not set or function is None:
try:
del self.eventTypeCallbacks[ev]
except KeyError, err:
success = False
return success
def lineReceived(self, line):
"""Handle Twisted's report of an incoming line from the manager"""
log.debug('Line In: %r', line)
self.messageCache.append(line)
if not line.strip():
self.dispatchIncoming() # does dispatch and clears cache
def connectionMade(self):
"""Handle connection to the AMI port (auto-login)
This is a Twisted customisation point, we use it to automatically
log into the connection we've just established.
XXX Should probably use proper Twisted-style credential negotiations
"""
log.info('Connection Made')
if self.factory.plaintext_login:
df = self.login()
else:
df = self.loginChallengeResponse()
def onComplete(message):
"""Check for success, errback or callback as appropriate"""
if not message['response'] == 'Success':
log.info('Login Failure: %s', message)
self.transport.loseConnection()
self.factory.loginDefer.errback(
error.AMICommandFailure("Unable to connect to manager",
message)
)
else:
# XXX messy here, would rather have the factory trigger its own
# callback...
log.info('Login Complete: %s', message)
self.factory.loginDefer.callback(
self,
)
def onFailure(reason):
"""Handle failure to connect (e.g. due to timeout)"""
log.info('Login Call Failure: %s', reason.getTraceback())
self.transport.loseConnection()
self.factory.loginDefer.errback(
reason
)
df.addCallbacks(onComplete, onFailure)
def connectionLost(self, reason):
"""Connection lost, clean up callbacks"""
for key, callable in self.actionIDCallbacks.items():
try:
callable(tw_error.ConnectionDone(
"FastAGI connection terminated"))
except Exception, err:
log.error("Failure during connectionLost for callable %s: %s",
callable, err)
self.actionIDCallbacks.clear()
self.eventTypeCallbacks.clear()
VERSION_PREFIX = 'Asterisk Call Manager'
END_DATA = '--END COMMAND--'
def dispatchIncoming(self):
"""Dispatch any finished incoming events/messages"""
log.debug('Dispatch Incoming')
message = {}
while self.messageCache:
line = self.messageCache.pop(0)
line = line.strip()
if line:
if line.endswith(self.END_DATA):
# multi-line command results...
message.setdefault(' ', []).extend([
l for l in line.split('\n')
if (l and l != self.END_DATA)
])
else:
# regular line...
if line.startswith(self.VERSION_PREFIX):
self.amiVersion = line[
len(self.VERSION_PREFIX) + 1:].strip()
else:
try:
key, value = line.split(':', 1)
except ValueError, err:
# XXX data-safety issues, what prevents the
# VERSION_PREFIX from showing up in a data-set?
log.warn("Improperly formatted line received and "
"ignored: %r", line)
else:
message[key.lower().strip()] = value.strip()
log.debug('Incoming Message: %s', message)
if 'actionid' in message:
key = message['actionid']
callback = self.actionIDCallbacks.get(key)
if callback:
try:
callback(message)
except Exception, err:
# XXX log failure here...
pass
# otherwise is a monitor message or something we didn't send...
if 'event' in message:
self.dispatchEvent(message)
def dispatchEvent(self, event):
"""Given an incoming event, dispatch to registered handlers"""
for key in (event['event'], None):
try:
handlers = self.eventTypeCallbacks[key]
except KeyError, err:
pass
else:
for handler in handlers:
try:
handler(self, event)
except Exception, err:
# would like the getException code here...
log.error(
'Exception in event handler %s on event %s: %s',
handler, event, err
)
def generateActionId(self):
"""Generate a unique action ID
Assumes that hostName must be unique among all machines which talk
to a given AMI server. With that is combined the memory location of
the protocol object (which should be machine-unique) and the count of
messages that this manager has created so far.
Generally speaking, you shouldn't need to know the action ID, as the
protocol handles the management of them automatically.
"""
self.count += 1
return '%s-%s-%s' % (self.hostName, id(self), self.count)
def sendDeferred(self, message):
"""Send with a single-callback deferred object
Returns deferred that fires when a response to this message is received
"""
df = deferredErrorResp()
actionid = self.sendMessage(message, df.callback)
df.addCallbacks(
self.checkErrorResponse, self.cleanup,
callbackArgs=(actionid, df,), errbackArgs=(actionid,)
)
return df
def checkErrorResponse(self, result, actionid, df):
"""Check for error response and callback"""
self.cleanup( result, actionid)
if result.get('response') == 'Error' and df._errorRespCallback:
df._errorRespCallback(result)
return result
def cleanup(self, result, actionid):
"""Cleanup callbacks on completion"""
try:
del self.actionIDCallbacks[actionid]
except KeyError, err:
pass
return result
def sendMessage(self, message, responseCallback=None):
"""Send the message to the other side, return deferred for the result
returns the actionid for the message
"""
if type(message) == list:
actionid = next((value for header, value in message
if str(header.lower()) == 'actionid'), None)
if actionid is None:
actionid = self.generateActionId()
message.append(['actionid', str(actionid)])
if responseCallback:
self.actionIDCallbacks[actionid] = responseCallback
log.debug("""MSG OUT: %s""", message)
for item in message:
self.sendLine('%s: %s' % (str(item[0].lower()), str(item[1])))
else:
message = dict([(k.lower(), v) for (k, v) in message.items()])
if 'actionid' not in message:
message['actionid'] = self.generateActionId()
if responseCallback:
self.actionIDCallbacks[message['actionid']] = responseCallback
log.debug("""MSG OUT: %s""", message)
for key, value in message.items():
self.sendLine('%s: %s' % (str(key.lower()), str(value)))
self.sendLine('')
if type(message) == list:
return actionid
else:
return message['actionid']
def collectDeferred(self, message, stopEvent):
"""Collect all responses to this message until stopEvent or error
returns deferred returning sequence of events/responses
"""
df = defer.Deferred()
cache = []
def onEvent(event):
if event.get('response') == 'Error':
df.errback(error.AMICommandFailure(event))
elif event.get('event') == stopEvent:
cache.append(event)
df.callback(cache)
else:
cache.append(event)
actionid = self.sendMessage(message, onEvent)
df.addCallbacks(
self.cleanup, self.cleanup,
callbackArgs=(actionid,), errbackArgs=(actionid,)
)
return df
def errorUnlessResponse(self, message, expected='Success'):
"""Raise AMICommandFailure error unless message['response'] == expected
If == expected, returns the message
"""
if type(message) is dict and message['response'] != expected:
raise error.AMICommandFailure(message)
return message
## End-user API
def absoluteTimeout(self, channel, timeout):
"""Set timeout value for the given channel (in seconds)"""
message = {
'action': 'absolutetimeout',
'timeout': timeout,
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def agentLogoff(self, agent, soft):
"""Logs off the specified agent for the queue system."""
if soft in (True, 'yes', 1):
soft = 'true'
else:
soft = 'false'
message = {
'Action': 'AgentLogoff',
'Agent': agent,
'Soft': soft
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def agents(self):
"""Retrieve agents information"""
message = {
"action": "agents"
}
return self.collectDeferred(message, "AgentsComplete")
def changeMonitor(self, channel, filename):
"""Change the file to which the channel is to be recorded"""
message = {
'action': 'changemonitor',
'channel': channel,
'filename': filename
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def command(self, command):
"""Run asterisk CLI command, return deferred result for list of lines
returns deferred returning list of lines (strings) of the command
output.
See listCommands to see available commands
"""
message = {
'action': 'command',
'command': command
}
df = self.sendDeferred(message)
df.addCallback(self.errorUnlessResponse, expected='Follows')
def onResult(message):
return message[' ']
return df.addCallback(onResult)
def action(self, action, **action_args):
"""Sends an arbitrary action to the AMI"""
#action_args will be ar least an empty dict so we build the message from it.
action_args['action'] = action
return self.sendDeferred(action_args).addCallback(self.errorUnlessResponse)
def dbDel(self, family, key):
"""Delete key value in the AstDB database"""
message = {
'Action': 'DBDel',
'Family': family,
'Key': key
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dbDelTree(self, family, key=None):
"""Delete key value or key tree in the AstDB database"""
message = {
'Action': 'DBDelTree',
'Family': family
}
if key is not None:
message['Key'] = key
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dbGet(self, family, key):
"""This action retrieves a value from the AstDB database"""
df = defer.Deferred()
def extractValue(ami, event):
value = event['val']
self.deregisterEvent("DBGetResponse", extractValue)
return df.callback(value)
def errorResponse( message ):
self.deregisterEvent("DBGetResponse", extractValue)
return df.callback(None)
message = {
'Action': 'DBGet',
'family': family,
'key': key
}
self.sendDeferred(message).registerError(errorResponse)
self.registerEvent("DBGetResponse", extractValue)
return df
def dbPut(self, family, key, value):
"""Sets a key value in the AstDB database"""
message = {
'Action': 'DBPut',
'Family': family,
'Key': key,
'Val': value
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def events(self, eventmask=False):
"""Determine whether events are generated"""
if eventmask in ('off', False, 0):
eventmask = 'off'
elif eventmask in ('on', True, 1):
eventmask = 'on'
# otherwise is likely a type-mask
message = {
'action': 'events',
'eventmask': eventmask
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def extensionState(self, exten, context):
"""Get extension state
This command reports the extension state for the given extension.
If the extension has a hint, this will report the status of the
device connected to the extension.
The following are the possible extension states:
-2 Extension removed
-1 Extension hint not found
0 Idle
1 In use
2 Busy"""
message = {
'Action': 'ExtensionState',
'Exten': exten,
'Context': context
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def getConfig(self, filename):
"""Retrieves the data from an Asterisk configuration file"""
message = {
'Action': 'GetConfig',
'filename': filename
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def getVar(self, channel, variable):
"""Retrieve the given variable from the channel.
If channel is None, this gets a global variable."""
def extractVariable(message):
"""When message comes in, extract the variable from it"""
if variable.lower() in message:
value = message[variable.lower()]
elif 'value' in message:
value = message['value']
else:
raise error.AMICommandFailure(message)
if value == '(null)':
value = None
return value
message = {
'action': 'getvar',
'variable': variable
}
# channel is optional
if channel:
message['channel'] = channel
return self.sendDeferred(
message
).addCallback(
self.errorUnlessResponse
).addCallback(
extractVariable,
)
def hangup(self, channel):
"""Tell channel to hang up"""
message = {
'action': 'hangup',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def login(self):
"""Log into the AMI interface (done automatically on connection)
Uses factory.username and factory.secret
"""
self.id = self.factory.id
return self.sendDeferred({
'action': 'login',
'username': self.factory.username,
'secret': self.factory.secret,
}).addCallback(self.errorUnlessResponse)
def loginChallengeResponse(self):
"""Log into the AMI interface with challenge-response.
Follows the same approach as self.login() using factory.username and factory.secret.
Also done automatically on connection: will be called instead of self.login() if
factory.plaintext_login is False: see AMIFactory constructor.
"""
def sendResponse(challenge):
if not type(challenge) is dict or not 'challenge' in challenge:
raise error.AMICommandFailure(challenge)
key_value = md5('%s%s' % (challenge['challenge'], self.factory.secret)).hexdigest()
return self.sendDeferred({
'action': 'Login',
'authtype': 'MD5',
'username': self.factory.username,
'key': key_value,
}).addCallback(self.errorUnlessResponse)
self.id = self.factory.id
return self.sendDeferred({
'action': 'Challenge',
'authtype': 'MD5',
}).addCallback(sendResponse)
def listCommands(self):
"""List the set of commands available
Returns a single message with each command-name as a key
"""
message = {
'action': 'listcommands'
}
def removeActionId(message):
try:
del message['actionid']
except KeyError, err:
pass
return message
return self.sendDeferred(message).addCallback(
self.errorUnlessResponse
).addCallback(
removeActionId
)
def logoff(self):
"""Log off from the manager instance"""
message = {
'action': 'logoff'
}
return self.sendDeferred(message).addCallback(
self.errorUnlessResponse, expected='Goodbye',
)
def mailboxCount(self, mailbox):
"""Get count of messages in the given mailbox"""
message = {
'action': 'mailboxcount',
'mailbox': mailbox
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def mailboxStatus(self, mailbox):
"""Get status of given mailbox"""
message = {
'action': 'mailboxstatus',
'mailbox': mailbox
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def meetmeMute(self, meetme, usernum):
"""Mute a user in a given meetme"""
message = {
'action': 'MeetMeMute',
'meetme': meetme,
'usernum': usernum
}
return self.sendDeferred(message)
def meetmeUnmute(self, meetme, usernum):
""" Unmute a specified user in a given meetme"""
message = {
'action': 'meetmeunmute',
'meetme': meetme,
'usernum': usernum
}
return self.sendDeferred(message)
def monitor(self, channel, file, format, mix):
"""Record given channel to a file (or attempt to anyway)"""
message = {
'action': 'monitor',
'channel': channel,
'file': file,
'format': format,
'mix': mix
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def originate(
self, channel, context=None, exten=None, priority=None,
timeout=None, callerid=None, account=None, application=None,
data=None, variable={}, async=False, channelid=None,
otherchannelid=None
):
"""Originate call to connect channel to given context/exten/priority
channel -- the outgoing channel to which will be dialed
context/exten/priority -- the dialplan coordinate to which to connect
the channel (i.e. where to start the called person)
timeout -- duration before timeout in seconds
(note: not Asterisk standard!)
callerid -- callerid to display on the channel
account -- account to which the call belongs
application -- alternate application to Dial to use for outbound dial
data -- data to pass to application
variable -- variables associated to the call
async -- make the origination asynchronous
"""
variable = ','.join(["%s=%s" % (x[0], x[1]) for x in variable.items()])
message = dict([(k, v) for (k, v) in {
'action': 'originate',
'channel': channel,
'context': context,
'exten': exten,
'priority': priority,
'timeout': timeout,
'callerid': callerid,
'account': account,
'application': application,
'data': data,
'variable': variable,
'async': str(async),
'channelid': channelid,
'otherchannelid': otherchannelid
}.items() if v is not None])
if 'timeout' in message:
message['timeout'] = message['timeout'] * 1000
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def park(self, channel, channel2, timeout):
"""Park channel"""
message = {
'action': 'park',
'channel': channel,
'channel2': channel2,
'timeout': timeout
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def parkedCall(self):
"""Check for a ParkedCall event"""
message = {
'action': 'ParkedCall'
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def unParkedCall(self):
"""Check for an UnParkedCall event """
message = {
'action': 'UnParkedCall'
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def parkedCalls(self):
"""Retrieve set of parked calls via multi-event callback"""
message = {
'action': 'ParkedCalls'
}
return self.collectDeferred(message, 'ParkedCallsComplete')
def pauseMonitor(self, channel):
"""Temporarily stop recording the channel"""
message = {
'action': 'pausemonitor',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def ping(self):
"""Check to see if the manager is alive..."""
message = {
'action': 'ping'
}
if self.amiVersion == "1.0":
return self.sendDeferred(message).addCallback(
self.errorUnlessResponse, expected='Pong',
)
else:
return self.sendDeferred(message).addCallback(
self.errorUnlessResponse
)
def playDTMF(self, channel, digit):
"""Play DTMF on a given channel"""
message = {
'action': 'playdtmf',
'channel': channel,
'digit': digit
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queueAdd(self, queue, interface, penalty=0, paused=True,
membername=None, stateinterface=None):
"""Add given interface to named queue"""
if paused in (True, 'true', 1):
paused = 'true'
else:
paused = 'false'
message = {
'action': 'queueadd',
'queue': queue,
'interface': interface,
'penalty': penalty,
'paused': paused
}
if membername is not None:
message['membername'] = membername
if stateinterface is not None:
message['stateinterface'] = stateinterface
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queueLog(self, queue, event, uniqueid=None, interface=None, msg=None):
"""Adds custom entry in queue_log"""
message = {
'action': 'queuelog',
'queue': queue,
'event': event
}
if uniqueid is not None:
message['uniqueid'] = uniqueid
if interface is not None:
message['interface'] = interface
if msg is not None:
message['message'] = msg
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queuePause(self, queue, interface, paused=True, reason=None):
if paused in (True, 'true', 1):
paused = 'true'
else:
paused = 'false'
message = {
'action': 'queuepause',
'queue': queue,
'interface': interface,
'paused': paused
}
if reason is not None:
message['reason'] = reason
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queuePenalty(self, interface, penalty, queue=None):
"""Set penalty for interface"""
message = {
'action': 'queuepenalty',
'interface': interface,
'penalty': penalty
}
if queue is not None:
message.update({'queue': queue})
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queueRemove(self, queue, interface):
"""Remove given interface from named queue"""
message = {
'action': 'queueremove',
'queue': queue,
'interface': interface
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queues(self):
"""Retrieve information about active queues via multiple events"""
# XXX AMI returns improperly formatted lines so this doesn't work now.
message = {
'action': 'queues'
}
#return self.collectDeferred(message, 'QueueStatusEnd')
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def queueStatus(self, queue=None, member=None):
"""Retrieve information about active queues via multiple events"""
message = {
'action': 'queuestatus'
}
if queue is not None:
message.update({'queue': queue})
if member is not None:
message.update({'member': member})
return self.collectDeferred(message, 'QueueStatusComplete')
def redirect(self, channel, context, exten, priority, extraChannel=None):
"""Transfer channel(s) to given context/exten/priority"""
message = {
'action': 'redirect',
'channel': channel,
'context': context,
'exten': exten,
'priority': priority,
}
if extraChannel is not None:
message['extrachannel'] = extraChannel
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def setCDRUserField(self, channel, userField, append=True):
"""Set/add to a user field in the CDR for given channel"""
if append in (True, 'true', 1):
append = 'true'
else:
append = 'false'
message = {
'channel': channel,
'userfield': userField,
'append': append,
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def setVar(self, channel, variable, value):
"""Set channel variable to given value.
If channel is None, this sets a global variable."""
message = {
'action': 'setvar',
'variable': variable,
'value': value
}
# channel is optional
if channel:
message['channel'] = channel
return self.sendDeferred(
message
).addCallback(
self.errorUnlessResponse
)
def sipPeers(self):
"""List all known sip peers"""
# XXX not available on my box...
message = {
'action': 'sippeers'
}
return self.collectDeferred(message, 'PeerlistComplete')
def sipShowPeers(self, peer):
message = {
'action': 'sipshowpeer',
'peer': peer
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def status(self, channel=None):
"""Retrieve status for the given (or all) channels
The results come in via multi-event callback
channel -- channel name or None to retrieve all channels
returns deferred returning list of Status Events for each requested
channel
"""
message = {
'action': 'Status'
}
if channel:
message['channel'] = channel
return self.collectDeferred(message, 'StatusComplete')
def stopMonitor(self, channel):
"""Stop monitoring the given channel"""
message = {
'action': 'monitor',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def unpauseMonitor(self, channel):
"""Resume recording a channel"""
message = {
'action': 'unpausemonitor',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def updateConfig(self, srcfile, dstfile, reload, headers={}):
"""Update a configuration file
headers should be a dictionary with the following keys
Action-XXXXXX
Cat-XXXXXX
Var-XXXXXX
Value-XXXXXX
Match-XXXXXX
"""
message = {}
if reload in (True, 'yes', 1):
reload = 'yes'
else:
reload = 'no'
message = {
'action': 'updateconfig',
'srcfilename': srcfile,
'dstfilename': dstfile,
'reload': reload
}
for k, v in headers.items():
message[k] = v
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def userEvent(self, event, **headers):
"""Sends an arbitrary event to the Asterisk Manager Interface."""
message = {
'Action': 'UserEvent',
'userevent': event
}
for i, j in headers.items():
message[i] = j
return self.sendMessage(message)
def waitEvent(self, timeout):
"""Waits for an event to occur
After calling this action, Asterisk will send you a Success response as
soon as another event is queued by the AMI
"""
message = {
'action': 'WaitEvent',
'timeout': timeout
}
return self.collectDeferred(message, 'WaitEventComplete')
def dahdiDNDoff(self, channel):
"""Toggles the DND state on the specified DAHDI channel to off"""
message = {
'action': 'DAHDIDNDoff',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dahdiDNDon(self, channel):
"""Toggles the DND state on the specified DAHDI channel to on"""
message = {
'action': 'DAHDIDNDon',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dahdiDialOffhook(self, channel, number):
"""Dial a number on a DAHDI channel while off-hook"""
message = {
'Action': 'DAHDIDialOffhook',
'DAHDIChannel': channel,
'Number': number
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dahdiHangup(self, channel):
"""Hangs up the specified DAHDI channel"""
message = {
'Action': 'DAHDIHangup',
'DAHDIChannel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dahdiRestart(self, channel):
"""Restarts the DAHDI channels, terminating any calls in progress"""
message = {
'Action': 'DAHDIRestart',
'DAHDIChannel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
def dahdiShowChannels(self):
"""List all DAHDI channels"""
message = {
'action': 'DAHDIShowChannels'
}
return self.collectDeferred(message, 'DAHDIShowChannelsComplete')
def dahdiTransfer(self, channel):
"""Transfers DAHDI channel"""
message = {
'Action': 'DAHDITransfer',
'channel': channel
}
return self.sendDeferred(message).addCallback(self.errorUnlessResponse)
class AMIFactory(protocol.ClientFactory):
"""A factory for AMI protocols
"""
protocol = AMIProtocol
def __init__(self, username, secret, id=None, plaintext_login=True):
self.username = username
self.secret = secret
self.id = id
self.plaintext_login = plaintext_login
def login(self, ip='localhost', port=5038, timeout=5, bindAddress=None):
"""Connect and return protocol instance
Connect and return our (singleton) protocol instance with login
completed.
XXX This is messy, we'd much rather have the factory able to create
large numbers of protocols simultaneously
"""
self.loginDefer = defer.Deferred()
reactor.connectTCP(ip, port, self, timeout=timeout,
bindAddress=bindAddress)
return self.loginDefer
def clientConnectionFailed(self, connector, reason):
"""Connection failed, report to our callers"""
self.loginDefer.errback(reason)
|