mime.h File Reference

#include "gwlib/gwlib.h"

Go to the source code of this file.

Typedefs
typedef struct MIMEEntity	MIMEEntity

Functions
MIMEEntity *	mime_entity_create (void)
void	mime_entity_destroy (MIMEEntity *e)
MIMEEntity *	mime_entity_duplicate (MIMEEntity *e)
void	mime_replace_headers (MIMEEntity *e, List *headers)
int	mime_entity_num_parts (MIMEEntity *e)
void	mime_entity_add_part (MIMEEntity *e, MIMEEntity *part)
MIMEEntity *	mime_entity_get_part (MIMEEntity *e, int i)
void	mime_entity_replace_part (MIMEEntity *e, int i, MIMEEntity *newpart)
void	mime_entity_remove_part (MIMEEntity *e, int i)
void	mime_entity_set_body (MIMEEntity *e, Octstr *body)
MIMEEntity *	mime_multipart_start_elem (MIMEEntity *e)
MIMEEntity *	mime_octstr_to_entity (Octstr *mime)
MIMEEntity *	mime_http_to_entity (List *headers, Octstr *body)
Octstr *	mime_entity_to_octstr (MIMEEntity *m)
List *	mime_entity_headers (MIMEEntity *m)
Octstr *	mime_entity_body (MIMEEntity *m)
void	mime_entity_dump (MIMEEntity *m)

Typedef Documentation

MIMEEntity

typedef struct MIMEEntity MIMEEntity

Definition at line 96 of file mime.h.

Function Documentation

mime_entity_add_part()

void mime_entity_add_part	(	MIMEEntity *	e,
		MIMEEntity *	part
	)

Definition at line 560 of file mime.c.

References gw_assert(), gwlist_append(), mime_entity_duplicate(), and MIMEEntity::multiparts.

{
     gw_assert(e != NULL);
     gw_assert(part != NULL);
     
     gwlist_append(e->multiparts, mime_entity_duplicate(part));
}

mime_entity_body()

Octstr* mime_entity_body

(

MIMEEntity *

m

)

Definition at line 485 of file mime.c.

References MIMEEntity::body, debug(), gw_assert(), MIMEEntity::headers, mime_entity_create(), mime_entity_destroy(), mime_entity_num_parts(), mime_entity_to_octstr(), octstr_destroy(), octstr_dump, octstr_duplicate, parse_context_create(), parse_context_destroy(), parse_get_rest(), and read_mime_headers().

{
    Octstr *os, *body;
    ParseContext *context;
    MIMEEntity *e;

    gw_assert(m != NULL && m->headers != NULL);

    /* For non-multipart, return body directly. */
    if (mime_entity_num_parts(m) == 0)
     return octstr_duplicate(m->body);

    os = mime_entity_to_octstr(m);
    context = parse_context_create(os);
    e = mime_entity_create();

    /* parse the headers up to the body */
    if ((read_mime_headers(context, e->headers) != 0) || e->headers == NULL) {
        debug("mime.parse",0,"Failed to read MIME headers in Octstr block:");
        octstr_dump(os, 0);
        mime_entity_destroy(e);
        parse_context_destroy(context);
        return NULL;
    }

    /* the rest is the body */
    body = parse_get_rest(context);

    octstr_destroy(os);
    mime_entity_destroy(e);
    parse_context_destroy(context);

    return body;
}

mime_entity_create()

MIMEEntity* mime_entity_create

(

void

)

Definition at line 87 of file mime.c.

References MIMEEntity::body, gwlist_create, MIMEEntity::headers, http_create_empty_headers(), MIMEEntity::multiparts, and MIMEEntity::start.

Referenced by mime_entity_body(), mime_entity_duplicate(), and mime_something_to_entity().

{
    MIMEEntity *e;

    e = gw_malloc(sizeof(MIMEEntity));
    e->headers = http_create_empty_headers();
    e->multiparts = gwlist_create();
    e->body = NULL;
    e->start = NULL;

    return e;
}

