nua_dialog.c 11.3 KB
Newer Older
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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2006 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

/**@CFILE nua_dialog.c
 * @brief Dialog and dialog usage handling
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 *
 * @date Created: Wed Mar  8 11:48:49 EET 2006 ppessi
 */

#include "config.h"

#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <limits.h>

#include <assert.h>

#include <sofia-sip/string0.h>

#include <sofia-sip/sip_protos.h>
45 46 47

#define NUA_OWNER_T su_home_t

48 49
#include "nua_dialog.h"

50 51 52 53 54 55 56
#define SU_LOG (nua_log)
#include <sofia-sip/su_debug.h>

#ifndef NONE
#define NONE ((void *)-1)
#endif

57 58 59
/* ======================================================================== */
/* Dialog handling */

60
static void nua_dialog_usage_remove_at(nua_owner_t*, nua_dialog_state_t*, 
61
				       nua_dialog_usage_t**);
62
static void nua_dialog_log_usage(nua_owner_t *, nua_dialog_state_t *);
63

Pekka Pessi's avatar
Pekka Pessi committed
64 65
/**@internal
 * UAS tag and route.
66 67 68 69
 *
 * Update dialog tags and route on the UAS side.
 *
 * @param own  dialog owner
Pekka Pessi's avatar
Pekka Pessi committed
70
 * @param ds   dialog state
71 72 73 74 75 76 77
 * @param sip  SIP message containing response used to update dialog
 * @param rtag if true, set remote tag within the leg
 */
void nua_dialog_uas_route(nua_owner_t *own, 
			  nua_dialog_state_t *ds,
			  sip_t const *sip, 
			  int rtag)
78 79 80 81
{
  int established = nua_dialog_is_established(ds);

  if (!established && sip->sip_from->a_tag)
82
    ds->ds_remote_tag = su_strdup(own, sip->sip_from->a_tag);
83 84 85 86 87 88 89 90 91 92 93

  if (ds->ds_leg == NULL)
    return;

  nta_leg_server_route(ds->ds_leg, sip->sip_record_route, sip->sip_contact);
  ds->ds_route = ds->ds_route || sip->sip_record_route || sip->sip_contact;

  if (rtag && !established && sip->sip_from->a_tag)
    nta_leg_rtag(ds->ds_leg, sip->sip_from->a_tag);
}

Pekka Pessi's avatar
Pekka Pessi committed
94 95
/**@internal
 * UAC tag and route.
96 97 98
 *
 * Update dialog tags and route on the UAC side.
 *
99
 * @param own  dialog owner
Pekka Pessi's avatar
Pekka Pessi committed
100
 * @param ds   dialog state
101 102 103
 * @param sip  SIP message containing response used to update dialog
 * @param rtag if true, set remote tag within the leg
 */
104 105 106 107
void nua_dialog_uac_route(nua_owner_t *own, 
			  nua_dialog_state_t *ds,
			  sip_t const *sip,
			  int rtag)
108 109 110 111
{
  int established = nua_dialog_is_established(ds);

  if (!established && sip->sip_to->a_tag)
112
    ds->ds_remote_tag = su_strdup(own, sip->sip_to->a_tag);
113 114 115 116 117 118 119 120 121 122 123

  if (ds->ds_leg == NULL)
    return;

  nta_leg_client_route(ds->ds_leg, sip->sip_record_route, sip->sip_contact);
  ds->ds_route = ds->ds_route || sip->sip_record_route || sip->sip_contact;

  if (rtag && !established && sip->sip_to->a_tag)
    nta_leg_rtag(ds->ds_leg, sip->sip_to->a_tag);
}

Pekka Pessi's avatar
Pekka Pessi committed
124
/**@internal Store information from remote endpoint. */
125 126 127
void nua_dialog_store_peer_info(nua_owner_t *own, 
				nua_dialog_state_t *ds,
				sip_t const *sip)
