utils.h File Reference

#include <stddef.h>
#include <stdio.h>
#include "octstr.h"
#include <termios.h>

Go to the source code of this file.

Typedefs
typedef unsigned char	Octet
typedef unsigned long	MultibyteInt

Functions
MultibyteInt	get_variable_value (Octet *source, int *len)
int	write_variable_value (MultibyteInt value, Octet *dest)
Octet	reverse_octet (Octet source)
int	get_and_set_debugs (int argc, char **argv, int(*find_own)(int index, int argc, char **argv))
int	is_allowed_ip (Octstr *allow_ip, Octstr *deny_ip, Octstr *ip)
int	connect_denied (Octstr *allow_ip, Octstr *ip)
int	does_prefix_match (Octstr *prefix, Octstr *number)
int	normalize_number (char *dial_prefixes, Octstr **number)
long	decode_network_long (unsigned char *data)
void	encode_network_long (unsigned char *data, unsigned long value)
void	kannel_cfmakeraw (struct termios *tio)
int	gw_isdigit (int)
int	gw_isxdigit (int)
int	roundup_div (int a, int b)
unsigned long long	gw_generate_id (void)
void	init_fatal_signals (void)
Octstr *	version_report_string (const char *boxname)
void	report_versions (const char *boxname)

Typedef Documentation

MultibyteInt

typedef unsigned long MultibyteInt

Definition at line 76 of file utils.h.

Octet

typedef unsigned char Octet

Definition at line 75 of file utils.h.

Function Documentation

connect_denied()

int connect_denied	(	Octstr *	allow_ip,
		Octstr *	ip
	)

Definition at line 833 of file utils.c.

References allow_ip, octstr_imm(), and pattern_list_matches_ip().

Referenced by httpsmsc_receiver().

{
    if (ip == NULL)
    return 1;

    /* If IP not set, allow from Localhost */
    if (allow_ip == NULL) { 
    if (pattern_list_matches_ip(octstr_imm("127.0.0.1"), ip))
        return 0;
    } else {
    if (pattern_list_matches_ip(allow_ip, ip))
        return 0;
    }
    return 1;
}

decode_network_long()

long decode_network_long

(

unsigned char *

data

)

Definition at line 935 of file utils.c.

Referenced by conn_read_withlen(), parse_integer(), read_msg(), and smpp_pdu_read_len().

                                              {
        return (data[0] << 24) | (data[1] << 16) | (data[2] << 8) | data[3];
}

does_prefix_match()

int does_prefix_match	(	Octstr *	prefix,
		Octstr *	number
	)

Definition at line 850 of file utils.c.

References gw_assert(), number, and octstr_get_cstr.

Referenced by check_allowed_translation(), smsbox_req_handle(), and smscconn_usable().

{
    /* XXX modify to use just octstr operations
     */
    char *b, *p, *n;

    gw_assert(prefix != NULL);
    gw_assert(number != NULL);

    p = octstr_get_cstr(prefix);
    n = octstr_get_cstr(number);
    

    while (*p != '\0') {
        b = n;
        for (b = n; *b != '\0'; b++, p++) {
            if (*p == ';' || *p == '\0') {
                return 1;
            }
            if (*p != *b) break;
        }
        if (*p == ';' || *p == '\0') {
            return 1;
        }
        while (*p != '\0' && *p != ';')
            p++;
        while (*p == ';') p++;
    }
    return 0;
}

encode_network_long()

void encode_network_long	(	unsigned char *	data,
		unsigned long	value
	)

Definition at line 940 of file utils.c.

Referenced by append_integer(), conn_write_withlen(), and write_msg().

                                                                   {
        data[0] = (value >> 24) & 0xff;
        data[1] = (value >> 16) & 0xff;
        data[2] = (value >> 8) & 0xff;
        data[3] = value & 0xff;
}

get_and_set_debugs()

int get_and_set_debugs	(	int	argc,
		char **	argv,
		int(*)(int index, int argc, char **argv)	find_own
	)

