Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:00:56 2007

Asterisk developer's documentation :: Codename Pineapple

---

sip3_cliami.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 1999 - 2007, Digium, Inc.
 * and Edvina AB, Sollentuna, Sweden (chan_sip3 changes/additions)
 *
 * Mark Spencer <markster@digium.com>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk 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 GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*!
 * \file
 * \brief SIP CLI and manager commands
 * Version 3 of chan_sip
 *
 * \author Mark Spencer <markster@digium.com>
 * \author Olle E. Johansson <oej@edvina.net> (all the chan_sip3 changes)
 *
 * See Also:
 * \arg \ref AstCREDITS
 *
 */

#include "asterisk.h"

ASTERISK_FILE_VERSION(__FILE__, "$Revision: 53128 $")

#include <stdio.h>
#include <ctype.h>
#include <string.h>
#include <unistd.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <net/if.h>
#include <errno.h>
#include <stdlib.h>
#include <fcntl.h>
#include <netdb.h>
#include <signal.h>
#include <sys/signal.h>
#include <netinet/in.h>
#include <netinet/in_systm.h>
#include <arpa/inet.h>
#include <netinet/ip.h>
#include <regex.h>

#include "asterisk/cli.h"
#include "asterisk/lock.h"
#include "asterisk/channel.h"
#include "asterisk/config.h"
#include "asterisk/logger.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/options.h"
#include "asterisk/sched.h"
#include "asterisk/io.h"
#include "asterisk/rtp.h"
#include "asterisk/udptl.h"
#include "asterisk/acl.h"
#include "asterisk/manager.h"
#include "asterisk/callerid.h"
#include "asterisk/cli.h"
#include "asterisk/app.h"
#include "asterisk/musiconhold.h"
#include "asterisk/features.h"
//#include "asterisk/srv.h"
//#include "asterisk/astdb.h"
#include "asterisk/causes.h"
#include "asterisk/utils.h"
#include "asterisk/file.h"
#include "asterisk/astobj.h"
#include "asterisk/dnsmgr.h"
#include "asterisk/devicestate.h"
#include "asterisk/linkedlists.h"
#include "asterisk/stringfields.h"
#include "asterisk/monitor.h"
#include "asterisk/localtime.h"
#include "asterisk/abstract_jb.h"
#include "asterisk/compiler.h"
#include "sip3.h"
#include "sip3funcs.h"


/*! \brief Display SIP nat mode */
const char *sip_nat_mode(const struct sip_dialog *p)
{
   return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
}

/*! \brief Convert transfer mode to text string */
static char *transfermode2str(enum transfermodes mode)
{
   if (mode == TRANSFER_OPENFORALL)
      return "open";
   else if (mode == TRANSFER_CLOSED)
      return "closed";
   return "strict";
}

/*! \brief  Convert NAT setting to text string */
static char *nat2str(int nat)
{
   switch(nat) {
   case SIP_NAT_NEVER:
      return "No";
   case SIP_NAT_ROUTE:
      return "Route";
   case SIP_NAT_ALWAYS:
      return "Always";
   case SIP_NAT_RFC3581:
      return "RFC3581";
   default:
      return "Unknown";
   }
}

/*! \brief Convert DTMF mode to printable string */
static const char *dtmfmode2str(int mode)
{
   switch (mode) {
   case SIP_DTMF_RFC2833:
      return "rfc2833";
   case SIP_DTMF_INFO:
      return "info";
   case SIP_DTMF_INBAND:
      return "inband";
   case SIP_DTMF_AUTO:
      return "auto";
   }
   return "<error>";
}

/*! \brief Convert Insecure setting to printable string */
static const char *insecure2str(int port, int invite)
{
   if (port && invite)
      return "port,invite";
   else if (port)
      return "port";
   else if (invite)
      return "invite";
   else
      return "no";
}

/*! \brief Print codec list from preference to CLI/manager */
static void print_codec_to_cli(int fd, struct ast_codec_pref *pref)
{
   int x, codec;

   for(x = 0; x < 32 ; x++) {
      codec = ast_codec_pref_index(pref, x);
      if (!codec)
         break;
      ast_cli(fd, "%s", ast_getformatname(codec));
      ast_cli(fd, ":%d", pref->framing[x]);
      if (x < 31 && ast_codec_pref_index(pref, x + 1))
         ast_cli(fd, ",");
   }
   if (!x)
      ast_cli(fd, "none");
}

/*! \brief Print call group and pickup group */
void  print_group(int fd, ast_group_t group, int crlf)
{
   char buf[256];
   ast_cli(fd, crlf ? "%s\r\n" : "%s\n", ast_print_group(buf, sizeof(buf), group) );
}

/*! \brief  Report Device status in character string
 *  \return 0 if peer is unreachable, 1 if peer is online, -1 if unmonitored
 */
int device_status(struct sip_device *device, char *status, int statuslen)
{
   int res = 0;
   if (device->maxms) {
      if (device->lastms < 0) {
         ast_copy_string(status, "UNREACHABLE", statuslen);
      } else if (device->lastms > device->maxms) {
         snprintf(status, statuslen, "LAGGED (%d ms)", device->lastms);
         res = 1;
      } else if (device->lastms) {
         snprintf(status, statuslen, "OK (%d ms)", device->lastms);
         res = 1;
      } else {
         ast_copy_string(status, "UNKNOWN", statuslen);
      }
   } else { 
      ast_copy_string(status, "Unmonitored", statuslen);
      /* Checking if port is 0 */
      res = -1;
   }
   return res;
}

/*! \brief  CLI Command to show calls within limits set by call_limit */
static int sip_show_inuse(int fd, int argc, char *argv[])
{
#define FORMAT  "%-25.25s %-15.15s %-15.15s \n"
#define FORMAT2 "%-25.25s %-15.15s %-15.15s \n"
   char ilimits[40];
   char iused[40];
   int showall = FALSE;

   if (argc < 3) 
      return RESULT_SHOWUSAGE;

   if (argc == 4 && !strcmp(argv[3],"all")) 
         showall = TRUE;
   
   ast_cli(fd, FORMAT, "* Peer name", "In use", "Limit");

   ASTOBJ_CONTAINER_TRAVERSE(&devicelist, 1, do {
      ASTOBJ_RDLOCK(iterator);
      if (iterator->call_limit)
         snprintf(ilimits, sizeof(ilimits), "%d", iterator->call_limit);
      else 
         ast_copy_string(ilimits, "N/A", sizeof(ilimits));
      snprintf(iused, sizeof(iused), "%d/%d", iterator->inUse, iterator->inRinging);
      if (showall || iterator->call_limit)
         ast_cli(fd, FORMAT2, iterator->name, iused, ilimits);
      ASTOBJ_UNLOCK(iterator);
   } while (0) );

   return RESULT_SUCCESS;
#undef FORMAT
#undef FORMAT2
}

char mandescr_show_devices[] = 
"Description: Lists SIP peers in text format with details on current status.\n"
"Variables: \n"
"  ActionID: <id> Action ID for this transaction. Will be returned.\n";

