#include "msg.h"

Macros
#define	SMS_PARAM_UNDEFINED MSG_PARAM_UNDEFINED

#define	MC_UNDEF SMS_PARAM_UNDEFINED

#define	MC_CLASS0 0

#define	MC_CLASS1 1

#define	MC_CLASS2 2

#define	MC_CLASS3 3

#define	MWI_UNDEF SMS_PARAM_UNDEFINED

#define	MWI_VOICE_ON 0

#define	MWI_FAX_ON 1

#define	MWI_EMAIL_ON 2

#define	MWI_OTHER_ON 3

#define	MWI_VOICE_OFF 4

#define	MWI_FAX_OFF 5

#define	MWI_EMAIL_OFF 6

#define	MWI_OTHER_OFF 7

#define	DC_UNDEF SMS_PARAM_UNDEFINED

#define	DC_7BIT 0

#define	DC_8BIT 1

#define	DC_UCS2 2

#define	COMPRESS_UNDEF SMS_PARAM_UNDEFINED

#define	COMPRESS_OFF 0

#define	COMPRESS_ON 1

#define	RPI_UNDEF SMS_PARAM_UNDEFINED

#define	RPI_OFF 0

#define	RPI_ON 1

#define	SMS_7BIT_MAX_LEN 160

#define	SMS_8BIT_MAX_LEN 140

#define	SMS_UCS2_MAX_LEN 70

#define	MAX_SMS_OCTETS 140

Functions
int	fields_to_dcs (Msg *msg, int mode)

int	dcs_to_fields (Msg **msg, int mode)

int	sms_msgdata_len (Msg *msg)

int	sms_swap (Msg *msg)

List *	sms_split (Msg orig, Octstr header, Octstr footer, Octstr nonlast_suffix, Octstr *split_chars, int catenate, unsigned long msg_sequence, int max_messages, int max_octets)

void	prepend_catenation_udh (Msg *sms, int part_no, int num_messages, int msg_sequence)

int	sms_priority_compare (const void a, const void b)

int	sms_charset_processing (Octstr charset, Octstr body, int coding)

Macro Definition Documentation

◆ COMPRESS_OFF

#define COMPRESS_OFF 0

Definition at line 115 of file sms.h.

◆ COMPRESS_ON

#define COMPRESS_ON 1

Definition at line 116 of file sms.h.

Referenced by fields_to_dcs().

◆ COMPRESS_UNDEF

#define COMPRESS_UNDEF SMS_PARAM_UNDEFINED

Definition at line 114 of file sms.h.

◆ DC_7BIT

◆ DC_8BIT

#define DC_8BIT 1

Definition at line 111 of file sms.h.

Referenced by at2_pdu_decode_deliver_sm(), at2_pdu_encode(), bb_alog_sms(), brunet_send_sms(), clickatell_send_sms(), convert_charset(), data_sm_to_msg(), dcs_to_fields(), extract_msgdata_part_by_coding(), fields_to_dcs(), fill_message(), get_pattern(), handle_mo_dcs(), init_batch(), msg_to_bb(), msg_to_emimsg(), msg_to_pdu(), obey_request(), ois_adjust_sm_text(), ois_append_data_coding_scheme(), ois_append_submission_options(), ota_pack_message(), ota_tokenize_bookmarks(), ota_tokenize_settings(), pack_sms_datagram(), packet_encode_message(), pdu_to_msg(), sema_receive_msg(), sms_split(), sms_to_client(), smsbox_req_handle(), smsbox_sendsms_post(), soap_bouyg_content_attribute(), soap_mobitai_content_attribute(), soap_msgdata_attribute(), soap_msgtype_deps(), soap_o2o_msgdata_attribute(), url_result_thread(), and urltrans_fill_escape_codes().

◆ DC_UCS2

◆ DC_UNDEF

#define DC_UNDEF SMS_PARAM_UNDEFINED

◆ MAX_SMS_OCTETS

#define MAX_SMS_OCTETS 140

Definition at line 129 of file sms.h.

Referenced by dispatch_datagram(), generic_receive_sms(), kannel_receive_sms(), run_batch(), smsbox_req_handle(), and smscconn_create().

◆ MC_CLASS0

#define MC_CLASS0 0

Definition at line 94 of file sms.h.

