kakserpom / phpdaemon

PHPDaemon/Clients/Asterisk/Connection.php

<?php
namespace PHPDaemon\Clients\Asterisk;

use PHPDaemon\Core\CallbackWrapper;
use PHPDaemon\Core\Daemon;
use PHPDaemon\Network\ClientConnection;
use PHPDaemon\Structures\StackCallbacks;

/**
 * Asterisk Call Manager Connection
 */
class Connection extends ClientConnection
{
    /**
     * @TODO DESCR
     */
    const CONN_STATE_START = 0;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_GOT_INITIAL_PACKET = 0.1;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_AUTH = 1;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_LOGIN_PACKET_SENT = 1.1;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_CHALLENGE_PACKET_SENT = 1.2;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_LOGIN_PACKET_SENT_AFTER_CHALLENGE = 1.3;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_HANDSHAKED_OK = 2.1;

    /**
     * @TODO DESCR
     */
    const CONN_STATE_HANDSHAKED_ERROR = 2.2;

    /**
     * @TODO DESCR
     */
    const INPUT_STATE_START = 0;

    /**
     * @TODO DESCR
     */
    const INPUT_STATE_END_OF_PACKET = 1;

    /**
     * @TODO DESCR
     */
    const INPUT_STATE_PROCESSING = 2;

    /**
     * @var string EOL
     */
    public $EOL = "\r\n";

    /**
     * @var string The username to access the interface
     */
    public $username;

    /**
     * @var string The password defined in manager interface of server
     */
    public $secret;

    /**
     * @var float Connection's state
     */
    public $state = self::CONN_STATE_START;

    /**
     * @var integer Input state
     */
    public $instate = self::INPUT_STATE_START;

    /**
     * @var array Received packets
     */
    public $packets = [];

    /**
     * @var integer For composite response on action
     */
    public $cnt = 0;

    /**
     * @var array Stack of callbacks called when response received
     */
    public $callbacks = [];

    /**
     * Assertions for callbacks.
     * Assertion: if more events may follow as response this is a main part or full
     * an action complete event indicating that all data has been sent
     * @var array
     */
    public $assertions = [];

    /**
     * @var callable Callback. Called when received response on challenge action
     */
    public $onChallenge;

    /**
     * Execute the given callback when/if the connection is handshaked
     * @param  callable Callback
     * @return void
     */
    public function onConnected($cb)

This method seems to be duplicated in your project.

    {
        if ($this->state === self::CONN_STATE_HANDSHAKED_ERROR) {
            $cb($this);
        } elseif ($this->state === self::CONN_STATE_HANDSHAKED_OK) {
            $cb($this);
        } else {
            if (!$this->onConnected) {
                $this->onConnected = new StackCallbacks();
            }

            $this->onConnected->push($cb);
        }
    }

    /**
     * Called when the connection is handshaked (at low-level), and peer is ready to recv. data
     * @return void
     */
    public function onReady()
    {
        if ($this->url === null) {
            return;
        }

        if ($this->connected && !$this->busy) {
            $this->pool->servConnFree[$this->url]->attach($this);
        }

        $url = parse_url($this->url);

        $this->username = $url['user'];
        $this->secret = $url['pass'];
    }

    /**
     * Called when the worker is going to shutdown
     * @return boolean Ready to shutdown?
     */
    public function gracefulShutdown()
    {
        if ($this->finished) {
            return !$this->writing;
        }

        $this->logoff();

        $this->finish();

        return false;
    }

    /**
     * Called when session finishes
     * @return void
     */
    public function onFinish()
    {
        $this->state = self::CONN_STATE_START;

The property $state was declared of type double, but self::CONN_STATE_START is of type integer. Maybe add a type cast?

        parent::onFinish();

        $this->event('disconnect');
    }

