modules/sipt add charging indication

modules/sipt/README

@@ -39,6 +39,7 @@ Torrey Searle
                       $sipt_called_party_nai
 
               4.7. $sipt(event_info)
+              4.8. $sipt(backward_call_indicator.charge_indicator)
 
    List of Tables
 
@@ -47,6 +48,7 @@ Torrey Searle
    1.3. Calling Nature of Address Values
    1.4. Called Nature of Address Values
    1.5. Event Info Values
+   1.6. Charge Indicator Values
 
    List of Examples
 
@@ -87,6 +89,7 @@ Chapter 1. Admin Guide
                 $sipt(called_party_number.nai) / $sipt_called_party_nai
 
         4.7. $sipt(event_info)
+        4.8. $sipt(backward_call_indicator.charge_indicator)
 
 1. Overview
 
@@ -166,6 +169,7 @@ sipt_set_calling($fU, 4, 0, 3);
           $sipt(called_party_number.nai) / $sipt_called_party_nai
 
    4.7. $sipt(event_info)
+   4.8. $sipt(backward_call_indicator.charge_indicator)
 
 4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
 
@@ -305,3 +309,15 @@ if($sipt(called_party_number.nai) == 3)
    4 Call forward on busy
    5 Call forward on no reply
    6 Call forward unconditional
+
+4.8. $sipt(backward_call_indicator.charge_indicator)
+
+   Returns the value of the charge indication of the backward call
+   indicator header in the ACM or COT message. Returns -1 if there is a
+   parsing error.
+
+   Table 1.6. Charge Indicator Values
+   0 no indication
+   1 no charge
+   2 charge
+   3 spare

modules/sipt/doc/sipt.txt

