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

   1 ;;;; nnkiboze.el --- select virtual news access for (ding) Gnus
   2 ;; Copyright (C) 1995 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Ingebrigtsen <larsi@ifi.uio.no>
   5 ;; Keywords: news
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22
  23 ;;; Commentary:
  24
  25 ;; The other access methods (nntp, nnspool, etc) are general news
  26 ;; access methods. This module relies on Gnus and can not be used
  27 ;; separately.
  28
  29 ;;; Code:
  30
  31 (require 'nntp)
  32 (require 'nnheader)
  33 (require 'gnus)
  34
  35 (defvar nnkiboze-directory
  36   (expand-file-name (or gnus-article-save-directory "~/News/"))
  37   "nnkiboze will put its files in this directory.")
  38
  39 \f
  40
  41 (defconst nnkiboze-version "nnkiboze 0.0"
  42   "Version numbers of this version of nnkiboze.")
  43
  44 (defvar nnkiboze-current-group nil)
  45 (defvar nnkiboze-current-score-group "")
  46 (defvar nnkiboze-status-string "")
  47
  48 \f
  49
  50 ;;; Interface functions.
  51
  52 (defun nnkiboze-retrieve-headers (articles &optional group server)
  53   (nnkiboze-possibly-change-newsgroups group)
  54   (if (or gnus-nov-is-evil)
  55       nil
  56     (let ((first (car articles))
  57           (last (progn (while (cdr articles) (setq articles (cdr articles)))
  58                        (car articles)))
  59           (nov (nnkiboze-nov-file-name)))
  60       (if (file-exists-p nov)
  61           (save-excursion
  62             (set-buffer nntp-server-buffer)
  63             (erase-buffer)
  64             (insert-file-contents nov)
  65             (goto-char 1)
  66             (while (and (not (eobp)) (< first (read (current-buffer))))
  67               (forward-line 1))
  68             (beginning-of-line)
  69             (if (not (eobp)) (delete-region 1 (point)))
  70             (while (and (not (eobp)) (>= last (read (current-buffer))))
  71               (forward-line 1))
  72             (beginning-of-line)
  73             (if (not (eobp)) (delete-region (point) (point-max)))
  74             'nov)))))
  75
  76 (defun nnkiboze-open-server (newsgroups &optional something)
  77   "Open a virtual newsgroup that contains NEWSGROUPS."
  78   (gnus-make-directory nnkiboze-directory)
  79   (nnheader-init-server-buffer))
  80
  81 (defun nnkiboze-close-server (&rest dum)
  82   "Close news server."
  83   t)
  84
  85 (fset 'nnkiboze-request-quit (symbol-function 'nnkiboze-close-server))
  86
  87 (defun nnkiboze-server-opened (&optional server)
  88   "Return server process status, T or NIL.
  89 If the stream is opened, return T, otherwise return NIL."
  90   (and nntp-server-buffer
  91        (get-buffer nntp-server-buffer)))
  92
  93 (defun nnkiboze-status-message ()
  94   "Return server status response as string."
  95   nnkiboze-status-string)
  96
  97 (defun nnkiboze-request-article (article &optional newsgroup server buffer)
  98   "Select article by message number."
  99   (nnkiboze-possibly-change-newsgroups newsgroup)
 100   (if (not (numberp article))
 101       ;; This is a real cludge. It might not work at times, but it
 102       ;; does no harm I think. The only alternative is to offer no
 103       ;; article fetching by message-id at all.
 104       (nntp-request-article article newsgroup gnus-nntp-server buffer)
 105     (let* ((header (gnus-get-header-by-number article))
 106            (xref (header-xref header))
 107            igroup iarticle)
 108       (or xref (error "nnkiboze: No xref"))
 109       (or (string-match " \\([^ ]+\\):\\([0-9]+\\)" xref)
 110           (error "nnkiboze: Malformed xref"))
 111       (setq igroup (substring xref (match-beginning 1) (match-end 1)))
 112       (setq iarticle (string-to-int
 113                       (substring xref (match-beginning 2) (match-end 2))))
 114       (and (gnus-request-group igroup t)
 115            (gnus-request-article iarticle igroup buffer)))))
 116
 117 (defun nnkiboze-request-group (group &optional server dont-check)
 118   "Make GROUP the current newsgroup."
 119   (nnkiboze-possibly-change-newsgroups group)
 120   (if dont-check
 121       ()
 122     (let (beg end total)
 123       (save-excursion
 124         (set-buffer nntp-server-buffer)
 125         (erase-buffer)
 126         (insert-file-contents (nnkiboze-nov-file-name))
 127         (if (zerop (buffer-size))
 128             (insert (format "211 0 0 0 %s\n" group))
 129           (goto-char (point-min))
 130           (and (looking-at "[0-9]+") (setq beg (read (current-buffer))))
 131           (goto-char (point-max))
 132           (and (re-search-backward "^[0-9]" nil t)
 133                (setq end (read (current-buffer))))
 134           (setq total (count-lines (point-min) (point-max)))
 135           (erase-buffer)
 136           (insert (format "211 %d %d %d %s\n" total beg end group))))))
 137   t)
 138
 139 (defun nnkiboze-close-group (group &optional server)
 140   (nnkiboze-possibly-change-newsgroups group)
 141   ;; Remove NOV lines of articles that are marked as read.
 142   (save-excursion
 143     (let ((unreads gnus-newsgroup-unreads)
 144           (unselected gnus-newsgroup-unselected))
 145       (set-buffer (get-buffer-create "*nnkiboze work*"))
 146       (buffer-disable-undo (current-buffer))
 147       (erase-buffer)
 148       (let ((cur (current-buffer))
 149             article)
 150         (insert-file-contents (nnkiboze-nov-file-name))
 151         (goto-char (point-min))
 152         (while (looking-at "[0-9]+")
 153           (if (or (memq (setq article (read cur)) unreads)
 154                   (memq article unselected))
 155               (forward-line 1)
 156             (delete-region (progn (beginning-of-line) (point))
 157                            (progn (forward-line 1) (point)))))
 158         (write-file (nnkiboze-nov-file-name))
 159         (kill-buffer (current-buffer)))))
 160   (setq nnkiboze-current-group nil))
 161
 162 (defun nnkiboze-request-list (&optional server)
 163   (setq nnkiboze-status-string "nnkiboze: LIST is not implemented.")
 164   nil)
 165
 166 (defun nnkiboze-request-newgroups (date &optional server)
 167   "List new groups."
 168   (setq nnkiboze-status-string "NEWGROUPS is not supported.")
 169   nil)
 170
 171 (defun nnkiboze-request-list-newsgroups (&optional server)
 172   (setq nnkiboze-status-string "nnkiboze: LIST NEWSGROUPS is not implemented.")
 173   nil)
 174
 175 (fset 'nnkiboze-request-post 'nntp-request-post)
 176
 177 (fset 'nnkiboze-request-post-buffer 'nntp-request-post-buffer)
 178
 179 \f
 180 ;;; Internal functions.
 181
 182 (defun nnkiboze-possibly-change-newsgroups (group)
 183   (setq nnkiboze-current-group group))
 184
 185 (defun nnkiboze-prefixed-name (group)
 186   (gnus-group-prefixed-name group '(nnkiboze "")))
 187
 188 ;;;###autoload
 189 (defun nnkiboze-generate-groups ()
 190   "Usage: emacs -batch -l nnkiboze -f nnkiboze-generate-groups
 191 Finds out what articles are to be part of the nnkiboze groups."
 192   (interactive)
 193   (let ((nnmail-spool-file nil)
 194         (gnus-use-dribble-file nil)
 195         (gnus-read-active-file t)
 196         (gnus-expert-user t))
 197     (gnus))
 198   (let* ((gnus-newsrc-assoc (copy-alist gnus-newsrc-assoc))
 199          (newsrc gnus-newsrc-assoc))
 200     (while newsrc
 201       (if (string-match "nnkiboze" (car (car newsrc)))
 202           (nnkiboze-generate-group (car (car newsrc))))
 203       (setq newsrc (cdr newsrc)))))
 204
 205 (defun nnkiboze-score-file (group)
 206   (list (expand-file-name
 207          (concat gnus-kill-files-directory nnkiboze-current-score-group
 208                  "." gnus-score-file-suffix))))
 209
 210 (defun nnkiboze-generate-group (group)
 211   (let* ((info (nth 2 (gnus-gethash group gnus-newsrc-hashtb)))
 212          (newsrc-file (concat nnkiboze-directory group ".newsrc"))
 213          (nov-file (concat nnkiboze-directory group ".nov"))
 214          (regexp (nth 1 (nth 4 info)))
 215          (gnus-expert-user t)
 216          (gnus-large-newsgroup nil)
 217          (gnus-score-find-score-files-function 'nnkiboze-score-file)
 218          method nnkiboze-newsrc nov-buffer gname newsrc active
 219          ginfo lowest)
 220     (setq nnkiboze-current-score-group group)
 221     (or info (error "No such group: %s" group))
 222     (and (file-exists-p newsrc-file) (load newsrc-file))
 223     (setq nov-buffer (find-file-noselect nov-file))
 224     (mapatoms
 225      (lambda (group)
 226        (if (and (string-match regexp (setq gname (symbol-name group)))
 227                 (not (assoc gname nnkiboze-newsrc)))
 228            (setq nnkiboze-newsrc
 229                  (cons (cons gname (1- (car (symbol-value group))))
 230                        nnkiboze-newsrc))))
 231      gnus-active-hashtb)
 232     (setq newsrc nnkiboze-newsrc)
 233     (while newsrc
 234       (if (not (setq active (gnus-gethash
 235                              (car (car newsrc)) gnus-active-hashtb)))
 236           (setq nnkiboze-newsrc (delq (car newsrc) nnkiboze-newsrc))
 237         (switch-to-buffer gnus-group-buffer)
 238         (gnus-group-jump-to-group (car (car newsrc)))
 239         (if (and (setq ginfo (nth 2 (gnus-gethash (gnus-group-group-name)
 240                                                   gnus-newsrc-hashtb)))
 241                  (nth 3 ginfo))
 242             (setcar (nthcdr 3 ginfo) nil))
 243         (if (not (and (or (not ginfo)
 244                           (> (length (gnus-list-of-unread-articles
 245                                       (car ginfo))) 0))
 246                       (progn
 247                         (gnus-group-select-group nil)
 248                         (eq major-mode 'gnus-summary-mode))))
 249             ()
 250           (setq lowest (cdr (car newsrc)))
 251           (setq method (gnus-find-method-for-group gnus-newsgroup-name))
 252           (and (eq method gnus-select-method) (setq method nil))
 253           (while gnus-newsgroup-scored
 254             (if (> (car (car gnus-newsgroup-scored)) lowest)
 255                 (nnkiboze-enter-nov
 256                  nov-buffer
 257                  (gnus-get-header-by-number (car (car gnus-newsgroup-scored)))
 258                  (if method
 259                      (gnus-group-prefixed-name gnus-newsgroup-name method)
 260                    gnus-newsgroup-name)))
 261             (setq gnus-newsgroup-scored (cdr gnus-newsgroup-scored)))
 262           (gnus-summary-quit)))
 263       (setcdr (car newsrc) (car active))
 264       (setq newsrc (cdr newsrc)))
 265     (set-buffer nov-buffer)
 266     (save-buffer)
 267     (kill-buffer (current-buffer))
 268     (set-buffer (get-buffer-create "*nnkiboze work*"))
 269     (buffer-disable-undo (current-buffer))
 270     (erase-buffer)
 271     (insert "(setq nnkiboze-newsrc '" (prin1-to-string nnkiboze-newsrc)
 272             ")\n")
 273     (write-file newsrc-file)
 274     (kill-buffer (current-buffer))
 275     (switch-to-buffer gnus-group-buffer)
 276     (gnus-group-list-groups 5 nil)))
 277
 278 (defun nnkiboze-enter-nov (buffer header group)
 279   (save-excursion
 280     (set-buffer buffer)
 281     (goto-char (point-max))
 282     (let ((xref (header-xref header))
 283           (prefix (gnus-group-real-prefix group))
 284           (first t)
 285           article)
 286       (if (zerop (forward-line -1))
 287           (progn
 288             (setq article (1+ (read (current-buffer))))
 289             (forward-line 1))
 290         (setq article 1))
 291       (insert (int-to-string article) "\t"
 292               (or (header-subject header) "") "\t"
 293               (or (header-from header) "") "\t"
 294               (or (header-date header) "") "\t"
 295               (or (header-id header) "") "\t"
 296               (or (header-references header) "") "\t"
 297               (int-to-string (or (header-chars header) 0)) "\t"
 298               (int-to-string (or (header-lines header) 0)) "\t")
 299       (if (or (not xref) (equal "" xref))
 300           (insert "Xref " (system-name) " " group ":"
 301                   (int-to-string (header-number header))
 302                   "\t\n")
 303         (insert (header-xref header) "\t\n")
 304         (search-backward "\t" nil t)
 305         (search-backward "\t" nil t)
 306         (while (re-search-forward
 307                 "[^ ]+:[0-9]+"
 308                 (save-excursion (end-of-line) (point)) t)
 309           (if first
 310               ;; The first xref has to be the group this article
 311               ;; really came for - this is the article nnkiboze
 312               ;; will to request when it is asked for the article.
 313               (save-excursion
 314                 (goto-char (match-beginning 0))
 315                 (insert prefix group ":"
 316                         (int-to-string (header-number header)) " ")
 317                 (setq first nil)))
 318           (save-excursion
 319             (goto-char (match-beginning 0))
 320             (insert prefix)))))))
 321
 322 (defun nnkiboze-nov-file-name ()
 323   (concat nnkiboze-directory
 324           (nnkiboze-prefixed-name nnkiboze-current-group) ".nov"))
 325
 326 (provide 'nnkiboze)
 327
 328 ;;; nnkiboze.el ends here