c0e56e0cb519af5691fa91a614482dd31c06d95a
[claws.git] / src / procmime.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2004 Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __PROCMIME_H__
21 #define __PROCMIME_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 typedef struct _MimeType        MimeType;
28 typedef struct _MimeInfo        MimeInfo;
29
30 #include "procmsg.h"
31 #include "utils.h"
32
33 typedef enum
34 {
35         ENC_7BIT,
36         ENC_8BIT,
37         ENC_BINARY,
38         ENC_QUOTED_PRINTABLE,
39         ENC_BASE64,
40         ENC_X_UUENCODE,
41         ENC_UNKNOWN
42 } EncodingType;
43
44 typedef enum
45 {
46         MIMETYPE_TEXT,
47         MIMETYPE_IMAGE,
48         MIMETYPE_AUDIO,
49         MIMETYPE_VIDEO,
50         MIMETYPE_APPLICATION,
51         MIMETYPE_MESSAGE,
52         MIMETYPE_MULTIPART,
53         MIMETYPE_UNKNOWN,
54 } MimeMediaType;
55
56 typedef enum
57 {
58         DISPOSITIONTYPE_INLINE,
59         DISPOSITIONTYPE_ATTACHMENT,
60         DISPOSITIONTYPE_UNKNOWN,
61 } DispositionType;
62
63 typedef enum
64 {
65         MIMECONTENT_EMPTY,
66         MIMECONTENT_FILE,               /* the file contains all content including sub parts */
67         MIMECONTENT_MEM,
68 } MimeContent;
69
70 #include <glib.h>
71 #include <stdio.h>
72
73 #include "procmsg.h"
74 #include "privacy.h"
75
76 struct _MimeType
77 {
78         gchar *type;
79         gchar *sub_type;
80
81         gchar *extension;
82 };
83
84 /*
85  * An example of MimeInfo structure:
86  *
87  * 1: +- message/rfc822                 (root)
88  *       |
89  * 2:    +- multipart/mixed             (children of 1)
90  *          |
91  * 3:       +- multipart/alternative    (children of 2)
92  *          |  |
93  * 4:       |  +- text/plain            (children of 3)
94  *          |  |
95  * 5:       |  +- text/html             (next of 4)
96  *          |
97  * 6:       +- message/rfc822           (next of 3)
98  *          |   |
99  * 7:       |   ...                     (children of 6)
100  *          |
101  * 8:       +- image/jpeg               (next of 6)
102  */
103
104 struct _MimeInfo
105 {
106         /* Internal data */
107         MimeContent content;
108         union
109         {
110                 gchar *filename;
111                 gchar *mem;
112         } data;
113         gboolean tmp;
114
115         GNode *node;
116
117         /* --- NEW MIME STUFF --- */
118         /* Content-Type */
119         MimeMediaType    type;
120         gchar           *subtype;
121
122         GHashTable      *typeparameters;
123
124         /* Content-Transfer-Encoding */
125         EncodingType     encoding_type;
126
127         /* Content-Description */
128         gchar           *description;
129
130         /* Content-ID */
131         gchar           *id;
132
133         guint            offset;
134         guint            length;
135
136         /* Content-Disposition */
137         DispositionType  disposition;
138         GHashTable      *dispositionparameters;
139
140         /* Privacy */
141         PrivacyData     *privacy;
142 };
143
144 #define IS_BOUNDARY(s, bnd, len) \
145         (bnd && s[0] == '-' && s[1] == '-' && !strncmp(s + 2, bnd, len))
146
147 #ifdef __cplusplus
148 extern "C" {
149 #endif /* __cplusplus */
150
151 /* MimeInfo handling */
152
153 MimeInfo *procmime_mimeinfo_new         (void);
154 void procmime_mimeinfo_free_all         (MimeInfo       *mimeinfo);
155
156 MimeInfo *procmime_mimeinfo_insert      (MimeInfo       *parent,
157                                          MimeInfo       *mimeinfo);
158 void procmime_mimeinfo_replace          (MimeInfo       *old_mimeinfo,
159                                          MimeInfo       *new_mimeinfo);
160
161 MimeInfo *procmime_mimeinfo_parent      (MimeInfo       *mimeinfo);
162 MimeInfo *procmime_mimeinfo_next        (MimeInfo       *mimeinfo);
163
164 MimeInfo *procmime_scan_message         (MsgInfo        *msginfo);
165 void procmime_scan_multipart_message    (MimeInfo       *mimeinfo,
166                                          FILE           *fp);
167 const gchar *procmime_mimeinfo_get_parameter
168                                         (MimeInfo       *mimeinfo,
169                                          const gchar    *name);
170
171 /* scan headers */
172
173 void procmime_scan_encoding             (MimeInfo       *mimeinfo,
174                                          const gchar    *encoding);
175 void procmime_scan_content_type         (MimeInfo       *mimeinfo,
176                                          const gchar    *content_type);
177 void procmime_scan_content_disposition  (MimeInfo       *mimeinfo,
178                                          const gchar    *content_disposition);
179 void procmime_scan_content_description  (MimeInfo       *mimeinfo,
180                                          const gchar    *content_description);
181 void procmime_scan_subject              (MimeInfo       *mimeinfo,
182                                          const gchar    *subject);
183 MimeInfo *procmime_scan_mime_header     (FILE           *fp);
184
185 gboolean procmime_decode_content        (MimeInfo       *mimeinfo);
186 gboolean procmime_encode_content        (MimeInfo       *mimeinfo, EncodingType encoding);
187 gint procmime_get_part                  (const gchar    *outfile,
188                                          MimeInfo       *mimeinfo);
189 FILE *procmime_get_text_content         (MimeInfo       *mimeinfo);
190 FILE *procmime_get_first_text_content   (MsgInfo        *msginfo);
191 FILE *procmime_get_first_encrypted_text_content
192                                         (MsgInfo        *msginfo);
193
194 gboolean procmime_find_string_part      (MimeInfo       *mimeinfo,
195                                          const gchar    *filename,
196                                          const gchar    *str,
197                                          StrFindFunc     find_func);
198 gboolean procmime_find_string           (MsgInfo        *msginfo,
199                                          const gchar    *str,
200                                          StrFindFunc     find_func);
201
202 gchar *procmime_get_tmp_file_name       (MimeInfo       *mimeinfo);
203 gchar *procmime_get_part_file_name      (MimeInfo       *mimeinfo);
204
205 gchar *procmime_get_mime_type           (const gchar    *filename);
206
207 GList *procmime_get_mime_type_list      (void);
208
209 EncodingType procmime_get_encoding_for_charset  (const gchar    *charset);
210 EncodingType procmime_get_encoding_for_text_file(const gchar    *file);
211 const gchar *procmime_get_encoding_str          (EncodingType    encoding);
212 MimeInfo *procmime_scan_file                    (const gchar    *filename);
213 MimeInfo *procmime_scan_queue_file              (const gchar    *filename);
214 const gchar *procmime_get_media_type_str        (MimeMediaType   type);
215 MimeMediaType procmime_get_media_type           (const gchar    *str);
216 gchar *procmime_get_content_type_str            (MimeMediaType   type,
217                                                  const gchar    *subtype);
218 void procmime_force_charset                     (const gchar    *str);
219 void procmime_force_encoding                    (EncodingType    encoding);
220 gboolean procmime_msginfo_is_encrypted          (MsgInfo        *msginfo);
221
222 void renderer_read_config(void);
223 void renderer_write_config(void);
224
225 gint procmime_write_mimeinfo(MimeInfo *mimeinfo, FILE *fp);
226
227 #ifdef __cplusplus
228 }
229 #endif /* __cplusplus */
230
231 #endif /* __PROCMIME_H__ */