dset.c
caf80ae6
 /*
  * $Id$
  *
  * destination set
7dd0b342
  *
035f593c
  * Copyright (C) 2001-2004 FhG FOKUS
7dd0b342
  *
  * This file is part of ser, a free SIP server.
  *
  * ser 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
  *
  * For a license to use the ser software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    info@iptel.org
  *
  * ser 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
caf80ae6
  */
 
b4ea4393
 /** destination set / branches support.
  * @file dset.c
  * @ingroup core
  * Module: @ref core
1d0661db
  */
 
caf80ae6
 #include <string.h>
 #include "dprint.h"
 #include "config.h"
 #include "parser/parser_f.h"
 #include "parser/msg_parser.h"
 #include "ut.h"
 #include "hash_func.h"
30449150
 #include "error.h"
035f593c
 #include "dset.h"
e3d05bb9
 #include "mem/mem.h"
dc4b13e8
 #include "ip_addr.h"
caf80ae6
 
035f593c
 #define CONTACT "Contact: "
 #define CONTACT_LEN (sizeof(CONTACT) - 1)
caf80ae6
 
035f593c
 #define CONTACT_DELIM ", "
 #define CONTACT_DELIM_LEN (sizeof(CONTACT_DELIM) - 1)
 
 #define Q_PARAM ">;q="
 #define Q_PARAM_LEN (sizeof(Q_PARAM) - 1)
 
 
 /* 
  * Where we store URIs of additional transaction branches
  * (-1 because of the default branch, #0)
  */
 static struct branch branches[MAX_BRANCHES - 1];
caf80ae6
 
 /* how many of them we have */
87962c1a
 unsigned int nr_branches = 0;
035f593c
 
caf80ae6
 /* branch iterator */
035f593c
 static int branch_iterator = 0;
 
b4ea4393
 /* used to mark ruris "consumed" when branching (1 new, 0 consumed) */
 int ruri_is_new = 0;
 
035f593c
 /* The q parameter of the Request-URI */
0202608d
 static qvalue_t ruri_q = Q_UNSPECIFIED;
 
 /* Branch flags of the Request-URI */
 static flag_t ruri_bflags;
 
 
15627cd0
 /*! \brief
  * Return pointer to branch[idx] structure
  * @param idx - branch index
  *
  * @return  pointer to branch or NULL if invalid branch
  */
 branch_t *get_sip_branch(int idx)
 {
 	if(nr_branches==0)
 		return NULL;
 	if(idx<0)
 	{
 		if(nr_branches + idx >= 0)
 			return &branches[nr_branches+idx];
 		return NULL;
 	}
 	if(idx < nr_branches)
 		return &branches[idx];
 	return 0;
 }
 
 /*! \brief
  * Drop branch[idx]
  * @param idx - branch index
  *
  * @return  0 on success, -1 on error
  */
 int drop_sip_branch(int idx)
 {
 	if(nr_branches==0 || idx>=nr_branches)
 		return 0;
 	if(idx<0 && nr_branches+idx<0)
 		return 0;
 	/* last branch */
 	if(idx==nr_branches-1)
 	{
 		nr_branches--;
 		return 0;
 	}
 	if(idx<0)
 		idx = nr_branches+idx;
 	/* shift back one position */
 	for(; idx<nr_branches-1; idx++)
 		memcpy(&branches[idx], &branches[idx+1], sizeof(branch_t));
 	nr_branches--;
 	return 0;
 }
 
0202608d
 static inline flag_t* get_bflags_ptr(unsigned int branch)
 {
 	if (branch == 0) return &ruri_bflags;
 	if (branch - 1 < nr_branches) return &branches[branch - 1].flags;
 	return NULL;
 }
 
 
 int setbflag(unsigned int branch, flag_t flag)
 {
 	flag_t* flags;
 
 	if ((flags = get_bflags_ptr(branch)) == NULL) return -1;
 	(*flags) |= 1 << flag;
 	return 1;
 }
 
 
 int isbflagset(unsigned int branch, flag_t flag)
 {
 	flag_t* flags;
 
 	if ((flags = get_bflags_ptr(branch)) == NULL) return -1;
 	return ((*flags) & (1 << flag)) ? 1 : -1;
 }
 
 
 int resetbflag(unsigned int branch, flag_t flag)
 {
 	flag_t* flags;
 
 	if ((flags = get_bflags_ptr(branch)) == NULL) return -1;
 	(*flags) &= ~ (1 << flag);
 	return 1;
 }
