osip_transaction.c 25.7 KB
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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 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 217 218 219 220 221 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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 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 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001-2020 Aymeric MOIZARD amoizard@antisip.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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#include <osip2/internal.h>
#include <osip2/osip.h>

#include "fsm.h"
#include "xixt.h"

extern osip_statemachine_t ict_fsm;
extern osip_statemachine_t ist_fsm;
extern osip_statemachine_t nict_fsm;
extern osip_statemachine_t nist_fsm;

int osip_id_mutex_lock(osip_t *osip);
int osip_id_mutex_unlock(osip_t *osip);

static int __osip_transaction_set_topvia(osip_transaction_t *transaction, osip_via_t *topvia);
static int __osip_transaction_set_from(osip_transaction_t *transaction, osip_from_t *from);
static int __osip_transaction_set_to(osip_transaction_t *transaction, osip_to_t *to);
static int __osip_transaction_set_call_id(osip_transaction_t *transaction, osip_call_id_t *call_id);
static int __osip_transaction_set_cseq(osip_transaction_t *transaction, osip_cseq_t *cseq);

static int __osip_transaction_set_topvia(osip_transaction_t *transaction, osip_via_t *topvia) {
  int i;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  i = osip_via_clone(topvia, &(transaction->topvia));

  if (i == 0)
    return OSIP_SUCCESS;

  transaction->topvia = NULL;
  return i;
}

static int __osip_transaction_set_from(osip_transaction_t *transaction, osip_from_t *from) {
  int i;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  i = osip_from_clone(from, &(transaction->from));

  if (i == 0)
    return OSIP_SUCCESS;

  transaction->from = NULL;
  return i;
}

static int __osip_transaction_set_to(osip_transaction_t *transaction, osip_to_t *to) {
  int i;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  i = osip_to_clone(to, &(transaction->to));

  if (i == 0)
    return OSIP_SUCCESS;

  transaction->to = NULL;
  return i;
}

static int __osip_transaction_set_call_id(osip_transaction_t *transaction, osip_call_id_t *call_id) {
  int i;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  i = osip_call_id_clone(call_id, &(transaction->callid));

  if (i == 0)
    return OSIP_SUCCESS;

  transaction->callid = NULL;
  return i;
}

static int __osip_transaction_set_cseq(osip_transaction_t *transaction, osip_cseq_t *cseq) {
  int i;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  i = osip_cseq_clone(cseq, &(transaction->cseq));

  if (i == 0)
    return OSIP_SUCCESS;

  transaction->cseq = NULL;
  return i;
}

