sofia-sip/msg_mime.h

Go to the documentation of this file.

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
 *
 * 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
 *
 */

#ifndef MSG_MIME_H

#define MSG_MIME_H

#ifndef URL_H
#include <sofia-sip/url.h>
#endif

#ifndef MSG_TYPES_H
#include <sofia-sip/msg_types.h>
#endif
#ifndef SU_TYPES_H
#include <sofia-sip/su_types.h>
#endif

SOFIA_BEGIN_DECLS

typedef struct msg_accept_any_s     msg_accept_any_t;

typedef struct msg_accept_s         msg_accept_t;

typedef msg_accept_any_t            msg_accept_charset_t;
typedef msg_accept_any_t            msg_accept_encoding_t;
typedef msg_accept_any_t            msg_accept_language_t;

typedef struct msg_content_disposition_s
                                    msg_content_disposition_t;
typedef msg_list_t                  msg_content_encoding_t;
typedef msg_generic_t               msg_content_id_t;
typedef struct msg_content_length_s msg_content_length_t;
typedef msg_generic_t               msg_content_location_t;
typedef msg_list_t                  msg_content_language_t;
typedef msg_generic_t               msg_content_md5_t;
typedef msg_generic_t               msg_content_transfer_encoding_t;
typedef struct msg_content_type_s   msg_content_type_t;
typedef msg_generic_t               msg_mime_version_t;
typedef struct msg_warning_s        msg_warning_t;

typedef struct msg_multipart_s      msg_multipart_t;

struct msg_accept_s
{
  msg_common_t        ac_common[1]; 
  msg_accept_t       *ac_next;      
  char const         *ac_type;      
  char const         *ac_subtype;   
  msg_param_t const  *ac_params;    
  char const         *ac_q;         
};

struct msg_accept_any_s
{
  msg_common_t        aa_common[1]; 
  msg_accept_any_t   *aa_next;      
  char const         *aa_value;     
  msg_param_t const  *aa_params;    
  char const         *aa_q;         
};

struct msg_content_disposition_s
{
  msg_common_t       cd_common[1];  
  msg_error_t       *cd_next;       
  char const        *cd_type;       
  msg_param_t const *cd_params;     
  char const        *cd_handling;   
  unsigned           cd_required:1; 
  unsigned           cd_optional:1; 
  unsigned           :0;            /* pad */
};

struct msg_content_length_s
{
  msg_common_t   l_common[1];       
  msg_error_t   *l_next;            
  unsigned long  l_length;          
};


struct msg_content_type_s
{
  msg_common_t        c_common[1];  
  msg_error_t        *c_next;       
  char const         *c_type;       
  char const         *c_subtype;    
  msg_param_t const  *c_params;     
};


struct msg_warning_s
{
  msg_common_t        w_common[1];  
  msg_warning_t      *w_next;       
  unsigned            w_code;       
  char const         *w_host;       
  char const         *w_port;       
  char const         *w_text;       
};


struct msg_multipart_s
{
  msg_common_t            mp_common[1]; 
  msg_multipart_t        *mp_next;      
  /* Preamble for this part */
  char                   *mp_data;      
  unsigned                mp_len;       
  unsigned                mp_flags;
  msg_error_t            *mp_error;

  /* === Headers start here */
  msg_content_type_t     *mp_content_type;      
  msg_content_disposition_t *mp_content_disposition;
  msg_content_location_t *mp_content_location;  
  msg_content_id_t       *mp_content_id;        
  msg_content_language_t *mp_content_language;  
  msg_content_encoding_t *mp_content_encoding;  
  msg_content_transfer_encoding_t *mp_content_transfer_encoding;
#if 0
  /* === Hash headers end here */
  /* These MIME headers are here for msg_parser.awk */
  msg_accept_t           *mp_accept;            
  msg_accept_charset_t   *mp_accept_charset;    
  msg_accept_encoding_t  *mp_accept_encoding;   
  msg_accept_language_t  *mp_accept_language;   
  msg_mime_version_t     *mp_mime_version;      
  msg_content_md5_t      *mp_content_md5;       
  msg_content_length_t   *mp_content_length;    
  msg_multipart_t        *mp_multipart;         
  msg_warning_t          *mp_warning;           
#endif
  /* === Headers end here */

  msg_unknown_t          *mp_unknown;           
  msg_separator_t        *mp_separator;         
  msg_payload_t          *mp_payload;           
  msg_multipart_t        *mp_multipart;         
  msg_payload_t          *mp_close_delim;       
};

SOFIAPUBFUN
msg_multipart_t *msg_multipart_create(su_home_t *home,
                                      char const *content_type,
                                      void const *data,
                                      isize_t dlen);
SOFIAPUBFUN
msg_multipart_t *msg_multipart_parse(su_home_t *home,
                                     msg_content_type_t const *c,
                                     msg_payload_t *pl);
SOFIAPUBFUN
int msg_multipart_complete(su_home_t *home,
                           msg_content_type_t *c,
                           msg_multipart_t *mp);
SOFIAPUBFUN msg_header_t *msg_multipart_serialize(msg_header_t **head0,
                                                  msg_multipart_t *mp);

SOFIAPUBFUN issize_t msg_multipart_prepare(msg_t *msg, msg_multipart_t *mp, int flags);

SOFIAPUBFUN isize_t msg_accept_any_dup_xtra(msg_header_t const *h, isize_t offset);

SOFIAPUBFUN char *msg_accept_any_dup_one(msg_header_t *dst,
                                         msg_header_t const *src,
                                         char *b, isize_t xtra);

SOFIAPUBFUN
msg_content_length_t *msg_content_length_create(su_home_t *home, uint32_t n);

#define MSG_MULTIPART_VERSION_CURRENT msg_mime_version_1_0
SOFIAPUBVAR char const msg_mime_version_1_0[];

#define MSG_MULTIPART_PROTOCOL_TAG   ((void *)0x4d494d45)       /* 'MIME' */

SOFIA_END_DECLS

#endif