osip_port.c 30.8 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 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
/*
  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
*/

#ifdef _WIN32_WCE
#define _INC_TIME /* for wce.h */
#include <windows.h>
#endif

#include <osipparser2/internal.h>

#include <osipparser2/osip_port.h>

#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif

#ifdef HAVE_CTYPE_H
#include <ctype.h>
#endif

#if defined(HAVE_STDARG_H)
#include <stdarg.h>
#define VA_START(a, f) va_start(a, f)
#else
#if defined(HAVE_VARARGS_H)
#include <varargs.h>
#define VA_START(a, f) va_start(a)
#else
#include <stdarg.h>
#define VA_START(a, f) va_start(a, f)
#endif
#endif

#if defined(__PALMOS__) && (__PALMOS__ < 0x06000000)
#include <TimeMgr.h>
#include <SysUtils.h>
#include <SystemMgr.h>
#include <StringMgr.h>
#else
#include <time.h>
#endif

#if defined(__VXWORKS_OS__)
#include <selectLib.h>

/* needed for snprintf replacement */
#include <vxWorks.h>
#include <fioLib.h>
#include <string.h>

#elif defined(__PALMOS__)
#if __PALMOS__ >= 0x06000000
#include <sys/time.h>
#include <SysThread.h>
#endif
#elif (!defined(WIN32) && !defined(_WIN32_WCE))
#include <sys/time.h>
#elif defined(WIN32)
#include <windows.h>
#if (_MSC_VER >= 1700) && !defined(_USING_V110_SDK71_)
#if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP)
#include <winsock2.h>
#elif defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_PC_APP)
#endif
#endif

#ifdef WIN32_USE_CRYPTO
#include <Wincrypt.h>
#endif
#endif

#if defined(__rtems__)
#include <rtems.h>
#endif

#if defined(HAVE_SYS_UNISTD_H)
#include <sys/unistd.h>
#endif

#if defined(HAVE_UNISTD_H)
#include <unistd.h>
#endif

#if defined(HAVE_SYSLOG_H) && !defined(__arc__)
#include <syslog.h>
#endif

#if defined(HAVE_SYS_SELECT_H)
#include <sys/select.h>
#endif

#ifdef HAVE_PTH_PTHREAD_H
#include <pthread.h>
#endif

#if defined(__arc__)
#define HAVE_LRAND48
#endif

FILE *logfile = NULL;
int tracing_table[END_TRACE_LEVEL];
static int use_syslog = 0;
static osip_trace_func_t *trace_func = 0;

static unsigned int random_seed_set = 0;

#ifndef MINISIZE
#if !defined(WIN32) && !defined(_WIN32_WCE)
osip_malloc_func_t *osip_malloc_func = 0;
osip_realloc_func_t *osip_realloc_func = 0;
osip_free_func_t *osip_free_func = 0;
#endif
#endif

const char *osip_error_table[] = {
    "success",       "undefined error", "bad parameter",   "wrong state", "allocation failure", "syntax error", "not found", "api not initialized", "undefined", "undefined", "no network", /* -10 */
    "busy port",     "unknown host",    "undefined",       "undefined",   "undefined",          "undefined",    "undefined", "undefined",           "undefined", "undefined", "undefined",
    "undefined",     "undefined",       "undefined",       "undefined",   "undefined",          "undefined",    "undefined", "undefined",           "disk full",              /* -30 */
    "no rights",     "file not found",  "undefined",       "undefined",   "undefined",          "undefined",    "undefined", "undefined",           "undefined", "undefined", /* -40 */
    "undefined",     "undefined",       "undefined",       "undefined",   "undefined",          "undefined",    "undefined", "undefined",           "undefined", "time out",  /* -50 */
    "too much call", "wrong format",    "no common codec", "undefined",   "undefined",          "undefined",    "undefined", "undefined",           "undefined", "undefined", /* -60 */
};

const char *osip_strerror(int err) {
  if (err > 0)
    return osip_error_table[0];

  if (err > -60)
    return osip_error_table[-err];

  return osip_error_table[59];
}