◆ MC_CLASS1

#define MC_CLASS1 1

Definition at line 95 of file sms.h.

◆ MC_CLASS2

#define MC_CLASS2 2

Definition at line 96 of file sms.h.

◆ MC_CLASS3

#define MC_CLASS3 3

Definition at line 97 of file sms.h.

◆ MC_UNDEF

#define MC_UNDEF SMS_PARAM_UNDEFINED

Definition at line 93 of file sms.h.

Referenced by dcs_to_fields(), fields_to_dcs(), kannel_send_sms(), msg_to_pdu(), ois_adjust_sm_text(), pack_sms_datagram(), and pdu_to_msg().

◆ MWI_EMAIL_OFF

#define MWI_EMAIL_OFF 6

Definition at line 106 of file sms.h.

◆ MWI_EMAIL_ON

#define MWI_EMAIL_ON 2

Definition at line 102 of file sms.h.

◆ MWI_FAX_OFF

#define MWI_FAX_OFF 5

Definition at line 105 of file sms.h.

◆ MWI_FAX_ON

#define MWI_FAX_ON 1

Definition at line 101 of file sms.h.

◆ MWI_OTHER_OFF

#define MWI_OTHER_OFF 7

Definition at line 107 of file sms.h.

◆ MWI_OTHER_ON

#define MWI_OTHER_ON 3

Definition at line 103 of file sms.h.

◆ MWI_UNDEF

#define MWI_UNDEF SMS_PARAM_UNDEFINED

Definition at line 99 of file sms.h.

Referenced by fields_to_dcs(), kannel_send_sms(), msg_to_pdu(), and pack_sms_datagram().

◆ MWI_VOICE_OFF

#define MWI_VOICE_OFF 4

Definition at line 104 of file sms.h.

◆ MWI_VOICE_ON

#define MWI_VOICE_ON 0

Definition at line 100 of file sms.h.

◆ RPI_OFF

#define RPI_OFF 0

Definition at line 119 of file sms.h.

◆ RPI_ON

#define RPI_ON 1

Definition at line 120 of file sms.h.

◆ RPI_UNDEF

#define RPI_UNDEF SMS_PARAM_UNDEFINED

Definition at line 118 of file sms.h.

◆ SMS_7BIT_MAX_LEN

#define SMS_7BIT_MAX_LEN 160

Definition at line 122 of file sms.h.

Referenced by at2_pdu_encode().

◆ SMS_8BIT_MAX_LEN

#define SMS_8BIT_MAX_LEN 140

Definition at line 123 of file sms.h.

Referenced by at2_pdu_encode().

◆ SMS_PARAM_UNDEFINED

#define SMS_PARAM_UNDEFINED MSG_PARAM_UNDEFINED

◆ SMS_UCS2_MAX_LEN

#define SMS_UCS2_MAX_LEN 70

Definition at line 124 of file sms.h.

Function Documentation

◆ dcs_to_fields()

int dcs_to_fields	(	Msg **	msg,
		int	mode
	)

Definition at line 139 of file sms.c.

References DC_7BIT, DC_8BIT, DC_UCS2, and MC_UNDEF.

Referenced by at2_pdu_decode_deliver_sm(), cimd2_accept_message(), data_sm_to_msg(), handle_operation(), oisd_accept_message(), and pdu_to_msg().

 {
     /* Non-MWI Mode 1 */
     if ((dcs & 0xF0) == 0xF0) { 
         dcs &= 0x07;
         (*msg)->sms.coding = (dcs & 0x04) ? DC_8BIT : DC_7BIT; /* grab bit 2 */
         (*msg)->sms.mclass = dcs & 0x03; /* grab bits 1,0 */
         (*msg)->sms.alt_dcs = 1; /* set 0xFX data coding */
     }
     
     /* Non-MWI Mode 0 */
     else if ((dcs & 0xC0) == 0x00) { 
         (*msg)->sms.alt_dcs = 0;
         (*msg)->sms.compress = ((dcs & 0x20) == 0x20) ? 1 : 0; /* grab bit 5 */
         (*msg)->sms.mclass = ((dcs & 0x10) == 0x10) ? dcs & 0x03 : MC_UNDEF; 
                         /* grab bit 0,1 if bit 4 is on */
         (*msg)->sms.coding = (dcs & 0x0C) >> 2; /* grab bit 3,2 */
     }
 
     /* MWI */
     else if ((dcs & 0xC0) == 0xC0) { 
         (*msg)->sms.alt_dcs = 0;
         (*msg)->sms.coding = ((dcs & 0x30) == 0x30) ? DC_UCS2 : DC_7BIT;
         if (!(dcs & 0x08))
             dcs |= 0x04; /* if bit 3 is active, have mwi += 4 */
         dcs &= 0x07;
         (*msg)->sms.mwi = dcs ; /* grab bits 1,0 */
     } 
     
     else {
         return 0;
     }
 
     return 1;
 }