int osip_transaction_init(osip_transaction_t **transaction, osip_fsm_type_t ctx_type, osip_t *osip, osip_message_t *request) {
  osip_via_t *topvia;

  int i;

  *transaction = NULL;

  if (request == NULL)
    return OSIP_BADPARAMETER;

  if (request->call_id == NULL)
    return OSIP_BADPARAMETER;

  if (request->call_id->number == NULL)
    return OSIP_BADPARAMETER;

  *transaction = (osip_transaction_t *) osip_malloc(sizeof(osip_transaction_t));

  if (*transaction == NULL)
    return OSIP_NOMEM;

  memset(*transaction, 0, sizeof(osip_transaction_t));

  (*transaction)->birth_time = osip_getsystemtime(NULL);
  osip_gettimeofday(&((*transaction)->created_time), NULL);
  osip_id_mutex_lock(osip);
  (*transaction)->transactionid = osip->transactionid++;
  osip_id_mutex_unlock(osip);
  OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO2, NULL, "allocating transaction resource %i %s\n", (*transaction)->transactionid, request->call_id->number));

  /* those lines must be called before "osip_transaction_free" */
  (*transaction)->ctx_type = ctx_type;
  (*transaction)->ict_context = NULL;
  (*transaction)->ist_context = NULL;
  (*transaction)->nict_context = NULL;
  (*transaction)->nist_context = NULL;
  (*transaction)->config = osip;

  topvia = osip_list_get(&request->vias, 0);

  if (topvia == NULL) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return OSIP_SYNTAXERROR;
  }

  i = __osip_transaction_set_topvia(*transaction, topvia);

  if (i != 0) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return i;
  }

  /* In some situation, some of those informtions might
     be useless. Mostly, I prefer to keep them in all case
     for backward compatibility. */
  i = __osip_transaction_set_from(*transaction, request->from);

  if (i != 0) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return i;
  }

  i = __osip_transaction_set_to(*transaction, request->to);

  if (i != 0) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return i;
  }

  i = __osip_transaction_set_call_id(*transaction, request->call_id);

  if (i != 0) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return i;
  }

  i = __osip_transaction_set_cseq(*transaction, request->cseq);

  if (i != 0) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return i;
  }

  /* RACE conditions can happen for server transactions */
  /* (*transaction)->orig_request = request; */
  (*transaction)->orig_request = NULL;

  (*transaction)->transactionff = (osip_fifo_t *) osip_malloc(sizeof(osip_fifo_t));

  if ((*transaction)->transactionff == NULL) {
    osip_transaction_free(*transaction);
    *transaction = NULL;
    return OSIP_NOMEM;
  }

  osip_fifo_init((*transaction)->transactionff);

  if (ctx_type == ICT) {
    (*transaction)->state = ICT_PRE_CALLING;
    i = __osip_ict_init(&((*transaction)->ict_context), osip, request);

    if (i != 0) {
      osip_transaction_free(*transaction);
      *transaction = NULL;
      return i;
    }

    __osip_add_ict(osip, *transaction);

  } else if (ctx_type == IST) {
    (*transaction)->state = IST_PRE_PROCEEDING;
    i = __osip_ist_init(&((*transaction)->ist_context), osip, request);

    if (i != 0) {
      osip_transaction_free(*transaction);
      *transaction = NULL;
      return i;
    }

    __osip_add_ist(osip, *transaction);

  } else if (ctx_type == NICT) {
    (*transaction)->state = NICT_PRE_TRYING;
    i = __osip_nict_init(&((*transaction)->nict_context), osip, request);

    if (i != 0) {
      osip_transaction_free(*transaction);
      *transaction = NULL;
      return i;
    }

    __osip_add_nict(osip, *transaction);

  } else {
    (*transaction)->state = NIST_PRE_TRYING;
    i = __osip_nist_init(&((*transaction)->nist_context), osip, request);

    if (i != 0) {
      osip_transaction_free(*transaction);
      *transaction = NULL;
      return i;
    }

    __osip_add_nist(osip, *transaction);
  }

  return OSIP_SUCCESS;
}

/* This method automaticly remove the transaction context from
   the osip stack. This task is required for proper operation
   when a transaction goes in the TERMINATED STATE.
   However the user might want to just take the context out of
   the SIP stack andf keep it for future use without freeing
   all resource.... This way the transaction context can be
   kept without being used by the oSIP stack.

   new methods that replace this one:
   osip_remove_transaction
   +
   osip_transaction_free2();

 */
int osip_transaction_free(osip_transaction_t *transaction) {
  int i;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  i = osip_remove_transaction(transaction->config, transaction);

  if (i != 0) { /* yet removed ??? */
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO4, NULL, "transaction already removed from list %i!\n", transaction->transactionid));
  }

  return osip_transaction_free2(transaction);
}

/* same as osip_transaction_free() but assume the transaction is
   already removed from the list of transaction in the osip stack */
int osip_transaction_free2(osip_transaction_t *transaction) {
  osip_event_t *evt;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  if (transaction->orig_request != NULL && transaction->orig_request->call_id != NULL && transaction->orig_request->call_id->number != NULL) {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO2, NULL, "free transaction resource %i %s\n", transaction->transactionid, transaction->orig_request->call_id->number));
  }

  if (transaction->ctx_type == ICT) {
    __osip_ict_free(transaction->ict_context);

  } else if (transaction->ctx_type == IST) {
    __osip_ist_free(transaction->ist_context);

  } else if (transaction->ctx_type == NICT) {
    __osip_nict_free(transaction->nict_context);

  } else {
    __osip_nist_free(transaction->nist_context);
  }

  /* empty the fifo */
  if (transaction->transactionff != NULL) {
    evt = osip_fifo_tryget(transaction->transactionff);

    while (evt != NULL) {
      osip_message_free(evt->sip);
      osip_free(evt);
      evt = osip_fifo_tryget(transaction->transactionff);
    }

    osip_fifo_free(transaction->transactionff);
  }

  osip_message_free(transaction->orig_request);
  osip_message_free(transaction->last_response);
  osip_message_free(transaction->ack);

  osip_via_free(transaction->topvia);
  osip_from_free(transaction->from);
  osip_to_free(transaction->to);
  osip_call_id_free(transaction->callid);
  osip_cseq_free(transaction->cseq);

  osip_free(transaction);
  return OSIP_SUCCESS;
}

