update example mimeinfo tree
[claws.git] / src / procmime.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2001 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 __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
26
27 #ifdef HAVE_CONFIG_H
28 #  include "config.h"
29 #endif
30
31 #include <glib.h>
32 #include <stdio.h>
33
34 typedef struct _MimeType        MimeType;
35 typedef struct _MimeInfo        MimeInfo;
36
37 typedef enum
38 {
39         ENC_7BIT,
40         ENC_8BIT,
41         ENC_BINARY,
42         ENC_QUOTED_PRINTABLE,
43         ENC_BASE64,
44         ENC_X_UUENCODE,
45         ENC_UNKNOWN
46 } EncodingType;
47
48 #include "procmsg.h"
49
50 struct _MimeType
51 {
52         gchar *type;
53         gchar *sub_type;
54
55         gchar *extension;
56 };
57
58 typedef enum
59 {
60         MIMETYPE_TEXT,
61         MIMETYPE_IMAGE,
62         MIMETYPE_AUDIO,
63         MIMETYPE_VIDEO,
64         MIMETYPE_APPLICATION,
65         MIMETYPE_MESSAGE,
66         MIMETYPE_MULTIPART,
67         MIMETYPE_UNKNOWN,
68 } MimeMediaType;
69
70 /*
71  * An example of MimeInfo structure:
72  *
73  * 1: +- message/rfc822                 (root)
74  *      |
75  * 2:   +- multipart/mixed              (children of 1)
76  *      |  |
77  * 3:   |  +- multipart/alternative     (children of 2)
78  *      |  |  |
79  * 4:   |  |  +- text/plain             (children of 3)
80  *      |  |  |
81  * 5:   |  |  +- text/html              (next of 4)
82  *      |  |
83  * 6:   |  +- message/rfc822            (next of 3)
84  *      |     |
85  * 7:   |     ...                       (children of 6)
86  *      |
87  * 8:   +- image/jpeg                   (next of 2)
88  */
89
90 struct _MimeInfo
91 {
92         gchar *encoding;
93
94         gchar *charset;
95         gchar *name;
96
97         gchar *content_disposition;
98
99         MimeInfo *main;
100
101         gint level;
102
103         /* Internal data */
104         gchar *filename;
105         gboolean tmpfile;
106
107         MimeInfo *next;
108         MimeInfo *parent;
109         MimeInfo *children;
110
111         /* --- NEW MIME STUFF --- */
112         /* Content-Type */
113         MimeMediaType    type;
114         gchar           *subtype;
115
116         GHashTable      *parameters;
117
118         /* Content-Transfer-Encoding */
119         EncodingType     encoding_type;
120
121         /* Content-Description */
122         gchar           *description;
123
124         /* Content-ID */
125         gchar           *id;
126
127         guint            offset;
128         guint            length;
129
130         /* Privacy */
131         gchar *sigstatus;
132         gchar *sigstatus_full;
133         gboolean sig_ok;
134         gboolean sig_unknown;
135         gboolean sig_expired;
136         gboolean key_expired;
137 };
138
139 #define IS_BOUNDARY(s, bnd, len) \
140         (bnd && s[0] == '-' && s[1] == '-' && !strncmp(s + 2, bnd, len))
141
142 /* MimeInfo handling */
143
144 MimeInfo *procmime_mimeinfo_new         (void);
145 void procmime_mimeinfo_free_all         (MimeInfo       *mimeinfo);
146
147 MimeInfo *procmime_mimeinfo_insert      (MimeInfo       *parent,
148                                          MimeInfo       *mimeinfo);
149 void procmime_mimeinfo_replace          (MimeInfo       *old_mimeinfo,
150                                          MimeInfo       *new_mimeinfo);
151
152 MimeInfo *procmime_mimeinfo_next        (MimeInfo       *mimeinfo);
153
154 MimeInfo *procmime_scan_message         (MsgInfo        *msginfo);
155 void procmime_scan_multipart_message    (MimeInfo       *mimeinfo,
156                                          FILE           *fp);
157
158 /* scan headers */
159
160 void procmime_scan_encoding             (MimeInfo       *mimeinfo,
161                                          const gchar    *encoding);
162 void procmime_scan_content_type         (MimeInfo       *mimeinfo,
163                                          const gchar    *content_type);
164 void procmime_scan_content_disposition  (MimeInfo       *mimeinfo,
165                                          const gchar    *content_disposition);
166 void procmime_scan_content_description  (MimeInfo       *mimeinfo,
167                                          const gchar    *content_description);
168 void procmime_scan_subject              (MimeInfo       *mimeinfo,
169                                          const gchar    *subject);
170 MimeInfo *procmime_scan_mime_header     (FILE           *fp);
171
172 gboolean procmime_decode_content        (MimeInfo       *mimeinfo);
173 gint procmime_get_part                  (const gchar    *outfile,
174                                          MimeInfo       *mimeinfo);
175 FILE *procmime_get_text_content         (MimeInfo       *mimeinfo,
176                                          FILE           *infp);
177 FILE *procmime_get_first_text_content   (MsgInfo        *msginfo);
178
179 gboolean procmime_find_string_part      (MimeInfo       *mimeinfo,
180                                          const gchar    *filename,
181                                          const gchar    *str,
182                                          gboolean        case_sens);
183 gboolean procmime_find_string           (MsgInfo        *msginfo,
184                                          const gchar    *str,
185                                          gboolean        case_sens);
186
187 gchar *procmime_get_tmp_file_name       (MimeInfo       *mimeinfo);
188
189 gchar *procmime_get_mime_type           (const gchar    *filename);
190
191 GList *procmime_get_mime_type_list      (void);
192
193 EncodingType procmime_get_encoding_for_charset  (const gchar    *charset);
194 EncodingType procmime_get_encoding_for_file     (const gchar    *file);
195 const gchar *procmime_get_encoding_str          (EncodingType    encoding);
196 MimeInfo *procmime_scan_file                    (gchar          *filename);
197 MimeInfo *procmime_scan_queue_file              (gchar          *filename);
198 const gchar *procmime_get_type_str              (MimeMediaType   type);
199
200 void renderer_read_config(void);
201 void renderer_write_config(void);
202
203 #ifdef __cplusplus
204 }
205 #endif /* __cplusplus */
206
207 #endif /* __PROCMIME_H__ */