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