modules/ims_qos: added patch for flow-description bug when request originates from...
[sip-router] / msg_translator.h
1 /*
2  * Copyright (C) 2001-2003 FhG Fokus
3  *
4  * This file is part of Kamailio, a free SIP server.
5  *
6  * Kamailio is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version
10  *
11  * Kamailio is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License 
17  * along with this program; if not, write to the Free Software 
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 /*!
23 * \file
24 * \brief Kamailio core :: Message translations
25 * \author jiri
26 * \ingroup core
27 * Module: \ref core
28 */
29
30
31 #ifndef  _MSG_TRANSLATOR_H
32 #define _MSG_TRANSLATOR_H
33
34 /* flags used for process_lumps flag parameter */
35 #define FLAG_MSG_LUMPS_ONLY     0   /* copy just the lumps */
36 #define FLAG_MSG_ALL            1   /* copy all the msg */
37
38 #define MY_HF_SEP ": "
39 #define MY_HF_SEP_LEN 2
40
41 #define BRANCH_SEPARATOR '.'
42 #define WARNING "Warning: 392 "
43 #define WARNING_LEN (sizeof(WARNING)-1)
44 #define WARNING_PHRASE " \"Noisy feedback tells: "
45 #define WARNING_PHRASE_LEN (sizeof(WARNING_PHRASE)-1)
46
47 /*#define MAX_CONTENT_LEN_BUF INT2STR_MAX_LEN *//* see ut.h/int2str() */
48
49 #define BUILD_NO_LOCAL_VIA              (1<<0)
50 #define BUILD_NO_VIA1_UPDATE    (1<<1)
51 #define BUILD_NO_PATH                   (1<<2)
52 #define BUILD_IN_SHM                    (1<<7)
53
54 #include "parser/msg_parser.h"
55 #include "ip_addr.h"
56
57 /* point to some remarkable positions in a SIP message */
58 struct bookmark {
59         str to_tag_val;
60 };
61
62 /* used by via_builder */
63 struct hostport {
64         str* host;
65         str* port;
66 };
67
68
69 #define set_hostport(hp, msg) \
70         do{ \
71                 if ((msg) && ((struct sip_msg*)(msg))->set_global_address.len) \
72                         (hp)->host=&(((struct sip_msg*)(msg))->set_global_address); \
73                 else \
74                         (hp)->host=&default_global_address; \
75                 if ((msg) && ((struct sip_msg*)(msg))->set_global_port.len) \
76                         (hp)->port=&(((struct sip_msg*)(msg))->set_global_port); \
77                 else \
78                         (hp)->port=&default_global_port; \
79         }while(0)
80
81 char * build_req_buf_from_sip_req(struct sip_msg* msg, 
82                                 unsigned int *returned_len, struct dest_info* send_info,
83                                 unsigned int mode);
84
85 char * build_res_buf_from_sip_res(struct sip_msg* msg,
86                                 unsigned int *returned_len);
87
88 char * generate_res_buf_from_sip_res(struct sip_msg* msg,
89                                 unsigned int *returned_len, unsigned int mode);
90
91 char * build_res_buf_from_sip_req(unsigned int code,
92                                 str *text,
93                                 str *new_tag,
94                                 struct sip_msg* msg,
95                                 unsigned int *returned_len,
96                                 struct bookmark *bmark);
97 /*
98 char * build_res_buf_with_body_from_sip_req(    unsigned int code ,
99                                 char *text ,
100                                 char *new_tag ,
101                                 unsigned int new_tag_len ,
102                                 char *body ,
103                                 unsigned int body_len,
104                                 char *content_type,
105                                 unsigned int content_type_len,
106                                 struct sip_msg* msg,
107                                 unsigned int *returned_len,
108                                 struct bookmark *bmark);
109 */
110 char* via_builder( unsigned int *len,
111         struct dest_info* send_info,
112         str *branch, str* extra_params, struct hostport *hp );
113
114 /* creates a via header honoring the protocol of the incomming socket
115  * msg is an optional parameter */
116 char* create_via_hf( unsigned int *len,
117         struct sip_msg *msg,
118         struct dest_info* send_info /* where to send the reply */,
119         str* branch);
120
121 int branch_builder( unsigned int hash_index, 
122         /* only either parameter useful */
123         unsigned int label, char * char_v,
124         int branch,
125         /* output value: string and actual length */
126         char *branch_str, int *len );
127
128 char* id_builder(struct sip_msg* msg, unsigned int *id_len);
129
130 /* check if IP address in Via != source IP address of signaling,
131  * or the sender is asking to set the values for rport or received */
132 int received_test( struct sip_msg *msg );
133
134 /* check if IP address in Via != source IP address of signaling */
135 int received_via_test( struct sip_msg *msg );
136
137 /* builds a char* buffer from message headers without body
138  * first line is excluded in case of skip_first_line=1
139  */
140 char * build_only_headers( struct sip_msg* msg, int skip_first_line,
141                                 unsigned int *returned_len,
142                                 int *error,
143                                 struct dest_info* send_info);
144
145 /* builds a char* buffer from message body
146  * error is set -1 if the memory allocation failes
147  */
148 char * build_body( struct sip_msg* msg,
149                         unsigned int *returned_len,
150                         int *error,
151                         struct dest_info* send_info);
152
153 /* builds a char* buffer from SIP message including body
154  * The function adjusts the Content-Length HF according
155  * to body lumps in case of adjust_clen=1.
156  */
157 char * build_all( struct sip_msg* msg, int adjust_clen,
158                         unsigned int *returned_len,
159                         int *error,
160                         struct dest_info* send_info);
161
162 /** cfg framework fixup */
163 void fix_global_req_flags(str* gname, str* name);
164
165 int build_sip_msg_from_buf(struct sip_msg *msg, char *buf, int len,
166                 unsigned int id);
167
168 /* returns a copy in private memory of the boundary in a multipart body */
169 int get_boundary(struct sip_msg* msg, str* boundary);
170
171
172 /* process the lumps of a sip msg
173  * flags =  => add also the existing header to new_buf
174  * flags =  => add only the lumps (unapplied info) to new_buf
175  **/
176 void process_lumps( struct sip_msg* msg,
177                     struct lump* lumps,
178                     char* new_buf,
179                     unsigned int* new_buf_offs,
180                     unsigned int* orig_offs,
181                     struct dest_info* send_info,
182                     int flag);
183 #endif