hdr_from.c

libosip-0.9.7源码

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001,2002,2003  Aymeric MOIZARD [e-mail]
  
  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
*/

/* HISTORY:

   v0.5.0: created.

   v0.6.0: 16/07/2001 complete support for from:
   new structure
   new from_parse() method
*/

#include <stdlib.h>
#include <stdio.h>

#include <osip/port.h>
#include <osip/smsg.h>
#include "msg.h"

/* adds the from header to message.              */
/* INPUT : char *hvalue | value of header.    */
/* OUTPUT: sip_t *sip | structure to save results.  */
/* returns -1 on error. */
int
msg_setfrom (sip_t * sip, char *hvalue)
{
  int i;

  if (sip->from != NULL)
    return -1;
  i = from_init (&(sip->from));
  if (i != 0)
    return -1;
#ifdef USE_TMP_BUFFER
  sip->message_property = 2;
#endif
  i = from_parse (sip->from, hvalue);
  if (i != 0)
    {
      from_free (sip->from);
      sfree (sip->from);
      sip->from = NULL;
      return -1;
    }
  return 0;
}


/* returns the from header.            */
/* INPUT : sip_t *sip | sip message.   */
/* returns null on error. */
from_t *
msg_getfrom (sip_t * sip)
{
  return sip->from;
}

int
from_init (from_t ** from)
{
  *from = (from_t *) smalloc (sizeof (from_t));
  if (*from == NULL)
    return -1;
  (*from)->displayname = NULL;
  (*from)->url = NULL;

  (*from)->gen_params = (list_t *) smalloc (sizeof (list_t));
  if ((*from)->gen_params == NULL)
    {
      sfree (*from);
      *from = NULL;
    }
  list_init ((*from)->gen_params);

  return 0;
}

/* deallocates a from_t structure.  */
/* INPUT : from_t *from | from. */
void
from_free (from_t * from)
{
  if (from == NULL)
    return;
  if (from->url != NULL)
    {
      url_free (from->url);
      sfree (from->url);
    }
  sfree (from->displayname);

  generic_param_freelist (from->gen_params);
  sfree (from->gen_params);

  from->url = NULL;
  from->displayname = NULL;
  from->gen_params = NULL;
}

/* parses the string as a from header.                   */
/* INPUT : const char *string | pointer to a from string.*/
/* OUTPUT: from_t *from | structure to save results.     */
/* returns -1 on error. */
int
from_parse (from_t * from, char *hvalue)
{
  char *displayname;
  char *url;
  char *url_end;
  char *gen_params;

  /* How to parse:

     we'll place the pointers:
     displayname  =>  beginning of displayname
     url          =>  beginning of url
     url_end      =>  end       of url
     gen_params  =>  beginning of params

     examples:

     jack <sip:[e-mail]>;tag=34erZ
     ^     ^                ^ ^

     sip:[e-mail];tag=34erZ
     ^                ^^      
   */

  displayname = strchr (hvalue, '"');

  url = strchr (hvalue, '<');
  if (url != NULL)
    {
      url_end = strchr (url, '>');
      if (url_end == NULL)
	return -1;
    }

  /* SIPit day2: this case was not supported
     first '"' is placed after '<' and after '>'
     <sip:ixion@62.254.248.117;method=INVITE>;description="OPEN";expires=28800
     if the fisrt quote is after '<' then
     this is not a quote for a displayname.
   */
  if (displayname > url)
    displayname = NULL;

  if ((displayname == NULL) && (url != NULL))
    {				/* displayname IS A '*token' (not a quoted-string) */
      if (hvalue != url)	/* displayname exists */
	{
	  if (url - hvalue + 1 < 2)
	    return -1;
	  from->displayname = (char *) smalloc (url - hvalue + 1);
	  if (from->displayname == NULL)
	    return -1;
	  sstrncpy (from->displayname, hvalue, url - hvalue);
	  sclrspace (from->displayname);
	}
      url++;			/* place pointer on the beginning of url */
    }
  else
    {
      if ((displayname != NULL) && (url != NULL))
	{			/* displayname IS A quoted-string (not a '*token') */
	  char *first;
	  char *second;

	  /* search for quotes */
	  first = quote_find (hvalue);
	  second = quote_find (first + 1);
	  if (second == NULL)
	    return -1;		/* if there is only 1 quote: failure */
	  if ((first > url))
	    return -1;

	  if (second - first + 2 >= 2)
	    {
	      from->displayname = (char *) smalloc (second - first + 2);
	      if (from->displayname == NULL)
		return -1;
	      sstrncpy (from->displayname, first, second - first + 1);
	      /* sclrspace(from->displayname); *//*should we do that? */

	      /* special case: "<sip:[e-mail]>" <sip:[e-mail]> */
	    }			/* else displayname is empty? */
	  url = strchr (second + 1, '<');
	  if (url == NULL)
	    return -1;		/* '<' MUST exist */
	  url++;
	}
      else
	url = hvalue;		/* field does not contains '<' and '>' */
    }

  /* DISPLAY-NAME SET   */
  /* START of URL KNOWN */

  url_end = strchr (url, '>');

  if (url_end == NULL)		/* sip:[e-mail];tag=023 */
    {				/* We are sure ';' is the delimiter for from-parameters */
      char *host = strchr (url, '@');

      if (host != NULL)
	gen_params = strchr (host, ';');
      else
	gen_params = strchr (url, ';');
      if (gen_params != NULL)
	url_end = gen_params - 1;
      else
	url_end = url + strlen (url);
    }
  else				/* jack <sip:[e-mail];user=phone>;tag=azer */
    {
      gen_params = strchr (url_end, ';');
      url_end--;		/* place pointer on the beginning of url */
    }

  if (gen_params != NULL)	/* now we are sure a param exist */
    if (generic_param_parseall (from->gen_params, gen_params) == -1)
      {
	return -1;
      }

  /* set the url */
  {
    char *tmp;
    int i;

    if (url_end - url + 2 < 7)
      return -1;
    i = url_init (&(from->url));
    if (i != 0)
      return -1;
    tmp = (char *) smalloc (url_end - url + 2);
    if (tmp == NULL)
      return -1;
    sstrncpy (tmp, url, url_end - url + 1);
    i = url_parse (from->url, tmp);
    sfree (tmp);
    if (i != 0)
      return -1;
  }
  return 0;
}