128
{
129
  nua_remote_t *nr = ds->ds_remote_ua;
130
  nua_dialog_usage_t *du;
131
  nua_remote_t old[1];
132 133 134

  *old = *nr;

135 136 137 138 139 140 141 142 143 144 145 146 147 148
  if (sip && sip->sip_status &&
      sip->sip_status->st_status >= 300 &&
      sip->sip_status->st_status <= 399)
    sip = NULL;			/* Redirected */

  if (sip == NULL) {
    nr->nr_allow = NULL, su_free(own, old->nr_allow);
    nr->nr_accept = NULL, su_free(own, old->nr_accept);
    nr->nr_require = NULL, su_free(own, old->nr_require);
    nr->nr_supported = NULL, su_free(own, old->nr_supported);
    nr->nr_user_agent = NULL, su_free(own, old->nr_user_agent);
    return;
  }

149
  if (sip->sip_allow) {
150 151
    nr->nr_allow = sip_allow_dup(own, sip->sip_allow);
    su_free(own, old->nr_allow);
152 153 154
  }

  if (sip->sip_accept) {
155 156
    nr->nr_accept = sip_accept_dup(own, sip->sip_accept);
    su_free(own, old->nr_accept);
157 158 159
  }

  if (sip->sip_require) {
160 161
    nr->nr_require = sip_require_dup(own, sip->sip_require);
    su_free(own, old->nr_require);
162 163 164
  }

  if (sip->sip_supported) {
165 166
    nr->nr_supported = sip_supported_dup(own, sip->sip_supported);
    su_free(own, old->nr_supported);
167 168 169
  }

  if (sip->sip_user_agent) {
170 171 172 173 174 175
    nr->nr_user_agent = sip_user_agent_dup(own, sip->sip_user_agent);
    su_free(own, old->nr_user_agent);
  }
  else if (sip->sip_server) {
    nr->nr_user_agent = sip_user_agent_dup(own, sip->sip_server);
    su_free(own, old->nr_user_agent);
176
  }
177 178 179 180 181

  for (du = ds->ds_usage; du; du = du->du_next) {
    if (du->du_class->usage_peer_info)
      du->du_class->usage_peer_info(du, ds, sip);
  }
182 183
}

Pekka Pessi's avatar
Pekka Pessi committed
184
/** @internal Get dialog usage slot. */
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
nua_dialog_usage_t **
nua_dialog_usage_at(nua_dialog_state_t const *ds, 
		    nua_usage_class const *kind,
		    sip_event_t const *event)
{
  static nua_dialog_usage_t *none = NULL;

  if (ds) {
    nua_dialog_usage_t *du, * const * prev;
    sip_event_t const *o;

    for (prev = &ds->ds_usage; (du = *prev); prev = &du->du_next) {
      if (du->du_class != kind)
	continue;

      if (event == NONE)
	return (nua_dialog_usage_t **)prev;

      o = du->du_event;

      if (!event && !o)
	return (nua_dialog_usage_t **)prev;

      if (event != o) {
	if (event == NULL || o == NULL)
	  continue;
	if (strcmp(event->o_type, o->o_type))
	  continue;
	if (str0casecmp(event->o_id, o->o_id))
	  continue;
      }

      return (nua_dialog_usage_t **)prev;
    }
  }

  return &none;
}

Pekka Pessi's avatar
Pekka Pessi committed
224
/** @internal Get a dialog usage */
225 226 227 228 229 230 231
nua_dialog_usage_t *nua_dialog_usage_get(nua_dialog_state_t const *ds, 
					 nua_usage_class const *kind,
					 sip_event_t const *event)
{
  return *nua_dialog_usage_at(ds, kind, event);
}

Pekka Pessi's avatar
Pekka Pessi committed
232
/** @internal Get dialog usage name */
233 234 235 236 237 238 239
char const *nua_dialog_usage_name(nua_dialog_usage_t const *du)
{
  if (du == NULL)
    return "<NULL>";
  return du->du_class->usage_name(du);
} 