◆ fields_to_dcs()

int fields_to_dcs	(	Msg *	msg,
		int	mode
	)

Definition at line 73 of file sms.c.

References COMPRESS_ON, DC_7BIT, DC_8BIT, DC_UCS2, DC_UNDEF, MC_UNDEF, msg, MWI_UNDEF, octstr_len(), and SMS_PARAM_UNDEFINED.

Referenced by at2_pdu_encode(), brunet_send_sms(), msg_to_emimsg(), msg_to_pdu(), packet_encode_message(), urltrans_fill_escape_codes(), and xidris_send_sms().

 {
     int dcs=0;
 
     /* Coding defaults to 7BIT or to 8BIT if udh is set */
     if (msg->sms.coding == DC_UNDEF) {
     if (octstr_len(msg->sms.udhdata))
       msg->sms.coding = DC_8BIT;
     else
       msg->sms.coding = DC_7BIT;
     }
 
 
     /* MWI */
     if (msg->sms.mwi != MWI_UNDEF) {
     dcs = msg->sms.mwi;  /* sets bits 2, 1 and 0 */
 
     if (dcs & 0x04) 
         dcs = (dcs & 0x03) | 0xC0; /* MWI Inactive */
     else {
         dcs = (dcs & 0x03) | 0x08; /* MWI Active, sets bit 3 */
 
         if (! octstr_len(msg->sms.msgdata))
         dcs |= 0xC0;    /* Discard */
         else
         if (msg->sms.coding == DC_7BIT)
             dcs |= 0xD0;    /* 7bit */
         else
             dcs |= 0xE0;    /* UCS-2 */
             /* XXX Shouldn't happen to have mwi and dc=DC_8BIT! */
     }
     }
 
     /* Non-MWI */
     else {
     /* mode 0 or mode UNDEF */
     if (mode == 0 || mode == SMS_PARAM_UNDEFINED || msg->sms.coding == DC_UCS2 
         || msg->sms.compress == COMPRESS_ON) { 
         /* bits 7,6 are 0 */
         if (msg->sms.compress == COMPRESS_ON)
         dcs |= 0x20; /* sets bit 5 */
         if (msg->sms.mclass != MC_UNDEF)
         dcs |= (0x10 | msg->sms.mclass); /* sets bit 4,1,0 */
         if (msg->sms.coding != DC_UNDEF)
         dcs |= (msg->sms.coding << 2); /* sets bit 3,2 */
     } 
     
     /* mode 1 */
     else {
         dcs |= 0xF0; /* sets bits 7-3 */
         if(msg->sms.coding != DC_UNDEF)
         dcs |= (msg->sms.coding << 2); /* only DC_7BIT or DC_8BIT, sets bit 2*/
         if (msg->sms.mclass == MC_UNDEF)
                 dcs |= 1; /* default meaning: ME specific */
             else
                 dcs |= msg->sms.mclass; /* sets bit 1,0 */
     }
     }
 
     return dcs;
 }

◆ prepend_catenation_udh()

void prepend_catenation_udh	(	Msg *	sms,
		int	part_no,
		int	num_messages,
		int	msg_sequence
	)

Create multipart UDH

Definition at line 224 of file sms.c.

References CATENATE_UDH_LEN, num_messages, octstr_append_char(), octstr_create, octstr_format_append(), octstr_len(), and octstr_set_char().

