domainpolicy_mod.c

Go to the documentation of this file.

/*
 * $Id: domainpolicy_mod.c 5695 2009-03-12 23:22:18Z henningw $
 *
 * Copyright (C) 2002-2003 Juha Heinanen
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio 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
 *
 * Kamailio 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
 *
 * History:
 * -------
 * 2003-03-11: New module interface (janakj)
 * 2003-03-16: flags export parameter added (janakj)
 * 2003-04-05: default_uri #define used (jiri)
 * 2003-04-06: db connection closed in mod_init (janakj)
 * 2004-06-06  updated to the new DB api, cleanup: static dbf & handler,
 *              calls to domainpolicy_db_{bind,init,close,ver} (andrei)
 */


/*!
 * \file
 * \brief Domain module
 */

#include "domainpolicy_mod.h"
#include <stdio.h>
#include "../../mem/shm_mem.h"
#include "../../sr_module.h"
#include "../../ut.h"
#include "domainpolicy.h"

/*
 * Module management function prototypes
 */
static int mod_init(void);
static int child_init(int rank);

MODULE_VERSION

/*!
 * Version of gw and lcr tables required by the module, increment this value
 * if you change the table in an backwards incompatible way
 */
#define DOMAINPOLICY_TABLE_VERSION 2


#define DOMAINPOLICY_TABLE "domainpolicy"
#define DOMAINPOLICY_COL_RULE "rule"
#define DOMAINPOLICY_COL_TYPE "type"
#define DOMAINPOLICY_COL_ATT "att"
#define DOMAINPOLICY_COL_VAL "val"

/* Default avp names */
#define DEF_PORT_OVERRIDE_AVP         "portoverride"
#define DEF_TRANSPORT_OVERRIDE_AVP    "transportoverride"
#define DEF_DOMAIN_PREFIX_AVP         "domainprefix"
#define DEF_DOMAIN_SUFFIX_AVP         "domainsuffix"
#define DEF_DOMAIN_REPLACEMENT_AVP    "domainreplacement"
#define DEF_SEND_SOCKET_AVP           "sendsocket"

/*
 * Module parameter variables
 */
static str db_url         = str_init(DEFAULT_RODB_URL);
str domainpolicy_table    = str_init(DOMAINPOLICY_TABLE);     /*!< Name of domainpolicy table */
str domainpolicy_col_rule = str_init(DOMAINPOLICY_COL_RULE);
str domainpolicy_col_type = str_init(DOMAINPOLICY_COL_TYPE);
str domainpolicy_col_att  = str_init(DOMAINPOLICY_COL_ATT);
str domainpolicy_col_val  = str_init(DOMAINPOLICY_COL_VAL);

str port_override_avp         = str_init(DEF_PORT_OVERRIDE_AVP);
str transport_override_avp    = str_init(DEF_TRANSPORT_OVERRIDE_AVP);
str domain_prefix_avp         = str_init(DEF_DOMAIN_PREFIX_AVP);
str domain_suffix_avp         = str_init(DEF_DOMAIN_SUFFIX_AVP);
str domain_replacement_avp    = str_init(DEF_DOMAIN_REPLACEMENT_AVP);
str send_socket_avp           = str_init(DEF_SEND_SOCKET_AVP);

/*
 * Other module variables
 */

int_str port_override_name, transport_override_name, domain_prefix_name, 
   domain_suffix_name, domain_replacement_name, send_socket_name;
unsigned short port_override_avp_name_str;
unsigned short transport_override_avp_name_str;
unsigned short domain_prefix_avp_name_str;
unsigned short domain_suffix_avp_name_str;
unsigned short domain_replacement_avp_name_str;
unsigned short send_socket_avp_name_str;

/*
 * Exported functions
 */
static cmd_export_t cmds[] = {
   {"dp_can_connect",  (cmd_function)dp_can_connect,  0, 0, 0, REQUEST_ROUTE},
   {"dp_apply_policy", (cmd_function)dp_apply_policy, 0, 0, 0, REQUEST_ROUTE},
   {0, 0, 0, 0, 0, 0}
};


/*
 * Exported parameters
 */
static param_export_t params[] = {
   {"db_url",                    STR_PARAM, &db_url.s                   },
   {"dp_table",                  STR_PARAM, &domainpolicy_table.s       },
   {"dp_col_rule",               STR_PARAM, &domainpolicy_col_rule.s    },
   {"dp_col_type",               STR_PARAM, &domainpolicy_col_type.s    },
   {"dp_col_att",                STR_PARAM, &domainpolicy_col_att.s     },
   {"dp_col_val",                STR_PARAM, &domainpolicy_col_val.s     },
   {"port_override_avp",         STR_PARAM, &port_override_avp.s        },
   {"transport_override_avp",    STR_PARAM, &transport_override_avp.s   },
   {"domain_prefix_avp",         STR_PARAM, &domain_prefix_avp.s        },
   {"domain_suffix_avp",         STR_PARAM, &domain_suffix_avp.s        },
   {"domain_replacement_avp",    STR_PARAM, &domain_replacement_avp.s   },
   {"send_socket_avp",           STR_PARAM, &send_socket_avp.s          },
   {0, 0, 0}
};


