transaction.c 12.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
	belle-sip - SIP (RFC3261) library.
    Copyright (C) 2010  Belledonne Communications SARL

    This program 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 3 of the License, or
    (at your option) any later version.

    This program 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, see <http://www.gnu.org/licenses/>.
*/

#include "belle_sip_internal.h"

21 22 23 24 25 26 27 28 29 30 31 32
const char *belle_sip_transaction_state_to_string(belle_sip_transaction_state_t state){
	switch(state){
		case BELLE_SIP_TRANSACTION_INIT:
			return "INIT";
		case BELLE_SIP_TRANSACTION_TRYING:
			return "TRYING";
		case BELLE_SIP_TRANSACTION_CALLING:
			return "CALLING";
		case BELLE_SIP_TRANSACTION_COMPLETED:
			return "COMPLETED";
		case BELLE_SIP_TRANSACTION_CONFIRMED:
			return "CONFIRMED";
33 34
		case BELLE_SIP_TRANSACTION_ACCEPTED:
			return "ACCEPTED";
35 36 37 38 39 40 41 42 43
		case BELLE_SIP_TRANSACTION_PROCEEDING:
			return "PROCEEDING";
		case BELLE_SIP_TRANSACTION_TERMINATED:
			return "TERMINATED";
	}
	belle_sip_fatal("Invalid transaction state.");
	return "INVALID";
}

44
static void belle_sip_transaction_init(belle_sip_transaction_t *t, belle_sip_provider_t *prov, belle_sip_request_t *req){
Simon Morlat's avatar
Simon Morlat committed
45
	t->request=(belle_sip_request_t*)belle_sip_object_ref(req);
46 47 48 49 50
	t->provider=prov;
}

static void transaction_destroy(belle_sip_transaction_t *t){
	if (t->request) belle_sip_object_unref(t->request);
51
	if (t->last_response) belle_sip_object_unref(t->last_response);
Simon Morlat's avatar
Simon Morlat committed
52
	if (t->channel) belle_sip_object_unref(t->channel);
53
	if (t->branch_id) belle_sip_free(t->branch_id);
54
}
55

56
BELLE_SIP_DECLARE_NO_IMPLEMENTED_INTERFACES(belle_sip_transaction_t);
Simon Morlat's avatar
Simon Morlat committed
57 58

BELLE_SIP_INSTANCIATE_CUSTOM_VPTR(belle_sip_transaction_t)={
Simon Morlat's avatar
Simon Morlat committed
59
	{
Simon Morlat's avatar
Simon Morlat committed
60 61 62 63
		BELLE_SIP_VPTR_INIT(belle_sip_transaction_t,belle_sip_object_t,FALSE),
		(belle_sip_object_destroy_t) transaction_destroy,
		NULL,/*no clone*/
		NULL,/*no marshall*/
Simon Morlat's avatar
Simon Morlat committed
64 65
	},
	NULL /*on_terminate*/
Simon Morlat's avatar
Simon Morlat committed
66
};
Simon Morlat's avatar
Simon Morlat committed
67

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
void *belle_sip_transaction_get_application_data(const belle_sip_transaction_t *t){
	return t->appdata;
}

void belle_sip_transaction_set_application_data(belle_sip_transaction_t *t, void *data){
	t->appdata=data;
}

const char *belle_sip_transaction_get_branch_id(const belle_sip_transaction_t *t){
	return t->branch_id;
}

belle_sip_transaction_state_t belle_sip_transaction_get_state(const belle_sip_transaction_t *t){
	return t->state;
}

void belle_sip_transaction_terminate(belle_sip_transaction_t *t){
85
	t->state=BELLE_SIP_TRANSACTION_TERMINATED;
Simon Morlat's avatar
Simon Morlat committed
86
	BELLE_SIP_OBJECT_VPTR(t,belle_sip_transaction_t)->on_terminate(t);
87
	belle_sip_provider_set_transaction_terminated(t->provider,t);
88 89 90 91 92 93
}

belle_sip_request_t *belle_sip_transaction_get_request(belle_sip_transaction_t *t){
	return t->request;
}

