chiark - git - mdw - disorder/blob - lib/mime.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005, 2007 Richard Kettlewell
   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, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * 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
  18  * USA
  19  */
  20 /** @file lib/mime.h
  21  * @brief Support for MIME and allied protocols
  22  */
  23
  24 #ifndef MIME_H
  25 #define MIME_H
  26
  27 int mime_content_type(const char *s,
  28                       char **typep,
  29                       char **parameternamep,
  30                       char **parametervaluep);
  31 /* Parse a content-type value.  returns 0 on success, -1 on error.
  32  * paramaternamep and parametervaluep are only set if present.
  33  * type and parametername are forced to lower case.
  34  */
  35
  36 const char *mime_parse(const char *s,
  37                        int (*callback)(const char *name, const char *value,
  38                                        void *u),
  39                        void *u);
  40 /* Parse a MIME message.  Calls CALLBACK for each header field, then returns a
  41  * pointer to the decoded body (might or might not point back into the original
  42  * string). */
  43
  44 int mime_multipart(const char *s,
  45                    int (*callback)(const char *s, void *u),
  46                    const char *boundary,
  47                    void *u);
  48 /* call CALLBACK with each part of multipart document [s,s+n) */
  49
  50 int mime_rfc2388_content_disposition(const char *s,
  51                                      char **dispositionp,
  52                                      char **parameternamep,
  53                                      char **parametervaluep);
  54 /* Parse an RFC2388-style content-disposition field */
  55
  56 char *mime_qp(const char *s);
  57
  58 /** @brief Parsed form of an HTTP Cookie: header field
  59  *
  60  * See <a href="http://tools.ietf.org/html/rfc2109">RFC 2109</a>.
  61  */
  62 struct cookiedata {
  63   /** @brief @c $Version or NULL if not set */
  64   char *version;
  65
  66   /** @brief List of cookies */
  67   struct cookie *cookies;
  68
  69   /** @brief Number of cookies */
  70   int ncookies;
  71 };
  72
  73 /** @brief A parsed cookie
  74  *
  75  * See <a href="http://tools.ietf.org/html/rfc2109">RFC 2109</a> and @ref
  76  * cookiedata.
  77  */
  78 struct cookie {
  79   /** @brief Cookie name */
  80   char *name;
  81
  82   /** @brief Cookie value */
  83   char *value;
  84
  85   /** @brief Cookie path */
  86   char *path;
  87
  88   /** @brief Cookie domain */
  89   char *domain;
  90
  91 };
  92
  93 int parse_cookie(const char *s,
  94                  struct cookiedata *cd);
  95 const struct cookie *find_cookie(const struct cookiedata *cd,
  96                                  const char *name);
  97 char *quote822(const char *s, int force);
  98 char *mime_to_qp(const char *text);
  99 const char *mime_encode_text(const char *text,
 100                              const char **charsetp,
 101                              const char **encodingp);
 102
 103 #endif /* MIME_H */
 104
 105 /*
 106 Local Variables:
 107 c-basic-offset:2
 108 comment-column:40
 109 fill-column:79
 110 End:
 111 */