smsc_smasi.c File Reference

#include "gwlib/gwlib.h"
#include "msg.h"
#include "smsc_p.h"
#include "smasi_pdu.h"
#include "smscconn_p.h"
#include "bb_smscconn_cb.h"
#include "sms.h"
#include "dlr.h"

Go to the source code of this file.

Data Structures
struct	SMASI

Macros
#define	DEBUG   1
#define	SMASI_DEFAULT_PORT   21500
#define	SMASI_DEFAULT_PRIORITY   0
#define	MAX_PENDING_SUBMITS   10
#define	SMASI_THROTTLING_SLEEP_TIME   15
#define	SMASI_ENQUIRE_LINK_INTERVAL   30.0
#define	SMASI_OVERRIDE_SOURCE_TON   1
#define	SMASI_OVERRIDE_SOURCE_NPI   -1
#define	SMASI_OVERRIDE_DEST_TON   -1
#define	SMASI_OVERRIDE_DEST_NPI   -1

Functions
static void	dump_pdu (const char *msg, Octstr *id, SMASI_PDU *pdu)
static SMASI *	smasi_create (SMSCConn *conn)
static void	smasi_destroy (SMASI *smasi)
static void	escape_data (Octstr *data)
static void	unescape_data (Octstr *data)
static void	encode_binary_data (Octstr *data)
static void	decode_binary_data (Octstr *data)
static Octstr *	get_ton_npi_value (int override, int message)
static Octstr *	get_source_addr_ton (SMASI *smasi, Msg *msg)
static Octstr *	get_source_addr_npi (SMASI *smasi, Msg *msg)
static Octstr *	get_dest_addr_ton (SMASI *smasi, Msg *msg)
static Octstr *	get_dest_addr_npi (SMASI *smasi, Msg *msg)
static Octstr *	get_originator_type (SMASI *smasi, Octstr *originator)
static SMASI_PDU *	msg_to_pdu (SMASI *smasi, Msg *msg)
static Msg *	pdu_to_msg (SMASI_PDU *pdu)
static void	send_logoff (SMASI *smasi, Connection *conn)
static void	send_enquire_link (SMASI *smasi, Connection *conn, long *last_sent)
static int	send_pdu (Connection *conn, Octstr *id, SMASI_PDU *pdu)
static int	read_pdu (SMASI *smasi, Connection *conn, SMASI_PDU **pdu)
static void	handle_pdu (SMASI *smasi, Connection *conn, SMASI_PDU *pdu, long *pending_submits)
static Connection *	open_connection (SMASI *smasi)
static void	send_messages (SMASI *smasi, Connection *conn, long *pending_submits)
static void	smasi_thread (void *arg)
static long	queued_cb (SMSCConn *conn)
static int	send_msg_cb (SMSCConn *conn, Msg *msg)
static int	shutdown_cb (SMSCConn *conn, int finish_sending)
static int	init_configuration (SMASI *smasi, CfgGroup *config)
int	smsc_smasi_create (SMSCConn *conn, CfgGroup *config)

Variables
static Octstr *	colon = NULL
static Octstr *	assign = NULL
static Octstr *	comma = NULL
static Octstr *	cr = NULL
static Octstr *	lf = NULL

Macro Definition Documentation

DEBUG

#define DEBUG   1

Definition at line 91 of file smsc_smasi.c.

MAX_PENDING_SUBMITS

#define MAX_PENDING_SUBMITS   10

Definition at line 110 of file smsc_smasi.c.

Referenced by send_messages().

SMASI_DEFAULT_PORT

#define SMASI_DEFAULT_PORT   21500

Definition at line 108 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_DEFAULT_PRIORITY

#define SMASI_DEFAULT_PRIORITY   0

Definition at line 109 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_ENQUIRE_LINK_INTERVAL

#define SMASI_ENQUIRE_LINK_INTERVAL   30.0

Definition at line 112 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_OVERRIDE_DEST_NPI

#define SMASI_OVERRIDE_DEST_NPI   -1

Definition at line 128 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_OVERRIDE_DEST_TON

#define SMASI_OVERRIDE_DEST_TON   -1

Definition at line 127 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_OVERRIDE_SOURCE_NPI

#define SMASI_OVERRIDE_SOURCE_NPI   -1

Definition at line 126 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_OVERRIDE_SOURCE_TON

#define SMASI_OVERRIDE_SOURCE_TON   1

Definition at line 125 of file smsc_smasi.c.

Referenced by init_configuration().

SMASI_THROTTLING_SLEEP_TIME

#define SMASI_THROTTLING_SLEEP_TIME   15

Definition at line 111 of file smsc_smasi.c.

Referenced by smasi_thread().

Function Documentation

decode_binary_data()

static void decode_binary_data ( Octstr *  data )

static

Definition at line 341 of file smsc_smasi.c.

References check(), error(), octstr_append_char(), octstr_create, octstr_delete(), octstr_destroy(), octstr_get_char(), octstr_hex_to_binary(), octstr_insert(), and octstr_len().

Referenced by pdu_to_msg().

{
    long pos = 0;

    while (pos < octstr_len(data)) {
        int check = octstr_get_char(data, pos);

        if (check == ':') {
            Octstr *byte;
            int msb = octstr_get_char(data, pos + 1);
            int lsb = octstr_get_char(data, pos + 2);

            if (msb != -1 && lsb != -1) {
                byte = octstr_create("");
                octstr_append_char(byte, msb);
                octstr_append_char(byte, lsb);

                if (octstr_hex_to_binary(byte) != -1) {
                    /* Do inplace unescaping. */
                    octstr_delete(data, pos, 3);
                    octstr_insert(data, byte, pos);
                } else {
                    error(0, "Malformed binary encoded data.");
                }

                octstr_destroy(byte);
            }
        } 
        pos++;
    } 
}

dump_pdu()

static void dump_pdu ( const char *  msg, Octstr *  id, SMASI_PDU *  pdu  )

static

Definition at line 96 of file smsc_smasi.c.

References debug(), msg, octstr_get_cstr, and smasi_pdu_dump().

Referenced by send_enquire_link(), send_logoff(), send_pdu(), and smasi_thread().