Simon Morlat's avatar
Simon Morlat committed
94 95 96 97 98 99 100 101
void belle_sip_transaction_notify_timeout(belle_sip_transaction_t *t){
	belle_sip_timeout_event_t ev;
	ev.source=t->provider;
	ev.transaction=t;
	ev.is_server_transaction=BELLE_SIP_OBJECT_IS_INSTANCE_OF(t,belle_sip_server_transaction_t);
	BELLE_SIP_PROVIDER_INVOKE_LISTENERS(t->provider,process_timeout,&ev);
}

102
/*
Simon Morlat's avatar
Simon Morlat committed
103 104
 * Server transaction
 */
105

106 107 108
static void server_transaction_destroy(belle_sip_server_transaction_t *t){
}

Simon Morlat's avatar
Simon Morlat committed
109

110
BELLE_SIP_DECLARE_NO_IMPLEMENTED_INTERFACES(belle_sip_server_transaction_t);
Simon Morlat's avatar
Simon Morlat committed
111
BELLE_SIP_INSTANCIATE_CUSTOM_VPTR(belle_sip_server_transaction_t)={
Simon Morlat's avatar
Simon Morlat committed
112
	{
Simon Morlat's avatar
Simon Morlat committed
113 114 115 116 117
		{
			BELLE_SIP_VPTR_INIT(belle_sip_server_transaction_t,belle_sip_transaction_t,FALSE),
			(belle_sip_object_destroy_t) server_transaction_destroy,
			NULL,
			NULL
Simon Morlat's avatar
Simon Morlat committed
118 119 120
		},
		NULL
	}
Simon Morlat's avatar
Simon Morlat committed
121
};
Simon Morlat's avatar
Simon Morlat committed
122

123
void belle_sip_server_transaction_init(belle_sip_server_transaction_t *t, belle_sip_provider_t *prov,belle_sip_request_t *req){
124
	belle_sip_transaction_init((belle_sip_transaction_t*)t,prov,req);
125
	belle_sip_random_token(t->to_tag,sizeof(t->to_tag));
126 127
}

Simon Morlat's avatar
Simon Morlat committed
128
void belle_sip_server_transaction_send_response(belle_sip_server_transaction_t *t, belle_sip_response_t *resp){
129
	belle_sip_transaction_t *base=(belle_sip_transaction_t*)t;
130
	belle_sip_header_to_t *to=(belle_sip_header_to_t*)belle_sip_message_get_header((belle_sip_message_t*)resp,"to");
Simon Morlat's avatar
Simon Morlat committed
131
	belle_sip_dialog_t *dialog=base->dialog;
Simon Morlat's avatar
Simon Morlat committed
132
	int status_code;
Simon Morlat's avatar
Simon Morlat committed
133
	
134 135 136 137 138 139
	belle_sip_object_ref(resp);
	if (!base->last_response){
		belle_sip_hop_t hop;
		belle_sip_response_get_return_hop(resp,&hop);
		base->channel=belle_sip_provider_get_channel(base->provider,hop.host, hop.port, hop.transport);
		belle_sip_object_ref(base->channel);
140
		belle_sip_hop_free(&hop);
141
	}
Simon Morlat's avatar
Simon Morlat committed
142 143 144 145 146 147 148 149 150 151 152
	status_code=belle_sip_response_get_status_code(resp);
	if (status_code!=100){
		if (belle_sip_header_to_get_tag(to)==NULL){
			//add a random to tag
			belle_sip_header_to_set_tag(to,t->to_tag);
		}
		if (dialog && status_code>=200 && status_code<300){
			/*response establishes a dialog*/
			/*fill dialog related fields accordingly*/
			belle_sip_response_fill_for_dialog(resp,base->request);
		}
153
	}
154 155 156 157 158
	if (BELLE_SIP_OBJECT_VPTR(t,belle_sip_server_transaction_t)->send_new_response(t,resp)==0){
		if (base->last_response)
			belle_sip_object_unref(base->last_response);
		base->last_response=resp;
	}
Simon Morlat's avatar
Simon Morlat committed
159 160
	if (dialog)
		belle_sip_dialog_update(dialog,base->request,resp,TRUE);
161 162
}

