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