Definition at line 626 of file utils.c.

References become_daemon(), cfg_dump_all(), change_user(), GW_DEBUG, GW_NON_EXCL, info(), init_fatal_signals(), log_close_all(), log_open(), log_set_debug_places(), log_set_output_level(), log_set_syslog(), octstr_destroy(), octstr_get_cstr, panic, parachute_start(), pid_file, remove_pid_file(), version_report_string(), and write_pid_file().

Referenced by main().

{
    int i, ret = -1;
    int debug_lvl = -1;
    int file_lvl = GW_DEBUG;
    char *log_file = NULL;
    char *debug_places = NULL;
    char *panic_script = NULL, *user = NULL;
    int parachute = 0, daemonize = 0;

    for (i=1; i < argc; i++) {
        if (strcmp(argv[i],"-v")==0 || strcmp(argv[i],"--verbosity")==0) {
            if (i+1 < argc) {
                debug_lvl = atoi(argv[i+1]);
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]); 
        } else if (strcmp(argv[i],"-F")==0 || strcmp(argv[i],"--logfile")==0) {
            if (i+1 < argc && *(argv[i+1]) != '-') {
                log_file = argv[i+1];
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]); 
        } else if (strcmp(argv[i],"-V")==0 || strcmp(argv[i],"--fileverbosity")==0) {
            if (i+1 < argc) {
                file_lvl = atoi(argv[i+1]);
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]); 
        } else if (strcmp(argv[i],"-D")==0 || strcmp(argv[i],"--debug")==0) {
            if (i+1 < argc) {
                debug_places = argv[i+1];
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]); 
        } else if (strcmp(argv[i], "-X")==0 || strcmp(argv[i], "--panic-script")==0) {
            if (i+1 < argc) {
                panic_script = argv[i+1];
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]);
        } else if (strcmp(argv[i], "-P")==0 || strcmp(argv[i], "--parachute")==0) {
            parachute = 1;
        } else if (strcmp(argv[i], "-d")==0 || strcmp(argv[i], "--daemonize")==0) {
            daemonize = 1;
        } else if (strcmp(argv[i], "-p")==0 || strcmp(argv[i], "--pid-file")==0) {
            if (i+1 < argc) {
                pid_file = argv[i+1];
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]);
        } else if (strcmp(argv[i], "-u")==0 || strcmp(argv[i], "--user")==0) {
            if (i+1 < argc) {
                user = argv[i+1];
                i++;
            } else
                panic(0, "Missing argument for option %s\n", argv[i]);
        } else if (strcmp(argv[i], "-g")==0 || strcmp(argv[i], "--generate")==0) {
            cfg_dump_all();
            exit(0);
        } else if (strcmp(argv[i], "--version")==0) {
            Octstr *version = version_report_string(basename(argv[0]));
            printf("%s", octstr_get_cstr(version));
            octstr_destroy(version);
            exit(0);
        } else if (strcmp(argv[i],"--")==0) {
            i++;
            break;
        } else if (*argv[i] != '-') {
            break;
        } else {
            if (find_own != NULL) {
            ret = find_own(i, argc, argv);
        }
        if (ret < 0) {
            fprintf(stderr, "Unknown option %s, exiting.\n", argv[i]);
            panic(0, "Option parsing failed");
        } else
            i += ret;   /* advance additional args */
        }
    }

    if (user && -1 == change_user(user))
        panic(0, "Could not change to user `%s'.", user);

    /* deamonize */
    if (daemonize && !become_daemon())
       exit(0);

    if (pid_file) {
        write_pid_file();
        atexit(remove_pid_file);
    }

    if (parachute) {
        /*
         * if we are running as daemon so open syslog
         * in order not to deal with i.e. log rotate.
         */
        if (daemonize) {
            char *ident = strrchr(argv[0], '/');
            if (!ident)
                ident = argv[0];
            else
                ident++;
            log_set_syslog(ident, (debug_lvl > -1 ? debug_lvl : 0));
        }
        parachute_start(argv[0], panic_script);
        /* now we are in child process so close syslog */
        if (daemonize)
            log_close_all();
    }

    if (debug_lvl > -1)
        log_set_output_level(debug_lvl);
    if (debug_places != NULL)
        log_set_debug_places(debug_places);
    if (log_file != NULL)
        log_open(log_file, file_lvl, GW_NON_EXCL);

    info(0, "Debug_lvl = %d, log_file = %s, log_lvl = %d",
         debug_lvl, log_file ? log_file : "<none>", file_lvl);
    if (debug_places != NULL)
        info(0, "Debug places: `%s'", debug_places);


    init_fatal_signals();
    
    return i;
}