Pekka Pessi's avatar
Pekka Pessi committed
240
/** @internal Add dialog usage */
241
nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *own, 
242 243 244 245 246 247 248 249 250 251 252 253
					 struct nua_dialog_state *ds, 
					 nua_usage_class const *uclass,
					 sip_event_t const *event)
{
  if (ds) {
    sip_event_t *o;
    nua_dialog_usage_t *du, **prev_du;

    prev_du = nua_dialog_usage_at(ds, uclass, event);
    du = *prev_du;
    if (du) {		/* Already exists */
      SU_DEBUG_5(("nua(%p): adding already existing %s usage%s%s\n",
254
		  own, nua_dialog_usage_name(du), 
255 256 257 258 259 260 261 262 263 264 265
		  event ? "  with event " : "", event ? event->o_type : ""));
      
      if (prev_du != &ds->ds_usage) {
	/* Move as a first usage in the list */
	*prev_du = du->du_next;
	du->du_next = ds->ds_usage;
	ds->ds_usage = du;
      }
      return du;
    }

266
    o = event ? sip_event_dup(own, event) : NULL;
267 268

    if (o != NULL || event == NULL)
269
      du = su_zalloc(own, sizeof *du + uclass->usage_size);
270 271 272 273 274

    if (du) {
      du->du_class = uclass;
      du->du_event = o;

275 276 277
      if (uclass->usage_add(own, ds, du) < 0) {
	su_free(own, o);
	su_free(own, du);
278 279 280 281
	return NULL;
      }
	
      SU_DEBUG_5(("nua(%p): adding %s usage%s%s\n",
282
		  own, nua_dialog_usage_name(du), 
283 284
		  o ? " with event " : "", o ? o->o_type :""));

285
      su_home_ref(own);
286 287 288 289 290
      du->du_next = ds->ds_usage, ds->ds_usage = du;

      return du;
    }

291
    su_free(own, o);
292 293 294 295 296
  }

  return NULL;
}

Pekka Pessi's avatar
Pekka Pessi committed
297
/** @internal Remove dialog usage. */
298
void nua_dialog_usage_remove(nua_owner_t *own, 
299 300 301 302 303
			     nua_dialog_state_t *ds,
			     nua_dialog_usage_t *du)
{
  nua_dialog_usage_t **at;

304
  assert(own); assert(ds); assert(du);
305 306 307 308 309 310 311

  for (at = &ds->ds_usage; *at; at = &(*at)->du_next)
    if (du == *at)
      break;

  assert(*at);

312
  nua_dialog_usage_remove_at(own, ds, at);
313 314
}

Pekka Pessi's avatar
Pekka Pessi committed
315
/** @internal Remove dialog usage. 
316 317 318 319
 *
 * Zap dialog state (leg, tag and route) if no usages remain. 
*/
static 
320
void nua_dialog_usage_remove_at(nua_owner_t *own, 
321 322 323 324 325 326 327 328 329 330 331 332
				nua_dialog_state_t *ds,
				nua_dialog_usage_t **at)
{
  if (*at) {
    nua_dialog_usage_t *du = *at;
    sip_event_t const *o = NULL;

    *at = du->du_next;

    o = du->du_event;

    SU_DEBUG_5(("nua(%p): removing %s usage%s%s\n",
333
		own, nua_dialog_usage_name(du), 
334
		o ? " with event " : "", o ? o->o_type :""));
335
    du->du_class->usage_remove(own, ds, du);
336
    msg_destroy(du->du_msg);
337 338
    su_home_unref(own);
    su_free(own, du);
339 340 341 342 343
  }

  /* Zap dialog if there is no more usages */
  if (ds->ds_usage == NULL) {
    nta_leg_destroy(ds->ds_leg), ds->ds_leg = NULL;
344
    su_free(own, (void *)ds->ds_remote_tag), ds->ds_remote_tag = NULL;
345 346 347 348 349 350
    ds->ds_route = 0;
    ds->ds_has_events = 0;
    ds->ds_terminated = 0;
    return;
  }
  else if (!ds->ds_terminated) {
351
    nua_dialog_log_usage(own, ds);
352 353 354 355
  }
}

