]> code.delx.au - gnu-emacs/blobdiff - lisp/mail/uce.el
(mail-send-and-exit): Make arg optional.
[gnu-emacs] / lisp / mail / uce.el
index a05727cdff54f54685c331484456de968cc8b0c8..93b3e430e7a00416699ecb594bbb5b1ca2f89861 100644 (file)
@@ -1,23 +1,22 @@
 ;;; uce.el --- facilitate reply to unsolicited commercial email
 
-;; Copyright (C) 1996 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1998, 2000 Free Software Foundation, Inc.
 
-;; Author: stanislav shalunov <shalunov@math.wisc.edu>
+;; Author: stanislav shalunov <shalunov@mccme.ru>
 ;; Created: 10 Dec 1996
-;; Version: 1.0
 ;; Keywords: uce, unsolicited commercial email
 
 ;; This file is part of GNU Emacs.
 
-;; This program is free software; you can redistribute it and/or
-;; modify it under the terms of the GNU General Public License as
-;; published by the Free Software Foundation; either version 2, or (at
-;; your option) any later version.
+;; GNU Emacs is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
 
-;; This program is distributed in the hope that it will be useful, but
-;; without any warranty; without even the implied warranty of
-;; merchantability or fitness for a particular purpose.  See the GNU
-;; General Public License for more details.
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
 ;;; Commentary:
 
 ;; Code in this file provides semi-automatic means of replying to
-;; UCE's you might get.  It works currently only with Rmail.  If you
-;; would like to make it work with other mail readers, Rmail-specific
-;; section is marked below.  If you want to play with code, would you
-;; please grab the newest version from
-;; http://math.wisc.edu/~shalunov/uce.el and let me know, if you would
-;; like, about your changes so I can incorporate them.  I'd appreciate
-;; it.
+;; UCE's you might get.  It works currently only with Rmail and Gnus.
+;; If you would like to make it work with other mail readers,
+;; Rmail-specific section is marked below.  If you want to play with
+;; code, please let me know about your changes so I can incorporate
+;; them.  I'd appreciate it.
 
 ;; Function uce-reply-to-uce, if called when current message in RMAIL
 ;; buffer is a UCE, will setup *mail* buffer in the following way: it
 ;; Dec 17, 1996 -- made scanning for host names little bit more clever
 ;; (obviously bogus stuff like localhost is now ignored).
 
-;;; Setup:
+;; Nov 11, 1997 -- incorporated changes from Mikael Djurfeldt
+;; <mdj@nada.kth.se> to make uce.el work with Gnus.  Changed the text
+;; of message that is sent.
 
