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