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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2010-2015 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
(require 'browse-url)
36 37
(require 'subr-x)
(require 'dom)
38

39 40
(defgroup shr nil
  "Simple HTML Renderer"
41 42
  :version "25.1"
  :group 'web)
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

(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
58
  :type '(choice (const nil) regexp))
59

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

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

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

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

81
(defcustom shr-width nil
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."
86
  :version "25.1"
87 88
  :type '(choice (integer :tag "Fixed width in characters")
		 (const   :tag "Use the width of the window" nil))
89 90
  :group 'shr)

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

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

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

112 113 114 115 116
(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.")

117 118 119
(defvar shr-put-image-function 'shr-put-image
  "Function called to put image and alt string.")

120 121 122 123
(defface shr-strike-through '((t (:strike-through t)))
  "Font for <s> elements."
  :group 'shr)

124
(defface shr-link
125
  '((t (:inherit link)))
126
  "Font for link elements."
127 128
  :group 'shr)

129 130 131
(defvar shr-inhibit-images nil
  "If non-nil, inhibit loading images.")

132 133
;;; Internal variables.

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

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

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

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

186
;;;###autoload
187 188 189 190 191 192 193 194 195 196 197
(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))))

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

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

229
(defun shr-copy-url (&optional image-url)
230
  "Copy the URL under point to the kill ring.
231 232 233
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.
234 235
If called twice, then try to fetch the URL and see whether it
redirects somewhere else."
236 237 238
  (interactive "P")
  (let ((url (or (get-text-property (point) 'shr-url)
		 (get-text-property (point) 'image-url))))
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
    (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))
256 257
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
258 259 260
     ;; Copy the URL to the kill ring.
     (t
      (with-temp-buffer
261
	(insert (url-encode-url url))
262
	(copy-region-as-kill (point-min) (point-max))
263
	(message "Copied %s" (buffer-string)))))))
264

265 266 267
(defun shr-next-link ()
  "Skip to the next link."
  (interactive)
268
  (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
269 270 271
    (if (or (eobp)
	    (not (setq skip (text-property-not-all skip (point-max)
						   'help-echo nil))))
272 273 274 275 276 277 278 279 280 281 282
	(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))
283
		(get-text-property (point) 'help-echo))
284 285 286
      (forward-char -1))
    ;; Find the previous link.
    (while (and (not (bobp))
287
		(not (setq found (get-text-property (point) 'help-echo))))
288 289 290 291 292 293 294
      (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))
295
		  (get-text-property (point) 'help-echo))
296 297 298 299
	(forward-char -1))
      (forward-char 1)
      (message "%s" (get-text-property (point) 'help-echo)))))

300 301 302 303 304 305
(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")
306
      (message "%s" (shr-fold-text text)))))
307

308 309 310 311 312
(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")
313
  (let ((url (get-text-property (point) 'image-url)))
314 315 316 317 318 319 320 321 322
    (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
323
      (message "Browsing %s..." url)
324
      (browse-url url)))))
325

326 327 328
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
329
  (let ((url (get-text-property (point) 'image-url)))
330 331 332 333 334
    (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))
335
		    t t))))
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 367 368 369 370
(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))))

371 372
;;; Utility functions.

373 374 375 376 377
(defsubst shr-generic (dom)
  (dolist (sub (dom-children dom))
    (if (stringp sub)
	(shr-insert sub)
      (shr-descend sub))))
378

379
(defun shr-descend (dom)
380 381 382 383
  (let ((function
	 (or
	  ;; Allow other packages to override (or provide) rendering
	  ;; of elements.
384 385 386
	  (cdr (assq (dom-tag dom) shr-external-rendering-functions))
	  (intern (concat "shr-tag-" (symbol-name (dom-tag dom))) obarray)))
	(style (dom-attr dom 'style))
387
	(shr-stylesheet shr-stylesheet)
388
	(shr-depth (1+ shr-depth))
389
	(start (point)))
390 391 392
    ;; 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'")
393
      (when style
394 395 396 397 398 399 400
	(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)
401 402
	    (funcall function dom)
	  (shr-generic dom))
403
	(when (and shr-target-id
404
		   (equal (dom-attr dom 'id) shr-target-id))
405 406 407 408 409 410 411 412 413 414 415
	  ;; 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))))))))
416

417
(defun shr-fold-text (text)
418 419 420 421 422 423 424 425 426
  (if (zerop (length text))
      text
    (with-temp-buffer
      (let ((shr-indentation 0)
	    (shr-state nil)
	    (shr-start nil)
	    (shr-internal-width (window-width)))
	(shr-insert text)
	(buffer-string)))))
427

428
(define-inline shr-char-breakable-p (char)
429
  "Return non-nil if a line can be broken before and after CHAR."
430 431
  (inline-quote (aref fill-find-break-point-function-table ,char)))
(define-inline shr-char-nospace-p (char)
432
  "Return non-nil if no space is required before and after CHAR."
433
  (inline-quote (aref fill-nospace-between-words-table ,char)))
434 435 436 437 438

;; 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.
439
(define-inline shr-char-kinsoku-bol-p (char)
440
  "Return non-nil if a line ought not to begin with CHAR."
441 442 443 444
  (inline-letevals (char)
    (inline-quote (and (not (eq ,char ?'))
                       (aref (char-category-set ,char) ?>)))))
(define-inline shr-char-kinsoku-eol-p (char)
445
  "Return non-nil if a line ought not to end with CHAR."
446
  (inline-quote (aref (char-category-set ,char) ?<)))
447 448 449
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
  (load "kinsoku" nil t))

450
(defun shr-insert (text)
451
  (when (and (eq shr-state 'image)
452
	     (not (bolp))
453
	     (not (string-match "\\`[ \t\n]+\\'" text)))
454 455 456 457 458 459
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
460
    (when (and (string-match "\\`[ \t\n ]" text)
461 462 463
	       (not (bolp))
	       (not (eq (char-after (1- (point))) ? )))
      (insert " "))
464
    (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
465 466 467 468
      (when (and (bolp)
		 (> shr-indentation 0))
	(shr-indent))
      ;; No space is needed behind a wide character categorized as
469 470
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
471
      (let (prev)
472 473
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
474
		   (or (= (line-beginning-position) (1- (point)))
475 476 477 478 479
		       (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)))))
480
	  (delete-char -1)))
481 482 483 484 485
      ;; 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)))
486
      (insert elem)
487
      (setq shr-state nil)
488
      (let (found)
489 490
	(while (and (> (current-column) shr-internal-width)
		    (> shr-internal-width 0)
491 492 493
		    (progn
		      (setq found (shr-find-fill-point))
		      (not (eolp))))
494 495 496 497
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
498 499 500 501 502 503
	    ;; 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))
504
	(if (<= (current-column) shr-internal-width)
505 506
	    (insert " ")
	  ;; In case we couldn't get a valid break point (because of a
507
	  ;; word that's longer than `shr-internal-width'), just break anyway.
508 509 510
	  (insert "\n")
	  (when (> shr-indentation 0)
	    (shr-indent)))))
511
    (unless (string-match "[ \t\r\n ]\\'" text)
512
      (delete-char -1)))))
513

514
(defun shr-find-fill-point ()
515
  (when (> (move-to-column shr-internal-width) shr-internal-width)
516
    (backward-char 1))
517 518
  (let ((bp (point))
	failed)
519
    (while (not (or (setq failed (<= (current-column) shr-indentation))
520 521 522 523
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
524 525 526
		    (and (shr-char-kinsoku-bol-p (preceding-char))
			 (shr-char-breakable-p (following-char))
			 (not (shr-char-kinsoku-bol-p (following-char))))
527 528
		    (shr-char-kinsoku-eol-p (following-char))
		    (bolp)))
529 530
      (backward-char 1))
    (if failed
531
	;; There's no breakable point, so we give it up.
532 533 534
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
535 536 537
	    (while (setq found (re-search-forward
				"\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				(line-end-position) 'move)))
538 539
	    (if (and found
		     (not (match-beginning 1)))
540
		(goto-char (match-beginning 0)))))
541 542
      (or
       (eolp)
543 544 545 546 547 548 549
       ;; 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))
550
	 (when (setq failed (<= (current-column) shr-indentation))
551 552 553 554
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
555
			 (<= (current-column) shr-internal-width))
556 557 558 559 560
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
561 562 563 564 565 566 567 568 569
	 ;; 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)))))))
570
	 (when (setq failed (<= (current-column) shr-indentation))
571 572 573 574 575
	   ;; 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))))
576
	((shr-char-kinsoku-bol-p (following-char))
577 578 579 580 581
	 ;; Find forward the point where kinsoku-bol characters end.
	 (let ((count 4))
	   (while (progn
		    (forward-char 1)
		    (and (>= (setq count (1- count)) 0)
582
			 (shr-char-kinsoku-bol-p (following-char))
583
			 (shr-char-breakable-p (following-char))))))))
