cgit.sxemacs.org Git - packages/blob - xemacs-packages/w3/lisp/url-util.el

   1 ;;; url-util.el --- Miscellaneous helper routines for URL library
   2
   3 ;; Copyright (C) 1996-1999, 2001, 2004-2012  Free Software Foundation, Inc.
   4
   5 ;; Author: Bill Perry <wmperry@gnu.org>
   6 ;; Keywords: comm, data, processes
   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 3 of the License, or
  13 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (require 'url-parse)
  28 (require 'url-vars)
  29 (eval-when-compile (require 'cl))
  30 (autoload 'timezone-parse-date "timezone")
  31 (autoload 'timezone-make-date-arpa-standard "timezone")
  32 (autoload 'mail-header-extract "mailheader")
  33
  34 (defvar url-parse-args-syntax-table
  35   (copy-syntax-table emacs-lisp-mode-syntax-table)
  36   "A syntax table for parsing sgml attributes.")
  37
  38 (modify-syntax-entry ?' "\"" url-parse-args-syntax-table)
  39 (modify-syntax-entry ?` "\"" url-parse-args-syntax-table)
  40 (modify-syntax-entry ?{ "(" url-parse-args-syntax-table)
  41 (modify-syntax-entry ?} ")" url-parse-args-syntax-table)
  42
  43 ;;;###autoload
  44 (defcustom url-debug nil
  45   "What types of debug messages from the URL library to show.
  46 Debug messages are logged to the *URL-DEBUG* buffer.
  47
  48 If t, all messages will be logged.
  49 If a number, all messages will be logged, as well shown via `message'.
  50 If a list, it is a list of the types of messages to be logged."
  51   :type '(choice (const :tag "none" nil)
  52                  (const :tag "all" t)
  53                  (checklist :tag "custom"
  54                             (const :tag "HTTP" :value http)
  55                             (const :tag "DAV" :value dav)
  56                             (const :tag "General" :value retrieval)
  57                             (const :tag "Filename handlers" :value handlers)
  58                             (symbol :tag "Other")))
  59   :group 'url-hairy)
  60
  61 ;;;###autoload
  62 (defun url-debug (tag &rest args)
  63   (if quit-flag
  64       (error "Interrupted!"))
  65   (if (or (eq url-debug t)
  66           (numberp url-debug)
  67           (and (listp url-debug) (memq tag url-debug)))
  68       (with-current-buffer (get-buffer-create "*URL-DEBUG*")
  69         (goto-char (point-max))
  70         (insert (symbol-name tag) " -> " (apply 'format args) "\n")
  71         (if (numberp url-debug)
  72             (apply 'message args)))))
  73
  74 ;;;###autoload
  75 (defun url-parse-args (str &optional nodowncase)
  76   ;; Return an assoc list of attribute/value pairs from an RFC822-type string
  77   (let (
  78         name                            ; From name=
  79         value                           ; its value
  80         results                         ; Assoc list of results
  81         name-pos                        ; Start of XXXX= position
  82         val-pos                         ; Start of value position
  83         st
  84         nd
  85         )
  86     (save-excursion
  87       (save-restriction
  88         (set-buffer (get-buffer-create " *urlparse-temp*"))
  89         (set-syntax-table url-parse-args-syntax-table)
  90         (erase-buffer)
  91         (insert str)
  92         (setq st (point-min)
  93               nd (point-max))
  94         (set-syntax-table url-parse-args-syntax-table)
  95         (narrow-to-region st nd)
  96         (goto-char (point-min))
  97         (while (not (eobp))
  98           (skip-chars-forward "; \n\t")
  99           (setq name-pos (point))
 100           (skip-chars-forward "^ \n\t=;")
 101           (if (not nodowncase)
 102               (downcase-region name-pos (point)))
 103           (setq name (buffer-substring name-pos (point)))
 104           (skip-chars-forward " \t\n")
 105           (if (/= (or (char-after (point)) 0)  ?=) ; There is no value
 106               (setq value nil)
 107             (skip-chars-forward " \t\n=")
 108             (setq val-pos (point)
 109                   value
 110                   (cond
 111                    ((or (= (or (char-after val-pos) 0) ?\")
 112                         (= (or (char-after val-pos) 0) ?'))
 113                     (buffer-substring (1+ val-pos)
 114                                       (condition-case ()
 115                                           (prog2
 116                                               (forward-sexp 1)
 117                                               (1- (point))
 118                                             (skip-chars-forward "\""))
 119                                         (error
 120                                          (skip-chars-forward "^ \t\n")
 121                                          (point)))))
 122                    (t
 123                     (buffer-substring val-pos
 124                                       (progn
 125                                         (skip-chars-forward "^;")
 126                                         (skip-chars-backward " \t")
 127                                         (point)))))))
 128           (setq results (cons (cons name value) results))
 129           (skip-chars-forward "; \n\t"))
 130         results))))
 131
 132 ;;;###autoload
 133 (defun url-insert-entities-in-string (string)
 134   "Convert HTML markup-start characters to entity references in STRING.
 135 Also replaces the \" character, so that the result may be safely used as
 136   an attribute value in a tag.  Returns a new string with the result of the
 137   conversion.  Replaces these characters as follows:
 138     &  ==>  &amp;
 139     <  ==>  &lt;
 140     >  ==>  &gt;
 141     \"  ==>  &quot;"
 142   (if (string-match "[&<>\"]" string)
 143       (with-current-buffer (get-buffer-create " *entity*")
 144         (erase-buffer)
 145         (buffer-disable-undo (current-buffer))
 146         (insert string)
 147         (goto-char (point-min))
 148         (while (progn
 149                  (skip-chars-forward "^&<>\"")
 150                  (not (eobp)))
 151           (insert (cdr (assq (char-after (point))
 152                              '((?\" . "&quot;")
 153                                (?& . "&amp;")
 154                                (?< . "&lt;")
 155                                (?> . "&gt;")))))
 156           (delete-char 1))
 157         (buffer-string))
 158     string))
 159
 160 ;;;###autoload
 161 (defun url-normalize-url (url)
 162   "Return a 'normalized' version of URL.
 163 Strips out default port numbers, etc."
 164   (let (type data retval)
 165     (setq data (url-generic-parse-url url)
 166           type (url-type data))
 167     (if (member type '("www" "about" "mailto" "info"))
 168         (setq retval url)
 169       ;; FIXME all this does, and all this function seems to do in
 170       ;; most cases, is remove any trailing "#anchor" part of a url.
 171       (setf (url-target data) nil)
 172       (setq retval (url-recreate-url data)))
 173     retval))
 174
 175 ;;;###autoload
 176 (defun url-lazy-message (&rest args)
 177   "Just like `message', but is a no-op if called more than once a second.
 178 Will not do anything if `url-show-status' is nil."
 179   (if (or (and url-current-object
 180                (url-silent url-current-object))
 181           (null url-show-status)
 182           (active-minibuffer-window)
 183           (= url-lazy-message-time
 184              (setq url-lazy-message-time (nth 1 (current-time)))))
 185       nil
 186     (apply 'message args)))
 187
 188 ;;;###autoload
 189 (defun url-get-normalized-date (&optional specified-time)
 190  "Return a 'real' date string that most HTTP servers can understand."
 191  (let ((system-time-locale "C"))
 192   (format-time-string "%a, %d %b %Y %T GMT"
 193    (or specified-time (current-time)) t)))
 194
 195 ;;;###autoload
 196 (defun url-eat-trailing-space (x)
 197   "Remove spaces/tabs at the end of a string."
 198   (let ((y (1- (length x)))
 199         (skip-chars (list ?  ?\t ?\n)))
 200     (while (and (>= y 0) (memq (aref x y) skip-chars))
 201       (setq y (1- y)))
 202     (substring x 0 (1+ y))))
 203
 204 ;;;###autoload
 205 (defun url-strip-leading-spaces (x)
 206   "Remove spaces at the front of a string."
 207   (let ((y (1- (length x)))
 208         (z 0)
 209         (skip-chars (list ?  ?\t ?\n)))
 210     (while (and (<= z y) (memq (aref x z) skip-chars))
 211       (setq z (1+ z)))
 212     (substring x z nil)))
 213
 214 ;;;###autoload
 215 (defun url-pretty-length (n)
 216   (cond
 217    ((< n 1024)
 218     (format "%d bytes" n))
 219    ((< n (* 1024 1024))
 220     (format "%dk" (/ n 1024.0)))
 221    (t
 222     (format "%2.2fM" (/ n (* 1024 1024.0))))))
 223
 224 ;;;###autoload
 225 (defun url-display-percentage (fmt perc &rest args)
 226   (when (and url-show-status
 227              (or (null url-current-object)
 228                  (not (url-silent url-current-object))))
 229     (if (null fmt)
 230         (if (fboundp 'clear-progress-display)
 231             (clear-progress-display))
 232       (if (and (fboundp 'progress-display) perc)
 233           (apply 'progress-display fmt perc args)
 234         (apply 'message fmt args)))))
 235
 236 ;;;###autoload
 237 (defun url-percentage (x y)
 238   (if (fboundp 'float)
 239       (round (* 100 (/ x (float y))))
 240     (/ (* x 100) y)))
 241
 242 ;;;###autoload
 243 (defalias 'url-basepath 'url-file-directory)
 244
 245 ;;;###autoload
 246 (defun url-file-directory (file)
 247   "Return the directory part of FILE, for a URL."
 248   (cond
 249    ((null file) "")
 250    ((string-match "\\?" file)
 251     (file-name-directory (substring file 0 (match-beginning 0))))
 252    (t (file-name-directory file))))
 253
 254 ;;;###autoload
 255 (defun url-file-nondirectory (file)
 256   "Return the nondirectory part of FILE, for a URL."
 257   (cond
 258    ((null file) "")
 259    ((string-match "\\?" file)
 260     (file-name-nondirectory (substring file 0 (match-beginning 0))))
 261    (t (file-name-nondirectory file))))
 262
 263 ;;;###autoload
 264 (defun url-parse-query-string (query &optional downcase allow-newlines)
 265   (let (retval pairs cur key val)
 266     (setq pairs (split-string query "&"))
 267     (while pairs
 268       (setq cur (car pairs)
 269             pairs (cdr pairs))
 270       (if (not (string-match "=" cur))
 271           nil                           ; Grace
 272         (setq key (url-unhex-string (substring cur 0 (match-beginning 0))
 273                                     allow-newlines))
 274         (setq val (url-unhex-string (substring cur (match-end 0) nil)
 275                                     allow-newlines))
 276         (if downcase
 277             (setq key (downcase key)))
 278         (setq cur (assoc key retval))
 279         (if cur
 280             (setcdr cur (cons val (cdr cur)))
 281           (setq retval (cons (list key val) retval)))))
 282     retval))
 283
 284 (defun url-unhex (x)
 285   (if (> x ?9)
 286       (if (>= x ?a)
 287           (+ 10 (- x ?a))
 288         (+ 10 (- x ?A)))
 289     (- x ?0)))
 290
 291 ;; Fixme: Is this definition better, and does it ever matter?
 292
 293 ;; (defun url-unhex-string (str &optional allow-newlines)
 294 ;;   "Remove %XX, embedded spaces, etc in a url.
 295 ;; If optional second argument ALLOW-NEWLINES is non-nil, then allow the
 296 ;; decoding of carriage returns and line feeds in the string, which is normally
 297 ;; forbidden in URL encoding."
 298 ;;   (setq str (or str ""))
 299 ;;   (setq str (replace-regexp-in-string "%[[:xdigit:]]\\{2\\}"
 300 ;;                                    (lambda (match)
 301 ;;                                      (string (string-to-number
 302 ;;                                               (substring match 1) 16)))
 303 ;;                                    str t t))
 304 ;;   (if allow-newlines
 305 ;;       (replace-regexp-in-string "[\n\r]" (lambda (match)
 306 ;;                                         (format "%%%.2X" (aref match 0)))
 307 ;;                              str t t)
 308 ;;     str))
 309
 310 ;;;###autoload
 311 (defun url-unhex-string (str &optional allow-newlines)
 312   "Remove %XX embedded spaces, etc in a URL.
 313 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
 314 decoding of carriage returns and line feeds in the string, which is normally
 315 forbidden in URL encoding."
 316   (setq str (or str ""))
 317   (let ((tmp "")
 318         (case-fold-search t))
 319     (while (string-match "%[0-9a-f][0-9a-f]" str)
 320       (let* ((start (match-beginning 0))
 321              (ch1 (url-unhex (elt str (+ start 1))))
 322              (code (+ (* 16 ch1)
 323                       (url-unhex (elt str (+ start 2))))))
 324         (setq tmp (concat
 325                    tmp (substring str 0 start)
 326                    (cond
 327                     (allow-newlines
 328                      (char-to-string code))
 329                     ((or (= code ?\n) (= code ?\r))
 330                      " ")
 331                     (t (char-to-string code))))
 332               str (substring str (match-end 0)))))
 333     (concat tmp str)))
 334
 335 (defconst url-unreserved-chars
 336   '(
 337     ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z
 338     ?A ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z
 339     ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9
 340     ?- ?_ ?. ?! ?~ ?* ?' ?\( ?\))
 341   "A list of characters that are _NOT_ reserved in the URL spec.
 342 This is taken from RFC 2396.")
 343
 344 ;;;###autoload
 345 (defun url-hexify-string (string)
 346   "Return a new string that is STRING URI-encoded.
 347 First, STRING is converted to utf-8, if necessary.  Then, for each
 348 character in the utf-8 string, those found in `url-unreserved-chars'
 349 are left as-is, all others are represented as a three-character
 350 string: \"%\" followed by two lowercase hex digits."
 351   ;; To go faster and avoid a lot of consing, we could do:
 352   ;;
 353   ;; (defconst url-hexify-table
 354   ;;   (let ((map (make-vector 256 nil)))
 355   ;;     (dotimes (byte 256) (aset map byte
 356   ;;                               (if (memq byte url-unreserved-chars)
 357   ;;                                   (char-to-string byte)
 358   ;;                                 (format "%%%02x" byte))))
 359   ;;     map))
 360   ;;
 361   ;; (mapconcat (curry 'aref url-hexify-table) ...)
 362   (mapconcat (lambda (byte)
 363                (if (memq byte url-unreserved-chars)
 364                    (char-to-string byte)
 365                  (format "%%%02x" byte)))
 366              (if (save-match-data (string-match "[^\x00-\x7f]" string))
 367                  (encode-coding-string string 'utf-8)
 368                string)
 369              ""))
 370
 371 ;;;###autoload
 372 (defun url-file-extension (fname &optional x)
 373   "Return the filename extension of FNAME.
 374 If optional argument X is t, then return the basename
 375 of the file with the extension stripped off."
 376   (if (and fname
 377            (setq fname (url-file-nondirectory fname))
 378            (string-match "\\.[^./]+$" fname))
 379       (if x (substring fname 0 (match-beginning 0))
 380         (substring fname (match-beginning 0) nil))
 381     ;;
 382     ;; If fname has no extension, and x then return fname itself instead of
 383     ;; nothing. When caching it allows the correct .hdr file to be produced
 384     ;; for filenames without extension.
 385     ;;
 386     (if x
 387         fname
 388       "")))
 389
 390 ;;;###autoload
 391 (defun url-truncate-url-for-viewing (url &optional width)
 392   "Return a shortened version of URL that is WIDTH characters wide or less.
 393 WIDTH defaults to the current frame width."
 394   (let* ((fr-width (or width (frame-width)))
 395          (str-width (length url))
 396          (fname nil)
 397          (modified 0)
 398          (urlobj nil))
 399     ;; The first thing that can go are the search strings
 400     (if (and (>= str-width fr-width)
 401              (string-match "?" url))
 402         (setq url (concat (substring url 0 (match-beginning 0)) "?...")
 403               str-width (length url)))
 404     (if (< str-width fr-width)
 405         nil                             ; Hey, we are done!
 406       (setq urlobj (url-generic-parse-url url)
 407             fname (url-filename urlobj)
 408             fr-width (- fr-width 4))
 409       (while (and (>= str-width fr-width)
 410                   (string-match "/" fname))
 411         (setq fname (substring fname (match-end 0) nil)
 412               modified (1+ modified))
 413         (setf (url-filename urlobj) fname)
 414         (setq url (url-recreate-url urlobj)
 415               str-width (length url)))
 416       (if (> modified 1)
 417           (setq fname (concat "/.../" fname))
 418         (setq fname (concat "/" fname)))
 419       (setf (url-filename urlobj) fname)
 420       (setq url (url-recreate-url urlobj)))
 421     url))
 422
 423 ;;;###autoload
 424 (defun url-view-url (&optional no-show)
 425   "View the current document's URL.
 426 Optional argument NO-SHOW means just return the URL, don't show it in
 427 the minibuffer.
 428
 429 This uses `url-current-object', set locally to the buffer."
 430   (interactive)
 431   (if (not url-current-object)
 432       nil
 433     (if no-show
 434         (url-recreate-url url-current-object)
 435       (message "%s" (url-recreate-url url-current-object)))))
 436
 437 (defvar url-get-url-filename-chars "-%.?@a-zA-Z0-9()_/:~=&"
 438   "Valid characters in a URL.")
 439
 440 (defun url-get-url-at-point (&optional pt)
 441   "Get the URL closest to point, but don't change position.
 442 Has a preference for looking backward when not directly on a symbol."
 443   ;; Not at all perfect - point must be right in the name.
 444   (save-excursion
 445     (if pt (goto-char pt))
 446     (let (start url)
 447       (save-excursion
 448         ;; first see if you're just past a filename
 449         (if (not (eobp))
 450             (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
 451                 (progn
 452                   (skip-chars-backward " \n\t\r({[]})")
 453                   (if (not (bobp))
 454                       (backward-char 1)))))
 455         (if (and (char-after (point))
 456                  (string-match (concat "[" url-get-url-filename-chars "]")
 457                                (char-to-string (char-after (point)))))
 458             (progn
 459               (skip-chars-backward url-get-url-filename-chars)
 460               (setq start (point))
 461               (skip-chars-forward url-get-url-filename-chars))
 462           (setq start (point)))
 463         (setq url (buffer-substring-no-properties start (point))))
 464       (if (and url (string-match "^(.*)\\.?$" url))
 465           (setq url (match-string 1 url)))
 466       (if (and url (string-match "^URL:" url))
 467           (setq url (substring url 4 nil)))
 468       (if (and url (string-match "\\.$" url))
 469           (setq url (substring url 0 -1)))
 470       (if (and url (string-match "^www\\." url))
 471           (setq url (concat "http://" url)))
 472       (if (and url (not (string-match url-nonrelative-link url)))
 473           (setq url nil))
 474       url)))
 475
 476 (defun url-generate-unique-filename (&optional fmt)
 477   "Generate a unique filename in `url-temporary-directory'."
 478   ;; This variable is obsolete, but so is this function.
 479   (let ((tempdir url-temporary-directory))
 480     (if (not fmt)
 481         (let ((base (format "url-tmp.%d" (user-real-uid)))
 482               (fname "")
 483               (x 0))
 484           (setq fname (format "%s%d" base x))
 485           (while (file-exists-p
 486                   (expand-file-name fname tempdir))
 487             (setq x (1+ x)
 488                   fname (concat base (int-to-string x))))
 489           (expand-file-name fname tempdir))
 490       (let ((base (concat "url" (int-to-string (user-real-uid))))
 491             (fname "")
 492             (x 0))
 493         (setq fname (format fmt (concat base (int-to-string x))))
 494         (while (file-exists-p
 495                 (expand-file-name fname tempdir))
 496           (setq x (1+ x)
 497                 fname (format fmt (concat base (int-to-string x)))))
 498         (expand-file-name fname tempdir)))))
 499 (make-obsolete 'url-generate-unique-filename 'make-temp-file "23.1")
 500
 501 (defun url-extract-mime-headers ()
 502   "Set `url-current-mime-headers' in current buffer."
 503   (save-excursion
 504     (goto-char (point-min))
 505     (unless url-current-mime-headers
 506       (set (make-local-variable 'url-current-mime-headers)
 507            (mail-header-extract)))))
 508
 509 (defun url-make-private-file (file)
 510   "Make FILE only readable and writable by the current user.
 511 Creates FILE and its parent directories if they do not exist."
 512   (let ((dir (file-name-directory file)))
 513     (when dir
 514       ;; For historical reasons.
 515       (make-directory dir t)))
 516   ;; Based on doc-view-make-safe-dir.
 517   (condition-case nil
 518       (let ((umask (default-file-modes)))
 519         (unwind-protect
 520             (progn
 521               (set-default-file-modes #o0600)
 522               (with-temp-buffer
 523                 (write-region (point-min) (point-max)
 524                               file nil 'silent nil 'excl)))
 525           (set-default-file-modes umask)))
 526     (file-already-exists
 527      (if (file-symlink-p file)
 528          (error "Danger: `%s' is a symbolic link" file))
 529      (set-file-modes file #o0600))))
 530
 531 (provide 'url-util)
 532
 533 ;;; url-util.el ends here