    /**
     * Called when new data received
     * @return void
     */
    public function onRead()
    {
        if ($this->state === self::CONN_STATE_START) {
            if (($ver = $this->readline()) === null) {
                return;
            }
            $this->pool->setAmiVersion($this->addr, $ver);
            $this->state = self::CONN_STATE_GOT_INITIAL_PACKET;
            $this->auth();
        }

        while (($line = $this->readline()) !== null) {
            //Daemon::log('>>> '.$line);
            if ($line === '') {
                $this->instate = self::INPUT_STATE_END_OF_PACKET;
                $packet =& $this->packets[$this->cnt];
                ++$this->cnt;
            } else {
                $this->instate = self::INPUT_STATE_PROCESSING;
                list($header, $value) = Pool::extract($line);
                $this->packets[$this->cnt][$header] = $value;
            }

            if ((int)$this->state === self::CONN_STATE_AUTH) {
                if ($this->instate === self::INPUT_STATE_END_OF_PACKET) {
                    if ($packet['response'] === 'success') {
                        if ($this->state === self::CONN_STATE_CHALLENGE_PACKET_SENT) {
                            if (is_callable($this->onChallenge)) {
                                $func = $this->onChallenge;
                                $func($this, $packet['challenge']);

The variable $packet does not seem to be defined for all execution paths leading up to this point.

                            }
                        } else {

This code seems to be duplicated across your project.

                            if ($packet['message'] === 'authentication accepted') {
                                $this->state = self::CONN_STATE_HANDSHAKED_OK;

                                Daemon::$process->log(
                                    __METHOD__ . ': Authentication ok. Connected to ' .
                                    parse_url($this->addr, PHP_URL_HOST)
                                );

                                if ($this->onConnected) {
                                    $this->connected = true;
                                    $this->onConnected->executeAll($this);
                                    $this->onConnected = null;
                                }

                                $this->event('connected');
                            }
                        }
                    } else {

This code seems to be duplicated across your project.

                        $this->state = self::CONN_STATE_HANDSHAKED_ERROR;

                        Daemon::$process->log(
                            __METHOD__ . ': Authentication failed. Connection to ' .
                            parse_url($this->addr, PHP_URL_HOST) . ' failed.'
                        );

                        if ($this->onConnected) {
                            $this->connected = false;
                            $this->onConnected->executeAll($this);
                            $this->onConnected = null;
                        }

                        $this->finish();
                    }

                    $this->packets = [];
                }
            } elseif ($this->state === self::CONN_STATE_HANDSHAKED_OK) {
                if ($this->instate === self::INPUT_STATE_END_OF_PACKET) {
                    // Event
                    if (isset($packet['event']) && !isset($packet['actionid'])) {
                        $this->event('event_' . $packet['event'], $packet);
                        $this->event('event', $packet);
                    } // Response
                    elseif (isset($packet['actionid'])) {
                        $action_id =& $packet['actionid'];

                        if (isset($this->callbacks[$action_id])) {
                            if (isset($this->assertions[$action_id])) {
                                $this->packets[$action_id][] = $packet;

                                $assertations = count(
                                    array_uintersect_uassoc(
                                        $this->assertions[$action_id],
                                        $packet,
                                        'strcasecmp',
                                        'strcasecmp'
                                    )
                                );
                                if ($assertations === count($this->assertions[$action_id])) {
                                    if (is_callable($this->callbacks[$action_id])) {
                                        $this->callbacks[$action_id]($this, $this->packets[$action_id]);
                                        unset($this->callbacks[$action_id]);
                                    }

                                    unset($this->assertions[$action_id]);
                                    unset($this->packets[$action_id]);
                                }
                            } else {
                                if (is_callable($this->callbacks[$action_id])) {
                                    $this->callbacks[$action_id]($this, $packet);
                                    unset($this->callbacks[$action_id]);
                                }
                            }
                        }
                    }

                    unset($packet);
                    unset($this->packets[$this->cnt - 1]);
                }
            }
        }
    }

    /**
     * Send authentication packet
     * @return void
     */
    protected function auth()
    {
        if ($this->state !== self::CONN_STATE_GOT_INITIAL_PACKET) {
            return;
        }

        if ($this->pool->config->authtype->value === 'md5') {
            $this->challenge(function ($conn, $challenge) {
                $packet = "Action: Login\r\n"
                    . "AuthType: MD5\r\n"
                    . "Username: " . $this->username . "\r\n"
                    . "Key: " . md5($challenge . $this->secret) . "\r\n"
                    . "Events: on\r\n"
                    . "\r\n";
                $this->state = self::CONN_STATE_LOGIN_PACKET_SENT_AFTER_CHALLENGE;
                $conn->write($packet);
            });
        } else {
            $this->login();
        }
    }

    /**
     * Action: Login
     * Synopsis: Login Manager
     * Privilege: <none>
     *
     * @return void
     */
    protected function login()
    {
        $this->state = self::CONN_STATE_LOGIN_PACKET_SENT;
        $this->write(
            "Action: login\r\n"
            . "Username: " . $this->username . "\r\n"
            . "Secret: " . $this->secret . "\r\n"
            . "Events: on\r\n"
            . "\r\n"
        );
    }

    /**
     * Action: Challenge
     * Synopsis: Generate Challenge for MD5 Auth
     * Privilege: <none>
     *
     * @param  callable $cb
     * @return void
     */
    protected function challenge($cb)
    {
        $this->onChallenge = $cb;
        $this->state = self::CONN_STATE_CHALLENGE_PACKET_SENT;
        $this->write(
            "Action: Challenge\r\n"
            . "AuthType: MD5\r\n"
            . "\r\n"
        );
    }