#ifndef WIN32_USE_CRYPTO
unsigned int osip_build_random_number()
#else
static unsigned int osip_fallback_random_number()
#endif
{
  if (!random_seed_set) {
    unsigned int ticks;

#ifdef __PALMOS__
#if __PALMOS__ < 0x06000000
    SysRandom((Int32) TimGetTicks());
#else
    struct timeval tv;

    gettimeofday(&tv, NULL);
    srand(tv.tv_usec);
    ticks = tv.tv_sec + tv.tv_usec;
#endif
#elif defined(WIN32)
    LARGE_INTEGER lCount;

    QueryPerformanceCounter(&lCount);
    ticks = lCount.LowPart + lCount.HighPart;
#elif defined(_WIN32_WCE)
    ticks = GetTickCount();
#elif defined(__PSOS__)
#elif defined(__rtems__)
    rtems_clock_get(RTEMS_CLOCK_GET_TICKS_SINCE_BOOT, &ticks);
#elif defined(__VXWORKS_OS__)
    struct timespec tp;

    clock_gettime(CLOCK_REALTIME, &tp);
    ticks = tp.tv_sec + tp.tv_nsec;
#else
    struct timeval tv;
    int fd;

    gettimeofday(&tv, NULL);
    ticks = (unsigned int) (tv.tv_sec + tv.tv_usec);
    fd = open("/dev/urandom", O_RDONLY);

    if (fd > 0) {
      unsigned int r;
      int i;

      for (i = 0; i < 512; i++) {
        read(fd, &r, sizeof(r));
        ticks += r;
      }

      close(fd);
    }

#endif

#ifdef HAVE_LRAND48
    srand48(ticks);
#else
    srand(ticks);
#endif
    random_seed_set = 1;
  }

#ifdef HAVE_LRAND48
  {
    int val = (int) lrand48();

    if (val == 0) {
      unsigned int ticks;
      struct timeval tv;

      gettimeofday(&tv, NULL);
      ticks = (unsigned int) (tv.tv_sec + tv.tv_usec);
      srand48(ticks);
      return (unsigned int) lrand48();
    }

    return val;
  }
#else
  return rand();
#endif
}

#ifdef WIN32_USE_CRYPTO

unsigned int osip_build_random_number() {
  HCRYPTPROV crypto;
  BOOL err;
  unsigned int num;

  if (!random_seed_set) {
    unsigned int ticks;
    LARGE_INTEGER lCount;

    QueryPerformanceCounter(&lCount);
    ticks = lCount.LowPart + lCount.HighPart;
    srand(ticks);
    random_seed_set = 1;
  }

  err = CryptAcquireContext(&crypto, NULL, NULL, PROV_RSA_FULL, CRYPT_VERIFYCONTEXT);

  if (err) {
    err = CryptGenRandom(crypto, sizeof(num), (BYTE *) &num);
    CryptReleaseContext(crypto, 0);
  }

  if (!err) {
    num = osip_fallback_random_number();
  }

  return num;
}

#endif

#if defined(__linux)
#include <limits.h>
#endif

char *osip_strncpy(char *dest, const char *src, size_t length) {
  strncpy(dest, src, length);
  dest[length] = '\0';
  return dest;
}

#undef osip_strdup

char *osip_strdup(const char *ch) {
  char *copy;
  size_t length;

  if (ch == NULL)
    return NULL;

  length = strlen(ch);
  copy = (char *) osip_malloc(length + 1);

  if (copy == NULL)
    return NULL;

  osip_strncpy(copy, ch, length);
  return copy;
}

#ifndef MINISIZE
int osip_atoi(const char *number) {
#if defined(__linux) || defined(HAVE_STRTOL)
  long int i;

  if (number == NULL)
    return OSIP_UNDEFINED_ERROR;

  i = strtol(number, (char **) NULL, 10);

  if (i == LONG_MIN || i == LONG_MAX)
    return OSIP_UNDEFINED_ERROR;

  return i;
#endif

  return atoi(number);
}

#endif

#if (_MSC_VER >= 1700) && !defined(_USING_V110_SDK71_)
#if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_PHONE_APP)
#define HAVE_WINDOWSPHONE_API
#elif defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_PC_APP)
#define HAVE_WINAPPSTORE_API
#endif
#endif

