mtbatch.c File Reference

#include <string.h>
#include <unistd.h>
#include <signal.h>
#include <ctype.h>
#include "gwlib/gwlib.h"
#include "msg.h"
#include "sms.h"
#include "dlr.h"
#include "bb.h"
#include "shared.h"
#include "heartbeat.h"

Go to the source code of this file.

Functions
static void	write_pid_file (void)
static void	identify_to_bearerbox (void)
static void	read_messages_from_bearerbox (void *arg)
static int	send_message (Msg *msg)
static void	help (void)
static void	init_batch (Octstr *cfilename, Octstr *rfilename)
static int	gw_ismsisdnchar (int c)
static unsigned long	run_batch (void)
int	main (int argc, char **argv)

Variables
static char *	pid_file
static Octstr *	smsbox_id = NULL
static Octstr *	content = NULL
static List *	lines = NULL
static Octstr *	bb_host
static long	bb_port
static int	bb_ssl
static Counter *	counter
static Octstr *	service = NULL
static Octstr *	account = NULL
static Octstr *	from = NULL
static int	dlr_mask = 0
static Octstr *	dlr_url = NULL
static Octstr *	smsc_id = NULL
static double	delay = 0
static int	no_smsbox_id = 0
static Octstr *	meta_data = NULL
static int	coding = DC_7BIT
static Octstr *	charset = NULL
static Octstr *	payload = NULL
static int	msg_log = 0

Function Documentation

gw_ismsisdnchar()

static int gw_ismsisdnchar ( int  c )

static

Definition at line 348 of file mtbatch.c.

Referenced by run_batch().

{
    return (isdigit(c) || c == '+');
}

help()

static void help ( void  )

static

Definition at line 231 of file mtbatch.c.

References info().

Referenced by main().

{
    info(0, "Usage: mtbatch [options] content-file receivers-file ...");
    info(0, "where options are:");
    info(0, "-v number");
    info(0, "    set log level for stderr logging");
    info(0, "-b host");
    info(0, "    defines the host of bearerbox (default: localhost)");
    info(0, "-p port");
    info(0, "    the smsbox port to connect to (default: 13001)");
    info(0, "-s");
    info(0, "    inidicator to use SSL for bearerbox connection (default: no)");
    info(0, "-i smsbox-id");
    info(0, "    defines the smsbox-id to be used for bearerbox connection (default: none)");
    info(0, "-x");
    info(0, "    indicator to not use smsbox-id in messages send to bearerbox (default: yes)");
    info(0, "-f sender");
    info(0, "    which sender address should be used");
    info(0, "-D dlr-mask");
    info(0, "    defines the dlr-mask");
    info(0, "-u dlr-url");
    info(0, "    defines the dlr-url");
    info(0, "-n service");
    info(0, "    defines which service name should be logged (default: none)");
    info(0, "-a account");
    info(0, "    defines which account name should be logged (default: none)");
    info(0, "-d seconds");
    info(0, "    delay between message sending to bearerbox (default: 0)");
    info(0, "-r smsc-id");
    info(0, "    use a specific route for the MT traffic");
    info(0, "-M meta-data");
    info(0, "    defines the meta-data");
    info(0, "-c coding (0: UTF-8, 1: binary, 2: UCS-2; default: 0)");
    info(0, "    defines the coding");
    info(0, "-C charset (iconv name; default: UTF-8");
    info(0, "    defines which character encoding is used in content-file");
    info(0, "-m");
    info(0, "    indicator to dump messages exchanged with bearebrox (default: no)");
}

identify_to_bearerbox()

static void identify_to_bearerbox ( void  )

static

Definition at line 127 of file mtbatch.c.

References cmd_identify, msg, msg_create, octstr_duplicate, smsbox_id, and write_to_bearerbox().

Referenced by main().

{
    Msg *msg;
    
    msg = msg_create(admin);
    msg->admin.command = cmd_identify;
    msg->admin.boxc_id = octstr_duplicate(smsbox_id);
    write_to_bearerbox(msg);
}

