1 ;;; mailalias.el --- expand and complete mailing address aliases
3 ;; Copyright (C) 1985, 1987, 1995, 1996, 1997, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Basic functions for defining and expanding mail aliases.
27 ;; These seal off the interface to the alias-definition parts of a
28 ;; .mailrc file formatted for BSD's Mail or USL's mailx.
34 (defgroup mailalias nil
35 "Expanding mail aliases."
38 (defcustom mail-passwd-files
'("/etc/passwd")
39 "*List of files from which to determine valid user names."
40 :type
'(repeat string
)
43 (defcustom mail-passwd-command nil
44 "*Shell command to retrieve text to add to `/etc/passwd', or nil."
45 :type
'(choice string
(const nil
))
48 (defvar mail-directory-names t
49 "Alist of mail address directory entries.
50 When t this still needs to be initialized.")
52 (defvar mail-address-field-regexp
53 "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):")
55 (defcustom mail-complete-alist
56 ;; Don't use backquote here; we don't want backquote to get loaded
57 ;; just because of loading this file.
58 ;; Don't refer to mail-address-field-regexp here;
59 ;; that confuses some things such as cus-dep.el.
60 (cons '("^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):"
61 .
(mail-get-names pattern
))
62 '(("Newsgroups:" .
(if (boundp 'gnus-active-hashtb
)
64 (if (boundp news-group-article-assoc
)
65 news-group-article-assoc
)))
66 ("Followup-To:" .
(mail-sentto-newsgroups))
67 ;;("Distribution:" ???)
69 "*Alist of header field and expression to return alist for completion.
70 The expression may reference the variable `pattern'
71 which will hold the string being completed.
72 If not on matching header, `mail-complete-function' gets called instead."
75 (put 'mail-complete-alist
'risky-local-variable t
)
78 (defcustom mail-complete-style
'angles
79 "*Specifies how \\[mail-complete] formats the full name when it completes.
80 If `nil', they contain just the return address like:
82 If `parens', they look like:
83 king@grassland.com (Elvis Parsley)
84 If `angles', they look like:
85 Elvis Parsley <king@grassland.com>"
86 :type
'(choice (const angles
) (const parens
) (const nil
))
89 (defcustom mail-complete-function
'ispell-complete-word
90 "*Function to call when completing outside `mail-complete-alist'-header."
91 :type
'(choice function
(const nil
))
94 (defcustom mail-directory-function nil
95 "*Function to get completions from directory service or nil for none.
96 See `mail-directory-requery'."
97 :type
'(choice function
(const nil
))
100 ;; This is for when the directory is huge, or changes frequently.
101 (defcustom mail-directory-requery nil
102 "*When non-nil call `mail-directory-function' for each completion.
103 In that case, one argument gets passed to the function, the partial string
108 (defcustom mail-directory-process nil
109 "*Shell command to get the list of names from a mail directory.
110 This value is used when the value of `mail-directory-function'
111 is `mail-directory-process'. The value should be a list
112 of the form (COMMAND ARG ...), where each of the list elements
113 is evaluated. COMMAND should evaluate to a string. When
114 `mail-directory-requery' is non-nil, during evaluation of these
115 elements, the variable `pattern' contains the partial input being
116 completed. `pattern' is nil when `mail-directory-requery' is nil.
118 The value might look like this:
120 '(remote-shell-program \"HOST\" \"-nl\" \"USER\" \"COMMAND\")
124 '(remote-shell-program \"HOST\" \"-n\" \"COMMAND '^\" pattern \"'\")"
127 (put 'mail-directory-process
'risky-local-variable t
)
129 (defcustom mail-directory-stream nil
130 "*List of (HOST SERVICE) for stream connection to mail directory."
133 (put 'mail-directory-stream
'risky-local-variable t
)
135 (defcustom mail-directory-parser nil
136 "*How to interpret the output of `mail-directory-function'.
137 Three types of values are possible:
139 - nil means to gather each line as one name
140 - regexp means first \\(grouping\\) in successive matches is name
141 - function called at beginning of buffer that returns an alist of names"
142 :type
'(choice (const nil
) regexp function
)
144 (put 'mail-directory-parser
'risky-local-variable t
)
146 ;; Internal variables.
149 "Alist of local users, aliases and directory entries as available.
150 Elements have the form (MAILNAME) or (MAILNAME . FULLNAME).
151 If the value means t, it means the real value should be calculated
152 for the next use. This is used in `mail-complete'.")
154 (defvar mail-local-names t
155 "Alist of local users.
156 When t this still needs to be initialized.")
159 ;; Called from sendmail-send-it, or similar functions,
160 ;; only if some mail aliases are defined.
162 (defun expand-mail-aliases (beg end
&optional exclude
)
163 "Expand all mail aliases in suitable header fields found between BEG and END.
164 If interactive, expand in header fields.
165 Suitable header fields are `To', `From', `CC' and `BCC', `Reply-to', and
166 their `Resent-' variants.
168 Optional second arg EXCLUDE may be a regular expression defining text to be
169 removed from alias expansions."
172 (list (goto-char (point-min))
174 (sendmail-sync-aliases)
175 (when (eq mail-aliases t
)
176 (setq mail-aliases nil
)
177 (build-mail-aliases))
180 (setq end
(set-marker (make-marker) end
))
181 (let ((case-fold-search nil
))
182 (while (let ((case-fold-search t
))
183 (re-search-forward mail-address-field-regexp end t
))
184 (skip-chars-forward " \t")
187 ;; DISABLED-ALIASES records aliases temporarily disabled
188 ;; while we scan text that resulted from expanding those aliases.
189 ;; Each element is (ALIAS . TILL-WHEN), where TILL-WHEN
190 ;; is where to reenable the alias (expressed as number of chars
191 ;; counting from END1).
192 (disabled-aliases nil
))
193 (re-search-forward "^[^ \t]" end
'move
)
195 (skip-chars-backward " \t\n")
196 (setq end1
(point-marker))
198 (while (< (point) end1
)
200 ;; Reenable any aliases which were disabled for ranges
201 ;; that we have passed out of.
202 (while (and disabled-aliases
203 (> pos
(- end1
(cdr (car disabled-aliases
)))))
204 (setq disabled-aliases
(cdr disabled-aliases
)))
205 ;; EPOS gets position of end of next name;
206 ;; SEPLEN gets length of whitespace&separator that follows it.
207 (if (re-search-forward "[ \t]*[\n,][ \t]*" end1 t
)
208 (setq epos
(match-beginning 0)
209 seplen
(- (point) epos
))
210 (setq epos
(marker-position end1
) seplen
0))
211 (let ((string (buffer-substring-no-properties pos epos
))
213 (if (and (not (assoc string disabled-aliases
))
214 (setq translation
(cdr (assoc string mail-aliases
))))
216 ;; This name is an alias. Disable it.
217 (setq disabled-aliases
(cons (cons string
(- end1 epos
))
219 ;; Replace the alias with its expansion
220 ;; then rescan the expansion for more aliases.
224 (let ((regexp (concat "\\b\\(" exclude
"\\)\\b"))
225 (end (point-marker)))
227 (while (re-search-forward regexp end t
)
230 (delete-region (point) (+ (point) (- epos pos
)))
232 ;; Name is not an alias. Skip to start of next name.
234 (forward-char seplen
))))
235 (set-marker end1 nil
)))
236 (set-marker end nil
))))
238 ;; Called by mail-setup, or similar functions, only if the file specified
239 ;; by mail-personal-alias-file (usually `~/.mailrc') exists.
240 (defun build-mail-aliases (&optional file
)
241 "Read mail aliases from personal aliases file and set `mail-aliases'.
242 By default, this is the file specified by `mail-personal-alias-file'."
243 (setq file
(expand-file-name (or file mail-personal-alias-file
)))
244 ;; In case mail-aliases is t, make sure define-mail-alias
245 ;; does not recursively call build-mail-aliases.
246 (setq mail-aliases nil
)
248 (obuf (current-buffer)))
251 (setq buffer
(generate-new-buffer " mailrc"))
254 (cond ((get-file-buffer file
)
255 (insert (save-excursion
256 (set-buffer (get-file-buffer file
))
257 (buffer-substring-no-properties
258 (point-min) (point-max)))))
259 ((file-exists-p file
) (insert-file-contents file
))
260 ((file-exists-p (setq file
(concat "~/" file
)))
261 (insert-file-contents file
))
263 (goto-char (point-min))
264 ;; Delete comments from the contents.
265 (while (search-forward "# " nil t
)
266 (let ((p (- (point) 2)))
268 (delete-region p
(point))))
269 ;; Don't lose if no final newline.
270 (goto-char (point-max))
271 (or (eq (preceding-char) ?
\n) (newline))
272 (goto-char (point-min))
273 ;; handle "\\\n" continuation lines
276 (if (= (preceding-char) ?
\\)
277 (progn (delete-char -
1) (delete-char 1) (insert ?\
))
279 (goto-char (point-min))
280 ;; handle `source' directives -- Eddy/1994/May/25
281 (cond ((re-search-forward "^source[ \t]+" nil t
)
282 (re-search-forward "\\S-+")
283 (setq file
(buffer-substring-no-properties
284 (match-beginning 0) (match-end 0)))
286 (insert "# ") ; to ensure we don't re-process this file
288 (t (setq file nil
))))
289 (goto-char (point-min))
290 (while (re-search-forward
291 "^\\(a\\|alias\\|g\\|group\\)[ \t]+\\([^ \t\n]+\\)" nil t
)
292 (let* ((name (match-string 2))
293 (start (progn (skip-chars-forward " \t") (point)))
296 (setq value
(buffer-substring-no-properties start
(point)))
297 (unless (equal value
"")
298 (define-mail-alias name value t
))))
300 (if buffer
(kill-buffer buffer
))
303 ;; Always autoloadable in case the user wants to define aliases
304 ;; interactively or in .emacs.
306 (defun define-mail-alias (name definition
&optional from-mailrc-file
)
307 "Define NAME as a mail alias that translates to DEFINITION.
308 This means that sending a message to NAME will actually send to DEFINITION.
310 Normally, the addresses in DEFINITION must be separated by commas.
311 If FROM-MAILRC-FILE is non-nil, then addresses in DEFINITION
312 can be separated by spaces; an address can contain spaces
313 if it is quoted with double-quotes."
315 (interactive "sDefine mail alias: \nsDefine %s as mail alias for: ")
316 ;; Read the defaults first, if we have not done so.
317 ;; But not if we are doing that already right now.
318 (unless from-mailrc-file
319 (sendmail-sync-aliases))
320 (if (eq mail-aliases t
)
322 (setq mail-aliases nil
)
323 (if (file-exists-p mail-personal-alias-file
)
324 (build-mail-aliases))))
325 ;; strip garbage from front and end
326 (if (string-match "\\`[ \t\n,]+" definition
)
327 (setq definition
(substring definition
(match-end 0))))
328 (if (string-match "[ \t\n,]+\\'" definition
)
329 (setq definition
(substring definition
0 (match-beginning 0))))
331 ;; If DEFINITION is null string, avoid looping even once.
332 (start (and (not (equal definition
"")) 0))
333 (L (length definition
))
337 (setq convert-backslash nil
)
338 ;; If we're reading from the mailrc file, then addresses are delimited
339 ;; by spaces, and addresses with embedded spaces must be surrounded by
340 ;; double-quotes. Otherwise, addresses are separated by commas.
342 (if (eq ?
\" (aref definition start
))
343 ;; The following test on `found' compensates for a bug
344 ;; in match-end, which does not return nil when match
346 (let ((found (string-match "[^\\]\\(\\([\\][\\]\\)*\\)\"[ \t,]*"
348 (setq start
(1+ start
)
349 end
(and found
(match-end 1))
350 convert-backslash t
))
351 (setq end
(string-match "[ \t,]+" definition start
)))
352 (setq end
(string-match "[ \t\n,]*,[ \t\n,]*" definition start
)))
353 (let ((temp (substring definition start end
))
358 (if convert-backslash
359 (while (string-match "[\\]" temp pos
)
360 (setq temp
(replace-match "" t t temp
))
362 (setq start
(1- start
)))
363 (setq pos
(match-end 0))))
364 (setq result
(cons temp result
))))
365 (setq definition
(mapconcat (function identity
)
368 (setq tem
(assoc name mail-aliases
))
370 (rplacd tem definition
)
371 (setq mail-aliases
(cons (cons name definition
) mail-aliases
)
375 (defun mail-complete (arg)
376 "Perform completion on header field or word preceding point.
377 Completable headers are according to `mail-complete-alist'. If none matches
378 current header, calls `mail-complete-function' and passes prefix arg if any."
380 ;; Read the defaults first, if we have not done so.
381 (sendmail-sync-aliases)
382 (if (eq mail-aliases t
)
384 (setq mail-aliases nil
)
385 (if (file-exists-p mail-personal-alias-file
)
386 (build-mail-aliases))))
387 (let ((list mail-complete-alist
))
388 (if (and (< 0 (mail-header-end))
390 (if (re-search-backward "^[^\t]" nil t
)
392 (if (looking-at (car (car list
)))
393 (setq arg
(cdr (car list
))
395 (setq list
(cdr list
)))))
399 (skip-chars-backward "^ \t<,:")
401 (pattern (buffer-substring beg end
))
403 (setq list
(eval arg
)
404 completion
(try-completion pattern list
))
405 (cond ((eq completion t
))
407 (message "Can't find completion for \"%s\"" pattern
)
409 ((not (string= pattern completion
))
410 (delete-region beg end
)
411 (let ((alist-elt (assoc completion mail-names
)))
413 (cond ((eq mail-complete-style
'parens
)
414 (insert completion
" (" (cdr alist-elt
) ")"))
415 ((eq mail-complete-style
'angles
)
416 (insert (cdr alist-elt
) " <" completion
">"))
418 (insert completion
)))
419 (insert completion
))))
421 (message "Making completion list...")
422 (with-output-to-temp-buffer "*Completions*"
423 (display-completion-list
424 (all-completions pattern list
)))
425 (message "Making completion list...%s" "done"))))
426 (funcall mail-complete-function arg
))))
428 (defun mail-get-names (pattern)
429 "Fetch local users and global mail addresses for completion.
430 Consults `/etc/passwd' and a directory service if one is set up via
431 `mail-directory-function'.
432 PATTERN is the string we want to complete."
433 (if (eq mail-local-names t
)
435 (set-buffer (generate-new-buffer " passwd"))
436 (let ((files mail-passwd-files
))
438 (insert-file-contents (car files
) nil nil nil t
)
439 (setq files
(cdr files
))))
440 (if mail-passwd-command
441 (call-process shell-file-name nil t nil
442 shell-command-switch mail-passwd-command
))
443 (goto-char (point-min))
444 (setq mail-local-names nil
)
446 ;;Recognize lines like
447 ;; nobody:*:65534:65534::/:
448 ;; +demo::::::/bin/csh
452 ;; The second \(...\) matches the user id.
453 (if (looking-at "\\+?\\([^:@\n+]+\\):[^:\n]*:\\([^\n:]*\\):")
454 (add-to-list 'mail-local-names
455 (cons (match-string 1)
457 (string-to-number (match-string 2))))))
458 (beginning-of-line 2))
459 (kill-buffer (current-buffer))))
460 (if (or (eq mail-names t
)
461 (eq mail-directory-names t
))
463 (and mail-directory-function
464 (eq mail-directory-names t
)
466 (mail-directory (if mail-directory-requery pattern
))))
467 (or mail-directory-requery
468 (setq mail-directory-names directory
))
472 (sort (append (if (consp mail-aliases
)
474 (function (lambda (a) (list (car a
))))
476 (if (consp mail-local-names
)
479 (when (consp mail-directory-names
)
480 mail-directory-names
)))
482 ;; should cache downcased strings
483 (string< (downcase (car a
))
484 (downcase (car b
)))))))))
488 (defun mail-directory (pattern)
489 "Use mail-directory facility to get user names matching PATTERN.
490 If PATTERN is nil, get all the defined user names.
491 This function calls `mail-directory-function' to query the directory,
492 then uses `mail-directory-parser' to parse the output it returns."
494 (message "Querying directory...")
495 (set-buffer (generate-new-buffer " *mail-directory*"))
496 (funcall mail-directory-function pattern
)
499 (if (stringp mail-directory-parser
)
500 (while (re-search-forward mail-directory-parser nil t
)
502 (cons (match-string 1) directory
)))
503 (if mail-directory-parser
504 (setq directory
(funcall mail-directory-parser
))
507 (cons (buffer-substring (point)
514 (kill-buffer (current-buffer))
515 (message "Querying directory...done")
519 (defun mail-directory-process (pattern)
520 "Run a shell command to output names in directory.
521 See `mail-directory-process'."
522 (when (consp mail-directory-process
)
523 (apply 'call-process
(eval (car mail-directory-process
)) nil t nil
524 (mapcar 'eval
(cdr mail-directory-process
)))))
526 ;; This should handle a dialog. Currently expects port to spit out names.
527 (defun mail-directory-stream (pattern)
528 "Open a stream to retrieve names in directory.
529 See `mail-directory-stream'."
530 (let (mailalias-done)
531 (set-process-sentinel
532 (apply 'open-network-stream
"mailalias" (current-buffer)
533 mail-directory-stream
)
535 (setq mailalias-done t
)))
536 (while (not mailalias-done
)
539 (defun mail-sentto-newsgroups ()
540 "Return all entries from Newsgroups: header as completion alist."
542 (if (mail-position-on-field "newsgroups" t
)
543 (let ((point (point))
545 (while (< (skip-chars-backward "^:, \t\n") 0)
546 (setq list
`((,(buffer-substring (point) point
))
548 (skip-chars-backward ", \t\n")
549 (setq point
(point)))
554 ;; arch-tag: 1d6a0f87-eb34-4d45-8816-60c1b952cf46
555 ;;; mailalias.el ends here