1 ;;; url-util.el --- Miscellaneous helper routines for URL library
3 ;; Copyright (C) 1996-1999, 2001, 2004-2012 Free Software Foundation, Inc.
5 ;; Author: Bill Perry <wmperry@gnu.org>
6 ;; Keywords: comm, data, processes
8 ;; This file is part of GNU Emacs.
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.
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.
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/>.
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")
34 (defvar url-parse-args-syntax-table
35 (copy-syntax-table emacs-lisp-mode-syntax-table
)
36 "A syntax table for parsing sgml attributes.")
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
)
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.
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
)
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")))
62 (defun url-debug (tag &rest args
)
64 (error "Interrupted!"))
65 (if (or (eq url-debug t
)
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
)))))
75 (defun url-parse-args (str &optional nodowncase
)
76 ;; Return an assoc list of attribute/value pairs from an RFC822-type string
80 results
; Assoc list of results
81 name-pos
; Start of XXXX= position
82 val-pos
; Start of value position
88 (set-buffer (get-buffer-create " *urlparse-temp*"))
89 (set-syntax-table url-parse-args-syntax-table
)
94 (set-syntax-table url-parse-args-syntax-table
)
95 (narrow-to-region st nd
)
96 (goto-char (point-min))
98 (skip-chars-forward "; \n\t")
99 (setq name-pos
(point))
100 (skip-chars-forward "^ \n\t=;")
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
107 (skip-chars-forward " \t\n=")
108 (setq val-pos
(point)
111 ((or (= (or (char-after val-pos
) 0) ?
\")
112 (= (or (char-after val-pos
) 0) ?
'))
113 (buffer-substring (1+ val-pos
)
118 (skip-chars-forward "\""))
120 (skip-chars-forward "^ \t\n")
123 (buffer-substring val-pos
125 (skip-chars-forward "^;")
126 (skip-chars-backward " \t")
128 (setq results
(cons (cons name value
) results
))
129 (skip-chars-forward "; \n\t"))
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:
142 (if (string-match "[&<>\"]" string
)
143 (with-current-buffer (get-buffer-create " *entity*")
145 (buffer-disable-undo (current-buffer))
147 (goto-char (point-min))
149 (skip-chars-forward "^&<>\"")
151 (insert (cdr (assq (char-after (point))
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"))
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
)))
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)))))
186 (apply 'message args
)))
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
)))
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
))
202 (substring x
0 (1+ y
))))
205 (defun url-strip-leading-spaces (x)
206 "Remove spaces at the front of a string."
207 (let ((y (1- (length x
)))
209 (skip-chars (list ? ?
\t ?
\n)))
210 (while (and (<= z y
) (memq (aref x z
) skip-chars
))
212 (substring x z nil
)))
215 (defun url-pretty-length (n)
218 (format "%d bytes" n
))
220 (format "%dk" (/ n
1024.0)))
222 (format "%2.2fM" (/ n
(* 1024 1024.0))))))
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
))))
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
)))))
237 (defun url-percentage (x y
)
239 (round (* 100 (/ x
(float y
))))
243 (defalias 'url-basepath
'url-file-directory
)
246 (defun url-file-directory (file)
247 "Return the directory part of FILE, for a URL."
250 ((string-match "\\?" file
)
251 (file-name-directory (substring file
0 (match-beginning 0))))
252 (t (file-name-directory file
))))
255 (defun url-file-nondirectory (file)
256 "Return the nondirectory part of FILE, for a URL."
259 ((string-match "\\?" file
)
260 (file-name-nondirectory (substring file
0 (match-beginning 0))))
261 (t (file-name-nondirectory file
))))
264 (defun url-parse-query-string (query &optional downcase allow-newlines
)
265 (let (retval pairs cur key val
)
266 (setq pairs
(split-string query
"&"))
268 (setq cur
(car pairs
)
270 (if (not (string-match "=" cur
))
272 (setq key
(url-unhex-string (substring cur
0 (match-beginning 0))
274 (setq val
(url-unhex-string (substring cur
(match-end 0) nil
)
277 (setq key
(downcase key
)))
278 (setq cur
(assoc key retval
))
280 (setcdr cur
(cons val
(cdr cur
)))
281 (setq retval
(cons (list key val
) retval
)))))
291 ;; Fixme: Is this definition better, and does it ever matter?
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\\}"
301 ;; (string (string-to-number
302 ;; (substring match 1) 16)))
304 ;; (if allow-newlines
305 ;; (replace-regexp-in-string "[\n\r]" (lambda (match)
306 ;; (format "%%%.2X" (aref match 0)))
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
""))
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))))
323 (url-unhex (elt str
(+ start
2))))))
325 tmp
(substring str
0 start
)
328 (byte-to-string code
))
329 ((or (= code ?
\n) (= code ?
\r))
331 (t (byte-to-string code
))))
332 str
(substring str
(match-end 0)))))
335 (defconst url-unreserved-chars
336 '(?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
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 ?
0 ?
1 ?
2 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9
340 "List of characters that are unreserved in the URL spec.
341 This is taken from RFC 3986 (section 2.3).")
343 (defconst url-encoding-table
344 (let ((vec (make-vector 256 nil
)))
346 (aset vec byte
(format "%%%02x" byte
)))
348 "Vector translating bytes to URI-encoded %-sequences.")
350 (defun url--allowed-chars (char-list)
351 "Return an \"allowed character\" mask (a 256-slot vector).
352 The Nth element is non-nil if character N is in CHAR-LIST. The
353 result can be passed as the second arg to `url-hexify-string'."
354 (let ((vec (make-vector 256 nil
)))
355 (dolist (byte char-list
)
356 (ignore-errors (aset vec byte t
)))
360 (defun url-hexify-string (string &optional allowed-chars
)
361 "URI-encode STRING and return the result.
362 If STRING is multibyte, it is first converted to a utf-8 byte
363 string. Each byte corresponding to an allowed character is left
364 as-is, while all other bytes are converted to a three-character
365 string: \"%\" followed by two lowercase hex digits.
367 The allowed characters are specified by ALLOWED-CHARS. If this
368 argument is nil, the list `url-unreserved-chars' determines the
369 allowed characters. Otherwise, ALLOWED-CHARS should be a vector
370 whose Nth element is non-nil if character N is allowed."
371 (unless allowed-chars
372 (setq allowed-chars
(url--allowed-chars url-unreserved-chars
)))
373 (mapconcat (lambda (byte)
374 (if (aref allowed-chars byte
)
375 (char-to-string byte
)
376 (aref url-encoding-table byte
)))
377 (if (multibyte-string-p string
)
378 (encode-coding-string string
'utf-8
)
382 (defconst url-host-allowed-chars
383 ;; Allow % to avoid re-encoding %-encoded sequences.
384 (url--allowed-chars (append '(?% ?
! ?$ ?
& ?
' ?\
( ?\
) ?
* ?
+ ?
, ?\
; ?=)
385 url-unreserved-chars
))
386 "Allowed-character byte mask for the host segment of a URI.
387 These characters are specified in RFC 3986, Appendix A.")
389 (defconst url-path-allowed-chars
390 (let ((vec (copy-sequence url-host-allowed-chars
)))
395 "Allowed-character byte mask for the path segment of a URI.
396 These characters are specified in RFC 3986, Appendix A.")
398 (defconst url-query-allowed-chars
399 (let ((vec (copy-sequence url-path-allowed-chars
)))
402 "Allowed-character byte mask for the query segment of a URI.
403 These characters are specified in RFC 3986, Appendix A.")
406 (defun url-encode-url (url)
407 "Return a properly URI-encoded version of URL.
408 This function also performs URI normalization, e.g. converting
409 the scheme to lowercase if it is uppercase. Apart from
410 normalization, if URL is already URI-encoded, this function
411 should return it unchanged."
412 (if (multibyte-string-p url
)
413 (setq url
(encode-coding-string url
'utf-8
)))
414 (let* ((obj (url-generic-parse-url url
))
415 (user (url-user obj
))
416 (pass (url-password obj
))
417 (host (url-host obj
))
418 (file (url-filename obj
))
419 (frag (url-target obj
))
422 (setf (url-user obj
) (url-hexify-string user
)))
424 (setf (url-password obj
) (url-hexify-string pass
)))
426 ;; No special encoding for IPv6 literals.
427 (unless (string-match "\\`\\[.*\\]\\'" host
)
429 (url-hexify-string host url-host-allowed-chars
))))
430 ;; Split FILENAME slot into its PATH and QUERY components, and
431 ;; encode them separately. The PATH component can contain
432 ;; unreserved characters, %-encodings, and /:@!$&'()*+,;=
434 (if (string-match "\\?" file
)
435 (setq path
(substring file
0 (match-beginning 0))
436 query
(substring file
(match-end 0)))
438 (setq path
(url-hexify-string path url-path-allowed-chars
))
440 (setq query
(url-hexify-string query url-query-allowed-chars
)))
441 (setf (url-filename obj
)
442 (if query
(concat path
"?" query
) path
)))
444 (setf (url-target obj
)
445 (url-hexify-string frag url-query-allowed-chars
)))
446 (url-recreate-url obj
)))
449 (defun url-file-extension (fname &optional x
)
450 "Return the filename extension of FNAME.
451 If optional argument X is t, then return the basename
452 of the file with the extension stripped off."
454 (setq fname
(url-file-nondirectory fname
))
455 (string-match "\\.[^./]+$" fname
))
456 (if x
(substring fname
0 (match-beginning 0))
457 (substring fname
(match-beginning 0) nil
))
459 ;; If fname has no extension, and x then return fname itself instead of
460 ;; nothing. When caching it allows the correct .hdr file to be produced
461 ;; for filenames without extension.
468 (defun url-truncate-url-for-viewing (url &optional width
)
469 "Return a shortened version of URL that is WIDTH characters wide or less.
470 WIDTH defaults to the current frame width."
471 (let* ((fr-width (or width
(frame-width)))
472 (str-width (length url
))
476 ;; The first thing that can go are the search strings
477 (if (and (>= str-width fr-width
)
478 (string-match "?" url
))
479 (setq url
(concat (substring url
0 (match-beginning 0)) "?...")
480 str-width
(length url
)))
481 (if (< str-width fr-width
)
482 nil
; Hey, we are done!
483 (setq urlobj
(url-generic-parse-url url
)
484 fname
(url-filename urlobj
)
485 fr-width
(- fr-width
4))
486 (while (and (>= str-width fr-width
)
487 (string-match "/" fname
))
488 (setq fname
(substring fname
(match-end 0) nil
)
489 modified
(1+ modified
))
490 (setf (url-filename urlobj
) fname
)
491 (setq url
(url-recreate-url urlobj
)
492 str-width
(length url
)))
494 (setq fname
(concat "/.../" fname
))
495 (setq fname
(concat "/" fname
)))
496 (setf (url-filename urlobj
) fname
)
497 (setq url
(url-recreate-url urlobj
)))
501 (defun url-view-url (&optional no-show
)
502 "View the current document's URL.
503 Optional argument NO-SHOW means just return the URL, don't show it in
506 This uses `url-current-object', set locally to the buffer."
508 (if (not url-current-object
)
511 (url-recreate-url url-current-object
)
512 (message "%s" (url-recreate-url url-current-object
)))))
514 (defvar url-get-url-filename-chars
"-%.?@a-zA-Z0-9()_/:~=&"
515 "Valid characters in a URL.")
517 (defun url-get-url-at-point (&optional pt
)
518 "Get the URL closest to point, but don't change position.
519 Has a preference for looking backward when not directly on a symbol."
520 ;; Not at all perfect - point must be right in the name.
522 (if pt
(goto-char pt
))
525 ;; first see if you're just past a filename
527 (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
529 (skip-chars-backward " \n\t\r({[]})")
531 (backward-char 1)))))
532 (if (and (char-after (point))
533 (string-match (concat "[" url-get-url-filename-chars
"]")
534 (char-to-string (char-after (point)))))
536 (skip-chars-backward url-get-url-filename-chars
)
538 (skip-chars-forward url-get-url-filename-chars
))
539 (setq start
(point)))
540 (setq url
(buffer-substring-no-properties start
(point))))
541 (if (and url
(string-match "^(.*)\\.?$" url
))
542 (setq url
(match-string 1 url
)))
543 (if (and url
(string-match "^URL:" url
))
544 (setq url
(substring url
4 nil
)))
545 (if (and url
(string-match "\\.$" url
))
546 (setq url
(substring url
0 -
1)))
547 (if (and url
(string-match "^www\\." url
))
548 (setq url
(concat "http://" url
)))
549 (if (and url
(not (string-match url-nonrelative-link url
)))
553 (defun url-generate-unique-filename (&optional fmt
)
554 "Generate a unique filename in `url-temporary-directory'."
555 ;; This variable is obsolete, but so is this function.
556 (let ((tempdir (with-no-warnings url-temporary-directory
)))
558 (let ((base (format "url-tmp.%d" (user-real-uid)))
561 (setq fname
(format "%s%d" base x
))
562 (while (file-exists-p
563 (expand-file-name fname tempdir
))
565 fname
(concat base
(int-to-string x
))))
566 (expand-file-name fname tempdir
))
567 (let ((base (concat "url" (int-to-string (user-real-uid))))
570 (setq fname
(format fmt
(concat base
(int-to-string x
))))
571 (while (file-exists-p
572 (expand-file-name fname tempdir
))
574 fname
(format fmt
(concat base
(int-to-string x
)))))
575 (expand-file-name fname tempdir
)))))
576 (make-obsolete 'url-generate-unique-filename
'make-temp-file
"23.1")
578 (defun url-extract-mime-headers ()
579 "Set `url-current-mime-headers' in current buffer."
581 (goto-char (point-min))
582 (unless url-current-mime-headers
583 (set (make-local-variable 'url-current-mime-headers
)
584 (mail-header-extract)))))
586 (defun url-make-private-file (file)
587 "Make FILE only readable and writable by the current user.
588 Creates FILE and its parent directories if they do not exist."
589 (let ((dir (file-name-directory file
)))
591 ;; For historical reasons.
592 (make-directory dir t
)))
593 ;; Based on doc-view-make-safe-dir.
595 (let ((umask (default-file-modes)))
598 (set-default-file-modes #o0600
)
600 (write-region (point-min) (point-max)
601 file nil
'silent nil
'excl
)))
602 (set-default-file-modes umask
)))
604 (if (file-symlink-p file
)
605 (error "Danger: `%s' is a symbolic link" file
))
606 (set-file-modes file
#o0600
))))
610 ;;; url-util.el ends here