File: items.h

package info (click to toggle)
openser 1.1.0-9etch1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 9,828 kB
  • ctags: 11,809
  • sloc: ansic: 120,528; sh: 5,249; yacc: 1,716; makefile: 1,261; php: 656; perl: 205; sql: 190
file content (168 lines) | stat: -rw-r--r-- 5,188 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * $Id: items.h,v 1.19 2006/07/05 14:33:07 miconda Exp $
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of openser, a free SIP server.
 *
 * openser 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
 *
 * openser 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
 */

#ifndef _ITEMS_H_
#define _ITEMS_H_

#include "parser/msg_parser.h"
#include "usr_avp.h"

#define ITEM_MARKER_STR	"$"
#define ITEM_MARKER	'$'

#define ITEM_LNBRACKET_STR	"("
#define ITEM_LNBRACKET		'('
#define ITEM_RNBRACKET_STR	")"
#define ITEM_RNBRACKET		')'

#define ITEM_LIBRACKET_STR	"["
#define ITEM_LIBRACKET		'['
#define ITEM_RIBRACKET_STR	"]"
#define ITEM_RIBRACKET		']'

/* flags [16-31] are reserved for avps */
#define XL_DISABLE_NONE		0		/* 0 */
#define XL_THROW_ERROR		1		/* 0 */
#define XL_DISABLE_MULTI	2		/* 1 */
#define XL_DISABLE_COLORS	4		/* 2 */
#define XL_DISABLE_PVARS	8		/* 3 */
#define XL_DPARAM			16		/* 4 */
#define XL_LEVEL2			32		/* 5 */
#define XL_EXTRA_FOUND		64		/* 6 */

#define XL_VAL_NONE			0
#define XL_VAL_NULL			1
#define XL_VAL_EMPTY		2
#define XL_VAL_STR			4
#define XL_VAL_INT			8
#define XL_TYPE_INT			16

enum _xl_type { 
	XL_NONE=0,           XL_EMPTY,             XL_NULL, 
	XL_MARKER,           XL_AVP,               XL_HDR,
	XL_PID,              XL_RETURN_CODE,       XL_TIMES,
	XL_TIMEF,            XL_MSGID,             XL_METHOD,
	XL_STATUS,           XL_REASON,            XL_RURI,
	XL_RURI_USERNAME,    XL_RURI_DOMAIN,       XL_RURI_PORT,
	XL_FROM,             XL_FROM_USERNAME,     XL_FROM_DOMAIN,
	XL_FROM_TAG,         XL_TO,                XL_TO_USERNAME,
	XL_TO_DOMAIN,        XL_TO_TAG,            XL_CSEQ,
	XL_CONTACT,          XL_CALLID,            XL_USERAGENT,
	XL_MSG_BUF,          XL_MSG_LEN,           XL_FLAGS,
	XL_HEXFLAGS,         XL_SRCIP,             XL_SRCPORT,
	XL_RCVIP,            XL_RCVPORT,           XL_REFER_TO,
	XL_DSET,             XL_DSTURI,            XL_COLOR,
	XL_BRANCH,           XL_BRANCHES,          XL_CONTENT_TYPE,
	XL_CONTENT_LENGTH,   XL_MSG_BODY,          XL_AUTH_USERNAME,
	XL_AUTH_REALM,       XL_RURI_PROTOCOL,     XL_DSTURI_DOMAIN,
	XL_DSTURI_PORT,      XL_DSTURI_PROTOCOL,   XL_FROM_DISPLAYNAME,
	XL_TO_DISPLAYNAME,   XL_OURI,              XL_OURI_USERNAME,
	XL_OURI_DOMAIN,      XL_OURI_PORT,         XL_OURI_PROTOCOL,
	XL_FORCE_SOCK,       XL_RPID_URI,          XL_DIVERSION_URI,
	XL_ITEM_EXTRA /* keep it last */
};
typedef enum _xl_type xl_type_t;


typedef struct _xl_value
{
	str rs;
	int ri;
	int flags;
} xl_value_t, *xl_value_p;

typedef struct _xl_param
{
	str val;
	int ind;
} xl_param_t, *xl_param_p;

typedef int (*item_func_t) (struct sip_msg*, xl_value_t*,  xl_param_t*, int);

typedef int xl_flags_t;

typedef struct _xl_dparam
{
	item_func_t itf;
	int ind;
} xl_dparam_t, *xl_dparam_p;

typedef struct _xl_spec {
	xl_type_t   type;
	xl_flags_t  flags;
	item_func_t itf;
	xl_param_t  p;
	xl_dparam_t dp;
} xl_spec_t, *xl_spec_p;

typedef struct _xl_elem
{
	str text;
	xl_spec_t spec;
	struct _xl_elem *next;
} xl_elem_t, *xl_elem_p;


int xl_elem_free_all(xl_elem_p list);
char* xl_parse_spec(char *s, xl_spec_p sp, int flags);
int xl_parse_format(char *s, xl_elem_p *el, int flags);
int xl_get_spec_index(xl_spec_p sp, int *idx);
int xl_get_spec_value(struct sip_msg* msg, xl_spec_p sp, xl_value_t *value,
		int flags);
int xl_get_spec_name(struct sip_msg* msg, xl_spec_p sp, xl_value_t *value,
		int flags);
int xl_get_avp_name(struct sip_msg* msg, xl_spec_p sp, int_str *avp_name,
		unsigned short *name_type);
int xl_print_spec(struct sip_msg* msg, xl_spec_p sp, char *buf, int *len);
int xl_printf(struct sip_msg* msg, xl_elem_p list, char *buf, int *len);

int xl_add_extra(char *name, item_func_t fct, int type, xl_param_t *param);
int xl_add_extra_spec(str *name, xl_spec_p sp);
int xl_fill_extra_spec(xl_spec_p sp);
int xl_init_extra_spec();
int xl_free_extra_spec();


#define XL_PRINT_BUF_SIZE  1024
#define XL_PRINT_BUF_NO    3
/*IMPORTANT NOTE - even if the function prints and returns a static buffer, it
 * has built-in support for 3 level of nesting (or cuncurrent usage).
 * If you think it's not enough for you, either use xl_printf() directly,
 * either increase XL_PRINT_BUF_NO   --bogdan */
static inline int xl_printf_s(struct sip_msg* msg, xl_elem_p list, str *s)
{
	static int buf_itr = 0;
	static char buf[XL_PRINT_BUF_NO][XL_PRINT_BUF_SIZE];

	if (list->next==0 && list->spec.itf==0) {
		*s = list->text;
		return 0;
	} else {
		s->s = buf[buf_itr];
		s->len = XL_PRINT_BUF_SIZE;
		buf_itr = (buf_itr+1)%XL_PRINT_BUF_NO;
		return xl_printf( msg, list, s->s, &s->len);
	}
}

#endif