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