cgit.sxemacs.org Git - gnus/blob - lisp/nneething.el

   1 ;;; nneething.el --- random file access for Gnus
   2 ;; Copyright (C) 1995,96,97 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   5 ;;      Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;; Keywords: news, mail
   7
   8 ;; This file is part of GNU Emacs.
   9
  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)
  13 ;; any later version.
  14
  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.
  19
  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.
  24
  25 ;;; Commentary:
  26
  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
  29 ;; Gnus sources.
  30
  31 ;;; Code:
  32
  33 (require 'nnheader)
  34 (require 'nnmail)
  35 (require 'nnoo)
  36 (require 'gnus-util)
  37 (require 'cl)
  38
  39 (nnoo-declare nneething)
  40
  41 (defvoo nneething-map-file-directory "~/.nneething/"
  42   "*Where nneething stores the map files.")
  43
  44 (defvoo nneething-map-file ".nneething"
  45   "*Name of the map files.")
  46
  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.")
  50
  51 \f
  52
  53 ;;; Internal variables.
  54
  55 (defconst nneething-version "nneething 1.0"
  56   "nneething version.")
  57
  58 (defvoo nneething-current-directory nil
  59   "Current news group directory.")
  60
  61 (defvoo nneething-status-string "")
  62 (defvoo nneething-group-alist nil)
  63
  64 (defvoo nneething-message-id-number 0)
  65 (defvoo nneething-work-buffer " *nneething work*")
  66
  67 (defvoo nneething-directory nil)
  68 (defvoo nneething-group nil)
  69 (defvoo nneething-map nil)
  70 (defvoo nneething-read-only nil)
  71 (defvoo nneething-active nil)
  72
  73 \f
  74
  75 ;;; Interface functions.
  76
  77 (nnoo-define-basics nneething)
  78
  79 (deffoo nneething-retrieve-headers (articles &optional group server fetch-old)
  80   (nneething-possibly-change-directory group)
  81
  82   (save-excursion
  83     (set-buffer nntp-server-buffer)
  84     (erase-buffer)
  85     (let* ((number (length articles))
  86            (count 0)
  87            (large (and (numberp nnmail-large-newsgroup)
  88                        (> number nnmail-large-newsgroup)))
  89            article file)
  90
  91       (if (stringp (car articles))
  92           'headers
  93
  94         (while (setq article (pop articles))
  95           (setq file (nneething-file-name article))
  96
  97           (when (and (file-exists-p file)
  98                      (or (file-directory-p file)
  99                          (not (zerop (nnheader-file-size file)))))
 100             (insert (format "221 %d Article retrieved.\n" article))
 101             (nneething-insert-head file)
 102             (insert ".\n"))
 103
 104           (incf count)
 105
 106           (and large
 107                (zerop (% count 20))
 108                (message "nneething: Receiving headers... %d%%"
 109                         (/ (* count 100) number))))
 110
 111         (when large
 112           (message "nneething: Receiving headers...done"))
 113
 114         (nnheader-fold-continuation-lines)
 115         'headers))))
 116
 117 (deffoo nneething-request-article (id &optional group server buffer)
 118   (nneething-possibly-change-directory group)
 119   (let ((file (unless (stringp id)
 120                 (nneething-file-name id)))
 121         (nntp-server-buffer (or buffer nntp-server-buffer)))
 122     (and (stringp file)                 ; We did not request by Message-ID.
 123          (file-exists-p file)           ; The file exists.
 124          (not (file-directory-p file))  ; It's not a dir.
 125          (save-excursion
 126            (nnmail-find-file file)      ; Insert the file in the nntp buf.
 127            (unless (nnheader-article-p) ; Either it's a real article...
 128              (goto-char (point-min))
 129              (nneething-make-head file (current-buffer)) ; ... or we fake some headers.
 130              (insert "\n"))
 131            t))))
 132
 133 (deffoo nneething-request-group (group &optional dir dont-check)
 134   (nneething-possibly-change-directory group dir)
 135   (unless dont-check
 136     (nneething-create-mapping)
 137     (if (> (car nneething-active) (cdr nneething-active))
 138         (nnheader-insert "211 0 1 0 %s\n" group)
 139       (nnheader-insert
 140        "211 %d %d %d %s\n"
 141        (- (1+ (cdr nneething-active)) (car nneething-active))
 142        (car nneething-active) (cdr nneething-active)
 143        group)))
 144   t)
 145
 146 (deffoo nneething-request-list (&optional server dir)
 147   (nnheader-report 'nneething "LIST is not implemented."))
 148
 149 (deffoo nneething-request-newgroups (date &optional server)
 150   (nnheader-report 'nneething "NEWSGROUPS is not implemented."))
 151
 152 (deffoo nneething-request-type (group &optional article)
 153   'unknown)
 154
 155 (deffoo nneething-close-group (group &optional server)
 156   (setq nneething-current-directory nil)
 157   t)
 158
 159 \f
 160 ;;; Internal functions.
 161
 162 (defun nneething-possibly-change-directory (group &optional dir)
 163   (when group
 164     (if (and nneething-group
 165              (string= group nneething-group))
 166         t
 167       (let (entry)
 168         (if (setq entry (assoc group nneething-group-alist))
 169             (progn
 170               (setq nneething-group group)
 171               (setq nneething-directory (nth 1 entry))
 172               (setq nneething-map (nth 2 entry))
 173               (setq nneething-active (nth 3 entry)))
 174           (setq nneething-group group)
 175           (setq nneething-directory dir)
 176           (setq nneething-map nil)
 177           (setq nneething-active (cons 1 0))
 178           (nneething-create-mapping)
 179           (push (list group dir nneething-map nneething-active)
 180                 nneething-group-alist))))))
 181
 182 (defun nneething-map-file ()
 183   ;; We make sure that the .nneething directory exists.
 184   (gnus-make-directory nneething-map-file-directory)
 185   ;; We store it in a special directory under the user's home dir.
 186   (concat (file-name-as-directory nneething-map-file-directory)
 187           nneething-group nneething-map-file))
 188
 189 (defun nneething-create-mapping ()
 190   ;; Read nneething-active and nneething-map.
 191   (let ((map-file (nneething-map-file))
 192         (files (directory-files nneething-directory))
 193         touched map-files)
 194     (when (file-exists-p map-file)
 195       (ignore-errors
 196         (load map-file nil t t)))
 197     (unless nneething-active
 198       (setq nneething-active (cons 1 0)))
 199     ;; Old nneething had a different map format.
 200     (when (and (cdar nneething-map)
 201                (atom (cdar nneething-map)))
 202       (setq nneething-map
 203             (mapcar (lambda (n)
 204                       (list (cdr n) (car n)
 205                             (nth 5 (file-attributes
 206                                     (nneething-file-name (car n))))))
 207                     nneething-map)))
 208     ;; Remove files matching the exclusion regexp.
 209     (when nneething-exclude-files
 210       (let ((f files)
 211             prev)
 212         (while f
 213           (if (string-match nneething-exclude-files (car f))
 214               (if prev (setcdr prev (cdr f))
 215                 (setq files (cdr files)))
 216             (setq prev f))
 217           (setq f (cdr f)))))
 218     ;; Remove deleted files from the map.
 219     (let ((map nneething-map)
 220           prev)
 221       (while map
 222         (if (and (member (cadar map) files)
 223                  ;; We also remove files that have changed mod times.
 224                  (equal (nth 5 (file-attributes
 225                                 (nneething-file-name (cadar map))))
 226                         (caddar map)))
 227             (progn
 228               (push (cadar map) map-files)
 229               (setq prev map))
 230           (setq touched t)
 231           (if prev
 232               (setcdr prev (cdr map))
 233             (setq nneething-map (cdr nneething-map))))
 234         (setq map (cdr map))))
 235     ;; Find all new files and enter them into the map.
 236     (while files
 237       (unless (member (car files) map-files)
 238         ;; This file is not in the map, so we enter it.
 239         (setq touched t)
 240         (setcdr nneething-active (1+ (cdr nneething-active)))
 241         (push (list (cdr nneething-active) (car files)
 242                     (nth 5 (file-attributes
 243                             (nneething-file-name (car files)))))
 244               nneething-map))
 245       (setq files (cdr files)))
 246     (when (and touched
 247                (not nneething-read-only))
 248       (nnheader-temp-write map-file
 249         (insert "(setq nneething-map '")
 250         (gnus-prin1 nneething-map)
 251         (insert ")\n(setq nneething-active '")
 252         (gnus-prin1 nneething-active)
 253         (insert ")\n")))))
 254
 255 (defun nneething-insert-head (file)
 256   "Insert the head of FILE."
 257   (when (nneething-get-head file)
 258     (insert-buffer-substring nneething-work-buffer)
 259     (goto-char (point-max))))
 260
 261 (defun nneething-make-head (file &optional buffer)
 262   "Create a head by looking at the file attributes of FILE."
 263   (let ((atts (file-attributes file)))
 264     (insert
 265      "Subject: " (file-name-nondirectory file) "\n"
 266      "Message-ID: <nneething-"
 267      (int-to-string (incf nneething-message-id-number))
 268      "@" (system-name) ">\n"
 269      (if (equal '(0 0) (nth 5 atts)) ""
 270        (concat "Date: " (current-time-string (nth 5 atts)) "\n"))
 271      (or (when buffer
 272            (save-excursion
 273              (set-buffer buffer)
 274              (when (re-search-forward "<[a-zA-Z0-9_]@[-a-zA-Z0-9_]>" 1000 t)
 275                (concat "From: " (match-string 0) "\n"))))
 276          (nneething-from-line (nth 2 atts) file))
 277      (if (> (string-to-int (int-to-string (nth 7 atts))) 0)
 278          (concat "Chars: " (int-to-string (nth 7 atts)) "\n")
 279        "")
 280      (if buffer
 281          (save-excursion
 282            (set-buffer buffer)
 283            (concat "Lines: " (int-to-string
 284                               (count-lines (point-min) (point-max)))
 285                    "\n"))
 286        "")
 287      )))
 288
 289 (defun nneething-from-line (uid &optional file)
 290   "Return a From header based of UID."
 291   (let* ((login (condition-case nil
 292                     (user-login-name uid)
 293                   (error
 294                    (cond ((= uid (user-uid)) (user-login-name))
 295                          ((zerop uid) "root")
 296                          (t (int-to-string uid))))))
 297          (name (condition-case nil
 298                    (user-full-name uid)
 299                  (error
 300                   (cond ((= uid (user-uid)) (user-full-name))
 301                         ((zerop uid) "Ms. Root")))))
 302          (host (if  (string-match "\\`/[^/@]*@\\([^:/]+\\):" file)
 303                    (prog1
 304                        (substring file
 305                                   (match-beginning 1)
 306                                   (match-end 1))
 307                      (when (string-match "/\\(users\\|home\\)/\\([^/]+\\)/" file)
 308                        (setq login (substring file
 309                                               (match-beginning 2)
 310                                               (match-end 2))
 311                              name nil)))
 312                  (system-name))))
 313     (concat "From: " login "@" host
 314             (if name (concat " (" name ")") "") "\n")))
 315
 316 (defun nneething-get-head (file)
 317   "Either find the head in FILE or make a head for FILE."
 318   (save-excursion
 319     (set-buffer (get-buffer-create nneething-work-buffer))
 320     (setq case-fold-search nil)
 321     (buffer-disable-undo (current-buffer))
 322     (erase-buffer)
 323     (cond
 324      ((not (file-exists-p file))
 325       ;; The file do not exist.
 326       nil)
 327      ((or (file-directory-p file)
 328           (file-symlink-p file))
 329       ;; It's a dir, so we fudge a head.
 330       (nneething-make-head file) t)
 331      (t
 332       ;; We examine the file.
 333       (nnheader-insert-head file)
 334       (if (nnheader-article-p)
 335           (delete-region
 336            (progn
 337              (goto-char (point-min))
 338              (or (and (search-forward "\n\n" nil t)
 339                       (1- (point)))
 340                  (point-max)))
 341            (point-max))
 342         (goto-char (point-min))
 343         (nneething-make-head file (current-buffer))
 344         (delete-region (point) (point-max)))
 345       t))))
 346
 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))
 352             article)))
 353
 354 (provide 'nneething)
 355
 356 ;;; nneething.el ends here