usr_avp.h
717bc5da
 /*
  * $Id$
  *
53c7e0f1
  * Copyright (C) 2001-2003 FhG Fokus
717bc5da
  *
  * 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.
  *
0973fee7
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
717bc5da
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * History:
  * ---------
2be21e31
  *  2004-07-21  created (bogdan)
7dfb54d7
  *  2004-11-14  global aliases support added
d0fdbd45
  *  2005-02-14  list with FLAGS USAGE added (bogdan)
717bc5da
  */
 
3da52f21
 #ifndef _SER_USR_AVP_H_
 #define _SER_USR_AVP_H_
717bc5da
 
9d7f3515
 #include <sys/types.h>
 #include <regex.h>
 
 
d0fdbd45
 /*
  *   LIST with the allocated flags, their meaning and owner
  *   flag no.    owner            description
  *   -------------------------------------------------------
  *     0        avp_core          avp has a string name
  *     1        avp_core          avp has a string value
35f927fb
  *     2        avp_core          regex search in progress
d0fdbd45
  *     3        avpops module     avp was loaded from DB
75a0b581
  *     4        lcr module        contact avp qvalue change
35f927fb
  *     5        core              avp is in user list
  *     6        core              avp is in domain list
  *     7        core              avp is in global list
3da52f21
  *     8        core              avp is in the from avp list
  *     9        core              avp is in the to avp list
145e3fb3
  *    10	core		  avp name with positive index
  *    11	core		  avp name with negative index
d0fdbd45
  */
717bc5da
 
2be21e31
 #include "str.h"
 
35f927fb
 
598694f6
 #define AVP_UID          "uid"           /* Unique user identifier */
 #define AVP_DID          "did"           /* Unique domain identifier */
 #define AVP_REALM        "digest_realm"  /* Digest realm */
 #define AVP_FR_TIMER     "fr_timer"      /* Value of final response timer */
 #define AVP_FR_INV_TIMER "fr_inv_timer"  /* Value of final response invite timer */
 #define AVP_RPID         "rpid"          /* Remote-Party-ID */
3da52f21
 #define AVP_GFLAGS       "gflags"        /* global flags */
598694f6
 
9d7f3515
 struct str_int_data {
 	str name;
 	int val;
 };
 
 struct str_str_data {
 	str name;
 	str val;
 };
 
2be21e31
 typedef union {
 	int  n;
3da52f21
 	str  s;
9d7f3515
 	regex_t* re;
2be21e31
 } int_str;
 
14102f39
 #define avp_id_t	unsigned short
cead8fc3
 #define avp_flags_t	unsigned int
14102f39
 #define avp_name_t	int_str
 #define avp_value_t	int_str
 #define avp_index_t	unsigned short
717bc5da
 
fdb74581
 union usr_avp_data{
 	void *p; /* forces alignment */
 	long l;
 	char data[sizeof(void*)]; /* used to access other types, var length */
 };
 
35f927fb
 typedef struct usr_avp {
14102f39
 	avp_id_t id;
fdb74581
 	/* Flags that are kept for the AVP lifetime */
14102f39
 	avp_flags_t flags;
717bc5da
 	struct usr_avp *next;
fdb74581
 	union usr_avp_data d; /* var length */
35f927fb
 } avp_t;
 
3da52f21
 typedef avp_t* avp_list_t;
 
14102f39
 /* AVP identification */
 typedef struct avp_ident {
 	avp_flags_t flags;
 	avp_name_t name;
 	avp_index_t index;
 } avp_ident_t;
35f927fb
 
 /*
  * AVP search state
  */
b5af0f66
 typedef struct search_state {
14102f39
 	avp_flags_t flags;  /* Type of search and additional flags */
 	avp_id_t id;
 	avp_name_t name;
35f927fb
 	avp_t* avp;            /* Current AVP */
14102f39
 //	regex_t* search_re;    /* Compiled regular expression */
b5af0f66
 } avp_search_state_t;
717bc5da
 
3da52f21
 /* avp aliases structs*/
7a2138c3
 typedef struct avp_spec {
14102f39
 	avp_flags_t type;
 	avp_name_t name;
 	avp_index_t index;
7a2138c3
 } avp_spec_t;
7dfb54d7
 
3da52f21
 /* AVP types */
2be21e31
 #define AVP_NAME_STR     (1<<0)
 #define AVP_VAL_STR      (1<<1)
9d7f3515
 #define AVP_NAME_RE      (1<<2)
35f927fb
 
3da52f21
 /* AVP classes */
e61ba5d2
 #define AVP_CLASS_URI    (1<<4)
3da52f21
 #define AVP_CLASS_USER   (1<<5)
 #define AVP_CLASS_DOMAIN (1<<6)
 #define AVP_CLASS_GLOBAL (1<<7)
35f927fb
 
3da52f21
 /* AVP track (either from or to) */
 #define AVP_TRACK_FROM   (1<<8)
 #define AVP_TRACK_TO     (1<<9)
 #define AVP_TRACK_ALL    (AVP_TRACK_FROM|AVP_TRACK_TO)
