carrierroute.c

Go to the documentation of this file.

/*
 * $Id$
 *
 * Copyright (C) 2007-2008 1&1 Internet AG
 *
 * This file is part of SIP-router, a free SIP server.
 *
 * SIP-router is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * SIP-router is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include "../../sr_module.h"
#include "../../str.h"
#include "../../mem/mem.h"
#include "../../ut.h" /* for user2uid() */
#include "carrierroute.h"
#include "cr_fixup.h"
#include "cr_map.h"
#include "cr_fifo.h"
#include "cr_data.h"
#include "cr_func.h"
#include "db_carrierroute.h"
#include "config.h"
#include <sys/stat.h>

MODULE_VERSION

str carrierroute_db_url = str_init(DEFAULT_RODB_URL);
str subscriber_table = str_init("subscriber");

static str subscriber_username_col = str_init("username");
static str subscriber_domain_col = str_init("domain");
static str cr_preferred_carrier_col = str_init("cr_preferred_carrier");

str * subscriber_columns[SUBSCRIBER_COLUMN_NUM] = {
        &subscriber_username_col,
        &subscriber_domain_col,
        &cr_preferred_carrier_col
};

char * config_source = "file";
char * config_file = CFG_DIR"carrierroute.conf";

str default_tree = str_init("default");
const str CR_EMPTY_PREFIX = str_init("null");

int mode = 0;
int cr_match_mode = 10;


/************* Declaration of Interface Functions **************************/
static int mod_init(void);
static int child_init(int);
static int mi_child_init(void);
static void mod_destroy(void);


/************* Module Exports **********************************************/
static cmd_export_t cmds[]={
        {"cr_user_carrier",  (cmd_function)cr_load_user_carrier,  3, cr_load_user_carrier_fixup, 0, REQUEST_ROUTE | FAILURE_ROUTE },
        {"cr_route",         (cmd_function)cr_route5,              5, cr_route_fixup,             0, REQUEST_ROUTE | FAILURE_ROUTE },
        {"cr_route",         (cmd_function)cr_route,              6, cr_route_fixup,             0, REQUEST_ROUTE | FAILURE_ROUTE },
        {"cr_nofallback_route",(cmd_function)cr_nofallback_route5,     5, cr_route_fixup,             0, REQUEST_ROUTE | FAILURE_ROUTE },
        {"cr_nofallback_route",(cmd_function)cr_nofallback_route,     6, cr_route_fixup,             0, REQUEST_ROUTE | FAILURE_ROUTE },
        {"cr_next_domain",   (cmd_function)cr_load_next_domain,   6, cr_load_next_domain_fixup,  0, REQUEST_ROUTE | FAILURE_ROUTE },
        {0, 0, 0, 0, 0, 0}
};

static param_export_t params[]= {
        carrierroute_DB_URL
        carrierroute_DB_TABLE
        carrierfailureroute_DB_TABLE
        carrier_name_DB_TABLE
        domain_name_DB_TABLE
        carrierroute_DB_COLS
        carrierfailureroute_DB_COLS
        carrier_name_DB_COLS
        domain_name_DB_COLS
        {"subscriber_table",       STR_PARAM, &subscriber_table.s },
        {"subscriber_user_col",    STR_PARAM, &subscriber_username_col.s },
        {"subscriber_domain_col",  STR_PARAM, &subscriber_domain_col.s },
        {"subscriber_carrier_col", STR_PARAM, &cr_preferred_carrier_col.s },
        {"config_source",          STR_PARAM, &config_source },
        {"default_tree",           STR_PARAM, &default_tree.s },
        {"config_file",            STR_PARAM, &config_file },
        {"use_domain",             INT_PARAM, &default_carrierroute_cfg.use_domain },
        {"fallback_default",       INT_PARAM, &default_carrierroute_cfg.fallback_default },
        {"fetch_rows",             INT_PARAM, &default_carrierroute_cfg.fetch_rows },
        {"match_mode",             INT_PARAM, &cr_match_mode },
        {0,0,0}
};

static mi_export_t mi_cmds[] = {
        { "cr_reload_routes",   reload_fifo,     MI_NO_INPUT_FLAG, 0,  mi_child_init },
        { "cr_dump_routes",     dump_fifo,       MI_NO_INPUT_FLAG, 0,  0 },
        { "cr_replace_host",    replace_host,    0,                0,  0 },
        { "cr_deactivate_host", deactivate_host, 0,                0,  0 },
        { "cr_activate_host",   activate_host,   0,                0,  0 },
        { "cr_add_host",        add_host,        0,                0,  0 },
        { "cr_delete_host",     delete_host,     0,                0,  0 },
        { 0, 0, 0, 0, 0}
};

