1 ;;; nneething.el --- random file access for Gnus
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
5 ;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; Based on nnspool.el by Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>.
28 ;; For an overview of what the interface functions do, please see the
35 (eval-when-compile (require 'cl))
37 (defvar nneething-map-file-directory "~/.nneething/"
38 "*Where nneething stores the map files.")
40 (defvar nneething-map-file ".nneething"
41 "*Name of the map files.")
43 (defvar nneething-exclude-files nil
44 "*Regexp saying what files to exclude from the group.
45 If this variable is nil, no files will be excluded.")
49 ;;; Internal variables.
51 (defconst nneething-version "nneething 1.0"
54 (defvar nneething-current-directory nil
55 "Current news group directory.")
57 (defvar nneething-status-string "")
58 (defvar nneething-group-alist nil)
60 (defvar nneething-message-id-number 0)
61 (defvar nneething-work-buffer " *nneething work*")
63 (defvar nneething-directory nil)
64 (defvar nneething-group nil)
65 (defvar nneething-map nil)
66 (defvar nneething-read-only nil)
67 (defvar nneething-active nil)
71 (defvar nneething-current-server nil)
72 (defvar nneething-server-alist)
73 (defvar nneething-server-variables
74 `((nneething-directory ,nneething-directory)
75 (nneething-current-directory nil)
76 (nneething-status-string "")
77 (nneething-active nil)
78 (nneething-read-only nil)
81 (nneething-work-buffer ,nneething-work-buffer)
82 (nneething-message-id-number ,nneething-message-id-number)
83 (nneething-exclude-files nil)
84 (nneething-map-file ,nneething-map-file)
85 (nneething-map-file-directory ,nneething-map-file-directory)
86 (nneething-group-alist nil)))
90 ;;; Interface functions.
92 (defun nneething-retrieve-headers (articles &optional group server fetch-old)
93 (nneething-possibly-change-directory group)
96 (set-buffer nntp-server-buffer)
98 (let* ((number (length articles))
100 (large (and (numberp nnmail-large-newsgroup)
101 (> number nnmail-large-newsgroup)))
104 (if (stringp (car articles))
107 (while (setq article (pop articles))
108 (setq file (nneething-file-name article))
110 (when (and (file-exists-p file)
111 (or (file-directory-p file)
112 (not (zerop (nth 7 (file-attributes file))))))
113 (insert (format "221 %d Article retrieved.\n" article))
114 (nneething-insert-head file)
121 (message "nneething: Receiving headers... %d%%"
122 (/ (* count 100) number))))
125 (message "nneething: Receiving headers...done"))
127 (nnheader-fold-continuation-lines)
130 (defun nneething-open-server (server &optional defs)
131 (nnheader-report 'nneething "")
132 (nnheader-init-server-buffer))
134 (defun nneething-close-server (&optional server)
135 (setq nneething-current-directory nil)
138 (defun nneething-server-opened (&optional server)
139 nneething-current-directory)
141 (defun nneething-status-message (&optional server)
142 nneething-status-string)
144 (defun nneething-request-article (id &optional group server buffer)
145 (nneething-possibly-change-directory group)
146 (let ((file (unless (stringp id) (nneething-file-name id)))
147 (nntp-server-buffer (or buffer nntp-server-buffer)))
148 (and (stringp file) ; We did not request by Message-ID.
149 (file-exists-p file) ; The file exists.
150 (not (file-directory-p file)) ; It's not a dir.
152 (nnmail-find-file file) ; Insert the file in the nntp buf.
153 (or (nnheader-article-p) ; Either it's a real article...
155 (goto-char (point-min))
156 (nneething-make-head file) ; ... or we fake some headers.
160 (defun nneething-request-group (group &optional dir dont-check)
161 (nneething-possibly-change-directory group dir)
163 (nneething-create-mapping)
164 (if (> (car nneething-active) (cdr nneething-active))
165 (nnheader-insert "211 0 1 0 %s\n" group)
168 (- (1+ (cdr nneething-active)) (car nneething-active))
169 (car nneething-active) (cdr nneething-active)
173 (defun nneething-request-list (&optional server dir)
174 (nnheader-report 'nneething "LIST is not implemented."))
176 (defun nneething-request-newgroups (date &optional server)
177 (nnheader-report 'nneething "NEWSGROUPS is not implemented."))
179 (defun nneething-request-type (group &optional article)
182 (defun nneething-close-group (group &optional server)
183 (setq nneething-current-directory nil)
187 ;;; Internal functions.
189 (defun nneething-possibly-change-directory (group &optional dir)
191 (if (and nneething-group
192 (string= group nneething-group))
195 (if (setq entry (assoc group nneething-group-alist))
197 (setq nneething-group group)
198 (setq nneething-directory (nth 1 entry))
199 (setq nneething-map (nth 2 entry))
200 (setq nneething-active (nth 3 entry)))
201 (setq nneething-group group)
202 (setq nneething-directory dir)
203 (setq nneething-map nil)
204 (setq nneething-active (cons 1 0))
205 (nneething-create-mapping)
206 (push (list group dir nneething-map nneething-active)
207 nneething-group-alist))))))
209 (defun nneething-map-file ()
210 ;; We make sure that the .nneething directory exists.
211 (unless (file-exists-p nneething-map-file-directory)
212 (make-directory nneething-map-file-directory 'parents))
213 ;; We store it in a special directory under the user's home dir.
214 (concat (file-name-as-directory nneething-map-file-directory)
215 nneething-group nneething-map-file))
217 (defun nneething-create-mapping ()
218 ;; Read nneething-active and nneething-map.
219 (let ((map-file (nneething-map-file))
220 (files (directory-files nneething-directory))
222 (if (file-exists-p map-file)
224 (load map-file nil t t)
226 (or nneething-active (setq nneething-active (cons 1 0)))
227 ;; Old nneething had a different map format.
228 (when (and (cdar nneething-map)
229 (atom (cdar nneething-map)))
232 (list (cdr n) (car n)
233 (nth 5 (file-attributes
234 (nneething-file-name (car n))))))
236 ;; Remove files matching the exclusion regexp.
237 (when nneething-exclude-files
241 (if (string-match nneething-exclude-files (car f))
242 (if prev (setcdr prev (cdr f))
243 (setq files (cdr files)))
246 ;; Remove deleted files from the map.
247 (let ((map nneething-map)
250 (if (and (member (cadar map) files)
251 ;; We also remove files that have changed mod times.
252 (equal (nth 5 (file-attributes
253 (nneething-file-name (cadar map))))
256 (push (cadar map) map-files)
260 (setcdr prev (cdr map))
261 (setq nneething-map (cdr nneething-map))))
262 (setq map (cdr map))))
263 ;; Find all new files and enter them into the map.
265 (unless (member (car files) map-files)
266 ;; This file is not in the map, so we enter it.
268 (setcdr nneething-active (1+ (cdr nneething-active)))
269 (push (list (cdr nneething-active) (car files)
270 (nth 5 (file-attributes
271 (nneething-file-name (car files)))))
273 (setq files (cdr files)))
275 (not nneething-read-only))
277 (nnheader-set-temp-buffer " *nneething map*")
278 (insert "(setq nneething-map '" (prin1-to-string nneething-map) ")\n"
279 "(setq nneething-active '" (prin1-to-string nneething-active)
281 (write-region (point-min) (point-max) map-file nil 'nomesg)
282 (kill-buffer (current-buffer))))))
284 (defun nneething-insert-head (file)
285 "Insert the head of FILE."
286 (when (nneething-get-head file)
287 (insert-buffer-substring nneething-work-buffer)))
289 (defun nneething-make-head (file)
290 "Create a head by looking at the file attributes of FILE."
291 (let ((atts (file-attributes file)))
293 "Subject: " (file-name-nondirectory file) "\n"
294 "Message-ID: <nneething-"
295 (int-to-string (incf nneething-message-id-number))
296 "@" (system-name) ">\n"
297 "Date: " (current-time-string (nth 5 atts)) "\n"
298 (nneething-from-line (nth 2 atts))
299 "Chars: " (int-to-string (nth 7 atts)) "\n")))
301 (defun nneething-from-line (uid)
302 "Return a From header based of UID."
303 (let ((login (condition-case nil
304 (user-login-name uid)
306 (cond ((= uid (user-uid)) (user-login-name))
308 (t (int-to-string uid))))))
309 (name (condition-case nil
312 (cond ((= uid (user-uid)) (user-full-name))
313 ((zerop uid) "Ms. Root"))))))
314 (concat "From: " login "@" (system-name)
315 (if name (concat " (" name ")") "") "\n")))
317 (defun nneething-get-head (file)
318 "Either find the head in FILE or make a head for FILE."
320 (set-buffer (get-buffer-create nneething-work-buffer))
321 (setq case-fold-search nil)
322 (buffer-disable-undo (current-buffer))
325 ((not (file-exists-p file))
326 ;; The file do not exist.
328 ((or (file-directory-p file)
329 (file-symlink-p file))
330 ;; It's a dir, so we fudge a head.
331 (nneething-make-head file) t)
333 ;; We examine the file.
334 (nnheader-insert-head file)
335 (if (nnheader-article-p)
338 (goto-char (point-min))
339 (or (and (search-forward "\n\n" nil t)
344 (nneething-make-head file))
347 (defun nneething-file-name (article)
348 "Return the file name of ARTICLE."
349 (concat (file-name-as-directory nneething-directory)
350 (if (numberp article)
351 (cadr (assq article nneething-map))
356 ;;; nneething.el ends here