035f593c
 
caf80ae6
 
d02a166d
 int getbflagsval(unsigned int branch, flag_t* res)
5a68f95d
 {
 	flag_t* flags;
 	if (res == NULL) return -1;
 	if ((flags = get_bflags_ptr(branch)) == NULL) return -1;
 	*res = *flags;
 	return 1;
 }
 
 
 int setbflagsval(unsigned int branch, flag_t val)
 {
 	flag_t* flags;
 	if ((flags = get_bflags_ptr(branch)) == NULL) return -1;
 	*flags = val;
 	return 1;
 }
 
 
035f593c
 /*
53c7e0f1
  * Initialize the branch iterator, the next
035f593c
  * call to next_branch will return the first
  * contact from the dset array
  */
caf80ae6
 void init_branch_iterator(void)
 {
035f593c
 	branch_iterator = 0;
caf80ae6
 }
 
764bac17
 int get_branch_iterator(void)
 {
 	return branch_iterator;
 }
035f593c
 
caf80ae6
 
035f593c
 
52d5764e
 /** \brief Get a branch from the destination set
  * \return Return the 'i' branch from the dset
  * array, 0 is returned if there are no
  * more branches
  */
 char* get_branch(unsigned int i, int* len, qvalue_t* q, str* dst_uri,
c43dc0cd
 				 str* path, unsigned int *flags,
 				 struct socket_info** force_socket)
52d5764e
 {
 	if (i < nr_branches) {
 		*len = branches[i].len;
 		*q = branches[i].q;
 		if (dst_uri) {
 			dst_uri->len = branches[i].dst_uri_len;
 			dst_uri->s = (dst_uri->len)?branches[i].dst_uri:0;
 		}
 		if (path) {
 			path->len = branches[i].path_len;
 			path->s = (path->len)?branches[i].path:0;
 		}
 		if (force_socket)
 			*force_socket = branches[i].force_send_socket;
 		if (flags)
 			*flags = branches[i].flags;
 		return branches[i].uri;
 	} else {
 		*len = 0;
 		*q = Q_UNSPECIFIED;
 		if (dst_uri) {
 			dst_uri->s = 0;
 			dst_uri->len = 0;
 		}
c43dc0cd
 		if (path) {
 			path->s = 0;
 			path->len = 0;
 		}
52d5764e
 		if (force_socket)
 			*force_socket = 0;
 		if (flags)
 			*flags = 0;
 		return 0;
 	}
 }
 
 
c43dc0cd
 
 /** Return the next branch from the dset array.
  * 0 is returned if there are no more branches
  */
 char* next_branch(int* len, qvalue_t* q, str* dst_uri, str* path,
 					unsigned int* flags, struct socket_info** force_socket)
 {
 	char* ret;
 	
 	ret=get_branch(branch_iterator, len, q, dst_uri, path, flags,
 					force_socket);
 	if (likely(ret))
 		branch_iterator++;
 	return ret;
 }
 
 
035f593c
 /*
  * Empty the dset array
  */
 void clear_branches(void)
caf80ae6
 {
035f593c
 	nr_branches = 0;
 	ruri_q = Q_UNSPECIFIED;
c6dd54e8
 	ruri_bflags = 0;
b4ea4393
 	ruri_mark_consumed();
caf80ae6
 }
 
035f593c
 
2a78db5c
 
c43dc0cd
 /**  Add a new branch to the current transaction.
  * @param msg - sip message, used for getting the uri if not specified (0).
  * @param uri - uri, can be 0 (in which case the uri is taken from msg)
  * @param dst_uri - destination uri, can be 0.
  * @param path - path vector (passed in a string), can be 0.
  * @param q  - q value.
  * @param flags - per branch flags.
  * @param force_socket - socket that should be used when sending.
  *
  * @return  <0 (-1) on failure, 1 on success (script convention).
52d5764e
  */
