;;; nnsoup.el --- SOUP access for Gnus
-;; Copyright (C) 1995 Free Software Foundation, Inc.
-;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
-;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
+;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
+;; Free Software Foundation, Inc.
+
+;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
+;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
;; Keywords: news, mail
;; This file is part of GNU Emacs.
;; 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 'nnmail)
(require 'gnus-soup)
(require 'gnus-msg)
+(require 'nnoo)
+(eval-when-compile (require 'cl))
+
+(nnoo-declare nnsoup)
+
+(defvoo nnsoup-directory "~/SOUP/"
+ "*SOUP packet directory.")
-(defvar nnsoup-directory "~/SOUP/"
- "*SOUP packet directory directory.")
+(defvoo nnsoup-tmp-directory
+ (cond ((fboundp 'temp-directory) (temp-directory))
+ ((boundp 'temporary-file-directory) temporary-file-directory)
+ ("/tmp/"))
+ "*Where nnsoup will store temporary files.")
-(defvar nnsoup-replies-directory (concat nnsoup-directory "replies/")
+(defvoo nnsoup-replies-directory (expand-file-name "replies/" nnsoup-directory)
"*Directory where outgoing packets will be composed.")
-(defvar nnsoup-replies-format-type ?n
+(defvoo nnsoup-replies-format-type ?u ;; u is USENET news format.
"*Format of the replies packages.")
-(defvar nnsoup-replies-index-type ?n
+(defvoo nnsoup-replies-index-type ?n
"*Index type of the replies packages.")
-(defvar nnsoup-active-file (concat nnsoup-directory "active")
+(defvoo nnsoup-active-file (expand-file-name "active" nnsoup-directory)
"Active file.")
-(defvar nnsoup-packer "tar cf - %s | gzip > $HOME/Soupin%d.tgz"
+(defvoo nnsoup-packer "tar cf - %s | gzip > $HOME/Soupin%d.tgz"
"Format string command for packing a SOUP packet.
The SOUP files will be inserted where the %s is in the string.
-This string MUST contain both %s and %d. The file number will be
+This string MUST contain both %s and %d. The file number will be
inserted where %d appears.")
-(defvar nnsoup-unpacker "gunzip -c %s | tar xvf -"
+(defvoo nnsoup-unpacker "gunzip -c %s | tar xvf -"
"*Format string command for unpacking a SOUP packet.
The SOUP packet file name will be inserted at the %s.")
-(defvar nnsoup-packet-directory "~/"
+(defvoo nnsoup-packet-directory "~/"
"*Where nnsoup will look for incoming packets.")
-(defvar nnsoup-packet-regexp "Soupout"
+(defvoo nnsoup-packet-regexp "Soupout"
"*Regular expression matching SOUP packets in `nnsoup-packet-directory'.")
+(defvoo nnsoup-always-save t
+ "If non nil commit the reply buffer on each message send.
+This is necessary if using message mode outside Gnus with nnsoup as a
+backend for the messages.")
+
\f
(defconst nnsoup-version "nnsoup 0.0"
"nnsoup version.")
-(defvar nnsoup-status-string "")
-(defvar nnsoup-group-alist nil)
-(defvar nnsoup-replies-list nil)
-(defvar nnsoup-buffers nil)
-(defvar nnsoup-current-group nil)
-
-\f
-
-;; Server variables.
-
-(defvar nnsoup-current-server nil)
-(defvar nnsoup-server-alist nil)
-(defvar nnsoup-server-variables
- (list
- (list 'nnsoup-directory nnsoup-directory)
- (list 'nnsoup-active-file nnsoup-active-file)
- '(nnsoup-status-string "")
- '(nnsoup-group-alist nil)))
-
+(defvoo nnsoup-status-string "")
+(defvoo nnsoup-group-alist nil)
+(defvoo nnsoup-current-prefix 0)
+(defvoo nnsoup-replies-list nil)
+(defvoo nnsoup-buffers nil)
+(defvoo nnsoup-current-group nil)
+(defvoo nnsoup-group-alist-touched nil)
+(defvoo nnsoup-article-alist nil)
\f
;;; Interface functions.
-(defun nnsoup-retrieve-headers (sequence &optional group server fetch-old)
+(nnoo-define-basics nnsoup)
+
+(deffoo nnsoup-retrieve-headers (sequence &optional group server fetch-old)
(nnsoup-possibly-change-group group)
(save-excursion
(set-buffer nntp-server-buffer)
(erase-buffer)
- (let ((areas (cdr (assoc nnsoup-current-group nnsoup-group-alist)))
+ (let ((areas (cddr (assoc nnsoup-current-group nnsoup-group-alist)))
(articles sequence)
(use-nov t)
- useful-areas this-area-seq)
+ useful-areas this-area-seq msg-buf)
(if (stringp (car sequence))
+ ;; We don't support fetching by Message-ID.
'headers
;; We go through all the areas and find which files the
;; articles in SEQUENCE come from.
(while (and areas sequence)
;; Peel off areas that are below sequence.
- (while (and areas (< (cdr (car (car areas))) (car sequence)))
+ (while (and areas (< (cdar (car areas)) (car sequence)))
(setq areas (cdr areas)))
- (if (not areas)
- ()
+ (when areas
;; This is a useful area.
- (setq useful-areas (cons (car areas) useful-areas)
- this-area-seq nil)
+ (push (car areas) useful-areas)
+ (setq this-area-seq nil)
;; We take note whether this MSG has a corresponding IDX
;; for later use.
- (if (or (= (gnus-soup-encoding-index
- (gnus-soup-area-encoding (nth 1 (car areas)))) ?n)
- (not (file-exists-p
- (nnsoup-file
- (gnus-soup-area-prefix (nth 1 (car areas)))))))
- (setq use-nov nil))
- ;; We assing the portion of `sequence' that is relevant to
+ (when (or (= (gnus-soup-encoding-index
+ (gnus-soup-area-encoding (nth 1 (car areas)))) ?n)
+ (not (file-exists-p
+ (nnsoup-file
+ (gnus-soup-area-prefix (nth 1 (car areas)))))))
+ (setq use-nov nil))
+ ;; We assign the portion of `sequence' that is relevant to
;; this MSG packet to this packet.
- (while (and sequence (<= (car sequence) (cdr (car (car areas)))))
- (setq this-area-seq (cons (car sequence) this-area-seq)
- sequence (cdr sequence)))
+ (while (and sequence (<= (car sequence) (cdar (car areas))))
+ (push (car sequence) this-area-seq)
+ (setq sequence (cdr sequence)))
(setcar useful-areas (cons (nreverse this-area-seq)
(car useful-areas)))))
;; We now have a list of article numbers and corresponding
- ;; areas.
+ ;; areas.
(setq useful-areas (nreverse useful-areas))
;; Two different approaches depending on whether all the MSG
;; what lines are relevant. If some of the IDX files are
;; missing, we must return HEADs for all the articles.
(if use-nov
- (while useful-areas
- (goto-char (point-max))
- (let ((b (point))
- (number (car (nth 1 (car useful-areas)))))
- (insert-buffer-substring
- (nnsoup-index-buffer
- (gnus-soup-area-prefix
- (nth 2 (car useful-areas)))))
- (goto-char b)
- ;; We have to remove the index number entires and
- ;; insert article numbers instead.
- (while (looking-at "[0-9]+")
- (replace-match (int-to-string number) t t)
- (setq number (1+ number))
- (forward-line 1)))
- (setq useful-areas (cdr useful-areas)))
+ ;; We have IDX files for all areas.
+ (progn
+ (while useful-areas
+ (goto-char (point-max))
+ (let ((b (point))
+ (number (car (nth 1 (car useful-areas))))
+ (index-buffer (nnsoup-index-buffer
+ (gnus-soup-area-prefix
+ (nth 2 (car useful-areas))))))
+ (when index-buffer
+ (insert-buffer-substring index-buffer)
+ (goto-char b)
+ ;; We have to remove the index number entries and
+ ;; insert article numbers instead.
+ (while (looking-at "[0-9]+")
+ (replace-match (int-to-string number) t t)
+ (incf number)
+ (forward-line 1))))
+ (setq useful-areas (cdr useful-areas)))
+ 'nov)
;; We insert HEADs.
(while useful-areas
- (setq articles (car (car useful-areas))
+ (setq articles (caar useful-areas)
useful-areas (cdr useful-areas))
(while articles
- (goto-char (point-max))
- (insert (format "221 %d Article retrieved.\n" (car articles)))
- (insert-buffer-substring
- (nnsoup-narrow-to-article
- (car articles) (cdr (car useful-areas)) 'head))
- (goto-char (point-max))
- (insert ".\n")
+ (when (setq msg-buf
+ (nnsoup-narrow-to-article
+ (car articles) (cdar useful-areas) 'head))
+ (goto-char (point-max))
+ (insert (format "221 %d Article retrieved.\n" (car articles)))
+ (insert-buffer-substring msg-buf)
+ (goto-char (point-max))
+ (insert ".\n"))
(setq articles (cdr articles))))
- ;; Fold continuation lines.
- (goto-char (point-min))
- (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
- (replace-match " " t t)))
- (if use-nov 'nov 'headers)))))
-
-(defun nnsoup-open-server (server &optional defs)
- (nnsoup-set-variables)
- (nnheader-init-server-buffer)
- (if (equal server nnsoup-current-server)
- t
- (if nnsoup-current-server
- (setq nnsoup-server-alist
- (cons (list nnsoup-current-server
- (nnheader-save-variables nnsoup-server-variables))
- nnsoup-server-alist)))
- (let ((state (assoc server nnsoup-server-alist)))
- (if state
- (progn
- (nnheader-restore-variables (nth 1 state))
- (setq nnsoup-server-alist (delq state nnsoup-server-alist)))
- (nnheader-set-init-variables nnsoup-server-variables defs)))
- (setq nnsoup-current-server server))
- (nnsoup-read-active-file))
-
-(defun nnsoup-request-close ()
+ (nnheader-fold-continuation-lines)
+ 'headers)))))
+
+(deffoo nnsoup-open-server (server &optional defs)
+ (nnoo-change-server 'nnsoup server defs)
+ (when (not (file-exists-p nnsoup-directory))
+ (condition-case ()
+ (make-directory nnsoup-directory t)
+ (error t)))
+ (cond
+ ((not (file-exists-p nnsoup-directory))
+ (nnsoup-close-server)
+ (nnheader-report 'nnsoup "Couldn't create directory: %s" nnsoup-directory))
+ ((not (file-directory-p (file-truename nnsoup-directory)))
+ (nnsoup-close-server)
+ (nnheader-report 'nnsoup "Not a directory: %s" nnsoup-directory))
+ (t
+ (nnsoup-read-active-file)
+ (nnheader-report 'nnsoup "Opened server %s using directory %s"
+ server nnsoup-directory)
+ t)))
+
+(deffoo nnsoup-request-close ()
(nnsoup-write-active-file)
(nnsoup-write-replies)
- (while nnsoup-buffers
- (and (car nnsoup-buffers)
- (buffer-name (car nnsoup-buffers))
- (kill-buffer (car nnsoup-buffers)))
- (setq nnsoup-buffers (cdr nnsoup-buffers)))
+ (gnus-soup-save-areas)
+ ;; Kill all nnsoup buffers.
+ (let (buffer)
+ (while nnsoup-buffers
+ (setq buffer (cdr (pop nnsoup-buffers)))
+ (and buffer
+ (buffer-name buffer)
+ (kill-buffer buffer))))
(setq nnsoup-group-alist nil
+ nnsoup-group-alist-touched nil
nnsoup-current-group nil
- nnsoup-current-server nil
- nnsoup-server-alist nil
nnsoup-replies-list nil)
+ (nnoo-close-server 'nnoo)
t)
-(defun nnsoup-close-server (&optional server)
- t)
-
-(defun nnsoup-server-opened (&optional server)
- (and (equal server nnsoup-current-server)
- nntp-server-buffer
- (buffer-name nntp-server-buffer)))
-
-(defun nnsoup-status-message (&optional server)
- nnsoup-status-string)
-
-(defun nnsoup-request-article (id &optional newsgroup server buffer)
+(deffoo nnsoup-request-article (id &optional newsgroup server buffer)
(nnsoup-possibly-change-group newsgroup)
- (let ((buffer (or buffer nntp-server-buffer)))
+ (let (buf)
(save-excursion
- (set-buffer buffer)
+ (set-buffer (or buffer nntp-server-buffer))
(erase-buffer)
- (if (stringp id)
- ()
- (insert-buffer-substring
- (nnsoup-narrow-to-article id))
+ (when (and (not (stringp id))
+ (setq buf (nnsoup-narrow-to-article id)))
+ (insert-buffer-substring buf)
t))))
-(defun nnsoup-request-group (group &optional server dont-check)
+(deffoo nnsoup-request-group (group &optional server dont-check)
(nnsoup-possibly-change-group group)
- (if dont-check
- ()
- (let ((area (cdr (assoc group nnsoup-group-alist)))
- min max)
- (save-excursion
- (set-buffer nntp-server-buffer)
- (erase-buffer)
- (setq min (car (car (car area))))
- (while (cdr area)
- (setq area (cdr area)))
- (setq max (cdr (car (car area))))
- (insert (format "211 %d %d %d %s\n"
- (max (1+ (- max min)) 0) min max group)))))
- t)
-
-(defun nnsoup-close-group (group &optional server)
+ (if dont-check
+ t
+ (let ((active (cadr (assoc group nnsoup-group-alist))))
+ (if (not active)
+ (nnheader-report 'nnsoup "No such group: %s" group)
+ (nnheader-insert
+ "211 %d %d %d %s\n"
+ (max (1+ (- (cdr active) (car active))) 0)
+ (car active) (cdr active) group)))))
+
+(deffoo nnsoup-request-type (group &optional article)
+ (nnsoup-possibly-change-group group)
+ ;; Try to guess the type based on the first article in the group.
+ (when (not article)
+ (setq article
+ (cdar (car (cddr (assoc group nnsoup-group-alist))))))
+ (if (not article)
+ 'unknown
+ (let ((kind (gnus-soup-encoding-kind
+ (gnus-soup-area-encoding
+ (nth 1 (nnsoup-article-to-area
+ article nnsoup-current-group))))))
+ (cond ((= kind ?m) 'mail)
+ ((= kind ?n) 'news)
+ (t 'unknown)))))
+
+(deffoo nnsoup-close-group (group &optional server)
+ ;; Kill all nnsoup buffers.
+ (let ((buffers nnsoup-buffers)
+ elem)
+ (while buffers
+ (when (equal (car (setq elem (pop buffers))) group)
+ (setq nnsoup-buffers (delq elem nnsoup-buffers))
+ (and (cdr elem) (buffer-name (cdr elem))
+ (kill-buffer (cdr elem))))))
t)
-(defun nnsoup-request-list (&optional server)
+(deffoo nnsoup-request-list (&optional server)
(save-excursion
(set-buffer nntp-server-buffer)
(erase-buffer)
+ (unless nnsoup-group-alist
+ (nnsoup-read-active-file))
(let ((alist nnsoup-group-alist)
- min)
- (while alist
- (setq min (car (car (nth 1 (car alist)))))
- (insert (format "%s %d %d y\n" (car (car alist))
- (let ((areas (car alist)))
- (while (cdr areas)
- (setq areas (cdr areas)))
- (cdr (car (car areas)))) min))
- (setq alist (cdr alist)))
+ (standard-output (current-buffer))
+ entry)
+ (while (setq entry (pop alist))
+ (insert (car entry) " ")
+ (princ (cdadr entry))
+ (insert " ")
+ (princ (caadr entry))
+ (insert " y\n"))
t)))
-(defun nnsoup-request-scan (group &optional server)
- (or nnsoup-group-alist (nnsoup-read-areas))
+(deffoo nnsoup-request-scan (group &optional server)
(nnsoup-unpack-packets))
-(defun nnsoup-request-newgroups (date &optional server)
+(deffoo nnsoup-request-newgroups (date &optional server)
(nnsoup-request-list))
-(defun nnsoup-request-list-newsgroups (&optional server)
+(deffoo nnsoup-request-list-newsgroups (&optional server)
nil)
-(defun nnsoup-request-post (&optional server)
+(deffoo nnsoup-request-post (&optional server)
(nnsoup-store-reply "news")
t)
-(defun nnsoup-request-mail ()
+(deffoo nnsoup-request-mail (&optional server)
(nnsoup-store-reply "mail")
t)
-(defun nnsoup-request-post-buffer (post group &rest args)
+(deffoo nnsoup-request-expire-articles (articles group &optional server force)
(nnsoup-possibly-change-group group)
- (apply
- ;; Find out whether the source for this group is a mail or a news
- ;; group and call the right function for getting a buffer.
- (let ((enc (nth 1 (car (cdr (assoc nnsoup-current-group
- nnsoup-group-alist))))))
- (if (and enc
- (= (gnus-soup-encoding-kind (gnus-soup-area-encoding enc)) ?m))
- 'nnmail-request-post-buffer
- 'nntp-request-post-buffer))
- post group args))
+ (let* ((total-infolist (assoc group nnsoup-group-alist))
+ (active (cadr total-infolist))
+ (infolist (cddr total-infolist))
+ info range-list mod-time prefix)
+ (while infolist
+ (setq info (pop infolist)
+ range-list (gnus-uncompress-range (car info))
+ prefix (gnus-soup-area-prefix (nth 1 info)))
+ (when;; All the articles in this file are marked for expiry.
+ (and (or (setq mod-time (nth 5 (file-attributes
+ (nnsoup-file prefix))))
+ (setq mod-time (nth 5 (file-attributes
+ (nnsoup-file prefix t)))))
+ (gnus-sublist-p articles range-list)
+ ;; This file is old enough.
+ (nnmail-expired-article-p group mod-time force))
+ ;; Ok, we delete this file.
+ (when (ignore-errors
+ (nnheader-message
+ 5 "Deleting %s in group %s..." (nnsoup-file prefix)
+ group)
+ (when (file-exists-p (nnsoup-file prefix))
+ (delete-file (nnsoup-file prefix)))
+ (nnheader-message
+ 5 "Deleting %s in group %s..." (nnsoup-file prefix t)
+ group)
+ (when (file-exists-p (nnsoup-file prefix t))
+ (delete-file (nnsoup-file prefix t)))
+ t)
+ (setcdr (cdr total-infolist) (delq info (cddr total-infolist)))
+ (setq articles (gnus-sorted-difference articles range-list))))
+ (when (not mod-time)
+ (setcdr (cdr total-infolist) (delq info (cddr total-infolist)))))
+ (if (cddr total-infolist)
+ (setcar active (caaadr (cdr total-infolist)))
+ (setcar active (1+ (cdr active))))
+ (nnsoup-write-active-file t)
+ ;; Return the articles that weren't expired.
+ articles))
\f
;;; Internal functions
(defun nnsoup-possibly-change-group (group &optional force)
- (if group
- (setq nnsoup-current-group group)
- t))
+ (when (and group
+ (not (equal nnsoup-current-group group)))
+ (setq nnsoup-article-alist nil)
+ (setq nnsoup-current-group group))
+ t)
(defun nnsoup-read-active-file ()
- (if (file-exists-p nnsoup-active-file)
- (condition-case ()
- (load nnsoup-active-file)
- (error nil))))
-
-(defun nnsoup-write-active-file ()
- (save-excursion
- (set-buffer (get-buffer-create " *nnsoup work*"))
- (buffer-disable-undo (current-buffer))
- (erase-buffer)
- (insert (format "(setq nnsoup-group-alist '%S)\n" nnsoup-group-alist))
- (write-region (point-min) (point-max) nnsoup-active-file
- nil 'silent)
- (kill-buffer (current-buffer))))
+ (setq nnsoup-group-alist nil)
+ (when (file-exists-p nnsoup-active-file)
+ (ignore-errors
+ (load nnsoup-active-file t t t))
+ ;; Be backwards compatible.
+ (when (and nnsoup-group-alist
+ (not (atom (caadar nnsoup-group-alist))))
+ (let ((alist nnsoup-group-alist)
+ entry e min max)
+ (while (setq e (cdr (setq entry (pop alist))))
+ (setq min (caaar e))
+ (while (cdr e)
+ (setq e (cdr e)))
+ (setq max (cdar (car e)))
+ (setcdr entry (cons (cons min max) (cdr entry)))))
+ (setq nnsoup-group-alist-touched t))
+ nnsoup-group-alist))
+
+(defun nnsoup-write-active-file (&optional force)
+ (when (and nnsoup-group-alist
+ (or force
+ nnsoup-group-alist-touched))
+ (setq nnsoup-group-alist-touched nil)
+ (with-temp-file nnsoup-active-file
+ (gnus-prin1 `(setq nnsoup-group-alist ',nnsoup-group-alist))
+ (insert "\n")
+ (gnus-prin1 `(setq nnsoup-current-prefix ,nnsoup-current-prefix))
+ (insert "\n"))))
+
+(defun nnsoup-next-prefix ()
+ "Return the next free prefix."
+ (let (prefix)
+ (while (or (file-exists-p
+ (nnsoup-file (setq prefix (int-to-string
+ nnsoup-current-prefix))))
+ (file-exists-p (nnsoup-file prefix t)))
+ (incf nnsoup-current-prefix))
+ (incf nnsoup-current-prefix)
+ prefix))
+
+(defun nnsoup-file-name (dir file)
+ "Return the full path of FILE (in any case) in DIR."
+ (let* ((case-fold-search t)
+ (files (directory-files dir t))
+ (regexp (concat (regexp-quote file) "$")))
+ (car (delq nil
+ (mapcar
+ (lambda (file)
+ (if (string-match regexp file)
+ file
+ nil))
+ files)))))
(defun nnsoup-read-areas ()
- (save-excursion
- (set-buffer nntp-server-buffer)
- (let ((areas (gnus-soup-parse-areas (concat nnsoup-directory "AREAS")))
- entry number area lnum)
- ;; Go through all areas in the new AREAS file.
- (while areas
- (setq area (car areas)
- areas (cdr areas))
- ;; Find the number of new articles in this area.
- (setq number (nnsoup-number-of-articles area))
- (if (not (setq entry (assoc (gnus-soup-area-name area)
- nnsoup-group-alist)))
- ;; If this is a new area (group), we just add this info to
- ;; the group alist.
- (setq nnsoup-group-alist
- (cons (list (gnus-soup-area-name area)
+ (let ((areas-file (nnsoup-file-name nnsoup-tmp-directory "areas")))
+ (when areas-file
+ (save-excursion
+ (set-buffer nntp-server-buffer)
+ (let ((areas (gnus-soup-parse-areas areas-file))
+ entry number area lnum cur-prefix file)
+ ;; Go through all areas in the new AREAS file.
+ (while (setq area (pop areas))
+ ;; Change the name to the permanent name and move the files.
+ (setq cur-prefix (nnsoup-next-prefix))
+ (nnheader-message 5 "Incorporating file %s..." cur-prefix)
+ (when (file-exists-p
+ (setq file
+ (expand-file-name
+ (concat (gnus-soup-area-prefix area) ".IDX")
+ nnsoup-tmp-directory)))
+ (rename-file file (nnsoup-file cur-prefix)))
+ (when (file-exists-p
+ (setq file (expand-file-name
+ (concat (gnus-soup-area-prefix area) ".MSG")
+ nnsoup-tmp-directory)))
+ (rename-file file (nnsoup-file cur-prefix t))
+ (gnus-soup-set-area-prefix area cur-prefix)
+ ;; Find the number of new articles in this area.
+ (setq number (nnsoup-number-of-articles area))
+ (if (not (setq entry (assoc (gnus-soup-area-name area)
+ nnsoup-group-alist)))
+ ;; If this is a new area (group), we just add this info to
+ ;; the group alist.
+ (push (list (gnus-soup-area-name area)
+ (cons 1 number)
(list (cons 1 number) area))
- nnsoup-group-alist))
- ;; There are already articles in this group, so&nbs
projects / gnus / blobdiff