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

   1 ;;; nnvirtual.el --- virtual newsgroups access for Gnus
   2 ;; Copyright (C) 1994,95,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
   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 ;; The other access methods (nntp, nnspool, etc) are general news
  28 ;; access methods. This module relies on Gnus and can not be used
  29 ;; separately.
  30
  31 ;;; Code:
  32
  33 (require 'nntp)
  34 (require 'nnheader)
  35 (require 'gnus)
  36 (eval-when-compile (require 'cl))
  37
  38 (defvar nnvirtual-always-rescan nil
  39   "*If non-nil, always scan groups for unread articles when entering a group.
  40 If this variable is nil (which is the default) and you read articles
  41 in a component group after the virtual group has been activated, the
  42 read articles from the component group will show up when you enter the
  43 virtual group.")
  44
  45 \f
  46
  47 (defconst nnvirtual-version "nnvirtual 1.0"
  48   "Version number of this version of nnvirtual.")
  49
  50 (defvar nnvirtual-group-alist nil)
  51 (defvar nnvirtual-current-group nil)
  52 (defvar nnvirtual-component-groups nil)
  53 (defvar nnvirtual-mapping nil)
  54
  55 (defvar nnvirtual-status-string "")
  56
  57 (eval-and-compile
  58   (autoload 'gnus-cache-articles-in-group "gnus-cache"))
  59
  60 \f
  61
  62 ;;; Interface functions.
  63
  64 (defun nnvirtual-retrieve-headers (articles &optional newsgroup server fetch-old)
  65   (when (nnvirtual-possibly-change-group newsgroup server)
  66     (save-excursion
  67       (if (stringp (car articles))
  68           'headers
  69         (let ((vbuf (nnheader-set-temp-buffer
  70                      (get-buffer-create " *virtual headers*")))
  71               (unfetched (mapcar (lambda (g) (list g))
  72                                  nnvirtual-component-groups))
  73               (system-name (system-name))
  74               cgroup article result prefix)
  75           (while articles
  76             (setq article (assq (pop articles) nnvirtual-mapping))
  77             (when (and (setq cgroup (cadr article))
  78                        (gnus-check-server
  79                         (gnus-find-method-for-group cgroup) t)
  80                        (gnus-request-group cgroup t))
  81               (setq prefix (gnus-group-real-prefix cgroup))
  82               (when (setq result (gnus-retrieve-headers
  83                                   (list (caddr article)) cgroup nil))
  84                 (set-buffer nntp-server-buffer)
  85                 (if (zerop (buffer-size))
  86                     (nconc (assq cgroup unfetched) (list (caddr article)))
  87                   ;; If we got HEAD headers, we convert them into NOV
  88                   ;; headers.  This is slow, inefficient and, come to think
  89                   ;; of it, downright evil.  So sue me.  I couldn't be
  90                   ;; bothered to write a header parse routine that could
  91                   ;; parse a mixed HEAD/NOV buffer.
  92                   (when (eq result 'headers)
  93                     (nnvirtual-convert-headers))
  94                   (goto-char (point-min))
  95                   (while (not (eobp))
  96                     (delete-region
  97                      (point) (progn (read nntp-server-buffer) (point)))
  98                     (princ (car article) (current-buffer))
  99                     (beginning-of-line)
 100                     (looking-at
 101                      "[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t[^\t]*\t")
 102                     (goto-char (match-end 0))
 103                     (or (search-forward
 104                          "\t" (save-excursion (end-of-line) (point)) t)
 105                         (end-of-line))
 106                     (while (= (char-after (1- (point))) ? )
 107                       (forward-char -1)
 108                       (delete-char 1))
 109                     (if (eolp)
 110                         (progn
 111                           (end-of-line)
 112                           (or (= (char-after (1- (point))) ?\t)
 113                               (insert ?\t))
 114                           (insert "Xref: " system-name " " cgroup ":")
 115                           (princ (caddr article) (current-buffer))
 116                           (insert "\t"))
 117                       (insert "Xref: " system-name " " cgroup ":")
 118                       (princ (caddr article) (current-buffer))
 119                       (insert " ")
 120                       (if (not (string= "" prefix))
 121                           (while (re-search-forward
 122                                   "[^ ]+:[0-9]+"
 123                                   (save-excursion (end-of-line) (point)) t)
 124                             (save-excursion
 125                               (goto-char (match-beginning 0))
 126                               (insert prefix))))
 127                       (end-of-line)
 128                       (or (= (char-after (1- (point))) ?\t)
 129                           (insert ?\t)))
 130                     (forward-line 1))
 131                   (set-buffer vbuf)
 132                   (goto-char (point-max))
 133                   (insert-buffer-substring nntp-server-buffer)))))
 134
 135           ;; In case some of the articles have expired or been
 136           ;; cancelled, we have to mark them as read in the
 137           ;; component group.
 138           (while unfetched
 139             (when (cdar unfetched)
 140               (gnus-group-make-articles-read
 141                (caar unfetched) (sort (cdar unfetched) '<)))
 142             (setq unfetched (cdr unfetched)))
 143
 144           ;; The headers are ready for reading, so they are inserted into
 145           ;; the nntp-server-buffer, which is where Gnus expects to find
 146           ;; them.
 147           (prog1
 148               (save-excursion
 149                 (set-buffer nntp-server-buffer)
 150                 (erase-buffer)
 151                 (insert-buffer-substring vbuf)
 152                 'nov)
 153             (kill-buffer vbuf)))))))
 154
 155 (defun nnvirtual-open-server (server &optional something)
 156   (nnheader-init-server-buffer))
 157
 158 (defun nnvirtual-close-server (&rest dum)
 159   t)
 160
 161 (defun nnvirtual-request-close ()
 162   (setq nnvirtual-current-group nil
 163         nnvirtual-component-groups nil
 164         nnvirtual-mapping nil
 165         nnvirtual-group-alist nil)
 166   t)
 167
 168 (defun nnvirtual-server-opened (&optional server)
 169   (and nntp-server-buffer
 170        (get-buffer nntp-server-buffer)))
 171
 172 (defun nnvirtual-status-message (&optional server)
 173   nnvirtual-status-string)
 174
 175 (defun nnvirtual-request-article (article &optional group server buffer)
 176   (when (and (nnvirtual-possibly-change-group group server)
 177              (numberp article))
 178     (let* ((amap (assq article nnvirtual-mapping))
 179            (cgroup (cadr amap)))
 180       (cond
 181        ((not amap)
 182         (nnheader-report 'nnvirtual "No such article: %s" article))
 183        ((not (gnus-check-group cgroup))
 184         (nnheader-report
 185          'nnvirtual "Can't open server where %s exists" cgroup))
 186        ((not (gnus-request-group cgroup t))
 187         (nnheader-report 'nnvirtual "Can't open component group %s" cgroup))
 188        (t
 189         (if buffer
 190             (save-excursion
 191               (set-buffer buffer)
 192               (gnus-request-article-this-buffer (caddr amap) cgroup))
 193           (gnus-request-article (caddr amap) cgroup)))))))
 194
 195 (defun nnvirtual-request-group (group &optional server dont-check)
 196   (cond
 197    ((null (nnvirtual-possibly-change-group
 198            group server
 199            (if nnvirtual-always-rescan nil (not dont-check))))
 200     (setq nnvirtual-current-group nil)
 201     (nnheader-report 'nnvirtual "No component groups in %s" group))
 202    (t
 203     (let ((len (length nnvirtual-mapping)))
 204       (nnheader-insert "211 %d 1 %d %s\n" len len group)))))
 205
 206 (defun nnvirtual-request-type (group &optional article)
 207   (when (nnvirtual-possibly-change-group group nil)
 208     (if (not article)
 209         'unknown
 210       (let ((mart (assq article nnvirtual-mapping)))
 211         (when mart
 212           (gnus-request-type (cadr mart) (car mart)))))))
 213
 214 (defun nnvirtual-request-update-mark (group article mark)
 215   (when (nnvirtual-possibly-change-group group nil)
 216     (let* ((nart (assq article nnvirtual-mapping))
 217            (cgroup (cadr nart))
 218            ;; The component group might be a virtual group.
 219            (nmark (gnus-request-update-mark cgroup (caddr nart) mark)))
 220       (when (and (= mark nmark)
 221                  (gnus-group-auto-expirable-p cgroup))
 222         (setq mark gnus-expirable-mark))))
 223   mark)
 224
 225 (defun nnvirtual-close-group (group &optional server)
 226   (when (nnvirtual-possibly-change-group group server)
 227     ;; Copy (un)read articles.
 228     (nnvirtual-update-reads)
 229     ;; We copy the marks from this group to the component
 230     ;; groups here.
 231     (nnvirtual-update-marked))
 232   t)
 233
 234 (defun nnvirtual-request-list (&optional server)
 235   (nnheader-report 'nnvirtual "LIST is not implemented."))
 236
 237 (defun nnvirtual-request-newgroups (date &optional server)
 238   (nnheader-report 'nnvirtual "NEWGROUPS is not supported."))
 239
 240 (defun nnvirtual-request-list-newsgroups (&optional server)
 241   (nnheader-report 'nnvirtual "LIST NEWSGROUPS is not implemented."))
 242
 243 (defun nnvirtual-request-update-info (group info &optional server)
 244   (when (nnvirtual-possibly-change-group group server)
 245     (let ((map nnvirtual-mapping)
 246           (marks (mapcar (lambda (m) (list (cdr m))) gnus-article-mark-lists))
 247           reads mr m op)
 248       ;; Go through the mapping.
 249       (while map
 250         (unless (nth 3 (setq m (pop map)))
 251           ;; Read article.
 252           (push (car m) reads))
 253         ;; Copy marks.
 254         (when (setq mr (nth 4 m))
 255           (while mr
 256             (setcdr (setq op (assq (pop mr) marks)) (cons (car m) (cdr op))))))
 257       ;; Compress the marks and the reads.
 258       (setq mr marks)
 259       (while mr
 260         (setcdr (car mr) (gnus-compress-sequence (sort (cdr (pop mr)) '<))))
 261       (setcar (cddr info) (gnus-compress-sequence (nreverse reads)))
 262       ;; Remove empty marks lists.
 263       (while (and marks (not (cdar marks)))
 264         (setq marks (cdr marks)))
 265       (setq mr marks)
 266       (while (cdr mr)
 267         (if (cdadr mr)
 268             (setq mr (cdr mr))
 269           (setcdr mr (cddr mr))))
 270
 271       ;; Enter these new marks into the info of the group.
 272       (if (nthcdr 3 info)
 273           (setcar (nthcdr 3 info) marks)
 274         ;; Add the marks lists to the end of the info.
 275         (when marks
 276           (setcdr (nthcdr 2 info) (list marks))))
 277       t)))
 278
 279 (defun nnvirtual-catchup-group (group &optional server all)
 280   (nnvirtual-possibly-change-group group server)
 281   (let ((gnus-group-marked nnvirtual-component-groups)
 282         (gnus-expert-user t))
 283     ;; Make sure all groups are activated.
 284     (mapcar
 285      (lambda (g)
 286        (when (not (numberp (car (gnus-gethash g gnus-newsrc-hashtb))))
 287          (gnus-activate-group g)))
 288      nnvirtual-component-groups)
 289     (save-excursion
 290       (set-buffer gnus-group-buffer)
 291       (gnus-group-catchup-current nil all))))
 292
 293 (defun nnvirtual-find-group-art (group article)
 294   "Return the real group and article for virtual GROUP and ARTICLE."
 295   (nnvirtual-possibly-change-group group nil)
 296   (let ((mart (assq article nnvirtual-mapping)))
 297     (when mart
 298       (cons (cadr mart) (caddr mart)))))
 299
 300 \f
 301 ;;; Internal functions.
 302
 303 (defun nnvirtual-convert-headers ()
 304   "Convert HEAD headers into NOV headers."
 305   (save-excursion
 306     (set-buffer nntp-server-buffer)
 307     (let* ((dependencies (make-vector 100 0))
 308            (headers (gnus-get-newsgroup-headers dependencies))
 309            header)
 310       (erase-buffer)
 311       (while (setq header (pop headers))
 312         (insert (int-to-string (mail-header-number header)) "\t"
 313                 (or (mail-header-subject header) "") "\t"
 314                 (or (mail-header-from header) "") "\t"
 315                 (or (mail-header-date header) "") "\t"
 316                 (or (mail-header-id header) "") "\t"
 317                 (or (mail-header-references header) "") "\t"
 318                 (int-to-string (or (mail-header-chars header) 0)) "\t"
 319                 (int-to-string (or (mail-header-lines header) 0)) "\t"
 320                 (if (mail-header-xref header)
 321                     (concat "Xref: " (mail-header-xref header) "\t")
 322                   "") "\n")))))
 323
 324 (defun nnvirtual-possibly-change-group (group regexp &optional check)
 325   (let ((inf t))
 326     (when (or (not (equal group nnvirtual-current-group))
 327               check)
 328       (setq inf (assoc group nnvirtual-group-alist))
 329       (when nnvirtual-current-group
 330         ;; Push the old group variables onto the alist.
 331         (setq nnvirtual-group-alist
 332               (cons (list nnvirtual-current-group
 333                           nnvirtual-component-groups
 334                           nnvirtual-mapping)
 335                     (delq inf nnvirtual-group-alist))))
 336       (if check
 337           ;; We nix out the variables.
 338           (setq nnvirtual-current-group nil
 339                 nnvirtual-component-groups nil
 340                 nnvirtual-mapping nil
 341                 nnvirtual-group-alist
 342                 (delq (assoc group nnvirtual-group-alist)
 343                       nnvirtual-group-alist))
 344         (setq nnvirtual-current-group nil
 345               nnvirtual-component-groups nil
 346               nnvirtual-mapping nil)
 347         ;; Try to find the variables in the assoc.
 348         (when (and inf (equal (nth 3 inf) regexp))
 349           (setq nnvirtual-current-group (car inf)
 350                 nnvirtual-component-groups (nth 1 inf)
 351                 nnvirtual-mapping (nth 2 inf))))
 352
 353       (unless nnvirtual-component-groups
 354         (setq nnvirtual-mapping nil)
 355         (setq nnvirtual-current-group group)
 356         ;; Go through the newsrc alist and find all component groups.
 357         (let ((newsrc (cdr gnus-newsrc-alist))
 358               (virt-group (gnus-group-prefixed-name
 359                            nnvirtual-current-group '(nnvirtual ""))))
 360           (while (setq group (car (pop newsrc)))
 361             (and (string-match regexp group) ; Match
 362                  ;; Virtual groups shouldn't include itself.
 363                  (not (string= group virt-group))
 364                  ;; Add this group to the list of component groups.
 365                  (setq nnvirtual-component-groups
 366                        (cons group
 367                              (delete group nnvirtual-component-groups))))))
 368         (if (not nnvirtual-component-groups)
 369             (nnheader-report 'nnvirtual "No component groups: %s" group)
 370           (nnvirtual-create-mapping)))))
 371   nnvirtual-component-groups)
 372
 373 (defun nnvirtual-update-marked ()
 374   "Copy marks from the virtual group to the component groups."
 375   (let ((mark-lists gnus-article-mark-lists)
 376         (marks (gnus-info-marks (gnus-get-info
 377                                  (concat "nnvirtual:"
 378                                          nnvirtual-current-group))))
 379         type list mart cgroups)
 380     (while (setq type (cdr (pop mark-lists)))
 381       (setq list (gnus-uncompress-range (cdr (assq type marks))))
 382       (setq cgroups
 383             (mapcar (lambda (g) (list g)) nnvirtual-component-groups))
 384       (while list
 385         (nconc (assoc (cadr (setq mart (assq (pop list) nnvirtual-mapping)))
 386                       cgroups)
 387                (list (caddr mart))))
 388       (while cgroups
 389         (gnus-add-marked-articles
 390          (caar cgroups) type (cdar cgroups) nil t)
 391         (gnus-group-update-group (car (pop cgroups)) t)))))
 392
 393 (defun nnvirtual-update-reads ()
 394   "Copy (un)reads from the current group to the component groups."
 395   (let ((groups (mapcar (lambda (g) (list g)) nnvirtual-component-groups))
 396         (articles (gnus-list-of-unread-articles
 397                    (concat "nnvirtual:" nnvirtual-current-group)))
 398         m)
 399     (while articles
 400       (setq m (assq (pop articles) nnvirtual-mapping))
 401       (nconc (assoc (nth 1 m) groups) (list (nth 2 m))))
 402     (while groups
 403       (gnus-update-read-articles (caar groups) (cdr (pop groups))))))
 404
 405 (defsubst nnvirtual-marks (article marks)
 406   "Return a list of mark types for ARTICLE."
 407   (let (out)
 408     (while marks
 409       (when (memq article (cdar marks))
 410         (push (caar marks) out))
 411       (setq marks (cdr marks)))
 412     out))
 413
 414 (defun nnvirtual-create-mapping ()
 415   "Create an article mapping for the current group."
 416   (let* ((div nil)
 417          m marks list article unreads marks active
 418          (map (sort
 419                (apply
 420                 'nconc
 421                 (mapcar
 422                  (lambda (g)
 423                    (when (and (setq active (gnus-activate-group g))
 424                               (> (cdr active) (car active)))
 425                      (setq unreads (gnus-list-of-unread-articles g)
 426                            marks (gnus-uncompress-marks
 427                                   (gnus-info-marks (gnus-get-info g))))
 428                      (when gnus-use-cache
 429                        (push (cons 'cache (gnus-cache-articles-in-group g))
 430                              marks))
 431                      (setq div (/ (float (car active))
 432                                   (if (zerop (cdr active))
 433                                       1 (cdr active))))
 434                      (mapcar (lambda (n)
 435                                (list (* div (- n (car active)))
 436                                      g n (and (memq n unreads) t)
 437                                      (inline (nnvirtual-marks n marks))))
 438                              (gnus-uncompress-range active))))
 439                  nnvirtual-component-groups))
 440                (lambda (m1 m2)
 441                  (< (car m1) (car m2)))))
 442     (i 0))
 443     (setq nnvirtual-mapping map)
 444     ;; Set the virtual article numbers.
 445     (while (setq m (pop map))
 446       (setcar m (setq article (incf i))))))
 447
 448 (provide 'nnvirtual)
 449
 450 ;;; nnvirtual.el ends here