c43dc0cd
 int append_branch(struct sip_msg* msg, str* uri, str* dst_uri, str* path,
52d5764e
 		qvalue_t q, unsigned int flags, struct socket_info* force_socket)
 {
 	str luri;
 
 #ifdef USE_LOCAL_ROUTE
c43dc0cd
 	if (unlikely(dset_state==0))
52d5764e
 		return -1;
 #endif
 
 	/* if we have already set up the maximum number
 	 * of branches, don't try new ones 
 	 */
c43dc0cd
 	if (unlikely(nr_branches == MAX_BRANCHES - 1)) {
52d5764e
 		LOG(L_ERR, "max nr of branches exceeded\n");
 		ser_error = E_TOO_MANY_BRANCHES;
 		return -1;
 	}
 
 	/* if not parameterized, take current uri */
 	if (uri==0 || uri->len==0 || uri->s==0) {
 		if (msg->new_uri.s)
 			luri = msg->new_uri;
 		else
 			luri = msg->first_line.u.request.uri;
 	} else {
 		luri = *uri;
 	}
 
c43dc0cd
 	if (unlikely(luri.len > MAX_URI_SIZE - 1)) {
52d5764e
 		LOG(L_ERR, "too long uri: %.*s\n", luri.len, luri.s);
 		return -1;
 	}
 
 	/* copy the dst_uri */
 	if (dst_uri && dst_uri->len && dst_uri->s) {
c43dc0cd
 		if (unlikely(dst_uri->len > MAX_URI_SIZE - 1)) {
 			LOG(L_ERR, "too long dst_uri: %.*s\n", dst_uri->len, dst_uri->s);
52d5764e
 			return -1;
 		}
 		memcpy(branches[nr_branches].dst_uri, dst_uri->s, dst_uri->len);
 		branches[nr_branches].dst_uri[dst_uri->len] = 0;
 		branches[nr_branches].dst_uri_len = dst_uri->len;
 	} else {
 		branches[nr_branches].dst_uri[0] = '\0';
 		branches[nr_branches].dst_uri_len = 0;
 	}
 
 	/* copy the path string */
c43dc0cd
 	if (unlikely(path && path->len && path->s)) {
 		if (unlikely(path->len > MAX_PATH_SIZE - 1)) {
52d5764e
 			LOG(L_ERR, "too long path: %.*s\n", path->len, path->s);
 			return -1;
 		}
 		memcpy(branches[nr_branches].path, path->s, path->len);
 		branches[nr_branches].path[path->len] = 0;
 		branches[nr_branches].path_len = path->len;
 	} else {
 		branches[nr_branches].path[0] = '\0';
 		branches[nr_branches].path_len = 0;
 	}
 
 	/* copy the ruri */
 	memcpy(branches[nr_branches].uri, luri.s, luri.len);
 	branches[nr_branches].uri[luri.len] = 0;
 	branches[nr_branches].len = luri.len;
 	branches[nr_branches].q = q;
 
 	branches[nr_branches].force_send_socket = force_socket;
 	branches[nr_branches].flags = flags;
 
 	nr_branches++;
 	return 1;
 }
 
 
035f593c
 /*
  * Create a Contact header field from the dset
  * array
  */
 char* print_dset(struct sip_msg* msg, int* len) 