/*
 * Module interface
 */
struct module_exports exports = {
   "domainpolicy", 
   DEFAULT_DLFLAGS, /*!< dlopen flags */
   cmds,      /*!< exported functions */
   params,    /*!< exported parameters */
   0,         /*!< exported statistics */
   0,         /*!< exported MI functions */
   0,         /*!< exported pseudo-variables */
   0,         /*!< extra processes */
   mod_init,  /*!< module initialization function */
   0,         /*!< response function*/
   0,         /*!< destroy function */
   child_init /*!< per-child init function */
};


static int mod_init(void)
{
   unsigned int par;
   int ver;

   db_url.len = strlen(db_url.s);
   domainpolicy_table.len = strlen(domainpolicy_table.s);
   domainpolicy_col_rule.len = strlen(domainpolicy_col_rule.s);
   domainpolicy_col_type.len = strlen(domainpolicy_col_type.s);
   domainpolicy_col_att.len = strlen(domainpolicy_col_att.s);
   domainpolicy_col_val.len = strlen(domainpolicy_col_val.s);

   LM_DBG("check for DB module\n");

   /* Check if database module has been loaded */
   if (domainpolicy_db_bind(&db_url)<0)  {
      LM_ERR("no database module loaded!"
         " Please make sure that a DB module is loaded first\n");
      return -1;
   }

   LM_DBG("update length of module variables\n");
   /* Update length of module variables */
   port_override_avp.len         = strlen(port_override_avp.s);
   transport_override_avp.len    = strlen(transport_override_avp.s);
   domain_prefix_avp.len         = strlen(domain_prefix_avp.s);
   domain_suffix_avp.len         = strlen(domain_suffix_avp.s);
   domain_replacement_avp.len    = strlen(domain_replacement_avp.s);
   send_socket_avp.len           = strlen(send_socket_avp.s);

   /* Check table version */
   ver = domainpolicy_db_ver(&db_url, &domainpolicy_table);
   if (ver < 0) {
      LM_ERR("failed to query table version\n");
      return -1;
   } else if (ver < DOMAINPOLICY_TABLE_VERSION) {
      LM_ERR("invalid table version of domainpolicy table\n");
      return -1;
   }

   /* Assign AVP parameter names */
   LM_DBG("AVP\n");
   if (str2int(&port_override_avp, &par) == 0) {
      if (!par) {
         LM_ERR("port_override_avp not defined!\n");
         return -1;
      }
      port_override_name.n = par;
      port_override_avp_name_str = 0;
   } else {
      port_override_name.s = port_override_avp;
      port_override_avp_name_str = AVP_NAME_STR;
   }
   if (str2int(&transport_override_avp, &par) == 0) {
      if (!par) {
         LM_ERR(" transport_override_avp not defined!\n");
         return -1;
      }
      transport_override_name.n = par;
      transport_override_avp_name_str = 0;
   } else {
      transport_override_name.s = transport_override_avp;
      transport_override_avp_name_str = AVP_NAME_STR;
   }
   if (str2int(&domain_prefix_avp, &par) == 0) {
      if (!par) {
         LM_ERR("domain_prefix_avp not defined!\n");
         return -1;
      }
      domain_prefix_name.n = par;
      domain_prefix_avp_name_str = 0;
   } else {
      domain_prefix_name.s = domain_prefix_avp;
      domain_prefix_avp_name_str = AVP_NAME_STR;
   }
   if (str2int(&domain_suffix_avp, &par) == 0) {
      if (!par) {
         LM_ERR(" domain_suffix_avp not defined!\n");
         return -1;
      }
      domain_suffix_name.n = par;
      domain_suffix_avp_name_str = 0;
   } else {
      domain_suffix_name.s = domain_suffix_avp;
      domain_suffix_avp_name_str = AVP_NAME_STR;
   }
   if (str2int(&domain_replacement_avp, &par) == 0) {
      if (!par) {
         LM_ERR(" domain_replacement_avp not defined!\n");
         return -1;
      }
      domain_replacement_name.n = par;
      domain_replacement_avp_name_str = 0;
   } else {
      domain_replacement_name.s = domain_replacement_avp;
      domain_replacement_avp_name_str = AVP_NAME_STR;
   }
   if (str2int(&send_socket_avp, &par) == 0) {
      if (!par) {
         LM_ERR(" send_socket_avp not defined!\n");
         return -1;
      }
      send_socket_name.n = par;
      send_socket_avp_name_str = 0;
   } else {
      send_socket_name.s = send_socket_avp;
      send_socket_avp_name_str = AVP_NAME_STR;
   }

   return 0;
}


static int child_init(int rank)
{
   /* Check if database is needed by child */
   if (rank > 0)  {
      if (domainpolicy_db_init(&db_url)<0) {
         LM_ERR("unable to connect to the database\n");
         return -1;
      }
   }
   return 0;
}