get_variable_value()

MultibyteInt get_variable_value	(	Octet *	source,
		int *	len
	)

Definition at line 477 of file utils.c.

Referenced by sema_decode_msg().

{
    MultibyteInt retval = 0;
    
    for(*len=1;; (*len)++, source++) {
    retval = retval * 0x80 + (*source & 0x7F);
    if (*source < 0x80)  /* if the continue-bit (high bit) is not set */
        break;
    }
    return retval;
}

gw_generate_id()

unsigned long long gw_generate_id

(

void

)

Definition at line 1013 of file utils.c.

References gw_rand().

{
    /* create a 64 bit unique Id by putting a 32 bit epoch time value
     * and a 32 bit random value together */
    unsigned long random, timer;
     
    random = gw_rand();
    timer = (unsigned long)time(NULL);
    
    return ((unsigned long long)timer << 32) + random;
}

gw_isdigit()

int gw_isdigit

(

int

)

Definition at line 988 of file utils.c.

Referenced by convert_addr_from_pdu(), date_parse_iso(), get_originator_type(), handle_dlr(), handle_pdu(), msg_to_cgwop(), msg_to_emimsg(), msg_to_pdu(), pack_parameter(), packet_check_header(), and packet_check_parameter().

{
    return isdigit(c);
}

gw_isxdigit()

int gw_isxdigit

(

int

)

Definition at line 994 of file utils.c.

Referenced by octstr_hex_to_binary(), octstr_is_all_hex(), octstr_symbolize(), packet_check(), and packet_check_parameter().

{
    return isxdigit(c);
}

init_fatal_signals()

void init_fatal_signals

(

void

)

Install fatal signal handler. Usefull to receive backtrace if program crash with SEGFAULT.

Definition at line 527 of file utils.c.

References fatal_handler().

Referenced by get_and_set_debugs(), and parachute_init_signals().

{
    /* install fatal signal handler */
    struct sigaction act;
    /* set segfault handler */
    sigemptyset(&act.sa_mask);
    act.sa_sigaction = fatal_handler;
    act.sa_flags = SA_SIGINFO;
    sigaction(SIGSEGV, &act, NULL);
}

is_allowed_ip()

int is_allowed_ip	(	Octstr *	allow_ip,
		Octstr *	deny_ip,
		Octstr *	ip
	)

Definition at line 815 of file utils.c.

References allow_ip, deny_ip, octstr_len(), and pattern_list_matches_ip().

Referenced by accept_boxc(), authorise_username(), cgw_listener(), check_login(), emi2_listener(), fake_listener(), get_data(), httpadmin_run(), main(), and udp_receiver().

{
    if (ip == NULL)
    return 0;

    if (octstr_len(deny_ip) == 0)
    return 1;

    if (allow_ip != NULL && pattern_list_matches_ip(allow_ip, ip))
    return 1;

    if (pattern_list_matches_ip(deny_ip, ip))
        return 0;

    return 1;
}

kannel_cfmakeraw()

void kannel_cfmakeraw

(

struct termios *

tio

)

Definition at line 951 of file utils.c.

