X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/17932f7aea1c21cf17738f47996345d9d0a6ce51..582d5e802ceb8e0c7f0dc5b83fdbf2a62fc10fb3:/h/mhparse.h diff --git a/h/mhparse.h b/h/mhparse.h index 1f8ab719..00802d13 100644 --- a/h/mhparse.h +++ b/h/mhparse.h @@ -1,12 +1,10 @@ - -/* - * 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 +#define NPREFS 20 /* * Abstract type for header fields @@ -16,9 +14,10 @@ typedef struct hfield *HF; /* * 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) @@ -43,6 +42,17 @@ struct hfield { 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. @@ -50,8 +60,8 @@ struct hfield { 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; }; @@ -68,6 +78,36 @@ struct cefile { /* * 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 */ @@ -89,6 +129,9 @@ struct Content { 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 */ @@ -99,6 +142,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 */ + int c_reqencoding; /* Requested encoding (by mhbuild) */ /* Content-MD5 info */ int c_digested; /* have we seen this header before? */ @@ -115,8 +159,7 @@ struct Content { 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... */ @@ -168,6 +211,10 @@ struct Content { /* 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 +227,7 @@ struct text { #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 { @@ -273,8 +321,37 @@ extern struct str2init str2methods[]; /* * prototypes */ -int pidcheck (int); 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); @@ -283,9 +360,220 @@ void close_encoding (CT); void free_content (CT); char *ct_type_str (int); char *ct_subtype_str (int, int); +int ct_str_type (const char *); +int ct_str_subtype (int, const char *); const struct str2init *get_ct_init (int); const char *ce_str (int); const struct str2init *get_ce_method (const char *); -int parse_header_attrs (const char *, int, char **, CI, int *); +char *content_charset (CT); +int convert_charset (CT, char *, int *); +void reverse_alternative_parts (CT); + +/* + * Given a content structure, return true if the content has a disposition + * of "inline". + * + * Arguments are: + * + * ct - Content structure to examine + */ +int is_inline(CT 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); + +/* + * Display MIME message(s) on standard out. + * + * Arguments are: + * + * cts - NULL terminated array of CT structures for messages + * to display + * concat - If true, concatenate all MIME parts. If false, show each + * MIME part under a separate pager. + * textonly - If true, only display "text" MIME parts + * inlineonly - If true, only display MIME parts that are marked with + * a disposition of "inline" (includes parts that lack a + * Content-Disposition header). + * markerform - The name of a file containing mh-format(5) code used to + * display markers about non-displayed MIME parts. + */ +void show_all_messages(CT *cts, int concat, int textonly, int inlineonly); + +/* + * Display (or store) a single MIME part using the specified command + * + * Arguments are: + * + * ct - The Content structure of the MIME part we wish to display + * alternate - Set this to true if this is one part of a MIME + * multipart/alternative part. Will suppress some errors and + * will cause the function to return DONE instead of OK on + * success. + * cp - The command string to execute. Will be run through the + * parser for %-escapes as described in mhshow(1). + * cracked - If set, chdir() to this directory before executing the + * command in "cp". Only used by mhstore(1). + * fmt - A series of mh-format(5) instructions to execute if the + * command string indicates a marker is desired. Can be NULL. + * + * Returns NOTOK if we could not display the part, DONE if alternate was + * set and we could display the part, and OK if alternate was not set and + * we could display the part. + */ +struct format; +int show_content_aux(CT ct, int alternate, char *cp, char *cracked, + struct format *fmt); 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); +void mhstoreinfo_free(mhstoreinfo_t); +void store_all_messages (mhstoreinfo_t);