{
    debug("bb.sms.smasi", 0, "SMASI[%s]: %s", octstr_get_cstr(id), msg);
    smasi_pdu_dump(pdu);
}

encode_binary_data()

static void encode_binary_data ( Octstr *  data )

static

Definition at line 305 of file smsc_smasi.c.

References octstr_append(), octstr_append_char(), octstr_create, octstr_delete(), octstr_destroy(), octstr_get_char(), and octstr_len().

Referenced by msg_to_pdu().

{
    Octstr *result = octstr_create("");
    long pos = 0;

    while (pos < octstr_len(data)) {
        int encode = octstr_get_char(data, pos);
        int msb = (encode & 0xf0) >> 4;
        int lsb = (encode & 0x0f) >> 0;

        if (msb == 0) msb = '0';
        else if (msb < 10) msb = '1' + msb - 1;
        else msb = 'a' + msb - 10;

        if (lsb == 0) lsb = '0';
        else if (lsb < 10) lsb = '1' + lsb - 1;
        else lsb = 'a' + lsb - 10;

        octstr_append_char(result, ':');
        octstr_append_char(result, msb);
        octstr_append_char(result, lsb);

        pos++;
    } 
    /* Replace binary data octet string with ASCII representation. */
    octstr_delete(data, 0, octstr_len(data));
    octstr_append(data, result);
    octstr_destroy(result);
}

escape_data()

static void escape_data ( Octstr *  data )

static

Definition at line 229 of file smsc_smasi.c.

References assign, check(), colon, comma, cr, lf, octstr_delete(), octstr_get_char(), octstr_insert(), and octstr_len().

Referenced by msg_to_pdu().

{
    long pos = 0;

    /* This one uses a different approach than the encode and decode
     * functions. Because it is assumed, that only a fraction of the
     * contained chars have to be escaped.
     */
    while (pos < octstr_len(data)) {
        Octstr * escaped = NULL;
        int check = octstr_get_char(data, pos);

        if (check == ':') escaped = colon;
        else if (check == '=') escaped = assign;
        else if (check == ',') escaped = comma;
        else if (check == '\n') escaped = cr;
        else if (check == '\r') escaped = lf;

        if (escaped != NULL) {
            /* If the current char has to be escaped, delete the char from
             * the source string, replace it with the escape sequence, and
             * advance position until after the inserted sequence.
             */
            octstr_delete(data, pos, 1);
            octstr_insert(data, escaped, pos);
            pos += octstr_len(escaped);
        } else {
            /* If not escaped, simply skip the current char. */
            pos++;
        } 
    } 
} 

get_dest_addr_npi()

static Octstr* get_dest_addr_npi ( SMASI *  smasi, Msg *  msg  )

static

Definition at line 431 of file smsc_smasi.c.

References SMASI::dest_addr_npi, get_ton_npi_value(), and GSM_ADDR_NPI_E164.

Referenced by msg_to_pdu().

{
    return get_ton_npi_value(smasi->dest_addr_npi, 
                             GSM_ADDR_NPI_E164);
}

get_dest_addr_ton()

static Octstr* get_dest_addr_ton ( SMASI *  smasi, Msg *  msg  )

static

Definition at line 419 of file smsc_smasi.c.

References SMASI::dest_addr_ton, get_ton_npi_value(), and GSM_ADDR_TON_INTERNATIONAL.

Referenced by msg_to_pdu().

{
    return get_ton_npi_value(smasi->dest_addr_ton, 
                             GSM_ADDR_TON_INTERNATIONAL);
}

get_originator_type()

static Octstr* get_originator_type ( SMASI *  smasi, Octstr *  originator  )

static

Definition at line 442 of file smsc_smasi.c.

References GSM_ADDR_TON_ALPHANUMERIC, GSM_ADDR_TON_INTERNATIONAL, gw_isdigit(), octstr_check_range(), octstr_delete(), octstr_format(), and octstr_get_char().

Referenced by msg_to_pdu().

{
    /* International or alphanumeric sender? */
    if (octstr_get_char(originator, 0) == '+') {
        if (!octstr_check_range(originator, 1, 256, gw_isdigit)) {
            return octstr_format("%ld", GSM_ADDR_TON_ALPHANUMERIC);
        } else {
           /* Numeric sender address with + in front: The + has to be
            * removed from this international number.
            */
           octstr_delete(originator, 0, 1);
           return octstr_format("%ld", GSM_ADDR_TON_INTERNATIONAL);
        }
    } else if (!octstr_check_range(originator, 0, 256, gw_isdigit)) {
       return octstr_format("%ld", GSM_ADDR_TON_ALPHANUMERIC);
    }

    /* Return the default value. */
    return octstr_format("%ld", GSM_ADDR_TON_INTERNATIONAL);
}

get_source_addr_npi()

static Octstr* get_source_addr_npi ( SMASI *  smasi, Msg *  msg  )

static

Definition at line 407 of file smsc_smasi.c.

References get_ton_npi_value(), GSM_ADDR_NPI_E164, and SMASI::source_addr_npi.

Referenced by msg_to_pdu().

{
    return get_ton_npi_value(smasi->source_addr_npi, 
                             GSM_ADDR_NPI_E164);
}

get_source_addr_ton()

static Octstr* get_source_addr_ton ( SMASI *  smasi, Msg *  msg  )

static

Definition at line 395 of file smsc_smasi.c.

References get_ton_npi_value(), GSM_ADDR_TON_INTERNATIONAL, and SMASI::source_addr_ton.

Referenced by msg_to_pdu().

{
    return get_ton_npi_value(smasi->source_addr_ton, 
                             GSM_ADDR_TON_INTERNATIONAL);
}

get_ton_npi_value()

static Octstr* get_ton_npi_value ( int  override, int  message  )

static

Definition at line 378 of file smsc_smasi.c.

References debug(), and octstr_format().

Referenced by get_dest_addr_npi(), get_dest_addr_ton(), get_source_addr_npi(), and get_source_addr_ton().