void osip_usleep(int useconds) {
#if defined(__PALMOS__) && (__PALMOS__ >= 0x06000000)
  /* This bit will work for the Protein API, but not the Palm 68K API */
  nsecs_t nanoseconds = useconds * 1000;

  SysThreadDelay(nanoseconds, P_ABSOLUTE_TIMEOUT);
#elif defined(__PALMOS__) && (__PALMOS__ < 0x06000000)
  UInt32 stoptime = TimGetTicks() + (useconds / 1000000) * SysTicksPerSecond();

  while (stoptime > TimGetTicks())
    /* I wish there was some type of yield function here */
    ;

#elif defined(HAVE_WINDOWSPHONE_API)
  struct timeval delay;
  int sec;

  sec = (int) useconds / 1000000;

  if (sec > 0) {
    delay.tv_sec = sec;
    delay.tv_usec = 0;

  } else {
    delay.tv_sec = 0;
    delay.tv_usec = useconds;
  }

  select(0, 0, 0, 0, &delay);
#elif defined(HAVE_WINAPPSTORE_API)
  TODO
#elif defined(WIN32)
  Sleep(useconds / 1000);
#elif defined(__rtems__)
  rtems_task_wake_after(RTEMS_MICROSECONDS_TO_TICKS(useconds));
#elif defined(__arc__)
  struct timespec req;
  struct timespec rem;

  req.tv_sec = (int) useconds / 1000000;
  req.tv_nsec = (int) (useconds % 1000000) * 1000;
  nanosleep(&req, &rem);
#else
  struct timeval delay;
  int sec;

  sec = (int) useconds / 1000000;

  if (sec > 0) {
    delay.tv_sec = sec;
    delay.tv_usec = 0;

  } else {
    delay.tv_sec = 0;
    delay.tv_usec = useconds;
  }

  select(0, 0, 0, 0, &delay);
#endif
}

char *osip_strdup_without_quote(const char *ch) {
  char *copy = (char *) osip_malloc(strlen(ch) + 1);

  if (copy == NULL)
    return NULL;

  /* remove leading and trailing " */
  if ((*ch == '\"')) {
    osip_strncpy(copy, ch + 1, strlen(ch + 1));
    osip_strncpy(copy + strlen(copy) - 1, "\0", 1);

  } else
    osip_strncpy(copy, ch, strlen(ch));

  return copy;
}

int osip_tolower(char *word) {
#if defined(HAVE_CTYPE_H) && !defined(_WIN32_WCE)

  for (; *word; word++)
    *word = (char) tolower(*word);

#else
  size_t i;
  size_t len = strlen(word);

  for (i = 0; i <= len - 1; i++) {
    if ('A' <= word[i] && word[i] <= 'Z')
      word[i] = word[i] + 32;
  }

#endif
  return OSIP_SUCCESS;
}

#ifndef MINISIZE
int osip_strcasecmp(const char *s1, const char *s2) {
#if defined(__VXWORKS_OS__) || defined(__PSOS__)

  while ((*s1 != '\0') && (tolower(*s1) == tolower(*s2))) {
    s1++;
    s2++;
  }

  return (tolower(*s1) - tolower(*s2));
#elif defined(__PALMOS__) && (__PALMOS__ < 0x06000000)
  return StrCaselessCompare(s1, s2);
#elif defined(__PALMOS__) || (!defined WIN32 && !defined _WIN32_WCE)
  return strcasecmp(s1, s2);
#else
  return _stricmp(s1, s2);
#endif
}

int osip_strncasecmp(const char *s1, const char *s2, size_t len) {
#if defined(__VXWORKS_OS__) || defined(__PSOS__)

  if (len == 0)
    return OSIP_SUCCESS;

  while ((len > 0) && (tolower(*s1) == tolower(*s2))) {
    len--;

    if ((len == 0) || (*s1 == '\0') || (*s2 == '\0'))
      break;

    s1++;
    s2++;
  }

  return tolower(*s1) - tolower(*s2);
#elif defined(__PALMOS__) && (__PALMOS__ < 0x06000000)
  return StrNCaselessCompare(s1, s2, len);
#elif defined(__PALMOS__) || (!defined WIN32 && !defined _WIN32_WCE)
  return strncasecmp(s1, s2, len);
#else
  return _strnicmp(s1, s2, len);
#endif
}

#endif

char *osip_strcasestr(const char *haystack, const char *needle) {
  char c, sc;
  size_t len;

  if ((c = *needle++) != 0) {
    c = tolower((unsigned char) c);
    len = strlen(needle);

    do {
      do {
        if ((sc = *haystack++) == 0)
          return (NULL);
      } while ((char) tolower((unsigned char) sc) != c);
    } while (osip_strncasecmp(haystack, needle, len) != 0);

    haystack--;
  }

  return (char *) haystack;
}

/* remove SPACE before and after the content */
int osip_clrspace(char *word) {
  char *pbeg;
  char *pend;
  size_t len;

  if (word == NULL)
    return OSIP_UNDEFINED_ERROR;

  if (*word == '\0')
    return OSIP_SUCCESS;

  len = strlen(word);

  pbeg = word;
  pbeg += strspn(pbeg, " \r\n\t");

  pend = word + len - 1;

  while ((' ' == *pend) || ('\r' == *pend) || ('\n' == *pend) || ('\t' == *pend)) {
    pend--;

    if (pend < pbeg) {
      *word = '\0';
      return OSIP_SUCCESS;
    }
  }

  /* Add terminating NULL only if we've cleared room for it */
  if (pend + 1 <= word + (len - 1))
    pend[1] = '\0';

  if (pbeg != word)
    memmove(word, pbeg, pend - pbeg + 2);

  return OSIP_SUCCESS;
}

