astproxy/lib/plugins_command_13/listSipPeers.js

Node.js proxy for Asterisk PBX

/**
 * @submodule plugins_command_13
 */
var action = require('../action');

/**
 * The module identifier used by the logger.
 *
 * @property IDLOG
 * @type string
 * @private
 * @final
 * @readOnly
 * @default [listSipPeers]
 */
var IDLOG = '[listSipPeers]';

(function () {
  /**
   * The logger. It must have at least three methods: _info, warn and error._
   *
   * @property logger
   * @type object
   * @private
   * @default console
   */
  var logger = console;

  try {
    /**
     * Map associations between ActionID and callback to execute at the end
     * of the command.
     *
     * @property map
     * @type {object}
     * @private
     */
    var map = {};

    /**
     * List of all sip extension numbers.
     *
     * @property list
     * @type {array}
     * @private
     */
    var list = [];

    /**
     * Command plugin to get the list of all SIP peers.
     *
     * Use it with _astproxy_ module as follow:
     *
     *     astproxy.doCmd({ command: 'listSipPeers' }, function (res) {
     *         // some code
     *     });
     *
     *
     * @class listSipPeers
     * @static
     */
    var listSipPeers = {

      /**
       * Execute asterisk action to get the list of all SIP peers.
       * 
       * @method execute
       * @param {object} am Asterisk manager used to send the action
       * @param {object} args The object containing optional parameters
       * @param {function} cb The callback function
       * @static
       */
      execute: function (am, args, cb) {
        try {
          // action for asterisk
          var act = {
            Action: 'SIPpeers'
          };

          // set the action identifier
          act.ActionID = action.getActionId('listSipPeers');

          // add association ActionID-callback
          map[act.ActionID] = cb;

          // send action to asterisk
          am.send(act);

        } catch (err) {
          logger.error(IDLOG, err.stack);
        }
      },

      /**
       * It's called from _astproxy_ component for each data received
       * from asterisk and relative to this command.
       *
       * @method data
       * @param {object} data The asterisk data for the current command.
       * @static
       */
      data: function (data) {
        try {
          // store new extension information object
          // data.objectname is the extension number, e.g., 214
          if (data && data.event === 'PeerEntry' && data.objectname && data.channeltype) {
            list.push({
              ext: data.objectname,
              ip: data.ipaddress === '-none-' ? '' : data.ipaddress,
              port: data.ipport === '0' ? '' : data.ipport
            });

          } else if (map[data.actionid] && data && data.event === 'PeerlistComplete') {
            map[data.actionid](null, list); // callback execution
          }

          if (data && data.event === 'PeerlistComplete') {
            list = []; // empties the list
            delete map[data.actionid]; // remove association ActionID-callback
          }

        } catch (err) {
          logger.error(IDLOG, err.stack);
          if (map[data.actionid]) {
            map[data.actionid](err);
            delete map[data.actionid];
          }
        }
      },

      /**
       * Set the logger to be used.
       *
       * @method setLogger
       * @param {object} log The logger object. It must have at least
       * three methods: _info, warn and error_
       * @static
       */
      setLogger: function (log) {
        try {
          if (typeof log === 'object' &&
            typeof log.info === 'function' &&
            typeof log.warn === 'function' &&
            typeof log.error === 'function') {

            logger = log;
          } else {
            throw new Error('wrong logger object');
          }
        } catch (err) {
          logger.error(IDLOG, err.stack);
        }
      }
    };

    // public interface
    exports.data = listSipPeers.data;
    exports.execute = listSipPeers.execute;
    exports.setLogger = listSipPeers.setLogger;

  } catch (err) {
    logger.error(IDLOG, err.stack);
  }
})();