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

3
;; Copyright (C) 2010-2013 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 93 94 95
(defcustom shr-bullet "* "
  "Bullet used for unordered lists.
Alternative suggestions are:
- \"  \"
- \"  \""
  :type 'string
  :group 'shr)

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

102 103 104 105 106
(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.")

107 108 109
(defvar shr-put-image-function 'shr-put-image
  "Function called to put image and alt string.")

110 111 112 113
(defface shr-strike-through '((t (:strike-through t)))
  "Font for <s> elements."
  :group 'shr)

114
(defface shr-link
115
  '((t (:inherit link)))
116
  "Font for link elements."
117 118
  :group 'shr)

119 120
;;; Internal variables.

121 122 123
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
124
(defvar shr-indentation 0)
125
(defvar shr-inhibit-images nil)
126
(defvar shr-list-mode nil)
127
(defvar shr-content-cache nil)
128
(defvar shr-kinsoku-shorten nil)
129
(defvar shr-table-depth 0)
130
(defvar shr-stylesheet nil)
131
(defvar shr-base nil)
132
(defvar shr-ignore-cache nil)
133
(defvar shr-external-rendering-functions nil)
134
(defvar shr-target-id nil)
135
(defvar shr-inhibit-decoration nil)
136
(defvar shr-table-separator-length 1)
137

138 139 140 141
(defvar shr-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'shr-show-alt-text)
    (define-key map "i" 'shr-browse-image)
142
    (define-key map "z" 'shr-zoom-image)
143 144
    (define-key map [tab] 'shr-next-link)
    (define-key map [backtab] 'shr-previous-link)
145
    (define-key map [follow-link] 'mouse-face)
146
    (define-key map [mouse-2] 'shr-browse-url)
147
    (define-key map "I" 'shr-insert-image)
148
    (define-key map "w" 'shr-copy-url)
149
    (define-key map "u" 'shr-copy-url)
150
    (define-key map "v" 'shr-browse-url)
151
    (define-key map "o" 'shr-save-contents)
152 153 154
    (define-key map "\r" 'shr-browse-url)
    map))

155
;; Public functions and commands.
156 157
(declare-function libxml-parse-html-region "xml.c"
		  (start end &optional base-url))
158

159 160 161
(defun shr-render-buffer (buffer)
  "Display the HTML rendering of the current buffer."
  (interactive (list (current-buffer)))
162 163
  (or (fboundp 'libxml-parse-html-region)
      (error "This function requires Emacs to be compiled with libxml2"))
164 165 166
  (pop-to-buffer "*html*")
  (erase-buffer)
  (shr-insert-document
167
   (with-current-buffer buffer
168 169
     (libxml-parse-html-region (point-min) (point-max))))
  (goto-char (point-min)))
170

171 172 173 174 175 176 177 178 179 180 181
(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))))

182 183 184 185 186 187 188
(defun shr-visit-file (file)
  "Parse FILE as an HTML document, and render it in a new buffer."
  (interactive "fHTML file name: ")
  (with-temp-buffer
    (insert-file-contents file)
    (shr-render-buffer (current-buffer))))

189 190
;;;###autoload
(defun shr-insert-document (dom)
191 192 193
  "Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
194
  (setq shr-content-cache nil)
195 196
  (let ((start (point))
	(shr-state nil)
197
	(shr-start nil)
198
	(shr-base nil)
199
	(shr-width (or shr-width (1- (window-width)))))
200 201 202 203
    (shr-descend (shr-transform-dom dom))
    (shr-remove-trailing-whitespace start (point))))

(defun shr-remove-trailing-whitespace (start end)
204 205 206 207 208 209
  (let ((width (window-width)))
    (save-restriction
      (narrow-to-region start end)
      (goto-char start)
      (while (not (eobp))
	(end-of-line)
210
	(when (> (shr-previous-newline-padding-width (current-column)) width)
211 212 213 214
	  (dolist (overlay (overlays-at (point)))
	    (when (overlay-get overlay 'before-string)
	      (overlay-put overlay 'before-string nil))))
	(forward-line 1)))))
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

(defun shr-copy-url ()
  "Copy the URL under point to the kill ring.
If called twice, then try to fetch the URL and see whether it
redirects somewhere else."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
    (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))
239 240
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
241 242 243 244 245 246 247
     ;; Copy the URL to the kill ring.
     (t
      (with-temp-buffer
	(insert url)
	(copy-region-as-kill (point-min) (point-max))
	(message "Copied %s" url))))))

248 249 250
(defun shr-next-link ()
  "Skip to the next link."
  (interactive)
251
  (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
252
    (if (not (setq skip (text-property-not-all skip (point-max)
253
					       'help-echo nil)))
254 255 256 257 258 259 260 261 262 263 264
	(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))
265
		(get-text-property (point) 'help-echo))
266 267 268
      (forward-char -1))
    ;; Find the previous link.
    (while (and (not (bobp))
269
		(not (setq found (get-text-property (point) 'help-echo))))
270 271 272 273 274 275 276
      (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))
277
		  (get-text-property (point) 'help-echo))
278 279 280 281
	(forward-char -1))
      (forward-char 1)
      (message "%s" (get-text-property (point) 'help-echo)))))

282 283 284 285 286 287 288 289
(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))))

290 291 292 293 294
(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")
295
  (let ((url (get-text-property (point) 'image-url)))
296 297 298 299 300 301 302 303 304
    (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
305
      (message "Browsing %s..." url)
306
      (browse-url url)))))
307

308 309 310
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
311
  (let ((url (get-text-property (point) 'image-url)))
312 313 314 315 316
    (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))
317
		    t t))))
318

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
(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))))

353 354
;;; Utility functions.

355 356 357 358 359 360 361 362
(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)
363
	  (push (cons 'text sub) result)
364 365 366 367
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

(defun shr-descend (dom)
368 369 370 371 372 373
  (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)))
374
	(style (cdr (assq :style (cdr dom))))
375
	(shr-stylesheet shr-stylesheet)
376
	(start (point)))
377
    (when style
378
      (if (string-match "color\\|display\\|border-collapse" style)
379 380 381
	  (setq shr-stylesheet (nconc (shr-parse-style style)
				      shr-stylesheet))
	(setq style nil)))
382
    ;; If we have a display:none, then just ignore this part of the DOM.
383 384 385 386 387 388 389 390 391 392 393 394
    (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))
	(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)))))))
395 396 397 398

(defun shr-generic (cont)
  (dolist (sub cont)
    (cond
399
     ((eq (car sub) 'text)
400
      (shr-insert (cdr sub)))
401
     ((listp (cdr sub))
402 403
      (shr-descend sub)))))

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
(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."
  `(aref (char-category-set ,char) ?>))
(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))

424
(defun shr-insert (text)
425
  (when (and (eq shr-state 'image)
426
	     (not (bolp))
427
	     (not (string-match "\\`[ \t\n]+\\'" text)))
428 429 430 431 432 433
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
434
    (when (and (string-match "\\`[ \t\n ]" text)
435 436 437
	       (not (bolp))
	       (not (eq (char-after (1- (point))) ? )))
      (insert " "))
438
    (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
439 440 441 442
      (when (and (bolp)
		 (> shr-indentation 0))
	(shr-indent))
      ;; No space is needed behind a wide character categorized as
443 444
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
445
      (let (prev)
446 447
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
448
		   (or (= (line-beginning-position) (1- (point)))
449 450 451 452 453
		       (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)))))
454
	  (delete-char -1)))
455 456 457 458 459
      ;; 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)))
460
      (insert elem)
461
      (setq shr-state nil)
462 463
      (let (found)
	(while (and (> (current-column) shr-width)
464
		    (> shr-width 0)
465 466
		    (progn
		      (setq found (shr-find-fill-point))
467
		      (not (eolp))))
468 469 470 471
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
472 473 474 475 476 477 478
	    ;; 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))
	(insert " ")))
479
    (unless (string-match "[ \t\r\n ]\\'" text)
480
      (delete-char -1)))))
481

482
(defun shr-find-fill-point ()
483 484
  (when (> (move-to-column shr-width) shr-width)
    (backward-char 1))
485 486 487 488 489 490 491
  (let ((bp (point))
	failed)
    (while (not (or (setq failed (= (current-column) shr-indentation))
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
492 493 494 495
		    (if (eq (preceding-char) ?')
			(not (memq (char-after (- (point) 2))
				   (list nil ?\n ? )))
		      (and (shr-char-kinsoku-bol-p (preceding-char))
496
			   (shr-char-breakable-p (following-char))
497
			   (not (shr-char-kinsoku-bol-p (following-char)))))
498
		    (shr-char-kinsoku-eol-p (following-char))))
499
      (backward-char 1))
500 501 502 503 504 505 506
    (if (and (not (or failed (eolp)))
	     (eq (preceding-char) ?'))
	(while (not (or (setq failed (eolp))
			(eq (following-char) ? )
			(shr-char-breakable-p (following-char))
			(shr-char-kinsoku-eol-p (following-char))))
	  (forward-char 1)))
507
    (if failed
508
	;; There's no breakable point, so we give it up.
509 510 511 512 513 514 515 516 517
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
	    (while (and (setq found (re-search-forward
				     "\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				     (line-end-position) 'move))
			(eq (preceding-char) ?')))
	    (if (and found (not (match-beginning 1)))
		(goto-char (match-beginning 0)))))
518 519
      (or
       (eolp)
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
       ;; 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))
	 (when (setq failed (= (current-column) shr-indentation))
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
			 (<= (current-column) shr-width))
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
	 ;; 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)))))))
	 (if (setq failed (= (current-column) shr-indentation))
	     ;; 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))))
	((shr-char-kinsoku-bol-p (following-char))
	 ;; Find forward the point where kinsoku-bol characters end.
	 (let ((count 4))
	   (while (progn
		    (forward-char 1)
		    (and (>= (setq count (1- count)) 0)
559
			 (shr-char-kinsoku-bol-p (following-char))
560
			 (shr-char-breakable-p (following-char))))))))
561 562 563
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
564

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 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))))
  (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)))