584 585 586
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
587

588 589 590 591
(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
592 593
  ;; NB: <base href="" > URI may itself be relative to the document s URI
  (setq url (shr-expand-url url))
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
  (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)))

609 610
(autoload 'url-expand-file-name "url-expand")

Glenn Morris's avatar
Glenn Morris committed
611 612
;; FIXME This needs some tests writing.
;; Does it even need to exist, given that url-expand-file-name does?
613 614 615
(defun shr-expand-url (url &optional base)
  (setq base
	(if base
Ivan Shmakov's avatar
Ivan Shmakov committed
616
	    ;; shr-parse-base should never call this with non-nil base!
617 618 619 620 621 622 623 624
	    (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
625 626
	 ;; Absolute or empty URI
	 (or url (nth 3 base)))
627 628 629 630 631 632 633 634 635 636 637 638
	((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.
639
	 (url-expand-file-name url (concat (car base) (cadr base))))))
640

641 642 643
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
644 645 646

(defun shr-ensure-paragraph ()
  (unless (bobp)
647
    (if (<= (current-column) shr-indentation)
648 649 650
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
651 652 653
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
654 655 656 657 658 659 660 661
	    ;; 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)))))
662
	  (delete-region (match-beginning 0) (match-end 0))
663 664
	(insert "\n\n")))))

