8373a12e3001efa36c129948c6bdafb52f246310
[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 HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <stdio.h>
29
30 typedef struct _MimeType        MimeType;
31 typedef struct _MimeInfo        MimeInfo;
32
33 #include "procmsg.h"
34
35 typedef enum
36 {
37         ENC_7BIT,
38         ENC_8BIT,
39         ENC_QUOTED_PRINTABLE,
40         ENC_BASE64,
41         ENC_X_UUENCODE,
42         ENC_UNKNOWN
43 } EncodingType;
44
45 typedef enum
46 {
47         MIME_TEXT,
48         MIME_TEXT_HTML,
49         MIME_MESSAGE_RFC822,
50         MIME_APPLICATION,
51         MIME_APPLICATION_OCTET_STREAM,
52         MIME_MULTIPART,
53         MIME_IMAGE,
54         MIME_AUDIO,
55         MIME_TEXT_ENRICHED,
56         MIME_UNKNOWN
57 } ContentType;
58
59 struct _MimeType
60 {
61         gchar *type;
62         gchar *sub_type;
63
64         gchar *extension;
65 };
66
67 /*
68  * An example of MimeInfo structure:
69  *
70  * multipart/mixed            root  <-+ parent
71  *                                    |
72  *   multipart/alternative      children <-+ parent
73  *                                         |
74  *     text/plain                 children  --+
75  *                                            |
76  *     text/html                  next      <-+
77  *
78  *   message/rfc822             next  <-+ main
79  *                                      |
80  *                                sub (capsulated message)
81  *
82  *   image/jpeg                 next
83  */
84
85 struct _MimeInfo
86 {
87         gchar *encoding;
88
89         EncodingType encoding_type;
90         ContentType  mime_type;
91
92         gchar *content_type;
93         gchar *charset;
94         gchar *name;
95         gchar *boundary;
96
97         gchar *content_disposition;
98         gchar *filename;
99
100         glong fpos;
101         guint size;
102
103         MimeInfo *main;
104         MimeInfo *sub;
105
106         MimeInfo *next;
107         MimeInfo *parent;
108         MimeInfo *children;
109
110 #if USE_GPGME
111         MimeInfo *plaintext;
112         gchar *plaintextfile;
113         gchar *sigstatus;
114         gchar *sigstatus_full;
115 #endif
116
117         gint level;
118 };
119
120 #define IS_BOUNDARY(s, bnd, len) \
121         (bnd && s[0] == '-' && s[1] == '-' && !strncmp(s + 2, bnd, len))
122
123 /* MimeInfo handling */
124
125 MimeInfo *procmime_mimeinfo_new         (void);
126 void procmime_mimeinfo_free             (MimeInfo       *mimeinfo);
127 void procmime_mimeinfo_free_all         (MimeInfo       *mimeinfo);
128
129 MimeInfo *procmime_mimeinfo_insert      (MimeInfo       *parent,
130                                          MimeInfo       *mimeinfo);
131 void procmime_mimeinfo_replace          (MimeInfo       *old,
132                                          MimeInfo       *new);
133
134 MimeInfo *procmime_mimeinfo_next        (MimeInfo       *mimeinfo);
135
136 MimeInfo *procmime_scan_message         (MsgInfo        *msginfo);
137 void procmime_scan_multipart_message    (MimeInfo       *mimeinfo,
138                                          FILE           *fp);
139
140 /* scan headers */
141
142 void procmime_scan_encoding             (MimeInfo       *mimeinfo,
143                                          const gchar    *encoding);
144 void procmime_scan_content_type         (MimeInfo       *mimeinfo,
145                                          const gchar    *content_type);
146 void procmime_scan_content_disposition  (MimeInfo       *mimeinfo,
147                                          const gchar    *content_disposition);
148 void procmime_scan_content_description  (MimeInfo       *mimeinfo,
149                                          const gchar    *content_description);
150 void procmime_scan_subject              (MimeInfo       *mimeinfo,
151                                          const gchar    *subject);
152 MimeInfo *procmime_scan_mime_header     (FILE           *fp);
153
154 FILE *procmime_decode_content           (FILE           *outfp,
155                                          FILE           *infp,
156                                          MimeInfo       *mimeinfo);
157 gint procmime_get_part                  (const gchar    *outfile,
158                                          const gchar    *infile,
159                                          MimeInfo       *mimeinfo);
160 FILE *procmime_get_text_content         (MimeInfo       *mimeinfo,
161                                          FILE           *infp);
162 FILE *procmime_get_first_text_content   (MsgInfo        *msginfo);
163
164 gboolean procmime_find_string_part      (MimeInfo       *mimeinfo,
165                                          const gchar    *filename,
166                                          const gchar    *str,
167                                          gboolean        case_sens);
168 gboolean procmime_find_string           (MsgInfo        *msginfo,
169                                          const gchar    *str,
170                                          gboolean        case_sens);
171
172 gchar *procmime_get_tmp_file_name       (MimeInfo       *mimeinfo);
173
174 ContentType procmime_scan_mime_type     (const gchar    *mime_type);
175 gchar *procmime_get_mime_type           (const gchar    *filename);
176
177 GList *procmime_get_mime_type_list      (void);
178
179 EncodingType procmime_get_encoding_for_charset  (const gchar    *charset);
180 EncodingType procmime_get_encoding_for_file     (const gchar    *file);
181 const gchar *procmime_get_encoding_str          (EncodingType    encoding);
182
183 void renderer_read_config(void);
184 void renderer_write_config(void);
185
186 #endif /* __PROCMIME_H__ */