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 &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)
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
114 (set-buffer gnus-original-article-buffer)
115 (message-resend spam-report-resend-to))))
117 (defun spam-report-resend-ham (articles)
118 "Report an article as ham by resending via email."
119 (spam-report-resend articles t))
121 (defun spam-report-gmane (&rest articles)
122 "Report an article as spam through Gmane."
123 (interactive (gnus-summary-work-articles current-prefix-arg))
124 (dolist (article articles)
125 (when (and gnus-newsgroup-name
126 (or (null spam-report-gmane-regex)
127 (string-match spam-report-gmane-regex gnus-newsgroup-name)))
128 (gnus-message 6 "Reporting spam article %d to spam.gmane.org..." article)
129 (if spam-report-gmane-use-article-number
130 (spam-report-url-ping
133 (gnus-group-real-name gnus-newsgroup-name)
135 (with-current-buffer nntp-server-buffer
136 (gnus-request-head article gnus-newsgroup-name)
137 (goto-char (point-min))
138 (if (re-search-forward spam-report-gmane-spam-header nil t)
139 (let* ((host (match-string 1))
140 (report (match-string 2))
141 (url (format "http://%s%s" host report)))
142 (gnus-message 7 "Reporting spam through URL %s..." url)
143 (spam-report-url-ping host report))
144 (gnus-message 3 "Could not find X-Report-Spam in article %d..."
148 (defun spam-report-url-ping (host report)
149 "Ping a host through HTTP, addressing a specific GET resource using
150 the function specified by `spam-report-url-ping-function'."
151 (funcall spam-report-url-ping-function host report))
153 (defun spam-report-url-ping-plain (host report)
154 "Ping a host through HTTP, addressing a specific GET resource."
155 (let ((tcp-connection))
157 (or (setq tcp-connection
163 (error "Could not open connection to %s" host))
164 (set-marker (process-mark tcp-connection) (point-min))
167 (format "GET %s HTTP/1.1\nUser-Agent: %s (spam-report.el)\nHost: %s\n\n"
168 report (gnus-emacs-version) host)))))
171 (defun spam-report-process-queue (&optional file keep)
172 "Report all queued requests from `spam-report-requests-file'.
174 If FILE is given, use it instead of `spam-report-requests-file'.
175 If KEEP is t, leave old requests in the file. If KEEP is the
176 symbol `ask', query before flushing the queue file."
178 (list (read-file-name
180 (file-name-directory spam-report-requests-file)
181 spam-report-requests-file
183 (file-name-nondirectory spam-report-requests-file))
185 (if (eq spam-report-url-ping-function 'spam-report-url-to-file)
186 (error (concat "Cannot process requests when "
187 "`spam-report-url-ping-function' is "
188 "`spam-report-url-to-file'."))
189 (gnus-message 7 "Processing requests using `%s'."
190 spam-report-url-ping-function))
191 (or file (setq file spam-report-requests-file))
193 (set-buffer (find-file-noselect file))
194 (goto-char (point-min))
195 (while (and (not (eobp))
197 "http://\\([^/]+\\)\\(/.*\\) *$" (point-at-eol) t))
198 (funcall spam-report-url-ping-function (match-string 1) (match-string 2))
200 (if (or (eq keep nil)
204 "Flush requests from `%s'? " (current-buffer)))))
206 (gnus-message 7 "Flushing request file `%s'"
207 spam-report-requests-file)
210 (kill-buffer (current-buffer)))
211 (gnus-message 7 "Keeping requests in `%s'" spam-report-requests-file))))
214 (defun spam-report-url-ping-mm-url (host report)
215 "Ping a host through HTTP, addressing a specific GET resource. Use
216 the external program specified in `mm-url-program' to connect to
219 (let ((url (concat "http://" host report)))
220 (mm-url-insert url t))))
223 (defun spam-report-url-to-file (host report)
224 "Collect spam report requests in `spam-report-requests-file'.
225 Customize `spam-report-url-ping-function' to use this function."
226 (let ((url (concat "http://" host report))
227 (file spam-report-requests-file))
228 (gnus-make-directory (file-name-directory file))
229 (gnus-message 9 "Writing URL `%s' to file `%s'" url file)
233 (append-to-file (point-min) (point-max) file))))
236 (defun spam-report-agentize ()
237 "Add spam-report support to the Agent.
238 Spam reports will be queued with \\[spam-report-url-to-file] when
239 the Agent is unplugged, and will be submitted in a batch when the
242 (add-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
243 (add-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
246 (defun spam-report-deagentize ()
247 "Remove spam-report support from the Agent.
248 Spam reports will be queued with the method used when
249 \\[spam-report-agentize] was run."
251 (remove-hook 'gnus-agent-plugged-hook 'spam-report-plug-agent)
252 (remove-hook 'gnus-agent-unplugged-hook 'spam-report-unplug-agent))
254 (defun spam-report-plug-agent ()
255 "Adjust spam report settings for plugged state.
256 Process queued spam reports."
257 ;; Process the queue, unless the user only wanted to report to a file
259 (unless (equal spam-report-url-ping-temp-agent-function
260 'spam-report-url-to-file)
261 (spam-report-process-queue))
262 ;; Set the reporting function, if we have memorized something otherwise,
263 ;; stick with plain URL reporting.
264 (setq spam-report-url-ping-function
265 (or spam-report-url-ping-temp-agent-function
266 'spam-report-url-ping-plain)))
268 (defun spam-report-unplug-agent ()
269 "Restore spam report settings for unplugged state."
270 ;; save the old value
271 (setq spam-report-url-ping-temp-agent-function
272 spam-report-url-ping-function)
273 ;; store all reports to file
274 (setq spam-report-url-ping-function
275 'spam-report-url-to-file))
277 (provide 'spam-report)
279 ;;; spam-report.el ends here.