]> diplodocus.org Git - nmh/blobdiff - uip/mhfixmsg.c
Exposed a bunch of switches that are now documented.
[nmh] / uip / mhfixmsg.c
index a5a24b91de029aa7253e2ea4183448076f90c075..5814eaeec65bd984a4093ebe69a211d8f6bcb7f1 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * mhfixmsg.c -- rewrite a message with various tranformations
+ * mhfixmsg.c -- rewrite a message with various transformations
  *
  * This code is Copyright (c) 2002 and 2013, by the authors of nmh.
  * See the COPYRIGHT file in the root directory of the nmh
@@ -17,6 +17,8 @@
     X("decodetext 8bit|7bit", 0, DECODETEXTSW) \
     X("nodecodetext", 0, NDECODETEXTSW) \
     X("decodetypes", 0, DECODETYPESW) \
+    X("crlflinebreaks", 0, CRLFLINEBREAKSSW) \
+    X("nocrlflinebreaks", 0, NCRLFLINEBREAKSSW) \
     X("textcharset", 0, TEXTCHARSETSW) \
     X("notextcharset", 0, NTEXTCHARSETSW) \
     X("reformat", 0, REFORMATSW) \
@@ -82,11 +84,14 @@ typedef struct fix_transformations {
     int replacetextplain;
     int decodetext;
     char *decodetypes;
+    /* Whether to use CRLF linebreaks, per RFC 2046 Sec. 4.1.1, par.1. */
+    int lf_line_endings;
     char *textcharset;
 } fix_transformations;
 
 int mhfixmsgsbr (CT *, const fix_transformations *, char *);
 static int fix_boundary (CT *, int *);
+static int copy_input_to_output (const char *, const char *);
 static int get_multipart_boundary (CT, char **);
 static int replace_boundary (CT, char *, char *);
 static int fix_types (CT, svector_t, int *);
@@ -114,8 +119,9 @@ static int content_encoding (CT, const char **);
 static int strip_crs (CT, int *);
 static int convert_charsets (CT, char *, int *);
 static int fix_always (CT, int *);
-static int write_content (CT, char *, char *, int, int);
-static int remove_file (char *);
+static int write_content (CT, const char *, char *, int, int);
+static void set_text_ctparams(CT, char *, int);
+static int remove_file (const char *);
 static void report (char *, char *, char *, char *, ...);
 static void pipeser (int);
 
