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