aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-mime-part.c
blob: e2a6a731f94079044ae36579d2e251d4658475d7 (plain) (blame)
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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */
/* camelMimePart.c : Abstract class for a mime_part */

/* 
 * Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
 *      Michael Zucchi <notzed@helixcode.com>
 *
 * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

#include <config.h>
#include <string.h>
#include "camel-mime-part.h"
#include <stdio.h>
#include "gmime-content-field.h"
#include "string-utils.h"
#include "hash-table-utils.h"
#include "camel-mime-part-utils.h"
#include <ctype.h>
#include "camel-mime-parser.h"
#include "camel-stream-mem.h"

#define d(x)

typedef enum {
    HEADER_UNKNOWN,
    HEADER_DESCRIPTION,
    HEADER_DISPOSITION,
    HEADER_CONTENT_ID,
    HEADER_ENCODING,
    HEADER_CONTENT_MD5,
    HEADER_CONTENT_LANGUAGES,
    HEADER_CONTENT_TYPE
} CamelHeaderType;


static GHashTable *header_name_table;


static CamelMediumClass *parent_class=NULL;

/* Returns the class for a CamelMimePart */
#define CMP_CLASS(so) CAMEL_MIME_PART_CLASS (GTK_OBJECT(so)->klass)
#define CDW_CLASS(so) CAMEL_DATA_WRAPPER_CLASS (GTK_OBJECT(so)->klass)
#define CMD_CLASS(so) CAMEL_MEDIUM_CLASS (GTK_OBJECT(so)->klass)

/* from GtkObject */
static void            finalize (GtkObject *object);

/* from CamelDataWrapper */
static int             write_to_stream                 (CamelDataWrapper *data_wrapper, 
                            CamelStream *stream);
static int         construct_from_stream           (CamelDataWrapper *dw, CamelStream *s);

/* from CamelMedia */ 
static void            add_header                      (CamelMedium *medium, const char *header_name, const void *header_value);
static void            set_header                      (CamelMedium *medium, const char *header_name, const void *header_value);
static void            remove_header                   (CamelMedium *medium, const char *header_name);
static const void     *get_header                      (CamelMedium *medium, const char *header_name);

static void            set_content_object              (CamelMedium *medium, CamelDataWrapper *content);

/* from camel mime parser */
static int             construct_from_parser           (CamelMimePart *, CamelMimeParser *);

/* forward references */
static void set_disposition (CamelMimePart *mime_part, const gchar *disposition);


/* loads in a hash table the set of header names we */
/* recognize and associate them with a unique enum  */
/* identifier (see CamelHeaderType above)           */
static void
init_header_name_table()
{
    header_name_table = g_hash_table_new (g_strcase_hash, g_strcase_equal);
    g_hash_table_insert (header_name_table, "Content-Description", (gpointer)HEADER_DESCRIPTION);
    g_hash_table_insert (header_name_table, "Content-Disposition", (gpointer)HEADER_DISPOSITION);
    g_hash_table_insert (header_name_table, "Content-id", (gpointer)HEADER_CONTENT_ID);
    g_hash_table_insert (header_name_table, "Content-Transfer-Encoding", (gpointer)HEADER_ENCODING);
    g_hash_table_insert (header_name_table, "Content-MD5", (gpointer)HEADER_CONTENT_MD5);
    g_hash_table_insert (header_name_table, "Content-Type", (gpointer)HEADER_CONTENT_TYPE);
    
}

static void
camel_mime_part_class_init (CamelMimePartClass *camel_mime_part_class)
{
    CamelMediumClass *camel_medium_class = CAMEL_MEDIUM_CLASS (camel_mime_part_class);
    CamelDataWrapperClass *camel_data_wrapper_class = CAMEL_DATA_WRAPPER_CLASS (camel_mime_part_class);
    GtkObjectClass *gtk_object_class = GTK_OBJECT_CLASS (camel_data_wrapper_class);

    parent_class = gtk_type_class (camel_medium_get_type ());
    init_header_name_table();

    camel_mime_part_class->construct_from_parser = construct_from_parser;
    
    /* virtual method overload */   
    camel_medium_class->add_header                = add_header;
    camel_medium_class->set_header                = set_header;
    camel_medium_class->get_header                = get_header;
    camel_medium_class->remove_header             = remove_header;
    camel_medium_class->set_content_object        = set_content_object;

    camel_data_wrapper_class->write_to_stream     = write_to_stream;
    camel_data_wrapper_class->construct_from_stream= construct_from_stream;

    gtk_object_class->finalize                    = finalize;
}