{
    if (override != -1) {
        debug("bb.sms.smasi", 0, "SMASI: Manually forced ton or npi to `%d'", 
              override);
        return (octstr_format("%ld", override));
    } else {
        return (octstr_format("%ld", message));
    }
}

handle_pdu()

static void handle_pdu ( SMASI *  smasi, Connection *  conn, SMASI_PDU *  pdu, long *  pending_submits  )

static

Definition at line 711 of file smsc_smasi.c.

References bb_smscconn_connected(), bb_smscconn_receive(), bb_smscconn_send_failed(), bb_smscconn_sent(), SMASI::conn, smscconn::connect_time, debug(), dict_remove(), error(), smscconn::id, info(), SMASI::logged_off, msg, msg_dump(), SMASI::my_number, octstr_create, octstr_destroy(), octstr_duplicate, octstr_get_cstr, octstr_len(), pdu_to_msg(), send_pdu(), SMASI::sent_msgs, smasi_pdu_create(), smasi_pdu_destroy(), SMSCCONN_ACTIVE, SMSCCONN_FAILED_REJECTED, smscconn::status, SMASI_PDU::type, SMASI_PDU::type_name, SMASI_PDU::u, and warning().

Referenced by smasi_thread().

{
    SMASI_PDU *resp = NULL;
    Msg *msg = NULL;
    long reason;

    switch (pdu->type) {

        case DeliverReq:
            msg = pdu_to_msg(pdu);

            msg_dump(msg, 0);

            if (smasi->my_number && octstr_len(smasi->my_number)) {
                octstr_destroy(msg->sms.receiver);
                msg->sms.receiver = octstr_duplicate(smasi->my_number);
            }

            time(&msg->sms.time);
            msg->sms.smsc_id = octstr_duplicate(smasi->conn->id);
            bb_smscconn_receive(smasi->conn, msg);
            resp = smasi_pdu_create(DeliverConf);

            if (pdu->u.DeliverReq.Sequence)
                resp->u.DeliverConf.Sequence =
                  octstr_duplicate(pdu->u.DeliverReq.Sequence);

            if (pdu->u.DeliverReq.MsgReference)
                resp->u.DeliverConf.MsgReference =
                  octstr_duplicate(pdu->u.DeliverReq.MsgReference);
            break;

        case SubmitConf:
            if (pdu->u.SubmitConf.Sequence) {
                msg = dict_remove(smasi->sent_msgs, 
                                  pdu->u.SubmitConf.Sequence);
            } else {
                msg = NULL;
            }

            if (msg == NULL) {
                warning(0, "SMASI[%s]: SMSC sent SubmitConf for unknown message.",
                        octstr_get_cstr(smasi->conn->id));
            } else {
                debug("bb.sms.smasi",0,
                      "SMSC[%s]: SMSC confirmed msg seq <%s> ref <%s>",
                       octstr_get_cstr(smasi->conn->id),
                       octstr_get_cstr(pdu->u.SubmitConf.Sequence),
                       octstr_get_cstr(pdu->u.SubmitConf.MsgReference));

                bb_smscconn_sent(smasi->conn, msg, NULL);

                --(*pending_submits);
            }
            break;

        case SubmitRej:
            if (pdu->u.SubmitRej.Sequence) {
                msg = dict_remove(smasi->sent_msgs, 
                                  pdu->u.SubmitRej.Sequence);
            } else {
                msg = NULL;
            }

            error(0, "SMASI[%s]: SMSC returned error code %s for "
                  "message ref <%s>", octstr_get_cstr(smasi->conn->id),
                  octstr_get_cstr(pdu->u.SubmitRej.RejectCode),
                  octstr_get_cstr(pdu->u.SubmitRej.MsgReference));

            if (msg == NULL) {
               warning(0, "SMASI[%s]: SMSC sent SubmitRej for unknown message.",
                       octstr_get_cstr(smasi->conn->id));
            } else {
                reason = SMSCCONN_FAILED_REJECTED;
                bb_smscconn_send_failed(smasi->conn, msg, reason,
                    octstr_create("REJECTED"));
                --(*pending_submits);
            }
            break;

        case LogonConf:
            *pending_submits = 0;

            smasi->conn->status = SMSCCONN_ACTIVE;
            smasi->conn->connect_time = time(NULL);

            bb_smscconn_connected(smasi->conn);

            info(0, "SMASI[%s]: connection to SMSC established.",
                 octstr_get_cstr(smasi->conn->id));
            break;

        case LogonRej:
            if (octstr_len(pdu->u.LogonRej.Reason) > 0) {
                error(0, "SMASI[%s]: SMSC rejected login with reason <%s>",
                      octstr_get_cstr(smasi->conn->id),
                      octstr_get_cstr(pdu->u.LogonRej.Reason));
            } else {
                error(0, "SMASI[%s]: SMSC rejected login without reason",
                      octstr_get_cstr(smasi->conn->id));
            }
            break;

        case LogoffConf:
            info(0, "SMASI[%s]: SMSC confirmed logoff.",
                 octstr_get_cstr(smasi->conn->id));
            smasi->logged_off = 1;
            break;

        default:
            warning(0, "SMASI[%s]: Unknown PDU type <%s>, ignored.",
                    octstr_get_cstr(smasi->conn->id), pdu->type_name);
            break;
    }

    if (resp != NULL) {
        send_pdu(conn, smasi->conn->id, resp);
        smasi_pdu_destroy(resp);
    }
}

init_configuration()

static int init_configuration ( SMASI *  smasi, CfgGroup *  config  )

static

Definition at line 1071 of file smsc_smasi.c.

References cfg_get, cfg_get_integer(), SMASI::conn, smscconn::data, SMASI::dest_addr_npi, SMASI::dest_addr_ton, SMASI::enquire_link_interval, error(), SMASI::host, smscconn::id, SMASI::my_number, smscconn::name, octstr_duplicate, octstr_format(), octstr_imm(), SMASI::password, SMASI::port, SMASI::priority, SMASI_DEFAULT_PORT, SMASI_DEFAULT_PRIORITY, SMASI_ENQUIRE_LINK_INTERVAL, SMASI_OVERRIDE_DEST_NPI, SMASI_OVERRIDE_DEST_TON, SMASI_OVERRIDE_SOURCE_NPI, SMASI_OVERRIDE_SOURCE_TON, SMASI::source_addr_npi, SMASI::source_addr_ton, and SMASI::username.