/* returns the from header as a string.  */
/* INPUT : from_t *from | from header.   */
/* returns -1 on error. */
int
from_2char (from_t * from, char **dest)
{
  char *url;
  char *buf;
  int i;
  int len;

  *dest = NULL;
  if ((from == NULL) || (from->url == NULL))
    return -1;

  i = url_2char (from->url, &url);
  if (i != 0)
    return -1;

  if (from->displayname == NULL)
    len = strlen (url) + 5;
  else
    len = strlen (url) + strlen (from->displayname) + 5;

  buf = (char *) smalloc (len);
  if (buf == NULL)
    {
      sfree (url);
      return -1;
    }

  if (from->displayname != NULL)
    sprintf (buf, "%s <%s>", from->displayname, url);
  else
    /* from rfc2543bis-04: for authentication related issue!
       "The To and From header fields always include the < and >
       delimiters even if the display-name is empty." */
    sprintf (buf, "<%s>", url);
  sfree (url);

  {
    int pos = 0;
    generic_param_t *u_param;
    int plen;
    char *tmp;

    while (!list_eol (from->gen_params, pos))
      {
	u_param = (generic_param_t *) list_get (from->gen_params, pos);

	if (u_param->gvalue == NULL)
	  plen = strlen (u_param->gname) + 2;
	else
	  plen = strlen (u_param->gname) + strlen (u_param->gvalue) + 3;
	len = len + plen;
	buf = (char *) realloc (buf, len);
	tmp = buf;
	tmp = tmp + strlen (tmp);
	if (u_param->gvalue == NULL)
	  sprintf (tmp, ";%s", u_param->gname);
	else
	  sprintf (tmp, ";%s=%s", u_param->gname, u_param->gvalue);
	pos++;
      }
  }
  *dest = buf;
  return 0;
}

char *
from_getdisplayname (from_t * from)
{
  if (from == NULL)
    return NULL;
  return from->displayname;
}

void
from_setdisplayname (from_t * from, char *displayname)
{
  from->displayname = displayname;
}

url_t *
from_geturl (from_t * from)
{
  if (from == NULL)
    return NULL;
  return from->url;
}

void
from_seturl (from_t * from, url_t * url)
{
  from->url = url;
}

int
from_param_get (from_t * from, int pos, generic_param_t ** fparam)
{
  *fparam = NULL;
  if (from == NULL)
    return -1;
  if (list_size (from->gen_params) <= pos)
    return -1;			/* does not exist */
  *fparam = (generic_param_t *) list_get (from->gen_params, pos);
  return pos;
}

int
from_clone (from_t * from, from_t ** dest)
{
  int i;
  from_t *fr;

  *dest = NULL;
  if (from == NULL)
    return -1;

  i = from_init (&fr);
  if (i != 0)			/* allocation failed */
    return -1;
  if (from->displayname != NULL)
    fr->displayname = sgetcopy (from->displayname);

  if (from->url != NULL)
    {
      i = url_clone (from->url, &(fr->url));
      if (i != 0)
	{
	  from_free (fr);
	  sfree (fr);
	  return -1;
	}
    }

  {
    int pos = 0;
    generic_param_t *u_param;
    generic_param_t *dest_param;

    while (!list_eol (from->gen_params, pos))
      {
	u_param = (generic_param_t *) list_get (from->gen_params, pos);
	i = generic_param_clone (u_param, &dest_param);
	if (i != 0)
	  {
	    from_free (fr);
	    sfree (fr);
	    return -1;
	  }
	list_add (fr->gen_params, dest_param, -1);
	pos++;
      }
  }
  *dest = fr;
  return 0;
}