163 164 165 166 167 168 169 170 171 172
static void server_transaction_notify(belle_sip_server_transaction_t *t, belle_sip_request_t *req, belle_sip_dialog_t *dialog){
	belle_sip_request_event_t event;

	event.source=t->base.provider;
	event.server_transaction=t;
	event.dialog=dialog;
	event.request=req;
	BELLE_SIP_PROVIDER_INVOKE_LISTENERS(t->base.provider,process_request_event,&event);
}

Simon Morlat's avatar
Simon Morlat committed
173 174 175
void belle_sip_server_transaction_on_request(belle_sip_server_transaction_t *t, belle_sip_request_t *req){
	const char *method=belle_sip_request_get_method(req);
	if (strcmp(method,"ACK")==0){
176 177 178
		/*this must be for an INVITE server transaction */
		if (BELLE_SIP_OBJECT_IS_INSTANCE_OF(t,belle_sip_ist_t)){
			belle_sip_ist_t *ist=(belle_sip_ist_t*)t;
179 180 181 182 183 184
			if (belle_sip_ist_process_ack(ist,(belle_sip_message_t*)req)==0){
				belle_sip_dialog_t *dialog=t->base.dialog;
				if (dialog && belle_sip_dialog_handle_ack(dialog,req)==-1)
					dialog=NULL;
				server_transaction_notify(t,req,dialog);
			}
185 186 187
		}else{
			belle_sip_warning("ACK received for non-invite server transaction ?");
		}
Simon Morlat's avatar
Simon Morlat committed
188
	}else if (strcmp(method,"CANCEL")==0){
189
		server_transaction_notify(t,req,t->base.dialog);
Simon Morlat's avatar
Simon Morlat committed
190 191
	}else
		BELLE_SIP_OBJECT_VPTR(t,belle_sip_server_transaction_t)->on_request_retransmission(t);
Simon Morlat's avatar
Simon Morlat committed
192
}
193

Simon Morlat's avatar
Simon Morlat committed
194 195 196 197
/*
 * client transaction
 */

198

199

200
belle_sip_request_t * belle_sip_client_transaction_create_cancel(belle_sip_client_transaction_t *t){
201 202 203 204 205 206 207 208 209 210 211 212 213 214
	belle_sip_message_t *orig=(belle_sip_message_t*)t->base.request;
	belle_sip_request_t *req;
	const char *orig_method=belle_sip_request_get_method((belle_sip_request_t*)orig);
	if (strcmp(orig_method,"ACK")==0 || strcmp(orig_method,"INVITE")!=0){
		belle_sip_error("belle_sip_client_transaction_create_cancel() cannot be used for ACK or non-INVITE transactions.");
		return NULL;
	}
	if (t->base.state==BELLE_SIP_TRANSACTION_PROCEEDING){
		belle_sip_error("belle_sip_client_transaction_create_cancel() can only be used in state BELLE_SIP_TRANSACTION_PROCEEDING"
		               " but current transaction state is %s",belle_sip_transaction_state_to_string(t->base.state));
	}
	req=belle_sip_request_new();
	belle_sip_request_set_method(req,"CANCEL");
	belle_sip_request_set_uri(req,(belle_sip_uri_t*)belle_sip_object_clone((belle_sip_object_t*)belle_sip_request_get_uri((belle_sip_request_t*)orig)));
215 216 217 218 219
	belle_sip_util_copy_headers(orig,(belle_sip_message_t*)req,"via",FALSE);
	belle_sip_util_copy_headers(orig,(belle_sip_message_t*)req,"call-id",FALSE);
	belle_sip_util_copy_headers(orig,(belle_sip_message_t*)req,"from",FALSE);
	belle_sip_util_copy_headers(orig,(belle_sip_message_t*)req,"to",FALSE);
	belle_sip_util_copy_headers(orig,(belle_sip_message_t*)req,"route",TRUE);
220 221 222 223 224
	belle_sip_message_add_header((belle_sip_message_t*)req,
		(belle_sip_header_t*)belle_sip_header_cseq_create(
			belle_sip_header_cseq_get_seq_number((belle_sip_header_cseq_t*)belle_sip_message_get_header(orig,"cseq")),
		    "CANCEL"));
	return req;
225
}
Simon Morlat's avatar
Simon Morlat committed
226

