(url-retrieve-synchronously): Don't exit precipitously when
[bpt/emacs.git] / lisp / url / url-dav.el
CommitLineData
8c8b8430
SM
1;;; url-dav.el --- WebDAV support
2
76827ca4 3;; Copyright (C) 2001, 2004 Free Software Foundation, Inc.
8c8b8430
SM
4
5;; Author: Bill Perry <wmperry@gnu.org>
6;; Maintainer: Bill Perry <wmperry@gnu.org>
8c8b8430
SM
7;; Keywords: url, vc
8
76827ca4
SM
9;; This file is part of GNU Emacs.
10
8c8b8430
SM
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
0aa70d32
SM
26;; DAV is in RFC 2518.
27
76827ca4
SM
28;;; Commentary:
29
30;;; Code:
31
8c8b8430
SM
32(eval-when-compile
33 (require 'cl))
34
35(require 'xml)
36(require 'url-util)
37(require 'url-handlers)
38
39(defvar url-dav-supported-protocols '(1 2)
40 "List of supported DAV versions.")
41
0aa70d32
SM
42(defun url-intersection (l1 l2)
43 "Return a list of the elements occuring in both of the lists L1 and L2."
44 (if (null l2)
45 l2
46 (let (result)
47 (while l1
48 (if (member (car l1) l2)
49 (setq result (cons (pop l1) result))
50 (pop l1)))
51 (nreverse result))))
52
8c8b8430
SM
53;;;###autoload
54(defun url-dav-supported-p (url)
55 (and (featurep 'xml)
56 (fboundp 'xml-expand-namespace)
0aa70d32
SM
57 (url-intersection url-dav-supported-protocols
58 (plist-get (url-http-options url) 'dav))))
8c8b8430
SM
59
60(defun url-dav-node-text (node)
61 "Return the text data from the XML node NODE."
62 (mapconcat (lambda (txt)
63 (if (stringp txt)
64 txt
65 "")) (xml-node-children node) " "))
66
67\f
68;;; Parsing routines for the actual node contents.
76827ca4
SM
69;;
70;; I am not incredibly happy with how this code looks/works right
71;; now, but it DOES work, and if we get the API right, our callers
72;; won't have to worry about the internal representation.
8c8b8430
SM
73
74(defconst url-dav-datatype-attribute
75 'urn:uuid:c2f41010-65b3-11d1-a29f-00aa00c14882/dt)
76
77(defun url-dav-process-integer-property (node)
78 (truncate (string-to-number (url-dav-node-text node))))
79
80(defun url-dav-process-number-property (node)
81 (string-to-number (url-dav-node-text node)))
82
83(defconst url-dav-iso8601-regexp
84 (let* ((dash "-?")
85 (colon ":?")
86 (4digit "\\([0-9][0-9][0-9][0-9]\\)")
87 (2digit "\\([0-9][0-9]\\)")
88 (date-fullyear 4digit)
89 (date-month 2digit)
90 (date-mday 2digit)
91 (time-hour 2digit)
92 (time-minute 2digit)
93 (time-second 2digit)
94 (time-secfrac "\\(\\.[0-9]+\\)?")
95 (time-numoffset (concat "[-+]\\(" time-hour "\\):" time-minute))
96 (time-offset (concat "Z" time-numoffset))
97 (partial-time (concat time-hour colon time-minute colon time-second
98 time-secfrac))
99 (full-date (concat date-fullyear dash date-month dash date-mday))
100 (full-time (concat partial-time time-offset))
101 (date-time (concat full-date "T" full-time)))
102 (list (concat "^" full-date)
103 (concat "T" partial-time)
104 (concat "Z" time-numoffset)))
105 "List of regular expressions matching iso8601 dates.
1061st regular expression matches the date.
1072nd regular expression matches the time.
76827ca4 1083rd regular expression matches the (optional) timezone specification.")
8c8b8430
SM
109
110(defun url-dav-process-date-property (node)
111 (require 'parse-time)
112 (let* ((date-re (nth 0 url-dav-iso8601-regexp))
113 (time-re (nth 1 url-dav-iso8601-regexp))
114 (tz-re (nth 2 url-dav-iso8601-regexp))
115 (date-string (url-dav-node-text node))
116 re-start
117 time seconds minute hour fractional-seconds
118 day month year day-of-week dst tz)
119 ;; We need to populate 'time' with
120 ;; (SEC MIN HOUR DAY MON YEAR DOW DST TZ)
121
122 ;; Nobody else handles iso8601 correctly, lets do it ourselves.
123 (when (string-match date-re date-string re-start)
216d3806
JB
124 (setq year (string-to-number (match-string 1 date-string))
125 month (string-to-number (match-string 2 date-string))
126 day (string-to-number (match-string 3 date-string))
8c8b8430
SM
127 re-start (match-end 0))
128 (when (string-match time-re date-string re-start)
216d3806
JB
129 (setq hour (string-to-number (match-string 1 date-string))
130 minute (string-to-number (match-string 2 date-string))
131 seconds (string-to-number (match-string 3 date-string))
132 fractional-seconds (string-to-number (or
133 (match-string 4 date-string)
134 "0"))
8c8b8430
SM
135 re-start (match-end 0))
136 (when (string-match tz-re date-string re-start)
137 (setq tz (match-string 1 date-string)))
138 (url-debug 'dav "Parsed iso8601%s date" (if tz "tz" ""))
139 (setq time (list seconds minute hour day month year day-of-week dst tz))))
140
141 ;; Fall back to having Gnus do fancy things for us.
142 (when (not time)
143 (setq time (parse-time-string date-string)))
144
145 (if time
146 (setq time (apply 'encode-time time))
147 (url-debug 'dav "Unable to decode date (%S) (%s)"
148 (xml-node-name node) date-string))
149 time))
150
151(defun url-dav-process-boolean-property (node)
216d3806 152 (/= 0 (string-to-number (url-dav-node-text node))))
8c8b8430
SM
153
154(defun url-dav-process-uri-property (node)
155 ;; Returns a parsed representation of the URL...
156 (url-generic-parse-url (url-dav-node-text node)))
157
158(defun url-dav-find-parser (node)
159 "Find a function to parse the XML node NODE."
160 (or (get (xml-node-name node) 'dav-parser)
161 (let ((fn (intern (format "url-dav-process-%s" (xml-node-name node)))))
162 (if (not (fboundp fn))
163 (setq fn 'url-dav-node-text)
164 (put (xml-node-name node) 'dav-parser fn))
165 fn)))
166
167(defmacro url-dav-dispatch-node (node)
168 `(funcall (url-dav-find-parser ,node) ,node))
169
170(defun url-dav-process-DAV:prop (node)
171 ;; A prop node has content model of ANY
172 ;;
173 ;; Some predefined nodes have special meanings though.
174 ;;
175 ;; DAV:supportedlock - list of DAV:lockentry
176 ;; DAV:source
177 ;; DAV:iscollection - boolean
178 ;; DAV:getcontentlength - integer
179 ;; DAV:ishidden - boolean
180 ;; DAV:getcontenttype - string
181 ;; DAV:resourcetype - node who's name is the resource type
182 ;; DAV:getlastmodified - date
183 ;; DAV:creationdate - date
184 ;; DAV:displayname - string
185 ;; DAV:getetag - unknown
186 (let ((children (xml-node-children node))
187 (node-type nil)
188 (props nil)
189 (value nil)
190 (handler-func nil))
191 (when (not children)
192 (error "No child nodes in DAV:prop"))
193
194 (while children
195 (setq node (car children)
196 node-type (intern
197 (or
198 (cdr-safe (assq url-dav-datatype-attribute
199 (xml-node-attributes node)))
200 "unknown"))
201 value nil)
202
203 (case node-type
204 ((dateTime.iso8601tz
205 dateTime.iso8601
206 dateTime.tz
207 dateTime.rfc1123
208 dateTime
209 date) ; date is our 'special' one...
210 ;; Some type of date/time string.
211 (setq value (url-dav-process-date-property node)))
212 (int
213 ;; Integer type...
214 (setq value (url-dav-process-integer-property node)))
215 ((number float)
216 (setq value (url-dav-process-number-property node)))
217 (boolean
218 (setq value (url-dav-process-boolean-property node)))
219 (uri
220 (setq value (url-dav-process-uri-property node)))
221 (otherwise
222 (if (not (eq node-type 'unknown))
223 (url-debug 'dav "Unknown data type in url-dav-process-prop: %s"
224 node-type))
225 (setq value (url-dav-dispatch-node node))))
226
227 (setq props (plist-put props (xml-node-name node) value)
228 children (cdr children)))
229 props))
230
231(defun url-dav-process-DAV:supportedlock (node)
232 ;; DAV:supportedlock is a list of DAV:lockentry items.
233 ;; DAV:lockentry in turn contains a DAV:lockscope and DAV:locktype.
234 ;; The DAV:lockscope must have a single node beneath it, ditto for
235 ;; DAV:locktype.
236 (let ((children (xml-node-children node))
237 (results nil)
238 scope type)
239 (while children
240 (when (and (not (stringp (car children)))
241 (eq (xml-node-name (car children)) 'DAV:lockentry))
242 (setq scope (assq 'DAV:lockscope (xml-node-children (car children)))
243 type (assq 'DAV:locktype (xml-node-children (car children))))
244 (when (and scope type)
245 (setq scope (xml-node-name (car (xml-node-children scope)))
246 type (xml-node-name (car (xml-node-children type))))
247 (push (cons type scope) results)))
248 (setq children (cdr children)))
249 results))
250
251(defun url-dav-process-subnode-property (node)
252 ;; Returns a list of child node names.
253 (delq nil (mapcar 'car-safe (xml-node-children node))))
254
255(defalias 'url-dav-process-DAV:depth 'url-dav-process-integer-property)
256(defalias 'url-dav-process-DAV:resourcetype 'url-dav-process-subnode-property)
257(defalias 'url-dav-process-DAV:locktype 'url-dav-process-subnode-property)
258(defalias 'url-dav-process-DAV:lockscope 'url-dav-process-subnode-property)
259(defalias 'url-dav-process-DAV:getcontentlength 'url-dav-process-integer-property)
260(defalias 'url-dav-process-DAV:getlastmodified 'url-dav-process-date-property)
261(defalias 'url-dav-process-DAV:creationdate 'url-dav-process-date-property)
262(defalias 'url-dav-process-DAV:iscollection 'url-dav-process-boolean-property)
263(defalias 'url-dav-process-DAV:ishidden 'url-dav-process-boolean-property)
264
265(defun url-dav-process-DAV:locktoken (node)
266 ;; DAV:locktoken can have one or more DAV:href children.
267 (delq nil (mapcar (lambda (n)
268 (if (stringp n)
269 n
270 (url-dav-dispatch-node n)))
271 (xml-node-children node))))
272
273(defun url-dav-process-DAV:owner (node)
274 ;; DAV:owner can contain anything.
275 (delq nil (mapcar (lambda (n)
276 (if (stringp n)
277 n
278 (url-dav-dispatch-node n)))
279 (xml-node-children node))))
280
281(defun url-dav-process-DAV:activelock (node)
282 ;; DAV:activelock can contain:
283 ;; DAV:lockscope
284 ;; DAV:locktype
285 ;; DAV:depth
286 ;; DAV:owner (optional)
287 ;; DAV:timeout (optional)
288 ;; DAV:locktoken (optional)
289 (let ((children (xml-node-children node))
290 (results nil))
291 (while children
292 (if (listp (car children))
293 (push (cons (xml-node-name (car children))
294 (url-dav-dispatch-node (car children)))
295 results))
296 (setq children (cdr children)))
297 results))
298
299(defun url-dav-process-DAV:lockdiscovery (node)
300 ;; Can only contain a list of DAV:activelock objects.
301 (let ((children (xml-node-children node))
302 (results nil))
303 (while children
304 (cond
305 ((stringp (car children))
306 ;; text node? why?
307 nil)
308 ((eq (xml-node-name (car children)) 'DAV:activelock)
309 (push (url-dav-dispatch-node (car children)) results))
310 (t
311 ;; Ignore unknown nodes...
312 nil))
313 (setq children (cdr children)))
314 results))
315
316(defun url-dav-process-DAV:status (node)
317 ;; The node contains a standard HTTP/1.1 response line... we really
318 ;; only care about the numeric status code.
319 (let ((status (url-dav-node-text node)))
320 (if (string-match "\\`[ \r\t\n]*HTTP/[0-9.]+ \\([0-9]+\\)" status)
216d3806 321 (string-to-number (match-string 1 status))
8c8b8430
SM
322 500)))
323
324(defun url-dav-process-DAV:propstat (node)
325 ;; A propstate node can have the following children...
326 ;;
327 ;; DAV:prop - a list of properties and values
328 ;; DAV:status - An HTTP/1.1 status line
329 (let ((children (xml-node-children node))
330 (props nil)
331 (status nil))
332 (when (not children)
333 (error "No child nodes in DAV:propstat"))
334
335 (setq props (url-dav-dispatch-node (assq 'DAV:prop children))
336 status (url-dav-dispatch-node (assq 'DAV:status children)))
337
338 ;; Need to parse out the HTTP status
339 (setq props (plist-put props 'DAV:status status))
340 props))
341
342(defun url-dav-process-DAV:response (node)
343 (let ((children (xml-node-children node))
344 (propstat nil)
345 (href))
346 (when (not children)
347 (error "No child nodes in DAV:response"))
348
349 ;; A response node can have the following children...
350 ;;
351 ;; DAV:href - URL the response is for.
352 ;; DAV:propstat - see url-dav-process-propstat
353 ;; DAV:responsedescription - text description of the response
354 (setq propstat (assq 'DAV:propstat children)
355 href (assq 'DAV:href children))
356
357 (when (not href)
358 (error "No href in DAV:response"))
359
360 (when (not propstat)
361 (error "No propstat in DAV:response"))
362
363 (setq propstat (url-dav-dispatch-node propstat)
364 href (url-dav-dispatch-node href))
365 (cons href propstat)))
366
367(defun url-dav-process-DAV:multistatus (node)
368 (let ((children (xml-node-children node))
369 (results nil))
370 (while children
371 (push (url-dav-dispatch-node (car children)) results)
372 (setq children (cdr children)))
373 results))
374
375\f
376;;; DAV request/response generation/processing
377(defun url-dav-process-response (buffer url)
76827ca4 378 "Parse a WebDAV response from BUFFER, interpreting it relative to URL.
8c8b8430
SM
379
380The buffer must have been retrieved by HTTP or HTTPS and contain an
76827ca4 381XML document."
8c8b8430
SM
382 (declare (special url-http-content-type
383 url-http-response-status
384 url-http-end-of-headers))
385 (let ((tree nil)
386 (overall-status nil))
387 (when buffer
388 (unwind-protect
f1bfaf65 389 (with-current-buffer buffer
8c8b8430
SM
390 (goto-char url-http-end-of-headers)
391 (setq overall-status url-http-response-status)
392
393 ;; XML documents can be transferred as either text/xml or
394 ;; application/xml, and we are required to accept both of
395 ;; them.
396 (if (and
397 url-http-content-type
f1bfaf65
SM
398 (string-match "\\`\\(text\\|application\\)/xml"
399 url-http-content-type))
8c8b8430
SM
400 (setq tree (xml-parse-region (point) (point-max)))))
401 ;; Clean up after ourselves.
f1bfaf65 402 (kill-buffer buffer)))
8c8b8430 403
f1bfaf65 404 ;; We should now be
8c8b8430
SM
405 (if (eq (xml-node-name (car tree)) 'DAV:multistatus)
406 (url-dav-dispatch-node (car tree))
407 (url-debug 'dav "Got back singleton response for URL(%S)" url)
408 (let ((properties (url-dav-dispatch-node (car tree))))
409 ;; We need to make sure we have a DAV:status node in there for
410 ;; higher-level code;
411 (setq properties (plist-put properties 'DAV:status overall-status))
412 ;; Make this look like a DAV:multistatus parse tree so that
413 ;; nobody but us needs to know the difference.
414 (list (cons url properties))))))
415
416(defun url-dav-request (url method tag body
417 &optional depth headers namespaces)
76827ca4 418 "Perform WebDAV operation METHOD on URL. Return the parsed responses.
8c8b8430
SM
419Automatically creates an XML request body if TAG is non-nil.
420BODY is the XML document fragment to be enclosed by <TAG></TAG>.
421
422DEPTH is how deep the request should propogate. Default is 0, meaning
423it should apply only to URL. A negative number means to use
424`Infinity' for the depth. Not all WebDAV servers support this depth
425though.
426
427HEADERS is an assoc list of extra headers to send in the request.
428
429NAMESPACES is an assoc list of (NAMESPACE . EXPANSION), and these are
430added to the <TAG> element. The DAV=DAV: namespace is automatically
76827ca4 431added to this list, so most requests can just pass in nil."
8c8b8430
SM
432 ;; Take care of the default value for depth...
433 (setq depth (or depth 0))
434
435 ;; Now lets translate it into something webdav can understand.
436 (if (< depth 0)
437 (setq depth "Infinity")
438 (setq depth (int-to-string depth)))
439 (if (not (assoc "DAV" namespaces))
440 (setq namespaces (cons '("DAV" . "DAV:") namespaces)))
441
442 (let* ((url-request-extra-headers `(("Depth" . ,depth)
443 ("Content-type" . "text/xml")
444 ,@headers))
445 (url-request-method method)
446 (url-request-data
447 (if tag
448 (concat
449 "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n"
450 "<" (symbol-name tag) " "
451 ;; add in the appropriate namespaces...
452 (mapconcat (lambda (ns)
453 (concat "xmlns:" (car ns) "='" (cdr ns) "'"))
454 namespaces "\n ")
455 ">\n"
456 body
457 "</" (symbol-name tag) ">\n"))))
458 (url-dav-process-response (url-retrieve-synchronously url) url)))
459
460;;;###autoload
461(defun url-dav-get-properties (url &optional attributes depth namespaces)
462 "Return properties for URL, up to DEPTH levels deep.
463
464Returns an assoc list, where the key is the filename (possibly a full
465URI), and the value is a standard property list of DAV property
76827ca4 466names (ie: DAV:resourcetype)."
8c8b8430
SM
467 (url-dav-request url "PROPFIND" 'DAV:propfind
468 (if attributes
469 (mapconcat (lambda (attr)
470 (concat "<DAV:prop><"
471 (symbol-name attr)
472 "/></DAV:prop>"))
473 attributes "\n ")
474 " <DAV:allprop/>")
475 depth nil namespaces))
476
477(defmacro url-dav-http-success-p (status)
478 "Return whether PROPERTIES was the result of a successful DAV request."
479 `(= (/ (or ,status 500) 100) 2))
480
481\f
482;;; Locking support
483(defvar url-dav-lock-identifier (concat "mailto:" user-mail-address)
484 "*URL used as contact information when creating locks in DAV.
485This will be used as the contents of the DAV:owner/DAV:href tag to
486identify the owner of a LOCK when requesting it. This will be shown
487to other users when the DAV:lockdiscovery property is requested, so
76827ca4 488make sure you are comfortable with it leaking to the outside world.")
8c8b8430
SM
489
490;;;###autoload
491(defun url-dav-lock-resource (url exclusive &optional depth)
492 "Request a lock on URL. If EXCLUSIVE is non-nil, get an exclusive lock.
493Optional 3rd argument DEPTH says how deep the lock should go, default is 0
494\(lock only the resource and none of its children\).
495
496Returns a cons-cell of (SUCCESSFUL-RESULTS . FAILURE-RESULTS).
497SUCCESSFUL-RESULTS is a list of (URL STATUS locktoken).
76827ca4 498FAILURE-RESULTS is a list of (URL STATUS)."
8c8b8430
SM
499 (setq exclusive (if exclusive "<DAV:exclusive/>" "<DAV:shared/>"))
500 (let* ((body
501 (concat
502 " <DAV:lockscope>" exclusive "</DAV:lockscope>\n"
503 " <DAV:locktype> <DAV:write/> </DAV:locktype>\n"
504 " <DAV:owner>\n"
505 " <DAV:href>" url-dav-lock-identifier "</DAV:href>\n"
506 " </DAV:owner>\n"))
507 (response nil) ; Responses to the LOCK request
508 (result nil) ; For walking thru the response list
509 (child-url nil)
510 (child-status nil)
511 (failures nil) ; List of failure cases (URL . STATUS)
512 (successes nil)) ; List of success cases (URL . STATUS)
513 (setq response (url-dav-request url "LOCK" 'DAV:lockinfo body
514 depth '(("Timeout" . "Infinite"))))
515
516 ;; Get the parent URL ready for expand-file-name
517 (if (not (vectorp url))
518 (setq url (url-generic-parse-url url)))
519
520 ;; Walk thru the response list, fully expand the URL, and grab the
521 ;; status code.
522 (while response
523 (setq result (pop response)
524 child-url (url-expand-file-name (pop result) url)
525 child-status (or (plist-get result 'DAV:status) 500))
526 (if (url-dav-http-success-p child-status)
527 (push (list url child-status "huh") successes)
528 (push (list url child-status) failures)))
529 (cons successes failures)))
530
531;;;###autoload
532(defun url-dav-active-locks (url &optional depth)
533 "Return an assoc list of all active locks on URL."
534 (let ((response (url-dav-get-properties url '(DAV:lockdiscovery) depth))
535 (properties nil)
536 (child nil)
537 (child-url nil)
538 (child-results nil)
539 (results nil))
540 (if (not (vectorp url))
541 (setq url (url-generic-parse-url url)))
542
543 (while response
544 (setq child (pop response)
545 child-url (pop child)
546 child-results nil)
547 (when (and (url-dav-http-success-p (plist-get child 'DAV:status))
548 (setq child (plist-get child 'DAV:lockdiscovery)))
549 ;; After our parser has had its way with it, The
550 ;; DAV:lockdiscovery property is a list of DAV:activelock
551 ;; objects, which are comprised of DAV:activelocks, which
552 ;; assoc lists of properties and values.
553 (while child
554 (if (assq 'DAV:locktoken (car child))
555 (let ((tokens (cdr (assq 'DAV:locktoken (car child))))
556 (owners (cdr (assq 'DAV:owner (car child)))))
557 (dolist (token tokens)
558 (dolist (owner owners)
559 (push (cons token owner) child-results)))))
560 (pop child)))
561 (if child-results
562 (push (cons (url-expand-file-name child-url url) child-results)
563 results)))
564 results))
565
566;;;###autoload
567(defun url-dav-unlock-resource (url lock-token)
568 "Release the lock on URL represented by LOCK-TOKEN.
76827ca4 569Returns t iff the lock was successfully released."
8c8b8430
SM
570 (declare (special url-http-response-status))
571 (let* ((url-request-extra-headers (list (cons "Lock-Token"
572 (concat "<" lock-token ">"))))
573 (url-request-method "UNLOCK")
574 (url-request-data nil)
575 (buffer (url-retrieve-synchronously url))
576 (result nil))
577 (when buffer
578 (unwind-protect
f1bfaf65 579 (with-current-buffer buffer
8c8b8430
SM
580 (setq result (url-dav-http-success-p url-http-response-status)))
581 (kill-buffer buffer)))
582 result))
583
584\f
585;;; file-name-handler stuff
586(defun url-dav-file-attributes-mode-string (properties)
587 (let ((modes (make-string 10 ?-))
588 (supported-locks (plist-get properties 'DAV:supportedlock))
589 (executable-p (equal (plist-get properties 'http://apache.org/dav/props/executable)
590 "T"))
591 (directory-p (memq 'DAV:collection (plist-get properties 'DAV:resourcetype)))
592 (readable t)
593 (lock nil))
594 ;; Assume we can read this, otherwise the PROPFIND would have
595 ;; failed.
596 (when readable
597 (aset modes 1 ?r)
598 (aset modes 4 ?r)
599 (aset modes 7 ?r))
600
601 (when directory-p
602 (aset modes 0 ?d))
603
604 (when executable-p
605 (aset modes 3 ?x)
606 (aset modes 6 ?x)
607 (aset modes 9 ?x))
608
609 (while supported-locks
610 (setq lock (car supported-locks)
611 supported-locks (cdr supported-locks))
612 (case (car lock)
613 (DAV:write
614 (case (cdr lock)
615 (DAV:shared ; group permissions (possibly world)
616 (aset modes 5 ?w))
617 (DAV:exclusive
618 (aset modes 2 ?w)) ; owner permissions?
619 (otherwise
620 (url-debug 'dav "Unrecognized DAV:lockscope (%S)" (cdr lock)))))
621 (otherwise
622 (url-debug 'dav "Unrecognized DAV:locktype (%S)" (car lock)))))
623 modes))
624
0aa70d32
SM
625(autoload 'url-http-head-file-attributes "url-http")
626
8c8b8430 627;;;###autoload
f1bfaf65 628(defun url-dav-file-attributes (url &optional id-format)
8c8b8430
SM
629 (let ((properties (cdar (url-dav-get-properties url)))
630 (attributes nil))
631 (if (and properties
632 (url-dav-http-success-p (plist-get properties 'DAV:status)))
633 ;; We got a good DAV response back..
634 (setq attributes
635 (list
636 ;; t for directory, string for symbolic link, or nil
637 ;; Need to support DAV Bindings to figure out the
638 ;; symbolic link issues.
639 (if (memq 'DAV:collection (plist-get properties 'DAV:resourcetype)) t nil)
640
641 ;; Number of links to file... Needs DAV Bindings.
642 1
643
644 ;; File uid - no way to figure out?
645 0
646
647 ;; File gid - no way to figure out?
648 0
649
650 ;; Last access time - ???
651 nil
652
653 ;; Last modification time
654 (plist-get properties 'DAV:getlastmodified)
655
656 ;; Last status change time... just reuse last-modified
657 ;; for now.
658 (plist-get properties 'DAV:getlastmodified)
659
660 ;; size in bytes
661 (or (plist-get properties 'DAV:getcontentlength) 0)
662
663 ;; file modes as a string like `ls -l'
664 ;;
665 ;; Should be able to build this up from the
666 ;; DAV:supportedlock attribute pretty easily. Getting
667 ;; the group info could be impossible though.
668 (url-dav-file-attributes-mode-string properties)
669
670 ;; t iff file's gid would change if it were deleted &
671 ;; recreated. No way for us to know that thru DAV.
672 nil
673
674 ;; inode number - meaningless
675 nil
676
677 ;; device number - meaningless
678 nil))
679 ;; Fall back to just the normal http way of doing things.
f1bfaf65 680 (setq attributes (url-http-head-file-attributes url id-format)))
8c8b8430
SM
681 attributes))
682
683;;;###autoload
684(defun url-dav-save-resource (url obj &optional content-type lock-token)
685 "Save OBJ as URL using WebDAV.
686URL must be a fully qualified URL.
687OBJ may be a buffer or a string."
0aa70d32 688 (declare (special url-http-response-status))
8c8b8430
SM
689 (let ((buffer nil)
690 (result nil)
691 (url-request-extra-headers nil)
692 (url-request-method "PUT")
693 (url-request-data
694 (cond
695 ((bufferp obj)
f1bfaf65 696 (with-current-buffer obj
8c8b8430
SM
697 (buffer-string)))
698 ((stringp obj)
699 obj)
700 (t
701 (error "Invalid object to url-dav-save-resource")))))
702
703 (if lock-token
704 (push
705 (cons "If" (concat "(<" lock-token ">)"))
706 url-request-extra-headers))
707
708 ;; Everything must always have a content-type when we submit it.
709 (push
710 (cons "Content-type" (or content-type "application/octet-stream"))
711 url-request-extra-headers)
712
713 ;; Do the save...
714 (setq buffer (url-retrieve-synchronously url))
715
716 ;; Sanity checking
717 (when buffer
718 (unwind-protect
f1bfaf65 719 (with-current-buffer buffer
8c8b8430
SM
720 (setq result (url-dav-http-success-p url-http-response-status)))
721 (kill-buffer buffer)))
722 result))
723
724(eval-when-compile
725 (defmacro url-dav-delete-something (url lock-token &rest error-checking)
726 "Delete URL completely, with no sanity checking whatsoever. DO NOT USE.
727This is defined as a macro that will not be visible from compiled files.
728Use with care, and even then think three times.
729"
730 `(progn
731 ,@error-checking
732 (url-dav-request ,url "DELETE" nil nil -1
733 (if ,lock-token
734 (list
735 (cons "If"
736 (concat "(<" ,lock-token ">)"))))))))
737
738
739;;;###autoload
740(defun url-dav-delete-directory (url &optional recursive lock-token)
741 "Delete the WebDAV collection URL.
742If optional second argument RECURSIVE is non-nil, then delete all
76827ca4 743files in the collection as well."
8c8b8430
SM
744 (let ((status nil)
745 (props nil)
746 (props nil))
747 (setq props (url-dav-delete-something
748 url lock-token
749 (setq props (url-dav-get-properties url '(DAV:getcontenttype) 1))
750 (if (and (not recursive)
751 (/= (length props) 1))
752 (signal 'file-error (list "Removing directory"
753 "directory not empty" url)))))
754
755 (mapc (lambda (result)
756 (setq status (plist-get (cdr result) 'DAV:status))
757 (if (not (url-dav-http-success-p status))
758 (signal 'file-error (list "Removing directory"
759 "Errror removing"
760 (car result) status))))
761 props))
762 nil)
763
764;;;###autoload
765(defun url-dav-delete-file (url &optional lock-token)
766 "Delete file named URL."
767 (let ((props nil)
768 (status nil))
769 (setq props (url-dav-delete-something
770 url lock-token
771 (setq props (url-dav-get-properties url))
772 (if (eq (plist-get (cdar props) 'DAV:resourcetype) 'DAV:collection)
773 (signal 'file-error (list "Removing old name" "is a collection" url)))))
774
775 (mapc (lambda (result)
776 (setq status (plist-get (cdr result) 'DAV:status))
777 (if (not (url-dav-http-success-p status))
778 (signal 'file-error (list "Removing old name"
779 "Errror removing"
780 (car result) status))))
781 props))
782 nil)
783
784;;;###autoload
785(defun url-dav-directory-files (url &optional full match nosort files-only)
786 "Return a list of names of files in DIRECTORY.
787There are three optional arguments:
788If FULL is non-nil, return absolute file names. Otherwise return names
789 that are relative to the specified directory.
790If MATCH is non-nil, mention only file names that match the regexp MATCH.
791If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
76827ca4 792 NOSORT is useful if you plan to sort the result yourself."
8c8b8430
SM
793 (let ((properties (url-dav-get-properties url '(DAV:resourcetype) 1))
794 (child-url nil)
795 (child-props nil)
796 (files nil)
797 (parsed-url (url-generic-parse-url url)))
798
799 (if (= (length properties) 1)
800 (signal 'file-error (list "Opening directory" "not a directory" url)))
801
802 (while properties
803 (setq child-props (pop properties)
804 child-url (pop child-props))
805 (if (and (eq (plist-get child-props 'DAV:resourcetype) 'DAV:collection)
806 files-only)
807 ;; It is a directory, and we were told to return just files.
808 nil
809
810 ;; Fully expand the URL and then rip off the beginning if we
811 ;; are not supposed to return fully-qualified names.
812 (setq child-url (url-expand-file-name child-url parsed-url))
813 (if (not full)
814 (setq child-url (substring child-url (length url))))
815
816 ;; We don't want '/' as the last character in filenames...
817 (if (string-match "/$" child-url)
818 (setq child-url (substring child-url 0 -1)))
819
820 ;; If we have a match criteria, then apply it.
821 (if (or (and match (not (string-match match child-url)))
822 (string= child-url "")
823 (string= child-url url))
824 nil
825 (push child-url files))))
826
827 (if nosort
828 files
829 (sort files 'string-lessp))))
830
831;;;###autoload
832(defun url-dav-file-directory-p (url)
833 "Return t if URL names an existing DAV collection."
834 (let ((properties (cdar (url-dav-get-properties url '(DAV:resourcetype)))))
835 (eq (plist-get properties 'DAV:resourcetype) 'DAV:collection)))
836
837;;;###autoload
838(defun url-dav-make-directory (url &optional parents)
839 "Create the directory DIR and any nonexistent parent dirs."
840 (declare (special url-http-response-status))
841 (let* ((url-request-extra-headers nil)
842 (url-request-method "MKCOL")
843 (url-request-data nil)
844 (buffer (url-retrieve-synchronously url))
845 (result nil))
846 (when buffer
847 (unwind-protect
f1bfaf65 848 (with-current-buffer buffer
8c8b8430
SM
849 (case url-http-response-status
850 (201 ; Collection created in its entirety
851 (setq result t))
852 (403 ; Forbidden
853 nil)
854 (405 ; Method not allowed
855 nil)
856 (409 ; Conflict
857 nil)
858 (415 ; Unsupported media type (WTF?)
859 nil)
860 (507 ; Insufficient storage
861 nil)
862 (otherwise
863 nil)))
864 (kill-buffer buffer)))
865 result))
866
867;;;###autoload
868(defun url-dav-rename-file (oldname newname &optional overwrite)
869 (if (not (and (string-match url-handler-regexp oldname)
870 (string-match url-handler-regexp newname)))
0aa70d32
SM
871 (signal 'file-error
872 (list "Cannot rename between different URL backends"
873 oldname newname)))
8c8b8430
SM
874
875 (let* ((headers nil)
876 (props nil)
877 (status nil)
878 (directory-p (url-dav-file-directory-p oldname))
879 (exists-p (url-http-file-exists-p newname)))
880
881 (if (and exists-p
882 (or
883 (null overwrite)
884 (and (numberp overwrite)
885 (not (yes-or-no-p
886 (format "File %s already exists; rename to it anyway? "
887 newname))))))
888 (signal 'file-already-exists (list "File already exists" newname)))
889
890 ;; Honor the overwrite flag...
891 (if overwrite (push '("Overwrite" . "T") headers))
892
893 ;; Have to tell them where to copy it to!
894 (push (cons "Destination" newname) headers)
895
896 ;; Always send a depth of -1 in case we are moving a collection.
897 (setq props (url-dav-request oldname "MOVE" nil nil (if directory-p -1 0)
898 headers))
899
900 (mapc (lambda (result)
901 (setq status (plist-get (cdr result) 'DAV:status))
902
903 (if (not (url-dav-http-success-p status))
904 (signal 'file-error (list "Renaming" oldname newname status))))
905 props)
906 t))
907
908;;;###autoload
909(defun url-dav-file-name-all-completions (file url)
910 "Return a list of all completions of file name FILE in directory DIRECTORY.
76827ca4 911These are all file names in directory DIRECTORY which begin with FILE."
8c8b8430
SM
912 (url-dav-directory-files url nil (concat "^" file ".*")))
913
914;;;###autoload
915(defun url-dav-file-name-completion (file url)
916 "Complete file name FILE in directory DIRECTORY.
917Returns the longest string
918common to all file names in DIRECTORY that start with FILE.
919If there is only one and FILE matches it exactly, returns t.
76827ca4 920Returns nil if DIR contains no name starting with FILE."
8c8b8430
SM
921 (let ((matches (url-dav-file-name-all-completions file url))
922 (result nil))
923 (cond
924 ((null matches)
925 ;; No matches
926 nil)
927 ((and (= (length matches) 1)
928 (string= file (car matches)))
929 ;; Only one file and FILE matches it exactly...
930 t)
931 (t
932 ;; Need to figure out the longest string that they have in commmon
933 (setq matches (sort matches (lambda (a b) (> (length a) (length b)))))
934 (let ((n (length file))
935 (searching t)
936 (regexp nil)
937 (failed nil))
938 (while (and searching
939 (< n (length (car matches))))
940 (setq regexp (concat "^" (substring (car matches) 0 (1+ n)))
941 failed nil)
942 (dolist (potential matches)
943 (if (not (string-match regexp potential))
944 (setq failed t)))
945 (if failed
946 (setq searching nil)
947 (incf n)))
948 (substring (car matches) 0 n))))))
949
950(defun url-dav-register-handler (op)
951 (put op 'url-file-handlers (intern-soft (format "url-dav-%s" op))))
952
953(mapcar 'url-dav-register-handler
954 '(file-name-all-completions
955 file-name-completion
956 rename-file
957 make-directory
958 file-directory-p
959 directory-files
960 delete-file
961 delete-directory
962 file-attributes))
963
964\f
965;;; Version Control backend cruft
966
967;(put 'vc-registered 'url-file-handlers 'url-dav-vc-registered)
968
969;;;###autoload
970(defun url-dav-vc-registered (url)
971 (if (and (string-match "\\`https?" url)
972 (plist-get (url-http-options url) 'dav))
973 (progn
974 (vc-file-setprop url 'vc-backend 'dav)
975 t)))
976
977\f
978;;; Miscellaneous stuff.
979
980(provide 'url-dav)
e5566bd5 981
76827ca4
SM
982;; arch-tag: 2b14b7b3-888a-49b8-a490-17276a40e78e
983;;; url-dav.el ends here