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

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

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

;; This file is part of GNU Emacs.

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

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

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

;;; Commentary:

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

;;; Code:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

126 127
;;; Internal variables.

128 129 130
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
131
(defvar shr-indentation 0)
132
(defvar shr-inhibit-images nil)
133
(defvar shr-list-mode nil)
134
(defvar shr-content-cache nil)
135
(defvar shr-kinsoku-shorten nil)
136
(defvar shr-table-depth 0)
137
(defvar shr-stylesheet nil)
138
(defvar shr-base nil)
139
(defvar shr-ignore-cache nil)
140
(defvar shr-external-rendering-functions nil)
141
(defvar shr-target-id nil)
142
(defvar shr-inhibit-decoration nil)
143
(defvar shr-table-separator-length 1)
144

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

162
;; Public functions and commands.
163 164
(declare-function libxml-parse-html-region "xml.c"
		  (start end &optional base-url))
165

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

178
;;;###autoload
179 180 181 182 183 184 185 186 187 188 189
(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))))

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

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

(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))
240 241
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
242 243 244 245 246 247 248
     ;; 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))))))

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

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

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

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

354 355
;;; Utility functions.

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

368 369 370 371 372 373 374 375
(defsubst shr-generic (cont)
  (dolist (sub cont)
    (cond
     ((eq (car sub) 'text)
      (shr-insert (cdr sub)))
     ((listp (cdr sub))
      (shr-descend sub)))))

376
(defun shr-descend (dom)
377 378 379 380 381 382
  (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)))
383
	(style (cdr (assq :style (cdr dom))))
384
	(shr-stylesheet shr-stylesheet)
385
	(start (point)))
386
    (when style
387
      (if (string-match "color\\|display\\|border-collapse" style)
388 389 390
	  (setq shr-stylesheet (nconc (shr-parse-style style)
				      shr-stylesheet))
	(setq style nil)))
391
    ;; If we have a display:none, then just ignore this part of the DOM.
392 393 394 395 396 397
    (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))
398 399 400 401
	;; 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 "*"))
402 403 404 405 406 407
	(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)))))))
408

