aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-data-wrapper.c
blob: 3d05ae3b54ebf7f65f143014669d1aef41c1638d (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-data-wrapper.c : Abstract class for a data_wrapper */

/** THIS IS MOSTLY AN ABSTRACT CLASS THAT SHOULD HAVE BEEN AN
    INTERFACE. **/

/*
 *
 * Author :
 *  Bertrand Guiheneuf <bertrand@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 "camel-data-wrapper.h"

static GtkObjectClass *parent_class = NULL;

/* Returns the class for a CamelDataWrapper */
#define CDW_CLASS(so) CAMEL_DATA_WRAPPER_CLASS (GTK_OBJECT (so)->klass)


static void set_input_stream (CamelDataWrapper *data_wrapper,
                  CamelStream *stream);
static CamelStream *get_input_stream (CamelDataWrapper *data_wrapper);
static void set_output_stream (CamelDataWrapper *data_wrapper,
                   CamelStream *stream);
static CamelStream *get_output_stream (CamelDataWrapper *data_wrapper);

static void construct_from_stream (CamelDataWrapper *data_wrapper,
                   CamelStream *stream);
static void write_to_stream (CamelDataWrapper *data_wrapper,
                 CamelStream *stream);
static void set_mime_type (CamelDataWrapper *data_wrapper,
               const gchar *mime_type);
static gchar *get_mime_type (CamelDataWrapper *data_wrapper);
static GMimeContentField *get_mime_type_field (CamelDataWrapper *data_wrapper);
static void set_mime_type_field (CamelDataWrapper *data_wrapper,
                 GMimeContentField *mime_type);
static void finalize (GtkObject *object);

static void
camel_data_wrapper_class_init (CamelDataWrapperClass *camel_data_wrapper_class)
{
    GtkObjectClass *gtk_object_class =
        GTK_OBJECT_CLASS (camel_data_wrapper_class);

    parent_class = gtk_type_class (gtk_object_get_type ());

    /* virtual method definition */
    camel_data_wrapper_class->write_to_stream = write_to_stream;
    camel_data_wrapper_class->construct_from_stream = construct_from_stream;
    camel_data_wrapper_class->set_mime_type = set_mime_type;
    camel_data_wrapper_class->get_mime_type = get_mime_type;
    camel_data_wrapper_class->get_mime_type_field = get_mime_type_field;
    camel_data_wrapper_class->set_mime_type_field = set_mime_type_field;

    camel_data_wrapper_class->set_input_stream = set_input_stream;
    camel_data_wrapper_class->get_input_stream = get_input_stream;
    camel_data_wrapper_class->set_output_stream = set_output_stream;
    camel_data_wrapper_class->get_output_stream = get_output_stream;

    /* virtual method overload */
    gtk_object_class->finalize = finalize;
}

static void
camel_data_wrapper_init (gpointer object, gpointer klass)
{
    CamelDataWrapper *camel_data_wrapper = CAMEL_DATA_WRAPPER (object);

    camel_data_wrapper->mime_type = gmime_content_field_new (NULL, NULL);
}



GtkType
camel_data_wrapper_get_type (void)
{
    static GtkType camel_data_wrapper_type = 0;

    if (!camel_data_wrapper_type) {
        GtkTypeInfo camel_data_wrapper_info =
        {
            "CamelDataWrapper",
            sizeof (CamelDataWrapper),
            sizeof (CamelDataWrapperClass),
            (GtkClassInitFunc) camel_data_wrapper_class_init,
            (GtkObjectInitFunc) camel_data_wrapper_init,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };

        camel_data_wrapper_type = gtk_type_unique (gtk_object_get_type (), &camel_data_wrapper_info);
    }

    return camel_data_wrapper_type;
}


static void
finalize (GtkObject *object)
{
    CamelDataWrapper *camel_data_wrapper = CAMEL_DATA_WRAPPER (object);

    if (camel_data_wrapper->mime_type)
        gmime_content_field_unref (camel_data_wrapper->mime_type);

    if (camel_data_wrapper->input_stream)
        gtk_object_unref (GTK_OBJECT (camel_data_wrapper->input_stream));

    if (camel_data_wrapper->output_stream)
        gtk_object_unref (GTK_OBJECT (camel_data_wrapper->output_stream));

    parent_class->finalize (object);
}


static void
set_input_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    if (data_wrapper->input_stream)
        gtk_object_unref (GTK_OBJECT (data_wrapper->input_stream));

    data_wrapper->input_stream = stream;

    if (!data_wrapper->output_stream && stream)
        set_output_stream (data_wrapper, stream);

    if (stream)
        gtk_object_ref (GTK_OBJECT (stream));
}

