-
-/*
- * mhparse.h -- definitions for parsing/building of MIME content
+/* mhparse.h -- definitions for parsing/building of MIME content
* -- (mhparse.c/mhbuildsbr.c)
*/
-#define NPARTS 50
-#define NTYPES 20
-#define NPARMS 10
-
/*
* Abstract type for header fields
*/
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 */
};
* 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 trhings) a linked list
+ * 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 */
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... */
/* 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. */
};
/*
#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 {
/*
* prototypes
*/
-int pidcheck (int);
CT parse_mime (char *);
/*
* 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 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);
-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);
/*
- * Parse a series of MIME attributes (or parameters) given a header as
- * input.
+ * List the content information of a single MIME part on stdout.
+ *
+ * Arguments are:
*
- * Arguments include:
+ * 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.
*
- * filename - Name of input file (for error messages)
- * fieldname - Name of field being processed
- * headerp - Pointer to pointer of the beginning of the MIME attributes.
- * Updated to point to end of attributes when finished.
- * param_head - Pointer to head of parameter list
- * param_tail - Pointer to tail of parameter list
- * commentp - Pointer to header comment pointer (may be NULL)
+ * 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.
*
- * Returns OK if parsing was successful, NOTOK if parsing failed, and
- * DONE to indicate a benign error (minor parsing error, but the program
- * should continue).
+ * Arguments and return value are the same as list_content().
*/
-int parse_header_attrs (const char *filename, const char *fieldname,
- char **headerp, PM *param_head, PM *param_tail,
- char **commentp);
+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
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.
*
* 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.
*
- * Returned allocated parameter element
+ * 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 add_param(PM *first, PM *last, const char *name, const char *value);
+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
char *get_param_value(PM pm, char replace);
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;