1 ;;; eudc.el --- Emacs Unified Directory Client
3 ;; Copyright (C) 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
5 ;; Author: Oscar Figueiredo <oscar@cpe.fr>
6 ;; Maintainer: Pavel JanÃk <Pavel@Janik.cz>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
27 ;; This package provides a common interface to query directory servers using
28 ;; different protocols such as LDAP, CCSO PH/QI or BBDB. Queries can be
29 ;; made through an interactive form or inline. Inline query strings in
30 ;; buffers are expanded with appropriately formatted query results
31 ;; (especially used to expand email addresses in message buffers). EUDC
32 ;; also interfaces with the BBDB package to let you register query results
33 ;; into your own BBDB database.
36 ;; EUDC comes with an extensive documentation, please refer to it.
38 ;; The main entry points of EUDC are:
39 ;; `eudc-query-form': Query a directory server from a query form
40 ;; `eudc-expand-inline': Query a directory server for the e-mail address
41 ;; of the name before cursor and insert it in the
43 ;; `eudc-get-phone': Get a phone number from a directory server
44 ;; `eudc-get-email': Get an e-mail address from a directory server
45 ;; `eudc-customize': Customize various aspects of EUDC
52 (if (not (fboundp 'make-overlay
))
54 (if (not (fboundp 'unless
))
57 (unless (fboundp 'custom-menu-create
)
58 (autoload 'custom-menu-create
"cus-edit"))
64 ;;{{{ Internal cooking
66 ;;{{{ Internal variables and compatibility tricks
68 (defconst eudc-xemacs-p
(string-match "XEmacs" emacs-version
))
69 (defconst eudc-emacs-p
(not eudc-xemacs-p
))
70 (defconst eudc-xemacs-mule-p
(and eudc-xemacs-p
72 (defconst eudc-emacs-mule-p
(and eudc-emacs-p
75 (defvar eudc-form-widget-list nil
)
76 (defvar eudc-mode-map nil
)
78 ;; List of known servers
79 ;; Alist of (SERVER . PROTOCOL)
80 (defvar eudc-server-hotlist nil
)
82 ;; List of variables that have server- or protocol-local bindings
83 (defvar eudc-local-vars nil
)
85 ;; Protocol local. Query function
86 (defvar eudc-query-function nil
)
88 ;; Protocol local. A function that retrieves a list of valid attribute names
89 (defvar eudc-list-attributes-function nil
)
91 ;; Protocol local. A mapping between EUDC attribute names and corresponding
92 ;; protocol specific names. The following names are defined by EUDC and may be
93 ;; included in that list: `name' , `firstname', `email', `phone'
94 (defvar eudc-protocol-attributes-translation-alist nil
)
96 ;; Protocol local. Mapping between protocol attribute names and BBDB field
98 (defvar eudc-bbdb-conversion-alist nil
)
100 ;; Protocol/Server local. Hook called upon switching to that server
101 (defvar eudc-switch-to-server-hook nil
)
103 ;; Protocol/Server local. Hook called upon switching from that server
104 (defvar eudc-switch-from-server-hook nil
)
106 ;; Protocol local. Whether the protocol supports queries with no specified
108 (defvar eudc-protocol-has-default-query-attributes nil
)
110 (defun eudc-cadr (obj)
113 (defun eudc-cdar (obj)
116 (defun eudc-caar (obj)
119 (defun eudc-cdaar (obj)
120 (cdr (car (car obj
))))
122 (defun eudc-plist-member (plist prop
)
123 "Return t if PROP has a value specified in PLIST."
124 (if (not (= 0 (%
(length plist
) 2)))
125 (error "Malformed plist"))
128 (if (eq prop
(car plist
))
130 (setq plist
(cdr (cdr plist
))))
133 ;; Emacs' plist-get lacks third parameter
134 (defun eudc-plist-get (plist prop
&optional default
)
135 "Extract a value from a property list.
136 PLIST is a property list, which is a list of the form
137 \(PROP1 VALUE1 PROP2 VALUE2...). This function returns the value
138 corresponding to the given PROP, or DEFAULT if PROP is not
139 one of the properties on the list."
140 (if (eudc-plist-member plist prop
)
141 (plist-get plist prop
)
144 (defun eudc-lax-plist-get (plist prop
&optional default
)
145 "Extract a value from a lax property list.
147 PLIST is a lax property list, which is a list of the form (PROP1
148 VALUE1 PROP2 VALUE2...), where comparisons between properties are done
149 using `equal' instead of `eq'. This function returns the value
150 corresponding to PROP, or DEFAULT if PROP is not one of the
151 properties on the list."
152 (if (not (= 0 (%
(length plist
) 2)))
153 (error "Malformed plist"))
156 (if (equal prop
(car plist
))
157 (throw 'found
(car (cdr plist
))))
158 (setq plist
(cdr (cdr plist
))))
161 (if (not (fboundp 'split-string
))
162 (defun split-string (string &optional pattern
)
163 "Return a list of substrings of STRING which are separated by PATTERN.
164 If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
166 (setq pattern
"[ \f\t\n\r\v]+"))
167 (let (parts (start 0))
168 (when (string-match pattern string
0)
169 (if (> (match-beginning 0) 0)
170 (setq parts
(cons (substring string
0 (match-beginning 0)) nil
)))
171 (setq start
(match-end 0))
172 (while (and (string-match pattern string start
)
173 (> (match-end 0) start
))
174 (setq parts
(cons (substring string start
(match-beginning 0)) parts
)
175 start
(match-end 0))))
176 (nreverse (if (< start
(length string
))
177 (cons (substring string start
) parts
)
180 (defun eudc-replace-in-string (str regexp newtext
)
181 "Replace all matches in STR for REGEXP with NEWTEXT.
182 Value is the new string."
186 (while (setq match
(string-match regexp str start
))
187 (setq prev-start start
191 (substring str prev-start match
)
193 (concat rtn-str
(substring str start
))))
197 ;;{{{ Server and Protocol Variable Routines
199 (defun eudc-server-local-variable-p (var)
200 "Return non-nil if VAR has server-local bindings."
201 (eudc-plist-member (get var
'eudc-locals
) 'server
))
203 (defun eudc-protocol-local-variable-p (var)
204 "Return non-nil if VAR has protocol-local bindings."
205 (eudc-plist-member (get var
'eudc-locals
) 'protocol
))
207 (defun eudc-default-set (var val
)
208 "Set the EUDC default value of VAR to VAL.
209 The current binding of VAR is not changed."
210 (put var
'eudc-locals
211 (plist-put (get var
'eudc-locals
) 'default val
))
212 (add-to-list 'eudc-local-vars var
))
214 (defun eudc-protocol-set (var val
&optional protocol
)
215 "Set the PROTOCOL-local binding of VAR to VAL.
216 If omitted PROTOCOL defaults to the current value of `eudc-protocol'.
217 The current binding of VAR is changed only if PROTOCOL is omitted."
218 (if (eq 'unbound
(eudc-variable-default-value var
))
219 (eudc-default-set var
(symbol-value var
)))
220 (let* ((eudc-locals (get var
'eudc-locals
))
221 (protocol-locals (eudc-plist-get eudc-locals
'protocol
)))
222 (setq protocol-locals
(plist-put protocol-locals
(or protocol
225 (plist-put eudc-locals
'protocol protocol-locals
))
226 (put var
'eudc-locals eudc-locals
)
227 (add-to-list 'eudc-local-vars var
)
229 (eudc-update-variable var
))))
231 (defun eudc-server-set (var val
&optional server
)
232 "Set the SERVER-local binding of VAR to VAL.
233 If omitted SERVER defaults to the current value of `eudc-server'.
234 The current binding of VAR is changed only if SERVER is omitted."
235 (if (eq 'unbound
(eudc-variable-default-value var
))
236 (eudc-default-set var
(symbol-value var
)))
237 (let* ((eudc-locals (get var
'eudc-locals
))
238 (server-locals (eudc-plist-get eudc-locals
'server
)))
239 (setq server-locals
(plist-put server-locals
(or server
242 (plist-put eudc-locals
'server server-locals
))
243 (put var
'eudc-locals eudc-locals
)
244 (add-to-list 'eudc-local-vars var
)
246 (eudc-update-variable var
))))
249 (defun eudc-set (var val
)
250 "Set the most local (server, protocol or default) binding of VAR to VAL.
251 The current binding of VAR is also set to VAL"
253 ((not (eq 'unbound
(eudc-variable-server-value var
)))
254 (eudc-server-set var val
))
255 ((not (eq 'unbound
(eudc-variable-protocol-value var
)))
256 (eudc-protocol-set var val
))
258 (eudc-default-set var val
)))
261 (defun eudc-variable-default-value (var)
262 "Return the default binding of VAR.
263 Return `unbound' if VAR has no EUDC default value."
264 (let ((eudc-locals (get var
'eudc-locals
)))
265 (if (and (boundp var
)
267 (eudc-plist-get eudc-locals
'default
'unbound
)
270 (defun eudc-variable-protocol-value (var &optional protocol
)
271 "Return the value of VAR local to PROTOCOL.
272 Return `unbound' if VAR has no value local to PROTOCOL.
273 PROTOCOL defaults to `eudc-protocol'"
274 (let* ((eudc-locals (get var
'eudc-locals
))
276 (if (not (and (boundp var
)
278 (eudc-plist-member eudc-locals
'protocol
)))
280 (setq protocol-locals
(eudc-plist-get eudc-locals
'protocol
))
281 (eudc-lax-plist-get protocol-locals
283 eudc-protocol
) 'unbound
))))
285 (defun eudc-variable-server-value (var &optional server
)
286 "Return the value of VAR local to SERVER.
287 Return `unbound' if VAR has no value local to SERVER.
288 SERVER defaults to `eudc-server'"
289 (let* ((eudc-locals (get var
'eudc-locals
))
291 (if (not (and (boundp var
)
293 (eudc-plist-member eudc-locals
'server
)))
295 (setq server-locals
(eudc-plist-get eudc-locals
'server
))
296 (eudc-lax-plist-get server-locals
298 eudc-server
) 'unbound
))))
300 (defun eudc-update-variable (var)
301 "Set the value of VAR according to its locals.
302 If the VAR has a server- or protocol-local value corresponding
303 to the current `eudc-server' and `eudc-protocol' then it is set
304 accordingly. Otherwise it is set to its EUDC default binding"
307 ((not (eq 'unbound
(setq val
(eudc-variable-server-value var
))))
309 ((not (eq 'unbound
(setq val
(eudc-variable-protocol-value var
))))
311 ((not (eq 'unbound
(setq val
(eudc-variable-default-value var
))))
314 (defun eudc-update-local-variables ()
315 "Update all EUDC variables according to their local settings."
317 (mapcar 'eudc-update-variable eudc-local-vars
))
319 (eudc-default-set 'eudc-query-function nil
)
320 (eudc-default-set 'eudc-list-attributes-function nil
)
321 (eudc-default-set 'eudc-protocol-attributes-translation-alist nil
)
322 (eudc-default-set 'eudc-bbdb-conversion-alist nil
)
323 (eudc-default-set 'eudc-switch-to-server-hook nil
)
324 (eudc-default-set 'eudc-switch-from-server-hook nil
)
325 (eudc-default-set 'eudc-protocol-has-default-query-attributes nil
)
326 (eudc-default-set 'eudc-attribute-display-method-alist nil
)
331 ;; Add PROTOCOL to the list of supported protocols
332 (defun eudc-register-protocol (protocol)
333 (unless (memq protocol eudc-supported-protocols
)
334 (setq eudc-supported-protocols
335 (cons protocol eudc-supported-protocols
))
336 (put 'eudc-protocol
'custom-type
337 `(choice :menu-tag
"Protocol"
338 ,@(mapcar (lambda (s)
339 (list 'string
':tag
(symbol-name s
)))
340 eudc-supported-protocols
))))
341 (or (memq protocol eudc-known-protocols
)
342 (setq eudc-known-protocols
343 (cons protocol eudc-known-protocols
))))
346 (defun eudc-translate-query (query)
347 "Translate attribute names of QUERY.
348 The translation is done according to
349 `eudc-protocol-attributes-translation-alist'."
350 (if eudc-protocol-attributes-translation-alist
351 (mapcar '(lambda (attribute)
352 (let ((trans (assq (car attribute
)
353 (symbol-value eudc-protocol-attributes-translation-alist
))))
355 (cons (cdr trans
) (cdr attribute
))
360 (defun eudc-translate-attribute-list (list)
361 "Translate a list of attribute names LIST.
362 The translation is done according to
363 `eudc-protocol-attributes-translation-alist'."
364 (if eudc-protocol-attributes-translation-alist
366 (mapcar '(lambda (attribute)
367 (setq trans
(assq attribute
368 (symbol-value eudc-protocol-attributes-translation-alist
)))
375 (defun eudc-select (choices beg end
)
376 "Choose one from CHOICES using a completion.
377 BEG and END delimit the text which is to be replaced."
380 (completing-read "Multiple matches found; choose one:"
381 (mapcar 'list choices
)))
382 (delete-region beg end
)
383 (insert replacement
)))
385 (defun eudc-query (query &optional return-attributes no-translation
)
386 "Query the current directory server with QUERY.
387 QUERY is a list of cons cells (ATTR . VALUE) where ATTR is an attribute
388 name and VALUE the corresponding value.
389 If NO-TRANSLATION is non-nil, ATTR is translated according to
390 `eudc-protocol-attributes-translation-alist'.
391 RETURN-ATTRIBUTES is a list of attributes to return defaulting to
392 `eudc-default-return-attributes'."
393 (unless eudc-query-function
394 (error "Don't know how to perform the query"))
396 (funcall eudc-query-function query
(or return-attributes
397 eudc-default-return-attributes
))
399 (funcall eudc-query-function
400 (eudc-translate-query query
)
403 (eudc-translate-attribute-list return-attributes
))
404 ((listp eudc-default-return-attributes
)
405 (eudc-translate-attribute-list eudc-default-return-attributes
))
407 eudc-default-return-attributes
)))))
409 (defun eudc-format-attribute-name-for-display (attribute)
410 "Format a directory attribute name for display.
411 ATTRIBUTE is looked up in `eudc-user-attribute-names-alist' and replaced
412 by the corresponding user name if any. Otherwise it is capitalized and
413 underscore characters are replaced by spaces."
414 (let ((match (assq attribute eudc-user-attribute-names-alist
)))
419 (split-string (symbol-name attribute
) "_")
422 (defun eudc-print-attribute-value (field)
423 "Insert the value of the directory FIELD at point.
424 The directory attribute name in car of FIELD is looked up in
425 `eudc-attribute-display-method-alist' and the corresponding method,
426 if any, is called to print the value in cdr of FIELD."
427 (let ((match (assoc (downcase (car field
))
428 eudc-attribute-display-method-alist
))
429 (col (current-column))
433 (eval (list (cdr match
) val
))
439 (insert val-elem
"\n")))
442 ((stringp val
) (split-string val
"\n"))
446 (defun eudc-print-record-field (field column-width
)
447 "Print the record field FIELD.
448 FIELD is a list (ATTR VALUE1 VALUE2 ...) or cons-cell (ATTR . VAL)
449 COLUMN-WIDTH is the width of the first display column containing the
450 attribute name ATTR."
451 (let ((field-beg (point)))
452 ;; The record field that is passed to this function has already been processed
453 ;; by `eudc-format-attribute-name-for-display' so we don't need to call it
454 ;; again to display the attribute name
455 (insert (format (concat "%" (int-to-string column-width
) "s: ")
457 (put-text-property field-beg
(point) 'face
'bold
)
458 (indent-to (+ 2 column-width
))
459 (eudc-print-attribute-value field
)))
461 (defun eudc-display-records (records &optional raw-attr-names
)
462 "Display the record list RECORDS in a formatted buffer.
463 If RAW-ATTR-NAMES is non-nil, the raw attribute names are displayed
464 otherwise they are formatted according to `eudc-user-attribute-names-alist'."
465 (let (inhibit-read-only
471 (with-output-to-temp-buffer "*Directory Query Results*"
472 (with-current-buffer standard-output
473 (setq buffer-read-only t
)
474 (setq inhibit-read-only t
)
476 (insert "Directory Query Result\n")
477 (insert "======================\n\n\n")
479 (insert "No match found.\n"
480 (if eudc-strict-return-matches
481 "Try setting `eudc-strict-return-matches' to nil or change `eudc-default-return-attributes'.\n"
483 ;; Replace field names with user names, compute max width
493 (symbol-name (car field
))
494 (eudc-format-attribute-name-for-display (car field
))))
495 (if (> (length attribute-name
) width
)
496 (setq width
(length attribute-name
)))
497 (cons attribute-name
(cdr field
))))
500 ;; Display the records
501 (setq first-record
(point))
506 ;; Map over the record fields to print the attribute/value pairs
509 (eudc-print-record-field field width
)))
511 ;; Store the record internal format in some convenient place
512 (overlay-put (make-overlay beg
(point))
515 (setq records
(cdr records
))
519 (widget-create 'push-button
520 :notify
(lambda (&rest ignore
)
524 (widget-create 'push-button
525 :notify
(lambda (&rest ignore
)
531 (goto-char first-record
))))))
533 (defun eudc-process-form ()
534 "Process the query form in current buffer and display the results."
537 (if (not (and (boundp 'eudc-form-widget-list
)
538 eudc-form-widget-list
))
539 (error "Not in a directory query form buffer")
542 (setq value
(widget-value (cdr wid-field
)))
543 (if (not (string= value
""))
544 (setq query-alist
(cons (cons (car wid-field
) value
)
546 eudc-form-widget-list
)
547 (kill-buffer (current-buffer))
548 (eudc-display-records (eudc-query query-alist
) eudc-use-raw-directory-names
))))
551 (defun eudc-filter-duplicate-attributes (record)
552 "Filter RECORD according to `eudc-duplicate-attribute-handling-method'."
558 ;; Search for multiple records
560 (not (listp (eudc-cdar rec
))))
561 (setq rec
(cdr rec
)))
563 (if (null (eudc-cdar rec
))
564 (list record
) ; No duplicate attrs in this record
567 (if (listp (cdr field
))
568 (setq duplicates
(cons field duplicates
))
569 (setq unique
(cons field unique
)))))
571 (setq result
(list unique
))
572 ;; Map over the record fields that have multiple values
576 (let ((method (if (consp eudc-duplicate-attribute-handling-method
)
584 eudc-protocol-attributes-translation-alist
)))
586 eudc-duplicate-attribute-handling-method
))
587 eudc-duplicate-attribute-handling-method
)))
589 ((or (null method
) (eq 'list method
))
591 (eudc-add-field-to-records field result
)))
594 (eudc-add-field-to-records (cons (car field
)
599 (eudc-add-field-to-records (cons (car field
)
604 ((eq 'duplicate method
)
606 (eudc-distribute-field-on-records field result
)))))))
610 (defun eudc-filter-partial-records (records attrs
)
611 "Eliminate records that do not contain all ATTRS from RECORDS."
620 (consp (assq attr rec
))))
625 (defun eudc-add-field-to-records (field records
)
626 "Add FIELD to each individual record in RECORDS and return the resulting list."
632 (defun eudc-distribute-field-on-records (field records
)
633 "Duplicate each individual record in RECORDS according to value of FIELD.
634 Each copy is added a new field containing one of the values of FIELD."
636 (values (cdr field
)))
637 ;; Uniquify values first
639 (setcdr values
(delete (car values
) (cdr values
)))
640 (setq values
(cdr values
)))
644 (let ((result-list (copy-sequence records
)))
645 (setq result-list
(eudc-add-field-to-records
646 (cons (car field
) value
)
648 (setq result
(append result-list result
))
655 "Major mode used in buffers displaying the results of directory queries.
656 There is no sense in calling this command from a buffer other than
657 one containing the results of a directory query.
659 These are the special commands of EUDC mode:
660 q -- Kill this buffer.
661 f -- Display a form to query the current directory server.
662 n -- Move to next record.
663 p -- Move to previous record.
664 b -- Insert record at point into the BBDB database."
666 (kill-all-local-variables)
667 (setq major-mode
'eudc-mode
)
668 (setq mode-name
"EUDC")
669 (use-local-map eudc-mode-map
)
671 (easy-menu-define eudc-emacs-menu eudc-mode-map
"" (eudc-menu))
672 (setq mode-popup-menu
(eudc-menu)))
673 (run-hooks 'eudc-mode-hook
)
678 ;;{{{ High-level interfaces (interactive functions)
680 (defun eudc-customize ()
681 "Customize the EUDC package."
683 (customize-group 'eudc
))
686 (defun eudc-set-server (server protocol
&optional no-save
)
687 "Set the directory server to SERVER using PROTOCOL.
688 Unless NO-SAVE is non-nil, the server is saved as the default
689 server for future sessions."
691 (read-from-minibuffer "Directory Server: ")
692 (intern (completing-read "Protocol: "
693 (mapcar '(lambda (elt)
694 (cons (symbol-name elt
)
696 eudc-known-protocols
)))))
697 (unless (or (member protocol
698 eudc-supported-protocols
)
699 (load (concat "eudcb-" (symbol-name protocol
)) t
))
700 (error "Unsupported protocol: %s" protocol
))
701 (run-hooks 'eudc-switch-from-server-hook
)
702 (setq eudc-protocol protocol
)
703 (setq eudc-server server
)
704 (eudc-update-local-variables)
705 (run-hooks 'eudc-switch-to-server-hook
)
707 (message "Current directory server is now %s (%s)" eudc-server eudc-protocol
))
709 (eudc-save-options)))
712 (defun eudc-get-email (name &optional error
)
713 "Get the email field of NAME from the directory server.
714 If ERROR is non-nil, report an error if there is none."
715 (interactive "sName: \np")
717 (call-interactively 'eudc-set-server
))
718 (let ((result (eudc-query (list (cons 'name name
)) '(email)))
720 (if (null (cdr result
))
721 (setq email
(eudc-cdaar result
))
722 (error "Multiple match--use the query form"))
726 (error "No record matching %s" name
)))
730 (defun eudc-get-phone (name &optional error
)
731 "Get the phone field of NAME from the directory server.
732 If ERROR is non-nil, report an error if there is none."
733 (interactive "sName: \np")
735 (call-interactively 'eudc-set-server
))
736 (let ((result (eudc-query (list (cons 'name name
)) '(phone)))
738 (if (null (cdr result
))
739 (setq phone
(eudc-cdaar result
))
740 (error "Multiple match--use the query form"))
744 (error "No record matching %s" name
)))
747 (defun eudc-get-attribute-list ()
748 "Return a list of valid attributes for the current server.
749 When called interactively the list is formatted in a dedicated buffer
750 otherwise a list of symbols is returned."
752 (if eudc-list-attributes-function
753 (let ((entries (funcall eudc-list-attributes-function
(interactive-p))))
756 (eudc-display-records entries t
)
758 (error "The %s protocol has no support for listing attributes" eudc-protocol
)))
760 (defun eudc-format-query (words format
)
761 "Use FORMAT to build a EUDC query from WORDS."
767 (while (and words format
)
768 (setq query-alist
(cons (cons (car format
) (car words
))
770 (setq words
(cdr words
)
771 format
(cdr format
)))
772 ;; If the same attribute appears more than once, merge
773 ;; the corresponding values
774 (setq query-alist
(nreverse query-alist
))
776 (setq key
(eudc-caar query-alist
)
777 val
(eudc-cdar query-alist
)
778 cell
(assq key query
))
780 (setcdr cell
(concat (cdr cell
) " " val
))
781 (setq query
(cons (car query-alist
) query
)))
782 (setq query-alist
(cdr query-alist
)))
784 (if eudc-protocol-has-default-query-attributes
785 (mapconcat 'identity words
" ")
786 (list (cons 'name
(mapconcat 'identity words
" ")))))))
788 (defun eudc-extract-n-word-formats (format-list n
)
789 "Extract a list of N-long formats from FORMAT-LIST.
790 If none try N - 1 and so forth."
792 (while (and (null formats
)
796 (mapcar '(lambda (format)
807 (defun eudc-expand-inline (&optional replace
)
808 "Query the directory server, and expand the query string before point.
809 The query string consists of the buffer substring from the point back to
810 the preceding comma, colon or beginning of line.
811 The variable `eudc-inline-query-format' controls how to associate the
812 individual inline query words with directory attribute names.
813 After querying the server for the given string, the expansion specified by
814 `eudc-inline-expansion-format' is inserted in the buffer at point.
815 If REPLACE is non-nil, then this expansion replaces the name in the buffer.
816 `eudc-expansion-overwrites-query' being non-nil inverts the meaning of REPLACE.
817 Multiple servers can be tried with the same query until one finds a match,
818 see `eudc-inline-expansion-servers'"
820 (if (memq eudc-inline-expansion-servers
821 '(current-server server-then-hotlist
))
823 (call-interactively 'eudc-set-server
))
824 (or eudc-server-hotlist
825 (error "No server in the hotlist")))
828 (if (re-search-backward "\\([:,]\\|^\\)[ \t]*"
833 (goto-char (match-end 0)))
835 (query-words (split-string (buffer-substring beg end
) "[ \t]+"))
840 (eudc-former-server eudc-server
)
841 (eudc-former-protocol eudc-protocol
)
844 ;; Prepare the list of servers to query
845 (setq servers
(copy-sequence eudc-server-hotlist
))
848 ((eq eudc-inline-expansion-servers
'hotlist
)
850 ((eq eudc-inline-expansion-servers
'server-then-hotlist
)
851 (cons (cons eudc-server eudc-protocol
)
852 (delete (cons eudc-server eudc-protocol
) servers
)))
853 ((eq eudc-inline-expansion-servers
'current-server
)
854 (list (cons eudc-server eudc-protocol
)))
856 (error "Wrong value for `eudc-inline-expansion-servers': %S"
857 eudc-inline-expansion-servers
))))
858 (if (and eudc-max-servers-to-query
859 (> (length servers
) eudc-max-servers-to-query
))
860 (setcdr (nthcdr (1- eudc-max-servers-to-query
) servers
) nil
))
862 (condition-case signal
866 ;; Loop on the servers
868 (eudc-set-server (eudc-caar servers
) (eudc-cdar servers
) t
)
870 ;; Determine which formats apply in the query-format list
873 (eudc-extract-n-word-formats eudc-inline-query-format
874 (length query-words
))
875 (if (null eudc-protocol-has-default-query-attributes
)
878 ;; Loop on query-formats
882 (eudc-format-query query-words
(car query-formats
))
883 (eudc-translate-attribute-list
884 (cdr eudc-inline-expansion-format
))))
886 (throw 'found response
))
887 (setq query-formats
(cdr query-formats
)))
888 (setq servers
(cdr servers
)))
889 ;; No more servers to try... no match found
896 ;; Process response through eudc-inline-expansion-format
898 (setq response-string
(apply 'format
899 (car eudc-inline-expansion-format
)
902 (or (cdr (assq field
(car response
)))
904 (eudc-translate-attribute-list
905 (cdr eudc-inline-expansion-format
)))))
906 (if (> (length response-string
) 0)
907 (setq response-strings
908 (cons response-string response-strings
)))
909 (setq response
(cdr response
)))
912 (and replace
(not eudc-expansion-overwrites-query
))
913 (and (not replace
) eudc-expansion-overwrites-query
))
914 (kill-ring-save beg end
))
916 ((or (= (length response-strings
) 1)
917 (null eudc-multiple-match-handling-method
)
918 (eq eudc-multiple-match-handling-method
'first
))
919 (delete-region beg end
)
920 (insert (car response-strings
)))
921 ((eq eudc-multiple-match-handling-method
'select
)
922 (eudc-select response-strings beg end
))
923 ((eq eudc-multiple-match-handling-method
'all
)
924 (insert (mapconcat 'identity response-strings
", ")))
925 ((eq eudc-multiple-match-handling-method
'abort
)
926 (error "There is more than one match for the query"))))
927 (or (and (equal eudc-server eudc-former-server
)
928 (equal eudc-protocol eudc-former-protocol
))
929 (eudc-set-server eudc-former-server eudc-former-protocol t
)))
931 (or (and (equal eudc-server eudc-former-server
)
932 (equal eudc-protocol eudc-former-protocol
))
933 (eudc-set-server eudc-former-server eudc-former-protocol t
))
934 (signal (car signal
) (cdr signal
))))))
937 (defun eudc-query-form (&optional get-fields-from-server
)
938 "Display a form to query the directory server.
939 If given a non-nil argument GET-FIELDS-FROM-SERVER, the function first
940 queries the server for the existing fields and displays a corresponding form."
942 (let ((fields (or (and get-fields-from-server
943 (eudc-get-attribute-list))
944 eudc-query-form-attributes
))
945 (buffer (get-buffer-create "*Directory Query Form*"))
951 (switch-to-buffer buffer
)
952 (setq inhibit-read-only t
)
954 (kill-all-local-variables)
955 (make-local-variable 'eudc-form-widget-list
)
956 (widget-insert "Directory Query Form\n")
957 (widget-insert "====================\n\n")
958 (widget-insert "Current server is: " (or eudc-server
960 (call-interactively 'eudc-set-server
)
963 (widget-insert "Protocol : " (symbol-name eudc-protocol
) "\n")
964 ;; Build the list of prompts
965 (setq prompts
(if eudc-use-raw-directory-names
966 (mapcar 'symbol-name
(eudc-translate-attribute-list fields
))
969 (or (and (assq field eudc-user-attribute-names-alist
)
970 (cdr (assq field eudc-user-attribute-names-alist
)))
971 (capitalize (symbol-name field
)))))
973 ;; Loop over prompt strings to find the longest one
976 (if (> (length prompt
) width
)
977 (setq width
(length prompt
)))))
979 ;; Insert the first widget out of the mapcar to leave the cursor
980 ;; in the first field
981 (widget-insert "\n\n" (format (concat "%" (int-to-string width
) "s: ") (car prompts
)))
983 (setq widget
(widget-create 'editable-field
:size
15))
984 (setq eudc-form-widget-list
(cons (cons (car fields
) widget
)
985 eudc-form-widget-list
))
986 (setq fields
(cdr fields
))
987 (setq prompts
(cdr prompts
))
990 (widget-insert "\n\n" (format (concat "%" (int-to-string width
) "s: ") (car prompts
)))
991 (setq widget
(widget-create 'editable-field
993 (setq eudc-form-widget-list
(cons (cons field widget
)
994 eudc-form-widget-list
))
995 (setq prompts
(cdr prompts
))))
997 (widget-insert "\n\n")
998 (widget-create 'push-button
999 :notify
(lambda (&rest ignore
)
1000 (eudc-process-form))
1003 (widget-create 'push-button
1004 :notify
(lambda (&rest ignore
)
1008 (widget-create 'push-button
1009 :notify
(lambda (&rest ignore
)
1013 (use-local-map widget-keymap
)
1017 (defun eudc-bookmark-server (server protocol
)
1018 "Add SERVER using PROTOCOL to the EUDC `servers' hotlist."
1019 (interactive "sDirectory server: \nsProtocol: ")
1020 (if (member (cons server protocol
) eudc-server-hotlist
)
1021 (error "%s:%s is already in the hotlist" protocol server
)
1022 (setq eudc-server-hotlist
(cons (cons server protocol
) eudc-server-hotlist
))
1024 (eudc-save-options)))
1026 (defun eudc-bookmark-current-server ()
1027 "Add current server to the EUDC `servers' hotlist."
1029 (eudc-bookmark-server eudc-server eudc-protocol
))
1031 (defun eudc-save-options ()
1032 "Save options to `eudc-options-file'."
1035 (set-buffer (find-file-noselect eudc-options-file t
))
1036 (goto-char (point-min))
1037 ;; delete the previous setq
1038 (let ((standard-output (current-buffer))
1044 (let ((sexp (condition-case nil
1045 (read (current-buffer))
1046 (end-of-file (throw 'found nil
)))))
1049 ((eq (car sexp
) 'eudc-set-server
)
1050 (delete-region (save-excursion
1054 (setq set-server-p t
))
1055 ((and (eq (car sexp
) 'setq
)
1056 (eq (eudc-cadr sexp
) 'eudc-server-hotlist
))
1057 (delete-region (save-excursion
1061 (setq set-hotlist-p t
))
1062 ((and (eq (car sexp
) 'provide
)
1063 (equal (eudc-cadr sexp
) '(quote eudc-options-file
)))
1064 (setq provide-p t
)))
1068 (throw 'found t
))))))
1069 (if (eq (point-min) (point-max))
1070 (princ ";; This file was automatically generated by eudc.el.\n\n"))
1072 (princ "(provide 'eudc-options-file)\n"))
1075 (delete-blank-lines)
1076 (princ "(eudc-set-server ")
1079 (prin1 eudc-protocol
)
1081 (princ "(setq eudc-server-hotlist '")
1082 (prin1 eudc-server-hotlist
)
1086 (defun eudc-move-to-next-record ()
1087 "Move to next record, in a buffer displaying directory query results."
1089 (if (not (eq major-mode
'eudc-mode
))
1090 (error "Not in a EUDC buffer")
1091 (let ((pt (next-overlay-change (point))))
1092 (if (< pt
(point-max))
1094 (error "No more records after point")))))
1096 (defun eudc-move-to-previous-record ()
1097 "Move to previous record, in a buffer displaying directory query results."
1099 (if (not (eq major-mode
'eudc-mode
))
1100 (error "Not in a EUDC buffer")
1101 (let ((pt (previous-overlay-change (point))))
1102 (if (> pt
(point-min))
1104 (error "No more records before point")))))
1108 ;;{{{ Menus and keymaps
1113 (let ((map (make-sparse-keymap)))
1114 (define-key map
"q" 'kill-this-buffer
)
1115 (define-key map
"x" 'kill-this-buffer
)
1116 (define-key map
"f" 'eudc-query-form
)
1117 (define-key map
"b" 'eudc-try-bbdb-insert
)
1118 (define-key map
"n" 'eudc-move-to-next-record
)
1119 (define-key map
"p" 'eudc-move-to-previous-record
)
1121 (set-keymap-parent eudc-mode-map widget-keymap
)
1123 (defconst eudc-custom-generated-menu
(cdr (custom-menu-create 'eudc
)))
1125 (defconst eudc-tail-menu
1127 ["Query with Form" eudc-query-form t
]
1128 ["Expand Inline Query" eudc-expand-inline t
]
1129 ["Insert Record into BBDB" eudc-insert-record-at-point-into-bbdb
1130 (and (or (featurep 'bbdb
)
1131 (prog1 (locate-library "bbdb") (message "")))
1132 (overlays-at (point))
1133 (overlay-get (car (overlays-at (point))) 'eudc-record
))]
1134 ["Insert All Records into BBDB" eudc-batch-export-records-to-bbdb
1135 (and (eq major-mode
'eudc-mode
)
1136 (or (featurep 'bbdb
)
1137 (prog1 (locate-library "bbdb") (message ""))))]
1139 ["Get Email" eudc-get-email t
]
1140 ["Get Phone" eudc-get-phone t
]
1141 ["List Valid Attribute Names" eudc-get-attribute-list t
]
1143 ,(cons "Customize" eudc-custom-generated-menu
)))
1146 (defconst eudc-server-menu
1148 ["Bookmark Current Server" eudc-bookmark-current-server t
]
1149 ["Edit Server List" eudc-edit-hotlist t
]
1150 ["New Server" eudc-set-server t
]))
1154 (append '("Directory Search")
1161 (let* ((server (car servspec
))
1162 (protocol (cdr servspec
))
1163 (proto-name (symbol-name protocol
)))
1164 (setq command
(intern (concat "eudc-set-server-"
1168 (if (not (fboundp command
))
1172 (eudc-set-server ,server
(quote ,protocol
))
1173 (message "Selected directory server is now %s (%s)"
1176 (vector (format "%s (%s)" server proto-name
)
1179 :selected
`(equal eudc-server
,server
)))))
1180 eudc-server-hotlist
)
1184 (defun eudc-install-menu ()
1186 ((and eudc-xemacs-p
(featurep 'menubar
))
1187 (add-submenu '("Tools") (eudc-menu)))
1190 ((fboundp 'easy-menu-create-menu
)
1193 [menu-bar tools directory-search
]
1194 (cons "Directory Search"
1195 (easy-menu-create-menu "Directory Search" (cdr (eudc-menu))))))
1196 ((fboundp 'easy-menu-add-item
)
1197 (let ((menu (eudc-menu)))
1198 (easy-menu-add-item nil
'("tools") (easy-menu-create-menu (car menu
)
1200 ((fboundp 'easy-menu-create-keymaps
)
1201 (easy-menu-define eudc-menu-map eudc-mode-map
"Directory Client Menu" (eudc-menu))
1204 [menu-bar tools eudc
]
1205 (cons "Directory Search"
1206 (easy-menu-create-keymaps "Directory Search" (cdr (eudc-menu))))))
1208 (error "Unknown version of easymenu"))))
1212 ;;; Load time initializations :
1214 ;;; Load the options file
1215 (if (and (not noninteractive
)
1216 (and (locate-library eudc-options-file
)
1217 (message "")) ; Remove modeline message
1218 (not (featurep 'eudc-options-file
)))
1219 (load eudc-options-file
))
1221 ;;; Install the full menu
1222 (unless (featurep 'infodock
)
1223 (eudc-install-menu))
1226 ;;; The following installs a short menu for EUDC at XEmacs startup.
1229 (defun eudc-load-eudc ()
1230 "Load the Emacs Unified Directory Client.
1231 This does nothing except loading eudc by autoload side-effect."
1236 (cond ((not (string-match "XEmacs" emacs-version
))
1237 (defvar eudc-tools-menu
(make-sparse-keymap "Directory Search"))
1238 (fset 'eudc-tools-menu
(symbol-value 'eudc-tools-menu
))
1239 (define-key eudc-tools-menu
[phone]
1240 '("Get Phone" . eudc-get-phone))
1241 (define-key eudc-tools-menu [email]
1242 '("Get Email" . eudc-get-email))
1243 (define-key eudc-tools-menu [separator-eudc-email]
1245 (define-key eudc-tools-menu [expand-inline]
1246 '("Expand Inline Query" . eudc-expand-inline))
1247 (define-key eudc-tools-menu [query]
1248 '("Query with Form" . eudc-query-form))
1249 (define-key eudc-tools-menu [separator-eudc-query]
1251 (define-key eudc-tools-menu [new]
1252 '("New Server" . eudc-set-server))
1253 (define-key eudc-tools-menu [load]
1254 '("Load Hotlist of Servers" . eudc-load-eudc)))
1257 (let ((menu '("Directory Search"
1258 ["Load Hotlist of Servers" eudc-load-eudc t]
1259 ["New Server" eudc-set-server t]
1261 ["Query with Form" eudc-query-form t]
1262 ["Expand Inline Query" eudc-expand-inline t]
1264 ["Get Email" eudc-get-email t]
1265 ["Get Phone" eudc-get-phone t])))
1266 (if (not (featurep 'eudc-autoloads))
1268 (if (and (featurep 'menubar)
1269 (not (featurep 'infodock)))
1270 (add-submenu '("Tools") menu))
1273 ((fboundp 'easy-menu-add-item)
1274 (easy-menu-add-item nil '("tools")
1275 (easy-menu-create-menu (car menu)
1277 ((fboundp 'easy-menu-create-keymaps)
1280 [menu-bar tools eudc]
1281 (cons "Directory Search"
1282 (easy-menu-create-keymaps "Directory Search"
1283 (cdr menu)))))))))))
1289 ;;; arch-tag: e18872b6-db83-400b-869d-be54e9a4160c
1290 ;;; eudc.el ends here