Referenced by at2_open_device(), at_dial(), and X28_open_data_link().

                                           {
    /* Block until a charactor is available, but it only needs to be one*/
    tio->c_cc[VMIN]    = 1;
    tio->c_cc[VTIME]   = 0;

    /* GNU cfmakeraw sets these flags so we had better too...*/

    /* Control modes */
    /* Mask out character size (CSIZE), then set it to 8 bits (CS8).
     * Enable parity bit generation in both directions (PARENB).
     */
    tio->c_cflag      &= ~(CSIZE|PARENB);
    tio->c_cflag      |= CS8;

    /* Input Flags,*/
    /* Turn off all input flags that interfere with the byte stream:
     * BRKINT - generate SIGINT when receiving BREAK, ICRNL - translate
     * NL to CR, IGNCR - ignore CR, IGNBRK - ignore BREAK,
     * INLCR - translate NL to CR, IXON - use XON/XOFF flow control,
     * ISTRIP - strip off eighth bit.
     */
    tio->c_iflag &= ~(BRKINT|ICRNL|IGNCR|IGNBRK|INLCR|IXON|ISTRIP);

    /* Other flags,*/
    /* Turn off all local flags that interpret the byte stream:
     * ECHO - echo input chars, ECHONL - always echo NL even if ECHO is off,
     * ICANON - enable canonical mode (basically line-oriented mode),
     * IEXTEN - enable implementation-defined input processing,
     * ISIG - generate signals when certain characters are received. */
    tio->c_lflag      &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);

    /* Output flags,*/
    /* Disable implementation defined processing on the output stream*/
    tio->c_oflag      &= ~OPOST;
}

normalize_number()

int normalize_number	(	char *	dial_prefixes,
		Octstr **	number
	)

Definition at line 882 of file utils.c.

References gw_assert(), number, octstr_create_from_data, octstr_destroy(), octstr_get_cstr, octstr_insert_data(), octstr_len(), and start.

Referenced by bb_smscconn_receive(), radius_acct_get_msisdn(), smsc2_rout(), and smscconn_send().

{
    char *t, *p, *official, *start;
    int len, official_len;
    
    if (dial_prefixes == NULL || dial_prefixes[0] == '\0')
        return 0;

    t = official = dial_prefixes;
    official_len = 0;

    gw_assert(number != NULL);
    
    while(1) {

        p = octstr_get_cstr(*number);
        for(start = t, len = 0; ; t++, p++, len++)
    {
            if (*t == ',' || *t == ';' || *t == '\0') {
                if (start != official) {
                    Octstr *nstr;
            long n;
            
            if ( official[0] == '-' ) official_len=0;
            n = official_len;
            if (strlen(official) < (size_t) n)
                n = strlen(official);
                    nstr = octstr_create_from_data(official, n);
                    octstr_insert_data(nstr, official_len,
                                           octstr_get_cstr(*number) + len,
                                           octstr_len(*number) - len);
                    octstr_destroy(*number);
                    *number = nstr;
                }
                return 1;
            }
            if (*p == '\0' || *t != *p)
                break;          /* not matching */
        }
        for(; *t != ',' && *t != ';' && *t != '\0'; t++, len++)
            ;
        if (*t == '\0') break;
        if (start == official) official_len = len;
        if (*t == ';') official = t+1;
        t++;
    }
    return 0;
}

report_versions()

void report_versions

(

const char *

boxname

)

Definition at line 539 of file utils.c.

References debug(), octstr_destroy(), octstr_get_cstr, and version_report_string().

Referenced by main().

{
    Octstr *os;
    
    os = version_report_string(boxname);
    debug("gwlib.gwlib", 0, "%s", octstr_get_cstr(os));
    octstr_destroy(os);
}

reverse_octet()

Octet reverse_octet

(

Octet

source

)

Definition at line 511 of file utils.c.

Referenced by OTAbitmap_create(), and wbmp_create().

{
    Octet   dest;
    dest = (source & 1) <<7;
    dest += (source & 2) <<5;
    dest += (source & 4) <<3;
    dest += (source & 8) <<1;
    dest += (source & 16) >>1;
    dest += (source & 32) >>3;
    dest += (source & 64) >>5;
    dest += (source & 128) >>7;
    
    return dest;
}

