]> code.delx.au - gnu-emacs/blob - lisp/url/url-http.el
a6652987966728239e94e3a9aa7ee7e13e948dee
[gnu-emacs] / lisp / url / url-http.el
1 ;;; url-http.el --- HTTP retrieval routines
2
3 ;; Copyright (C) 1999, 2001, 2004, 2005, 2006, 2007, 2008,
4 ;; 2009, 2010, 2011 Free Software Foundation, Inc.
5
6 ;; Author: Bill Perry <wmperry@gnu.org>
7 ;; Keywords: comm, data, processes
8
9 ;; This file is part of GNU Emacs.
10 ;;
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.
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. If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (eval-when-compile (require 'cl))
29 (defvar url-http-extra-headers)
30 (defvar url-http-target-url)
31 (defvar url-http-proxy)
32 (defvar url-http-connection-opened)
33 (require 'url-gw)
34 (require 'url-util)
35 (require 'url-parse)
36 (require 'url-cookie)
37 (require 'mail-parse)
38 (require 'url-auth)
39 (require 'url)
40 (autoload 'url-cache-create-filename "url-cache")
41
42 (defconst url-http-default-port 80 "Default HTTP port.")
43 (defconst url-http-asynchronous-p t "HTTP retrievals are asynchronous.")
44 (defalias 'url-http-expand-file-name 'url-default-expander)
45
46 (defvar url-http-real-basic-auth-storage nil)
47 (defvar url-http-proxy-basic-auth-storage nil)
48
49 (defvar url-http-open-connections (make-hash-table :test 'equal
50 :size 17)
51 "A hash table of all open network connections.")
52
53 (defvar url-http-version "1.1"
54 "What version of HTTP we advertise, as a string.
55 Valid values are 1.1 and 1.0.
56 This is only useful when debugging the HTTP subsystem.
57
58 Setting this to 1.0 will tell servers not to send chunked encoding,
59 and other HTTP/1.1 specific features.")
60
61 (defvar url-http-attempt-keepalives t
62 "Whether to use a single TCP connection multiple times in HTTP.
63 This is only useful when debugging the HTTP subsystem. Setting to
64 nil will explicitly close the connection to the server after every
65 request.")
66
67 ;(eval-when-compile
68 ;; These are all macros so that they are hidden from external sight
69 ;; when the file is byte-compiled.
70 ;;
71 ;; This allows us to expose just the entry points we want.
72
73 ;; These routines will allow us to implement persistent HTTP
74 ;; connections.
75 (defsubst url-http-debug (&rest args)
76 (if quit-flag
77 (let ((proc (get-buffer-process (current-buffer))))
78 ;; The user hit C-g, honor it! Some things can get in an
79 ;; incredibly tight loop (chunked encoding)
80 (if proc
81 (progn
82 (set-process-sentinel proc nil)
83 (set-process-filter proc nil)))
84 (error "Transfer interrupted!")))
85 (apply 'url-debug 'http args))
86
87 (defun url-http-mark-connection-as-busy (host port proc)
88 (url-http-debug "Marking connection as busy: %s:%d %S" host port proc)
89 (set-process-query-on-exit-flag proc t)
90 (puthash (cons host port)
91 (delq proc (gethash (cons host port) url-http-open-connections))
92 url-http-open-connections)
93 proc)
94
95 (defun url-http-mark-connection-as-free (host port proc)
96 (url-http-debug "Marking connection as free: %s:%d %S" host port proc)
97 (when (memq (process-status proc) '(open run connect))
98 (set-process-buffer proc nil)
99 (set-process-sentinel proc 'url-http-idle-sentinel)
100 (set-process-query-on-exit-flag proc nil)
101 (puthash (cons host port)
102 (cons proc (gethash (cons host port) url-http-open-connections))
103 url-http-open-connections))
104 nil)
105
106 (defun url-http-find-free-connection (host port)
107 (let ((conns (gethash (cons host port) url-http-open-connections))
108 (found nil))
109 (while (and conns (not found))
110 (if (not (memq (process-status (car conns)) '(run open connect)))
111 (progn
112 (url-http-debug "Cleaning up dead process: %s:%d %S"
113 host port (car conns))
114 (url-http-idle-sentinel (car conns) nil))
115 (setq found (car conns))
116 (url-http-debug "Found existing connection: %s:%d %S" host port found))
117 (pop conns))
118 (if found
119 (url-http-debug "Reusing existing connection: %s:%d" host port)
120 (url-http-debug "Contacting host: %s:%d" host port))
121 (url-lazy-message "Contacting host: %s:%d" host port)
122 (url-http-mark-connection-as-busy
123 host port
124 (or found
125 (let ((buf (generate-new-buffer " *url-http-temp*")))
126 ;; `url-open-stream' needs a buffer in which to do things
127 ;; like authentication. But we use another buffer afterwards.
128 (unwind-protect
129 (let ((proc (url-open-stream host buf host port)))
130 ;; url-open-stream might return nil.
131 (when (processp proc)
132 ;; Drop the temp buffer link before killing the buffer.
133 (set-process-buffer proc nil))
134 proc)
135 (kill-buffer buf)))))))
136
137 ;; Building an HTTP request
138 (defun url-http-user-agent-string ()
139 (if (or (eq url-privacy-level 'paranoid)
140 (and (listp url-privacy-level)
141 (memq 'agent url-privacy-level)))
142 ""
143 (format "User-Agent: %sURL/%s%s\r\n"
144 (if url-package-name
145 (concat url-package-name "/" url-package-version " ")
146 "")
147 url-version
148 (cond
149 ((and url-os-type url-system-type)
150 (concat " (" url-os-type "; " url-system-type ")"))
151 ((or url-os-type url-system-type)
152 (concat " (" (or url-system-type url-os-type) ")"))
153 (t "")))))
154
155 (defun url-http-create-request (&optional ref-url)
156 "Create an HTTP request for `url-http-target-url', referred to by REF-URL."
157 (declare (special proxy-info
158 url-http-method url-http-data
159 url-http-extra-headers))
160 (let* ((extra-headers)
161 (request nil)
162 (no-cache (cdr-safe (assoc "Pragma" url-http-extra-headers)))
163 (using-proxy url-http-proxy)
164 (proxy-auth (if (or (cdr-safe (assoc "Proxy-Authorization"
165 url-http-extra-headers))
166 (not using-proxy))
167 nil
168 (let ((url-basic-auth-storage
169 'url-http-proxy-basic-auth-storage))
170 (url-get-authentication url-http-target-url nil 'any nil))))
171 (real-fname (concat (url-filename url-http-target-url)
172 (url-recreate-url-attributes url-http-target-url)))
173 (host (url-host url-http-target-url))
174 (auth (if (cdr-safe (assoc "Authorization" url-http-extra-headers))
175 nil
176 (url-get-authentication (or
177 (and (boundp 'proxy-info)
178 proxy-info)
179 url-http-target-url) nil 'any nil))))
180 (if (equal "" real-fname)
181 (setq real-fname "/"))
182 (setq no-cache (and no-cache (string-match "no-cache" no-cache)))
183 (if auth
184 (setq auth (concat "Authorization: " auth "\r\n")))
185 (if proxy-auth
186 (setq proxy-auth (concat "Proxy-Authorization: " proxy-auth "\r\n")))
187
188 ;; Protection against stupid values in the referer
189 (if (and ref-url (stringp ref-url) (or (string= ref-url "file:nil")
190 (string= ref-url "")))
191 (setq ref-url nil))
192
193 ;; We do not want to expose the referer if the user is paranoid.
194 (if (or (memq url-privacy-level '(low high paranoid))
195 (and (listp url-privacy-level)
196 (memq 'lastloc url-privacy-level)))
197 (setq ref-url nil))
198
199 ;; url-http-extra-headers contains an assoc-list of
200 ;; header/value pairs that we need to put into the request.
201 (setq extra-headers (mapconcat
202 (lambda (x)
203 (concat (car x) ": " (cdr x)))
204 url-http-extra-headers "\r\n"))
205 (if (not (equal extra-headers ""))
206 (setq extra-headers (concat extra-headers "\r\n")))
207
208 ;; This was done with a call to `format'. Concatting parts has
209 ;; the advantage of keeping the parts of each header together and
210 ;; allows us to elide null lines directly, at the cost of making
211 ;; the layout less clear.
212 (setq request
213 ;; We used to concat directly, but if one of the strings happens
214 ;; to being multibyte (even if it only contains pure ASCII) then
215 ;; every string gets converted with `string-MAKE-multibyte' which
216 ;; turns the 127-255 codes into things like latin-1 accented chars
217 ;; (it would work right if it used `string-TO-multibyte' instead).
218 ;; So to avoid the problem we force every string to be unibyte.
219 (mapconcat
220 ;; FIXME: Instead of `string-AS-unibyte' we'd want
221 ;; `string-to-unibyte', so as to properly signal an error if one
222 ;; of the strings contains a multibyte char.
223 'string-as-unibyte
224 (delq nil
225 (list
226 ;; The request
227 (or url-http-method "GET") " "
228 (if using-proxy (url-recreate-url url-http-target-url) real-fname)
229 " HTTP/" url-http-version "\r\n"
230 ;; Version of MIME we speak
231 "MIME-Version: 1.0\r\n"
232 ;; (maybe) Try to keep the connection open
233 "Connection: " (if (or using-proxy
234 (not url-http-attempt-keepalives))
235 "close" "keep-alive") "\r\n"
236 ;; HTTP extensions we support
237 (if url-extensions-header
238 (format
239 "Extension: %s\r\n" url-extensions-header))
240 ;; Who we want to talk to
241 (if (/= (url-port url-http-target-url)
242 (url-scheme-get-property
243 (url-type url-http-target-url) 'default-port))
244 (format
245 "Host: %s:%d\r\n" host (url-port url-http-target-url))
246 (format "Host: %s\r\n" host))
247 ;; Who its from
248 (if url-personal-mail-address
249 (concat
250 "From: " url-personal-mail-address "\r\n"))
251 ;; Encodings we understand
252 (if url-mime-encoding-string
253 (concat
254 "Accept-encoding: " url-mime-encoding-string "\r\n"))
255 (if url-mime-charset-string
256 (concat
257 "Accept-charset: " url-mime-charset-string "\r\n"))
258 ;; Languages we understand
259 (if url-mime-language-string
260 (concat
261 "Accept-language: " url-mime-language-string "\r\n"))
262 ;; Types we understand
263 "Accept: " (or url-mime-accept-string "*/*") "\r\n"
264 ;; User agent
265 (url-http-user-agent-string)
266 ;; Proxy Authorization
267 proxy-auth
268 ;; Authorization
269 auth
270 ;; Cookies
271 (url-cookie-generate-header-lines host real-fname
272 (equal "https" (url-type url-http-target-url)))
273 ;; If-modified-since
274 (if (and (not no-cache)
275 (member url-http-method '("GET" nil)))
276 (let ((tm (url-is-cached url-http-target-url)))
277 (if tm
278 (concat "If-modified-since: "
279 (url-get-normalized-date tm) "\r\n"))))
280 ;; Whence we came
281 (if ref-url (concat
282 "Referer: " ref-url "\r\n"))
283 extra-headers
284 ;; Length of data
285 (if url-http-data
286 (concat
287 "Content-length: " (number-to-string
288 (length url-http-data))
289 "\r\n"))
290 ;; End request
291 "\r\n"
292 ;; Any data
293 url-http-data))
294 ""))
295 (url-http-debug "Request is: \n%s" request)
296 request))
297
298 ;; Parsing routines
299 (defun url-http-clean-headers ()
300 "Remove trailing \r from header lines.
301 This allows us to use `mail-fetch-field', etc."
302 (declare (special url-http-end-of-headers))
303 (goto-char (point-min))
304 (while (re-search-forward "\r$" url-http-end-of-headers t)
305 (replace-match "")))
306
307 (defun url-http-handle-authentication (proxy)
308 (declare (special status success url-http-method url-http-data
309 url-callback-function url-callback-arguments))
310 (url-http-debug "Handling %s authentication" (if proxy "proxy" "normal"))
311 (let ((auths (or (nreverse
312 (mail-fetch-field
313 (if proxy "proxy-authenticate" "www-authenticate")
314 nil nil t))
315 '("basic")))
316 (type nil)
317 (url (url-recreate-url url-current-object))
318 (auth-url (url-recreate-url
319 (if (and proxy (boundp 'url-http-proxy))
320 url-http-proxy
321 url-current-object)))
322 (url-basic-auth-storage (if proxy
323 ;; Cheating, but who cares? :)
324 'url-http-proxy-basic-auth-storage
325 'url-http-real-basic-auth-storage))
326 auth
327 (strength 0))
328
329 ;; find strongest supported auth
330 (dolist (this-auth auths)
331 (setq this-auth (url-eat-trailing-space
332 (url-strip-leading-spaces
333 this-auth)))
334 (let* ((this-type
335 (if (string-match "[ \t]" this-auth)
336 (downcase (substring this-auth 0 (match-beginning 0)))
337 (downcase this-auth)))
338 (registered (url-auth-registered this-type))
339 (this-strength (cddr registered)))
340 (when (and registered (> this-strength strength))
341 (setq auth this-auth
342 type this-type
343 strength this-strength))))
344
345 (if (not (url-auth-registered type))
346 (progn
347 (widen)
348 (goto-char (point-max))
349 (insert "<hr>Sorry, but I do not know how to handle " type
350 " authentication. If you'd like to write it,"
351 " send it to " url-bug-address ".<hr>")
352 (setq status t))
353 (let* ((args (url-parse-args (subst-char-in-string ?, ?\; auth)))
354 (auth (url-get-authentication auth-url
355 (cdr-safe (assoc "realm" args))
356 type t args)))
357 (if (not auth)
358 (setq success t)
359 (push (cons (if proxy "Proxy-Authorization" "Authorization") auth)
360 url-http-extra-headers)
361 (let ((url-request-method url-http-method)
362 (url-request-data url-http-data)
363 (url-request-extra-headers url-http-extra-headers))
364 (url-retrieve-internal url url-callback-function
365 url-callback-arguments)))))))
366
367 (defun url-http-parse-response ()
368 "Parse just the response code."
369 (declare (special url-http-end-of-headers url-http-response-status
370 url-http-response-version))
371 (if (not url-http-end-of-headers)
372 (error "Trying to parse HTTP response code in odd buffer: %s" (buffer-name)))
373 (url-http-debug "url-http-parse-response called in (%s)" (buffer-name))
374 (goto-char (point-min))
375 (skip-chars-forward " \t\n") ; Skip any blank crap
376 (skip-chars-forward "HTTP/") ; Skip HTTP Version
377 (setq url-http-response-version
378 (buffer-substring (point)
379 (progn
380 (skip-chars-forward "[0-9].")
381 (point))))
382 (setq url-http-response-status (read (current-buffer))))
383
384 (defun url-http-handle-cookies ()
385 "Handle all set-cookie / set-cookie2 headers in an HTTP response.
386 The buffer must already be narrowed to the headers, so `mail-fetch-field' will
387 work correctly."
388 (let ((cookies (nreverse (mail-fetch-field "Set-Cookie" nil nil t)))
389 (cookies2 (nreverse (mail-fetch-field "Set-Cookie2" nil nil t))))
390 (and cookies (url-http-debug "Found %d Set-Cookie headers" (length cookies)))
391 (and cookies2 (url-http-debug "Found %d Set-Cookie2 headers" (length cookies2)))
392 (while cookies
393 (url-cookie-handle-set-cookie (pop cookies)))
394 ;;; (while cookies2
395 ;;; (url-cookie-handle-set-cookie2 (pop cookies)))
396 )
397 )
398
399 (defun url-http-parse-headers ()
400 "Parse and handle HTTP specific headers.
401 Return t if and only if the current buffer is still active and
402 should be shown to the user."
403 ;; The comments after each status code handled are taken from RFC
404 ;; 2616 (HTTP/1.1)
405 (declare (special url-http-end-of-headers url-http-response-status
406 url-http-response-version
407 url-http-method url-http-data url-http-process
408 url-callback-function url-callback-arguments))
409
410 (url-http-mark-connection-as-free (url-host url-current-object)
411 (url-port url-current-object)
412 url-http-process)
413
414 (if (or (not (boundp 'url-http-end-of-headers))
415 (not url-http-end-of-headers))
416 (error "Trying to parse headers in odd buffer: %s" (buffer-name)))
417 (goto-char (point-min))
418 (url-http-debug "url-http-parse-headers called in (%s)" (buffer-name))
419 (url-http-parse-response)
420 (mail-narrow-to-head)
421 ;;(narrow-to-region (point-min) url-http-end-of-headers)
422 (let ((connection (mail-fetch-field "Connection")))
423 ;; In HTTP 1.0, keep the connection only if there is a
424 ;; "Connection: keep-alive" header.
425 ;; In HTTP 1.1 (and greater), keep the connection unless there is a
426 ;; "Connection: close" header
427 (cond
428 ((string= url-http-response-version "1.0")
429 (unless (and connection
430 (string= (downcase connection) "keep-alive"))
431 (delete-process url-http-process)))
432 (t
433 (when (and connection
434 (string= (downcase connection) "close"))
435 (delete-process url-http-process)))))
436 (let ((buffer (current-buffer))
437 (class nil)
438 (success nil)
439 ;; The filename part of a URL could be in remote file syntax,
440 ;; see Bug#6717 for an example. We disable file name
441 ;; handlers, therefore.
442 (file-name-handler-alist nil))
443 (setq class (/ url-http-response-status 100))
444 (url-http-debug "Parsed HTTP headers: class=%d status=%d" class url-http-response-status)
445 (url-http-handle-cookies)
446
447 (case class
448 ;; Classes of response codes
449 ;;
450 ;; 5xx = Server Error
451 ;; 4xx = Client Error
452 ;; 3xx = Redirection
453 ;; 2xx = Successful
454 ;; 1xx = Informational
455 (1 ; Information messages
456 ;; 100 = Continue with request
457 ;; 101 = Switching protocols
458 ;; 102 = Processing (Added by DAV)
459 (url-mark-buffer-as-dead buffer)
460 (error "HTTP responses in class 1xx not supported (%d)" url-http-response-status))
461 (2 ; Success
462 ;; 200 Ok
463 ;; 201 Created
464 ;; 202 Accepted
465 ;; 203 Non-authoritative information
466 ;; 204 No content
467 ;; 205 Reset content
468 ;; 206 Partial content
469 ;; 207 Multi-status (Added by DAV)
470 (case url-http-response-status
471 ((204 205)
472 ;; No new data, just stay at the same document
473 (url-mark-buffer-as-dead buffer)
474 (setq success t))
475 (otherwise
476 ;; Generic success for all others. Store in the cache, and
477 ;; mark it as successful.
478 (widen)
479 (if (and url-automatic-caching (equal url-http-method "GET"))
480 (url-store-in-cache buffer))
481 (setq success t))))
482 (3 ; Redirection
483 ;; 300 Multiple choices
484 ;; 301 Moved permanently
485 ;; 302 Found
486 ;; 303 See other
487 ;; 304 Not modified
488 ;; 305 Use proxy
489 ;; 307 Temporary redirect
490 (let ((redirect-uri (or (mail-fetch-field "Location")
491 (mail-fetch-field "URI"))))
492 (case url-http-response-status
493 (300
494 ;; Quoth the spec (section 10.3.1)
495 ;; -------------------------------
496 ;; The requested resource corresponds to any one of a set of
497 ;; representations, each with its own specific location and
498 ;; agent-driven negotiation information is being provided so
499 ;; that the user can select a preferred representation and
500 ;; redirect its request to that location.
501 ;; [...]
502 ;; If the server has a preferred choice of representation, it
503 ;; SHOULD include the specific URI for that representation in
504 ;; the Location field; user agents MAY use the Location field
505 ;; value for automatic redirection.
506 ;; -------------------------------
507 ;; We do not support agent-driven negotiation, so we just
508 ;; redirect to the preferred URI if one is provided.
509 nil)
510 ((301 302 307)
511 ;; If the 301|302 status code is received in response to a
512 ;; request other than GET or HEAD, the user agent MUST NOT
513 ;; automatically redirect the request unless it can be
514 ;; confirmed by the user, since this might change the
515 ;; conditions under which the request was issued.
516 (if (member url-http-method '("HEAD" "GET"))
517 ;; Automatic redirection is ok
518 nil
519 ;; It is just too big of a pain in the ass to get this
520 ;; prompt all the time. We will just silently lose our
521 ;; data and convert to a GET method.
522 (url-http-debug "Converting `%s' request to `GET' because of REDIRECT(%d)"
523 url-http-method url-http-response-status)
524 (setq url-http-method "GET"
525 url-http-data nil)))
526 (303
527 ;; The response to the request can be found under a different
528 ;; URI and SHOULD be retrieved using a GET method on that
529 ;; resource.
530 (setq url-http-method "GET"
531 url-http-data nil))
532 (304
533 ;; The 304 response MUST NOT contain a message-body.
534 (url-http-debug "Extracting document from cache... (%s)"
535 (url-cache-create-filename (url-view-url t)))
536 (url-cache-extract (url-cache-create-filename (url-view-url t)))
537 (setq redirect-uri nil
538 success t))
539 (305
540 ;; The requested resource MUST be accessed through the
541 ;; proxy given by the Location field. The Location field
542 ;; gives the URI of the proxy. The recipient is expected
543 ;; to repeat this single request via the proxy. 305
544 ;; responses MUST only be generated by origin servers.
545 (error "Redirection thru a proxy server not supported: %s"
546 redirect-uri))
547 (otherwise
548 ;; Treat everything like '300'
549 nil))
550 (when redirect-uri
551 ;; Clean off any whitespace and/or <...> cruft.
552 (if (string-match "\\([^ \t]+\\)[ \t]" redirect-uri)
553 (setq redirect-uri (match-string 1 redirect-uri)))
554 (if (string-match "^<\\(.*\\)>$" redirect-uri)
555 (setq redirect-uri (match-string 1 redirect-uri)))
556
557 ;; Some stupid sites (like sourceforge) send a
558 ;; non-fully-qualified URL (ie: /), which royally confuses
559 ;; the URL library.
560 (if (not (string-match url-nonrelative-link redirect-uri))
561 ;; Be careful to use the real target URL, otherwise we may
562 ;; compute the redirection relative to the URL of the proxy.
563 (setq redirect-uri
564 (url-expand-file-name redirect-uri url-http-target-url)))
565 (let ((url-request-method url-http-method)
566 (url-request-data url-http-data)
567 (url-request-extra-headers url-http-extra-headers))
568 ;; Check existing number of redirects
569 (if (or (< url-max-redirections 0)
570 (and (> url-max-redirections 0)
571 (let ((events (car url-callback-arguments))
572 (old-redirects 0))
573 (while events
574 (if (eq (car events) :redirect)
575 (setq old-redirects (1+ old-redirects)))
576 (and (setq events (cdr events))
577 (setq events (cdr events))))
578 (< old-redirects url-max-redirections))))
579 ;; url-max-redirections hasn't been reached, so go
580 ;; ahead and redirect.
581 (progn
582 ;; Remember that the request was redirected.
583 (setf (car url-callback-arguments)
584 (nconc (list :redirect redirect-uri)
585 (car url-callback-arguments)))
586 ;; Put in the current buffer a forwarding pointer to the new
587 ;; destination buffer.
588 ;; FIXME: This is a hack to fix url-retrieve-synchronously
589 ;; without changing the API. Instead url-retrieve should
590 ;; either simply not return the "destination" buffer, or it
591 ;; should take an optional `dest-buf' argument.
592 (set (make-local-variable 'url-redirect-buffer)
593 (url-retrieve-internal
594 redirect-uri url-callback-function
595 url-callback-arguments))
596 (url-mark-buffer-as-dead buffer))
597 ;; We hit url-max-redirections, so issue an error and
598 ;; stop redirecting.
599 (url-http-debug "Maximum redirections reached")
600 (setf (car url-callback-arguments)
601 (nconc (list :error (list 'error 'http-redirect-limit
602 redirect-uri))
603 (car url-callback-arguments)))
604 (setq success t))))))
605 (4 ; Client error
606 ;; 400 Bad Request
607 ;; 401 Unauthorized
608 ;; 402 Payment required
609 ;; 403 Forbidden
610 ;; 404 Not found
611 ;; 405 Method not allowed
612 ;; 406 Not acceptable
613 ;; 407 Proxy authentication required
614 ;; 408 Request time-out
615 ;; 409 Conflict
616 ;; 410 Gone
617 ;; 411 Length required
618 ;; 412 Precondition failed
619 ;; 413 Request entity too large
620 ;; 414 Request-URI too large
621 ;; 415 Unsupported media type
622 ;; 416 Requested range not satisfiable
623 ;; 417 Expectation failed
624 ;; 422 Unprocessable Entity (Added by DAV)
625 ;; 423 Locked
626 ;; 424 Failed Dependency
627 (case url-http-response-status
628 (401
629 ;; The request requires user authentication. The response
630 ;; MUST include a WWW-Authenticate header field containing a
631 ;; challenge applicable to the requested resource. The
632 ;; client MAY repeat the request with a suitable
633 ;; Authorization header field.
634 (url-http-handle-authentication nil))
635 (402
636 ;; This code is reserved for future use
637 (url-mark-buffer-as-dead buffer)
638 (error "Somebody wants you to give them money"))
639 (403
640 ;; The server understood the request, but is refusing to
641 ;; fulfill it. Authorization will not help and the request
642 ;; SHOULD NOT be repeated.
643 (setq success t))
644 (404
645 ;; Not found
646 (setq success t))
647 (405
648 ;; The method specified in the Request-Line is not allowed
649 ;; for the resource identified by the Request-URI. The
650 ;; response MUST include an Allow header containing a list of
651 ;; valid methods for the requested resource.
652 (setq success t))
653 (406
654 ;; The resource identified by the request is only capable of
655 ;; generating response entities which have content
656 ;; characteristics nota cceptable according to the accept
657 ;; headers sent in the request.
658 (setq success t))
659 (407
660 ;; This code is similar to 401 (Unauthorized), but indicates
661 ;; that the client must first authenticate itself with the
662 ;; proxy. The proxy MUST return a Proxy-Authenticate header
663 ;; field containing a challenge applicable to the proxy for
664 ;; the requested resource.
665 (url-http-handle-authentication t))
666 (408
667 ;; The client did not produce a request within the time that
668 ;; the server was prepared to wait. The client MAY repeat
669 ;; the request without modifications at any later time.
670 (setq success t))
671 (409
672 ;; The request could not be completed due to a conflict with
673 ;; the current state of the resource. This code is only
674 ;; allowed in situations where it is expected that the user
675 ;; mioght be able to resolve the conflict and resubmit the
676 ;; request. The response body SHOULD include enough
677 ;; information for the user to recognize the source of the
678 ;; conflict.
679 (setq success t))
680 (410
681 ;; The requested resource is no longer available at the
682 ;; server and no forwarding address is known.
683 (setq success t))
684 (411
685 ;; The server refuses to accept the request without a defined
686 ;; Content-Length. The client MAY repeat the request if it
687 ;; adds a valid Content-Length header field containing the
688 ;; length of the message-body in the request message.
689 ;;
690 ;; NOTE - this will never happen because
691 ;; `url-http-create-request' automatically calculates the
692 ;; content-length.
693 (setq success t))
694 (412
695 ;; The precondition given in one or more of the
696 ;; request-header fields evaluated to false when it was
697 ;; tested on the server.
698 (setq success t))
699 ((413 414)
700 ;; The server is refusing to process a request because the
701 ;; request entity|URI is larger than the server is willing or
702 ;; able to process.
703 (setq success t))
704 (415
705 ;; The server is refusing to service the request because the
706 ;; entity of the request is in a format not supported by the
707 ;; requested resource for the requested method.
708 (setq success t))
709 (416
710 ;; A server SHOULD return a response with this status code if
711 ;; a request included a Range request-header field, and none
712 ;; of the range-specifier values in this field overlap the
713 ;; current extent of the selected resource, and the request
714 ;; did not include an If-Range request-header field.
715 (setq success t))
716 (417
717 ;; The expectation given in an Expect request-header field
718 ;; could not be met by this server, or, if the server is a
719 ;; proxy, the server has unambiguous evidence that the
720 ;; request could not be met by the next-hop server.
721 (setq success t))
722 (otherwise
723 ;; The request could not be understood by the server due to
724 ;; malformed syntax. The client SHOULD NOT repeat the
725 ;; request without modifications.
726 (setq success t)))
727 ;; Tell the callback that an error occurred, and what the
728 ;; status code was.
729 (when success
730 (setf (car url-callback-arguments)
731 (nconc (list :error (list 'error 'http url-http-response-status))
732 (car url-callback-arguments)))))
733 (5
734 ;; 500 Internal server error
735 ;; 501 Not implemented
736 ;; 502 Bad gateway
737 ;; 503 Service unavailable
738 ;; 504 Gateway time-out
739 ;; 505 HTTP version not supported
740 ;; 507 Insufficient storage
741 (setq success t)
742 (case url-http-response-status
743 (501
744 ;; The server does not support the functionality required to
745 ;; fulfill the request.
746 nil)
747 (502
748 ;; The server, while acting as a gateway or proxy, received
749 ;; an invalid response from the upstream server it accessed
750 ;; in attempting to fulfill the request.
751 nil)
752 (503
753 ;; The server is currently unable to handle the request due
754 ;; to a temporary overloading or maintenance of the server.
755 ;; The implication is that this is a temporary condition
756 ;; which will be alleviated after some delay. If known, the
757 ;; length of the delay MAY be indicated in a Retry-After
758 ;; header. If no Retry-After is given, the client SHOULD
759 ;; handle the response as it would for a 500 response.
760 nil)
761 (504
762 ;; The server, while acting as a gateway or proxy, did not
763 ;; receive a timely response from the upstream server
764 ;; specified by the URI (e.g. HTTP, FTP, LDAP) or some other
765 ;; auxiliary server (e.g. DNS) it needed to access in
766 ;; attempting to complete the request.
767 nil)
768 (505
769 ;; The server does not support, or refuses to support, the
770 ;; HTTP protocol version that was used in the request
771 ;; message.
772 nil)
773 (507 ; DAV
774 ;; The method could not be performed on the resource
775 ;; because the server is unable to store the representation
776 ;; needed to successfully complete the request. This
777 ;; condition is considered to be temporary. If the request
778 ;; which received this status code was the result of a user
779 ;; action, the request MUST NOT be repeated until it is
780 ;; requested by a separate user action.
781 nil))
782 ;; Tell the callback that an error occurred, and what the
783 ;; status code was.
784 (when success
785 (setf (car url-callback-arguments)
786 (nconc (list :error (list 'error 'http url-http-response-status))
787 (car url-callback-arguments)))))
788 (otherwise
789 (error "Unknown class of HTTP response code: %d (%d)"
790 class url-http-response-status)))
791 (if (not success)
792 (url-mark-buffer-as-dead buffer))
793 (url-http-debug "Finished parsing HTTP headers: %S" success)
794 (widen)
795 success))
796
797 ;; Miscellaneous
798 (defun url-http-activate-callback ()
799 "Activate callback specified when this buffer was created."
800 (declare (special url-http-process
801 url-callback-function
802 url-callback-arguments))
803 (url-http-mark-connection-as-free (url-host url-current-object)
804 (url-port url-current-object)
805 url-http-process)
806 (url-http-debug "Activating callback in buffer (%s)" (buffer-name))
807 (apply url-callback-function url-callback-arguments))
808
809 ;; )
810
811 ;; These unfortunately cannot be macros... please ignore them!
812 (defun url-http-idle-sentinel (proc why)
813 "Remove (now defunct) process PROC from the list of open connections."
814 (maphash (lambda (key val)
815 (if (memq proc val)
816 (puthash key (delq proc val) url-http-open-connections)))
817 url-http-open-connections))
818
819 (defun url-http-end-of-document-sentinel (proc why)
820 ;; Sentinel used for old HTTP/0.9 or connections we know are going
821 ;; to die as the 'end of document' notifier.
822 (url-http-debug "url-http-end-of-document-sentinel in buffer (%s)"
823 (process-buffer proc))
824 (url-http-idle-sentinel proc why)
825 (with-current-buffer (process-buffer proc)
826 (goto-char (point-min))
827 (if (not (looking-at "HTTP/"))
828 ;; HTTP/0.9 just gets passed back no matter what
829 (url-http-activate-callback)
830 (if (url-http-parse-headers)
831 (url-http-activate-callback)))))
832
833 (defun url-http-simple-after-change-function (st nd length)
834 ;; Function used when we do NOT know how long the document is going to be
835 ;; Just _very_ simple 'downloaded %d' type of info.
836 (declare (special url-http-end-of-headers))
837 (url-lazy-message "Reading %s..." (url-pretty-length nd)))
838
839 (defun url-http-content-length-after-change-function (st nd length)
840 "Function used when we DO know how long the document is going to be.
841 More sophisticated percentage downloaded, etc.
842 Also does minimal parsing of HTTP headers and will actually cause
843 the callback to be triggered."
844 (declare (special url-current-object
845 url-http-end-of-headers
846 url-http-content-length
847 url-http-content-type
848 url-http-process))
849 (if url-http-content-type
850 (url-display-percentage
851 "Reading [%s]... %s of %s (%d%%)"
852 (url-percentage (- nd url-http-end-of-headers)
853 url-http-content-length)
854 url-http-content-type
855 (url-pretty-length (- nd url-http-end-of-headers))
856 (url-pretty-length url-http-content-length)
857 (url-percentage (- nd url-http-end-of-headers)
858 url-http-content-length))
859 (url-display-percentage
860 "Reading... %s of %s (%d%%)"
861 (url-percentage (- nd url-http-end-of-headers)
862 url-http-content-length)
863 (url-pretty-length (- nd url-http-end-of-headers))
864 (url-pretty-length url-http-content-length)
865 (url-percentage (- nd url-http-end-of-headers)
866 url-http-content-length)))
867
868 (if (> (- nd url-http-end-of-headers) url-http-content-length)
869 (progn
870 ;; Found the end of the document! Wheee!
871 (url-display-percentage nil nil)
872 (url-lazy-message "Reading... done.")
873 (if (url-http-parse-headers)
874 (url-http-activate-callback)))))
875
876 (defun url-http-chunked-encoding-after-change-function (st nd length)
877 "Function used when dealing with 'chunked' encoding.
878 Cannot give a sophisticated percentage, but we need a different
879 function to look for the special 0-length chunk that signifies
880 the end of the document."
881 (declare (special url-current-object
882 url-http-end-of-headers
883 url-http-content-type
884 url-http-chunked-length
885 url-http-chunked-counter
886 url-http-process url-http-chunked-start))
887 (save-excursion
888 (goto-char st)
889 (let ((read-next-chunk t)
890 (case-fold-search t)
891 (regexp nil)
892 (no-initial-crlf nil))
893 ;; We need to loop thru looking for more chunks even within
894 ;; one after-change-function call.
895 (while read-next-chunk
896 (setq no-initial-crlf (= 0 url-http-chunked-counter))
897 (if url-http-content-type
898 (url-display-percentage nil
899 "Reading [%s]... chunk #%d"
900 url-http-content-type url-http-chunked-counter)
901 (url-display-percentage nil
902 "Reading... chunk #%d"
903 url-http-chunked-counter))
904 (url-http-debug "Reading chunk %d (%d %d %d)"
905 url-http-chunked-counter st nd length)
906 (setq regexp (if no-initial-crlf
907 "\\([0-9a-z]+\\).*\r?\n"
908 "\r?\n\\([0-9a-z]+\\).*\r?\n"))
909
910 (if url-http-chunked-start
911 ;; We know how long the chunk is supposed to be, skip over
912 ;; leading crap if possible.
913 (if (> nd (+ url-http-chunked-start url-http-chunked-length))
914 (progn
915 (url-http-debug "Got to the end of chunk #%d!"
916 url-http-chunked-counter)
917 (goto-char (+ url-http-chunked-start
918 url-http-chunked-length)))
919 (url-http-debug "Still need %d bytes to hit end of chunk"
920 (- (+ url-http-chunked-start
921 url-http-chunked-length)
922 nd))
923 (setq read-next-chunk nil)))
924 (if (not read-next-chunk)
925 (url-http-debug "Still spinning for next chunk...")
926 (if no-initial-crlf (skip-chars-forward "\r\n"))
927 (if (not (looking-at regexp))
928 (progn
929 ;; Must not have received the entirety of the chunk header,
930 ;; need to spin some more.
931 (url-http-debug "Did not see start of chunk @ %d!" (point))
932 (setq read-next-chunk nil))
933 (add-text-properties (match-beginning 0) (match-end 0)
934 (list 'start-open t
935 'end-open t
936 'chunked-encoding t
937 'face 'cursor
938 'invisible t))
939 (setq url-http-chunked-length (string-to-number (buffer-substring
940 (match-beginning 1)
941 (match-end 1))
942 16)
943 url-http-chunked-counter (1+ url-http-chunked-counter)
944 url-http-chunked-start (set-marker
945 (or url-http-chunked-start
946 (make-marker))
947 (match-end 0)))
948 ; (if (not url-http-debug)
949 (delete-region (match-beginning 0) (match-end 0));)
950 (url-http-debug "Saw start of chunk %d (length=%d, start=%d"
951 url-http-chunked-counter url-http-chunked-length
952 (marker-position url-http-chunked-start))
953 (if (= 0 url-http-chunked-length)
954 (progn
955 ;; Found the end of the document! Wheee!
956 (url-http-debug "Saw end of stream chunk!")
957 (setq read-next-chunk nil)
958 (url-display-percentage nil nil)
959 ;; Every chunk, even the last 0-length one, is
960 ;; terminated by CRLF. Skip it.
961 (when (looking-at "\r?\n")
962 (url-http-debug "Removing terminator of last chunk")
963 (delete-region (match-beginning 0) (match-end 0)))
964 (if (re-search-forward "^\r*$" nil t)
965 (url-http-debug "Saw end of trailers..."))
966 (if (url-http-parse-headers)
967 (url-http-activate-callback))))))))))
968
969 (defun url-http-wait-for-headers-change-function (st nd length)
970 ;; This will wait for the headers to arrive and then splice in the
971 ;; next appropriate after-change-function, etc.
972 (declare (special url-current-object
973 url-http-end-of-headers
974 url-http-content-type
975 url-http-content-length
976 url-http-transfer-encoding
977 url-callback-function
978 url-callback-arguments
979 url-http-process
980 url-http-method
981 url-http-after-change-function
982 url-http-response-status))
983 (url-http-debug "url-http-wait-for-headers-change-function (%s)"
984 (buffer-name))
985 (when (not (bobp))
986 (let ((end-of-headers nil)
987 (old-http nil)
988 (content-length nil))
989 (goto-char (point-min))
990 (if (and (looking-at ".*\n") ; have one line at least
991 (not (looking-at "^HTTP/[1-9]\\.[0-9]")))
992 ;; Not HTTP/x.y data, must be 0.9
993 ;; God, I wish this could die.
994 (setq end-of-headers t
995 url-http-end-of-headers 0
996 old-http t)
997 (when (re-search-forward "^\r*$" nil t)
998 ;; Saw the end of the headers
999 (url-http-debug "Saw end of headers... (%s)" (buffer-name))
1000 (setq url-http-end-of-headers (set-marker (make-marker)
1001 (point))
1002 end-of-headers t)
1003 (url-http-clean-headers)))
1004
1005 (if (not end-of-headers)
1006 ;; Haven't seen the end of the headers yet, need to wait
1007 ;; for more data to arrive.
1008 nil
1009 (if old-http
1010 (message "HTTP/0.9 How I hate thee!")
1011 (progn
1012 (url-http-parse-response)
1013 (mail-narrow-to-head)
1014 ;;(narrow-to-region (point-min) url-http-end-of-headers)
1015 (setq url-http-transfer-encoding (mail-fetch-field
1016 "transfer-encoding")
1017 url-http-content-type (mail-fetch-field "content-type"))
1018 (if (mail-fetch-field "content-length")
1019 (setq url-http-content-length
1020 (string-to-number (mail-fetch-field "content-length"))))
1021 (widen)))
1022 (when url-http-transfer-encoding
1023 (setq url-http-transfer-encoding
1024 (downcase url-http-transfer-encoding)))
1025
1026 (cond
1027 ((or (= url-http-response-status 204)
1028 (= url-http-response-status 205))
1029 (url-http-debug "%d response must have headers only (%s)."
1030 url-http-response-status (buffer-name))
1031 (when (url-http-parse-headers)
1032 (url-http-activate-callback)))
1033 ((string= "HEAD" url-http-method)
1034 ;; A HEAD request is _ALWAYS_ terminated by the header
1035 ;; information, regardless of any entity headers,
1036 ;; according to section 4.4 of the HTTP/1.1 draft.
1037 (url-http-debug "HEAD request must have headers only (%s)."
1038 (buffer-name))
1039 (when (url-http-parse-headers)
1040 (url-http-activate-callback)))
1041 ((string= "CONNECT" url-http-method)
1042 ;; A CONNECT request is finished, but we cannot stick this
1043 ;; back on the free connectin list
1044 (url-http-debug "CONNECT request must have headers only.")
1045 (when (url-http-parse-headers)
1046 (url-http-activate-callback)))
1047 ((equal url-http-response-status 304)
1048 ;; Only allowed to have a header section. We have to handle
1049 ;; this here instead of in url-http-parse-headers because if
1050 ;; you have a cached copy of something without a known
1051 ;; content-length, and try to retrieve it from the cache, we'd
1052 ;; fall into the 'being dumb' section and wait for the
1053 ;; connection to terminate, which means we'd wait for 10
1054 ;; seconds for the keep-alives to time out on some servers.
1055 (when (url-http-parse-headers)
1056 (url-http-activate-callback)))
1057 (old-http
1058 ;; HTTP/0.9 always signaled end-of-connection by closing the
1059 ;; connection.
1060 (url-http-debug
1061 "Saw HTTP/0.9 response, connection closed means end of document.")
1062 (setq url-http-after-change-function
1063 'url-http-simple-after-change-function))
1064 ((equal url-http-transfer-encoding "chunked")
1065 (url-http-debug "Saw chunked encoding.")
1066 (setq url-http-after-change-function
1067 'url-http-chunked-encoding-after-change-function)
1068 (when (> nd url-http-end-of-headers)
1069 (url-http-debug
1070 "Calling initial chunked-encoding for extra data at end of headers")
1071 (url-http-chunked-encoding-after-change-function
1072 (marker-position url-http-end-of-headers) nd
1073 (- nd url-http-end-of-headers))))
1074 ((integerp url-http-content-length)
1075 (url-http-debug
1076 "Got a content-length, being smart about document end.")
1077 (setq url-http-after-change-function
1078 'url-http-content-length-after-change-function)
1079 (cond
1080 ((= 0 url-http-content-length)
1081 ;; We got a NULL body! Activate the callback
1082 ;; immediately!
1083 (url-http-debug
1084 "Got 0-length content-length, activating callback immediately.")
1085 (when (url-http-parse-headers)
1086 (url-http-activate-callback)))
1087 ((> nd url-http-end-of-headers)
1088 ;; Have some leftover data
1089 (url-http-debug "Calling initial content-length for extra data at end of headers")
1090 (url-http-content-length-after-change-function
1091 (marker-position url-http-end-of-headers)
1092 nd
1093 (- nd url-http-end-of-headers)))
1094 (t
1095 nil)))
1096 (t
1097 (url-http-debug "No content-length, being dumb.")
1098 (setq url-http-after-change-function
1099 'url-http-simple-after-change-function)))))
1100 ;; We are still at the beginning of the buffer... must just be
1101 ;; waiting for a response.
1102 (url-http-debug "Spinning waiting for headers..."))
1103 (goto-char (point-max)))
1104
1105 ;;;###autoload
1106 (defun url-http (url callback cbargs)
1107 "Retrieve URL via HTTP asynchronously.
1108 URL must be a parsed URL. See `url-generic-parse-url' for details.
1109 When retrieval is completed, the function CALLBACK is executed with
1110 CBARGS as the arguments."
1111 (check-type url vector "Need a pre-parsed URL.")
1112 (declare (special url-current-object
1113 url-http-end-of-headers
1114 url-http-content-type
1115 url-http-content-length
1116 url-http-transfer-encoding
1117 url-http-after-change-function
1118 url-callback-function
1119 url-callback-arguments
1120 url-http-method
1121 url-http-extra-headers
1122 url-http-data
1123 url-http-chunked-length
1124 url-http-chunked-start
1125 url-http-chunked-counter
1126 url-http-process))
1127 (let* ((host (url-host (or url-using-proxy url)))
1128 (port (url-port (or url-using-proxy url)))
1129 (connection (url-http-find-free-connection host port))
1130 (buffer (generate-new-buffer (format " *http %s:%d*" host port))))
1131 (if (not connection)
1132 ;; Failed to open the connection for some reason
1133 (progn
1134 (kill-buffer buffer)
1135 (setq buffer nil)
1136 (error "Could not create connection to %s:%d" host port))
1137 (with-current-buffer buffer
1138 (mm-disable-multibyte)
1139 (setq url-current-object url
1140 mode-line-format "%b [%s]")
1141
1142 (dolist (var '(url-http-end-of-headers
1143 url-http-content-type
1144 url-http-content-length
1145 url-http-transfer-encoding
1146 url-http-after-change-function
1147 url-http-response-version
1148 url-http-response-status
1149 url-http-chunked-length
1150 url-http-chunked-counter
1151 url-http-chunked-start
1152 url-callback-function
1153 url-callback-arguments
1154 url-http-process
1155 url-http-method
1156 url-http-extra-headers
1157 url-http-data
1158 url-http-target-url
1159 url-http-connection-opened
1160 url-http-proxy))
1161 (set (make-local-variable var) nil))
1162
1163 (setq url-http-method (or url-request-method "GET")
1164 url-http-extra-headers url-request-extra-headers
1165 url-http-data url-request-data
1166 url-http-process connection
1167 url-http-chunked-length nil
1168 url-http-chunked-start nil
1169 url-http-chunked-counter 0
1170 url-callback-function callback
1171 url-callback-arguments cbargs
1172 url-http-after-change-function 'url-http-wait-for-headers-change-function
1173 url-http-target-url url-current-object
1174 url-http-connection-opened nil
1175 url-http-proxy url-using-proxy)
1176
1177 (set-process-buffer connection buffer)
1178 (set-process-filter connection 'url-http-generic-filter)
1179 (let ((status (process-status connection)))
1180 (cond
1181 ((eq status 'connect)
1182 ;; Asynchronous connection
1183 (set-process-sentinel connection 'url-http-async-sentinel))
1184 ((eq status 'failed)
1185 ;; Asynchronous connection failed
1186 (error "Could not create connection to %s:%d" host port))
1187 (t
1188 (set-process-sentinel connection 'url-http-end-of-document-sentinel)
1189 (process-send-string connection (url-http-create-request)))))))
1190 buffer))
1191
1192 (defun url-http-async-sentinel (proc why)
1193 (declare (special url-callback-arguments))
1194 ;; We are performing an asynchronous connection, and a status change
1195 ;; has occurred.
1196 (with-current-buffer (process-buffer proc)
1197 (cond
1198 (url-http-connection-opened
1199 (url-http-end-of-document-sentinel proc why))
1200 ((string= (substring why 0 4) "open")
1201 (setq url-http-connection-opened t)
1202 (process-send-string proc (url-http-create-request)))
1203 (t
1204 (setf (car url-callback-arguments)
1205 (nconc (list :error (list 'error 'connection-failed why
1206 :host (url-host (or url-http-proxy url-current-object))
1207 :service (url-port (or url-http-proxy url-current-object))))
1208 (car url-callback-arguments)))
1209 (url-http-activate-callback)))))
1210
1211 ;; Since Emacs 19/20 does not allow you to change the
1212 ;; `after-change-functions' hook in the midst of running them, we fake
1213 ;; an after change by hooking into the process filter and inserting
1214 ;; the data ourselves. This is slightly less efficient, but there
1215 ;; were tons of weird ways the after-change code was biting us in the
1216 ;; shorts.
1217 (defun url-http-generic-filter (proc data)
1218 ;; Sometimes we get a zero-length data chunk after the process has
1219 ;; been changed to 'free', which means it has no buffer associated
1220 ;; with it. Do nothing if there is no buffer, or 0 length data.
1221 (declare (special url-http-after-change-function))
1222 (and (process-buffer proc)
1223 (/= (length data) 0)
1224 (with-current-buffer (process-buffer proc)
1225 (url-http-debug "Calling after change function `%s' for `%S'" url-http-after-change-function proc)
1226 (funcall url-http-after-change-function
1227 (point-max)
1228 (progn
1229 (goto-char (point-max))
1230 (insert data)
1231 (point-max))
1232 (length data)))))
1233
1234 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1235 ;;; file-name-handler stuff from here on out
1236 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1237 (defalias 'url-http-symbol-value-in-buffer
1238 (if (fboundp 'symbol-value-in-buffer)
1239 'symbol-value-in-buffer
1240 (lambda (symbol buffer &optional unbound-value)
1241 "Return the value of SYMBOL in BUFFER, or UNBOUND-VALUE if it is unbound."
1242 (with-current-buffer buffer
1243 (if (not (boundp symbol))
1244 unbound-value
1245 (symbol-value symbol))))))
1246
1247 (defun url-http-head (url)
1248 (let ((url-request-method "HEAD")
1249 (url-request-data nil))
1250 (url-retrieve-synchronously url)))
1251
1252 ;;;###autoload
1253 (defun url-http-file-exists-p (url)
1254 (let ((status nil)
1255 (exists nil)
1256 (buffer (url-http-head url)))
1257 (if (not buffer)
1258 (setq exists nil)
1259 (setq status (url-http-symbol-value-in-buffer 'url-http-response-status
1260 buffer 500)
1261 exists (and (integerp status)
1262 (>= status 200) (< status 300)))
1263 (kill-buffer buffer))
1264 exists))
1265
1266 ;;;###autoload
1267 (defalias 'url-http-file-readable-p 'url-http-file-exists-p)
1268
1269 (defun url-http-head-file-attributes (url &optional id-format)
1270 (let ((buffer (url-http-head url)))
1271 (when buffer
1272 (prog1
1273 (list
1274 nil ;dir / link / normal file
1275 1 ;number of links to file.
1276 0 0 ;uid ; gid
1277 nil nil nil ;atime ; mtime ; ctime
1278 (url-http-symbol-value-in-buffer 'url-http-content-length
1279 buffer -1)
1280 (eval-when-compile (make-string 10 ?-))
1281 nil nil nil) ;whether gid would change ; inode ; device.
1282 (kill-buffer buffer)))))
1283
1284 (declare-function url-dav-file-attributes "url-dav" (url &optional id-format))
1285
1286 ;;;###autoload
1287 (defun url-http-file-attributes (url &optional id-format)
1288 (if (url-dav-supported-p url)
1289 (url-dav-file-attributes url id-format)
1290 (url-http-head-file-attributes url id-format)))
1291
1292 ;;;###autoload
1293 (defun url-http-options (url)
1294 "Return a property list describing options available for URL.
1295 This list is retrieved using the `OPTIONS' HTTP method.
1296
1297 Property list members:
1298
1299 methods
1300 A list of symbols specifying what HTTP methods the resource
1301 supports.
1302
1303 dav
1304 A list of numbers specifying what DAV protocol/schema versions are
1305 supported.
1306
1307 dasl
1308 A list of supported DASL search types supported (string form)
1309
1310 ranges
1311 A list of the units available for use in partial document fetches.
1312
1313 p3p
1314 The `Platform For Privacy Protection' description for the resource.
1315 Currently this is just the raw header contents. This is likely to
1316 change once P3P is formally supported by the URL package or
1317 Emacs/W3."
1318 (let* ((url-request-method "OPTIONS")
1319 (url-request-data nil)
1320 (buffer (url-retrieve-synchronously url))
1321 (header nil)
1322 (options nil))
1323 (when (and buffer (= 2 (/ (url-http-symbol-value-in-buffer
1324 'url-http-response-status buffer 0) 100)))
1325 ;; Only parse the options if we got a 2xx response code!
1326 (with-current-buffer buffer
1327 (save-restriction
1328 (save-match-data
1329 (mail-narrow-to-head)
1330
1331 ;; Figure out what methods are supported.
1332 (when (setq header (mail-fetch-field "allow"))
1333 (setq options (plist-put
1334 options 'methods
1335 (mapcar 'intern (split-string header "[ ,]+")))))
1336
1337 ;; Check for DAV
1338 (when (setq header (mail-fetch-field "dav"))
1339 (setq options (plist-put
1340 options 'dav
1341 (delq 0
1342 (mapcar 'string-to-number
1343 (split-string header "[, ]+"))))))
1344
1345 ;; Now for DASL
1346 (when (setq header (mail-fetch-field "dasl"))
1347 (setq options (plist-put
1348 options 'dasl
1349 (split-string header "[, ]+"))))
1350
1351 ;; P3P - should get more detailed here. FIXME
1352 (when (setq header (mail-fetch-field "p3p"))
1353 (setq options (plist-put options 'p3p header)))
1354
1355 ;; Check for whether they accept byte-range requests.
1356 (when (setq header (mail-fetch-field "accept-ranges"))
1357 (setq options (plist-put
1358 options 'ranges
1359 (delq 'none
1360 (mapcar 'intern
1361 (split-string header "[, ]+"))))))
1362 ))))
1363 (if buffer (kill-buffer buffer))
1364 options))
1365
1366 ;; HTTPS. This used to be in url-https.el, but that file collides
1367 ;; with url-http.el on systems with 8-character file names.
1368 (require 'tls)
1369
1370 ;;;###autoload
1371 (defconst url-https-default-port 443 "Default HTTPS port.")
1372 ;;;###autoload
1373 (defconst url-https-asynchronous-p t "HTTPS retrievals are asynchronous.")
1374
1375 ;; FIXME what is the point of this alias being an autoload?
1376 ;; Trying to use it will not cause url-http to be loaded,
1377 ;; since the full alias just gets dumped into loaddefs.el.
1378
1379 ;;;###autoload (autoload 'url-default-expander "url-expand")
1380 ;;;###autoload
1381 (defalias 'url-https-expand-file-name 'url-default-expander)
1382
1383 (defmacro url-https-create-secure-wrapper (method args)
1384 `(defun ,(intern (format (if method "url-https-%s" "url-https") method)) ,args
1385 ,(format "HTTPS wrapper around `%s' call." (or method "url-http"))
1386 (let ((url-gateway-method 'tls))
1387 (,(intern (format (if method "url-http-%s" "url-http") method))
1388 ,@(remove '&rest (remove '&optional args))))))
1389
1390 ;;;###autoload (autoload 'url-https "url-http")
1391 (url-https-create-secure-wrapper nil (url callback cbargs))
1392 ;;;###autoload (autoload 'url-https-file-exists-p "url-http")
1393 (url-https-create-secure-wrapper file-exists-p (url))
1394 ;;;###autoload (autoload 'url-https-file-readable-p "url-http")
1395 (url-https-create-secure-wrapper file-readable-p (url))
1396 ;;;###autoload (autoload 'url-https-file-attributes "url-http")
1397 (url-https-create-secure-wrapper file-attributes (url &optional id-format))
1398
1399 (provide 'url-http)
1400
1401 ;; arch-tag: ba7c59ae-c0f4-4a31-9617-d85f221732ee
1402 ;;; url-http.el ends here