mime-bbdb.el

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