init_batch()

static void init_batch ( Octstr *  cfilename, Octstr *  rfilename  )

static

Definition at line 271 of file mtbatch.c.

References charset, charset_convert(), coding, counter, counter_create(), DC_7BIT, DC_8BIT, DC_UCS2, error(), GW_INFO, gwlist_len(), info(), lines, octstr_dump, octstr_duplicate, octstr_get_cstr, octstr_imm(), octstr_read_file(), octstr_split(), octstr_strip_crlfs(), panic, and payload.

Referenced by main().

{
    Octstr *receivers;
    long lineno = 0; 

    /* read content file */
    content = octstr_read_file(octstr_get_cstr(cfilename)); 
    octstr_strip_crlfs(content);
    if (content == NULL) 
        panic(0,"Can not read content file `%s'.", 
              octstr_get_cstr(cfilename));

    /* handle transcoding */
    switch (coding) {
        case DC_8BIT: {
            payload = octstr_duplicate(content);
            info(0, "SMS message (binary), coding 1 (DC_8BIT):");
            octstr_dump(payload, 0, GW_INFO);
        }
        break;
        case DC_7BIT: {
            octstr_strip_crlfs(content);
            payload = octstr_duplicate(content);

            /* convert to UTF-8 if given in other charset */
            if (charset != NULL) {
                if (charset_convert(payload, octstr_get_cstr(charset), "UTF-8") != 0) {
                    error(0, "Failed to convert content from %s to UTF-8, will leave as is.",
                          octstr_get_cstr(charset));
                }
                info(0, "Content (%s):", octstr_get_cstr(charset));
                octstr_dump(content, 0, GW_INFO);
            }
            info(0, "SMS message (UTF-8), coding 0 (DC_7BIT):");
            octstr_dump(payload, 0, GW_INFO);
        }
        break;
        case DC_UCS2: {
            octstr_strip_crlfs(content);
            payload = octstr_duplicate(content);

            /* convert to UTF-16BE (Unicode) */
            if (charset == NULL)
                charset = octstr_imm("UTF-8");
            if (charset_convert(payload, octstr_get_cstr(charset), "UTF-16BE") != 0) {
                error(0, "Failed to convert content from %s to UTF-16BE (Unicode), will leave as is.",
                      octstr_get_cstr(charset));
            }
            info(0, "Content (%s):", octstr_get_cstr(charset));
            octstr_dump(content, 0, GW_INFO);
            info(0, "SMS message (UTF-16BE, Unicode), coding 2 (DCS_UCS2):");
            octstr_dump(payload, 0, GW_INFO);
        }
        break;
        default:
            panic(0, "Coding value %d out of range!", coding);
            break;
    }

    /* read receivers */
    info(0,"Loading receiver list. This may take a while...");
    receivers = octstr_read_file(octstr_get_cstr(rfilename)); 
    if (receivers == NULL) 
        panic(0,"Can not read receivers file `%s'.", 
              octstr_get_cstr(rfilename)); 

    lines = octstr_split(receivers, octstr_imm("\n")); 
    lineno = gwlist_len(lines);
    if (lineno <= 0) 
        panic(0,"Receiver file seems empty!");

    info(0,"Receivers file `%s' contains %ld destination address(es).",
         octstr_get_cstr(rfilename), lineno);

    counter = counter_create();
}

main()

int main	(	int	argc,
		char **	argv
	)

Definition at line 434 of file mtbatch.c.

References account, bb_host, bb_port, bb_ssl, charset, coding, connect_to_bearerbox(), counter, counter_destroy(), counter_value(), delay, DLR_IS_ENABLED, dlr_mask, dlr_url, error(), from, getopt(), gwlib_init(), gwlib_shutdown(), gwlist_destroy(), gwthread_create, gwthread_join_all(), gwthread_sleep(), help(), identify_to_bearerbox(), init_batch(), lines, log_set_output_level(), msg_log, no_smsbox_id, octstr_create, octstr_destroy(), octstr_destroy_item(), optarg, optind, panic, payload, read_messages_from_bearerbox(), report_versions(), run_batch(), service, shutting_down, smsbox_id, smsc_id, and write_pid_file().

