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

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