res_pjsip_session: add new flag use_callerid_contact

Add a new global flag to res_pjsip to allow the callerid to be used
as the username in the contact header.  This allows chan_pjsip to have
the same behavour as chan_sip

ASTERISK-28087 #close

Change-Id: I9a720e058323f6862a91c62f8a8c1a4b5c087b95

diff --git a/contrib/ast-db-manage/config/versions/2bb1a85135ad_pjsip_add_use_callerid_contact.py b/contrib/ast-db-manage/config/versions/2bb1a85135ad_pjsip_add_use_callerid_contact.py
new file mode 100644 (file)
index 0000000..490e23d
--- /dev/null
+++ b/contrib/ast-db-manage/config/versions/2bb1a85135ad_pjsip_add_use_callerid_contact.py
@@ -0,0 +1,42 @@
+"""pjsip add use_callerid_contact
+
+Revision ID: 2bb1a85135ad
+Revises: 7f85dd44c775
+Create Date: 2018-10-18 15:13:40.462354
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '2bb1a85135ad'
+down_revision = '7f85dd44c775'
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects.postgresql import ENUM
+
+AST_BOOL_NAME = 'ast_bool_values'
+# We'll just ignore the n/y and f/t abbreviations as Asterisk does not write
+# those aliases.
+AST_BOOL_VALUES = [ '0', '1',
+                    'off', 'on',
+                    'false', 'true',
+                    'no', 'yes' ]
+
+
+def upgrade():
+    # Create the new enum
+    ast_bool_values = ENUM(*AST_BOOL_VALUES, name=AST_BOOL_NAME, create_type=False)
+    if op.get_context().bind.dialect.name == 'postgresql':
+        ast_bool_values.create(op.get_bind(), checkfirst=False)
+
+
+    op.add_column('ps_globals', sa.Column('use_callerid_contact', ast_bool_values))
+
+
+def downgrade():
+    if op.get_context().bind.dialect.name == 'mssql':
+        op.drop_constraint('ck_ps_globals_use_callerid_contact_ast_bool_values','ps_globals')
+    op.drop_column('ps_globals', 'use_callerid_contact')
+
+    if op.get_context().bind.dialect.name == 'postgresql':
+        ENUM(name=AST_BOOL_NAME).drop(op.get_bind(), checkfirst=False)

diff --git a/include/asterisk/res_pjsip.h b/include/asterisk/res_pjsip.h
index 17282d64eb4d05df054e255d5b59170ec63f1e82..eb0905bf8ac8909f3d8d0246736ea8ee5673f342 100644 (file)
--- a/include/asterisk/res_pjsip.h
+++ b/include/asterisk/res_pjsip.h
@@ -2773,6 +2773,14 @@ int ast_sip_get_mwi_tps_queue_low(void);
  */
 unsigned int ast_sip_get_mwi_disable_initial_unsolicited(void);
 
+/*!
+ * \brief Retrieve the global setting 'use_callerid_contact'.
+ * \since 13.24.0
+ *
+ * \retval non zero if CALLERID(num) is to be used as the default username in the contact
+ */
+unsigned int ast_sip_get_use_callerid_contact(void);
+
 /*!
  * \brief Retrieve the global setting 'ignore_uri_user_options'.
  * \since 13.12.0

diff --git a/res/res_pjsip/config_global.c b/res/res_pjsip/config_global.c
index b3d6fa28b851b99f1313b756e200be0ee1b28195..a02cacdde764996d2a78d74fb1ba0912089d72d2 100644 (file)
--- a/res/res_pjsip/config_global.c
+++ b/res/res_pjsip/config_global.c
@@ -48,6 +48,7 @@
 #define DEFAULT_MWI_TPS_QUEUE_LOW -1
 #define DEFAULT_MWI_DISABLE_INITIAL_UNSOLICITED 0
 #define DEFAULT_IGNORE_URI_USER_OPTIONS 0
+#define DEFAULT_USE_CALLERID_CONTACT 0
 
 /*!
  * \brief Cached global config object
@@ -103,6 +104,8 @@ struct global_config {
        } mwi;
        /*! Nonzero if URI user field options are ignored. */
        unsigned int ignore_uri_user_options;
+       /*! Nonzero if CALLERID(num) is to be used as the default contact username instead of default_from_user */
+       unsigned int use_callerid_contact;
 };
 
 static void global_destructor(void *obj)
@@ -402,6 +405,21 @@ unsigned int ast_sip_get_ignore_uri_user_options(void)
        return ignore_uri_user_options;
 }
 
+unsigned int ast_sip_get_use_callerid_contact(void)
+{
+       unsigned int use_callerid_contact;
+       struct global_config *cfg;
+
+       cfg = get_global_cfg();
+       if (!cfg) {
+               return DEFAULT_USE_CALLERID_CONTACT;
+       }
+
+       use_callerid_contact = cfg->use_callerid_contact;
+       ao2_ref(cfg, -1);
+       return use_callerid_contact;
+}
+
 /*!
  * \internal
  * \brief Observer to set default global object if none exist.
@@ -553,6 +571,9 @@ int ast_sip_initialize_sorcery_global(void)
        ast_sorcery_object_field_register(sorcery, "global", "ignore_uri_user_options",
                DEFAULT_IGNORE_URI_USER_OPTIONS ? "yes" : "no",
                OPT_BOOL_T, 1, FLDSET(struct global_config, ignore_uri_user_options));
+       ast_sorcery_object_field_register(sorcery, "global", "use_callerid_contact",
+               DEFAULT_USE_CALLERID_CONTACT ? "yes" : "no",
+               OPT_YESNO_T, 1, FLDSET(struct global_config, use_callerid_contact));
 
        if (ast_sorcery_instance_observer_add(sorcery, &observer_callbacks_global)) {
                return -1;

diff --git a/res/res_pjsip_session.c b/res/res_pjsip_session.c
index ff40e5504a6f070b37787fac515e3e07422f8d09..669315f5cdf2cd13d4600907f239a2dd30768100 100644 (file)
--- a/res/res_pjsip_session.c
+++ b/res/res_pjsip_session.c
@@ -761,8 +761,10 @@ static void set_from_header(struct ast_sip_session *session)
        struct ast_party_id connected_id;
        pj_pool_t *dlg_pool;
        pjsip_fromto_hdr *dlg_info;
+       pjsip_contact_hdr *dlg_contact;
        pjsip_name_addr *dlg_info_name_addr;
        pjsip_sip_uri *dlg_info_uri;
+       pjsip_sip_uri *dlg_contact_uri;
        int restricted;
 
        if (!session->channel || session->saved_from_hdr) {
@@ -783,11 +785,16 @@ static void set_from_header(struct ast_sip_session *session)
 
        dlg_pool = session->inv_session->dlg->pool;
        dlg_info = session->inv_session->dlg->local.info;
+       dlg_contact = session->inv_session->dlg->local.contact;
        dlg_info_name_addr = (pjsip_name_addr *) dlg_info->uri;
        dlg_info_uri = pjsip_uri_get_uri(dlg_info_name_addr);
+       dlg_contact_uri = (pjsip_sip_uri*)pjsip_uri_get_uri(dlg_contact->uri);
 
        if (session->endpoint->id.trust_outbound || !restricted) {
                ast_sip_modify_id_header(dlg_pool, dlg_info, &connected_id);
+               if (ast_sip_get_use_callerid_contact() && ast_strlen_zero(session->endpoint->contact_user)) {
+                       pj_strdup2(dlg_pool, &dlg_contact_uri->user, S_COR(connected_id.number.valid, connected_id.number.str, ""));
+               }
        }
 
        ast_party_id_free(&connected_id);
@@ -817,6 +824,10 @@ static void set_from_header(struct ast_sip_session *session)
                        pj_strdup2(dlg_pool, &dlg_info_uri->user, "anonymous");
                }
 
+               if (ast_sip_get_use_callerid_contact() && ast_strlen_zero(session->endpoint->contact_user)) {
+                       pj_strdup2(dlg_pool, &dlg_contact_uri->user, "anonymous");
+               }
+
                if (ast_strlen_zero(session->endpoint->fromdomain)) {
                        pj_strdup2(dlg_pool, &dlg_info_uri->host, "anonymous.invalid");
                }