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