This commit was generated by cvs2svn to compensate for changes in r473,
[elisp/tm.git] / tm-bbdb.el
1 ;;; tm-bbdb.el --- tm shared module for BBDB
2
3 ;; Copyright (C) 1995,1996 Shuhei KOBAYASHI
4 ;; Copyright (C) 1996 Artur Pioro
5
6 ;; Author: Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
7 ;;         Artur Pioro <artur@flugor.if.uj.edu.pl>
8 ;; Maintainer: Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
9 ;; Version: $Id: tm-bbdb.el,v 7.19 1996/10/22 05:28:23 shuhei-k Exp $
10 ;; Keywords: mail, news, MIME, multimedia, multilingual, BBDB
11
12 ;; This file is part of tm (Tools for MIME).
13
14 ;; This program is free software; you can redistribute it and/or
15 ;; modify it under the terms of the GNU General Public License as
16 ;; published by the Free Software Foundation; either version 2, or (at
17 ;; your option) any later version.
18
19 ;; This program is distributed in the hope that it will be useful, but
20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22 ;; General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
28
29 ;;; Code:
30
31 (require 'bbdb)
32 (require 'bbdb-com)
33 (require 'std11)
34 (require 'tm-ew-d)
35 (require 'tm-view)
36
37
38 ;;; @ mail-extr
39 ;;;
40
41 (defvar tm-bbdb/use-mail-extr t)
42
43 (defun tm-bbdb/extract-address-components (str)
44   (let* ((ret     (std11-extract-address-components str))
45          (phrase  (car ret))
46          (address (car (cdr ret)))
47          (methods tm-bbdb/canonicalize-full-name-methods))
48     (while (and phrase methods)
49       (setq phrase  (funcall (car methods) phrase)
50             methods (cdr methods)))
51     (if (string= address "") (setq address nil))
52     (if (string= phrase "") (setq phrase nil))
53     (list phrase address)
54     ))
55
56 (or tm-bbdb/use-mail-extr
57     (progn
58       (require 'mail-extr) ; for `what-domain'
59       (or (fboundp 'tm:mail-extract-address-components)
60           (fset 'tm:mail-extract-address-components
61                 (symbol-function 'mail-extract-address-components)))
62       (fset 'mail-extract-address-components
63             (symbol-function 'tm-bbdb/extract-address-components))
64       ))
65
66
67 ;;; @ bbdb-extract-field-value
68 ;;;
69
70 (or (fboundp 'tm:bbdb-extract-field-value)
71     (progn
72       ;; (require 'bbdb-hooks) ; not provided.
73       ;; (or (fboundp 'bbdb-extract-field-value) ; defined as autoload
74       (or (fboundp 'bbdb-header-start)
75           (load "bbdb-hooks"))
76       (fset 'tm:bbdb-extract-field-value
77             (symbol-function 'bbdb-extract-field-value))
78       (defun bbdb-extract-field-value (field)
79         (let ((value (tm:bbdb-extract-field-value field)))
80           (and value
81                (mime-eword/decode-string value))))
82       ))
83
84
85 ;;; @ full-name canonicalization methods
86 ;;;
87
88 (defun tm-bbdb/canonicalize-spaces (str)
89   (let (dest)
90     (while (string-match "\\s +" str)
91       (setq dest (cons (substring str 0 (match-beginning 0)) dest))
92       (setq str (substring str (match-end 0)))
93       )
94     (or (string= str "")
95         (setq dest (cons str dest)))
96     (setq dest (nreverse dest))
97     (mapconcat 'identity dest " ")
98     ))
99
100 (defun tm-bbdb/canonicalize-dots (str)
101   (let (dest)
102     (while (string-match "\\." str)
103       (setq dest (cons (substring str 0 (match-end 0)) dest))
104       (setq str (substring str (match-end 0)))
105       )
106     (or (string= str "")
107         (setq dest (cons str dest)))
108     (setq dest (nreverse dest))
109     (mapconcat 'identity dest " ")
110     ))
111
112 (defvar tm-bbdb/canonicalize-full-name-methods
113   '(mime-eword/decode-string
114     tm-bbdb/canonicalize-dots
115     tm-bbdb/canonicalize-spaces))
116
117
118 ;;; @ BBDB functions for mime/viewer-mode
119 ;;;
120
121 (defvar tm-bbdb/auto-create-p nil)
122
123 (defun tm-bbdb/update-record (&optional offer-to-create)
124   "Return the record corresponding to the current MIME previewing message.
125 Creating or modifying it as necessary. A record will be created if
126 tm-bbdb/auto-create-p is non-nil, or if OFFER-TO-CREATE is non-nil and
127 the user confirms the creation."
128   (save-excursion
129     (if (and mime::article/preview-buffer
130              (get-buffer mime::article/preview-buffer))
131         (set-buffer mime::article/preview-buffer))
132     (if bbdb-use-pop-up
133         (tm-bbdb/pop-up-bbdb-buffer offer-to-create)
134       (let* ((from (std11-field-body "From"))
135              (addr (if from
136                        (car (cdr (mail-extract-address-components from))))))
137         (if (or (null from)
138                 (null addr)
139                 (string-match (bbdb-user-mail-names) addr))
140             (setq from (or (std11-field-body "To") from))
141           )
142         (if from
143             (bbdb-annotate-message-sender
144              from t
145              (or (bbdb-invoke-hook-for-value tm-bbdb/auto-create-p)
146                  offer-to-create)
147              offer-to-create))
148         ))))
149
150 (defun tm-bbdb/annotate-sender (string)
151   "Add a line to the end of the Notes field of the BBDB record 
152 corresponding to the sender of this message."
153   (interactive
154    (list (if bbdb-readonly-p
155              (error "The Insidious Big Brother Database is read-only.")
156            (read-string "Comments: "))))
157   (bbdb-annotate-notes (tm-bbdb/update-record t) string))
158
159 (defun tm-bbdb/edit-notes (&optional arg)
160   "Edit the notes field or (with a prefix arg) a user-defined field
161 of the BBDB record corresponding to the sender of this message."
162   (interactive "P")
163   (let ((record (or (tm-bbdb/update-record t)
164                     (error ""))))
165     (bbdb-display-records (list record))
166     (if arg
167         (bbdb-record-edit-property record nil t)
168       (bbdb-record-edit-notes record t))))
169
170 (defun tm-bbdb/show-sender ()
171   "Display the contents of the BBDB for the sender of this message.
172 This buffer will be in bbdb-mode, with associated keybindings."
173   (interactive)
174   (let ((record (tm-bbdb/update-record t)))
175     (if record
176         (bbdb-display-records (list record))
177         (error "unperson"))))
178
179 (defun tm-bbdb/pop-up-bbdb-buffer (&optional offer-to-create)
180   "Make the *BBDB* buffer be displayed along with the MIME preview window(s),
181 displaying the record corresponding to the sender of the current message."
182   (bbdb-pop-up-bbdb-buffer
183    (function
184     (lambda (w)
185       (let ((b (current-buffer)))
186         (set-buffer (window-buffer w))
187         (prog1 (eq major-mode 'mime/viewer-mode)
188           (set-buffer b))))))
189   (let ((bbdb-gag-messages t)
190         (bbdb-use-pop-up nil)
191         (bbdb-electric-p nil))
192     (let ((record (tm-bbdb/update-record offer-to-create))
193           (bbdb-elided-display (bbdb-pop-up-elided-display))
194           (b (current-buffer)))
195       (bbdb-display-records (if record (list record) nil))
196       (or record
197           (delete-windows-on (get-buffer "*BBDB*")))
198       (set-buffer b)
199       record)))
200
201 (defun tm-bbdb/define-keys ()
202   (let ((mime/viewer-mode-map (current-local-map)))
203     (define-key mime/viewer-mode-map ";" 'tm-bbdb/edit-notes)
204     (define-key mime/viewer-mode-map ":" 'tm-bbdb/show-sender)
205     ))
206
207 (add-hook 'mime-viewer/define-keymap-hook 'tm-bbdb/define-keys)
208
209
210 ;;; @ for signature.el
211 ;;;
212
213 (defun signature/get-bbdb-sigtype (addr)
214   "Extract sigtype information from BBDB."
215   (let ((record (bbdb-search-simple nil addr)))
216     (and record
217          (bbdb-record-getprop record 'sigtype))
218     ))
219
220 (defun signature/set-bbdb-sigtype (sigtype addr)
221   "Add sigtype information to BBDB."
222   (let* ((bbdb-notice-hook nil)
223          (record (bbdb-annotate-message-sender 
224                   addr t
225                   (bbdb-invoke-hook-for-value 
226                    bbdb/mail-auto-create-p)
227                   t)))
228     (if record
229         (progn
230           (bbdb-record-putprop record 'sigtype sigtype)
231           (bbdb-change-record record nil))
232       )))
233
234 (defun signature/get-sigtype-from-bbdb (&optional verbose)
235   (let* ((to (std11-field-body "To"))
236          (addr (and to
237                     (car (cdr (mail-extract-address-components to)))))
238          (sigtype (signature/get-bbdb-sigtype addr))
239          return  
240          )
241     (if addr
242         (if verbose
243             (progn
244               (setq return (signature/get-sigtype-interactively sigtype))
245               (if (and (not (string-equal return sigtype))
246                        (y-or-n-p
247                         (format "Register \"%s\" for <%s>? " return addr))
248                        )
249                   (signature/set-bbdb-sigtype return addr)
250                 )
251               return)
252           (or sigtype
253               (signature/get-signature-file-name))
254           ))
255     ))
256
257
258 ;;; @ end
259 ;;;
260
261 (provide 'tm-bbdb)
262
263 (run-hooks 'tm-bbdb-load-hook)
264
265 ;;; end of tm-bbdb.el