/* __osip_set_next_token:
   dest is the place where the value will be allocated
   buf is the string where the value is searched
   end_separator is the character that MUST be found at the end of the value
   next is the final location of the separator + 1

   the element MUST be found before any "\r" "\n" "\0" and
   end_separator

   return -1 on error
   return 1 on success
*/
int __osip_set_next_token(char **dest, char *buf, int end_separator, char **next) {
  char *sep; /* separator */

  *next = NULL;

  sep = buf;

  while ((*sep != end_separator) && (*sep != '\0') && (*sep != '\r') && (*sep != '\n'))
    sep++;

  if ((*sep == '\r') || (*sep == '\n')) { /* we should continue normally only if this is the separator asked! */
    if (*sep != end_separator)
      return OSIP_UNDEFINED_ERROR;
  }

  if (*sep == '\0')
    return OSIP_UNDEFINED_ERROR; /* value must not end with this separator! */

  if (sep == buf)
    return OSIP_UNDEFINED_ERROR; /* empty value (or several space!) */

  *dest = osip_malloc(sep - (buf) + 1);

  if (*dest == NULL)
    return OSIP_NOMEM;

  osip_strncpy(*dest, buf, sep - buf);

  *next = sep + 1; /* return the position right after the separator */
  return OSIP_SUCCESS;
}

#if 0
/*  not yet done!!! :-)
 */
int __osip_set_next_token_better(char **dest, char *buf, int end_separator, int *forbidden_tab[], int size_tab, char **next) {
  char *sep;                    /* separator */

  *next = NULL;

  sep = buf;

  while ((*sep != end_separator) && (*sep != '\0') && (*sep != '\r')
         && (*sep != '\n'))
    sep++;

  if ((*sep == '\r') && (*sep == '\n')) {       /* we should continue normally only if this is the separator asked! */
    if (*sep != end_separator)
      return OSIP_UNDEFINED_ERROR;
  }

  if (*sep == '\0')
    return OSIP_UNDEFINED_ERROR;        /* value must not end with this separator! */

  if (sep == buf)
    return OSIP_UNDEFINED_ERROR;        /* empty value (or several space!) */

  *dest = osip_malloc(sep - (buf) + 1);

  if (*dest == NULL)
    return OSIP_NOMEM;

  osip_strncpy(*dest, buf, sep - buf);

  *next = sep + 1;              /* return the position right after the separator */
  return 1;
}
#endif

/* in quoted-string, many characters can be escaped...   */
/* __osip_quote_find returns the next quote that is not escaped */
const char *__osip_quote_find(const char *qstring) {
  const char *quote;

  quote = strchr(qstring, '"');

  if (quote == qstring) /* the first char matches and is not escaped... */
    return quote;

  if (quote == NULL)
    return NULL; /* no quote at all... */

  /* this is now the nasty cases where '"' is escaped
     '" jonathan ros \\\""'
     |                  |
     '" jonathan ros \\"'
     |                |
     '" jonathan ros \""'
     |                |
     we must count the number of preceeding '\' */
  {
    int i = 1;

    for (;;) {
      if (0 == strncmp(quote - i, "\\", 1))
        i++;

      else {
        if (i % 2 == 1) /* the '"' was not escaped */
          return quote;

        /* else continue with the next '"' */
        quote = strchr(quote + 1, '"');

        if (quote == NULL)
          return NULL;

        i = 1;
      }

      if (quote - i == qstring - 1)
      /* example: "\"john"  */
      /* example: "\\"jack" */
      {
        /* special case where the string start with '\' */
        if (*qstring == '\\')
          i++; /* an escape char was not counted */

        if (i % 2 == 0) /* the '"' was not escaped */
          return quote;

        else {                 /* else continue with the next '"' */
          qstring = quote + 1; /* reset qstring because
                                  (*quote+1) may be also == to '\\' */
          quote = strchr(quote + 1, '"');

          if (quote == NULL)
            return NULL;

          i = 1;
        }
      }
    }

    return NULL;
  }
}

char *osip_enquote(const char *s) {
  char *rtn;
  char *t;

  t = rtn = osip_malloc(strlen(s) * 2 + 3);

  if (rtn == NULL)
    return NULL;

  *t++ = '"';

  for (; *s != '\0'; s++) {
    switch (*s) {
    case '"':
    case '\\':
    case 0x7f:
      *t++ = '\\';
      *t++ = *s;
      break;

    case '\n':
    case '\r':
      *t++ = ' ';
      break;

    default:
      *t++ = *s;
      break;
    }
  }

  *t++ = '"';
  *t++ = '\0';
  return rtn;
}