int osip_transaction_add_event(osip_transaction_t *transaction, osip_event_t *evt) {
  if (evt == NULL)
    return OSIP_BADPARAMETER;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  evt->transactionid = transaction->transactionid;
  osip_fifo_add(transaction->transactionff, evt);
  return OSIP_SUCCESS;
}

int osip_transaction_execute(osip_transaction_t *transaction, osip_event_t *evt) {
  osip_statemachine_t *statemachine;

  /* to kill the process, simply send this type of event. */
  if (EVT_IS_KILL_TRANSACTION(evt)) {
    /* MAJOR CHANGE!
       TRANSACTION MUST NOW BE RELEASED BY END-USER:
       So Any usefull data can be save and re-used */
    /* osip_transaction_free(transaction);
       osip_free(transaction); */
    osip_free(evt);
    return OSIP_SUCCESS;
  }

  OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO4, NULL, "sipevent tr->transactionid: %i\n", transaction->transactionid));
  OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO4, NULL, "sipevent tr->state: %i\n", transaction->state));
  OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO4, NULL, "sipevent evt->type: %i\n", evt->type));
  OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO4, NULL, "sipevent evt->sip: %x\n", evt->sip));

  if (transaction->ctx_type == ICT)
    statemachine = &ict_fsm;

  else if (transaction->ctx_type == IST)
    statemachine = &ist_fsm;

  else if (transaction->ctx_type == NICT)
    statemachine = &nict_fsm;

  else
    statemachine = &nist_fsm;

  if (0 != fsm_callmethod(evt->type, transaction->state, statemachine, evt, transaction)) {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO3, NULL, "USELESS event!\n"));

    /* message is useless. */
    if (EVT_IS_MSG(evt)) {
      if (evt->sip != NULL) {
        osip_message_free(evt->sip);
      }
    }

  } else {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_INFO4, NULL, "sipevent evt: method called!\n"));
  }

  osip_free(evt); /* this is the ONLY place for freeing event!! */
  return 1;
}

int osip_transaction_get_destination(osip_transaction_t *transaction, char **ip, int *port) {
  *ip = NULL;
  *port = 0;

  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  if (transaction->ict_context != NULL) {
    *ip = transaction->ict_context->destination;
    *port = transaction->ict_context->port;
    return OSIP_SUCCESS;

  } else if (transaction->nict_context != NULL) {
    *ip = transaction->nict_context->destination;
    *port = transaction->nict_context->port;
    return OSIP_SUCCESS;
  }

  return OSIP_UNDEFINED_ERROR;
}

int osip_transaction_set_srv_record(osip_transaction_t *transaction, osip_srv_record_t *record) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  memcpy(&transaction->record, record, sizeof(osip_srv_record_t));
  return OSIP_SUCCESS;
}

int osip_transaction_set_naptr_record(osip_transaction_t *transaction, osip_naptr_t *record) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->naptr_record = record;
  return OSIP_SUCCESS;
}

int osip_transaction_set_your_instance(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved1 = ptr;
  return OSIP_SUCCESS;
}

int osip_transaction_set_reserved1(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved1 = ptr;
  return OSIP_SUCCESS;
}

int osip_transaction_set_reserved2(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved2 = ptr;
  return OSIP_SUCCESS;
}

int osip_transaction_set_reserved3(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved3 = ptr;
  return OSIP_SUCCESS;
}

int osip_transaction_set_reserved4(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved4 = ptr;
  return OSIP_SUCCESS;
}

int osip_transaction_set_reserved5(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved5 = ptr;
  return OSIP_SUCCESS;
}