{
    int opt;
    unsigned long sended = 0;
    Octstr *cf, *rf;

    gwlib_init();

    bb_host = octstr_create("localhost");
    bb_port = 13001;
    bb_ssl = 0;
        
    while ((opt = getopt(argc, argv, "hv:b:p:si:xn:a:f:D:u:d:r:M:c:C:m")) != EOF) {
        switch (opt) {
            case 'v':
                log_set_output_level(atoi(optarg));
                break;
            case 'b':
                octstr_destroy(bb_host);
                bb_host = octstr_create(optarg);
                break;
            case 'p':
                bb_port = atoi(optarg);
                break;
            case 's':
                bb_ssl = 1;
                break;
            case 'i':
                smsbox_id = octstr_create(optarg);
                break;
            case 'x':
                no_smsbox_id = 1;
                break;
            case 'n':
                service = octstr_create(optarg);
                break;
            case 'a':
                account = octstr_create(optarg);
                break;
            case 'f':
                from = octstr_create(optarg);
                break;
            case 'D':
                dlr_mask = atoi(optarg);
                break;
            case 'u':
                dlr_url = octstr_create(optarg);
                break;
            case 'd':
                delay = atof(optarg);
                break;
            case 'r':
                smsc_id = octstr_create(optarg);
                break;
            case 'M':
                 meta_data = octstr_create(optarg);
                 break;
            case 'c':
                coding = atoi(optarg);
                break;
            case 'C':
                 charset = octstr_create(optarg);
                 break;
            case 'm':
                msg_log = 1;
                break;
            case '?':
            default:
                error(0, "Invalid option %c", opt);
                help();
                panic(0, "Stopping.");
        }
    }
    
    if (optind == argc || argc-optind < 2) {
        help();
        exit(1);
    }

    /* check some mandatory elements */
    if (from == NULL)
        panic(0,"Sender address not specified. Use option -f to specify sender address.");

    if ((DLR_IS_ENABLED(dlr_mask) && dlr_url == NULL) || (!DLR_IS_ENABLED(dlr_mask) && dlr_url != NULL))
        panic(0,"dlr-url address OR dlr-mask not specified. Use option -D or -u to specify dlr values");

    rf = octstr_create(argv[argc-1]);
    cf = octstr_create(argv[argc-2]);

    report_versions("mtbatch");
    write_pid_file();
 
    init_batch(cf, rf);

    connect_to_bearerbox(bb_host, bb_port, bb_ssl, NULL /* bb_our_host */);
    identify_to_bearerbox();
    gwthread_create(read_messages_from_bearerbox, NULL);

    sended = run_batch();

    /* avoid exiting before receiving all ACK msgs */
    while (sended > counter_value(counter)) {
         gwthread_sleep(0.1);
    }

    program_status = shutting_down;
    gwthread_join_all();

    octstr_destroy(bb_host);
    octstr_destroy(smsbox_id);
    octstr_destroy(content);
    octstr_destroy(service);
    octstr_destroy(account);
    octstr_destroy(dlr_url);
    octstr_destroy(smsc_id);
    octstr_destroy(meta_data);
    octstr_destroy(charset);
    octstr_destroy(payload);
    counter_destroy(counter);
    gwlist_destroy(lines, octstr_destroy_item); 
   
    gwlib_shutdown();

    return 0;
}

read_messages_from_bearerbox()

static void read_messages_from_bearerbox ( void *  arg )

static

Definition at line 143 of file mtbatch.c.

References ack_buffered, ack_failed, ack_failed_tmp, ack_success, cmd_restart, cmd_shutdown, counter, counter_increase(), debug(), info(), msg, msg_destroy(), msg_dump(), msg_log, read_from_bearerbox(), shutting_down, start, and warning().

Referenced by main().

