shr.el 53.8 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 104 105 106 107
(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.")

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

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

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

120 121
;;; Internal variables.

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

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

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

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

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

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

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

(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))
233 234
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
235 236 237 238 239 240 241
     ;; 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))))))

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

276 277 278 279 280 281 282 283
(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))))

284 285 286 287 288
(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")
289
  (let ((url (get-text-property (point) 'image-url)))
290 291 292 293 294 295 296 297 298
    (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
299
      (message "Browsing %s..." url)
300
      (browse-url url)))))
301

302 303 304
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
305
  (let ((url (get-text-property (point) 'image-url)))
306 307 308 309 310
    (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))
311
		    t t))))
312

313 314 315 316 317 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
(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))))

347 348
;;; Utility functions.

349 350 351 352 353 354 355 356
(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)
357
	  (push (cons 'text sub) result)
358 359 360 361
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

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

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

402 403 404 405 406 407 408 409 410 411 412 413 414
(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."
415 416 417
  `(let ((char ,char))
     (and (not (eq char ?'))
	  (aref (char-category-set char) ?>))))
418 419 420 421 422 423
(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
      (let (found)
463
	(while (and (> (current-column) shr-width)
464
		    (> shr-width 0)
465 466 467
		    (progn
		      (setq found (shr-find-fill-point))
		      (not (eolp))))
468 469 470 471
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
472 473 474 475 476 477
	    ;; 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))
478 479 480 481 482 483 484
	(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)))))
485
    (unless (string-match "[ \t\r\n ]\\'" text)
486
      (delete-char -1)))))
487

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

562 563 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
(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))))
607

608 609 610
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
611 612 613

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

632
(defun shr-indent ()
633 634
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
635

636
(defun shr-fontize-cont (cont &rest types)
637 638
  (let (shr-start)
    (shr-generic cont)
639 640
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
641

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

657 658 659 660 661 662
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

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

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

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

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

720 721 722 723 724 725 726 727 728 729 730
(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)))

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

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

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

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

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

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

841 842 843 844 845
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

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

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

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

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

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

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

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

950 951
;;; Tag-specific rendering rules.

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

962
(defun shr-tag-style (_cont)
963 964
  )

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

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

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
(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