665
(defun shr-indent ()
666 667
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
668

669
(defun shr-fontize-dom (dom &rest types)
670
  (let (shr-start)
671
    (shr-generic dom)
672 673
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
674

675 676 677
;; 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.
678
(defun shr-add-font (start end type)
679 680 681 682 683 684 685 686 687 688
  (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))))))
689

690 691 692 693 694 695
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

696
(defun shr-browse-url (&optional external mouse-event)
697 698
  "Browse the URL under point.
If EXTERNAL, browse the URL using `shr-external-browser'."
699 700
  (interactive (list current-prefix-arg last-nonmenu-event))
  (mouse-set-point mouse-event)
701
  (let ((url (get-text-property (point) 'shr-url)))
702 703 704 705
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
706
      (browse-url-mail url))
707
     (t
708 709 710
      (if external
	  (funcall shr-external-browser url)
	(browse-url url))))))
711

712 713 714 715 716 717 718
(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)
719 720
		    'shr-store-contents (list url directory)
		    nil t))))
721 722 723 724 725 726 727 728 729

(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)))))

730
(defun shr-image-fetched (status buffer start end &optional flags)
731 732 733 734 735 736
  (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))
737
	(let ((data (shr-parse-image-data)))
738 739 740
	  (with-current-buffer buffer
	    (save-excursion
	      (let ((alt (buffer-substring start end))
741
		    (properties (text-properties-at start))
742 743 744
		    (inhibit-read-only t))
		(delete-region start end)
		(goto-char start)
745 746 747 748 749 750
		(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))))))))))
751
    (kill-buffer image-buffer)))
752

753 754 755 756 757 758 759 760 761 762 763
(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)))

764 765 766 767
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))

768 769 770 771
(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."
772
  (if (display-graphic-p)
773
      (let* ((size (cdr (assq 'size flags)))
774 775 776 777 778
	     (data (if (consp spec)
		       (car spec)
		     spec))
	     (content-type (and (consp spec)
				(cadr spec)))
779 780 781
	     (start (point))
	     (image (cond
		     ((eq size 'original)
782
		      (create-image data nil t :ascent 100
783
				    :format content-type))
784 785
		     ((eq content-type 'image/svg+xml)
		      (create-image data 'svg t :ascent 100))
786 787
		     ((eq size 'full)
		      (ignore-errors
788
			(shr-rescale-image data content-type)))
789 790
		     (t
		      (ignore-errors
791
			(shr-rescale-image data content-type))))))
792
        (when image
793 794 795 796 797
	  ;; 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"))
798
	  (if (eq size 'original)
799
	      (insert-sliced-image image (or alt "*") nil 20 1)
800 801
	    (insert-image image (or alt "*")))
	  (put-text-property start (point) 'image-size size)
802 803
	  (when (and shr-image-animate
                     (cond ((fboundp 'image-multi-frame-p)
804 805 806
		       ;; Only animate multi-frame things that specify a
		       ;; delay; eg animated gifs as opposed to
		       ;; multi-page tiffs.  FIXME?
807 808 809 810
                            (cdr (image-multi-frame-p image)))
                           ((fboundp 'image-animated-p)
                            (image-animated-p image))))
            (image-animate image nil 60)))
811
	image)
812
    (insert alt)))
813

814 815 816 817
(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))))
818 819 820 821 822 823 824 825 826
      (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
827
				(- (nth 3 edges) (nth 1 edges))))
828
       :format content-type))))
829

Glenn Morris's avatar
Glenn Morris committed
830 831 832
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
833
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
834

835 836 837 838 839
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
840
    (when (ignore-errors
841
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
842 843 844
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
845 846 847
	(shr-parse-image-data)))))

(defun shr-parse-image-data ()
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
  (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
864
	     (libxml-parse-xml-region (point) (point-max)))))
865
    (list data content-type)))
866

867 868 869 870
(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
871
START, and END.  Note that START and END should be markers."
872
  `(lambda (url start end)
873 874 875 876 877 878 879
     (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)
880
		   (funcall shr-put-image-function
881
			    image (buffer-substring start end))
882
		   (delete-region (point) end))))
883 884
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
885
		       t t)))))
886

887
(defun shr-heading (dom &rest types)
888
  (shr-ensure-paragraph)
889
  (apply #'shr-fontize-dom dom types)
890 891
  (shr-ensure-paragraph))

892
(defun shr-urlify (start url &optional title)
893
  (shr-add-font start (point) 'shr-link)
894 895 896
  (add-text-properties
   start (point)
   (list 'shr-url url
897 898 899 900 901 902 903
	 'help-echo (let ((iri (or (with-demoted-errors
				       "shr-urlify: %s"
				     (decode-coding-string
				      (url-unhex-string url)
				      'utf-8 t))
				   url)))
		      (if title (format "%s (%s)" iri title) iri))
904
	 'follow-link t
905
	 'mouse-face 'highlight
906
	 'keymap shr-map)))
907 908 909 910 911

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

912 913
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936

(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)))))))

937
(defun shr-colorize-region (start end fg &optional bg)
938 939
  (when (and (not shr-inhibit-decoration)
	     (or fg bg))
940
    (let ((new-colors (shr-color-check fg bg)))
941
      (when new-colors