nua_dialog.c 9.86 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

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

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

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

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

  if (!established && sip->sip_to->a_tag)
108
    ds->ds_remote_tag = su_strdup(own, sip->sip_to->a_tag);
109 110 111 112 113 114 115 116 117 118 119 120

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

/** Store information from remote endpoint. */
121 122 123
void nua_dialog_store_peer_info(nua_owner_t *own, 
				nua_dialog_state_t *ds,
				sip_t const *sip)
124
{
125 126
  nua_remote_t *nr = ds->ds_remote_ua;
  nua_remote_t old[1];
127 128 129 130

  *old = *nr;

  if (sip->sip_allow) {
131 132
    nr->nr_allow = sip_allow_dup(own, sip->sip_allow);
    su_free(own, old->nr_allow);
133 134 135
  }

  if (sip->sip_accept) {
136 137
    nr->nr_accept = sip_accept_dup(own, sip->sip_accept);
    su_free(own, old->nr_accept);
138 139 140
  }

  if (sip->sip_require) {
141 142
    nr->nr_require = sip_require_dup(own, sip->sip_require);
    su_free(own, old->nr_require);
143 144 145
  }

  if (sip->sip_supported) {
146 147
    nr->nr_supported = sip_supported_dup(own, sip->sip_supported);
    su_free(own, old->nr_supported);
148 149 150
  }

  if (sip->sip_user_agent) {
151 152 153 154 155 156
    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);
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 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
  }
}

/** Get dialog usage slot */
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;
}

/** Get a dialog usage */ 
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);
}

/** Get dialog usage name */
char const *nua_dialog_usage_name(nua_dialog_usage_t const *du)
{
  if (du == NULL)
    return "<NULL>";
  return du->du_class->usage_name(du);
} 

/** Add dialog usage */
217
nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *own, 
218 219 220 221 222 223 224 225 226 227 228 229
					 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",
230
		  own, nua_dialog_usage_name(du), 
231 232 233 234 235 236 237 238 239 240 241
		  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;
    }

242
    o = event ? sip_event_dup(own, event) : NULL;
243 244

    if (o != NULL || event == NULL)
245
      du = su_zalloc(own, sizeof *du + uclass->usage_size);
246 247 248 249 250

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

251 252 253
      if (uclass->usage_add(own, ds, du) < 0) {
	su_free(own, o);
	su_free(own, du);
254 255 256 257
	return NULL;
      }
	
      SU_DEBUG_5(("nua(%p): adding %s usage%s%s\n",
258
		  own, nua_dialog_usage_name(du), 
259 260
		  o ? " with event " : "", o ? o->o_type :""));

261
      su_home_ref(own);
262 263 264 265 266
      du->du_next = ds->ds_usage, ds->ds_usage = du;

      return du;
    }

267
    su_free(own, o);
268 269 270 271 272 273
  }

  return NULL;
}

/** Remove dialog usage. */
274
void nua_dialog_usage_remove(nua_owner_t *own, 
275 276 277 278 279
			     nua_dialog_state_t *ds,
			     nua_dialog_usage_t *du)
{
  nua_dialog_usage_t **at;

280
  assert(own); assert(ds); assert(du);
281 282 283 284 285 286 287

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

  assert(*at);

288
  nua_dialog_usage_remove_at(own, ds, at);
289 290 291 292 293 294 295
}

/** Remove dialog usage.
 *
 * Zap dialog state (leg, tag and route) if no usages remain. 
*/
static 
296
void nua_dialog_usage_remove_at(nua_owner_t *own, 
297 298 299 300 301 302 303 304 305 306 307 308
				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",
309
		own, nua_dialog_usage_name(du), 
310
		o ? " with event " : "", o ? o->o_type :""));
311
    du->du_class->usage_remove(own, ds, du);
312
    msg_destroy(du->du_msg);
313 314
    su_home_unref(own);
    su_free(own, du);
315 316 317 318 319
  }

  /* Zap dialog if there is no more usages */
  if (ds->ds_usage == NULL) {
    nta_leg_destroy(ds->ds_leg), ds->ds_leg = NULL;
320
    su_free(own, (void *)ds->ds_remote_tag), ds->ds_remote_tag = NULL;
321 322 323 324 325 326
    ds->ds_route = 0;
    ds->ds_has_events = 0;
    ds->ds_terminated = 0;
    return;
  }
  else if (!ds->ds_terminated) {
327
    nua_dialog_log_usage(own, ds);
328 329 330 331
  }
}

static
332
void nua_dialog_log_usage(nua_owner_t *own, nua_dialog_state_t *ds)
333 334 335
{
  nua_dialog_usage_t *du;

336
  if (SU_LOG->log_level >= 3) {
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
    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;
      }
    }
    
358
    SU_DEBUG_3(("nua(%p): handle with %s%s%s\n", own,
359 360 361 362 363 364 365
		ds->ds_has_session ? "session and " : "", 
		ds->ds_has_events ? "events " : "",
		buffer));
  }
}

/** Dialog has been terminated. */
366
void nua_dialog_terminated(nua_owner_t *own,
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
			   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
383
    nua_dialog_usage_remove_at(own, ds, &ds->ds_usage);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
  }
}


/** Set refresh value suitably.
 *
 * 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
403
  else if (delta > 1)
404 405 406
    /* refresh at half time before deadline */
    delta /= 2;

Pekka Pessi's avatar
Pekka Pessi committed
407
  if (delta != 0 && target + delta >= target)
408 409 410 411 412 413
    target = target + delta;
  else
    target = SIP_TIME_MAX;

  du->du_refresh = target;
}