| blob | f47bc5da3e475b1daa34a76f371a5f3ffe0f63df |
1 ;;; url-dav.el --- WebDAV support
3 ;; Copyright (C) 2001, 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Bill Perry <wmperry@gnu.org>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: url, vc
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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
24 ;; DAV is in RFC 2518.
26 ;;; Commentary:
28 ;;; Code:
40 ;; Dynamically bound.
46 "Return a list of the elements occurring in both of the lists L1 and L2."
48 l2
56 ;;;###autoload
58 "Return WebDAV protocol version supported by URL.
59 Returns nil if WebDAV is not supported."
64 "Return the text data from the XML node NODE."
67 txt
70 \f
71 ;;; Parsing routines for the actual node contents.
72 ;;
73 ;; I am not incredibly happy with how this code looks/works right
74 ;; now, but it DOES work, and if we get the API right, our callers
75 ;; won't have to worry about the internal representation.
101 time-secfrac))
108 "List of regular expressions matching ISO 8601 dates.
109 1st regular expression matches the date.
110 2nd regular expression matches the time.
119 re-start
120 time seconds minute hour fractional-seconds
121 day month year day-of-week dst tz)
122 ;; We need to populate 'time' with
123 ;; (SEC MIN HOUR DAY MON YEAR DOW DST TZ)
125 ;; Nobody else handles iso8601 correctly, let's do it ourselves.
144 ;; Fall back to having Gnus do fancy things for us.
152 time))
158 ;; Returns a parsed representation of the URL...
162 "Find a function to parse the XML node NODE."
168 fn)))
174 ;; A prop node has content model of ANY
175 ;;
176 ;; Some predefined nodes have special meanings though.
177 ;;
178 ;; DAV:supportedlock - list of DAV:lockentry
179 ;; DAV:source
180 ;; DAV:iscollection - boolean
181 ;; DAV:getcontentlength - integer
182 ;; DAV:ishidden - boolean
183 ;; DAV:getcontenttype - string
184 ;; DAV:resourcetype - node who's name is the resource type
185 ;; DAV:getlastmodified - date
186 ;; DAV:creationdate - date
187 ;; DAV:displayname - string
188 ;; DAV:getetag - unknown
204 value nil)
208 `dateTime.iso8601
209 `dateTime.tz
210 `dateTime.rfc1123
211 `dateTime
213 ;; Some type of date/time string.
215 (`int
216 ;; Integer type...
220 (`boolean
222 (`uri
227 node-type))
232 props))
235 ;; DAV:supportedlock is a list of DAV:lockentry items.
236 ;; DAV:lockentry in turn contains a DAV:lockscope and DAV:locktype.
237 ;; The DAV:lockscope must have a single node beneath it, ditto for
238 ;; DAV:locktype.
241 scope type)
252 results))
255 ;; Returns a list of child node names.
269 ;; DAV:locktoken can have one or more DAV:href children.
272 n
277 ;; DAV:owner can contain anything.
280 n
285 ;; DAV:activelock can contain:
286 ;; DAV:lockscope
287 ;; DAV:locktype
288 ;; DAV:depth
289 ;; DAV:owner (optional)
290 ;; DAV:timeout (optional)
291 ;; DAV:locktoken (optional)
298 results))
300 results))
303 ;; Can only contain a list of DAV:activelock objects.
309 ;; text node? why?
310 nil)
314 ;; Ignore unknown nodes...
315 nil))
317 results))
320 ;; The node contains a standard HTTP/1.1 response line... we really
321 ;; only care about the numeric status code.
328 ;; A propstate node can have the following children...
329 ;;
330 ;; DAV:prop - a list of properties and values
331 ;; DAV:status - An HTTP/1.1 status line
341 ;; Need to parse out the HTTP status
343 props))
352 ;; A response node can have the following children...
353 ;;
354 ;; DAV:href - URL the response is for.
355 ;; DAV:propstat - see url-dav-process-propstat
356 ;; DAV:responsedescription - text description of the response
376 results))
378 \f
379 ;;; DAV request/response generation/processing
381 "Parse a WebDAV response from BUFFER, interpreting it relative to URL.
383 The buffer must have been retrieved by HTTP or HTTPS and contain an
384 XML document."
390 ;; First remove all indentation and line endings
398 ;; XML documents can be transferred as either text/xml or
399 ;; application/xml, and we are required to accept both of
400 ;; them.
402 url-http-content-type
404 url-http-content-type))
406 ;; Clean up after ourselves.
409 ;; We should now be
414 ;; We need to make sure we have a DAV:status node in there for
415 ;; higher-level code;
417 ;; Make this look like a DAV:multistatus parse tree so that
418 ;; nobody but us needs to know the difference.
421 ;;;###autoload
424 "Perform WebDAV operation METHOD on URL. Return the parsed responses.
425 Automatically creates an XML request body if TAG is non-nil.
426 BODY is the XML document fragment to be enclosed by <TAG></TAG>.
428 DEPTH is how deep the request should propagate. Default is 0, meaning
429 it should apply only to URL. A negative number means to use
430 `Infinity' for the depth. Not all WebDAV servers support this depth
431 though.
433 HEADERS is an assoc list of extra headers to send in the request.
435 NAMESPACES is an assoc list of (NAMESPACE . EXPANSION), and these are
436 added to the <TAG> element. The DAV=DAV: namespace is automatically
437 added to this list, so most requests can just pass in nil."
438 ;; Take care of the default value for depth...
441 ;; Now let's translate it into something webdav can understand.
457 ;; add in the appropriate namespaces...
462 body
467 "Return properties for URL, up to DEPTH levels deep.
469 Returns an assoc list, where the key is the filename (possibly a full
470 URI), and the value is a standard property list of DAV property
471 names (ie: DAV:resourcetype)."
480 depth nil namespaces))
483 "Return whether STATUS was the result of a successful DAV request."
486 \f
487 ;;; Locking support
489 "URL used as contact information when creating locks in DAV.
490 This will be used as the contents of the DAV:owner/DAV:href tag to
491 identify the owner of a LOCK when requesting it. This will be shown
492 to other users when the DAV:lockdiscovery property is requested, so
496 "Request a lock on URL. If EXCLUSIVE is non-nil, get an exclusive lock.
497 Optional 3rd argument DEPTH says how deep the lock should go, default is 0
498 \(lock only the resource and none of its children).
500 Returns a cons-cell of (SUCCESSFUL-RESULTS . FAILURE-RESULTS).
501 SUCCESSFUL-RESULTS is a list of (URL STATUS locktoken).
502 FAILURE-RESULTS is a list of (URL STATUS)."
520 ;; Get the parent URL ready for expand-file-name
524 ;; Walk thru the response list, fully expand the URL, and grab the
525 ;; status code.
536 "Return an assoc list of all active locks on URL."
549 child-results nil)
552 ;; After our parser has had its way with it, The
553 ;; DAV:lockdiscovery property is a list of DAV:activelock
554 ;; objects, which are comprised of DAV:activelocks, which
555 ;; assoc lists of properties and values.
566 results)))
567 results))
570 "Release the lock on URL represented by LOCK-TOKEN.
571 Returns t if the lock was successfully released."
583 result))
585 \f
586 ;;; file-name-handler stuff
595 ;; Assume we can read this, otherwise the PROPFIND would have
596 ;; failed.
624 modes))
630 ;; We got a good DAV response back..
632 ;; t for directory, string for symbolic link, or nil
633 ;; Need to support DAV Bindings to figure out the
634 ;; symbolic link issues.
637 ;; Number of links to file... Needs DAV Bindings.
638 1
640 ;; File uid - no way to figure out?
641 0
643 ;; File gid - no way to figure out?
644 0
646 ;; Last access time - ???
647 nil
649 ;; Last modification time
652 ;; Last status change time... just reuse last-modified
653 ;; for now.
656 ;; size in bytes
659 ;; file modes as a string like `ls -l'
660 ;;
661 ;; Should be able to build this up from the
662 ;; DAV:supportedlock attribute pretty easily. Getting
663 ;; the group info could be impossible though.
666 ;; t if file's gid would change if it were deleted &
667 ;; recreated. No way for us to know that thru DAV.
668 nil
670 ;; inode number - meaningless
671 nil
673 ;; device number - meaningless
674 nil)
675 ;; Fall back to just the normal http way of doing things.
679 "Save OBJ as URL using WebDAV.
680 URL must be a fully qualified URL.
681 OBJ may be a buffer or a string."
692 obj)
699 url-request-extra-headers))
701 ;; Everything must always have a content-type when we submit it.
704 url-request-extra-headers)
706 ;; Do the save...
709 ;; Sanity checking
715 result))
719 "Delete URL completely, with no sanity checking whatsoever. DO NOT USE.
720 This is defined as a macro that will not be visible from compiled files.
721 Use with care, and even then think three times."
723 ,@error-checking
732 "Delete the WebDAV collection URL.
733 If optional second argument RECURSIVE is non-nil, then delete all
734 files in the collection as well."
739 url lock-token
750 "Error removing"
752 props))
753 nil)
756 "Delete file named URL."
760 url lock-token
769 "Error removing"
771 props))
772 nil)
775 "Return a list of names of files in URL.
776 There are three optional arguments:
777 If FULL is non-nil, return absolute URLs. Otherwise return names
778 that are relative to the specified URL.
779 If MATCH is non-nil, mention only file names that match the regexp MATCH.
780 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
781 NOSORT is useful if you plan to sort the result yourself."
796 files-only)
797 ;; It is a directory, and we were told to return just files.
798 nil
800 ;; Fully expand the URL and then rip off the beginning if we
801 ;; are not supposed to return fully-qualified names.
804 ;; Parts of the URL might be hex'ed.
808 ;; We don't want '/' as the last character in filenames...
812 ;; If we have a match criteria, then apply it.
816 nil
820 files
824 "Return t if URL names an existing DAV collection."
827 t)))
830 "Create the directory DIR and any nonexistent parent dirs."
843 nil)
845 nil)
847 nil)
849 nil)
851 nil)
853 nil)))
855 result))
862 oldname newname)))
876 newname))))))
879 ;; Honor the overwrite flag...
882 ;; Have to tell them where to copy it to!
885 ;; Always send a depth of -1 in case we are moving a collection.
887 headers))
894 props)
895 t))
898 "Return a list of all completions of file name FILE in URL.
899 These are all file names in URL which begin with FILE."
903 "Complete file name FILE in URL.
904 Returns the longest string common to all file names in URL
905 that start with FILE.
906 If there is only one and FILE matches it exactly, returns t.
907 Returns nil if URL contains no name starting with FILE."
912 ;; No matches
913 nil)
916 ;; Only one file and FILE matches it exactly...
917 t)
919 ;; Need to figure out the longest string that they have in common
928 failed nil)
941 ;; These handlers are disabled because they incorrectly presume that
942 ;; the URL specifies an HTTP location and thus break FTP URLs.
944 ;; file-name-completion
945 ;; rename-file
946 ;; make-directory
947 ;; file-directory-p
948 ;; directory-files
949 ;; delete-file
950 ;; delete-directory
951 ;; file-attributes
952 ))
954 \f
955 ;;; Version Control backend cruft
957 ;(put 'vc-registered 'url-file-handlers 'url-dav-vc-registered)
959 ;;;###autoload
965 t)))
967 \f
968 ;;; Miscellaneous stuff.
972 ;;; url-dav.el ends here