void osip_dequote(char *s) {
  size_t len;

  if (*s == '\0')
    return;

  if (*s != '"')
    return;

  len = strlen(s);
  memmove(s, s + 1, len--);

  if (len > 0 && s[len - 1] == '"')
    s[--len] = '\0';

  for (; *s != '\0'; s++, len--) {
    if (*s == '\\')
      memmove(s, s + 1, len--);
  }
}

/**********************************************************/
/* only MACROS from osip/trace.h should be used by others */
/* TRACE_INITIALIZE(level,file))                          */
/* TRACE_ENABLE_LEVEL(level)                              */
/* TRACE_DISABLE_LEVEL(level)                             */
/* IS_TRACE_LEVEL_ACTIVATE(level)                         */
/**********************************************************/
#ifndef ENABLE_TRACE
void osip_trace_initialize_func(osip_trace_level_t level, osip_trace_func_t *func) {
}

void osip_trace_initialize_syslog(osip_trace_level_t level, char *ident) {
}

int osip_trace_initialize(osip_trace_level_t level, FILE *file) {
  return OSIP_UNDEFINED_ERROR;
}

void osip_trace_enable_level(osip_trace_level_t level) {
}

void osip_trace_disable_level(osip_trace_level_t level) {
}

int osip_is_trace_level_activate(osip_trace_level_t level) {
  return LOG_FALSE;
}

#else

/* initialize log */
/* all lower levels of level are logged in file. */
int osip_trace_initialize(osip_trace_level_t level, FILE *file) {
  osip_trace_level_t i = TRACE_LEVEL0;

  /* enable trace in log file by default */
  logfile = NULL;

  if (file != NULL)
    logfile = file;

  else
    logfile = stdout;

  /* enable all lower levels */
  while (i < END_TRACE_LEVEL) {
    if (i < level)
      tracing_table[i] = LOG_TRUE;

    else
      tracing_table[i] = LOG_FALSE;

    i++;
  }

  return 0;
}

void osip_trace_initialize_syslog(osip_trace_level_t level, char *ident) {
  osip_trace_level_t i = TRACE_LEVEL0;

#if defined(HAVE_SYSLOG_H) && !defined(__arc__)
  openlog(ident, LOG_CONS | LOG_PID, LOG_DAEMON);
  use_syslog = 1;
#endif

  /* enable all lower levels */
  while (i < END_TRACE_LEVEL) {
    if (i < level)
      tracing_table[i] = LOG_TRUE;

    else
      tracing_table[i] = LOG_FALSE;

    i++;
  }
}

void osip_trace_enable_until_level(osip_trace_level_t level) {
  osip_trace_level_t i = 0;

  while (i < END_TRACE_LEVEL) {
    if (i < level)
      tracing_table[i] = LOG_TRUE;

    else
      tracing_table[i] = LOG_FALSE;

    i++;
  }
}

void osip_trace_initialize_func(osip_trace_level_t level, osip_trace_func_t *func) {
  osip_trace_level_t i = 0;

  trace_func = func;

  /* enable all lower levels */
  while (i < END_TRACE_LEVEL) {
    if (i < level)
      tracing_table[i] = LOG_TRUE;

    else
      tracing_table[i] = LOG_FALSE;

    i++;
  }
}

/* enable a special debugging level! */
void osip_trace_enable_level(osip_trace_level_t level) {
  tracing_table[level] = LOG_TRUE;
}

/* disable a special debugging level! */
void osip_trace_disable_level(osip_trace_level_t level) {
  tracing_table[level] = LOG_FALSE;
}

/* not so usefull? */
int osip_is_trace_level_activate(osip_trace_level_t level) {
  return tracing_table[level];
}
#endif

#if defined(WIN32) && !defined(_WIN32_WCE)

#include <time.h>
#include <sys/timeb.h>

int __osip_port_gettimeofday(struct timeval *tp, void *tz) {
  struct _timeb timebuffer;

  _ftime(&timebuffer);
  tp->tv_sec = (long) timebuffer.time;
  tp->tv_usec = timebuffer.millitm * 1000;
  return OSIP_SUCCESS;
}
#elif defined(__linux)
#include <sys/time.h>
#define __osip_port_gettimeofday gettimeofday
#elif defined(__APPLE__)
#include <sys/time.h>
#define __osip_port_gettimeofday gettimeofday
#endif

