1 ;;; spam-report.el --- Reporting spam
2 ;; Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
4 ;; Author: Teodor Zlatanov <tzz@lifelogs.com>
7 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
35 (autoload 'mm-url-insert "mm-url"))
37 (defgroup spam-report nil
38 "Spam reporting configuration.")
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
45 :type '(radio (const nil)
46 (regexp :format "%t: %v\n" :size 0 :value "^nntp\+.*:gmane\."))
49 (defcustom spam-report-gmane-spam-header
50 "^X-Report-Spam: http://\\([^/]+\\)\\(.*\\)$"
51 "String matching Gmane spam-reporting header. Two match groups are needed."
55 (defcustom spam-report-gmane-use-article-number t
56 "Whether the article number (faster!) or the header should be used."
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'."
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))
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."
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."
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
95 (defun spam-report-resend (articles)
96 "Report an article as spam by resending via email."
97 (dolist (article articles)
99 "Reporting spam article %d to <%s>..."
100 article spam-report-resend-to)
101 (unless spam-report-resend-to
102 (customize-set-variable
103 spam-report-resend-to
104 (read-from-minibuffer "email address to resend SPAM to? ")))
105 ;; This is ganked from the `gnus-summary-resend-message' function.
106 ;; It involves rendering the SPAM, which is undesirable, but there does
107 ;; not seem to be a nicer way to achieve this.
108 ;; select this particular article
109 (gnus-summary-select-article nil nil nil article)
110 ;; resend it to the destination address
112 (set-buffer gnus-original-article-buffer)
113 (message-resend spam-report-resend-to))))
115 (defun spam-report-gmane (&rest articles)
116 "Report an article as spam through Gmane"
117 (dolist (article articles)
118 (when (and gnus-newsgroup-name
119 (or (null spam-report-gmane-regex)
120 (string-match spam-report-gmane-regex gnus-newsgroup-name)))
121 (gnus-message 6 "Reporting spam article %d to spam.gmane.org..." article)
122 (if spam-report-gmane-use-article-number
123 (spam-report-url-ping
126 (gnus-group-real-name gnus-newsgroup-name)
128 (with-current-buffer nntp-server-buffer
129 (gnus-request-head article gnus-newsgroup-name)
130 (goto-char (point-min))
131 (if (re-search-forward spam-report-gmane-spam-header nil t)
132 (let* ((host (match-string 1))
133 (report (match-string 2))
134 (url (format "http://%s%s" host report)))
135 (gnus-message 7 "Reporting spam through URL %s..." url)
136 (spam-report-url-ping host report))
137 (gnus-message 3 "Could not find X-Report-Spam in article %d..."
141 (defun spam-report-url-ping (host report)
142 "Ping a host through HTTP, addressing a specific GET resource using
143 the function specified by `spam-report-url-ping-function'."
144 (funcall spam-report-url-ping-function host report))
146 (defun spam-report-url-ping-plain (host report)
147 "Ping a host through HTTP, addressing a specific GET resource."
148 (let ((tcp-connection))
150 (or (setq tcp-connection
156 (error "Could not open connection to %s" host))
157 (set-marker (process-mark tcp-connection) (point-min))
160 (format "GET %s HTTP/1.1\nUser-Agent: %s (spam-report.el)\nHost: %s\n\n"
161 report (gnus-emacs-version) host)))))
164 (defun spam-report-process-queue (&optional file keep)
165 "Report all queued requests from `spam-report-requests-file'.
167 If FILE is given, use it instead of `spam-report-requests-file'.
168 If KEEP is t, leave old requests in the file. If KEEP is the
169 symbol `ask', query before flushing the queue file."
171 (list (read-file-name
173 (file-name-directory spam-report-requests-file)
174 spam-report-requests-file
176 (file-name-nondirectory spam-report-requests-file))
178 (if (eq spam-report-url-ping-function 'spam-report-url-to-file)
179 (error (concat "Cannot process requests when "
180 "`spam-report-url-ping-function' is "
181 "`spam-report-url-to-file'."))
182 (gnus-message 7 "Processing requests using `%s'."
183 spam-report-url-ping-function))
184 (or file (setq file spam-report-requests-file))
186 (set-buffer (find-file-noselect file))
187 (goto-char (point-min))
188 (while (and (not (eobp))
190 "http://\\([^/]+\\)\\(/.*\\) *$" (point-at-eol) t))
191 (funcall spam-report-url-ping-function (match-string 1) (match-string 2))
193 (if (or (eq keep nil)
197 "Flush requests from `%s'? " (current-buffer)))))
199 (gnus-message 7 "Flushing request file `%s'"
200 spam-report-requests-file)
203 (kill-buffer (current-buffer)))
204 (gnus-message 7 "Keeping requests in `%s'" spam-report-requests-file))))
207 (defun spam-report-url-ping-mm-url (host report)
208 "Ping a host through HTTP, addressing a specific GET resource. Use
209 the external program specified in `mm-url-program' to connect to
212 (let ((url (concat "http://" host report)))
213 (mm-url-insert url t))))
216 (defun spam-report-url-to-file (host report)
217 "Collect spam report requests in `spam-report-requests-file'.
218 Customize `spam-report-url-ping-function' to use this function."
219 (let ((url (concat "http://" host report))
220 (file spam-report-requests-file))
221 (gnus-make-directory (file-name-directory file))
222 (gnus-message 9 "Writing URL `%s' to file `%s'" url file)
226 (append-to-file (point-min) (point-max) file))))
229 (defun spam-report-agentize ()
230 "Add spam-report support to the Agent.
231 Spam reports will be queued with \\[spam-report-url-to-file] when
232 the Agent is unplugged, and will be submitted in a batch when the
235 (add-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
236 (add-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
239 (defun spam-report-deagentize ()
240 "Remove spam-report support from the Agent.
241 Spam reports will be queued with the method used when
242 \\[spam-report-agentize] was run."
244 (remove-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
245 (remove-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
247 (defun spam-report-plug-agent ()
248 "Adjust spam report settings for plugged state.
249 Process queued spam reports."
250 ;; Process the queue, unless the user only wanted to report to a file
252 (unless (equal spam-report-url-ping-temp-agent-function
253 'spam-report-url-to-file)
254 (spam-report-process-queue))
255 ;; Set the reporting function, if we have memorized something otherwise,
256 ;; stick with plain URL reporting.
257 (setq spam-report-url-ping-function
258 (or spam-report-url-ping-temp-agent-function
259 'spam-report-url-ping-plain)))
261 (defun spam-report-unplug-agent ()
262 "Restore spam report settings for unplugged state."
263 ;; save the old value
264 (setq spam-report-url-ping-temp-agent-function
265 spam-report-url-ping-function)
266 ;; store all reports to file
267 (setq spam-report-url-ping-function
268 'spam-report-url-to-file))
270 (provide 'spam-report)
272 ;;; arch-tag: f6683295-ec89-4ab5-8803-8cc842293022
273 ;;; spam-report.el ends here.