This commit was generated by cvs2svn to compensate for changes in r6231,
[elisp/gnus.git-] / lisp / nndoc.el
index afdeab8..0da245a 100644 (file)
@@ -1,6 +1,5 @@
 ;;; nndoc.el --- single file access for Gnus
-;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000
-;;        Free Software Foundation, Inc.
+;; Copyright (C) 1995,96,97,98 Free Software Foundation, Inc.
 
 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;;     Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
@@ -32,7 +31,6 @@
 (require 'nnmail)
 (require 'nnoo)
 (require 'gnus-util)
-(require 'mm-util)
 (eval-when-compile (require 'cl))
 
 (nnoo-declare nndoc)
@@ -40,8 +38,8 @@
 (defvoo nndoc-article-type 'guess
   "*Type of the file.
 One of `mbox', `babyl', `digest', `news', `rnews', `mmdf', `forward',
-`rfc934', `rfc822-forward', `mime-parts', `standard-digest',
-`slack-digest', `clari-briefs', `nsmail' or `guess'.")
+`rfc934', `rfc822-forward', `mime-digest', `mime-parts', `standard-digest',
+`slack-digest', `clari-briefs' or `guess'.")
 
 (defvoo nndoc-post-type 'mail
   "*Whether the nndoc group is `mail' or `post'.")
@@ -49,14 +47,12 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf', `forward',
 (defvoo nndoc-open-document-hook 'nnheader-ms-strip-cr
   "Hook run after opening a document.
 The default function removes all trailing carriage returns
-from the document.")
+from the document.")  
 
 (defvar nndoc-type-alist
   `((mmdf
      (article-begin .  "^\^A\^A\^A\^A\n")
      (body-end .  "^\^A\^A\^A\^A\n"))
-    (nsmail
-     (article-begin .  "^From - "))
     (news
      (article-begin . "^Path:"))
     (rnews
@@ -71,8 +67,8 @@ from the document.")
      (body-begin-function . nndoc-babyl-body-begin)
      (head-begin-function . nndoc-babyl-head-begin))
     (forward
-     (article-begin . "^-+ \\(Start of \\)?forwarded message -+\n+")
-     (body-end . "^-+ End \\(of \\)?forwarded message -+$")
+     (article-begin . "^-+ Start of forwarded message -+\n+")
+     (body-end . "^-+ End of forwarded message -+$")
      (prepare-body-function . nndoc-unquote-dashes))
     (rfc934
      (article-begin . "^--.*\n+")
@@ -147,13 +143,10 @@ from the document.")
 (defvoo nndoc-head-begin-function nil)
 (defvoo nndoc-body-end nil)
 ;; nndoc-dissection-alist is a list of sublists.  Each sublist holds the
-;; following items.  ARTICLE acts as the association key and is an ordinal
-;; starting at 1.  HEAD-BEGIN [0], HEAD-END [1], BODY-BEGIN [2] and BODY-END
-;; [3] are positions in the `nndoc' buffer.  LINE-COUNT [4] is a count of
-;; lines in the body.  For MIME dissections only, ARTICLE-INSERT [5] and
-;; SUMMARY-INSERT [6] give headers to insert for full article or summary line
-;; generation, respectively.  Other headers usually follow directly from the
-;; buffer.  Value `nil' means no insert.
+;; following items.  ARTICLE is an ordinal starting at 1.  HEAD-BEGIN,
+;; HEAD-END, BODY-BEGIN and BODY-END are positions in the `nndoc' buffer.
+;; LINE-COUNT is a count of lines in the body.  SUBJECT, MESSAGE-ID and
+;; REFERENCES, only present for MIME dissections, are field values.
 (defvoo nndoc-dissection-alist nil)
 (defvoo nndoc-prepare-body-function nil)
 (defvoo nndoc-generate-head-function nil)
@@ -165,6 +158,8 @@ from the document.")
 (defvoo nndoc-current-buffer nil
   "Current nndoc news buffer.")
 (defvoo nndoc-address nil)
+(defvoo nndoc-mime-header nil)
+(defvoo nndoc-mime-subject nil)
 
 (defconst nndoc-version "nndoc 1.0"
   "nndoc version.")
@@ -192,7 +187,7 @@ from the document.")
                (insert-buffer-substring
                 nndoc-current-buffer (car entry) (nth 1 entry)))
              (goto-char (point-max))
-             (unless (eq (char-after (1- (point))) ?\n)
+             (unless (= (char-after (1- (point))) ?\n)
                (insert "\n"))
              (insert (format "Lines: %d\n" (nth 4 entry)))
              (insert ".\n")))
@@ -294,7 +289,7 @@ from the document.")
       (setq nndoc-dissection-alist nil)
       (save-excursion
        (set-buffer nndoc-current-buffer)
-       (mm-enable-multibyte)
+       (buffer-disable-undo (current-buffer))
        (erase-buffer)
        (if (stringp nndoc-address)
            (nnheader-insert-file-contents nndoc-address)
@@ -348,9 +343,6 @@ from the document.")
                (setq entry (pop alist)))
       (when (memq subtype (or (cdr (assq 'subtype entry)) '(guess)))
        (goto-char (point-min))
-       ;; Remove blank lines.
-       (while (eq (following-char) ?\n)
-         (delete-char 1))
        (when (numberp (setq result (funcall (intern
                                              (format "nndoc-%s-type-p"
                                                      (car entry))))))
@@ -460,30 +452,38 @@ from the document.")
        (limit (search-forward "\n\n" nil t)))
     (goto-char (point-min))
     (when (and limit
-              (re-search-forward
-               (concat "\
-^Content-Type:[ \t]*multipart/[a-z]+ *; *\\(\\(\n[ \t]\\)?.*;\\)*"
-                       "\\(\n[ \t]\\)?[ \t]*boundary=\"?[^\"\n]*[^\" \t\n]")
-               limit t))
+               (re-search-forward
+                (concat "\
+^Content-Type:[ \t]*multipart/[a-z]+;\\(.*;\\)*"
+                        "[ \t\n]*[ \t]boundary=\"?[^\"\n]*[^\" \t\n]")
+          limit t))
       t)))
 
 (defun nndoc-transform-mime-parts (article)
-  (let* ((entry (cdr (assq article nndoc-dissection-alist)))
-        (headers (nth 5 entry)))
-    (when headers
+  (unless (= article 1)
+    ;; Ensure some MIME-Version.
+    (goto-char (point-min))
+    (search-forward "\n\n")
+    (let ((case-fold-search nil)
+         (limit (point)))
       (goto-char (point-min))
-      (insert headers))))
-
-(defun nndoc-generate-mime-parts-head (article)
-  (let* ((entry (cdr (assq article nndoc-dissection-alist)))
-        (headers (nth 6 entry)))
-    (save-restriction
-      (narrow-to-region (point) (point))
-      (insert-buffer-substring
-       nndoc-current-buffer (car entry) (nth 1 entry))
-      (goto-char (point-max)))
-    (when headers
-      (insert headers))))
+      (or (save-excursion (re-search-forward "^MIME-Version:" limit t))
+         (insert "Mime-Version: 1.0\n")))
+    ;; Generate default header before entity fields.
+    (goto-char (point-min))
+    (nndoc-generate-mime-parts-head article t)))
+
+(defun nndoc-generate-mime-parts-head (article &optional body-present)
+  (let ((entry (cdr (assq (if body-present 1 article) nndoc-dissection-alist))))
+    (let ((subject (if body-present
+                      nndoc-mime-subject
+                    (concat "<" (nth 5 entry) ">")))
+         (message-id (nth 6 entry))
+         (references (nth 7 entry)))
+      (insert nndoc-mime-header)
+      (and subject (insert "Subject: " subject "\n"))
+      (and message-id (insert "Message-ID: " message-id "\n"))
+      (and references (insert "References: " references "\n")))))
 
 (defun nndoc-clari-briefs-type-p ()
   (when (let ((case-fold-search nil))
@@ -516,7 +516,6 @@ from the document.")
     (insert "From: " "clari@clari.net (" (or from "unknown") ")"
            "\nSubject: " (or subject "(no subject)") "\n")))
 
-
 (defun nndoc-mime-digest-type-p ()
   (let ((case-fold-search t)
        boundary-id b-delimiter entry)
@@ -559,7 +558,10 @@ from the document.")
 (defun nndoc-transform-lanl-gov-announce (article)
   (goto-char (point-max))
   (when (re-search-backward "^\\\\\\\\ +(\\([^ ]*\\) , *\\([^ ]*\\))" nil t)
-    (replace-match "\n\nGet it at \\1 (\\2)" t nil)))
+    (replace-match "\n\nGet it at \\1 (\\2)" t nil))
+  ;;  (when (re-search-backward "^\\\\\\\\$" nil t)
+  ;;    (replace-match "" t t))
+  )
 
 (defun nndoc-generate-lanl-gov-head (article)
   (let ((entry (cdr (assq article nndoc-dissection-alist)))
@@ -577,20 +579,18 @@ from the document.")
          (when (re-search-forward "^Title: \\([^\f]*\\)\nAuthors?: \\(.*\\)"
                                   nil t)
            (setq subject (concat (match-string 1) subject))
-           (setq from (concat (match-string 2) " <" e-mail ">"))))))
+           (setq from (concat (match-string 2) " <" e-mail ">"))))
+       ))
     (while (and from (string-match "(\[^)\]*)" from))
       (setq from (replace-match "" t t from)))
     (insert "From: "  (or from "unknown")
            "\nSubject: " (or subject "(no subject)") "\n")))
 
-(defun nndoc-nsmail-type-p ()
-  (when (looking-at "From - ")
-    t))
-
 (deffoo nndoc-request-accept-article (group &optional server last)
   nil)
 
 
+
 ;;;
 ;;; Functions for dissecting the documents
 ;;;
@@ -609,9 +609,6 @@ from the document.")
     (save-excursion
       (set-buffer nndoc-current-buffer)
       (goto-char (point-min))
-      ;; Remove blank lines.
-      (while (eq (following-char) ?\n)
-       (delete-char 1))
       ;; Find the beginning of the file.
       (when nndoc-file-begin
        (nndoc-search nndoc-file-begin))
@@ -672,128 +669,92 @@ the header of this entity, and one article per sub-entity."
        nndoc-mime-split-ordinal 0)
   (save-excursion
     (set-buffer nndoc-current-buffer)
-    (nndoc-dissect-mime-parts-sub (point-min) (point-max) nil nil nil)))
-
-(defun nndoc-dissect-mime-parts-sub (head-begin body-end article-insert
-                                               position parent)
-  "Dissect an entity, within a composite MIME message.
-The complete message or MIME entity extends from HEAD-BEGIN to BODY-END.
-ARTICLE-INSERT should be added at beginning for generating a full article.
+    (message-narrow-to-head)
+    (let ((case-fold-search t)
+         (message-id (message-fetch-field "Message-ID"))
+         (references (message-fetch-field "References")))
+      (setq nndoc-mime-header (buffer-substring (point-min) (point-max))
+           nndoc-mime-subject (message-fetch-field "Subject"))
+      (while (string-match "\
+^\\(Subject\\|Message-ID\\|References\\|Lines\\|\
+MIME-Version\\|Content-Type\\|Content-Transfer-Encoding\\|\
+\\):.*\n\\([ \t].*\n\\)*"
+                          nndoc-mime-header)
+       (setq nndoc-mime-header (replace-match "" t t nndoc-mime-header)))
+      (widen)
+      (nndoc-dissect-mime-parts-sub (point-min) (point-max)
+                                   nil message-id references))))
+
+(defun nndoc-dissect-mime-parts-sub (begin end position message-id references)
+  "Dissect an entity within a composite MIME message.
+The article, which corresponds to a MIME entity, extends from BEGIN to END.
 The string POSITION holds a dotted decimal representation of the article
 position in the hierarchical structure, it is nil for the outer entity.
-PARENT is the message-ID of the parent summary line, or nil for none."
-  (let ((case-fold-search t)
-       (message-id (nnmail-message-id))
-       head-end body-begin summary-insert message-rfc822 multipart-any
-       subject content-type type subtype boundary-regexp)
-    ;; Gracefully handle a missing body.
-    (goto-char head-begin)
-    (if (search-forward "\n\n" body-end t)
-       (setq head-end (1- (point))
-             body-begin (point))
-      (setq head-end body-end
-           body-begin body-end))
-    (narrow-to-region head-begin head-end)
-    ;; Save MIME attributes.
-    (goto-char head-begin)
-    (setq content-type (message-fetch-field "Content-Type"))
-    (when content-type
-      (when (string-match
-            "^ *\\([^ \t\n/;]+\\)/\\([^ \t\n/;]+\\)" content-type)
-       (setq type (downcase (match-string 1 content-type))
-             subtype (downcase (match-string 2 content-type))
-             message-rfc822 (and (string= type "message")
-                                 (string= subtype "rfc822"))
-             multipart-any (string= type "multipart")))
-      (when (string-match ";[ \t\n]*name=\\([^ \t\n;]+\\)" content-type)
-       (setq subject (match-string 1 content-type)))
-      (when (string-match "boundary=\"?\\([^\"\n]*[^\" \t\n]\\)" content-type)
-       (setq boundary-regexp (concat "^--"
-                                     (regexp-quote
-                                      (match-string 1 content-type))
-                                     "\\(--\\)?[ \t]*\n"))))
-    (unless subject
-      (when (or multipart-any (not article-insert))
-       (setq subject (message-fetch-field "Subject"))))
-    (unless type
-      (setq type "text"
-           subtype "plain"))
-    ;; Prepare the article and summary inserts.
-    (unless article-insert
-      (setq article-insert (buffer-substring (point-min) (point-max))
-           head-end head-begin))
-    (setq summary-insert article-insert)
-    ;; - summary Subject.
-    (setq summary-insert
-         (let ((line (concat "Subject: <" position
-                             (and position multipart-any ".")
-                             (and multipart-any "*")
-                             (and (or position multipart-any) " ")
-                             (cond ((string= subtype "plain") type)
-                                   ((string= subtype "basic") type)
-                                   (t subtype))
-                             ">"
-                             (and subject " ")
-                             subject
-                             "\n")))
-           (if (string-match "Subject:.*\n\\([ \t].*\n\\)*" summary-insert)
-               (replace-match line t t summary-insert)
-             (concat summary-insert line))))
-    ;; - summary Message-ID.
-    (setq summary-insert
-         (let ((line (concat "Message-ID: " message-id "\n")))
-           (if (string-match "Message-ID:.*\n\\([ \t].*\n\\)*" summary-insert)
-               (replace-match line t t summary-insert)
-             (concat summary-insert line))))
-    ;; - summary References.
-    (when parent
-      (setq summary-insert
-           (let ((line (concat "References: " parent "\n")))
-             (if (string-match "References:.*\n\\([ \t].*\n\\)*"
-                               summary-insert)
-                 (replace-match line t t summary-insert)
-               (concat summary-insert line)))))
-    ;; Generate dissection information for this entity.
-    (push (list (incf nndoc-mime-split-ordinal)
-               head-begin head-end body-begin body-end
-               (count-lines body-begin body-end)
-               article-insert summary-insert)
-         nndoc-dissection-alist)
-    ;; Recurse for all sub-entities, if any.
-    (widen)
-    (cond
-     (message-rfc822
-      (save-excursion
-       (nndoc-dissect-mime-parts-sub body-begin body-end nil
-                                     position message-id)))
-     ((and multipart-any boundary-regexp)
-      (let ((part-counter 0)
-           part-begin part-end eof-flag)
-       (while (string-match "\
-^\\(Lines\\|Content-\\(Type\\|Transfer-Encoding\\)\\):.*\n\\([ \t].*\n\\)*"
-                            article-insert)
-         (setq article-insert (replace-match "" t t article-insert)))
-       (let ((case-fold-search nil))
-         (goto-char body-begin)
-         (setq eof-flag (not (re-search-forward boundary-regexp body-end t)))
+The generated article should use MESSAGE-ID and REFERENCES field values."
+  ;; Note: `case-fold-search' is already `t' from the calling function.
+  (let ((head-begin begin)
+       (body-end end)
+       head-end body-begin type subtype composite comment)
+    (save-excursion
+      ;; Gracefully handle a missing body.
+      (goto-char head-begin)
+      (if (search-forward "\n\n" body-end t)
+         (setq head-end (1- (point))
+               body-begin (point))
+       (setq head-end end
+             body-begin end))
+      ;; Save MIME attributes.
+      (goto-char head-begin)
+      (if (re-search-forward "\
+^Content-Type: *\\([^ \t\n/;]+\\)/\\([^ \t\n/;]+\\)"
+                            head-end t)
+         (setq type (downcase (match-string 1))
+               subtype (downcase (match-string 2)))
+       (setq type "text"
+             subtype "plain"))
+      (setq composite (string= type "multipart")
+           comment (concat position
+                           (when (and position composite) ".")
+                           (when composite "*")
+                           (when (or position composite) " ")
+                           (cond ((string= subtype "plain") type)
+                                 ((string= subtype "basic") type)
+                                 (t subtype))))
+      ;; Generate dissection information for this entity.
+      (push (list (incf nndoc-mime-split-ordinal)
+                 head-begin head-end body-begin body-end
+                 (count-lines body-begin body-end)
+                 comment message-id references)
+           nndoc-dissection-alist)
+      ;; Recurse for all sub-entities, if any.
+      (goto-char head-begin)
+      (when (re-search-forward
+            (concat "\
+^Content-Type: *multipart/\\([a-z]+\\);\\(.*;\\)*"
+                    "[ \t\n]*[ \t]boundary=\"?\\([^\"\n]*[^\" \t\n]\\)")
+          head-end t)
+       (let ((boundary (concat "\n--" (match-string 3) "\\(--\\)?[ \t]*\n"))
+             (part-counter 0)
+             begin end eof-flag)
+         (goto-char head-end)
+         (setq eof-flag (not (re-search-forward boundary body-end t)))
          (while (not eof-flag)
-           (setq part-begin (point))
-           (cond ((re-search-forward boundary-regexp body-end t)
+           (setq begin (point))
+           (cond ((re-search-forward boundary body-end t)
                   (or (not (match-string 1))
                       (string= (match-string 1) "")
                       (setq eof-flag t))
                   (forward-line -1)
-                  (setq part-end (point))
+                  (setq end (point))
                   (forward-line 1))
-                 (t (setq part-end body-end
+                 (t (setq end body-end
                           eof-flag t)))
-           (save-excursion
-             (nndoc-dissect-mime-parts-sub
-              part-begin part-end article-insert
-              (concat position
-                      (and position ".")
-                      (format "%d" (incf part-counter)))
-              message-id)))))))))
+           (nndoc-dissect-mime-parts-sub begin end
+                                         (concat position (when position ".")
+                                                 (format "%d"
+                                                         (incf part-counter)))
+                                         (nnmail-message-id)
+                                         message-id)))))))
 
 ;;;###autoload
 (defun nndoc-add-type (definition &optional position)