227 228

void belle_sip_client_transaction_send_request(belle_sip_client_transaction_t *t){
Simon Morlat's avatar
Simon Morlat committed
229 230
	belle_sip_hop_t hop={0};
	belle_sip_channel_t *chan;
Simon Morlat's avatar
Simon Morlat committed
231
	belle_sip_provider_t *prov=t->base.provider;
Simon Morlat's avatar
Simon Morlat committed
232
	
Simon Morlat's avatar
Simon Morlat committed
233 234 235
	if (t->base.state!=BELLE_SIP_TRANSACTION_INIT){
		belle_sip_error("belle_sip_client_transaction_send_request: bad state.");
		return;
Simon Morlat's avatar
Simon Morlat committed
236
	}
Simon Morlat's avatar
Simon Morlat committed
237 238 239
	belle_sip_stack_get_next_hop(prov->stack,t->base.request,&hop);
	chan=belle_sip_provider_get_channel(prov,hop.host, hop.port, hop.transport);
	if (chan){
240
		belle_sip_provider_add_client_transaction(t->base.provider,t);
Simon Morlat's avatar
Simon Morlat committed
241
		belle_sip_object_ref(chan);
Simon Morlat's avatar
Simon Morlat committed
242 243
		belle_sip_channel_add_listener(chan,BELLE_SIP_CHANNEL_LISTENER(t));
		t->base.channel=chan;
Simon Morlat's avatar
Simon Morlat committed
244 245 246 247
		if (belle_sip_channel_get_state(chan)==BELLE_SIP_CHANNEL_INIT)
			belle_sip_channel_prepare(chan);
		if (belle_sip_channel_get_state(chan)!=BELLE_SIP_CHANNEL_READY){
			belle_sip_message("belle_sip_client_transaction_send_request(): waiting channel to be ready");
248 249
		} else {
			BELLE_SIP_OBJECT_VPTR(t,belle_sip_client_transaction_t)->send_request(t);
Simon Morlat's avatar
Simon Morlat committed
250
		}
Simon Morlat's avatar
Simon Morlat committed
251
	}else belle_sip_error("belle_sip_client_transaction_send_request(): no channel available");
252
	belle_sip_hop_free(&hop);
Simon Morlat's avatar
Simon Morlat committed
253 254
}

255
void belle_sip_client_transaction_notify_response(belle_sip_client_transaction_t *t, belle_sip_response_t *resp){
Simon Morlat's avatar
Simon Morlat committed
256
	belle_sip_transaction_t *base=(belle_sip_transaction_t*)t;
257
	belle_sip_response_event_t event;
Simon Morlat's avatar
Simon Morlat committed
258
	belle_sip_dialog_t *dialog=base->dialog;
259
		
260 261 262
	if (base->last_response)
		belle_sip_object_unref(base->last_response);
	base->last_response=(belle_sip_response_t*)belle_sip_object_ref(resp);
263

Simon Morlat's avatar
Simon Morlat committed
264 265 266 267 268 269 270 271 272 273 274 275
	if (dialog){
		if (dialog->state==BELLE_SIP_DIALOG_EARLY || dialog->state==BELLE_SIP_DIALOG_CONFIRMED){
			/*make sure this response matches the current dialog, or creates a new one*/
			if (!belle_sip_dialog_match(dialog,(belle_sip_message_t*)resp,FALSE)){
				dialog=belle_sip_dialog_new(base);
				if (dialog){
					belle_sip_message("Handling response creating a new dialog !");
				}
			}
		}
		if (dialog) belle_sip_dialog_update(dialog,base->request,resp,FALSE);
	}
276 277
	event.source=base->provider;
	event.client_transaction=t;
Simon Morlat's avatar
Simon Morlat committed
278
	event.dialog=dialog;
279 280
	event.response=(belle_sip_response_t*)resp;
	BELLE_SIP_PROVIDER_INVOKE_LISTENERS(base->provider,process_response_event,&event);
Simon Morlat's avatar
Simon Morlat committed
281 282
	/*check that 200Ok for INVITEs have been acknoledged by listener*/
	if (dialog) belle_sip_dialog_check_ack_sent(dialog);
283 284 285 286 287
}


