shr.el 56.3 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
(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 fill-column
82 83 84 85 86 87
  "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))
88 89
  :group 'shr)

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

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

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

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

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

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

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

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

131 132
;;; Internal variables.

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

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

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

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

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

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

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

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

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

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

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

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

370 371
;;; Utility functions.

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

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

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

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

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

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

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

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

606 607
(autoload 'url-expand-file-name "url-expand")

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

638 639 640
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
641 642 643

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

662
(defun shr-indent ()
663 664
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
665

666
(defun shr-fontize-dom (dom &rest types)
667
  (let (shr-start)
668
    (shr-generic dom)
669 670
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
671

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

687 688 689 690 691 692
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

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

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

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

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

750 751 752 753 754 755 756 757 758 759 760
(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)))

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

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

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

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

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

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

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

884
(defun shr-heading (dom &rest types)
885
  (shr-ensure-paragraph)
886
  (apply #'shr-fontize-dom dom types)
887 888
  (shr-ensure-paragraph))

889
(defun shr-urlify (start url &optional title)
890
  (shr-add-font start (point) 'shr-link)
891 892 893
  (add-text-properties
   start (point)
   (list 'shr-url url
894
	 'help-echo (if title (shr-fold-text (format "%s (%s)" url title)) url)
895
	 'follow-link t
896
	 'mouse-face 'highlight
897
	 'keymap shr-map)))
898 899 900 901 902

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

903 904
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927

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

928
(defun shr-colorize-region (start end fg &optional bg)
929 930
  (when (and (not shr-inhibit-decoration)
	     (or fg bg))
931
    (let ((new-colors (shr-color-check fg bg)))
932
      (when new-colors
933
	(when fg
934 935 936
	  (add-face-text-property start end
				  (list :foreground (cadr new-colors))
				  t))
937
	(when bg
938 939 940
	  (add-face-text-property start end
				  (list :background (car new-colors))
				  t)))
941
      new-colors)))
942

943 944
(defun shr-expand-newlines (start end color)
  (save-restriction
945 946 947 948 949 950 951 952 953
    ;; Skip past all white space at the start and ends.
    (goto-char start)
    (skip-chars-forward " \t\n")
    (beginning-of-line)
    (setq start (point))
    (goto-char end)
    (skip-chars-backward " \t\n")
    (forward-line 1)
    (setq end (point))
954
    (narrow-to-region start end)
955
    (let ((width (shr-buffer-width))
956 957 958 959
	  column)
      (goto-char (point-min))
      (while (not (eobp))
	(end-of-line)
960 961
	(when (and (< (setq column (current-column)) width)
		   (< (setq column (shr-previous-newline-padding-width column))
962
		      width))
963
	  (let ((overlay (make-overlay (point) (1+ (point)))))
964
	    (overlay-put overlay 'before-string
965 966 967
			 (concat
			  (mapconcat
			   (lambda (overlay)
968 969 970
			     (let ((string (plist-get
					    (overlay-properties overlay)
					    'before-string)))
971 972 973 974 975 976
			       (if (not string)
				   ""
				 (overlay-put overlay 'before-string "")
				 string)))
			   (overlays-at (point))
			   "")
977
			  (propertize (make-string (- width column) ? )
978
				      'face (list :background color))))))
979
	(forward-line 1)))))
980

981 982 983 984 985 986 987 988
(defun shr-previous-newline-padding-width (width)
  (let ((overlays (overlays-at (point)))
	(previous-width 0))
    (if (null overlays)
	width
      (dolist (overlay overlays)
	(setq previous-width
	      (+ previous-width
989 990
		 (length (plist-get (overlay-properties overlay)
				    'before-string)))))
991 992
      (+ width previous-width))))

993 994
;;; Tag-specific rendering rules.

995
(defun shr-tag-body (dom)
996
  (let* ((start (point))
997 998
	 (fgcolor (or (dom-attr dom 'fgcolor) (dom-attr dom 'text)))
	 (bgcolor (dom-attr dom 'bgcolor))
999 1000
	 (shr-stylesheet (list (cons 'color fgcolor)
			       (cons 'background-color bgcolor))))
1001
    (shr-generic dom)
1002
    (shr-colorize-region start (point) fgcolor bgcolor)))
1003

1004
(defun shr-tag-style (_dom)
1005 1006
  )

1007
(defun shr-tag-script (_dom)
1008 1009
  )

1010
(defun shr-tag-comment (_dom)
1011 1012
  )

1013
(defun shr-dom-to-xml (dom)
1014 1015 1016 1017 1018
  (with-temp-buffer
    (shr-dom-print dom)
    (buffer-string)))

(defun shr-dom-print (dom)
1019
  "Convert DOM into a string containing the xml representation."
1020 1021
  (insert (format "<%s" (dom-tag dom)))
  (dolist (attr (dom-attributes dom))
1022 1023
    ;; Ignore attributes that start with a colon because they are
    ;; private elements.
1024 1025 1026 1027 1028
    (unless (= (aref (format "%s" (car attr)) 0) ?:)
      (insert (format " %s=\"%s\"" (car attr) (cdr attr)))))
  (insert ">")
  (let (url)
    (dolist (elem (dom-children dom))
1029 1030 1031
      (cond
       ((stringp elem)
	(insert elem))
1032 1033
       ((eq (dom-tag elem) 'comment)
	)
1034 1035 1036 1037 1038
       ((or (not (eq (dom-tag elem) 'image))
	    ;; Filter out blocked elements inside the SVG image.
	    (not (setq url (dom-attr elem ':xlink:href)))
	    (not shr-blocked-images)
	    (not (string-match shr-blocked-images url)))
1039
	(insert " ")
1040
	(shr-dom-print elem)))))