Referenced by smsc_smasi_create().

{
    /* Read mandatory entries. */
    smasi->host = cfg_get(config, octstr_imm("host"));
    smasi->username = cfg_get(config, octstr_imm("smsc-username"));
    smasi->password = cfg_get(config, octstr_imm("smsc-password"));

    /* Check configuration. */
    if (smasi->host == NULL) {
        error(0,"SMASI: Configuration file doesn't specify host");
        return -1;
    }
    if (smasi->username == NULL) {
        error(0, "SMASI: Configuration file doesn't specify username.");
        return -1;
    }
    if (smasi->password == NULL) {
        error(0, "SMASI: Configuration file doesn't specify password.");
        return -1;
    }

    /* Read optional entries. Set default values if not set. */
    smasi->my_number = cfg_get(config, octstr_imm("my-number"));
    if (cfg_get_integer(&smasi->port, config, octstr_imm("port")) == -1)
        smasi->port = SMASI_DEFAULT_PORT;
    if (cfg_get_integer(&smasi->source_addr_ton, config,
      octstr_imm("source-addr-ton")) == -1)
        smasi->source_addr_ton = SMASI_OVERRIDE_SOURCE_TON;
    if (cfg_get_integer(&smasi->source_addr_npi, config,
      octstr_imm("source-addr-npi")) == -1)
        smasi->source_addr_npi = SMASI_OVERRIDE_SOURCE_NPI;
    if (cfg_get_integer(&smasi->dest_addr_ton, config,
      octstr_imm("dest-addr-ton")) == -1)
        smasi->dest_addr_ton = SMASI_OVERRIDE_DEST_TON;
    if (cfg_get_integer(&smasi->dest_addr_npi, config,
      octstr_imm("dest-addr-npi")) == -1)
        smasi->dest_addr_npi = SMASI_OVERRIDE_DEST_NPI;
    if (cfg_get_integer(&smasi->priority, config,
      octstr_imm("priority")) == -1)
        smasi->priority = SMASI_DEFAULT_PRIORITY;
    if (cfg_get_integer(&smasi->enquire_link_interval, config,
      octstr_imm("enquire-link-interval")) == -1)
        smasi->enquire_link_interval = SMASI_ENQUIRE_LINK_INTERVAL;
   
    /* Configure SMSC connection. */
    smasi->conn->data = smasi;
    smasi->conn->name = octstr_format("SMASI:%S:%d:%S",
        smasi->host, smasi->port, smasi->username);

    smasi->conn->id = cfg_get(config, octstr_imm("smsc-id"));

    if (smasi->conn->id == NULL)
      smasi->conn->id = octstr_duplicate(smasi->conn->name);

    return 0;
} 

msg_to_pdu()

static SMASI_PDU* msg_to_pdu ( SMASI *  smasi, Msg *  msg  )

static

Definition at line 467 of file smsc_smasi.c.

References counter_increase(), DC_7BIT, DC_8BIT, DC_UCS2, DC_UNDEF, encode_binary_data(), escape_data(), get_dest_addr_npi(), get_dest_addr_ton(), get_originator_type(), get_source_addr_npi(), get_source_addr_ton(), MC_UNDEF, SMASI::message_id_counter, msg, octstr_create, octstr_delete(), octstr_destroy(), octstr_duplicate, octstr_format(), octstr_get_char(), octstr_len(), SMASI::priority, smasi_pdu_create(), SMS_PARAM_UNDEFINED, and SMASI_PDU::u.

Referenced by send_messages().

{
    SMASI_PDU *pdu = smasi_pdu_create(SubmitReq);

    pdu->u.SubmitReq.Destination = octstr_duplicate(msg->sms.receiver);
    pdu->u.SubmitReq.Body = octstr_duplicate(msg->sms.msgdata);
    pdu->u.SubmitReq.Originator = octstr_duplicate(msg->sms.sender);

    pdu->u.SubmitReq.OriginatorType = 
        get_originator_type(smasi, pdu->u.SubmitReq.Originator);

    pdu->u.SubmitReq.Sequence = 
        octstr_format("%ld", counter_increase(smasi->message_id_counter));


    /* If its a international number starting with +, lets remove the +. */
    if (octstr_get_char(pdu->u.SubmitReq.Destination, 0) == '+')
        octstr_delete(pdu->u.SubmitReq.Destination, 0, 1);

    /* Do ton and npi override - if configured. Use values from message
     * otherwise.
     */
    pdu->u.SubmitReq.OriginatorType = get_source_addr_ton(smasi, msg);
    pdu->u.SubmitReq.OriginatorPlan = get_source_addr_npi(smasi, msg);
    pdu->u.SubmitReq.DestinationType = get_dest_addr_ton(smasi, msg);
    pdu->u.SubmitReq.DestinationPlan = get_dest_addr_npi(smasi, msg);
       
    /* Set priority. */
    if (smasi->priority >= 0 && smasi->priority <= 3) {
        pdu->u.SubmitReq.MqPriority = octstr_format("%ld", smasi->priority);
    } else {
        pdu->u.SubmitReq.MqPriority = octstr_format("%ld", 0);
    }

    /* Set encoding. */
    if (msg->sms.coding != DC_UNDEF) {
        if (msg->sms.coding == DC_7BIT)
            pdu->u.SubmitReq.MsEncoding = octstr_create("7bit");
        else if (msg->sms.coding == DC_8BIT)
            pdu->u.SubmitReq.MsEncoding = octstr_create("8bit");
        else if (msg->sms.coding == DC_UCS2)
            pdu->u.SubmitReq.MsEncoding = octstr_create("16bit");

        /* Everything else will default to 7bit. */
    }

    /* Set messaging class - if within defined parameter range. */
    if (msg->sms.mclass != MC_UNDEF)
        pdu->u.SubmitReq.Class = octstr_format("%ld", msg->sms.mclass);

    /* Set Protocol ID. */
    pdu->u.SubmitReq.ProtocolID = octstr_format("%ld", 
    (msg->sms.pid == SMS_PARAM_UNDEFINED ? 0 : msg->sms.pid));

    /* Check if SMS is binary. */
    if (msg->sms.udhdata && octstr_len(msg->sms.udhdata) > 0) {
        
        pdu->u.SubmitReq.UserDataHeader =
          octstr_duplicate(msg->sms.udhdata);

        pdu->u.SubmitReq.BodyEncoding =
          octstr_create("Data");

        if (pdu->u.SubmitReq.MsEncoding)
          octstr_destroy(pdu->u.SubmitReq.MsEncoding);

        pdu->u.SubmitReq.MsEncoding =
          octstr_create("transparent");

        /* Encode data. */
        encode_binary_data(pdu->u.SubmitReq.UserDataHeader);
        encode_binary_data(pdu->u.SubmitReq.Body);
    } else {

        /* Otherwise do data escaping. */
        escape_data(pdu->u.SubmitReq.Body);
    } 

    return pdu;
} 