void belle_sip_client_transaction_add_response(belle_sip_client_transaction_t *t, belle_sip_response_t *resp){
	BELLE_SIP_OBJECT_VPTR(t,belle_sip_client_transaction_t)->on_response(t,resp);
Simon Morlat's avatar
Simon Morlat committed
288 289
}

Simon Morlat's avatar
Simon Morlat committed
290
static void client_transaction_destroy(belle_sip_client_transaction_t *t ){
Simon Morlat's avatar
Simon Morlat committed
291 292
}

Simon Morlat's avatar
Simon Morlat committed
293 294
static void on_channel_state_changed(belle_sip_channel_listener_t *l, belle_sip_channel_t *chan, belle_sip_channel_state_t state){
	belle_sip_client_transaction_t *t=(belle_sip_client_transaction_t*)l;
Simon Morlat's avatar
Simon Morlat committed
295
	belle_sip_message("transaction on_channel_state_changed");
Simon Morlat's avatar
Simon Morlat committed
296 297 298 299 300 301 302 303
	switch(state){
		case BELLE_SIP_CHANNEL_READY:
			BELLE_SIP_OBJECT_VPTR(t,belle_sip_client_transaction_t)->send_request(t);
		break;
		default:
			/*ignored*/
		break;
	}
Simon Morlat's avatar
Simon Morlat committed
304 305
}

Simon Morlat's avatar
Simon Morlat committed
306 307 308 309 310 311 312 313 314
BELLE_SIP_IMPLEMENT_INTERFACE_BEGIN(belle_sip_client_transaction_t,belle_sip_channel_listener_t)
on_channel_state_changed,
NULL,
NULL
BELLE_SIP_IMPLEMENT_INTERFACE_END

BELLE_SIP_DECLARE_IMPLEMENTED_INTERFACES_1(belle_sip_client_transaction_t, belle_sip_channel_listener_t);
BELLE_SIP_INSTANCIATE_CUSTOM_VPTR(belle_sip_client_transaction_t)={
	{
Simon Morlat's avatar
Simon Morlat committed
315 316 317 318 319 320
		{
			BELLE_SIP_VPTR_INIT(belle_sip_client_transaction_t,belle_sip_transaction_t,FALSE),
			(belle_sip_object_destroy_t)client_transaction_destroy,
			NULL,
			NULL
		},
Simon Morlat's avatar
Simon Morlat committed
321 322 323 324 325
		NULL
	},
	NULL,
	NULL
};
Simon Morlat's avatar
Simon Morlat committed
326

Simon Morlat's avatar
Simon Morlat committed
327
void belle_sip_client_transaction_init(belle_sip_client_transaction_t *obj, belle_sip_provider_t *prov, belle_sip_request_t *req){
Simon Morlat's avatar
Simon Morlat committed
328 329
	belle_sip_header_via_t *via=BELLE_SIP_HEADER_VIA(belle_sip_message_get_header((belle_sip_message_t*)req,"via"));
	char token[10];
330 331 332 333 334 335 336

	if (!via){
		belle_sip_fatal("belle_sip_client_transaction_init(): No via in request.");
	}
	
	if (strcmp(belle_sip_request_get_method(req),"CANCEL")!=0){
		obj->base.branch_id=belle_sip_strdup_printf(BELLE_SIP_BRANCH_MAGIC_COOKIE ".%s",belle_sip_random_token(token,sizeof(token)));
Simon Morlat's avatar
Simon Morlat committed
337 338
		belle_sip_header_via_set_branch(via,obj->base.branch_id);
	}else{
339
		obj->base.branch_id=belle_sip_strdup(belle_sip_header_via_get_branch(via));
Simon Morlat's avatar
Simon Morlat committed
340
	}
Simon Morlat's avatar
Simon Morlat committed
341
	belle_sip_transaction_init((belle_sip_transaction_t*)obj, prov,req);
342 343
}

344