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