@@ -1,323 +0,0 @@
-sipt Module
-
-Torrey Searle
-
-   Voxbone SA
-   <[email protected]>
-
-   Copyright © 2013 Voxbone SA
-     __________________________________________________________________
-
-   Table of Contents
-
-   1. Admin Guide
-
-        1. Overview
-        2. Dependencies
-        3. Functions
-
-              3.1. sipt_destination(destination, hops, nai)
-              3.2. sipt_set_bci_1(charge_indicator, called_status,
-                      called_category, e2e_indicator)
-
-              3.3. sipt_set_calling(origin, nai, presentation, screening)
-
-        4. Exported pseudo-variables
-
-              4.1. $sipt(calling_party_number.presentation) /
-                      $sipt_presentation
-
-              4.2. $sipt(calling_party_number.screening) / $sipt_screening
-              4.3. $sipt(hop_counter) / $sipt_hop_counter
-              4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
-              4.5. $sipt(calling_party_number.nature_of_address) /
-                      $sipt.(calling_party_number.nai) /
-                      $sipt_calling_party_nai
-
-              4.6. $sipt(called_party_number.nature_of_address) /
-                      $sipt(called_party_number.nai) /
-                      $sipt_called_party_nai
-
-              4.7. $sipt(event_info)
-              4.8. $sipt(backward_call_indicator.charge_indicator)
-
-   List of Tables
-
-   1.1. Address Presentation Restricted Indicator Values
-   1.2. Screening Indicator Values
-   1.3. Calling Nature of Address Values
-   1.4. Called Nature of Address Values
-   1.5. Event Info Values
-   1.6. Charge Indicator Values
-
-   List of Examples
-
-   1.1. sipt_destination(destination, hops, nai) usage
-   1.2. sipt_destination(destination, hops, nai) usage
-   1.3. sipt_set_calling(origin, nai, presentation, screening) usage
-   1.4. sipt_presentation pseudo-variable usage
-   1.5. sipt_screening pseudo-variable usage
-   1.6. sipt_hop_counter pseudo-variable usage
-   1.7. sipt_cpc pseudo-variable usage
-   1.8. sipt_calling_party_nai pseudo-variable usage
-   1.9. sipt_called_party_nai pseudo-variable usage
-
-Chapter 1. Admin Guide
-
-   Table of Contents
-
-   1. Overview
-   2. Dependencies
-   3. Functions
-
-        3.1. sipt_destination(destination, hops, nai)
-        3.2. sipt_set_bci_1(charge_indicator, called_status,
-                called_category, e2e_indicator)
-
-        3.3. sipt_set_calling(origin, nai, presentation, screening)
-
-   4. Exported pseudo-variables
-
-        4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
-        4.2. $sipt(calling_party_number.screening) / $sipt_screening
-        4.3. $sipt(hop_counter) / $sipt_hop_counter
-        4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
-        4.5. $sipt(calling_party_number.nature_of_address) /
-                $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
-
-        4.6. $sipt(called_party_number.nature_of_address) /
-                $sipt(called_party_number.nai) / $sipt_called_party_nai
-
-        4.7. $sipt(event_info)
-        4.8. $sipt(backward_call_indicator.charge_indicator)
-
-1. Overview
-
-   Module for updating ISUP encapuslated in SIP (SIP-T/SIP-I)
-
-   The sipt module can be used to update various ss7 headers contained
-   inside a message.
-
-2. Dependencies
-
-   The module depends on the following modules (in the other words the
-   listed modules must be loaded before this module):
-     * none
-
-3. Functions
-
-   3.1. sipt_destination(destination, hops, nai)
-   3.2. sipt_set_bci_1(charge_indicator, called_status, called_category,
-          e2e_indicator)
-
-   3.3. sipt_set_calling(origin, nai, presentation, screening)
-
-3.1. sipt_destination(destination, hops, nai)
-
-   updates the IAM in the body if it exists, setting the called party
-   number to “destination” with the nature address specified in “nai” and
-   decrementing the hop counter value if present. If the hop counter
-   header is missing it will be added with the value of “hops”.
-
-   Example 1.1. sipt_destination(destination, hops, nai) usage
-...
-# update the destination number to our current request uri,
-# setting nature of address to international
-$rU = "19495551234";
-sipt_destination($rU, 31, 4);
-...
-
-3.2. sipt_set_bci_1(charge_indicator, called_status, called_category,
-e2e_indicator)
-
-   updates the first byte of the backward call indicator in the ACM or COT
-   in the body if setting the Charge Indicator to “charge_indicator”, the
-   Called party's status indicator in “called_status”, the Called party's
-   category indicator in “called_category” and the End to End Method
-   Indicator with the value of the value of “e2e_indicator”.
-
-   Example 1.2. sipt_destination(destination, hops, nai) usage
-...
-# set bci for charging, subscriber free, ordinary, no e2e available
-sipt_set_bci_1("2", "1", "1", "0");
-...
-
-3.3. sipt_set_calling(origin, nai, presentation, screening)
-
-   updates the IAM in the body if it exists, setting (or adding) the
-   calling party number to “origin” with the nature address specified in
-   “nai” and setting the presentation and screening values to
-   “presentation” and “screening”.
-
-   Example 1.3. sipt_set_calling(origin, nai, presentation, screening)
-   usage
-...
-# update the calling party to the value in the from header
-sipt_set_calling($fU, 4, 0, 3);
-...
-
-4. Exported pseudo-variables
-
-   4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
-   4.2. $sipt(calling_party_number.screening) / $sipt_screening
-   4.3. $sipt(hop_counter) / $sipt_hop_counter
-   4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
-   4.5. $sipt(calling_party_number.nature_of_address) /
-          $sipt.(calling_party_number.nai) / $sipt_calling_party_nai
-
-   4.6. $sipt(called_party_number.nature_of_address) /
-          $sipt(called_party_number.nai) / $sipt_called_party_nai
-
-   4.7. $sipt(event_info)
-   4.8. $sipt(backward_call_indicator.charge_indicator)
-
-4.1. $sipt(calling_party_number.presentation) / $sipt_presentation
-
-   Returns the value of the Address presentation restricted indicator
-   contained in the Calling Party Number header of the IAM message if it
-   exists. Returns -1 if there isn't a Calling Party Number header.
-
-   Table 1.1. Address Presentation Restricted Indicator Values
-   0 presentation allowed
-   1 presentation restricted
-   2 address not avail (national use)
-   3 spare
-
-   Example 1.4. sipt_presentation pseudo-variable usage
-...
-# add privacy header if restriction is requested
-if($sipt(calling_party_number.presentation) == 1)
-{
-        append_hf("Privacy: id\r\n");
-        $fn = "Anonymous";
-}
-
-...
-
-4.2. $sipt(calling_party_number.screening) / $sipt_screening
-
-   Returns the value of the Screening Indicator contained in the Calling
-   Party Number header of the IAM message if it exists. Returns -1 if
-   there isn't a Calling Party Number header.
-
-   Table 1.2. Screening Indicator Values
-   0 Reserved (user provided, not verified)
-   1 User Provided, Verified and Passed
-   2 Reserved (user provided, verified and failed)
-   3 Network provided
-
-   Example 1.5. sipt_screening pseudo-variable usage
-...
-
-# remove P-Asserted-Identity header if the screening isn't verified
-# or network provided
-$avp(s:screening) = $sipt(calling_party_number.screening);
-if($avp(s:screening) != 1 && $avp(s:screening) != 3)
-{
-        remove_hf("P-Asserted-Id");
-}
-
-...
-
-4.3. $sipt(hop_counter) / $sipt_hop_counter
-
-   Returns the value of the Hop Counter for the IAM message if it exists.
-   Returns -1 if there isn't a hop counter.
-
-   Example 1.6. sipt_hop_counter pseudo-variable usage
-...
-# get the hop counter and update the Max-Forwards header if it exists
-$avp(s:hop) = $sipt(hop_counter);
-if($avp(s:hop) > 0)
-{
-        remove_hf("Max-Forwards");
-        append_hf("Max-Forwards: $avp(s:hop)\r\n");
-}
-
-...
-
-4.4. $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc
-
-   Returns the value of the Calling Party Category for the IAM message.
-   Returns -1 if there is a parsing error.
-
-   Example 1.7. sipt_cpc pseudo-variable usage
-...
-# get the Cpc code and set put it in a custom sip header
-append_hf("X-CPC: $sipt(cpc)\r\n");
-
-...
-
-4.5. $sipt(calling_party_number.nature_of_address) /
-$sipt.(calling_party_number.nai) / $sipt_calling_party_nai
-
-   Returns the value of the Nature of Address Indicator of the Calling
-   Party for the IAM message. Returns -1 if there is a parsing error or if
-   the Calling Party Number is not present.
-
-   Table 1.3. Calling Nature of Address Values
-   0 Spare
-   1 Subscriber Number (national use)
-   2 Unknown (national use)
-   3 National (significant) number (national use)
-   4 International use
-
-   Example 1.8. sipt_calling_party_nai pseudo-variable usage
-...
-# get the Calling Nai and add country code if national
-if($sipt(calling_party_number.nai) == 3)
-{
-        $fU = "32" + "$fU";
-}
-
-...
-
-4.6. $sipt(called_party_number.nature_of_address) /
-$sipt(called_party_number.nai) / $sipt_called_party_nai
-
-   Returns the value of the Nature of Address Indicator of the Called
-   Party for the IAM message. Returns -1 if there is a parsing error.
-
-   Table 1.4. Called Nature of Address Values
-   0 Spare
-   1 Subscriber Number (national use)
-   2 Unknown (national use)
-   3 National (significant) number
-   4 International use
-   5 Network-specific number (national use)
-
-   Example 1.9. sipt_called_party_nai pseudo-variable usage
-...
-# get the Called Nai and add country code if national
-if($sipt(called_party_number.nai) == 3)
-{
-        $rU = "32" + "$rU";
-}
-
-...
-
-4.7. $sipt(event_info)
-
-   Returns the value of the Event Info header of the CPG message. Returns
-   -1 if there is a parsing error.
-
-   Table 1.5. Event Info Values
-   0 Spare
-   1 ALERTING
-   2 PROGRESS
-   3 In-band information or an appropriate pattern is now available
-   4 Call forward on busy
-   5 Call forward on no reply
-   6 Call forward unconditional
-
-4.8. $sipt(backward_call_indicator.charge_indicator)
-
-   Returns the value of the charge indication of the backward call
-   indicator header in the ACM or COT message. Returns -1 if there is a
-   parsing error.
-
-   Table 1.6. Charge Indicator Values
-   0 no indication
-   1 no charge
-   2 charge
-   3 spare

