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