static void
camel_mime_part_init (gpointer   object,  gpointer   klass)
{
    CamelMimePart *camel_mime_part = CAMEL_MIME_PART (object);
    
    camel_mime_part->content_type         = gmime_content_field_new ("text", "plain");
    camel_mime_part->description          = NULL;
    camel_mime_part->disposition          = NULL;
    camel_mime_part->content_id           = NULL;
    camel_mime_part->content_MD5          = NULL;
    camel_mime_part->content_languages    = NULL;
    camel_mime_part->encoding             = CAMEL_MIME_PART_ENCODING_DEFAULT;

    camel_mime_part->temp_message_buffer  = NULL;   
    camel_mime_part->content_input_stream = NULL;
}




GtkType
camel_mime_part_get_type (void)
{
    static GtkType camel_mime_part_type = 0;
    
    if (!camel_mime_part_type)  {
        GtkTypeInfo camel_mime_part_info =  
        {
            "CamelMimePart",
            sizeof (CamelMimePart),
            sizeof (CamelMimePartClass),
            (GtkClassInitFunc) camel_mime_part_class_init,
            (GtkObjectInitFunc) camel_mime_part_init,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };
        
        camel_mime_part_type = gtk_type_unique (camel_medium_get_type (), &camel_mime_part_info);
    }
    
    return camel_mime_part_type;
}


static void           
finalize (GtkObject *object)
{
    CamelMimePart *mime_part = CAMEL_MIME_PART (object);

    g_free (mime_part->description);
    g_free (mime_part->content_id);
    g_free (mime_part->content_MD5);
    string_list_free (mime_part->content_languages);
    header_disposition_unref(mime_part->disposition);
    
    if (mime_part->content_type) gmime_content_field_unref (mime_part->content_type);
    if (mime_part->temp_message_buffer) g_byte_array_free (mime_part->temp_message_buffer, TRUE);

    if (mime_part->content_input_stream) gtk_object_unref (GTK_OBJECT (mime_part->content_input_stream));

    GTK_OBJECT_CLASS (parent_class)->finalize (object);
}

/* **** */

static gboolean
process_header(CamelMedium *medium, const char *header_name, const char *header_value)
{
    CamelMimePart *mime_part = CAMEL_MIME_PART (medium);
    CamelHeaderType header_type;
    char *text;

    /* Try to parse the header pair. If it corresponds to something   */
    /* known, the job is done in the parsing routine. If not,         */
    /* we simply add the header in a raw fashion                      */

    /* FIXMME: MUST check fields for validity before adding them! */

    header_type = (CamelHeaderType) g_hash_table_lookup (header_name_table, header_name);
    switch (header_type) {
    case HEADER_DESCRIPTION: /* raw header->utf8 conversion */
        text = header_decode_string(header_value);
        g_free(mime_part->description);
        mime_part->description = text;
        break;
    case HEADER_DISPOSITION:
        set_disposition (mime_part, header_value);
        break;
    case HEADER_CONTENT_ID:
        text = header_msgid_decode(header_value);
        g_free(mime_part->content_id);
        mime_part->content_id = text;
        break;
    case HEADER_ENCODING:
        text = header_token_decode(header_value);
        mime_part->encoding = camel_mime_part_encoding_from_string (text);
        g_free(text);
        break;
    case HEADER_CONTENT_MD5:
        g_free(mime_part->content_MD5);
        mime_part->content_MD5 = g_strdup(header_value);
        break;
    case HEADER_CONTENT_TYPE: 
        gmime_content_field_construct_from_string (mime_part->content_type, header_value);
        break;
    default:
        return FALSE;
    }
    return TRUE;
}


static void
set_header (CamelMedium *medium, const char *header_name, const void *header_value)
{
    CamelMimePart *part = (CamelMimePart *)medium;

    process_header(medium, header_name, header_value);
    header_raw_replace(&part->headers, header_name, header_value, -1);
}

