1 ;;; nneething.el --- arbitrary file access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
31 (eval-when-compile (require 'cl
))
38 (nnoo-declare nneething
)
40 (defvoo nneething-map-file-directory
41 (nnheader-concat gnus-directory
".nneething/")
42 "Where nneething stores the map files.")
44 (defvoo nneething-map-file
".nneething"
45 "Name of the map files.")
47 (defvoo nneething-exclude-files nil
48 "Regexp saying what files to exclude from the group.
49 If this variable is nil, no files will be excluded.")
51 (defvoo nneething-include-files nil
52 "Regexp saying what files to include in the group.
53 If this variable is non-nil, only files matching this regexp will be
58 ;;; Internal variables.
60 (defconst nneething-version
"nneething 1.0"
63 (defvoo nneething-current-directory nil
64 "Current news group directory.")
66 (defvoo nneething-status-string
"")
68 (defvoo nneething-work-buffer
" *nneething work*")
70 (defvoo nneething-group nil
)
71 (defvoo nneething-map nil
)
72 (defvoo nneething-read-only nil
)
73 (defvoo nneething-active nil
)
74 (defvoo nneething-address nil
)
78 ;;; Interface functions.
80 (nnoo-define-basics nneething
)
82 (deffoo nneething-retrieve-headers
(articles &optional group server fetch-old
)
83 (nneething-possibly-change-directory group
)
86 (set-buffer nntp-server-buffer
)
88 (let* ((number (length articles
))
90 (large (and (numberp nnmail-large-newsgroup
)
91 (> number nnmail-large-newsgroup
)))
94 (if (stringp (car articles
))
97 (while (setq article
(pop articles
))
98 (setq file
(nneething-file-name article
))
100 (when (and (file-exists-p file
)
101 (or (file-directory-p file
)
102 (not (zerop (nnheader-file-size file
)))))
103 (insert (format "221 %d Article retrieved.\n" article
))
104 (nneething-insert-head file
)
111 (nnheader-message 5 "nneething: Receiving headers... %d%%"
112 (/ (* count
100) number
))))
115 (nnheader-message 5 "nneething: Receiving headers...done"))
117 (nnheader-fold-continuation-lines)
120 (deffoo nneething-request-article
(id &optional group server buffer
)
121 (nneething-possibly-change-directory group
)
122 (let ((file (unless (stringp id
)
123 (nneething-file-name id
)))
124 (nntp-server-buffer (or buffer nntp-server-buffer
)))
125 (and (stringp file
) ; We did not request by Message-ID.
126 (file-exists-p file
) ; The file exists.
127 (not (file-directory-p file
)) ; It's not a dir.
129 (let ((nnmail-file-coding-system 'binary
))
130 (nnmail-find-file file
)) ; Insert the file in the nntp buf.
131 (unless (nnheader-article-p) ; Either it's a real article...
133 (unless (file-directory-p file
)
134 (or (cdr (assoc (concat "." (file-name-extension file
))
135 mailcap-mime-extensions
))
138 (mm-detect-mime-charset-region (point-min) (point-max)))
140 (unless (string-match "\\`text/" type
)
141 (base64-encode-region (point-min) (point-max))
142 (setq encoding
"base64"))
143 (goto-char (point-min))
144 (nneething-make-head file
(current-buffer)
145 nil type charset encoding
))
149 (deffoo nneething-request-group
(group &optional server dont-check
)
150 (nneething-possibly-change-directory group server
)
152 (nneething-create-mapping)
153 (if (> (car nneething-active
) (cdr nneething-active
))
154 (nnheader-insert "211 0 1 0 %s\n" group
)
157 (- (1+ (cdr nneething-active
)) (car nneething-active
))
158 (car nneething-active
) (cdr nneething-active
)
162 (deffoo nneething-request-list
(&optional server dir
)
163 (nnheader-report 'nneething
"LIST is not implemented."))
165 (deffoo nneething-request-newgroups
(date &optional server
)
166 (nnheader-report 'nneething
"NEWSGROUPS is not implemented."))
168 (deffoo nneething-request-type
(group &optional article
)
171 (deffoo nneething-close-group
(group &optional server
)
172 (setq nneething-current-directory nil
)
175 (deffoo nneething-open-server
(server &optional defs
)
176 (nnheader-init-server-buffer)
177 (if (nneething-server-opened server
)
179 (unless (assq 'nneething-address defs
)
180 (setq defs
(append defs
(list (list 'nneething-address server
)))))
181 (nnoo-change-server 'nneething server defs
)))
184 ;;; Internal functions.
186 (defun nneething-possibly-change-directory (group &optional server
)
188 (not (nneething-server-opened server
)))
189 (nneething-open-server server
))
191 (not (equal nneething-group group
)))
192 (setq nneething-group group
)
193 (setq nneething-map nil
)
194 (setq nneething-active
(cons 1 0))
195 (nneething-create-mapping)))
197 (defun nneething-map-file ()
198 ;; We make sure that the .nneething directory exists.
199 (gnus-make-directory nneething-map-file-directory
)
200 ;; We store it in a special directory under the user's home dir.
201 (concat (file-name-as-directory nneething-map-file-directory
)
202 nneething-group nneething-map-file
))
204 (defun nneething-create-mapping ()
205 ;; Read nneething-active and nneething-map.
206 (when (file-exists-p nneething-address
)
207 (let ((map-file (nneething-map-file))
208 (files (directory-files nneething-address
))
210 (when (file-exists-p map-file
)
212 (load map-file nil t t
)))
213 (unless nneething-active
214 (setq nneething-active
(cons 1 0)))
215 ;; Old nneething had a different map format.
216 (when (and (cdar nneething-map
)
217 (atom (cdar nneething-map
)))
220 (list (cdr n
) (car n
)
221 (nth 5 (file-attributes
222 (nneething-file-name (car n
))))))
224 ;; Remove files matching the exclusion regexp.
225 (when nneething-exclude-files
229 (if (string-match nneething-exclude-files
(car f
))
230 (if prev
(setcdr prev
(cdr f
))
231 (setq files
(cdr files
)))
234 ;; Remove files not matching the inclusion regexp.
235 (when nneething-include-files
239 (if (not (string-match nneething-include-files
(car f
)))
240 (if prev
(setcdr prev
(cdr f
))
241 (setq files
(cdr files
)))
244 ;; Remove deleted files from the map.
245 (let ((map nneething-map
)
248 (if (and (member (cadr (car map
)) files
)
249 ;; We also remove files that have changed mod times.
250 (equal (nth 5 (file-attributes
251 (nneething-file-name (cadr (car map
)))))
254 (push (cadr (car map
)) map-files
)
258 (setcdr prev
(cdr map
))
259 (setq nneething-map
(cdr nneething-map
))))
260 (setq map
(cdr map
))))
261 ;; Find all new files and enter them into the map.
263 (unless (member (car files
) map-files
)
264 ;; This file is not in the map, so we enter it.
266 (setcdr nneething-active
(1+ (cdr nneething-active
)))
267 (push (list (cdr nneething-active
) (car files
)
268 (nth 5 (file-attributes
269 (nneething-file-name (car files
)))))
271 (setq files
(cdr files
)))
273 (not nneething-read-only
))
274 (with-temp-file map-file
275 (insert "(setq nneething-map '")
276 (gnus-prin1 nneething-map
)
277 (insert ")\n(setq nneething-active '")
278 (gnus-prin1 nneething-active
)
281 (defun nneething-insert-head (file)
282 "Insert the head of FILE."
283 (when (nneething-get-head file
)
284 (insert-buffer-substring nneething-work-buffer
)
285 (goto-char (point-max))))
287 (defun nneething-encode-file-name (file &optional coding-system
)
288 "Encode the name of the FILE in CODING-SYSTEM."
290 (setq file
(mm-encode-coding-string
291 file
(or coding-system nnmail-pathname-coding-system
)))
292 (while (string-match "[^-0-9a-zA-Z_:/.]" file pos
)
293 (setq buf
(cons (format "%%%02x" (aref file
(match-beginning 0)))
294 (cons (substring file pos
(match-beginning 0)) buf
))
296 (apply (function concat
)
297 (nreverse (cons (substring file pos
) buf
)))))
299 (defun nneething-decode-file-name (file &optional coding-system
)
300 "Decode the name of the FILE is encoded in CODING-SYSTEM."
302 (while (string-match "%\\([0-9a-fA-F][0-9a-fA-F]\\)" file pos
)
303 (setq buf
(cons (string (string-to-number (match-string 1 file
) 16))
304 (cons (substring file pos
(match-beginning 0)) buf
))
306 (decode-coding-string
307 (apply (function concat
)
308 (nreverse (cons (substring file pos
) buf
)))
309 (or coding-system nnmail-pathname-coding-system
))))
311 (defun nneething-get-file-name (id)
312 "Extract the file name from the message ID string."
313 (when (string-match "\\`<nneething-\\([^@]+\\)@.*>\\'" id
)
314 (nneething-decode-file-name (match-string 1 id
))))
316 (defun nneething-make-head (file &optional buffer extra-msg
317 mime-type mime-charset mime-encoding
)
318 "Create a head by looking at the file attributes of FILE."
319 (let ((atts (file-attributes file
)))
321 "Subject: " (file-name-nondirectory file
) (or extra-msg
"") "\n"
322 "Message-ID: <nneething-" (nneething-encode-file-name file
)
323 "@" (system-name) ">\n"
324 (if (equal '(0 0) (nth 5 atts
)) ""
325 (concat "Date: " (current-time-string (nth 5 atts
)) "\n"))
329 (when (re-search-forward "<[a-zA-Z0-9_]@[-a-zA-Z0-9_]>" 1000 t
)
330 (concat "From: " (match-string 0) "\n"))))
331 (nneething-from-line (nth 2 atts
) file
))
332 (if (> (string-to-number (int-to-string (nth 7 atts
))) 0)
333 (concat "Chars: " (int-to-string (nth 7 atts
)) "\n")
338 (concat "Lines: " (int-to-string
339 (count-lines (point-min) (point-max)))
343 (concat "Content-Type: " mime-type
346 (if (stringp mime-charset
)
348 (symbol-name mime-charset
)))
351 (concat "\nContent-Transfer-Encoding: " mime-encoding
)
353 "\nMIME-Version: 1.0\n")
356 (defun nneething-from-line (uid &optional file
)
357 "Return a From header based of UID."
358 (let* ((login (condition-case nil
359 (user-login-name uid
)
361 (cond ((= uid
(user-uid)) (user-login-name))
363 (t (int-to-string uid
))))))
364 (name (condition-case nil
367 (cond ((= uid
(user-uid)) (user-full-name))
368 ((zerop uid
) "Ms. Root")))))
369 (host (if (string-match "\\`/[^/@]*@\\([^:/]+\\):" file
)
375 "/\\(users\\|home\\)/\\([^/]+\\)/" file
)
376 (setq login
(substring file
381 (concat "From: " login
"@" host
382 (if name
(concat " (" name
")") "") "\n")))
384 (defun nneething-get-head (file)
385 "Either find the head in FILE or make a head for FILE."
387 (set-buffer (get-buffer-create nneething-work-buffer
))
388 (setq case-fold-search nil
)
389 (buffer-disable-undo)
392 ((not (file-exists-p file
))
393 ;; The file do not exist.
395 ((or (file-directory-p file
)
396 (file-symlink-p file
))
397 ;; It's a dir, so we fudge a head.
398 (nneething-make-head file
) t
)
400 ;; We examine the file.
403 (nnheader-insert-head file
)
404 (if (nnheader-article-p)
407 (goto-char (point-min))
408 (or (and (search-forward "\n\n" nil t
)
412 (goto-char (point-min))
413 (nneething-make-head file
(current-buffer))
414 (delete-region (point) (point-max))))
416 (nneething-make-head file
(current-buffer) " (unreadable)")))
419 (defun nneething-file-name (article)
420 "Return the file name of ARTICLE."
421 (let ((dir (file-name-as-directory nneething-address
))
423 (if (numberp article
)
424 (if (setq fname
(cadr (assq article nneething-map
)))
425 (expand-file-name fname dir
)
426 (mm-make-temp-file (expand-file-name "nneething" dir
)))
427 (expand-file-name article dir
))))
431 ;;; arch-tag: 1277f386-88f2-4459-bb24-f3f45962a6c5
432 ;;; nneething.el ends here