cgit.sxemacs.org Git - gnus/blob - lisp/spam-report.el

   1 ;;; spam-report.el --- Reporting spam
   2 ;; Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
   3
   4 ;; Author: Teodor Zlatanov <tzz@lifelogs.com>
   5 ;; Keywords: network
   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 ;;; This module addresses a few aspects of spam reporting under Gnus.  Page
  27 ;;; breaks are used for grouping declarations and documentation relating to
  28 ;;; each particular aspect.
  29
  30 ;;; Code:
  31 (require 'gnus)
  32 (require 'gnus-sum)
  33
  34 (eval-and-compile
  35   (autoload 'mm-url-insert "mm-url"))
  36
  37 (defgroup spam-report nil
  38   "Spam reporting configuration.")
  39
  40 (defcustom spam-report-gmane-regex nil
  41   "Regexp matching Gmane newsgroups, e.g. \"^nntp\\+.*:gmane\\.\"
  42 If you are using spam.el, consider setting gnus-spam-process-newsgroups
  43 or the gnus-group-spam-exit-processor-report-gmane group/topic parameter
  44 instead."
  45   :type '(radio (const nil)
  46                 (regexp :format "%t: %v\n" :size 0 :value "^nntp\+.*:gmane\."))
  47   :group 'spam-report)
  48
  49 (defcustom spam-report-gmane-spam-header
  50   "^X-Report-Spam: http://\\([^/]+\\)\\(.*\\)$"
  51   "String matching Gmane spam-reporting header.  Two match groups are needed."
  52   :type 'regexp
  53   :group 'spam-report)
  54
  55 (defcustom spam-report-gmane-use-article-number t
  56   "Whether the article number (faster!) or the header should be used."
  57   :type 'boolean
  58   :group 'spam-report)
  59
  60 (defcustom spam-report-url-ping-function
  61   'spam-report-url-ping-plain
  62   "Function to use for url ping spam reporting.
  63 The function must accept the arguments `host' and `report'."
  64   :type '(choice
  65           (const :tag "Connect directly"
  66                  spam-report-url-ping-plain)
  67           (const :tag "Use the external program specified in `mm-url-program'"
  68                  spam-report-url-ping-mm-url)
  69           (const :tag "Store request URLs in `spam-report-requests-file'"
  70                  spam-report-url-to-file)
  71           (function :tag "User defined function" nil))
  72   :group 'spam-report)
  73
  74 (defcustom spam-report-requests-file
  75   (nnheader-concat gnus-directory "spam/" "spam-report-requests.url")
  76   ;; Is there a convention for the extension of such a file?
  77   ;; Should we use `spam-directory'?
  78   "File where spam report request are stored."
  79   :type 'file
  80   :group 'spam-report)
  81
  82 (defcustom spam-report-resend-to nil
  83   "Email address that spam articles are resent to when reporting.
  84 If not set, the user will be prompted to enter a value which will be
  85 saved for future use."
  86   :type 'string
  87   :group 'spam-report)
  88
  89 (defvar spam-report-url-ping-temp-agent-function nil
  90   "Internal variable for `spam-report-agentize' and `spam-report-deagentize'.
  91 This variable will store the value of `spam-report-url-ping-function' from
  92 before `spam-report-agentize' was run, so that `spam-report-deagentize' can
  93 undo that change.")
  94
  95 (defun spam-report-resend (articles &optional ham)
  96   "Report an article as spam by resending via email.
  97 Reports is as ham when HAM is set."
  98   (dolist (article articles)
  99     (gnus-message 6
 100                   "Reporting %s article %d to <%s>..."
 101                   (if ham "ham" "spam")
 102                   article spam-report-resend-to)
 103     (unless spam-report-resend-to
 104       (customize-set-variable
 105        spam-report-resend-to
 106        (read-from-minibuffer "email address to resend SPAM/HAM to? ")))
 107     ;; This is ganked from the `gnus-summary-resend-message' function.
 108     ;; It involves rendering the SPAM, which is undesirable, but there does
 109     ;; not seem to be a nicer way to achieve this.
 110     ;; select this particular article
 111     (gnus-summary-select-article nil nil nil article)
 112     ;; resend it to the destination address
 113     (save-excursion
 114       (set-buffer gnus-original-article-buffer)
 115       (message-resend spam-report-resend-to))))
 116
 117 (defun spam-report-resend-ham (articles)
 118   "Report an article as ham by resending via email."
 119   (spam-report-resend articles t))
 120
 121 (defun spam-report-gmane (&rest articles)
 122   "Report an article as spam through Gmane"
 123   (dolist (article articles)
 124     (when (and gnus-newsgroup-name
 125                (or (null spam-report-gmane-regex)
 126                    (string-match spam-report-gmane-regex gnus-newsgroup-name)))
 127       (gnus-message 6 "Reporting spam article %d to spam.gmane.org..." article)
 128       (if spam-report-gmane-use-article-number
 129           (spam-report-url-ping
 130            "spam.gmane.org"
 131            (format "/%s:%d"
 132                    (gnus-group-real-name gnus-newsgroup-name)
 133                    article))
 134         (with-current-buffer nntp-server-buffer
 135           (gnus-request-head article gnus-newsgroup-name)
 136           (goto-char (point-min))
 137           (if (re-search-forward spam-report-gmane-spam-header nil t)
 138               (let* ((host (match-string 1))
 139                      (report (match-string 2))
 140                      (url (format "http://%s%s" host report)))
 141                 (gnus-message 7 "Reporting spam through URL %s..." url)
 142                 (spam-report-url-ping host report))
 143             (gnus-message 3 "Could not find X-Report-Spam in article %d..."
 144                           article)))))))
 145
 146
 147 (defun spam-report-url-ping (host report)
 148   "Ping a host through HTTP, addressing a specific GET resource using
 149 the function specified by `spam-report-url-ping-function'."
 150   (funcall spam-report-url-ping-function host report))
 151
 152 (defun spam-report-url-ping-plain (host report)
 153   "Ping a host through HTTP, addressing a specific GET resource."
 154   (let ((tcp-connection))
 155     (with-temp-buffer
 156       (or (setq tcp-connection
 157                 (open-network-stream
 158                  "URL ping"
 159                  (buffer-name)
 160                  host
 161                  80))
 162           (error "Could not open connection to %s" host))
 163       (set-marker (process-mark tcp-connection) (point-min))
 164       (process-send-string
 165        tcp-connection
 166        (format "GET %s HTTP/1.1\nUser-Agent: %s (spam-report.el)\nHost: %s\n\n"
 167                report (gnus-emacs-version) host)))))
 168
 169 ;;;###autoload
 170 (defun spam-report-process-queue (&optional file keep)
 171   "Report all queued requests from `spam-report-requests-file'.
 172
 173 If FILE is given, use it instead of `spam-report-requests-file'.
 174 If KEEP is t, leave old requests in the file.  If KEEP is the
 175 symbol `ask', query before flushing the queue file."
 176   (interactive
 177    (list (read-file-name
 178           "File: "
 179           (file-name-directory spam-report-requests-file)
 180           spam-report-requests-file
 181           nil
 182           (file-name-nondirectory spam-report-requests-file))
 183          current-prefix-arg))
 184   (if (eq spam-report-url-ping-function 'spam-report-url-to-file)
 185       (error (concat "Cannot process requests when "
 186                      "`spam-report-url-ping-function' is "
 187                      "`spam-report-url-to-file'."))
 188     (gnus-message 7 "Processing requests using `%s'."
 189                   spam-report-url-ping-function))
 190   (or file (setq file spam-report-requests-file))
 191   (save-excursion
 192     (set-buffer (find-file-noselect file))
 193     (goto-char (point-min))
 194     (while (and (not (eobp))
 195                 (re-search-forward
 196                  "http://\\([^/]+\\)\\(/.*\\) *$" (point-at-eol) t))
 197       (funcall spam-report-url-ping-function (match-string 1) (match-string 2))
 198       (forward-line 1))
 199     (if (or (eq keep nil)
 200             (and (eq keep 'ask)
 201                  (y-or-n-p
 202                   (format
 203                    "Flush requests from `%s'? " (current-buffer)))))
 204         (progn
 205           (gnus-message 7 "Flushing request file `%s'"
 206                         spam-report-requests-file)
 207           (erase-buffer)
 208           (save-buffer)
 209           (kill-buffer (current-buffer)))
 210       (gnus-message 7 "Keeping requests in `%s'" spam-report-requests-file))))
 211
 212 ;;;###autoload
 213 (defun spam-report-url-ping-mm-url (host report)
 214   "Ping a host through HTTP, addressing a specific GET resource. Use
 215 the external program specified in `mm-url-program' to connect to
 216 server."
 217   (with-temp-buffer
 218     (let ((url (concat "http://" host report)))
 219       (mm-url-insert url t))))
 220
 221 ;;;###autoload
 222 (defun spam-report-url-to-file (host report)
 223   "Collect spam report requests in `spam-report-requests-file'.
 224 Customize `spam-report-url-ping-function' to use this function."
 225   (let ((url (concat "http://" host report))
 226         (file spam-report-requests-file))
 227     (gnus-make-directory (file-name-directory file))
 228     (gnus-message 9 "Writing URL `%s' to file `%s'" url file)
 229     (with-temp-buffer
 230       (insert url)
 231       (newline)
 232       (append-to-file (point-min) (point-max) file))))
 233
 234 ;;;###autoload
 235 (defun spam-report-agentize ()
 236   "Add spam-report support to the Agent.
 237 Spam reports will be queued with \\[spam-report-url-to-file] when
 238 the Agent is unplugged, and will be submitted in a batch when the
 239 Agent is plugged."
 240   (interactive)
 241   (add-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
 242   (add-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
 243
 244 ;;;###autoload
 245 (defun spam-report-deagentize ()
 246   "Remove spam-report support from the Agent.
 247 Spam reports will be queued with the method used when
 248 \\[spam-report-agentize] was run."
 249   (interactive)
 250   (remove-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
 251   (remove-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
 252
 253 (defun spam-report-plug-agent ()
 254   "Adjust spam report settings for plugged state.
 255 Process queued spam reports."
 256   ;; Process the queue, unless the user only wanted to report to a file
 257   ;; anyway.
 258   (unless (equal spam-report-url-ping-temp-agent-function
 259                  'spam-report-url-to-file)
 260     (spam-report-process-queue))
 261   ;; Set the reporting function, if we have memorized something otherwise,
 262   ;; stick with plain URL reporting.
 263   (setq spam-report-url-ping-function
 264         (or spam-report-url-ping-temp-agent-function
 265             'spam-report-url-ping-plain)))
 266
 267 (defun spam-report-unplug-agent ()
 268   "Restore spam report settings for unplugged state."
 269   ;; save the old value
 270   (setq spam-report-url-ping-temp-agent-function
 271         spam-report-url-ping-function)
 272   ;; store all reports to file
 273   (setq spam-report-url-ping-function
 274         'spam-report-url-to-file))
 275
 276 (provide 'spam-report)
 277
 278 ;;; arch-tag: f6683295-ec89-4ab5-8803-8cc842293022
 279 ;;; spam-report.el ends here.