1 ;;; url-http.el --- HTTP retrieval routines
3 ;; Copyright (C) 1999, 2001, 2004, 2005, 2006 Free Software Foundation, Inc.
5 ;; Author: Bill Perry <wmperry@gnu.org>
6 ;; Keywords: comm, data, processes
8 ;; This file is part of GNU Emacs.
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 2, or (at your option)
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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
29 (eval-when-compile (require 'cl))
30 (defvar url-http-extra-headers)
31 (defvar url-http-target-url)
39 (autoload 'url-cache-create-filename "url-cache")
41 (defconst url-http-default-port 80 "Default HTTP port.")
42 (defconst url-http-asynchronous-p t "HTTP retrievals are asynchronous.")
43 (defalias 'url-http-expand-file-name 'url-default-expander)
45 (defvar url-http-real-basic-auth-storage nil)
46 (defvar url-http-proxy-basic-auth-storage nil)
48 (defvar url-http-open-connections (make-hash-table :test 'equal
50 "A hash table of all open network connections.")
52 (defvar url-http-version "1.1"
53 "What version of HTTP we advertise, as a string.
54 Valid values are 1.1 and 1.0.
55 This is only useful when debugging the HTTP subsystem.
57 Setting this to 1.0 will tell servers not to send chunked encoding,
58 and other HTTP/1.1 specific features.")
60 (defvar url-http-attempt-keepalives t
61 "Whether to use a single TCP connection multiple times in HTTP.
62 This is only useful when debugging the HTTP subsystem. Setting to
63 nil will explicitly close the connection to the server after every
67 ;; These are all macros so that they are hidden from external sight
68 ;; when the file is byte-compiled.
70 ;; This allows us to expose just the entry points we want.
72 ;; These routines will allow us to implement persistent HTTP
74 (defsubst url-http-debug (&rest args)
76 (let ((proc (get-buffer-process (current-buffer))))
77 ;; The user hit C-g, honor it! Some things can get in an
78 ;; incredibly tight loop (chunked encoding)
81 (set-process-sentinel proc nil)
82 (set-process-filter proc nil)))
83 (error "Transfer interrupted!")))
84 (apply 'url-debug 'http args))
86 (defun url-http-mark-connection-as-busy (host port proc)
87 (url-http-debug "Marking connection as busy: %s:%d %S" host port proc)
88 (puthash (cons host port)
89 (delq proc (gethash (cons host port) url-http-open-connections))
90 url-http-open-connections)
93 (defun url-http-mark-connection-as-free (host port proc)
94 (url-http-debug "Marking connection as free: %s:%d %S" host port proc)
95 (when (memq (process-status proc) '(open run))
96 (set-process-buffer proc nil)
97 (set-process-sentinel proc 'url-http-idle-sentinel)
98 (puthash (cons host port)
99 (cons proc (gethash (cons host port) url-http-open-connections))
100 url-http-open-connections))
103 (defun url-http-find-free-connection (host port)
104 (let ((conns (gethash (cons host port) url-http-open-connections))
106 (while (and conns (not found))
107 (if (not (memq (process-status (car conns)) '(run open)))
109 (url-http-debug "Cleaning up dead process: %s:%d %S"
110 host port (car conns))
111 (url-http-idle-sentinel (car conns) nil))
112 (setq found (car conns))
113 (url-http-debug "Found existing connection: %s:%d %S" host port found))
116 (url-http-debug "Reusing existing connection: %s:%d" host port)
117 (url-http-debug "Contacting host: %s:%d" host port))
118 (url-lazy-message "Contacting host: %s:%d" host port)
119 (url-http-mark-connection-as-busy
122 (let ((buf (generate-new-buffer " *url-http-temp*")))
123 ;; `url-open-stream' needs a buffer in which to do things
124 ;; like authentication. But we use another buffer afterwards.
126 (let ((proc (url-open-stream host buf host port)))
127 ;; url-open-stream might return nil.
128 (when (processp proc)
129 ;; Drop the temp buffer link before killing the buffer.
130 (set-process-buffer proc nil))
132 (kill-buffer buf)))))))
134 ;; Building an HTTP request
135 (defun url-http-user-agent-string ()
136 (if (or (eq url-privacy-level 'paranoid)
137 (and (listp url-privacy-level)
138 (memq 'agent url-privacy-level)))
140 (format "User-Agent: %sURL/%s%s\r\n"
142 (concat url-package-name "/" url-package-version " ")
146 ((and url-os-type url-system-type)
147 (concat " (" url-os-type "; " url-system-type ")"))
148 ((or url-os-type url-system-type)
149 (concat " (" (or url-system-type url-os-type) ")"))
152 (defun url-http-create-request (url &optional ref-url)
153 "Create an HTTP request for URL, referred to by REF-URL."
154 (declare (special proxy-object proxy-info
155 url-http-method url-http-data
156 url-http-extra-headers))
157 (let* ((extra-headers)
159 (no-cache (cdr-safe (assoc "Pragma" url-http-extra-headers)))
160 (proxy-obj (and (boundp 'proxy-object) proxy-object))
161 (proxy-auth (if (or (cdr-safe (assoc "Proxy-Authorization"
162 url-http-extra-headers))
165 (let ((url-basic-auth-storage
166 'url-http-proxy-basic-auth-storage))
167 (url-get-authentication url nil 'any nil))))
168 (real-fname (concat (url-filename (or proxy-obj url))
169 (url-recreate-url-attributes (or proxy-obj url))))
170 (host (url-host (or proxy-obj url)))
171 (auth (if (cdr-safe (assoc "Authorization" url-http-extra-headers))
173 (url-get-authentication (or
174 (and (boundp 'proxy-info)
176 url) nil 'any nil))))
177 (if (equal "" real-fname)
178 (setq real-fname "/"))
179 (setq no-cache (and no-cache (string-match "no-cache" no-cache)))
181 (setq auth (concat "Authorization: " auth "\r\n")))
183 (setq proxy-auth (concat "Proxy-Authorization: " proxy-auth "\r\n")))
185 ;; Protection against stupid values in the referer
186 (if (and ref-url (stringp ref-url) (or (string= ref-url "file:nil")
187 (string= ref-url "")))
190 ;; We do not want to expose the referer if the user is paranoid.
191 (if (or (memq url-privacy-level '(low high paranoid))
192 (and (listp url-privacy-level)
193 (memq 'lastloc url-privacy-level)))
196 ;; url-http-extra-headers contains an assoc-list of
197 ;; header/value pairs that we need to put into the request.
198 (setq extra-headers (mapconcat
200 (concat (car x) ": " (cdr x)))
201 url-http-extra-headers "\r\n"))
202 (if (not (equal extra-headers ""))
203 (setq extra-headers (concat extra-headers "\r\n")))
205 ;; This was done with a call to `format'. Concatting parts has
206 ;; the advantage of keeping the parts of each header together and
207 ;; allows us to elide null lines directly, at the cost of making
208 ;; the layout less clear.
210 ;; We used to concat directly, but if one of the strings happens
211 ;; to being multibyte (even if it only contains pure ASCII) then
212 ;; every string gets converted with `string-MAKE-multibyte' which
213 ;; turns the 127-255 codes into things like latin-1 accented chars
214 ;; (it would work right if it used `string-TO-multibyte' instead).
215 ;; So to avoid the problem we force every string to be unibyte.
217 ;; FIXME: Instead of `string-AS-unibyte' we'd want
218 ;; `string-to-unibyte', so as to properly signal an error if one
219 ;; of the strings contains a multibyte char.
224 (or url-http-method "GET") " "
225 (if proxy-obj (url-recreate-url proxy-obj) real-fname)
226 " HTTP/" url-http-version "\r\n"
227 ;; Version of MIME we speak
228 "MIME-Version: 1.0\r\n"
229 ;; (maybe) Try to keep the connection open
230 "Connection: " (if (or proxy-obj
231 (not url-http-attempt-keepalives))
232 "close" "keep-alive") "\r\n"
233 ;; HTTP extensions we support
234 (if url-extensions-header
236 "Extension: %s\r\n" url-extensions-header))
237 ;; Who we want to talk to
238 (if (/= (url-port (or proxy-obj url))
239 (url-scheme-get-property
240 (url-type (or proxy-obj url)) 'default-port))
242 "Host: %s:%d\r\n" host (url-port (or proxy-obj url)))
243 (format "Host: %s\r\n" host))
245 (if url-personal-mail-address
247 "From: " url-personal-mail-address "\r\n"))
248 ;; Encodings we understand
249 (if url-mime-encoding-string
251 "Accept-encoding: " url-mime-encoding-string "\r\n"))
252 (if url-mime-charset-string
254 "Accept-charset: " url-mime-charset-string "\r\n"))
255 ;; Languages we understand
256 (if url-mime-language-string
258 "Accept-language: " url-mime-language-string "\r\n"))
259 ;; Types we understand
260 "Accept: " (or url-mime-accept-string "*/*") "\r\n"
262 (url-http-user-agent-string)
263 ;; Proxy Authorization
268 (url-cookie-generate-header-lines host real-fname
269 (equal "https" (url-type url)))
271 (if (and (not no-cache)
272 (member url-http-method '("GET" nil)))
273 (let ((tm (url-is-cached (or proxy-obj url))))
275 (concat "If-modified-since: "
276 (url-get-normalized-date tm) "\r\n"))))
279 "Referer: " ref-url "\r\n"))
284 "Content-length: " (number-to-string
285 (length url-http-data))
292 (url-http-debug "Request is: \n%s" request)
296 (defun url-http-clean-headers ()
297 "Remove trailing \r from header lines.
298 This allows us to use `mail-fetch-field', etc."
299 (declare (special url-http-end-of-headers))
300 (goto-char (point-min))
301 (while (re-search-forward "\r$" url-http-end-of-headers t)
304 (defun url-http-handle-authentication (proxy)
305 (declare (special status success url-http-method url-http-data
306 url-callback-function url-callback-arguments))
307 (url-http-debug "Handling %s authentication" (if proxy "proxy" "normal"))
308 (let ((auth (or (mail-fetch-field (if proxy "proxy-authenticate" "www-authenticate"))
311 (url (url-recreate-url url-current-object))
312 (url-basic-auth-storage 'url-http-real-basic-auth-storage)
315 ;; Cheating, but who cares? :)
317 (setq url-basic-auth-storage 'url-http-proxy-basic-auth-storage))
319 (setq auth (url-eat-trailing-space (url-strip-leading-spaces auth)))
320 (if (string-match "[ \t]" auth)
321 (setq type (downcase (substring auth 0 (match-beginning 0))))
322 (setq type (downcase auth)))
324 (if (not (url-auth-registered type))
327 (goto-char (point-max))
328 (insert "<hr>Sorry, but I do not know how to handle " type
329 " authentication. If you'd like to write it,"
330 " send it to " url-bug-address ".<hr>")
332 (let* ((args (url-parse-args (subst-char-in-string ?, ?\; auth)))
333 (auth (url-get-authentication url (cdr-safe (assoc "realm" args))
337 (push (cons (if proxy "Proxy-Authorization" "Authorization") auth)
338 url-http-extra-headers)
339 (let ((url-request-method url-http-method)
340 (url-request-data url-http-data)
341 (url-request-extra-headers url-http-extra-headers))
342 (url-retrieve-internal url url-callback-function
343 url-callback-arguments)))))))
345 (defun url-http-parse-response ()
346 "Parse just the response code."
347 (declare (special url-http-end-of-headers url-http-response-status))
348 (if (not url-http-end-of-headers)
349 (error "Trying to parse HTTP response code in odd buffer: %s" (buffer-name)))
350 (url-http-debug "url-http-parse-response called in (%s)" (buffer-name))
351 (goto-char (point-min))
352 (skip-chars-forward " \t\n") ; Skip any blank crap
353 (skip-chars-forward "HTTP/") ; Skip HTTP Version
354 (read (current-buffer))
355 (setq url-http-response-status (read (current-buffer))))
357 (defun url-http-handle-cookies ()
358 "Handle all set-cookie / set-cookie2 headers in an HTTP response.
359 The buffer must already be narrowed to the headers, so `mail-fetch-field' will
361 (let ((cookies (mail-fetch-field "Set-Cookie" nil nil t))
362 (cookies2 (mail-fetch-field "Set-Cookie2" nil nil t))
363 (url-current-object url-http-target-url))
364 (and cookies (url-http-debug "Found %d Set-Cookie headers" (length cookies)))
365 (and cookies2 (url-http-debug "Found %d Set-Cookie2 headers" (length cookies2)))
367 (url-cookie-handle-set-cookie (pop cookies)))
369 ;;; (url-cookie-handle-set-cookie2 (pop cookies)))
373 (defun url-http-parse-headers ()
374 "Parse and handle HTTP specific headers.
375 Return t if and only if the current buffer is still active and
376 should be shown to the user."
377 ;; The comments after each status code handled are taken from RFC
379 (declare (special url-http-end-of-headers url-http-response-status
380 url-http-method url-http-data url-http-process
381 url-callback-function url-callback-arguments))
383 (url-http-mark-connection-as-free (url-host url-current-object)
384 (url-port url-current-object)
387 (if (or (not (boundp 'url-http-end-of-headers))
388 (not url-http-end-of-headers))
389 (error "Trying to parse headers in odd buffer: %s" (buffer-name)))
390 (goto-char (point-min))
391 (url-http-debug "url-http-parse-headers called in (%s)" (buffer-name))
392 (url-http-parse-response)
393 (mail-narrow-to-head)
394 ;;(narrow-to-region (point-min) url-http-end-of-headers)
395 (let ((connection (mail-fetch-field "Connection")))
397 (string= (downcase connection) "close"))
398 (delete-process url-http-process)))
401 (setq class (/ url-http-response-status 100))
402 (url-http-debug "Parsed HTTP headers: class=%d status=%d" class url-http-response-status)
403 (url-http-handle-cookies)
406 ;; Classes of response codes
408 ;; 5xx = Server Error
409 ;; 4xx = Client Error
412 ;; 1xx = Informational
413 (1 ; Information messages
414 ;; 100 = Continue with request
415 ;; 101 = Switching protocols
416 ;; 102 = Processing (Added by DAV)
417 (url-mark-buffer-as-dead (current-buffer))
418 (error "HTTP responses in class 1xx not supported (%d)" url-http-response-status))
423 ;; 203 Non-authoritative information
426 ;; 206 Partial content
427 ;; 207 Multi-status (Added by DAV)
428 (case url-http-response-status
430 ;; No new data, just stay at the same document
431 (url-mark-buffer-as-dead (current-buffer))
434 ;; Generic success for all others. Store in the cache, and
435 ;; mark it as successful.
437 (if (and url-automatic-caching (equal url-http-method "GET"))
438 (url-store-in-cache (current-buffer)))
441 ;; 300 Multiple choices
442 ;; 301 Moved permanently
447 ;; 307 Temporary redirect
448 (let ((redirect-uri (or (mail-fetch-field "Location")
449 (mail-fetch-field "URI"))))
450 (case url-http-response-status
452 ;; Quoth the spec (section 10.3.1)
453 ;; -------------------------------
454 ;; The requested resource corresponds to any one of a set of
455 ;; representations, each with its own specific location and
456 ;; agent-driven negotiation information is being provided so
457 ;; that the user can select a preferred representation and
458 ;; redirect its request to that location.
460 ;; If the server has a preferred choice of representation, it
461 ;; SHOULD include the specific URI for that representation in
462 ;; the Location field; user agents MAY use the Location field
463 ;; value for automatic redirection.
464 ;; -------------------------------
465 ;; We do not support agent-driven negotiation, so we just
466 ;; redirect to the preferred URI if one is provided.
469 ;; If the 301|302 status code is received in response to a
470 ;; request other than GET or HEAD, the user agent MUST NOT
471 ;; automatically redirect the request unless it can be
472 ;; confirmed by the user, since this might change the
473 ;; conditions under which the request was issued.
474 (if (member url-http-method '("HEAD" "GET"))
475 ;; Automatic redirection is ok
477 ;; It is just too big of a pain in the ass to get this
478 ;; prompt all the time. We will just silently lose our
479 ;; data and convert to a GET method.
480 (url-http-debug "Converting `%s' request to `GET' because of REDIRECT(%d)"
481 url-http-method url-http-response-status)
482 (setq url-http-method "GET"
485 ;; The response to the request can be found under a different
486 ;; URI and SHOULD be retrieved using a GET method on that
488 (setq url-http-method "GET"
491 ;; The 304 response MUST NOT contain a message-body.
492 (url-http-debug "Extracting document from cache... (%s)"
493 (url-cache-create-filename (url-view-url t)))
494 (url-cache-extract (url-cache-create-filename (url-view-url t)))
495 (setq redirect-uri nil
498 ;; The requested resource MUST be accessed through the
499 ;; proxy given by the Location field. The Location field
500 ;; gives the URI of the proxy. The recipient is expected
501 ;; to repeat this single request via the proxy. 305
502 ;; responses MUST only be generated by origin servers.
503 (error "Redirection thru a proxy server not supported: %s"
506 ;; Treat everything like '300'
509 ;; Clean off any whitespace and/or <...> cruft.
510 (if (string-match "\\([^ \t]+\\)[ \t]" redirect-uri)
511 (setq redirect-uri (match-string 1 redirect-uri)))
512 (if (string-match "^<\\(.*\\)>$" redirect-uri)
513 (setq redirect-uri (match-string 1 redirect-uri)))
515 ;; Some stupid sites (like sourceforge) send a
516 ;; non-fully-qualified URL (ie: /), which royally confuses
518 (if (not (string-match url-nonrelative-link redirect-uri))
519 ;; Be careful to use the real target URL, otherwise we may
520 ;; compute the redirection relative to the URL of the proxy.
522 (url-expand-file-name redirect-uri url-http-target-url)))
523 (let ((url-request-method url-http-method)
524 (url-request-data url-http-data)
525 (url-request-extra-headers url-http-extra-headers))
526 ;; Remember that the request was redirected.
527 (setf (car url-callback-arguments)
528 (nconc (list :redirect redirect-uri)
529 (car url-callback-arguments)))
530 ;; Put in the current buffer a forwarding pointer to the new
531 ;; destination buffer.
532 ;; FIXME: This is a hack to fix url-retrieve-synchronously
533 ;; without changing the API. Instead url-retrieve should
534 ;; either simply not return the "destination" buffer, or it
535 ;; should take an optional `dest-buf' argument.
536 (set (make-local-variable 'url-redirect-buffer)
537 (url-retrieve-internal
538 redirect-uri url-callback-function
539 url-callback-arguments))
540 (url-mark-buffer-as-dead (current-buffer))))))
544 ;; 402 Payment required
547 ;; 405 Method not allowed
548 ;; 406 Not acceptable
549 ;; 407 Proxy authentication required
550 ;; 408 Request time-out
553 ;; 411 Length required
554 ;; 412 Precondition failed
555 ;; 413 Request entity too large
556 ;; 414 Request-URI too large
557 ;; 415 Unsupported media type
558 ;; 416 Requested range not satisfiable
559 ;; 417 Expectation failed
560 ;; 422 Unprocessable Entity (Added by DAV)
562 ;; 424 Failed Dependency
563 (case url-http-response-status
565 ;; The request requires user authentication. The response
566 ;; MUST include a WWW-Authenticate header field containing a
567 ;; challenge applicable to the requested resource. The
568 ;; client MAY repeat the request with a suitable
569 ;; Authorization header field.
570 (url-http-handle-authentication nil))
572 ;; This code is reserved for future use
573 (url-mark-buffer-as-dead (current-buffer))
574 (error "Somebody wants you to give them money"))
576 ;; The server understood the request, but is refusing to
577 ;; fulfill it. Authorization will not help and the request
578 ;; SHOULD NOT be repeated.
584 ;; The method specified in the Request-Line is not allowed
585 ;; for the resource identified by the Request-URI. The
586 ;; response MUST include an Allow header containing a list of
587 ;; valid methods for the requested resource.
590 ;; The resource identified by the request is only capable of
591 ;; generating response entities which have content
592 ;; characteristics nota cceptable according to the accept
593 ;; headers sent in the request.
596 ;; This code is similar to 401 (Unauthorized), but indicates
597 ;; that the client must first authenticate itself with the
598 ;; proxy. The proxy MUST return a Proxy-Authenticate header
599 ;; field containing a challenge applicable to the proxy for
600 ;; the requested resource.
601 (url-http-handle-authentication t))
603 ;; The client did not produce a request within the time that
604 ;; the server was prepared to wait. The client MAY repeat
605 ;; the request without modifications at any later time.
608 ;; The request could not be completed due to a conflict with
609 ;; the current state of the resource. This code is only
610 ;; allowed in situations where it is expected that the user
611 ;; mioght be able to resolve the conflict and resubmit the
612 ;; request. The response body SHOULD include enough
613 ;; information for the user to recognize the source of the
617 ;; The requested resource is no longer available at the
618 ;; server and no forwarding address is known.
621 ;; The server refuses to accept the request without a defined
622 ;; Content-Length. The client MAY repeat the request if it
623 ;; adds a valid Content-Length header field containing the
624 ;; length of the message-body in the request message.
626 ;; NOTE - this will never happen because
627 ;; `url-http-create-request' automatically calculates the
631 ;; The precondition given in one or more of the
632 ;; request-header fields evaluated to false when it was
633 ;; tested on the server.
636 ;; The server is refusing to process a request because the
637 ;; request entity|URI is larger than the server is willing or
641 ;; The server is refusing to service the request because the
642 ;; entity of the request is in a format not supported by the
643 ;; requested resource for the requested method.
646 ;; A server SHOULD return a response with this status code if
647 ;; a request included a Range request-header field, and none
648 ;; of the range-specifier values in this field overlap the
649 ;; current extent of the selected resource, and the request
650 ;; did not include an If-Range request-header field.
653 ;; The expectation given in an Expect request-header field
654 ;; could not be met by this server, or, if the server is a
655 ;; proxy, the server has unambiguous evidence that the
656 ;; request could not be met by the next-hop server.
659 ;; The request could not be understood by the server due to
660 ;; malformed syntax. The client SHOULD NOT repeat the
661 ;; request without modifications.
663 ;; Tell the callback that an error occurred, and what the
666 (setf (car url-callback-arguments)
667 (nconc (list :error (list 'error 'http url-http-response-status))
668 (car url-callback-arguments)))))
670 ;; 500 Internal server error
671 ;; 501 Not implemented
673 ;; 503 Service unavailable
674 ;; 504 Gateway time-out
675 ;; 505 HTTP version not supported
676 ;; 507 Insufficient storage
678 (case url-http-response-status
680 ;; The server does not support the functionality required to
681 ;; fulfill the request.
684 ;; The server, while acting as a gateway or proxy, received
685 ;; an invalid response from the upstream server it accessed
686 ;; in attempting to fulfill the request.
689 ;; The server is currently unable to handle the request due
690 ;; to a temporary overloading or maintenance of the server.
691 ;; The implication is that this is a temporary condition
692 ;; which will be alleviated after some delay. If known, the
693 ;; length of the delay MAY be indicated in a Retry-After
694 ;; header. If no Retry-After is given, the client SHOULD
695 ;; handle the response as it would for a 500 response.
698 ;; The server, while acting as a gateway or proxy, did not
699 ;; receive a timely response from the upstream server
700 ;; specified by the URI (e.g. HTTP, FTP, LDAP) or some other
701 ;; auxiliary server (e.g. DNS) it needed to access in
702 ;; attempting to complete the request.
705 ;; The server does not support, or refuses to support, the
706 ;; HTTP protocol version that was used in the request
710 ;; The method could not be performed on the resource
711 ;; because the server is unable to store the representation
712 ;; needed to successfully complete the request. This
713 ;; condition is considered to be temporary. If the request
714 ;; which received this status code was the result of a user
715 ;; action, the request MUST NOT be repeated until it is
716 ;; requested by a separate user action.
718 ;; Tell the callback that an error occurred, and what the
721 (setf (car url-callback-arguments)
722 (nconc (list :error (list 'error 'http url-http-response-status))
723 (car url-callback-arguments)))))
725 (error "Unknown class of HTTP response code: %d (%d)"
726 class url-http-response-status)))
728 (url-mark-buffer-as-dead (current-buffer)))
729 (url-http-debug "Finished parsing HTTP headers: %S" success)
734 (defun url-http-activate-callback ()
735 "Activate callback specified when this buffer was created."
736 (declare (special url-http-process
737 url-callback-function
738 url-callback-arguments))
739 (url-http-mark-connection-as-free (url-host url-current-object)
740 (url-port url-current-object)
742 (url-http-debug "Activating callback in buffer (%s)" (buffer-name))
743 (apply url-callback-function url-callback-arguments))
747 ;; These unfortunately cannot be macros... please ignore them!
748 (defun url-http-idle-sentinel (proc why)
749 "Remove this (now defunct) process PROC from the list of open connections."
750 (maphash (lambda (key val)
752 (puthash key (delq proc val) url-http-open-connections)))
753 url-http-open-connections))
755 (defun url-http-end-of-document-sentinel (proc why)
756 ;; Sentinel used for old HTTP/0.9 or connections we know are going
757 ;; to die as the 'end of document' notifier.
758 (url-http-debug "url-http-end-of-document-sentinel in buffer (%s)"
759 (process-buffer proc))
760 (url-http-idle-sentinel proc why)
761 (with-current-buffer (process-buffer proc)
762 (goto-char (point-min))
763 (if (not (looking-at "HTTP/"))
764 ;; HTTP/0.9 just gets passed back no matter what
765 (url-http-activate-callback)
766 (if (url-http-parse-headers)
767 (url-http-activate-callback)))))
769 (defun url-http-simple-after-change-function (st nd length)
770 ;; Function used when we do NOT know how long the document is going to be
771 ;; Just _very_ simple 'downloaded %d' type of info.
772 (declare (special url-http-end-of-headers))
773 (url-lazy-message "Reading %s..." (url-pretty-length nd)))
775 (defun url-http-content-length-after-change-function (st nd length)
776 "Function used when we DO know how long the document is going to be.
777 More sophisticated percentage downloaded, etc.
778 Also does minimal parsing of HTTP headers and will actually cause
779 the callback to be triggered."
780 (declare (special url-current-object
781 url-http-end-of-headers
782 url-http-content-length
783 url-http-content-type
785 (if url-http-content-type
786 (url-display-percentage
787 "Reading [%s]... %s of %s (%d%%)"
788 (url-percentage (- nd url-http-end-of-headers)
789 url-http-content-length)
790 url-http-content-type
791 (url-pretty-length (- nd url-http-end-of-headers))
792 (url-pretty-length url-http-content-length)
793 (url-percentage (- nd url-http-end-of-headers)
794 url-http-content-length))
795 (url-display-percentage
796 "Reading... %s of %s (%d%%)"
797 (url-percentage (- nd url-http-end-of-headers)
798 url-http-content-length)
799 (url-pretty-length (- nd url-http-end-of-headers))
800 (url-pretty-length url-http-content-length)
801 (url-percentage (- nd url-http-end-of-headers)
802 url-http-content-length)))
804 (if (> (- nd url-http-end-of-headers) url-http-content-length)
806 ;; Found the end of the document! Wheee!
807 (url-display-percentage nil nil)
808 (message "Reading... done.")
809 (if (url-http-parse-headers)
810 (url-http-activate-callback)))))
812 (defun url-http-chunked-encoding-after-change-function (st nd length)
813 "Function used when dealing with 'chunked' encoding.
814 Cannot give a sophisticated percentage, but we need a different
815 function to look for the special 0-length chunk that signifies
816 the end of the document."
817 (declare (special url-current-object
818 url-http-end-of-headers
819 url-http-content-type
820 url-http-chunked-length
821 url-http-chunked-counter
822 url-http-process url-http-chunked-start))
825 (let ((read-next-chunk t)
828 (no-initial-crlf nil))
829 ;; We need to loop thru looking for more chunks even within
830 ;; one after-change-function call.
831 (while read-next-chunk
832 (setq no-initial-crlf (= 0 url-http-chunked-counter))
833 (if url-http-content-type
834 (url-display-percentage nil
835 "Reading [%s]... chunk #%d"
836 url-http-content-type url-http-chunked-counter)
837 (url-display-percentage nil
838 "Reading... chunk #%d"
839 url-http-chunked-counter))
840 (url-http-debug "Reading chunk %d (%d %d %d)"
841 url-http-chunked-counter st nd length)
842 (setq regexp (if no-initial-crlf
843 "\\([0-9a-z]+\\).*\r?\n"
844 "\r?\n\\([0-9a-z]+\\).*\r?\n"))
846 (if url-http-chunked-start
847 ;; We know how long the chunk is supposed to be, skip over
848 ;; leading crap if possible.
849 (if (> nd (+ url-http-chunked-start url-http-chunked-length))
851 (url-http-debug "Got to the end of chunk #%d!"
852 url-http-chunked-counter)
853 (goto-char (+ url-http-chunked-start
854 url-http-chunked-length)))
855 (url-http-debug "Still need %d bytes to hit end of chunk"
856 (- (+ url-http-chunked-start
857 url-http-chunked-length)
859 (setq read-next-chunk nil)))
860 (if (not read-next-chunk)
861 (url-http-debug "Still spinning for next chunk...")
862 (if no-initial-crlf (skip-chars-forward "\r\n"))
863 (if (not (looking-at regexp))
865 ;; Must not have received the entirety of the chunk header,
866 ;; need to spin some more.
867 (url-http-debug "Did not see start of chunk @ %d!" (point))
868 (setq read-next-chunk nil))
869 (add-text-properties (match-beginning 0) (match-end 0)
875 (setq url-http-chunked-length (string-to-number (buffer-substring
879 url-http-chunked-counter (1+ url-http-chunked-counter)
880 url-http-chunked-start (set-marker
881 (or url-http-chunked-start
884 ; (if (not url-http-debug)
885 (delete-region (match-beginning 0) (match-end 0));)
886 (url-http-debug "Saw start of chunk %d (length=%d, start=%d"
887 url-http-chunked-counter url-http-chunked-length
888 (marker-position url-http-chunked-start))
889 (if (= 0 url-http-chunked-length)
891 ;; Found the end of the document! Wheee!
892 (url-http-debug "Saw end of stream chunk!")
893 (setq read-next-chunk nil)
894 (url-display-percentage nil nil)
895 (goto-char (match-end 1))
896 (if (re-search-forward "^\r*$" nil t)
897 (url-http-debug "Saw end of trailers..."))
898 (if (url-http-parse-headers)
899 (url-http-activate-callback))))))))))
901 (defun url-http-wait-for-headers-change-function (st nd length)
902 ;; This will wait for the headers to arrive and then splice in the
903 ;; next appropriate after-change-function, etc.
904 (declare (special url-current-object
905 url-http-end-of-headers
906 url-http-content-type
907 url-http-content-length
908 url-http-transfer-encoding
909 url-callback-function
910 url-callback-arguments
913 url-http-after-change-function
914 url-http-response-status))
915 (url-http-debug "url-http-wait-for-headers-change-function (%s)"
918 (let ((end-of-headers nil)
920 (content-length nil))
921 (goto-char (point-min))
922 (if (not (looking-at "^HTTP/[1-9]\\.[0-9]"))
923 ;; Not HTTP/x.y data, must be 0.9
924 ;; God, I wish this could die.
925 (setq end-of-headers t
926 url-http-end-of-headers 0
928 (if (re-search-forward "^\r*$" nil t)
929 ;; Saw the end of the headers
931 (url-http-debug "Saw end of headers... (%s)" (buffer-name))
932 (setq url-http-end-of-headers (set-marker (make-marker)
935 (url-http-clean-headers))))
937 (if (not end-of-headers)
938 ;; Haven't seen the end of the headers yet, need to wait
939 ;; for more data to arrive.
942 (message "HTTP/0.9 How I hate thee!")
944 (url-http-parse-response)
945 (mail-narrow-to-head)
946 ;;(narrow-to-region (point-min) url-http-end-of-headers)
947 (setq url-http-transfer-encoding (mail-fetch-field
949 url-http-content-type (mail-fetch-field "content-type"))
950 (if (mail-fetch-field "content-length")
951 (setq url-http-content-length
952 (string-to-number (mail-fetch-field "content-length"))))
954 (if url-http-transfer-encoding
955 (setq url-http-transfer-encoding
956 (downcase url-http-transfer-encoding)))
959 ((or (= url-http-response-status 204)
960 (= url-http-response-status 205))
961 (url-http-debug "%d response must have headers only (%s)."
962 url-http-response-status (buffer-name))
963 (if (url-http-parse-headers)
964 (url-http-activate-callback)))
965 ((string= "HEAD" url-http-method)
966 ;; A HEAD request is _ALWAYS_ terminated by the header
967 ;; information, regardless of any entity headers,
968 ;; according to section 4.4 of the HTTP/1.1 draft.
969 (url-http-debug "HEAD request must have headers only (%s)."
971 (if (url-http-parse-headers)
972 (url-http-activate-callback)))
973 ((string= "CONNECT" url-http-method)
974 ;; A CONNECT request is finished, but we cannot stick this
975 ;; back on the free connectin list
976 (url-http-debug "CONNECT request must have headers only.")
977 (if (url-http-parse-headers)
978 (url-http-activate-callback)))
979 ((equal url-http-response-status 304)
980 ;; Only allowed to have a header section. We have to handle
981 ;; this here instead of in url-http-parse-headers because if
982 ;; you have a cached copy of something without a known
983 ;; content-length, and try to retrieve it from the cache, we'd
984 ;; fall into the 'being dumb' section and wait for the
985 ;; connection to terminate, which means we'd wait for 10
986 ;; seconds for the keep-alives to time out on some servers.
987 (if (url-http-parse-headers)
988 (url-http-activate-callback)))
990 ;; HTTP/0.9 always signaled end-of-connection by closing the
993 "Saw HTTP/0.9 response, connection closed means end of document.")
994 (setq url-http-after-change-function
995 'url-http-simple-after-change-function))
996 ((equal url-http-transfer-encoding "chunked")
997 (url-http-debug "Saw chunked encoding.")
998 (setq url-http-after-change-function
999 'url-http-chunked-encoding-after-change-function)
1000 (if (> nd url-http-end-of-headers)
1003 "Calling initial chunked-encoding for extra data at end of headers")
1004 (url-http-chunked-encoding-after-change-function
1005 (marker-position url-http-end-of-headers) nd
1006 (- nd url-http-end-of-headers)))))
1007 ((integerp url-http-content-length)
1009 "Got a content-length, being smart about document end.")
1010 (setq url-http-after-change-function
1011 'url-http-content-length-after-change-function)
1013 ((= 0 url-http-content-length)
1014 ;; We got a NULL body! Activate the callback
1017 "Got 0-length content-length, activating callback immediately.")
1018 (if (url-http-parse-headers)
1019 (url-http-activate-callback)))
1020 ((> nd url-http-end-of-headers)
1021 ;; Have some leftover data
1022 (url-http-debug "Calling initial content-length for extra data at end of headers")
1023 (url-http-content-length-after-change-function
1024 (marker-position url-http-end-of-headers)
1026 (- nd url-http-end-of-headers)))
1030 (url-http-debug "No content-length, being dumb.")
1031 (setq url-http-after-change-function
1032 'url-http-simple-after-change-function)))))
1033 ;; We are still at the beginning of the buffer... must just be
1034 ;; waiting for a response.
1035 (url-http-debug "Spinning waiting for headers..."))
1036 (goto-char (point-max)))
1039 (defun url-http (url callback cbargs)
1040 "Retrieve URL via HTTP asynchronously.
1041 URL must be a parsed URL. See `url-generic-parse-url' for details.
1042 When retrieval is completed, the function CALLBACK is executed with
1043 CBARGS as the arguments."
1044 (check-type url vector "Need a pre-parsed URL.")
1045 (declare (special url-current-object
1046 url-http-end-of-headers
1047 url-http-content-type
1048 url-http-content-length
1049 url-http-transfer-encoding
1050 url-http-after-change-function
1051 url-callback-function
1052 url-callback-arguments
1054 url-http-extra-headers
1056 url-http-chunked-length
1057 url-http-chunked-start
1058 url-http-chunked-counter
1060 (let ((connection (url-http-find-free-connection (url-host url)
1062 (buffer (generate-new-buffer (format " *http %s:%d*"
1065 (if (not connection)
1066 ;; Failed to open the connection for some reason
1068 (kill-buffer buffer)
1070 (error "Could not create connection to %s:%d" (url-host url)
1072 (with-current-buffer buffer
1073 (mm-disable-multibyte)
1074 (setq url-current-object url
1075 mode-line-format "%b [%s]")
1077 (dolist (var '(url-http-end-of-headers
1078 url-http-content-type
1079 url-http-content-length
1080 url-http-transfer-encoding
1081 url-http-after-change-function
1082 url-http-response-status
1083 url-http-chunked-length
1084 url-http-chunked-counter
1085 url-http-chunked-start
1086 url-callback-function
1087 url-callback-arguments
1090 url-http-extra-headers
1092 url-http-target-url))
1093 (set (make-local-variable var) nil))
1095 (setq url-http-method (or url-request-method "GET")
1096 url-http-extra-headers url-request-extra-headers
1097 url-http-data url-request-data
1098 url-http-process connection
1099 url-http-chunked-length nil
1100 url-http-chunked-start nil
1101 url-http-chunked-counter 0
1102 url-callback-function callback
1103 url-callback-arguments cbargs
1104 url-http-after-change-function 'url-http-wait-for-headers-change-function
1105 url-http-target-url (if (boundp 'proxy-object)
1107 url-current-object))
1109 (set-process-buffer connection buffer)
1110 (set-process-filter connection 'url-http-generic-filter)
1111 (let ((status (process-status connection)))
1113 ((eq status 'connect)
1114 ;; Asynchronous connection
1115 (set-process-sentinel connection 'url-http-async-sentinel))
1116 ((eq status 'failed)
1117 ;; Asynchronous connection failed
1118 (error "Could not create connection to %s:%d" (url-host url)
1121 (set-process-sentinel connection 'url-http-end-of-document-sentinel)
1122 (process-send-string connection (url-http-create-request url)))))))
1125 (defun url-http-async-sentinel (proc why)
1126 (declare (special url-callback-arguments))
1127 ;; We are performing an asynchronous connection, and a status change
1129 (with-current-buffer (process-buffer proc)
1131 ((string= (substring why 0 4) "open")
1132 (set-process-sentinel proc 'url-http-end-of-document-sentinel)
1133 (process-send-string proc (url-http-create-request url-current-object)))
1135 (setf (car url-callback-arguments)
1136 (nconc (list :error (list 'error 'connection-failed why
1137 :host (url-host url-current-object)
1138 :service (url-port url-current-object)))
1139 (car url-callback-arguments)))
1140 (url-http-activate-callback)))))
1142 ;; Since Emacs 19/20 does not allow you to change the
1143 ;; `after-change-functions' hook in the midst of running them, we fake
1144 ;; an after change by hooking into the process filter and inserting
1145 ;; the data ourselves. This is slightly less efficient, but there
1146 ;; were tons of weird ways the after-change code was biting us in the
1148 (defun url-http-generic-filter (proc data)
1149 ;; Sometimes we get a zero-length data chunk after the process has
1150 ;; been changed to 'free', which means it has no buffer associated
1151 ;; with it. Do nothing if there is no buffer, or 0 length data.
1152 (declare (special url-http-after-change-function))
1153 (and (process-buffer proc)
1154 (/= (length data) 0)
1155 (with-current-buffer (process-buffer proc)
1156 (url-http-debug "Calling after change function `%s' for `%S'" url-http-after-change-function proc)
1157 (funcall url-http-after-change-function
1160 (goto-char (point-max))
1165 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1166 ;;; file-name-handler stuff from here on out
1167 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1168 (defalias 'url-http-symbol-value-in-buffer
1169 (if (fboundp 'symbol-value-in-buffer)
1170 'symbol-value-in-buffer
1171 (lambda (symbol buffer &optional unbound-value)
1172 "Return the value of SYMBOL in BUFFER, or UNBOUND-VALUE if it is unbound."
1173 (with-current-buffer buffer
1174 (if (not (boundp symbol))
1176 (symbol-value symbol))))))
1178 (defun url-http-head (url)
1179 (let ((url-request-method "HEAD")
1180 (url-request-data nil))
1181 (url-retrieve-synchronously url)))
1184 (defun url-http-file-exists-p (url)
1187 (buffer (url-http-head url)))
1190 (setq status (url-http-symbol-value-in-buffer 'url-http-response-status
1192 exists (and (integerp status)
1193 (>= status 200) (< status 300)))
1194 (kill-buffer buffer))
1198 (defalias 'url-http-file-readable-p 'url-http-file-exists-p)
1200 (defun url-http-head-file-attributes (url &optional id-format)
1201 (let ((buffer (url-http-head url)))
1205 nil ;dir / link / normal file
1206 1 ;number of links to file.
1208 nil nil nil ;atime ; mtime ; ctime
1209 (url-http-symbol-value-in-buffer 'url-http-content-length
1211 (eval-when-compile (make-string 10 ?-))
1212 nil nil nil) ;whether gid would change ; inode ; device.
1213 (kill-buffer buffer)))))
1216 (defun url-http-file-attributes (url &optional id-format)
1217 (if (url-dav-supported-p url)
1218 (url-dav-file-attributes url id-format)
1219 (url-http-head-file-attributes url id-format)))
1222 (defun url-http-options (url)
1223 "Return a property list describing options available for URL.
1224 This list is retrieved using the `OPTIONS' HTTP method.
1226 Property list members:
1229 A list of symbols specifying what HTTP methods the resource
1233 A list of numbers specifying what DAV protocol/schema versions are
1237 A list of supported DASL search types supported (string form)
1240 A list of the units available for use in partial document fetches.
1243 The `Platform For Privacy Protection' description for the resource.
1244 Currently this is just the raw header contents. This is likely to
1245 change once P3P is formally supported by the URL package or
1247 (let* ((url-request-method "OPTIONS")
1248 (url-request-data nil)
1249 (buffer (url-retrieve-synchronously url))
1252 (when (and buffer (= 2 (/ (url-http-symbol-value-in-buffer
1253 'url-http-response-status buffer 0) 100)))
1254 ;; Only parse the options if we got a 2xx response code!
1255 (with-current-buffer buffer
1258 (mail-narrow-to-head)
1260 ;; Figure out what methods are supported.
1261 (when (setq header (mail-fetch-field "allow"))
1262 (setq options (plist-put
1264 (mapcar 'intern (split-string header "[ ,]+")))))
1267 (when (setq header (mail-fetch-field "dav"))
1268 (setq options (plist-put
1271 (mapcar 'string-to-number
1272 (split-string header "[, ]+"))))))
1275 (when (setq header (mail-fetch-field "dasl"))
1276 (setq options (plist-put
1278 (split-string header "[, ]+"))))
1280 ;; P3P - should get more detailed here. FIXME
1281 (when (setq header (mail-fetch-field "p3p"))
1282 (setq options (plist-put options 'p3p header)))
1284 ;; Check for whether they accept byte-range requests.
1285 (when (setq header (mail-fetch-field "accept-ranges"))
1286 (setq options (plist-put
1290 (split-string header "[, ]+"))))))
1292 (if buffer (kill-buffer buffer))
1295 ;; HTTPS. This used to be in url-https.el, but that file collides
1296 ;; with url-http.el on systems with 8-character file names.
1300 (defconst url-https-default-port 443 "Default HTTPS port.")
1302 (defconst url-https-asynchronous-p t "HTTPS retrievals are asynchronous.")
1304 (defalias 'url-https-expand-file-name 'url-http-expand-file-name)
1306 (defmacro url-https-create-secure-wrapper (method args)
1307 `(defun ,(intern (format (if method "url-https-%s" "url-https") method)) ,args
1308 ,(format "HTTPS wrapper around `%s' call." (or method "url-http"))
1309 (let ((url-gateway-method 'tls))
1310 (,(intern (format (if method "url-http-%s" "url-http") method))
1311 ,@(remove '&rest (remove '&optional args))))))
1313 ;;;###autoload (autoload 'url-https "url-http")
1314 (url-https-create-secure-wrapper nil (url callback cbargs))
1315 ;;;###autoload (autoload 'url-https-file-exists-p "url-http")
1316 (url-https-create-secure-wrapper file-exists-p (url))
1317 ;;;###autoload (autoload 'url-https-file-readable-p "url-http")
1318 (url-https-create-secure-wrapper file-readable-p (url))
1319 ;;;###autoload (autoload 'url-https-file-attributes "url-http")
1320 (url-https-create-secure-wrapper file-attributes (url &optional id-format))
1324 ;; arch-tag: ba7c59ae-c0f4-4a31-9617-d85f221732ee
1325 ;;; url-http.el ends here