open_connection()

static Connection* open_connection ( SMASI *  smasi )

static

Definition at line 843 of file smsc_smasi.c.

References SMASI::conn, conn_open_tcp_with_port(), counter_increase(), error(), SMASI::host, smscconn::id, SMASI::message_id_counter, octstr_duplicate, octstr_get_cstr, smscconn::our_host, SMASI::password, SMASI::port, send_pdu(), smasi_pdu_create(), smasi_pdu_destroy(), SMASI_PDU::u, and SMASI::username.

Referenced by smasi_thread().

{
    Connection *conn = conn_open_tcp_with_port(smasi->host, smasi->port, 0, smasi->conn->our_host);

    if (conn == NULL) {
        error(0, "SMASI[%s]: Couldn't connect to server.",
              octstr_get_cstr(smasi->conn->id));
        return NULL;
    } else {
        SMASI_PDU *logon = smasi_pdu_create(LogonReq);

        logon->u.LogonReq.Name = octstr_duplicate(smasi->username);
        logon->u.LogonReq.Password = octstr_duplicate(smasi->password);

        counter_increase(smasi->message_id_counter);

        send_pdu(conn, smasi->conn->id, logon);

        smasi_pdu_destroy(logon);
    }

    return conn;
} 

pdu_to_msg()

static Msg* pdu_to_msg ( SMASI_PDU *  pdu )

static

Definition at line 552 of file smsc_smasi.c.

References DC_7BIT, DC_8BIT, DC_UCS2, decode_binary_data(), gw_assert(), MC_UNDEF, msg, msg_create, octstr_duplicate, octstr_len(), octstr_parse_long(), octstr_str_compare(), SMS_PARAM_UNDEFINED, SMASI_PDU::type, SMASI_PDU::u, and unescape_data().

Referenced by handle_pdu().

{
    Msg *msg = NULL;

    gw_assert(pdu->type == DeliverReq);
    gw_assert(pdu->u.DeliverReq.Originator);
    gw_assert(pdu->u.DeliverReq.Destination);
    gw_assert(pdu->u.DeliverReq.Body);

    msg = msg_create(sms);

    msg->sms.sender = octstr_duplicate(pdu->u.DeliverReq.Originator);
    msg->sms.receiver = octstr_duplicate(pdu->u.DeliverReq.Destination);
    msg->sms.msgdata = octstr_duplicate(pdu->u.DeliverReq.Body);
 
    /* Read priority. */
    if (pdu->u.DeliverReq.ProtocolId)
        if (octstr_parse_long(&msg->sms.pid, 
                              pdu->u.DeliverReq.ProtocolId, 0, 10) == -1)
            msg->sms.pid = SMS_PARAM_UNDEFINED;

    /* Read Coding. */
    if (pdu->u.DeliverReq.MsEncoding) {

        /* Use specified coding. */
        if (octstr_str_compare(pdu->u.DeliverReq.MsEncoding, "7bit") == 0)
            msg->sms.coding = DC_7BIT;
        else if (octstr_str_compare(pdu->u.DeliverReq.MsEncoding, "8bit") == 0)
            msg->sms.coding = DC_8BIT;
        else if (octstr_str_compare(pdu->u.DeliverReq.MsEncoding, "UCS2") == 0)
            msg->sms.coding = DC_UCS2;
        else if (octstr_str_compare(pdu->u.DeliverReq.MsEncoding, "transparent") == 0)
            msg->sms.coding = DC_8BIT;
    } else {

        /* Determine specified coding according to udhdata presence. */
        if (pdu->u.DeliverReq.UserDataHeader)
            msg->sms.coding = DC_8BIT;
        else
            msg->sms.coding = DC_7BIT;
    }

    /* Unescape (non-binary) or decode (binary) data. */
    if (msg->sms.coding == DC_8BIT) {

        decode_binary_data(msg->sms.msgdata);
        if (pdu->u.DeliverReq.UserDataHeader &&
            octstr_len(pdu->u.DeliverReq.UserDataHeader) > 0) {
            msg->sms.udhdata = octstr_duplicate(pdu->u.DeliverReq.UserDataHeader);
            decode_binary_data(msg->sms.udhdata);
        }

    } else {
        unescape_data(msg->sms.msgdata);
    } 

    /* Read message class. */
    if (pdu->u.DeliverReq.Class &&
        octstr_parse_long(&msg->sms.mclass, 
                          pdu->u.DeliverReq.Class, 0, 10) == -1)
            msg->sms.mclass = MC_UNDEF;    /* Set to unspecified. */

    /* Read protocol ID. */
    if (pdu->u.DeliverReq.ProtocolId &&
        octstr_parse_long(&msg->sms.pid, 
                          pdu->u.DeliverReq.ProtocolId, 0, 10) == -1)
            msg->sms.pid = SMS_PARAM_UNDEFINED;

    return msg;
}

queued_cb()

static long queued_cb ( SMSCConn *  conn )

static

Definition at line 1012 of file smsc_smasi.c.

References smscconn::data, gwlist_len(), smscconn::load, SMASI::msgs_to_send, SMSCCONN_DEAD, and smscconn::status.

