1 ;;; nneething.el --- arbitrary file access for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
29 (eval-when-compile (require 'cl
))
37 (nnoo-declare nneething
)
39 (defvoo nneething-map-file-directory
40 (nnheader-concat gnus-directory
".nneething/")
41 "Where nneething stores the map files.")
43 (defvoo nneething-map-file
".nneething"
44 "Name of the map files.")
46 (defvoo nneething-exclude-files nil
47 "Regexp saying what files to exclude from the group.
48 If this variable is nil, no files will be excluded.")
50 (defvoo nneething-include-files nil
51 "Regexp saying what files to include in the group.
52 If this variable is non-nil, only files matching this regexp will be
57 ;;; Internal variables.
59 (defconst nneething-version
"nneething 1.0"
62 (defvoo nneething-current-directory nil
63 "Current news group directory.")
65 (defvoo nneething-status-string
"")
67 (defvoo nneething-work-buffer
" *nneething work*")
69 (defvoo nneething-group nil
)
70 (defvoo nneething-map nil
)
71 (defvoo nneething-read-only nil
)
72 (defvoo nneething-active nil
)
73 (defvoo nneething-address nil
)
77 ;;; Interface functions.
79 (nnoo-define-basics nneething
)
81 (deffoo nneething-retrieve-headers
(articles &optional group server fetch-old
)
82 (nneething-possibly-change-directory group
)
85 (set-buffer nntp-server-buffer
)
87 (let* ((number (length articles
))
89 (large (and (numberp nnmail-large-newsgroup
)
90 (> number nnmail-large-newsgroup
)))
93 (if (stringp (car articles
))
96 (while (setq article
(pop articles
))
97 (setq file
(nneething-file-name article
))
99 (when (and (file-exists-p file
)
100 (or (file-directory-p file
)
101 (not (zerop (nnheader-file-size file
)))))
102 (insert (format "221 %d Article retrieved.\n" article
))
103 (nneething-insert-head file
)
110 (nnheader-message 5 "nneething: Receiving headers... %d%%"
111 (/ (* count
100) number
))))
114 (nnheader-message 5 "nneething: Receiving headers...done"))
116 (nnheader-fold-continuation-lines)
119 (deffoo nneething-request-article
(id &optional group server buffer
)
120 (nneething-possibly-change-directory group
)
121 (let ((file (unless (stringp id
)
122 (nneething-file-name id
)))
123 (nntp-server-buffer (or buffer nntp-server-buffer
)))
124 (and (stringp file
) ; We did not request by Message-ID.
125 (file-exists-p file
) ; The file exists.
126 (not (file-directory-p file
)) ; It's not a dir.
128 (let ((nnmail-file-coding-system 'binary
))
129 (nnmail-find-file file
)) ; Insert the file in the nntp buf.
130 (unless (nnheader-article-p) ; Either it's a real article...
132 (unless (file-directory-p file
)
133 (or (cdr (assoc (concat "." (file-name-extension file
))
134 mailcap-mime-extensions
))
137 (mm-detect-mime-charset-region (point-min) (point-max)))
139 (unless (string-match "\\`text/" type
)
140 (base64-encode-region (point-min) (point-max))
141 (setq encoding
"base64"))
142 (goto-char (point-min))
143 (nneething-make-head file
(current-buffer)
144 nil type charset encoding
))
148 (deffoo nneething-request-group
(group &optional server dont-check
)
149 (nneething-possibly-change-directory group server
)
151 (nneething-create-mapping)
152 (if (> (car nneething-active
) (cdr nneething-active
))
153 (nnheader-insert "211 0 1 0 %s\n" group
)
156 (- (1+ (cdr nneething-active
)) (car nneething-active
))
157 (car nneething-active
) (cdr nneething-active
)
161 (deffoo nneething-request-list
(&optional server dir
)
162 (nnheader-report 'nneething
"LIST is not implemented."))
164 (deffoo nneething-request-newgroups
(date &optional server
)
165 (nnheader-report 'nneething
"NEWSGROUPS is not implemented."))
167 (deffoo nneething-request-type
(group &optional article
)
170 (deffoo nneething-close-group
(group &optional server
)
171 (setq nneething-current-directory nil
)
174 (deffoo nneething-open-server
(server &optional defs
)
175 (nnheader-init-server-buffer)
176 (if (nneething-server-opened server
)
178 (unless (assq 'nneething-address defs
)
179 (setq defs
(append defs
(list (list 'nneething-address server
)))))
180 (nnoo-change-server 'nneething server defs
)))
183 ;;; Internal functions.
185 (defun nneething-possibly-change-directory (group &optional server
)
187 (not (nneething-server-opened server
)))
188 (nneething-open-server server
))
190 (not (equal nneething-group group
)))
191 (setq nneething-group group
)
192 (setq nneething-map nil
)
193 (setq nneething-active
(cons 1 0))
194 (nneething-create-mapping)))
196 (defun nneething-map-file ()
197 ;; We make sure that the .nneething directory exists.
198 (gnus-make-directory nneething-map-file-directory
)
199 ;; We store it in a special directory under the user's home dir.
200 (concat (file-name-as-directory nneething-map-file-directory
)
201 nneething-group nneething-map-file
))
203 (defun nneething-create-mapping ()
204 ;; Read nneething-active and nneething-map.
205 (when (file-exists-p nneething-address
)
206 (let ((map-file (nneething-map-file))
207 (files (directory-files nneething-address
))
209 (when (file-exists-p map-file
)
211 (load map-file nil t t
)))
212 (unless nneething-active
213 (setq nneething-active
(cons 1 0)))
214 ;; Old nneething had a different map format.
215 (when (and (cdar nneething-map
)
216 (atom (cdar nneething-map
)))
219 (list (cdr n
) (car n
)
220 (nth 5 (file-attributes
221 (nneething-file-name (car n
))))))
223 ;; Remove files matching the exclusion regexp.
224 (when nneething-exclude-files
228 (if (string-match nneething-exclude-files
(car f
))
229 (if prev
(setcdr prev
(cdr f
))
230 (setq files
(cdr files
)))
233 ;; Remove files not matching the inclusion regexp.
234 (when nneething-include-files
238 (if (not (string-match nneething-include-files
(car f
)))
239 (if prev
(setcdr prev
(cdr f
))
240 (setq files
(cdr files
)))
243 ;; Remove deleted files from the map.
244 (let ((map nneething-map
)
247 (if (and (member (cadr (car map
)) files
)
248 ;; We also remove files that have changed mod times.
249 (equal (nth 5 (file-attributes
250 (nneething-file-name (cadr (car map
)))))
253 (push (cadr (car map
)) map-files
)
257 (setcdr prev
(cdr map
))
258 (setq nneething-map
(cdr nneething-map
))))
259 (setq map
(cdr map
))))
260 ;; Find all new files and enter them into the map.
262 (unless (member (car files
) map-files
)
263 ;; This file is not in the map, so we enter it.
265 (setcdr nneething-active
(1+ (cdr nneething-active
)))
266 (push (list (cdr nneething-active
) (car files
)
267 (nth 5 (file-attributes
268 (nneething-file-name (car files
)))))
270 (setq files
(cdr files
)))
272 (not nneething-read-only
))
273 (with-temp-file map-file
274 (insert "(setq nneething-map '")
275 (gnus-prin1 nneething-map
)
276 (insert ")\n(setq nneething-active '")
277 (gnus-prin1 nneething-active
)
280 (defun nneething-insert-head (file)
281 "Insert the head of FILE."
282 (when (nneething-get-head file
)
283 (insert-buffer-substring nneething-work-buffer
)
284 (goto-char (point-max))))
286 (defun nneething-encode-file-name (file &optional coding-system
)
287 "Encode the name of the FILE in CODING-SYSTEM."
289 (setq file
(mm-encode-coding-string
290 file
(or coding-system nnmail-pathname-coding-system
)))
291 (while (string-match "[^-0-9a-zA-Z_:/.]" file pos
)
292 (setq buf
(cons (format "%%%02x" (aref file
(match-beginning 0)))
293 (cons (substring file pos
(match-beginning 0)) buf
))
295 (apply (function concat
)
296 (nreverse (cons (substring file pos
) buf
)))))
298 (defun nneething-decode-file-name (file &optional coding-system
)
299 "Decode the name of the FILE is encoded in CODING-SYSTEM."
301 (while (string-match "%\\([0-9a-fA-F][0-9a-fA-F]\\)" file pos
)
302 (setq buf
(cons (string (string-to-number (match-string 1 file
) 16))
303 (cons (substring file pos
(match-beginning 0)) buf
))
305 (mm-decode-coding-string
306 (apply (function concat
)
307 (nreverse (cons (substring file pos
) buf
)))
308 (or coding-system nnmail-pathname-coding-system
))))
310 (defun nneething-get-file-name (id)
311 "Extract the file name from the message ID string."
312 (when (string-match "\\`<nneething-\\([^@]+\\)@.*>\\'" id
)
313 (nneething-decode-file-name (match-string 1 id
))))
315 (defun nneething-make-head (file &optional buffer extra-msg
316 mime-type mime-charset mime-encoding
)
317 "Create a head by looking at the file attributes of FILE."
318 (let ((atts (file-attributes file
)))
320 "Subject: " (file-name-nondirectory file
) (or extra-msg
"") "\n"
321 "Message-ID: <nneething-" (nneething-encode-file-name file
)
322 "@" (system-name) ">\n"
323 (if (equal '(0 0) (nth 5 atts
)) ""
324 (concat "Date: " (current-time-string (nth 5 atts
)) "\n"))
328 (when (re-search-forward "<[a-zA-Z0-9_]@[-a-zA-Z0-9_]>" 1000 t
)
329 (concat "From: " (match-string 0) "\n"))))
330 (nneething-from-line (nth 2 atts
) file
))
331 (if (> (string-to-number (int-to-string (nth 7 atts
))) 0)
332 (concat "Chars: " (int-to-string (nth 7 atts
)) "\n")
337 (concat "Lines: " (int-to-string
338 (count-lines (point-min) (point-max)))
342 (concat "Content-Type: " mime-type
345 (if (stringp mime-charset
)
347 (symbol-name mime-charset
)))
350 (concat "\nContent-Transfer-Encoding: " mime-encoding
)
352 "\nMIME-Version: 1.0\n")
355 (defun nneething-from-line (uid &optional file
)
356 "Return a From header based of UID."
357 (let* ((login (condition-case nil
358 (user-login-name uid
)
360 (cond ((= uid
(user-uid)) (user-login-name))
362 (t (int-to-string uid
))))))
363 (name (condition-case nil
366 (cond ((= uid
(user-uid)) (user-full-name))
367 ((zerop uid
) "Ms. Root")))))
368 (host (if (string-match "\\`/[^/@]*@\\([^:/]+\\):" file
)
374 "/\\(users\\|home\\)/\\([^/]+\\)/" file
)
375 (setq login
(substring file
380 (concat "From: " login
"@" host
381 (if name
(concat " (" name
")") "") "\n")))
383 (defun nneething-get-head (file)
384 "Either find the head in FILE or make a head for FILE."
386 (set-buffer (get-buffer-create nneething-work-buffer
))
387 (setq case-fold-search nil
)
388 (buffer-disable-undo)
391 ((not (file-exists-p file
))
392 ;; The file do not exist.
394 ((or (file-directory-p file
)
395 (file-symlink-p file
))
396 ;; It's a dir, so we fudge a head.
397 (nneething-make-head file
) t
)
399 ;; We examine the file.
402 (nnheader-insert-head file
)
403 (if (nnheader-article-p)
406 (goto-char (point-min))
407 (or (and (search-forward "\n\n" nil t
)
411 (goto-char (point-min))
412 (nneething-make-head file
(current-buffer))
413 (delete-region (point) (point-max))))
415 (nneething-make-head file
(current-buffer) " (unreadable)")))
418 (defun nneething-file-name (article)
419 "Return the file name of ARTICLE."
420 (let ((dir (file-name-as-directory nneething-address
))
422 (if (numberp article
)
423 (if (setq fname
(cadr (assq article nneething-map
)))
424 (expand-file-name fname dir
)
425 (make-temp-name (expand-file-name "nneething" dir
)))
426 (expand-file-name article dir
))))
430 ;; arch-tag: 1277f386-88f2-4459-bb24-f3f45962a6c5
431 ;;; nneething.el ends here