lib-mime/mime-types.h

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19
  20 /*
  21  * Copyright notice from original mutt:
  22  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  23  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
  24  *
  25  * This file is part of mutt-ng, see http://www.muttng.org/.
  26  * It's licensed under the GNU General Public License,
  27  * please see the file GPL in the top level source directory.
  28  */
  29
  30 #ifndef MUTT_LIB_MIME_MIME_TYPES_H
  31 #define MUTT_LIB_MIME_MIME_TYPES_H
  32
  33 #if HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <lib-lib/mem.h>
  38 #include <lib-lib/buffer.h>
  39 #include <lib-lib/list.h>
  40
  41 /* Content-Type */
  42 enum {
  43     TYPEOTHER,
  44     TYPEAUDIO,
  45     TYPEAPPLICATION,
  46     TYPEIMAGE,
  47     TYPEMESSAGE,
  48     TYPEMODEL,
  49     TYPEMULTIPART,
  50     TYPETEXT,
  51     TYPEVIDEO,
  52     TYPEANY
  53 };
  54
  55 /* Content-Transfer-Encoding */
  56 enum {
  57     ENCOTHER,
  58     ENC7BIT,
  59     ENC8BIT,
  60     ENCQUOTEDPRINTABLE,
  61     ENCBASE64,
  62     ENCBINARY,
  63     ENCUUENCODED,
  64 };
  65
  66 /* Content-Disposition values */
  67 enum {
  68     DISPINLINE,
  69     DISPATTACH,
  70     DISPFORMDATA
  71 };
  72
  73 /****************************************************************************/
  74 /* rfc822 addresses                                                         */
  75 /****************************************************************************/
  76
  77 typedef struct address_t {
  78     struct address_t *next;
  79     char *personal;               /* real name of address */
  80     char *mailbox;                /* mailbox and host address */
  81     int group;                    /* group mailbox? */
  82 } address_t;
  83
  84 DO_INIT(address_t, address);
  85 static inline void address_wipe(address_t *addr) {
  86     p_delete(&addr->personal);
  87     p_delete(&addr->mailbox);
  88 }
  89
  90 DO_NEW(address_t, address);
  91 DO_DELETE(address_t, address);
  92 DO_SLIST(address_t, address, address_delete);
  93
  94 /****************************************************************************/
  95 /* rfc822 header parameters                                                 */
  96 /****************************************************************************/
  97
  98 typedef struct parameter_t {
  99     struct parameter_t *next;
 100     char *attribute;
 101     char *value;
 102 } parameter_t;
 103
 104 DO_INIT(parameter_t, parameter);
 105 static inline void parameter_wipe(parameter_t *param) {
 106     p_delete(&param->attribute);
 107     p_delete(&param->value);
 108 }
 109
 110 DO_NEW(parameter_t, parameter);
 111 DO_DELETE(parameter_t, parameter);
 112 DO_SLIST(parameter_t, parameter, parameter_delete);
 113
 114 char *parameter_getval(parameter_t *, const char *);
 115 void parameter_setval(parameter_t **, const char *, const char *);
 116 void parameter_delval(parameter_t ** p, const char *);
 117 void parameter_set_boundary(parameter_t **);
 118
 119 int parameter_equal(const parameter_t *, const parameter_t *);
 120
 121 /****************************************************************************/
 122 /* rfc822 envelopes                                                         */
 123 /****************************************************************************/
 124
 125 typedef struct envelope_t {
 126     address_t *return_path;
 127     address_t *from;
 128     address_t *to;
 129     address_t *cc;
 130     address_t *bcc;
 131     address_t *sender;
 132     address_t *reply_to;
 133     address_t *mail_followup_to;
 134     char *list_post;              /* this stores a mailto URL, or nothing */
 135     char *subject;
 136     char *real_subj;              /* offset of the real subject */
 137     char *message_id;
 138     char *supersedes;
 139     char *date;
 140     char *x_label;
 141     char *organization;
 142 #ifdef USE_NNTP
 143     char *newsgroups;
 144     char *xref;
 145     char *followup_to;
 146     char *x_comment_to;
 147 #endif
 148     BUFFER *spam;
 149     string_list_t *references;             /* message references (in reverse order) */
 150     string_list_t *in_reply_to;            /* in-reply-to header content */
 151     string_list_t *userhdrs;               /* user defined headers */
 152     unsigned int irt_changed:1;   /* In-Reply-To changed to link/break threads */
 153     unsigned int refs_changed:1;  /* References changed to break thread */
 154 } ENVELOPE;
 155
 156 DO_INIT(ENVELOPE, envelope);
 157 void envelope_wipe(ENVELOPE*);
 158
 159 DO_NEW(ENVELOPE, envelope);
 160 DO_DELETE(ENVELOPE, envelope);
 161
 162 /****************************************************************************/
 163 /* rfc822 content-*                                                         */
 164 /****************************************************************************/
 165
 166 /* Information that helps in determing the Content-* of an attachment */
 167 typedef struct content {
 168     long hibin;                   /* 8-bit characters */
 169     long lobin;                   /* unprintable 7-bit chars (eg., control chars) */
 170     long crlf;                    /* '\r' and '\n' characters */
 171     long ascii;                   /* number of ascii chars */
 172     long linemax;                 /* length of the longest line in the file */
 173     unsigned int space:1;         /* whitespace at the end of lines? */
 174     unsigned int binary:1;        /* long lines, or CR not in CRLF pair */
 175     unsigned int from:1;          /* has a line beginning with "From "? */
 176     unsigned int dot:1;           /* has a line consisting of a single dot? */
 177     unsigned int cr:1;            /* has CR, even when in a CRLF pair */
 178 } CONTENT;
 179
 180
 181 /****************************************************************************/
 182 /* rfc822 Bodies                                                            */
 183 /****************************************************************************/
 184
 185 typedef struct body {
 186     char *xtype;                  /* content-type if x-unknown */
 187     char *subtype;                /* content-type subtype */
 188     parameter_t *parameter;         /* parameters of the content-type */
 189     char *description;            /* content-description */
 190     char *form_name;              /* Content-Disposition form-data name param */
 191     off_t hdr_offset;             /* offset in stream where the headers begin.
 192                                    * this info is used when invoking metamail,
 193                                    * where we need to send the headers of the
 194                                    * attachment
 195                                    */
 196     off_t offset;                 /* offset where the actual data begins */
 197     off_t length;                 /* length (in bytes) of attachment */
 198     char *filename;               /* when sending a message, this is the file
 199                                    * to which this structure refers
 200                                    */
 201     char *d_filename;             /* filename to be used for the
 202                                    * content-disposition header.
 203                                    * If NULL, filename is used
 204                                    * instead.
 205                                    */
 206     char *file_charset;           /* charset of attached file */
 207     CONTENT *content;             /* structure used to store detailed info about
 208                                    * the content of the attachment.  this is used
 209                                    * to determine what content-transfer-encoding
 210                                    * is required when sending mail.
 211                                    */
 212     struct body *next;            /* next attachment in the list */
 213     struct body *parts;           /* parts of a multipart or message/rfc822 */
 214     struct header *hdr;           /* header information for message/rfc822 */
 215
 216     struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 217
 218     signed short attach_count;
 219
 220     time_t stamp;                 /* time stamp of last
 221                                    * encoding update.
 222                                    */
 223
 224     unsigned int type:4;          /* content-type primary type */
 225     unsigned int encoding:3;      /* content-transfer-encoding */
 226     unsigned int disposition:2;   /* content-disposition */
 227     unsigned int use_disp:1;      /* Content-Disposition uses filename= ? */
 228     unsigned int unlink:1;        /* flag to indicate the the file named by
 229                                    * "filename" should be unlink()ed before
 230                                    * free()ing this structure
 231                                    */
 232     unsigned int tagged:1;
 233     unsigned int deleted:1;       /* attachment marked for deletion */
 234
 235     unsigned int noconv:1;        /* don't do character set conversion */
 236     unsigned int force_charset:1; /* send mode: don't adjust the character set
 237                                      when in send-mode. */
 238     unsigned int is_signed_data:1; /* A lot of MUAs don't indicate S/MIME
 239                                       signed-data correctly, e.g. they use
 240                                       foo.p7m even for the name of signed
 241                                       data.  This flag is used to keep track
 242                                       of the actual message type.  It gets set
 243                                       during the verification (which is done
 244                                       if the encryption try failed) and check
 245                                       by the function to figure the type of
 246                                       the message. */
 247
 248     unsigned int goodsig:1;       /* good cryptographic signature */
 249     unsigned int warnsig:1;       /* maybe good signature */
 250     unsigned int badsig:1;        /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 251
 252     unsigned int collapsed:1;     /* used by recvattach */
 253     unsigned int attach_qualifies:1;
 254 } BODY;
 255
 256
 257 /****************************************************************************/
 258 /* rfc822 Headers                                                           */
 259 /****************************************************************************/
 260
 261 typedef struct header {
 262     unsigned int security:11;     /* bit 0-6: flags, bit 7,8: application.
 263 see: crypt.h pgplib.h, smime.h */
 264
 265     unsigned int mime:1;          /* has a MIME-Version header? */
 266     unsigned int flagged:1;       /* marked important? */
 267     unsigned int tagged:1;
 268     unsigned int appended:1;      /* has been saved */
 269     unsigned int purged:1;        /* bypassing the trash folder */
 270     unsigned int deleted:1;
 271     unsigned int changed:1;
 272     unsigned int attach_del:1;    /* has an attachment marked for deletion */
 273     unsigned int old:1;
 274     unsigned int read:1;
 275     unsigned int expired:1;       /* already expired? */
 276     unsigned int superseded:1;    /* got superseded? */
 277     unsigned int replied:1;
 278     unsigned int subject_changed:1;       /* used for threading */
 279     unsigned int threaded:1;      /* used for threading */
 280     unsigned int display_subject:1;       /* used for threading */
 281     unsigned int recip_valid:1;   /* is_recipient is valid */
 282     unsigned int active:1;        /* message is not to be removed */
 283     unsigned int trash:1;         /* message is marked as trashed on disk.
 284                                    * This flag is used by the maildir_trash
 285                                    * option.
 286                                    */
 287
 288     /* timezone of the sender of this message */
 289     unsigned int zhours:5;
 290     unsigned int zminutes:6;
 291     unsigned int zoccident:1;
 292
 293     /* bits used for caching when searching */
 294     unsigned int searched:1;
 295     unsigned int matched:1;
 296
 297     /* tells whether the attach count is valid */
 298     unsigned int attach_valid:1;
 299
 300     /* the following are used to support collapsing threads  */
 301     unsigned int collapsed:1;     /* is this message part of a collapsed thread? */
 302     unsigned int limited:1;       /* is this message in a limited view?  */
 303     size_t num_hidden;            /* number of hidden messages in this view */
 304
 305     short recipient;              /* user_is_recipient()'s return value, cached */
 306
 307     int pair;                     /* color-pair to use when displaying in the index */
 308
 309     time_t date_sent;             /* time when the message was sent (UTC) */
 310     time_t received;              /* time when the message was placed in the mailbox */
 311     off_t offset;                 /* where in the stream does this message begin? */
 312     int lines;                    /* how many lines in the body of this message? */
 313     int index;                    /* the absolute (unsorted) message number */
 314     int msgno;                    /* number displayed to the user */
 315     int virtual;                  /* virtual message number */
 316     int score;
 317     ENVELOPE *env;                /* envelope information */
 318     BODY *content;                /* list of MIME parts */
 319     char *path;
 320 #ifdef USE_NNTP
 321     int article_num;
 322 #endif
 323
 324     char *tree;                   /* character string to print thread tree */
 325     struct thread *thread;
 326
 327     short attach_total;
 328
 329 #ifdef MIXMASTER
 330     string_list_t *chain;
 331 #endif
 332
 333     int refno;                    /* message number on server */
 334     void *data;                   /* driver-specific data */
 335
 336     char *maildir_flags;          /* unknown maildir flags */
 337 } HEADER;
 338
 339 DO_INIT(HEADER, header);
 340 void header_wipe(HEADER *);
 341
 342 DO_NEW(HEADER, header);
 343 DO_DELETE(HEADER, header);
 344
 345 #endif /* MUTT_LIB_MIME_MIME_TYPES_H */