Referenced by data_sm_to_msg(), pdu_to_msg(), and sms_split().

 {
     if (sms->sms.udhdata == NULL)
         sms->sms.udhdata = octstr_create("");
     if (octstr_len(sms->sms.udhdata) == 0)
     octstr_append_char(sms->sms.udhdata, CATENATE_UDH_LEN);
     octstr_format_append(sms->sms.udhdata, "%c\3%c%c%c", 
                          0, msg_sequence, num_messages, part_no);
 
      /* Set the number of messages left, if any */
      if (part_no < num_messages)
         sms->sms.msg_left = num_messages - part_no;
      else
         sms->sms.msg_left = 0;
     /* 
      * Now that we added the concatenation information the
      * length is all wrong. we need to recalculate it. 
      */
     octstr_set_char(sms->sms.udhdata, 0, octstr_len(sms->sms.udhdata) - 1 );
 }

◆ sms_charset_processing()

int sms_charset_processing	(	Octstr *	charset,
		Octstr *	body,
		int	coding
	)

Definition at line 419 of file sms.c.

References charset, charset_convert(), coding, DC_7BIT, DC_UCS2, error(), octstr_get_cstr, and octstr_len().

Referenced by generic_receive_sms(), kannel_receive_sms(), smsbox_req_handle(), and url_result_thread().

 {
     int resultcode = 0;
 
     /*
     debug("gw.sms", 0, "%s: enter, charset=%s, coding=%d, msgdata is:",
           __func__, octstr_get_cstr(charset), coding);
     octstr_dump(body, 0);
     */
 
     if (octstr_len(charset)) {
         if (coding == DC_7BIT) {
             /*
              * For 7 bit, convert to UTF-8
              */
             if (charset_convert(body, octstr_get_cstr(charset), "UTF-8") < 0) {
                 error(0, "Failed to convert msgdata from charset <%s> to <%s>, will leave as is.",
                       octstr_get_cstr(charset), "UTF-8");
                 resultcode = -1;
             }
         } else if (coding == DC_UCS2) {
             /*
              * For UCS-2, convert to UTF-16BE
              */
             if (charset_convert(body, octstr_get_cstr(charset), "UTF-16BE") < 0) {
                 error(0, "Failed to convert msgdata from charset <%s> to <%s>, will leave as is.",
                       octstr_get_cstr(charset), "UTF-16BE");
                 resultcode = -1;
             }
         }
     }
 
     /*
     debug("gw.sms", 0, "%s: exit, charset=%s, coding=%d, msgdata is:",
           __func__, octstr_get_cstr(charset), coding);
     octstr_dump(body, 0);
     */
 
     return resultcode;
 }

◆ sms_msgdata_len()

int sms_msgdata_len ( Msg * msg )

Definition at line 180 of file sms.c.

References charset_utf8_to_gsm(), DC_7BIT, msg, octstr_destroy(), octstr_duplicate, and octstr_len().

Referenced by at2_pdu_encode(), and sms_split().

 {
     int ret = 0;
     Octstr* msgdata = NULL;
     
     /* got a bad input */
     if (!msg || !msg->sms.msgdata) 
         return -1;
 
     if (msg->sms.coding == DC_7BIT) {
         msgdata = octstr_duplicate(msg->sms.msgdata);
         charset_utf8_to_gsm(msgdata);
         ret = octstr_len(msgdata);
         octstr_destroy(msgdata);
     } else 
         ret = octstr_len(msg->sms.msgdata);
 
     return ret;
 }

◆ sms_priority_compare()

int sms_priority_compare	(	const void *	a,
		const void *	b
	)

Compare priority and time of two sms's.

Returns: -1 of a < b; 0 a = b; 1 a > b

Definition at line 395 of file sms.c.

References gw_assert().

Referenced by smpp_create(), smsc_at2_create(), and smsc_emi2_create().

 {
     int ret;
     Msg *msg1 = (Msg*)a, *msg2 = (Msg*)b;
     gw_assert(msg_type(msg1) == sms);
     gw_assert(msg_type(msg2) == sms);
     
     if (msg1->sms.priority > msg2->sms.priority)
         ret = 1;
     else if (msg1->sms.priority < msg2->sms.priority)
         ret = -1;
     else {
         if (msg1->sms.time > msg2->sms.time)
             ret = 1;
         else if (msg1->sms.time < msg2->sms.time)
             ret = -1;
         else
             ret = 0;
     }
     
     return ret;
 }