2a78db5c
 {
d7a3fdea
 	int cnt, i;
 	unsigned int qlen;
035f593c
 	qvalue_t q;
2a78db5c
 	str uri;
b0edf8f9
 	char* p, *qbuf;
2a78db5c
 	static char dset[MAX_REDIRECTION_LEN];
 
 	if (msg->new_uri.s) {
035f593c
 		cnt = 1;
 		*len = msg->new_uri.len;
 		if (ruri_q != Q_UNSPECIFIED) {
 			*len += 1 + Q_PARAM_LEN + len_q(ruri_q);
 		}
2a78db5c
 	} else {
035f593c
 		cnt = 0;
 		*len = 0;
2a78db5c
 	}
 
 	init_branch_iterator();
c43dc0cd
 	while ((uri.s = next_branch(&uri.len, &q, 0, 0, 0, 0))) {
2a78db5c
 		cnt++;
035f593c
 		*len += uri.len;
 		if (q != Q_UNSPECIFIED) {
 			*len += 1 + Q_PARAM_LEN + len_q(q);
 		}
2a78db5c
 	}
 
035f593c
 	if (cnt == 0) return 0;	
2a78db5c
 
035f593c
 	*len += CONTACT_LEN + CRLF_LEN + (cnt - 1) * CONTACT_DELIM_LEN;
2a78db5c
 
035f593c
 	if (*len + 1 > MAX_REDIRECTION_LEN) {
2a78db5c
 		LOG(L_ERR, "ERROR: redirection buffer length exceed\n");
 		return 0;
 	}
 
035f593c
 	memcpy(dset, CONTACT, CONTACT_LEN);
 	p = dset + CONTACT_LEN;
2a78db5c
 	if (msg->new_uri.s) {
035f593c
 		if (ruri_q != Q_UNSPECIFIED) {
 			*p++ = '<';
 		}
 
2a78db5c
 		memcpy(p, msg->new_uri.s, msg->new_uri.len);
035f593c
 		p += msg->new_uri.len;
 
 		if (ruri_q != Q_UNSPECIFIED) {
 			memcpy(p, Q_PARAM, Q_PARAM_LEN);
 			p += Q_PARAM_LEN;
b0edf8f9
 
 			qbuf = q2str(ruri_q, &qlen);
 			memcpy(p, qbuf, qlen);
 			p += qlen;
035f593c
 		}
 		i = 1;
 	} else {
 		i = 0;
 	}
2a78db5c
 
 	init_branch_iterator();
c43dc0cd
 	while ((uri.s = next_branch(&uri.len, &q, 0, 0, 0, 0))) {
2a78db5c
 		if (i) {
035f593c
 			memcpy(p, CONTACT_DELIM, CONTACT_DELIM_LEN);
 			p += CONTACT_DELIM_LEN;
 		}
 
 		if (q != Q_UNSPECIFIED) {
 			*p++ = '<';
2a78db5c
 		}
035f593c
 
2a78db5c
 		memcpy(p, uri.s, uri.len);
035f593c
 		p += uri.len;
 		if (q != Q_UNSPECIFIED) {
 			memcpy(p, Q_PARAM, Q_PARAM_LEN);
 			p += Q_PARAM_LEN;
b0edf8f9
 
 			qbuf = q2str(q, &qlen);
 			memcpy(p, qbuf, qlen);
 			p += qlen;
035f593c
 		}
2a78db5c
 		i++;
 	}
035f593c
 
 	memcpy(p, CRLF " ", CRLF_LEN + 1);
2a78db5c
 	return dset;
 }
 
035f593c
 
 /*
  * Sets the q parameter of the Request-URI
  */
 void set_ruri_q(qvalue_t q)
 {
 	ruri_q = q;
 }
 
 
 /*
  * Return the q value of the Request-URI
  */
 qvalue_t get_ruri_q(void)
 {
 	return ruri_q;
 }
7c8890f0
 
 
 
 /*
  * Rewrite Request-URI
  */
 int rewrite_uri(struct sip_msg* _m, str* _s)
 {
         char* buf;
 
         buf = (char*)pkg_malloc(_s->len + 1);
         if (!buf) {
fcf655d0
                 LOG(L_ERR, "ERROR: rewrite_uri: No memory left\n");
7c8890f0
                 return -1;
         }
 
         memcpy(buf, _s->s, _s->len);
         buf[_s->len] = '\0';
 
         _m->parsed_uri_ok = 0;
         if (_m->new_uri.s) {
                 pkg_free(_m->new_uri.s);
         }
 
         _m->new_uri.s = buf;
         _m->new_uri.len = _s->len;
b4ea4393
         /* mark ruri as new and available for forking */
         ruri_mark_new();
7c8890f0
 
607468e1
         return 1;
7c8890f0
 }