int osip_transaction_set_reserved6(osip_transaction_t *transaction, void *ptr) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->reserved6 = ptr;
  return OSIP_SUCCESS;
}

void *osip_transaction_get_your_instance(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved1;
}

void *osip_transaction_get_reserved1(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved1;
}

void *osip_transaction_get_reserved2(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved2;
}

void *osip_transaction_get_reserved3(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved3;
}

void *osip_transaction_get_reserved4(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved4;
}

void *osip_transaction_get_reserved5(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved5;
}

void *osip_transaction_get_reserved6(osip_transaction_t *transaction) {
  if (transaction == NULL)
    return NULL;

  return transaction->reserved6;
}

int __osip_transaction_set_state(osip_transaction_t *transaction, state_t state) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->state = state;
  return OSIP_SUCCESS;
}

int osip_transaction_set_in_socket(osip_transaction_t *transaction, int sock) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->in_socket = sock;
  return OSIP_SUCCESS;
}

int osip_transaction_set_out_socket(osip_transaction_t *transaction, int sock) {
  if (transaction == NULL)
    return OSIP_BADPARAMETER;

  transaction->out_socket = sock;
  return OSIP_SUCCESS;
}

int __osip_transaction_matching_response_osip_to_xict_17_1_3(osip_transaction_t *tr, osip_message_t *response) {
  osip_generic_param_t *b_request;
  osip_generic_param_t *b_response;
  osip_via_t *topvia_response;

  /* some checks to avoid crashing on bad requests */
  if (tr == NULL || (tr->ict_context == NULL && tr->nict_context == NULL) ||
      /* only ict and nict can match a response */
      response == NULL || response->cseq == NULL || response->cseq->method == NULL)
    return OSIP_BADPARAMETER;

  topvia_response = osip_list_get(&response->vias, 0);

  if (topvia_response == NULL) {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_ERROR, NULL, "Remote UA is not compliant: missing a Via header!\n"));
    return OSIP_SYNTAXERROR;
  }

  osip_via_param_get_byname(tr->topvia, "branch", &b_request);

  if (b_request == NULL) {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_BUG, NULL, "You created a transaction without any branch! THIS IS NOT ALLOWED\n"));
    return OSIP_SYNTAXERROR;
  }

  osip_via_param_get_byname(topvia_response, "branch", &b_response);

  if (b_response == NULL) {
#ifdef FWDSUPPORT

    /* the from tag (unique) */
    if (from_tag_match(tr->from, response->from) != 0)
      return OSIP_UNDEFINED_ERROR;

    /* the Cseq field */
    if (cseq_match(tr->cseq, response->cseq) != 0)
      return OSIP_UNDEFINED_ERROR;

    /* the To field */
    if (response->to->url->username == NULL && tr->from->url->username != NULL)
      return OSIP_UNDEFINED_ERROR;

    if (response->to->url->username != NULL && tr->from->url->username == NULL)
      return OSIP_UNDEFINED_ERROR;

    if (response->to->url->username != NULL && tr->from->url->username != NULL) {
      if (strcmp(response->to->url->host, tr->from->url->host) || strcmp(response->to->url->username, tr->from->url->username))
        return OSIP_UNDEFINED_ERROR;

    } else {
      if (strcmp(response->to->url->host, tr->from->url->host))
        return OSIP_UNDEFINED_ERROR;
    }

    /* the Call-ID field */
    if (call_id_match(tr->callid, response->call_id) != 0)
      return OSIP_UNDEFINED_ERROR;

    return OSIP_SUCCESS;
#else
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_BUG, NULL, "Remote UA is not compliant: missing a branch parameter in  Via header!\n"));
    return OSIP_SYNTAXERROR;
#endif
  }

  if ((b_request->gvalue == NULL) || (b_response->gvalue == NULL)) {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_BUG, NULL, "Remote UA is not compliant: missing a branch parameter in  Via header!\n"));
    return OSIP_SYNTAXERROR;
  }

  /*
     A response matches a client transaction under two
     conditions:

     1.   If the response has the same value of the branch parameter
     in the top Via header field as the branch parameter in the
     top Via header field of the request that created the
     transaction.
   */
  if (0 != strcmp(b_request->gvalue, b_response->gvalue))
    return OSIP_UNDEFINED_ERROR;

  /*
     2.   If the method parameter in the CSeq header field matches
     the method of the request that created the transaction. The
     method is needed since a CANCEL request constitutes a
     different transaction, but shares the same value of the
     branch parameter.
     AMD NOTE: cseq->method is ALWAYS the same than the METHOD of the request.
   */
  if (0 == strcmp(response->cseq->method, tr->cseq->method)) /* general case */
    return OSIP_SUCCESS;

  return OSIP_UNDEFINED_ERROR;
}