Referenced by smsc_smasi_create().

{
    SMASI *smasi = conn->data;

    conn->load = (smasi ? (conn->status != SMSCCONN_DEAD ? 
                    gwlist_len(smasi->msgs_to_send) : 0) : 0);

    return conn->load;
} 

read_pdu()

static int read_pdu ( SMASI *  smasi, Connection *  conn, SMASI_PDU **  pdu  )

static

Definition at line 685 of file smsc_smasi.c.

References SMASI::conn, conn_eof(), conn_error(), debug(), error(), smscconn::id, octstr_destroy(), octstr_dump, octstr_get_cstr, smasi_pdu_read(), and smasi_pdu_unpack().

Referenced by smasi_thread().

{
    Octstr *os;
    
    os = smasi_pdu_read(conn);
    if (os == NULL) {
        if (conn_eof(conn) || conn_error(conn)) 
            return -1;
        return 0;
    }

    *pdu = smasi_pdu_unpack(os);
    if (*pdu == NULL) {
        error(0, "SMASI[%s]: PDU unpacking failed.",
              octstr_get_cstr(smasi->conn->id));
        debug("bb.sms.smasi", 0, "SMASI[%s]: Failed PDU follows.",
              octstr_get_cstr(smasi->conn->id));
        octstr_dump(os, 0);
        octstr_destroy(os);
        return -1;
    }
    octstr_destroy(os);
    return 1;
}

send_enquire_link()

static void send_enquire_link ( SMASI *  smasi, Connection *  conn, long *  last_sent  )

static

Definition at line 646 of file smsc_smasi.c.

References SMASI::conn, conn_write(), date_universal_now(), dump_pdu(), smscconn::id, octstr_destroy(), smasi_pdu_create(), smasi_pdu_destroy(), and smasi_pdu_pack().

Referenced by smasi_thread().

{ 
    SMASI_PDU *pdu = NULL; 
    Octstr *os = NULL; 
 
    if (date_universal_now() - *last_sent < smasi->enquire_link_interval)
        return; 
    *last_sent = date_universal_now(); 
 
    pdu = smasi_pdu_create(EnquireLinkReq);
    dump_pdu("Sending EnquireLinkReq:", smasi->conn->id, pdu); 
    os = smasi_pdu_pack(pdu); 
    if (os)
       conn_write(conn, os); /* Write errors checked by caller. */ 
    octstr_destroy(os); 
    smasi_pdu_destroy(pdu); 
} 

send_logoff()

static void send_logoff ( SMASI *  smasi, Connection *  conn  )

static

Definition at line 628 of file smsc_smasi.c.

References SMASI::conn, conn_write(), counter_increase(), dump_pdu(), smscconn::id, SMASI::message_id_counter, octstr_create, octstr_destroy(), smasi_pdu_create(), smasi_pdu_destroy(), smasi_pdu_pack(), and SMASI_PDU::u.

Referenced by smasi_thread().

{
    SMASI_PDU *pdu = NULL;
    Octstr *os = NULL;

    counter_increase(smasi->message_id_counter);

    pdu = smasi_pdu_create(LogoffReq);
    pdu->u.LogoffReq.Reason = octstr_create("Client shutting down");
    dump_pdu("Sending !LogoffReq:", smasi->conn->id, pdu); 

    os = smasi_pdu_pack(pdu);
    conn_write(conn, os);
    octstr_destroy(os);
    smasi_pdu_destroy(pdu);
}

send_messages()

static void send_messages ( SMASI *  smasi, Connection *  conn, long *  pending_submits  )

static

Definition at line 868 of file smsc_smasi.c.

References SMASI::conn, delay, dict_put(), gwlist_extract_first(), gwthread_sleep(), smscconn::id, MAX_PENDING_SUBMITS, msg, msg_to_pdu(), SMASI::msgs_to_send, send_pdu(), SMASI::sent_msgs, smasi_pdu_destroy(), smscconn::throughput, and SMASI_PDU::u.

Referenced by smasi_thread().

{
    double delay = 0;

    if (*pending_submits == -1) return;

    if (smasi->conn->throughput > 0) {
        delay = 1.0 / smasi->conn->throughput;
    }

    while (*pending_submits < MAX_PENDING_SUBMITS) {
        SMASI_PDU *pdu = NULL;
        /* Get next message, quit if none to be sent. */
        Msg *msg = gwlist_extract_first(smasi->msgs_to_send);

        if (msg == NULL) break;

        /* Send PDU, record it as waiting for ack from SMSC. */
        pdu = msg_to_pdu(smasi, msg);

        if (pdu->u.SubmitReq.Sequence)
            dict_put(smasi->sent_msgs, pdu->u.SubmitReq.Sequence, msg);

        send_pdu(conn, smasi->conn->id, pdu);

        smasi_pdu_destroy(pdu);

        /* obey throughput speed limit, if any */
        if (smasi->conn->throughput > 0)
            gwthread_sleep(delay);

        ++(*pending_submits);
    }
}

send_msg_cb()

static int send_msg_cb ( SMSCConn *  conn, Msg *  msg  )

static

Definition at line 1023 of file smsc_smasi.c.

References smscconn::data, gwlist_produce(), gwthread_wakeup(), msg, msg_duplicate(), SMASI::msgs_to_send, and SMASI::thread_handle.

Referenced by smsc_smasi_create().

{
    SMASI *smasi = conn->data;

    gwlist_produce(smasi->msgs_to_send, msg_duplicate(msg));
    gwthread_wakeup(smasi->thread_handle);

    return 0;
}

send_pdu()

static int send_pdu ( Connection *  conn, Octstr *  id, SMASI_PDU *  pdu  )

static

Definition at line 665 of file smsc_smasi.c.

References conn_write(), dump_pdu(), octstr_destroy(), and smasi_pdu_pack().

Referenced by handle_pdu(), open_connection(), and send_messages().

{
    Octstr * os = NULL;
    int ret = 0;

    dump_pdu("Sending PDU:", id, pdu); 
    os = smasi_pdu_pack(pdu);
    if (os) ret = conn_write(conn, os);
    else ret = -1;

    octstr_destroy(os);
    return ret;
}

