refresher.c 12 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 38 39 40 41 42 43 44 45 46
}
static void process_io_error(void *user_ctx, const belle_sip_io_error_event_t *event){
	belle_sip_fatal("Refresher process_io_error not implemented yet");
}

static int set_expires_from_trans(belle_sip_refresher_t* refresher);
static int refresh(belle_sip_refresher_t* refresher);
static int timer_cb(void *user_data, unsigned int events) ;

static void schedule_timer(belle_sip_refresher_t* refresher) {
	if (refresher->expires>0) {
47 48 49 50
		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
51
		refresher->timer=belle_sip_timeout_source_new(timer_cb,refresher,refresher->expires*1000);
jehan's avatar
jehan committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
		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:{
jehan's avatar
jehan committed
76
			refresh(refresher); /*authorization is supposed to be available immediately*/
jehan's avatar
jehan committed
77 78 79 80 81 82 83 84 85
			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
86 87 88 89 90
/*	belle_sip_client_transaction_t* client_transaction = belle_sip_response_event_get_client_transaction(event);
	belle_sip_refresher_t* refresher=(belle_sip_refresher_t*)user_ctx;
	if (refresher && (client_transaction !=refresher->transaction))
		return;*/ /*not for me*/

jehan's avatar
jehan committed
91 92 93
		belle_sip_fatal("Unhandled event timeout [%p]",event);
}
static void process_transaction_terminated(void *user_ctx, const belle_sip_transaction_terminated_event_t *event) {
jehan's avatar
jehan committed
94 95 96 97 98 99
/*	belle_sip_client_transaction_t* client_transaction = belle_sip_response_event_get_client_transaction(event);
	belle_sip_refresher_t* refresher=(belle_sip_refresher_t*)user_ctx;
	if (refresher && (client_transaction !=refresher->transaction))
		return;*/ /*not for me*/

	belle_sip_fatal("Unhandled transaction terminated [%p]",event);
jehan's avatar
jehan committed
100 101 102 103
}

static void destroy(belle_sip_refresher_t *refresher){
	if (refresher->transaction) belle_sip_object_unref(refresher->transaction);
Simon Morlat's avatar
Simon Morlat committed
104
	if (refresher->sip_listener) belle_sip_object_unref(refresher->sip_listener);
jehan's avatar
jehan committed
105

jehan's avatar
jehan committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
}
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;
}

static int refresh(belle_sip_refresher_t* refresher) {
	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
121
	belle_sip_header_expires_t* expires_header;
jehan's avatar
jehan committed
122 123
	belle_sip_provider_t* prov=refresher->transaction->base.provider;
	if (!dialog) {
jehan's avatar
jehan committed
124 125
		/*create new request*/
		request=belle_sip_client_transaction_create_authenticated_request(refresher->transaction);
jehan's avatar
jehan committed
126
	} else if (dialog && belle_sip_dialog_get_state(dialog)==BELLE_SIP_DIALOG_CONFIRMED) {
jehan's avatar
jehan committed
127
		request=belle_sip_dialog_create_request_from(dialog,old_request);
jehan's avatar
jehan committed
128 129
		if (strcmp(belle_sip_request_get_method(request),"SUBSCRIBE")==0) {
			/*put expire header*/
jehan's avatar
jehan committed
130 131 132 133 134 135
			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));
			}
			belle_sip_header_expires_set_expires(expires_header,refresher->expires);

jehan's avatar
jehan committed
136
		}
137
		belle_sip_provider_add_authorization(prov,request,NULL,NULL);
jehan's avatar
jehan committed
138 139 140 141 142 143 144 145 146 147 148 149 150
	} 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;
	}
	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
151
	belle_sip_object_ref(refresher->transaction);
jehan's avatar
jehan committed
152 153 154 155 156

	if (belle_sip_client_transaction_send_request(client_transaction)) {
		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
157
		return -1;
jehan's avatar
jehan committed
158 159 160 161 162 163
	}
	return 0;
}

static int timer_cb(void *user_data, unsigned int events) {
	belle_sip_refresher_t* refresher = (belle_sip_refresher_t*)user_data;
164 165
	refresh(refresher);
	return BELLE_SIP_STOP;
jehan's avatar
jehan committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
}
/*return 0 if succeeded*/
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;
	belle_sip_header_contact_t* local_contact;
	/*we assume, there is only one contact in request*/
	local_contact= belle_sip_message_get_header_by_type(BELLE_SIP_MESSAGE(request),belle_sip_header_contact_t);
	local_contact= BELLE_SIP_HEADER_CONTACT(belle_sip_object_clone(BELLE_SIP_OBJECT(local_contact)));

	/*first fix contact using received/rport*/
	belle_sip_response_fix_contact(response,local_contact);

	/*now, we have a *NAT* aware contact*/
	contact_header_list = belle_sip_message_get_headers(BELLE_SIP_MESSAGE(response),BELLE_SIP_CONTACT);
	if (contact_header_list) {
		contact_header_list = belle_sip_list_find_custom((belle_sip_list_t*)contact_header_list
184
				,(belle_sip_compare_func)belle_sip_header_contact_not_equals
jehan's avatar
jehan committed
185 186 187 188 189
				, (const void*)local_contact);
		if (!contact_header_list) {
			char* contact_string=belle_sip_object_to_string(BELLE_SIP_OBJECT(local_contact));
			belle_sip_error("no matching contact for  [%s]",contact_string);
			belle_sip_free(contact_string);
190
			belle_sip_object_unref(local_contact);
jehan's avatar
jehan committed
191 192
			return NULL;
		} else {
jehan's avatar
jehan committed
193
			return BELLE_SIP_HEADER_CONTACT(local_contact);
jehan's avatar
jehan committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
		}
	} 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;
	refresher->expires=-1;
	belle_sip_header_contact_t* contact_header;
	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
214
		if (strcmp("REGISTER",belle_sip_request_get_method(request))==0
215 216
				&& (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
217
			/*great, we have an expire param from contact header*/
jehan's avatar
jehan committed
218 219
			belle_sip_object_unref(contact_header);
			contact_header=NULL;
220 221
		}
		if (refresher->expires==-1){
jehan's avatar
jehan committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
			/*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);
		}
	}
	return 0;
}

void belle_sip_refresher_stop(belle_sip_refresher_t* refresher) {
256 257 258 259 260
	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;
	}
jehan's avatar
jehan committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
}
belle_sip_refresher_t* belle_sip_refresher_new(belle_sip_client_transaction_t* transaction) {

	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;
	}
	belle_sip_refresher_t* refresher = (belle_sip_refresher_t*)belle_sip_object_new(belle_sip_refresher_t);
	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
277 278 279
	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
280 281 282 283 284
	if (set_expires_from_trans(refresher)){
		belle_sip_error("Unable to extract refresh value from transaction [%p]",transaction);
	}
	return refresher;
}