int
from_compare (from_t * from1, from_t * from2)
{
  char *tag1;
  char *tag2;

  if (from1 == NULL || from2 == NULL)
    return -1;
  if (from1->url == NULL || from2->url == NULL)
    return -1;

  /* we could have a sip or sips url, but if string!=NULL,
     host part will be NULL. */
  if (from1->url->host == NULL && from2->url->host == NULL)
    {
      if (from1->url->string == NULL || from2->url->string == NULL)
	return -1;
      if (0 == strcmp (from1->url->string, from2->url->string))
	return 0;
    }
  if (from1->url->host == NULL || from2->url->host == NULL)
    return -1;

  /* compare url including tag */
  if (0 != strcmp (from1->url->host, from2->url->host))
    return -1;
  if (from1->url->username != NULL && from2->url->username != NULL)
    if (0 != strcmp (from1->url->username, from2->url->username))
      return -1;

  tag1 = NULL;
  tag2 = NULL;
  {
    int pos = 0;
    generic_param_t *u_param;

    while (!list_eol (from1->gen_params, pos))
      {
	u_param = (generic_param_t *) list_get (from1->gen_params, pos);
	if (0 == strncmp (u_param->gname, "tag", 3))
	  {
	    tag1 = u_param->gvalue;
	    break;
	  }
	pos++;
      }
  }
  {
    int pos = 0;
    generic_param_t *u_param;

    while (!list_eol (from2->gen_params, pos))
      {
	u_param = (generic_param_t *) list_get (from2->gen_params, pos);
	if (0 == strncmp (u_param->gname, "tag", 3))
	  {
	    tag2 = u_param->gvalue;
	    break;
	  }
	pos++;
      }
  }

  /* sounds like a BUG!
     if tag2 exists and tag1 does not, then it will
     return 0;
     in the first request, (INVITE) the To field does not
     contain any tag. The response contains one! and the
     response must match the request....
   */
  /* so we test the tags only when both exist! */
  if (tag1 != NULL && tag2 != NULL)
    if (0 != strcmp (tag1, tag2))
      return -1;

  /* We could return a special case, when */
  /* only one tag exists?? */

  return 0;			/* return code changed to 0 from release 0.6.1 */
}

int
generic_param_parseall (list_t * gen_params, char *params)
{
  char *pname;
  char *pvalue;

  char *comma;
  char *equal;

  /* find '=' wich is the separator for one param */
  /* find ';' wich is the separator for multiple params */

  equal = next_separator (params + 1, '=', ';');
  comma = strchr (params + 1, ';');

  while (comma != NULL)
    {

      if (equal == NULL)
	{
	  equal = comma;
	  pvalue = NULL;
	}
      else
	{
	  char *tmp;
	  /* check for NULL param with an '=' character */
	  tmp = equal + 1;
	  for (; *tmp == '\t' || *tmp == ' '; tmp++)
	    {
	    }
	  pvalue = NULL;
	  if (*tmp != ',' && *tmp != '\0')
	    {
	      if (comma - equal < 2)
		return -1;
	      pvalue = (char *) smalloc (comma - equal);
	      if (pvalue == NULL)
		return -1;
	      sstrncpy (pvalue, equal + 1, comma - equal - 1);
	    }
	}

      if (equal - params < 2)
	{
	  sfree (pvalue);
	  return -1;
	}
      pname = (char *) smalloc (equal - params);
      if (pname == NULL)
	{
	  sfree (pvalue);
	  return -1;
	}
      sstrncpy (pname, params + 1, equal - params - 1);

      generic_param_add (gen_params, pname, pvalue);

      params = comma;
      equal = next_separator (params + 1, '=', ';');
      comma = strchr (params + 1, ';');
    }

  /* this is the last header (comma==NULL) */
  comma = params + strlen (params);

  if (equal == NULL)
    {
      equal = comma;		/* at the end */
      pvalue = NULL;
    }
  else
    {
      char *tmp;
      /* check for NULL param with an '=' character */
      tmp = equal + 1;
      for (; *tmp == '\t' || *tmp == ' '; tmp++)
	{
	}
      pvalue = NULL;
      if (*tmp != ',' && *tmp != '\0')
	{
	  if (comma - equal < 2)
	    return -1;
	  pvalue = (char *) smalloc (comma - equal);
	  if (pvalue == NULL)
	    return -1;
	  sstrncpy (pvalue, equal + 1, comma - equal - 1);
	}
    }

  if (equal - params < 2)
    {
      sfree (pvalue);
      return -1;
    }
  pname = (char *) smalloc (equal - params);
  if (pname == NULL)
    return -1;
  sstrncpy (pname, params + 1, equal - params - 1);

  generic_param_add (gen_params, pname, pvalue);

  return 0;
}


void
generic_param_setvalue (generic_param_t * fparam, char *value)
{
  fparam->gvalue = value;
}

char *
generic_param_getname (generic_param_t * fparam)
{
  if (fparam == NULL)
    return NULL;
  return fparam->gname;
}

void
generic_param_setname (generic_param_t * fparam, char *name)
{
  fparam->gname = name;
}

char *
generic_param_getvalue (generic_param_t * fparam)
{
  if (fparam == NULL)
    return NULL;
  if (fparam->gname == NULL)
    return NULL;		/* name is mandatory */
  return fparam->gvalue;
}