modules/sipt/doc/sipt_admin.xml

@@ -291,6 +291,26 @@ if($sipt(called_party_number.nai) == 3)
 			</tgroup>
 		</table>
 	</section>
+	<section id="sipt.v.sipt_backward_call_indicator_charge_indicator">
+		<title><varname>$sipt(backward_call_indicator.charge_indicator)</varname></title>
+		<para>
+			Returns the value of the charge indication 
+			of the backward call indicator header in 
+			the ACM or COT message.
+			Returns -1 if there is a parsing error.
+		</para>
+		<table>
+			<title>Charge Indicator Values</title>
+			<tgroup cols="2">
+				<tbody>
+					<row><entry>0</entry><entry>no indication</entry></row>
+					<row><entry>1</entry><entry>no charge</entry></row>
+					<row><entry>2</entry><entry>charge</entry></row>
+					<row><entry>3</entry><entry>spare</entry></row>
+				</tbody>
+			</tgroup>
+		</table>
+	</section>
 
 </section>
 </chapter>

modules/sipt/sipt.c

@@ -49,6 +49,7 @@ static int sipt_get_calling_party_nai(struct sip_msg *msg, pv_param_t *param, pv
 static int sipt_get_presentation(struct sip_msg *msg, pv_param_t *param, pv_value_t *res);
 static int sipt_get_screening(struct sip_msg *msg, pv_param_t *param, pv_value_t *res);
 static int sipt_get_called_party_nai(struct sip_msg *msg, pv_param_t *param, pv_value_t *res);
+static int sipt_get_charge_indicator(struct sip_msg *msg, pv_param_t *param, pv_value_t *res);
 
 /* New API */
 int sipt_parse_pv_name(pv_spec_p sp, str *in);
@@ -92,6 +93,10 @@ static sipt_header_map_t sipt_header_mapping[] =
 		{{NULL, 0}} },
 	{"EVENT_INFO", ISUP_PARM_EVENT_INFO, 
 		{{NULL, 0}} },
