Mercurial > emacs
annotate lisp/url/url-vars.el @ 93056:93ab884a75dd
*** empty log message ***
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Wed, 19 Mar 2008 01:52:49 +0000 |
parents | 107ccd98fa12 |
children | 1e3a407766b9 |
rev | line source |
---|---|
54695 | 1 ;;; url-vars.el --- Variables for Uniform Resource Locator tool |
57614 | 2 |
64748
875dcc490074
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64084
diff
changeset
|
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2001, 2004, |
79720 | 4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
57614 | 5 |
54695 | 6 ;; Keywords: comm, data, processes, hypermedia |
7 | |
57614 | 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 | |
78222
8932997d0b62
Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents:
77178
diff
changeset
|
12 ;; the Free Software Foundation; either version 3, or (at your option) |
57614 | 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 | |
64084 | 22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 ;; Boston, MA 02110-1301, USA. | |
57614 | 24 |
25 ;;; Code: | |
54695 | 26 |
27 (require 'mm-util) | |
28 | |
54770
e8824c4f5f7e
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-196
Miles Bader <miles@gnu.org>
parents:
54699
diff
changeset
|
29 (defconst url-version "Emacs" |
54695 | 30 "Version number of URL package.") |
31 | |
32 (defgroup url nil | |
63993
ef9f3b48923d
(url, url-file, url-cache, url-mime, url-hairy): Finish `defgroup' description
Juanma Barranquero <lekktu@gmail.com>
parents:
63619
diff
changeset
|
33 "Uniform Resource Locator tool." |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
57614
diff
changeset
|
34 :version "22.1" |
54695 | 35 :group 'hypermedia) |
36 | |
37 (defgroup url-file nil | |
63993
ef9f3b48923d
(url, url-file, url-cache, url-mime, url-hairy): Finish `defgroup' description
Juanma Barranquero <lekktu@gmail.com>
parents:
63619
diff
changeset
|
38 "URL storage." |
54695 | 39 :prefix "url-" |
40 :group 'url) | |
41 | |
42 (defgroup url-cache nil | |
63993
ef9f3b48923d
(url, url-file, url-cache, url-mime, url-hairy): Finish `defgroup' description
Juanma Barranquero <lekktu@gmail.com>
parents:
63619
diff
changeset
|
43 "URL cache." |
54695 | 44 :prefix "url-" |
45 :prefix "url-cache-" | |
46 :group 'url) | |
47 | |
48 (defgroup url-mime nil | |
63993
ef9f3b48923d
(url, url-file, url-cache, url-mime, url-hairy): Finish `defgroup' description
Juanma Barranquero <lekktu@gmail.com>
parents:
63619
diff
changeset
|
49 "MIME options of URL." |
54695 | 50 :prefix "url-" |
51 :group 'url) | |
52 | |
53 (defgroup url-hairy nil | |
63993
ef9f3b48923d
(url, url-file, url-cache, url-mime, url-hairy): Finish `defgroup' description
Juanma Barranquero <lekktu@gmail.com>
parents:
63619
diff
changeset
|
54 "Hairy options of URL." |
54695 | 55 :prefix "url-" |
56 :group 'url) | |
57 | |
58 | |
59 (defvar url-current-object nil | |
60 "A parsed representation of the current url.") | |
61 | |
62 (defvar url-current-mime-headers nil | |
63 "A parsed representation of the MIME headers for the current url.") | |
64 | |
84930
41b075c0a949
(top): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78222
diff
changeset
|
65 (mapc 'make-variable-buffer-local |
41b075c0a949
(top): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78222
diff
changeset
|
66 '( |
41b075c0a949
(top): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78222
diff
changeset
|
67 url-current-object |
41b075c0a949
(top): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78222
diff
changeset
|
68 url-current-referer |
41b075c0a949
(top): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78222
diff
changeset
|
69 url-current-mime-headers |
41b075c0a949
(top): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78222
diff
changeset
|
70 )) |
54695 | 71 |
72 (defcustom url-honor-refresh-requests t | |
73 "*Whether to do automatic page reloads. | |
74 These are done at the request of the document author or the server via | |
75 the `Refresh' header in an HTTP response. If nil, no refresh | |
76 requests will be honored. If t, all refresh requests will be honored. | |
77 If non-nil and not t, the user will be asked for each refresh | |
78 request." | |
79 :type '(choice (const :tag "off" nil) | |
80 (const :tag "on" t) | |
81 (const :tag "ask" 'ask)) | |
82 :group 'url-hairy) | |
83 | |
84 (defcustom url-automatic-caching nil | |
85 "*If non-nil, all documents will be automatically cached to the local disk." | |
86 :type 'boolean | |
87 :group 'url-cache) | |
88 | |
89 ;; Fixme: sanitize this. | |
90 (defcustom url-cache-expired | |
91 (lambda (t1 t2) (>= (- (car t2) (car t1)) 5)) | |
92 "*A function determining if a cached item has expired. | |
93 It takes two times (numbers) as its arguments, and returns non-nil if | |
94 the second time is 'too old' when compared to the first time." | |
95 :type 'function | |
96 :group 'url-cache) | |
97 | |
54804
2f011866477f
(cl): Don't require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54770
diff
changeset
|
98 (defconst url-bug-address "bug-gnu-emacs@gnu.org" |
54695 | 99 "Where to send bug reports.") |
100 | |
101 (defcustom url-personal-mail-address nil | |
102 "*Your full email address. | |
103 This is what is sent to HTTP servers as the FROM field in an HTTP | |
104 request." | |
105 :type '(choice (const :tag "Unspecified" nil) string) | |
106 :group 'url) | |
107 | |
108 (defcustom url-directory-index-file "index.html" | |
109 "*The filename to look for when indexing a directory. | |
110 If this file exists, and is readable, then it will be viewed instead of | |
111 using `dired' to view the directory." | |
112 :type 'string | |
113 :group 'url-file) | |
114 | |
115 (defcustom url-privacy-level '(email) | |
68121
0c55f53b51e6
(url-privacy-level): Add setter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65559
diff
changeset
|
116 "How private you want your requests to be. |
54695 | 117 HTTP has header fields for various information about the user, including |
118 operating system information, email addresses, the last page you visited, etc. | |
119 This variable controls how much of this information is sent. | |
120 | |
121 This should a symbol or a list. | |
122 Valid values if a symbol are: | |
123 none -- Send all information | |
124 low -- Don't send the last location | |
125 high -- Don't send the email address or last location | |
126 paranoid -- Don't send anything | |
127 | |
128 If a list, this should be a list of symbols of what NOT to send. | |
129 Valid symbols are: | |
130 email -- the email address | |
131 os -- the operating system info | |
132 lastloc -- the last location | |
133 agent -- Do not send the User-Agent string | |
134 cookie -- never accept HTTP cookies | |
135 | |
136 Samples: | |
137 | |
138 (setq url-privacy-level 'high) | |
139 (setq url-privacy-level '(email lastloc)) ;; equivalent to 'high | |
140 (setq url-privacy-level '(os)) | |
141 | |
142 ::NOTE:: | |
143 This variable controls several other variables and is _NOT_ automatically | |
144 updated. Call the function `url-setup-privacy-info' after modifying this | |
145 variable." | |
68121
0c55f53b51e6
(url-privacy-level): Add setter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65559
diff
changeset
|
146 :initialize 'custom-initialize-default |
0c55f53b51e6
(url-privacy-level): Add setter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65559
diff
changeset
|
147 :set (lambda (sym val) (set-default sym val) (url-setup-privacy-info)) |
54695 | 148 :type '(radio (const :tag "None (you believe in the basic goodness of humanity)" |
149 :value none) | |
150 (const :tag "Low (do not reveal last location)" | |
151 :value low) | |
152 (const :tag "High (no email address or last location)" | |
153 :value high) | |
154 (const :tag "Paranoid (reveal nothing!)" | |
155 :value paranoid) | |
156 (checklist :tag "Custom" | |
157 (const :tag "Email address" :value email) | |
158 (const :tag "Operating system" :value os) | |
159 (const :tag "Last location" :value lastloc) | |
160 (const :tag "Browser identification" :value agent) | |
161 (const :tag "No cookies" :value cookie))) | |
162 :group 'url) | |
163 | |
164 (defvar url-inhibit-uncompression nil "Do not do decompression if non-nil.") | |
165 | |
166 (defcustom url-uncompressor-alist '((".z" . "x-gzip") | |
167 (".gz" . "x-gzip") | |
168 (".uue" . "x-uuencoded") | |
169 (".hqx" . "x-hqx") | |
170 (".Z" . "x-compress") | |
171 (".bz2" . "x-bzip2")) | |
172 "*An alist of file extensions and appropriate content-transfer-encodings." | |
173 :type '(repeat (cons :format "%v" | |
174 (string :tag "Extension") | |
175 (string :tag "Encoding"))) | |
176 :group 'url-mime) | |
177 | |
65559
02ea691fea58
(url-mail-command): Don't test fboundp of `compose-mail'.
Richard M. Stallman <rms@gnu.org>
parents:
64748
diff
changeset
|
178 (defcustom url-mail-command 'compose-mail |
54695 | 179 "*This function will be called whenever url needs to send mail. |
180 It should enter a mail-mode-like buffer in the current window. | |
181 The commands `mail-to' and `mail-subject' should still work in this | |
182 buffer, and it should use `mail-header-separator' if possible." | |
183 :type 'function | |
184 :group 'url) | |
185 | |
186 (defcustom url-proxy-services nil | |
187 "*An alist of schemes and proxy servers that gateway them. | |
188 Looks like ((\"http\" . \"hostname:portnumber\") ...). This is set up | |
189 from the ACCESS_proxy environment variables." | |
190 :type '(repeat (cons :format "%v" | |
191 (string :tag "Protocol") | |
192 (string :tag "Proxy"))) | |
193 :group 'url) | |
194 | |
195 (defcustom url-standalone-mode nil | |
196 "*Rely solely on the cache?" | |
197 :type 'boolean | |
198 :group 'url-cache) | |
199 | |
200 (defvar url-mime-separator-chars (mapcar 'identity | |
201 (concat "ABCDEFGHIJKLMNOPQRSTUVWXYZ" | |
202 "abcdefghijklmnopqrstuvwxyz" | |
203 "0123456789'()+_,-./=?")) | |
204 "Characters allowable in a MIME multipart separator.") | |
205 | |
206 (defcustom url-bad-port-list | |
207 '("25" "119" "19") | |
208 "*List of ports to warn the user about connecting to. | |
209 Defaults to just the mail, chargen, and NNTP ports so you cannot be | |
210 tricked into sending fake mail or forging messages by a malicious HTML | |
211 document." | |
212 :type '(repeat (string :tag "Port")) | |
213 :group 'url-hairy) | |
214 | |
215 (defvar url-mime-content-type-charset-regexp | |
216 ";[ \t]*charset=\"?\\([^\"]+\\)\"?" | |
217 "Regexp used in parsing `Content-Type' for a charset indication.") | |
218 | |
219 (defvar url-request-data nil "Any data to send with the next request.") | |
220 | |
221 (defvar url-request-extra-headers nil | |
222 "A list of extra headers to send with the next request. | |
223 Should be an assoc list of headers/contents.") | |
224 | |
225 (defvar url-request-method nil "The method to use for the next request.") | |
226 | |
227 ;; FIXME!! (RFC 2616 gives examples like `compress, gzip'.) | |
228 (defvar url-mime-encoding-string nil | |
229 "*String to send in the Accept-encoding: field in HTTP requests.") | |
230 | |
231 ;; Perhaps the first few should actually be given decreasing `q's and | |
232 ;; the list should be trimmed significantly. | |
233 ;; Fixme: do something sane if we don't have `sort-coding-systems' | |
234 ;; (Emacs 20, XEmacs). | |
235 (defun url-mime-charset-string () | |
236 "Generate a list of preferred MIME charsets for HTTP requests. | |
237 Generated according to current coding system priorities." | |
238 (if (fboundp 'sort-coding-systems) | |
239 (let ((ordered (sort-coding-systems | |
240 (let (accum) | |
241 (dolist (elt mm-mime-mule-charset-alist) | |
242 (if (mm-coding-system-p (car elt)) | |
243 (push (car elt) accum))) | |
244 (nreverse accum))))) | |
245 (concat (format "%s;q=1, " (pop ordered)) | |
246 (mapconcat 'symbol-name ordered ";q=0.5, ") | |
247 ";q=0.5")))) | |
248 | |
249 (defvar url-mime-charset-string (url-mime-charset-string) | |
250 "*String to send in the Accept-charset: field in HTTP requests. | |
251 The MIME charset corresponding to the most preferred coding system is | |
252 given priority 1 and the rest are given priority 0.5.") | |
253 | |
254 (defun url-set-mime-charset-string () | |
255 (setq url-mime-charset-string (url-mime-charset-string))) | |
256 ;; Regenerate if the language environment changes. | |
257 (add-hook 'set-language-environment-hook 'url-set-mime-charset-string) | |
258 | |
259 ;; Fixme: set from the locale. | |
260 (defcustom url-mime-language-string nil | |
261 "*String to send in the Accept-language: field in HTTP requests. | |
262 | |
263 Specifies the preferred language when servers can serve documents in | |
264 several languages. Use RFC 1766 abbreviations, e.g.@: `en' for | |
265 English, `de' for German. A comma-separated specifies descending | |
266 order of preference. The ordering can be made explicit using `q' | |
267 factors defined by HTTP, e.g. `de,en-gb;q=0.8,en;q=0.7'. `*' means | |
268 get the first available language (as opposed to the default)." | |
269 :type '(radio | |
270 (const :tag "None (get default language version)" :value nil) | |
271 (const :tag "Any (get first available language version)" :value "*") | |
272 (string :tag "Other")) | |
273 :group 'url-mime | |
274 :group 'i18n) | |
275 | |
276 (defvar url-mime-accept-string nil | |
277 "String to send to the server in the Accept: field in HTTP requests.") | |
278 | |
279 (defvar url-package-version nil | |
280 "Version number of package using URL.") | |
281 | |
68121
0c55f53b51e6
(url-privacy-level): Add setter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65559
diff
changeset
|
282 (defvar url-package-name nil "Name of package using URL.") |
54695 | 283 |
284 (defvar url-system-type nil | |
285 "What type of system we are on.") | |
286 (defvar url-os-type nil | |
287 "What OS we are on.") | |
288 | |
289 (defcustom url-max-password-attempts 5 | |
290 "*Maximum number of times a password will be prompted for. | |
291 Applies when a protected document is denied by the server." | |
292 :type 'integer | |
293 :group 'url) | |
294 | |
295 (defcustom url-temporary-directory (or (getenv "TMPDIR") "/tmp") | |
296 "*Where temporary files go." | |
297 :type 'directory | |
298 :group 'url-file) | |
299 | |
300 (defcustom url-show-status t | |
301 "*Whether to show a running total of bytes transferred. | |
302 Can cause a large hit if using a remote X display over a slow link, or | |
303 a terminal with a slow modem." | |
304 :type 'boolean | |
305 :group 'url) | |
306 | |
307 (defvar url-using-proxy nil | |
308 "Either nil or the fully qualified proxy URL in use, e.g. | |
309 http://www.domain.com/") | |
310 | |
311 (defcustom url-news-server nil | |
312 "*The default news server from which to get newsgroups/articles. | |
313 Applies if no server is specified in the URL. Defaults to the | |
314 environment variable NNTPSERVER or \"news\" if NNTPSERVER is | |
315 undefined." | |
316 :type '(choice (const :tag "None" :value nil) string) | |
317 :group 'url) | |
318 | |
319 (defvar url-nonrelative-link | |
320 "\\`\\([-a-zA-Z0-9+.]+:\\)" | |
321 "A regular expression that will match an absolute URL.") | |
322 | |
77178
54ea4fb072b4
(url-max-redirections): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
75347
diff
changeset
|
323 (defcustom url-max-redirections 30 |
54ea4fb072b4
(url-max-redirections): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
75347
diff
changeset
|
324 "*The maximum number of redirection requests to honor in a HTTP connection. |
54ea4fb072b4
(url-max-redirections): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
75347
diff
changeset
|
325 A negative number means to honor an unlimited number of redirection requests." |
54ea4fb072b4
(url-max-redirections): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
75347
diff
changeset
|
326 :type 'integer |
54ea4fb072b4
(url-max-redirections): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
75347
diff
changeset
|
327 :group 'url) |
54ea4fb072b4
(url-max-redirections): New var.
Chong Yidong <cyd@stupidchicken.com>
parents:
75347
diff
changeset
|
328 |
54695 | 329 (defcustom url-confirmation-func 'y-or-n-p |
330 "*What function to use for asking yes or no functions. | |
331 Possible values are `yes-or-no-p' or `y-or-n-p', or any function that | |
332 takes a single argument (the prompt), and returns t only if a positive | |
333 answer is given." | |
334 :type '(choice (const :tag "Short (y or n)" :value y-or-n-p) | |
335 (const :tag "Long (yes or no)" :value yes-or-no-p) | |
336 (function :tag "Other")) | |
337 :group 'url-hairy) | |
338 | |
339 (defcustom url-gateway-method 'native | |
340 "*The type of gateway support to use. | |
341 Should be a symbol specifying how to get a connection from the local machine. | |
342 | |
343 Currently supported methods: | |
344 `telnet': Run telnet in a subprocess to connect; | |
345 `rlogin': Rlogin to another machine to connect; | |
346 `socks': Connect through a socks server; | |
57449
202c408c174b
url-vars.el (url-gateway-method): Add new method `tls'.
Simon Josefsson <jas@extundo.com>
parents:
57427
diff
changeset
|
347 `tls': Connect with TLS; |
202c408c174b
url-vars.el (url-gateway-method): Add new method `tls'.
Simon Josefsson <jas@extundo.com>
parents:
57427
diff
changeset
|
348 `ssl': Connect with SSL (deprecated, use `tls' instead); |
54695 | 349 `native': Connect directy." |
350 :type '(radio (const :tag "Telnet to gateway host" :value telnet) | |
351 (const :tag "Rlogin to gateway host" :value rlogin) | |
352 (const :tag "Use SOCKS proxy" :value socks) | |
57449
202c408c174b
url-vars.el (url-gateway-method): Add new method `tls'.
Simon Josefsson <jas@extundo.com>
parents:
57427
diff
changeset
|
353 (const :tag "Use SSL/TLS for all connections" :value tls) |
202c408c174b
url-vars.el (url-gateway-method): Add new method `tls'.
Simon Josefsson <jas@extundo.com>
parents:
57427
diff
changeset
|
354 (const :tag "Use SSL for all connections (obsolete)" :value ssl) |
54695 | 355 (const :tag "Direct connection" :value native)) |
356 :group 'url-hairy) | |
357 | |
358 (defvar url-setup-done nil "Has setup configuration been done?") | |
359 | |
57514
c386726e02a5
(url-passwd-entry-func): Var deleted.
Richard M. Stallman <rms@gnu.org>
parents:
57449
diff
changeset
|
360 (defconst url-weekday-alist |
54695 | 361 '(("Sunday" . 0) ("Monday" . 1) ("Tuesday" . 2) ("Wednesday" . 3) |
362 ("Thursday" . 4) ("Friday" . 5) ("Saturday" . 6) | |
363 ("Tues" . 2) ("Thurs" . 4) | |
364 ("Sun" . 0) ("Mon" . 1) ("Tue" . 2) ("Wed" . 3) | |
365 ("Thu" . 4) ("Fri" . 5) ("Sat" . 6))) | |
366 | |
57514
c386726e02a5
(url-passwd-entry-func): Var deleted.
Richard M. Stallman <rms@gnu.org>
parents:
57449
diff
changeset
|
367 (defconst url-monthabbrev-alist |
54695 | 368 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4) ("May" . 5) ("Jun" . 6) |
369 ("Jul" . 7) ("Aug" . 8) ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) | |
370 ("Dec" . 12))) | |
371 | |
372 (defvar url-lazy-message-time 0) | |
373 | |
374 ;; Fixme: We may not be able to run SSL. | |
375 (defvar url-extensions-header "Security/Digest Security/SSL") | |
376 | |
377 (defvar url-parse-syntax-table | |
378 (copy-syntax-table emacs-lisp-mode-syntax-table) | |
379 "*A syntax table for parsing URLs.") | |
380 | |
381 (modify-syntax-entry ?' "\"" url-parse-syntax-table) | |
382 (modify-syntax-entry ?` "\"" url-parse-syntax-table) | |
383 (modify-syntax-entry ?< "(>" url-parse-syntax-table) | |
384 (modify-syntax-entry ?> ")<" url-parse-syntax-table) | |
385 (modify-syntax-entry ?/ " " url-parse-syntax-table) | |
386 | |
387 (defvar url-load-hook nil | |
388 "*Hooks to be run after initalizing the URL library.") | |
389 | |
390 ;;; Make OS/2 happy - yeeks | |
391 ;; (defvar tcp-binary-process-input-services nil | |
392 ;; "*Make OS/2 happy with our CRLF pairs...") | |
393 | |
394 (defconst url-working-buffer " *url-work") | |
395 | |
396 (defvar url-gateway-unplugged nil | |
63619
14790c6d12cd
(url-gateway-unplugged): Fix spellings.
Juanma Barranquero <lekktu@gmail.com>
parents:
59996
diff
changeset
|
397 "Non-nil means don't open new network connections. |
54695 | 398 This should be set, e.g. by mail user agents rendering HTML to avoid |
399 `bugs' which call home.") | |
400 | |
401 (provide 'url-vars) | |
402 | |
54699 | 403 ;;; arch-tag: 29205e5f-c5ce-433c-8d5d-38cbaed64b49 |
54695 | 404 ;;; url-vars.el ends here |