#ifdef ANDROID
#include <android/log.h>
#endif

#ifndef MAX_LENGTH_TR
#define MAX_LENGTH_TR 2024 /* NEVER DEFINE MORE THAN 2024 */
#endif

int osip_trace(const char *filename_long, int li, osip_trace_level_t level, FILE *f, const char *chfr, ...) {
#ifdef ENABLE_TRACE
  va_list ap;
  char time_buffer[80] = {'\0'};

  const char *fi = NULL;

  if (logfile == NULL && use_syslog == 0 && trace_func == NULL && f == NULL) {
    /* user did not initialize logger: Let's make it default. */
    osip_trace_initialize(OSIP_WARNING, stdout);
  }

  if (tracing_table[level] == LOG_FALSE)
    return OSIP_SUCCESS;

#if defined(HAVE_LOCALTIME)
  {
    time_t timestamp;
    struct timeval now;
    struct tm *ptm;
#ifdef __USE_POSIX
    struct tm local_tm;
#endif
    int tenths_ms;
    __osip_port_gettimeofday(&now, NULL);

    timestamp = now.tv_sec;
    tenths_ms = now.tv_usec / (100L);
#ifdef __USE_POSIX
    ptm = localtime_r(&timestamp, &local_tm);
#else
    ptm = localtime(&timestamp);
#endif

    snprintf(time_buffer, 80, "%04d-%02d-%02d %02d:%02d:%02d.%04d", 1900 + ptm->tm_year, ptm->tm_mon + 1, ptm->tm_mday, ptm->tm_hour, ptm->tm_min, ptm->tm_sec, tenths_ms);
  }
#endif

  if (filename_long != NULL) {
    fi = strrchr(filename_long, '/');

    if (fi == NULL)
      fi = strrchr(filename_long, '\\');

    if (fi != NULL)
      fi++;

    if (fi == NULL)
      fi = filename_long;
  }

  if (f == NULL)
    f = logfile;

#if defined(__VXWORKS_OS__) || defined(__rtems__)
  /* vxworks can't have a local file */
  f = stdout;
#endif

  VA_START(ap, chfr);

  if (trace_func) {
    trace_func(fi, li, level, chfr, ap);
    va_end(ap);
    return OSIP_SUCCESS;
  }

#ifdef ANDROID
  {
    int lev;

    switch (level) {
    case OSIP_INFO3:
      lev = ANDROID_LOG_DEBUG;
      break;

    case OSIP_INFO4:
      lev = ANDROID_LOG_DEBUG;
      break;

    case OSIP_INFO2:
      lev = ANDROID_LOG_INFO;
      break;

    case OSIP_INFO1:
      lev = ANDROID_LOG_INFO;
      break;

    case OSIP_WARNING:
      lev = ANDROID_LOG_WARN;
      break;

    case OSIP_ERROR:
      lev = ANDROID_LOG_ERROR;
      break;

    case OSIP_BUG:
      lev = ANDROID_LOG_FATAL;
      break;

    case OSIP_FATAL:
      lev = ANDROID_LOG_FATAL;
      break;

    default:
      lev = ANDROID_LOG_DEFAULT;
      break;
    }

    __android_log_vprint(lev, "osip2", chfr, ap);
    va_end(ap);
    return OSIP_SUCCESS;
  }
#endif

  {
    char buffer[MAX_LENGTH_TR];
    int in = 0;

    memset(buffer, 0, sizeof(buffer));

    if (level == OSIP_FATAL)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "| FATAL | %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_BUG)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "|  BUG  | %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_ERROR)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "| ERROR | %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_WARNING)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "|WARNING| %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_INFO1)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "| INFO1 | %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_INFO2)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "| INFO2 | %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_INFO3)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "| INFO3 | %s <%10.10s:%5i> ", time_buffer, fi, li);

    else if (level == OSIP_INFO4)
      in = snprintf(buffer, MAX_LENGTH_TR - 1, "| INFO4 | %s <%10.10s:%5i> ", time_buffer, fi, li);

    vsnprintf(buffer + in, MAX_LENGTH_TR - 1 - in, chfr, ap);