    /**
     * Action: SIPpeers
     * Synopsis: List SIP peers (text format)
     * Privilege: system,reporting,all
     * Description: Lists SIP peers in text format with details on current status.
     * Peerlist will follow as separate events, followed by a final event called
     * PeerlistComplete.
     * Variables:
     * ActionID: <id>    Action ID for this transaction. Will be returned.
     *
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function getSipPeers($cb)
    {
        $this->command("Action: SIPpeers\r\n", $cb, ['event' => 'peerlistcomplete']);
    }

    /**
     * Action: IAXpeerlist
     * Synopsis: List IAX Peers
     * Privilege: system,reporting,all
     *
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function getIaxPeers($cb)
    {
        $this->command("Action: IAXpeerlist\r\n", $cb, ['event' => 'peerlistcomplete']);
    }

    /**
     * Action: GetConfig
     * Synopsis: Retrieve configuration
     * Privilege: system,config,all
     * Description: A 'GetConfig' action will dump the contents of a configuration
     * file by category and contents or optionally by specified category only.
     * Variables: (Names marked with * are required)
     *   *Filename: Configuration filename (e.g. foo.conf)
     *   Category: Category in configuration file
     *
     * @param  string $filename Filename
     * @param  callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function getConfig($filename, $cb)
    {
        $this->command("Action: GetConfig\r\nFilename: " . trim($filename) . "\r\n", $cb);
    }

    /**
     * Action: GetConfigJSON
     * Synopsis: Retrieve configuration
     * Privilege: system,config,all
     * Description: A 'GetConfigJSON' action will dump the contents of a configuration
     * file by category and contents in JSON format.  This only makes sense to be used
     * using rawman over the HTTP interface.
     * Variables:
     *    Filename: Configuration filename (e.g. foo.conf)
     *
     * @param  string $filename Filename
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function getConfigJSON($filename, $cb)
    {
        $this->command("Action: GetConfigJSON\r\nFilename: " . trim($filename) . "\r\n", $cb);
    }

    /**
     * Action: Setvar
     * Synopsis: Set Channel Variable
     * Privilege: call,all
     * Description: Set a global or local channel variable.
     * Variables: (Names marked with * are required)
     * Channel: Channel to set variable for
     *  *Variable: Variable name
     *  *Value: Value
     *
     * @param string $channel
     * @param string $variable
     * @param string $value
     * @param callable $cb
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function setVar($channel, $variable, $value, $cb)
    {
        $cmd = "Action: SetVar\r\n";

        if ($channel) {
            $cmd .= "Channel: " . trim($channel) . "\r\n";
        }

        if (isset($variable, $value)) {
            $cmd .= "Variable: " . trim($variable) . "\r\n"
                . "Value: " . trim($value) . "\r\n";

            $this->command($cmd, $cb);
        }
    }

    /**
     * Action: CoreShowChannels
     * Synopsis: List currently active channels
     * Privilege: system,reporting,all
     * Description: List currently defined channels and some information
     *        about them.
     * Variables:
     *        ActionID: Optional Action id for message matching.
     *
     * @param callable $cb
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function coreShowChannels($cb)
    {
        $this->command(
            "Action: CoreShowChannels\r\n",
            $cb,
            ['event' => 'coreshowchannelscomplete', 'eventlist' => 'complete']
        );
    }

    /**
     * Action: Status
     * Synopsis: Lists channel status
     * Privilege: system,call,reporting,all
     * Description: Lists channel status along with requested channel vars.
     * Variables: (Names marked with * are required)
     *Channel: Name of the channel to query for status
     *    Variables: Comma ',' separated list of variables to include
     * ActionID: Optional ID for this transaction
     * Will return the status information of each channel along with the
     * value for the specified channel variables.
     *
     * @param  callable $cb
     * @param  string $channel

Should the type for parameter $channel not be string|null?

     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function status($cb, $channel = null)
    {
        $cmd = "Action: Status\r\n";

        if ($channel !== null) {
            $cmd .= 'Channel: ' . trim($channel) . "\r\n";
        }

        $this->command($cmd, $cb, ['event' => 'statuscomplete']);
    }

    /**
     * Action: Redirect
     * Synopsis: Redirect (transfer) a call
     * Privilege: call,all
     * Description: Redirect (transfer) a call.
     * Variables: (Names marked with * are required)
     * *Channel: Channel to redirect
     *  ExtraChannel: Second call leg to transfer (optional)
     * *Exten: Extension to transfer to
     * *Context: Context to transfer to
     * *Priority: Priority to transfer to
     * ActionID: Optional Action id for message matching.
     *
     * @param array $params
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function redirect(array $params, $cb)
    {
        $this->command("Action: Redirect\r\n" . $this->implodeParams($params), $cb);
    }

    /**
     * Action: Originate
     * Synopsis: Originate a call
     * Privilege: call,all
     * Description: first the Channel is rung. Then, when that answers, the Extension is dialled within the Context
     *  to initiate the other end of the call.
     * Variables: (Names marked with * are required)
     * *Channel: Channel on which to originate the call (The same as you specify in the Dial application command)
     * *Context: Context to use on connect (must use Exten & Priority with it)
     * *Exten: Extension to use on connect (must use Context & Priority with it)
     * *Priority: Priority to use on connect (must use Context & Exten with it)
     * Timeout: Timeout (in milliseconds) for the originating connection to happen(defaults to 30000 milliseconds)
     * *CallerID: CallerID to use for the call
     * Variable: Channels variables to set (max 32). Variables will be set for both channels (local and connected).
     * Account: Account code for the call
     * Application: Application to use on connect (use Data for parameters)
     * Data : Data if Application parameter is used
     * ActionID: Optional Action id for message matching.
     *
     * @param array $params
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function originate(array $params, $cb)
    {
        $params['Async'] = 1;

        $this->command("Action: Originate\r\n" . $this->implodeParams($params), $cb);
    }

    /**
     * Action: ExtensionState
     * Synopsis: Get an extension's state.
     * Description: function can be used to retrieve the state from any    hinted extension.
     * Variables: (Names marked with * are required)
     * *Exten: Extension to get state
     * Context: Context for exten
     * ActionID: Optional Action id for message matching.
     *
     * @param array $params
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function extensionState(array $params, $cb)
    {
        $this->command("Action: ExtensionState\r\n" . $this->implodeParams($params), $cb);
    }

    /**
     * Action: Ping
     * Description: A 'Ping' action will ellicit a 'Pong' response.  Used to keep the
     *   manager connection open.
     * Variables: NONE
     *
     * @param callable $cb Callback called when response received
     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function ping($cb)
    {
        $this->command("Action: Ping\r\n", $cb);
    }

    /**
     * For almost any actions in Action: ListCommands
     * Privilege: depends on $action
     *
     * @param string $action Action
     * @param callable $cb Callback called when response received
     * @param array $params Parameters

Should the type for parameter $params not be null|array?

     * @param array $assertion If more events may follow as response this is a main part or full an action complete event indicating that all data has been sent

Should the type for parameter $assertion not be null|array?

     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function action($action, $cb, array $params = null, array $assertion = null)
    {
        $action = trim($action);

        $this->command("Action: {$action}\r\n" . ($params ? $this->implodeParams($params) : ''), $cb, $assertion);
    }

    /**
     * Action: Logoff
     * Synopsis: Logoff Manager
     * Privilege: <none>
     * Description: Logoff this manager session
     * Variables: NONE
     *
     * @param callable $cb Optional callback called when response received

Should the type for parameter $cb not be callable|null?

     * @callback $cb ( Connection $conn, array $packet )
     * @return void
     */
    public function logoff($cb = null)
    {
        $this->command("Action: Logoff\r\n", $cb);

It seems like $cb defined by parameter $cb on line 648 can also be of type null; however, PHPDaemon\Clients\Asterisk\Connection::command() does only seem to accept callable, maybe add an additional type check?

    }