(defun shr-expand-url (url &optional base)
  (setq base
	(if base
	    (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))
	 ;; Absolute URL.
	 (or url (car base)))
	((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.
	 (concat (car base) (cadr base) url))))
610

611 612 613
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
614 615 616

(defun shr-ensure-paragraph ()
  (unless (bobp)
617
    (if (<= (current-column) shr-indentation)
618 619 620
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
621 622 623
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
624 625 626 627 628 629 630 631
	    ;; 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)))))
632
	  (delete-region (match-beginning 0) (match-end 0))
633 634
	(insert "\n\n")))))

635
(defun shr-indent ()
636 637
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
638

639
(defun shr-fontize-cont (cont &rest types)
640 641
  (let (shr-start)
    (shr-generic cont)
642 643
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
644

645 646 647
;; 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.
648
(defun shr-add-font (start end type)
649 650 651 652 653 654 655 656 657 658
  (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))))))
659

660 661 662 663 664 665
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

666
(defun shr-browse-url (&optional external mouse-event)
667 668
  "Browse the URL under point.
If EXTERNAL, browse the URL using `shr-external-browser'."
669 670
  (interactive (list current-prefix-arg last-nonmenu-event))
  (mouse-set-point mouse-event)
671
  (let ((url (get-text-property (point) 'shr-url)))
672 673 674 675
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
676
      (browse-url-mail url))
677
     (t
678 679 680
      (if external
	  (funcall shr-external-browser url)
	(browse-url url))))))
681

682 683 684 685 686 687 688
(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)
689 690
		    'shr-store-contents (list url directory)
		    nil t))))
691 692 693 694 695 696 697 698 699

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

700
(defun shr-image-fetched (status buffer start end &optional flags)
701 702 703 704 705 706
  (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))
707
	(let ((data (shr-parse-image-data)))
708 709 710
	  (with-current-buffer buffer
	    (save-excursion
	      (let ((alt (buffer-substring start end))
711
		    (properties (text-properties-at start))
712 713 714
		    (inhibit-read-only t))
		(delete-region start end)
		(goto-char start)
715 716 717 718 719 720
		(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))))))))))
721
    (kill-buffer image-buffer)))
722

723 724 725 726 727 728 729 730 731 732 733
(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)))

734 735 736 737
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))

738 739 740 741
(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."
742
  (if (display-graphic-p)
743
      (let* ((size (cdr (assq 'size flags)))
744 745 746 747 748
	     (data (if (consp spec)
		       (car spec)
		     spec))
	     (content-type (and (consp spec)
				(cadr spec)))
749 750 751
	     (start (point))
	     (image (cond
		     ((eq size 'original)
752
		      (create-image data nil t :ascent 100
753
				    :format content-type))
754 755
		     ((eq size 'full)
		      (ignore-errors
756
			(shr-rescale-image data content-type)))
757 758
		     (t
		      (ignore-errors
759
			(shr-rescale-image data content-type))))))
760
        (when image
761 762 763 764 765
	  ;; 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"))
766
	  (if (eq size 'original)
767
	      (insert-sliced-image image (or alt "*") nil 20 1)
768 769
	    (insert-image image (or alt "*")))
	  (put-text-property start (point) 'image-size size)
770 771 772 773 774 775 776
	  (when (cond ((fboundp 'image-multi-frame-p)
		       ;; Only animate multi-frame things that specify a
		       ;; delay; eg animated gifs as opposed to
		       ;; multi-page tiffs.  FIXME?
		       (cdr (image-multi-frame-p image)))
		      ((fboundp 'image-animated-p)
		       (image-animated-p image)))
777
	    (image-animate image nil 60)))
778
	image)
779
    (insert alt)))
780

781 782 783 784
(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))))
785 786 787 788 789 790 791 792 793
      (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
794
				(- (nth 3 edges) (nth 1 edges))))
795
       :format content-type))))
796

Glenn Morris's avatar
Glenn Morris committed
797 798 799
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
800
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
801

802 803 804 805 806
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
807
    (when (ignore-errors
808
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
809 810 811
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
812 813 814 815 816 817 818 819 820 821 822
	(shr-parse-image-data)))))

(defun shr-parse-image-data ()
  (list
   (buffer-substring (point) (point-max))
   (save-excursion
     (save-restriction
       (narrow-to-region (point-min) (point))
       (let ((content-type (mail-fetch-field "content-type")))
	 (and content-type
	      (intern content-type obarray)))))))
823

824 825 826 827
(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
828
START, and END.  Note that START and END should be markers."
829
  `(lambda (url start end)
830 831 832 833 834 835 836
     (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)
837
		   (funcall shr-put-image-function
838
			    image (buffer-substring start end))
839
		   (delete-region (point) end))))