int __osip_transaction_matching_request_osip_to_xist_17_2_3(osip_transaction_t *tr, osip_message_t *request) {
  osip_generic_param_t *b_origrequest;
  osip_generic_param_t *b_request;
  osip_via_t *topvia_request;
  size_t length_br;
  size_t length_br2;

  /* some checks to avoid crashing on bad requests */
  if (tr == NULL || (tr->ist_context == NULL && tr->nist_context == NULL) ||
      /* only ist and nist can match a request */
      request == NULL || request->cseq == NULL || request->cseq->method == NULL)
    return OSIP_BADPARAMETER;

  topvia_request = osip_list_get(&request->vias, 0);

  if (topvia_request == NULL) {
    OSIP_TRACE(osip_trace(__FILE__, __LINE__, OSIP_ERROR, NULL, "Remote UA is not compliant: missing a Via header!\n"));
    return OSIP_SYNTAXERROR;
  }

  osip_via_param_get_byname(topvia_request, "branch", &b_request);
  osip_via_param_get_byname(tr->topvia, "branch", &b_origrequest);

  if ((b_origrequest == NULL && b_request != NULL) || (b_origrequest != NULL && b_request == NULL))
    return OSIP_SYNTAXERROR; /* one request is compliant, the other one is not... */

  /* Section 17.2.3 Matching Requests to Server Transactions:
     "The branch parameter in the topmost Via header field of the request
     is examined. If it is present and begins with the magic cookie
     "z9hG4bK", the request was generated by a client transaction
     compliant to this specification."
   */

  if (b_origrequest != NULL && b_request != NULL)
  /* case where both request contains a branch */
  {
    if (!b_origrequest->gvalue)
      return OSIP_UNDEFINED_ERROR;

    if (!b_request->gvalue)
      return OSIP_UNDEFINED_ERROR;

    length_br = strlen(b_origrequest->gvalue);
    length_br2 = strlen(b_request->gvalue);

    if (length_br != length_br2)
      return OSIP_UNDEFINED_ERROR;

    /* can't be the same */
    if (0 == strncmp(b_origrequest->gvalue, "z9hG4bK", 7) && 0 == strncmp(b_request->gvalue, "z9hG4bK", 7)) {
      /* both request comes from a compliant UA */
      /* The request matches a transaction if the branch parameter
         in the request is equal to the one in the top Via header
         field of the request that created the transaction, the
         sent-by value in the top Via of the request is equal to
         the one in the request that created the transaction, and in
         the case of a CANCEL request, the method of the request
         that created the transaction was also CANCEL.
       */
      if (0 != strcmp(b_origrequest->gvalue, b_request->gvalue))
        return OSIP_UNDEFINED_ERROR; /* branch param does not match */

      {
        /* check the sent-by values */
        char *b_port = via_get_port(topvia_request);
        char *b_origport = via_get_port(tr->topvia);
        char *b_host = via_get_host(topvia_request);
        char *b_orighost = via_get_host(tr->topvia);

        if ((b_host == NULL || b_orighost == NULL))
          return OSIP_UNDEFINED_ERROR;

        if (0 != strcmp(b_orighost, b_host))
          return OSIP_UNDEFINED_ERROR;

        if (b_port != NULL && b_origport == NULL && 0 != strcmp(b_port, "5060"))
          return OSIP_UNDEFINED_ERROR;

        else if (b_origport != NULL && b_port == NULL && 0 != strcmp(b_origport, "5060"))
          return OSIP_UNDEFINED_ERROR;

        else if (b_origport != NULL && b_port != NULL && 0 != strcmp(b_origport, b_port))
          return OSIP_UNDEFINED_ERROR;
      }
#ifdef AC_BUG

      /* audiocodes bug (MP108-fxs-SIP-4-0-282-380) */
      if (0 != osip_from_tag_match(tr->from, request->from))
        return OSIP_UNDEFINED_ERROR;

#endif

      if (/* MSG_IS_CANCEL(request)&& <<-- BUG from the spec?
                                   I always check the CSeq */
          (!(0 == strcmp(tr->cseq->method, "INVITE") && 0 == strcmp(request->cseq->method, "ACK"))) && 0 != strcmp(tr->cseq->method, request->cseq->method))
        return OSIP_UNDEFINED_ERROR;

      return OSIP_SUCCESS;
    }
  }

  /* Back to the old backward compatibilty mechanism for matching requests */
  if (0 != osip_call_id_match(tr->callid, request->call_id))
    return OSIP_UNDEFINED_ERROR;

  if (MSG_IS_ACK(request)) {
    osip_generic_param_t *tag_from1;
    osip_generic_param_t *tag_from2;

    osip_from_param_get_byname(tr->to, "tag", &tag_from1);
    osip_from_param_get_byname(request->to, "tag", &tag_from2);

    if (tag_from1 == NULL && tag_from2 != NULL) {
      /* do not check it as it can be a new tag when the final
                                                             answer has a tag while an INVITE doesn't have one */
    } else if (tag_from1 != NULL && tag_from2 == NULL) {
      return OSIP_UNDEFINED_ERROR;

    } else {
      if (0 != osip_to_tag_match(tr->to, request->to))
        return OSIP_UNDEFINED_ERROR;
    }

  } else {
    if (tr->orig_request == NULL || tr->orig_request->to == NULL)
      return OSIP_UNDEFINED_ERROR;

    if (0 != osip_to_tag_match(tr->orig_request->to, request->to))
      return OSIP_UNDEFINED_ERROR;
  }

  if (0 != osip_from_tag_match(tr->from, request->from))
    return OSIP_UNDEFINED_ERROR;

  if (0 != osip_cseq_match(tr->cseq, request->cseq))
    return OSIP_UNDEFINED_ERROR;

  if (0 != osip_via_match(tr->topvia, topvia_request))
    return OSIP_UNDEFINED_ERROR;

  return OSIP_SUCCESS;
}

