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