shutdown_cb()

static int shutdown_cb ( SMSCConn *  conn, int  finish_sending  )

static

Definition at line 1034 of file smsc_smasi.c.

References assign, bb_smscconn_killed(), colon, comma, cr, smscconn::data, debug(), gwthread_join(), gwthread_wakeup(), lf, smscconn::name, octstr_destroy(), octstr_get_cstr, SMASI::quitting, smasi_destroy(), SMSCCONN_DEAD, SMSCCONN_KILLED_SHUTDOWN, smscconn::status, SMASI::thread_handle, and smscconn::why_killed.

Referenced by smsc_smasi_create().

{
    SMASI *smasi = NULL;

    debug("bb.sms.smasi", 0, "Shutting down SMSCConn %s (%s)",
          octstr_get_cstr(conn->name), finish_sending ? "slow" : "instant");

    conn->why_killed = SMSCCONN_KILLED_SHUTDOWN;

    smasi = conn->data;
    smasi->quitting = 1;
    gwthread_wakeup(smasi->thread_handle);
    gwthread_join(smasi->thread_handle);
    smasi_destroy(smasi);

    debug("bb.sms.smasi", 0, "SMSCConn %s shut down.",
          octstr_get_cstr(conn->name));
    conn->status = SMSCCONN_DEAD;
    bb_smscconn_killed();

    /* Clean up. */
    octstr_destroy(colon);
    octstr_destroy(assign);
    octstr_destroy(comma);
    octstr_destroy(cr);
    octstr_destroy(lf);

    return 0;
}

smasi_create()

static SMASI* smasi_create ( SMSCConn *  conn )

static

Definition at line 159 of file smsc_smasi.c.

References SMASI::conn, counter_create(), SMASI::dest_addr_npi, SMASI::dest_addr_ton, dict_create(), SMASI::enquire_link_interval, gwlist_add_producer(), gwlist_create, SMASI::host, SMASI::logged_off, SMASI::message_id_counter, SMASI::msgs_to_send, SMASI::my_number, SMASI::password, SMASI::port, SMASI::priority, SMASI::quitting, SMASI::received_msgs, SMASI::sent_msgs, SMASI::source_addr_npi, SMASI::source_addr_ton, SMASI::thread_handle, SMASI::throttling_err_time, and SMASI::username.

Referenced by smsc_smasi_create().

{

    SMASI *smasi = gw_malloc(sizeof(SMASI));

    smasi->conn = conn;

    smasi->thread_handle = -1;
    smasi->msgs_to_send = gwlist_create();
    smasi->sent_msgs = dict_create(16, NULL);
    smasi->received_msgs = gwlist_create();
    smasi->message_id_counter = counter_create();
    smasi->host = NULL;
    smasi->username = NULL;
    smasi->password = NULL;
    smasi->source_addr_ton = -1;
    smasi->source_addr_npi = -1;
    smasi->dest_addr_ton = -1;
    smasi->dest_addr_npi = -1;
    smasi->my_number = NULL;
    smasi->port = 21500;
    smasi->quitting = 0;
    smasi->logged_off = 0;
    smasi->priority = 0;
    smasi->throttling_err_time = 0;
    smasi->enquire_link_interval = 30;

    gwlist_add_producer(smasi->msgs_to_send);

    return smasi;
} 

smasi_destroy()

static void smasi_destroy ( SMASI *  smasi )

static

Definition at line 192 of file smsc_smasi.c.

References counter_destroy(), dict_destroy(), gwlist_destroy(), SMASI::host, SMASI::message_id_counter, msg_destroy_item(), SMASI::msgs_to_send, octstr_destroy(), SMASI::password, SMASI::received_msgs, SMASI::sent_msgs, and SMASI::username.

Referenced by shutdown_cb(), and smsc_smasi_create().

{
    if (smasi == NULL) return;

    gwlist_destroy(smasi->msgs_to_send, msg_destroy_item);
    dict_destroy(smasi->sent_msgs);
    gwlist_destroy(smasi->received_msgs, msg_destroy_item);
    counter_destroy(smasi->message_id_counter);
    octstr_destroy(smasi->host);
    octstr_destroy(smasi->username);
    octstr_destroy(smasi->password);
    gw_free(smasi);
} 

smasi_thread()

static void smasi_thread ( void *  arg )

static

Definition at line 911 of file smsc_smasi.c.

References SMASI::conn, conn_destroy(), conn_wait(), date_universal_now(), dump_pdu(), SMASI::enquire_link_interval, error(), gwthread_sleep(), handle_pdu(), smscconn::id, smscconn::log_idx, log_thread_to(), SMASI::logged_off, octstr_get_cstr, open_connection(), SMASI::quitting, read_pdu(), smscconn::reconnect_delay, send_enquire_link(), send_logoff(), send_messages(), smasi_pdu_destroy(), SMASI_THROTTLING_SLEEP_TIME, SMSCCONN_RECONNECTING, smscconn::status, and SMASI::throttling_err_time.

Referenced by smsc_smasi_create().

