|
0
|
1 ;;; reporter.el --- customizable bug reporting of lisp programs
|
|
|
2
|
|
2
|
3 ;; Copyright (C) 1993 1994 1995 1996 Free Software Foundation, Inc.
|
|
|
4
|
|
|
5 ;; Author: 1993-1996 Barry A. Warsaw
|
|
0
|
6 ;; Created: 19-Apr-1993
|
|
2
|
7 ;; Version: 3.3
|
|
|
8 ;; Last Modified: 1996/07/02 00:39:09
|
|
|
9 ;; Keywords: maint mail tools
|
|
0
|
10
|
|
|
11 ;; This file is part of XEmacs.
|
|
|
12
|
|
2
|
13 ;; XEmacs is free software; you can redistribute it and/or modify
|
|
|
14 ;; it under the terms of the GNU General Public License as published by
|
|
0
|
15 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
16 ;; any later version.
|
|
|
17
|
|
2
|
18 ;; XEmacs is distributed in the hope that it will be useful,
|
|
|
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
21 ;; GNU General Public License for more details.
|
|
0
|
22
|
|
|
23 ;; You should have received a copy of the GNU General Public License
|
|
2
|
24 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
|
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
26 ;; Boston, MA 02111-1307, USA.
|
|
0
|
27
|
|
2
|
28 ;;; Synched up with: FSF 19.34.
|
|
0
|
29
|
|
|
30 ;;; Commentary:
|
|
2
|
31
|
|
|
32 ;; End User Interface
|
|
|
33 ;; ==================
|
|
|
34 ;; The variable `mail-user-agent' contains a symbol indicating which
|
|
|
35 ;; Emacs mail package end users would like to use to compose outgoing
|
|
|
36 ;; mail. See that variable for details.
|
|
|
37
|
|
|
38 ;; Mail Package Interface
|
|
|
39 ;; ======================
|
|
|
40 ;; Mail package authors can configure reporter to support their
|
|
|
41 ;; package by calling the function `define-mail-user-agent' See that
|
|
|
42 ;; function for details.
|
|
|
43
|
|
|
44 ;; Lisp Package Authors
|
|
|
45 ;; ====================
|
|
|
46 ;; Reporter was written primarily for Emacs Lisp package authors so
|
|
|
47 ;; that their users can easily report bugs. When invoked,
|
|
|
48 ;; reporter-submit-bug-report will set up an outgoing mail buffer with
|
|
|
49 ;; the appropriate bug report address, including a lisp expression the
|
|
|
50 ;; maintainer of the package can eval to completely reproduce the
|
|
|
51 ;; environment in which the bug was observed (e.g. by using
|
|
|
52 ;; eval-last-sexp). This package proved especially useful during my
|
|
|
53 ;; development of cc-mode, which is highly dependent on its
|
|
|
54 ;; configuration variables.
|
|
0
|
55 ;;
|
|
|
56 ;; Do a "C-h f reporter-submit-bug-report" for more information.
|
|
|
57 ;; Here's an example usage:
|
|
|
58 ;;
|
|
|
59 ;;(defconst mypkg-version "9.801")
|
|
|
60 ;;(defconst mypkg-maintainer-address "mypkg-help@foo.com")
|
|
|
61 ;;(defun mypkg-submit-bug-report ()
|
|
|
62 ;; "Submit via mail a bug report on mypkg"
|
|
|
63 ;; (interactive)
|
|
|
64 ;; (reporter-submit-bug-report
|
|
|
65 ;; mypkg-maintainer-address
|
|
|
66 ;; (concat "mypkg.el " mypkg-version)
|
|
|
67 ;; (list 'mypkg-variable-1
|
|
|
68 ;; 'mypkg-variable-2
|
|
|
69 ;; ;; ...
|
|
|
70 ;; 'mypkg-variable-last)))
|
|
|
71
|
|
|
72 ;; Mailing List
|
|
|
73 ;; ============
|
|
2
|
74 ;; I've set up a Majordomo mailing list to report bugs or suggest
|
|
|
75 ;; enhancements, etc. This list's intended audience is elisp package
|
|
|
76 ;; authors who are using reporter and want to stay current with
|
|
|
77 ;; releases. Here are the relevant addresses:
|
|
0
|
78 ;;
|
|
2
|
79 ;; Administrivia: reporter-request@python.org
|
|
|
80 ;; Submissions: reporter@python.org
|
|
0
|
81
|
|
|
82 ;; Packages that currently use reporter are: cc-mode, supercite, elp,
|
|
2
|
83 ;; tcl, ediff, crypt++ (crypt), dired-x, rmailgen, mode-line, vm,
|
|
|
84 ;; mh-e, edebug, archie, viper, w3-mode, framepop, hl319, hilit19,
|
|
|
85 ;; pgp, eos, hm--html, efs.
|
|
|
86 ;;
|
|
|
87 ;; If you know of others, please email me!
|
|
0
|
88
|
|
|
89 ;;; Code:
|
|
|
90
|
|
|
91
|
|
2
|
92 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
|
|
|
93 ;; End user interface
|
|
|
94
|
|
|
95 ;; XEmacs -- don't autoload
|
|
|
96 (defvar mail-user-agent 'sendmail-user-agent
|
|
|
97 "*Your preference for a mail composition package.
|
|
|
98 Various Emacs Lisp packages (e.g. reporter) require you to compose an
|
|
|
99 outgoing email message. As there are several such packages available
|
|
|
100 for Emacs, you can indicate your preference by setting this variable.
|
|
|
101
|
|
|
102 Valid values currently are:
|
|
0
|
103
|
|
2
|
104 'sendmail-user-agent -- use Emacs built-in Mail package
|
|
|
105 'vm-user-agent -- use Kyle Jones' VM package
|
|
|
106 'mh-e-user-agent -- use the Emacs interface to the MH mail system
|
|
0
|
107
|
|
2
|
108 Additional valid symbols may be available; check with the author of
|
|
|
109 your package for details.")
|
|
|
110
|
|
|
111
|
|
|
112
|
|
|
113 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
|
|
|
114 ;; Package author interface variables
|
|
0
|
115
|
|
|
116 (defvar reporter-prompt-for-summary-p nil
|
|
|
117 "Interface variable controlling prompting for problem summary.
|
|
|
118 When non-nil, `reporter-submit-bug-report' prompts the user for a
|
|
|
119 brief summary of the problem, and puts this summary on the Subject:
|
|
2
|
120 line. If this variable is a string, that string is used as the prompt
|
|
|
121 string.
|
|
0
|
122
|
|
|
123 Default behavior is to not prompt (i.e. nil). If you want reporter to
|
|
2
|
124 prompt, you should `let' bind this variable before calling
|
|
0
|
125 `reporter-submit-bug-report'. Note that this variable is not
|
|
|
126 buffer-local so you should never just `setq' it.")
|
|
|
127
|
|
|
128 (defvar reporter-dont-compact-list nil
|
|
2
|
129 "Interface variable controlling compacting of list values.
|
|
0
|
130 When non-nil, this must be a list of variable symbols. When a
|
|
|
131 variable containing a list value is formatted in the bug report mail
|
|
|
132 buffer, it normally is compacted so that its value fits one the fewest
|
|
|
133 number of lines. If the variable's symbol appears in this list, its
|
|
|
134 value is printed in a more verbose style, specifically, one elemental
|
|
|
135 sexp per line.
|
|
|
136
|
|
|
137 Note that this variable is not buffer-local so you should never just
|
|
|
138 `setq' it. If you want to changes its default value, you should `let'
|
|
|
139 bind it.")
|
|
|
140
|
|
2
|
141 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
142 ;; End of editable variables
|
|
0
|
143
|
|
2
|
144
|
|
0
|
145 (defvar reporter-eval-buffer nil
|
|
|
146 "Buffer to retrieve variable's value from.
|
|
|
147 This is necessary to properly support the printing of buffer-local
|
|
|
148 variables. Current buffer will always be the mail buffer being
|
|
|
149 composed.")
|
|
|
150
|
|
2
|
151 (defconst reporter-version "3.2"
|
|
0
|
152 "Reporter version number.")
|
|
|
153
|
|
|
154 (defvar reporter-initial-text nil
|
|
|
155 "The automatically created initial text of a bug report.")
|
|
|
156 (make-variable-buffer-local 'reporter-initial-text)
|
|
|
157
|
|
2
|
158
|
|
0
|
159
|
|
2
|
160 ;; status feedback to the user
|
|
0
|
161 (defvar reporter-status-message nil)
|
|
|
162 (defvar reporter-status-count nil)
|
|
|
163
|
|
|
164 (defun reporter-update-status ()
|
|
|
165 ;; periodically output a status message
|
|
|
166 (if (zerop (% reporter-status-count 10))
|
|
|
167 (progn
|
|
|
168 (message reporter-status-message)
|
|
|
169 (setq reporter-status-message (concat reporter-status-message "."))))
|
|
|
170 (setq reporter-status-count (1+ reporter-status-count)))
|
|
|
171
|
|
|
172
|
|
2
|
173 ;; dumping/pretty printing of values
|
|
0
|
174 (defun reporter-beautify-list (maxwidth compact-p)
|
|
|
175 ;; pretty print a list
|
|
|
176 (reporter-update-status)
|
|
|
177 (let (linebreak indent-enclosing-p indent-p here)
|
|
|
178 (condition-case nil ;loop exit
|
|
|
179 (progn
|
|
|
180 (down-list 1)
|
|
|
181 (setq indent-enclosing-p t)
|
|
|
182 (while t
|
|
|
183 (setq here (point))
|
|
|
184 (forward-sexp 1)
|
|
|
185 (if (<= maxwidth (current-column))
|
|
|
186 (if linebreak
|
|
|
187 (progn
|
|
|
188 (goto-char linebreak)
|
|
|
189 (newline-and-indent)
|
|
|
190 (setq linebreak nil))
|
|
|
191 (goto-char here)
|
|
|
192 (setq indent-p (reporter-beautify-list maxwidth compact-p))
|
|
|
193 (goto-char here)
|
|
|
194 (forward-sexp 1)
|
|
|
195 (if indent-p
|
|
|
196 (newline-and-indent))
|
|
|
197 t)
|
|
|
198 (if compact-p
|
|
|
199 (setq linebreak (point))
|
|
|
200 (newline-and-indent))
|
|
|
201 ))
|
|
|
202 t)
|
|
|
203 (error indent-enclosing-p))))
|
|
|
204
|
|
|
205 (defun reporter-lisp-indent (indent-point state)
|
|
|
206 ;; a better lisp indentation style for bug reporting
|
|
|
207 (save-excursion
|
|
|
208 (goto-char (1+ (nth 1 state)))
|
|
|
209 (current-column)))
|
|
|
210
|
|
|
211 (defun reporter-dump-variable (varsym mailbuf)
|
|
|
212 ;; Pretty-print the value of the variable in symbol VARSYM. MAILBUF
|
|
|
213 ;; is the mail buffer being composed
|
|
|
214 (reporter-update-status)
|
|
|
215 (condition-case nil
|
|
|
216 (let ((val (save-excursion
|
|
|
217 (set-buffer reporter-eval-buffer)
|
|
|
218 (symbol-value varsym)))
|
|
|
219 (sym (symbol-name varsym))
|
|
|
220 (print-escape-newlines t)
|
|
|
221 (maxwidth (1- (window-width)))
|
|
|
222 (here (point)))
|
|
|
223 (insert " " sym " "
|
|
|
224 (cond
|
|
|
225 ((memq val '(t nil)) "")
|
|
|
226 ((listp val) "'")
|
|
|
227 ((symbolp val) "'")
|
|
|
228 (t ""))
|
|
|
229 (prin1-to-string val))
|
|
|
230 (lisp-indent-line)
|
|
|
231 ;; clean up lists, but only if the line as printed was long
|
|
|
232 ;; enough to wrap
|
|
|
233 (if (and val ;nil is a list, but short
|
|
|
234 (listp val)
|
|
|
235 (<= maxwidth (current-column)))
|
|
|
236 (save-excursion
|
|
|
237 (let ((compact-p (not (memq varsym reporter-dont-compact-list)))
|
|
|
238 (lisp-indent-function 'reporter-lisp-indent))
|
|
|
239 (goto-char here)
|
|
|
240 (reporter-beautify-list maxwidth compact-p))))
|
|
|
241 (insert "\n"))
|
|
|
242 (void-variable
|
|
|
243 (save-excursion
|
|
|
244 (set-buffer mailbuf)
|
|
|
245 (mail-position-on-field "X-Reporter-Void-Vars-Found")
|
|
|
246 (end-of-line)
|
|
|
247 (insert (symbol-name varsym) " ")))
|
|
2
|
248 (error
|
|
|
249 (error ""))))
|
|
0
|
250
|
|
|
251 (defun reporter-dump-state (pkgname varlist pre-hooks post-hooks)
|
|
|
252 ;; Dump the state of the mode specific variables.
|
|
|
253 ;; PKGNAME contains the name of the mode as it will appear in the bug
|
|
|
254 ;; report (you must explicitly concat any version numbers).
|
|
|
255
|
|
|
256 ;; VARLIST is the list of variables to dump. Each element in
|
|
|
257 ;; VARLIST can be a variable symbol, or a cons cell. If a symbol,
|
|
|
258 ;; this will be passed to `reporter-dump-variable' for insertion
|
|
|
259 ;; into the mail buffer. If a cons cell, the car must be a variable
|
|
|
260 ;; symbol and the cdr must be a function which will be `funcall'd
|
|
|
261 ;; with arguments the symbol and the mail buffer being composed. Use
|
|
|
262 ;; this to write your own custom variable value printers for
|
|
|
263 ;; specific variables.
|
|
|
264
|
|
|
265 ;; Note that the global variable `reporter-eval-buffer' will be bound to
|
|
|
266 ;; the buffer in which `reporter-submit-bug-report' was invoked. If you
|
|
|
267 ;; want to print the value of a buffer local variable, you should wrap
|
|
|
268 ;; the `eval' call in your custom printer inside a `set-buffer' (and
|
|
|
269 ;; probably a `save-excursion'). `reporter-dump-variable' handles this
|
|
|
270 ;; properly.
|
|
|
271
|
|
|
272 ;; PRE-HOOKS is run after the emacs-version and PKGNAME are inserted, but
|
|
|
273 ;; before the VARLIST is dumped. POST-HOOKS is run after the VARLIST is
|
|
|
274 ;; dumped.
|
|
|
275 (let ((buffer (current-buffer)))
|
|
|
276 (set-buffer buffer)
|
|
|
277 (insert "Emacs : " (emacs-version) "\n")
|
|
|
278 (and pkgname
|
|
|
279 (insert "Package: " pkgname "\n"))
|
|
|
280 (run-hooks 'pre-hooks)
|
|
|
281 (if (not varlist)
|
|
|
282 nil
|
|
|
283 (insert "\ncurrent state:\n==============\n")
|
|
|
284 ;; create an emacs-lisp-mode buffer to contain the output, which
|
|
|
285 ;; we'll later insert into the mail buffer
|
|
|
286 (condition-case fault
|
|
|
287 (let ((mailbuf (current-buffer))
|
|
|
288 (elbuf (get-buffer-create " *tmp-reporter-buffer*")))
|
|
|
289 (save-excursion
|
|
|
290 (set-buffer elbuf)
|
|
|
291 (emacs-lisp-mode)
|
|
|
292 (erase-buffer)
|
|
|
293 (insert "(setq\n")
|
|
|
294 (lisp-indent-line)
|
|
|
295 (mapcar
|
|
|
296 (function
|
|
|
297 (lambda (varsym-or-cons-cell)
|
|
|
298 (let ((varsym (or (car-safe varsym-or-cons-cell)
|
|
|
299 varsym-or-cons-cell))
|
|
|
300 (printer (or (cdr-safe varsym-or-cons-cell)
|
|
|
301 'reporter-dump-variable)))
|
|
|
302 (funcall printer varsym mailbuf)
|
|
|
303 )))
|
|
|
304 varlist)
|
|
|
305 (lisp-indent-line)
|
|
|
306 (insert ")\n"))
|
|
|
307 (insert-buffer elbuf))
|
|
|
308 (error
|
|
|
309 (insert "State could not be dumped due to the following error:\n\n"
|
|
|
310 (format "%s" fault)
|
|
|
311 "\n\nYou should still send this bug report."))))
|
|
|
312 (run-hooks 'post-hooks)
|
|
|
313 ))
|
|
|
314
|
|
|
315
|
|
|
316 (defun reporter-calculate-separator ()
|
|
|
317 ;; returns the string regexp matching the mail separator
|
|
|
318 (save-excursion
|
|
|
319 (re-search-forward
|
|
|
320 (concat
|
|
|
321 "^\\(" ;beginning of line
|
|
|
322 (mapconcat
|
|
|
323 'identity
|
|
|
324 (list "[\t ]*" ;simple SMTP form
|
|
|
325 "-+" ;mh-e form
|
|
|
326 (regexp-quote
|
|
|
327 mail-header-separator)) ;sendmail.el form
|
|
|
328 "\\|") ;or them together
|
|
|
329 "\\)$") ;end of line
|
|
|
330 nil
|
|
|
331 'move) ;search for and move
|
|
|
332 (buffer-substring (match-beginning 0) (match-end 0))))
|
|
|
333
|
|
2
|
334
|
|
|
335 ;; Serves as an interface to `mail' (sendmail.el), but when the user
|
|
|
336 ;; answers "no" to discarding an unsent message, it gives an error.
|
|
0
|
337 (defun reporter-mail (&rest args)
|
|
|
338 (or (apply 'mail args)
|
|
|
339 (error "Bug report aborted")))
|
|
|
340
|
|
2
|
341 (defun reporter-compose-outgoing ()
|
|
|
342 ;; compose the outgoing mail buffer, and return the selected
|
|
|
343 ;; paradigm, with the current-buffer tacked onto the beginning of
|
|
|
344 ;; the list.
|
|
|
345 (let* ((agent mail-user-agent)
|
|
|
346 (compose (get mail-user-agent 'composefunc)))
|
|
|
347 ;; Sanity check. If this fails then we'll try to use the SENDMAIL
|
|
|
348 ;; protocol, otherwise we must signal an error.
|
|
|
349 (if (not (and compose (fboundp compose)))
|
|
|
350 (progn
|
|
|
351 (setq agent 'sendmail-user-agent
|
|
|
352 compose (get agent 'composefunc))
|
|
|
353 (if (not (and compose (fboundp compose)))
|
|
|
354 (error "Could not find a valid `mail-user-agent'.")
|
|
|
355 (ding)
|
|
|
356 (message "`%s' is an invalid `mail-user-agent'; using `sendmail-user-agent'."
|
|
|
357 mail-user-agent)
|
|
|
358 )))
|
|
|
359 (funcall compose)
|
|
|
360 agent))
|
|
|
361
|
|
|
362
|
|
0
|
363 ;;;###autoload
|
|
|
364 (defun reporter-submit-bug-report
|
|
|
365 (address pkgname varlist &optional pre-hooks post-hooks salutation)
|
|
|
366 ;; Submit a bug report via mail.
|
|
|
367
|
|
|
368 ;; ADDRESS is the email address for the package's maintainer. PKGNAME is
|
|
|
369 ;; the name of the mode (you must explicitly concat any version numbers).
|
|
|
370 ;; VARLIST is the list of variables to dump (see `reporter-dump-state'
|
|
|
371 ;; for details). Optional PRE-HOOKS and POST-HOOKS are passed to
|
|
|
372 ;; `reporter-dump-state'. Optional SALUTATION is inserted at the top of the
|
|
|
373 ;; mail buffer, and point is left after the salutation.
|
|
|
374
|
|
|
375 ;; This function will prompt for a summary if
|
|
|
376 ;; reporter-prompt-for-summary-p is non-nil.
|
|
|
377
|
|
2
|
378 ;; The mailer used is described in by the variable `mail-user-agent'.
|
|
0
|
379 (let ((reporter-eval-buffer (current-buffer))
|
|
|
380 final-resting-place
|
|
|
381 after-sep-pos
|
|
|
382 (reporter-status-message "Formatting bug report buffer...")
|
|
|
383 (reporter-status-count 0)
|
|
|
384 (problem (and reporter-prompt-for-summary-p
|
|
2
|
385 (read-string (if (stringp reporter-prompt-for-summary-p)
|
|
|
386 reporter-prompt-for-summary-p
|
|
|
387 "(Very) brief summary of problem: "))))
|
|
|
388 (agent (reporter-compose-outgoing))
|
|
|
389 (mailbuf (current-buffer))
|
|
|
390 hookvar)
|
|
|
391 ;; do the work
|
|
0
|
392 (require 'sendmail)
|
|
2
|
393 ;; If mailbuf did not get made visible before, make it visible now.
|
|
|
394 (let (same-window-buffer-names same-window-regexps)
|
|
|
395 (pop-to-buffer mailbuf)
|
|
|
396 ;; Just in case the original buffer is not visible now, bring it
|
|
|
397 ;; back somewhere
|
|
|
398 (display-buffer reporter-eval-buffer))
|
|
0
|
399 (goto-char (point-min))
|
|
|
400 ;; different mailers use different separators, some may not even
|
|
2
|
401 ;; use mail-header-separator, but sendmail.el stuff must have this
|
|
|
402 ;; variable bound.
|
|
0
|
403 (let ((mail-header-separator (reporter-calculate-separator)))
|
|
|
404 (mail-position-on-field "to")
|
|
|
405 (insert address)
|
|
|
406 ;; insert problem summary if available
|
|
|
407 (if (and reporter-prompt-for-summary-p problem pkgname)
|
|
|
408 (progn
|
|
|
409 (mail-position-on-field "subject")
|
|
|
410 (insert pkgname "; " problem)))
|
|
|
411 ;; move point to the body of the message
|
|
|
412 (mail-text)
|
|
|
413 (forward-line 1)
|
|
|
414 (setq after-sep-pos (point))
|
|
|
415 (and salutation (insert "\n" salutation "\n\n"))
|
|
|
416 (unwind-protect
|
|
|
417 (progn
|
|
|
418 (setq final-resting-place (point-marker))
|
|
|
419 (insert "\n\n")
|
|
|
420 (reporter-dump-state pkgname varlist pre-hooks post-hooks)
|
|
|
421 (goto-char final-resting-place))
|
|
|
422 (set-marker final-resting-place nil)))
|
|
|
423
|
|
|
424 ;; save initial text and set up the `no-empty-submission' hook.
|
|
2
|
425 ;; This only works for mailers that support a pre-send hook, and
|
|
|
426 ;; for which the paradigm has a non-nil value for the `hookvar'
|
|
|
427 ;; key in its agent (i.e. sendmail.el's mail-send-hook).
|
|
|
428 (save-excursion
|
|
|
429 (goto-char (point-max))
|
|
|
430 (skip-chars-backward " \t\n")
|
|
|
431 (setq reporter-initial-text (buffer-substring after-sep-pos (point))))
|
|
|
432 (if (setq hookvar (get agent 'hookvar))
|
|
0
|
433 (progn
|
|
2
|
434 (make-variable-buffer-local hookvar)
|
|
|
435 (add-hook hookvar 'reporter-bug-hook)))
|
|
0
|
436
|
|
2
|
437 ;; compose the minibuf message and display this.
|
|
|
438 (let* ((sendkey-whereis (where-is-internal
|
|
|
439 (get agent 'sendfunc) nil t))
|
|
|
440 (abortkey-whereis (where-is-internal
|
|
|
441 (get agent 'abortfunc) nil t))
|
|
|
442 (sendkey (if sendkey-whereis
|
|
|
443 (key-description sendkey-whereis)
|
|
|
444 "C-c C-c")) ; TBD: BOGUS hardcode
|
|
|
445 (abortkey (if abortkey-whereis
|
|
|
446 (key-description abortkey-whereis)
|
|
|
447 "M-x kill-buffer")) ; TBD: BOGUS hardcode
|
|
|
448 )
|
|
|
449 (message "Please enter your report. Type %s to send, %s to abort."
|
|
|
450 sendkey abortkey))
|
|
0
|
451 ))
|
|
|
452
|
|
|
453 (defun reporter-bug-hook ()
|
|
|
454 ;; prohibit sending mail if empty bug report
|
|
|
455 (let ((after-sep-pos
|
|
|
456 (save-excursion
|
|
|
457 (beginning-of-buffer)
|
|
|
458 (re-search-forward (reporter-calculate-separator) (point-max) 'move)
|
|
|
459 (forward-line 1)
|
|
|
460 (point))))
|
|
|
461 (save-excursion
|
|
|
462 (goto-char (point-max))
|
|
|
463 (skip-chars-backward " \t\n")
|
|
|
464 (if (and (= (- (point) after-sep-pos)
|
|
|
465 (length reporter-initial-text))
|
|
|
466 (string= (buffer-substring after-sep-pos (point))
|
|
|
467 reporter-initial-text))
|
|
2
|
468 (error "Empty bug report cannot be sent."))
|
|
0
|
469 )))
|
|
|
470
|
|
|
471
|
|
2
|
472 ;; paradigm definitions
|
|
|
473 (defun define-mail-user-agent (symbol composefunc sendfunc
|
|
|
474 &optional abortfunc hookvar)
|
|
|
475 "Define a symbol appropriate for `mail-user-agent'.
|
|
|
476
|
|
|
477 SYMBOL can be any meaningful lisp symbol. It need not have a function
|
|
|
478 or variable definition, as it is only used for its property list.
|
|
|
479 The property names are equivalent to the formal argument described
|
|
|
480 below (but in lower case). Additional properties can be placed on the
|
|
|
481 symbol.
|
|
|
482
|
|
|
483 COMPOSEFUNC is program callable function that composes an outgoing
|
|
|
484 mail message buffer. This function should set up the basics of the
|
|
|
485 buffer without requiring user interaction. It should populate the
|
|
|
486 standard mail headers, leaving the `to:' and `subject:' headers blank.
|
|
|
487
|
|
|
488 SENDFUNC is the command a user would type to send the message.
|
|
|
489
|
|
|
490 Optional ABORTFUNC is the command a user would type to abort the
|
|
|
491 message. For mail packages that don't have a separate abort function,
|
|
|
492 this can be `kill-buffer' (the equivalent of omitting this argument).
|
|
|
493
|
|
|
494 Optional HOOKVAR is a hook variable that gets run before the message
|
|
|
495 is actually sent. Reporter will install `reporter-bug-hook' onto this
|
|
|
496 hook so that empty bug reports can be suppressed by raising an error.
|
|
|
497 If not supplied, `mail-send-hook' will be used."
|
|
|
498 (put symbol 'composefunc composefunc)
|
|
|
499 (put symbol 'sendfunc sendfunc)
|
|
|
500 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
|
|
|
501 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
|
|
|
502
|
|
|
503 (define-mail-user-agent 'sendmail-user-agent
|
|
|
504 'reporter-mail 'mail-send-and-exit)
|
|
|
505
|
|
|
506 (define-mail-user-agent 'vm-user-agent
|
|
|
507 'vm-mail 'vm-mail-send-and-exit)
|
|
|
508
|
|
|
509 (define-mail-user-agent 'mh-e-user-agent
|
|
|
510 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
|
|
|
511 'mh-before-send-letter-hook)
|
|
|
512
|
|
|
513
|
|
0
|
514 (provide 'reporter)
|
|
|
515 ;;; reporter.el ends here
|
