]> diplodocus.org Git - nmh/blobdiff - h/mhparse.h
Garbage collect closefds()
[nmh] / h / mhparse.h
index e8e7be880c307bed392915d89717c6be4157dfe0..96a37b0aaa3d9e3591407f5b7b868f0259401fa7 100644 (file)
@@ -1,13 +1,7 @@
-
-/*
- * mhparse.h -- definitions for parsing/building of MIME content
+/* mhparse.h -- definitions for parsing/building of MIME content
  *           -- (mhparse.c/mhbuildsbr.c)
  */
 
  *           -- (mhparse.c/mhbuildsbr.c)
  */
 
-#define        NPARTS  50
-#define        NTYPES  20
-#define        NPARMS  10
-
 /*
  * Abstract type for header fields
  */
 /*
  * Abstract type for header fields
  */
@@ -16,9 +10,10 @@ typedef struct hfield *HF;
 /*
  * Abstract types for MIME parsing/building
  */
 /*
  * Abstract types for MIME parsing/building
  */
-typedef struct cefile  *CE;
-typedef struct CTinfo  *CI;
-typedef struct Content *CT;
+typedef struct cefile          *CE;
+typedef struct CTinfo          *CI;
+typedef struct Content         *CT;
+typedef struct Parameter       *PM;
 
 /*
  * type for Init function (both type and transfer encoding)
 
 /*
  * type for Init function (both type and transfer encoding)
@@ -39,10 +34,20 @@ typedef unsigned long (*SizeCEFunc) (CT);
 struct hfield {
     char *name;                /* field name */
     char *value;       /* field body */
 struct hfield {
     char *name;                /* field name */
     char *value;       /* field body */
-    int hf_encoding;   /* internal flag for transfer encoding to use */
     HF next;           /* link to next header field */
 };
 
     HF next;           /* link to next header field */
 };
 
+/*
+ * Structure for holding MIME parameter elements.
+ */
+struct Parameter {
+    char *pm_name;     /* Parameter name */
+    char *pm_value;    /* Parameter value */
+    char *pm_charset;  /* Parameter character set (optional) */
+    char *pm_lang;     /* Parameter language tag (optional) */
+    PM   pm_next;      /* Pointer to next element */
+};
+
 /*
  * Structure for storing parsed elements
  * of the Content-Type component.
 /*
  * Structure for storing parsed elements
  * of the Content-Type component.
@@ -50,8 +55,8 @@ struct hfield {
 struct CTinfo {
     char *ci_type;             /* content type     */
     char *ci_subtype;          /* content subtype  */
 struct CTinfo {
     char *ci_type;             /* content type     */
     char *ci_subtype;          /* content subtype  */
-    char *ci_attrs[NPARMS + 2];        /* attribute names  */
-    char *ci_values[NPARMS];   /* attribute values */
+    PM   ci_first_pm;          /* Pointer to first MIME parameter */
+    PM   ci_last_pm;           /* Pointer to last MIME parameter */
     char *ci_comment;          /* RFC-822 comments */
     char *ci_magic;
 };
     char *ci_comment;          /* RFC-822 comments */
     char *ci_magic;
 };
