Asterisk-AMI
view release on metacpan or search on metacpan
lib/Asterisk/AMI.pm view on Meta::CPAN
'Username' has no default and must be supplied.
'Secret' has no default and must be supplied.
'AuthType' sets the authentication type to use for login. Default is 'plaintext'. Use 'MD5' for MD5 challenge
authentication.
'UseSSL' defaults to 0 (no ssl). When SSL is enabled the default PeerPort changes to 5039.
'BufferSize' has a default of 30000. It also acts as our max actionid before we reset the counter.
'Timeout' has a default of 0, which means no timeout on blocking.
'Handlers' accepts a hash reference setting a callback handler for the specified event. EVENT should match
the contents of the {'Event'} key of the event object will be. The handler should be a subroutine reference that
will be passed the a copy of the AMI object and the event object. The 'default' keyword can be used to set
a default event handler. If handlers are installed we do not buffer events and instead immediately dispatch them.
If no handler is specified for an event type and a 'default' was not set the event is discarded.
'Keepalive' only works when running with an event loop. Used with on_timeout, this can be used to detect if
asterisk has become un-responsive.
'TCP_Keepalive' default is disabled. Activates the tcp keep-alive at the socket layer. This does not require
an event-loop and is lightweight. Useful for applications that use long-lived connections to Asterisk but
do not run an event loop.
'Blocking' has a default of 1 (block on connecting). A value of 0 will cause us to queue our connection
and login for when an event loop is started. If set to non blocking we will always return a valid object.
'on_connect' is a subroutine to call when we have successfully connected and logged into the asterisk manager.
it will be passed our AMI object.
'on_connect_err', 'on_error', 'on_disconnect'
These three specify subroutines to call when errors occur. 'on_connect_err' is specifically for errors that
occur while connecting, as well as failed logins. If 'on_connect_err' or 'on_disconnect' it is not set,
but 'on_error' is, 'on_error' will be called. 'on_disconnect' is not reliable, as disconnects seem to get lumped
under 'on_error' instead. When the subroutine specified for any of theses is called the first argument is a copy
of our AMI object, and the second is a string containing a message/reason. All three of these are 'fatal', when
they occur we destroy our buffers and our socket connections.
'on_timeout' is called when a keep-alive has timed out, not when a normal action has. It is non-'fatal'.
The subroutine will be called with a copy of our AMI object and a message.
'OriginateHack' defaults to 0 (off). This essentially enables 'call' events and says 'discard all events
unless the user has explicitly enabled events' (prevents a memory leak). It does its best not to mess up
anything you have already set. Without this, if you use 'Async' with an 'Originate' the action will timeout
or never callback. You don't need this if you are already doing work with events, simply add 'call' events
to your eventmask.
=head2 Disabling Warnings
If you have warnings enabled this module will emit a number of them on connection errors, deprecated features, etc.
To disable this but still have all other warnings in perl enabled you can do the following:
use Asterisk::AMI;
use warnings;
no warnings qw(Asterisk::AMI);
That will enable warnings but disable any warnings from this module.
=head2 Warning - Mixing Event-loops and blocking actions
For an intro to Event-Based programming please check out the documentation in AnyEvent::Intro.
If you are running an event loop and use blocking methods (e.g. get_response, check_response, action,
simple_action, connected, or a blocking connect) the outcome is unspecified. It may work, it may lock everything up, the action may
work but break something else. I have tested it and behavior seems unpredictable at best and is very
circumstantial.
If you are running an event-loop use non-blocking callbacks! It is why they are there!
However if you do play with blocking methods inside of your loops let me know how it goes.
=head2 Actions
=head3 ActionIDs
This module handles ActionIDs internally and if you supply one in an action it will simply be ignored and overwritten.
=head3 Construction
No matter which method you use to send an action (send_action(), simple_action(), or action()), they all accept
actions in the same format, which is a hash reference. The only exceptions to this rules are when specifying a
callback and a callback timeout, which only work with send_action.
To build and send an action you can do the following:
%action = ( Action => 'Command',
Command => 'sip show peers'
);
$astman->send_action(\%action);
Alternatively you can also do the following to the same effect:
$astman->send_action({ Action => 'Command',
Command => 'sip show peers'
});
Additionally the value of the hash may be an array reference. When an array reference is used, every value in the
array is append as a different line to the action. For example:
{ Variable => [ 'var1=1', 'var2=2' ] }
Will become:
Variable: var1=1
Variable: var2=2
When the action is sent.
=head3 Sending and Retrieving
More detailed information on these individual methods is available below
The send_action() method can be used to send an action to the AMI. It will return a positive integer, which is the
ActionID of the action, on success and will return undef in the event it is unable to send the action.
After sending an action you can then get its response in one of two methods.
The method check_response() accepts an actionid and will return 1 if the action was considered successful, 0 if it
failed and undef if an error occurred or on timeout.
The method get_response() accepts an actionid and will return a Response object (really just a fancy hash) with the
contents of the Action Response as well as any associated Events it generated. It will return undef if an error
occurred or on timeout.
All responses and events are buffered, therefor you can issue several send_action()s and then retrieve/check their
responses out of order without losing any information. In-fact, if you are issuing many actions in series you can get
much better performance sending them all first and then retrieving them later, rather than waiting for responses
immediately after issuing an action.
Alternatively you can also use simple_action() and action(). simple_action() combines send_action() and
check_response(), and therefore returns 1 on success and 0 on failure, and undef on error or timeout. action()
combines send_action() and get_response(), and therefore returns a Response object or undef.
=head4 Examples
Send and retrieve and action:
my $actionid = $astman->send_action({ Action => 'Command',
Command => 'sip show peers'
});
my $response = $astman->get_response($actionid)
This is equivalent to the above:
my $response = $astman->action({ Action => 'Command',
Command => 'sip show peers'
});
The following:
my $actionid1 = $astman->send_action({ Action => 'Command',
Command => 'sip show peers'
});
my $actionid2 = $astman->send_action({ Action => 'Command',
Command => 'sip show peers'
});
my $actionid3 = $astman->send_action({ Action => 'Command',
Command => 'sip show peers'
});
my $response3 = $astman->get_response($actionid3);
my $response1 = $astman->get_response($actionid1);
my $response2 = $astman->get_response($actionid2);
Can be much faster than:
my $response1 = $astman->action({ Action => 'Command',
Command => 'sip show peers'
});
my $response2 = $astman->action({ Action => 'Command',
Command => 'sip show peers'
});
my $response3 = $astman->action({ Action => 'Command',
Command => 'sip show peers'
});
=head3 Originate Examples
These don't include non-blocking examples, please read the section on 'Callbacks' below for information
on using non-blocking callbacks and events.
NOTE: Please read about the 'OriginateHack' option for the constructor above if you plan on using the 'Async'
option in your Originate command, as it may be required to properly retrieve the response.
In these examples we are dialing extension '12345' at a sip peer named 'peer' and when the call connects
we drop the channel into 'some_context' at priority 1 for extension 100.
Example 1 - A simple non-ASYNC Originate
my $response = $astman->action({Action => 'Originate',
Channel => 'SIP/peer/12345',
Context => 'some_context',
Exten => 100,
Priority => 1});
And the contents of respone will look similiar to the following:
{
'Message' => 'Originate successfully queued',
'ActionID' => '3',
'GOOD' => 1,
'COMPLETED' => 1,
'Response' => 'Success'
};
Example 2 - Originate with multiple variables
This will set the channel variables 'var1' and 'var2' to 1 and 2, respectfully.
The value for the 'Variable' key should be an array reference or an anonymous array in order
to set multiple variables.
my $response = $astman->action({Action => 'Originate',
Channel => 'SIP/peer/12345',
Context => 'some_context',
Exten => 100,
Priority => 1,
Variable = [ 'var1=1', 'var2=2' ]});
Example 3 - An Async Originate
If your Async Originate never returns please read about the 'OriginateHack' option for the constructor.
my $response = $astman->action({Action => 'Originate',
Channel => 'SIP/peer/12345',
Context => 'some_context',
Exten => 100,
Priority => 1,
Async => 1});
And the contents of response will look similiar to the following:
{
'Message' => 'Originate successfully queued',
'EVENTS' => [
{
'Exten' => '100',
'CallerID' => '<unknown>',
'Event' => 'OriginateResponse',
'Privilege' => 'call,all',
'Channel' => 'SIP/peer-009c5510',
'Context' => 'some_context',
'Response' => 'Success',
'Reason' => '4',
'CallerIDName' => '<unknown>',
'Uniqueid' => '1276543236.82',
'ActionID' => '3',
'CallerIDNum' => '<unknown>'
}
],
'ActionID' => '3',
'GOOD' => 1,
'COMPLETED' => 1,
'Response' => 'Success'
};
More Info:
Check out the voip-info.org page for more information on the Originate action.
http://www.voip-info.org/wiki/view/Asterisk+Manager+API+Action+Originate
=head3 Callbacks
You may also specify a subroutine to callback when using send_action as well as a timeout.
An example of this would be:
$astman->send_action({ Action => 'Ping' }, \&somemethod, 7, $somevar);
In this example once the action 'Ping' finishes we will call somemethod() and pass it the a copy of our AMI object,
the Response Object for the action, and an optional variable $somevar. If a timeout is not specified
it will use the default set. A value of 0 means no timeout. When the timeout is reached somemethod() will be called
and passed a reference to our $astman and the uncompleted Response Object, therefore somemethod() should check the
state of the object. Checking the key {'GOOD'} is usually a good indication if the response is useable.
Anonymous subroutines are also acceptable as demostrated in the examples below:
my $callback = sub { return };
$astman->send_action({ Action => 'Ping' }, $callback, 7);
Or
$astman->send_action({ Action => 'Ping' }, sub { return }, 7);
=head3 Callback Caveats
Callbacks only work if we are processing packets, therefore you must be running an event loop. Alternatively, we run
mini-event loops for our blocking calls (e.g. action(), get_action()), so in theory if you set callbacks and then
issue a blocking call those callbacks should also get triggered. However this is an unsupported scenario.
Timeouts are done using timers and they are set as soon as you send the object. Therefore if you send an action with a
timeout and then monkey around for a long time before getting back to your event loop (to process input) you can time
out before ever even attempting to receive the response.
A very contrived example:
$astman->send_action({ Action => 'Ping' }, \&somemethod, 3);
sleep(4);
#Start loop
$astman->loop;
#Oh no we never even tried to get the response yet it will still time out
=head2 Passing Variables in an Action Response
Sometimes, when working in an event framework, you want a way to associate/map the response to an action with another
identifier used in your application. Normally you would have to maintain some sort of separate mapping involving the
ActionID to accomplish this. This modules provides a generic way to pass any perl scalar (this includes references)
with your action which is then passed to the callback with the response.
=head3 Passing
The variable to be passed to the callback should be passed as the fourth argument to the send_action() method.
For example to pass a simple scalar value:
my $vartostore = "Stored";
$astman->send_action({ Action => 'Ping' }, \&somemethod, undef, $vartostore });
And to pass a reference:
my @vartostore = ("One", "Two");
$astman->send_action({ Action => 'Ping' }, \&somemethod, undef, \@vartostore });
=head3 Retrieving
The passed variable will be available as the third argument to the callback.
To retrieve in a callback:
my ($astman, $resp, $store) = @_;
print $store . " was stored\n";
=head2 Responses and Events
NOTE: Empty fields sent by Asterisk (e.g. 'Account: ' with no value in an event) are represented by the hash
value of null string, not undef. This means you need to test for ''
(e.g. if ($response->{'Account'} ne '')) ) for any values that might be possibly be empty.
=head3 Responses
Responses are returned as response objects, which are hash references, structured as follows:
$response->{'Response'} Response to our packet (Success, Failed, Error, Pong, etc).
{'ActionID'} ActionID of this Response.
{'Message'} Message line of the response.
lib/Asterisk/AMI.pm view on Meta::CPAN
only has an affect if a CALLBACK is specified. USERDATA is optional and is a perl variable that will be passed to
the CALLBACK in addition to the response.
The use of the CALLBACK and TIMEOUT keys in the ACTION has been deprecated.
check_response( [ ACTIONID ], [ TIMEOUT ] )
Returns 1 if the action was considered successful, 0 if it failed, or undef on timeout or error. If no ACTIONID
is specified the ACTIONID of the last action sent will be used. If no TIMEOUT is given it blocks, reading in
packets until the action completes. This will remove a response from the buffer.
get_response ( [ ACTIONID ], [ TIMEOUT ] )
Returns the response object for the action. Returns undef on error or timeout.
If no ACTIONID is specified the ACTIONID of the last action sent will be used. If no TIMEOUT is given it
blocks, reading in packets until the action completes. This will remove the response from the buffer.
action ( ACTION [, TIMEOUT ] )
Sends the action and returns the response object for the action. Returns undef on error or timeout.
If no ACTIONID is specified the ACTIONID of the last action sent will be used.
If no TIMEOUT is given it blocks, reading in packets until the action completes. This will remove the
response from the buffer.
simple_action ( ACTION [, TIMEOUT ] )
Sends the action and returns 1 if the action was considered successful, 0 if it failed, or undef on error
and timeout. If no ACTIONID is specified the ACTIONID of the last action sent will be used. If no TIMEOUT is
given it blocks, reading in packets until the action completes. This will remove the response from the buffer.
disconnect ()
Logoff and disconnects from the AMI. Returns 1 on success and 0 if any errors were encountered.
get_event ( [ TIMEOUT ] )
This returns the first event object in the buffer, or if no events are in the buffer it reads in packets
waiting for an event. It will return undef if an error occurs.
If no TIMEOUT is given it blocks, reading in packets until an event arrives.
amiver ()
Returns the version of the Asterisk Manager Interface we are connected to. Undef until the connection is made
(important if you have Blocking => 0).
connected ( [ TIMEOUT ] )
This checks the connection to the AMI to ensure it is still functional. It checks at the socket layer and
also sends a 'PING' to the AMI to ensure it is still responding. If no TIMEOUT is given this will block
waiting for a response.
Returns 1 if the connection is good, 0 if it is not.
error ()
Returns 1 if there are currently errors on the socket, 0 if everything is ok.
destroy ()
Destroys the contents of all buffers and removes any current callbacks that are set.
Mostly used internally. Useful if you want to ensure that our IO handle watcher gets removed.
Gets called automatically when our object goes out of scope.
loop ()
Starts an event loop via AnyEvent.
break ()
Breaks/exits the current event loop. The program will continue from where the event loop was invoked.
=head1 See Also
AnyEvent, Asterisk::AMI::Common, Asterisk::AMI::Common::Dev
=head1 AUTHOR
Ryan Bullock (rrb3942@gmail.com)
=head1 BUG REPORTING AND FEEDBACK
Please report any bugs or errors to our github issue tracker at http://github.com/rrb3942/perl-Asterisk-AMI/issues or
the cpan request tracker at https://rt.cpan.org/Public/Bug/Report.html?Queue=perl-Asterisk-AMI
=head1 LICENSE
Copyright (C) 2011 by Ryan Bullock (rrb3942@gmail.com)
This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.
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.
=cut
package Asterisk::AMI;
#Register warnings
use warnings::register;
use strict;
use warnings;
use AnyEvent;
use AnyEvent::Handle;
use AnyEvent::Socket;
use Digest::MD5;
use Scalar::Util qw/weaken/;
use Carp qw/carp/;
#Duh
use version 0.77; our $VERSION = version->declare("v0.2.8");
#Used for storing events while reading command responses Events are stored as hashes in the array Example
#$self->{EVETNBUFFER}->{'Event'} = Something
#Buffer for holding action responses and data
# Structure: $self->{RESPONSEBUFFER}->{'ActionID'}->{'Response'} = (Success|Failure|Follows|Goodbye|Pong|Etc..)
# //Reponse Status
# {'Message'} = Message //Message in the response {'EVENTS'} = [%hash1, %hash2, ..] //Arry
lib/Asterisk/AMI.pm view on Meta::CPAN
$self->{CONFIG}->{$opt} = $val;
}
#Check for required options
foreach my $req (@required) {
if (!exists $self->{CONFIG}->{$req}) {
carp "Must supply a username and secret for connecting to asterisk" if warnings::enabled('Asterisk::AMI');
return;
}
}
#Change default port if using ssl
if ($self->{CONFIG}->{USESSL}) {
$defaults{PEERPORT} = 5039;
}
#Assign defaults for any missing options
while (my ($opt, $val) = each(%defaults)) {
if (!defined $self->{CONFIG}->{$opt}) {
$self->{CONFIG}->{$opt} = $val;
}
}
#Make adjustments for Originate Async bullscrap
if ($self->{CONFIG}->{ORIGINATEHACK}) {
#Turn on call events, otherwise we wont get the Async response
if (lc($self->{CONFIG}->{EVENTS}) eq 'off') {
$self->{CONFIG}->{EVENTS} = 'call';
#Fake event type so that we will discard events, else by turning on events our event buffer
#Will just continue to fill up.
$self->{CONFIG}->{HANDLERS} = { 'JUSTMAKETHEHASHNOTEMPTY' => sub {} } unless ($self->{CONFIG}->{HANDLERS});
#They already turned events on, just add call types to it, assume they are doing something with events
#and don't mess with the handlers
} elsif (lc($self->{CONFIG}->{EVENTS}) !~ /on|call/x) {
$self->{CONFIG}->{EVENTS} .= ',call';
}
}
#Initialize the seq number
$self->{idseq} = 1;
#Weaken reference for use in anonsub
weaken($self);
#Set keepalive
$self->{CONFIG}->{KEEPALIVE} = AE::timer($self->{CONFIG}->{KEEPALIVE}, $self->{CONFIG}->{KEEPALIVE}, sub { $self->_send_keepalive }) if ($self->{CONFIG}->{KEEPALIVE});
return 1;
}
#Handles connection failures (includes login failure);
sub _on_connect_err {
my ($self, $message) = @_;
warnings::warnif('Asterisk::AMI', "Failed to connect to asterisk - $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}");
warnings::warnif('Asterisk::AMI', "Error Message: $message");
#Dispatch all callbacks as if they timed out
$self->_clear_cbs();
if (exists $self->{CONFIG}->{ON_CONNECT_ERR}) {
$self->{CONFIG}->{ON_CONNECT_ERR}->($self, $message);
} elsif (exists $self->{CONFIG}->{ON_ERROR}) {
$self->{CONFIG}->{ON_ERROR}->($self, $message);
}
$self->{SOCKERR} = 1;
$self->destroy();
return;
}
#Handles other errors on the socket
sub _on_error {
my ($self, $message) = @_;
warnings::warnif('Asterisk::AMI', "Received Error on socket - $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}");
warnings::warnif('Asterisk::AMI', "Error Message: $message");
#Call all cbs as if they had timed out
$self->_clear_cbs();
$self->{CONFIG}->{ON_ERROR}->($self, $message) if (exists $self->{CONFIG}->{ON_ERROR});
$self->{SOCKERR} = 1;
$self->destroy();
return;
}
#Handles the remote end disconnecting
sub _on_disconnect {
my ($self) = @_;
my $message = "Remote end disconnected - $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}";
warnings::warnif('Asterisk::AMI', "Remote Asterisk Server ended connection - $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}");
#Call all callbacks as if they had timed out
_
$self->_clear_cbs();
if (exists $self->{CONFIG}->{ON_DISCONNECT}) {
$self->{CONFIG}->{ON_DISCONNECT}->($self, $message);
} elsif (exists $self->{CONFIG}->{ON_ERROR}) {
$self->{CONFIG}->{ON_ERROR}->($self, $message);
}
$self->{SOCKERR} = 1;
$self->destroy();
return;
}
#What happens if our keep alive times out
sub _on_timeout {
my ($self, $message) = @_;
warnings::warnif('Asterisk::AMI', $message);
if (exists $self->{CONFIG}->{ON_TIMEOUT}) {
$self->{CONFIG}->{ON_TIMEOUT}->($self, $message);
} elsif (exists $self->{CONFIG}->{ON_ERROR}) {
$self->{CONFIG}->{ON_ERROR}->($self, $message);
}
$self->{SOCKERR} = 1;
return;
}
#Things to do after our initial connect
sub _on_connect {
my ($self, $fh, $line) = @_;
if ($line =~ /^Asterisk\ Call\ Manager\/([0-9]\.[0-9])$/ox) {
$self->{AMIVER} = $1;
} else {
warnings::warnif('Asterisk::AMI', "Unknown Protocol/AMI Version from $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}");
}
#Weak reference for us in anonysub
weaken($self);
$self->{handle}->push_read( 'Asterisk::AMI' => sub { $self->_handle_packet(@_); } );
return 1;
}
#Connects to the AMI Returns 1 on success, 0 on failure
sub _connect {
my ($self) = @_;
#Weaken ref for use in anonysub
weaken($self);
#Build a hash of our anyevent::handle options
my %hdl = ( connect => [$self->{CONFIG}->{PEERADDR} => $self->{CONFIG}->{PEERPORT}],
on_connect_err => sub { $self->_on_connect_err($_[1]); },
on_error => sub { $self->_on_error($_[2]) },
on_eof => sub { $self->_on_disconnect; },
on_connect => sub { $self->{handle}->push_read( line => sub { $self->_on_connect(@_); } ); });
#TLS stuff
$hdl{'tls'} = 'connect' if ($self->{CONFIG}->{USESSL});
#TCP Keepalive
$hdl{'keeplive'} = 1 if ($self->{CONFIG}->{TCP_KEEPALIVE});
#Make connection/create handle
$self->{handle} = AnyEvent::Handle->new(%hdl);
#Return login status if blocking
return $self->_login if ($self->{CONFIG}->{BLOCKING});
#Queue our login
$self->_login;
#If we have a handle, SUCCESS!
return 1 if (defined $self->{handle});
return;
}
sub _handle_packet {
my ($self, $hdl, $buffer) = @_;
foreach my $packet (split /\015\012\015\012/ox, $buffer) {
my %parsed;
foreach my $line (split /\015\012/ox, $packet) {
#Is this our command output?
if ($line =~ s/--END\ COMMAND--$//ox) {
$parsed{'COMPLETED'} = 1;
push(@{$parsed{'CMD'}},split(/\x20*\x0A/ox, $line));
} else {
#Regular output, split on :\
my ($key, $value) = split /:\ /x, $line, 2;
$parsed{$key} = $value;
}
}
#Dispatch depending on packet type
if (exists $parsed{'ActionID'}) {
$self->_handle_action(\%parsed);
} elsif (exists $parsed{'Event'}) {
$self->_handle_event(\%parsed);
}
}
return 1;
}
#Used once and action completes
#Determines goodness and performs any oustanding callbacks
sub _action_complete {
my ($self, $actionid) = @_;
#Determine 'Goodness'
if (defined $self->{RESPONSEBUFFER}->{$actionid}->{'Response'}
&& $self->{RESPONSEBUFFER}->{$actionid}->{'Response'} =~ /^(?:Success|Follows|Goodbye|Events Off|Pong)$/ox) {
$self->{RESPONSEBUFFER}->{$actionid}->{'GOOD'} = 1;
}
#Do callback and cleanup if callback exists
if (defined $self->{CALLBACKS}->{$actionid}->{'cb'}) {
#Stuff needed to process callback
my $callback = $self->{CALLBACKS}->{$actionid}->{'cb'};
my $response = $self->{RESPONSEBUFFER}->{$actionid};
my $store = $self->{CALLBACKS}->{$actionid}->{'store'};
#cleanup
delete $self->{RESPONSEBUFFER}->{$actionid};
delete $self->{CALLBACKS}->{$actionid};
#Delete Originate Async bullshit
delete $response->{'ASYNC'};
$callback->($self, $response, $store);
}
return 1;
}
#Handles proccessing and callbacks for action responses
sub _handle_action {
my ($self, $packet) = @_;
#Snag our actionid
my $actionid = $packet->{'ActionID'};
#Discard Unknown ActionIDs
return unless ($self->{EXPECTED}->{$actionid});
#Event responses
if (exists $packet->{'Event'}) {
#EventCompleted Event?
if ($packet->{'Event'} =~ /[cC]omplete/ox) {
$self->{RESPONSEBUFFER}->{$actionid}->{'COMPLETED'} = 1;
} else {
#DBGetResponse and Originate Async Exceptions
if ($packet->{'Event'} eq 'DBGetResponse' || $packet->{'Event'} eq 'OriginateResponse') {
$self->{RESPONSEBUFFER}->{$actionid}->{'COMPLETED'} = 1;
}
#To the buffer
push(@{$self->{RESPONSEBUFFER}->{$actionid}->{'EVENTS'}}, $packet);
}
#Response packets
} elsif (exists $packet->{'Response'}) {
#If No indication of future packets, mark as completed
if ($packet->{'Response'} ne 'Follows') {
#Originate Async Exception is the first test
if (!$self->{RESPONSEBUFFER}->{$actionid}->{'ASYNC'}
&& (!exists $packet->{'Message'} || $packet->{'Message'} !~ /[fF]ollow/ox)) {
$self->{RESPONSEBUFFER}->{$actionid}->{'COMPLETED'} = 1;
}
}
#Copy the response into the buffer
foreach (keys %{$packet}) {
if ($_ =~ /^(?:Response|Message|ActionID|Privilege|CMD|COMPLETED)$/ox) {
$self->{RESPONSEBUFFER}->{$actionid}->{$_} = $packet->{$_};
} else {
$self->{RESPONSEBUFFER}->{$actionid}->{'PARSED'}->{$_} = $packet->{$_};
}
}
}
if ($self->{RESPONSEBUFFER}->{$actionid}->{'COMPLETED'}) {
#This aciton is finished do not accept any more packets for it
delete $self->{EXPECTED}->{$actionid};
#Determine goodness, do callback
$self->_action_complete($actionid);
}
return 1;
}
#Handles proccessing and callbacks for 'Event' packets
sub _handle_event {
my ($self, $event) = @_;
#If handlers were configured just dispatch, don't buffer
if ($self->{CONFIG}->{HANDLERS}) {
if (exists $self->{CONFIG}->{HANDLERS}->{$event->{'Event'}}) {
$self->{CONFIG}->{HANDLERS}->{$event->{'Event'}}->($self, $event);
} elsif (exists $self->{CONFIG}->{HANDLERS}->{'default'}) {
$self->{CONFIG}->{HANDLERS}->{'default'}->($self, $event);
}
} else {
#Someone is waiting on this packet, don't bother buffering
if (exists $self->{CALLBACKS}->{'EVENT'}) {
$self->{CALLBACKS}->{'EVENT'}->{'cb'}->($event);
delete $self->{CALLBACKS}->{'EVENT'};
#Save for later
} else {
push(@{$self->{EVENTBUFFER}}, $event);
}
}
return 1;
}
#This is used to provide blocking behavior for calls It installs callbacks for an action if it is not in the buffer
#and waits for the response before returning it.
sub _wait_response {
my ($self, $id, $timeout) = @_;
#Already got it?
if ($self->{RESPONSEBUFFER}->{$id}->{'COMPLETED'}) {
my $resp = $self->{RESPONSEBUFFER}->{$id};
delete $self->{RESPONSEBUFFER}->{$id};
delete $self->{CALLBACKS}->{$id};
delete $self->{EXPECTED}->{$id};
return $resp;
}
#Don't Have it, wait for it Install some handlers and use a CV to simulate blocking
my $process = AE::cv;
$self->{CALLBACKS}->{$id}->{'cb'} = sub { $process->send($_[1]) };
$timeout = $self->{CONFIG}->{TIMEOUT} unless (defined $timeout);
#Should not need to weaken here because this is a blocking call Only outcomes can be error, timeout, or
#complete, all of which will finish the cb and clear the reference weaken($self)
if ($timeout) {
$self->{CALLBACKS}->{$id}->{'timeout'} = sub {
my $response = $self->{'RESPONSEBUFFER'}->{$id};
delete $self->{RESPONSEBUFFER}->{$id};
delete $self->{CALLBACKS}->{$id};
delete $self->{EXPECTED}->{$id};
$process->send($response);
};
#Make sure event loop is up to date in case of sleeps
AE::now_update;
$self->{CALLBACKS}->{$id}->{'timer'} = AE::timer $timeout, 0, $self->{CALLBACKS}->{$id}->{'timeout'};
}
return $process->recv;
}
sub _build_action {
my ($actionhash, $id) = @_;
my $action;
my $async;
my $callback;
my $timeout;
#Create an action out of a hash
while (my ($key, $value) = each(%{$actionhash})) {
my $lkey = lc($key);
#Callbacks
if ($key eq 'CALLBACK') {
carp "Use of the CALLBACK key in an action is deprecated and will be removed in a future release.\n",
"Please use the syntax that is available." if warnings::enabled('Asterisk::AMI');
$callback = $actionhash->{$key} unless (defined $callback);
next;
lib/Asterisk/AMI.pm view on Meta::CPAN
} else {
$self->_on_connect_err("Login Failed to Asterisk due to timeout at $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}");
}
return;
}
return;
}
#Blocking Login
sub _login_block {
my ($self, $action, $challenge, $timeout) = @_;
my $resp;
#If a challenge exists do handle it first before the login
if (%{$challenge}) {
#Get challenge response
my $chresp = $self->action($challenge,$timeout);
if ($chresp->{'GOOD'}) {
$action->{'Key'} = $self->_md5_resp($chresp->{'PARSED'}->{'Challenge'}, $self->{CONFIG}->{SECRET});
$action->{'AuthType'} = $self->{CONFIG}->{AUTHTYPE};
#Login
$resp = $self->action($action, $timeout);
} else {
#Challenge Failed
if ($chresp->{'COMPLETED'}) {
$self->_on_connect_err("$self->{CONFIG}->{AUTHTYPE} challenge failed");
} else {
$self->_on_connect_err("Timed out waiting for challenge");
}
return;
}
} else {
#Plaintext login
$resp = $self->action($action, $timeout);
}
return $self->_logged_in($resp);
}
#Non-blocking login
sub _login_noblock {
my ($self, $action, $challenge, $timeout) = @_;
#Weaken ref for use in anonsub
weaken($self);
#Callback for login action
my $login_cb = sub { $self->_logged_in($_[1]) };
#Do a md5 challenge
if (%{$challenge}) {
#Create callbacks for the challenge
my $challenge_cb = sub {
if ($_[1]->{'GOOD'}) {
my $md5 = Digest::MD5->new();
$md5->add($_[1]->{'PARSED'}->{'Challenge'});
$md5->add($self->{CONFIG}->{SECRET});
$md5 = $md5->hexdigest;
$action->{'Key'} = $md5;
$action->{'AuthType'} = $self->{CONFIG}->{AUTHTYPE};
$self->send_action($action, $login_cb, $timeout);
} else {
if ($_[1]->{'COMPLETED'}) {
$self->_on_connect_err("$self->{CONFIG}->{AUTHTYPE} challenge failed");
} else {
$self->_on_connect_err("Timed out waiting for challenge");
}
return;
}
};
#Send challenge
$self->send_action($challenge, $challenge_cb, $timeout);
} else {
#Plaintext login
$self->send_action($action, $login_cb, $timeout);
}
return 1;
}
#Disconnect from the AMI If logged in will first issue a logoff
sub disconnect {
my ($self) = @_;
$self->destroy();
#No socket? No Problem.
return 1;
}
#Pops the topmost event out of the buffer and returns it Events are hash references
sub get_event {
my ($self, $timeout) = @_;
#my $timeout = $_[1];
$timeout = $self->{CONFIG}->{TIMEOUT} unless (defined $timeout);
unless (defined $self->{EVENTBUFFER}->[0]) {
my $process = AE::cv;
$self->{CALLBACKS}->{'EVENT'}->{'cb'} = sub { $process->send($_[0]) };
$self->{CALLBACKS}->{'EVENT'}->{'timeout'} = sub { warnings::warnif('Asterisk::AMI', "Timed out waiting for event"); $process->send(undef); };
$timeout = $self->{CONFIG}->{TIMEOUT} unless (defined $timeout);
if ($timeout) {
#Make sure event loop is up to date in case of sleeps
AE::now_update;
$self->{CALLBACKS}->{'EVENT'}->{'timer'} = AE::timer $timeout, 0, $self->{CALLBACKS}->{'EVENT'}->{'timeout'};
}
return $process->recv;
}
return shift @{$self->{EVENTBUFFER}};
}
#Returns server AMI version
sub amiver {
my ($self) = @_;
return $self->{AMIVER};
}
#Checks the connection, returns 1 if the connection is good
sub connected {
my ($self, $timeout) = @_;
if ($self && $self->simple_action({ Action => 'Ping'}, $timeout)) {
return 1;
}
return 0;
}
#Check whether there was an error on the socket
sub error {
my ($self) = @_;
return $self->{SOCKERR};
}
#Sends a keep alive
sub _send_keepalive {
my ($self) = @_;
#Weaken ref for use in anonysub
weaken($self);
my $cb = sub {
unless ($_[1]->{'GOOD'}) {
$self->_on_timeout("Asterisk failed to respond to keepalive - $self->{CONFIG}->{PEERADDR}:$self->{CONFIG}->{PEERPORT}");
};
};
my $timeout = $self->{CONFIG}->{TIMEOUT} || 5;
return $self->send_action({ Action => 'Ping' }, $cb, $timeout);
}
#Calls all callbacks as if they had timed out Used when an error has occured on the socket
sub _clear_cbs {
my ($self) = @_;
foreach my $id (keys %{$self->{CALLBACKS}}) {
my $response = $self->{RESPONSEBUFFER}->{$id};
my $callback = $self->{CALLBACKS}->{$id}->{'cb'};
my $store = $self->{CALLBACKS}->{$id}->{'store'};
delete $self->{RESPONSEBUFFER}->{$id};
delete $self->{CALLBACKS}->{$id};
delete $self->{EXPECTED}->{$id};
$callback->($self, $response, $store);
}
return 1;
}
#Cleans up
sub destroy {
my ($self) = @_;
$self->DESTROY;
bless $self, "Asterisk::AMI::destroyed";
return 1;
}
#Run event loop via anyevent
sub loop {
$_[0]->{tmp_loop} = AnyEvent->condvar;
my $exit = $_[0]->{tmp_loop}->recv;
delete $_[0]->{tmp_loop};
return $exit;
}
#Ends exits loops
sub break {
if (defined $_[0]->{tmp_loop}) {
$_[0]->{tmp_loop}->send(1);
}
}
#Bye bye
sub DESTROY {
my ($self) = @_;
#Logoff if we are not in error
if (!$self->{SOCKERR} && $self->{LOGGEDIN}) {
$self->send_action({ Action => 'Logoff' });
undef $self->{LOGGEDIN};
}
#Destroy our handle first to cause it to flush
if ($self->{handle}) {
$self->{handle}->destroy();
}
#Do our own flushing
$self->_clear_cbs();
( run in 0.669 second using v1.01-cache-2.11-cpan-ceb78f64989 )