Merge from origin/emacs-24
[emacs.git] / lisp / net / eudcb-ph.el
blob1897e0b08bc5170514e39941743415c411cd59f8
1 ;;; eudcb-ph.el --- Emacs Unified Directory Client - CCSO PH/QI Backend -*- coding: utf-8 -*-
3 ;; Copyright (C) 1998-2015 Free Software Foundation, Inc.
5 ;; Author: Oscar Figueiredo <oscar@cpe.fr>
6 ;; Pavel Janík <Pavel@Janik.cz>
7 ;; Maintainer: Thomas Fitzsimmons <fitzsim@fitzsim.org>
8 ;; Keywords: comm
9 ;; Package: eudc
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This library provides specific CCSO PH/QI protocol support for the
29 ;; Emacs Unified Directory Client package.
31 ;;; Code:
33 (require 'eudc)
35 ;;{{{ Internal cooking
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)
42 (defvar eudc-ph-process-buffer nil)
43 (defvar eudc-ph-read-point)
45 (defconst eudc-ph-default-server-port 105
46 "Default TCP port for CCSO PH/QI directory services.")
48 (defun eudc-ph-query-internal (query &optional return-fields)
49 "Query the PH/QI server with QUERY.
50 QUERY can be a string NAME or a list made of strings NAME
51 and/or cons cells (KEY . VALUE) where KEYs should be valid
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)))
61 (setq request
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))))
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))))
86 (defun eudc-ph-parse-query-result (&optional fields)
87 "Return a list of alists of key/values from in `eudc-ph-process-buffer'.
88 Fields not in FIELDS are discarded."
89 (let (record
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
121 (eq key current-key))
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)))
139 (setq records (append record records)))))
140 (message "Done")
141 records))
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
153 (with-current-buffer (setq buffer (process-buffer process))
154 (eudc-ph-send-command process request)
155 (message "Request sent, waiting for reply...")
156 (eudc-ph-read-response process))))
157 (if process
158 (eudc-ph-close-session process)))
159 buffer))
161 (defun eudc-ph-open-session (&optional server)
162 "Open a connection to the given CCSO/QI SERVER.
163 SERVER is either a string naming the server or a list (NAME PORT)."
164 (let (process
165 host
166 port)
167 (catch 'done
168 (if (null server)
169 (setq server (or eudc-server
170 (call-interactively 'eudc-ph-set-server))))
171 (string-match "\\(.*\\)\\(:\\(.*\\)\\)?" server)
172 (setq host (match-string 1 server))
173 (setq port (or (match-string 3 server)
174 eudc-ph-default-server-port))
175 (setq eudc-ph-process-buffer (get-buffer-create (format " *PH-%s*" host)))
176 (with-current-buffer eudc-ph-process-buffer
177 (erase-buffer)
178 (setq eudc-ph-read-point (point))
179 (and (featurep 'xemacs) (featurep 'mule)
180 (set-buffer-file-coding-system 'binary t)))
181 (setq process (open-network-stream "ph" eudc-ph-process-buffer host port))
182 (if (null process)
183 (throw 'done nil))
184 (set-process-query-on-exit-flag process t)
185 process)))
187 (defun eudc-ph-close-session (process)
188 (with-current-buffer (process-buffer process)
189 (eudc-ph-send-command process "quit")
190 (eudc-ph-read-response process)
191 (run-at-time 2 nil 'delete-process process)))
193 (defun eudc-ph-send-command (process command)
194 (goto-char (point-max))
195 (process-send-string process command)
196 (process-send-string process "\r\n")
199 (defun eudc-ph-read-response (process &optional return-response)
200 "Read a response from the PH/QI query process PROCESS.
201 Returns nil if response starts with an error code. If the
202 response is successful the return code or the response itself is returned
203 depending on RETURN-RESPONSE."
204 (let ((case-fold-search nil)
205 return-code
206 match-end)
207 (goto-char eudc-ph-read-point)
208 ;; CCSO protocol : response complete if status >= 200
209 (while (not (re-search-forward "^\\(^[2-5].*\\):.*\n" nil t))
210 (accept-process-output process)
211 (goto-char eudc-ph-read-point))
212 (setq match-end (point))
213 (goto-char eudc-ph-read-point)
214 (if (and (setq return-code (match-string 1))
215 (setq return-code (string-to-number return-code))
216 (>= (abs return-code) 300))
217 (progn (setq eudc-ph-read-point match-end) nil)
218 (setq eudc-ph-read-point match-end)
219 (if return-response
220 (buffer-substring (point) match-end)
221 return-code))))
223 ;;}}}
225 ;;{{{ High-level interfaces (interactive functions)
227 (defun eudc-ph-customize ()
228 "Customize the EUDC PH support."
229 (interactive)
230 (customize-group 'eudc-ph))
232 (defun eudc-ph-set-server (server)
233 "Set the PH server to SERVER."
234 (interactive "sNew PH/QI Server: ")
235 (message "Selected PH/QI server is now %s" server)
236 (eudc-set-server server 'ph))
238 ;;}}}
240 (eudc-register-protocol 'ph)
242 (provide 'eudcb-ph)
244 ;;; eudcb-ph.el ends here