rr_mod.c

Go to the documentation of this file.

/*
 * $Id: rr_mod.c 5575 2009-02-10 10:13:29Z henningw $
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * 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
 */

/*!
 * \file
 * \brief Route & Record-Route module
 * \ingroup rr
 */


#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <regex.h>

#include "../../sr_module.h"
#include "../../ut.h"
#include "../../error.h"
#include "../../pvar.h"
#include "../../mem/mem.h"
#include "../../mod_fix.h"
#include "loose.h"
#include "record.h"
#include "rr_cb.h"
#include "api.h"

#ifdef ENABLE_USER_CHECK
#include <string.h>
#include "../../str.h"
str i_user;
char *ignore_user = NULL;
#endif

int append_fromtag = 1;    /*!< append from tag by default */
int enable_double_rr = 1;  /*!< enable using of 2 RR by default */
int enable_full_lr = 0;    /*!< compatibilty mode disabled by default */
int add_username = 0;      /*!< do not add username by default */

static unsigned int last_rr_msg;

MODULE_VERSION

static int  mod_init(void);static void mod_destroy(void);
/* fixup functions */
static int direction_fixup(void** param, int param_no);
static int it_list_fixup(void** param, int param_no);
/* wrapper functions */
static int w_record_route(struct sip_msg *,char *, char *);
static int w_record_route_preset(struct sip_msg *,char *, char *);
static int w_add_rr_param(struct sip_msg *,char *, char *);
static int w_check_route_param(struct sip_msg *,char *, char *);
static int w_is_direction(struct sip_msg *,char *, char *);

/*!
 * \brief Exported functions
 */
static cmd_export_t cmds[] = {
   {"loose_route",          (cmd_function)loose_route,         0, 0, 0,
         REQUEST_ROUTE},
   {"record_route",         (cmd_function)w_record_route,      0, 0, 0,
         REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE},
   {"record_route",         (cmd_function)w_record_route,      1, it_list_fixup, 0,
         REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE},
   {"record_route_preset",  (cmd_function)w_record_route_preset, 1, it_list_fixup, 0,
         REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE},
   {"add_rr_param",         (cmd_function)w_add_rr_param,   1, it_list_fixup, 0,
         REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE},
   {"check_route_param",    (cmd_function)w_check_route_param, 1, fixup_regexp_null, fixup_free_regexp_null,
         REQUEST_ROUTE},
   {"is_direction",         (cmd_function)w_is_direction,      1, direction_fixup, 0,
         REQUEST_ROUTE},
   {"load_rr",              (cmd_function)load_rr,             0, 0, 0, 0},
   {0, 0, 0, 0, 0, 0}
};


/*!
 * \brief Exported parameters
 */
static param_export_t params[] ={ 
   {"append_fromtag",   INT_PARAM, &append_fromtag},
   {"enable_double_rr", INT_PARAM, &enable_double_rr},
   {"enable_full_lr",      INT_PARAM, &enable_full_lr},
#ifdef ENABLE_USER_CHECK
   {"ignore_user",      STR_PARAM, &ignore_user},
#endif
   {"add_username",     INT_PARAM, &add_username},
   {0, 0, 0 }
};


struct module_exports exports = {
   "rr",
   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,         /*!< initialize module */
   0,          /*!< response function*/
   mod_destroy,      /*!< destroy function */
   0           /*!< per-child init function */
};


static int mod_init(void)
{
#ifdef ENABLE_USER_CHECK
   if(ignore_user)
   {
      i_user.s = ignore_user;
      i_user.len = strlen(ignore_user);
   }
   else
   {
      i_user.s = 0;
      i_user.len = 0;
   }
#endif
   return 0;
}


static void mod_destroy(void)
{
   destroy_rrcb_lists();
}


static int it_list_fixup(void** param, int param_no)
{
   pv_elem_t *model;
   str s;
   if(*param)
   {
      s.s = (char*)(*param); s.len = strlen(s.s);
      if(pv_parse_format(&s, &model)<0)
      {
         LM_ERR("wrong format[%s]\n",(char*)(*param));
         return E_UNSPEC;
      }
      *param = (void*)model;
   }
   return 0;
}


static int direction_fixup(void** param, int param_no)
{
   char *s;
   int n;

   if (!append_fromtag) {
      LM_ERR("usage of \"is_direction\" function requires parameter"
            "\"append_fromtag\" enabled!!");
      return E_CFG;
   }
   if (param_no==1) {
      n = 0;
      s = (char*) *param;
      if ( strcasecmp(s,"downstream")==0 ) {
         n = RR_FLOW_DOWNSTREAM;
      } else if ( strcasecmp(s,"upstream")==0 ) {
         n = RR_FLOW_UPSTREAM;
      } else {
         LM_ERR("unknown direction '%s'\n",s);
         return E_CFG;
      }
      /* free string */
      pkg_free(*param);
      /* replace it with the flag */
      *param = (void*)(unsigned long)n;
   }
   return 0;
}


static int w_record_route(struct sip_msg *msg, char *key, char *bar)
{
   str s;

   if (msg->id == last_rr_msg) {
      LM_ERR("Double attempt to record-route\n");
      return -1;
   }

   if (key && pv_printf_s(msg, (pv_elem_t*)key, &s)<0) {
      LM_ERR("failed to print the format\n");
      return -1;
   }
   if ( record_route( msg, key?&s:0 )<0 )
      return -1;

   last_rr_msg = msg->id;
   return 1;
}


static int w_record_route_preset(struct sip_msg *msg, char *key, char *bar)
{
   str s;

   if (msg->id == last_rr_msg) {
      LM_ERR("Duble attempt to record-route\n");
      return -1;
   }

   if (pv_printf_s(msg, (pv_elem_t*)key, &s)<0) {
      LM_ERR("failed to print the format\n");
      return -1;
   }
   if ( record_route_preset( msg, &s)<0 )
      return -1;

   last_rr_msg = msg->id;
   return 1;
}


static int w_add_rr_param(struct sip_msg *msg, char *key, char *foo)
{
   str s;

   if (pv_printf_s(msg, (pv_elem_t*)key, &s)<0) {
      LM_ERR("failed to print the format\n");
      return -1;
   }
   return ((add_rr_param( msg, &s)==0)?1:-1);
}



static int w_check_route_param(struct sip_msg *msg,char *re, char *foo)
{
   return ((check_route_param(msg,(regex_t*)re)==0)?1:-1);
}



static int w_is_direction(struct sip_msg *msg,char *dir, char *foo)
{
   return ((is_direction(msg,(int)(long)dir)==0)?1:-1);
}