◆ sms_split()

List* sms_split	(	Msg *	orig,
		Octstr *	header,
		Octstr *	footer,
		Octstr *	nonlast_suffix,
		Octstr *	split_chars,
		int	catenate,
		unsigned long	msg_sequence,
		int	max_messages,
		int	max_octets
	)

Definition at line 309 of file sms.c.

References CATENATE_UDH_LEN, DC_8BIT, DC_UCS2, DLR_IS_ENABLED, extract_msgdata_part_by_coding(), gwlist_append(), gwlist_create, gwlist_get(), max_messages, msg_destroy(), msg_duplicate(), octstr_append(), octstr_destroy(), octstr_insert(), octstr_len(), prepend_catenation_udh(), sms_msgdata_len(), and uuid_generate().

Referenced by dispatch_datagram(), msg_to_pdu(), run_batch(), send_message(), and smscconn_send().

 {
     long max_part_len, udh_len, hf_len, nlsuf_len;
     unsigned long total_messages, msgno;
     long last;
     List *list;
     Msg *part, *temp;
 
     hf_len = octstr_len(header) + octstr_len(footer);
     nlsuf_len = octstr_len(nonlast_suffix);
     udh_len = octstr_len(orig->sms.udhdata);
 
     /* First check whether the message is under one-part maximum */
     if (orig->sms.coding == DC_8BIT || orig->sms.coding == DC_UCS2)
         max_part_len = max_octets - udh_len - hf_len;
     else
         max_part_len = (max_octets - udh_len) * 8 / 7 - hf_len;
 
     if (sms_msgdata_len(orig) > max_part_len && catenate) {
         /* Change part length to take concatenation overhead into account */
         if (udh_len == 0)
             udh_len = 1;  /* Add the udh total length octet */
         udh_len += CATENATE_UDH_LEN;
         if (orig->sms.coding == DC_8BIT || orig->sms.coding == DC_UCS2)
             max_part_len = max_octets - udh_len - hf_len;
         else
             max_part_len = (max_octets - udh_len) * 8 / 7 - hf_len;
     }
 
     /* ensure max_part_len is never negativ */
     max_part_len = max_part_len > 0 ? max_part_len : 0;
 
     temp = msg_duplicate(orig);
     msgno = 0;
     list = gwlist_create();
 
     last = 0;
     do {
         msgno++;
         part = msg_duplicate(orig);
 
         /* 
          * if its a DLR request message getting split, 
          * only ask DLR for the first one 
          */
         if ((msgno > 1) && DLR_IS_ENABLED(part->sms.dlr_mask)) {
             octstr_destroy(part->sms.dlr_url);
             part->sms.dlr_url = NULL;
             part->sms.dlr_mask = 0;
         }
         octstr_destroy(part->sms.msgdata);
         if (sms_msgdata_len(temp) <= max_part_len || msgno == max_messages)
             last = 1;
 
         part->sms.msgdata = 
             extract_msgdata_part_by_coding(temp, split_chars,
                                            max_part_len - nlsuf_len);
         /* create new id for every part, except last */
         if (!last)
             uuid_generate(part->sms.id);
 
         if (header)
             octstr_insert(part->sms.msgdata, header, 0);
         if (footer)
             octstr_append(part->sms.msgdata, footer);
         if (!last && nonlast_suffix)
             octstr_append(part->sms.msgdata, nonlast_suffix);
         gwlist_append(list, part);
     } while (!last);
 
     total_messages = msgno;
     msg_destroy(temp);
     if (catenate && total_messages > 1) {
         for (msgno = 1; msgno <= total_messages; msgno++) {
             part = gwlist_get(list, msgno - 1);
             prepend_catenation_udh(part, msgno, total_messages, msg_sequence);
         }
     }
 
     return list;
 }

◆ sms_swap()

int sms_swap ( Msg * msg )

Definition at line 201 of file sms.c.

References msg.

Referenced by obey_request_thread().

 {
     Octstr *sender = NULL;
 
     if (msg->sms.sender != NULL && msg->sms.receiver != NULL) {
         sender = msg->sms.sender;
         msg->sms.sender = msg->sms.receiver;
         msg->sms.receiver = sender;
 
         return 1;
     }
 
     return 0;
 }

Macros

Functions