struct module_exports exports = {
        "carrierroute",
        DEFAULT_DLFLAGS, /* dlopen flags */
        cmds,       /* Exported functions */
        params,     /* Export parameters */
        0,          /* exported statistics */
        mi_cmds,    /* exported MI functions */
        0,          /* exported pseudo-variables */
        0,          /* extra processes */
        mod_init,   /* Module initialization function */
        0,          /* Response function */
        mod_destroy,/* Destroy function */
        child_init  /* Child initialization function */
};


/************* Interface Functions *****************************************/

static int mod_init(void) {
        struct stat fs;
        extern char* user; /*from main.c*/
        int uid, gid;

        if(register_mi_mod(exports.name, mi_cmds)!=0)
        {
                LM_ERR("failed to register MI commands\n");
                return -1;
        }

        subscriber_table.len = strlen(subscriber_table.s);
        subscriber_username_col.len = strlen(subscriber_username_col.s);
        subscriber_domain_col.len = strlen(subscriber_domain_col.s);
        cr_preferred_carrier_col.len = strlen(cr_preferred_carrier_col.s);
        default_tree.len = strlen(default_tree.s);

        carrierroute_db_vars();

        if (cr_match_mode != 10 && cr_match_mode != 128) {
                LM_ERR("invalid matching mode %d specific, please use 10 or 128\n", cr_match_mode);
                return -1;
        }

        if (strcmp(config_source, "db") == 0) {
                mode = CARRIERROUTE_MODE_DB;

                LM_INFO("use database as configuration source\n");
                if(carrierroute_db_init() < 0){
                        return -1;
                }
                // FIXME, move data initialization into child process
                if(carrierroute_db_open() < 0){
                        return -1;
                }
        }
        else if (strcmp(config_source, "file") == 0) {
                mode = CARRIERROUTE_MODE_FILE;

                LM_INFO("use file as configuration source\n");
                if(stat(config_file, &fs) != 0){
                        LM_ERR("can't stat config file\n");
                        return -1;
                }
                if(fs.st_mode & S_IWOTH){
                        LM_WARN("insecure file permissions, routing data is world writeable\n");
                }

                if (user){
                        if (user2uid(&uid, &gid, user)<0){
                                LM_ERR("bad user name/uid number: -u %s\n", user);
                                return -1;
                        }
                } else {
                        uid = geteuid();
                        gid = getegid();
                }

                if( !( fs.st_mode & S_IWOTH) &&
                        !((fs.st_mode & S_IWGRP) && (fs.st_gid == uid)) &&
                        !((fs.st_mode & S_IWUSR) && (fs.st_uid == gid))) {
                                LM_ERR("config file %s not writable\n", config_file);
                                return -1;
                }
        }
        else {
                LM_ERR("invalid config_source parameter: %s\n", config_source);
                return -1;
        }

        if(cfg_declare("carrierroute", carrierroute_cfg_def, &default_carrierroute_cfg, cfg_sizeof(carrierroute), &carrierroute_cfg)){
                LM_ERR("Fail to declare the configuration\n");
                return -1;
        }

        if (init_route_data() < 0) {
                LM_ERR("could not init route data\n");
                return -1;
        }

        if (reload_route_data() == -1) {
                LM_ERR("could not prepare route data\n");
                return -1;
        }

        if(mode == CARRIERROUTE_MODE_DB){
                carrierroute_db_close();
        }
        return 0;
}


static int child_init(int rank) {
        if (rank==PROC_INIT || rank==PROC_MAIN || rank==PROC_TCP_MAIN)
                return 0; /* do nothing for the main process */

        if(mode == CARRIERROUTE_MODE_DB){
                return carrierroute_db_open();
        }
        return 0;
}


static int mi_child_init(void) {
        if(mode == CARRIERROUTE_MODE_DB){
                return carrierroute_db_open();
        }
        return 0;
}


static void mod_destroy(void) {
        if(mode == CARRIERROUTE_MODE_DB){
                carrierroute_db_close();
        }
        destroy_route_data();
}