1 ;;; spam-report.el --- Reporting spam
3 ;; Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
6 ;; Keywords: network, spam, mail, gmane, report
8 ;; This file is part of GNU Emacs.
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)
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.
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., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;;; This module addresses a few aspects of spam reporting under Gnus. Page
28 ;;; breaks are used for grouping declarations and documentation relating to
29 ;;; each particular aspect.
36 (autoload 'mm-url-insert "mm-url"))
38 (defgroup spam-report nil
39 "Spam reporting configuration."
43 (defcustom spam-report-gmane-regex nil
44 "Regexp matching Gmane newsgroups, e.g. \"^nntp\\+.*:gmane\\.\"
45 If you are using spam.el, consider setting gnus-spam-process-newsgroups
46 or the gnus-group-spam-exit-processor-report-gmane group/topic parameter
48 :type '(radio (const nil)
49 (regexp :value "^nntp\+.*:gmane\."))
52 (defcustom spam-report-gmane-use-article-number t
53 "Whether the article number (faster!) or the header should be used."
57 (defcustom spam-report-url-ping-function
58 'spam-report-url-ping-plain
59 "Function to use for url ping spam reporting.
60 The function must accept the arguments `host' and `report'."
62 (const :tag "Connect directly"
63 spam-report-url-ping-plain)
64 (const :tag "Use the external program specified in `mm-url-program'"
65 spam-report-url-ping-mm-url)
66 (const :tag "Store request URLs in `spam-report-requests-file'"
67 spam-report-url-to-file)
68 (function :tag "User defined function" nil))
71 (defcustom spam-report-requests-file
72 (nnheader-concat gnus-directory "spam/" "spam-report-requests.url")
73 ;; Is there a convention for the extension of such a file?
74 ;; Should we use `spam-directory'?
75 "File where spam report request are stored."
79 (defcustom spam-report-resend-to nil
80 "Email address that spam articles are resent to when reporting.
81 If not set, the user will be prompted to enter a value which will be
82 saved for future use."
86 (defvar spam-report-url-ping-temp-agent-function nil
87 "Internal variable for `spam-report-agentize' and `spam-report-deagentize'.
88 This variable will store the value of `spam-report-url-ping-function' from
89 before `spam-report-agentize' was run, so that `spam-report-deagentize' can
92 (defun spam-report-resend (articles &optional ham)
93 "Report an article as spam by resending via email.
94 Reports is as ham when HAM is set."
95 (dolist (article articles)
97 "Reporting %s article %d to <%s>..."
99 article spam-report-resend-to)
100 (unless spam-report-resend-to
101 (customize-set-variable
102 spam-report-resend-to
103 (read-from-minibuffer "email address to resend SPAM/HAM to? ")))
104 ;; This is ganked from the `gnus-summary-resend-message' function.
105 ;; It involves rendering the SPAM, which is undesirable, but there does
106 ;; not seem to be a nicer way to achieve this.
107 ;; select this particular article
108 (gnus-summary-select-article nil nil nil article)
109 ;; resend it to the destination address
111 (set-buffer gnus-original-article-buffer)
112 (message-resend spam-report-resend-to))))
114 (defun spam-report-resend-ham (articles)
115 "Report an article as ham by resending via email."
116 (spam-report-resend articles t))
118 (defun spam-report-gmane (&rest articles)
119 "Report an article as spam through Gmane."
120 (interactive (gnus-summary-work-articles current-prefix-arg))
121 (dolist (article articles)
122 (when (and gnus-newsgroup-name
123 (or (null spam-report-gmane-regex)
124 (string-match spam-report-gmane-regex gnus-newsgroup-name)))
125 (gnus-message 6 "Reporting spam article %d to spam.gmane.org..." article)
126 (if spam-report-gmane-use-article-number
127 (spam-report-url-ping
130 (gnus-group-real-name gnus-newsgroup-name)
132 (with-current-buffer nntp-server-buffer
133 (gnus-request-head article gnus-newsgroup-name)
134 (let ((case-fold-search t)
135 field host report url)
136 ;; First check for X-Report-Spam because it's more specific to
137 ;; spam reporting than Archived-At. OTOH, all new articles on
138 ;; Gmane don't have X-Report-Spam anymore (unless Lars changes his
141 ;; There might be more than one Archived-At header so we need to
142 ;; find (and transform) the one related to Gmane.
143 (setq field (or (gnus-fetch-field "X-Report-Spam")
144 (gnus-fetch-field "Archived-At")))
147 (concat "http://\\([a-z]+\\.gmane\\.org\\)"
148 "\\(/[^:/]+[:/][0-9]+\\)")
150 (match-string 1 field)))
151 (setq report (match-string 2 field))
152 (when (string-equal "permalink.gmane.org" host)
153 (setq host "spam.gmane.org")
154 (setq report (gnus-replace-in-string
155 report "/\\([0-9]+\\)$" ":\\1")))
156 (setq url (format "http://%s%s" host report))
157 (if (not (and host report url))
159 3 "Could not find a spam report header in article %d..."
161 (gnus-message 7 "Reporting spam through URL %s..." url)
162 (spam-report-url-ping host report))))))))
165 (defun spam-report-url-ping (host report)
166 "Ping a host through HTTP, addressing a specific GET resource using
167 the function specified by `spam-report-url-ping-function'."
169 ;; host: "spam.gmane.org"
170 ;; report: "/gmane.some.group:123456"
171 (funcall spam-report-url-ping-function host report))
173 (defun spam-report-url-ping-plain (host report)
174 "Ping a host through HTTP, addressing a specific GET resource."
175 (let ((tcp-connection))
177 (or (setq tcp-connection
183 (error "Could not open connection to %s" host))
184 (set-marker (process-mark tcp-connection) (point-min))
187 (format "GET %s HTTP/1.1\nUser-Agent: %s (spam-report.el)\nHost: %s\n\n"
188 report (gnus-emacs-version) host)))))
191 (defun spam-report-process-queue (&optional file keep)
192 "Report all queued requests from `spam-report-requests-file'.
194 If FILE is given, use it instead of `spam-report-requests-file'.
195 If KEEP is t, leave old requests in the file. If KEEP is the
196 symbol `ask', query before flushing the queue file."
198 (list (read-file-name
200 (file-name-directory spam-report-requests-file)
201 spam-report-requests-file
203 (file-name-nondirectory spam-report-requests-file))
205 (if (eq spam-report-url-ping-function 'spam-report-url-to-file)
206 (error (concat "Cannot process requests when "
207 "`spam-report-url-ping-function' is "
208 "`spam-report-url-to-file'."))
209 (gnus-message 7 "Processing requests using `%s'."
210 spam-report-url-ping-function))
211 (or file (setq file spam-report-requests-file))
213 (set-buffer (find-file-noselect file))
214 (goto-char (point-min))
215 (while (and (not (eobp))
217 "http://\\([^/]+\\)\\(/.*\\) *$" (point-at-eol) t))
218 (funcall spam-report-url-ping-function (match-string 1) (match-string 2))
220 (if (or (eq keep nil)
224 "Flush requests from `%s'? " (current-buffer)))))
226 (gnus-message 7 "Flushing request file `%s'"
227 spam-report-requests-file)
230 (kill-buffer (current-buffer)))
231 (gnus-message 7 "Keeping requests in `%s'" spam-report-requests-file))))
234 (defun spam-report-url-ping-mm-url (host report)
235 "Ping a host through HTTP, addressing a specific GET resource. Use
236 the external program specified in `mm-url-program' to connect to
239 (let ((url (format "http://%s%s" host report)))
240 (mm-url-insert url t))))
243 (defun spam-report-url-to-file (host report)
244 "Collect spam report requests in `spam-report-requests-file'.
245 Customize `spam-report-url-ping-function' to use this function."
246 (let ((url (format "http://%s%s" host report))
247 (file spam-report-requests-file))
248 (gnus-make-directory (file-name-directory file))
249 (gnus-message 9 "Writing URL `%s' to file `%s'" url file)
253 (append-to-file (point-min) (point-max) file))))
256 (defun spam-report-agentize ()
257 "Add spam-report support to the Agent.
258 Spam reports will be queued with \\[spam-report-url-to-file] when
259 the Agent is unplugged, and will be submitted in a batch when the
262 (add-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
263 (add-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
266 (defun spam-report-deagentize ()
267 "Remove spam-report support from the Agent.
268 Spam reports will be queued with the method used when
269 \\[spam-report-agentize] was run."
271 (remove-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
272 (remove-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
274 (defun spam-report-plug-agent ()
275 "Adjust spam report settings for plugged state.
276 Process queued spam reports."
277 ;; Process the queue, unless the user only wanted to report to a file
279 (unless (equal spam-report-url-ping-temp-agent-function
280 'spam-report-url-to-file)
281 (spam-report-process-queue))
282 ;; Set the reporting function, if we have memorized something otherwise,
283 ;; stick with plain URL reporting.
284 (setq spam-report-url-ping-function
285 (or spam-report-url-ping-temp-agent-function
286 'spam-report-url-ping-plain)))
288 (defun spam-report-unplug-agent ()
289 "Restore spam report settings for unplugged state."
290 ;; save the old value
291 (setq spam-report-url-ping-temp-agent-function
292 spam-report-url-ping-function)
293 ;; store all reports to file
294 (setq spam-report-url-ping-function
295 'spam-report-url-to-file))
297 (provide 'spam-report)
299 ;;; spam-report.el ends here.