@@ -68,6 +73,36 @@ struct cefile {
 
 /*
  * Primary structure for handling Content (Entity)
 
 /*
  * Primary structure for handling Content (Entity)
+ *
+ * Some more explanation of this:
+ *
+ * This structure recursively describes a complete MIME message.
+ * At the top level, the c_first_hf list has a list of all message
+ * headers.  If the content-type is multipart (c_type == CT_MULTIPART)
+ * then c_ctparams will contain a pointer to a struct multipart.
+ * A struct multipart contains (among other things) a linked list
+ * of struct part elements, and THOSE contain a pointer to the sub-part's
+ * Content structure.
+ *
+ * An extra note for message/external-body parts.  The enclosing
+ * content structure is marked as a message/external-body; the c_ctparams
+ * contains a pointer to a struct exbody, which contains a pointer to
+ * (among other things) the "real" content (e.g., application/octet-stream).
+ * The "real" content structure has the c_ctexbody pointer back to the
+ * same struct exbody sees in the enclosing content structure (the struct
+ * exbody contains parent pointers if you need to traverse up the content
+ * structure).  Hopefully this makes it clearer:
+ *
+ * Enclosing content:
+ *   Type: message/external-body
+ *   c_ctparams: pointer to "struct exbody"
+ *   c_ctexbody: NULL
+ *
+ * "Real" content:
+ *   Type: application/octet-stream (or whatever)
+ *   c_ctparams: NULL
+ *   c_ctexbody: pointer to "struct exbody"
+ *
  */
 struct Content {
     /* source (read) file */
  */
 struct Content {
     /* source (read) file */
@@ -89,6 +124,9 @@ struct Content {
     char *c_id;                        /* Content-ID:                       */
     char *c_descr;             /* Content-Description:              */
     char *c_dispo;             /* Content-Disposition:              */
     char *c_id;                        /* Content-ID:                       */
     char *c_descr;             /* Content-Description:              */
     char *c_dispo;             /* Content-Disposition:              */
+    char *c_dispo_type;                /* Type of Content-Disposition       */
+    PM c_dispo_first;          /* Pointer to first disposition parm */
+    PM c_dispo_last;           /* Pointer to last disposition parm  */
     char *c_partno;            /* within multipart content          */
 
     /* Content-Type info */
     char *c_partno;            /* within multipart content          */
 
     /* Content-Type info */
@@ -99,6 +137,7 @@ struct Content {
     /* Content-Transfer-Encoding info (decoded contents) */
     struct cefile c_cefile;    /* structure holding decoded content */
     int        c_encoding;             /* internal flag for encoding type   */
     /* Content-Transfer-Encoding info (decoded contents) */
     struct cefile c_cefile;    /* structure holding decoded content */
     int        c_encoding;             /* internal flag for encoding type   */
+    int c_reqencoding;         /* Requested encoding (by mhbuild)   */
 
     /* Content-MD5 info */
     int        c_digested;             /* have we seen this header before?  */
 
     /* Content-MD5 info */
     int        c_digested;             /* have we seen this header before?  */
@@ -115,8 +154,7 @@ struct Content {
     SizeCEFunc  c_cesizefnx;   /* size of decoded contents          */
 
     int        c_umask;                /* associated umask                  */
     SizeCEFunc  c_cesizefnx;   /* size of decoded contents          */
 
     int        c_umask;                /* associated umask                  */
-    pid_t c_pid;               /* process doing display             */
-    int        c_rfc934;               /* rfc934 compatibility flag         */
+    int        c_rfc934;               /* RFC 934 compatibility flag        */
 
     char *c_showproc;          /* default, if not in profile        */
     char *c_termproc;          /* for charset madness...            */
 
     char *c_showproc;          /* default, if not in profile        */
     char *c_termproc;          /* for charset madness...            */
@@ -168,6 +206,10 @@ struct Content {
 /* Structure for text content */
 struct text {
     int        tx_charset;             /* flag for character set */
 /* Structure for text content */
 struct text {
     int        tx_charset;             /* flag for character set */
+    int lf_line_endings;        /* Whether to use CR LF (0) or LF (1) line
+                                   endings.  The meaning of 0 was selected so
+                                   that CR LF is the default, in accordance
+                                   with RFC 2046, Sec. 4.1.1, Par. 1. */
 };
 
 /*
 };
 
 /*
@@ -180,6 +222,7 @@ struct text {
 #define        MULTI_ALTERNATE 0x02
 #define        MULTI_DIGEST    0x03
 #define        MULTI_PARALLEL  0x04
 #define        MULTI_ALTERNATE 0x02
 #define        MULTI_DIGEST    0x03
 #define        MULTI_PARALLEL  0x04
+#define        MULTI_RELATED   0x05
 
 /* Structure for subparts of a multipart content */
 struct part {
 
 /* Structure for subparts of a multipart content */
 struct part {
@@ -273,18 +316,219 @@ extern struct str2init str2methods[];
 /*
  * prototypes
  */
 /*
  * prototypes
  */
-int pidcheck (int);
 CT parse_mime (char *);
 CT parse_mime (char *);
+
+/*
+ * Translate a composition file into a MIME data structure.  Arguments are:
+ *
+ * infile      - Name of input filename
+ * autobuild    - A flag to indicate if the composition file parser is
+ *               being run in automatic mode or not.  In auto mode,
+ *               if a MIME-Version header is encountered it is assumed
+ *               that the composition file is already in MIME format
+ *               and will not be processed further.  Otherwise, an
+ *               error is generated.
+ * dist                - A flag to indicate if we are being run by "dist".  In
+ *               that case, add no MIME headers to the message.  Existing
+ *               headers will still be encoded by RFC 2047.
+ * directives  - A flag to control whether or not build directives are
+ *               processed by default.
+ * encoding    - The default encoding to use when doing RFC 2047 header
+ *               encoding.  Must be one of CE_UNKNOWN, CE_BASE64, or
+ *               CE_QUOTED.
+ * maxunencoded        - The maximum line length before the default encoding for
+ *               text parts is quoted-printable.
+ * verbose     - If 1, output verbose information during message composition
+ *
+ * Returns a CT structure describing the resulting MIME message.  If the
+ * -auto flag is set and a MIME-Version header is encountered, the return
+ * value is NULL.
+ */
+CT build_mime (char *infile, int autobuild, int dist, int directives,
+              int encoding, size_t maxunencoded, int verbose);
+
 int add_header (CT, char *, char *);
 int get_ctinfo (char *, CT, int);
 int params_external (CT, int);
 int open7Bit (CT, char **);
 void close_encoding (CT);
 int add_header (CT, char *, char *);
 int get_ctinfo (char *, CT, int);
 int params_external (CT, int);
 int open7Bit (CT, char **);
 void close_encoding (CT);
-void free_content (CT);
-char *ct_type_str (int);
-char *ct_subtype_str (int, int);
-const struct str2init *get_ct_init (int);
-const char *ce_str (int);
-const struct str2init *get_ce_method (const char *);
+char *ct_type_str (int) CONST;
+char *ct_subtype_str (int, int) CONST;
+int ct_str_type (const char *) PURE;
+int ct_str_subtype (int, const char *) PURE;
+const struct str2init *get_ct_init (int) PURE;
+const char *ce_str (int) CONST;
+const struct str2init *get_ce_method (const char *) PURE;
+char *content_charset (CT);
+void reverse_alternative_parts (CT);
+
+/*
+ * Given a list of messages, display information about them on standard
+ * output.
+ *
+ * Arguments are:
+ *
+ * cts         - An array of CT elements of messages that need to be
+ *               displayed.  Array is terminated by a NULL.
+ * headsw      - If 1, display a column header.
+ * sizesw      - If 1, display the size of the part.
+ * verbosw     - If 1, display verbose information
+ * debugsw     - If 1, turn on debugging for the output.
+ * disposw     - If 1, display MIME part disposition information.
+ *
+ */
+void list_all_messages(CT *cts, int headsw, int sizesw, int verbosw,
+                      int debugsw, int disposw);
+
+/*
+ * List the content information of a single MIME part on stdout.
+ *
+ * Arguments are:
+ *
+ * ct          - MIME Content structure to display.
+ * toplevel    - If set, we're at the top level of a message
+ * realsize    - If set, determine the real size of the content
+ * verbose     - If set, output verbose information
+ * debug       - If set, turn on debugging for the output
+ * dispo       - If set, display MIME part disposition information.
+ *
+ * Returns OK on success, NOTOK otherwise.
+ */
+int list_content(CT ct, int toplevel, int realsize, int verbose, int debug,
+                int dispo);
+
+/*
+ * Display content-appropriate information on MIME parts, descending recursively
+ * into multipart content if appropriate.  Uses list_content() for displaying
+ * generic information.
+ *
+ * Arguments and return value are the same as list_content().
+ */
+int list_switch(CT ct, int toplevel, int realsize, int verbose, int debug,
+               int dispo);
+
+/*
+ * Given a linked list of parameters, build an output string for them.  This
+ * string is designed to be concatenated on an already-built header.
+ *
+ * Arguments are:
+ *
+ * initialwidth        - Current width of the header.  Used to compute when to wrap
+ *               parameters on the first line.  The following lines will
+ *               be prefixed by a tab (\t) character.
+ * params      - Pointer to head of linked list of parameters.
+ * offsetout   - The final line offset after all the parameters have been
+ *               output.  May be NULL.
+ * external    - If set, outputting an external-body type and will not
+ *               output a "body" parameter.
+ * Returns a pointer to the resulting parameter string.  This string must
+ * be free()'d by the caller.  Returns NULL on error.
+ */
+char *output_params(size_t initialwidth, PM params, int *offsetout,
+                   int external);
+
+/*
+ * Encode a parameter value using RFC 2231 encode.
+ *
+ * Arguments are:
+ *
+ * pm           - PM containing the parameter value and related info.
+ * output       - Output buffer.
+ * len          - Size, in octets, of output buffer.
+ * valuelen     - Number of characters in the value
+ * valueoff     - Offset into value field (pm->pm_value).
+ * index        - If 0, output character set and language tag.
+ */
+size_t encode_param(PM pm, char *output, size_t len, size_t valuelen,
+                    size_t valueoff, int index);
+
+/*
+ * Add a parameter to the parameter linked list.
+ *
+ * Arguments are:
+ *
+ * first       - Pointer to head of linked list
+ * last                - Pointer to tail of linked list
+ * name                - Name of parameter
+ * value       - Value of parameter
+ * nocopy      - If set, will use the pointer values directly for "name"
+ *               and "value" instead of making their own copy.  These
+ *               pointers will be free()'d later by the MIME routines, so
+ *               they should not be used after calling this function!
+ *
+ * Returns allocated parameter element
+ */
+PM add_param(PM *first, PM *last, char *name, char *value, int nocopy);
+
+/*
+ * Replace (or add) a parameter to the parameter linked list.
+ *
+ * If the named parameter already exists on the parameter linked list,
+ * replace the value with the new one.  Otherwise add it to the linked
+ * list.  All parameters are identical to add_param().
+ */
+PM replace_param(PM *first, PM *last, char *name, char *value, int nocopy);
+
+/*
+ * Retrieve a parameter value from a parameter linked list.  Convert to the
+ * local character set if required.
+ *
+ * Arguments are:
+ *
+ * first       - Pointer to head of parameter linked list.
+ * name                - Name of parameter.
+ * replace     - If characters in the parameter list cannot be converted to
+ *               the local character set, replace with this character.
+ * fetchonly   - If true, return pointer to original value, no conversion
+ *               performed.
+ *
+ * Returns parameter value if found, NULL otherwise.  Memory must be free()'d
+ * unless fetchonly is set.
+ */
+
+char *get_param(PM first, const char *name, char replace, int fetchonly);
+
+/*
+ * Fetch a parameter value from a parameter structure, converting it to
+ * the local character set.
+ *
+ * Arguments are:
+ *
+ * pm          - Pointer to parameter structure
+ * replace     - If characters in the parameter list cannot be converted to
+ *               the local character set, replace with this character.
+ *
+ * Returns a pointer to the parameter value.  Memory is stored in an
+ * internal buffer, so the returned value is only valid until the next
+ * call to get_param_value() or get_param() (get_param() uses get_param_value()
+ * internally).
+ */
+char *get_param_value(PM pm, char replace);
 
 extern int checksw;    /* Add Content-MD5 field */
 
 extern int checksw;    /* Add Content-MD5 field */
+
+/*
+ * mhstore
+ * Put it here because it uses the CT typedef.
+ */
+typedef struct mhstoreinfo *mhstoreinfo_t;
+mhstoreinfo_t mhstoreinfo_create(CT *, char *, const char *, int, int);
+int mhstoreinfo_files_not_clobbered(const mhstoreinfo_t) PURE;
+void mhstoreinfo_free(mhstoreinfo_t);
+void store_all_messages (mhstoreinfo_t);
+
+extern bool skip_mp_cte_check;
+extern bool suppress_bogus_mp_content_warning;
+extern bool bogus_mp_content;
+extern bool suppress_extraneous_trailing_semicolon_warning;
+
+extern bool suppress_multiple_mime_version_warning;
+
+#define        NPREFS  20
+typedef struct {
+    char *type;
+    char *subtype;
+} mime_type_subtype;
+extern mime_type_subtype mime_preference[NPREFS];
+extern int npreferred;