source: project/release/4/estraier-client/estraier-client.scm @ 15852

Last change on this file since 15852 was 15852, checked in by sjamaan, 11 years ago

Add more detailed error information to errors detected client-side

File size: 17.2 KB
Line 
1;;
2;; Hyper Estraier client library
3;;
4; Copyright (c) 2009, Peter Bex
5; All rights reserved.
6;
7; Redistribution and use in source and binary forms, with or without
8; modification, are permitted provided that the following conditions
9; are met:
10;
11; 1. Redistributions of source code must retain the above copyright
12;    notice, this list of conditions and the following disclaimer.
13; 2. Redistributions in binary form must reproduce the above copyright
14;    notice, this list of conditions and the following disclaimer in the
15;    documentation and/or other materials provided with the distribution.
16; 3. Neither the name of the author nor the names of its
17;    contributors may be used to endorse or promote products derived
18;    from this software without specific prior written permission.
19;
20; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23; FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24; COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25; INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27; SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28; HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29; STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30; ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31; OF THE POSSIBILITY OF SUCH DAMAGE.
32;
33; Please report bugs, suggestions and ideas to the Chicken Trac
34; ticket tracking system (assign tickets to user 'sjamaan'):
35; http://trac.callcc.org
36
37(module estraier-client
38  (get-node-info get-cache-usage optimize-node sync-node document-uri->id
39   list-documents put-document delete-document get-document
40   update-attributes document-attribute document-keywords find-documents
41   unregister-user register-admin-user register-guest-user
42   
43   ;; these could be useful on their own, so export them too
44   read-attributes read-draft write-attributes write-draft
45
46   shutdown-master sync-master backup-master rotate-log
47   list-nodes add-node delete-node clear-node list-users add-user delete-user)
48
49(import chicken scheme)
50(use data-structures extras ports regex srfi-1 srfi-13
51     http-client uri-common intarweb)
52
53;; Exhaust input port with web-server's output (yes, confusing) and return void
54(define (discard-output in)
55  (let loop ((line (read-line in)))
56    (if (eof-object? line) (void) (loop (read-line in)))))
57
58(define (estraier-exn loc message specific . rest)
59  (make-composite-condition
60   (make-property-condition 'exn 'location loc 'message message)
61   (make-property-condition 'estraier-client)
62   (apply make-property-condition specific rest)))
63
64(define (http->estraier-exn exn loc specific . rest)
65  (estraier-exn loc ((condition-property-accessor 'exn 'message) exn)))
66
67(define (exec loc uri writer reader)
68  (condition-case
69      ;; Estraier doesn't understand the preferred ";" separator
70      (parameterize ((form-urlencoded-separator "&"))
71        (call-with-input-request uri writer reader))
72    (exn (client-error)
73         (case (response-code
74                ((condition-property-accessor 'client-error 'response) exn))
75           ((400) (signal (http->estraier-exn exn loc 'args)))
76           ((401) (signal (http->estraier-exn exn loc 'auth)))
77           ((403) (signal (http->estraier-exn exn loc 'perm)))
78           ((404) (signal (http->estraier-exn exn loc 'node)))
79           (else  (signal exn))))
80    (exn (server-error)
81         (case (response-code
82                ((condition-property-accessor 'client-error 'response) exn))
83           ((500) (signal (http->estraier-exn exn loc 'server)))
84           (else  (signal exn))))))
85
86;; Read one block of data. The Hyper Estraier API sends data out in blocks
87;; separated by newlines.  The lines in the block are returned as a list
88(define (read-block inport)
89  (let loop ((result (list))
90             (line (read-line inport)))
91    (if (or (eof-object? line) (string-null? line))
92        (reverse! result)
93        (loop (cons line result) (read-line inport)))))
94
95(define (split-attrib-line attrib-line)
96  (let ((idx (string-index attrib-line #\=)))
97    (cons (string->symbol (string-take attrib-line idx))
98          (string-drop attrib-line (add1 idx)))))
99
100;; Helper procedure for checking that id xor uri is supplied
101(define (id/uri->alist loc id uri)
102  (cond
103   ((and id (not uri)) `((id . ,id)))
104   ((and uri (not id)) `((uri . ,uri)))
105   (else
106    (signal (estraier-exn loc "You must supply either an id or a uri" 'args)))))
107
108;;;; Node API
109
110(define (node-uri base-uri node action . args)
111  (let* ((rel (update-uri (uri-reference "") path: (list "node" node action)))
112         (uri (if (uri-reference? base-uri)
113                  (uri-relative-to rel base-uri)
114                  (uri-relative-to rel (uri-reference base-uri)))))
115    (apply update-uri uri args)))
116
117(define (get-node-info base-uri node)
118  (exec
119   'get-node-info
120   (node-uri base-uri node "inform")
121   #f
122   (lambda (in)
123     (let* ((db-info (string-split (car (read-block in)) "\t" #t))
124            (admins (read-block in))
125            (guests (read-block in)))
126       ;; According to the docs, there's more info after GUESTS but I can't
127       ;; seem to get this, so let's just read out just to be sure (for now)
128       (discard-output in)
129       `((name . ,(first db-info))
130         (label . ,(second db-info))
131         (document-count . ,(string->number (third db-info)))
132         (word-count . ,(string->number (fourth db-info)))
133         (size . ,(string->number (fifth db-info)))
134         (admin-users . ,admins)
135         (guest-users . ,guests))))))
136
137(define (get-cache-usage base-uri node)
138  (string->number
139   (exec 'get-cache-usage (node-uri base-uri node "cacheusage") #f read-line)))
140
141(define (optimize-node base-uri node)
142  (exec 'optimize-node (node-uri base-uri node "optimize") #f discard-output))
143
144(define (sync-node base-uri node)
145  (exec 'sync-node (node-uri base-uri node "sync") #f discard-output))
146
147(define (list-documents base-uri node #!key max prev)
148  (exec 'list-documents
149        (node-uri base-uri node "list" query: `((max . ,max) (prev . ,prev)))
150        #f
151        (lambda (in)
152          (map (lambda (line)
153                 (map cons
154                      `(@id @uri @digest @cdate @mdate @adate @title @author
155                            @type @lang @genre @size @weight @misc)
156                      (string-split line "\t" #t)))
157               (read-lines in)))))
158
159;; Flatten all whitespace types to one regular whitespace.  Draft syntax
160;; assigns special meaning to tabs/newlines but has no way to escape that.
161(define (kill-special-whitespace str)
162  (string-substitute '(+ whitespace) " " str))
163
164(define (write-attributes outport attributes)
165  (for-each (lambda (attrib)
166              (fprintf outport "~A=~A\r\n"
167                       (kill-special-whitespace (->string (car attrib)))
168                       (kill-special-whitespace (->string (cdr attrib)))))
169            attributes))
170
171;; Write out a document in "draft" format to the specified output port.
172(define (write-draft outport attributes contents)
173  (write-attributes outport attributes)
174  (fprintf outport "\r\n")
175  (for-each (lambda (line)
176              (fprintf outport "~A\r\n" (kill-special-whitespace line)))
177            contents))
178
179(define (read-attributes inport)
180  (map split-attrib-line
181       ;; Remove control commands like %VECTOR for now
182       (filter (lambda (line)
183                 (string-index line #\=))
184               (read-block inport))))
185
186;; Read a document in "draft" format from the specified input port.
187(define (read-draft inport)
188  (let* ((metadata (read-attributes inport))
189         (document (read-lines inport)))
190    (values document metadata)))
191
192(define (put-document base-uri node contents attribs)
193  (exec
194   'put-document
195   (make-request uri: (node-uri base-uri node "put_doc")
196                 method: 'POST major: 1 minor: 0
197                 headers: (headers '((content-type text/x-estraier-draft))))
198   (call-with-output-string ; use string because it wants content-length
199     ;; Can't write @digest because that would invalidate the document
200     (lambda (out) (write-draft out (alist-delete '@digest attribs) contents)))
201   discard-output))
202
203(define (delete-document base-uri node #!key id uri)
204  (exec 'delete-document
205        (node-uri base-uri node "out_doc"
206                  query: (id/uri->alist 'delete-document id uri))
207        #f discard-output))
208
209(define (document-uri->id base-uri node uri)
210  (exec 'document-uri->id
211        (node-uri base-uri node "uri_to_id"
212                  query: `((uri . ,uri))) #f read-line))
213
214(define (get-document base-uri node #!key id uri)
215  (apply values
216         (exec
217          'get-document
218          (node-uri base-uri node "get_doc"
219                    query: (id/uri->alist 'get-document id uri))
220          #f (lambda (in)
221               (call-with-values (lambda () (read-draft in)) list)))))
222
223;; This requires the new attributes plus all the old attribs, it
224;; simply replaces the document's attributes.  This also means it
225;; requires both @uri and @id!  Anything not present is reset or
226;; removed.  It's identical to put-document, except for the doc body.
227(define (update-attributes base-uri node attribs)
228  (exec
229   'update-attributes
230   (make-request uri: (node-uri base-uri node "edit_doc")
231                 method: 'POST major: 1 minor: 0
232                 headers: (headers '((content-type text/x-estraier-draft))))
233   (call-with-output-string ; use string because it wants content-length
234     ;; Can't write @digest because that would invalidate the document
235     (lambda (out) (write-attributes out (alist-delete '@digest attribs))))
236   discard-output))
237
238(define (document-attribute base-uri node attrib #!key id uri)
239  (exec 'document-attribute
240        (node-uri base-uri node "get_doc_attr"
241                  query: (cons `(attr . ,attrib)
242                               (id/uri->alist 'document-attribute id uri)))
243        #f read-line))
244
245(define (document-keywords base-uri node #!key id uri)
246  (exec 'document-keywords
247        (node-uri base-uri node "etch_doc"
248                  query: (id/uri->alist 'document-keywords id uri))
249        #f
250        (lambda (in)
251          (let loop ((line (read-line in))
252                     (keywords (list)))
253            (if (eof-object? line)
254                (reverse! keywords) ;; preserve keyword document order
255                (let ((kwd/score (string-split line "\t" #t)))
256                  (loop (read-line in)
257                        (cons (cons (first kwd/score)
258                                    (string->number (second kwd/score)))
259                              keywords))))))))
260
261;; Attrs are ANDed together.  All attribute phrases must match
262(define (find-documents base-uri node #!key phrase (attr-phrases '())
263                        order max options auxiliary distinct depth
264                        wwidth hwidth awidth skip mask)
265  (when (> (length attr-phrases) 10)
266    (signal
267     (estraier-exn 'find-documents
268                   (conc "You can't provide more than 10 attribute phrases. "
269                         "This is a limitation of the estraier API. Sorry!")
270                   'args)))
271  ;; Normalise attr-phrases list to attr, attr1, ... attr9
272  (let ((attrs (map (lambda (a i)
273                      (if (zero? i)
274                          (cons 'attr a)
275                          (cons (sprintf "attr~A" i) a)))
276                    attr-phrases
277                    (iota 10))))
278   (apply
279    values
280    (exec 'find-documents
281          (node-uri base-uri node "search"
282                    query: `((phrase . ,phrase) (order . ,order)
283                             (max . ,max)       (options . ,options)
284                             (depth . ,depth)   (wwidth . ,wwidth)
285                             (hwidth . ,hwidth) (awidth . ,awidth)
286                             (skip . ,skip)     (mask . ,mask)
287                             (auxiliary . ,auxiliary)
288                             (distinct . ,distinct)
289                             ,@attrs))
290          #f
291          (lambda (in)
292            (let* ((delimiter (read-line in))
293                   (meta
294                    (let next-line ((line (read-line in))
295                                    (metadata (list)))
296                      ;; There's a pointless blank line at the end... skip over it
297                      (if (string-null? line)
298                          (next-line (read-line in) metadata)
299                          (if (string-prefix? delimiter line)
300                              (reverse! metadata) ; done, continue to snippets
301                              (let ((data (string-split line "\t" #t)))
302                                (next-line (read-line in)
303                                           (cons (cons (string->symbol (car data))
304                                                       (cdr data))
305                                                 metadata)))))))
306                   (documents
307                    (let next-document ((docs (list)))
308                      (let ((attribs (read-attributes in)))
309                        (let next-line ((matches (list))
310                                        (line  (read-line in)))
311                          (cond
312                           ;; We're not relying on :END here since it would
313                           ;; complicate matters with zero search results.
314                           ((eof-object? line)
315                            (reverse! docs))
316                           ((string-prefix? delimiter line)
317                            (next-document (cons (cons (reverse! matches) attribs)
318                                                 docs)))
319                           ;; Discard pointless empty lines.. there's at least
320                           ;; one at the end of each block.
321                           ((string-null? line)
322                            (next-line matches (read-line in)))
323                           (else
324                            (let* ((idx (string-index line #\tab))
325                                   (highlight (and idx (string-take line idx)))
326                                   (match (if idx
327                                              (string-drop line (add1 idx))
328                                              line)))
329                              (next-line (cons (cons highlight match) matches)
330                                         (read-line in))))))))))
331              (list documents meta)))))))
332
333(define (_set-user loc base-uri node name mode)
334  (exec loc (node-uri base-uri node "_set_user"
335                      query: `((name . ,name) (mode . ,mode)))
336        #f read-lines))
337
338(define (unregister-user base-uri node name)
339  (_set-user 'unregister-user base-uri node name 0))
340
341(define (register-admin-user base-uri node name)
342  (_set-user 'register-admin-user base-uri node name 1))
343
344(define (register-guest-user base-uri node name)
345  (_set-user 'register-guest-user base-uri node name 2))
346
347;; TODO: _set_link
348
349;;;; Master API
350
351(define (master-uri base-uri action . args)
352  (let ((uri (if (uri-reference? base-uri)
353                 (apply update-uri base-uri args)
354                 (apply update-uri (uri-reference base-uri) args))))
355    (update-uri (uri-relative-to (uri-reference "./master") uri)
356                query: (alist-update! 'action action (uri-query uri)))))
357
358(define (shutdown-master base-uri)
359  (exec 'shutdown-master (master-uri base-uri "shutdown") #f discard-output))
360
361(define (sync-master base-uri)
362  (exec 'sync-master (master-uri base-uri "sync") #f discard-output))
363
364(define (backup-master base-uri)
365  (exec 'backup-master (master-uri base-uri "backup") #f discard-output))
366
367(define (rotate-log base-uri)
368  (exec 'rotate-log (master-uri base-uri "logrtt") #f discard-output))
369
370(define (list-nodes base-uri)
371  (map (lambda (line)
372         (string-split line "\t" #t))
373       (exec 'list-nodes (master-uri base-uri "nodelist") #f read-lines)))
374
375(define (add-node base-uri node-name #!optional node-label)
376  (exec 'add-node
377        (master-uri base-uri "nodeadd"
378                    query: `((name . ,node-name) (label . ,node-label)))
379        #f discard-output))
380
381(define (delete-node base-uri node-name)
382  (exec 'delete-node
383        (master-uri base-uri "nodedel" query: `((name . ,node-name)))
384        #f discard-output))
385
386(define (clear-node base-uri node-name)
387  (exec 'clear-node
388        (master-uri base-uri "nodeclr" query: `((name . ,node-name)))
389        #f discard-output))
390
391(define (list-users base-uri)
392  (exec 'list-users
393        (master-uri base-uri "userlist")
394        #f
395        (lambda (in)
396          (let loop ((line (read-line in))
397                     (lines (list)))
398            (if (eof-object? line)
399                (reverse! lines)
400                (loop (read-line in)
401                      (cons (string-split line "\t" #t) lines)))))))
402
403(define (add-user base-uri username password
404                  #!key flags fullname description)
405  (exec 'add-user
406        (make-request uri: (master-uri base-uri "useradd")
407                      method: 'POST major: 1 minor: 0)
408        `((name . ,username) (passwd . ,password)
409          (flags . ,flags) (fname . ,fullname) (misc . ,description))
410        discard-output))
411
412(define (delete-user base-uri username)
413  (exec 'delete-user
414        (master-uri base-uri "userdel" query: `((name . ,username)))
415        #f discard-output))
416
417)
Note: See TracBrowser for help on using the repository browser.