+	{"BACKWARD_CALL_INDICATOR", ISUP_PARM_BACKWARD_CALL_IND,
+		{{"CHARGE_INDICATOR", 1}, 
+			{NULL, 0}
+		}},
 	{ NULL, 0, {}}
 };
 
@@ -311,6 +316,28 @@ static int sipt_get_screening(struct sip_msg *msg, pv_param_t *param, pv_value_t
 	return 0;
 }
 
+static int sipt_get_charge_indicator(struct sip_msg *msg, pv_param_t *param, pv_value_t *res)
+{
+	str body;
+	body.s = get_body_part(msg, TYPE_APPLICATION,SUBTYPE_ISUP,&body.len);
+
+	if(body.s == NULL)
+	{
+		LM_INFO("No ISUP Message Found");
+		return -1;
+	}
+
+	if(body.s[0] != ISUP_COT && body.s[0] != ISUP_ACM)
+	{
+		LM_DBG("message not a COT or ACM\n");
+		return -1;
+	}
+	LM_DBG("about to get charge indicator\n");
+	
+	pv_get_sintval(msg, param, res, isup_get_charging_indicator((unsigned char*)body.s, body.len));
+	return 0;
+}
+
 static int sipt_get_called_party_nai(struct sip_msg *msg, pv_param_t *param, pv_value_t *res)
 {
 	str body;
@@ -471,6 +498,13 @@ static int sipt_get_pv(struct sip_msg *msg, pv_param_t *param, pv_value_t *res)
 			return sipt_get_hop_counter(msg, param, res);
 		case ISUP_PARM_EVENT_INFO:
 			return sipt_get_event_info(msg, param, res);
+		case ISUP_PARM_BACKWARD_CALL_IND:
+			switch(spv->sub_type)
+			{
+				case 1: /* charge_indicator */
+				return sipt_get_charge_indicator(msg, param, res);
+			}
+			break;
 	}
 
 	return -1;

modules/sipt/ss7.h

@@ -202,6 +202,7 @@ int isup_get_calling_party_nai(unsigned char *buf, int len);
 int isup_get_called_party_nai(unsigned char *buf, int len);
 int isup_get_screening(unsigned char *buf, int len);
 int isup_get_presentation(unsigned char *buf, int len);
+int isup_get_charging_indicator(unsigned char *buf, int len);
 int isup_update_destination(struct sdp_mangler * mangle, char * dest, int hops, int nai, unsigned char *buf, int len);
 int isup_update_bci_1(struct sdp_mangler * mangle, int charge_indicator, int called_status, int called_category, int e2e_indicator, unsigned char *buf, int len);
 int isup_update_calling(struct sdp_mangler * mangle, char * origin, int nai, int presentation, int screening, unsigned char * buf, int len);

modules/sipt/ss7_parser.c

@@ -305,6 +305,23 @@ int isup_get_called_party_nai(unsigned char *buf, int len)
 	return message->called_party_number[1]&0x7F;
 }
 
+
+int isup_get_charging_indicator(unsigned char *buf, int len) {
+	struct isup_acm_fixed * orig_message = (struct isup_acm_fixed*)buf;
+
+	// not an acm or cot? do nothing
+	if(orig_message->type != ISUP_ACM && orig_message->type != ISUP_COT)
+	{
+		return -1;
+	}
+
+	// add minus 1 because the optinal pointer is optional
+	if (len < sizeof(struct isup_acm_fixed) -1 )
+		return -1;
+
+	return (orig_message->backwards_call_ind[0] & 0x03);
+}
+
 int isup_update_bci_1(struct sdp_mangler * mangle, int charge_indicator, int called_status, int called_category, int e2e_indicator, unsigned char *buf, int len)
 {
 	struct isup_acm_fixed * orig_message = (struct isup_acm_fixed*)buf;