840 841
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
842
		       t t)))))
843

844 845 846 847 848
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

849
(defun shr-urlify (start url &optional title)
850
  (shr-add-font start (point) 'shr-link)
851 852 853
  (add-text-properties
   start (point)
   (list 'shr-url url
854
	 'help-echo (if title (format "%s (%s)" url title) url)
855
	 'follow-link t
856
	 'mouse-face 'highlight
857
	 'keymap shr-map)))
858 859 860 861 862

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

863 864
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887

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

888
(defun shr-colorize-region (start end fg &optional bg)
889 890
  (when (and (not shr-inhibit-decoration)
	     (or fg bg))
891
    (let ((new-colors (shr-color-check fg bg)))
892
      (when new-colors
893
	(when fg
894 895 896
	  (add-face-text-property start end
				  (list :foreground (cadr new-colors))
				  t))
897
	(when bg
898 899 900
	  (add-face-text-property start end
				  (list :background (car new-colors))
				  t)))
901
      new-colors)))
902

903 904
(defun shr-expand-newlines (start end color)
  (save-restriction
905 906 907 908 909 910 911 912 913
    ;; 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))
914
    (narrow-to-region start end)
915
    (let ((width (shr-buffer-width))
916 917 918 919
	  column)
      (goto-char (point-min))
      (while (not (eobp))
	(end-of-line)
920 921
	(when (and (< (setq column (current-column)) width)
		   (< (setq column (shr-previous-newline-padding-width column))
922
		      width))
923
	  (let ((overlay (make-overlay (point) (1+ (point)))))
924
	    (overlay-put overlay 'before-string
925 926 927
			 (concat
			  (mapconcat
			   (lambda (overlay)
928 929 930
			     (let ((string (plist-get
					    (overlay-properties overlay)
					    'before-string)))
931 932 933 934 935 936
			       (if (not string)
				   ""
				 (overlay-put overlay 'before-string "")
				 string)))
			   (overlays-at (point))
			   "")
937
			  (propertize (make-string (- width column) ? )
938
				      'face (list :background color))))))
939
	(forward-line 1)))))
940

941 942 943 944 945 946 947 948
(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
949 950
		 (length (plist-get (overlay-properties overlay)
				    'before-string)))))
951 952
      (+ width previous-width))))

953 954
;;; Tag-specific rendering rules.

955
(defun shr-tag-body (cont)
956
  (let* ((start (point))
957 958
	 (fgcolor (cdr (or (assq :fgcolor cont)
                           (assq :text cont))))
959
	 (bgcolor (cdr (assq :bgcolor cont)))
960 961
	 (shr-stylesheet (list (cons 'color fgcolor)
			       (cons 'background-color bgcolor))))
962
    (shr-generic cont)
963
    (shr-colorize-region start (point) fgcolor bgcolor)))
964

965
(defun shr-tag-style (_cont)
966 967
  )

968
(defun shr-tag-script (_cont)
969 970
  )

971
(defun shr-tag-comment (_cont)
972 973
  )

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
(defun shr-dom-to-xml (dom)
  "Convert DOM into a string containing the xml representation."
  (let ((arg " ")
        (text ""))
    (dolist (sub (cdr dom))
      (cond
       ((listp (cdr sub))
        (setq text (concat text (shr-dom-to-xml sub))))
       ((eq (car sub) 'text)
        (setq text (concat text (cdr sub))))
       (t
        (setq arg (concat arg (format "%s=\"%s\" "
                                      (substring (symbol-name (car sub)) 1)
                                      (cdr sub)))))))
    (format "<%s%s>%s</%s>"
            (car dom)
            (substring arg 0 (1- (length arg)))
            text
            (car dom))))

994
(defun shr-tag-svg (cont)
995 996 997 998
  (when (image-type-available-p 'svg)
    (funcall shr-put-image-function
             (shr-dom-to-xml (cons 'svg cont))
             "SVG Image")))
999

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
(defun shr-tag-sup (cont)
  (let ((start (point)))
    (shr-generic cont)
    (put-text-property start (point) 'display '(raise 0.5))))

(defun shr-tag-sub (cont)
  (let ((start (point)))
    (shr-generic cont)
    (put-text-property start (point) 'display '(raise -0.5))))

1010 1011 1012 1013
(defun shr-tag-label (cont)
  (shr-generic cont)
  (shr-ensure-paragraph))

1014 1015
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
1016
  (shr-indent)
1017 1018 1019
  (shr-generic cont)
  (shr-ensure-paragraph))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1020 1021 1022 1023 1024 1025
(defun shr-tag-div (cont)
  (shr-ensure-newline)
  (shr-indent)
  (shr-generic cont)
  (shr-ensure-newline))

1026 1027 1028
(defun shr-tag-s (cont)
  (shr-fontize-cont cont 'shr-strike-through))

1029 1030 1031
(defun shr-tag-del (cont)
  (shr-fontize-cont cont 'shr-strike-through))

1032 1033 1034 1035 1036 1037 1038
(defun shr-tag-b (cont)
  (shr-fontize-cont cont 'bold))

(defun shr-tag-i (cont)
  (shr-fontize-cont cont 'italic))

(defun shr-tag-em (cont)
1039
  (shr-fontize-cont cont 'italic))
1040

1041 1042 1043
(defun shr-tag-strong (cont)
  (shr-fontize-cont cont 'bold))

1044 1045 1046
(defun shr-tag-u (cont)
  (shr-fontize-cont cont 'underline))

1047 1048
(defun shr-parse-style (style)
  (when style
1049 1050 1051
    (save-match-data
      (when (string-match "\n" style)
        (setq style (replace-match " " t t style))))
1052 1053 1054 1055 1056 1057 1058 1059
    (let ((plist nil))
      (dolist (elem (split-string style ";"))
	(when elem
	  (setq elem (split-string elem ":"))
	  (when (and (car elem)
		     (cadr elem))
	    (let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
		  (value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
1060 1061
	      (when (string-match " *!important\\'" value)
		(setq value (substring value 0 (match-beginning 0))))
1062 1063 1064 1065 1066
	      (push (cons (intern name obarray)
			  value)
		    plist)))))
      plist)))

1067
(defun shr-tag-base (cont)
1068 1069 1070
  (let ((base (cdr (assq :href cont))))
    (when base
      (setq shr-base (shr-parse-base base))))
1071
  (shr-generic cont))
1072

1073 1074
(defun shr-tag-a (cont)
  (let ((url (cdr (assq :href cont)))
1075
        (title (cdr (assq :title cont)))
1076 1077 1078
	(start (point))
	shr-start)
    (shr-generic cont)
1079
    (when (and shr-target-id
1080
	       (equal (cdr (assq :name cont)) shr-target-id))
1081 1082 1083 1084 1085 1086
      ;; We have a zero-length <a name="foo"> element, so just
      ;; insert...  something.
      (when (= start (point))
	(shr-ensure-newline)
	(insert " "))
      (put-text-property start (1+ start) 'shr-target-id shr-target-id))
1087 1088
    (when (and url
	       (not shr-inhibit-decoration))
1089
      (shr-urlify (or shr-start start) (shr-expand-url url) title))))
1090 1091

(defun shr-tag-object (cont)
1092 1093 1094 1095 1096 1097 1098 1099
  (let ((start (point))
	url)
    (dolist (elem cont)
      (when (eq (car elem) 'embed)
	(setq url (or url (cdr (assq :src (cdr elem))))))
      (when (and (eq (car elem) 'param)
		 (equal (cdr (assq :name (cdr elem))) "movie"))
	(setq url (or url (cdr (assq :value (cdr elem)))))))
1100 1101
    (when url
      (shr-insert " [multimedia] ")
1102
      (shr-urlify start (shr-expand-url url)))
1103 1104
    (shr-generic cont)))

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
(defcustom shr-prefer-media-type-alist '(("webm" . 1.0)
                                         ("ogv"  . 1.0)
                                         ("ogg"  . 1.0)
                                         ("opus" . 1.0)
                                         ("flac" . 0.9)
                                         ("wav"  . 0.5))
  "Preferences for media types.
The key element should be a regexp matched against the type of the source or
url if no type is specified.  The value should be a float in the range 0.0 to
1.0.  Media elements with higher value are preferred."
  :version "24.4"
  :group 'shr
  :type '(alist :key-type regexp :value-type float))

(defun shr--get-media-pref (elem)
  "Determine the preference for ELEM.
The preference is a float determined from `shr-prefer-media-type'."
  (let ((type (cdr (assq :type elem)))
        (p 0.0))
    (unless type
      (setq type (cdr (assq :src elem))))
    (when type
      (dolist (pref shr-prefer-media-type-alist)
        (when (and
               (> (cdr pref) p)
               (string-match-p (car pref) type))
          (setq p (cdr pref)))))
    p))

(defun shr--extract-best-source (cont &optional url pref)
  "Extract the best `:src' property from <source> blocks in CONT."
  (setq pref (or pref -1.0))
  (let (new-pref)
    (dolist (elem cont)
      (when (and (listp elem)
                 (not (keywordp (car elem)))) ;; skip attributes
        (when (and (eq (car elem) 'source)
                   (< pref
                      (setq new-pref
                            (shr--get-media-pref elem))))
          (setq pref new-pref
                url (cdr (assq :src elem)))
          (message "new %s %s" url pref))
Paul Eggert's avatar
Paul Eggert committed
1148
        ;; libxml's html parser isn't HTML5 compliant and non terminated
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
        ;; source tags might end up as children.  So recursion it is...
        (dolist (child (cdr elem))
          (when (and (listp child)
                     (not (keywordp (car child)))  ;; skip attributes
                     (eq (car child) 'source))
            (let ((ret (shr--extract-best-source (list child) url pref)))
              (when (< pref (cdr ret))
                (setq url (car ret)
                      pref (cdr ret)))))))))
  (cons url pref))

1160 1161
(defun shr-tag-video (cont)
  (let ((image (cdr (assq :poster cont)))
1162 1163 1164 1165
        (url (cdr (assq :src cont)))
        (start (point)))
    (unless url
      (setq url (car (shr--extract-best-source cont))))
1166 1167 1168
    (if image
        (shr-tag-img nil image)
      (shr-insert " [video] "))
1169
    (shr-urlify start (shr-expand-url url))))
Gnus developers's avatar