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