lisp/net/eudcb-bbdb.el

   1 ;;; eudcb-bbdb.el --- Emacs Unified Directory Client - BBDB Backend -*- coding: utf-8 -*-
   2
   3 ;; Copyright (C) 1998-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Oscar Figueiredo <oscar@cpe.fr>
   6 ;; Maintainer: Pavel Janík <Pavel@Janik.cz>
   7 ;; Keywords: comm
   8 ;; Package: eudc
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU 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.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26 ;;    This library provides an interface to use BBDB as a backend of
  27 ;;    the Emacs Unified Directory Client.
  28
  29 ;;; Code:
  30
  31 (require 'eudc)
  32
  33 ;; Make it loadable on systems without bbdb.
  34 (require 'bbdb nil t)
  35 (require 'bbdb-com nil t)
  36
  37 ;;{{{      Internal cooking
  38
  39 ;; I don't like this but mapcar does not accept a parameter to the function and
  40 ;; I don't want to use mapcar*
  41 (defvar eudc-bbdb-current-query nil)
  42 (defvar eudc-bbdb-current-return-attributes nil)
  43
  44 (defvar eudc-bbdb-attributes-translation-alist
  45   '((name . lastname)
  46     (email . net)
  47     (phone . phones))
  48   "Alist mapping EUDC attribute names to BBDB names.")
  49
  50 (eudc-protocol-set 'eudc-query-function 'eudc-bbdb-query-internal 'bbdb)
  51 (eudc-protocol-set 'eudc-list-attributes-function nil 'bbdb)
  52 (eudc-protocol-set 'eudc-protocol-attributes-translation-alist
  53                    'eudc-bbdb-attributes-translation-alist 'bbdb)
  54 (eudc-protocol-set 'eudc-bbdb-conversion-alist nil 'bbdb)
  55 (eudc-protocol-set 'eudc-protocol-has-default-query-attributes nil 'bbdb)
  56
  57 (defun eudc-bbdb-format-query (query)
  58   "Format a EUDC query alist into a list suitable to `bbdb-search'."
  59   (let* ((firstname (cdr (assq 'firstname query)))
  60          (lastname (cdr (assq 'lastname query)))
  61          (name (or (and firstname lastname
  62                         (concat firstname " " lastname))
  63                    firstname
  64                    lastname))
  65         (company (cdr (assq 'company query)))
  66         (net (cdr (assq 'net query)))
  67         (notes (cdr (assq 'notes query)))
  68         (phone (cdr (assq 'phone query))))
  69     (list name company net notes phone)))
  70
  71
  72 (defun eudc-bbdb-filter-non-matching-record (record)
  73   "Return RECORD if it matches `eudc-bbdb-current-query', nil otherwise."
  74   (require 'bbdb)
  75   (catch 'unmatch
  76     (progn
  77       (dolist (condition eudc-bbdb-current-query)
  78         (let ((attr (car condition))
  79               (val (cdr condition))
  80               (case-fold-search t)
  81               bbdb-val)
  82           (or (and (memq attr '(firstname lastname aka company phones
  83                                 addresses net))
  84                    (progn
  85                      (setq bbdb-val
  86                            (eval (list (intern (concat "bbdb-record-"
  87                                                        (symbol-name attr)))
  88                                        'record)))
  89                      (if (listp bbdb-val)
  90                          (if eudc-bbdb-enable-substring-matches
  91                              (eval `(or ,@(mapcar (lambda (subval)
  92                                                     (string-match val subval))
  93                                                   bbdb-val)))
  94                            (member (downcase val)
  95                                    (mapcar 'downcase bbdb-val)))
  96                        (if eudc-bbdb-enable-substring-matches
  97                            (string-match val bbdb-val)
  98                          (string-equal (downcase val) (downcase bbdb-val))))))
  99               (throw 'unmatch nil))))
 100       record)))
 101
 102 ;; External.
 103 (declare-function bbdb-phone-location   "ext:bbdb" t) ; via bbdb-defstruct
 104 (declare-function bbdb-phone-string     "ext:bbdb" (phone))
 105 (declare-function bbdb-record-phones    "ext:bbdb" t) ; via bbdb-defstruct
 106 (declare-function bbdb-address-streets  "ext:bbdb" t) ; via bbdb-defstruct
 107 (declare-function bbdb-address-city     "ext:bbdb" t) ; via bbdb-defstruct
 108 (declare-function bbdb-address-state    "ext:bbdb" t) ; via bbdb-defstruct
 109 (declare-function bbdb-address-zip      "ext:bbdb" t) ; via bbdb-defstruct
 110 (declare-function bbdb-address-location "ext:bbdb" t) ; via bbdb-defstruct
 111 (declare-function bbdb-record-addresses "ext:bbdb" t) ; via bbdb-defstruct
 112 (declare-function bbdb-records          "ext:bbdb"
 113                   (&optional dont-check-disk already-in-db-buffer))
 114
 115 (defun eudc-bbdb-extract-phones (record)
 116   (require 'bbdb)
 117   (mapcar (function
 118            (lambda (phone)
 119              (if eudc-bbdb-use-locations-as-attribute-names
 120                  (cons (intern (bbdb-phone-location phone))
 121                        (bbdb-phone-string phone))
 122                (cons 'phones (format "%s: %s"
 123                                      (bbdb-phone-location phone)
 124                                      (bbdb-phone-string phone))))))
 125           (bbdb-record-phones record)))
 126
 127 (defun eudc-bbdb-extract-addresses (record)
 128   (require 'bbdb)
 129   (let (s c val)
 130     (mapcar (lambda (address)
 131               (setq c (bbdb-address-streets address))
 132               (dotimes (n 3)
 133                 (unless (zerop (length (setq s (nth n c))))
 134                   (setq val (concat val s "\n"))))
 135               (setq c (bbdb-address-city address)
 136                     s (bbdb-address-state address))
 137               (setq val (concat val
 138                                 (if (and (> (length c) 0) (> (length s) 0))
 139                                     (concat c ", " s)
 140                                   c)
 141                                 " "
 142                                 (bbdb-address-zip address)))
 143               (if eudc-bbdb-use-locations-as-attribute-names
 144                   (cons (intern (bbdb-address-location address)) val)
 145                 (cons 'addresses (concat (bbdb-address-location address)
 146                                          "\n" val))))
 147             (bbdb-record-addresses record))))
 148
 149 (defun eudc-bbdb-format-record-as-result (record)
 150   "Format the BBDB RECORD as a EUDC query result record.
 151 The record is filtered according to `eudc-bbdb-current-return-attributes'"
 152   (require 'bbdb)
 153   (let ((attrs (or eudc-bbdb-current-return-attributes
 154                    '(firstname lastname aka company phones addresses net notes)))
 155         attr
 156         eudc-rec
 157         val)
 158     (while (prog1
 159                (setq attr (car attrs))
 160              (setq attrs (cdr attrs)))
 161       (cond
 162        ((eq attr 'phones)
 163         (setq val (eudc-bbdb-extract-phones record)))
 164        ((eq attr 'addresses)
 165         (setq val (eudc-bbdb-extract-addresses record)))
 166        ((memq attr '(firstname lastname aka company net notes))
 167         (setq val (eval
 168                    (list (intern
 169                           (concat "bbdb-record-"
 170                                   (symbol-name attr)))
 171                          'record))))
 172        (t
 173         (error "Unknown BBDB attribute")))
 174       (cond
 175        ((or (not val) (equal val ""))) ; do nothing
 176        ((memq attr '(phones addresses))
 177         (setq eudc-rec (append val eudc-rec)))
 178        ((and (listp val)
 179              (= 1 (length val)))
 180         (setq eudc-rec (cons (cons attr (car val)) eudc-rec)))
 181        ((> (length val) 0)
 182         (setq eudc-rec (cons (cons attr val) eudc-rec)))
 183        (t
 184         (error "Unexpected attribute value"))))
 185     (nreverse eudc-rec)))
 186
 187
 188
 189 (defun eudc-bbdb-query-internal (query &optional return-attrs)
 190   "Query BBDB  with QUERY.
 191 QUERY is a list of cons cells (ATTR . VALUE) where ATTRs should be valid
 192 BBDB attribute names.
 193 RETURN-ATTRS is a list of attributes to return, defaulting to
 194 `eudc-default-return-attributes'."
 195   (require 'bbdb)
 196   (let ((eudc-bbdb-current-query query)
 197         (eudc-bbdb-current-return-attributes return-attrs)
 198         (query-attrs (eudc-bbdb-format-query query))
 199         bbdb-attrs
 200         (records (bbdb-records))
 201         result
 202         filtered)
 203     ;; BBDB ORs its query attributes while EUDC ANDs them, hence we need to
 204     ;; call bbdb-search iteratively on the returned records for each of the
 205     ;; requested attributes
 206     (while (and records (> (length query-attrs) 0))
 207       (setq bbdb-attrs (append bbdb-attrs (list (car query-attrs))))
 208       (if (car query-attrs)
 209           (setq records (eval `(bbdb-search ,(quote records) ,@bbdb-attrs))))
 210       (setq query-attrs (cdr query-attrs)))
 211     (mapc (function
 212            (lambda (record)
 213              (setq filtered (eudc-filter-duplicate-attributes record))
 214              ;; If there were duplicate attributes reverse the order of the
 215              ;; record so the unique attributes appear first
 216              (if (> (length filtered) 1)
 217                  (setq filtered (mapcar (function
 218                                          (lambda (rec)
 219                                            (reverse rec)))
 220                                         filtered)))
 221              (setq result (append result filtered))))
 222           (delq nil
 223                 (mapcar 'eudc-bbdb-format-record-as-result
 224                         (delq nil
 225                               (mapcar 'eudc-bbdb-filter-non-matching-record
 226                                       records)))))
 227     result))
 228
 229 ;;}}}
 230
 231 ;;{{{      High-level interfaces (interactive functions)
 232
 233 (defun eudc-bbdb-set-server (dummy)
 234   "Set the EUDC server to BBDB."
 235   (interactive)
 236   (eudc-set-server dummy 'bbdb)
 237   (message "BBDB server selected"))
 238
 239 ;;}}}
 240
 241
 242 (eudc-register-protocol 'bbdb)
 243
 244 (provide 'eudcb-bbdb)
 245
 246 ;;; eudcb-bbdb.el ends here