static void
add_header (CamelMedium *medium, const char *header_name, const void *header_value)
{
    CamelMimePart *part = (CamelMimePart *)medium;

    /* Try to parse the header pair. If it corresponds to something   */
    /* known, the job is done in the parsing routine. If not,         */
    /* we simply add the header in a raw fashion                      */

    /* FIXMME: MUST check fields for validity before adding them! */

    /* If it was one of the headers we handled, it must be unique, set it instead of add */
    if (process_header(medium, header_name, header_value))
        header_raw_replace(&part->headers, header_name, header_value, -1);
    else
        header_raw_append(&part->headers, header_name, header_value, -1);
}

static void
remove_header (CamelMedium *medium, const char *header_name)
{
    CamelMimePart *part = (CamelMimePart *)medium;

    process_header(medium, header_name, NULL);
    header_raw_remove(&part->headers, header_name);
}

static const void *
get_header (CamelMedium *medium, const char *header_name)
{
    CamelMimePart *part = (CamelMimePart *)medium;

    return header_raw_find(&part->headers, header_name, NULL);
}


/* **** Content-Description */
void
camel_mime_part_set_description (CamelMimePart *mime_part, const gchar *description)
{
    camel_medium_set_header (CAMEL_MEDIUM (mime_part),
                 "Content-Description", description);
}

const gchar *
camel_mime_part_get_description (CamelMimePart *mime_part)
{
    return mime_part->description;
}

/* **** Content-Disposition */

static void
set_disposition (CamelMimePart *mime_part, const gchar *disposition)
{
    header_disposition_unref(mime_part->disposition);
    if (disposition)
        mime_part->disposition = header_disposition_decode(disposition);
    else
        mime_part->disposition = NULL;
}


void
camel_mime_part_set_disposition (CamelMimePart *mime_part, const gchar *disposition)
{
    char *text;

    /* we poke in a new disposition (so we dont lose 'filename', etc) */
    if (mime_part->disposition == NULL) {
        set_disposition(mime_part, disposition);
    }
    if (mime_part->disposition != NULL) {
        g_free(mime_part->disposition->disposition);
        mime_part->disposition->disposition = g_strdup(disposition);
    }
    text = header_disposition_format(mime_part->disposition);

    camel_medium_set_header (CAMEL_MEDIUM (mime_part),
                 "Content-Description", text);

    g_free(text);
}

const gchar *
camel_mime_part_get_disposition (CamelMimePart *mime_part)
{
    if (mime_part->disposition)
        return (mime_part->disposition)->disposition;
    else
        return NULL;
}


/* **** Content-Disposition: filename="xxx" */

void
camel_mime_part_set_filename (CamelMimePart *mime_part, gchar *filename)
{
    char *str;
    if (mime_part->disposition == NULL)
        mime_part->disposition = header_disposition_decode("attachment");

    header_set_param(&mime_part->disposition->params, "filename", filename);
    str = header_disposition_format(mime_part->disposition);

    camel_medium_set_header (CAMEL_MEDIUM (mime_part),
                 "Content-Disposition", str);
    g_free(str);
}

const gchar *
camel_mime_part_get_filename (CamelMimePart *mime_part)
{
    if (mime_part->disposition)
        return header_param(mime_part->disposition->params, "filename");
    return NULL;
}


/* **** Content-ID: */

void
camel_mime_part_set_content_id (CamelMimePart *mime_part, const char *contentid)
{
    camel_medium_set_header (CAMEL_MEDIUM (mime_part), "Content-ID",
                 contentid);
}

const gchar *
camel_mime_part_get_content_id (CamelMimePart *mime_part)
{
    return mime_part->content_id;
}

/* **** Content-MD5: */

void
camel_mime_part_set_content_MD5 (CamelMimePart *mime_part, const char *md5)
{
    camel_medium_set_header (CAMEL_MEDIUM (mime_part), "Content-MD5", md5);
}

const gchar *
camel_mime_part_get_content_MD5 (CamelMimePart *mime_part)
{
    return mime_part->content_MD5;
}

