src/modules/path/path_mod.c
46a0dab3
 /*
  * $Id$ 
  *
  * Path handling for intermediate proxies
  *
  * Copyright (C) 2006 Inode GmbH (Andreas Granig <andreas.granig@inode.info>)
  *
27642a08
  * This file is part of Kamailio, a free SIP server.
46a0dab3
  *
27642a08
  * Kamailio is free software; you can redistribute it and/or modify
46a0dab3
  * 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
  *
27642a08
  * Kamailio is distributed in the hope that it will be useful,
46a0dab3
  * 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 
9e1ff448
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
46a0dab3
  *
  */
 
e46039c5
 /*! \file
  * \brief Path :: Core
  *
  * \ingroup path
  * - Module: path
  */
 
 /*! \defgroup path Path:: Handling of "path" header for intermediate proxies
  * This module is designed to be used at intermediate sip proxies
  * like loadbalancers in front of registrars and proxies. It
  * provides functions for inserting a Path header including a
  * parameter for passing forward the received-URI of a
  * registration to the next hop. It also provides a mechanism for
  * evaluating this parameter in subsequent requests and to set the
  * destination URI according to it.
  *
  * - No developer API
  * - No MI functions
  */
 
 
46a0dab3
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
cf83221d
 #include "../../core/sr_module.h"
 #include "../../core/mem/mem.h"
 #include "../../core/mod_fix.h"
17be61ed
 #include "../../core/kemi.h"
b27311b5
 #include "../outbound/api.h"
46a0dab3
 #include "../rr/api.h"
 
 #include "path.h"
 #include "path_mod.h"
 
 MODULE_VERSION
 
 
e46039c5
 /*! \brief If received-param of current Route uri should be used
46a0dab3
  * as dst-uri. */
2c62b317
 int path_use_received = 0;
 
 int path_received_format = 0;
 int path_enable_r2 = 0;
31d92814
 int path_sockname_mode = 0;
46a0dab3
 
e46039c5
 /*! \brief
46a0dab3
  * Module initialization function prototype
  */
 static int mod_init(void);
 
e46039c5
 /*! \brief
46a0dab3
  * rr callback API
  */
 struct rr_binds path_rrb;
 
b27311b5
 /*! \brief
  * outbound API
  */
 ob_api_t path_obb;
46a0dab3
 
e46039c5
 /*! \brief
46a0dab3
  * Exported functions
  */
 static cmd_export_t cmds[] = {
b119333e
 	{ "add_path",          (cmd_function)add_path,              0,
 			0,              0,  REQUEST_ROUTE },
 	{ "add_path",          (cmd_function)add_path_usr,          1,
99415516
 			fixup_spve_null, 0, REQUEST_ROUTE },
 	{ "add_path",          (cmd_function)add_path_usr,          2,
 			fixup_spve_spve, 0, REQUEST_ROUTE },
b119333e
 	{ "add_path_received", (cmd_function)add_path_received,     0,
 			0,              0, REQUEST_ROUTE },
 	{ "add_path_received", (cmd_function)add_path_received_usr, 1,
99415516
 			fixup_spve_null, 0, REQUEST_ROUTE },
 	{ "add_path_received", (cmd_function)add_path_received_usr, 2,
 			fixup_spve_spve, 0, REQUEST_ROUTE },
80998a7f
 	{ 0, 0, 0, 0, 0, 0 }
46a0dab3
 };
 
 
e46039c5
 /*! \brief
46a0dab3
  * Exported parameters
  */
 static param_export_t params[] = {
2c62b317
 	{"use_received",    INT_PARAM, &path_use_received },
 	{"received_format", INT_PARAM, &path_received_format },
 	{"enable_r2",       INT_PARAM, &path_enable_r2 },
31d92814
 	{"sockname_mode",   INT_PARAM, &path_sockname_mode },
46a0dab3
 	{ 0, 0, 0 }
 };
 
 
e46039c5
 /*! \brief
46a0dab3
  * Module interface
  */
 struct module_exports exports = {
f3114393
 	"path",          /* module name */
51716422
 	DEFAULT_DLFLAGS, /* dlopen flags */
f3114393
 	cmds,            /* Exported functions */
 	params,          /* Exported parameters */
 	0,               /* RPC method exports */
 	0,               /* exported pseudo-variables */
 	0,               /* response function */
 	mod_init,        /* module initialization function */
 	0,               /* child initialization function */
 	0                /* destroy function */
46a0dab3
 };
 
 
 static int mod_init(void)
 {
2c62b317
 	if (path_use_received) {
46a0dab3
 		if (load_rr_api(&path_rrb) != 0) {
387847d7
 			LM_ERR("failed to load rr-API\n");
46a0dab3
 			return -1;
 		}
 		if (path_rrb.register_rrcb(path_rr_callback, 0) != 0) {
387847d7
 			LM_ERR("failed to register rr callback\n");
46a0dab3
 			return -1;
 		}
 	}
b27311b5
 
 	if (ob_load_api(&path_obb) == 0)
ee2847c5
 		LM_DBG("Bound path module to outbound module\n");
b27311b5
 	else {
 		LM_INFO("outbound module not available\n");
 		memset(&path_obb, 0, sizeof(ob_api_t));
 	}
2c62b317
 
46a0dab3
 	return 0;
 }
17be61ed
 
 /**
  *
  */
 /* clang-format off */
 static sr_kemi_t sr_kemi_path_exports[] = {
 	{ str_init("path"), str_init("add_path"),
 		SR_KEMIP_INT, ki_add_path,
2fda4db2
 		{ SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE,
17be61ed
 			SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
 	},
 	{ str_init("path"), str_init("add_path_user"),
 		SR_KEMIP_INT, ki_add_path_user,
 		{ SR_KEMIP_STR, SR_KEMIP_NONE, SR_KEMIP_NONE,
 			SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
 	},
 	{ str_init("path"), str_init("add_path_user_params"),
 		SR_KEMIP_INT, ki_add_path_user_params,
 		{ SR_KEMIP_STR, SR_KEMIP_STR, SR_KEMIP_NONE,
 			SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
 	},
 	{ str_init("path"), str_init("add_path_received"),
 		SR_KEMIP_INT, ki_add_path_received,
2fda4db2
 		{ SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE,
17be61ed
 			SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
 	},
 	{ str_init("path"), str_init("add_path_received_user"),
 		SR_KEMIP_INT, ki_add_path_received_user,
 		{ SR_KEMIP_STR, SR_KEMIP_NONE, SR_KEMIP_NONE,
 			SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
 	},
 	{ str_init("path"), str_init("add_path_received_user_params"),
 		SR_KEMIP_INT, ki_add_path_received_user_params,
 		{ SR_KEMIP_STR, SR_KEMIP_STR, SR_KEMIP_NONE,
 			SR_KEMIP_NONE, SR_KEMIP_NONE, SR_KEMIP_NONE }
 	},
 	{ {0, 0}, {0, 0}, 0, NULL, { 0, 0, 0, 0, 0, 0 } }
 };
 /* clang-format on */
 
 /**
  *
  */
 int mod_register(char *path, int *dlflags, void *p1, void *p2)
 {
 	sr_kemi_modules_add(sr_kemi_path_exports);
 	return 0;
2c62b317
 }