Docstrings fixes.
[emacs.git] / lisp / mail / mh-utils.el
blob5b89c54cf30caf63fe45b4727dadd5ca6dc4c409
1 ;;; mh-utils.el --- mh-e code needed for both sending and reading
2 ;; Time-stamp: <95/10/22 17:58:16 gildea>
4 ;; Copyright (C) 1993, 1995, 1997 Free Software Foundation, Inc.
6 ;; This file is part of mh-e, part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
23 ;;; Commentary:
25 ;; Internal support for mh-e package.
27 ;;; Code:
29 ;;; Set for local environment:
30 ;;; mh-progs and mh-lib used to be set in paths.el, which tried to
31 ;;; figure out at build time which of several possible directories MH
32 ;;; was installed into. But if you installed MH after building Emacs,
33 ;;; this would almost certainly be wrong, so now we do it at run time.
35 (defvar mh-progs nil
36 "Directory containing MH commands, such as inc, repl, and rmm.")
38 (defvar mh-lib nil
39 "Directory containing the MH library.
40 This directory contains, among other things,
41 the components file.")
43 (defvar mh-lib-progs nil
44 "Directory containing MH helper programs.
45 This directory contains, among other things,
46 the mhl program.")
48 (defvar mh-nmh-p nil
49 "Non-nil if nmh is installed on this system instead of MH")
51 ;;;###autoload
52 (put 'mh-progs 'risky-local-variable t)
53 ;;;###autoload
54 (put 'mh-lib 'risky-local-variable t)
55 ;;;###autoload
56 (put 'mh-lib-progs 'risky-local-variable t)
57 ;;;###autoload
58 (put 'mh-nmh-p 'risky-local-variable t)
60 ;;; User preferences:
62 (defgroup mh-buffer nil
63 "Layout of MH-E buffers"
64 :prefix "mh-"
65 :group 'mh)
68 (defcustom mh-auto-folder-collect t
69 "*Whether to start collecting MH folder names immediately in the background.
70 Non-nil means start a background process collecting the names of all
71 folders as soon as mh-e is loaded."
72 :type 'boolean
73 :group 'mh)
75 (defcustom mh-recursive-folders nil
76 "*If non-nil, then commands which operate on folders do so recursively."
77 :type 'boolean
78 :group 'mh)
80 (defcustom mh-clean-message-header nil
81 "*Non-nil means clean headers of messages that are displayed or inserted.
82 The variables `mh-visible-headers' and `mh-invisible-headers' control what
83 is removed."
84 :type 'boolean
85 :group 'mh-buffer)
87 (defcustom mh-visible-headers nil
88 "*If non-nil, contains a regexp specifying the headers to keep when cleaning.
89 Only used if `mh-clean-message-header' is non-nil. Setting this variable
90 overrides `mh-invisible-headers'."
91 :type '(choice (const nil) regexp)
92 :group 'mh-buffer)
94 (defvar mh-invisible-headers
95 "^Received: \\|^Message-Id: \\|^Remailed-\\|^Via: \\|^Mail-from: \\|^Return-Path: \\|^Delivery-Date: \\|^In-Reply-To: \\|^Resent-"
96 "Regexp matching lines in a message header that are not to be shown.
97 If `mh-visible-headers' is non-nil, it is used instead to specify what
98 to keep.")
100 (defcustom mh-bury-show-buffer t
101 "*Non-nil means that the displayed show buffer for a folder is buried."
102 :type 'boolean
103 :group 'mh-buffer)
105 (defcustom mh-summary-height 4
106 "*Number of lines in MH-Folder window (including the mode line)."
107 :type 'integer
108 :group 'mh-buffer)
110 (defvar mh-msg-number-regexp "^ *\\([0-9]+\\)"
111 "Regexp to find the number of a message in a scan line.
112 The message's number must be surrounded with \\( \\)")
114 (defvar mh-msg-search-regexp "^[^0-9]*%d[^0-9]"
115 "Format string containing a regexp matching the scan listing for a message.
116 The desired message's number will be an argument to format.")
118 (defcustom mhl-formfile nil
119 "*Name of format file to be used by mhl to show and print messages.
120 A value of T means use the default format file.
121 Nil means don't use mhl to format messages when showing; mhl is still used,
122 with the default format file, to format messages when printing them.
123 The format used should specify a non-zero value for overflowoffset so
124 the message continues to conform to RFC 822 and mh-e can parse the headers."
125 :type '(choice (const nil) (const t) string)
126 :group 'mh)
127 (put 'mhl-formfile 'info-file "mh-e")
129 (defvar mh-default-folder-for-message-function nil
130 "Function to select a default folder for refiling or Fcc.
131 If set to a function, that function is called with no arguments by
132 `\\[mh-refile-msg]' and `\\[mh-to-fcc]' to get a default when
133 prompting the user for a folder. The function is called from within a
134 save-excursion, with point at the start of the message. It should
135 return the folder to offer as the refile or Fcc folder, as a string
136 with a leading `+' sign. It can also return an empty string to use no
137 default, or NIL to calculate the default the usual way.
138 NOTE: This variable is not an ordinary hook;
139 It may not be a list of functions.")
141 (defvar mh-find-path-hook nil
142 "Invoked by mh-find-path while reading the user's MH profile.")
144 (defvar mh-folder-list-change-hook nil
145 "Invoked whenever the cached folder list `mh-folder-list' is changed.")
147 (defvar mh-show-buffer-mode-line-buffer-id "{show-%s} %d"
148 "Format string to produce `mode-line-buffer-identification' for show buffers.
149 First argument is folder name. Second is message number.")
151 (defvar mh-cmd-note 4
152 "Offset to insert notation.")
154 (defvar mh-note-seq "%"
155 "String whose first character is used to notate messages in a sequence.")
157 ;;; Internal bookkeeping variables:
159 ;; The value of `mh-folder-list-change-hook' is called whenever
160 ;; mh-folder-list variable is set.
161 (defvar mh-folder-list nil) ;List of folder names for completion.
163 ;; Cached value of the `Path:' component in the user's MH profile.
164 (defvar mh-user-path nil) ;User's mail folder directory.
166 ;; An mh-draft-folder of NIL means do not use a draft folder.
167 ;; Cached value of the `Draft-Folder:' component in the user's MH profile.
168 (defvar mh-draft-folder nil) ;Name of folder containing draft messages.
170 ;; Cached value of the `Unseen-Sequence:' component in the user's MH profile.
171 (defvar mh-unseen-seq nil) ;Name of the Unseen sequence.
173 ;; Cached value of the `Previous-Sequence:' component in the user's MH profile.
174 (defvar mh-previous-seq nil) ;Name of the Previous sequence.
176 ;; Cached value of the `Inbox:' component in the user's MH profile,
177 ;; or "+inbox" if no such component.
178 (defvar mh-inbox nil) ;Name of the Inbox folder.
180 (defconst mh-temp-buffer " *mh-temp*") ;Name of mh-e scratch buffer.
182 (defvar mh-previous-window-config nil) ;Window configuration before mh-e command.
184 ;;; Internal variables local to a folder.
186 (defvar mh-current-folder nil) ;Name of current folder, a string.
188 (defvar mh-show-buffer nil) ;Buffer that displays message for this folder.
190 (defvar mh-folder-filename nil) ;Full path of directory for this folder.
192 (defvar mh-msg-count nil) ;Number of msgs in buffer.
194 (defvar mh-showing nil) ;If non-nil, show the message in a separate window.
196 ;;; This holds a documentation string used by describe-mode.
197 (defun mh-showing ()
198 "When moving to a new message in the Folder window,
199 also show it in a separate Show window."
200 nil)
202 (defvar mh-seq-list nil) ;The sequences of this folder. An alist of (seq . msgs).
204 (defvar mh-seen-list nil) ;List of displayed messages to be removed from the Unseen sequence.
206 ;; If non-nil, show buffer contains message with all headers.
207 ;; If nil, show buffer contains message processed normally.
208 (defvar mh-showing-with-headers nil) ;Showing message with headers or normally.
211 ;;; mh-e macros
213 (defmacro with-mh-folder-updating (save-modification-flag-p &rest body)
214 ;; Format is (with-mh-folder-updating (SAVE-MODIFICATION-FLAG-P) &body BODY).
215 ;; Execute BODY, which can modify the folder buffer without having to
216 ;; worry about file locking or the read-only flag, and return its result.
217 ;; If SAVE-MODIFICATION-FLAG-P is non-nil, the buffer's modification
218 ;; flag is unchanged, otherwise it is cleared.
219 (setq save-modification-flag-p (car save-modification-flag-p)) ; CL style
220 `(prog1
221 (let ((mh-folder-updating-mod-flag (buffer-modified-p))
222 (buffer-read-only nil)
223 (buffer-file-name nil)) ;don't let the buffer get locked
224 (prog1
225 (progn
226 ,@body)
227 (mh-set-folder-modified-p mh-folder-updating-mod-flag)))
228 ,@(if (not save-modification-flag-p)
229 '((mh-set-folder-modified-p nil)))))
231 (put 'with-mh-folder-updating 'lisp-indent-hook 1)
233 (defmacro mh-in-show-buffer (show-buffer &rest body)
234 ;; Format is (mh-in-show-buffer (SHOW-BUFFER) &body BODY).
235 ;; Display buffer SHOW-BUFFER in other window and execute BODY in it.
236 ;; Stronger than save-excursion, weaker than save-window-excursion.
237 (setq show-buffer (car show-buffer)) ; CL style
238 `(let ((mh-in-show-buffer-saved-window (selected-window)))
239 (switch-to-buffer-other-window ,show-buffer)
240 (if mh-bury-show-buffer (bury-buffer (current-buffer)))
241 (unwind-protect
242 (progn
243 ,@body)
244 (select-window mh-in-show-buffer-saved-window))))
246 (put 'mh-in-show-buffer 'lisp-indent-hook 1)
248 (defmacro mh-make-seq (name msgs) (list 'cons name msgs))
250 (defmacro mh-seq-name (pair) (list 'car pair))
252 (defmacro mh-seq-msgs (pair) (list 'cdr pair))
255 ;;; Ensure new buffers won't get this mode if default-major-mode is nil.
256 (put 'mh-show-mode 'mode-class 'special)
258 (defun mh-show-mode ()
259 "Major mode for showing messages in mh-e.
260 The value of mh-show-mode-hook is called when a new message is displayed."
261 (kill-all-local-variables)
262 (setq major-mode 'mh-show-mode)
263 (mh-set-mode-name "MH-Show")
264 (run-hooks 'mh-show-mode-hook))
267 (defun mh-maybe-show (&optional msg)
268 ;; If in showing mode, then display the message pointed to by the cursor.
269 (if mh-showing (mh-show msg)))
271 (defun mh-show (&optional message)
272 "Show MESSAGE (default: message at cursor).
273 Force a two-window display with the folder window on top (size
274 mh-summary-height) and the show buffer below it.
275 If the message is already visible, display the start of the message.
277 Display of the message is controlled by setting the variables
278 `mh-clean-message-header' and `mhl-formfile'. The default behavior is
279 to scroll uninteresting headers off the top of the window.
280 Type \"\\[mh-header-display]\" to see the message with all its headers."
281 (interactive)
282 (and mh-showing-with-headers
283 (or mhl-formfile mh-clean-message-header)
284 (mh-invalidate-show-buffer))
285 (mh-show-msg message))
288 (defun mh-show-msg (msg)
289 (if (not msg)
290 (setq msg (mh-get-msg-num t)))
291 (setq mh-showing t)
292 (let ((folder mh-current-folder)
293 (clean-message-header mh-clean-message-header)
294 (show-window (get-buffer-window mh-show-buffer)))
295 (if (not (eq (next-window (minibuffer-window)) (selected-window)))
296 (delete-other-windows)) ; force ourself to the top window
297 (mh-in-show-buffer (mh-show-buffer)
298 (if (and show-window
299 (equal (mh-msg-filename msg folder) buffer-file-name))
300 (progn ;just back up to start
301 (goto-char (point-min))
302 (if (not clean-message-header)
303 (mh-start-of-uncleaned-message)))
304 (mh-display-msg msg folder))))
305 (if (not (= (1+ (window-height)) (screen-height))) ;not horizontally split
306 (shrink-window (- (window-height) mh-summary-height)))
307 (mh-recenter nil)
308 (if (not (memq msg mh-seen-list)) (setq mh-seen-list (cons msg mh-seen-list)))
309 (run-hooks 'mh-show-hook))
312 (defun mh-display-msg (msg-num folder)
313 ;; Display message NUMBER of FOLDER.
314 ;; Sets the current buffer to the show buffer.
315 (set-buffer folder)
316 ;; Bind variables in folder buffer in case they are local
317 (let ((formfile mhl-formfile)
318 (clean-message-header mh-clean-message-header)
319 (invisible-headers mh-invisible-headers)
320 (visible-headers mh-visible-headers)
321 (msg-filename (mh-msg-filename msg-num))
322 (show-buffer mh-show-buffer))
323 (if (not (file-exists-p msg-filename))
324 (error "Message %d does not exist" msg-num))
325 (set-buffer show-buffer)
326 (cond ((not (equal msg-filename buffer-file-name))
327 (mh-unvisit-file)
328 (erase-buffer)
329 ;; Changing contents, so this hook needs to be reinitialized.
330 ;; pgp.el uses this.
331 (if (boundp 'write-contents-hooks) ;Emacs 19
332 (kill-local-variable 'write-contents-hooks))
333 (if formfile
334 (mh-exec-lib-cmd-output "mhl" "-nobell" "-noclear"
335 (if (stringp formfile)
336 (list "-form" formfile))
337 msg-filename)
338 (insert-file-contents msg-filename))
339 (goto-char (point-min))
340 (cond (clean-message-header
341 (mh-clean-msg-header (point-min)
342 invisible-headers
343 visible-headers)
344 (goto-char (point-min)))
346 (mh-start-of-uncleaned-message)))
347 ;; the parts of visiting we want to do (no locking)
348 (or (eq buffer-undo-list t) ;don't save undo info for prev msgs
349 (setq buffer-undo-list nil))
350 (set-buffer-modified-p nil)
351 (set-buffer-auto-saved)
352 ;; the parts of set-visited-file-name we want to do (no locking)
353 (setq buffer-file-name msg-filename)
354 (setq buffer-backed-up nil)
355 (auto-save-mode 1)
356 (set-mark nil)
357 (mh-show-mode)
358 (setq mode-line-buffer-identification
359 (list (format mh-show-buffer-mode-line-buffer-id
360 folder msg-num)))
361 (set-buffer folder)
362 (setq mh-showing-with-headers nil)))))
364 (defun mh-start-of-uncleaned-message ()
365 ;; position uninteresting headers off the top of the window
366 (let ((case-fold-search t))
367 (re-search-forward
368 "^To:\\|^Cc:\\|^From:\\|^Subject:\\|^Date:" nil t)
369 (beginning-of-line)
370 (mh-recenter 0)))
373 (defun mh-invalidate-show-buffer ()
374 ;; Invalidate the show buffer so we must update it to use it.
375 (if (get-buffer mh-show-buffer)
376 (save-excursion
377 (set-buffer mh-show-buffer)
378 (mh-unvisit-file))))
381 (defun mh-unvisit-file ()
382 ;; Separate current buffer from the message file it was visiting.
383 (or (not (buffer-modified-p))
384 (null buffer-file-name) ;we've been here before
385 (yes-or-no-p (format "Message %s modified; flush changes? "
386 (file-name-nondirectory buffer-file-name)))
387 (error "Flushing changes not confirmed"))
388 (clear-visited-file-modtime)
389 (unlock-buffer)
390 (setq buffer-file-name nil))
393 (defun mh-get-msg-num (error-if-no-message)
394 ;; Return the message number of the displayed message. If the argument
395 ;; ERROR-IF-NO-MESSAGE is non-nil, then complain if the cursor is not
396 ;; pointing to a message.
397 (save-excursion
398 (beginning-of-line)
399 (cond ((looking-at mh-msg-number-regexp)
400 (string-to-int (buffer-substring (match-beginning 1)
401 (match-end 1))))
402 (error-if-no-message
403 (error "Cursor not pointing to message"))
404 (t nil))))
407 (defun mh-msg-filename (msg &optional folder)
408 ;; Return the file name of MESSAGE in FOLDER (default current folder).
409 (expand-file-name (int-to-string msg)
410 (if folder
411 (mh-expand-file-name folder)
412 mh-folder-filename)))
415 (defun mh-clean-msg-header (start invisible-headers visible-headers)
416 ;; Flush extraneous lines in a message header, from the given POINT to the
417 ;; end of the message header. If VISIBLE-HEADERS is non-nil, it contains a
418 ;; regular expression specifying the lines to display, otherwise
419 ;; INVISIBLE-HEADERS contains a regular expression specifying lines to
420 ;; delete from the header.
421 (let ((case-fold-search t))
422 (save-restriction
423 (goto-char start)
424 (if (search-forward "\n\n" nil 'move)
425 (backward-char 1))
426 (narrow-to-region start (point))
427 (goto-char (point-min))
428 (if visible-headers
429 (while (< (point) (point-max))
430 (cond ((looking-at visible-headers)
431 (forward-line 1)
432 (while (looking-at "[ \t]") (forward-line 1)))
434 (mh-delete-line 1)
435 (while (looking-at "[ \t]")
436 (mh-delete-line 1)))))
437 (while (re-search-forward invisible-headers nil t)
438 (beginning-of-line)
439 (mh-delete-line 1)
440 (while (looking-at "[ \t]")
441 (mh-delete-line 1))))
442 (unlock-buffer))))
445 (defun mh-recenter (arg)
446 ;; Like recenter but with two improvements: nil arg means recenter,
447 ;; and only does anything if the current buffer is in the selected
448 ;; window. (Commands like save-some-buffers can make this false.)
449 (if (eq (get-buffer-window (current-buffer))
450 (selected-window))
451 (recenter (if arg arg '(t)))))
454 (defun mh-delete-line (lines)
455 ;; Delete version of kill-line.
456 (delete-region (point) (progn (forward-line lines) (point))))
459 (defun mh-notate (msg notation offset)
460 ;; Marks MESSAGE with the character NOTATION at position OFFSET.
461 ;; Null MESSAGE means the message that the cursor points to.
462 (save-excursion
463 (if (or (null msg)
464 (mh-goto-msg msg t t))
465 (with-mh-folder-updating (t)
466 (beginning-of-line)
467 (forward-char offset)
468 (delete-char 1)
469 (insert notation)))))
472 (defun mh-find-msg-get-num (step)
473 ;; Return the message number of the message on the current scan line
474 ;; or one nearby. Jumps over non-message lines, such as inc errors.
475 ;; STEP tells whether to search forward or backward if we have to search.
476 (or (mh-get-msg-num nil)
477 (let ((msg-num nil)
478 (nreverses 0))
479 (while (and (not msg-num)
480 (< nreverses 2))
481 (cond ((eobp)
482 (setq step -1)
483 (setq nreverses (1+ nreverses)))
484 ((bobp)
485 (setq step 1)
486 (setq nreverses (1+ nreverses))))
487 (forward-line step)
488 (setq msg-num (mh-get-msg-num nil)))
489 msg-num)))
491 (defun mh-goto-msg (number &optional no-error-if-no-message dont-show)
492 "Position the cursor at message NUMBER.
493 Optional non-nil second argument means return nil instead of
494 signaling an error if message does not exist; in this case,
495 the cursor is positioned near where the message would have been.
496 Non-nil third argument means not to show the message."
497 (interactive "NGo to message: ")
498 (setq number (prefix-numeric-value number)) ;Emacs 19
499 ;; This basic routine tries to be as fast as possible,
500 ;; using a binary search and minimal regexps.
501 (let ((cur-msg (mh-find-msg-get-num -1))
502 (jump-size mh-msg-count))
503 (while (and (> jump-size 1)
504 cur-msg
505 (not (eq cur-msg number)))
506 (cond ((< cur-msg number)
507 (setq jump-size (min (- number cur-msg)
508 (ash (1+ jump-size) -1)))
509 (forward-line jump-size)
510 (setq cur-msg (mh-find-msg-get-num 1)))
512 (setq jump-size (min (- cur-msg number)
513 (ash (1+ jump-size) -1)))
514 (forward-line (- jump-size))
515 (setq cur-msg (mh-find-msg-get-num -1)))))
516 (if (eq cur-msg number)
517 (progn
518 (beginning-of-line)
519 (or dont-show
520 (mh-maybe-show number)
522 (if (not no-error-if-no-message)
523 (error "No message %d" number)))))
526 (defun mh-msg-search-pat (n)
527 ;; Return a search pattern for message N in the scan listing.
528 (format mh-msg-search-regexp n))
531 (defun mh-get-profile-field (field)
532 ;; Find and return the value of FIELD in the current buffer.
533 ;; Returns NIL if the field is not in the buffer.
534 (let ((case-fold-search t))
535 (goto-char (point-min))
536 (cond ((not (re-search-forward (format "^%s" field) nil t)) nil)
537 ((looking-at "[\t ]*$") nil)
539 (re-search-forward "[\t ]*\\([^\t \n].*\\)$" nil t)
540 (let ((start (match-beginning 1)))
541 (end-of-line)
542 (buffer-substring start (point)))))))
544 (defvar mail-user-agent)
546 (defvar mh-find-path-run nil
547 "Non-nil if `mh-find-path' has been run already.")
549 (defun mh-find-path ()
550 ;; Set mh-progs, mh-lib, and mh-libs-progs
551 ;; (This step is necessary if MH was installed after this Emacs was dumped.)
552 ;; From profile file, set mh-user-path, mh-draft-folder,
553 ;; mh-unseen-seq, mh-previous-seq, mh-inbox.
554 (mh-find-progs)
555 (unless mh-find-path-run
556 (setq mh-find-path-run t)
557 (setq mail-user-agent 'mh-e-user-agent))
558 (save-excursion
559 ;; Be sure profile is fully expanded before switching buffers
560 (let ((profile (expand-file-name (or (getenv "MH") "~/.mh_profile"))))
561 (set-buffer (get-buffer-create mh-temp-buffer))
562 (setq buffer-offer-save nil) ;for people who set default to t
563 (erase-buffer)
564 (condition-case err
565 (insert-file-contents profile)
566 (file-error
567 (mh-install profile err)))
568 (setq mh-user-path (mh-get-profile-field "Path:"))
569 (if (not mh-user-path)
570 (setq mh-user-path "Mail"))
571 (setq mh-user-path
572 (file-name-as-directory
573 (expand-file-name mh-user-path (expand-file-name "~"))))
574 (setq mh-draft-folder (mh-get-profile-field "Draft-Folder:"))
575 (if mh-draft-folder
576 (progn
577 (if (not (mh-folder-name-p mh-draft-folder))
578 (setq mh-draft-folder (format "+%s" mh-draft-folder)))
579 (if (not (file-exists-p (mh-expand-file-name mh-draft-folder)))
580 (error "Draft folder \"%s\" not found. Create it and try again."
581 (mh-expand-file-name mh-draft-folder)))))
582 (setq mh-inbox (mh-get-profile-field "Inbox:"))
583 (cond ((not mh-inbox)
584 (setq mh-inbox "+inbox"))
585 ((not (mh-folder-name-p mh-inbox))
586 (setq mh-inbox (format "+%s" mh-inbox))))
587 (setq mh-unseen-seq (mh-get-profile-field "Unseen-Sequence:"))
588 (if mh-unseen-seq
589 (setq mh-unseen-seq (intern mh-unseen-seq))
590 (setq mh-unseen-seq 'unseen)) ;old MH default?
591 (setq mh-previous-seq (mh-get-profile-field "Previous-Sequence:"))
592 (if mh-previous-seq
593 (setq mh-previous-seq (intern mh-previous-seq)))
594 (run-hooks 'mh-find-path-hook)))
595 (and mh-auto-folder-collect
596 (let ((mh-no-install t)) ;only get folders if MH installed
597 (condition-case err
598 (mh-make-folder-list-background)
599 (file-error))))) ;so don't complain if not installed
601 (defun mh-file-command-p (file)
602 "Return t if file FILE is the name of a executable regular file."
603 (and (file-regular-p file) (file-executable-p file)))
605 (defun mh-find-progs ()
606 "Find the `inc' and `mhl' programs of MH.
607 Set the `mh-progs' and `mh-lib', and `mh-lib-progs' variables to the
608 directory names."
609 (or (and mh-progs (mh-file-command-p (expand-file-name "inc" mh-progs)))
610 (setq mh-progs
611 (or (mh-path-search exec-path "inc")
612 (mh-path-search '("/usr/local/bin/mh/"
613 "/usr/local/mh/"
614 "/usr/bin/mh/" ;Ultrix 4.2
615 "/usr/new/mh/" ;Ultrix <4.2
616 "/usr/contrib/mh/bin/" ;BSDI
617 "/usr/pkg/bin/" ; NetBSD
618 "/usr/local/bin/"
620 "inc"))))
621 (or (null mh-progs)
622 (let ((mh-base mh-progs))
623 (while (let ((dir-name (file-name-nondirectory
624 (directory-file-name mh-base))))
625 (or (string= "mh" dir-name)
626 (string= "bin" dir-name)))
627 (setq mh-base
628 (file-name-directory (directory-file-name mh-base))))
629 (or (and mh-lib
630 (file-exists-p (expand-file-name "components" mh-lib)))
631 (setq mh-lib
632 ;; Look for a lib directory roughly parallel to the bin
633 ;; directory: Strip any trailing `mh' or `bin' path
634 ;; components, then look for lib/mh or mh/lib.
635 (or (mh-path-search
636 (mapcar (lambda (p) (expand-file-name p mh-base))
637 '("lib/mh" "etc/nmh" "/etc/nmh" "mh/lib" "etc"))
638 "components"
639 'file-exists-p))))
640 (or (and mh-lib-progs
641 (mh-file-command-p (expand-file-name "mhl" mh-lib-progs)))
642 (setq mh-lib-progs
643 (or (mh-path-search
644 (mapcar (lambda (p) (expand-file-name p mh-base))
645 '("lib/mh" "libexec/nmh" "lib/nmh" "mh/lib"))
646 "mhl")
647 (mh-path-search '("/usr/local/bin/mh/") "mhl")
648 (mh-path-search exec-path "mhl") ;unlikely
649 )))))
650 (unless (and mh-progs mh-lib mh-lib-progs)
651 (error "Cannot find the commands `inc' and `mhl' and the file `components'"))
652 (setq mh-nmh-p (not (null
653 (or (string-match "nmh" mh-lib-progs)
654 (string-match "nmh" mh-lib))))))
656 (defun mh-path-search (path file &optional func-p)
657 ;; Search PATH, a list of directory names, for FILE.
658 ;; Returns the element of PATH that contains FILE, or nil if not found.
659 (while (and path
660 (not (funcall (or func-p 'mh-file-command-p)
661 (expand-file-name file (car path)))))
662 (setq path (cdr path)))
663 (car path))
665 (defvar mh-no-install nil) ;do not run install-mh
667 (defun mh-install (profile error-val)
668 ;; Called to do error recovery if we fail to read the profile file.
669 ;; If possible, initialize the MH environment.
670 (if (or (getenv "MH")
671 (file-exists-p profile)
672 mh-no-install)
673 (signal (car error-val)
674 (list (format "Cannot read MH profile \"%s\"" profile)
675 (car (cdr (cdr error-val))))))
676 ;; The "install-mh" command will output a short note which
677 ;; mh-exec-cmd will display to the user.
678 ;; The MH 5 version of install-mh might try prompt the user
679 ;; for information, which would fail here.
680 (mh-exec-cmd (expand-file-name "install-mh" mh-lib-progs) "-auto")
681 ;; now try again to read the profile file
682 (erase-buffer)
683 (condition-case err
684 (insert-file-contents profile)
685 (file-error
686 (signal (car err) ;re-signal with more specific msg
687 (list (format "Cannot read MH profile \"%s\"" profile)
688 (car (cdr (cdr err))))))))
691 (defun mh-set-folder-modified-p (flag)
692 ;; Mark current folder as modified or unmodified according to FLAG.
693 (set-buffer-modified-p flag))
696 (defun mh-find-seq (name) (assoc name mh-seq-list))
698 (defun mh-seq-to-msgs (seq)
699 ;; Return a list of the messages in SEQUENCE.
700 (mh-seq-msgs (mh-find-seq seq)))
703 (defun mh-add-msgs-to-seq (msgs seq &optional internal-flag)
704 ;; Add MESSAGE(s) to the SEQUENCE. If optional FLAG is non-nil, do not mark
705 ;; the message in the scan listing or inform MH of the addition.
706 (let ((entry (mh-find-seq seq)))
707 (if (and msgs (atom msgs)) (setq msgs (list msgs)))
708 (if (null entry)
709 (setq mh-seq-list (cons (mh-make-seq seq msgs) mh-seq-list))
710 (if msgs (setcdr entry (append msgs (mh-seq-msgs entry)))))
711 (cond ((not internal-flag)
712 (mh-add-to-sequence seq msgs)
713 (mh-notate-seq seq mh-note-seq (1+ mh-cmd-note))))))
715 (autoload 'mh-add-to-sequence "mh-seq")
716 (autoload 'mh-notate-seq "mh-seq")
717 (autoload 'mh-read-seq-default "mh-seq")
718 (autoload 'mh-map-to-seq-msgs "mh-seq")
721 (defun mh-set-mode-name (mode-name-string)
722 ;; Set the mode-name and ensure that the mode line is updated.
723 (setq mode-name mode-name-string)
724 (force-mode-line-update t))
727 (defun mh-prompt-for-folder (prompt default can-create)
728 ;; Prompt for a folder name with PROMPT. Returns the folder's name as a
729 ;; string. DEFAULT is used if the folder exists and the user types return.
730 ;; If the CAN-CREATE flag is t, then a non-existent folder is made.
731 (if (null default)
732 (setq default ""))
733 (let* ((prompt (format "%s folder%s" prompt
734 (if (equal "" default)
735 "? "
736 (format " [%s]? " default))))
737 read-name folder-name)
738 (if (null mh-folder-list)
739 (mh-set-folder-list))
740 (while (and (setq read-name (completing-read prompt mh-folder-list
741 nil nil "+"))
742 (equal read-name "")
743 (equal default "")))
744 (cond ((or (equal read-name "") (equal read-name "+"))
745 (setq read-name default))
746 ((not (mh-folder-name-p read-name))
747 (setq read-name (format "+%s" read-name))))
748 (setq folder-name read-name)
749 (cond ((and (> (length folder-name) 0)
750 (eq (aref folder-name (1- (length folder-name))) ?/))
751 (setq folder-name (substring folder-name 0 -1))))
752 (let ((new-file-p (not (file-exists-p (mh-expand-file-name folder-name)))))
753 (cond ((and new-file-p
754 (y-or-n-p
755 (format "Folder %s does not exist. Create it? " folder-name)))
756 (message "Creating %s" folder-name)
757 (call-process "mkdir" nil nil nil (mh-expand-file-name folder-name))
758 (message "Creating %s...done" folder-name)
759 (setq mh-folder-list (cons (list read-name) mh-folder-list))
760 (run-hooks 'mh-folder-list-change-hook))
761 (new-file-p
762 (error "Folder %s is not created" folder-name))
763 ((not (file-directory-p (mh-expand-file-name folder-name)))
764 (error "\"%s\" is not a directory"
765 (mh-expand-file-name folder-name)))
766 ((and (null (assoc read-name mh-folder-list))
767 (null (assoc (concat read-name "/") mh-folder-list)))
768 (setq mh-folder-list (cons (list read-name) mh-folder-list))
769 (run-hooks 'mh-folder-list-change-hook))))
770 folder-name))
773 (defvar mh-make-folder-list-process nil) ;The background process collecting the folder list.
775 (defvar mh-folder-list-temp nil) ;mh-folder-list as it is being built.
777 (defvar mh-folder-list-partial-line "") ;Start of last incomplete line from folder process.
779 (defun mh-set-folder-list ()
780 ;; Sets mh-folder-list correctly.
781 ;; A useful function for the command line or for when you need to
782 ;; sync by hand. Format is in a form suitable for completing read.
783 (message "Collecting folder names...")
784 (if (not mh-make-folder-list-process)
785 (mh-make-folder-list-background))
786 (while (eq (process-status mh-make-folder-list-process) 'run)
787 (accept-process-output mh-make-folder-list-process))
788 (setq mh-folder-list mh-folder-list-temp)
789 (run-hooks 'mh-folder-list-change-hook)
790 (setq mh-folder-list-temp nil)
791 (delete-process mh-make-folder-list-process)
792 (setq mh-make-folder-list-process nil)
793 (message "Collecting folder names...done"))
795 (defun mh-make-folder-list-background ()
796 ;; Start a background process to compute a list of the user's folders.
797 ;; Call mh-set-folder-list to wait for the result.
798 (cond
799 ((not mh-make-folder-list-process)
800 (unless mh-inbox
801 (mh-find-path))
802 (let ((process-connection-type nil))
803 (setq mh-make-folder-list-process
804 (start-process "folders" nil (expand-file-name "folders" mh-progs)
805 "-fast"
806 (if mh-recursive-folders
807 "-recurse"
808 "-norecurse")))
809 (set-process-filter mh-make-folder-list-process
810 'mh-make-folder-list-filter)
811 (process-kill-without-query mh-make-folder-list-process)))))
813 (defun mh-make-folder-list-filter (process output)
814 ;; parse output from "folders -fast"
815 (let ((position 0)
816 line-end
817 new-folder
818 (prevailing-match-data (match-data)))
819 (unwind-protect
820 ;; make sure got complete line
821 (while (setq line-end (string-match "\n" output position))
822 (setq new-folder (format "+%s%s"
823 mh-folder-list-partial-line
824 (substring output position line-end)))
825 (setq mh-folder-list-partial-line "")
826 ;; is new folder a subfolder of previous?
827 (if (and mh-folder-list-temp
828 (string-match
829 (regexp-quote
830 (concat (car (car mh-folder-list-temp)) "/"))
831 new-folder))
832 ;; append slash to parent folder for better completion
833 ;; (undone by mh-prompt-for-folder)
834 (setq mh-folder-list-temp
835 (cons
836 (list new-folder)
837 (cons
838 (list (concat (car (car mh-folder-list-temp)) "/"))
839 (cdr mh-folder-list-temp))))
840 (setq mh-folder-list-temp
841 (cons (list new-folder)
842 mh-folder-list-temp)))
843 (setq position (1+ line-end)))
844 (set-match-data prevailing-match-data))
845 (setq mh-folder-list-partial-line (substring output position))))
848 (defun mh-folder-name-p (name)
849 ;; Return non-NIL if NAME is possibly the name of a folder.
850 ;; A name (a string or symbol) can be a folder name if it begins with "+".
851 (if (symbolp name)
852 (eq (aref (symbol-name name) 0) ?+)
853 (and (> (length name) 0)
854 (eq (aref name 0) ?+))))
857 ;;; Issue commands to MH.
860 (defun mh-exec-cmd (command &rest args)
861 ;; Execute mh-command COMMAND with ARGS.
862 ;; The side effects are what is desired.
863 ;; Any output is assumed to be an error and is shown to the user.
864 ;; The output is not read or parsed by mh-e.
865 (save-excursion
866 (set-buffer (get-buffer-create mh-temp-buffer))
867 (erase-buffer)
868 (apply 'call-process
869 (expand-file-name command mh-progs) nil t nil
870 (mh-list-to-string args))
871 (if (> (buffer-size) 0)
872 (save-window-excursion
873 (switch-to-buffer-other-window mh-temp-buffer)
874 (sit-for 5)))))
877 (defun mh-exec-cmd-error (env command &rest args)
878 ;; In environment ENV, execute mh-command COMMAND with args ARGS.
879 ;; ENV is nil or a string of space-separated "var=value" elements.
880 ;; Signals an error if process does not complete successfully.
881 (save-excursion
882 (set-buffer (get-buffer-create mh-temp-buffer))
883 (erase-buffer)
884 (let ((status
885 (if env
886 ;; the shell hacks necessary here shows just how broken Unix is
887 (apply 'call-process "/bin/sh" nil t nil "-c"
888 (format "%s %s ${1+\"$@\"}"
889 env
890 (expand-file-name command mh-progs))
891 command
892 (mh-list-to-string args))
893 (apply 'call-process
894 (expand-file-name command mh-progs) nil t nil
895 (mh-list-to-string args)))))
896 (mh-handle-process-error command status))))
899 (defun mh-exec-cmd-daemon (command &rest args)
900 ;; Execute MH command COMMAND with ARGS in the background.
901 ;; Any output from command is displayed in an asynchronous pop-up window.
902 (save-excursion
903 (set-buffer (get-buffer-create mh-temp-buffer))
904 (erase-buffer))
905 (let* ((process-connection-type nil)
906 (process (apply 'start-process
907 command nil
908 (expand-file-name command mh-progs)
909 (mh-list-to-string args))))
910 (set-process-filter process 'mh-process-daemon)))
912 (defun mh-process-daemon (process output)
913 ;; Process daemon that puts output into a temporary buffer.
914 (set-buffer (get-buffer-create mh-temp-buffer))
915 (insert-before-markers output)
916 (display-buffer mh-temp-buffer))
919 (defun mh-exec-cmd-quiet (raise-error command &rest args)
920 ;; Args are RAISE-ERROR, COMMANDS, ARGS....
921 ;; Execute MH command COMMAND with ARGS. ARGS is a list of strings.
922 ;; Return at start of mh-temp buffer, where output can be parsed and used.
923 ;; Returns value of call-process, which is 0 for success,
924 ;; unless RAISE-ERROR is non-nil, in which case an error is signaled
925 ;; if call-process returns non-0.
926 (set-buffer (get-buffer-create mh-temp-buffer))
927 (erase-buffer)
928 (let ((value
929 (apply 'call-process
930 (expand-file-name command mh-progs) nil t nil
931 args)))
932 (goto-char (point-min))
933 (if raise-error
934 (mh-handle-process-error command value)
935 value)))
938 (defun mh-exec-cmd-output (command display &rest args)
939 ;; Execute MH command COMMAND with DISPLAY flag and ARGS.
940 ;; Put the output into buffer after point. Set mark after inserted text.
941 ;; Output is expected to be shown to user, not parsed by mh-e.
942 (push-mark (point) t)
943 (apply 'call-process
944 (expand-file-name command mh-progs) nil t display
945 (mh-list-to-string args))
946 (exchange-point-and-mark))
949 (defun mh-exec-lib-cmd-output (command &rest args)
950 ;; Execute MH library command COMMAND with ARGS.
951 ;; Put the output into buffer after point. Set mark after inserted text.
952 (apply 'mh-exec-cmd-output (expand-file-name command mh-lib-progs) nil args))
955 (defun mh-handle-process-error (command status)
956 ;; Raise error if COMMAND returned non-0 STATUS, otherwise return STATUS.
957 ;; STATUS is return value from call-process.
958 ;; Program output is in current buffer.
959 ;; If output is too long to include in error message, display the buffer.
960 (cond ((eq status 0) ;success
961 status)
962 ((stringp status) ;kill string
963 (error "%s: %s" command status))
964 (t ;exit code
965 (cond
966 ((= (buffer-size) 0) ;program produced no error message
967 (error "%s: exit code %d" command status))
969 ;; will error message fit on one line?
970 (goto-line 2)
971 (if (and (< (buffer-size) (screen-width))
972 (eobp))
973 (error "%s"
974 (buffer-substring 1 (progn (goto-char 1)
975 (end-of-line)
976 (point))))
977 (display-buffer (current-buffer))
978 (error "%s failed with status %d. See error message in other window."
979 command status)))))))
982 (defun mh-expand-file-name (filename &optional default)
983 ;; Just like `expand-file-name', but also handles MH folder names.
984 ;; Assumes that any filename that starts with '+' is a folder name.
985 (if (mh-folder-name-p filename)
986 (expand-file-name (substring filename 1) mh-user-path)
987 (expand-file-name filename default)))
990 (defun mh-list-to-string (l)
991 ;; Flattens the list L and makes every element of the new list into a string.
992 (nreverse (mh-list-to-string-1 l)))
994 (defun mh-list-to-string-1 (l)
995 (let ((new-list nil))
996 (while l
997 (cond ((null (car l)))
998 ((symbolp (car l))
999 (setq new-list (cons (symbol-name (car l)) new-list)))
1000 ((numberp (car l))
1001 (setq new-list (cons (int-to-string (car l)) new-list)))
1002 ((equal (car l) ""))
1003 ((stringp (car l)) (setq new-list (cons (car l) new-list)))
1004 ((listp (car l))
1005 (setq new-list (nconc (mh-list-to-string-1 (car l))
1006 new-list)))
1007 (t (error "Bad element in mh-list-to-string: %s" (car l))))
1008 (setq l (cdr l)))
1009 new-list))
1011 (provide 'mh-utils)
1013 ;;; mh-utils.el ends here