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