-;; put in your ~./emacs the following line:
+;; Dec 3, 1997 -- changes from Gareth Jones <gdj1@gdjones.demon.co.uk>
+;; handling Received headers following some line like `From:'.
+
+;; Aug 16, 2000 -- changes from Detlev Zundel
+;; <detlev.zundel@stud.uni-karlsruhe.de> to make uce.el work with the
+;; latest Gnus.  Lars told him it should work for all versions of Gnus
+;; younger than three years.
+
+;; Setup:
+
+;; Add the following line to your ~/.emacs:
 
 ;; (autoload 'uce-reply-to-uce "uce" "Reply to UCEs" t nil)
 
+;; If you want to use it with Gnus also use
+
+;; (setq uce-mail-reader 'gnus)
+
 ;; store this file (uce.el) somewhere in load-path and byte-compile it.
 
 ;;; Variables:
 ;;; Code:
 
 (require 'sendmail)
-(require 'rmail)
+;; Those sections of code which are dependent upon
+;; RMAIL are only evaluated if we have received a message with RMAIL...
+;;(require 'rmail)
 
 (defgroup uce nil
   "Facilitate reply to unsolicited commercial email."
   :prefix "uce-"
   :group 'mail)
 
+(defcustom uce-mail-reader 'rmail
+  "A symbol indicating which mail reader you are using.
+Choose from: `gnus', `rmail'."
+  :type '(choice (const gnus) (const rmail))
+  :version "20.3"
+  :group 'uce)
+
 (defcustom uce-setup-hook nil
   "Hook to run after UCE rant message is composed.
-This hook is run after mail-setup-hook, which is run as well."
+This hook is run after `mail-setup-hook', which is run as well."
   :type 'hook
   :group 'uce)
 
-(defcustom uce-message-text 
+(defcustom uce-message-text
   "Recently, I have received an Unsolicited Commercial E-mail from you.
 I do not like UCE's and I would like to inform you that sending
 unsolicited messages to someone while he or she may have to pay for
@@ -126,23 +148,33 @@ If you think that this is a good way to advertise your products or
 services you are mistaken.  Spamming will only make people hate you, not
 buy from you.
 
-If you have any list of people you send unsolicited commercial emails to, 
-REMOVE me from such list immediately.  I suggest that you make this list 
+If you have any list of people you send unsolicited commercial emails to,
+REMOVE me from such list immediately.  I suggest that you make this list
 just empty.
 
+       ----------------------------------------------------
+
+If you are not an administrator of any site and still have received
+this message then your email address is being abused by some spammer.
+They fake your address in From: or Reply-To: header.  In this case,
+you might want to show this message to your system administrator, and
+ask him/her to investigate this matter.
+
 Note to the postmaster(s): I append the text of UCE in question to
-this message, I would like to hear from you about action(s) taken.
+this message; I would like to hear from you about action(s) taken.
 This message has been sent to postmasters at the host that is
-mentioned as original sender's host and to the postmaster whose host
-was used as mail relay for this message.  If message was sent not by
-your user, could you please compare time when this message was sent
-(use time in Received: field of the envelope rather than Date: field)
-with your sendmail logs and see what host was using your sendmail at
-this moment of time.
+mentioned as original sender's host (I do realize that it may be
+faked, but I think that if your domain name is being abused this way
+you might want to learn about it, and take actions) and to the
+postmaster whose host was used as mail relay for this message.  If
+message was sent not by your user, could you please compare time when
+this message was sent (use time in Received: field of the envelope
+rather than Date: field) with your sendmail logs and see what host was
+using your sendmail at this moment of time.
 
 Thank you."
 
-  "This is the text that uce-reply-to-uce command will put in reply buffer.
+  "This is the text that `uce-reply-to-uce' command will put in reply buffer.
 Some of spamming programs in use will be set up to read all incoming
 to spam address email, and will remove people who put the word `remove'
 on beginning of some line from the spamming list.  So, when you set it
@@ -160,8 +192,8 @@ Value nil means use no separator."
   :group 'uce)
 
 (defcustom uce-signature mail-signature
-"Text to put as your signature after the note to UCE sender.  
-Value nil means none, t means insert ~/.signature file (if it happens
+"Text to put as your signature after the note to UCE sender.
+Value nil means none, t means insert `~/.signature' file (if it happens
 to exist), if this variable is a string this string will be inserted
 as your signature."
   :type '(choice (const nil) (const t) string)
@@ -185,128 +217,174 @@ These are mostly meant for headers that prevent delivery errors reporting."
 UCE stands for unsolicited commercial email.  Function will set up reply
 buffer with default To: to the sender, his postmaster, his abuse@
 address, and postmaster of the mail relay used."
