refresher.c 14.7 KB
Newer Older
jehan's avatar
jehan committed
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
/*
	belle-sip - SIP (RFC3261) library.
    Copyright (C) 2012  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"
#include "belle-sip/refresher-helper.h"

struct belle_sip_refresher {
	belle_sip_object_t obj;
	belle_sip_refresher_listener_t listener;
	belle_sip_source_t* timer;
	belle_sip_client_transaction_t* transaction;
	int expires;
	unsigned int started;
	belle_sip_listener_callbacks_t listener_callbacks;
Simon Morlat's avatar
Simon Morlat committed
30
	belle_sip_listener_t *sip_listener;
jehan's avatar
jehan committed
31 32 33
	void* user_data;
};

jehan's avatar
jehan committed
34 35
static void process_dialog_terminated(void *user_ctx, const belle_sip_dialog_terminated_event_t *event){
	/*nop*/
jehan's avatar
jehan committed
36 37
}
static void process_io_error(void *user_ctx, const belle_sip_io_error_event_t *event){
38 39 40 41 42 43 44 45 46 47 48 49
	belle_sip_refresher_t* refresher=(belle_sip_refresher_t*)user_ctx;
	belle_sip_client_transaction_t*client_transaction;

	if (belle_sip_object_is_instance_of(BELLE_SIP_OBJECT(belle_sip_io_error_event_get_source(event)),BELLE_SIP_TYPE_ID(belle_sip_client_transaction_t))) {
		client_transaction=BELLE_SIP_CLIENT_TRANSACTION(belle_sip_io_error_event_get_source(event));
		if (refresher && (client_transaction !=refresher->transaction))
				return; /*not for me*/

		/*first stop timer if any*/
		belle_sip_refresher_stop(refresher);
		refresher->listener(refresher,refresher->user_data,503, "io error");
		return;
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
	} else if (belle_sip_object_is_instance_of(BELLE_SIP_OBJECT(belle_sip_io_error_event_get_source(event)),BELLE_SIP_TYPE_ID(belle_sip_provider_t))) {
		/*something went wrong on this provider, checking if my channel is still up*/
		if (refresher->started &&
								(belle_sip_channel_get_state(refresher->transaction->base.channel) == BELLE_SIP_CHANNEL_DISCONNECTED
								||belle_sip_channel_get_state(refresher->transaction->base.channel) == BELLE_SIP_CHANNEL_ERROR)) {
			belle_sip_message("refresher [%p] has channel [%p] in state [%s], reporting error"
								,refresher
								,refresher->transaction->base.channel
								,belle_sip_channel_state_to_string(belle_sip_channel_get_state(refresher->transaction->base.channel)));
			belle_sip_refresher_stop(refresher);
			refresher->listener(refresher,refresher->user_data,503, "io error");
		}
		return;
	}else {
		belle_sip_error("Refresher process_io_error not implemented yet for non transaction/provider source");
65
	}
jehan's avatar
jehan committed
66 67 68
}

static int set_expires_from_trans(belle_sip_refresher_t* refresher);
69

jehan's avatar
jehan committed
70 71 72 73
static int timer_cb(void *user_data, unsigned int events) ;

static void schedule_timer(belle_sip_refresher_t* refresher) {
	if (refresher->expires>0) {
74 75 76 77
		if (refresher->timer){
			belle_sip_main_loop_remove_source(belle_sip_stack_get_main_loop(refresher->transaction->base.provider->stack),refresher->timer);
			belle_sip_object_unref(refresher->timer);
		}
jehan's avatar
jehan committed
78
		refresher->timer=belle_sip_timeout_source_new(timer_cb,refresher,refresher->expires*1000);
jehan's avatar
jehan committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
		belle_sip_object_set_name((belle_sip_object_t*)refresher->timer,"Refresher timeout");
		belle_sip_main_loop_add_source(belle_sip_stack_get_main_loop(refresher->transaction->base.provider->stack),refresher->timer);
	}
}

