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