roundup_div()

int roundup_div	(	int	a,
		int	b
	)

Definition at line 1001 of file utils.c.

{
    int t;

    t = a / b;
    if (t * b != a)
        t += 1;

    return t;
}

version_report_string()

Octstr* version_report_string

(

const char *

boxname

)

Definition at line 549 of file utils.c.

References get_official_ip(), get_official_name(), octstr_format(), and octstr_get_cstr.

Referenced by bb_print_status(), get_and_set_debugs(), and report_versions().

{
    struct utsname u;

    uname(&u);
    return octstr_format(GW_NAME " %s version `%s'.\nBuild `%s', compiler `%s'.\n"
                         "System %s, release %s, version %s, machine %s.\n"
             "Hostname %s, IP %s.\n"
             "Libxml version %s.\n"
#ifdef HAVE_LIBSSL
             "Using "
#ifdef HAVE_WTLS_OPENSSL
             "WTLS library "
#endif
             "%s.\n"
#endif
#ifdef HAVE_MYSQL
             "Compiled with MySQL %s, using MySQL %s.\n"
#endif
#ifdef HAVE_PGSQL
             "Compiled with PostgreSQL %s.\n"
#endif
#ifdef HAVE_SDB
             "Using LibSDB %s.\n"
#endif
#if defined(HAVE_SQLITE) || defined(HAVE_SQLITE3)
             "Using SQLite %s.\n"
#endif
#ifdef HAVE_ORACLE
#if defined(OCI_MAJOR_VERSION) && defined(OCI_MINOR_VERSION)
             "Using Oracle OCI %d.%d.\n"
#else
             "Using Oracle OCI.\n"
#endif
#endif
#ifdef HAVE_REDIS
             "Using hiredis API %d.%d.%d\n"
#endif
             "Using %s malloc.\n",
             boxname, GW_VERSION,
#ifdef __GNUC__ 
             (__DATE__ " " __TIME__) ,
             __VERSION__,
#else 
             "unknown" , "unknown",
#endif 
             u.sysname, u.release, u.version, u.machine,
             octstr_get_cstr(get_official_name()),
             octstr_get_cstr(get_official_ip()),
             LIBXML_DOTTED_VERSION,
#ifdef HAVE_LIBSSL
             OPENSSL_VERSION_TEXT,
#endif
#ifdef HAVE_MYSQL
             MYSQL_SERVER_VERSION, mysql_get_client_info(),
#endif
#ifdef HAVE_PGSQL
             PG_VERSION,
#endif
#ifdef HAVE_SDB
             LIBSDB_VERSION,
#endif
#if defined(HAVE_SQLITE) || defined(HAVE_SQLITE3)
             SQLITE_VERSION,
#endif
#ifdef HAVE_ORACLE
#if defined(OCI_MAJOR_VERSION) && defined(OCI_MINOR_VERSION)
             OCI_MAJOR_VERSION, OCI_MINOR_VERSION,
#endif
#endif
#ifdef HAVE_REDIS
             HIREDIS_MAJOR, HIREDIS_MINOR, HIREDIS_PATCH,
#endif
             octstr_get_cstr(gwmem_type()));
}

write_variable_value()

int write_variable_value	(	MultibyteInt	value,
		Octet *	dest
	)

Definition at line 490 of file utils.c.

Referenced by sema_encode_msg(), sema_submit_result(), and wbmp_create_stream().

{
    int i, loc = 0;
    Octet revbuffer[20];    /* we write it backwards */
    
    for (;;) {
    revbuffer[loc++] = (value & 0x7F) + 0x80;   
    if (value >= 0x80)
        value = value >> 7;
    else
        break;
    }
    for(i=0; i < loc; i++)      /* reverse the buffer */
    dest[i] = revbuffer[loc-i-1];
    
    dest[loc-1] &= 0x7F;    /* remove trailer-bit from last */

    return loc;
}