nua_dialog.c 12.5 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
/*
 * 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>
43
#include <sofia-sip/su_uniqueid.h>
44 45

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

#define NUA_OWNER_T su_home_t

49 50
#include "nua_dialog.h"

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

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

58 59 60
/* ======================================================================== */
/* Dialog handling */

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

65 66
/**@internal
 * UAS tag and route.
67 68 69 70
 *
 * Update dialog tags and route on the UAS side.
 *
 * @param own  dialog owner
71
 * @param ds   dialog state
72 73 74 75 76 77 78
 * @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)
79 80 81 82
{
  int established = nua_dialog_is_established(ds);

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

  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);
}

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

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

  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);
}

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

  *old = *nr;

136 137 138 139 140 141 142 143 144 145 146 147 148 149
  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;
  }

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

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

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

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

  if (sip->sip_user_agent) {
171 172 173 174 175 176
    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);
177
  }
178 179 180 181 182

  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);
  }
183 184
}

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
/** Remove dialog (if there is no other usages). */
int nua_dialog_remove(nua_owner_t *own,
		      nua_dialog_state_t *ds,
		      nua_dialog_usage_t *usage)
{
  if (ds->ds_usage == usage && (usage == NULL || usage->du_next == NULL)) {
    nua_dialog_store_peer_info(own, ds, NULL); /* zap peer info */
    nta_leg_destroy(ds->ds_leg), ds->ds_leg = NULL;
    su_free(own, (void *)ds->ds_remote_tag), ds->ds_remote_tag = NULL;
    ds->ds_route = 0;
  }
  return 0;
}


200
/** @internal Get dialog usage slot. */
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
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;
}

240
/** @internal Get a dialog usage */
241 242 243 244 245 246 247
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);
}

248
/** @internal Get dialog usage name */
249 250 251 252 253 254 255
char const *nua_dialog_usage_name(nua_dialog_usage_t const *du)
{
  if (du == NULL)
    return "<NULL>";
  return du->du_class->usage_name(du);
} 

256
/** @internal Add dialog usage */
257
nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *own, 
258 259 260 261 262 263 264 265 266 267 268 269
					 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",
270
		  own, nua_dialog_usage_name(du), 
271 272 273 274 275 276 277 278 279 280 281
		  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;
    }

282
    o = event ? sip_event_dup(own, event) : NULL;
283 284

    if (o != NULL || event == NULL)
285
      du = su_zalloc(own, sizeof *du + uclass->usage_size);
286 287 288 289 290

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

291 292 293
      if (uclass->usage_add(own, ds, du) < 0) {
	su_free(own, o);
	su_free(own, du);
294 295 296 297
	return NULL;
      }
	
      SU_DEBUG_5(("nua(%p): adding %s usage%s%s\n",
298
		  own, nua_dialog_usage_name(du), 
299 300
		  o ? " with event " : "", o ? o->o_type :""));

301
      su_home_ref(own);
302 303 304 305 306
      du->du_next = ds->ds_usage, ds->ds_usage = du;

      return du;
    }

307
    su_free(own, o);
308 309 310 311 312
  }

  return NULL;
}

313
/** @internal Remove dialog usage. */
314
void nua_dialog_usage_remove(nua_owner_t *own, 
315 316 317 318 319
			     nua_dialog_state_t *ds,
			     nua_dialog_usage_t *du)
{
  nua_dialog_usage_t **at;

320
  assert(own); assert(ds); assert(du);
321 322 323 324 325 326 327

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

  assert(*at);

328
  nua_dialog_usage_remove_at(own, ds, at);
329 330
}

331
/** @internal Remove dialog usage. 
332 333 334 335
 *
 * Zap dialog state (leg, tag and route) if no usages remain. 
*/
static 
336
void nua_dialog_usage_remove_at(nua_owner_t *own, 
337 338 339 340 341 342 343 344 345 346 347 348
				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",
349
		own, nua_dialog_usage_name(du), 
350
		o ? " with event " : "", o ? o->o_type :""));
351
    du->du_class->usage_remove(own, ds, du);
352
    msg_destroy(du->du_msg);
353 354
    su_home_unref(own);
    su_free(own, du);
355 356 357 358 359
  }

  /* Zap dialog if there is no more usages */
  if (ds->ds_usage == NULL) {
    nta_leg_destroy(ds->ds_leg), ds->ds_leg = NULL;
360
    su_free(own, (void *)ds->ds_remote_tag), ds->ds_remote_tag = NULL;
361 362 363 364 365 366
    ds->ds_route = 0;
    ds->ds_has_events = 0;
    ds->ds_terminated = 0;
    return;
  }
  else if (!ds->ds_terminated) {
367
    nua_dialog_log_usage(own, ds);
368 369 370 371
  }
}

static
372
void nua_dialog_log_usage(nua_owner_t *own, nua_dialog_state_t *ds)
373 374 375
{
  nua_dialog_usage_t *du;

376
  if (SU_LOG->log_level >= 3) {
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    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;
      }
    }
    
398
    SU_DEBUG_3(("nua(%p): handle with %s%s%s\n", own,
399 400 401 402 403 404
		ds->ds_has_session ? "session and " : "", 
		ds->ds_has_events ? "events " : "",
		buffer));
  }
}

405
/** @internal Dialog has been terminated. */
406
void nua_dialog_terminated(nua_owner_t *own,
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
			   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
423
    nua_dialog_usage_remove_at(own, ds, &ds->ds_usage);
424 425 426 427
  }
}


428 429
/**@internal
 * Set refresh value suitably. 
430
 *
431 432 433
 * The refresh time is set either around half of the @a delta interval or,
 * if @a delta is less than 5 minutes but longer than 90 seconds, 30..60
 * seconds before end of interval.
434 435 436 437 438 439
 *
 * 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)
{
440 441 442
  if (delta == 0)
    du->du_refresh = SIP_TIME_MAX;
  else if (delta > 90 && delta < 5 * 60)
443
    /* refresh 30..60 seconds before deadline */
444 445
    nua_dialog_usage_refresh_range(du, delta - 60, delta - 30);
  else 
446
    /* refresh around half time before deadline */
447 448
    nua_dialog_usage_refresh_range(du, delta / 4, delta / 2 + delta / 4);
}
449

450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
/**@internal Set refresh in range min..max seconds in the future. */
void nua_dialog_usage_refresh_range(nua_dialog_usage_t *du, 
				    unsigned min, unsigned max)
{
  sip_time_t now = sip_now(), target;
  unsigned delta;

  if (max < min)
    max = min;

  if (min != max)
    delta = su_randint(min, max);
  else
    delta = min;

  if (now + delta >= now)
    target = now + delta;
467 468 469
  else
    target = SIP_TIME_MAX;

470 471 472
  SU_DEBUG_7(("nua(): refresh %s after %lu seconds (in [%u..%u])\n",
	      nua_dialog_usage_name(du), target - now, min, max));

473 474
  du->du_refresh = target;
}
475

476 477 478 479 480 481 482
/**@internal Do not refresh. */
void nua_dialog_usage_no_refresh(nua_dialog_usage_t *du)
{
  du->du_refresh = 0;
}

/** @internal Refresh usage or shutdown usage if @a now is 0. */
483 484 485 486 487 488 489
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;

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
    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;
      }
    }

506
    du->du_pending = NULL;
507

508 509 510 511 512
    if (pending)
      pending(owner, du, now);
  }
}