New sip.conf option for setting default tonezone for channel or individual devices

Review: https://reviewboard.asterisk.org/r/1429/

(closes issue ASTERISK-18497)

Thanks to russellb for peer review.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@335325 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/CREDITS b/CREDITS
index a9e9687..a842821 100644 (file)
--- a/CREDITS
+++ b/CREDITS
@@ -23,6 +23,8 @@ John Todd, TalkPlus, Inc.  and JR Richardson, Ntegrated Solutions. - for funding
 Omnitor AB, Gunnar Hellström, for funding work with videocaps, T.140 RED,
 originate with video/text and many more contributions.
 
+ClearIT AB for work with RTCP, manager and tonezones
+
 === WISHLIST CONTRIBUTERS ===
 Jeremy McNamara - SpeeX support
 Nick Seraphin - RDNIS support

diff --git a/UPGRADE.txt b/UPGRADE.txt
index 1c0f8bc..2f54158 100644 (file)
--- a/UPGRADE.txt
+++ b/UPGRADE.txt
@@ -34,6 +34,11 @@ Configuration Files:
 
    - cdr.conf: [general] section
 
+SIP
+===
+ - A new option "tonezone" for setting default tonezone for the channel driver
+   or individual devices
+
 From 1.8 to 10:
 
 cel_pgsql:

diff --git a/channels/chan_sip.c b/channels/chan_sip.c
index 8f5bb83..0b0ac20 100644 (file)
--- a/channels/chan_sip.c
+++ b/channels/chan_sip.c
@@ -692,6 +692,7 @@ static char default_parkinglot[AST_MAX_CONTEXT];   /*!< Parkinglot */
 static char default_engine[256];                   /*!< Default RTP engine */
 static int default_maxcallbitrate;                 /*!< Maximum bitrate for call */
 static struct ast_codec_pref default_prefs;        /*!< Default codec prefs */
+static char default_zone[MAX_TONEZONE_COUNTRY];        /*!< Default tone zone for channels created from the SIP driver */
 static unsigned int default_transports;            /*!< Default Transports (enum sip_transport) that are acceptable */
 static unsigned int default_primary_transport;     /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
 /*@}*/
@@ -5215,6 +5216,7 @@ static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)
        ref_proxy(dialog, obproxy_get(dialog, peer));
        dialog->callgroup = peer->callgroup;
        dialog->pickupgroup = peer->pickupgroup;
+       ast_copy_string(dialog->zone, peer->zone, sizeof(dialog->zone));
        dialog->allowtransfer = peer->allowtransfer;
        dialog->jointnoncodeccapability = dialog->noncodeccapability;
        dialog->rtptimeout = peer->rtptimeout;