/**
 * camel_data_wrapper_set_input_stream:
 * @data_wrapper: a data wrapper
 * @stream: a stream that can be read from, or %NULL
 *
 * This sets the data wrapper's input stream from @stream, most likely
 * causing @data_wrapper to initialize itself from that stream.
 * @data_wrapper may or may not notice future changes to @stream, and
 * if @stream is closed before @data_wrapper is destroyed, it could
 * be arbitrarily bad. This function may fail, but there is no way
 * for the caller to know this.
 *
 * If @data_wrapper has no output stream, its output stream will also
 * be set to @stream.
 **/
void
camel_data_wrapper_set_input_stream (CamelDataWrapper *data_wrapper,
                     CamelStream *stream)
{
    g_return_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper));
    g_return_if_fail (stream == NULL || CAMEL_IS_STREAM (stream));

    CDW_CLASS (data_wrapper)->set_input_stream (data_wrapper, stream);
}


static CamelStream *
get_input_stream (CamelDataWrapper *data_wrapper)
{
    return data_wrapper->input_stream;
}

/**
 * camel_data_wrapper_get_input_stream:
 * @data_wrapper: a data wrapper
 *
 * Return value: @data_wrapper's input stream
 **/
CamelStream *
camel_data_wrapper_get_input_stream (CamelDataWrapper *data_wrapper)
{
    g_return_val_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper), NULL);

    return CDW_CLASS (data_wrapper)->get_input_stream (data_wrapper);
}


static void
set_output_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    if (data_wrapper->output_stream)
        gtk_object_unref (GTK_OBJECT (data_wrapper->output_stream));

    data_wrapper->output_stream = stream;
    if (stream)
        gtk_object_ref (GTK_OBJECT (stream));
}

/**
 * camel_data_wrapper_set_output_stream:
 * @data_wrapper: a data wrapper
 * @stream: a stream that can be read from
 *
 * This sets the data wrapper's output stream to @stream. Unlike
 * camel_data_wrapper_set_input_stream(), this function has no side
 * effects.
 *
 * The output stream should theoretically be a stream that, if read
 * from, produces the data wrapper's contents. However, while certain
 * pieces of code assume this, nothing enforces it.
 **/
void
camel_data_wrapper_set_output_stream (CamelDataWrapper *data_wrapper,
                      CamelStream *stream)
{
    g_return_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper));
    g_return_if_fail (CAMEL_IS_STREAM (stream));

    CDW_CLASS (data_wrapper)->set_output_stream (data_wrapper, stream);
}


static CamelStream *
get_output_stream (CamelDataWrapper *data_wrapper)
{
    return data_wrapper->output_stream;
}

/**
 * camel_data_wrapper_get_output_stream:
 * @data_wrapper: a data wrapper
 *
 * Return value: @data_wrapper's output stream
 **/
CamelStream *
camel_data_wrapper_get_output_stream (CamelDataWrapper *data_wrapper)
{
    g_return_val_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper), NULL);

    return CDW_CLASS (data_wrapper)->get_output_stream (data_wrapper);
}


static void
write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    gchar tmp_buf[4096];
    gint nb_read;
    gint nb_written;
    CamelStream *output_stream;

    output_stream = camel_data_wrapper_get_output_stream (data_wrapper);
    if (!output_stream)
        return;

    camel_stream_reset (output_stream);

    while (!camel_stream_eos (output_stream)) {
        nb_read = camel_stream_read (output_stream, tmp_buf, 4096);
        nb_written = 0;
        while (nb_written < nb_read)
            nb_written += camel_stream_write (stream, tmp_buf + nb_written, nb_read - nb_written);
    }
}


/**
 * camel_data_wrapper_write_to_stream:
 * @data_wrapper: a data wrapper
 * @stream: stream for data to be written to
 *
 * Writes the data content to @stream in a machine-independent format
 * appropriate for the data. It should be possible to construct an
 * equivalent data wrapper object later by passing this stream to
 * camel_data_construct_from_stream().
 *
 * Of course, this operation might fail, and of course, there's no
 * way for you to find out about it.
 **/
