@nethesis/astproxy/lib/plugins_command_13/dndSet.js

Node.js proxy for Asterisk PBX

/**
 * @module astproxy
 * @submodule plugins_command_13
 */
var action = require("../action");

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

(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 = {};

    /**
     * Command plugin to set the DND status of an extension. This command doesn't generates any
     * asterisk events, so it's better to use the _setDnd_ method of the _astproxy_ component
     * that simulate it.
     *
     * Use it with _astproxy_ module as follow:
     *
     *     astproxy.doCmd({ command: 'dndSet', exten: '214', activate: true }, function (res) {
     *         // some code
     *     });
     *
     *
     * @class dndSet
     * @static
     */
    var dndSet = {
      /**
       * Execute asterisk action to set the DND status.
       *
       * @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 {
          var act;
          // action for asterisk
          if (args.activate) {
            act = {
              Action: "DBPut",
              Family: "DND",
              Key: args.exten,
              Val: "YES",
            };
          } else {
            act = {
              Action: "DBDel",
              Family: "DND",
              Key: args.exten,
            };
          }

          // set the action identifier
          act.ActionID = action.getActionId("dndSet");

          // 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 {
          // check callback and info presence and execute it
          if (
            map[data.actionid] &&
            (data.message === "Updated database successfully" ||
              data.message === "Key deleted successfully") &&
            data.response === "Success"
          ) {
            map[data.actionid](null);
            delete map[data.actionid]; // remove association ActionID-callback
          } else if (map[data.actionid] && data.response === "Error") {
            map[data.actionid](new Error(data.message || "unknown error"));
            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 = dndSet.data;
    exports.execute = dndSet.execute;
    exports.setLogger = dndSet.setLogger;
  } catch (err) {
    logger.error(IDLOG, err.stack);
  }
})();