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

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

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

;; This file is part of GNU Emacs.

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

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

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

;;; Commentary:

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

;;; Code:

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

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

(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 62 63
  :group 'shr
  :type 'character)

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

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

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

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

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

96 97 98 99 100
(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.")

101 102 103
(defvar shr-put-image-function 'shr-put-image
  "Function called to put image and alt string.")

104 105 106 107
(defface shr-strike-through '((t (:strike-through t)))
  "Font for <s> elements."
  :group 'shr)

108
(defface shr-link
109
  '((t (:inherit link)))
110
  "Font for link elements."
111 112
  :group 'shr)

113 114
;;; Internal variables.

115 116 117
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
118
(defvar shr-indentation 0)
119
(defvar shr-inhibit-images nil)
120
(defvar shr-list-mode nil)
121
(defvar shr-content-cache nil)
122
(defvar shr-kinsoku-shorten nil)
123
(defvar shr-table-depth 0)
124
(defvar shr-stylesheet nil)
125
(defvar shr-base nil)
126
(defvar shr-ignore-cache nil)
127
(defvar shr-external-rendering-functions nil)
128
(defvar shr-target-id nil)
129
(defvar shr-inhibit-decoration nil)
130
(defvar shr-table-separator-length 1)
131

132 133 134 135
(defvar shr-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'shr-show-alt-text)
    (define-key map "i" 'shr-browse-image)
136
    (define-key map "z" 'shr-zoom-image)
137 138
    (define-key map [tab] 'shr-next-link)
    (define-key map [backtab] 'shr-previous-link)
139
    (define-key map [follow-link] 'mouse-face)
140 141 142
    (define-key map "I" 'shr-insert-image)
    (define-key map "u" 'shr-copy-url)
    (define-key map "v" 'shr-browse-url)
143
    (define-key map "o" 'shr-save-contents)
144 145 146
    (define-key map "\r" 'shr-browse-url)
    map))

147
;; Public functions and commands.
148 149
(declare-function libxml-parse-html-region "xml.c"
		  (start end &optional base-url))
150

151 152 153
(defun shr-render-buffer (buffer)
  "Display the HTML rendering of the current buffer."
  (interactive (list (current-buffer)))
154 155
  (or (fboundp 'libxml-parse-html-region)
      (error "This function requires Emacs to be compiled with libxml2"))
156 157 158
  (pop-to-buffer "*html*")
  (erase-buffer)
  (shr-insert-document
159
   (with-current-buffer buffer
160 161
     (libxml-parse-html-region (point-min) (point-max))))
  (goto-char (point-min)))
162

163 164 165 166 167 168 169
(defun shr-visit-file (file)
  "Parse FILE as an HTML document, and render it in a new buffer."
  (interactive "fHTML file name: ")
  (with-temp-buffer
    (insert-file-contents file)
    (shr-render-buffer (current-buffer))))

170 171
;;;###autoload
(defun shr-insert-document (dom)
172 173 174
  "Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
175
  (setq shr-content-cache nil)
176 177
  (let ((start (point))
	(shr-state nil)
178
	(shr-start nil)
179
	(shr-base nil)
180
	(shr-preliminary-table-render 0)
181
	(shr-width (or shr-width (1- (window-width)))))
182 183 184 185
    (shr-descend (shr-transform-dom dom))
    (shr-remove-trailing-whitespace start (point))))

(defun shr-remove-trailing-whitespace (start end)
186 187 188 189 190 191
  (let ((width (window-width)))
    (save-restriction
      (narrow-to-region start end)
      (goto-char start)
      (while (not (eobp))
	(end-of-line)
192
	(when (> (shr-previous-newline-padding-width (current-column)) width)
193 194 195 196
	  (dolist (overlay (overlays-at (point)))
	    (when (overlay-get overlay 'before-string)
	      (overlay-put overlay 'before-string nil))))
	(forward-line 1)))))
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

(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))
221 222
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
223 224 225 226 227 228 229
     ;; 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))))))

230 231 232
(defun shr-next-link ()
  "Skip to the next link."
  (interactive)
233
  (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
234
    (if (not (setq skip (text-property-not-all skip (point-max)
235
					       'help-echo nil)))
236 237 238 239 240 241 242 243 244 245 246
	(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))
247
		(get-text-property (point) 'help-echo))
248 249 250
      (forward-char -1))
    ;; Find the previous link.
    (while (and (not (bobp))
251
		(not (setq found (get-text-property (point) 'help-echo))))
252 253 254 255 256 257 258
      (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))
259
		  (get-text-property (point) 'help-echo))
260 261 262 263
	(forward-char -1))
      (forward-char 1)
      (message "%s" (get-text-property (point) 'help-echo)))))

264 265 266 267 268 269 270 271
(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))))

272 273 274 275 276
(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")
277
  (let ((url (get-text-property (point) 'image-url)))
278 279 280 281 282 283 284 285 286
    (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
287
      (message "Browsing %s..." url)
288
      (browse-url url)))))
289

290 291 292
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
293
  (let ((url (get-text-property (point) 'image-url)))
294 295 296 297 298
    (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))
299
		    t t))))
300

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
(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))))

335 336
;;; Utility functions.

337 338 339 340 341 342 343 344
(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)
345
	  (push (cons 'text sub) result)
346 347 348 349
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

(defun shr-descend (dom)
350 351 352 353 354 355
  (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)))
356
	(style (cdr (assq :style (cdr dom))))
357
	(shr-stylesheet shr-stylesheet)
358
	(start (point)))
359
    (when style
360
      (if (string-match "color\\|display\\|border-collapse" style)
361 362 363
	  (setq shr-stylesheet (nconc (shr-parse-style style)
				      shr-stylesheet))
	(setq style nil)))
364 365 366 367 368 369 370 371 372 373 374 375 376 377
    ;; If we have a display:none, then just ignore this part of the
    ;; DOM.
    (unless (equal (cdr (assq 'display shr-stylesheet)) "none")
      (if (fboundp function)
	  (funcall function (cdr dom))
	(shr-generic (cdr dom)))
      (when (and shr-target-id
		 (equal (cdr (assq :id (cdr dom))) shr-target-id))
	(put-text-property start (1+ start) 'shr-target-id shr-target-id))
      ;; If style is set, then this node has set the color.
      (when style
	(shr-colorize-region start (point)
			     (cdr (assq 'color shr-stylesheet))
			     (cdr (assq 'background-color shr-stylesheet)))))))
378 379 380 381

(defun shr-generic (cont)
  (dolist (sub cont)
    (cond
382
     ((eq (car sub) 'text)
383
      (shr-insert (cdr sub)))
384
     ((listp (cdr sub))
385 386
      (shr-descend sub)))))

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
(defmacro shr-char-breakable-p (char)
  "Return non-nil if a line can be broken before and after CHAR."
  `(aref fill-find-break-point-function-table ,char))
(defmacro shr-char-nospace-p (char)
  "Return non-nil if no space is required before and after CHAR."
  `(aref fill-nospace-between-words-table ,char))

;; KINSOKU is a Japanese word meaning a rule that should not be violated.
;; In Emacs, it is a term used for characters, e.g. punctuation marks,
;; parentheses, and so on, that should not be placed in the beginning
;; of a line or the end of a line.
(defmacro shr-char-kinsoku-bol-p (char)
  "Return non-nil if a line ought not to begin with CHAR."
  `(aref (char-category-set ,char) ?>))
(defmacro shr-char-kinsoku-eol-p (char)
  "Return non-nil if a line ought not to end with CHAR."
  `(aref (char-category-set ,char) ?<))
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
  (load "kinsoku" nil t))

407
(defun shr-insert (text)
408
  (when (and (eq shr-state 'image)
409
	     (not (bolp))
410
	     (not (string-match "\\`[ \t\n]+\\'" text)))
411 412 413 414 415 416
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
417
    (when (and (string-match "\\`[ \t\n ]" text)
418 419 420
	       (not (bolp))
	       (not (eq (char-after (1- (point))) ? )))
      (insert " "))
421
    (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
422 423 424 425
      (when (and (bolp)
		 (> shr-indentation 0))
	(shr-indent))
      ;; No space is needed behind a wide character categorized as
426 427
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
428
      (let (prev)
429 430
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
431
		   (or (= (line-beginning-position) (1- (point)))
432 433 434 435 436
		       (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)))))
437
	  (delete-char -1)))
438 439 440 441 442
      ;; 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)))
443
      (insert elem)
444
      (setq shr-state nil)
445 446 447 448
      (let (found)
	(while (and (> (current-column) shr-width)
		    (progn
		      (setq found (shr-find-fill-point))
449
		      (not (eolp))))
450 451 452 453
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
454 455 456 457 458 459 460
	    ;; No space is needed at the beginning of a line.
	    (when (eq (following-char) ? )
	      (delete-char 1)))
	  (when (> shr-indentation 0)
	    (shr-indent))
	  (end-of-line))
	(insert " ")))
461
    (unless (string-match "[ \t\r\n ]\\'" text)
462
      (delete-char -1)))))
463

464
(defun shr-find-fill-point ()
465 466
  (when (> (move-to-column shr-width) shr-width)
    (backward-char 1))
467 468 469 470 471 472 473
  (let ((bp (point))
	failed)
    (while (not (or (setq failed (= (current-column) shr-indentation))
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
474 475 476 477
		    (if (eq (preceding-char) ?')
			(not (memq (char-after (- (point) 2))
				   (list nil ?\n ? )))
		      (and (shr-char-kinsoku-bol-p (preceding-char))
478
			   (shr-char-breakable-p (following-char))
479
			   (not (shr-char-kinsoku-bol-p (following-char)))))
480
		    (shr-char-kinsoku-eol-p (following-char))))
481
      (backward-char 1))
482 483 484 485 486 487 488
    (if (and (not (or failed (eolp)))
	     (eq (preceding-char) ?'))
	(while (not (or (setq failed (eolp))
			(eq (following-char) ? )
			(shr-char-breakable-p (following-char))
			(shr-char-kinsoku-eol-p (following-char))))
	  (forward-char 1)))
489
    (if failed
490
	;; There's no breakable point, so we give it up.
491 492 493 494 495 496 497 498 499
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
	    (while (and (setq found (re-search-forward
				     "\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				     (line-end-position) 'move))
			(eq (preceding-char) ?')))
	    (if (and found (not (match-beginning 1)))
		(goto-char (match-beginning 0)))))
500 501
      (or
       (eolp)
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
       ;; Don't put kinsoku-bol characters at the beginning of a line,
       ;; or kinsoku-eol characters at the end of a line.
       (cond
	(shr-kinsoku-shorten
	 (while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
		     (shr-char-kinsoku-eol-p (preceding-char)))
	   (backward-char 1))
	 (when (setq failed (= (current-column) shr-indentation))
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
			 (<= (current-column) shr-width))
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
	 ;; Find backward the point where kinsoku-eol characters begin.
	 (let ((count 4))
	   (while
	       (progn
		 (backward-char 1)
		 (and (> (setq count (1- count)) 0)
		      (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
		      (or (shr-char-kinsoku-eol-p (preceding-char))
			  (shr-char-kinsoku-bol-p (following-char)))))))
	 (if (setq failed (= (current-column) shr-indentation))
	     ;; There's no breakable point that doesn't violate kinsoku,
	     ;; so we go to the second best position.
	     (if (looking-at "\\(\\c<+\\)\\c<")
		 (goto-char (match-end 1))
	       (forward-char 1))))
	((shr-char-kinsoku-bol-p (following-char))
	 ;; Find forward the point where kinsoku-bol characters end.
	 (let ((count 4))
	   (while (progn
		    (forward-char 1)
		    (and (>= (setq count (1- count)) 0)
541
			 (shr-char-kinsoku-bol-p (following-char))
542
			 (shr-char-breakable-p (following-char))))))))
543 544 545
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
546

547 548 549 550 551 552 553 554 555 556 557 558 559 560 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
(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))))
592

593 594 595
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
596 597 598

(defun shr-ensure-paragraph ()
  (unless (bobp)
599
    (if (<= (current-column) shr-indentation)
600 601 602
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
603 604 605
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
606 607 608 609 610 611 612 613
	    ;; 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)))))
614
	  (delete-region (match-beginning 0) (match-end 0))
615 616
	(insert "\n\n")))))

617
(defun shr-indent ()
618 619
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
620

621
(defun shr-fontize-cont (cont &rest types)
622 623
  (let (shr-start)
    (shr-generic cont)
624 625
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
626

627 628 629
;; 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.
630
(defun shr-add-font (start end type)
631 632 633 634 635 636 637 638 639 640
  (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))))))
641

642 643 644 645
(defun shr-browse-url ()
  "Browse the URL under point."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
646 647 648 649
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
650
      (browse-url-mail url))
651 652
     (t
      (browse-url url)))))
653

654 655 656 657 658 659 660
(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)
661 662
		    'shr-store-contents (list url directory)
		    nil t))))
663 664 665 666 667 668 669 670 671

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

672
(defun shr-image-fetched (status buffer start end &optional flags)
673 674 675 676 677 678 679 680 681 682
  (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))
	(let ((data (buffer-substring (point) (point-max))))
	  (with-current-buffer buffer
	    (save-excursion
	      (let ((alt (buffer-substring start end))
683
		    (properties (text-properties-at start))
684 685 686
		    (inhibit-read-only t))
		(delete-region start end)
		(goto-char start)
687 688 689 690 691 692
		(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))))))))))
693
    (kill-buffer image-buffer)))
694

695 696 697 698 699 700 701 702 703 704 705
(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)))

706
(defun shr-put-image (data alt &optional flags)
707
  "Put image DATA with a string ALT.  Return image."
708
  (if (display-graphic-p)
709 710 711 712 713 714 715 716 717 718 719
      (let* ((size (cdr (assq 'size flags)))
	     (start (point))
	     (image (cond
		     ((eq size 'original)
		      (create-image data nil t :ascent 100))
		     ((eq size 'full)
		      (ignore-errors
			(shr-rescale-image data t)))
		     (t
		      (ignore-errors
			(shr-rescale-image data))))))
720
        (when image
721 722 723 724 725
	  ;; 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"))
726
	  (if (eq size 'original)
727
	      (insert-sliced-image image (or alt "*") nil 20 1)
728 729
	    (insert-image image (or alt "*")))
	  (put-text-property start (point) 'image-size size)
730 731 732 733 734 735 736
	  (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)))
737
	    (image-animate image nil 60)))
738
	image)
739
    (insert alt)))
740

741 742 743
(defun shr-rescale-image (data &optional force)
  "Rescale DATA, if too big, to fit the current buffer.
If FORCE, rescale the image anyway."
744 745 746 747 748 749 750 751 752 753 754 755
  (if (or (not (fboundp 'imagemagick-types))
	  (not (get-buffer-window (current-buffer))))
      (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
				(- (nth 3 edges) (nth 1 edges))))))))
756

Glenn Morris's avatar
Glenn Morris committed
757 758 759
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
760
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
761

762 763 764 765 766
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
767
    (when (ignore-errors
768
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
769 770 771 772
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
	(buffer-substring (point) (point-max))))))
773

774 775 776 777
(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
778
START, and END.  Note that START and END should be markers."
779
  `(lambda (url start end)
780 781 782 783 784 785 786
     (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)
787
		   (funcall shr-put-image-function
788
			    image (buffer-substring start end))
789
		   (delete-region (point) end))))
790 791
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
792
		       t t)))))
793

794 795 796 797 798
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

799
(defun shr-urlify (start url &optional title)
800
  (when (and title (string-match "ctx" title)) (debug))
801
  (shr-add-font start (point) 'shr-link)
802 803 804
  (add-text-properties
   start (point)
   (list 'shr-url url
805
	 'help-echo (if title (format "%s (%s)" url title) url)
806
	 'keymap shr-map)))
807 808 809 810 811

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

812 813
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836

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

837
(defun shr-colorize-region (start end fg &optional bg)
838 839
  (when (and (not shr-inhibit-decoration)
	     (or fg bg))
840
    (let ((new-colors (shr-color-check fg bg)))
841
      (when new-colors
842
	(when fg
843 844 845
	  (add-face-text-property start end
				  (list :foreground (cadr new-colors))
				  t))
846
	(when bg
847 848 849
	  (add-face-text-property start end
				  (list :background (car new-colors))
				  t)))
850
      new-colors)))
851

852 853
(defun shr-expand-newlines (start end color)
  (save-restriction
854 855 856 857 858 859 860 861 862
    ;; 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))
863
    (narrow-to-region start end)
864
    (let ((width (shr-buffer-width))
865 866 867 868
	  column)
      (goto-char (point-min))
      (while (not (eobp))
	(end-of-line)
869 870
	(when (and (< (setq column (current-column)) width)
		   (< (setq column (shr-previous-newline-padding-width column))
871
		      width))
872
	  (let ((overlay (make-overlay (point) (1+ (point)))))
873
	    (overlay-put overlay 'before-string
874 875 876
			 (concat
			  (mapconcat
			   (lambda (overlay)
877 878 879
			     (let ((string (plist-get
					    (overlay-properties overlay)
					    'before-string)))
880 881 882 883 884 885
			       (if (not string)
				   ""
				 (overlay-put overlay 'before-string "")
				 string)))
			   (overlays-at (point))
			   "")
886
			  (propertize (make-string (- width column) ? )
887
				      'face (list :background color))))))
888
	(forward-line 1)))))
889

890 891 892 893 894 895 896 897
(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
898 899
		 (length (plist-get (overlay-properties overlay)
				    'before-string)))))
900 901
      (+ width previous-width))))

902 903
;;; Tag-specific rendering rules.

904
(defun shr-tag-body (cont)
905
  (let* ((start (point))
906 907
	 (fgcolor (cdr (or (assq :fgcolor cont)
                           (assq :text cont))))
908
	 (bgcolor (cdr (assq :bgcolor cont)))
909 910
	 (shr-stylesheet (list (cons 'color fgcolor)
			       (cons 'background-color bgcolor))))
911
    (shr-generic cont)
912
    (shr-colorize-region start (point) fgcolor bgcolor)))
913

914 915 916
(defun shr-tag-style (cont)
  )

917 918 919
(defun shr-tag-script (cont)
  )

920 921 922
(defun shr-tag-comment (cont)
  )

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
(defun shr-dom-to-xml (dom)
  "Convert DOM into a string containing the xml representation."
  (let ((arg " ")
        (text ""))
    (dolist (sub (cdr dom))
      (cond
       ((listp (cdr sub))
        (setq text (concat text (shr-dom-to-xml sub))))
       ((eq (car sub) 'text)
        (setq text (concat text (cdr sub))))
       (t
        (setq arg (concat arg (format "%s=\"%s\" "
                                      (substring (symbol-name (car sub)) 1)
                                      (cdr sub)))))))
    (format "<%s%s>%s</%s>"
            (car dom)
            (substring arg 0 (1- (length arg)))
            text
            (car dom))))

943
(defun shr-tag-svg (cont)
944 945 946 947
  (when (image-type-available-p 'svg)
    (funcall shr-put-image-function
             (shr-dom-to-xml (cons 'svg cont))
             "SVG Image")))
948

949 950 951 952 953 954 955 956 957 958
(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))))

959 960 961 962
(defun shr-tag-label (cont)
  (shr-generic cont)
  (shr-ensure-paragraph))

963 964
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
965
  (shr-indent)
966 967 968
  (shr-generic cont)
  (shr-ensure-paragraph))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
969 970 971 972 973 974
(defun shr-tag-div (cont)
  (shr-ensure-newline)
  (shr-indent)
  (shr-generic cont)
  (shr-ensure-newline))

975 976 977
(defun shr-tag-s (cont)
  (shr-fontize-cont cont 'shr-strike-through))

978 979 980
(defun shr-tag-del (cont)
  (shr-fontize-cont cont 'shr-strike-through))

981 982 983 984 985 986 987
(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)
988
  (shr-fontize-cont cont 'italic))
989

990 991 992
(defun shr-tag-strong (cont)
  (shr-fontize-cont cont 'bold))

993 994 995
(defun shr-tag-u (cont)
  (shr-fontize-cont cont 'underline))

996 997
(defun shr-parse-style (style)
  (when style
998 999 1000
    (save-match-data
      (when (string-match "\n" style)
        (setq style (replace-match " " t t style))))
1001 1002 1003 1004 1005 1006 1007 1008
    (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))))
1009 1010
	      (when (string-match " *!important\\'" value)
		(setq value (substring value 0 (match-beginning 0))))
1011 1012 1013 1014 1015
	      (push (cons (intern name obarray)
			  value)
		    plist)))))
      plist)))

1016
(defun shr-tag-base (cont)
1017 1018 1019
  (let ((base (cdr (assq :href cont))))
    (when base
      (setq shr-base (shr-parse-base base))))
1020
  (shr-generic cont))
1021

1022 1023
(defun shr-tag-a (cont)
  (let ((url (cdr (assq :href cont)))
1024
        (title (cdr (assq :title cont)))
1025 1026 1027
	(start (point))
	shr-start)
    (shr-generic cont)
1028 1029
    (when (and url
	       (not shr-inhibit-decoration))
1030
      (shr-urlify (or shr-start start) (shr-expand-url url) title))))
1031 1032

(defun shr-tag-object (cont)