annotate lisp/nneething.el @ 13686:6e3b9c9595eb

Fixed dst-in-effect for southern hemisphere. Also made doc string clearer.

;;; nneething.el --- random file access for Gnus
;; Copyright (C) 1995 Free Software Foundation, Inc.

;; Author: Lars Magne Ingebrigtsen <[e-mail]>
;; 	Masanobu UMEDA <[e-mail]>
;; Keywords: news, mail

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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.

;;; Commentary:

;; Based on nnspool.el by Masanobu UMEDA <[e-mail]>.
;; For an overview of what the interface functions do, please see the
;; Gnus sources.  

;;; Code:

(require 'nnheader)
(require 'nnmail)

(defvar nneething-map-file-directory "~/.nneething/"
  "*Map files directory.")

(defvar nneething-exclude-files "~$"
  "*Regexp saying what files to exclude from the group.")

(defvar nneething-map-file ".nneething"
  "*Name of map files.")



(defconst nneething-version "nneething 1.0"
  "nneething version.")

(defvar nneething-current-directory nil
  "Current news group directory.")

(defvar nneething-status-string "")
(defvar nneething-group-alist nil)



(defvar nneething-directory nil)
(defvar nneething-group nil)
(defvar nneething-map nil)
(defvar nneething-read-only nil)
(defvar nneething-active nil)
(defvar nneething-server-variables 
  (list
   (list 'nneething-directory nneething-directory)
   '(nneething-current-directory nil)
   '(nneething-status-string "")
   '(nneething-group-alist)))



;;; Interface functions.

(defun nneething-retrieve-headers (sequence &optional newsgroup server)
  (nneething-possibly-change-directory newsgroup)

  (save-excursion
    (set-buffer nntp-server-buffer)
    (erase-buffer)
    (let* ((number (length sequence))
	   (count 0)
	   (large (and (numberp nnmail-large-newsgroup)
		       (> number nnmail-large-newsgroup)))
	   article file)

      (if (stringp (car sequence))
	  'headers

	(while sequence
	  (setq article (car sequence))
	  (setq file (nneething-file-name article))

	  (if (and (file-exists-p file)
		   (not (zerop (nth 7 (file-attributes file)))))
	      (progn
		(insert (format "221 %d Article retrieved.\n" article))
		(nneething-insert-head file)
		(insert ".\n")))

	  (setq sequence (cdr sequence)
		count (1+ count))

	  (and large
	       (zerop (% count 20))
	       (message "nneething: Receiving headers... %d%%"
			(/ (* count 100) number))))

	(and large (message "nneething: Receiving headers...done"))

	;; Fold continuation lines.
	(goto-char (point-min))
	(while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
	  (replace-match " " t t))
	'headers))))

(defun nneething-open-server (server &optional defs)
  (setq nneething-status-string "")
  (nnheader-init-server-buffer))

(defun nneething-close-server (&optional server)
  t)

(defun nneething-server-opened (&optional server)
  t)

(defun nneething-status-message (&optional server)
  nneething-status-string)

(defun nneething-request-article (id &optional newsgroup server buffer)
  (nneething-possibly-change-directory newsgroup)
  (let ((file (if (stringp id) nil (nneething-file-name id)))
	(nntp-server-buffer (or buffer nntp-server-buffer)))
    (and (stringp file)			; We did not request by Message-ID.
	 (file-exists-p file)		; The file exists.
	 (not (file-directory-p file))	; It's not a dir.
	 (save-excursion
	   (nnmail-find-file file)	; Insert the file in the nntp buf.
	   (or (nnheader-article-p)	; Either it's a real article...
	       (progn
		 (goto-char (point-min))
		 (nneething-make-head file) ; ... or we fake some headers.
		 (insert "\n")))
	   t))))

(defun nneething-request-group (group &optional dir dont-check)
  (nneething-possibly-change-directory group dir)
  (or dont-check (nneething-create-mapping))
  (save-excursion
    (set-buffer nntp-server-buffer)
    (erase-buffer)
    (if (> (car nneething-active) (cdr nneething-active))
	(insert (format "211 0 1 0 %s\n" group))
      (insert (format "211 %d %d %d %s\n" 
		      (- (1+ (cdr nneething-active)) (car nneething-active))
		      (car nneething-active) (cdr nneething-active)
		      group)))
    t))

(defun nneething-request-list (&optional server dir)
  (save-excursion
    (set-buffer nntp-server-buffer)
    (erase-buffer))
  nil)

(defun nneething-request-newgroups (date &optional server)
  (save-excursion
    (set-buffer nntp-server-buffer)
    (erase-buffer))
  nil)

(defun nneething-request-post (&optional server)
  (mail-send-and-exit nil))

(defalias 'nneething-request-post-buffer 'nnmail-request-post-buffer)

(defun nneething-close-group (group &optional server)
  t)


;;; Internal functions.

(defun nneething-possibly-change-directory (group &optional dir)
  (if (not group)
      ()
    (if (and nneething-group
	     (string= group nneething-group))
	t
      (let (entry)
	(if (setq entry (assoc group nneething-group-alist))
	    (progn
	      (setq nneething-group group)
	      (setq nneething-directory (nth 1 entry))
	      (setq nneething-map (nth 2 entry))
	      (setq nneething-active (nth 3 entry)))
	  (setq nneething-group group)
	  (setq nneething-directory dir)
	  (setq nneething-map nil)
	  (setq nneething-active (cons 1 0))
	  (nneething-create-mapping)
	  (setq nneething-group-alist
		(cons (list group dir nneething-map nneething-active)
		      nneething-group-alist)))))))

(defun nneething-map-file ()
  ;; We make sure that the .neething directory exists. 
  (make-directory nneething-map-file-directory 'parents)
  ;; We store it in a special directory under the user's home dir.
  (concat (file-name-as-directory nneething-map-file-directory)
	  nneething-group nneething-map-file))

(defun nneething-create-mapping ()
  ;; Read nneething-active and nneething-map
  (let ((map-file (nneething-map-file))
	(files (directory-files nneething-directory))
	touched)
    (if (file-exists-p map-file)
	(condition-case nil
	    (load map-file nil t t)
	  (error nil)))
    (or nneething-active (setq nneething-active (cons 1 0)))
    ;; Remove files matching that regexp.
    (let ((f files)
	  prev)
      (while f
	(if (string-match nneething-exclude-files (car f))
	    (if prev (setcdr prev (cdr f))
	      (setq files (cdr files)))
	  (setq prev f))
	(setq f (cdr f))))
    ;; Remove files that have disappeared from the map.
    (let ((map nneething-map)
	  prev)
      (while map
	(if (member (car (car map)) files)
	    (setq prev map)
	  (setq touched t)
	  (if prev
	      (setcdr prev (cdr map))
	    (setq nneething-map (cdr nneething-map))))
	(setq map (cdr map))))
    ;; Find all new files and enter them into the map.
    (while files
      (or (assoc (car files) nneething-map) ; If already in the map, ignore.
	  (progn
	    (setq touched t)
	    (setcdr nneething-active (1+ (cdr nneething-active)))
	    (setq nneething-map
		  (cons (cons (car files) (cdr nneething-active)) nneething-map))))
      (setq files (cdr files)))
    (if (or (not touched) nneething-read-only)
	()
      (save-excursion
	(set-buffer (get-buffer-create " *nneething map*"))
	(buffer-disable-undo (current-buffer))
	(erase-buffer)
	(insert "(setq nneething-map '" (prin1-to-string nneething-map) ")\n"
		"(setq nneething-active '" (prin1-to-string nneething-active)
		")\n")
	(write-region (point-min) (point-max) map-file nil 'nomesg)
	(kill-buffer (current-buffer))))))

(defvar nneething-message-id-number 0)
(defvar nneething-work-buffer " *nneething work*")

(defun nneething-insert-head (file)
  (and (nneething-get-head file)
       (insert-buffer-substring nneething-work-buffer)))

(defun nneething-make-head (file)
  (let ((atts (file-attributes file)))
    (insert "Subject: " (file-name-nondirectory file) "\n"
	    "Message-ID: <nneething-"
	    (int-to-string 
	     (setq nneething-message-id-number
		   (1+ nneething-message-id-number)))
	    "@" (system-name) ">\n"
	    "Date: " (current-time-string (nth 5 atts)) "\n"
	    (nneething-from-line (nth 2 atts))
	    "Chars: " (int-to-string (nth 7 atts)) "\n")))

(defun nneething-from-line (uid)
  (let ((login (condition-case nil 
		   (user-login-name uid)
		 (error 
		  (cond ((= uid (user-uid)) (user-login-name))
			((zerop uid) "root")
			(t (int-to-string uid))))))
	(name (condition-case nil 
		  (user-full-name uid)
		(error 
		 (cond ((= uid (user-uid)) (user-full-name))
		       ((zerop uid) "Ms. Root"))))))
    (concat "From: " login "@" (system-name) 
	    (if name (concat " (" name ")") "") "\n")))

(defun nneething-get-head (file)
  (save-excursion
    (set-buffer (get-buffer-create nneething-work-buffer))
    (setq case-fold-search nil)
    (buffer-disable-undo (current-buffer))
    (erase-buffer)
    (cond 
     ((not (file-exists-p file))
      ;; The file do not exist. 
      nil)
     ((or (file-directory-p file)
	  (file-symlink-p file))
      ;; It's a dir, so we fudge a head.
      (nneething-make-head file) t)
     (t 
      ;; We examine the file.
      (nnheader-insert-head file)
      (if (nnheader-article-p)
	  (delete-region 
	   (progn
	     (goto-char (point-min))
	     (or (and (search-forward "\n\n" nil t)
		      (1- (point)))
		 (point-max)))
	   (point-max))
	(erase-buffer)
	(nneething-make-head file))
      t))))

(defun nneething-number-to-file (number)
  (car (rassq number nneething-map)))

(defun nneething-file-name (article)
  (concat (file-name-as-directory nneething-directory)
	  (if (numberp article) (nneething-number-to-file article)
	    article)))

(provide 'nneething)

;;; nneething.el ends here