    /**
     * Called when event occured
     * @deprecated Replaced with ->bind('event', ...)
     * @param callable $cb Callback
     * @return void
     */
    public function onEvent($cb)
    {
        $this->bind('event', $cb);
    }

    /**
     * Sends arbitrary command
     * @param string $packet A packet for sending by the connected client to Asterisk
     * @param callable $cb Callback called when response received
     * @param array $assertion If more events may follow as response this is a main part or full an action complete event indicating that all data has been sent

Should the type for parameter $assertion not be array|null?

     */
    protected function command($packet, $cb, $assertion = null)
    {
        if ($this->finished) {
            throw new ConnectionFinished;
        }

        if ($this->state !== self::CONN_STATE_HANDSHAKED_OK) {
            return;
        }

        $actionId = Daemon::uniqid();

        if (!is_callable($cb, true)) {
            $cb = false;
        }

        $this->callbacks[$actionId] = CallbackWrapper::wrap($cb);

It seems like $cb defined by false on line 683 can also be of type false; however, PHPDaemon\Core\CallbackWrapper::wrap() does only seem to accept callable, did you maybe forget to handle an error condition?

        if ($assertion !== null) {
            $this->assertions[$actionId] = $assertion;
        }

        $this->write($packet);
        $this->write('ActionID: ' . $actionId . "\r\n\r\n");
    }

    /**
     * Generate AMI packet string from associative array provided
     * @param  array $params
     * @return string
     */
    protected function implodeParams(array $params)
    {
        $s = '';

        foreach ($params as $header => $value) {
            $s .= trim($header) . ": " . trim($value) . "\r\n";
        }

        return $s;
    }
}