static void process_response_event(void *user_ctx, const belle_sip_response_event_t *event){
	belle_sip_client_transaction_t* client_transaction = belle_sip_response_event_get_client_transaction(event);
	belle_sip_response_t* response = belle_sip_response_event_get_response(event);
	int response_code = belle_sip_response_get_status_code(response);
	belle_sip_refresher_t* refresher=(belle_sip_refresher_t*)user_ctx;
	if (refresher && (client_transaction !=refresher->transaction))
		return; /*not for me*/

		/*handle authorization*/
		switch (response_code) {
		case 200: {
			/*great, success*/
			/*update expire if needed*/
			set_expires_from_trans(refresher);
			schedule_timer(refresher); /*re-arm timer*/
			break;
		}
		case 401:
		case 407:{
103
			belle_sip_refresher_refresh(refresher,refresher->expires); /*authorization is supposed to be available immediately*/
jehan's avatar
jehan committed
104 105 106 107 108 109 110 111 112
			return;
		}
		default:
			break;
		}
		refresher->listener(refresher,refresher->user_data,response_code, belle_sip_response_get_reason_phrase(response));

}
static void process_timeout(void *user_ctx, const belle_sip_timeout_event_t *event) {
jehan's avatar
jehan committed
113
	belle_sip_refresher_t* refresher=(belle_sip_refresher_t*)user_ctx;
jehan's avatar
jehan committed
114 115
	belle_sip_client_transaction_t*client_transaction =belle_sip_timeout_event_get_client_transaction(event);

jehan's avatar
jehan committed
116
	if (refresher && (client_transaction !=refresher->transaction))
jehan's avatar
jehan committed
117
				return; /*not for me*/
jehan's avatar
jehan committed
118

jehan's avatar
jehan committed
119 120 121 122
		/*first stop timer if any*/
	belle_sip_refresher_stop(refresher);
	refresher->listener(refresher,refresher->user_data,408, "timeout");
	return;
jehan's avatar
jehan committed
123 124
}
static void process_transaction_terminated(void *user_ctx, const belle_sip_transaction_terminated_event_t *event) {
jehan's avatar
jehan committed
125
	/*belle_sip_message("process_transaction_terminated Transaction terminated [%p]",event);*/
jehan's avatar
jehan committed
126 127 128
}

static void destroy(belle_sip_refresher_t *refresher){
129 130 131
	belle_sip_provider_remove_internal_sip_listener(refresher->transaction->base.provider,refresher->sip_listener);
	belle_sip_object_unref(refresher->transaction);
	belle_sip_object_unref(refresher->sip_listener);
jehan's avatar
jehan committed
132
}
133

jehan's avatar
jehan committed
134 135 136 137 138 139 140 141 142
BELLE_SIP_DECLARE_NO_IMPLEMENTED_INTERFACES(belle_sip_refresher_t);

BELLE_SIP_INSTANCIATE_VPTR(belle_sip_refresher_t, belle_sip_object_t,destroy, NULL, NULL,FALSE);

void belle_sip_refresher_set_listener(belle_sip_refresher_t* refresher, belle_sip_refresher_listener_t listener,void* user_pointer) {
	refresher->listener=listener;
	refresher->user_data=user_pointer;
}