mime_entity_destroy()

void mime_entity_destroy

(

MIMEEntity *

e

)

Definition at line 105 of file mime.c.

References MIMEEntity::body, gw_assert(), gwlist_destroy(), MIMEEntity::headers, mime_entity_destroy_item(), MIMEEntity::multiparts, octstr_destroy(), octstr_destroy_item(), and MIMEEntity::start.

Referenced by main(), mime_entity_body(), mime_entity_destroy_item(), mime_entity_remove_part(), mime_entity_replace_part(), and mime_something_to_entity().

{
    gw_assert(e != NULL);

    if (e->headers != NULL)
        gwlist_destroy(e->headers, octstr_destroy_item);
    if (e->multiparts != NULL)
        gwlist_destroy(e->multiparts, mime_entity_destroy_item);
    octstr_destroy(e->body);
    e->start = NULL; /* will be destroyed on it's own via gwlist_destroy */
  
    gw_free(e);
}    

mime_entity_dump()

void mime_entity_dump

(

MIMEEntity *

m

)

Definition at line 717 of file mime.c.

References debug(), gw_assert(), MIMEEntity::headers, and mime_entity_dump_real().

Referenced by main().

{
    gw_assert(m != NULL && m->headers != NULL);

    debug("mms",0,"Dumping MIMEEntity at address %p", m);
    mime_entity_dump_real(m, 0);
}

mime_entity_duplicate()

MIMEEntity* mime_entity_duplicate

(

MIMEEntity *

e

)

Definition at line 521 of file mime.c.

References MIMEEntity::body, gwlist_append(), gwlist_get(), gwlist_len(), MIMEEntity::headers, mime_entity_create(), mime_entity_duplicate(), mime_replace_headers(), MIMEEntity::multiparts, and octstr_duplicate.

Referenced by mime_entity_add_part(), mime_entity_duplicate(), mime_entity_get_part(), mime_entity_replace_part(), and mime_multipart_start_elem().

{
     MIMEEntity *copy = mime_entity_create();
     int i, n;
     
     mime_replace_headers(copy, e->headers);
     copy->body = e->body ? octstr_duplicate(e->body) : NULL;
     
     for (i = 0, n = gwlist_len(e->multiparts); i < n; i++)
      gwlist_append(copy->multiparts, 
            mime_entity_duplicate(gwlist_get(e->multiparts, i)));
     return copy;
}

mime_entity_get_part()

MIMEEntity* mime_entity_get_part	(	MIMEEntity *	e,
		int	i
	)

Definition at line 570 of file mime.c.

References gw_assert(), gwlist_get(), gwlist_len(), mime_entity_duplicate(), and MIMEEntity::multiparts.

{
     MIMEEntity *m;
     gw_assert(e != NULL);
     gw_assert(i >= 0);
     gw_assert(i < gwlist_len(e->multiparts));

     m = gwlist_get(e->multiparts, i);
     gw_assert(m);
     return mime_entity_duplicate(m);
}

mime_entity_headers()

List* mime_entity_headers

(

MIMEEntity *

m

)

Definition at line 469 of file mime.c.

References fix_boundary_element(), gw_assert(), MIMEEntity::headers, http_header_duplicate(), and mime_entity_num_parts().

{
    List *headers;

    gw_assert(m != NULL && m->headers != NULL);

    /* Need a fixup before hand over. */
    if (mime_entity_num_parts(m) > 0)
       fix_boundary_element(m->headers, NULL);

    headers = http_header_duplicate(m->headers);

    return headers;
}

mime_entity_num_parts()

int mime_entity_num_parts

(

MIMEEntity *

e

)

Definition at line 550 of file mime.c.

References gw_assert(), gwlist_len(), and MIMEEntity::multiparts.

Referenced by mime_entity_body(), and mime_entity_headers().