/* **** Content-Transfer-Encoding: */

void
camel_mime_part_set_encoding (CamelMimePart *mime_part,
                  CamelMimePartEncodingType encoding)
{
    const char *text;

    text = camel_mime_part_encoding_to_string (encoding);
    camel_medium_set_header (CAMEL_MEDIUM (mime_part),
                 "Content-Transfer-Encoding", text);
}

const CamelMimePartEncodingType
camel_mime_part_get_encoding (CamelMimePart *mime_part)
{
    return mime_part->encoding;
}

/* FIXME: do something with this stuff ... */

void
camel_mime_part_set_content_languages (CamelMimePart *mime_part, GList *content_languages)
{
    if (mime_part->content_languages) string_list_free (mime_part->content_languages);
    mime_part->content_languages = content_languages;

    /* FIXME: translate to a header and set it */
}

const GList *
camel_mime_part_get_content_languages (CamelMimePart *mime_part)
{
    return mime_part->content_languages;
}


/* **** */

/* **** Content-Type: */

void 
camel_mime_part_set_content_type (CamelMimePart *mime_part, gchar *content_type)
{
    camel_medium_set_header (CAMEL_MEDIUM (mime_part),
                 "Content-Type", content_type);
}

GMimeContentField *
camel_mime_part_get_content_type (CamelMimePart *mime_part)
{
    return mime_part->content_type;
}

/*********/



static void
set_content_object (CamelMedium *medium, CamelDataWrapper *content)
{
    CamelMimePart *mime_part = CAMEL_MIME_PART (medium);
    GMimeContentField *object_content_field;

    parent_class->set_content_object (medium, content);

    object_content_field = camel_data_wrapper_get_mime_type_field (content);
    if (mime_part->content_type &&
        (mime_part->content_type != object_content_field)) {
        char *txt;

        txt = header_content_type_format(object_content_field?object_content_field->content_type:NULL);
        camel_medium_set_header (CAMEL_MEDIUM (mime_part),
                     "Content-Type", txt);
    }
}

/**********************************************************************/
#ifdef WHPT
#warning : WHPT is already defined !!!!!!
#endif
#define WHPT gmime_write_header_pair_to_stream


static int
write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    CamelMimePart *mp = CAMEL_MIME_PART (data_wrapper);
    CamelMedium *medium = CAMEL_MEDIUM (data_wrapper);
    CamelDataWrapper *content;
    int total = 0, count;

    d(printf("mime_part::write_to_stream\n"));

    /* FIXME: something needs to be done about this ... */
    /* FIXME: need to count these bytes too */
#warning content-languages should be stored as a header
    gmime_write_header_with_glist_to_stream (stream, "Content-Language", mp->content_languages,", ");

    if (mp->headers) {
        struct _header_raw *h = mp->headers;
        while (h) {
            if ( (count = camel_stream_write_strings (stream, h->name, isspace(h->value[0])?":":": ", h->value, "\n", NULL) ) == -1 )
                return -1;
            total += count;
            h = h->next;
        }
    }

    if ( (count = camel_stream_write_string(stream,"\n")) == -1)
        return -1;
    total += count;

    content = camel_medium_get_content_object (medium);
    if (content) {
        if ( (count = camel_data_wrapper_write_to_stream(content, stream)) == -1 )
            return -1;
        total += count;
    } else {
        g_warning("No content for medium, nothing to write");
    }
    return total;
}

/* mime_part */
static int
construct_from_parser(CamelMimePart *dw, CamelMimeParser *mp)
{
    struct _header_raw *headers;
    char *buf;
    int len;

    d(printf("mime_part::construct_from_parser()\n"));

    switch (camel_mime_parser_step(mp, &buf, &len)) {
    case HSCAN_HEADER:
    case HSCAN_MESSAGE:
    case HSCAN_MULTIPART:
        /* we have the headers, build them into 'us' */
        headers = camel_mime_parser_headers_raw(mp);
        while (headers) {
            camel_medium_add_header((CamelMedium *)dw, headers->name, headers->value);
            headers = headers->next;
        }
        camel_mime_part_construct_content_from_parser(dw, mp);
        break;
    default:
        g_warning("Invalid state encountered???: %d", camel_mime_parser_state(mp));
    }

    d(printf("mime_part::construct_from_parser() leaving\n"));
#warning "Need to work out how to detect a (fatally) bad parse in the parser"
    return 0;
}