static
356
void nua_dialog_log_usage(nua_owner_t *own, nua_dialog_state_t *ds)
357 358 359
{
  nua_dialog_usage_t *du;

360
  if (SU_LOG->log_level >= 3) {
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
    char buffer[160];
    int l = 0, n, N = sizeof buffer;
    
    buffer[0] = '\0';

    for (du = ds->ds_usage; du; du = du->du_next) {
      msg_header_t const *h = (void *)du->du_event;

      if (!h)
	continue;

      n = sip_event_e(buffer + l, N - l, h, 0);
      if (n == -1)
	break;
      l += n;
      if (du->du_next && l + 2 < sizeof(buffer)) {
	strcpy(buffer + l, ", ");
	l += 2;
      }
    }
    
382
    SU_DEBUG_3(("nua(%p): handle with %s%s%s\n", own,
383 384 385 386 387 388
		ds->ds_has_session ? "session and " : "", 
		ds->ds_has_events ? "events " : "",
		buffer));
  }
}

Pekka Pessi's avatar
Pekka Pessi committed
389
/** @internal Dialog has been terminated. */
390
void nua_dialog_terminated(nua_owner_t *own,
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
			   struct nua_dialog_state *ds,
			   int status,
			   char const *phrase)
{

  ds->ds_terminated = 1;

  while (ds->ds_usage) {
#if 0
    int call = 0;

    if (ds->ds_usage->du_kind == nua_session_usage)
      call = 1;			/* Delay sending the event */
    else
      /* XXX */;
#endif
407
    nua_dialog_usage_remove_at(own, ds, &ds->ds_usage);
408 409 410 411
  }
}


Pekka Pessi's avatar
Pekka Pessi committed
412 413
/**@internal
 * Set refresh value suitably. 
414 415 416 417 418 419 420 421 422 423 424 425 426 427
 *
 * The refresh time is set either at half of the @a delta interval or if @a
 * delta is less than 5 minutes, 30 seconds before end of interval. $
 *
 * If @a delta is 0, the refresh time is set at the end of the world
 * (maximum time, for 32-bit systems sometimes during 2036).
 */
void nua_dialog_usage_set_refresh(nua_dialog_usage_t *du, unsigned delta)
{
  sip_time_t target = sip_now();

  if (delta > 60 && delta < 5 * 60)
    /* refresh 30 seconds before deadline */
    delta -= 30;
Pekka Pessi's avatar
Pekka Pessi committed
428
  else if (delta > 1)
429 430 431
    /* refresh at half time before deadline */
    delta /= 2;

Pekka Pessi's avatar
Pekka Pessi committed
432
  if (delta != 0 && target + delta >= target)
433 434 435 436 437 438
    target = target + delta;
  else
    target = SIP_TIME_MAX;

  du->du_refresh = target;
}
439

Pekka Pessi's avatar
Pekka Pessi committed
440
/** @internal Call the owner operation function. */
441 442 443 444 445 446 447
void nua_dialog_usage_refresh(nua_owner_t *owner,
			      nua_dialog_usage_t *du, 
			      sip_time_t now)
{
  if (du) {
    nh_pending_f *pending = du->du_pending;

Pekka Pessi's avatar
Pekka Pessi committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
    du->du_refresh = 0;

    if (now > 0) {
      if (du->du_class->usage_refresh) {
	du->du_class->usage_refresh(owner, du, now);
	return;
      }
    }
    else {
      du->du_shutdown = 1;
      if (du->du_class->usage_shutdown) {
	du->du_class->usage_shutdown(owner, du);
	return;
      }
    }

464
    du->du_pending = NULL;
Pekka Pessi's avatar
Pekka Pessi committed
465

466 467 468 469 470
    if (pending)
      pending(owner, du, now);
  }
}