#if defined(HAVE_SYSLOG_H) && !defined(__arc__)

    if (use_syslog == 1) {
      if (level == OSIP_FATAL)
        syslog(LOG_ERR, "%s", buffer);

      else if (level == OSIP_BUG)
        syslog(LOG_ERR, "%s", buffer);

      else if (level == OSIP_ERROR)
        syslog(LOG_ERR, "%s", buffer);

      else if (level == OSIP_WARNING)
        syslog(LOG_WARNING, "%s", buffer);

      else if (level == OSIP_INFO1)
        syslog(LOG_INFO, "%s", buffer);

      else if (level == OSIP_INFO2)
        syslog(LOG_INFO, "%s", buffer);

      else if (level == OSIP_INFO3)
        syslog(LOG_DEBUG, "%s", buffer);

      else if (level == OSIP_INFO4)
        syslog(LOG_DEBUG, "%s", buffer);

      va_end(ap);
      return OSIP_SUCCESS;
    }

#endif

#if defined(WIN32)

    if (f == stdout) {
#ifdef UNICODE
      WCHAR wUnicode[MAX_LENGTH_TR * 2];
      int size;

      size = MultiByteToWideChar(CP_UTF8, 0, buffer, -1, wUnicode, MAX_LENGTH_TR * 2);
      wUnicode[size - 2] = '\n';
      wUnicode[size - 1] = '\0';
      OutputDebugString(wUnicode);
#else
      OutputDebugString(buffer);
#endif
      va_end(ap);
      return OSIP_SUCCESS;
    }

#endif

#if defined(__APPLE__) && defined(__OBJC__)

    if (f == stdout) {
      NSLog(@"%s", buffer);
      va_end(ap);
      return OSIP_SUCCESS;
    }

#endif

    if (f) {
      fprintf(f, "%s", buffer);
      fflush(f);
      va_end(ap);
      return OSIP_SUCCESS;
    }
  }

  va_end(ap);
#endif
  return OSIP_SUCCESS;
}

#if defined(WIN32) || defined(_WIN32_WCE)

#undef osip_malloc
void *osip_malloc(size_t size) {
  void *ptr = malloc(size);

  if (ptr != NULL)
    memset(ptr, 0, size);

  return ptr;
}

#undef osip_realloc
void *osip_realloc(void *ptr, size_t size) {
  return realloc(ptr, size);
}

#undef osip_free
void osip_free(void *ptr) {
  if (ptr == NULL)
    return;

  free(ptr);
}

#else

#ifndef MINISIZE
void osip_set_allocators(osip_malloc_func_t *malloc_func, osip_realloc_func_t *realloc_func, osip_free_func_t *free_func) {
  osip_malloc_func = malloc_func;
  osip_realloc_func = realloc_func;
  osip_free_func = free_func;
}
#endif

#endif

#if defined(__VXWORKS_OS__)

typedef struct {
  char *str;
  int max;
  int len;
} _context;

STATUS _cb_snprintf(char *buffer, int nc, int arg);

STATUS _cb_snprintf(char *buffer, int nc, int arg) {
  _context *ctx = (_context *) arg;

  if (ctx->max - ctx->len - nc < 1) { /* retain 1 pos for terminating \0 */
    nc = ctx->max - ctx->len - 1;
  }

  if (nc > 0) {
    memcpy(ctx->str + ctx->len, buffer, nc);
    ctx->len += nc;
  }

  ctx->str[ctx->len] = '\0';

  return OK;
}

int osip_vsnprintf(char *buf, int max, const char *fmt, va_list ap) {
  _context ctx;

  ctx.str = buf;
  ctx.max = max;
  ctx.len = 0;

  if (fioFormatV(fmt, ap, _cb_snprintf, (int) &ctx) != OK) {
    return OSIP_UNDEFINED_ERROR;
  }

  return ctx.len;
}

int osip_snprintf(char *buf, int max, const char *fmt, ...) {
  int retval;
  va_list ap;

  va_start(ap, fmt);
  retval = osip_vsnprintf(buf, max, fmt, ap);
  va_end(ap);
  return retval;
}

#endif

#if defined(__PSOS__)

int osip_snprintf(char *buf, int max, const char *fmt, ...) {
  static char buffer[1024];
  int retval;
  va_list ap;

  buffer[0] = '\n';
  va_start(ap, fmt);
  vsprintf(&(buffer[strlen(buffer)]), fmt, ap);
  va_end(ap);
  retval = strlen(buffer);
  memmove(buf, buffer, max);

  if (retval > max)
    return OSIP_UNDEFINED_ERROR;

  return retval;
}

#endif

#ifdef DEBUG_MEM

/*
  This is a debug facility for detecting memory leaks.
  I recommend to use external tools such as mpatrol
  when possible. On some fancy platform, you may not
  have any usefull tools: in this case, use this code!
 */