/**
 * camel_mime_part_construct_from_parser:
 * @mime_part: 
 * @mp: 
 * 
 * 
 * 
 * Return value: 
 **/
int
camel_mime_part_construct_from_parser(CamelMimePart *mime_part, CamelMimeParser *mp)
{
    return CMP_CLASS (mime_part)->construct_from_parser (mime_part, mp);
}

static int
construct_from_stream(CamelDataWrapper *dw, CamelStream *s)
{
    CamelMimeParser *mp;
    int ret;

    d(printf("mime_part::construct_from_stream()\n"));

    mp = camel_mime_parser_new();
    if (camel_mime_parser_init_with_stream(mp, s) == -1) {
        g_warning("Cannot create parser for stream");
        ret = -1;
    } else {
        ret = camel_mime_part_construct_from_parser((CamelMimePart *)dw, mp);
    }
    gtk_object_unref((GtkObject *)mp);
    return ret;
}


const gchar *
camel_mime_part_encoding_to_string (CamelMimePartEncodingType encoding)
{
    switch (encoding) {
    case CAMEL_MIME_PART_ENCODING_DEFAULT:
    case CAMEL_MIME_PART_ENCODING_7BIT:
        return "7bit";
    case CAMEL_MIME_PART_ENCODING_8BIT:
        return "8bit";
    case CAMEL_MIME_PART_ENCODING_BASE64:
        return "base64";
    case CAMEL_MIME_PART_ENCODING_QUOTEDPRINTABLE:
        return "quoted-printable";
    default:
        break;
    }
    return "";
}



/* FIXME I am not sure this is the correct way to do this.  */
CamelMimePartEncodingType
camel_mime_part_encoding_from_string (const gchar *string)
{
    if (string == NULL)
        return CAMEL_MIME_PART_ENCODING_DEFAULT;
    else if (strcasecmp (string, "7bit") == 0)
        return CAMEL_MIME_PART_ENCODING_7BIT;
    else if (strcasecmp (string, "8bit") == 0)
        return CAMEL_MIME_PART_ENCODING_8BIT;
    else if (strcasecmp (string, "base64") == 0)
        return CAMEL_MIME_PART_ENCODING_BASE64;
    else if (strcasecmp (string, "quoted-printable") == 0)
        return CAMEL_MIME_PART_ENCODING_QUOTEDPRINTABLE;
    else
        /* FIXME?  Spit a warning?  */
        return CAMEL_MIME_PART_ENCODING_DEFAULT;
}


/******************************/
/**  Misc utility functions  **/

/**
 * camel_mime_part_new:
 *
 * Return value: a new CamelMimePart
 **/
CamelMimePart *
camel_mime_part_new (void)
{
    return (CamelMimePart *)gtk_object_new (CAMEL_MIME_PART_TYPE, NULL);
}

/**
 * camel_mime_part_set_content:
 * @camel_mime_part: Mime part
 * @data: data to put into the part
 * @length: length of @data
 * @type: Content-Type of the data
 * 
 * Utility function used to set the content of a mime part object to 
 * be the provided data. If @length is 0, this routine can be used as
 * a way to remove old content (in which case @data and @type are
 * ignored and may be %NULL).
 **/
void 
camel_mime_part_set_content (CamelMimePart *camel_mime_part,
                 const char *data, int length,
                 const char *type) /* why on earth is the type last? */
{
    CamelMedium *medium = CAMEL_MEDIUM (camel_mime_part);

    if (length) {
        CamelDataWrapper *dw;
        CamelStream *stream;

        dw = camel_data_wrapper_new();
        camel_data_wrapper_set_mime_type (dw, type);
        stream = camel_stream_mem_new_with_buffer (data, length);
        camel_data_wrapper_construct_from_stream (dw, stream);
        camel_medium_set_content_object (medium, dw);
    } else {
        if (medium->content)
            gtk_object_unref ( (GtkObject *)medium->content);
        medium->content = NULL;
    }
}