35f927fb
 
e61ba5d2
 #define AVP_CLASS_ALL (AVP_CLASS_URI|AVP_CLASS_USER|AVP_CLASS_DOMAIN|AVP_CLASS_GLOBAL)
717bc5da
 
145e3fb3
 /* AVP name index */
 #define AVP_INDEX_FORWARD	(1<<10)
 #define AVP_INDEX_BACKWARD	(1<<11)
 #define AVP_INDEX_ALL		(AVP_INDEX_FORWARD | AVP_INDEX_BACKWARD)
 
67ae0865
 /* AVP DB flag used by avpops module - defined in avpops
  * - kept here for reference */
 // #define AVP_IS_IN_DB    (1<<12)
 
 #define AVP_CUSTOM_FLAGS	13
0973fee7
 
d34839a3
 #define GALIAS_CHAR_MARKER  '$'
 
e8496ace
 #define AVP_NAME_VALUE_MASK     0x0007
 #define AVP_CORE_MASK           0x00ff
 #define AVP_SCRIPT_MASK         0xff00
 #define avp_core_flags(f)       ((f)&0x00ff)
 #define avp_script_flags(f)     (((f)<<8)&0xff00)
 #define avp_get_script_flags(f) (((f)&0xff00)>>8)
 
 #define is_avp_str_name(a)      ((a)->flags&AVP_NAME_STR)
 #define is_avp_str_val(a)       ((a)->flags&AVP_VAL_STR)
 
 
85d4627f
 #define AVP_IS_ASSIGNABLE(ident) ( ((ident).flags & AVP_NAME_RE) == 0 && (((ident).flags & AVP_NAME) == 0 || (((ident)->flags & AVP_NAME) && (ident).name.s.len)) )
3da52f21
 /* Initialize memory structures */
 int init_avps(void);
 
 /* add avp to the list of avps */
14102f39
 int add_avp(avp_flags_t flags, avp_name_t name, avp_value_t val);
 int add_avp_before(avp_t *avp, avp_flags_t flags, avp_name_t name, avp_value_t val);
 int add_avp_list(avp_list_t* list, avp_flags_t flags, avp_name_t name, avp_value_t val);
717bc5da
 
3da52f21
 /* Delete avps with given type and name */
14102f39
 void delete_avp(avp_flags_t flags, avp_name_t name);
598694f6
 
63701a5b
 int destroy_avps(avp_flags_t flags, avp_name_t name, int all);
 
53c7e0f1
 /* search functions */
14102f39
 avp_t *search_first_avp( avp_flags_t flags, avp_name_t name,
 			 avp_value_t *val, struct search_state* state);
 avp_t *search_avp_by_index( avp_flags_t flags, avp_name_t name,
                             avp_value_t *val, avp_index_t index);
 
 avp_t *search_avp (avp_ident_t ident, avp_value_t* val, struct search_state* state);
 avp_t *search_next_avp(struct search_state* state, avp_value_t *val);
 
6bdb84e1
 /* Reset one avp list */
 int reset_avp_list(int flags);
590612d3
 
2be21e31
 /* free functions */
3da52f21
 void reset_avps(void);
35f927fb
 
 void destroy_avp(avp_t *avp);
3da52f21
 void destroy_avp_list(avp_list_t *list );
 void destroy_avp_list_unsafe(avp_list_t *list );
717bc5da
 
a564ae7a
 /* get func */
14102f39
 void get_avp_val(avp_t *avp, avp_value_t *val );
35f927fb
 str* get_avp_name(avp_t *avp);
 
14102f39
 avp_list_t get_avp_list(avp_flags_t flags);
 avp_list_t* set_avp_list(avp_flags_t flags, avp_list_t* list);
35f927fb
 
717bc5da
 
7dfb54d7
 /* global alias functions (manipulation and parsing)*/
 int add_avp_galias_str(char *alias_definition);
d34839a3
 int lookup_avp_galias(str *alias, int *type, int_str *avp_name);
7dfb54d7
 int add_avp_galias(str *alias, int type, int_str avp_name);
14102f39
 int parse_avp_ident( str *name, avp_ident_t* attr);
145e3fb3
 int parse_avp_name( str *name, int *type, int_str *avp_name, int *index);
 int parse_avp_spec( str *name, int *type, int_str *avp_name, int *index);
34b688d7
 int km_parse_avp_spec( str *name, int *type, int_str *avp_name);
36fe0059
 void free_avp_name( avp_flags_t *type, int_str *avp_name);
5137b02d
 /* Free an ident obtained with parse_avp_ident() */
 void free_avp_ident(avp_ident_t* attr);
717bc5da
 
85d4627f
 /* AVP flags functions */
 #define MAX_AVPFLAG  ((unsigned int)( sizeof(avp_flags_t) * CHAR_BIT - 1 - AVP_CUSTOM_FLAGS))
 
 avp_flags_t register_avpflag(char* name);
 avp_flags_t get_avpflag_no(char* name);
 
717bc5da
 #endif