void *_osip_malloc(size_t size, char *file, unsigned short line) {
  void *mem;

  mem = osip_malloc_func(size + 20);

  if (mem != NULL) {
    char *s;

    memcpy(mem, &line, 2);

    for (s = file + strlen(file); s != file; s--) {
      if (*s == '\\' || *s == '/') {
        s++;
        break;
      }
    }

    strncpy((char *) mem + 2, s, 18);
    return (void *) ((char *) mem + 20);
  }

  return NULL;
}

void _osip_free(void *ptr) {
  if (ptr != NULL) {
    osip_free_func((char *) ptr - 20);
  }
}

void *_osip_realloc(void *ptr, size_t size, char *file, unsigned short line) {
  void *mem;

  mem = osip_realloc_func((char *) ptr - 20, size + 20);

  if (mem != NULL) {
    char *s;

    memcpy(mem, &line, 2);

    for (s = file + strlen(file); s != file; s--) {
      if (*s == '\\' || *s == '/') {
        s++;
        break;
      }
    }

    strncpy((char *) mem + 2, s, 18);
    return (char *) mem + 20;
  }

  return NULL;
}

#endif

#ifdef OSIP_MEMORY_DEBUG
/* for windows test purpose */
#define _CRTDBG_MAP_ALLOC
#include <crtdbg.h>
/*
  This is a debug facility for detecting memory leaks.
  I recommend to use external tools such as mpatrol
  when possible. On some fancy platform, you may not
  have any usefull tools: in this case, use this code!
 */

void *_osip_malloc(size_t size, char *file, unsigned short line) {
  return _malloc_dbg(size, _NORMAL_BLOCK, file, line);
}

void _osip_free(void *ptr) {
  _free_dbg(ptr, _NORMAL_BLOCK);
}

void *_osip_realloc(void *ptr, size_t size, char *file, unsigned short line) {
  return _realloc_dbg(ptr, size, _NORMAL_BLOCK, file, line);
}
#endif

/* ---For better performance---
   Calculates a hash value for the given string */
unsigned long osip_hash(const char *str) {
  unsigned int hash = 5381;
  int c;

  while ((c = *str++))
    hash = ((hash << 5) + hash) + c;

  return hash & 0xFFFFFFFFu;
}

/* ---For better performance---
   Appends src-string to dst-string.

   This was introduced to replace the
   inefficient constructions like:

   osip_strncpy (tmp, src, strlen(src) );
   tmp = tmp + strlen (src);

   This function returns a pointer to the
   end of the destination string

   Pre: src is null terminated */
char *osip_str_append(char *dst, const char *src) {
  while (*src != '\0') {
    *dst = *src;
    src++;
    dst++;
  }

  *dst = '\0';
  return dst;
}

/* ---For better performance---
   Same as above, only this time we know the length */
char *osip_strn_append(char *dst, const char *src, size_t len) {
  memmove((void *) dst, (void *) src, len);
  dst += len;
  *dst = '\0';
  return dst;
}

/* ---For better performance---
   This is to replace this construction:
   osip_strncpy (  dest, source, length);
   osip_clrspace ( dest ); */
#ifndef MINISIZE
char *osip_clrncpy(char *dst, const char *src, size_t len) {
  const char *pbeg;
  const char *pend;
  char *p;
  size_t spaceless_length;

  if (src == NULL || len == 0) {
    *dst = '\0';
    return NULL;
  }

  /* find the start of relevant text */
  pbeg = src;
  pbeg += strspn(pbeg, " \r\n\t");

  /* find the end of relevant text */
  pend = src + len - 1;

  while ((' ' == *pend) || ('\r' == *pend) || ('\n' == *pend) || ('\t' == *pend)) {
    pend--;

    if (pend < pbeg) {
      *dst = '\0';
      return dst;
    }
  }

  /* if pend == pbeg there is only one char to copy */
  spaceless_length = pend - pbeg + 1; /* excluding any '\0' */
  memmove(dst, pbeg, spaceless_length);
  p = dst + spaceless_length;

#if defined(__GNUC__)
  /* terminate the string and pad dest with zeros until len.
     99% of the time (SPACELESS_LENGTH == LEN) or
     (SPACELESS_LENGHT + 1 == LEN). We handle these cases efficiently.  */
  *p = '\0';

  if (__builtin_expect(++spaceless_length < len, 0)) {
    do
      *++p = '\0';

    while (++spaceless_length < len);
  }

#else

  /* terminate the string and pad dest with zeros until len */
  do {
    *p = '\0';
    p++;
    spaceless_length++;
  } while (spaceless_length < len);

#endif

  return dst;
}

#else

char *osip_clrncpy(char *dst, const char *src, size_t len) {
  osip_strncpy(dst, src, len);
  osip_clrspace(dst);
  return dst;
}

#endif