{
     gw_assert(e != NULL);
     return e->multiparts ? gwlist_len(e->multiparts) : 0;
}

mime_entity_remove_part()

void mime_entity_remove_part	(	MIMEEntity *	e,
		int	i
	)

Definition at line 584 of file mime.c.

References gw_assert(), gwlist_delete(), gwlist_get(), gwlist_len(), mime_entity_destroy(), MIMEEntity::multiparts, and MIMEEntity::start.

{
     MIMEEntity *m;

     gw_assert(e != NULL);
     gw_assert(i >= 0);
     gw_assert(i < gwlist_len(e->multiparts));
     
     
     m = gwlist_get(e->multiparts, i);
     gwlist_delete(e->multiparts, i, 1);
     if (m == e->start) e->start = NULL;

     mime_entity_destroy(m);
}

mime_entity_replace_part()

void mime_entity_replace_part	(	MIMEEntity *	e,
		int	i,
		MIMEEntity *	newpart
	)

Definition at line 601 of file mime.c.

References gw_assert(), gwlist_delete(), gwlist_get(), gwlist_insert(), gwlist_len(), mime_entity_destroy(), mime_entity_duplicate(), MIMEEntity::multiparts, and MIMEEntity::start.

{

     MIMEEntity *m;
     
     gw_assert(e != NULL);
     gw_assert(i >= 0);
     gw_assert(i < gwlist_len(e->multiparts));
     
     m = gwlist_get(e->multiparts, i);
     gwlist_delete(e->multiparts, i, 1);
     gwlist_insert(e->multiparts, i, mime_entity_duplicate(newpart));
     if (m == e->start) e->start = NULL;

     mime_entity_destroy(m);
}

mime_entity_set_body()

void mime_entity_set_body	(	MIMEEntity *	e,
		Octstr *	body
	)

Definition at line 622 of file mime.c.

References MIMEEntity::body, gw_assert(), octstr_destroy(), and octstr_duplicate.

{
     gw_assert(e != NULL);
     gw_assert(body != NULL);

     if (e->body)
      octstr_destroy(e->body);
     e->body = octstr_duplicate(body);
}

mime_entity_to_octstr()

Octstr* mime_entity_to_octstr

(

MIMEEntity *

m

)

Definition at line 216 of file mime.c.

References MIMEEntity::body, boundary, finished, fix_boundary_element(), gw_assert(), gwlist_get(), gwlist_len(), MIMEEntity::headers, http_destroy_headers(), http_header_duplicate(), mime_entity_to_octstr(), MIMEEntity::multiparts, octstr_append(), octstr_create, octstr_destroy(), and octstr_imm().

Referenced by main(), mime_entity_body(), and mime_entity_to_octstr().

{
    Octstr *mime, *boundary = NULL;
    List *headers;
    long i;

    gw_assert(m != NULL && m->headers != NULL);

    mime = octstr_create("");

    /* 
     * First of all check if we have further MIME entity dependencies,
     * which means we have further MIMEEntities in our m->multiparts
     * list. If no, then add headers and body and return. This is the
     * easy case. Otherwise we have to loop inside our entities.
     */
    if (gwlist_len(m->multiparts) == 0) {
        for (i = 0; i < gwlist_len(m->headers); i++) {
            octstr_append(mime, gwlist_get(m->headers, i));
            octstr_append(mime, octstr_imm("\r\n"));
        }
        octstr_append(mime, octstr_imm("\r\n"));
        if (m->body != NULL)
            octstr_append(mime, m->body);
        goto finished;
    }

    /* This call ensures boundary exists, and returns it */
    fix_boundary_element(m->headers, &boundary);
    headers = http_header_duplicate(m->headers);

    /* headers */
    for (i = 0; i < gwlist_len(headers); i++) {
        octstr_append(mime, gwlist_get(headers, i));
        octstr_append(mime, octstr_imm("\r\n"));
    }
    http_destroy_headers(headers);
    octstr_append(mime, octstr_imm("\r\n")); /* Mark end of headers. */

    /* loop through all MIME multipart entities of this entity */
    for (i = 0; i < gwlist_len(m->multiparts); i++) {
        MIMEEntity *e = gwlist_get(m->multiparts, i);
        Octstr *body;

        octstr_append(mime, octstr_imm("\r\n--"));
        octstr_append(mime, boundary);
        octstr_append(mime, octstr_imm("\r\n"));

        /* call ourself to produce the MIME entity body */
        body = mime_entity_to_octstr(e);
        octstr_append(mime, body);

        octstr_destroy(body);
    }

    octstr_append(mime, octstr_imm("\r\n--"));
    octstr_append(mime, boundary);
    octstr_append(mime, octstr_imm("--\r\n"));

    octstr_destroy(boundary);

finished:

    return mime;
}

