code.delx.au - gnu-emacs/blob - lisp/url/url-cookie.el

   1 ;;; url-cookie.el --- Netscape Cookie support
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2004,
   4 ;;   2005, 2006 Free Software Foundation, Inc.
   5
   6 ;; Keywords: comm, data, processes, hypermedia
   7
   8 ;; This file is part of GNU Emacs.
   9 ;;
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14 ;;
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19 ;;
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23 ;; Boston, MA 02110-1301, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (require 'timezone)
  30 (require 'url-util)
  31 (require 'url-parse)
  32 (eval-when-compile (require 'cl))
  33
  34 ;; See http://home.netscape.com/newsref/std/cookie_spec.html for the
  35 ;; 'open standard' defining this crap.
  36 ;;
  37 ;; A cookie is stored internally as a vector of 7 slots
  38 ;; [ cookie NAME VALUE EXPIRES LOCALPART DOMAIN SECURE ]
  39
  40 (defsubst url-cookie-name    (cookie) (aref cookie 1))
  41 (defsubst url-cookie-value   (cookie) (aref cookie 2))
  42 (defsubst url-cookie-expires (cookie) (aref cookie 3))
  43 (defsubst url-cookie-localpart    (cookie) (aref cookie 4))
  44 (defsubst url-cookie-domain  (cookie) (aref cookie 5))
  45 (defsubst url-cookie-secure  (cookie) (aref cookie 6))
  46
  47 (defsubst url-cookie-set-name    (cookie val) (aset cookie 1 val))
  48 (defsubst url-cookie-set-value   (cookie val) (aset cookie 2 val))
  49 (defsubst url-cookie-set-expires (cookie val) (aset cookie 3 val))
  50 (defsubst url-cookie-set-localpart (cookie val) (aset cookie 4 val))
  51 (defsubst url-cookie-set-domain  (cookie val) (aset cookie 5 val))
  52 (defsubst url-cookie-set-secure  (cookie val) (aset cookie 6 val))
  53 (defsubst url-cookie-retrieve-arg (key args) (nth 1 (memq key args)))
  54
  55 (defsubst url-cookie-create (&rest args)
  56   "Create a cookie vector object from keyword-value pairs ARGS.
  57 The keywords allowed are
  58   :name NAME
  59   :value VALUE
  60   :expires TIME
  61   :localpart LOCALPAR
  62   :domain DOMAIN
  63   :secure ???
  64 Could someone fill in more information?"
  65   (let ((retval (make-vector 7 nil)))
  66     (aset retval 0 'cookie)
  67     (url-cookie-set-name retval (url-cookie-retrieve-arg :name args))
  68     (url-cookie-set-value retval (url-cookie-retrieve-arg :value args))
  69     (url-cookie-set-expires retval (url-cookie-retrieve-arg :expires args))
  70     (url-cookie-set-localpart retval (url-cookie-retrieve-arg :localpart args))
  71     (url-cookie-set-domain retval (url-cookie-retrieve-arg :domain args))
  72     (url-cookie-set-secure retval (url-cookie-retrieve-arg :secure args))
  73     retval))
  74
  75 (defun url-cookie-p (obj)
  76   "Return non-nil if OBJ is a cookie vector object.
  77 These objects represent cookies in the URL package.
  78 A cookie vector object is a vector of 7 slots:
  79  [cookie NAME VALUE EXPIRES LOCALPART DOMAIN SECURE]."
  80   (and (vectorp obj) (= (length obj) 7) (eq (aref obj 0) 'cookie)))
  81
  82 (defgroup url-cookie nil
  83   "URL cookies."
  84   :prefix "url-"
  85   :prefix "url-cookie-"
  86   :group 'url)
  87
  88 (defvar url-cookie-storage nil         "Where cookies are stored.")
  89 (defvar url-cookie-secure-storage nil  "Where secure cookies are stored.")
  90 (defcustom url-cookie-file nil
  91   "File where cookies are stored on disk."
  92   :type '(choice (const :tag "Default" :value nil) file)
  93   :group 'url-file
  94   :group 'url-cookie)
  95
  96 (defcustom url-cookie-confirmation nil
  97   "If non-nil, confirmation by the user is required to accept HTTP cookies."
  98   :type 'boolean
  99   :group 'url-cookie)
 100
 101 (defcustom url-cookie-multiple-line nil
 102   "If nil, HTTP requests put all cookies for the server on one line.
 103 Some web servers, such as http://www.hotmail.com/, only accept cookies
 104 when they are on one line.  This is broken behavior, but just try
 105 telling Microsoft that."
 106   :type 'boolean
 107   :group 'url-cookie)
 108
 109 (defvar url-cookies-changed-since-last-save nil
 110   "Whether the cookies list has changed since the last save operation.")
 111
 112 (defun url-cookie-parse-file (&optional fname)
 113   (setq fname (or fname url-cookie-file))
 114   (condition-case ()
 115       (load fname nil t)
 116     (error
 117      ;; It's completely normal for the cookies file not to exist yet.
 118      ;; (message "Could not load cookie file %s" fname)
 119      )))
 120
 121 (defun url-cookie-clean-up (&optional secure)
 122   (let* (
 123          (var (if secure 'url-cookie-secure-storage 'url-cookie-storage))
 124          (val (symbol-value var))
 125          (cur nil)
 126          (new nil)
 127          (cookies nil)
 128          (cur-cookie nil)
 129          (new-cookies nil)
 130          )
 131     (while val
 132       (setq cur (car val)
 133             val (cdr val)
 134             new-cookies nil
 135             cookies (cdr cur))
 136       (while cookies
 137         (setq cur-cookie (car cookies)
 138               cookies (cdr cookies))
 139         (if (or (not (url-cookie-p cur-cookie))
 140                 (url-cookie-expired-p cur-cookie)
 141                 (null (url-cookie-expires cur-cookie)))
 142             nil
 143           (setq new-cookies (cons cur-cookie new-cookies))))
 144       (if (not new-cookies)
 145           nil
 146         (setcdr cur new-cookies)
 147         (setq new (cons cur new))))
 148     (set var new)))
 149
 150 (defun url-cookie-write-file (&optional fname)
 151   (setq fname (or fname url-cookie-file))
 152   (unless (file-directory-p (file-name-directory fname))
 153     (ignore-errors (make-directory (file-name-directory fname))))
 154   (cond
 155    ((not url-cookies-changed-since-last-save) nil)
 156    ((not (file-writable-p fname))
 157     (message "Cookies file %s (see variable `url-cookie-file') is unwritable." fname))
 158    (t
 159     (url-cookie-clean-up)
 160     (url-cookie-clean-up t)
 161     (with-current-buffer (get-buffer-create " *cookies*")
 162       (erase-buffer)
 163       (fundamental-mode)
 164       (insert ";; Emacs-W3 HTTP cookies file\n"
 165               ";; Automatically generated file!!! DO NOT EDIT!!!\n\n"
 166               "(setq url-cookie-storage\n '")
 167       (pp url-cookie-storage (current-buffer))
 168       (insert ")\n(setq url-cookie-secure-storage\n '")
 169       (pp url-cookie-secure-storage (current-buffer))
 170       (insert ")\n")
 171       (insert "\f\n;; Local Variables:\n"
 172               ";; version-control: never\n"
 173               ";; no-byte-compile: t\n"
 174               ";; End:\n")
 175       (set (make-local-variable 'version-control) 'never)
 176       (write-file fname)
 177       (setq url-cookies-changed-since-last-save nil)
 178       (kill-buffer (current-buffer))))))
 179
 180 (defun url-cookie-store (name value &optional expires domain localpart secure)
 181   "Store a netscape-style cookie."
 182   (let* ((storage (if secure url-cookie-secure-storage url-cookie-storage))
 183          (tmp storage)
 184          (cur nil)
 185          (found-domain nil))
 186
 187     ;; First, look for a matching domain
 188     (setq found-domain (assoc domain storage))
 189
 190     (if found-domain
 191         ;; Need to either stick the new cookie in existing domain storage
 192         ;; or possibly replace an existing cookie if the names match.
 193         (progn
 194           (setq storage (cdr found-domain)
 195                 tmp nil)
 196           (while storage
 197             (setq cur (car storage)
 198                   storage (cdr storage))
 199             (if (and (equal localpart (url-cookie-localpart cur))
 200                      (equal name (url-cookie-name cur)))
 201                 (progn
 202                   (url-cookie-set-expires cur expires)
 203                   (url-cookie-set-value cur value)
 204                   (setq tmp t))))
 205           (if (not tmp)
 206               ;; New cookie
 207               (setcdr found-domain (cons
 208                                     (url-cookie-create :name name
 209                                                        :value value
 210                                                        :expires expires
 211                                                        :domain domain
 212                                                        :localpart localpart
 213                                                        :secure secure)
 214                                     (cdr found-domain)))))
 215       ;; Need to add a new top-level domain
 216       (setq tmp (url-cookie-create :name name
 217                                    :value value
 218                                    :expires expires
 219                                    :domain domain
 220                                    :localpart localpart
 221                                    :secure secure))
 222       (cond
 223        (storage
 224         (setcdr storage (cons (list domain tmp) (cdr storage))))
 225        (secure
 226         (setq url-cookie-secure-storage (list (list domain tmp))))
 227        (t
 228         (setq url-cookie-storage (list (list domain tmp))))))))
 229
 230 (defun url-cookie-expired-p (cookie)
 231   (let* (
 232          (exp (url-cookie-expires cookie))
 233          (cur-date (and exp (timezone-parse-date (current-time-string))))
 234          (exp-date (and exp (timezone-parse-date exp)))
 235          (cur-greg (and cur-date (timezone-absolute-from-gregorian
 236                                   (string-to-number (aref cur-date 1))
 237                                   (string-to-number (aref cur-date 2))
 238                                   (string-to-number (aref cur-date 0)))))
 239          (exp-greg (and exp (timezone-absolute-from-gregorian
 240                              (string-to-number (aref exp-date 1))
 241                              (string-to-number (aref exp-date 2))
 242                              (string-to-number (aref exp-date 0)))))
 243          (diff-in-days (and exp (- cur-greg exp-greg)))
 244          )
 245     (cond
 246      ((not exp) nil)                    ; No expiry == expires at browser quit
 247      ((< diff-in-days 0) nil)           ; Expires sometime after today
 248      ((> diff-in-days 0) t)             ; Expired before today
 249      (t                                 ; Expires sometime today, check times
 250       (let* ((cur-time (timezone-parse-time (aref cur-date 3)))
 251              (exp-time (timezone-parse-time (aref exp-date 3)))
 252              (cur-norm (+ (* 360 (string-to-number (aref cur-time 2)))
 253                           (*  60 (string-to-number (aref cur-time 1)))
 254                           (*   1 (string-to-number (aref cur-time 0)))))
 255              (exp-norm (+ (* 360 (string-to-number (aref exp-time 2)))
 256                           (*  60 (string-to-number (aref exp-time 1)))
 257                           (*   1 (string-to-number (aref exp-time 0))))))
 258         (> (- cur-norm exp-norm) 1))))))
 259
 260 (defun url-cookie-retrieve (host localpart &optional secure)
 261   "Retrieve all the netscape-style cookies for a specified HOST and LOCALPART."
 262   (let ((storage (if secure
 263                      (append url-cookie-secure-storage url-cookie-storage)
 264                    url-cookie-storage))
 265         (case-fold-search t)
 266         (cookies nil)
 267         (cur nil)
 268         (retval nil)
 269         (localpart-regexp nil))
 270     (while storage
 271       (setq cur (car storage)
 272             storage (cdr storage)
 273             cookies (cdr cur))
 274       (if (and (car cur)
 275                (string-match (concat "^.*" (regexp-quote (car cur)) "$") host))
 276           ;; The domains match - a possible hit!
 277           (while cookies
 278             (setq cur (car cookies)
 279                   cookies (cdr cookies)
 280                   localpart-regexp (concat "^" (regexp-quote
 281                                                 (url-cookie-localpart cur))))
 282             (if (and (string-match localpart-regexp localpart)
 283                      (not (url-cookie-expired-p cur)))
 284                 (setq retval (cons cur retval))))))
 285     retval))
 286
 287 (defun url-cookie-generate-header-lines (host localpart secure)
 288   (let* ((cookies (url-cookie-retrieve host localpart secure))
 289          (retval nil)
 290          (cur nil)
 291          (chunk nil))
 292     ;; Have to sort this for sending most specific cookies first
 293     (setq cookies (and cookies
 294                        (sort cookies
 295                              (function
 296                               (lambda (x y)
 297                                 (> (length (url-cookie-localpart x))
 298                                    (length (url-cookie-localpart y))))))))
 299     (while cookies
 300       (setq cur (car cookies)
 301             cookies (cdr cookies)
 302             chunk (format "%s=%s" (url-cookie-name cur) (url-cookie-value cur))
 303             retval (if (and url-cookie-multiple-line
 304                             (< 80 (+ (length retval) (length chunk) 4)))
 305                        (concat retval "\r\nCookie: " chunk)
 306                      (if retval
 307                          (concat retval "; " chunk)
 308                        (concat "Cookie: " chunk)))))
 309     (if retval
 310         (concat retval "\r\n")
 311       "")))
 312
 313 (defvar url-cookie-two-dot-domains
 314   (concat "\\.\\("
 315    (mapconcat 'identity (list "com" "edu" "net" "org" "gov" "mil" "int")
 316               "\\|")
 317    "\\)$")
 318   "A regexp of top level domains that only require two matching
 319 '.'s in the domain name in order to set a cookie.")
 320
 321 (defcustom url-cookie-trusted-urls nil
 322   "A list of regular expressions matching URLs to always accept cookies from."
 323   :type '(repeat regexp)
 324   :group 'url-cookie)
 325
 326 (defcustom url-cookie-untrusted-urls nil
 327   "A list of regular expressions matching URLs to never accept cookies from."
 328   :type '(repeat regexp)
 329   :group 'url-cookie)
 330
 331 (defun url-cookie-host-can-set-p (host domain)
 332   (let ((numdots 0)
 333         (last nil)
 334         (case-fold-search t)
 335         (mindots 3))
 336     (while (setq last (string-match "\\." domain last))
 337       (setq numdots (1+ numdots)
 338             last (1+ last)))
 339     (if (string-match url-cookie-two-dot-domains domain)
 340         (setq mindots 2))
 341     (cond
 342      ((string= host domain)             ; Apparently netscape lets you do this
 343       t)
 344      ((>= numdots mindots)              ; We have enough dots in domain name
 345       ;; Need to check and make sure the host is actually _in_ the
 346       ;; domain it wants to set a cookie for though.
 347       (string-match (concat (regexp-quote domain) "$") host))
 348      (t
 349       nil))))
 350
 351 (defun url-cookie-handle-set-cookie (str)
 352   (setq url-cookies-changed-since-last-save t)
 353   (let* ((args (url-parse-args str t))
 354          (case-fold-search t)
 355          (secure (and (assoc-string "secure" args t) t))
 356          (domain (or (cdr-safe (assoc-string "domain" args t))
 357                      (url-host url-current-object)))
 358          (current-url (url-view-url t))
 359          (trusted url-cookie-trusted-urls)
 360          (untrusted url-cookie-untrusted-urls)
 361          (expires (cdr-safe (assoc-string "expires" args t)))
 362          (localpart (or (cdr-safe (assoc-string "path" args t))
 363                         (file-name-directory
 364                          (url-filename url-current-object))))
 365          (rest nil))
 366     (while args
 367       (if (not (member (downcase (car (car args)))
 368                        '("secure" "domain" "expires" "path")))
 369           (setq rest (cons (car args) rest)))
 370       (setq args (cdr args)))
 371
 372     ;; Sometimes we get dates that the timezone package cannot handle very
 373     ;; gracefully - take care of this here, instead of in url-cookie-expired-p
 374     ;; to speed things up.
 375     (if (and expires
 376              (string-match
 377               (concat "^[^,]+, +\\(..\\)-\\(...\\)-\\(..\\) +"
 378                       "\\(..:..:..\\) +\\[*\\([^\]]+\\)\\]*$")
 379               expires))
 380         (setq expires (concat (match-string 1 expires) " "
 381                               (match-string 2 expires) " "
 382                               (match-string 3 expires) " "
 383                               (match-string 4 expires) " ["
 384                               (match-string 5 expires) "]")))
 385
 386     ;; This one is for older Emacs/XEmacs variants that don't
 387     ;; understand this format without tenths of a second in it.
 388     ;; Wednesday, 30-Dec-2037 16:00:00 GMT
 389     ;;       - vs -
 390     ;; Wednesday, 30-Dec-2037 16:00:00.00 GMT
 391     (if (and expires
 392              (string-match
 393               "\\([0-9]+\\)-\\([A-Za-z]+\\)-\\([0-9]+\\)[ \t]+\\([0-9]+:[0-9]+:[0-9]+\\)\\(\\.[0-9]+\\)*[ \t]+\\([-+a-zA-Z0-9]+\\)"
 394               expires))
 395         (setq expires (concat (match-string 1 expires) "-"      ; day
 396                               (match-string 2 expires) "-"      ; month
 397                               (match-string 3 expires) " "      ; year
 398                               (match-string 4 expires) ".00 " ; hour:minutes:seconds
 399                               (match-string 6 expires)))) ":" ; timezone
 400
 401     (while (consp trusted)
 402       (if (string-match (car trusted) current-url)
 403           (setq trusted (- (match-end 0) (match-beginning 0)))
 404         (pop trusted)))
 405     (while (consp untrusted)
 406       (if (string-match (car untrusted) current-url)
 407           (setq untrusted (- (match-end 0) (match-beginning 0)))
 408         (pop untrusted)))
 409     (if (and trusted untrusted)
 410         ;; Choose the more specific match
 411         (if (> trusted untrusted)
 412             (setq untrusted nil)
 413           (setq trusted nil)))
 414     (cond
 415      (untrusted
 416       ;; The site was explicity marked as untrusted by the user
 417       nil)
 418      ((or (eq url-privacy-level 'paranoid)
 419           (and (listp url-privacy-level) (memq 'cookies url-privacy-level)))
 420       ;; user never wants cookies
 421       nil)
 422      ((and url-cookie-confirmation
 423            (not trusted)
 424            (save-window-excursion
 425              (with-output-to-temp-buffer "*Cookie Warning*"
 426                (mapcar
 427                 (function
 428                  (lambda (x)
 429                    (princ (format "%s - %s" (car x) (cdr x))))) rest))
 430              (prog1
 431                  (not (funcall url-confirmation-func
 432                                (format "Allow %s to set these cookies? "
 433                                        (url-host url-current-object))))
 434                (if (get-buffer "*Cookie Warning*")
 435                    (kill-buffer "*Cookie Warning*")))))
 436       ;; user wants to be asked, and declined.
 437       nil)
 438      ((url-cookie-host-can-set-p (url-host url-current-object) domain)
 439       ;; Cookie is accepted by the user, and passes our security checks
 440       (let ((cur nil))
 441         (while rest
 442           (setq cur (pop rest))
 443           (url-cookie-store (car cur) (cdr cur)
 444                             expires domain localpart secure))))
 445      (t
 446       (message "%s tried to set a cookie for domain %s - rejected."
 447                (url-host url-current-object) domain)))))
 448
 449 (defvar url-cookie-timer nil)
 450
 451 (defcustom url-cookie-save-interval 3600
 452   "The number of seconds between automatic saves of cookies.
 453 Default is 1 hour.  Note that if you change this variable outside of
 454 the `customize' interface after `url-do-setup' has been run, you need
 455 to run the `url-cookie-setup-save-timer' function manually."
 456   :set #'(lambda (var val)
 457            (set-default var val)
 458            (if (bound-and-true-p url-setup-done)
 459                (url-cookie-setup-save-timer)))
 460   :type 'integer
 461   :group 'url-cookie)
 462
 463 (defun url-cookie-setup-save-timer ()
 464   "Reset the cookie saver timer."
 465   (interactive)
 466   (ignore-errors (cancel-timer url-cookie-timer))
 467   (setq url-cookie-timer nil)
 468   (if url-cookie-save-interval
 469       (setq url-cookie-timer (run-at-time url-cookie-save-interval
 470                                           url-cookie-save-interval
 471                                           #'url-cookie-write-file))))
 472
 473 (provide 'url-cookie)
 474
 475 ;; arch-tag: 2568751b-6452-4398-aa2d-303edadb54d7
 476 ;;; url-cookie.el ends here