@@ -6997,6 +6999,11 @@ static struct ast_channel *sip_new(struct sip_pvt *i, int state, const char *tit
        if (!ast_strlen_zero(i->language)) {
                ast_string_field_set(tmp, language, i->language);
        }
+       if (!ast_strlen_zero(i->zone)) {
+               if (!(tmp->zone = ast_get_indication_zone(i->zone))) {
+                       ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone. Check indications.conf for available country codes.\n", i->zone);
+               } 
+       }
        i->owner = tmp;
        ast_module_ref(ast_module_info->self);
        ast_copy_string(tmp->context, i->context, sizeof(tmp->context));
@@ -7529,6 +7536,7 @@ struct sip_pvt *sip_alloc(ast_string_field callid, struct ast_sockaddr *addr,
        p->session_modify = TRUE;
        p->stimer = NULL;
        p->prefs = default_prefs;               /* Set default codecs for this call */
+       ast_copy_string(p->zone, default_zone, sizeof(p->zone));
        p->maxforwards = sip_cfg.default_max_forwards;
 
        if (intended_method != SIP_OPTIONS) {   /* Peerpoke has it's own system */
@@ -15874,6 +15882,7 @@ static enum check_auth_result check_peer_ok(struct sip_pvt *p, char *of,
                ast_format_cap_copy(p->caps, peer->caps);
                ast_format_cap_copy(p->jointcaps, peer->caps);
                p->prefs = peer->prefs;
+               ast_copy_string(p->zone, peer->zone, sizeof(p->zone));
                if (peer->maxforwards > 0) {
                        p->maxforwards = peer->maxforwards;
                }
@@ -17363,6 +17372,7 @@ static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct
                ast_cli(fd, "  Context      : %s\n", peer->context);
                ast_cli(fd, "  Subscr.Cont. : %s\n", S_OR(peer->subscribecontext, "<Not set>") );
                ast_cli(fd, "  Language     : %s\n", peer->language);
+               ast_cli(fd, "  Tonezone     : %s\n", peer->zone[0] != '\0' ? peer->zone : "<Not set>");
                if (!ast_strlen_zero(peer->accountcode))
                        ast_cli(fd, "  Accountcode  : %s\n", peer->accountcode);
                ast_cli(fd, "  AMA flags    : %s\n", ast_cdr_flags2str(peer->amaflags));
@@ -17477,6 +17487,7 @@ static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct
                astman_append(s, "MD5SecretExist: %s\r\n", ast_strlen_zero(peer->md5secret)?"N":"Y");
                astman_append(s, "Context: %s\r\n", peer->context);
                astman_append(s, "Language: %s\r\n", peer->language);
+               astman_append(s, "ToneZone: %s\r\n", peer->zone[0] != '\0' ? peer->zone : "<Not set>");
                if (!ast_strlen_zero(peer->accountcode))
                        astman_append(s, "Accountcode: %s\r\n", peer->accountcode);
                astman_append(s, "AMAflags: %s\r\n", ast_cdr_flags2str(peer->amaflags));
@@ -17644,6 +17655,7 @@ static char *sip_show_user(struct ast_cli_entry *e, int cmd, struct ast_cli_args
                if (!ast_strlen_zero(user->accountcode))
                        ast_cli(a->fd, "  Accountcode  : %s\n", user->accountcode);
                ast_cli(a->fd, "  AMA flags    : %s\n", ast_cdr_flags2str(user->amaflags));
+               ast_cli(a->fd, "  Tonezone     : %s\n", user->zone[0] != '\0' ? user->zone : "<Not set>");
                ast_cli(a->fd, "  Transfer mode: %s\n", transfermode2str(user->allowtransfer));
                ast_cli(a->fd, "  MaxCallBR    : %d kbps\n", user->maxcallbitrate);
                ast_cli(a->fd, "  CallingPres  : %s\n", ast_describe_caller_presentation(user->callingpres));
@@ -18117,6 +18129,7 @@ static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_
        ast_cli(a->fd, "  Use ClientCode:         %s\n", AST_CLI_YESNO(ast_test_flag(&global_flags[0], SIP_USECLIENTCODE)));
        ast_cli(a->fd, "  Progress inband:        %s\n", (ast_test_flag(&global_flags[0], SIP_PROG_INBAND) == SIP_PROG_INBAND_NEVER) ? "Never" : (AST_CLI_YESNO(ast_test_flag(&global_flags[0], SIP_PROG_INBAND) != SIP_PROG_INBAND_NO)));
        ast_cli(a->fd, "  Language:               %s\n", default_language);
+       ast_cli(a->fd, "  Tone zone:              %s\n", default_zone[0] != '\0' ? default_zone : "<Not set>");
        ast_cli(a->fd, "  MOH Interpret:          %s\n", default_mohinterpret);
        ast_cli(a->fd, "  MOH Suggest:            %s\n", default_mohsuggest);
        ast_cli(a->fd, "  Voice Mail Extension:   %s\n", default_vmexten);
@@ -27129,6 +27142,7 @@ static void set_peer_defaults(struct sip_peer *peer)
        peer->pickupgroup = 0;
        peer->maxms = default_qualify;
        peer->prefs = default_prefs;
+       ast_string_field_set(peer, zone, default_zone);
        peer->stimer.st_mode_oper = global_st_mode;     /* Session-Timers */
        peer->stimer.st_ref = global_st_refresher;
        peer->stimer.st_min_se = global_min_se;
@@ -27518,6 +27532,14 @@ static struct sip_peer *build_peer(const char *name, struct ast_variable *v, str
                                        }
                                        peer->deprecated_username = 1;
                                }
+                       } else if (!strcasecmp(v->name, "tonezone")) {
+                               struct ast_tone_zone *new_zone;
+                               if (!(new_zone = ast_get_indication_zone(v->value))) {
+                                       ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone in device [%s] at line %d. Check indications.conf for available country codes.\n", v->value, peer->name, v->lineno);
+                               } else {
+                                       ast_tone_zone_unref(new_zone);
+                                       ast_string_field_set(peer, zone, v->value);
+                               }
                        } else if (!strcasecmp(v->name, "language")) {
                                ast_string_field_set(peer, language, v->value);
                        } else if (!strcasecmp(v->name, "regexten")) {
@@ -28144,6 +28166,7 @@ static int reload_config(enum channelreloadreason reason)
        default_fromdomain[0] = '\0';
        default_fromdomainport = 0;
        default_qualify = DEFAULT_QUALIFY;
+       default_zone[0] = '\0';
        default_maxcallbitrate = DEFAULT_MAX_CALL_BITRATE;
        ast_copy_string(default_mohinterpret, DEFAULT_MOHINTERPRET, sizeof(default_mohinterpret));
        ast_copy_string(default_mohsuggest, DEFAULT_MOHSUGGEST, sizeof(default_mohsuggest));
@@ -28353,6 +28376,14 @@ static int reload_config(enum channelreloadreason reason)
                        ast_copy_string(default_mohinterpret, v->value, sizeof(default_mohinterpret));
                } else if (!strcasecmp(v->name, "mohsuggest")) {
                        ast_copy_string(default_mohsuggest, v->value, sizeof(default_mohsuggest));
+               } else if (!strcasecmp(v->name, "tonezone")) {
+                       struct ast_tone_zone *new_zone;
+                       if (!(new_zone = ast_get_indication_zone(v->value))) {
+                               ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone in [general] at line %d. Check indications.conf for available country codes.\n", v->value, v->lineno);
+                       } else {
+                               ast_tone_zone_unref(new_zone);
+                               ast_copy_string(default_zone, v->value, sizeof(default_zone));
+                       }
                } else if (!strcasecmp(v->name, "language")) {
                        ast_copy_string(default_language, v->value, sizeof(default_language));
                } else if (!strcasecmp(v->name, "regcontext")) {

diff --git a/channels/sip/include/sip.h b/channels/sip/include/sip.h
index fe2933b..5018f0f 100644 (file)
--- a/channels/sip/include/sip.h
+++ b/channels/sip/include/sip.h
@@ -32,6 +32,7 @@
 #include "asterisk/channel.h"
 #include "asterisk/app.h"
 #include "asterisk/astobj.h"
+#include "asterisk/indications.h"
 
 #ifndef FALSE
 #define FALSE    0
@@ -1030,6 +1031,7 @@ struct sip_pvt {
        struct t38properties t38;             /*!< T38 settings */
        struct ast_sockaddr udptlredirip;     /*!< Where our T.38 UDPTL should be going if not to us */
        struct ast_udptl *udptl;              /*!< T.38 UDPTL session */
+       char zone[MAX_TONEZONE_COUNTRY];      /*!< Default tone zone for channels created by this dialog */
        int callingpres;                      /*!< Calling presentation */
        int expiry;                         /*!< How long we take to expire */
        int sessionversion;                 /*!< SDP Session Version */
@@ -1199,6 +1201,7 @@ struct sip_peer {
                AST_STRING_FIELD(mwi_from);     /*!< Name to place in From header for outgoing NOTIFY requests */
                AST_STRING_FIELD(engine);       /*!<  RTP Engine to use */
                AST_STRING_FIELD(unsolicited_mailbox);  /*!< Mailbox to store received unsolicited MWI NOTIFY messages information in */
+               AST_STRING_FIELD(zone);         /*!< Tonezone for this device */
                );
        struct sip_socket socket;       /*!< Socket used for this peer */
        enum sip_transport default_outbound_transport;   /*!< Peer Registration may change the default outbound transport.

diff --git a/configs/sip.conf.sample b/configs/sip.conf.sample
index 7c04a4a..e590423 100644 (file)
--- a/configs/sip.conf.sample
+++ b/configs/sip.conf.sample
@@ -307,6 +307,9 @@ srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
                                 ; Parkinglots are configured in features.conf
 ;language=en                    ; Default language setting for all users/peers
                                 ; This may also be set for individual users/peers
+;tonezone=se                   ; Default tonezone for all users/peers
+                                ; This may also be set for individual users/peers
+
 ;relaxdtmf=yes                  ; Relax dtmf handling
 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
 ;sendrpid = yes                 ; If Remote-Party-ID should be sent (defaults to no)

diff --git a/include/asterisk/indications.h b/include/asterisk/indications.h
index c0c17e5..13422d9 100644 (file)
--- a/include/asterisk/indications.h
+++ b/include/asterisk/indications.h
@@ -62,6 +62,8 @@ struct ast_tone_zone_sound {
        };
 };
 
+#define MAX_TONEZONE_COUNTRY 16
+
 /*!
  * \brief A set of tones for a given locale
  *
@@ -72,7 +74,7 @@ struct ast_tone_zone_sound {
  */
 struct ast_tone_zone {
        /*! \brief Country code that this set of tones is for */
-       char country[16];
+       char country[MAX_TONEZONE_COUNTRY];
        /*! 
         * \brief Text description of the given country.
         *