void
camel_data_wrapper_write_to_stream (CamelDataWrapper *data_wrapper,
                    CamelStream *stream)
{
    g_return_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper));
    g_return_if_fail (CAMEL_IS_STREAM (stream));

    CDW_CLASS (data_wrapper)->write_to_stream (data_wrapper, stream);
}


static void
construct_from_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    /* nothing */
}

/**
 * camel_data_wrapper_construct_from_stream:
 * @data_wrapper: a data wrapper
 * @stream: a stream that can be read from
 *
 * This constructs a data wrapper object from a stream. It is not clear
 * how this differs from camel_data_wrapper_set_input_stream(), nor is
 * it clear how it affects the data wrapper's input and output streams.
 *
 * This could fail, but you can't know if it did.
 **/
void
camel_data_wrapper_construct_from_stream (CamelDataWrapper *data_wrapper,
                      CamelStream *stream)
{
    g_return_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper));
    g_return_if_fail (CAMEL_IS_STREAM (stream));

    CDW_CLASS (data_wrapper)->construct_from_stream (data_wrapper, stream);
}


static void
set_mime_type (CamelDataWrapper *data_wrapper, const gchar *mime_type)
{
    gmime_content_field_construct_from_string (data_wrapper->mime_type,
                           mime_type);
}

/**
 * camel_data_wrapper_set_mime_type:
 * @data_wrapper: a data wrapper
 * @mime_type: the text representation of a MIME type
 *
 * This sets the data wrapper's MIME type.
 * It might fail, but you won't know. It will allow you to set
 * Content-Type parameters on the data wrapper, which are meaningless.
 * You should not be allowed to change the MIME type of a data wrapper
 * that contains data, or at least, if you do, it should invalidate the
 * data.
 **/
void
camel_data_wrapper_set_mime_type (CamelDataWrapper *data_wrapper,
                  const gchar *mime_type)
{
    g_return_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper));
    g_return_if_fail (mime_type != NULL);

    CDW_CLASS (data_wrapper)->set_mime_type (data_wrapper, mime_type);
}

static gchar *
get_mime_type (CamelDataWrapper *data_wrapper)
{
    return gmime_content_field_get_mime_type (data_wrapper->mime_type);
}

/**
 * camel_data_wrapper_get_mime_type:
 * @data_wrapper: a data wrapper
 *
 * Return value: the text form of the data wrapper's MIME type
 **/
gchar *
camel_data_wrapper_get_mime_type (CamelDataWrapper *data_wrapper)
{
    g_return_val_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper), NULL);

    return CDW_CLASS (data_wrapper)->get_mime_type (data_wrapper);
}


static GMimeContentField *
get_mime_type_field (CamelDataWrapper *data_wrapper)
{
    return data_wrapper->mime_type;
}

/**
 * camel_data_wrapper_get_mime_type_field:
 * @data_wrapper: a data wrapper
 *
 * Return value: the parsed form of the data wrapper's MIME type
 **/
GMimeContentField *
camel_data_wrapper_get_mime_type_field (CamelDataWrapper *data_wrapper)
{
    g_return_val_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper), NULL);

    return CDW_CLASS (data_wrapper)->get_mime_type_field (data_wrapper);
}


/**
 * camel_data_wrapper_set_mime_type_field:
 * @data_wrapper: a data wrapper
 * @mime_type: the parsed representation of a MIME type
 *
 * This sets the data wrapper's MIME type. It suffers from the same
 * flaws as camel_data_wrapper_set_mime_type.
 **/
static void
set_mime_type_field (CamelDataWrapper *data_wrapper,
             GMimeContentField *mime_type)
{
    g_return_if_fail (CAMEL_IS_DATA_WRAPPER (data_wrapper));
    g_return_if_fail (mime_type != NULL);

    if (data_wrapper->mime_type)
        gmime_content_field_unref (data_wrapper->mime_type);
    data_wrapper->mime_type = mime_type;
}

void
camel_data_wrapper_set_mime_type_field (CamelDataWrapper *data_wrapper,
                    GMimeContentField *mime_type)
{
    CDW_CLASS (data_wrapper)->set_mime_type_field (data_wrapper,
                               mime_type);
}