{
    time_t start, t;
    unsigned long secs;
    unsigned long total_s, total_f, total_ft, total_b, total_o;
    Msg *msg;

    total_s = total_f = total_ft = total_b = total_o = 0;
    start = t = time(NULL);
    while (program_status != shutting_down) {
        int ret;

        /* block infinite for reading messages */
        ret = read_from_bearerbox(&msg, 0.5);
        if (ret == -1)
            break;
        else if (ret == 1) /* timeout */
            continue;
        else if (msg == NULL) /* just to be sure, may not happens */
            break;

        if (msg_log) {
            debug("msg", 0, "Received message from bearerbox:");
            msg_dump(msg, 0);
        }

        if (msg_type(msg) == admin) {
            if (msg->admin.command == cmd_shutdown ||
                msg->admin.command == cmd_restart) {
                info(0, "Bearerbox told us to die");
                program_status = shutting_down;
            }
            /*
             * XXXX here should be suspend/resume, add RSN
             */
            msg_destroy(msg);
        } else if (msg_type(msg) == ack) {
            counter_increase(counter);
            switch (msg->ack.nack) {
                case ack_success:
                    total_s++;
                    break;
                case ack_failed:
                    total_f++;
                    break;
                case ack_failed_tmp:
                    total_ft++;
                    break;
                case ack_buffered:
                    total_b++;
                    break;
            }
            msg_destroy(msg);
        } else {
            warning(0, "Received other message than ack/admin, ignoring!");
            msg_destroy(msg);
            total_o++;
        }
    }
    secs = difftime(time(NULL), start);
    info(0, "Received ACKs: %ld success, %ld failed, %ld failed temporarly, %ld queued, %ld other in %ld seconds "
         "(%.2f per second)", total_s, total_f, total_ft, total_b, total_o, secs,
         (float)(total_s+total_f+total_ft+total_b) / secs);
}

run_batch()

static unsigned long run_batch ( void  )

static

Definition at line 353 of file mtbatch.c.

References account, coding, debug(), dlr_mask, dlr_url, error(), from, gw_ismsisdnchar(), gwlist_consume(), gwlist_destroy(), gwlist_len(), info(), lines, MAX_SMS_OCTETS, msg, msg_create, msg_destroy(), msg_destroy_item(), msg_duplicate(), mt_push, no_smsbox_id, octstr_check_range(), octstr_create, octstr_destroy(), octstr_duplicate, octstr_get_cstr, octstr_len(), payload, send_message(), service, sms_split(), smsbox_id, and smsc_id.

Referenced by main().