143
int belle_sip_refresher_refresh(belle_sip_refresher_t* refresher,int expires) {
jehan's avatar
jehan committed
144 145 146 147
	belle_sip_request_t*old_request=belle_sip_transaction_get_request(BELLE_SIP_TRANSACTION(refresher->transaction));
	belle_sip_dialog_t* dialog = belle_sip_transaction_get_dialog(BELLE_SIP_TRANSACTION(refresher->transaction));
	belle_sip_client_transaction_t* client_transaction;
	belle_sip_request_t* request;
jehan's avatar
jehan committed
148
	belle_sip_header_expires_t* expires_header;
149
	belle_sip_uri_t* preset_route=refresher->transaction->preset_route;
jehan's avatar
jehan committed
150
	belle_sip_provider_t* prov=refresher->transaction->base.provider;
151 152 153 154
	belle_sip_header_contact_t* contact;
	/*first remove timer if any*/
	belle_sip_refresher_stop(refresher);

jehan's avatar
jehan committed
155
	if (!dialog) {
jehan's avatar
jehan committed
156 157
		/*create new request*/
		request=belle_sip_client_transaction_create_authenticated_request(refresher->transaction);
jehan's avatar
jehan committed
158
	} else if (dialog && belle_sip_dialog_get_state(dialog)==BELLE_SIP_DIALOG_CONFIRMED) {
jehan's avatar
jehan committed
159
		request=belle_sip_dialog_create_request_from(dialog,old_request);
jehan's avatar
jehan committed
160 161
		if (strcmp(belle_sip_request_get_method(request),"SUBSCRIBE")==0) {
			/*put expire header*/
jehan's avatar
jehan committed
162 163 164 165
			if (!(expires_header = belle_sip_message_get_header_by_type(request,belle_sip_header_expires_t))) {
				expires_header = belle_sip_header_expires_new();
				belle_sip_message_add_header(BELLE_SIP_MESSAGE(request),BELLE_SIP_HEADER(expires_header));
			}
166

jehan's avatar
jehan committed
167

jehan's avatar
jehan committed
168
		}
169
		belle_sip_provider_add_authorization(prov,request,NULL,NULL);
jehan's avatar
jehan committed
170 171 172 173 174 175 176
	} else {
		belle_sip_error("Unexpected dialog state [%s] for dialog [%p], cannot refresh [%s]"
				,belle_sip_dialog_state_to_string(belle_sip_dialog_get_state(dialog))
				,dialog
				,belle_sip_request_get_method(old_request));
		return -1;
	}
177 178 179 180 181 182 183 184
	/*update expires in any cases*/
	expires_header = belle_sip_message_get_header_by_type(request,belle_sip_header_expires_t);
	if (expires_header)
		belle_sip_header_expires_set_expires(expires_header,expires);
	contact=belle_sip_message_get_header_by_type(request,belle_sip_header_contact_t);
	if (belle_sip_header_contact_get_expires(contact)>=0)
		belle_sip_header_contact_set_expires(contact,expires);

jehan's avatar
jehan committed
185 186 187 188 189 190
	client_transaction = belle_sip_provider_create_client_transaction(prov,request);
	client_transaction->base.is_internal=1;
	belle_sip_transaction_set_application_data(BELLE_SIP_TRANSACTION(client_transaction),refresher);
	/*update reference transaction for next refresh*/
	belle_sip_object_unref(refresher->transaction);
	refresher->transaction=client_transaction;
jehan's avatar
jehan committed
191
	belle_sip_object_ref(refresher->transaction);
jehan's avatar
jehan committed
192

193
	if (belle_sip_client_transaction_send_request_to(client_transaction,preset_route)) {
jehan's avatar
jehan committed
194 195 196
		belle_sip_error("Cannot send refresh method [%s] for refresher [%p]"
				,belle_sip_request_get_method(old_request)
				,refresher);
Simon Morlat's avatar
Simon Morlat committed
197
		return -1;
jehan's avatar
jehan committed
198 199 200 201
	}
	return 0;
}

202

jehan's avatar
jehan committed
203 204
static int timer_cb(void *user_data, unsigned int events) {
	belle_sip_refresher_t* refresher = (belle_sip_refresher_t*)user_data;
205
	belle_sip_refresher_refresh(refresher,refresher->expires);
206
	return BELLE_SIP_STOP;
jehan's avatar
jehan committed
207
}
208

