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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2010-2015 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
(require 'browse-url)
36 37
(require 'subr-x)
(require 'dom)
38

39 40
(defgroup shr nil
  "Simple HTML Renderer"
41 42
  :version "25.1"
  :group 'web)
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

(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
58
  :type '(choice (const nil) regexp))
59

60 61 62 63 64 65
(defcustom shr-use-fonts nil
  "If non-nil, use proportional fonts for text."
  :version "25.1"
  :group 'shr
  :type 'boolean)

66 67 68
(defcustom shr-table-horizontal-line nil
  "Character used to draw horizontal table lines.
If nil, don't draw horizontal table lines."
69
  :group 'shr
Glenn Morris's avatar
Glenn Morris committed
70
  :type '(choice (const nil) character))
71

72
(defcustom shr-table-vertical-line ?\s
73
  "Character used to draw vertical table lines."
74
  :group 'shr
75
  :type 'character)
76

77
(defcustom shr-table-corner ?\s
78
  "Character used to draw table corners."
79
  :group 'shr
80
  :type 'character)
81 82

(defcustom shr-hr-line ?-
83
  "Character used to draw hr lines."
84
  :group 'shr
85
  :type 'character)
86

87
(defcustom shr-width nil
88 89 90 91
  "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."
92
  :version "25.1"
93 94
  :type '(choice (integer :tag "Fixed width in characters")
		 (const   :tag "Use the width of the window" nil))
95 96
  :group 'shr)

97 98 99 100 101
(defcustom shr-bullet "* "
  "Bullet used for unordered lists.
Alternative suggestions are:
- \"  \"
- \"  \""
102
  :version "24.4"
103 104 105
  :type 'string
  :group 'shr)

106 107 108 109 110 111
(defcustom shr-external-browser 'browse-url-default-browser
  "Function used to launch an external browser."
  :version "24.4"
  :group 'shr
  :type 'function)

112
(defcustom shr-image-animate t
Glenn Morris's avatar
Glenn Morris committed
113
  "Non nil means that images that can be animated will be."
114 115 116 117
  :version "24.4"
  :group 'shr
  :type 'boolean)

118 119 120 121 122
(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.")

123 124 125
(defvar shr-put-image-function 'shr-put-image
  "Function called to put image and alt string.")

126 127 128 129
(defface shr-strike-through '((t (:strike-through t)))
  "Font for <s> elements."
  :group 'shr)

130
(defface shr-link
131
  '((t (:inherit link)))
132
  "Font for link elements."
133 134
  :group 'shr)

135 136 137
(defvar shr-inhibit-images nil
  "If non-nil, inhibit loading images.")

138 139
;;; Internal variables.

140 141
(defvar shr-folding-mode nil)
(defvar shr-start nil)
142
(defvar shr-indentation 0)
143
(defvar shr-internal-width nil)
144
(defvar shr-list-mode nil)
145
(defvar shr-content-cache nil)
146
(defvar shr-kinsoku-shorten nil)
147
(defvar shr-table-depth 0)
148
(defvar shr-stylesheet nil)
149
(defvar shr-base nil)
150 151
(defvar shr-depth 0)
(defvar shr-warning nil)
152
(defvar shr-ignore-cache nil)
153
(defvar shr-external-rendering-functions nil)
154
(defvar shr-target-id nil)
155
(defvar shr-inhibit-decoration nil)
156
(defvar shr-table-separator-length 1)
157 158 159
(defvar shr-table-separator-pixel-width 0)
(defvar shr-table-id nil)
(defvar shr-current-font nil)
160

161 162 163 164
(defvar shr-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'shr-show-alt-text)
    (define-key map "i" 'shr-browse-image)
165
    (define-key map "z" 'shr-zoom-image)
166 167
    (define-key map [?\t] 'shr-next-link)
    (define-key map [?\M-\t] 'shr-previous-link)
168
    (define-key map [follow-link] 'mouse-face)
169
    (define-key map [mouse-2] 'shr-browse-url)
170
    (define-key map "I" 'shr-insert-image)
171
    (define-key map "w" 'shr-copy-url)
172
    (define-key map "u" 'shr-copy-url)
173
    (define-key map "v" 'shr-browse-url)
174
    (define-key map "o" 'shr-save-contents)
175 176 177
    (define-key map "\r" 'shr-browse-url)
    map))

178
;; Public functions and commands.
179 180
(declare-function libxml-parse-html-region "xml.c"
		  (start end &optional base-url))
181

182 183 184
(defun shr-render-buffer (buffer)
  "Display the HTML rendering of the current buffer."
  (interactive (list (current-buffer)))
185 186
  (or (fboundp 'libxml-parse-html-region)
      (error "This function requires Emacs to be compiled with libxml2"))
187 188 189
  (pop-to-buffer "*html*")
  (erase-buffer)
  (shr-insert-document
190
   (with-current-buffer buffer
191 192
     (libxml-parse-html-region (point-min) (point-max))))
  (goto-char (point-min)))
193

194
;;;###autoload
195 196 197 198 199 200 201 202 203 204 205
(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))))

206 207
;;;###autoload
(defun shr-insert-document (dom)
208 209 210
  "Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
211
  (setq shr-content-cache nil)
212
  (let ((start (point))
213
	(shr-start nil)
214
	(shr-base nil)
215
	(shr-depth 0)
216
	(shr-table-id 0)
217
	(shr-warning nil)
218 219 220 221 222 223 224 225 226
	(shr-table-separator-pixel-width (shr-string-pixel-width "-"))
	(shr-internal-width (or (and shr-width
				     (if (not shr-use-fonts)
					 shr-width
				       (* shr-width (frame-char-width))))
				(if (not shr-use-fonts)
				    (- (window-width) 2)
				  (- (window-pixel-width)
				     (* (frame-fringe-width) 2))))))
227
    (shr-descend dom)
228
    (shr-fill-lines start (point))
229 230 231
    (shr-remove-trailing-whitespace start (point))
    (when shr-warning
      (message "%s" shr-warning))))
232 233

(defun shr-remove-trailing-whitespace (start end)
234 235 236 237 238 239
  (let ((width (window-width)))
    (save-restriction
      (narrow-to-region start end)
      (goto-char start)
      (while (not (eobp))
	(end-of-line)
240
	(when (> (shr-previous-newline-padding-width (current-column)) width)
241 242 243 244
	  (dolist (overlay (overlays-at (point)))
	    (when (overlay-get overlay 'before-string)
	      (overlay-put overlay 'before-string nil))))
	(forward-line 1)))))
245

246
(defun shr-copy-url (&optional image-url)
247
  "Copy the URL under point to the kill ring.
248 249 250
If IMAGE-URL (the prefix) is non-nil, or there is no link under
point, but there is an image under point then copy the URL of the
image under point instead.
251 252
If called twice, then try to fetch the URL and see whether it
redirects somewhere else."
253 254 255
  (interactive "P")
  (let ((url (or (get-text-property (point) 'shr-url)
		 (get-text-property (point) 'image-url))))
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
    (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))
273 274
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
275 276 277
     ;; Copy the URL to the kill ring.
     (t
      (with-temp-buffer
278
	(insert (url-encode-url url))
279
	(copy-region-as-kill (point-min) (point-max))
280
	(message "Copied %s" (buffer-string)))))))
281

282 283 284
(defun shr-next-link ()
  "Skip to the next link."
  (interactive)
285
  (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
286 287 288
    (if (or (eobp)
	    (not (setq skip (text-property-not-all skip (point-max)
						   'help-echo nil))))
289 290 291 292 293 294 295 296 297 298 299
	(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))
300
		(get-text-property (point) 'help-echo))
301 302 303
      (forward-char -1))
    ;; Find the previous link.
    (while (and (not (bobp))
304
		(not (setq found (get-text-property (point) 'help-echo))))
305 306 307 308 309 310 311
      (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))
312
		  (get-text-property (point) 'help-echo))
313 314 315 316
	(forward-char -1))
      (forward-char 1)
      (message "%s" (get-text-property (point) 'help-echo)))))

317 318 319 320 321 322
(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")
323
      (message "%s" (shr-fill-text text)))))
324

325 326 327 328 329
(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")
330
  (let ((url (get-text-property (point) 'image-url)))
331 332 333 334 335 336 337 338 339
    (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
340
      (message "Browsing %s..." url)
341
      (browse-url url)))))
342

343 344 345
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
346
  (let ((url (get-text-property (point) 'image-url)))
347 348 349 350 351
    (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))
352
		    t t))))
353

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
(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))))

388 389
;;; Utility functions.

390 391 392 393 394
(defsubst shr-generic (dom)
  (dolist (sub (dom-children dom))
    (if (stringp sub)
	(shr-insert sub)
      (shr-descend sub))))
395

396
(defun shr-descend (dom)
397 398 399 400
  (let ((function
	 (or
	  ;; Allow other packages to override (or provide) rendering
	  ;; of elements.
401 402 403
	  (cdr (assq (dom-tag dom) shr-external-rendering-functions))
	  (intern (concat "shr-tag-" (symbol-name (dom-tag dom))) obarray)))
	(style (dom-attr dom 'style))
404
	(shr-stylesheet shr-stylesheet)
405
	(shr-depth (1+ shr-depth))
406
	(start (point)))
407 408 409
    ;; shr uses about 12 frames per nested node.
    (if (> shr-depth (/ max-specpdl-size 12))
	(setq shr-warning "Too deeply nested to render properly; consider increasing `max-specpdl-size'")
410
      (when style
411 412 413 414 415 416 417
	(if (string-match "color\\|display\\|border-collapse" style)
	    (setq shr-stylesheet (nconc (shr-parse-style style)
					shr-stylesheet))
	  (setq style nil)))
      ;; 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)
418 419
	    (funcall function dom)
	  (shr-generic dom))
420
	(when (and shr-target-id
421
		   (equal (dom-attr dom 'id) shr-target-id))
422 423 424 425 426 427 428 429 430 431 432
	  ;; 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 "*"))
	  (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))))))))
433

434
(defun shr-fill-text (text)
435 436 437 438 439
  (if (zerop (length text))
      text
    (with-temp-buffer
      (let ((shr-indentation 0)
	    (shr-start nil)
440 441
	    (shr-internal-width (- (window-pixel-width)
				   (* (frame-fringe-width) 2))))
442 443
	(shr-insert text)
	(buffer-string)))))
444

445
(define-inline shr-char-breakable-p (char)
446
  "Return non-nil if a line can be broken before and after CHAR."
447 448
  (inline-quote (aref fill-find-break-point-function-table ,char)))
(define-inline shr-char-nospace-p (char)
449
  "Return non-nil if no space is required before and after CHAR."
450
  (inline-quote (aref fill-nospace-between-words-table ,char)))
451 452 453 454 455

;; 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.
456
(define-inline shr-char-kinsoku-bol-p (char)
457
  "Return non-nil if a line ought not to begin with CHAR."
458 459 460 461
  (inline-letevals (char)
    (inline-quote (and (not (eq ,char ?'))
                       (aref (char-category-set ,char) ?>)))))
(define-inline shr-char-kinsoku-eol-p (char)
462
  "Return non-nil if a line ought not to end with CHAR."
463
  (inline-quote (aref (char-category-set ,char) ?<)))
464 465 466
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
  (load "kinsoku" nil t))

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
(defun shr-pixel-column ()
  (if (not shr-use-fonts)
      (current-column)
    (if (not (get-buffer-window (current-buffer)))
	(save-window-excursion
	  (set-window-buffer nil (current-buffer))
	  (car (window-text-pixel-size nil (line-beginning-position) (point))))
      (car (window-text-pixel-size nil (line-beginning-position) (point))))))

(defun shr-pixel-region ()
  (- (shr-pixel-column)
     (save-excursion
       (goto-char (mark))
       (shr-pixel-column))))

(defun shr-string-pixel-width (string)
  (if (not shr-use-fonts)
      (length string)
    (with-temp-buffer
      (insert string)
      (shr-pixel-column))))

489
(defun shr-insert (text)
490 491 492
  (when (and (not (bolp))
	     (get-text-property (1- (point)) 'image-url))
    (insert "\n"))
493 494 495 496
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
    (let ((font-start (point)))
      (when (and (string-match "\\`[ \t\n\r ]" text)
		 (not (bolp))
		 (not (eq (char-after (1- (point))) ? )))
	(insert " "))
      (let ((start (point))
	    (bolp (bolp)))
	(insert text)
	(save-restriction
	  (narrow-to-region start (point))
	  (goto-char start)
	  (when (looking-at "[ \t\n\r ]+")
	    (replace-match "" t t))
	  (while (re-search-forward "[ \t\n\r ]+" nil t)
	    (replace-match " " t t))
	  (goto-char (point-max)))
	;; We may have removed everything we inserted if if was just
	;; spaces.
	(unless (= font-start (point))
	  ;; Mark all lines that should possibly be folded afterwards.
	  (when bolp
	    (shr-mark-fill start))
	  (when shr-use-fonts
	    (put-text-property font-start (point)
			       'face
			       (or shr-current-font 'variable-pitch)))))))))
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 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

(defun shr-fill-lines (start end)
  (if (<= shr-internal-width 0)
      nil
    (save-restriction
      (narrow-to-region start end)
      (goto-char start)
      (when (get-text-property (point) 'shr-indentation)
	(shr-fill-line))
      (while (setq start (next-single-property-change start 'shr-indentation))
	(goto-char start)
	(when (bolp)
	  (shr-fill-line)))
      (goto-char (point-max)))))

(defun shr-vertical-motion (column)
  (if (not shr-use-fonts)
      (move-to-column column)
    (unless (eolp)
      (forward-char 1))
    (vertical-motion (cons (/ column (frame-char-width)) 0))
    (unless (eolp)
      (forward-char 1))))

(defun shr-fill-line ()
  (let ((shr-indentation (get-text-property (point) 'shr-indentation))
	(continuation (get-text-property
		       (point) 'shr-continuation-indentation))
	start)
    (put-text-property (point) (1+ (point)) 'shr-indentation nil)
    (shr-indent)
    (setq start (point))
    (setq shr-indentation (or continuation shr-indentation))
    (shr-vertical-motion shr-internal-width)
    (when (looking-at " $")
      (delete-region (point) (line-end-position)))
    (while (not (eolp))
      ;; We have to do some folding.  First find the first
      ;; previous point suitable for folding.
      (if (or (not (shr-find-fill-point (line-beginning-position)))
	      (= (point) start))
	  ;; We had unbreakable text (for this width), so just go to
	  ;; the first space and carry on.
	  (progn
	    (beginning-of-line)
	    (skip-chars-forward " ")
	    (search-forward " " (line-end-position) 'move)))
      ;; Success; continue.
      (when (= (preceding-char) ?\s)
	(delete-char -1))
      (insert "\n")
      (shr-indent)
      (setq start (point))
      (shr-vertical-motion shr-internal-width)
      (when (looking-at " $")
	(delete-region (point) (line-end-position))))))

(defun shr-find-fill-point (start)
581
  (let ((bp (point))
582
	(end (point))
583
	failed)
584
    (while (not (or (setq failed (<= (point) start))
585 586 587 588
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
589 590 591
		    (and (shr-char-kinsoku-bol-p (preceding-char))
			 (shr-char-breakable-p (following-char))
			 (not (shr-char-kinsoku-bol-p (following-char))))
592 593
		    (shr-char-kinsoku-eol-p (following-char))
		    (bolp)))
594 595
      (backward-char 1))
    (if failed
596
	;; There's no breakable point, so we give it up.
597 598 599
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
600 601 602
	    (while (setq found (re-search-forward
				"\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				(line-end-position) 'move)))
603 604
	    (if (and found
		     (not (match-beginning 1)))
605
		(goto-char (match-beginning 0)))))
606 607
      (or
       (eolp)
608 609 610 611 612 613 614
       ;; 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))
615
	 (when (setq failed (<= (point) start))
616 617 618 619
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
620
			 (<= (point) end))
621 622 623 624 625
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
626 627 628 629 630 631 632 633 634
	 ;; 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)))))))
635
	 (when (setq failed (<= (point) start))
636 637 638 639 640
	   ;; 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))))
641
	((shr-char-kinsoku-bol-p (following-char))
642 643 644 645 646
	 ;; Find forward the point where kinsoku-bol characters end.
	 (let ((count 4))
	   (while (progn
		    (forward-char 1)
		    (and (>= (setq count (1- count)) 0)
647
			 (shr-char-kinsoku-bol-p (following-char))
648
			 (shr-char-breakable-p (following-char))))))))
649 650 651
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
652

653 654 655 656
(defun shr-parse-base (url)
  ;; Always chop off anchors.
  (when (string-match "#.*" url)
    (setq url (substring url 0 (match-beginning 0))))
Ivan Shmakov's avatar
Ivan Shmakov committed
657 658
  ;; NB: <base href="" > URI may itself be relative to the document s URI
  (setq url (shr-expand-url url))
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
  (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)))

674 675
(autoload 'url-expand-file-name "url-expand")

Glenn Morris's avatar
Glenn Morris committed
676 677
;; FIXME This needs some tests writing.
;; Does it even need to exist, given that url-expand-file-name does?
678 679 680
(defun shr-expand-url (url &optional base)
  (setq base
	(if base
Ivan Shmakov's avatar
Ivan Shmakov committed
681
	    ;; shr-parse-base should never call this with non-nil base!
682 683 684 685 686 687 688 689
	    (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))
Ivan Shmakov's avatar
Ivan Shmakov committed
690 691
	 ;; Absolute or empty URI
	 (or url (nth 3 base)))
692 693 694 695 696 697 698 699 700 701 702 703
	((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.
704
	 (url-expand-file-name url (concat (car base) (cadr base))))))
705

706 707 708
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
709 710 711

(defun shr-ensure-paragraph ()
  (unless (bobp)
712
    (if (<= (current-column) shr-indentation)
713 714 715
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
716 717 718
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
719 720 721 722 723 724 725 726
	    ;; 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)))))
727
	  (delete-region (match-beginning 0) (match-end 0))
728 729
	(insert "\n\n")))))

730
(defun shr-indent ()
731
  (when (> shr-indentation 0)
732 733 734 735 736 737
    (insert
     (if (not shr-use-fonts)
	 (make-string shr-indentation ?\s)
       (propertize " "
		   'display
		   `(space :width (,shr-indentation)))))))
738

739
(defun shr-fontize-dom (dom &rest types)
740
  (let ((start (point)))
741
    (shr-generic dom)
742
    (dolist (type types)
743
      (shr-add-font start (point) type))))
744

745 746 747
;; 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.
748
(defun shr-add-font (start end type)
749 750 751 752 753 754 755 756 757 758
  (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))))))
759

760 761 762 763 764 765
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

766
(defun shr-browse-url (&optional external mouse-event)
767 768
  "Browse the URL under point.
If EXTERNAL, browse the URL using `shr-external-browser'."
769 770
  (interactive (list current-prefix-arg last-nonmenu-event))
  (mouse-set-point mouse-event)
771
  (let ((url (get-text-property (point) 'shr-url)))
772 773 774 775
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
776
      (browse-url-mail url))
777
     (t
778 779 780
      (if external
	  (funcall shr-external-browser url)
	(browse-url url))))))
781

782 783 784 785 786 787 788
(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)
789 790
		    'shr-store-contents (list url directory)
		    nil t))))
791 792 793 794 795 796 797 798 799

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

800
(defun shr-image-fetched (status buffer start end &optional flags)
801 802 803 804 805 806
  (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))
807
	(let ((data (shr-parse-image-data)))
808 809 810
	  (with-current-buffer buffer
	    (save-excursion
	      (let ((alt (buffer-substring start end))
811
		    (properties (text-properties-at start))
812 813 814
		    (inhibit-read-only t))
		(delete-region start end)
		(goto-char start)
815 816 817 818 819 820
		(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))))))))))
821
    (kill-buffer image-buffer)))
822

823 824 825 826 827 828 829 830 831 832 833
(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)))

834 835 836 837
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))

838 839 840 841
(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."
842
  (if (display-graphic-p)
843
      (let* ((size (cdr (assq 'size flags)))
844 845 846 847 848
	     (data (if (consp spec)
		       (car spec)
		     spec))
	     (content-type (and (consp spec)
				(cadr spec)))
849 850 851
	     (start (point))
	     (image (cond
		     ((eq size 'original)
852
		      (create-image data nil t :ascent 100
853
				    :format content-type))
854 855
		     ((eq content-type 'image/svg+xml)
		      (create-image data 'svg t :ascent 100))
856 857
		     ((eq size 'full)
		      (ignore-errors
858
			(shr-rescale-image data content-type)))
859 860
		     (t
		      (ignore-errors
861
			(shr-rescale-image data content-type))))))
862
        (when image
863 864 865 866 867
	  ;; 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"))
868
	  (if (eq size 'original)
869
	      (insert-sliced-image image (or alt "*") nil 20 1)
870 871
	    (insert-image image (or alt "*")))
	  (put-text-property start (point) 'image-size size)
872 873
	  (when (and shr-image-animate
                     (cond ((fboundp 'image-multi-frame-p)
874 875 876
		       ;; Only animate multi-frame things that specify a
		       ;; delay; eg animated gifs as opposed to
		       ;; multi-page tiffs.  FIXME?
877 878 879 880
                            (cdr (image-multi-frame-p image)))
                           ((fboundp 'image-animated-p)
                            (image-animated-p image))))
            (image-animate image nil 60)))
881
	image)
882
    (insert alt)))
883

884 885 886 887
(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))))
888 889 890 891 892 893 894 895 896
      (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
897
				(- (nth 3 edges) (nth 1 edges))))
898
       :format content-type))))
899

Glenn Morris's avatar
Glenn Morris committed
900 901 902
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
903
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
904

905 906 907 908 909
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
910
    (when (ignore-errors
911
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
912 913 914
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
915 916 917
	(shr-parse-image-data)))))

(defun shr-parse-image-data ()
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
  (let ((data (buffer-substring (point) (point-max)))
	(content-type
	 (save-excursion
	   (save-restriction
	     (narrow-to-region (point-min) (point))
	     (let ((content-type (mail-fetch-field "content-type")))
	       (and content-type
		    ;; Remove any comments in the type string.
		    (intern (replace-regexp-in-string ";.*" "" content-type)
			    obarray)))))))
    ;; SVG images may contain references to further images that we may
    ;; want to block.  So special-case these by parsing the XML data
    ;; and remove the blocked bits.
    (when (eq content-type 'image/svg+xml)
      (setq data
	    (shr-dom-to-xml
934
	     (libxml-parse-xml-region (point) (point-max)))))
935
    (list data content-type)))
936

937 938 939 940
(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
941
START, and END.  Note that START and END should be markers."
942
  `(lambda (url start end)
943 944 945 946 947 948 949
     (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)
950
		   (funcall shr-put-image-function
951
			    image (buffer-substring start end))
952
		   (delete-region (point) end))))
953 954
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
955
		       t t)))))
956

957
(defun shr-heading (dom &rest types)
958
  (shr-ensure-paragraph)
959
  (apply #'shr-fontize-dom dom types)
960 961
  (shr-ensure-paragraph))

962
(defun shr-urlify (start url &optional title)
963
  (shr-add-font start (point) 'shr-link)
964 965 966
  (add-text-properties
   start (point)
   (list 'shr-url url
967
	 'help-echo (let ((iri (or (ignore-errors
968 969 970 971 972
				     (decode-coding-string
				      (url-unhex-string url)
				      'utf-8 t))
				   url)))
		      (if title (format "%s (%s)" iri title) iri))
973
	 'follow-link t
974
	 'mouse-face 'highlight
975
	 'keymap shr-map)))
976 977 978 979 980

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

981 982
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005

(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