Trailing whitepace deleted.
[bpt/emacs.git] / lisp / mail / mailalias.el
index e653c0e..0e22538 100644 (file)
 
 (require 'sendmail)
 
-(defvar mail-names t
-  "Alist of local users, aliases and directory entries as available.
-Elements have the form (MAILNAME) or (MAILNAME . FULLNAME).
-If the value means t, it means the real value should be calculated
-for the next use.  this is used in `mail-complete'.")
+(defgroup mailalias nil
+  "Expanding mail aliases"
+  :group 'mail)
 
-(defvar mail-local-names t
-  "Alist of local users.
-When t this still needs to be initialized.")
-
-(defvar mail-passwd-files '("/etc/passwd")
-  "List of files from which to determine valid user names.")
+(defcustom mail-passwd-files '("/etc/passwd")
+  "*List of files from which to determine valid user names."
+  :type '(repeat string)
+  :group 'mailalias)
 
-(defvar mail-passwd-command nil
-  "Shell command to retrieve text to add to `/etc/passwd', or nil.")
+(defcustom mail-passwd-command nil
+  "*Shell command to retrieve text to add to `/etc/passwd', or nil."
+  :type '(choice string (const nil))
+  :group 'mailalias)
 
 (defvar mail-directory-names t
   "Alist of mail address directory entries.
@@ -55,141 +53,187 @@ When t this still needs to be initialized.")
 (defvar mail-address-field-regexp
   "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):")
 
-(defvar mail-complete-alist
-  `((,mail-address-field-regexp mail-get-names pattern)
-    ("Newsgroups:" . (if (boundp 'gnus-active-hashtb)
-                        gnus-active-hashtb
-                      (if (boundp news-group-article-assoc)
-                          news-group-article-assoc)))
-    ("Followup-To:" . (mail-sentto-newsgroups))
-    ;;("Distribution:" ???)
-    )
-  "Alist of header field and expression to return alist for completion.
-Expression may reference variable `pattern' which is the string being completed.
-If not on matching header, `mail-complete-function' gets called instead.")
+(defcustom mail-complete-alist
+  ;; Don't use backquote here; we don't want backquote to get loaded
+  ;; just because of loading this file.
+  ;; Don't refer to mail-address-field-regexp here;
+  ;; that confuses some things such as cus-dep.el.
+  (cons '("^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):"
+         . (mail-get-names pattern))
+       '(("Newsgroups:" . (if (boundp 'gnus-active-hashtb)
+                              gnus-active-hashtb
+                            (if (boundp news-group-article-assoc)
+                                news-group-article-assoc)))
+         ("Followup-To:" . (mail-sentto-newsgroups))
+         ;;("Distribution:" ???)
+         ))
+  "*Alist of header field and expression to return alist for completion.
+The expression may reference the variable `pattern'
+which will hold the string being completed.
+If not on matching header, `mail-complete-function' gets called instead."
+  :type 'alist
+  :group 'mailalias)
+(put 'mail-complete-alist 'risky-local-variable t)
 
 ;;;###autoload
-(defvar mail-complete-style 'angles
+(defcustom mail-complete-style 'angles
   "*Specifies how \\[mail-complete] formats the full name when it completes.
 If `nil', they contain just the return address like:
        king@grassland.com
 If `parens', they look like:
        king@grassland.com (Elvis Parsley)
 If `angles', they look like:
-       Elvis Parsley <king@grassland.com>")
-
-(defvar mail-complete-function 'ispell-complete-word
-  "Function to call when completing outside `mail-complete-alist'-header.")
+       Elvis Parsley <king@grassland.com>"
+  :type '(choice (const angles) (const parens) (const nil))
+  :group 'mailalias)
 
+(defcustom mail-complete-function 'ispell-complete-word
+  "*Function to call when completing outside `mail-complete-alist'-header."
+  :type '(choice function (const nil))
+  :group 'mailalias)
 
-(defvar mail-directory-function nil
-  "Function to get completions from directory service or `nil' for none.
-See `mail-directory-requery'.")
-
+(defcustom mail-directory-function nil
+  "*Function to get completions from directory service or `nil' for none.
+See `mail-directory-requery'."
+  :type '(choice function (const nil))
+  :group 'mailalias)
 
 ;; This is for when the directory is huge, or changes frequently.
-(defvar mail-directory-requery nil
-  "When non-`nil' call `mail-directory-function' for each completion.
+(defcustom mail-directory-requery nil
+  "*When non-`nil' call `mail-directory-function' for each completion.
 In that case, one argument gets passed to the function, the partial string
-entered so far.")
+entered so far."
+  :type 'boolean
+  :group 'mailalias)
 
+(defcustom mail-directory-process nil
+  "*Shell command to get the list of names from a mail directory.
+This value is used when the value of `mail-directory-function'
+is `mail-directory-process'.  The value should be a list
+of the form (COMMAND ARG ...), where each of the list elements
+is evaluated.  When `mail-directory-requery' is non-nil, during
+evaluation of these elements, the variable `pattern' contains
+the partial input being completed.
 
-(defvar mail-directory-process nil
-  "Unix command when `mail-directory-function' is `mail-directory-process'.
-This is a list of the form (COMMAND ARG ...), where each of the list elements
-is evaluated.  When `mail-directory-requery' is non-`nil', during
-evaluation the variable `pattern' contains the partial input being completed.
-This might look like
+The value might look like this:
 
   '(remote-shell-program \"HOST\" \"-nl\" \"USER\" \"COMMAND\")
 
-or
+or like this:
 
-  '(remote-shell-program \"HOST\" \"-n\" \"COMMAND '^\" pattern \"'\")")
+  '(remote-shell-program \"HOST\" \"-n\" \"COMMAND '^\" pattern \"'\")"
+  :type 'sexp
+  :group 'mailalias)
+(put 'mail-directory-process 'risky-local-variable t)
 
-(defvar mail-directory-stream ()
-  "List of (HOST SERVICE) for stream connection to mail directory.")
+(defcustom mail-directory-stream nil
+  "*List of (HOST SERVICE) for stream connection to mail directory."
+  :type 'sexp
+  :group 'mailalias)
+(put 'mail-directory-stream 'risky-local-variable t)
 
-(defvar mail-directory-parser nil
-  "How to interpret the output of `mail-directory-function'.
+(defcustom mail-directory-parser nil
+  "*How to interpret the output of `mail-directory-function'.
 Three types of values are possible:
 
   - nil means to gather each line as one name
   - regexp means first \\(grouping\\) in successive matches is name
-  - function called at beginning of buffer that returns an alist of names")
+  - function called at beginning of buffer that returns an alist of names"
+  :type '(choice (const nil) regexp function)
+  :group 'mailalias)
+(put 'mail-directory-parser 'risky-local-variable t)
 
+;; Internal variables.
+
+(defvar mail-names t
+  "Alist of local users, aliases and directory entries as available.
+Elements have the form (MAILNAME) or (MAILNAME . FULLNAME).
+If the value means t, it means the real value should be calculated
+for the next use.  this is used in `mail-complete'.")
+
+(defvar mail-local-names t
+  "Alist of local users.
+When t this still needs to be initialized.")
+\f
 
 ;; Called from sendmail-send-it, or similar functions,
 ;; only if some mail aliases are defined.
+;;;###autoload
 (defun expand-mail-aliases (beg end &optional exclude)
   "Expand all mail aliases in suitable header fields found between BEG and END.
+If interactive, expand in header fields.
 Suitable header fields are `To', `From', `CC' and `BCC', `Reply-to', and
 their `Resent-' variants.
 
 Optional second arg EXCLUDE may be a regular expression defining text to be
 removed from alias expansions."
+  (interactive
+   (save-excursion
+     (list (goto-char (point-min))
+          (mail-header-end))))
   (sendmail-sync-aliases)
-  (if (eq mail-aliases t)
-      (progn (setq mail-aliases nil) (build-mail-aliases)))
-  (goto-char beg)
-  (setq end (set-marker (make-marker) end))
-  (let ((case-fold-search nil))
-    (while (let ((case-fold-search t))
-            (re-search-forward mail-address-field-regexp end t))
-      (skip-chars-forward " \t")
-      (let ((beg1 (point))
-           end1 pos epos seplen
-           ;; DISABLED-ALIASES records aliases temporarily disabled
-           ;; while we scan text that resulted from expanding those aliases.
-           ;; Each element is (ALIAS . TILL-WHEN), where TILL-WHEN
-           ;; is where to reenable the alias (expressed as number of chars
-           ;; counting from END1).
-           (disabled-aliases nil))
-       (re-search-forward "^[^ \t]" end 'move)
-       (beginning-of-line)
-       (skip-chars-backward " \t\n")
-       (setq end1 (point-marker))
-       (goto-char beg1)
-       (while (< (point) end1)
-         (setq pos (point))
-         ;; Reenable any aliases which were disabled for ranges
-         ;; that we have passed out of.
-         (while (and disabled-aliases (> pos (- end1 (cdr (car disabled-aliases)))))
-           (setq disabled-aliases (cdr disabled-aliases)))
-         ;; EPOS gets position of end of next name;
-         ;; SEPLEN gets length of whitespace&separator that follows it.
-         (if (re-search-forward "[ \t]*[\n,][ \t]*" end1 t)
-             (setq epos (match-beginning 0)
-                   seplen (- (point) epos))
-           (setq epos (marker-position end1) seplen 0))
-         (let (translation
-               (string (buffer-substring-no-properties pos epos)))
-           (if (and (not (assoc string disabled-aliases))
-                    (setq translation
-                          (cdr (assoc string mail-aliases))))
-               (progn
-                 ;; This name is an alias.  Disable it.
-                 (setq disabled-aliases (cons (cons string (- end1 epos))
-                                              disabled-aliases))
-                 ;; Replace the alias with its expansion
-                 ;; then rescan the expansion for more aliases.
-                 (goto-char pos)
-                 (insert translation)
-                 (if exclude
-                     (let ((regexp
-                            (concat "\\b\\(" exclude "\\)\\b"))
+  (when (eq mail-aliases t)
+    (setq mail-aliases nil)
+    (build-mail-aliases))
+  (save-excursion
+    (goto-char beg)
+    (setq end (set-marker (make-marker) end))
+    (let ((case-fold-search nil))
+      (while (let ((case-fold-search t))
+              (re-search-forward mail-address-field-regexp end t))
+       (skip-chars-forward " \t")
+       (let ((beg1 (point))
+             end1 pos epos seplen
+             ;; DISABLED-ALIASES records aliases temporarily disabled
+             ;; while we scan text that resulted from expanding those aliases.
+             ;; Each element is (ALIAS . TILL-WHEN), where TILL-WHEN
+             ;; is where to reenable the alias (expressed as number of chars
+             ;; counting from END1).
+             (disabled-aliases nil))
+         (re-search-forward "^[^ \t]" end 'move)
+         (beginning-of-line)
+         (skip-chars-backward " \t\n")
+         (setq end1 (point-marker))
+         (goto-char beg1)
+         (while (< (point) end1)
+           (setq pos (point))
+           ;; Reenable any aliases which were disabled for ranges
+           ;; that we have passed out of.
+           (while (and disabled-aliases
+                       (> pos (- end1 (cdr (car disabled-aliases)))))
+             (setq disabled-aliases (cdr disabled-aliases)))
+           ;; EPOS gets position of end of next name;
+           ;; SEPLEN gets length of whitespace&separator that follows it.
+           (if (re-search-forward "[ \t]*[\n,][ \t]*" end1 t)
+               (setq epos (match-beginning 0)
+                     seplen (- (point) epos))
+             (setq epos (marker-position end1) seplen 0))
+           (let ((string (buffer-substring-no-properties pos epos))
+                 translation)
+             (if (and (not (assoc string disabled-aliases))
+                      (setq translation (cdr (assoc string mail-aliases))))
+                 (progn
+                   ;; This name is an alias.  Disable it.
+                   (setq disabled-aliases (cons (cons string (- end1 epos))
+                                                disabled-aliases))
+                   ;; Replace the alias with its expansion
+                   ;; then rescan the expansion for more aliases.
+                   (goto-char pos)
+                   (insert translation)
+                   (when exclude
+                     (let ((regexp (concat "\\b\\(" exclude "\\)\\b"))
                            (end (point-marker)))
                        (goto-char pos)
                        (while (re-search-forward regexp end t)
                          (replace-match ""))
                        (goto-char end)))
-                 (delete-region (point) (+ (point) (- epos pos)))
-                 (goto-char pos))
-             ;; Name is not an alias.  Skip to start of next name.
-             (goto-char epos)
-             (forward-char seplen))))
-       (set-marker end1 nil)))
-    (set-marker end nil)))
+                   (delete-region (point) (+ (point) (- epos pos)))
+                   (goto-char pos))
+               ;; Name is not an alias.  Skip to start of next name.
+               (goto-char epos)
+               (forward-char seplen))))
+         (set-marker end1 nil)))
+      (set-marker end nil))))
 
 ;; Called by mail-setup, or similar functions, only if the file specified
 ;; by mail-personal-alias-file (usually `~/.mailrc') exists.
@@ -197,6 +241,9 @@ removed from alias expansions."
   "Read mail aliases from personal aliases file and set `mail-aliases'.
 By default, this is the file specified by `mail-personal-alias-file'."
   (setq file (expand-file-name (or file mail-personal-alias-file)))
+  ;; In case mail-aliases is t, make sure define-mail-alias
+  ;; does not recursively call build-mail-aliases.
+  (setq mail-aliases nil)
   (let ((buffer nil)
        (obuf (current-buffer)))
     (unwind-protect
@@ -235,14 +282,14 @@ By default, this is the file specified by `mail-personal-alias-file'."
                  (t (setq file nil))))
          (goto-char (point-min))
          (while (re-search-forward
-                 "^\\(a\\|alias\\|g\\|group\\)[ \t]+\\([^ \t]+\\)" nil t)
+                 "^\\(a\\|alias\\|g\\|group\\)[ \t]+\\([^ \t\n]+\\)" nil t)
            (let* ((name (match-string 2))
-                  (start (progn (skip-chars-forward " \t") (point))))
+                  (start (progn (skip-chars-forward " \t") (point)))
+                  value)
              (end-of-line)
-             (define-mail-alias
-               name
-               (buffer-substring-no-properties start (point))
-               t)))
+             (setq value (buffer-substring-no-properties start (point)))
+             (unless (equal value "")
+               (define-mail-alias name value t))))
          mail-aliases)
       (if buffer (kill-buffer buffer))
       (set-buffer obuf))))
@@ -255,13 +302,15 @@ By default, this is the file specified by `mail-personal-alias-file'."
 This means that sending a message to NAME will actually send to DEFINITION.
 
 Normally, the addresses in DEFINITION must be separated by commas.
-If FROM-MAILRC-FILE is non-nil, then addresses in DEFINITION 
+If FROM-MAILRC-FILE is non-nil, then addresses in DEFINITION
 can be separated by spaces; an address can contain spaces
 if it is quoted with double-quotes."
 
   (interactive "sDefine mail alias: \nsDefine %s as mail alias for: ")
   ;; Read the defaults first, if we have not done so.
-  (sendmail-sync-aliases)
+  ;; But not if we are doing that already right now.
+  (unless from-mailrc-file
+    (sendmail-sync-aliases))
   (if (eq mail-aliases t)
       (progn
        (setq mail-aliases nil)
@@ -276,21 +325,37 @@ if it is quoted with double-quotes."
        ;; If DEFINITION is null string, avoid looping even once.
        (start (and (not (equal definition "")) 0))
        (L (length definition))
+       convert-backslash
        end tem)
     (while start
+      (setq convert-backslash nil)
       ;; If we're reading from the mailrc file, then addresses are delimited
       ;; by spaces, and addresses with embedded spaces must be surrounded by
       ;; double-quotes.  Otherwise, addresses are separated by commas.
       (if from-mailrc-file
          (if (eq ?\" (aref definition start))
-             (setq start (1+ start)
-                   end (string-match "\"[ \t,]*" definition start))
+             ;; The following test on `found' compensates for a bug
+             ;; in match-end, which does not return nil when match
+             ;; failed.
+             (let ((found (string-match "[^\\]\\(\\([\\][\\]\\)*\\)\"[ \t,]*"
+                                        definition start)))
+               (setq start (1+ start)
+                     end (and found (match-end 1))
+                     convert-backslash t))
            (setq end (string-match "[ \t,]+" definition start)))
        (setq end (string-match "[ \t\n,]*,[ \t\n,]*" definition start)))