osip_event_t *__osip_transaction_need_timer_x_event(void *xixt, struct timeval *timer, int cond_state, int transactionid, int TIMER_VAL) {
  struct timeval now;

  osip_gettimeofday(&now, NULL);

  if (xixt == NULL)
    return NULL;

  if (cond_state) {
    if (timer->tv_sec == -1)
      return NULL;

    if (osip_timercmp(&now, timer, >=))
      return __osip_event_new(TIMER_VAL, transactionid);
  }

  return NULL;
}

int __osip_transaction_snd_xxx(osip_transaction_t *ist, osip_message_t *msg) {
  osip_t *osip = (osip_t *) ist->config;
  osip_via_t *via;
  char *host;
  int port;
  osip_generic_param_t *maddr;
  osip_generic_param_t *received;
  osip_generic_param_t *rport;

  via = (osip_via_t *) osip_list_get(&msg->vias, 0);

  if (!via)
    return OSIP_SYNTAXERROR;

  osip_via_param_get_byname(via, "maddr", &maddr);
  osip_via_param_get_byname(via, "received", &received);
  osip_via_param_get_byname(via, "rport", &rport);

  /* 1: user should not use the provided information
     (host and port) if they are using a reliable
     transport. Instead, they should use the already
     open socket attached to this transaction. */
  /* 2: check maddr and multicast usage */
  if (maddr != NULL)
    host = maddr->gvalue;

  /* we should check if this is a multicast address and use
     set the "ttl" in this case. (this must be done in the
     UDP message (not at the SIP layer) */
  else if (received != NULL)
    host = received->gvalue;

  else
    host = via->host;

  if (rport == NULL || rport->gvalue == NULL) {
    if (via->port != NULL)
      port = osip_atoi(via->port);

    else
      port = 5060;

  } else
    port = osip_atoi(rport->gvalue);

  return osip->cb_send_message(ist, msg, host, port, ist->out_socket);
}