Mercurial > emacs
annotate lisp/net/eudcb-ph.el @ 59792:ff0bef9e820a
*** empty log message ***
author | Luc Teirlinck <teirllm@auburn.edu> |
---|---|
date | Sun, 30 Jan 2005 00:43:04 +0000 |
parents | 695cf19ef79e |
children | 18a818a2ee7c 375f2633d815 |
rev | line source |
---|---|
27313 | 1 ;;; eudcb-ph.el --- Emacs Unified Directory Client - CCSO PH/QI Backend |
2 | |
42607
033986c328d5
New maintainer. New e-mail address of the author.
Pavel Janík <Pavel@Janik.cz>
parents:
42574
diff
changeset
|
3 ;; Copyright (C) 1998, 1999, 2000, 2002 Free Software Foundation, Inc. |
27313 | 4 |
42607
033986c328d5
New maintainer. New e-mail address of the author.
Pavel Janík <Pavel@Janik.cz>
parents:
42574
diff
changeset
|
5 ;; Author: Oscar Figueiredo <oscar@cpe.fr> |
033986c328d5
New maintainer. New e-mail address of the author.
Pavel Janík <Pavel@Janik.cz>
parents:
42574
diff
changeset
|
6 ;; Maintainer: Pavel Janík <Pavel@Janik.cz> |
42574 | 7 ;; Keywords: comm |
27313 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
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) | |
14 ;; any later version. | |
15 | |
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. | |
20 | |
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. | |
25 | |
26 ;;; Commentary: | |
42780
b136d94976d9
(eudc-ph-open-session): Remove XEmacs case.
Pavel Janík <Pavel@Janik.cz>
parents:
42607
diff
changeset
|
27 |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
28 ;; This library provides specific CCSO PH/QI protocol support for the |
42780
b136d94976d9
(eudc-ph-open-session): Remove XEmacs case.
Pavel Janík <Pavel@Janik.cz>
parents:
42607
diff
changeset
|
29 ;; Emacs Unified Directory Client package. |
27313 | 30 |
31 ;;; Code: | |
32 | |
33 (require 'eudc) | |
34 | |
35 ;;{{{ Internal cooking | |
36 | |
37 (eudc-protocol-set 'eudc-bbdb-conversion-alist 'eudc-ph-bbdb-conversion-alist 'ph) | |
38 (eudc-protocol-set 'eudc-query-function 'eudc-ph-query-internal 'ph) | |
39 (eudc-protocol-set 'eudc-list-attributes-function 'eudc-ph-get-field-list 'ph) | |
40 (eudc-protocol-set 'eudc-protocol-has-default-query-attributes t 'ph) | |
41 | |
42 (defvar eudc-ph-process-buffer nil) | |
43 (defvar eudc-ph-read-point) | |
44 | |
45 (defconst eudc-ph-default-server-port 105 | |
46 "Default TCP port for CCSO PH/QI directory services.") | |
47 | |
48 (defun eudc-ph-query-internal (query &optional return-fields) | |
49 "Query the PH/QI server with QUERY. | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
50 QUERY can be a string NAME or a list made of strings NAME |
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
51 and/or cons cells (KEY . VALUE) where KEYs should be valid |
27313 | 52 CCSO database keys. NAME is equivalent to (DEFAULT . NAME), |
53 where DEFAULT is the default key of the database. | |
54 RETURN-FIELDS is a list of database fields to return, | |
55 defaulting to `eudc-default-return-attributes'." | |
56 (let (request) | |
57 (if (null return-fields) | |
58 (setq return-fields eudc-default-return-attributes)) | |
59 (if (eq 'all return-fields) | |
60 (setq return-fields '(all))) | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
61 (setq request |
27313 | 62 (concat "query " |
63 (if (stringp query) | |
64 query | |
65 (mapconcat (function (lambda (elt) | |
66 (if (stringp elt) elt) | |
67 (format "%s=%s" (car elt) (cdr elt)))) | |
68 query | |
69 " ")) | |
70 (if return-fields | |
71 (concat " return " (mapconcat 'symbol-name return-fields " "))))) | |
72 (and (> (length request) 6) | |
73 (eudc-ph-do-request request) | |
74 (eudc-ph-parse-query-result return-fields)))) | |
75 | |
76 (defun eudc-ph-get-field-list (full-records) | |
77 "Return a list of valid field names for the current server. | |
78 If FULL-RECORDS is non-nil, full records including field description | |
79 are returned" | |
80 (interactive) | |
81 (eudc-ph-do-request "fields") | |
82 (if full-records | |
83 (eudc-ph-parse-query-result) | |
84 (mapcar 'eudc-caar (eudc-ph-parse-query-result)))) | |
85 | |
86 (defun eudc-ph-parse-query-result (&optional fields) | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
87 "Return a list of alists of key/values from in `eudc-ph-process-buffer'. |
27313 | 88 Fields not in FIELDS are discarded." |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
89 (let (record |
27313 | 90 records |
91 line-regexp | |
92 current-key | |
93 key | |
94 value | |
95 ignore) | |
96 (save-excursion | |
97 (message "Parsing results...") | |
98 (set-buffer eudc-ph-process-buffer) | |
99 (goto-char (point-min)) | |
100 (while (re-search-forward "^\\(-[0-9]+\\):\\([0-9]+\\):" nil t) | |
101 (catch 'ignore | |
102 (setq line-regexp (concat "^\\(-[0-9]+\\):" (match-string 2) ":[ \t]*\\([-a-zA-Z_]*\\)?:[ \t]*\\(.*\\)$")) | |
103 (beginning-of-line) | |
104 (setq record nil | |
105 ignore nil | |
106 current-key nil) | |
107 (while (re-search-forward line-regexp nil t) | |
108 (catch 'skip-line | |
109 (if (string= "-508" (match-string 1)) | |
110 ;; A field is missing in this entry. Skip it or skip the | |
111 ;; whole record (see `eudc-strict-return-matches') | |
112 (if (not eudc-strict-return-matches) | |
113 (throw 'skip-line t) | |
114 (while (re-search-forward line-regexp nil t)) | |
115 (setq ignore t) | |
116 (throw 'ignore t))) | |
117 (setq key (and (not (string= (match-string 2) "")) | |
118 (intern (match-string 2))) | |
119 value (match-string 3)) | |
120 (if (and current-key | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
121 (eq key current-key)) |
27313 | 122 (setq key nil) |
123 (setq current-key key)) | |
124 (if (or (null fields) | |
125 (eq 'all fields) | |
126 (memq current-key fields)) | |
127 (if key | |
128 (setq record (cons (cons key value) record)) ; New key | |
129 (setcdr (car record) (if (listp (eudc-cdar record)) | |
130 (append (eudc-cdar record) (list value)) | |
131 (list (eudc-cdar record) value)))))))) | |
132 (and (not ignore) | |
133 (or (null fields) | |
134 (eq 'all fields) | |
135 (setq record (nreverse record))) | |
136 (setq record (if (not (eq 'list eudc-duplicate-attribute-handling-method)) | |
137 (eudc-filter-duplicate-attributes record) | |
138 (list record))) | |
42780
b136d94976d9
(eudc-ph-open-session): Remove XEmacs case.
Pavel Janík <Pavel@Janik.cz>
parents:
42607
diff
changeset
|
139 (setq records (append record records))))) |
27313 | 140 (message "Done") |
42780
b136d94976d9
(eudc-ph-open-session): Remove XEmacs case.
Pavel Janík <Pavel@Janik.cz>
parents:
42607
diff
changeset
|
141 records)) |
27313 | 142 |
143 (defun eudc-ph-do-request (request) | |
144 "Send REQUEST to the server. | |
145 Wait for response and return the buffer containing it." | |
146 (let (process | |
147 buffer) | |
148 (unwind-protect | |
149 (progn | |
150 (message "Contacting server...") | |
151 (setq process (eudc-ph-open-session)) | |
152 (if process | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
153 (save-excursion |
27313 | 154 (set-buffer (setq buffer (process-buffer process))) |
155 (eudc-ph-send-command process request) | |
156 (message "Request sent, waiting for reply...") | |
157 (eudc-ph-read-response process)))) | |
158 (if process | |
159 (eudc-ph-close-session process))) | |
160 buffer)) | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
161 |
27313 | 162 (defun eudc-ph-open-session (&optional server) |
163 "Open a connection to the given CCSO/QI SERVER. | |
164 SERVER is either a string naming the server or a list (NAME PORT)." | |
165 (let (process | |
166 host | |
167 port) | |
168 (catch 'done | |
169 (if (null server) | |
170 (setq server (or eudc-server | |
171 (call-interactively 'eudc-ph-set-server)))) | |
172 (string-match "\\(.*\\)\\(:\\(.*\\)\\)?" server) | |
173 (setq host (match-string 1 server)) | |
174 (setq port (or (match-string 3 server) | |
175 eudc-ph-default-server-port)) | |
176 (setq eudc-ph-process-buffer (get-buffer-create (format " *PH-%s*" host))) | |
177 (save-excursion | |
178 (set-buffer eudc-ph-process-buffer) | |
179 (erase-buffer) | |
180 (setq eudc-ph-read-point (point)) | |
181 (and eudc-xemacs-mule-p | |
182 (set-buffer-file-coding-system 'binary t))) | |
183 (setq process (open-network-stream "ph" eudc-ph-process-buffer host port)) | |
184 (if (null process) | |
185 (throw 'done nil)) | |
186 (process-kill-without-query process) | |
187 process))) | |
188 | |
189 (defun eudc-ph-close-session (process) | |
190 (save-excursion | |
191 (set-buffer (process-buffer process)) | |
192 (eudc-ph-send-command process "quit") | |
193 (eudc-ph-read-response process) | |
42780
b136d94976d9
(eudc-ph-open-session): Remove XEmacs case.
Pavel Janík <Pavel@Janik.cz>
parents:
42607
diff
changeset
|
194 (run-at-time 2 nil 'delete-process process))) |
27313 | 195 |
196 (defun eudc-ph-send-command (process command) | |
197 (goto-char (point-max)) | |
198 (process-send-string process command) | |
199 (process-send-string process "\r\n") | |
200 ) | |
201 | |
202 (defun eudc-ph-read-response (process &optional return-response) | |
203 "Read a response from the PH/QI query process PROCESS. | |
204 Returns nil if response starts with an error code. If the | |
205 response is successful the return code or the response itself is returned | |
206 depending on RETURN-RESPONSE." | |
207 (let ((case-fold-search nil) | |
208 return-code | |
209 match-end) | |
210 (goto-char eudc-ph-read-point) | |
211 ;; CCSO protocol : response complete if status >= 200 | |
212 (while (not (re-search-forward "^\\(^[2-5].*\\):.*\n" nil t)) | |
213 (accept-process-output process) | |
214 (goto-char eudc-ph-read-point)) | |
215 (setq match-end (point)) | |
216 (goto-char eudc-ph-read-point) | |
217 (if (and (setq return-code (match-string 1)) | |
218 (setq return-code (string-to-number return-code)) | |
219 (>= (abs return-code) 300)) | |
220 (progn (setq eudc-ph-read-point match-end) nil) | |
221 (setq eudc-ph-read-point match-end) | |
222 (if return-response | |
223 (buffer-substring (point) match-end) | |
224 return-code)))) | |
225 | |
42570
78a4068d960a
Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents:
27313
diff
changeset
|
226 ;;}}} |
27313 | 227 |
228 ;;{{{ High-level interfaces (interactive functions) | |
229 | |
230 (defun eudc-ph-customize () | |
231 "Customize the EUDC PH support." | |
232 (interactive) | |
233 (customize-group 'eudc-ph)) | |
234 | |
235 (defun eudc-ph-set-server (server) | |
236 "Set the PH server to SERVER." | |
237 (interactive "sNew PH/QI Server: ") | |
238 (message "Selected PH/QI server is now %s" server) | |
239 (eudc-set-server server 'ph)) | |
240 | |
241 ;;}}} | |
242 | |
243 (eudc-register-protocol 'ph) | |
244 | |
245 (provide 'eudcb-ph) | |
246 | |
52401 | 247 ;;; arch-tag: 4365bbf5-af20-453e-b5b6-2e7118ebfcdb |
27313 | 248 ;;; eudcb-ph.el ends here |