/*! \brief  Execute sip show devices command */
static int _sip_show_devices(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[])
{
   regex_t regexbuf;
   int havepattern = FALSE;

#define FORMAT2 "%-25.25s  %-15.15s %-3.3s %-3.3s %-3.3s %-8s %-10s %-10s\n"
#define FORMAT  "%-25.25s  %-15.15s %-3.3s %-3.3s %-3.3s %-8d %-10s %-10s\n"

   char name[256];
   int total_peers = 0;
   int peers_mon_online = 0;
   int peers_mon_offline = 0;
   int peers_unmon_offline = 0;
   int peers_unmon_online = 0;
   const char *id;
   char idtext[256] = "";
   int realtimepeers;

   realtimepeers = ast_check_realtime("sippeers");

   if (s) { /* Manager - get ActionID */
      id = astman_get_header(m, "ActionID");
      if (!ast_strlen_zero(id))
         snprintf(idtext, sizeof(idtext), "ActionID: %s\r\n", id);
   }

   switch (argc) {
   case 5:
      if (!strcasecmp(argv[3], "like")) {
         if (regcomp(&regexbuf, argv[4], REG_EXTENDED | REG_NOSUB))
            return RESULT_SHOWUSAGE;
         havepattern = TRUE;
      } else
         return RESULT_SHOWUSAGE;
   case 3:
      break;
   default:
      return RESULT_SHOWUSAGE;
   }

   if (!s) /* Normal list */
      ast_cli(fd, FORMAT2, "Name", "Host", "Dyn", "Nat", "ACL", "Port", "Status", (realtimepeers ? "Realtime" : ""));
   
   ASTOBJ_CONTAINER_TRAVERSE(&devicelist, 1, do {
      char status[20] = "";
      char srch[2000];
      char pstatus;
      
      ASTOBJ_RDLOCK(iterator);

      if (havepattern && regexec(&regexbuf, iterator->name, 0, NULL, 0)) {
         ASTOBJ_UNLOCK(iterator);
         continue;
      }

      if (!ast_strlen_zero(iterator->domain) && !s)
         snprintf(name, sizeof(name), "%s@%s", iterator->name, iterator->domain);
      else
         ast_copy_string(name, iterator->name, sizeof(name));
      
      pstatus = device_status(iterator, status, sizeof(status));
      if (pstatus == 1)
         peers_mon_online++;
      else if (pstatus == 0)
         peers_mon_offline++;
      else {
         if (iterator->addr.sin_port == 0)
            peers_unmon_offline++;
         else
            peers_unmon_online++;
      }

      snprintf(srch, sizeof(srch), FORMAT, name,
         iterator->addr.sin_addr.s_addr ? ast_inet_ntoa(iterator->addr.sin_addr) : "(Unspecified)",
         ast_test_flag(&iterator->flags[1], SIP_PAGE2_DYNAMIC) ? " D " : "   ",  /* Dynamic or not? */
         ast_test_flag(&iterator->flags[0], SIP_NAT_ROUTE) ? " N " : "   ",   /* NAT=yes? */
         iterator->ha ? " A " : "   ",    /* permit/deny */
         ntohs(iterator->addr.sin_port), status,
         realtimepeers ? (ast_test_flag(&iterator->flags[0], SIP_REALTIME) ? "Cached RT":"") : "");

      if (!s)  {/* Normal CLI list */
         ast_cli(fd, FORMAT, name, 
         iterator->addr.sin_addr.s_addr ? ast_inet_ntoa(iterator->addr.sin_addr) : "(Unspecified)",
         ast_test_flag(&iterator->flags[1], SIP_PAGE2_DYNAMIC) ? " D " : "   ",  /* Dynamic or not? */
         ast_test_flag(&iterator->flags[0], SIP_NAT_ROUTE) ? " N " : "   ",   /* NAT=yes? */
         iterator->ha ? " A " : "   ",       /* permit/deny */
         
         ntohs(iterator->addr.sin_port), status,
         realtimepeers ? (ast_test_flag(&iterator->flags[0], SIP_REALTIME) ? "Cached RT":"") : "");
      } else { /* Manager format */
         /* The names here need to be the same as other channels */
         astman_append(s, 
         "Event: PeerEntry\r\n%s"
         "Channeltype: SIP\r\n"
         "ObjectName: %s\r\n"
         "ChanObjectType: peer\r\n" /* "peer" or "user" */
         "IPaddress: %s\r\n"
         "IPport: %d\r\n"
         "Dynamic: %s\r\n"
         "Natsupport: %s\r\n"
         "VideoSupport: %s\r\n"
         "ACL: %s\r\n"
         "Status: %s\r\n"
         "RealtimeDevice: %s\r\n\r\n", 
         idtext,
         iterator->name, 
         iterator->addr.sin_addr.s_addr ? ast_inet_ntoa(iterator->addr.sin_addr) : "-none-",
         ntohs(iterator->addr.sin_port), 
         ast_test_flag(&iterator->flags[1], SIP_PAGE2_DYNAMIC) ? "yes" : "no",   /* Dynamic or not? */
         ast_test_flag(&iterator->flags[0], SIP_NAT_ROUTE) ? "yes" : "no", /* NAT=yes? */
         ast_test_flag(&iterator->flags[1], SIP_PAGE2_VIDEOSUPPORT) ? "yes" : "no", /* VIDEOSUPPORT=yes? */
         iterator->ha ? "yes" : "no",       /* permit/deny */
         status,
         realtimepeers ? (ast_test_flag(&iterator->flags[0], SIP_REALTIME) ? "yes":"no") : "no");
      }

      ASTOBJ_UNLOCK(iterator);

      total_peers++;
   } while(0) );
   
   if (!s)
      ast_cli(fd, "%d sip peers [Monitored: %d online, %d offline Unmonitored: %d online, %d offline]\n",
              total_peers, peers_mon_online, peers_mon_offline, peers_unmon_online, peers_unmon_offline);

   if (havepattern)
      regfree(&regexbuf);

   if (total)
      *total = total_peers;
   

   return RESULT_SUCCESS;
#undef FORMAT
#undef FORMAT2
}

/*! \brief  Show SIP peers in the manager API */
/*    Inspired from chan_iax2 */
int manager_sip_show_devices(struct mansession *s, const struct message *m )
{
   const char *id = astman_get_header(m,"ActionID");
   const char *a[] = { "sip3", "show", "peers" };
   char idtext[256] = "";
   int total = 0;

   if (!ast_strlen_zero(id))
      snprintf(idtext, sizeof(idtext), "ActionID: %s\r\n", id);

   astman_send_ack(s, m, "Peer status list will follow");
   /* List the peers in separate manager events */
   _sip_show_devices(-1, &total, s, m, 3, a);
   /* Send final confirmation */
   astman_append(s,
   "Event: PeerlistComplete\r\n"
   "ListItems: %d\r\n"
   "%s"
   "\r\n", total, idtext);
   return 0;
}


/*! \brief  CLI Show Peers command */
static int sip_show_devices(int fd, int argc, char *argv[])
{
   return _sip_show_devices(fd, NULL, NULL, NULL, argc, (const char **) argv);
}


/*! \brief List all allocated SIP Objects (realtime or static) */
static int sip_show_objects(int fd, int argc, char *argv[])
{
   char tmp[256];
   if (argc != 3)
      return RESULT_SHOWUSAGE;
   ast_cli(fd, "-= Device objects: %d static, %d realtime, %d autocreate =-\n\n", sipcounters.static_peers, sipcounters.realtime_peers, sipcounters.autocreated_peers);
   ASTOBJ_CONTAINER_DUMP(fd, tmp, sizeof(tmp), &devicelist);
   ast_cli(fd, "-= Registry objects: %d =-\n\n", sipcounters.registry_objects);
   ast_cli(fd, "-= Dialog objects: %d =-\n\n", sipcounters.dialog_objects);
   ASTOBJ_CONTAINER_DUMP(fd, tmp, sizeof(tmp), &regl);
   return RESULT_SUCCESS;
}

static char mandescr_show_device[] = 
"Description: Show one SIP device with details on current status.\n"
"Variables: \n"
"  Peer: <name>           The peer name you want to check.\n"
"  ActionID: <id>   Optional action ID for this AMI transaction.\n";