-      (setq result (cons (substring definition start end) result))
-      (setq start (and end
-                      (/= (match-end 0) L)
-                      (match-end 0))))
+      (let ((temp (substring definition start end))
+           (pos 0))
+       (setq start (and end
+                        (/= (match-end 0) L)
+                        (match-end 0)))
+       (if convert-backslash
+           (while (string-match "[\\]" temp pos)
+             (setq temp (replace-match "" t t temp))
+             (if start
+                 (setq start (1- start)))
+             (setq pos (match-end 0))))
+       (setq result (cons temp result))))
     (setq definition (mapconcat (function identity)
                                (nreverse result)
                                ", "))
@@ -314,9 +379,7 @@ current header, calls `mail-complete-function' and passes prefix arg if any."
        (if (file-exists-p mail-personal-alias-file)
            (build-mail-aliases))))
   (let ((list mail-complete-alist))
-    (if (and (save-excursion (search-forward
-                             (concat "\n" mail-header-separator "\n")
-                             nil t))
+    (if (and (< 0 (mail-header-end))
             (save-excursion
               (if (re-search-backward "^[^\t]" nil t)
                   (while list
@@ -444,7 +507,7 @@ Calls `mail-directory-function' and applies `mail-directory-parser' to output."
 
 
 (defun mail-directory-process (pattern)
-  "Call a Unix process to output names in directory.
+  "Run a shell command to output names in directory.
 See `mail-directory-process'."
   (apply 'call-process (eval (car mail-directory-process)) nil t nil
         (mapcar 'eval (cdr mail-directory-process))))
@@ -457,7 +520,7 @@ See `mail-directory-stream'."
     (set-process-sentinel
      (apply 'open-network-stream "mailalias" (current-buffer)
            mail-directory-stream)
-     (lambda (x x)
+     (lambda (x y)
        (setq mailalias-done t)))
     (while (not mailalias-done)
       (sit-for .1))))