Commit | Line | Data |
---|---|---|
8c8b8430 | 1 | ;;; url-util.el --- Miscellaneous helper routines for URL library |
a2fd1462 | 2 | |
df41da5e | 3 | ;; Copyright (c) 1996,1997,1998,1999,2001,2004 Free Software Foundation, Inc. |
a2fd1462 | 4 | |
8c8b8430 | 5 | ;; Author: Bill Perry <wmperry@gnu.org> |
8c8b8430 SM |
6 | ;; Keywords: comm, data, processes |
7 | ||
a2fd1462 SM |
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., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
24 | ||
25 | ;;; Commentary: | |
26 | ||
27 | ;;; Code: | |
8c8b8430 SM |
28 | |
29 | (require 'url-parse) | |
30 | (autoload 'timezone-parse-date "timezone") | |
31 | (autoload 'timezone-make-date-arpa-standard "timezone") | |
c6bfe6e7 | 32 | (autoload 'mail-header-extract "mailheader") |
8c8b8430 SM |
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))) | |
a2fd1462 | 68 | (with-current-buffer (get-buffer-create "*URL-DEBUG*") |
8c8b8430 SM |
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 | & ==> & | |
139 | < ==> < | |
140 | > ==> > | |
141 | \" ==> "" | |
142 | (if (string-match "[&<>\"]" string) | |
143 | (save-excursion | |
144 | (set-buffer (get-buffer-create " *entity*")) | |
145 | (erase-buffer) | |
146 | (buffer-disable-undo (current-buffer)) | |
147 | (insert string) | |
148 | (goto-char (point-min)) | |
149 | (while (progn | |
150 | (skip-chars-forward "^&<>\"") | |
151 | (not (eobp))) | |
152 | (insert (cdr (assq (char-after (point)) | |
153 | '((?\" . """) | |
154 | (?& . "&") | |
155 | (?< . "<") | |
156 | (?> . ">"))))) | |
157 | (delete-char 1)) | |
158 | (buffer-string)) | |
159 | string)) | |
160 | ||
161 | ;;;###autoload | |
162 | (defun url-normalize-url (url) | |
163 | "Return a 'normalized' version of URL. | |
164 | Strips out default port numbers, etc." | |
165 | (let (type data grok retval) | |
166 | (setq data (url-generic-parse-url url) | |
167 | type (url-type data)) | |
168 | (if (member type '("www" "about" "mailto" "info")) | |
169 | (setq retval url) | |
170 | (url-set-target data nil) | |
171 | (setq retval (url-recreate-url data))) | |
172 | retval)) | |
173 | ||
174 | ;;;###autoload | |
175 | (defun url-lazy-message (&rest args) | |
176 | "Just like `message', but is a no-op if called more than once a second. | |
a2fd1462 | 177 | Will not do anything if `url-show-status' is nil." |
8c8b8430 SM |
178 | (if (or (null url-show-status) |
179 | (active-minibuffer-window) | |
180 | (= url-lazy-message-time | |
181 | (setq url-lazy-message-time (nth 1 (current-time))))) | |
182 | nil | |
183 | (apply 'message args))) | |
184 | ||
185 | ;;;###autoload | |
186 | (defun url-get-normalized-date (&optional specified-time) | |
187 | "Return a 'real' date string that most HTTP servers can understand." | |
188 | (require 'timezone) | |
189 | (let* ((raw (if specified-time (current-time-string specified-time) | |
190 | (current-time-string))) | |
191 | (gmt (timezone-make-date-arpa-standard raw | |
192 | (nth 1 (current-time-zone)) | |
193 | "GMT")) | |
194 | (parsed (timezone-parse-date gmt)) | |
f5d4d259 | 195 | (day (cdr-safe (assoc (substring raw 0 3) url-weekday-alist))) |
8c8b8430 SM |
196 | (year nil) |
197 | (month (car | |
198 | (rassoc | |
f5d4d259 | 199 | (string-to-int (aref parsed 1)) url-monthabbrev-alist))) |
8c8b8430 | 200 | ) |
f5d4d259 | 201 | (setq day (or (car-safe (rassoc day url-weekday-alist)) |
8c8b8430 SM |
202 | (substring raw 0 3)) |
203 | year (aref parsed 0)) | |
204 | ;; This is needed for plexus servers, or the server will hang trying to | |
205 | ;; parse the if-modified-since header. Hopefully, I can take this out | |
206 | ;; soon. | |
207 | (if (and year (> (length year) 2)) | |
208 | (setq year (substring year -2 nil))) | |
209 | ||
210 | (concat day ", " (aref parsed 2) "-" month "-" year " " | |
211 | (aref parsed 3) " " (or (aref parsed 4) | |
212 | (concat "[" (nth 1 (current-time-zone)) | |
213 | "]"))))) | |
214 | ||
215 | ;;;###autoload | |
216 | (defun url-eat-trailing-space (x) | |
217 | "Remove spaces/tabs at the end of a string." | |
218 | (let ((y (1- (length x))) | |
219 | (skip-chars (list ? ?\t ?\n))) | |
220 | (while (and (>= y 0) (memq (aref x y) skip-chars)) | |
221 | (setq y (1- y))) | |
222 | (substring x 0 (1+ y)))) | |
223 | ||
224 | ;;;###autoload | |
225 | (defun url-strip-leading-spaces (x) | |
226 | "Remove spaces at the front of a string." | |
227 | (let ((y (1- (length x))) | |
228 | (z 0) | |
229 | (skip-chars (list ? ?\t ?\n))) | |
230 | (while (and (<= z y) (memq (aref x z) skip-chars)) | |
231 | (setq z (1+ z))) | |
232 | (substring x z nil))) | |
233 | ||
234 | ;;;###autoload | |
235 | (defun url-pretty-length (n) | |
236 | (cond | |
237 | ((< n 1024) | |
238 | (format "%d bytes" n)) | |
239 | ((< n (* 1024 1024)) | |
240 | (format "%dk" (/ n 1024.0))) | |
241 | (t | |
242 | (format "%2.2fM" (/ n (* 1024 1024.0)))))) | |
243 | ||
244 | ;;;###autoload | |
245 | (defun url-display-percentage (fmt perc &rest args) | |
246 | (if (null fmt) | |
247 | (if (fboundp 'clear-progress-display) | |
248 | (clear-progress-display)) | |
249 | (if (and (fboundp 'progress-display) perc) | |
250 | (apply 'progress-display fmt perc args) | |
251 | (apply 'message fmt args)))) | |
252 | ||
253 | ;;;###autoload | |
254 | (defun url-percentage (x y) | |
255 | (if (fboundp 'float) | |
256 | (round (* 100 (/ x (float y)))) | |
257 | (/ (* x 100) y))) | |
258 | ||
259 | ;;;###autoload | |
260 | (defun url-basepath (file &optional x) | |
261 | "Return the base pathname of FILE, or the actual filename if X is true." | |
262 | (cond | |
263 | ((null file) "") | |
264 | ((string-match (eval-when-compile (regexp-quote "?")) file) | |
265 | (if x | |
266 | (file-name-nondirectory (substring file 0 (match-beginning 0))) | |
267 | (file-name-directory (substring file 0 (match-beginning 0))))) | |
268 | (x (file-name-nondirectory file)) | |
269 | (t (file-name-directory file)))) | |
270 | ||
271 | ;;;###autoload | |
272 | (defun url-parse-query-string (query &optional downcase) | |
273 | (let (retval pairs cur key val) | |
274 | (setq pairs (split-string query "&")) | |
275 | (while pairs | |
276 | (setq cur (car pairs) | |
277 | pairs (cdr pairs)) | |
278 | (if (not (string-match "=" cur)) | |
279 | nil ; Grace | |
280 | (setq key (url-unhex-string (substring cur 0 (match-beginning 0))) | |
281 | val (url-unhex-string (substring cur (match-end 0) nil))) | |
282 | (if downcase | |
283 | (setq key (downcase key))) | |
284 | (setq cur (assoc key retval)) | |
285 | (if cur | |
286 | (setcdr cur (cons val (cdr cur))) | |
287 | (setq retval (cons (list key val) retval))))) | |
288 | retval)) | |
289 | ||
290 | (defun url-unhex (x) | |
291 | (if (> x ?9) | |
292 | (if (>= x ?a) | |
293 | (+ 10 (- x ?a)) | |
294 | (+ 10 (- x ?A))) | |
295 | (- x ?0))) | |
296 | ||
c6bfe6e7 SM |
297 | ;; Fixme: Is this definition better, and does it ever matter? |
298 | ||
299 | ;; (defun url-unhex-string (str &optional allow-newlines) | |
300 | ;; "Remove %XX, embedded spaces, etc in a url. | |
301 | ;; If optional second argument ALLOW-NEWLINES is non-nil, then allow the | |
302 | ;; decoding of carriage returns and line feeds in the string, which is normally | |
303 | ;; forbidden in URL encoding." | |
304 | ;; (setq str (or str "")) | |
305 | ;; (setq str (replace-regexp-in-string "%[[:xdigit:]]\\{2\\}" | |
306 | ;; (lambda (match) | |
307 | ;; (string (string-to-number | |
308 | ;; (substring match 1) 16))) | |
309 | ;; str t t)) | |
310 | ;; (if allow-newlines | |
311 | ;; (replace-regexp-in-string "[\n\r]" (lambda (match) | |
312 | ;; (format "%%%.2X" (aref match 0))) | |
313 | ;; str t t) | |
314 | ;; str)) | |
315 | ||
8c8b8430 SM |
316 | ;;;###autoload |
317 | (defun url-unhex-string (str &optional allow-newlines) | |
c6bfe6e7 | 318 | "Remove %XX embedded spaces, etc in a url. |
8c8b8430 SM |
319 | If optional second argument ALLOW-NEWLINES is non-nil, then allow the |
320 | decoding of carriage returns and line feeds in the string, which is normally | |
321 | forbidden in URL encoding." | |
322 | (setq str (or str "")) | |
323 | (let ((tmp "") | |
324 | (case-fold-search t)) | |
325 | (while (string-match "%[0-9a-f][0-9a-f]" str) | |
326 | (let* ((start (match-beginning 0)) | |
327 | (ch1 (url-unhex (elt str (+ start 1)))) | |
328 | (code (+ (* 16 ch1) | |
329 | (url-unhex (elt str (+ start 2)))))) | |
330 | (setq tmp (concat | |
331 | tmp (substring str 0 start) | |
332 | (cond | |
333 | (allow-newlines | |
334 | (char-to-string code)) | |
335 | ((or (= code ?\n) (= code ?\r)) | |
336 | " ") | |
337 | (t (char-to-string code)))) | |
338 | str (substring str (match-end 0))))) | |
339 | (setq tmp (concat tmp str)) | |
340 | tmp)) | |
341 | ||
342 | (defconst url-unreserved-chars | |
343 | '( | |
344 | ?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 | |
345 | ?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 | |
346 | ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 | |
347 | ?- ?_ ?. ?! ?~ ?* ?' ?\( ?\)) | |
348 | "A list of characters that are _NOT_ reserved in the URL spec. | |
349 | This is taken from RFC 2396.") | |
350 | ||
351 | ;;;###autoload | |
352 | (defun url-hexify-string (str) | |
353 | "Escape characters in a string." | |
354 | (mapconcat | |
355 | (lambda (char) | |
356 | ;; Fixme: use a char table instead. | |
357 | (if (not (memq char url-unreserved-chars)) | |
c6bfe6e7 SM |
358 | (if (> char 255) |
359 | (error "Hexifying multibyte character %s" str) | |
360 | (format "%%%02X" char)) | |
8c8b8430 SM |
361 | (char-to-string char))) |
362 | str "")) | |
363 | ||
364 | ;;;###autoload | |
365 | (defun url-file-extension (fname &optional x) | |
366 | "Return the filename extension of FNAME. | |
367 | If optional variable X is t, | |
368 | then return the basename of the file with the extension stripped off." | |
369 | (if (and fname | |
370 | (setq fname (url-basepath fname t)) | |
371 | (string-match "\\.[^./]+$" fname)) | |
372 | (if x (substring fname 0 (match-beginning 0)) | |
373 | (substring fname (match-beginning 0) nil)) | |
374 | ;; | |
375 | ;; If fname has no extension, and x then return fname itself instead of | |
376 | ;; nothing. When caching it allows the correct .hdr file to be produced | |
377 | ;; for filenames without extension. | |
378 | ;; | |
379 | (if x | |
380 | fname | |
381 | ""))) | |
382 | ||
383 | ;;;###autoload | |
384 | (defun url-truncate-url-for-viewing (url &optional width) | |
385 | "Return a shortened version of URL that is WIDTH characters or less wide. | |
386 | WIDTH defaults to the current frame width." | |
387 | (let* ((fr-width (or width (frame-width))) | |
388 | (str-width (length url)) | |
389 | (tail (file-name-nondirectory url)) | |
390 | (fname nil) | |
391 | (modified 0) | |
392 | (urlobj nil)) | |
393 | ;; The first thing that can go are the search strings | |
394 | (if (and (>= str-width fr-width) | |
395 | (string-match "?" url)) | |
396 | (setq url (concat (substring url 0 (match-beginning 0)) "?...") | |
397 | str-width (length url) | |
398 | tail (file-name-nondirectory url))) | |
399 | (if (< str-width fr-width) | |
400 | nil ; Hey, we are done! | |
401 | (setq urlobj (url-generic-parse-url url) | |
402 | fname (url-filename urlobj) | |
403 | fr-width (- fr-width 4)) | |
404 | (while (and (>= str-width fr-width) | |
405 | (string-match "/" fname)) | |
406 | (setq fname (substring fname (match-end 0) nil) | |
407 | modified (1+ modified)) | |
408 | (url-set-filename urlobj fname) | |
409 | (setq url (url-recreate-url urlobj) | |
410 | str-width (length url))) | |
411 | (if (> modified 1) | |
412 | (setq fname (concat "/.../" fname)) | |
413 | (setq fname (concat "/" fname))) | |
414 | (url-set-filename urlobj fname) | |
415 | (setq url (url-recreate-url urlobj))) | |
416 | url)) | |
417 | ||
418 | ;;;###autoload | |
419 | (defun url-view-url (&optional no-show) | |
420 | "View the current document's URL. | |
421 | Optional argument NO-SHOW means just return the URL, don't show it in | |
422 | the minibuffer. | |
423 | ||
424 | This uses `url-current-object', set locally to the buffer." | |
425 | (interactive) | |
426 | (if (not url-current-object) | |
427 | nil | |
428 | (if no-show | |
429 | (url-recreate-url url-current-object) | |
430 | (message "%s" (url-recreate-url url-current-object))))) | |
431 | ||
432 | (eval-and-compile | |
433 | (defvar url-get-url-filename-chars "-%.?@a-zA-Z0-9()_/:~=&" | |
434 | "Valid characters in a URL") | |
435 | ) | |
436 | ||
437 | (defun url-get-url-at-point (&optional pt) | |
438 | "Get the URL closest to point, but don't change position. | |
439 | Has a preference for looking backward when not directly on a symbol." | |
440 | ;; Not at all perfect - point must be right in the name. | |
441 | (save-excursion | |
442 | (if pt (goto-char pt)) | |
443 | (let (start url) | |
444 | (save-excursion | |
445 | ;; first see if you're just past a filename | |
446 | (if (not (eobp)) | |
447 | (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens | |
448 | (progn | |
449 | (skip-chars-backward " \n\t\r({[]})") | |
450 | (if (not (bobp)) | |
451 | (backward-char 1))))) | |
452 | (if (and (char-after (point)) | |
453 | (string-match (eval-when-compile | |
454 | (concat "[" url-get-url-filename-chars "]")) | |
455 | (char-to-string (char-after (point))))) | |
456 | (progn | |
457 | (skip-chars-backward url-get-url-filename-chars) | |
458 | (setq start (point)) | |
459 | (skip-chars-forward url-get-url-filename-chars)) | |
460 | (setq start (point))) | |
461 | (setq url (buffer-substring-no-properties start (point)))) | |
462 | (if (and url (string-match "^(.*)\\.?$" url)) | |
463 | (setq url (match-string 1 url))) | |
464 | (if (and url (string-match "^URL:" url)) | |
465 | (setq url (substring url 4 nil))) | |
466 | (if (and url (string-match "\\.$" url)) | |
467 | (setq url (substring url 0 -1))) | |
468 | (if (and url (string-match "^www\\." url)) | |
469 | (setq url (concat "http://" url))) | |
470 | (if (and url (not (string-match url-nonrelative-link url))) | |
471 | (setq url nil)) | |
472 | url))) | |
473 | ||
474 | (defun url-generate-unique-filename (&optional fmt) | |
475 | "Generate a unique filename in `url-temporary-directory'." | |
476 | (if (not fmt) | |
477 | (let ((base (format "url-tmp.%d" (user-real-uid))) | |
478 | (fname "") | |
479 | (x 0)) | |
480 | (setq fname (format "%s%d" base x)) | |
481 | (while (file-exists-p | |
482 | (expand-file-name fname url-temporary-directory)) | |
483 | (setq x (1+ x) | |
484 | fname (concat base (int-to-string x)))) | |
485 | (expand-file-name fname url-temporary-directory)) | |
486 | (let ((base (concat "url" (int-to-string (user-real-uid)))) | |
487 | (fname "") | |
488 | (x 0)) | |
489 | (setq fname (format fmt (concat base (int-to-string x)))) | |
490 | (while (file-exists-p | |
491 | (expand-file-name fname url-temporary-directory)) | |
492 | (setq x (1+ x) | |
493 | fname (format fmt (concat base (int-to-string x))))) | |
494 | (expand-file-name fname url-temporary-directory)))) | |
495 | ||
496 | (defun url-extract-mime-headers () | |
497 | "Set `url-current-mime-headers' in current buffer." | |
498 | (save-excursion | |
499 | (goto-char (point-min)) | |
500 | (unless url-current-mime-headers | |
501 | (set (make-local-variable 'url-current-mime-headers) | |
502 | (mail-header-extract))))) | |
503 | ||
504 | (provide 'url-util) | |
e5566bd5 | 505 | |
a2fd1462 SM |
506 | ;; arch-tag: 24352abc-5a5a-412e-90cd-313b26bed5c9 |
507 | ;;; url-util.el ends here |