-  (interactive "P")
-  (let ((to (mail-strip-quoted-names (mail-fetch-field "from" t)))
-       (reply-to (mail-fetch-field "reply-to"))
-       temp)
-    ;; Initial setting of the list of recipients of our message; that's
-    ;; what they are pretending to be (and in many cases, really are).
-    (if to
-       (setq to (format "%s" (mail-strip-quoted-names to)))
-      (setq to ""))
-    (if reply-to
-       (setq to (format "%s, %s" to (mail-strip-quoted-names reply-to))))
-    (let (first-at-sign end-of-hostname sender-host)
-      (setq first-at-sign (string-match "@" to)
-           end-of-hostname (string-match "[ ,>]" to first-at-sign)
-           sender-host (substring to first-at-sign end-of-hostname))
-      (if (string-match "\\." sender-host)
-          (setq to (format "%s, postmaster%s, abuse%s" 
-                           to sender-host sender-host))))
-    (setq mail-send-actions nil)
-    (setq mail-reply-buffer nil)
-    ;; Begin of Rmail dependant section.
-    (or (get-buffer "RMAIL")
-       (error "No buffer RMAIL, cannot find UCE"))
-    (switch-to-buffer "RMAIL")
-    (save-excursion
-      (save-restriction
-       (widen)
-       (rmail-maybe-set-message-counters)
-       (copy-region-as-kill (rmail-msgbeg rmail-current-message) 
-                            (rmail-msgend rmail-current-message))))
-    (switch-to-buffer "*mail*")
-    (erase-buffer)
-    (setq temp (point))
-    (yank)
-    (goto-char temp)
-    (forward-line 2)
-    (while (looking-at "Summary-Line:\\|Mail-From:")
-      (forward-line 1))
-    (delete-region temp (point))
-    ;; Now find the mail hub that first accepted this message.
-    (while (or (looking-at "Received:")
-               (looking-at " ")
-               (looking-at "\t"))
-      (forward-line 1))
-    (while (or (looking-at " ")
-               (looking-at "\t"))
-      (forward-line -1))
-    ;; Is this always good?  It's the only thing I saw when I checked
-    ;; a few messages.
-    (search-forward ": from ")
-    (setq temp (point))
-    (search-forward " ")
-    (forward-char -1)
-    ;; And add its postmaster to the list of addresses.
-    (if (string-match "\\." (buffer-substring temp (point)))
-        (setq to (format "%s, postmaster@%s" 
-                         to (buffer-substring temp (point)))))
-    ;; Also look at the message-id, it helps *very* often.
-    (search-forward "\nMessage-Id: ")
-    (search-forward "@")
-    (setq temp (point))
-    (search-forward ">")
-    (forward-char -1)
-    (if (string-match "\\." (buffer-substring temp (point)))
-        (setq to (format "%s, postmaster@%s" 
-                         to (buffer-substring temp (point)))))
-    (search-forward "\n*** EOOH ***\n")
-    (forward-line -1)
-    (setq temp (point))
-    (search-forward "\n\n" nil t)
-    (delete-region temp (point))
-    ;; End of Rmail dependent section.
-    (auto-save-mode auto-save-default)
-    (mail-mode)
-    (goto-char (point-min))
-    (insert "To: ")
-    (save-excursion
+  (interactive)
+  (let ((message-buffer
+        (cond ((eq uce-mail-reader 'gnus) gnus-original-article-buffer)
+              ((eq uce-mail-reader 'rmail) "RMAIL")
+              (t (error
+                  "Variable uce-mail-reader set to unrecognized value"))))
+       (full-header-p (and (eq uce-mail-reader 'rmail)
+                           (not (rmail-msg-is-pruned)))))
+    (or (get-buffer message-buffer)
+       (error (concat "No buffer " message-buffer ", cannot find UCE")))
+    (switch-to-buffer message-buffer)
+    ;; We need the message with headers pruned.
+    (if full-header-p
+       (rmail-toggle-header 1))
+    (let ((to (mail-strip-quoted-names (mail-fetch-field "from" t)))
+         (reply-to (mail-fetch-field "reply-to"))
+         temp)
+      ;; Initial setting of the list of recipients of our message; that's
+      ;; what they are pretending to be.
       (if to
-         (let ((fill-prefix "\t")
-               (address-start (point)))
-           (insert to "\n")
-           (fill-region-as-paragraph address-start (point)))
-       (newline))
-      (insert "Subject: " uce-subject-line "\n")
-      (if uce-default-headers
-         (insert uce-default-headers))
-      (if mail-default-headers
-          (insert mail-default-headers))
-      (if mail-default-reply-to
-         (insert "Reply-to: " mail-default-reply-to "\n"))
-      (insert mail-header-separator "\n")
-      ;; Insert all our text.  Then go back to the place where we started.
-      (if to (setq to (point)))
-      ;; Text of ranting.
-      (if uce-message-text
-         (insert uce-message-text))
-      ;; Signature.
-      (cond ((eq uce-signature t)
-            (if (file-exists-p "~/.signature")
-                (progn
-                  (insert "\n\n-- \n")
-                  (insert-file "~/.signature")
-                  ;; Function insert-file leaves point where it was,
-                  ;; while we want to place signature in the ``middle''
-                  ;; of the message.
-                  (exchange-point-and-mark))))
-           (uce-signature
-            (insert "\n\n-- \n" uce-signature)))
-      ;; And text of the original message.
-      (if uce-uce-separator
-         (insert "\n\n" uce-uce-separator "\n"))
-      ;; If message doesn't end with a newline, insert it.
-      (goto-char (point-max))
-      (or (bolp) (newline)))
-    ;; And go back to the beginning of text.
-    (if to (goto-char to))
-    (or to (set-buffer-modified-p nil))
-    ;; Run hooks before we leave buffer for editing.  Reasonable usage
-    ;; might be to set up special key bindings, replace standart
-    ;; functions in mail-mode, etc.
-    (run-hooks 'mail-setup-hook 'uce-setup-hook)))
-  
+         (setq to (format "%s" (mail-strip-quoted-names to)))
+       (setq to ""))
+      (if reply-to
+         (setq to (format "%s, %s" to (mail-strip-quoted-names reply-to))))
+      (let (first-at-sign end-of-hostname sender-host)
+       (setq first-at-sign (string-match "@" to)
+             end-of-hostname (string-match "[ ,>]" to first-at-sign)
+             sender-host (substring to first-at-sign end-of-hostname))
+       (if (string-match "\\." sender-host)
+           (setq to (format "%s, postmaster%s, abuse%s"
+                            to sender-host sender-host))))
+      (setq mail-send-actions nil)
+      (setq mail-reply-buffer nil)
+      (cond ((eq uce-mail-reader 'gnus)
+            (copy-region-as-kill (point-min) (point-max)))
+           ((eq uce-mail-reader 'rmail)
+            (save-excursion
+              (save-restriction
+                (rmail-toggle-header 1)
+                (widen)
+                (rmail-maybe-set-message-counters)
+                (copy-region-as-kill (rmail-msgbeg rmail-current-message)
+                                     (rmail-msgend rmail-current-message))))))
+      ;; Restore the pruned header state we found.
+      (if full-header-p
+         (rmail-toggle-header 0))
+      (switch-to-buffer "*mail*")
+      (erase-buffer)
+      (setq temp (point))
+      (yank)
+      (goto-char temp)
+      (if (eq uce-mail-reader 'rmail)
+         (progn
+           (forward-line 2)
+           (let ((case-fold-search t))
+             (while (looking-at "Summary-Line:\\|Mail-From:")
+               (forward-line 1)))
+           (delete-region temp (point))))
+      ;; Now find the mail hub that first accepted this message.
+      ;; This should try to find the last Received: header.
+      ;; Sometimes there may be other headers inbetween Received: headers.
+      (cond ((eq uce-mail-reader 'gnus)
+            ;; Does Gnus always have Lines: in the end?
+            (re-search-forward "^Lines:")
+            (beginning-of-line))
+           ((eq uce-mail-reader 'rmail)
+            (beginning-of-buffer)
+            (search-forward "*** EOOH ***\n")
+            (beginning-of-line)
+            (forward-line -1)))
+      (re-search-backward "^Received:")
+      (beginning-of-line)
+      ;; Is this always good?  It's the only thing I saw when I checked
+      ;; a few messages.
+      (let ((eol (save-excursion (end-of-line) (point))))
+       ;;(if (not (re-search-forward ": \\(from\\|by\\) " eol t))
+       (if (not (re-search-forward "\\(from\\|by\\) " eol t))
+           (progn
+             (goto-char eol)
+             (if (looking-at "[ \t\n]+\\(from\\|by\\) ")
+                 (goto-char (match-end 0))
+               (error "Failed to extract hub address")))))
+      (setq temp (point))
+      (search-forward " ")
+      (forward-char -1)
+      ;; And add its postmaster to the list of addresses.
+      (if (string-match "\\." (buffer-substring temp (point)))
+         (setq to (format "%s, postmaster@%s"
+                          to (buffer-substring temp (point)))))
+      ;; Also look at the message-id, it helps *very* often.
+      (if (and (search-forward "\nMessage-Id: " nil t)
+              ;; Not all Message-Id:'s have an `@' sign.
+              (let ((bol (point))
+                    eol)
+                (end-of-line)
+                (setq eol (point))
+                (goto-char bol)
+                (search-forward "@" eol t)))
+         (progn
+           (setq temp (point))
+           (search-forward ">")
+           (forward-char -1)
+           (if (string-match "\\." (buffer-substring temp (point)))
+               (setq to (format "%s, postmaster@%s"
+                                to (buffer-substring temp (point)))))))
+      (cond ((eq uce-mail-reader 'gnus)
+            ;; Does Gnus always have Lines: in the end?
+            (re-search-forward "^Lines:")
+            (beginning-of-line))
+           ((eq uce-mail-reader 'rmail)
+            (search-forward "\n*** EOOH ***\n")
+            (forward-line -1)))
+      (setq temp (point))
+      (search-forward "\n\n" nil t)
+      (if (eq uce-mail-reader 'gnus)
+         (forward-line -1))
+      (delete-region temp (point))
+      ;; End of Rmail dependent section.
+      (auto-save-mode auto-save-default)
+      (mail-mode)
+      (goto-char (point-min))
+      (insert "To: ")
+      (save-excursion
+       (if to
+           (let ((fill-prefix "\t")
+                 (address-start (point)))
+             (insert to "\n")
+             (fill-region-as-paragraph address-start (point)))
+         (newline))
+       (insert "Subject: " uce-subject-line "\n")
+       (if uce-default-headers
+           (insert uce-default-headers))
+       (if mail-default-headers
+           (insert mail-default-headers))
+       (if mail-default-reply-to
+           (insert "Reply-to: " mail-default-reply-to "\n"))
+       (insert mail-header-separator "\n")
+       ;; Insert all our text.  Then go back to the place where we started.
+       (if to (setq to (point)))
+       ;; Text of ranting.
+       (if uce-message-text
+           (insert uce-message-text))
+       ;; Signature.
+       (cond ((eq uce-signature t)
+              (if (file-exists-p "~/.signature")
+                  (progn
+                    (insert "\n\n-- \n")
+                    (insert-file "~/.signature")
+                    ;; Function insert-file leaves point where it was,
+                    ;; while we want to place signature in the ``middle''
+                    ;; of the message.
+                    (exchange-point-and-mark))))
+             (uce-signature
+              (insert "\n\n-- \n" uce-signature)))
+       ;; And text of the original message.
+       (if uce-uce-separator
+           (insert "\n\n" uce-uce-separator "\n"))
+       ;; If message doesn't end with a newline, insert it.
+       (goto-char (point-max))
+       (or (bolp) (newline)))
+      ;; And go back to the beginning of text.
+      (if to (goto-char to))
+      (or to (set-buffer-modified-p nil))
+      ;; Run hooks before we leave buffer for editing.  Reasonable usage
+      ;; might be to set up special key bindings, replace standart
+      ;; functions in mail-mode, etc.
+      (run-hooks 'mail-setup-hook 'uce-setup-hook))))
+
 (defun uce-insert-ranting (&optional ignored)
   "Insert text of the usual reply to UCE into current buffer."
   (interactive "P")