jehan's avatar
jehan committed
209 210 211 212
static belle_sip_header_contact_t* get_matching_contact(const belle_sip_transaction_t* transaction) {
	belle_sip_request_t*request=belle_sip_transaction_get_request(transaction);
	belle_sip_response_t*response=transaction->last_response;
	const belle_sip_list_t* contact_header_list;
jehan's avatar
jehan committed
213 214 215 216
	belle_sip_header_contact_t* unfixed_local_contact;
	belle_sip_header_contact_t* fixed_local_contact;
	char* tmp_string;
	char* tmp_string2;
jehan's avatar
jehan committed
217
	/*we assume, there is only one contact in request*/
jehan's avatar
jehan committed
218 219
	unfixed_local_contact= belle_sip_message_get_header_by_type(BELLE_SIP_MESSAGE(request),belle_sip_header_contact_t);
	fixed_local_contact= BELLE_SIP_HEADER_CONTACT(belle_sip_object_clone(BELLE_SIP_OBJECT(unfixed_local_contact)));
jehan's avatar
jehan committed
220 221

	/*first fix contact using received/rport*/
jehan's avatar
jehan committed
222
	belle_sip_response_fix_contact(response,fixed_local_contact);
jehan's avatar
jehan committed
223
	contact_header_list = belle_sip_message_get_headers(BELLE_SIP_MESSAGE(response),BELLE_SIP_CONTACT);
jehan's avatar
jehan committed
224

jehan's avatar
jehan committed
225
	if (contact_header_list) {
jehan's avatar
jehan committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
			contact_header_list = belle_sip_list_find_custom((belle_sip_list_t*)contact_header_list
																,(belle_sip_compare_func)belle_sip_header_contact_not_equals
																, (const void*)fixed_local_contact);
			if (!contact_header_list) {
				/*reset header list*/
				contact_header_list = belle_sip_message_get_headers(BELLE_SIP_MESSAGE(response),BELLE_SIP_CONTACT);
				contact_header_list = belle_sip_list_find_custom((belle_sip_list_t*)contact_header_list
																,(belle_sip_compare_func)belle_sip_header_contact_not_equals
																,unfixed_local_contact);
			}
			if (!contact_header_list) {
				tmp_string=belle_sip_object_to_string(BELLE_SIP_OBJECT(fixed_local_contact));
				tmp_string2=belle_sip_object_to_string(BELLE_SIP_OBJECT(unfixed_local_contact));
				belle_sip_error("No matching contact neither for [%s] nor [%s]", tmp_string, tmp_string2);
				belle_sip_free(tmp_string);
				belle_sip_free(tmp_string2);
				return NULL;
			} else {
				return BELLE_SIP_HEADER_CONTACT(contact_header_list->data);
			}
jehan's avatar
jehan committed
246 247 248 249 250 251 252 253 254 255 256
		} else {
		return NULL;
	}

}
static int set_expires_from_trans(belle_sip_refresher_t* refresher) {
	belle_sip_transaction_t* transaction = BELLE_SIP_TRANSACTION(refresher->transaction);
	belle_sip_response_t*response=transaction->last_response;
	belle_sip_request_t*request=belle_sip_transaction_get_request(transaction);
	belle_sip_header_expires_t* expires_header;
	belle_sip_header_contact_t* contact_header;
257 258 259

	refresher->expires=-1;
	
jehan's avatar
jehan committed
260 261 262 263 264 265 266
	if (strcmp("REGISTER",belle_sip_request_get_method(request))==0
			|| strcmp("SUBSCRIBE",belle_sip_request_get_method(request))==0) {

		/*An "expires" parameter on the "Contact" header has no semantics for
		*   SUBSCRIBE and is explicitly not equivalent to an "Expires" header in
		*  a SUBSCRIBE request or response.
		*/
jehan's avatar
jehan committed
267
		if (strcmp("REGISTER",belle_sip_request_get_method(request))==0
268 269
				&& (contact_header=get_matching_contact(transaction))!=NULL){
			refresher->expires=belle_sip_header_contact_get_expires(BELLE_SIP_HEADER_CONTACT(contact_header));
jehan's avatar
jehan committed
270
			/*great, we have an expire param from contact header*/
271 272
		}
		if (refresher->expires==-1){
jehan's avatar
jehan committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
			/*no contact with expire or not relevant, looking for Expires header*/
			if ((expires_header=(belle_sip_header_expires_t*)belle_sip_message_get_header(BELLE_SIP_MESSAGE(response),BELLE_SIP_EXPIRES))) {
				refresher->expires = belle_sip_header_expires_get_expires(expires_header);
			}
		}
		if (refresher->expires<0) {
			belle_sip_message("Neither Expires header nor corresponding Contact header found");
			refresher->expires=0;
			return 1;
		}

	} 	else if (strcmp("INVITE",belle_sip_request_get_method(request))==0) {
		belle_sip_fatal("Refresher does not support ERROR yet");
	} else {
		belle_sip_error("Refresher does not support [%s] yet",belle_sip_request_get_method(request));
		return 1;
	}
	return 0;
}