mime_http_to_entity()

MIMEEntity* mime_http_to_entity	(	List *	headers,
		Octstr *	body
	)

Definition at line 461 of file mime.c.

References MIMEEntity::body, gw_assert(), MIMEEntity::headers, and mime_something_to_entity().

{
    gw_assert(headers != NULL && body != NULL);

    return mime_something_to_entity(body, headers);
}

mime_multipart_start_elem()

MIMEEntity* mime_multipart_start_elem

(

MIMEEntity *

e

)

Definition at line 633 of file mime.c.

References cid_matches(), get_start_param(), gw_assert(), gwlist_get(), gwlist_len(), MIMEEntity::headers, http_header_value(), mime_entity_duplicate(), MIMEEntity::multiparts, octstr_destroy(), octstr_imm(), MIMEEntity::start, and start.

{
     gw_assert(e != NULL);
     
    /* If e->start element is not yet set, set it as follows:
     * - if content type is not set, then set it to NULL
     * - if the start element is not set but this is a multipart object, set
     *   it to first multipart element, else set it to null
     * - if the start element of the content type is set, find a matching object
     *    and set e->start accordingly.
     * Finally, return a copy of it.
     */
     if (!e->start) {
      Octstr *ctype = http_header_value(e->headers, octstr_imm("Content-Type"));
      Octstr *start = get_start_param(ctype);
      int i;
      
      if (!ctype)
           e->start = NULL;
      else if (!start) {
           if (gwlist_len(e->multiparts) > 0) 
            e->start = gwlist_get(e->multiparts, 0); 
           else 
            e->start = NULL;
      } else 
           for (i = 0; i < gwlist_len(e->multiparts); i++) {
            MIMEEntity *x = gwlist_get(e->multiparts, i);
            if (cid_matches(x->headers, start)) {
             e->start = x;
             break;
            }
           }
      
      if (ctype)
           octstr_destroy(ctype);
      if (start)
           octstr_destroy(start);
     }
     
     return (e->start) ? mime_entity_duplicate(e->start) : NULL;
}

mime_octstr_to_entity()

MIMEEntity* mime_octstr_to_entity

(

Octstr *

mime

)

Definition at line 453 of file mime.c.

References gw_assert(), and mime_something_to_entity().

Referenced by main(), and mime_something_to_entity().

{
    gw_assert(mime != NULL);

    return mime_something_to_entity(mime, NULL);
}

mime_replace_headers()

void mime_replace_headers	(	MIMEEntity *	e,
		List *	headers
	)

Definition at line 536 of file mime.c.

References gw_assert(), MIMEEntity::headers, http_destroy_headers(), http_header_duplicate(), and MIMEEntity::start.

Referenced by mime_entity_duplicate().

{
     gw_assert(e != NULL);
     gw_assert(headers != NULL);

     http_destroy_headers(e->headers);
     e->headers = http_header_duplicate(headers);
     e->start = NULL; /* clear it, since header change means it could have changed.*/
}