@@ -138,7 +144,8 @@ main (int argc, char **argv) {
     fx.fixtypes = NULL;
     fx.replacetextplain = 0;
     fx.decodetext = CE_8BIT;
-    fx.decodetypes = "text";  /* Default to all text content. */
+    fx.decodetypes = "text,application/ics";  /* Default, per man page. */
+    fx.lf_line_endings = 0;
     fx.textcharset = NULL;
 
     if (nmh_init(argv[0], 1)) { return 1; }
@@ -170,8 +177,9 @@ main (int argc, char **argv) {
                 done (0);
 
             case DECODETEXTSW:
-                if (! (cp = *argp++)  ||  *cp == '-')
+                if (! (cp = *argp++)  ||  *cp == '-') {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 if (! strcasecmp (cp, "8bit")) {
                     fx.decodetext = CE_8BIT;
                 } else if (! strcasecmp (cp, "7bit")) {
@@ -184,13 +192,21 @@ main (int argc, char **argv) {
                 fx.decodetext = 0;
                 continue;
             case DECODETYPESW:
-                if (! (cp = *argp++)  ||  *cp == '-')
+                if (! (cp = *argp++)  ||  *cp == '-') {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 fx.decodetypes = cp;
                 continue;
+            case CRLFLINEBREAKSSW:
+                fx.lf_line_endings = 0;
+                continue;
+            case NCRLFLINEBREAKSSW:
+                fx.lf_line_endings = 1;
+                continue;
             case TEXTCHARSETSW:
-                if (! (cp = *argp++) || (*cp == '-' && cp[1]))
+                if (! (cp = *argp++) || (*cp == '-' && cp[1])) {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 fx.textcharset = cp;
                 continue;
             case NTEXTCHARSETSW:
@@ -209,8 +225,9 @@ main (int argc, char **argv) {
                 fx.fixcte = 0;
                 continue;
             case FIXTYPESW:
-                if (! (cp = *argp++) || (*cp == '-' && cp[1]))
+                if (! (cp = *argp++) || (*cp == '-' && cp[1])) {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 if (! strncasecmp (cp, "multipart/", 10)  ||
                     ! strncasecmp (cp, "message/", 8)) {
                     adios (NULL, "-fixtype %s not allowed", cp);
@@ -233,18 +250,21 @@ main (int argc, char **argv) {
                 fx.replacetextplain = 0;
                 continue;
             case FILESW:
-                if (! (cp = *argp++) || (*cp == '-' && cp[1]))
+                if (! (cp = *argp++) || (*cp == '-' && cp[1])) {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 file = *cp == '-'  ?  add (cp, NULL)  :  path (cp, TFILE);
                 continue;
             case OUTFILESW:
-                if (! (cp = *argp++) || (*cp == '-' && cp[1]))
+                if (! (cp = *argp++) || (*cp == '-' && cp[1])) {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 outfile = *cp == '-'  ?  add (cp, NULL)  :  path (cp, TFILE);
                 continue;
             case RPROCSW:
-                if (!(rmmproc = *argp++) || *rmmproc == '-')
+                if (!(rmmproc = *argp++) || *rmmproc == '-') {
                     adios (NULL, "missing argument to %s", argp[-2]);
+                }
                 continue;
             case NRPRCSW:
                 rmmproc = NULL;
@@ -264,10 +284,11 @@ main (int argc, char **argv) {
             }
         }
         if (*cp == '+' || *cp == '@') {
-            if (folder)
+            if (folder) {
                 adios (NULL, "only one folder at a time!");
-            else
+            } else {
                 folder = pluspath (cp);
+            }
         } else {
             if (*cp == '/') {
                 /* Interpret a full path as a filename, not a message. */
@@ -292,11 +313,13 @@ main (int argc, char **argv) {
     suppress_bogus_mp_content_warning = skip_mp_cte_check = 1;
     suppress_extraneous_trailing_semicolon_warning = 1;
 
-    if (! context_find ("path"))
+    if (! context_find ("path")) {
         free (path ("./", TFOLDER));
+    }
 
-    if (file && msgs.size)
+    if (file && msgs.size) {
         adios (NULL, "cannot specify msg and file at same time!");
+    }
 
     /*
      * check if message is coming from file
@@ -334,34 +357,56 @@ main (int argc, char **argv) {
         }
         ctp = cts;
 
-        if ((ct = parse_mime (file))) { *ctp++ = ct; }
+        if ((ct = parse_mime (file))) {
+            set_text_ctparams(ct, fx.decodetypes, fx.lf_line_endings);
+            *ctp++ = ct;
+        } else {
+            advise (NULL, "unable to parse message from file %s", file);
+            status = NOTOK;
+
+            /* If there's an outfile, pass the input message unchanged, so the message won't
+               get dropped from a pipeline. */
+            if (outfile) {
+                /* Something went wrong.  Output might be expected, such as if this were run
+                   as a filter.  Just copy the input to the output. */
+                if (copy_input_to_output (file, outfile) != OK) {
+                    advise (NULL, "unable to copy message to %s, it might be lost\n", outfile);
+                }
+            }
+        }
     } else {
         /*
          * message(s) are coming from a folder
          */
         CT ct;
 
-        if (! msgs.size)
+        if (! msgs.size) {
             app_msgarg(&msgs, "cur");
-        if (! folder)
+        }
+        if (! folder) {
             folder = getfolder (1);
+        }
         maildir = m_maildir (folder);
 
-        if (chdir (maildir) == NOTOK)
+        if (chdir (maildir) == NOTOK) {
             adios (maildir, "unable to change directory to");
+        }
 
         /* read folder and create message structure */
-        if (! (mp = folder_read (folder, 1)))
+        if (! (mp = folder_read (folder, 1))) {
             adios (NULL, "unable to read folder %s", folder);
+        }
 
         /* check for empty folder */
-        if (mp->nummsg == 0)
+        if (mp->nummsg == 0) {
             adios (NULL, "no messages in %s", folder);
+        }
 
         /* parse all the message ranges/sequences and set SELECTED */
         for (msgnum = 0; msgnum < msgs.size; msgnum++)
-            if (! m_convert (mp, msgs.msgs[msgnum]))
+            if (! m_convert (mp, msgs.msgs[msgnum])) {
                 done (1);
+            }
         seq_setprev (mp);       /* set the previous-sequence */
 
         if (! (cts =
@@ -375,7 +420,25 @@ main (int argc, char **argv) {
                 char *msgnam;
 
                 msgnam = m_name (msgnum);
-                if ((ct = parse_mime (msgnam))) { *ctp++ = ct; }
+                if ((ct = parse_mime (msgnam))) {
+                    set_text_ctparams(ct, fx.decodetypes, fx.lf_line_endings);
+                    *ctp++ = ct;
+                } else {
+                    advise (NULL, "unable to parse message %s", msgnam);
+                    status = NOTOK;
+
+                    /* If there's an outfile, pass the input message unchanged, so the message won't
+                       get dropped from a pipeline. */
+                    if (outfile) {
+                        /* Something went wrong.  Output might be expected, such as if this were run
+                           as a filter.  Just copy the input to the output. */
+                        const char *input_filename = path (msgnam, TFILE);
+
+                        if (copy_input_to_output (input_filename, outfile) != OK) {
+                            advise (NULL, "unable to copy message to %s, it might be lost\n", outfile);
+                        }
+                    }
+                }
             }
         }
 
@@ -407,6 +470,8 @@ main (int argc, char **argv) {
     if (fx.fixtypes != NULL) { svector_free (fx.fixtypes); }
     free (outfile);
     free (file);
+    free (folder);
+    free (arguments);
 
     /* done is freects_done, which will clean up all of cts. */
     done (status);
@@ -482,19 +547,9 @@ mhfixmsgsbr (CT *ctp, const fix_transformations *fx, char *outfile) {
         /* Something went wrong.  Output might be expected, such
            as if this were run as a filter.  Just copy the input
            to the output. */
-        int in = open (input_filename, O_RDONLY);
-        int out = strcmp (outfile, "-")
-            ?  open (outfile, O_WRONLY | O_CREAT, m_gmprot ())
-            :  STDOUT_FILENO;
-
-        if (in != -1  &&  out != -1) {
-            cpydata (in, out, input_filename, outfile);
-        } else {
-            status = NOTOK;
+        if (copy_input_to_output (input_filename, outfile) != OK) {
+            advise (NULL, "unable to copy message to %s, it might be lost\n", outfile);
         }
-
-        close (out);
-        close (in);
     }
 
     if (modify_inplace) {
@@ -509,6 +564,29 @@ mhfixmsgsbr (CT *ctp, const fix_transformations *fx, char *outfile) {
 }
 
 
+/* Copy input message to output.  Assumes not modifying in place, so this
+   might be running as part of a pipeline. */
+static int
+copy_input_to_output (const char *input_filename, const char *output_filename) {
+    int in = open (input_filename, O_RDONLY);
+    int out = strcmp (output_filename, "-")
+        ?  open (output_filename, O_WRONLY | O_CREAT, m_gmprot ())
+        :  STDOUT_FILENO;
+    int status = OK;
+
+    if (in != -1  &&  out != -1) {
+        cpydata (in, out, input_filename, output_filename);
+    } else {
+        status = NOTOK;
+    }
+
+    close (out);
+    close (in);
+
+    return status;
+}
+
+
 static int
 fix_boundary (CT *ct, int *message_mods) {
     struct multipart *mp;
@@ -565,7 +643,16 @@ fix_boundary (CT *ct, int *message_mods) {
                 }
 
                 free (part_boundary);
+            } else {
+                /* Couldn't fix the boundary.  Report failure so that mhfixmsg
+                   doesn't modify the message. */
+                status = NOTOK;
             }
+        } else {
+            /* No multipart struct, even though the content type is
+               CT_MULTIPART.  Report failure so that mhfixmsg doesn't modify
+               the message. */
+            status = NOTOK;
         }
     }
 
@@ -716,8 +803,9 @@ replace_boundary (CT ct, char *file, char *boundary) {
                 fprintf (fpout, "%s:%s%s\n", np, new_ctline,
                         new_params ? new_params : "");
                free(new_ctline);
-               if (new_params)
+               if (new_params) {
                    free(new_params);
+                }
             }
 
             free (vp);
@@ -1327,8 +1415,7 @@ insert_into_new_mp_alt (CT *ct, int *message_mods) {
         CT mp_alt = build_multipart_alt (*ct, tp_part, CT_MULTIPART,
                                          MULTI_ALTERNATE);
         if (mp_alt) {
-            struct multipart *mp =
-                (struct multipart *) mp_alt->c_ctparams;
+            struct multipart *mp = (struct multipart *) mp_alt->c_ctparams;
 
             if (mp  &&  mp->mp_parts) {
                 mp->mp_parts->mp_part = tp_part;
@@ -1759,13 +1846,37 @@ set_ct_type (CT ct, int type, int subtype, int encoding) {
 static int
 decode_text_parts (CT ct, int encoding, const char *decodetypes, int *message_mods) {
     int status = OK;
+    int lf_line_endings = 0;
 
     switch (ct->c_type) {
-    case CT_TEXT:
+    case CT_MULTIPART: {
+        struct multipart *m = (struct multipart *) ct->c_ctparams;
+        struct part *part;
+
+        /* Should check to see if the body for this part is encoded?
+           For now, it gets passed along as-is by InitMultiPart(). */
+        for (part = m->mp_parts; status == OK  &&  part; part = part->mp_next) {
+            status = decode_text_parts (part->mp_part, encoding, decodetypes, message_mods);
+        }
+        break;
+    }
+
+    case CT_MESSAGE:
+        if (ct->c_subtype == MESSAGE_EXTERNAL) {
+            struct exbody *e = (struct exbody *) ct->c_ctparams;
+
+            status = decode_text_parts (e->eb_content, encoding, decodetypes, message_mods);
+        }
+        break;
+
+    default:
         if (! should_decode(decodetypes, ct->c_ctinfo.ci_type, ct->c_ctinfo.ci_subtype)) {
             break;
         }
 
+        lf_line_endings =
+            ct->c_ctparams  &&  ((struct text *) ct->c_ctparams)->lf_line_endings;
+
         switch (ct->c_encoding) {
         case CE_BASE64:
         case CE_QUOTED: {
@@ -1805,19 +1916,22 @@ decode_text_parts (CT ct, int encoding, const char *decodetypes, int *message_mo
                     ct->c_cefile.ce_file = NULL;
                 } else {
                     int enc;
-                    if (ct_encoding == CE_BINARY)
+                    if (ct_encoding == CE_BINARY) {
                         enc = CE_BINARY;
-                    else if (ct_encoding == CE_8BIT  &&  encoding == CE_7BIT)
+                    } else if (ct_encoding == CE_8BIT  &&  encoding == CE_7BIT) {
                         enc = CE_QUOTED;
-                    else
+                    } else {
                         enc = charset_encoding (ct);
+                    }
                     if (set_ce (ct, enc) == OK) {
                         ++*message_mods;
                         if (verbosw) {
                             report (NULL, ct->c_partno, ct->c_file, "decode%s",
                                     ct->c_ctline ? ct->c_ctline : "");
                         }
-                        strip_crs (ct, message_mods);
+                        if (lf_line_endings) {
+                            strip_crs (ct, message_mods);
+                        }
                     } else {
                         status = NOTOK;
                     }
@@ -1829,36 +1943,15 @@ decode_text_parts (CT ct, int encoding, const char *decodetypes, int *message_mo
         }
         case CE_8BIT:
         case CE_7BIT:
-            strip_crs (ct, message_mods);
+            if (lf_line_endings) {
+                strip_crs (ct, message_mods);
+            }
             break;
         default:
             break;
         }
 
         break;
-
-    case CT_MULTIPART: {
-        struct multipart *m = (struct multipart *) ct->c_ctparams;
-        struct part *part;
-
-        /* Should check to see if the body for this part is encoded?
-           For now, it gets passed along as-is by InitMultiPart(). */
-        for (part = m->mp_parts; status == OK  &&  part; part = part->mp_next) {
-            status = decode_text_parts (part->mp_part, encoding, decodetypes, message_mods);
-        }
-        break;
-    }
-
-    case CT_MESSAGE:
-        if (ct->c_subtype == MESSAGE_EXTERNAL) {
-            struct exbody *e = (struct exbody *) ct->c_ctparams;
-
-            status = decode_text_parts (e->eb_content, encoding, decodetypes, message_mods);
-        }
-        break;
-
-    default:
-        break;
     }
 
     return status;
@@ -2244,7 +2337,7 @@ fix_always (CT ct, int *message_mods) {
 
 
 static int
-write_content (CT ct, char *input_filename, char *outfile, int modify_inplace,
+write_content (CT ct, const char *input_filename, char *outfile, int modify_inplace,
                int message_mods) {
     int status = OK;
 
@@ -2317,12 +2410,50 @@ write_content (CT ct, char *input_filename, char *outfile, int modify_inplace,
 }
 
 
+/*
+ * parse_mime() does not set lf_line_endings in struct text, so use this function to do it.
+ * It touches the parts the decodetypes identifies.
+ */
+static void
+set_text_ctparams(CT ct, char *decodetypes, int lf_line_endings) {
+    switch (ct->c_type) {
+    case CT_MULTIPART: {
+        struct multipart *m = (struct multipart *) ct->c_ctparams;
+        struct part *part;
+
+        for (part = m->mp_parts; part; part = part->mp_next) {
+            set_text_ctparams(part->mp_part, decodetypes, lf_line_endings);
+        }
+        break;
+    }
+
+    case CT_MESSAGE:
+        if (ct->c_subtype == MESSAGE_EXTERNAL) {
+            struct exbody *e = (struct exbody *) ct->c_ctparams;
+
+            set_text_ctparams(e->eb_content, decodetypes, lf_line_endings);
+        }
+        break;
+
+    default:
+        if (should_decode(decodetypes, ct->c_ctinfo.ci_type, ct->c_ctinfo.ci_subtype)) {
+            if (ct->c_ctparams == NULL) {
+                if ((ct->c_ctparams = (struct text *) mh_xcalloc (1, sizeof (struct text))) == NULL) {
+                    adios (NULL, "out of memory");
+                }
+            }
+            ((struct text *) ct->c_ctparams)->lf_line_endings = lf_line_endings;
+        }
+    }
+}
+
+
 /*
  * If "rmmproc" is defined, call that to remove the file.  Otherwise,
  * use the standard MH backup file.
  */
 static int
-remove_file (char *file) {
+remove_file (const char *file) {
     if (rmmproc) {
         char *rmm_command = concat (rmmproc, " ", file, NULL);
         int status = system (rmm_command);