int belle_sip_refresher_start(belle_sip_refresher_t* refresher) {
	if(refresher->started) {
		belle_sip_warning("Refresher[%p] already started",refresher);
	} else {
		if (refresher->expires>0) {
			schedule_timer(refresher);
			belle_sip_message("Refresher [%p] started, next refresh in [%i] s",refresher,refresher->expires);
		}
	}
303
	refresher->started=1;
jehan's avatar
jehan committed
304 305 306 307
	return 0;
}

void belle_sip_refresher_stop(belle_sip_refresher_t* refresher) {
308 309 310 311 312
	if (refresher->timer){
		belle_sip_main_loop_remove_source(belle_sip_stack_get_main_loop(refresher->transaction->base.provider->stack), refresher->timer);
		belle_sip_object_unref(refresher->timer);
		refresher->timer=NULL;
	}
313
	refresher->started=0;
jehan's avatar
jehan committed
314 315
}
belle_sip_refresher_t* belle_sip_refresher_new(belle_sip_client_transaction_t* transaction) {
316
	belle_sip_refresher_t* refresher;
jehan's avatar
jehan committed
317 318 319 320 321 322
	if (belle_sip_transaction_get_state(BELLE_SIP_TRANSACTION(transaction)) != BELLE_SIP_TRANSACTION_COMPLETED) {
		belle_sip_error("Invalid state [%s] for transaction [%p], should be BELLE_SIP_TRANSACTION_COMPLETED"
					,belle_sip_transaction_state_to_string(belle_sip_transaction_get_state(BELLE_SIP_TRANSACTION(transaction)))
					,transaction);
		return NULL;
	}
323
	refresher = (belle_sip_refresher_t*)belle_sip_object_new(belle_sip_refresher_t);
jehan's avatar
jehan committed
324 325 326 327 328 329
	refresher->transaction=transaction;
	belle_sip_object_ref(transaction);
	refresher->listener_callbacks.process_response_event=process_response_event;
	refresher->listener_callbacks.process_timeout=process_timeout;
	refresher->listener_callbacks.process_io_error=process_io_error;
	refresher->listener_callbacks.process_dialog_terminated=process_dialog_terminated;
Simon Morlat's avatar
Simon Morlat committed
330 331 332
	refresher->listener_callbacks.process_transaction_terminated=process_transaction_terminated;;
	refresher->sip_listener=belle_sip_listener_create_from_callbacks(&(refresher->listener_callbacks),refresher);
	belle_sip_provider_add_internal_sip_listener(transaction->base.provider,refresher->sip_listener);
jehan's avatar
jehan committed
333 334 335 336 337
	if (set_expires_from_trans(refresher)){
		belle_sip_error("Unable to extract refresh value from transaction [%p]",transaction);
	}
	return refresher;
}
338 339 340
int belle_sip_refresher_get_expires(const belle_sip_refresher_t* refresher) {
	return refresher->expires;
}