*** empty log message ***
[gnus] / lisp / nndoc.el
index a70a9bd..77f8fa5 100644 (file)
@@ -18,8 +18,9 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
 (require 'nnheader)
 (require 'rmail)
 (require 'nnmail)
+(eval-when-compile (require 'cl))
 
 (defvar nndoc-article-type 'guess
   "*Type of the file.
-One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
-`forward', `mime-digest', `standard-digest', `slack-digest', or
+One of `mbox', `babyl', `digest', `news', `rnews', `mmdf', `forward',
+`mime-digest', `standard-digest', `slack-digest', `clari-briefs' or
 `guess'.")
 
+(defvar nndoc-post-type 'mail
+  "*Whether the nndoc group is `mail' or `post'.")
+
 (defvar nndoc-type-alist 
   `((mmdf 
      (article-begin .  "^\^A\^A\^A\^A\n")
@@ -42,7 +47,7 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
     (news
      (article-begin . "^Path:"))
     (rnews
-     (article-begin . "^#! *rnews +\\([0-9]\\)+ *\n")
+     (article-begin . "^#! *rnews +\\([0-9]+\\) *\n")
      (body-end-function . nndoc-rnews-body-end))
     (mbox 
      (article-begin . 
@@ -54,6 +59,7 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
     (babyl 
      (article-begin . "\^_\^L *\n")
      (body-end . "\^_")
+     (body-begin-function . nndoc-babyl-body-begin)
      (head-begin . "^[0-9].*\n"))
     (forward
      (article-begin . "^-+ Start of forwarded message -+\n+")
@@ -68,6 +74,7 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
     (slack-digest
      (article-begin . "^------------------------------*[\n \t]+")
      (head-end . "^ ?$")
+     (body-end-function . nndoc-digest-body-end)
      (body-begin . "^ ?$")
      (file-end . "^End of")
      (prepare-body . nndoc-prepare-digest-body))
@@ -77,11 +84,13 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
      (body-end . "")
      (file-end . ""))
     (standard-digest
-     (first-article . ,(concat "^" (make-string 70 ?-) "\n\n"))
-     (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n"))
+     (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
+     (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
      (prepare-body . nndoc-prepare-digest-body)
      (body-end-function . nndoc-digest-body-end)
-     (file-end . "^End of .* Digest"))
+     (head-end . "^ ?$")
+     (body-begin . "^ ?\n")
+     (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$"))
     (guess 
      (guess . nndoc-guess-type))
     (digest
@@ -99,42 +108,53 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
 (defvar nndoc-file-end nil)
 (defvar nndoc-body-begin nil)
 (defvar nndoc-body-end-function nil)
+(defvar nndoc-body-begin-function nil)
 (defvar nndoc-body-end nil)
 (defvar nndoc-dissection-alist nil)
 (defvar nndoc-prepare-body nil)
 (defvar nndoc-generate-head nil)
 (defvar nndoc-article-transform nil)
 
+(defvar nndoc-status-string "")
+(defvar nndoc-group-alist nil)
+(defvar nndoc-current-buffer nil
+  "Current nndoc news buffer.")
+(defvar nndoc-address nil)
+
+\f
+
 (defvar nndoc-current-server nil)
 (defvar nndoc-server-alist nil)
 (defvar nndoc-server-variables
-  (list
-   (list 'nndoc-article-type nndoc-article-type)
-   '(nndoc-article-begin nil)
-   '(nndoc-article-end nil)
-   '(nndoc-head-begin nil)
-   '(nndoc-head-end nil)
-   '(nndoc-first-article nil)
-   '(nndoc-current-buffer nil)
-   '(nndoc-group-alist nil)
-   '(nndoc-end-of-file nil)
-   '(nndoc-body-begin nil)
-   '(nndoc-address nil)))
+  `((nndoc-article-type ,nndoc-article-type)
+    (nndoc-article-begin nil)
+    (nndoc-article-end nil)
+    (nndoc-head-begin nil)
+    (nndoc-head-end nil)
+    (nndoc-first-article nil)
+    (nndoc-current-buffer nil)
+    (nndoc-group-alist nil)
+    (nndoc-end-of-file nil)
+    (nndoc-body-begin nil)
+    (nndoc-dissection-alist nil)
+    (nndoc-generate-head nil)
+    (nndoc-article-transform nil)
+    (nndoc-body-end-function nil)
+    (nndoc-prepare-body nil)
+    (nndoc-body-begin-function nil)
+    (nndoc-status-string ,nndoc-status-string)
+    (nndoc-body-end ,nndoc-body-end)
+    (nndoc-file-end ,nndoc-file-end)
+    (nndoc-file-begin ,nndoc-file-begin)
+    (nndoc-type-alist ,nndoc-type-alist)
+    (nndoc-post-type ,nndoc-post-type)
+    (nndoc-address nil)))
 
 (defconst nndoc-version "nndoc 1.0"
   "nndoc version.")
 
-(defvar nndoc-current-buffer nil
-  "Current nndoc news buffer.")
-
-(defvar nndoc-address nil)
-
 \f
 
-(defvar nndoc-status-string "")
-
-(defvar nndoc-group-alist nil)
-
 ;;; Interface functions
 
 (defun nndoc-retrieve-headers (articles &optional newsgroup server fetch-old)
@@ -146,40 +166,26 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
        (if (stringp (car articles))
            'headers
          (while articles
-           (setq entry (cdr (assq (setq article (pop articles))
-                                  nndoc-dissection-alist)))
-           (insert (format "221 %d Article retrieved.\n" article))
-           (if nndoc-generate-head
-               (funcall nndoc-generate-head article)
-             (insert-buffer-substring
-              nndoc-current-buffer (car entry) (nth 1 entry)))
-           (goto-char (point-max))
-           (or (= (char-after (1- (point))) ?\n) (insert "\n"))
-           (insert (format "Lines: %d\n" (nth 4 entry)))
-           (insert ".\n"))
+           (when (setq entry (cdr (assq (setq article (pop articles))
+                                        nndoc-dissection-alist)))
+             (insert (format "221 %d Article retrieved.\n" article))
+             (if nndoc-generate-head
+                 (funcall nndoc-generate-head article)
+               (insert-buffer-substring
+                nndoc-current-buffer (car entry) (nth 1 entry)))
+             (goto-char (point-max))
+             (or (= (char-after (1- (point))) ?\n) (insert "\n"))
+             (insert (format "Lines: %d\n" (nth 4 entry)))
+             (insert ".\n")))
 
          (nnheader-fold-continuation-lines)
          'headers)))))
 
 (defun nndoc-open-server (server &optional defs)
-  (nnheader-init-server-buffer)
-  (if (equal server nndoc-current-server)
-      t
-    (if nndoc-current-server
-       (setq nndoc-server-alist 
-             (cons (list nndoc-current-server
-                         (nnheader-save-variables nndoc-server-variables))
-                   nndoc-server-alist)))
-    (let ((state (assoc server nndoc-server-alist)))
-      (if state 
-         (progn
-           (nnheader-restore-variables (nth 1 state))
-           (setq nndoc-server-alist (delq state nndoc-server-alist)))
-       (nnheader-set-init-variables nndoc-server-variables defs)))
-    (setq nndoc-current-server server)
-    t))
+  (nnheader-change-server 'nndoc server defs))
 
 (defun nndoc-close-server (&optional server)
+  (setq nndoc-current-server nil)
   t)
 
 (defun nndoc-server-opened (&optional server)
@@ -215,24 +221,24 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
 
 (defun nndoc-request-group (group &optional server dont-check)
   "Select news GROUP."
-  (save-excursion
-    (let (number)
-      (cond 
-       ((not (nndoc-possibly-change-buffer group server))
-       (nnheader-report 'nndoc "No such file or buffer: %s"
-                        nndoc-address))
-       (dont-check
-       (nnheader-report 'nndoc "Selected group %s" group)
-       t)
-       ((zerop (setq number (length nndoc-dissection-alist)))
-       (nndoc-close-group group)
-       (nnheader-report 'nndoc "No articles in group %s" group))
-       (t
-       (save-excursion
-         (set-buffer nntp-server-buffer)
-         (erase-buffer)
-         (insert (format "211 %d %d %d %s\n" number 1 number group))
-         t))))))
+  (let (number)
+    (cond 
+     ((not (nndoc-possibly-change-buffer group server))
+      (nnheader-report 'nndoc "No such file or buffer: %s"
+                      nndoc-address))
+     (dont-check
+      (nnheader-report 'nndoc "Selected group %s" group)
+      t)
+     ((zerop (setq number (length nndoc-dissection-alist)))
+      (nndoc-close-group group)
+      (nnheader-report 'nndoc "No articles in group %s" group))
+     (t
+      (nnheader-insert "211 %d %d %d %s\n" number 1 number group)))))
+
+(defun nndoc-request-type (group &optional article)
+  (cond ((not article) 'unknown)
+        (nndoc-post-type nndoc-post-type)
+        (t 'unknown)))
 
 (defun nndoc-close-group (group &optional server)
   (nndoc-possibly-change-buffer group server)
@@ -278,11 +284,10 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
          (and (stringp nndoc-address)
               (file-exists-p nndoc-address)
               (not (file-directory-p nndoc-address))))
-      (setq nndoc-group-alist 
-           (cons (cons group (setq nndoc-current-buffer 
-                                   (get-buffer-create 
-                                    (concat " *nndoc " group "*"))))
-                 nndoc-group-alist))
+      (push (cons group (setq nndoc-current-buffer 
+                             (get-buffer-create 
+                              (concat " *nndoc " group "*"))))
+           nndoc-group-alist)
       (setq nndoc-dissection-alist nil)
       (save-excursion
        (set-buffer nndoc-current-buffer)
@@ -291,16 +296,21 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
        (if (stringp nndoc-address)
            (insert-file-contents nndoc-address)
          (insert-buffer-substring nndoc-address)))))
+    ;; Initialize the nndoc structures according to this new document.
     (when (and nndoc-current-buffer
               (not nndoc-dissection-alist))
       (save-excursion
        (set-buffer nndoc-current-buffer)
        (nndoc-set-delims)
        (nndoc-dissect-buffer)))
-    t))
+    (unless nndoc-current-buffer
+      (nndoc-close-server))
+    ;; Return whether we managed to select a file.
+    nndoc-current-buffer))
 
 ;; MIME (RFC 1341) digest hack by Ulrik Dickow <dickow@nbi.dk>.
 (defun nndoc-guess-digest-type ()
+  "Guess what digest type the current document is."
   (let ((case-fold-search t)           ; We match a bit too much, keep it simple.
        boundary-id b-delimiter entry)
     (goto-char (point-min))
@@ -318,13 +328,14 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
       (setcdr entry
              (list
               (cons 'head-end "^ ?$")
-              (cons 'body-begin "^ \n")
+              (cons 'body-begin "^ ?\n")
               (cons 'article-begin b-delimiter)
               (cons 'body-end-function 'nndoc-digest-body-end)
 ;             (cons 'body-end 
 ;                   (concat "\n--" boundary-id "\\(--\\)?[\n \t]+"))
               (cons 'file-end (concat "\n--" boundary-id "--[ \t]*$"))))
       'mime-digest)
+     ;; Standard digest.
      ((and (re-search-forward (concat "^" (make-string 70 ?-) "\n\n") nil t)
           (re-search-forward 
            (concat "\n\n" (make-string 30 ?-) "\n\n") nil t))
@@ -342,6 +353,8 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
    ((looking-at "\^A\^A\^A\^A$")
     'mmdf)
    ((looking-at "^Path:.*\n")
+    'news)
+   ((looking-at "#! *rnews")
     'rnews)
    ((re-search-forward "\^_\^L *\n" nil t)
     'babyl)
@@ -352,19 +365,18 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
    ((let ((case-fold-search nil))
       (re-search-forward "^\t[^a-z]+ ([^a-z]+) --" nil t))
     'clari-briefs)
-   ((re-search-forward "^Path: .*!" nil t)
-    'news)
    (t 
     'digest)))
 
 (defun nndoc-set-delims ()
+  "Set the nndoc delimiter variables according to the type of the document."
   (let ((vars '(nndoc-file-begin 
                nndoc-first-article 
                nndoc-article-end nndoc-head-begin nndoc-head-end
                nndoc-file-end nndoc-article-begin
                nndoc-body-begin nndoc-body-end-function nndoc-body-end
                nndoc-prepare-body nndoc-article-transform
-               nndoc-generate-head)))
+               nndoc-generate-head nndoc-body-begin-function)))
     (while vars
       (set (pop vars) nil)))
   (let* (defs guess)
@@ -372,8 +384,9 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
     (while (setq defs (cdr (assq nndoc-article-type nndoc-type-alist))
                 guess (assq 'guess defs))
       (setq nndoc-article-type (funcall (cdr guess))))
+    ;; Set the nndoc variables.
     (while defs
-      (set (intern (format "nndoc-%s" (car (car defs))))
+      (set (intern (format "nndoc-%s" (caar defs)))
           (cdr (pop defs))))))
 
 (defun nndoc-search (regexp)
@@ -382,6 +395,7 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
     (beginning-of-line)))
 
 (defun nndoc-dissect-buffer ()
+  "Go through the document and partition it into heads/bodies/articles."
   (let ((i 0)
        (first t)
        head-begin head-end body-begin body-end)
@@ -397,27 +411,32 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
                 (nndoc-search nndoc-first-article)
               (nndoc-search nndoc-article-begin))
        (setq first nil)
-       (when nndoc-head-begin
-         (nndoc-search nndoc-head-begin))
-       (setq head-begin (point))
-       (nndoc-search (or nndoc-head-end "^$"))
-       (setq head-end (point))
-       (nndoc-search (or nndoc-body-begin "^\n"))
-       (setq body-begin (point))
-       (or (and nndoc-body-end-function
-                (funcall nndoc-body-end-function))
-           (and nndoc-body-end
-                (nndoc-search nndoc-body-end))
-           (nndoc-search nndoc-article-begin)
-           (progn
-             (goto-char (point-max))
-             (when nndoc-file-end
-               (and (re-search-backward nndoc-file-end nil t)
-                    (beginning-of-line)))))
-       (setq body-end (point))
-       (push (list (incf i) head-begin head-end body-begin body-end
-                   (count-lines body-begin body-end))
-             nndoc-dissection-alist)))))
+       (when nndoc-head-begin 
+         (nndoc-search nndoc-head-begin))
+       (if (and nndoc-file-end
+                (looking-at nndoc-file-end))
+           (goto-char (point-max))
+         (setq head-begin (point))
+         (nndoc-search (or nndoc-head-end "^$"))
+         (setq head-end (point))
+         (if nndoc-body-begin-function
+             (funcall nndoc-body-begin-function)
+           (nndoc-search (or nndoc-body-begin "^\n")))
+         (setq body-begin (point))
+         (or (and nndoc-body-end-function
+                  (funcall nndoc-body-end-function))
+             (and nndoc-body-end
+                  (nndoc-search nndoc-body-end))
+             (nndoc-search nndoc-article-begin)
+             (progn
+               (goto-char (point-max))
+               (when nndoc-file-end
+                 (and (re-search-backward nndoc-file-end nil t)
+                      (beginning-of-line)))))
+         (setq body-end (point))
+         (push (list (incf i) head-begin head-end body-begin body-end
+                     (count-lines body-begin body-end))
+               nndoc-dissection-alist))))))
 
 (defun nndoc-prepare-digest-body ()
   "Unquote quoted non-separators in digests."
@@ -436,7 +455,8 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
          (and (re-search-backward nndoc-article-begin nil t)
               (setq end (point))
               (search-forward "\n\n" beg t)
-              (re-search-backward "^Content-Length: \\([0-9]+\\) *$" end t)
+              (re-search-backward
+               "^Content-Length:[ \t]*\\([0-9]+\\) *$" end t)
               (setq len (string-to-int (match-string 1)))
               (search-forward "\n\n" beg t)
               (or (= (setq len (+ (point) len)) (point-max))
@@ -446,9 +466,9 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
       (goto-char len))))
 
 (defun nndoc-rnews-body-end ()
-  (save-excursion
-    (and (re-search-backward nndoc-article-begin nil t)
-        (goto-char (+ (point) (string-to-int (match-string 1)))))))  
+  (and (re-search-backward nndoc-article-begin nil t)
+       (forward-line 1)
+       (goto-char (+ (point) (string-to-int (match-string 1))))))
 
 (defun nndoc-transform-clari-briefs (article)
   (goto-char (point-min))
@@ -465,7 +485,9 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
        (narrow-to-region (car entry) (nth 3 entry))
        (goto-char (point-min))
        (when (looking-at " *\\*\\(.*\\)$")
-         (setq subject (match-string 1)))
+         (setq subject (match-string 1))
+         (when (string-match "[ \t]+$" subject)
+           (setq subject (substring subject 0 (match-beginning 0)))))
        (when
            (let ((case-fold-search nil))
              (re-search-forward
@@ -474,6 +496,11 @@ One of `mbox', `babyl', `digest', `news', `rnews', `mmdf',
     (insert "From: " "clari@clari.net (" (or from "unknown") ")"
            "\nSubject: " (or subject "(no subject)") "\n")))
 
+(defun nndoc-babyl-body-begin ()
+  (re-search-forward "^\n" nil t)
+  (when (looking-at "\*\*\* EOOH \*\*\*")
+    (re-search-forward "^\n" nil t)))
+
 (provide 'nndoc)
 
 ;;; nndoc.el ends here