Merge from origin/emacs-24
[emacs.git] / lisp / url / url-cookie.el
bloba7b3d16d46df7c5e9cda0b34d019afa54676df61
1 ;;; url-cookie.el --- URL cookie support
3 ;; Copyright (C) 1996-1999, 2004-2015 Free Software Foundation, Inc.
5 ;; Keywords: comm, data, processes, hypermedia
7 ;; This file is part of GNU Emacs.
8 ;;
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22 ;;; Commentary:
24 ;;; Code:
26 (require 'url-util)
27 (require 'url-parse)
28 (require 'url-domsuf)
30 (eval-when-compile (require 'cl-lib))
32 (defgroup url-cookie nil
33 "URL cookies."
34 :prefix "url-"
35 :prefix "url-cookie-"
36 :group 'url)
38 ;; A cookie is stored internally as a vector of 7 slots
39 ;; [ url-cookie NAME VALUE EXPIRES LOCALPART DOMAIN SECURE ]
41 (cl-defstruct (url-cookie
42 (:constructor url-cookie-create)
43 (:copier nil)
44 (:type vector)
45 :named)
46 name value expires localpart domain secure)
48 (defvar url-cookie-storage nil "Where cookies are stored.")
49 (defvar url-cookie-secure-storage nil "Where secure cookies are stored.")
50 (defcustom url-cookie-file nil
51 "File where cookies are stored on disk."
52 :type '(choice (const :tag "Default" :value nil) file)
53 :group 'url-file
54 :group 'url-cookie)
56 (defcustom url-cookie-confirmation nil
57 "If non-nil, confirmation by the user is required to accept HTTP cookies."
58 :type 'boolean
59 :group 'url-cookie)
61 (defcustom url-cookie-multiple-line nil
62 "If nil, HTTP requests put all cookies for the server on one line.
63 Some web servers, such as http://www.hotmail.com/, only accept cookies
64 when they are on one line. This is broken behavior, but just try
65 telling Microsoft that."
66 :type 'boolean
67 :group 'url-cookie)
69 (defvar url-cookies-changed-since-last-save nil
70 "Whether the cookies list has changed since the last save operation.")
72 (defun url-cookie-parse-file (&optional fname)
73 "Load FNAME, default `url-cookie-file'."
74 ;; It's completely normal for the cookies file not to exist yet.
75 (load (or fname url-cookie-file) t t))
77 (defun url-cookie-clean-up (&optional secure)
78 (let ((var (if secure 'url-cookie-secure-storage 'url-cookie-storage))
79 new new-cookies)
80 (dolist (cur (symbol-value var))
81 (setq new-cookies nil)
82 (dolist (cur-cookie (cdr cur))
83 (or (not (url-cookie-p cur-cookie))
84 (url-cookie-expired-p cur-cookie)
85 (null (url-cookie-expires cur-cookie))
86 (setq new-cookies (cons cur-cookie new-cookies))))
87 (when new-cookies
88 (setcdr cur new-cookies)
89 (setq new (cons cur new))))
90 (set var new)))
92 (defun url-cookie-write-file (&optional fname)
93 (when url-cookies-changed-since-last-save
94 (or fname (setq fname (expand-file-name url-cookie-file)))
95 (if (condition-case nil
96 (progn
97 (url-make-private-file fname)
98 nil)
99 (error t))
100 (message "Error accessing cookie file `%s'" fname)
101 (url-cookie-clean-up)
102 (url-cookie-clean-up t)
103 (with-temp-buffer
104 (insert ";; Emacs-W3 HTTP cookies file\n"
105 ";; Automatically generated file!!! DO NOT EDIT!!!\n\n"
106 "(setq url-cookie-storage\n '")
107 (let ((print-length nil) (print-level nil))
108 (pp url-cookie-storage (current-buffer))
109 (insert ")\n(setq url-cookie-secure-storage\n '")
110 (pp url-cookie-secure-storage (current-buffer)))
111 (insert ")\n")
112 (insert "\f\n;; Local Variables:\n"
113 ";; version-control: never\n"
114 ";; no-byte-compile: t\n"
115 ";; End:\n")
116 (set (make-local-variable 'version-control) 'never)
117 (write-file fname))
118 (setq url-cookies-changed-since-last-save nil))))
120 (defun url-cookie-store (name value &optional expires domain localpart secure)
121 "Store a cookie."
122 (let ((storage (if secure url-cookie-secure-storage url-cookie-storage))
123 tmp found-domain)
124 ;; First, look for a matching domain.
125 (if (setq found-domain (assoc domain storage))
126 ;; Need to either stick the new cookie in existing domain storage
127 ;; or possibly replace an existing cookie if the names match.
128 (unless (dolist (cur (setq storage (cdr found-domain)) tmp)
129 (and (equal localpart (url-cookie-localpart cur))
130 (equal name (url-cookie-name cur))
131 (progn
132 (setf (url-cookie-expires cur) expires)
133 (setf (url-cookie-value cur) value)
134 (setq tmp t))))
135 ;; New cookie.
136 (setcdr found-domain (cons
137 (url-cookie-create :name name
138 :value value
139 :expires expires
140 :domain domain
141 :localpart localpart
142 :secure secure)
143 (cdr found-domain))))
144 ;; Need to add a new top-level domain.
145 (setq tmp (url-cookie-create :name name
146 :value value
147 :expires expires
148 :domain domain
149 :localpart localpart
150 :secure secure))
151 (cond (storage
152 (setcdr storage (cons (list domain tmp) (cdr storage))))
153 (secure
154 (setq url-cookie-secure-storage (list (list domain tmp))))
156 (setq url-cookie-storage (list (list domain tmp))))))))
158 (defun url-cookie-expired-p (cookie)
159 "Return non-nil if COOKIE is expired."
160 (let ((exp (url-cookie-expires cookie)))
161 (and (> (length exp) 0)
162 (condition-case ()
163 (> (float-time) (float-time (date-to-time exp)))
164 (error nil)))))
166 (defun url-cookie-retrieve (host &optional localpart secure)
167 "Retrieve all cookies for a specified HOST and LOCALPART."
168 (let ((storage (if secure
169 (append url-cookie-secure-storage url-cookie-storage)
170 url-cookie-storage))
171 (case-fold-search t)
172 cookies retval localpart-match)
173 (dolist (cur storage)
174 (setq cookies (cdr cur))
175 (if (and (car cur)
176 (string-match
177 (concat "^.*"
178 (regexp-quote
179 ;; Remove the dot from wildcard domains
180 ;; before matching.
181 (if (eq ?. (aref (car cur) 0))
182 (substring (car cur) 1)
183 (car cur)))
184 "$") host))
185 ;; The domains match - a possible hit!
186 (dolist (cur cookies)
187 (and (if (and (stringp
188 (setq localpart-match (url-cookie-localpart cur)))
189 (stringp localpart))
190 (string-match (concat "^" (regexp-quote localpart-match))
191 localpart)
192 (equal localpart localpart-match))
193 (not (url-cookie-expired-p cur))
194 (setq retval (cons cur retval))))))
195 retval))
197 (defun url-cookie-generate-header-lines (host localpart secure)
198 (let ((cookies (url-cookie-retrieve host localpart secure))
199 retval chunk)
200 ;; Have to sort this for sending most specific cookies first.
201 (setq cookies (and cookies
202 (sort cookies
203 (lambda (x y)
204 (> (length (url-cookie-localpart x))
205 (length (url-cookie-localpart y)))))))
206 (dolist (cur cookies)
207 (setq chunk (format "%s=%s" (url-cookie-name cur) (url-cookie-value cur))
208 retval (if (and url-cookie-multiple-line
209 (< 80 (+ (length retval) (length chunk) 4)))
210 (concat retval "\r\nCookie: " chunk)
211 (if retval
212 (concat retval "; " chunk)
213 (concat "Cookie: " chunk)))))
214 (if retval
215 (concat retval "\r\n")
216 "")))
218 (defcustom url-cookie-trusted-urls nil
219 "A list of regular expressions matching URLs to always accept cookies from."
220 :type '(repeat regexp)
221 :group 'url-cookie)
223 (defcustom url-cookie-untrusted-urls nil
224 "A list of regular expressions matching URLs to never accept cookies from."
225 :type '(repeat regexp)
226 :group 'url-cookie)
228 (defun url-cookie-host-can-set-p (host domain)
229 (let ((last nil)
230 (case-fold-search t))
231 (if (string= host domain) ; Apparently netscape lets you do this
233 ;; Remove the dot from wildcard domains before matching.
234 (when (eq ?. (aref domain 0))
235 (setq domain (substring domain 1)))
236 (and (url-domsuf-cookie-allowed-p domain)
237 ;; Need to check and make sure the host is actually _in_ the
238 ;; domain it wants to set a cookie for though.
239 (string-match (concat (regexp-quote domain)
240 "$") host)))))
242 (defun url-cookie-handle-set-cookie (str)
243 (setq url-cookies-changed-since-last-save t)
244 (let* ((args (url-parse-args str t))
245 (case-fold-search t)
246 (secure (and (assoc-string "secure" args t) t))
247 (domain (or (cdr-safe (assoc-string "domain" args t))
248 (url-host url-current-object)))
249 (current-url (url-view-url t))
250 (trusted url-cookie-trusted-urls)
251 (untrusted url-cookie-untrusted-urls)
252 (expires (cdr-safe (assoc-string "expires" args t)))
253 (localpart (or (cdr-safe (assoc-string "path" args t))
254 (file-name-directory
255 (url-filename url-current-object))))
256 (rest nil))
257 (dolist (this args)
258 (or (member (downcase (car this)) '("secure" "domain" "expires" "path"))
259 (setq rest (cons this rest))))
261 ;; Sometimes we get dates that the timezone package cannot handle very
262 ;; gracefully - take care of this here, instead of in url-cookie-expired-p
263 ;; to speed things up.
264 (and expires
265 (string-match
266 (concat "^[^,]+, +\\(..\\)-\\(...\\)-\\(..\\) +"
267 "\\(..:..:..\\) +\\[*\\([^\]]+\\)\\]*$")
268 expires)
269 (setq expires (concat (match-string 1 expires) " "
270 (match-string 2 expires) " "
271 (match-string 3 expires) " "
272 (match-string 4 expires) " ["
273 (match-string 5 expires) "]")))
275 ;; This one is for older Emacs/XEmacs variants that don't
276 ;; understand this format without tenths of a second in it.
277 ;; Wednesday, 30-Dec-2037 16:00:00 GMT
278 ;; - vs -
279 ;; Wednesday, 30-Dec-2037 16:00:00.00 GMT
280 (and expires
281 (string-match
282 "\\([0-9]+\\)-\\([A-Za-z]+\\)-\\([0-9]+\\)[ \t]+\\([0-9]+:[0-9]+:[0-9]+\\)\\(\\.[0-9]+\\)*[ \t]+\\([-+a-zA-Z0-9]+\\)"
283 expires)
284 (setq expires (concat (match-string 1 expires) "-" ; day
285 (match-string 2 expires) "-" ; month
286 (match-string 3 expires) " " ; year
287 (match-string 4 expires) ".00 " ; hour:minutes:seconds
288 (match-string 6 expires)))) ":" ; timezone
290 (while (consp trusted)
291 (if (string-match (car trusted) current-url)
292 (setq trusted (- (match-end 0) (match-beginning 0)))
293 (pop trusted)))
294 (while (consp untrusted)
295 (if (string-match (car untrusted) current-url)
296 (setq untrusted (- (match-end 0) (match-beginning 0)))
297 (pop untrusted)))
298 (and trusted untrusted
299 ;; Choose the more specific match.
300 (set (if (> trusted untrusted) 'untrusted 'trusted) nil))
301 (cond
302 (untrusted
303 ;; The site was explicitly marked as untrusted by the user.
304 nil)
305 ((or (eq url-privacy-level 'paranoid)
306 (and (listp url-privacy-level) (memq 'cookies url-privacy-level)))
307 ;; User never wants cookies.
308 nil)
309 ((and url-cookie-confirmation
310 (not trusted)
311 (save-window-excursion
312 (with-output-to-temp-buffer "*Cookie Warning*"
313 (dolist (x rest)
314 (princ (format "%s - %s" (car x) (cdr x)))))
315 (prog1
316 (not (funcall url-confirmation-func
317 (format "Allow %s to set these cookies? "
318 (url-host url-current-object))))
319 (if (get-buffer "*Cookie Warning*")
320 (kill-buffer "*Cookie Warning*")))))
321 ;; User wants to be asked, and declined.
322 nil)
323 ((url-cookie-host-can-set-p (url-host url-current-object) domain)
324 ;; Cookie is accepted by the user, and passes our security checks.
325 (dolist (cur rest)
326 (url-cookie-store (car cur) (cdr cur) expires domain localpart secure)))
328 (url-lazy-message "%s tried to set a cookie for domain %s - rejected."
329 (url-host url-current-object) domain)))))
331 (defvar url-cookie-timer nil)
333 (defcustom url-cookie-save-interval 3600
334 "The number of seconds between automatic saves of cookies.
335 Default is 1 hour. Note that if you change this variable outside of
336 the `customize' interface after `url-do-setup' has been run, you need
337 to run the `url-cookie-setup-save-timer' function manually."
338 :set #'(lambda (var val)
339 (set-default var val)
340 (if (bound-and-true-p url-setup-done)
341 (url-cookie-setup-save-timer)))
342 :type 'integer
343 :group 'url-cookie)
345 (defun url-cookie-setup-save-timer ()
346 "Reset the cookie saver timer."
347 (interactive)
348 (ignore-errors (cancel-timer url-cookie-timer))
349 (setq url-cookie-timer nil)
350 (if url-cookie-save-interval
351 (setq url-cookie-timer (run-at-time url-cookie-save-interval
352 url-cookie-save-interval
353 #'url-cookie-write-file))))
355 ;;; Mode for listing and editing cookies.
357 (defun url-cookie-list ()
358 "Display a buffer listing the current URL cookies, if there are any.
359 Use \\<url-cookie-mode-map>\\\[url-cookie-delete] to remove cookies."
360 (interactive)
361 (when (and (null url-cookie-secure-storage)
362 (null url-cookie-storage))
363 (error "No cookies are defined"))
365 (pop-to-buffer "*url cookies*")
366 (let ((inhibit-read-only t)
367 (domains (sort
368 (copy-sequence
369 (append url-cookie-secure-storage
370 url-cookie-storage))
371 (lambda (e1 e2)
372 (string< (car e1) (car e2)))))
373 (domain-length 0)
374 start name format domain)
375 (erase-buffer)
376 (url-cookie-mode)
377 (dolist (elem domains)
378 (setq domain-length (max domain-length (length (car elem)))))
379 (setq format (format "%%-%ds %%-20s %%s" domain-length)
380 header-line-format
381 (concat " " (format format "Domain" "Name" "Value")))
382 (dolist (elem domains)
383 (setq domain (car elem))
384 (dolist (cookie (sort (copy-sequence (cdr elem))
385 (lambda (c1 c2)
386 (string< (url-cookie-name c1)
387 (url-cookie-name c2)))))
388 (setq start (point)
389 name (url-cookie-name cookie))
390 (when (> (length name) 20)
391 (setq name (substring name 0 20)))
392 (insert (format format domain name
393 (url-cookie-value cookie))
394 "\n")
395 (setq domain "")
396 (put-text-property start (1+ start) 'url-cookie cookie)))
397 (goto-char (point-min))))
399 (defun url-cookie-delete ()
400 "Delete the cookie on the current line."
401 (interactive)
402 (let ((cookie (get-text-property (line-beginning-position) 'url-cookie))
403 (inhibit-read-only t)
404 variable)
405 (unless cookie
406 (error "No cookie on the current line"))
407 (setq variable (if (url-cookie-secure cookie)
408 'url-cookie-secure-storage
409 'url-cookie-storage))
410 (let* ((list (symbol-value variable))
411 (elem (assoc (url-cookie-domain cookie) list)))
412 (setq elem (delq cookie elem))
413 (when (zerop (length (cdr elem)))
414 (setq list (delq elem list)))
415 (set variable list))
416 (setq url-cookies-changed-since-last-save t)
417 (url-cookie-write-file)
418 (delete-region (line-beginning-position)
419 (progn
420 (forward-line 1)
421 (point)))))
423 (defun url-cookie-quit ()
424 "Kill the current buffer."
425 (interactive)
426 (kill-buffer (current-buffer)))
428 (defvar url-cookie-mode-map
429 (let ((map (make-sparse-keymap)))
430 (suppress-keymap map)
431 (define-key map "q" 'url-cookie-quit)
432 (define-key map [delete] 'url-cookie-delete)
433 (define-key map [(control k)] 'url-cookie-delete)
434 map))
436 (define-derived-mode url-cookie-mode nil "URL Cookie"
437 "Mode for listing cookies.
439 \\{url-cookie-mode-map}"
440 (buffer-disable-undo)
441 (setq buffer-read-only t
442 truncate-lines t))
444 (provide 'url-cookie)
446 ;;; url-cookie.el ends here