1 ;;; url-http.el --- HTTP retrieval routines
3 ;; Copyright (C) 1999, 2001, 2004-2015 Free Software Foundation, Inc.
5 ;; Author: Bill Perry <wmperry@gnu.org>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: comm, data, processes
9 ;; This file is part of GNU Emacs.
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.
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.
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/>.
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
)
62 (autoload 'url-cache-create-filename
"url-cache")
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
)
68 (defvar url-http-real-basic-auth-storage nil
)
69 (defvar url-http-proxy-basic-auth-storage nil
)
71 (defvar url-http-open-connections
(make-hash-table :test
'equal
73 "A hash table of all open network connections.")
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.
80 Setting this to 1.0 will tell servers not to send chunked encoding,
81 and other HTTP/1.1 specific features.")
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
89 (defconst url-http-codes
90 '((100 continue
"Continue with request")
91 (101 switching-protocols
"Switching protocols")
92 (102 processing
"Processing (Added by DAV)")
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")
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")
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.")
138 (defcustom url-user-agent
(format "User-Agent: %sURL/%s\r\n"
140 (concat url-package-name
"/"
141 url-package-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"))
150 ;; These are all macros so that they are hidden from external sight
151 ;; when the file is byte-compiled.
153 ;; This allows us to expose just the entry points we want.
155 ;; These routines will allow us to implement persistent HTTP
157 (defsubst url-http-debug
(&rest args
)
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)
164 (set-process-sentinel proc nil
)
165 (set-process-filter proc nil
)))
166 (error "Transfer interrupted!")))
167 (apply 'url-debug
'http args
))
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
)
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
))
188 (defun url-http-find-free-connection (host port
&optional gateway-method
)
189 (let ((conns (gethash (cons host port
) url-http-open-connections
))
191 (while (and conns
(not connection
))
192 (if (not (memq (process-status (car conns
)) '(run open connect
)))
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
))
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
)
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.
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
218 (when (get-buffer-process buf
)
219 (set-process-query-on-exit-flag (get-buffer-process buf
) nil
))
223 (url-http-mark-connection-as-busy host port connection
))))
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
)))
231 (if (functionp url-user-agent
)
232 (funcall url-user-agent
)
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)
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
))
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
))
252 (url-get-authentication (or
253 (and (boundp '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
)))
260 (setq auth
(concat "Authorization: " auth
"\r\n")))
262 (setq proxy-auth
(concat "Proxy-Authorization: " proxy-auth
"\r\n")))
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
"")))
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
)))
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
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")))
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.
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.
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.
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
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
))
321 "Host: %s:%d\r\n" host
(url-port url-http-target-url
))
322 (format "Host: %s\r\n" host
))
324 (if url-personal-mail-address
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
)
335 (setq url-mime-encoding-string
"gzip")))
337 "Accept-encoding: " url-mime-encoding-string
"\r\n"))
338 (if url-mime-charset-string
340 "Accept-charset: " url-mime-charset-string
"\r\n"))
341 ;; Languages we understand
342 (if url-mime-language-string
344 "Accept-language: " url-mime-language-string
"\r\n"))
345 ;; Types we understand
346 "Accept: " (or url-mime-accept-string
"*/*") "\r\n"
348 (url-http-user-agent-string)
349 ;; Proxy Authorization
354 (when (url-use-cookies url-http-target-url
)
355 (url-cookie-generate-header-lines
357 (equal "https" (url-type url-http-target-url
))))
359 (if (and (not no-cache
)
360 (member url-http-method
'("GET" nil
)))
361 (let ((tm (url-is-cached url-http-target-url
)))
363 (concat "If-modified-since: "
364 (url-get-normalized-date tm
) "\r\n"))))
367 "Referer: " ref-url
"\r\n"))
372 "Content-length: " (number-to-string
373 (length url-http-data
))
380 (url-http-debug "Request is: \n%s" request
)
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
)
392 (- end url-http-end-of-headers
)))
394 (defun url-http-handle-authentication (proxy)
395 (url-http-debug "Handling %s authentication" (if proxy
"proxy" "normal"))
396 (let ((auths (or (nreverse
398 (if proxy
"proxy-authenticate" "www-authenticate")
402 (url (url-recreate-url url-current-object
))
403 (auth-url (url-recreate-url
404 (if (and proxy
(boundp '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
))
414 ;; find strongest supported auth
415 (dolist (this-auth auths
)
416 (setq this-auth
(url-eat-trailing-space
417 (url-strip-leading-spaces
420 (downcase (if (string-match "[ \t]" this-auth
)
421 (substring this-auth
0 (match-beginning 0))
423 (registered (url-auth-registered this-type
))
424 (this-strength (cddr registered
)))
425 (when (and registered
(> this-strength strength
))
428 strength this-strength
))))
430 (if (not (url-auth-registered type
))
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?
441 nil
) ;; Not success yet.
443 (let* ((args (url-parse-args (subst-char-in-string ?
, ?\
; auth)))
444 (auth (url-get-authentication auth-url
445 (cdr-safe (assoc "realm" args
))
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.
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)
469 (skip-chars-forward "[0-9].")
471 (setq url-http-response-status
(read (current-buffer))))
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
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
)))
482 (url-cookie-handle-set-cookie (pop cookies
)))
484 ;;; (url-cookie-handle-set-cookie2 (pop cookies)))
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
494 (url-http-mark-connection-as-free (url-host url-current-object
)
495 (url-port url-current-object
)
497 ;; Pass the https certificate on to the caller.
498 (when (gnutls-available-p)
499 (let ((status (gnutls-peer-status url-http-process
)))
501 (plist-get (car url-callback-arguments
) :peer
))
502 (setcar url-callback-arguments
503 (plist-put (car url-callback-arguments
)
505 (if (or (not (boundp 'url-http-end-of-headers
))
506 (not url-http-end-of-headers
))
507 (error "Trying to parse headers in odd buffer: %s" (buffer-name)))
508 (goto-char (point-min))
509 (url-http-debug "url-http-parse-headers called in (%s)" (buffer-name))
510 (url-http-parse-response)
511 (mail-narrow-to-head)
512 ;;(narrow-to-region (point-min) url-http-end-of-headers)
513 (let ((connection (mail-fetch-field "Connection")))
514 ;; In HTTP 1.0, keep the connection only if there is a
515 ;; "Connection: keep-alive" header.
516 ;; In HTTP 1.1 (and greater), keep the connection unless there is a
517 ;; "Connection: close" header
519 ((string= url-http-response-version
"1.0")
520 (unless (and connection
521 (string= (downcase connection
) "keep-alive"))
522 (delete-process url-http-process
)))
524 (when (and connection
525 (string= (downcase connection
) "close"))
526 (delete-process url-http-process
)))))
527 (let* ((buffer (current-buffer))
528 (class (/ url-http-response-status
100))
530 ;; other status symbols: jewelry and luxury cars
531 (status-symbol (cadr (assq url-http-response-status url-http-codes
))))
532 (url-http-debug "Parsed HTTP headers: class=%d status=%d"
533 class url-http-response-status
)
534 (when (url-use-cookies url-http-target-url
)
535 (url-http-handle-cookies))
538 ;; Classes of response codes
540 ;; 5xx = Server Error
541 ;; 4xx = Client Error
544 ;; 1xx = Informational
545 (1 ; Information messages
546 ;; 100 = Continue with request
547 ;; 101 = Switching protocols
548 ;; 102 = Processing (Added by DAV)
549 (url-mark-buffer-as-dead buffer
)
550 (error "HTTP responses in class 1xx not supported (%d)"
551 url-http-response-status
))
556 ;; 203 Non-authoritative information
559 ;; 206 Partial content
560 ;; 207 Multi-status (Added by DAV)
562 ((or `no-content
`reset-content
)
563 ;; No new data, just stay at the same document
564 (url-mark-buffer-as-dead buffer
))
566 ;; Generic success for all others. Store in the cache, and
567 ;; mark it as successful.
569 (if (and url-automatic-caching
(equal url-http-method
"GET"))
570 (url-store-in-cache buffer
))))
573 ;; 300 Multiple choices
574 ;; 301 Moved permanently
579 ;; 307 Temporary redirect
580 (let ((redirect-uri (or (mail-fetch-field "Location")
581 (mail-fetch-field "URI"))))
583 (`multiple-choices
; 300
584 ;; Quoth the spec (section 10.3.1)
585 ;; -------------------------------
586 ;; The requested resource corresponds to any one of a set of
587 ;; representations, each with its own specific location and
588 ;; agent-driven negotiation information is being provided so
589 ;; that the user can select a preferred representation and
590 ;; redirect its request to that location.
592 ;; If the server has a preferred choice of representation, it
593 ;; SHOULD include the specific URI for that representation in
594 ;; the Location field; user agents MAY use the Location field
595 ;; value for automatic redirection.
596 ;; -------------------------------
597 ;; We do not support agent-driven negotiation, so we just
598 ;; redirect to the preferred URI if one is provided.
600 ((or `moved-permanently
`found
`temporary-redirect
) ; 301 302 307
601 ;; If the 301|302 status code is received in response to a
602 ;; request other than GET or HEAD, the user agent MUST NOT
603 ;; automatically redirect the request unless it can be
604 ;; confirmed by the user, since this might change the
605 ;; conditions under which the request was issued.
606 (unless (member url-http-method
'("HEAD" "GET"))
607 (setq redirect-uri nil
)))
609 ;; The response to the request can be found under a different
610 ;; URI and SHOULD be retrieved using a GET method on that
612 (setq url-http-method
"GET"
615 ;; The 304 response MUST NOT contain a message-body.
616 (url-http-debug "Extracting document from cache... (%s)"
617 (url-cache-create-filename (url-view-url t
)))
618 (url-cache-extract (url-cache-create-filename (url-view-url t
)))
619 (setq redirect-uri nil
622 ;; The requested resource MUST be accessed through the
623 ;; proxy given by the Location field. The Location field
624 ;; gives the URI of the proxy. The recipient is expected
625 ;; to repeat this single request via the proxy. 305
626 ;; responses MUST only be generated by origin servers.
627 (error "Redirection thru a proxy server not supported: %s"
630 ;; Treat everything like '300'
633 ;; Clean off any whitespace and/or <...> cruft.
634 (if (string-match "\\([^ \t]+\\)[ \t]" redirect-uri
)
635 (setq redirect-uri
(match-string 1 redirect-uri
)))
636 (if (string-match "^<\\(.*\\)>$" redirect-uri
)
637 (setq redirect-uri
(match-string 1 redirect-uri
)))
639 ;; Some stupid sites (like sourceforge) send a
640 ;; non-fully-qualified URL (ie: /), which royally confuses
642 (if (not (string-match url-nonrelative-link redirect-uri
))
643 ;; Be careful to use the real target URL, otherwise we may
644 ;; compute the redirection relative to the URL of the proxy.
646 (url-expand-file-name redirect-uri url-http-target-url
)))
647 (let ((url-request-method url-http-method
)
648 (url-request-data url-http-data
)
649 (url-request-extra-headers url-http-extra-headers
))
650 ;; Check existing number of redirects
651 (if (or (< url-max-redirections
0)
652 (and (> url-max-redirections
0)
653 (let ((events (car url-callback-arguments
))
656 (if (eq (car events
) :redirect
)
657 (setq old-redirects
(1+ old-redirects
)))
658 (and (setq events
(cdr events
))
659 (setq events
(cdr events
))))
660 (< old-redirects url-max-redirections
))))
661 ;; url-max-redirections hasn't been reached, so go
662 ;; ahead and redirect.
664 ;; Remember that the request was redirected.
665 (setf (car url-callback-arguments
)
666 (nconc (list :redirect redirect-uri
)
667 (car url-callback-arguments
)))
668 ;; Put in the current buffer a forwarding pointer to the new
669 ;; destination buffer.
670 ;; FIXME: This is a hack to fix url-retrieve-synchronously
671 ;; without changing the API. Instead url-retrieve should
672 ;; either simply not return the "destination" buffer, or it
673 ;; should take an optional `dest-buf' argument.
674 (set (make-local-variable 'url-redirect-buffer
)
675 (url-retrieve-internal
676 redirect-uri url-callback-function
677 url-callback-arguments
678 (url-silent url-current-object
)
679 (not (url-use-cookies url-current-object
))))
680 (url-mark-buffer-as-dead buffer
))
681 ;; We hit url-max-redirections, so issue an error and
683 (url-http-debug "Maximum redirections reached")
684 (setf (car url-callback-arguments
)
685 (nconc (list :error
(list 'error
'http-redirect-limit
687 (car url-callback-arguments
)))
688 (setq success t
))))))
692 ;; 402 Payment required
695 ;; 405 Method not allowed
696 ;; 406 Not acceptable
697 ;; 407 Proxy authentication required
698 ;; 408 Request time-out
701 ;; 411 Length required
702 ;; 412 Precondition failed
703 ;; 413 Request entity too large
704 ;; 414 Request-URI too large
705 ;; 415 Unsupported media type
706 ;; 416 Requested range not satisfiable
707 ;; 417 Expectation failed
708 ;; 422 Unprocessable Entity (Added by DAV)
710 ;; 424 Failed Dependency
714 ;; The request requires user authentication. The response
715 ;; MUST include a WWW-Authenticate header field containing a
716 ;; challenge applicable to the requested resource. The
717 ;; client MAY repeat the request with a suitable
718 ;; Authorization header field.
719 (url-http-handle-authentication nil
))
720 (`payment-required
; 402
721 ;; This code is reserved for future use
722 (url-mark-buffer-as-dead buffer
)
723 (error "Somebody wants you to give them money"))
725 ;; The server understood the request, but is refusing to
726 ;; fulfill it. Authorization will not help and the request
727 ;; SHOULD NOT be repeated.
732 (`method-not-allowed
; 405
733 ;; The method specified in the Request-Line is not allowed
734 ;; for the resource identified by the Request-URI. The
735 ;; response MUST include an Allow header containing a list of
736 ;; valid methods for the requested resource.
738 (`not-acceptable
; 406
739 ;; The resource identified by the request is only capable of
740 ;; generating response entities which have content
741 ;; characteristics not acceptable according to the accept
742 ;; headers sent in the request.
744 (`proxy-authentication-required
; 407
745 ;; This code is similar to 401 (Unauthorized), but indicates
746 ;; that the client must first authenticate itself with the
747 ;; proxy. The proxy MUST return a Proxy-Authenticate header
748 ;; field containing a challenge applicable to the proxy for
749 ;; the requested resource.
750 (url-http-handle-authentication t
))
751 (`request-timeout
; 408
752 ;; The client did not produce a request within the time that
753 ;; the server was prepared to wait. The client MAY repeat
754 ;; the request without modifications at any later time.
757 ;; The request could not be completed due to a conflict with
758 ;; the current state of the resource. This code is only
759 ;; allowed in situations where it is expected that the user
760 ;; might be able to resolve the conflict and resubmit the
761 ;; request. The response body SHOULD include enough
762 ;; information for the user to recognize the source of the
766 ;; The requested resource is no longer available at the
767 ;; server and no forwarding address is known.
769 (`length-required
; 411
770 ;; The server refuses to accept the request without a defined
771 ;; Content-Length. The client MAY repeat the request if it
772 ;; adds a valid Content-Length header field containing the
773 ;; length of the message-body in the request message.
775 ;; NOTE - this will never happen because
776 ;; `url-http-create-request' automatically calculates the
779 (`precondition-failed
; 412
780 ;; The precondition given in one or more of the
781 ;; request-header fields evaluated to false when it was
782 ;; tested on the server.
784 ((or `request-entity-too-large
`request-uri-too-large
) ; 413 414
785 ;; The server is refusing to process a request because the
786 ;; request entity|URI is larger than the server is willing or
789 (`unsupported-media-type
; 415
790 ;; The server is refusing to service the request because the
791 ;; entity of the request is in a format not supported by the
792 ;; requested resource for the requested method.
794 (`requested-range-not-satisfiable
; 416
795 ;; A server SHOULD return a response with this status code if
796 ;; a request included a Range request-header field, and none
797 ;; of the range-specifier values in this field overlap the
798 ;; current extent of the selected resource, and the request
799 ;; did not include an If-Range request-header field.
801 (`expectation-failed
; 417
802 ;; The expectation given in an Expect request-header field
803 ;; could not be met by this server, or, if the server is a
804 ;; proxy, the server has unambiguous evidence that the
805 ;; request could not be met by the next-hop server.
808 ;; The request could not be understood by the server due to
809 ;; malformed syntax. The client SHOULD NOT repeat the
810 ;; request without modifications.
812 ;; Tell the callback that an error occurred, and what the
815 (setf (car url-callback-arguments
)
816 (nconc (list :error
(list 'error
'http url-http-response-status
))
817 (car url-callback-arguments
)))))
819 ;; 500 Internal server error
820 ;; 501 Not implemented
822 ;; 503 Service unavailable
823 ;; 504 Gateway time-out
824 ;; 505 HTTP version not supported
825 ;; 507 Insufficient storage
827 (pcase url-http-response-status
828 (`not-implemented
; 501
829 ;; The server does not support the functionality required to
830 ;; fulfill the request.
833 ;; The server, while acting as a gateway or proxy, received
834 ;; an invalid response from the upstream server it accessed
835 ;; in attempting to fulfill the request.
837 (`service-unavailable
; 503
838 ;; The server is currently unable to handle the request due
839 ;; to a temporary overloading or maintenance of the server.
840 ;; The implication is that this is a temporary condition
841 ;; which will be alleviated after some delay. If known, the
842 ;; length of the delay MAY be indicated in a Retry-After
843 ;; header. If no Retry-After is given, the client SHOULD
844 ;; handle the response as it would for a 500 response.
846 (`gateway-timeout
; 504
847 ;; The server, while acting as a gateway or proxy, did not
848 ;; receive a timely response from the upstream server
849 ;; specified by the URI (e.g. HTTP, FTP, LDAP) or some other
850 ;; auxiliary server (e.g. DNS) it needed to access in
851 ;; attempting to complete the request.
853 (`http-version-not-supported
; 505
854 ;; The server does not support, or refuses to support, the
855 ;; HTTP protocol version that was used in the request
858 (`insufficient-storage
; 507 (DAV)
859 ;; The method could not be performed on the resource
860 ;; because the server is unable to store the representation
861 ;; needed to successfully complete the request. This
862 ;; condition is considered to be temporary. If the request
863 ;; which received this status code was the result of a user
864 ;; action, the request MUST NOT be repeated until it is
865 ;; requested by a separate user action.
867 ;; Tell the callback that an error occurred, and what the
870 (setf (car url-callback-arguments
)
871 (nconc (list :error
(list 'error
'http url-http-response-status
))
872 (car url-callback-arguments
)))))
874 (error "Unknown class of HTTP response code: %d (%d)"
875 class url-http-response-status
)))
877 (url-mark-buffer-as-dead buffer
)
878 (url-handle-content-transfer-encoding))
879 (url-http-debug "Finished parsing HTTP headers: %S" success
)
881 (goto-char (point-min))
884 (declare-function zlib-decompress-region
"decompress.c" (start end
))
886 (defun url-handle-content-transfer-encoding ()
887 (let ((encoding (mail-fetch-field "content-encoding")))
889 (fboundp 'zlib-available-p
)
891 (equal (downcase encoding
) "gzip"))
894 (goto-char (point-min))
895 (when (search-forward "\n\n")
896 (zlib-decompress-region (point) (point-max)))))))
899 (defun url-http-activate-callback ()
900 "Activate callback specified when this buffer was created."
901 (url-http-mark-connection-as-free (url-host url-current-object
)
902 (url-port url-current-object
)
904 (url-http-debug "Activating callback in buffer (%s): %S %S"
905 (buffer-name) url-callback-function url-callback-arguments
)
906 (apply url-callback-function url-callback-arguments
))
910 ;; These unfortunately cannot be macros... please ignore them!
911 (defun url-http-idle-sentinel (proc why
)
912 "Remove (now defunct) process PROC from the list of open connections."
913 (maphash (lambda (key val
)
915 (puthash key
(delq proc val
) url-http-open-connections
)))
916 url-http-open-connections
))
918 (defun url-http-end-of-document-sentinel (proc why
)
919 ;; Sentinel used to handle (i) terminated old HTTP/0.9 connections,
920 ;; and (ii) closed connection due to reusing a HTTP connection which
921 ;; we believed was still alive, but which the server closed on us.
922 ;; We handle case (ii) by calling `url-http' again.
923 (url-http-debug "url-http-end-of-document-sentinel in buffer (%s)"
924 (process-buffer proc
))
925 (url-http-idle-sentinel proc why
)
926 (when (buffer-name (process-buffer proc
))
927 (with-current-buffer (process-buffer proc
)
928 (goto-char (point-min))
929 (cond ((not (looking-at "HTTP/"))
930 (if url-http-no-retry
931 ;; HTTP/0.9 just gets passed back no matter what
932 (url-http-activate-callback)
933 ;; Call `url-http' again if our connection expired.
935 (let ((url-request-method url-http-method
)
936 (url-request-extra-headers url-http-extra-headers
)
937 (url-request-data url-http-data
))
938 (url-http url-current-object url-callback-function
939 url-callback-arguments
(current-buffer)))))
940 ((url-http-parse-headers)
941 (url-http-activate-callback))))))
943 (defun url-http-simple-after-change-function (st nd length
)
944 ;; Function used when we do NOT know how long the document is going to be
945 ;; Just _very_ simple 'downloaded %d' type of info.
946 (url-lazy-message "Reading %s..." (file-size-human-readable nd
)))
948 (defun url-http-content-length-after-change-function (st nd length
)
949 "Function used when we DO know how long the document is going to be.
950 More sophisticated percentage downloaded, etc.
951 Also does minimal parsing of HTTP headers and will actually cause
952 the callback to be triggered."
953 (if url-http-content-type
954 (url-display-percentage
955 "Reading [%s]... %s of %s (%d%%)"
956 (url-percentage (- nd url-http-end-of-headers
)
957 url-http-content-length
)
958 url-http-content-type
959 (file-size-human-readable (- nd url-http-end-of-headers
))
960 (file-size-human-readable url-http-content-length
)
961 (url-percentage (- nd url-http-end-of-headers
)
962 url-http-content-length
))
963 (url-display-percentage
964 "Reading... %s of %s (%d%%)"
965 (url-percentage (- nd url-http-end-of-headers
)
966 url-http-content-length
)
967 (file-size-human-readable (- nd url-http-end-of-headers
))
968 (file-size-human-readable url-http-content-length
)
969 (url-percentage (- nd url-http-end-of-headers
)
970 url-http-content-length
)))
972 (if (> (- nd url-http-end-of-headers
) url-http-content-length
)
974 ;; Found the end of the document! Wheee!
975 (url-display-percentage nil nil
)
976 (url-lazy-message "Reading... done.")
977 (if (url-http-parse-headers)
978 (url-http-activate-callback)))))
980 (defun url-http-chunked-encoding-after-change-function (st nd length
)
981 "Function used when dealing with 'chunked' encoding.
982 Cannot give a sophisticated percentage, but we need a different
983 function to look for the special 0-length chunk that signifies
984 the end of the document."
987 (let ((read-next-chunk t
)
990 (no-initial-crlf nil
))
991 ;; We need to loop thru looking for more chunks even within
992 ;; one after-change-function call.
993 (while read-next-chunk
994 (setq no-initial-crlf
(= 0 url-http-chunked-counter
))
995 (if url-http-content-type
996 (url-display-percentage nil
997 "Reading [%s]... chunk #%d"
998 url-http-content-type url-http-chunked-counter
)
999 (url-display-percentage nil
1000 "Reading... chunk #%d"
1001 url-http-chunked-counter
))
1002 (url-http-debug "Reading chunk %d (%d %d %d)"
1003 url-http-chunked-counter st nd length
)
1004 (setq regexp
(if no-initial-crlf
1005 "\\([0-9a-z]+\\).*\r?\n"
1006 "\r?\n\\([0-9a-z]+\\).*\r?\n"))
1008 (if url-http-chunked-start
1009 ;; We know how long the chunk is supposed to be, skip over
1010 ;; leading crap if possible.
1011 (if (> nd
(+ url-http-chunked-start url-http-chunked-length
))
1013 (url-http-debug "Got to the end of chunk #%d!"
1014 url-http-chunked-counter
)
1015 (goto-char (+ url-http-chunked-start
1016 url-http-chunked-length
)))
1017 (url-http-debug "Still need %d bytes to hit end of chunk"
1018 (- (+ url-http-chunked-start
1019 url-http-chunked-length
)
1021 (setq read-next-chunk nil
)))
1022 (if (not read-next-chunk
)
1023 (url-http-debug "Still spinning for next chunk...")
1024 (if no-initial-crlf
(skip-chars-forward "\r\n"))
1025 (if (not (looking-at regexp
))
1027 ;; Must not have received the entirety of the chunk header,
1028 ;; need to spin some more.
1029 (url-http-debug "Did not see start of chunk @ %d!" (point))
1030 (setq read-next-chunk nil
))
1031 (add-text-properties (match-beginning 0) (match-end 0)
1037 (setq url-http-chunked-length
(string-to-number (buffer-substring
1041 url-http-chunked-counter
(1+ url-http-chunked-counter
)
1042 url-http-chunked-start
(set-marker
1043 (or url-http-chunked-start
1046 ; (if (not url-http-debug)
1047 (delete-region (match-beginning 0) (match-end 0));)
1048 (url-http-debug "Saw start of chunk %d (length=%d, start=%d"
1049 url-http-chunked-counter url-http-chunked-length
1050 (marker-position url-http-chunked-start
))
1051 (if (= 0 url-http-chunked-length
)
1053 ;; Found the end of the document! Wheee!
1054 (url-http-debug "Saw end of stream chunk!")
1055 (setq read-next-chunk nil
)
1056 (url-display-percentage nil nil
)
1057 ;; Every chunk, even the last 0-length one, is
1058 ;; terminated by CRLF. Skip it.
1059 (when (looking-at "\r?\n")
1060 (url-http-debug "Removing terminator of last chunk")
1061 (delete-region (match-beginning 0) (match-end 0)))
1062 (if (re-search-forward "^\r*$" nil t
)
1063 (url-http-debug "Saw end of trailers..."))
1064 (if (url-http-parse-headers)
1065 (url-http-activate-callback))))))))))
1067 (defun url-http-wait-for-headers-change-function (st nd length
)
1068 ;; This will wait for the headers to arrive and then splice in the
1069 ;; next appropriate after-change-function, etc.
1070 (url-http-debug "url-http-wait-for-headers-change-function (%s)"
1072 (let ((end-of-headers nil
)
1074 (process-buffer (current-buffer))
1075 (content-length nil
))
1077 (goto-char (point-min))
1078 (if (and (looking-at ".*\n") ; have one line at least
1079 (not (looking-at "^HTTP/[1-9]\\.[0-9]")))
1080 ;; Not HTTP/x.y data, must be 0.9
1081 ;; God, I wish this could die.
1082 (setq end-of-headers t
1083 url-http-end-of-headers
0
1085 ;; Blank line at end of headers.
1086 (when (re-search-forward "^\r?\n" nil t
)
1088 ;; Saw the end of the headers
1089 (url-http-debug "Saw end of headers... (%s)" (buffer-name))
1090 (setq url-http-end-of-headers
(set-marker (make-marker)
1093 (setq nd
(- nd
(url-http-clean-headers)))))
1095 (if (not end-of-headers
)
1096 ;; Haven't seen the end of the headers yet, need to wait
1097 ;; for more data to arrive.
1100 (url-http-parse-response)
1101 (mail-narrow-to-head)
1102 (setq url-http-transfer-encoding
(mail-fetch-field
1103 "transfer-encoding")
1104 url-http-content-type
(mail-fetch-field "content-type"))
1105 (if (mail-fetch-field "content-length")
1106 (setq url-http-content-length
1107 (string-to-number (mail-fetch-field "content-length"))))
1109 (when url-http-transfer-encoding
1110 (setq url-http-transfer-encoding
1111 (downcase url-http-transfer-encoding
)))
1114 ((null url-http-response-status
)
1115 ;; We got back a headerless malformed response from the
1117 (url-http-activate-callback))
1118 ((or (= url-http-response-status
204)
1119 (= url-http-response-status
205))
1120 (url-http-debug "%d response must have headers only (%s)."
1121 url-http-response-status
(buffer-name))
1122 (when (url-http-parse-headers)
1123 (url-http-activate-callback)))
1124 ((string= "HEAD" url-http-method
)
1125 ;; A HEAD request is _ALWAYS_ terminated by the header
1126 ;; information, regardless of any entity headers,
1127 ;; according to section 4.4 of the HTTP/1.1 draft.
1128 (url-http-debug "HEAD request must have headers only (%s)."
1130 (when (url-http-parse-headers)
1131 (url-http-activate-callback)))
1132 ((string= "CONNECT" url-http-method
)
1133 ;; A CONNECT request is finished, but we cannot stick this
1134 ;; back on the free connection list
1135 (url-http-debug "CONNECT request must have headers only.")
1136 (when (url-http-parse-headers)
1137 (url-http-activate-callback)))
1138 ((equal url-http-response-status
304)
1139 ;; Only allowed to have a header section. We have to handle
1140 ;; this here instead of in url-http-parse-headers because if
1141 ;; you have a cached copy of something without a known
1142 ;; content-length, and try to retrieve it from the cache, we'd
1143 ;; fall into the 'being dumb' section and wait for the
1144 ;; connection to terminate, which means we'd wait for 10
1145 ;; seconds for the keep-alives to time out on some servers.
1146 (when (url-http-parse-headers)
1147 (url-http-activate-callback)))
1149 ;; HTTP/0.9 always signaled end-of-connection by closing the
1152 "Saw HTTP/0.9 response, connection closed means end of document.")
1153 (setq url-http-after-change-function
1154 'url-http-simple-after-change-function
))
1155 ((equal url-http-transfer-encoding
"chunked")
1156 (url-http-debug "Saw chunked encoding.")
1157 (setq url-http-after-change-function
1158 'url-http-chunked-encoding-after-change-function
)
1159 (when (> nd url-http-end-of-headers
)
1161 "Calling initial chunked-encoding for extra data at end of headers")
1162 (url-http-chunked-encoding-after-change-function
1163 (marker-position url-http-end-of-headers
) nd
1164 (- nd url-http-end-of-headers
))))
1165 ((integerp url-http-content-length
)
1167 "Got a content-length, being smart about document end.")
1168 (setq url-http-after-change-function
1169 'url-http-content-length-after-change-function
)
1171 ((= 0 url-http-content-length
)
1172 ;; We got a NULL body! Activate the callback
1175 "Got 0-length content-length, activating callback immediately.")
1176 (when (url-http-parse-headers)
1177 (url-http-activate-callback)))
1178 ((> nd url-http-end-of-headers
)
1179 ;; Have some leftover data
1180 (url-http-debug "Calling initial content-length for extra data at end of headers")
1181 (url-http-content-length-after-change-function
1182 (marker-position url-http-end-of-headers
)
1184 (- nd url-http-end-of-headers
)))
1188 (url-http-debug "No content-length, being dumb.")
1189 (setq url-http-after-change-function
1190 'url-http-simple-after-change-function
)))))
1191 ;; We are still at the beginning of the buffer... must just be
1192 ;; waiting for a response.
1193 (url-http-debug "Spinning waiting for headers...")
1194 (when (eq process-buffer
(current-buffer))
1195 (goto-char (point-max)))))
1197 (defun url-http (url callback cbargs
&optional retry-buffer gateway-method
)
1198 "Retrieve URL via HTTP asynchronously.
1199 URL must be a parsed URL. See `url-generic-parse-url' for details.
1201 When retrieval is completed, execute the function CALLBACK, passing it
1202 an updated value of CBARGS as arguments. The first element in CBARGS
1203 should be a plist describing what has happened so far during the
1204 request, as described in the docstring of `url-retrieve' (if in
1205 doubt, specify nil).
1207 Optional arg RETRY-BUFFER, if non-nil, specifies the buffer of a
1208 previous `url-http' call, which is being re-attempted.
1210 Optional arg GATEWAY-METHOD specifies the gateway to be used,
1211 overriding the value of `url-gateway-method'."
1212 (cl-check-type url vector
"Need a pre-parsed URL.")
1213 (let* ((host (url-host (or url-using-proxy url
)))
1214 (port (url-port (or url-using-proxy url
)))
1215 (nsm-noninteractive (or url-request-noninteractive
1216 (and (boundp 'url-http-noninteractive
)
1217 url-http-noninteractive
)))
1218 (connection (url-http-find-free-connection host port gateway-method
))
1219 (buffer (or retry-buffer
1220 (generate-new-buffer
1221 (format " *http %s:%d*" host port
)))))
1222 (if (not connection
)
1223 ;; Failed to open the connection for some reason
1225 (kill-buffer buffer
)
1227 (error "Could not create connection to %s:%d" host port
))
1228 (with-current-buffer buffer
1229 (mm-disable-multibyte)
1230 (setq url-current-object url
1231 mode-line-format
"%b [%s]")
1233 (dolist (var '(url-http-end-of-headers
1234 url-http-content-type
1235 url-http-content-length
1236 url-http-transfer-encoding
1237 url-http-after-change-function
1238 url-http-response-version
1239 url-http-response-status
1240 url-http-chunked-length
1241 url-http-chunked-counter
1242 url-http-chunked-start
1243 url-callback-function
1244 url-callback-arguments
1248 url-http-extra-headers
1249 url-http-noninteractive
1253 url-http-connection-opened
1255 (set (make-local-variable var
) nil
))
1257 (setq url-http-method
(or url-request-method
"GET")
1258 url-http-extra-headers url-request-extra-headers
1259 url-http-noninteractive url-request-noninteractive
1260 url-http-data url-request-data
1261 url-http-process connection
1262 url-http-chunked-length nil
1263 url-http-chunked-start nil
1264 url-http-chunked-counter
0
1265 url-callback-function callback
1266 url-callback-arguments cbargs
1267 url-http-after-change-function
'url-http-wait-for-headers-change-function
1268 url-http-target-url url-current-object
1269 url-http-no-retry retry-buffer
1270 url-http-connection-opened nil
1271 url-http-proxy url-using-proxy
)
1273 (set-process-buffer connection buffer
)
1274 (set-process-filter connection
'url-http-generic-filter
)
1275 (pcase (process-status connection
)
1277 ;; Asynchronous connection
1278 (set-process-sentinel connection
'url-http-async-sentinel
))
1280 ;; Asynchronous connection failed
1281 (error "Could not create connection to %s:%d" host port
))
1283 (set-process-sentinel connection
1284 'url-http-end-of-document-sentinel
)
1285 (process-send-string connection
(url-http-create-request))))))
1288 (defun url-http-async-sentinel (proc why
)
1289 ;; We are performing an asynchronous connection, and a status change
1291 (when (buffer-name (process-buffer proc
))
1292 (with-current-buffer (process-buffer proc
)
1294 (url-http-connection-opened
1295 (setq url-http-no-retry t
)
1296 (url-http-end-of-document-sentinel proc why
))
1297 ((string= (substring why
0 4) "open")
1298 (setq url-http-connection-opened t
)
1299 (condition-case error
1300 (process-send-string proc
(url-http-create-request))
1302 (setq url-http-connection-opened nil
)
1303 (message "HTTP error: %s" error
))))
1305 (setf (car url-callback-arguments
)
1306 (nconc (list :error
(list 'error
'connection-failed why
1307 :host
(url-host (or url-http-proxy url-current-object
))
1308 :service
(url-port (or url-http-proxy url-current-object
))))
1309 (car url-callback-arguments
)))
1310 (url-http-activate-callback))))))
1312 ;; Since Emacs 19/20 does not allow you to change the
1313 ;; `after-change-functions' hook in the midst of running them, we fake
1314 ;; an after change by hooking into the process filter and inserting
1315 ;; the data ourselves. This is slightly less efficient, but there
1316 ;; were tons of weird ways the after-change code was biting us in the
1318 ;; FIXME this can probably be simplified since the above is no longer true.
1319 (defun url-http-generic-filter (proc data
)
1320 ;; Sometimes we get a zero-length data chunk after the process has
1321 ;; been changed to 'free', which means it has no buffer associated
1322 ;; with it. Do nothing if there is no buffer, or 0 length data.
1323 (and (process-buffer proc
)
1324 (/= (length data
) 0)
1325 (with-current-buffer (process-buffer proc
)
1326 (url-http-debug "Calling after change function `%s' for `%S'" url-http-after-change-function proc
)
1327 (funcall url-http-after-change-function
1330 (goto-char (point-max))
1335 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1336 ;;; file-name-handler stuff from here on out
1337 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1338 (defalias 'url-http-symbol-value-in-buffer
1339 (if (fboundp 'symbol-value-in-buffer
)
1340 'symbol-value-in-buffer
1341 (lambda (symbol buffer
&optional unbound-value
)
1342 "Return the value of SYMBOL in BUFFER, or UNBOUND-VALUE if it is unbound."
1343 (with-current-buffer buffer
1344 (if (not (boundp symbol
))
1346 (symbol-value symbol
))))))
1348 (defun url-http-head (url)
1349 (let ((url-request-method "HEAD")
1350 (url-request-data nil
))
1351 (url-retrieve-synchronously url
)))
1353 (defun url-http-file-exists-p (url)
1354 (let ((buffer (url-http-head url
)))
1356 (let ((status (url-http-symbol-value-in-buffer 'url-http-response-status
1359 (and (integerp status
)
1360 (>= status
200) (< status
300))
1361 (kill-buffer buffer
))))))
1363 (defalias 'url-http-file-readable-p
'url-http-file-exists-p
)
1365 (defun url-http-head-file-attributes (url &optional id-format
)
1366 (let ((buffer (url-http-head url
)))
1370 nil
;dir / link / normal file
1371 1 ;number of links to file.
1373 nil nil nil
;atime ; mtime ; ctime
1374 (url-http-symbol-value-in-buffer 'url-http-content-length
1376 (eval-when-compile (make-string 10 ?-
))
1377 nil nil nil
) ;whether gid would change ; inode ; device.
1378 (kill-buffer buffer
)))))
1380 (declare-function url-dav-file-attributes
"url-dav" (url &optional id-format
))
1382 (defun url-http-file-attributes (url &optional id-format
)
1383 (if (url-dav-supported-p url
)
1384 (url-dav-file-attributes url id-format
)
1385 (url-http-head-file-attributes url id-format
)))
1387 (defun url-http-options (url)
1388 "Return a property list describing options available for URL.
1389 This list is retrieved using the `OPTIONS' HTTP method.
1391 Property list members:
1394 A list of symbols specifying what HTTP methods the resource
1398 A list of numbers specifying what DAV protocol/schema versions are
1402 A list of supported DASL search types supported (string form)
1405 A list of the units available for use in partial document fetches.
1408 The `Platform For Privacy Protection' description for the resource.
1409 Currently this is just the raw header contents. This is likely to
1410 change once P3P is formally supported by the URL package or
1412 (let* ((url-request-method "OPTIONS")
1413 (url-request-data nil
)
1414 (buffer (url-retrieve-synchronously url
))
1417 (when (and buffer
(= 2 (/ (url-http-symbol-value-in-buffer
1418 'url-http-response-status buffer
0) 100)))
1419 ;; Only parse the options if we got a 2xx response code!
1420 (with-current-buffer buffer
1423 (mail-narrow-to-head)
1425 ;; Figure out what methods are supported.
1426 (when (setq header
(mail-fetch-field "allow"))
1427 (setq options
(plist-put
1429 (mapcar 'intern
(split-string header
"[ ,]+")))))
1432 (when (setq header
(mail-fetch-field "dav"))
1433 (setq options
(plist-put
1436 (mapcar 'string-to-number
1437 (split-string header
"[, ]+"))))))
1440 (when (setq header
(mail-fetch-field "dasl"))
1441 (setq options
(plist-put
1443 (split-string header
"[, ]+"))))
1445 ;; P3P - should get more detailed here. FIXME
1446 (when (setq header
(mail-fetch-field "p3p"))
1447 (setq options
(plist-put options
'p3p header
)))
1449 ;; Check for whether they accept byte-range requests.
1450 (when (setq header
(mail-fetch-field "accept-ranges"))
1451 (setq options
(plist-put
1455 (split-string header
"[, ]+"))))))
1457 (if buffer
(kill-buffer buffer
))
1460 ;; HTTPS. This used to be in url-https.el, but that file collides
1461 ;; with url-http.el on systems with 8-character file names.
1464 (defconst url-https-default-port
443 "Default HTTPS port.")
1465 (defconst url-https-asynchronous-p t
"HTTPS retrievals are asynchronous.")
1467 ;; FIXME what is the point of this alias being an autoload?
1468 ;; Trying to use it will not cause url-http to be loaded,
1469 ;; since the full alias just gets dumped into loaddefs.el.
1471 ;;;###autoload (autoload 'url-default-expander "url-expand")
1473 (defalias 'url-https-expand-file-name
'url-default-expander
)
1475 (defmacro url-https-create-secure-wrapper
(method args
)
1476 `(defun ,(intern (format (if method
"url-https-%s" "url-https") method
)) ,args
1477 ,(format "HTTPS wrapper around `%s' call." (or method
"url-http"))
1478 (,(intern (format (if method
"url-http-%s" "url-http") method
))
1479 ,@(remove '&rest
(remove '&optional
(append args
(if method nil
'(nil 'tls
))))))))
1481 ;;;###autoload (autoload 'url-https "url-http")
1482 (url-https-create-secure-wrapper nil
(url callback cbargs
))
1483 ;;;###autoload (autoload 'url-https-file-exists-p "url-http")
1484 (url-https-create-secure-wrapper file-exists-p
(url))
1485 ;;;###autoload (autoload 'url-https-file-readable-p "url-http")
1486 (url-https-create-secure-wrapper file-readable-p
(url))
1487 ;;;###autoload (autoload 'url-https-file-attributes "url-http")
1488 (url-https-create-secure-wrapper file-attributes
(url &optional id-format
))
1492 ;;; url-http.el ends here