{
    Octstr *no;
    unsigned long linerr = 0;
    unsigned long lineno = 0;
    Msg *tmsg;
    unsigned long msg_count;
    List *list;

    /*
     * Create message template.
     * Receiver is set in the duplicate that is send.
     */
    tmsg = msg_create(sms);
    tmsg->sms.smsc_id = smsc_id ? octstr_duplicate(smsc_id) : NULL;
    tmsg->sms.service = service ? octstr_duplicate(service) : NULL;
    tmsg->sms.sms_type = mt_push;
    tmsg->sms.sender = octstr_duplicate(from);
    tmsg->sms.account = account ? octstr_duplicate(account) : NULL;
    tmsg->sms.msgdata = payload ? octstr_duplicate(payload) : octstr_create("");
    tmsg->sms.dlr_mask = dlr_mask;
    tmsg->sms.dlr_url = octstr_duplicate(dlr_url);
    tmsg->sms.udhdata = octstr_create("");
    tmsg->sms.coding = coding;
    tmsg->sms.meta_data = octstr_duplicate(meta_data);

    /*
     * Encode our smsbox-id to the msg structure.
     * This will allow bearerbox to return specific answers to the
     * same smsbox, mainly for DLRs and SMS proxy modes.
     *
     * In addition the -x flag can be used to identify the mtbatch
     * instance with an own smsbox-id, but let the normal smsbox
     * daemons handle the DLRs coming back, as the mtbatch shuts down
     * after all MTs have been injected. It's not meant to process
     * the DLR messages.
     */
    if (no_smsbox_id == 0 && smsbox_id != NULL) {
        tmsg->sms.boxc_id = octstr_duplicate(smsbox_id);
    }

    list = sms_split(tmsg, NULL, NULL, NULL, NULL, 1, 0, 100, MAX_SMS_OCTETS);
    msg_count = gwlist_len(list);
    gwlist_destroy(list, msg_destroy_item);

    if (msg_count > 1) {
        debug("sms", 0, "Message length %ld octets, will send %ld concat parts for each message.",
              octstr_len(tmsg->sms.msgdata), msg_count);
    }

    /*
     * Send loop
     */
    while ((no = gwlist_consume(lines)) != NULL) {
        if (octstr_check_range(no, 0, 256, gw_ismsisdnchar)) {
            Msg *msg;
        
            lineno++;

            msg = msg_duplicate(tmsg);
            msg->sms.receiver = octstr_duplicate(no);

            if (send_message(msg) != 0) {
                linerr++;
                info(0,"Failed to send message at line <%ld> for receiver `%s' to bearerbox.",
                      lineno, octstr_get_cstr(no));
                msg_destroy(msg);
            }
        }
        else {
            linerr++;
            error(0, "Receiver `%s' at line <%ld> contains non-MSISDN characters, discarded!",
                  octstr_get_cstr(no), lineno);
        }
        octstr_destroy(no);
    }
    info(0, "Processed batch of %ld messages with %ld send errors.", lineno, linerr);
    msg_destroy(tmsg);
    return lineno;
} 

send_message()

static int send_message ( Msg *  msg )

static

Definition at line 213 of file mtbatch.c.

References debug(), delay, deliver_to_bearerbox(), gw_assert(), gwthread_sleep(), msg, msg_dump(), and msg_log.

Referenced by run_batch().

{
    gw_assert(msg != NULL);
    gw_assert(msg_type(msg) == sms);

    if (delay > 0)
        gwthread_sleep(delay);

    if (msg_log) {
        debug("msg", 0, "Sending message to bearerbox:");
        msg_dump(msg, 0);
    }

    /* pass message to bearerbox */
    return deliver_to_bearerbox(msg);
}

write_pid_file()

static void write_pid_file ( void  )

static

Definition at line 107 of file mtbatch.c.

References pid_file.

Referenced by main().

                                 {
    FILE *f;
        
    if (pid_file != NULL) {
    f = fopen(pid_file, "w");
    fprintf(f, "%d\n", (int)getpid());
    fclose(f);
    }
}

Variable Documentation

account

Octstr* account = NULL

static

Definition at line 94 of file mtbatch.c.

Referenced by check_allowed_translation(), fill_message(), find_default_translation(), generic_receive_sms(), get_x_kannel_from_headers(), get_x_kannel_from_xml(), kannel_receive_sms(), main(), run_batch(), smsbox_req_handle(), smsbox_req_sendota(), smsbox_req_sendsms(), smsbox_sendsms_post(), url_result_thread(), and xidris_receive_sms().

bb_host

Octstr* bb_host

static

Definition at line 89 of file mtbatch.c.

Referenced by main().

bb_port

long bb_port

static

Definition at line 90 of file mtbatch.c.

Referenced by main().

bb_ssl

int bb_ssl

static

Definition at line 91 of file mtbatch.c.

Referenced by main().

charset

Octstr* charset = NULL

static

Definition at line 103 of file mtbatch.c.

Referenced by init_batch(), and main().

coding

int coding = DC_7BIT

static

Definition at line 102 of file mtbatch.c.

Referenced by brunet_receive_sms(), fill_message(), get_x_kannel_from_headers(), get_x_kannel_from_xml(), init_batch(), kannel_receive_sms(), main(), run_batch(), sms_charset_processing(), smsbox_req_handle(), smsbox_req_sendsms(), smsbox_sendsms_post(), url_result_thread(), and xidris_receive_sms().

content

