shr.el 57.1 KB
Newer Older
1 2
;;; shr.el --- Simple HTML Renderer

3
;; Copyright (C) 2010-2014 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: html

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This package takes a HTML parse tree (as provided by
;; libxml-parse-html-region) and renders it in the current buffer.  It
;; does not do CSS, JavaScript or anything advanced: It's geared
;; towards rendering typical short snippets of HTML, like what you'd
;; find in HTML email and the like.

;;; Code:

33
(eval-when-compile (require 'cl))
34
(eval-when-compile (require 'url))      ;For url-filename's setf handler.
35 36
(require 'browse-url)

37 38
(defgroup shr nil
  "Simple HTML Renderer"
39
  :version "24.1"
40
  :group 'hypermedia)
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

(defcustom shr-max-image-proportion 0.9
  "How big pictures displayed are in relation to the window they're in.
A value of 0.7 means that they are allowed to take up 70% of the
width and height of the window.  If they are larger than this,
and Emacs supports it, then the images will be rescaled down to
fit these criteria."
  :version "24.1"
  :group 'shr
  :type 'float)

(defcustom shr-blocked-images nil
  "Images that have URLs matching this regexp will be blocked."
  :version "24.1"
  :group 'shr
56
  :type '(choice (const nil) regexp))
57

58 59 60
(defcustom shr-table-horizontal-line nil
  "Character used to draw horizontal table lines.
If nil, don't draw horizontal table lines."
61
  :group 'shr
Glenn Morris's avatar
Glenn Morris committed
62
  :type '(choice (const nil) character))
63

64
(defcustom shr-table-vertical-line ?\s
65
  "Character used to draw vertical table lines."
66
  :group 'shr
67
  :type 'character)
68

69
(defcustom shr-table-corner ?\s
70
  "Character used to draw table corners."
71
  :group 'shr
72
  :type 'character)
73 74

(defcustom shr-hr-line ?-
75
  "Character used to draw hr lines."
76
  :group 'shr
77
  :type 'character)
78

79
(defcustom shr-width fill-column
80 81 82 83 84 85
  "Frame width to use for rendering.
May either be an integer specifying a fixed width in characters,
or nil, meaning that the full width of the window should be
used."
  :type '(choice (integer :tag "Fixed width in characters")
		 (const   :tag "Use the width of the window" nil))
86 87
  :group 'shr)

88 89 90 91 92
(defcustom shr-bullet "* "
  "Bullet used for unordered lists.
Alternative suggestions are:
- \"  \"
- \"  \""
93
  :version "24.4"
94 95 96
  :type 'string
  :group 'shr)

97 98 99 100 101 102
(defcustom shr-external-browser 'browse-url-default-browser
  "Function used to launch an external browser."
  :version "24.4"
  :group 'shr
  :type 'function)

103
(defcustom shr-image-animate t
Glenn Morris's avatar
Glenn Morris committed
104
  "Non nil means that images that can be animated will be."
105 106 107 108
  :version "24.4"
  :group 'shr
  :type 'boolean)

109 110 111 112 113
(defvar shr-content-function nil
  "If bound, this should be a function that will return the content.
This is used for cid: URLs, and the function is called with the
cid: URL as the argument.")

114 115 116
(defvar shr-put-image-function 'shr-put-image
  "Function called to put image and alt string.")

117 118 119 120
(defface shr-strike-through '((t (:strike-through t)))
  "Font for <s> elements."
  :group 'shr)

121
(defface shr-link
122
  '((t (:inherit link)))
123
  "Font for link elements."
124 125
  :group 'shr)

126 127 128
(defvar shr-inhibit-images nil
  "If non-nil, inhibit loading images.")

129 130
;;; Internal variables.

131 132 133
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
134
(defvar shr-indentation 0)
135
(defvar shr-internal-width (or shr-width (1- (window-width))))
136
(defvar shr-list-mode nil)
137
(defvar shr-content-cache nil)
138
(defvar shr-kinsoku-shorten nil)
139
(defvar shr-table-depth 0)
140
(defvar shr-stylesheet nil)
141
(defvar shr-base nil)
142 143
(defvar shr-depth 0)
(defvar shr-warning nil)
144
(defvar shr-ignore-cache nil)
145
(defvar shr-external-rendering-functions nil)
146
(defvar shr-target-id nil)
147
(defvar shr-inhibit-decoration nil)
148
(defvar shr-table-separator-length 1)
149

150 151 152 153
(defvar shr-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'shr-show-alt-text)
    (define-key map "i" 'shr-browse-image)
154
    (define-key map "z" 'shr-zoom-image)
155 156
    (define-key map [?\t] 'shr-next-link)
    (define-key map [?\M-\t] 'shr-previous-link)
157
    (define-key map [follow-link] 'mouse-face)
158
    (define-key map [mouse-2] 'shr-browse-url)
159
    (define-key map "I" 'shr-insert-image)
160
    (define-key map "w" 'shr-copy-url)
161
    (define-key map "u" 'shr-copy-url)
162
    (define-key map "v" 'shr-browse-url)
163
    (define-key map "o" 'shr-save-contents)
164 165 166
    (define-key map "\r" 'shr-browse-url)
    map))

167
;; Public functions and commands.
168 169
(declare-function libxml-parse-html-region "xml.c"
		  (start end &optional base-url))
170

171 172 173
(defun shr-render-buffer (buffer)
  "Display the HTML rendering of the current buffer."
  (interactive (list (current-buffer)))
174 175
  (or (fboundp 'libxml-parse-html-region)
      (error "This function requires Emacs to be compiled with libxml2"))
176 177 178
  (pop-to-buffer "*html*")
  (erase-buffer)
  (shr-insert-document
179
   (with-current-buffer buffer
180 181
     (libxml-parse-html-region (point-min) (point-max))))
  (goto-char (point-min)))
182

183
;;;###autoload
184 185 186 187 188 189 190 191 192 193 194
(defun shr-render-region (begin end &optional buffer)
  "Display the HTML rendering of the region between BEGIN and END."
  (interactive "r")
  (unless (fboundp 'libxml-parse-html-region)
    (error "This function requires Emacs to be compiled with libxml2"))
  (with-current-buffer (or buffer (current-buffer))
    (let ((dom (libxml-parse-html-region begin end)))
      (delete-region begin end)
      (goto-char begin)
      (shr-insert-document dom))))

195 196
;;;###autoload
(defun shr-insert-document (dom)
197 198 199
  "Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
200
  (setq shr-content-cache nil)
201 202
  (let ((start (point))
	(shr-state nil)
203
	(shr-start nil)
204
	(shr-base nil)
205 206
	(shr-depth 0)
	(shr-warning nil)
207
	(shr-internal-width (or shr-width (1- (window-width)))))
208
    (shr-descend (shr-transform-dom dom))
209 210 211
    (shr-remove-trailing-whitespace start (point))
    (when shr-warning
      (message "%s" shr-warning))))
212 213

(defun shr-remove-trailing-whitespace (start end)
214 215 216 217 218 219
  (let ((width (window-width)))
    (save-restriction
      (narrow-to-region start end)
      (goto-char start)
      (while (not (eobp))
	(end-of-line)
220
	(when (> (shr-previous-newline-padding-width (current-column)) width)
221 222 223 224
	  (dolist (overlay (overlays-at (point)))
	    (when (overlay-get overlay 'before-string)
	      (overlay-put overlay 'before-string nil))))
	(forward-line 1)))))
225

226
(defun shr-copy-url (&optional image-url)
227
  "Copy the URL under point to the kill ring.
228 229 230
If IMAGE-URL (the prefix) is non-nil, or there is no link under
point, but there is an image under point then copy the URL of the
image under point instead.
231 232
If called twice, then try to fetch the URL and see whether it
redirects somewhere else."
233 234 235
  (interactive "P")
  (let ((url (or (get-text-property (point) 'shr-url)
		 (get-text-property (point) 'image-url))))
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    (cond
     ((not url)
      (message "No URL under point"))
     ;; Resolve redirected URLs.
     ((equal url (car kill-ring))
      (url-retrieve
       url
       (lambda (a)
	 (when (and (consp a)
		    (eq (car a) :redirect))
	   (with-temp-buffer
	     (insert (cadr a))
	     (goto-char (point-min))
	     ;; Remove common tracking junk from the URL.
	     (when (re-search-forward ".utm_.*" nil t)
	       (replace-match "" t t))
	     (message "Copied %s" (buffer-string))
253 254
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
255 256 257
     ;; Copy the URL to the kill ring.
     (t
      (with-temp-buffer
258
	(insert (url-encode-url url))
259
	(copy-region-as-kill (point-min) (point-max))
260
	(message "Copied %s" (buffer-string)))))))
261

262 263 264
(defun shr-next-link ()
  "Skip to the next link."
  (interactive)
265
  (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
266
    (if (not (setq skip (text-property-not-all skip (point-max)
267
					       'help-echo nil)))
268 269 270 271 272 273 274 275 276 277 278
	(message "No next link")
      (goto-char skip)
      (message "%s" (get-text-property (point) 'help-echo)))))

(defun shr-previous-link ()
  "Skip to the previous link."
  (interactive)
  (let ((start (point))
	(found nil))
    ;; Skip past the current link.
    (while (and (not (bobp))
279
		(get-text-property (point) 'help-echo))
280 281 282
      (forward-char -1))
    ;; Find the previous link.
    (while (and (not (bobp))
283
		(not (setq found (get-text-property (point) 'help-echo))))
284 285 286 287 288 289 290
      (forward-char -1))
    (if (not found)
	(progn
	  (message "No previous link")
	  (goto-char start))
      ;; Put point at the start of the link.
      (while (and (not (bobp))
291
		  (get-text-property (point) 'help-echo))
292 293 294 295
	(forward-char -1))
      (forward-char 1)
      (message "%s" (get-text-property (point) 'help-echo)))))

296 297 298 299 300 301 302 303
(defun shr-show-alt-text ()
  "Show the ALT text of the image under point."
  (interactive)
  (let ((text (get-text-property (point) 'shr-alt)))
    (if (not text)
	(message "No image under point")
      (message "%s" text))))

304 305 306 307 308
(defun shr-browse-image (&optional copy-url)
  "Browse the image under point.
If COPY-URL (the prefix if called interactively) is non-nil, copy
the URL of the image to the kill buffer instead."
  (interactive "P")
309
  (let ((url (get-text-property (point) 'image-url)))
310 311 312 313 314 315 316 317 318
    (cond
     ((not url)
      (message "No image under point"))
     (copy-url
      (with-temp-buffer
	(insert url)
	(copy-region-as-kill (point-min) (point-max))
	(message "Copied %s" url)))
     (t
319
      (message "Browsing %s..." url)
320
      (browse-url url)))))
321

322 323 324
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
325
  (let ((url (get-text-property (point) 'image-url)))
326 327 328 329 330
    (if (not url)
	(message "No image under point")
      (message "Inserting %s..." url)
      (url-retrieve url 'shr-image-fetched
		    (list (current-buffer) (1- (point)) (point-marker))
331
		    t t))))
332

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
(defun shr-zoom-image ()
  "Toggle the image size.
The size will be rotated between the default size, the original
size, and full-buffer size."
  (interactive)
  (let ((url (get-text-property (point) 'image-url))
	(size (get-text-property (point) 'image-size))
	(buffer-read-only nil))
    (if (not url)
	(message "No image under point")
      ;; Delete the old picture.
      (while (get-text-property (point) 'image-url)
	(forward-char -1))
      (forward-char 1)
      (let ((start (point)))
	(while (get-text-property (point) 'image-url)
	  (forward-char 1))
	(forward-char -1)
	(put-text-property start (point) 'display nil)
	(when (> (- (point) start) 2)
	  (delete-region start (1- (point)))))
      (message "Inserting %s..." url)
      (url-retrieve url 'shr-image-fetched
		    (list (current-buffer) (1- (point)) (point-marker)
			  (list (cons 'size
				      (cond ((or (eq size 'default)
						 (null size))
					     'original)
					    ((eq size 'original)
					     'full)
					    ((eq size 'full)
					     'default)))))
		    t))))

367 368
;;; Utility functions.

369 370 371 372 373 374 375 376
(defun shr-transform-dom (dom)
  (let ((result (list (pop dom))))
    (dolist (arg (pop dom))
      (push (cons (intern (concat ":" (symbol-name (car arg))) obarray)
		  (cdr arg))
	    result))
    (dolist (sub dom)
      (if (stringp sub)
377
	  (push (cons 'text sub) result)
378 379 380
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

381 382 383 384 385 386 387
(defun shr-retransform-dom (dom)
  "Transform the shr DOM back into the libxml DOM."
  (let ((tag (car dom))
	(attributes nil)
	(sub-nodes nil))
    (dolist (elem (cdr dom))
      (cond
388
       ((and (stringp (cdr elem))
389
	     (eq (car elem) 'text))
390
	(push (cdr elem) sub-nodes))
391
       ((not (listp (cdr elem)))
392 393 394 395 396 397
	(push (cons (intern (substring (symbol-name (car elem)) 1) obarray)
		    (cdr elem))
	      attributes))
       (t
	(push (shr-retransform-dom elem) sub-nodes))))
    (append (list tag (nreverse attributes))
398
	    (nreverse sub-nodes))))
399

400 401 402 403 404 405 406 407
(defsubst shr-generic (cont)
  (dolist (sub cont)
    (cond
     ((eq (car sub) 'text)
      (shr-insert (cdr sub)))
     ((listp (cdr sub))
      (shr-descend sub)))))

408
(defun shr-descend (dom)
409 410 411 412 413 414
  (let ((function
	 (or
	  ;; Allow other packages to override (or provide) rendering
	  ;; of elements.
	  (cdr (assq (car dom) shr-external-rendering-functions))
	  (intern (concat "shr-tag-" (symbol-name (car dom))) obarray)))
415
	(style (cdr (assq :style (cdr dom))))
416
	(shr-stylesheet shr-stylesheet)
417
	(shr-depth (1+ shr-depth))
418
	(start (point)))
419 420 421
    ;; shr uses about 12 frames per nested node.
    (if (> shr-depth (/ max-specpdl-size 12))
	(setq shr-warning "Too deeply nested to render properly; consider increasing `max-specpdl-size'")
422
      (when style
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
	(if (string-match "color\\|display\\|border-collapse" style)
	    (setq shr-stylesheet (nconc (shr-parse-style style)
					shr-stylesheet))
	  (setq style nil)))
      ;; If we have a display:none, then just ignore this part of the DOM.
      (unless (equal (cdr (assq 'display shr-stylesheet)) "none")
	(if (fboundp function)
	    (funcall function (cdr dom))
	  (shr-generic (cdr dom)))
	(when (and shr-target-id
		   (equal (cdr (assq :id (cdr dom))) shr-target-id))
	  ;; If the element was empty, we don't have anything to put the
	  ;; anchor on.  So just insert a dummy character.
	  (when (= start (point))
	    (insert "*"))
	  (put-text-property start (1+ start) 'shr-target-id shr-target-id))
	;; If style is set, then this node has set the color.
	(when style
	  (shr-colorize-region
	   start (point)
	   (cdr (assq 'color shr-stylesheet))
	   (cdr (assq 'background-color shr-stylesheet))))))))
445

446 447 448 449 450 451 452 453 454 455 456 457 458
(defmacro shr-char-breakable-p (char)
  "Return non-nil if a line can be broken before and after CHAR."
  `(aref fill-find-break-point-function-table ,char))
(defmacro shr-char-nospace-p (char)
  "Return non-nil if no space is required before and after CHAR."
  `(aref fill-nospace-between-words-table ,char))

;; KINSOKU is a Japanese word meaning a rule that should not be violated.
;; In Emacs, it is a term used for characters, e.g. punctuation marks,
;; parentheses, and so on, that should not be placed in the beginning
;; of a line or the end of a line.
(defmacro shr-char-kinsoku-bol-p (char)
  "Return non-nil if a line ought not to begin with CHAR."
459 460 461
  `(let ((char ,char))
     (and (not (eq char ?'))
	  (aref (char-category-set char) ?>))))
462 463 464 465 466 467
(defmacro shr-char-kinsoku-eol-p (char)
  "Return non-nil if a line ought not to end with CHAR."
  `(aref (char-category-set ,char) ?<))
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
  (load "kinsoku" nil t))

468
(defun shr-insert (text)
469
  (when (and (eq shr-state 'image)
470
	     (not (bolp))
471
	     (not (string-match "\\`[ \t\n]+\\'" text)))
472 473 474 475 476 477
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
478
    (when (and (string-match "\\`[ \t\n ]" text)
479 480 481
	       (not (bolp))
	       (not (eq (char-after (1- (point))) ? )))
      (insert " "))
482
    (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
483 484 485 486
      (when (and (bolp)
		 (> shr-indentation 0))
	(shr-indent))
      ;; No space is needed behind a wide character categorized as
487 488
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
489
      (let (prev)
490 491
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
492
		   (or (= (line-beginning-position) (1- (point)))
493 494 495 496 497
		       (and (shr-char-breakable-p
			     (setq prev (char-after (- (point) 2))))
			    (shr-char-kinsoku-bol-p prev))
		       (and (shr-char-nospace-p prev)
			    (shr-char-nospace-p (aref elem 0)))))
498
	  (delete-char -1)))
499 500 501 502 503
      ;; The shr-start is a special variable that is used to pass
      ;; upwards the first point in the buffer where the text really
      ;; starts.
      (unless shr-start
	(setq shr-start (point)))
504
      (insert elem)
505
      (setq shr-state nil)
506
      (let (found)
507 508
	(while (and (> (current-column) shr-internal-width)
		    (> shr-internal-width 0)
509 510 511
		    (progn
		      (setq found (shr-find-fill-point))
		      (not (eolp))))
512 513 514 515
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
516 517 518 519 520 521
	    ;; No space is needed at the beginning of a line.
	    (when (eq (following-char) ? )
	      (delete-char 1)))
	  (when (> shr-indentation 0)
	    (shr-indent))
	  (end-of-line))
522
	(if (<= (current-column) shr-internal-width)
523 524
	    (insert " ")
	  ;; In case we couldn't get a valid break point (because of a
525
	  ;; word that's longer than `shr-internal-width'), just break anyway.
526 527 528
	  (insert "\n")
	  (when (> shr-indentation 0)
	    (shr-indent)))))
529
    (unless (string-match "[ \t\r\n ]\\'" text)
530
      (delete-char -1)))))
531

532
(defun shr-find-fill-point ()
533
  (when (> (move-to-column shr-internal-width) shr-internal-width)
534
    (backward-char 1))
535 536
  (let ((bp (point))
	failed)
537
    (while (not (or (setq failed (<= (current-column) shr-indentation))
538 539 540 541
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
542 543 544
		    (and (shr-char-kinsoku-bol-p (preceding-char))
			 (shr-char-breakable-p (following-char))
			 (not (shr-char-kinsoku-bol-p (following-char))))
545 546
		    (shr-char-kinsoku-eol-p (following-char))
		    (bolp)))
547 548
      (backward-char 1))
    (if failed
549
	;; There's no breakable point, so we give it up.
550 551 552
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
553 554 555
	    (while (setq found (re-search-forward
				"\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				(line-end-position) 'move)))
556 557
	    (if (and found
		     (not (match-beginning 1)))
558
		(goto-char (match-beginning 0)))))
559 560
      (or
       (eolp)
561 562 563 564 565 566 567
       ;; Don't put kinsoku-bol characters at the beginning of a line,
       ;; or kinsoku-eol characters at the end of a line.
       (cond
	(shr-kinsoku-shorten
	 (while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
		     (shr-char-kinsoku-eol-p (preceding-char)))
	   (backward-char 1))
568
	 (when (setq failed (<= (current-column) shr-indentation))
569 570 571 572
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
573
			 (<= (current-column) shr-internal-width))
574 575 576 577 578
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
579 580 581 582 583 584 585 586 587
	 ;; Find backward the point where kinsoku-eol characters begin.
	 (let ((count 4))
	   (while
	       (progn
		 (backward-char 1)
		 (and (> (setq count (1- count)) 0)
		      (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
		      (or (shr-char-kinsoku-eol-p (preceding-char))
			  (shr-char-kinsoku-bol-p (following-char)))))))
588
	 (when (setq failed (<= (current-column) shr-indentation))
589 590 591 592 593
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we go to the second best position.
	   (if (looking-at "\\(\\c<+\\)\\c<")
	       (goto-char (match-end 1))
	     (forward-char 1))))
594
	((shr-char-kinsoku-bol-p (following-char))
595 596 597 598 599
	 ;; Find forward the point where kinsoku-bol characters end.
	 (let ((count 4))
	   (while (progn
		    (forward-char 1)
		    (and (>= (setq count (1- count)) 0)
600
			 (shr-char-kinsoku-bol-p (following-char))
601
			 (shr-char-breakable-p (following-char))))))))
602 603 604
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
605

606 607 608 609
(defun shr-parse-base (url)
  ;; Always chop off anchors.
  (when (string-match "#.*" url)
    (setq url (substring url 0 (match-beginning 0))))
Ivan Shmakov's avatar
Ivan Shmakov committed
610 611
  ;; NB: <base href="" > URI may itself be relative to the document s URI
  (setq url (shr-expand-url url))
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
  (let* ((parsed (url-generic-parse-url url))
	 (local (url-filename parsed)))
    (setf (url-filename parsed) "")
    ;; Chop off the bit after the last slash.
    (when (string-match "\\`\\(.*/\\)[^/]+\\'" local)
      (setq local (match-string 1 local)))
    ;; Always make the local bit end with a slash.
    (when (and (not (zerop (length local)))
	       (not (eq (aref local (1- (length local))) ?/)))
      (setq local (concat local "/")))
    (list (url-recreate-url parsed)
	  local
	  (url-type parsed)
	  url)))

627 628
(autoload 'url-expand-file-name "url-expand")

Glenn Morris's avatar
Glenn Morris committed
629 630
;; FIXME This needs some tests writing.
;; Does it even need to exist, given that url-expand-file-name does?
631 632 633
(defun shr-expand-url (url &optional base)
  (setq base
	(if base
Ivan Shmakov's avatar
Ivan Shmakov committed
634
	    ;; shr-parse-base should never call this with non-nil base!
635 636 637 638 639 640 641 642
	    (shr-parse-base base)
	  ;; Bound by the parser.
	  shr-base))
  (when (zerop (length url))
    (setq url nil))
  (cond ((or (not url)
	     (not base)
	     (string-match "\\`[a-z]*:" url))
Ivan Shmakov's avatar
Ivan Shmakov committed
643 644
	 ;; Absolute or empty URI
	 (or url (nth 3 base)))
645 646 647 648 649 650 651 652 653 654 655 656
	((eq (aref url 0) ?/)
	 (if (and (> (length url) 1)
		  (eq (aref url 1) ?/))
	     ;; //host...; just use the protocol
	     (concat (nth 2 base) ":" url)
	   ;; Just use the host name part.
	   (concat (car base) url)))
	((eq (aref url 0) ?#)
	 ;; A link to an anchor.
	 (concat (nth 3 base) url))
	(t
	 ;; Totally relative.
657
	 (url-expand-file-name url (concat (car base) (cadr base))))))
658

659 660 661
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
662 663 664

(defun shr-ensure-paragraph ()
  (unless (bobp)
665
    (if (<= (current-column) shr-indentation)
666 667 668
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
669 670 671
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
672 673 674 675 676 677 678 679
	    ;; If the current line is totally blank, and doesn't even
	    ;; have any face properties set, then delete the blank
	    ;; space.
	    (and (looking-at " *$")
		 (not (get-text-property (point) 'face))
		 (not (= (next-single-property-change (point) 'face nil
						      (line-end-position))
			 (line-end-position)))))
680
	  (delete-region (match-beginning 0) (match-end 0))
681 682
	(insert "\n\n")))))

683
(defun shr-indent ()
684 685
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
686

687
(defun shr-fontize-cont (cont &rest types)
688 689
  (let (shr-start)
    (shr-generic cont)
690 691
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
692

693 694 695
;; Add face to the region, but avoid putting the font properties on
;; blank text at the start of the line, and the newline at the end, to
;; avoid ugliness.
696
(defun shr-add-font (start end type)
697 698 699 700 701 702 703 704 705 706
  (unless shr-inhibit-decoration
    (save-excursion
      (goto-char start)
      (while (< (point) end)
	(when (bolp)
	  (skip-chars-forward " "))
	(add-face-text-property (point) (min (line-end-position) end) type t)
	(if (< (line-end-position) end)
	    (forward-line 1)
	  (goto-char end))))))
707

708 709 710 711 712 713
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

714
(defun shr-browse-url (&optional external mouse-event)
715 716
  "Browse the URL under point.
If EXTERNAL, browse the URL using `shr-external-browser'."
717 718
  (interactive (list current-prefix-arg last-nonmenu-event))
  (mouse-set-point mouse-event)
719
  (let ((url (get-text-property (point) 'shr-url)))
720 721 722 723
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
724
      (browse-url-mail url))
725
     (t
726 727 728
      (if external
	  (funcall shr-external-browser url)
	(browse-url url))))))
729

730 731 732 733 734 735 736
(defun shr-save-contents (directory)
  "Save the contents from URL in a file."
  (interactive "DSave contents of URL to directory: ")
  (let ((url (get-text-property (point) 'shr-url)))
    (if (not url)
	(message "No link under point")
      (url-retrieve (shr-encode-url url)
737 738
		    'shr-store-contents (list url directory)
		    nil t))))
739 740 741 742 743 744 745 746 747

(defun shr-store-contents (status url directory)
  (unless (plist-get status :error)
    (when (or (search-forward "\n\n" nil t)
	      (search-forward "\r\n\r\n" nil t))
      (write-region (point) (point-max)
		    (expand-file-name (file-name-nondirectory url)
				      directory)))))

748
(defun shr-image-fetched (status buffer start end &optional flags)
749 750 751 752 753 754
  (let ((image-buffer (current-buffer)))
    (when (and (buffer-name buffer)
	       (not (plist-get status :error)))
      (url-store-in-cache image-buffer)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
755
	(let ((data (shr-parse-image-data)))
756 757 758
	  (with-current-buffer buffer
	    (save-excursion
	      (let ((alt (buffer-substring start end))
759
		    (properties (text-properties-at start))
760 761 762
		    (inhibit-read-only t))
		(delete-region start end)
		(goto-char start)
763 764 765 766 767 768
		(funcall shr-put-image-function data alt flags)
		(while properties
		  (let ((type (pop properties))
			(value (pop properties)))
		    (unless (memq type '(display image-size))
		      (put-text-property start (point) type value))))))))))
769
    (kill-buffer image-buffer)))
770

771 772 773 774 775 776 777 778 779 780 781
(defun shr-image-from-data (data)
  "Return an image from the data: URI content DATA."
  (when (string-match
	 "\\(\\([^/;,]+\\(/[^;,]+\\)?\\)\\(;[^;,]+\\)*\\)?,\\(.*\\)"
	 data)
    (let ((param (match-string 4 data))
	  (payload (url-unhex-string (match-string 5 data))))
      (when (string-match "^.*\\(;[ \t]*base64\\)$" param)
	(setq payload (base64-decode-string payload)))
      payload)))

782 783 784 785
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))

786 787 788 789
(defun shr-put-image (spec alt &optional flags)
  "Insert image SPEC with a string ALT.  Return image.
SPEC is either an image data blob, or a list where the first
element is the data blob and the second element is the content-type."
790
  (if (display-graphic-p)
791
      (let* ((size (cdr (assq 'size flags)))
792 793 794 795 796
	     (data (if (consp spec)
		       (car spec)
		     spec))
	     (content-type (and (consp spec)
				(cadr spec)))
797 798 799
	     (start (point))
	     (image (cond
		     ((eq size 'original)
800
		      (create-image data nil t :ascent 100
801
				    :format content-type))
802 803
		     ((eq content-type 'image/svg+xml)
		      (create-image data 'svg t :ascent 100))
804 805
		     ((eq size 'full)
		      (ignore-errors
806
			(shr-rescale-image data content-type)))
807 808
		     (t
		      (ignore-errors
809
			(shr-rescale-image data content-type))))))
810
        (when image
811 812 813 814 815
	  ;; When inserting big-ish pictures, put them at the
	  ;; beginning of the line.
	  (when (and (> (current-column) 0)
		     (> (car (image-size image t)) 400))
	    (insert "\n"))
816
	  (if (eq size 'original)
817
	      (insert-sliced-image image (or alt "*") nil 20 1)
818 819
	    (insert-image image (or alt "*")))
	  (put-text-property start (point) 'image-size size)
820 821
	  (when (and shr-image-animate
                     (cond ((fboundp 'image-multi-frame-p)
822 823 824
		       ;; Only animate multi-frame things that specify a
		       ;; delay; eg animated gifs as opposed to
		       ;; multi-page tiffs.  FIXME?
825 826 827 828
                            (cdr (image-multi-frame-p image)))
                           ((fboundp 'image-animated-p)
                            (image-animated-p image))))
            (image-animate image nil 60)))
829
	image)
830
    (insert alt)))
831

832 833 834 835
(defun shr-rescale-image (data &optional content-type)
  "Rescale DATA, if too big, to fit the current buffer."
  (if (not (and (fboundp 'imagemagick-types)
                (get-buffer-window (current-buffer))))
836 837 838 839 840 841 842 843 844
      (create-image data nil t :ascent 100)
    (let ((edges (window-inside-pixel-edges
		  (get-buffer-window (current-buffer)))))
      (create-image
       data 'imagemagick t
       :ascent 100
       :max-width (truncate (* shr-max-image-proportion
			       (- (nth 2 edges) (nth 0 edges))))
       :max-height (truncate (* shr-max-image-proportion
845
				(- (nth 3 edges) (nth 1 edges))))
846
       :format content-type))))
847

Glenn Morris's avatar
Glenn Morris committed
848 849 850
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
851
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
852

853 854 855 856 857
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
858
    (when (ignore-errors
859
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
860 861 862
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
863 864 865
	(shr-parse-image-data)))))

(defun shr-parse-image-data ()
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
  (let ((data (buffer-substring (point) (point-max)))
	(content-type
	 (save-excursion
	   (save-restriction
	     (narrow-to-region (point-min) (point))
	     (let ((content-type (mail-fetch-field "content-type")))
	       (and content-type
		    ;; Remove any comments in the type string.
		    (intern (replace-regexp-in-string ";.*" "" content-type)
			    obarray)))))))
    ;; SVG images may contain references to further images that we may
    ;; want to block.  So special-case these by parsing the XML data
    ;; and remove the blocked bits.
    (when (eq content-type 'image/svg+xml)
      (setq data
	    (shr-dom-to-xml
	     (shr-transform-dom
	      (libxml-parse-xml-region (point) (point-max))))))
    (list data content-type)))
885

886 887 888 889
(defun shr-image-displayer (content-function)
  "Return a function to display an image.
CONTENT-FUNCTION is a function to retrieve an image for a cid url that
is an argument.  The function to be returned takes three arguments URL,
Paul Eggert's avatar
Paul Eggert committed
890
START, and END.  Note that START and END should be markers."
891
  `(lambda (url start end)
892 893 894 895 896 897 898
     (when url
       (if (string-match "\\`cid:" url)
	   ,(when content-function
	      `(let ((image (funcall ,content-function
				     (substring url (match-end 0)))))
		 (when image
		   (goto-char start)
899
		   (funcall shr-put-image-function
900
			    image (buffer-substring start end))
901
		   (delete-region (point) end))))
902 903
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
904
		       t t)))))
905

906 907 908 909 910
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

911
(defun shr-urlify (start url &optional title)
912
  (shr-add-font start (point) 'shr-link)
913 914 915
  (add-text-properties
   start (point)
   (list 'shr-url url
916
	 'help-echo (if title (format "%s (%s)" url title) url)
917
	 'follow-link t
918
	 'mouse-face 'highlight
919
	 'keymap shr-map)))
920 921 922 923 924

(defun shr-encode-url (url)
  "Encode URL."
  (browse-url-url-encode-chars url "[)$ ]"))

925 926
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949

(defun shr-color-check (fg bg)
  "Check that FG is visible on BG.
Returns (fg bg) with corrected values.
Returns nil if the colors that would be used are the default
ones, in case fg and bg are nil."
  (when (or fg bg)
    (let ((fixed (cond ((null fg) 'fg)
                       ((null bg) 'bg))))
      ;; Convert colors to hexadecimal, or set them to default.
      (let ((fg (or (shr-color->hexadecimal fg)
                    (frame-parameter nil 'foreground-color)))
            (bg (or (shr-color->hexadecimal bg)
                    (frame-parameter nil 'background-color))))
        (cond ((eq fixed 'bg)
               ;; Only return the new fg
               (list nil (cadr (shr-color-visible bg fg t))))
              ((eq fixed 'fg)
               ;; Invert args and results and return only the new bg
               (list (cadr (shr-color-visible fg bg t)) nil))
              (t
               (shr-color-visible bg fg)))))))

950
(defun shr-colorize-region (start end fg &optional bg)
951 952
  (when (and (not shr-inhibit-decoration)
	     (or fg bg))
953
    (let ((new-colors (shr-color-check fg bg)))
954
      (when new-colors
955
	(when fg
956 957 958
	  (add-face-text-property start end
				  (list :foreground (cadr new-colors))
				  t))
959
	(when bg
960 961 962
	  (add-face-text-property start end
				  (list :background (car new-colors))
				  t)))
963
      new-colors)))
964

965 966
(defun shr-expand-newlines (start end color)
  (save-restriction