Commit | Line | Data |
---|---|---|
8c8b8430 | 1 | ;;; url-handlers.el --- file-name-handler stuff for URL loading |
f1300fba | 2 | |
acaf905b | 3 | ;; Copyright (C) 1996-1999, 2004-2012 Free Software Foundation, Inc. |
f1300fba | 4 | |
8c8b8430 SM |
5 | ;; Keywords: comm, data, processes, hypermedia |
6 | ||
f1300fba SM |
7 | ;; This file is part of GNU Emacs. |
8 | ;; | |
4936186e | 9 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
f1300fba | 10 | ;; it under the terms of the GNU General Public License as published by |
4936186e GM |
11 | ;; the Free Software Foundation, either version 3 of the License, or |
12 | ;; (at your option) any later version. | |
13 | ||
f1300fba SM |
14 | ;; GNU Emacs is distributed in the hope that it will be useful, |
15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | ;; GNU General Public License for more details. | |
4936186e | 18 | |
f1300fba | 19 | ;; You should have received a copy of the GNU General Public License |
4936186e | 20 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
f1300fba SM |
21 | |
22 | ;;; Commentary: | |
23 | ||
24 | ;;; Code: | |
8c8b8430 | 25 | |
5007cdc9 | 26 | ;; (require 'url) |
29c7eba8 | 27 | (require 'url-parse) |
5007cdc9 SM |
28 | ;; (require 'url-util) |
29 | (eval-when-compile (require 'mm-decode)) | |
30 | ;; (require 'mailcap) | |
31 | ;; The following functions in the byte compiler's warnings are known not | |
32 | ;; to cause any real problem for the following reasons: | |
33 | ;; - mm-save-part-to-file, mm-destroy-parts: always used | |
34 | ;; after mm-dissect-buffer and defined in the same file. | |
35 | ;; The following are autoloaded instead of `require'd to avoid eagerly | |
36 | ;; loading all of URL when turning on url-handler-mode in the .emacs. | |
5007cdc9 SM |
37 | (autoload 'url-expand-file-name "url-expand" "Convert url to a fully specified url, and canonicalize it.") |
38 | (autoload 'mm-dissect-buffer "mm-decode" "Dissect the current buffer and return a list of MIME handles.") | |
39 | (autoload 'url-scheme-get-property "url-methods" "Get property of a URL SCHEME.") | |
8c8b8430 | 40 | |
8c8b8430 SM |
41 | ;; Implementation status |
42 | ;; --------------------- | |
43 | ;; Function Status | |
44 | ;; ------------------------------------------------------------ | |
45 | ;; add-name-to-file Needs DAV Bindings | |
46 | ;; copy-file Broken (assumes 1st item is URL) | |
47 | ;; delete-directory Finished (DAV) | |
48 | ;; delete-file Finished (DAV) | |
49 | ;; diff-latest-backup-file | |
50 | ;; directory-file-name unnecessary (what about VMS)? | |
51 | ;; directory-files Finished (DAV) | |
52 | ;; dired-call-process | |
53 | ;; dired-compress-file | |
54 | ;; dired-uncache | |
55 | ;; expand-file-name Finished | |
56 | ;; file-accessible-directory-p | |
57 | ;; file-attributes Finished, better with DAV | |
58 | ;; file-directory-p Needs DAV, finished | |
59 | ;; file-executable-p Finished | |
60 | ;; file-exists-p Finished | |
61 | ;; file-local-copy | |
62 | ;; file-modes | |
63 | ;; file-name-all-completions Finished (DAV) | |
64 | ;; file-name-as-directory | |
65 | ;; file-name-completion Finished (DAV) | |
66 | ;; file-name-directory | |
67 | ;; file-name-nondirectory | |
68 | ;; file-name-sans-versions why? | |
69 | ;; file-newer-than-file-p | |
70 | ;; file-ownership-preserved-p No way to know | |
71 | ;; file-readable-p Finished | |
72 | ;; file-regular-p !directory_p | |
a9f31e3d | 73 | ;; file-remote-p Finished |
8c8b8430 SM |
74 | ;; file-symlink-p Needs DAV bindings |
75 | ;; file-truename Needs DAV bindings | |
76 | ;; file-writable-p Check for LOCK? | |
77 | ;; find-backup-file-name why? | |
78 | ;; get-file-buffer why? | |
79 | ;; insert-directory Use DAV | |
80 | ;; insert-file-contents Finished | |
81 | ;; load | |
82 | ;; make-directory Finished (DAV) | |
83 | ;; make-symbolic-link Needs DAV bindings | |
84 | ;; rename-file Finished (DAV) | |
85 | ;; set-file-modes Use mod_dav specific executable flag? | |
86 | ;; set-visited-file-modtime Impossible? | |
87 | ;; shell-command Impossible? | |
88 | ;; unhandled-file-name-directory | |
89 | ;; vc-registered Finished (DAV) | |
90 | ;; verify-visited-file-modtime | |
91 | ;; write-region | |
92 | ||
f1a4e679 CY |
93 | ;;;###autoload |
94 | (defcustom url-handler-regexp "\\`\\(https?\\|ftp\\|file\\|nfs\\)://" | |
95 | "Regular expression for URLs handled by `url-handler-mode'. | |
96 | When URL Handler mode is enabled, this regular expression is | |
97 | added to `file-name-handler-alist'. | |
98 | ||
99 | Some valid URL protocols just do not make sense to visit | |
100 | interactively \(about, data, info, irc, mailto, etc\). This | |
101 | regular expression avoids conflicts with local files that look | |
102 | like URLs \(Gnus is particularly bad at this\)." | |
103 | :group 'url | |
104 | :type 'regexp | |
105 | :set (lambda (symbol value) | |
106 | (let ((enable url-handler-mode)) | |
107 | (url-handler-mode 0) | |
108 | (set-default symbol value) | |
109 | (if enable | |
110 | (url-handler-mode))))) | |
8c8b8430 SM |
111 | |
112 | ;;;###autoload | |
f1300fba | 113 | (define-minor-mode url-handler-mode |
ac6c8639 CY |
114 | "Toggle using `url' library for URL filenames (URL Handler mode). |
115 | With a prefix argument ARG, enable URL Handler mode if ARG is | |
116 | positive, and disable it otherwise. If called from Lisp, enable | |
117 | the mode if ARG is omitted or nil." | |
4ee48a9b | 118 | :global t :group 'url |
f1a4e679 CY |
119 | ;; Remove old entry, if any. |
120 | (setq file-name-handler-alist | |
121 | (delq (rassq 'url-file-handler file-name-handler-alist) | |
122 | file-name-handler-alist)) | |
123 | (if url-handler-mode | |
124 | (push (cons url-handler-regexp 'url-file-handler) | |
125 | file-name-handler-alist))) | |
8c8b8430 SM |
126 | |
127 | (defun url-run-real-handler (operation args) | |
128 | (let ((inhibit-file-name-handlers (cons 'url-file-handler | |
129 | (if (eq operation inhibit-file-name-operation) | |
130 | inhibit-file-name-handlers))) | |
131 | (inhibit-file-name-operation operation)) | |
132 | (apply operation args))) | |
133 | ||
80e4b01d | 134 | ;;;###autoload |
8c8b8430 SM |
135 | (defun url-file-handler (operation &rest args) |
136 | "Function called from the `file-name-handler-alist' routines. | |
137 | OPERATION is what needs to be done (`file-exists-p', etc). ARGS are | |
138 | the arguments that would have been passed to OPERATION." | |
139 | (let ((fn (or (get operation 'url-file-handlers) | |
140 | (intern-soft (format "url-%s" operation)))) | |
141 | (val nil) | |
142 | (hooked nil)) | |
143 | (if (and fn (fboundp fn)) | |
144 | (setq hooked t | |
d696b0d5 | 145 | val (save-match-data (apply fn args))) |
8c8b8430 SM |
146 | (setq hooked nil |
147 | val (url-run-real-handler operation args))) | |
148 | (url-debug 'handlers "%s %S%S => %S" (if hooked "Hooked" "Real") | |
149 | operation args val) | |
150 | val)) | |
151 | ||
152 | (defun url-file-handler-identity (&rest args) | |
153 | ;; Identity function | |
154 | (car args)) | |
155 | ||
156 | ;; These are operations that we can fully support | |
157 | (put 'file-readable-p 'url-file-handlers 'url-file-exists-p) | |
158 | (put 'substitute-in-file-name 'url-file-handlers 'url-file-handler-identity) | |
159 | (put 'file-name-absolute-p 'url-file-handlers (lambda (&rest ignored) t)) | |
160 | (put 'expand-file-name 'url-file-handlers 'url-handler-expand-file-name) | |
bdba217b | 161 | (put 'directory-file-name 'url-file-handlers 'url-handler-directory-file-name) |
ce4059ee | 162 | (put 'unhandled-file-name-directory 'url-file-handlers 'url-handler-unhandled-file-name-directory) |
a9f31e3d | 163 | (put 'file-remote-p 'url-file-handlers 'url-handler-file-remote-p) |
bdba217b | 164 | ;; (put 'file-name-as-directory 'url-file-handlers 'url-handler-file-name-as-directory) |
8c8b8430 SM |
165 | |
166 | ;; These are operations that we do not support yet (DAV!!!) | |
167 | (put 'file-writable-p 'url-file-handlers 'ignore) | |
168 | (put 'file-symlink-p 'url-file-handlers 'ignore) | |
f1b58706 SM |
169 | ;; Just like for ange-ftp: let's not waste time trying to look for RCS/foo,v |
170 | ;; files and such since we can't do anything clever with them anyway. | |
171 | (put 'vc-registered 'url-file-handlers 'ignore) | |
8c8b8430 SM |
172 | |
173 | (defun url-handler-expand-file-name (file &optional base) | |
bdba217b SM |
174 | ;; When we see "/foo/bar" in a file whose working dir is "http://bla/bla", |
175 | ;; there are two interpretations possible: either it's a local "/foo/bar" | |
176 | ;; or it's "http:/bla/foo/bar". When working with URLs, the second | |
177 | ;; interpretation is the right one, but when working with Emacs file | |
178 | ;; names, the first is preferred. | |
8c8b8430 SM |
179 | (if (file-name-absolute-p file) |
180 | (expand-file-name file "/") | |
181 | (url-expand-file-name file base))) | |
182 | ||
bdba217b SM |
183 | ;; directory-file-name and file-name-as-directory are kind of hard to |
184 | ;; implement really right for URLs since URLs can have repeated / chars. | |
185 | ;; We'd want the following behavior: | |
186 | ;; idempotence: (d-f-n (d-f-n X) == (d-f-n X) | |
187 | ;; idempotence: (f-n-a-d (f-n-a-d X) == (f-n-a-d X) | |
188 | ;; reversible: (d-f-n (f-n-a-d (d-f-n X))) == (d-f-n X) | |
189 | ;; reversible: (f-n-a-d (d-f-n (f-n-a-d X))) == (f-n-a-d X) | |
190 | (defun url-handler-directory-file-name (dir) | |
191 | ;; When there's more than a single /, just don't touch the slashes at all. | |
192 | (if (string-match "//\\'" dir) dir | |
193 | (url-run-real-handler 'directory-file-name (list dir)))) | |
194 | ||
ce4059ee | 195 | (defun url-handler-unhandled-file-name-directory (filename) |
791fe182 SM |
196 | (let ((url (url-generic-parse-url filename))) |
197 | (if (equal (url-type url) "file") | |
198 | ;; `file' URLs are actually local. The filename part may be "" | |
199 | ;; which really stands for "/". | |
200 | ;; FIXME: maybe we should check that the host part is "" or "localhost" | |
201 | ;; or some name that represents the local host? | |
202 | (or (file-name-directory (url-filename url)) "/") | |
203 | ;; All other URLs are not expected to be directly accessible from | |
204 | ;; a local process. | |
205 | nil))) | |
ce4059ee | 206 | |
a9f31e3d MA |
207 | (defun url-handler-file-remote-p (filename &optional identification connected) |
208 | (let ((url (url-generic-parse-url filename))) | |
209 | (if (and (url-type url) (not (equal (url-type url) "file"))) | |
210 | ;; Maybe we can find a suitable check for CONNECTED. For now, | |
211 | ;; we ignore it. | |
212 | (cond | |
213 | ((eq identification 'method) (url-type url)) | |
214 | ((eq identification 'user) (url-user url)) | |
215 | ((eq identification 'host) (url-host url)) | |
216 | ((eq identification 'localname) (url-filename url)) | |
217 | (t (url-recreate-url | |
218 | (url-parse-make-urlobj (url-type url) (url-user url) nil | |
219 | (url-host url) (url-port url))))) | |
220 | ;; If there is no URL type, or it is a "file://" URL, the | |
221 | ;; filename is expected to be non remote. A more subtle check | |
222 | ;; for "file://" URLs could be applied, as said in | |
223 | ;; `url-handler-unhandled-file-name-directory'. | |
224 | nil))) | |
225 | ||
8c8b8430 SM |
226 | ;; The actual implementation |
227 | ;;;###autoload | |
120812a0 CY |
228 | (defun url-copy-file (url newname &optional ok-if-already-exists |
229 | keep-time preserve-uid-gid) | |
8c8b8430 SM |
230 | "Copy URL to NEWNAME. Both args must be strings. |
231 | Signals a `file-already-exists' error if file NEWNAME already exists, | |
232 | unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil. | |
233 | A number as third arg means request confirmation if NEWNAME already exists. | |
234 | This is what happens in interactive use with M-x. | |
235 | Fourth arg KEEP-TIME non-nil means give the new file the same | |
236 | last-modified time as the old one. (This works on only some systems.) | |
120812a0 | 237 | Fifth arg PRESERVE-UID-GID is ignored. |
8c8b8430 SM |
238 | A prefix arg makes KEEP-TIME non-nil." |
239 | (if (and (file-exists-p newname) | |
240 | (not ok-if-already-exists)) | |
241 | (error "Opening output file: File already exists, %s" newname)) | |
242 | (let ((buffer (url-retrieve-synchronously url)) | |
243 | (handle nil)) | |
244 | (if (not buffer) | |
245 | (error "Opening input file: No such file or directory, %s" url)) | |
d4fdad60 | 246 | (with-current-buffer buffer |
8c8b8430 SM |
247 | (setq handle (mm-dissect-buffer t))) |
248 | (mm-save-part-to-file handle newname) | |
249 | (kill-buffer buffer) | |
250 | (mm-destroy-parts handle))) | |
251 | ||
252 | ;;;###autoload | |
253 | (defun url-file-local-copy (url &rest ignored) | |
254 | "Copy URL into a temporary file on this machine. | |
255 | Returns the name of the local copy, or nil, if FILE is directly | |
256 | accessible." | |
bdba217b | 257 | (let ((filename (make-temp-file "url"))) |
d0f891a7 | 258 | (url-copy-file url filename 'ok-if-already-exists) |
8c8b8430 SM |
259 | filename)) |
260 | ||
89a1fe77 SM |
261 | (defun url-insert (buffer &optional beg end) |
262 | "Insert the body of a URL object. | |
263 | BUFFER should be a complete URL buffer as returned by `url-retrieve'. | |
264 | If the headers specify a coding-system, it is applied to the body before it is inserted. | |
265 | Returns a list of the form (SIZE CHARSET), where SIZE is the size in bytes | |
266 | of the inserted text and CHARSET is the charset that was specified in the header, | |
267 | or nil if none was found. | |
268 | BEG and END can be used to only insert a subpart of the body. | |
269 | They count bytes from the beginning of the body." | |
270 | (let* ((handle (with-current-buffer buffer (mm-dissect-buffer t))) | |
271 | (data (with-current-buffer (mm-handle-buffer handle) | |
272 | (if beg | |
273 | (buffer-substring (+ (point-min) beg) | |
274 | (if end (+ (point-min) end) (point-max))) | |
275 | (buffer-string)))) | |
276 | (charset (mail-content-type-get (mm-handle-type handle) | |
277 | 'charset))) | |
278 | (mm-destroy-parts handle) | |
279 | (if charset | |
280 | (insert (mm-decode-string data (mm-charset-to-coding-system charset))) | |
281 | (insert data)) | |
282 | (list (length data) charset))) | |
283 | ||
8c8b8430 SM |
284 | ;;;###autoload |
285 | (defun url-insert-file-contents (url &optional visit beg end replace) | |
89a1fe77 | 286 | (let ((buffer (url-retrieve-synchronously url))) |
8c8b8430 SM |
287 | (if (not buffer) |
288 | (error "Opening input file: No such file or directory, %s" url)) | |
289 | (if visit (setq buffer-file-name url)) | |
8c8b8430 | 290 | (save-excursion |
89a1fe77 SM |
291 | (let* ((start (point)) |
292 | (size-and-charset (url-insert buffer beg end))) | |
293 | (kill-buffer buffer) | |
294 | (when replace | |
295 | (delete-region (point-min) start) | |
296 | (delete-region (point) (point-max))) | |
297 | (unless (cadr size-and-charset) | |
298 | ;; If the headers don't specify any particular charset, use the | |
299 | ;; usual heuristic/rules that we apply to files. | |
300 | (decode-coding-inserted-region start (point) url visit beg end replace)) | |
301 | (list url (car size-and-charset)))))) | |
8c8b8430 | 302 | |
a118b59b | 303 | (defun url-file-name-completion (url directory &optional predicate) |
8c8b8430 SM |
304 | (error "Unimplemented")) |
305 | ||
306 | (defun url-file-name-all-completions (file directory) | |
307 | (error "Unimplemented")) | |
308 | ||
309 | ;; All other handlers map onto their respective backends. | |
310 | (defmacro url-handlers-create-wrapper (method args) | |
311 | `(defun ,(intern (format "url-%s" method)) ,args | |
312 | ,(format "URL file-name-handler wrapper for `%s' call.\n---\n%s" method | |
313 | (or (documentation method t) "No original documentation.")) | |
314 | (setq url (url-generic-parse-url url)) | |
315 | (when (url-type url) | |
316 | (funcall (url-scheme-get-property (url-type url) (quote ,method)) | |
317 | ,@(remove '&rest (remove '&optional args)))))) | |
318 | ||
319 | (url-handlers-create-wrapper file-exists-p (url)) | |
c7389b5d | 320 | (url-handlers-create-wrapper file-attributes (url &optional id-format)) |
8c8b8430 SM |
321 | (url-handlers-create-wrapper file-symlink-p (url)) |
322 | (url-handlers-create-wrapper file-writable-p (url)) | |
323 | (url-handlers-create-wrapper file-directory-p (url)) | |
324 | (url-handlers-create-wrapper file-executable-p (url)) | |
cc38a294 EZ |
325 | (url-handlers-create-wrapper directory-files (url &optional full match nosort)) |
326 | (url-handlers-create-wrapper file-truename (url &optional counter prev-dirs)) | |
8c8b8430 | 327 | |
c7389b5d | 328 | (add-hook 'find-file-hook 'url-handlers-set-buffer-mode) |
8c8b8430 SM |
329 | |
330 | (defun url-handlers-set-buffer-mode () | |
331 | "Set correct modes for the current buffer if visiting a remote file." | |
332 | (and (stringp buffer-file-name) | |
333 | (string-match url-handler-regexp buffer-file-name) | |
334 | (auto-save-mode 0))) | |
335 | ||
336 | (provide 'url-handlers) | |
e5566bd5 | 337 | |
f1300fba | 338 | ;;; url-handlers.el ends here |