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

   1 ;;; gnus-nocem.el --- NoCeM pseudo-cancellation treatment
   2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne 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 the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'gnus)
  29 (require 'nnmail)
  30 (eval-when-compile (require 'cl))
  31
  32 (defvar gnus-nocem-groups
  33   '("alt.nocem.misc" "news.admin.net-abuse.announce")
  34   "*List of groups that will be searched for NoCeM messages.")
  35
  36 (defvar gnus-nocem-issuers
  37   '("Automoose-1" ; The CancelMoose[tm] on autopilot.
  38     "clewis@ferret.ocunix.on.ca;" ; Chris Lewis -- Canadian angel & despammer.
  39     "jem@xpat.com;"  ; Jem -- Korean despammer.
  40     "red@redpoll.mrfs.oh.us (Richard E. Depew)" ; Spew/bincancel guy.
  41     )
  42   "*List of NoCeM issuers to pay attention to.")
  43
  44 (defvar gnus-nocem-directory
  45   (concat (file-name-as-directory gnus-article-save-directory) "NoCeM/")
  46   "*Directory where NoCeM files will be stored.")
  47
  48 (defvar gnus-nocem-expiry-wait 15
  49   "*Number of days to keep NoCeM headers in the cache.")
  50
  51 ;;; Internal variables
  52
  53 (defvar gnus-nocem-active nil)
  54 (defvar gnus-nocem-alist nil)
  55 (defvar gnus-nocem-touched-alist nil)
  56 (defvar gnus-nocem-hashtb nil)
  57
  58 ;;; Functions
  59
  60 (defun gnus-nocem-active-file ()
  61   (concat (file-name-as-directory gnus-nocem-directory) "active"))
  62
  63 (defun gnus-nocem-cache-file ()
  64   (concat (file-name-as-directory gnus-nocem-directory) "cache"))
  65
  66 (defun gnus-nocem-scan-groups ()
  67   "Scan all NoCeM groups for new NoCeM messages."
  68   (interactive)
  69   (let ((groups gnus-nocem-groups)
  70         group active gactive articles)
  71     (or (file-exists-p gnus-nocem-directory)
  72         (make-directory gnus-nocem-directory t))
  73     ;; Load any previous NoCeM headers.
  74     (gnus-nocem-load-cache)
  75     ;; Read the active file if it hasn't been read yet.
  76     (and (file-exists-p (gnus-nocem-active-file))
  77          (not gnus-nocem-active)
  78          (condition-case ()
  79              (load (gnus-nocem-active-file) t t t)
  80            (error nil)))
  81     ;; Go through all groups and see whether new articles have
  82     ;; arrived.
  83     (while (setq group (pop groups))
  84       (if (not (setq gactive (gnus-activate-group group)))
  85           () ; This group doesn't exist.
  86         (setq active (nth 1 (assoc group gnus-nocem-active)))
  87         (when (and (not (< (cdr gactive) (car gactive))) ; Empty group.
  88                    (or (not active)
  89                        (< (cdr active) (cdr gactive))))
  90           ;; Ok, there are new articles in this group, se we fetch the
  91           ;; headers.
  92           (save-excursion
  93             (let ((gnus-newsgroup-dependencies (make-vector 10 nil))
  94                   (buffer (nnheader-set-temp-buffer " *Gnus NoCeM*"))
  95                   headers)
  96               (setq headers
  97                     (if (eq 'nov
  98                             (gnus-retrieve-headers
  99                              (setq articles
 100                                    (gnus-uncompress-range
 101                                     (cons
 102                                      (if active (1+ (cdr active))
 103                                        (car gactive))
 104                                      (cdr gactive))))
 105                              group))
 106                         (gnus-get-newsgroup-headers-xover articles)
 107                       (gnus-get-newsgroup-headers)))
 108               (while headers
 109                 ;; We take a closer look on all articles that have
 110                 ;; "@@NCM" in the subject.
 111                 (when (string-match "@@NCM"
 112                                     (mail-header-subject (car headers)))
 113                   (gnus-nocem-check-article group (car headers)))
 114                 (setq headers (cdr headers)))
 115               (kill-buffer (current-buffer)))))
 116         (setq gnus-nocem-active
 117               (cons (list group gactive)
 118                     (delq (assoc group gnus-nocem-active)
 119                           gnus-nocem-active)))))
 120     ;; Save the results, if any.
 121     (gnus-nocem-save-cache)
 122     (gnus-nocem-save-active)))
 123
 124 (defun gnus-nocem-check-article (group header)
 125   "Check whether the current article is an NCM article and that we want it."
 126   ;; Get the article.
 127   (gnus-message 7 "Checking article %d in %s for NoCeM..."
 128                 (mail-header-number header) group)
 129   (let ((date (mail-header-date header))
 130         issuer b e)
 131     (when (or (not date)
 132               (nnmail-time-less
 133                (nnmail-time-since (nnmail-date-to-time date))
 134                (nnmail-days-to-time gnus-nocem-expiry-wait)))
 135       (gnus-request-article-this-buffer (mail-header-number header) group)
 136       ;; The article has to have proper NoCeM headers.
 137       (when (and (setq b (search-forward "\n@@BEGIN NCM HEADERS\n" nil t))
 138                  (setq e (search-forward "\n@@BEGIN NCM BODY\n" nil t)))
 139         ;; We get the name of the issuer.
 140         (narrow-to-region b e)
 141         (setq issuer (mail-fetch-field "issuer"))
 142         (and (member issuer gnus-nocem-issuers) ; We like her...
 143              (gnus-nocem-verify-issuer issuer) ; She is who she says she is..
 144              (gnus-nocem-enter-article)))))) ; We gobble the message.
 145
 146 (defun gnus-nocem-verify-issuer (person)
 147   "Verify using PGP that the canceler is who she says she is."
 148   t)
 149
 150 (defun gnus-nocem-enter-article ()
 151   "Enter the current article into the NoCeM cache."
 152   (widen)
 153   (goto-char (point-min))
 154   (let ((b (search-forward "\n@@BEGIN NCM BODY\n" nil t))
 155         (e (search-forward "\n@@END NCM BODY\n" nil t))
 156         (buf (current-buffer))
 157         ncm id)
 158     (when (and b e)
 159       (narrow-to-region b (1+ (match-beginning 0)))
 160       (goto-char (point-min))
 161       (while (search-forward "\t" nil t)
 162         (when (boundp (let ((obarray gnus-active-hashtb)) (read buf)))
 163           (beginning-of-line)
 164           (while (= (following-char) ?\t)
 165             (forward-line -1))
 166           (setq id (buffer-substring (point) (1- (search-forward "\t"))))
 167           (push id ncm)
 168           (gnus-sethash id t gnus-nocem-hashtb)
 169           (forward-line 1)
 170           (while (= (following-char) ?\t)
 171             (forward-line 1))))
 172       (when ncm
 173         (setq gnus-nocem-touched-alist t)
 174         (push (cons (let ((time (current-time))) (setcdr (cdr time) nil) time)
 175                     ncm)
 176               gnus-nocem-alist)))))
 177
 178 (defun gnus-nocem-load-cache ()
 179   "Load the NoCeM cache."
 180   (unless gnus-nocem-alist
 181     ;; The buffer doesn't exist, so we create it and load the NoCeM
 182     ;; cache.
 183     (when (file-exists-p (gnus-nocem-cache-file))
 184       (load (gnus-nocem-cache-file) t t t)
 185       (gnus-nocem-alist-to-hashtb))))
 186
 187 (defun gnus-nocem-save-cache ()
 188   "Save the NoCeM cache."
 189   (when (and gnus-nocem-alist
 190              gnus-nocem-touched-alist)
 191     (nnheader-temp-write (gnus-nocem-cache-file)
 192       (prin1 `(setq gnus-nocem-alist ',gnus-nocem-alist) (current-buffer)))
 193     (setq gnus-nocem-touched-alist nil)))
 194
 195 (defun gnus-nocem-save-active ()
 196   "Save the NoCeM active file."
 197   (nnheader-temp-write (gnus-nocem-active-file)
 198     (prin1 `(setq gnus-nocem-active ',gnus-nocem-active) (current-buffer))))
 199
 200 (defun gnus-nocem-alist-to-hashtb ()
 201   "Create a hashtable from the Message-IDs we have."
 202   (let* ((alist gnus-nocem-alist)
 203          (pprev (cons nil alist))
 204          (prev pprev)
 205          (expiry (nnmail-days-to-time gnus-nocem-expiry-wait))
 206          entry)
 207     (setq gnus-nocem-hashtb (gnus-make-hashtable (* (length alist) 51)))
 208     (while (setq entry (car alist))
 209       (if (not (nnmail-time-less (nnmail-time-since (car entry)) expiry))
 210           ;; This entry has expired, so we remove it.
 211           (setcdr prev (cdr alist))
 212         (setq prev alist)
 213         ;; This is ok, so we enter it into the hashtable.
 214         (setq entry (cdr entry))
 215         (while entry
 216           (gnus-sethash (car entry) t gnus-nocem-hashtb)
 217           (setq entry (cdr entry))))
 218       (setq alist (cdr alist)))))
 219
 220 (gnus-add-shutdown 'gnus-nocem-close 'gnus)
 221
 222 (defun gnus-nocem-close ()
 223   "Clear internal NoCeM variables."
 224   (setq gnus-nocem-alist nil
 225         gnus-nocem-hashtb nil
 226         gnus-nocem-active nil
 227         gnus-nocem-touched-alist nil))
 228
 229 (defun gnus-nocem-unwanted-article-p (id)
 230   "Say whether article ID in the current group is wanted."
 231   (gnus-gethash id gnus-nocem-hashtb))
 232
 233 (provide 'gnus-nocem)
 234
 235 ;;; gnus-nocem.el ends here