aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-data-wrapper.c
blob: cd4fcce7de6a1fd86e5d41e9fe7a9e6763ec3f58 (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelDataWrapper.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 HelixCode (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"
#include "camel-log.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 my_set_input_stream (CamelDataWrapper *data_wrapper, CamelStream *stream);
static CamelStream *my_get_input_stream (CamelDataWrapper *data_wrapper);
static void my_set_output_stream (CamelDataWrapper *data_wrapper, CamelStream *stream);
static CamelStream *my_get_output_stream (CamelDataWrapper *data_wrapper);

static void my_construct_from_stream (CamelDataWrapper *data_wrapper, CamelStream *stream);
static void my_write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream);
static void my_set_mime_type (CamelDataWrapper *data_wrapper, const gchar *mime_type);
static gchar *my_get_mime_type (CamelDataWrapper *data_wrapper);
static GMimeContentField *my_get_mime_type_field (CamelDataWrapper *data_wrapper);
static void my_set_mime_type_field (CamelDataWrapper *data_wrapper, GMimeContentField *mime_type);
static CamelStream *my_get_stream (CamelDataWrapper *data_wrapper);
static void my_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 = my_write_to_stream;
    camel_data_wrapper_class->construct_from_stream = my_construct_from_stream;
    camel_data_wrapper_class->set_mime_type = my_set_mime_type;
    camel_data_wrapper_class->get_mime_type = my_get_mime_type;
    camel_data_wrapper_class->get_mime_type_field = my_get_mime_type_field;
    camel_data_wrapper_class->set_mime_type_field = my_set_mime_type_field;
    camel_data_wrapper_class->get_stream = my_get_stream;

    camel_data_wrapper_class->set_input_stream = my_set_input_stream;
    camel_data_wrapper_class->get_input_stream = my_get_input_stream;
    camel_data_wrapper_class->set_output_stream = my_set_output_stream;
    camel_data_wrapper_class->get_output_stream = my_get_output_stream;

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





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

    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_init:: Entering\n");
    camel_data_wrapper->mime_type = gmime_content_field_new (NULL, NULL);
    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_init:: Leaving\n");
}



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           
my_finalize (GtkObject *object)
{
    CamelDataWrapper *camel_data_wrapper = CAMEL_DATA_WRAPPER (object);

    CAMEL_LOG_FULL_DEBUG ("Entering CamelDataWrapper::finalize\n");
    CAMEL_LOG_FULL_DEBUG  ("CamelDataWrapper::finalize, finalizing object %p\n", 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);
    CAMEL_LOG_FULL_DEBUG ("Leaving CamelDataWrapper::finalize\n");
}






static void 
my_set_input_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    g_assert (data_wrapper);
    data_wrapper->input_stream = stream;
    if (!data_wrapper->output_stream && stream)
        data_wrapper->output_stream = stream;   
        
    if (stream)
        gtk_object_ref (GTK_OBJECT (stream));
}


void 
camel_data_wrapper_set_input_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    g_assert (data_wrapper);
    CDW_CLASS(data_wrapper)->set_input_stream (data_wrapper, stream);
}





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

CamelStream * 
camel_data_wrapper_get_input_stream (CamelDataWrapper *data_wrapper)
{
    g_assert (data_wrapper);
    return CDW_CLASS(data_wrapper)->get_input_stream (data_wrapper);
}




static void 
my_set_output_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    g_assert (data_wrapper);
    data_wrapper->output_stream = stream;
    if (stream)
        gtk_object_ref (GTK_OBJECT (stream));
}

void 
camel_data_wrapper_set_output_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    g_assert (data_wrapper);
    CDW_CLASS(data_wrapper)->set_output_stream (data_wrapper, stream);
}




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

CamelStream * 
camel_data_wrapper_get_output_stream (CamelDataWrapper *data_wrapper)
{
    g_assert (data_wrapper);
    return CDW_CLASS(data_wrapper)->get_output_stream (data_wrapper);
}





/**
 * my_write_to_stream: write data content in a byte stream
 * @data_wrapper: the data wrapper object
 * @stream byte stream where data will be written 
 * 
 * This method must be overriden by subclasses
 * Data must be written in the bytes stream
 * in a architecture independant fashion. 
 * If data is a standard data (for example an jpg image)
 * it must be serialized in the strea exactly as it 
 * would be saved on disk. A simple dump of the stream in
 * a file should be sufficient for the data to be 
 * re-read by a foreign application.  
 * 
 **/
static void
my_write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    gchar tmp_buf[4096];
    gint nb_read;
    gint nb_written;
    CamelStream *output_stream;

    /* 
     * default implementation that uses the input 
     * stream and stream it in a blocking way.
     */
    g_assert (data_wrapper);
    g_assert (stream);
    
    output_stream = camel_data_wrapper_get_output_stream (data_wrapper);

    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: write data in a stream
 * @data_wrapper: the data wrapper object
 * @stream: byte stream where data will be written 
 *
 * Write data content in a stream. Data is stored in a machine
 * independant format. 
 * 
 **/
void 
camel_data_wrapper_write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_write_to_stream:: Entering\n");
    CDW_CLASS(data_wrapper)->write_to_stream (data_wrapper, stream);
    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_write_to_stream:: Leaving\n");
}






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

void 
camel_data_wrapper_construct_from_stream (CamelDataWrapper *data_wrapper, CamelStream *stream)
{
    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_construct_from_stream:: Entering\n");
    CDW_CLASS(data_wrapper)->construct_from_stream (data_wrapper, stream);
    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_construct_from_stream:: Leaving\n");
}



static void
my_set_mime_type (CamelDataWrapper *data_wrapper, const gchar *mime_type)
{
    CAMEL_LOG_FULL_DEBUG ( "CamelDataWrapper::set_mime_type Entering\n");
    g_assert (mime_type);
    gmime_content_field_construct_from_string (data_wrapper->mime_type, mime_type);
    CAMEL_LOG_FULL_DEBUG ( "CamelDataWrapper::set_mime_type Leaving\n");
}

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

static gchar *
my_get_mime_type (CamelDataWrapper *data_wrapper)
{
    gchar *mime_type;

    mime_type = gmime_content_field_get_mime_type (data_wrapper->mime_type);
    return mime_type;
}

gchar *
camel_data_wrapper_get_mime_type (CamelDataWrapper *data_wrapper)
{
    CAMEL_LOG_FULL_DEBUG ( "camel_data_wrapper_get_mime_type:: Entering before returning\n");
    return CDW_CLASS(data_wrapper)->get_mime_type (data_wrapper);
}


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

GMimeContentField *
camel_data_wrapper_get_mime_type_field (CamelDataWrapper *data_wrapper)
{
    return CDW_CLASS(data_wrapper)->get_mime_type_field (data_wrapper);
}


static void
my_set_mime_type_field (CamelDataWrapper *data_wrapper, GMimeContentField *mime_type)
{
    if (data_wrapper->mime_type) gmime_content_field_free (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);
}

static CamelStream *
my_get_stream (CamelDataWrapper *data_wrapper)
{
    /* This needs to be implemented in subclasses.  */
    return NULL;
}

CamelStream *
camel_data_wrapper_get_stream (CamelDataWrapper *data_wrapper)
{
    return CDW_CLASS(data_wrapper)->get_stream (data_wrapper);
}