Octstr* content = NULL

static

Definition at line 87 of file mtbatch.c.

Referenced by parse_ota_syncsettings(), post_content_create(), soap_fetch_xml_data(), soap_map_xml_data(), and ws_pragma_meta_body().

counter

Counter* counter

static

Definition at line 92 of file mtbatch.c.

Referenced by init_batch(), main(), and read_messages_from_bearerbox().

delay

double delay = 0

static

Definition at line 99 of file mtbatch.c.

Referenced by emi2_do_send(), httpsmsc_sender(), main(), main_connection_loop(), send_message(), and send_messages().

dlr_mask

int dlr_mask = 0

static

Definition at line 96 of file mtbatch.c.

Referenced by main(), and run_batch().

dlr_url

Octstr* dlr_url = NULL

static

Definition at line 97 of file mtbatch.c.

Referenced by main(), and run_batch().

from

Octstr* from = NULL

static

Definition at line 95 of file mtbatch.c.

Referenced by brunet_receive_sms(), cgw_handle_op(), char_iso_to_sms(), char_sms_to_iso(), charset_to_utf8(), clickatell_receive_sms(), client(), delete_items_from_list(), fill_message(), generic_receive_sms(), get_x_kannel_from_headers(), get_x_kannel_from_xml(), http_append_headers(), internal_char_hex_to_gsm(), internal_char_hex_to_IA5(), internal_char_IA5_to_hex(), kannel_receive_sms(), line_scan_hex_GSM7(), line_scan_IA5_hex(), main(), octstr_binary_to_base64(), octstr_copy_real(), octstr_write_data(), ota_pack_message(), ota_tokenize_bookmarks(), ota_tokenize_settings(), parse_binary_to_emi(), parse_cimd_to_iso88591(), parse_emi_to_iso88591(), parse_iso88591_to_cimd(), parse_iso88591_to_emi(), run_batch(), server(), set_addr_tuple(), smsbox_req_handle(), smsbox_req_sendota(), smsbox_req_sendsms(), smsbox_sendota_post(), smsbox_sendsms_post(), url_result_thread(), X28_msg_pop(), and xidris_receive_sms().

lines

List* lines = NULL

static

Definition at line 88 of file mtbatch.c.

Referenced by cfg_read(), expand_file(), init_batch(), main(), numhash_create(), octstr_binary_to_base64(), and run_batch().

meta_data

Octstr* meta_data = NULL

static

Definition at line 101 of file mtbatch.c.

Referenced by fill_message(), generic_receive_sms(), smsbox_req_sendsms(), smsbox_sendsms_post(), and url_result_thread().

msg_log

int msg_log = 0

static

Definition at line 105 of file mtbatch.c.

Referenced by main(), read_messages_from_bearerbox(), and send_message().

no_smsbox_id

int no_smsbox_id = 0

static

Definition at line 100 of file mtbatch.c.

Referenced by main(), and run_batch().

payload

Octstr* payload = NULL

static

Definition at line 104 of file mtbatch.c.

Referenced by init_batch(), main(), and run_batch().

pid_file

char* pid_file

static

Definition at line 85 of file mtbatch.c.

Referenced by write_pid_file().

service

Octstr* service = NULL

static

Definition at line 93 of file mtbatch.c.

Referenced by main(), and run_batch().

smsbox_id

Octstr* smsbox_id = NULL

static

Definition at line 86 of file mtbatch.c.

Referenced by identify_to_bearerbox(), main(), and run_batch().

smsc_id

Octstr* smsc_id = NULL

static

Definition at line 98 of file mtbatch.c.

Referenced by boxc_route_msg_to_smsc(), check_multipart(), create_session(), handle_pdu(), init_smsc_routes(), main(), make_unit_push_request(), run_batch(), set_smsc_id(), smpp_pdu_init(), smpp_tlv_add_constant(), smpp_tlv_get_by_name(), smpp_tlv_get_by_tag(), smsc_smpp_create(), and wap_push_ppg_pushuser_smsc_id_get().