/*! \brief Show one peer in detail (main function) */
static int _sip_show_device(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[])
{
   char status[30] = "";
   char cbuf[256];
   struct sip_device *device;
   char codec_buf[512];
   struct ast_codec_pref *pref;
   struct ast_variable *v;
   struct sip_auth *auth;
   int x = 0, codec = 0, load_realtime;
   int realtimepeers;

   realtimepeers = ast_check_realtime("sippeers");

   if (argc < 4)
      return RESULT_SHOWUSAGE;

   load_realtime = (argc == 5 && !strcmp(argv[4], "load")) ? TRUE : FALSE;
   device = find_device(argv[3], NULL, load_realtime);
   if (s) {    /* Manager */
      if (device)
         astman_append(s, "Response: Success\r\n");
      else {
         snprintf (cbuf, sizeof(cbuf), "Device %s not found.\n", argv[3]);
         astman_send_error(s, m, cbuf);
         return 0;
      }
   }
   if (device && type==0 ) { /* Normal listing */
      ast_cli(fd,"\n\n");
      if (!ast_strlen_zero(device->domain))
         ast_cli(fd, "  * Name       : %s@%s\n", device->name, device->domain);
      else
         ast_cli(fd, "  * Name       : %s <no domain>\n", device->name);
      if (realtimepeers) { /* Realtime is enabled */
         ast_cli(fd, "  Realtime device: %s\n", ast_test_flag(&device->flags[0], SIP_REALTIME) ? "Yes, cached" : "No");
      }
      ast_cli(fd, "  Secret       : %s\n", ast_strlen_zero(device->secret)?"<Not set>":"<Set>");
      ast_cli(fd, "  MD5Secret    : %s\n", ast_strlen_zero(device->md5secret)?"<Not set>":"<Set>");
      for (auth = device->auth; auth; auth = auth->next) {
         ast_cli(fd, "  Realm-auth   : Realm %-15.15s User %-10.20s ", auth->realm, auth->username);
         ast_cli(fd, "%s\n", !ast_strlen_zero(auth->secret)?"<Secret set>":(!ast_strlen_zero(auth->md5secret)?"<MD5secret set>" : "<Not set>"));
      }
      ast_cli(fd, "  Context      : %s\n", device->extra.context);
      ast_cli(fd, "  Subscr.Cont. : %s\n", S_OR(device->extra.subscribecontext, "<Not set>") );
      ast_cli(fd, "  Language     : %s\n", device->language);
      if (!ast_strlen_zero(device->extra.accountcode))
         ast_cli(fd, "  Accountcode  : %s\n", device->extra.accountcode);
      ast_cli(fd, "  AMA flags    : %s\n", ast_cdr_flags2str(device->extra.amaflags));
      ast_cli(fd, "  Transfer mode: %s\n", transfermode2str(device->allowtransfer));
      ast_cli(fd, "  CallingPres  : %s\n", ast_describe_caller_presentation(device->callingpres));
      if (!ast_strlen_zero(device->extra.fromuser))
         ast_cli(fd, "  FromUser     : %s\n", device->extra.fromuser);
      if (!ast_strlen_zero(device->extra.fromdomain))
         ast_cli(fd, "  FromDomain   : %s\n", device->extra.fromdomain);
      ast_cli(fd, "  Callgroup    : ");
      print_group(fd, device->callgroup, 0);
      ast_cli(fd, "  Pickupgroup  : ");
      print_group(fd, device->pickupgroup, 0);
      ast_cli(fd, "  Mailbox      : %s\n", device->mailbox.mailbox);
      ast_cli(fd, "  VM Extension : %s\n", device->mailbox.vmexten);
      ast_cli(fd, "  Call limit   : %d\n", device->call_limit);
      ast_cli(fd, "  Dynamic      : %s\n", (ast_test_flag(&device->flags[1], SIP_PAGE2_DYNAMIC)?"Yes":"No"));
      ast_cli(fd, "  Expire       : %ld\n", ast_sched_when(sched, device->expire));
      ast_cli(fd, "  Callerid     : %s\n", ast_callerid_merge(cbuf, sizeof(cbuf), device->extra.cid_name, device->extra.cid_num, "<unspecified>"));
      if (!ast_strlen_zero(global.regcontext))
         ast_cli(fd, "  Reg. exten   : %s\n", device->extra.regexten);
      ast_cli(fd, "  MaxCallBR    : %d kbps\n", device->maxcallbitrate);
      ast_cli(fd, "  Insecure     : %s\n", insecure2str(ast_test_flag(&device->flags[0], SIP_INSECURE_PORT), ast_test_flag(&device->flags[0], SIP_INSECURE_INVITE)));
      ast_cli(fd, "  Nat support  : %s\n", nat2str(ast_test_flag(&device->flags[0], SIP_NAT)));
      ast_cli(fd, "  CanReinvite  : %s\n", ast_test_flag(&device->flags[0], SIP_CAN_REINVITE)?"Yes":"No");
      ast_cli(fd, "  ACL          : %s\n", (device->ha?"Yes":"No"));
      ast_cli(fd, "  T38 pt UDPTL : %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_T38SUPPORT_UDPTL)?"Yes":"No");
      ast_cli(fd, "  T38 pt RTP   : %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_T38SUPPORT_RTP)?"Yes":"No");
      ast_cli(fd, "  T38 pt TCP   : %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_T38SUPPORT_TCP)?"Yes":"No");
      ast_cli(fd, "  PromiscRedir : %s\n", ast_test_flag(&device->flags[0], SIP_PROMISCREDIR)?"Yes":"No");
      ast_cli(fd, "  Video Support: %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_VIDEOSUPPORT)?"Yes":"No");
      ast_cli(fd, "  Trust RPID   : %s\n", ast_test_flag(&device->flags[0], SIP_TRUSTRPID) ? "Yes" : "No");
      ast_cli(fd, "  Send RPID    : %s\n", ast_test_flag(&device->flags[0], SIP_SENDRPID) ? "Yes" : "No");
      ast_cli(fd, "  Subscriptions: %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_ALLOWSUBSCRIBE) ? "Yes" : "No");
      ast_cli(fd, "  Overlap dial : %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_ALLOWOVERLAP) ? "Yes" : "No");

      /* - is enumerated */
      ast_cli(fd, "  DTMFmode     : %s\n", dtmfmode2str(ast_test_flag(&device->flags[0], SIP_DTMF)));
      ast_cli(fd, "  User=Phone   : %s\n", ast_test_flag(&device->flags[0], SIP_USEREQPHONE)?"Yes":"No");
      ast_cli(fd, "  ToHost       : %s\n", device->extra.tohost);
      ast_cli(fd, "  Addr->IP     : %s Port %d\n",  device->addr.sin_addr.s_addr ? ast_inet_ntoa(device->addr.sin_addr) : "(Unspecified)", ntohs(device->addr.sin_port));
      ast_cli(fd, "  Defaddr->IP  : %s Port %d\n", ast_inet_ntoa(device->defaddr.sin_addr), ntohs(device->defaddr.sin_port));
      ast_cli(fd, "  Def. Username: %s\n", device->defaultuser);
      ast_cli(fd, "  Codecs       : ");
      ast_getformatname_multiple(codec_buf, sizeof(codec_buf) -1, device->capability);
      ast_cli(fd, "%s\n", codec_buf);
      ast_cli(fd, "  Codec Order  : (");
      print_codec_to_cli(fd, &device->prefs);
      ast_cli(fd, ")\n");

      ast_cli(fd, "  LastMsgsSent : %d\n", device->mailbox.lastmsgssent);
      ast_cli(fd, "  SIP Options  : ");
      if (device->sipoptions) {
         sip_options_print(device->sipoptions, fd);
      } else
         ast_cli(fd, "(none)");
      ast_cli(fd, "\n");

      device_status(device, status, sizeof(status));
      ast_cli(fd, "  Status       : %s\n", status);
      ast_cli(fd, "  Useragent    : %s\n", device->useragent);
      ast_cli(fd, "  Reg. Contact : %s\n", device->fullcontact);
      if (device->chanvars) {
         ast_cli(fd, "  Variables    :\n");
         for (v = device->chanvars ; v ; v = v->next)
            ast_cli(fd, "                 %s = %s\n", v->name, v->value);
      }
      ast_cli(fd,"\n");
      device_unref(device);
   } else  if (device && type == 1) { /* manager listing */
      char buf[256];
      astman_append(s, "Channeltype: SIP\r\n");
      astman_append(s, "ObjectName: %s\r\n", device->name);
      astman_append(s, "SIPDomain: %s\r\n", device->domain);
      astman_append(s, "ChanObjectType: device\r\n");
      astman_append(s, "SecretExist: %s\r\n", ast_strlen_zero(device->secret)?"N":"Y");
      astman_append(s, "MD5SecretExist: %s\r\n", ast_strlen_zero(device->md5secret)?"N":"Y");
      astman_append(s, "Context: %s\r\n", device->extra.context);
      astman_append(s, "Language: %s\r\n", device->language);
      if (!ast_strlen_zero(device->extra.accountcode))
         astman_append(s, "Accountcode: %s\r\n", device->extra.accountcode);
      astman_append(s, "AMAflags: %s\r\n", ast_cdr_flags2str(device->extra.amaflags));
      astman_append(s, "CID-CallingPres: %s\r\n", ast_describe_caller_presentation(device->callingpres));
      if (!ast_strlen_zero(device->extra.fromuser))
         astman_append(s, "SIP-FromUser: %s\r\n", device->extra.fromuser);
      if (!ast_strlen_zero(device->extra.fromdomain))
         astman_append(s, "SIP-FromDomain: %s\r\n", device->extra.fromdomain);
      astman_append(s, "Callgroup: ");
      astman_append(s, "%s\r\n", ast_print_group(buf, sizeof(buf), device->callgroup));
      astman_append(s, "Pickupgroup: ");
      astman_append(s, "%s\r\n", ast_print_group(buf, sizeof(buf), device->pickupgroup));
      astman_append(s, "VoiceMailbox: %s\r\n", device->mailbox.mailbox);
      astman_append(s, "TransferMode: %s\r\n", transfermode2str(device->allowtransfer));
      astman_append(s, "LastMsgsSent: %d\r\n", device->mailbox.lastmsgssent);
      astman_append(s, "Call limit: %d\r\n", device->call_limit);
      astman_append(s, "MaxCallBR: %d kbps\r\n", device->maxcallbitrate);
      astman_append(s, "Dynamic: %s\r\n", (ast_test_flag(&device->flags[1], SIP_PAGE2_DYNAMIC)?"Y":"N"));
      astman_append(s, "Callerid: %s\r\n", ast_callerid_merge(cbuf, sizeof(cbuf), device->extra.cid_name, device->extra.cid_num, ""));
      astman_append(s, "RegExpire: %ld seconds\r\n", ast_sched_when(sched,device->expire));
      astman_append(s, "SIP-AuthInsecure: %s\r\n", insecure2str(ast_test_flag(&device->flags[0], SIP_INSECURE_PORT), ast_test_flag(&device->flags[0], SIP_INSECURE_INVITE)));
      astman_append(s, "SIP-NatSupport: %s\r\n", nat2str(ast_test_flag(&device->flags[0], SIP_NAT)));
      astman_append(s, "ACL: %s\r\n", (device->ha?"Y":"N"));
      astman_append(s, "SIP-CanReinvite: %s\r\n", (ast_test_flag(&device->flags[0], SIP_CAN_REINVITE)?"Y":"N"));
      astman_append(s, "SIP-PromiscRedir: %s\r\n", (ast_test_flag(&device->flags[0], SIP_PROMISCREDIR)?"Y":"N"));
      astman_append(s, "SIP-UserPhone: %s\r\n", (ast_test_flag(&device->flags[0], SIP_USEREQPHONE)?"Y":"N"));
      astman_append(s, "SIP-VideoSupport: %s\r\n", (ast_test_flag(&device->flags[1], SIP_PAGE2_VIDEOSUPPORT)?"Y":"N"));
      astman_append(s, "T38pt-UDPTL: %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_T38SUPPORT_UDPTL)?"Y":"N");
      astman_append(s, "T38pt-RTP: %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_T38SUPPORT_RTP)?"Y":"N");
      astman_append(s, "T38pt-TCP: %s\n", ast_test_flag(&device->flags[1], SIP_PAGE2_T38SUPPORT_TCP)?"Y":"N");

      /* - is enumerated */
      astman_append(s, "SIP-DTMFmode: %s\r\n", dtmfmode2str(ast_test_flag(&device->flags[0], SIP_DTMF)));
      astman_append(s, "ToHost: %s\r\n", device->extra.tohost);
      astman_append(s, "Address-IP: %s\r\nAddress-Port: %d\r\n",  device->addr.sin_addr.s_addr ? ast_inet_ntoa(device->addr.sin_addr) : "", ntohs(device->addr.sin_port));
      astman_append(s, "Default-addr-IP: %s\r\nDefault-addr-port: %d\r\n", ast_inet_ntoa(device->defaddr.sin_addr), ntohs(device->defaddr.sin_port));
      astman_append(s, "Default-Username: %s\r\n", device->defaultuser);
      if (!ast_strlen_zero(global.regcontext))
         astman_append(s, "RegExtension: %s\r\n", device->extra.regexten);
      astman_append(s, "Codecs: ");
      ast_getformatname_multiple(codec_buf, sizeof(codec_buf) -1, device->capability);
      astman_append(s, "%s\r\n", codec_buf);
      astman_append(s, "CodecOrder: ");
      pref = &device->prefs;
      for(x = 0; x < 32 ; x++) {
         codec = ast_codec_pref_index(pref,x);
         if (!codec)
            break;
         astman_append(s, "%s", ast_getformatname(codec));
         if (x < 31 && ast_codec_pref_index(pref,x+1))
            astman_append(s, ",");
      }

      astman_append(s, "\r\n");
      astman_append(s, "Status: ");
      device_status(device, status, sizeof(status));
      astman_append(s, "%s\r\n", status);
      astman_append(s, "SIP-Useragent: %s\r\n", device->useragent);
      astman_append(s, "Reg-Contact : %s\r\n", device->fullcontact);
      if (device->chanvars) {
         for (v = device->chanvars ; v ; v = v->next) {
            astman_append(s, "ChanVariable:\n");
            astman_append(s, " %s,%s\r\n", v->name, v->value);
         }
      }

      device_unref(device);

   } else {
      ast_cli(fd,"Device %s not found.\n", argv[3]);
      ast_cli(fd,"\n");
   }

   return RESULT_SUCCESS;
}

/*! \brief Show one peer in detail */
static int sip_show_device(int fd, int argc, const char *argv[])
{
   return _sip_show_device(0, fd, NULL, NULL, argc, argv);
}

/*! \brief Show SIP peers in the manager API  */
int manager_sip_show_device( struct mansession *s, const struct message *m)
{
   const char *id = astman_get_header(m,"ActionID");
   const char *a[4];
   const char *peer;
   int ret;

   peer = astman_get_header(m,"Peer");
   if (ast_strlen_zero(peer)) {
      astman_send_error(s, m, "Peer: <name> missing.\n");
      return 0;
   }
   a[0] = "sip3";
   a[1] = "show";
   a[2] = "peer";
   a[3] = peer;

   if (!ast_strlen_zero(id))
      astman_append(s, "ActionID: %s\r\n",id);
   ret = _sip_show_device(1, -1, s, m, 4, a );
   astman_append(s, "\r\n\r\n" );
   return ret;
}



/*! \brief  Show SIP Registry (registrations with other SIP proxies */
static int sip_show_registry(int fd, int argc, char *argv[])
{
#define FORMAT2 "%-30.30s  %-12.12s  %8.8s %-20.20s %-25.25s\n"
#define FORMAT  "%-30.30s  %-12.12s  %8d %-20.20s %-25.25s\n"
   char host[80];
   char tmpdat[256];
   struct tm tm;


   if (argc != 3)
      return RESULT_SHOWUSAGE;
   ast_cli(fd, FORMAT2, "Host", "Username", "Refresh", "State", "Reg.Time");
   ASTOBJ_CONTAINER_TRAVERSE(&regl, 1, do {
      ASTOBJ_RDLOCK(iterator);
      snprintf(host, sizeof(host), "%s:%d", iterator->hostname, iterator->portno ? iterator->portno : STANDARD_SIP_PORT);
      if (iterator->regtime) {
         ast_localtime(&iterator->regtime, &tm, NULL);
         strftime(tmpdat, sizeof(tmpdat), "%a, %d %b %Y %T", &tm);
      } else {
         tmpdat[0] = 0;
      }
      ast_cli(fd, FORMAT, host, iterator->username, iterator->refresh, regstate2str(iterator->regstate), tmpdat);
      ASTOBJ_UNLOCK(iterator);
   } while(0));
   return RESULT_SUCCESS;
#undef FORMAT
#undef FORMAT2
}

/*! \brief List global settings for the SIP channel */
static int sip_show_settings(int fd, int argc, char *argv[])
{
   int realtimepeers;
   int realtimeusers;

   realtimepeers = ast_check_realtime("sip3peers");
   realtimeusers = ast_check_realtime("sip3users");

   if (argc != 3)
      return RESULT_SHOWUSAGE;
   ast_cli(fd, "\n\nGlobal Settings:\n");
   ast_cli(fd, "----------------\n");
   ast_cli(fd, "  SIP Port:               %d\n", ntohs(sipnet.bindaddr.sin_port));
   ast_cli(fd, "  Bindaddress:            %s\n", ast_inet_ntoa(sipnet.bindaddr.sin_addr));
   ast_cli(fd, "  Videosupport:           %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_VIDEOSUPPORT) ? "Yes" : "No");
   ast_cli(fd, "  AutoCreatePeer:         %s\n", global.autocreatepeer ? "Yes" : "No");
   ast_cli(fd, "  Allow unknown access:   %s\n", global.allowguest ? "Yes" : "No");
   ast_cli(fd, "  Allow subscriptions:    %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_ALLOWSUBSCRIBE) ? "Yes" : "No");
   ast_cli(fd, "  Allow overlap dialing:  %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_ALLOWOVERLAP) ? "Yes" : "No");
   ast_cli(fd, "  Promsic. redir:         %s\n", ast_test_flag(&global.flags[0], SIP_PROMISCREDIR) ? "Yes" : "No");
   ast_cli(fd, "  SIP domain support:     %s\n", domains_configured() ? "No" : "Yes");
   ast_cli(fd, "  Call to non-local dom.: %s\n", global.allow_external_domains ? "Yes" : "No");
   ast_cli(fd, "  URI user is phone no:   %s\n", ast_test_flag(&global.flags[0], SIP_USEREQPHONE) ? "Yes" : "No");
   ast_cli(fd, "  Our auth realm          %s\n", global.realm);
   ast_cli(fd, "  Realm. auth:            %s\n", authl ? "Yes": "No");
   ast_cli(fd, "  Always auth rejects:    %s\n", global.alwaysauthreject ? "Yes" : "No");
   ast_cli(fd, "  User Agent:             %s\n", global.useragent);
   ast_cli(fd, "  MWI checking interval:  %d secs\n", global.mwitime);
   ast_cli(fd, "  Reg. context:           %s\n", S_OR(global.regcontext, "(not set)"));
   ast_cli(fd, "  Caller ID:              %s\n", global.default_callerid);
   ast_cli(fd, "  From: Domain:           %s\n", global.default_fromdomain);
   ast_cli(fd, "  Record SIP history:     %s\n", global.recordhistory ? "On" : "Off");
   ast_cli(fd, "  Call Events:            %s\n", global.callevents ? "On" : "Off");
   ast_cli(fd, "  IP ToS SIP:             %s\n", ast_tos2str(global.tos_sip));
   ast_cli(fd, "  IP ToS RTP audio:       %s\n", ast_tos2str(global.tos_audio));
   ast_cli(fd, "  IP ToS RTP video:       %s\n", ast_tos2str(global.tos_video));
   ast_cli(fd, "  IP ToS SIP presence:    %s\n", ast_tos2str(global.tos_presense));
   ast_cli(fd, "  T38 fax pt UDPTL:       %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_T38SUPPORT_UDPTL) ? "Yes" : "No");
   ast_cli(fd, "  T38 fax pt RTP:         %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_T38SUPPORT_RTP) ? "Yes" : "No");
   ast_cli(fd, "  T38 fax pt TCP:         %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_T38SUPPORT_TCP) ? "Yes" : "No");
   ast_cli(fd, "  RFC2833 Compensation:   %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_RFC2833_COMPENSATE) ? "Yes" : "No");
   ast_cli(fd, "  Jitterbuffer enabled:   %s\n", ast_test_flag(&global.jbconf, AST_JB_ENABLED) ? "Yes" : "No");
   ast_cli(fd, "  Jitterbuffer forced:    %s\n", ast_test_flag(&global.jbconf, AST_JB_FORCED) ? "Yes" : "No");
   ast_cli(fd, "  Jitterbuffer max size:  %ld\n", global.jbconf.max_size);
   ast_cli(fd, "  Jitterbuffer resync:    %ld\n", global.jbconf.resync_threshold);
   ast_cli(fd, "  Jitterbuffer impl:      %s\n", global.jbconf.impl);
   ast_cli(fd, "  Jitterbuffer log:       %s\n", ast_test_flag(&global.jbconf, AST_JB_LOG) ? "Yes" : "No");
   ast_cli(fd, "  SIP debug level:        %s\n", global.debuglevel == SIPDEBUG_ALL ? "Everything" : (global.debuglevel == SIPDEBUG_CALLS ? "Calls" : "No OPTION messages"));
   if (!realtimepeers && !realtimeusers)
      ast_cli(fd, "  SIP realtime:           Disabled\n" );
   else
      ast_cli(fd, "  SIP realtime:           Enabled\n" );

   ast_cli(fd, "\nGlobal Signalling Settings:\n");
   ast_cli(fd, "---------------------------\n");
   ast_cli(fd, "  Codecs:                 ");
   print_codec_to_cli(fd, &global.default_prefs);
   ast_cli(fd, "\n");
   ast_cli(fd, "  Relax DTMF:             %s\n", global.relaxdtmf ? "Yes" : "No");
   ast_cli(fd, "  Compact SIP headers:    %s\n", global.compactheaders ? "Yes" : "No");
   ast_cli(fd, "  RTP Keepalive:          %d %s\n", global.rtptimer.rtpkeepalive, global.rtptimer.rtpkeepalive ? "" : "(Disabled)" );
   ast_cli(fd, "  RTP Timeout:            %d %s\n", global.rtptimer.rtptimeout, global.rtptimer.rtptimeout ? "" : "(Disabled)" );
   ast_cli(fd, "  RTP Hold Timeout:       %d %s\n", global.rtptimer.rtpholdtimeout, global.rtptimer.rtpholdtimeout ? "" : "(Disabled)");
   ast_cli(fd, "  MWI NOTIFY mime type:   %s\n", global.default_notifymime);
   ast_cli(fd, "  DNS SRV lookup:         %s\n", global.srvlookup ? "Yes" : "No");
   ast_cli(fd, "  Reg. min duration       %d secs\n", expiry.min_expiry);
   ast_cli(fd, "  Reg. max duration:      %d secs\n", expiry.max_expiry);
   ast_cli(fd, "  Reg. default duration:  %d secs\n", expiry.default_expiry);
   ast_cli(fd, "  Outbound reg. timeout:  %d secs\n", global.reg_timeout);
   ast_cli(fd, "  Outbound reg. attempts: %d\n", global.regattempts_max);
   ast_cli(fd, "  Notify ringing state:   %s\n", global.notifyringing ? "Yes" : "No");
   ast_cli(fd, "  SIP Transfer mode:      %s\n", transfermode2str(global.allowtransfer));
   ast_cli(fd, "  Max Call Bitrate:       %d kbps\r\n", global.default_maxcallbitrate);
   ast_cli(fd, "\nTimer Settings:\n");
   ast_cli(fd, "-----------------\n");
   ast_cli(fd, "  SIP Timer T1 minimum: %d\n", global.t1min);
   ast_cli(fd, "  SIP Timer T1 default: %d\n", global.t1default);
   ast_cli(fd, "  SIP Timer T2:         %d\n", global.t2default);
   ast_cli(fd, "  SIP Timer T4:         %d\n", global.t4default);
   ast_cli(fd, "  SIP Timer B:          %d\n", global.siptimer_b);
   ast_cli(fd, "  SIP Timer F:          %d\n", global.siptimer_f);
   ast_cli(fd, "\nDefault Settings:\n");
   ast_cli(fd, "-----------------\n");
   ast_cli(fd, "  Context:                %s\n", global.default_context);
   ast_cli(fd, "  Nat:                    %s\n", nat2str(ast_test_flag(&global.flags[0], SIP_NAT)));
   ast_cli(fd, "  DTMF:                   %s\n", dtmfmode2str(ast_test_flag(&global.flags[0], SIP_DTMF)));
   ast_cli(fd, "  Qualify:                %d\n", global.default_qualify);
   ast_cli(fd, "  Qualify timer OK:       %d sec\n", global.default_qualifycheck_ok);
   ast_cli(fd, "  Qualify timer not OK:   %d sec\n", global.default_qualifycheck_notok);
   ast_cli(fd, "  Use ClientCode:         %s\n", ast_test_flag(&global.flags[0], SIP_USECLIENTCODE) ? "Yes" : "No");
   ast_cli(fd, "  Progress inband:        %s\n", (ast_test_flag(&global.flags[0], SIP_PROG_INBAND) == SIP_PROG_INBAND_NEVER) ? "Never" : (ast_test_flag(&global.flags[0], SIP_PROG_INBAND) == SIP_PROG_INBAND_NO) ? "No" : "Yes" );
   ast_cli(fd, "  Language:               %s\n", S_OR(global.default_language, "(Defaults to English)"));
   ast_cli(fd, "  MOH Interpret:          %s\n", global.default_mohinterpret);
   ast_cli(fd, "  MOH Suggest:            %s\n", global.default_mohsuggest);
   ast_cli(fd, "  Voice Mail Extension:   %s\n", global.default_vmexten);

   
   if (realtimepeers || realtimeusers) {
      ast_cli(fd, "\nRealtime SIP Settings:\n");
      ast_cli(fd, "----------------------\n");
      ast_cli(fd, "  Realtime Peers:         %s\n", realtimepeers ? "Yes" : "No");
      ast_cli(fd, "  Realtime Users:         %s\n", realtimeusers ? "Yes" : "No");
      ast_cli(fd, "  Cache Friends:          %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_RTCACHEFRIENDS) ? "Yes" : "No");
      ast_cli(fd, "  Update:                 %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_RTUPDATE) ? "Yes" : "No");
      ast_cli(fd, "  Ignore Reg. Expire:     %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_IGNOREREGEXPIRE) ? "Yes" : "No");
      ast_cli(fd, "  Save sys. name:         %s\n", ast_test_flag(&global.flags[1], SIP_PAGE2_RTSAVE_SYSNAME) ? "Yes" : "No");
      ast_cli(fd, "  Auto Clear:             %d\n", global.rtautoclear);
   }
   ast_cli(fd, "\n----\n");
   return RESULT_SUCCESS;
}

/*! \brief Show details of one active dialog */
static int sip_show_channel(int fd, int argc, char *argv[])
{
   struct sip_dialog *cur;
   size_t len;
   int found = 0;

   if (argc != 4)
      return RESULT_SHOWUSAGE;
   len = strlen(argv[3]);
   dialoglist_lock();
   for (cur = dialoglist; cur; cur = cur->next) {
      if (!strncasecmp(cur->callid, argv[3], len)) {
         char formatbuf[BUFSIZ/2];
         ast_cli(fd,"\n");
         if (cur->subscribed != NONE)
            ast_cli(fd, "  * Subscription (type: %s)\n", subscription_type2str(cur->subscribed));
         else
            ast_cli(fd, "  * SIP Call\n");
         ast_cli(fd, "  State:                  %s\n", dialogstate2str(cur->state));
         ast_cli(fd, "  Direction:              %s\n", ast_test_flag(&cur->flags[0], SIP_OUTGOING)?"Outgoing":"Incoming");
         ast_cli(fd, "  Call-ID:                %s\n", cur->callid);
         ast_cli(fd, "  Owner channel ID:       %s\n", cur->owner ? cur->owner->name : "<none>");
         ast_cli(fd, "  Our Codec Capability:   %d\n", cur->capability);
         ast_cli(fd, "  Non-Codec Capability (DTMF):   %d\n", cur->noncodeccapability);
         ast_cli(fd, "  Their Codec Capability:   %d\n", cur->peercapability);
         ast_cli(fd, "  Joint Codec Capability:   %d\n", cur->jointcapability);
         ast_cli(fd, "  Format:                 %s\n", ast_getformatname_multiple(formatbuf, sizeof(formatbuf), cur->owner ? cur->owner->nativeformats : 0) );
         ast_cli(fd, "  T.38 support            %s\n", cur->udptl ? "Yes" : "No");
         ast_cli(fd, "  Video support           %s\n", cur->vrtp ? "Yes" : "No");
         ast_cli(fd, "  MaxCallBR:              %d kbps\n", cur->maxcallbitrate);
         ast_cli(fd, "  Theoretical Address:    %s:%d\n", ast_inet_ntoa(cur->sa.sin_addr), ntohs(cur->sa.sin_port));
         ast_cli(fd, "  Received Address:       %s:%d\n", ast_inet_ntoa(cur->recv.sin_addr), ntohs(cur->recv.sin_port));
         ast_cli(fd, "  SIP Transfer mode:      %s\n", transfermode2str(cur->allowtransfer));
         ast_cli(fd, "  NAT Support:            %s\n", nat2str(ast_test_flag(&cur->flags[0], SIP_NAT)));
         ast_cli(fd, "  Audio IP:               %s %s\n", ast_inet_ntoa(cur->redirip.sin_addr.s_addr ? cur->redirip.sin_addr : cur->ourip), cur->redirip.sin_addr.s_addr ? "(Outside bridge)" : "(local)" );
         ast_cli(fd, "  Our Tag:                %s\n", cur->tag);
         ast_cli(fd, "  Their Tag:              %s\n", cur->theirtag);
         ast_cli(fd, "  SIP User agent:         %s\n", cur->useragent);
         if (!ast_strlen_zero(cur->username))
            ast_cli(fd, "  Username:               %s\n", cur->username);
         if (!ast_strlen_zero(cur->peername))
            ast_cli(fd, "  Peername:               %s\n", cur->peername);
         if (!ast_strlen_zero(cur->uri))
            ast_cli(fd, "  Original uri:           %s\n", cur->uri);
         if (!ast_strlen_zero(cur->cid_num))
            ast_cli(fd, "  Caller-ID:              %s\n", cur->cid_num);
         ast_cli(fd, "  Need Destroy:           %d\n", ast_test_flag(&cur->flags[0], SIP_NEEDDESTROY));
         ast_cli(fd, "  Last Message:           %s\n", cur->lastmsg);
         ast_cli(fd, "  Promiscuous Redir:      %s\n", ast_test_flag(&cur->flags[0], SIP_PROMISCREDIR) ? "Yes" : "No");
         ast_cli(fd, "  Route:                  %s\n", cur->route ? cur->route->hop : "N/A");
         ast_cli(fd, "  DTMF Mode:              %s\n", dtmfmode2str(ast_test_flag(&cur->flags[0], SIP_DTMF)));
         ast_cli(fd, "  SIP Options:            ");
         if (cur->sipoptions) {
            sip_options_print(cur->sipoptions, fd);
         } else
            ast_cli(fd, "(none)\n");
         ast_cli(fd, "\n\n");
         found++;
      }
   }
   dialoglist_unlock();
   if (!found) 
      ast_cli(fd, "No such SIP Call ID starting with '%s'\n", argv[3]);
   return RESULT_SUCCESS;
}

/*! \brief Show history details of one dialog */
static int sip_show_history(int fd, int argc, char *argv[])
{
   struct sip_dialog *cur;
   size_t len;
   int found = 0;

   if (argc != 4)
      return RESULT_SHOWUSAGE;
   if (!global.recordhistory)
      ast_cli(fd, "\n***Note: History recording is currently DISABLED.  Use 'sip history' to ENABLE.\n");
   len = strlen(argv[3]);
   dialoglist_lock();
   for (cur = dialoglist; cur; cur = cur->next) {
      if (!strncasecmp(cur->callid, argv[3], len)) {
         struct sip_history *hist;
         int x = 0;

         ast_cli(fd,"\n");
         if (cur->subscribed != NONE)
            ast_cli(fd, "  * Subscription\n");
         else
            ast_cli(fd, "  * SIP Call\n");
         if (cur->history) {
            AST_LIST_TRAVERSE(cur->history, hist, list)
               ast_cli(fd, "%d. %s\n", ++x, hist->event);
         }
         if (x == 0)
            ast_cli(fd, "Call '%s' has no history\n", cur->callid);
         found++;
      }
   }
   dialoglist_unlock();
   if (!found) 
      ast_cli(fd, "No such SIP Call ID starting with '%s'\n", argv[3]);
   return RESULT_SUCCESS;
}

/*! \brief Do completion on peer name */
GNURK char *complete_sip_device(const char *word, int state, int flags2)
{
   char *result = NULL;
   int wordlen = strlen(word);
   int which = 0;

   ASTOBJ_CONTAINER_TRAVERSE(&devicelist, !result, do {
      /* locking of the object is not required because only the name and flags are being compared */
      if (!strncasecmp(word, iterator->name, wordlen) &&
            (!flags2 || ast_test_flag(&iterator->flags[1], flags2)) &&
            ++which > state)
         result = ast_strdup(iterator->name);
   } while(0) );
   return result;
}

/*! \brief Support routine for 'sip show peer' CLI */
GNURK char *complete_sip_show_device(const char *line, const char *word, int pos, int state)
{
   if (pos == 3)
      return complete_sip_device(word, state, 0);

   return NULL;
}

/*! \brief Support routine for 'sip show channel' CLI */
static char *complete_sipch(const char *line, const char *word, int pos, int state)
{
   int which=0;
   struct sip_dialog *cur;
   char *c = NULL;
   int wordlen = strlen(word);

   dialoglist_lock();
   for (cur = dialoglist; cur; cur = cur->next) {
      if (!strncasecmp(word, cur->callid, wordlen) && ++which > state) {
         c = ast_strdup(cur->callid);
         break;
      }
   }
   dialoglist_unlock();
   return c;
}


/*! \brief Support routine for 'sip debug peer' CLI */
static char *complete_sip_debug_device(const char *line, const char *word, int pos, int state)
{
   if (pos == 3)
      return complete_sip_device(word, state, 0);

   return NULL;
}


/*! \brief SIP show channels CLI (main function) */
static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions)
{
#define FORMAT3 "%-15.15s  %-10.10s  %-11.11s  %-15.15s  %-13.13s  %-15.15s %-10.10s\n"
#define FORMAT2 "%-15.15s  %-10.10s  %-11.11s  %-11.11s  %-4.4s  %-7.7s  %-15.15s\n"
#define FORMAT  "%-15.15s  %-10.10s  %-11.11s  %5.5d/%5.5d  %-4.4s  %-3.3s %-3.3s  %-15.15s %-10.10s\n"
   struct sip_dialog *cur;
   int numchans = 0;
   const char *referstatus = NULL;

   if (argc != 3)
      return RESULT_SHOWUSAGE;
   dialoglist_lock();
   cur = dialoglist;
   if (!subscriptions)
      ast_cli(fd, FORMAT2, "Peer", "User/ANR", "Call ID", "Seq (Tx/Rx)", "Format", "Hold", "Last Message");
   else 
      ast_cli(fd, FORMAT3, "Peer", "User", "Call ID", "Extension", "Last state", "Type", "Mailbox");
   for (; cur; cur = cur->next) {
      dialoglist_unlock();
      referstatus = "";
      if (cur->refer) { /* SIP transfer in progress */
         referstatus = referstatus2str(cur->refer->status);
      }
      if (cur->subscribed == NONE && !subscriptions) {
         ast_cli(fd, FORMAT, ast_inet_ntoa(cur->sa.sin_addr), 
            S_OR(cur->username, S_OR(cur->cid_num, "(None)")),
            cur->callid, 
            cur->ocseq, cur->icseq, 
            ast_getformatname(cur->owner ? cur->owner->nativeformats : 0), 
            ast_test_flag(&cur->flags[1], SIP_PAGE2_CALL_ONHOLD) ? "Yes" : "No",
            ast_test_flag(&cur->flags[0], SIP_NEEDDESTROY) ? "(d)" : "",
            cur->lastmsg ,
            referstatus
         );
         numchans++;
      }
      if (cur->subscribed != NONE && subscriptions) {
         ast_cli(fd, FORMAT3, ast_inet_ntoa(cur->sa.sin_addr),
            S_OR(cur->username, S_OR(cur->cid_num, "(None)")), 
               cur->callid,
            /* the 'complete' exten/context is hidden in the refer_to field for subscriptions */
            cur->subscribed == MWI_NOTIFICATION ? "--" : cur->subscribeuri,
            cur->subscribed == MWI_NOTIFICATION ? "<none>" : ast_extension_state2str(cur->laststate), 
            subscription_type2str(cur->subscribed),
            cur->subscribed == MWI_NOTIFICATION ? (cur->relatedpeer ? cur->relatedpeer->mailbox.mailbox : "<none>") : "<none>"
);
         numchans++;
      }
      dialoglist_lock();
   }
   dialoglist_unlock();
   if (!subscriptions)
      ast_cli(fd, "%d active SIP channel%s\n", numchans, (numchans != 1) ? "s" : "");
   else
      ast_cli(fd, "%d active SIP subscription%s\n", numchans, (numchans != 1) ? "s" : "");
   return RESULT_SUCCESS;
#undef FORMAT
#undef FORMAT2
#undef FORMAT3
}

/*! \brief Show active SIP channels */
static int sip_show_channels(int fd, int argc, char *argv[])  
{
        return __sip_show_channels(fd, argc, argv, 0);
}
 
/*! \brief Show active SIP subscriptions */
static int sip_show_subscriptions(int fd, int argc, char *argv[])
{
        return __sip_show_channels(fd, argc, argv, 1);
}


/*! \brief Start reload process from CLI */
static  int cli_sip_reload(int fd, int argc, char *argv[])
{
   return sip_reload(fd);
   
}

/*! \brief List configuration options */
static  int cli_sip_listconfigs(int fd, int argc, char *argv[])
{
   return sip_listconfigs(fd);
}


/*! \brief Enable SIP Debugging in CLI */
static int sip_do_debug_ip(int fd, int argc, char *argv[])
{
   struct hostent *hp;
   struct ast_hostent ahp;
   int port = 0;
   char *p, *arg;

   if (argc != 4)
      return RESULT_SHOWUSAGE;
   p = arg = argv[3];
   strsep(&p, ":");
   if (p)
      port = atoi(p);
   hp = ast_gethostbyname(arg, &ahp);
   if (hp == NULL)
      return RESULT_SHOWUSAGE;

   sipnet.debugaddr.sin_family = AF_INET;
   memcpy(&sipnet.debugaddr.sin_addr, hp->h_addr, sizeof(sipnet.debugaddr.sin_addr));
   sipnet.debugaddr.sin_port = htons(port);
   if (port == 0)
      ast_cli(fd, "SIP Debugging Enabled for IP: %s\n", ast_inet_ntoa(sipnet.debugaddr.sin_addr));
   else
      ast_cli(fd, "SIP Debugging Enabled for IP: %s:%d\n", ast_inet_ntoa(sipnet.debugaddr.sin_addr), port);

   ast_set_flag(&global.flags[1], SIP_PAGE2_DEBUG_CONSOLE);

   return RESULT_SUCCESS;
}


/*! \brief  sip_do_debug_device: Turn on SIP debugging with peer mask */
static int sip_do_debug_device(int fd, int argc, char *argv[])
{
   struct sip_device *peer;
   if (argc != 4)
      return RESULT_SHOWUSAGE;
   peer = find_device(argv[3], NULL, 1);
   if (peer) {
      if (peer->addr.sin_addr.s_addr) {
         sipnet.debugaddr.sin_family = AF_INET;
         sipnet.debugaddr.sin_addr = peer->addr.sin_addr;
         sipnet.debugaddr.sin_port = peer->addr.sin_port;
         ast_cli(fd, "SIP Debugging Enabled for IP: %s:%d\n", ast_inet_ntoa(sipnet.debugaddr.sin_addr), ntohs(sipnet.debugaddr.sin_port));
         ast_set_flag(&global.flags[1], SIP_PAGE2_DEBUG_CONSOLE);
      } else
         ast_cli(fd, "Unable to get IP address of peer '%s'\n", argv[3]);
      device_unref(peer);
   } else
      ast_cli(fd, "No such peer '%s'\n", argv[3]);
   return RESULT_SUCCESS;
}

/*! \brief Turn on SIP debugging (CLI command) */
static int sip_do_debug(int fd, int argc, char *argv[])
{
   int oldsipdebug = sipdebug_console;
   if (argc != 3) {
      if (argc != 4) 
         return RESULT_SHOWUSAGE;
      else if (strcmp(argv[2], "ip") == 0)
         return sip_do_debug_ip(fd, argc, argv);
      else if (strcmp(argv[2], "peer") == 0)
         return sip_do_debug_device(fd, argc, argv);
      else
         return RESULT_SHOWUSAGE;
   }
   ast_set_flag(&global.flags[1], SIP_PAGE2_DEBUG_CONSOLE);
   memset(&sipnet.debugaddr, 0, sizeof(sipnet.debugaddr));
   ast_cli(fd, "SIP Debugging %senabled\n", oldsipdebug ? "re-" : "");
   return RESULT_SUCCESS;
}

/*! \brief Disable SIP Debugging in CLI */
static int sip_no_debug(int fd, int argc, char *argv[])
{
   if (argc != 3)
      return RESULT_SHOWUSAGE;
   ast_clear_flag(&global.flags[1], SIP_PAGE2_DEBUG_CONSOLE);
   ast_cli(fd, "SIP Debugging Disabled\n");
   return RESULT_SUCCESS;
}


/*! \brief Enable SIP History logging (CLI) */
static int sip_do_history(int fd, int argc, char *argv[])
{
   if (argc != 3) {
      return RESULT_SHOWUSAGE;
   }
   global.recordhistory = TRUE;
   ast_cli(fd, "SIP History Recording Enabled (use 'sip show history')\n");
   return RESULT_SUCCESS;
}

/*! \brief Disable SIP History logging (CLI) */
static int sip_no_history(int fd, int argc, char *argv[])
{
   if (argc != 3) {
      return RESULT_SHOWUSAGE;
   }
   global.recordhistory = FALSE;
   ast_cli(fd, "SIP History Recording Disabled\n");
   return RESULT_SUCCESS;
}


/*! \brief Support routine for 'sip notify' CLI */
static char *complete_sipnotify(const char *line, const char *word, int pos, int state)
{
   char *c = NULL;

   if (pos == 2) {
      int which = 0;
      char *cat = NULL;
      int wordlen = strlen(word);

      /* do completion for notify type */

      if (!notify_types)
         return NULL;
      
      while ( (cat = ast_category_browse(notify_types, cat)) ) {
         if (!strncasecmp(word, cat, wordlen) && ++which > state) {
            c = ast_strdup(cat);
            break;
         }
      }
      return c;
   }

   if (pos > 2)
      return complete_sip_device(word, state, 0);

   return NULL;
}

/*! \brief Support routine for 'sip prune realtime peer' CLI */
static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state)
{
   if (pos == 4)
      return complete_sip_device(word, state, SIP_PAGE2_RTCACHEFRIENDS);
   return NULL;
}

static char show_domains_usage[] = 
"Usage: sip list domains\n"
"       Lists all configured SIP local domains.\n"
"       Asterisk only responds to SIP messages to local domains.\n";

static char notify_usage[] =
"Usage: sip notify <type> <peer> [<peer>...]\n"
"       Send a NOTIFY message to a SIP peer or peers\n"
"       Message types are defined in sip_notify.conf\n";

static char show_inuse_usage[] = 
"Usage: sip list inuse [all]\n"
"       List all SIP users and peers usage counters and limits.\n"
"       Add option \"all\" to show all devices, not only those with a limit.\n";

static char show_channels_usage[] = 
"Usage: sip list channels\n"
"       Lists all currently active SIP channels.\n";

static char show_channel_usage[] = 
"Usage: sip show channel <channel>\n"
"       Provides detailed status on a given SIP channel.\n";

static char show_history_usage[] = 
"Usage: sip show history <channel>\n"
"       Provides detailed dialog history on a given SIP channel.\n";

static char show_devices_usage[] = 
"Usage: sip list devices [like <pattern>]\n"
"       Lists all known SIP devices.\n"
"       Optional regular expression pattern is used to filter the devices list.\n";

static char show_device_usage[] =
"Usage: sip show device <name> [load]\n"
"       Shows all details on one SIP device and the current status.\n"
"       Option \"load\" forces lookup of peer in realtime storage.\n";

static char prune_realtime_usage[] =
"Usage: sip prune realtime peer [<name>|all|like <pattern>]\n"
"       Prunes object(s) from the cache.\n"
"       Optional regular expression pattern is used to filter the objects.\n";

static char show_reg_usage[] =
"Usage: sip list registry\n"
"       Lists all service registration requests and status.\n";

static char debug_usage[] = 
"Usage: sip debug on/off\n"
"       Enables dumping of SIP packets for debugging purposes\n\n"
"       sip debug ip <host[:PORT]>\n"
"       Enables dumping of SIP packets to and from host.\n\n"
"       sip debug peer <peername>\n"
"       Enables dumping of SIP packets to and from host.\n"
"       Require peer to be registered.\n";

static char no_debug_usage[] = 
"Usage: sip debug off\n"
"       Disables dumping of SIP packets for debugging purposes\n";

static char no_history_usage[] = 
"Usage: sip history off\n"
"       Disables recording of SIP dialog history for debugging purposes\n";

static char history_usage[] = 
"Usage: sip history on\n"
"       Enables recording of SIP dialog history for debugging purposes.\n"
"Use 'sip show history' to view the history of a call number.\n";

static char sip_reload_usage[] =
"Usage: sip reload\n"
"       Reloads SIP configuration from sip.conf\n";

static char show_subscriptions_usage[] =
"Usage: sip list subscriptions\n" 
"       Lists active SIP subscriptions for extension states\n";

static char show_objects_usage[] =
"Usage: sip list objects\n" 
"       Lists status of known SIP objects\n";

static char show_settings_usage[] = 
"Usage: sip list settings\n"
"       Provides detailed list of the configuration of the SIP channel.\n";

static char sip_listconfig_usage[] = 
"Usage: sip list configs\n"
"       Provides detailed list of the configuration options of the SIP channel.\n";


static struct ast_cli_entry cli_sip[] = {
   { { "sip", "show", "channels", NULL },
   sip_show_channels, "List active SIP channels",
   show_channels_usage },

   { { "sip", "show", "domains", NULL },
   sip_show_domains, "List our local SIP domains.",
   show_domains_usage },

   { { "sip", "show", "inuse", NULL },
   sip_show_inuse, "List all call limits and their current usage level",
   show_inuse_usage },

   { { "sip", "show", "objects", NULL },
   sip_show_objects, "List all SIP object allocations",
   show_objects_usage },

   { { "sip", "show", "devices", NULL },
   sip_show_devices, "List defined SIP devices (phones, trunks, services)",
   show_devices_usage },

   { { "sip", "list", "registry", NULL },
   sip_show_registry, "List SIP registration status for services",
   show_reg_usage },

   { { "sip", "show", "settings", NULL },
   sip_show_settings, "Show SIP global settings",
   show_settings_usage },

   { { "sip", "show", "subscriptions", NULL },
   sip_show_subscriptions, "List active SIP subscriptions",
   show_subscriptions_usage },

   { { "sip", "notify", NULL },
   sip_notify, "Send a notify packet to a SIP device",
   notify_usage, complete_sipnotify },

   { { "sip", "show", "channel", NULL },
   sip_show_channel, "Show detailed SIP channel info",
   show_channel_usage, complete_sipch  },

   { { "sip", "show", "history", NULL },
   sip_show_history, "Show SIP dialog history",
   show_history_usage, complete_sipch  },

   { { "sip", "show", "device", NULL },
   sip_show_device, "Show details on specific SIP device (phone, service, trunk)",
   show_device_usage, complete_sip_show_device },

   { { "sip", "prune", "realtime", NULL },
   sip_prune_realtime, "Prune cached Realtime object(s)",
   prune_realtime_usage },

   { { "sip", "prune", "realtime", "peer", NULL },
   sip_prune_realtime, "Prune cached Realtime peer(s)",
   prune_realtime_usage, complete_sip_prune_realtime_peer },

   { { "sip", "debug", "on", NULL },
   sip_do_debug, "Enable SIP debugging",
   debug_usage },

   { { "sip", "debug", "ip", NULL },
   sip_do_debug, "Enable SIP debugging on IP",
   debug_usage },

   { { "sip", "debug", "device", NULL },
   sip_do_debug, "Enable SIP debugging on device-name",
   debug_usage, complete_sip_debug_device },

   { { "sip", "debug", "off", NULL },
   sip_no_debug, "Disable SIP debugging",
   no_debug_usage },

   { { "sip", "history", "on", NULL },
   sip_do_history, "Enable SIP history",
   history_usage },

   { { "sip", "history", "off", NULL },
   sip_no_history, "Disable SIP history",
   no_history_usage },

   { { "sip", "reload", NULL },
   cli_sip_reload, "Reload SIP configuration",
   sip_reload_usage },

   { { "sip", "list", "configs", NULL },
   cli_sip_listconfigs, "List SIP coniguration options",
   sip_listconfig_usage },
};

/*! \brief Register cli and manager commands */
void sip_cli_and_manager_commands_register()
{
   /* Register CLI commands */
   ast_cli_register_multiple(cli_sip, sizeof(cli_sip)/ sizeof(struct ast_cli_entry));
   /* Register manager commands */
   ast_manager_register2("SIPdevices", EVENT_FLAG_SYSTEM, manager_sip_show_devices,
         "List SIP devices (text format)", mandescr_show_devices);
   ast_manager_register2("SIPshowdevice", EVENT_FLAG_SYSTEM, manager_sip_show_device,
         "Show SIP device (text format)", mandescr_show_device);
}

/*! \brief Unregister cli and manager commands */
void sip_cli_and_manager_commands_unregister()
{
   ast_cli_unregister_multiple(cli_sip, sizeof(cli_sip) / sizeof(struct ast_cli_entry));
   ast_manager_unregister("SIPdevices");
   ast_manager_unregister("SIPshowdevice");
}

---

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen