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