shr.el 54.2 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
;;;###autoload
173 174 175 176 177 178 179 180 181 182 183
(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))))

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

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

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

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

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

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

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

348 349
;;; Utility functions.

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

362 363 364 365 366 367 368 369
(defsubst shr-generic (cont)
  (dolist (sub cont)
    (cond
     ((eq (car sub) 'text)
      (shr-insert (cdr sub)))
     ((listp (cdr sub))
      (shr-descend sub)))))

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

951 952
;;; Tag-specific rendering rules.

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

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

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

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

972 973 974
(defun shr-dom-to-xml (dom)
  "Convert DOM into a string containing the xml representation."
  (let ((arg " ")
975 976
        (text "")
	url)
977 978 979
    (dolist (sub (cdr dom))
      (cond
       ((listp (cdr sub))
980 981 982 983