409 410 411 412 413 414 415 416 417 418 419 420 421
(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."
422 423 424
  `(let ((char ,char))
     (and (not (eq char ?'))
	  (aref (char-category-set char) ?>))))
425 426 427 428 429 430
(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))

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

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

615 616 617
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
618 619 620

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

639
(defun shr-indent ()
640 641
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
642

643
(defun shr-fontize-cont (cont &rest types)
644 645
  (let (shr-start)
    (shr-generic cont)
646 647
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
648

649 650 651
;; 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.
652
(defun shr-add-font (start end type)
653 654 655 656 657 658 659 660 661 662
  (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))))))
663

664 665 666 667 668 669
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

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

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

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

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

727 728 729 730 731 732 733 734 735 736 737
(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)))

738 739 740 741
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))

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

786 787 788 789
(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))))
790 791 792 793 794 795 796 797 798
      (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
799
				(- (nth 3 edges) (nth 1 edges))))
800
       :format content-type))))
801

Glenn Morris's avatar
Glenn Morris committed
802 803 804
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
805
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
806

807 808 809 810 811
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
812
    (when (ignore-errors
813
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
814 815 816
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
817 818 819 820 821 822 823 824 825 826 827
	(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)))))))
828

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

849 850 851 852 853
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

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

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

868 869
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892

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

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

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

946 947 948 949 950 951 952 953
(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
954 955
		 (length (plist-get (overlay-properties overlay)
				    'before-string)))))
956 957
      (+ width previous-width))))

958 959
;;; Tag-specific rendering rules.

960
(defun shr-tag-body (cont)
961
  (let* ((start (point))
962 963
	 (fgcolor (cdr (or (assq :fgcolor cont)
                           (assq :text cont))))
964
	 (bgcolor (cdr (assq :bgcolor cont)))
965 966
	 (shr-stylesheet (list (cons 'color fgcolor)
			       (cons 'background-color bgcolor))))
967
    (shr-generic cont)
968
    (shr-colorize-region start (point) fgcolor bgcolor)))
969

970
(defun shr-tag-style (_cont)
971 972
  )

973
(defun shr-tag-script (_cont)
974 975
  )

976
(defun shr-tag-comment (_cont)
977 978
  )

979 980 981
(defun shr-dom-to-xml (dom)
  "Convert DOM into a string containing the xml representation."
  (let ((arg " ")
982 983
        (text "")
	url)
984 985 986
    (dolist (sub (cdr dom))
      (cond
       ((listp (cdr sub))
987 988 989 990 991 992 993
	;; Ignore external image definitions if required.
	;; <image xlink:href="http://TRACKING_URL/"/>
	(when (or (not (eq (car sub) 'image))
		  (not (setq url (cdr (assq ':xlink:href (cdr sub)))))
		  (not shr-blocked-images)
		  (not (string-match shr-blocked-images url)))
	  (setq text (concat text (shr-dom-to-xml sub)))))
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
       ((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))))

1006
(defun shr-tag-svg (cont)
1007 1008
  (when (and (image-type-available-p 'svg)
	     (not shr-inhibit-images))
1009 1010 1011
    (funcall shr-put-image-function
             (shr-dom-to-xml (cons 'svg cont))
             "SVG Image")))
1012

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
(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))))

1023 1024 1025 1026
(defun shr-tag-label (cont)
  (shr-generic cont)
  (shr-ensure-paragraph))

1027 1028
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
1029
  (shr-indent)
1030 1031 1032
  (shr-generic cont)
  (shr-ensure-paragraph))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1033 1034 1035 1036 1037 1038
(defun shr-tag-div (cont)
  (shr-ensure-newline)
  (shr-indent)
  (shr-generic cont)
  (shr-ensure-newline))

1039 1040 1041
(defun shr-tag-s (cont)
  (shr-fontize-cont cont 'shr-strike-through))

1042 1043 1044
(defun shr-tag-del (cont)
  (shr-fontize-cont cont 'shr-strike-through))

1045 1046 1047 1048 1049 1050 1051
(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)
1052
  (shr-fontize-cont cont 'italic))
1053

1054 1055 1056
(defun shr-tag-strong (cont)
  (shr-fontize-cont cont 'bold))

1057 1058 1059
(defun shr-tag-u (cont)
  (shr-fontize-cont cont 'underline))

1060 1061
(defun shr-parse-style (style)
  (when style
1062 1063 1064
    (save-match-data
      (when (string-match "\n" style)
        (setq style (replace-match " " t t style))))
1065 1066 1067 1068 1069 1070 1071 1072
    (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))))
1073 1074
	      (when (string-match " *!important\\'" value)
		(setq value (substring value 0 (match-beginning 0))))
1075 1076 1077 1078 1079
	      (push (cons (intern name obarray)
			  value)
		    plist)))))
      plist)))

1080
(defun shr-tag-base (cont)
1081 1082 1083
  (let ((base (cdr (assq :href cont))))
    (when base
      (setq shr-base (shr-parse-base base))))
1084
  (shr-generic cont))
1085

1086 1087
(defun shr-tag-a (cont)
  (let ((url (cdr (assq :href cont)))
1088
        (title (cdr (assq :title cont)))
1089 1090 1091
	(start (point))
	shr-start)
    (shr-generic cont)
1092
    (when (and shr-target-id
1093
	       (equal (cdr (assq :name cont)) shr-target-id))
1094 1095 1096 1097 1098 1099
      ;; 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))
1100 1101
    (when (and url
	       (not shr-inhibit-decoration))
1102
      (shr-urlify (or shr-start start) (shr-expand-url url) title))))
1103 1104

(defun shr-tag-object (cont)
1105 1106 1107 1108 1109 1110 1111 1112
  (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)))))))
1113 1114
    (when url
      (shr-insert " [multimedia] ")
1115
      (shr-urlify start (shr-expand-url url)))