{
    long pending_submits;
    SMASI_PDU *pdu;
    SMASI *smasi;
    int logoff_already_sent = 0;
    int ret;
    Connection *conn;
    long last_enquire_sent; 
    double timeout; 

    smasi = arg;

    /* Make sure we log into our own log-file if defined */
    log_thread_to(smasi->conn->log_idx);
    
    while (!smasi->quitting) {

        conn = open_connection(smasi);
        if (conn == NULL) {
            error(0, "SMASI[%s]: Could not connect to SMSC center " \
                  "(retrying in %ld seconds).",
                  octstr_get_cstr(smasi->conn->id), smasi->conn->reconnect_delay);

            gwthread_sleep(smasi->conn->reconnect_delay);
            smasi->conn->status = SMSCCONN_RECONNECTING;
            continue;
        }

        last_enquire_sent = date_universal_now(); 
        pending_submits = -1;

        for (;;) {
            timeout = last_enquire_sent + smasi->enquire_link_interval
                        - date_universal_now(); 

            /* wait for activity */
            if (conn_wait(conn, timeout) == -1) {
                error(0, "SMASI[%s]: I/O error or other error. Re-connecting.",
                      octstr_get_cstr(smasi->conn->id));
                break;
            }

            /* Send logoff request if module is shutting down. */
            if (smasi->quitting && !logoff_already_sent) {
                send_logoff(smasi, conn);
                logoff_already_sent = 1;
            } 

            /* send an enquire link */
            send_enquire_link(smasi, conn, &last_enquire_sent); 

            /* Receive incoming PDUs. */
            while ((ret = read_pdu(smasi, conn, &pdu)) == 1) {
                /* Deal with the PDU we just got */ 
                dump_pdu("Got PDU:", smasi->conn->id, pdu);

                /* Process the received PDU. */
                handle_pdu(smasi, conn, pdu, &pending_submits);

                smasi_pdu_destroy(pdu);

                /* Bail out if logoff confirmed. */
                if (smasi->logged_off) break;

                /* Make sure we send even if we read a lot. */
                if ((!smasi->throttling_err_time ||
                    ((time(NULL) - smasi->throttling_err_time) >
                     SMASI_THROTTLING_SLEEP_TIME
                      && !(smasi->throttling_err_time = 0))))
                    send_messages(smasi, conn, &pending_submits);
            } 

            /* Check if connection broken. */
            if (ret == -1) {
                error(0, "SMASI[%s]: I/O error or other error. Re-connecting.",
                      octstr_get_cstr(smasi->conn->id));
                break;
            } 

            /* Bail out if logoff confirmed. */
            if (smasi->logged_off) break;

            if ((!smasi->throttling_err_time ||
                ((time(NULL) - smasi->throttling_err_time) >
                 SMASI_THROTTLING_SLEEP_TIME
                  && !(smasi->throttling_err_time = 0))))
                send_messages(smasi, conn, &pending_submits);

        } 

        conn_destroy(conn);
        conn = NULL;
    } 
} 

smsc_smasi_create()

int smsc_smasi_create	(	SMSCConn *	conn,
		CfgGroup *	config
	)

Definition at line 1129 of file smsc_smasi.c.

References assign, colon, comma, SMASI::conn, cr, smscconn::data, error(), gwthread_create, smscconn::id, init_configuration(), lf, octstr_create, octstr_get_cstr, panic, smscconn::queued, queued_cb(), smscconn::send_msg, send_msg_cb(), smscconn::shutdown, shutdown_cb(), smasi_create(), smasi_destroy(), smasi_thread(), SMSCCONN_CONNECTING, smscconn::status, and SMASI::thread_handle.

Referenced by smscconn_create().

{
    SMASI *smasi = NULL;

    /* Initialize data encoding subsystem. */
    colon = octstr_create(":3a");
    assign = octstr_create(":3d");
    comma = octstr_create(":2c");
    cr = octstr_create(":0a");
    lf = octstr_create(":0d");

    /* Create main SMASI structure and initialize it with configuration
     * settings.
     */
    smasi = smasi_create(conn);

    if (init_configuration(smasi, config) != 0)
        panic(0, "SMASI SMSC module configuration invalid.");

    conn->status = SMSCCONN_CONNECTING;

    /* Port is always set to a configured value or defaults to 21500.
     * Therefore, threads are always started.
     */
    smasi->thread_handle = gwthread_create(smasi_thread, smasi);

    if (smasi->thread_handle == -1) {
        error(0, "SMASI[%s]: Couldn't start SMASI thread.",
              octstr_get_cstr(smasi->conn->id));
        smasi_destroy(conn->data);
        return -1;
    } 

    /* Setup control function pointers. */
    conn->shutdown = shutdown_cb;
    conn->queued = queued_cb;
    conn->send_msg = send_msg_cb;

    return 0;
}

unescape_data()

static void unescape_data ( Octstr *  data )

static

Definition at line 267 of file smsc_smasi.c.

References check(), octstr_delete(), octstr_get_char(), octstr_insert_data(), and octstr_len().

Referenced by pdu_to_msg().

{
    long pos = 0;

    /* Again, an inplace transformation is used. Because, again, it is
     * assumed that only a fraction of chars has to be unescaped.
     */
    while (pos < octstr_len(data)) {
        int check = octstr_get_char(data, pos);

        if (check == ':') {
            char byte = 0;
            int msb = octstr_get_char(data, pos + 1);
            int lsb = octstr_get_char(data, pos + 2);
 
            if (msb == '0') msb = 0;
            else if (msb >= '1' && msb <= '9') msb -= '1' + 1;
            else msb -= 'a' + 10;

            if (lsb == '0') lsb = 0;
            else if (lsb >= '1' && lsb <= '9') lsb -= '1' + 1;
            else lsb -= 'a' + 10;

            byte = msb << 4 | lsb;

            /* Do inplace unescaping. */
            octstr_delete(data, pos, 3);
            octstr_insert_data(data, pos, &byte, 1);
        } 
        pos++;
    } 
}

Variable Documentation

assign

Octstr* assign = NULL

static

Definition at line 219 of file smsc_smasi.c.

Referenced by escape_data(), shutdown_cb(), and smsc_smasi_create().

colon

Octstr* colon = NULL

static

Definition at line 218 of file smsc_smasi.c.

Referenced by escape_data(), get_header_value(), header_is_called(), http_header_get(), http_header_value(), parse_url(), shutdown_cb(), skip_until_after_colon(), and smsc_smasi_create().

comma

Octstr* comma = NULL

static

Definition at line 220 of file smsc_smasi.c.

Referenced by escape_data(), handle_two_terminators(), shutdown_cb(), and smsc_smasi_create().

cr

Octstr* cr = NULL

static

Definition at line 221 of file smsc_smasi.c.

Referenced by escape_data(), shutdown_cb(), and smsc_smasi_create().

lf

Octstr* lf = NULL

static

Definition at line 222 of file smsc_smasi.c.

Referenced by escape_data(), init_bearerbox(), init_smsbox(), init_wapbox(), shutdown_cb(), and smsc_smasi_create().