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

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

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

;; This file is part of GNU Emacs.

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

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

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

;;; Commentary:

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

;;; Code:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

126 127
;;; Internal variables.

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

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

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

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

181
;;;###autoload
182 183 184 185 186 187 188 189 190 191 192
(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))))

193 194
;;;###autoload
(defun shr-insert-document (dom)
195 196 197
  "Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
198
  (setq shr-content-cache nil)
199 200
  (let ((start (point))
	(shr-state nil)
201
	(shr-start nil)
202
	(shr-base nil)
203 204
	(shr-depth 0)
	(shr-warning nil)
205
	(shr-internal-width (or shr-width (1- (window-width)))))
206
    (shr-descend (shr-transform-dom dom))
207 208 209
    (shr-remove-trailing-whitespace start (point))
    (when shr-warning
      (message "%s" shr-warning))))
210 211

(defun shr-remove-trailing-whitespace (start end)
212 213 214 215 216 217
  (let ((width (window-width)))
    (save-restriction
      (narrow-to-region start end)
      (goto-char start)
      (while (not (eobp))
	(end-of-line)
218
	(when (> (shr-previous-newline-padding-width (current-column)) width)
219 220 221 222
	  (dolist (overlay (overlays-at (point)))
	    (when (overlay-get overlay 'before-string)
	      (overlay-put overlay 'before-string nil))))
	(forward-line 1)))))
223

224
(defun shr-copy-url (&optional image-url)
225
  "Copy the URL under point to the kill ring.
226 227 228
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.
229 230
If called twice, then try to fetch the URL and see whether it
redirects somewhere else."
231 232 233
  (interactive "P")
  (let ((url (or (get-text-property (point) 'shr-url)
		 (get-text-property (point) 'image-url))))
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    (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))
251 252
	     (copy-region-as-kill (point-min) (point-max)))))
       nil t))
253 254 255
     ;; Copy the URL to the kill ring.
     (t
      (with-temp-buffer
256
	(insert (url-encode-url url))
257
	(copy-region-as-kill (point-min) (point-max))
258
	(message "Copied %s" (buffer-string)))))))
259

260 261 262
(defun shr-next-link ()
  "Skip to the next link."
  (interactive)
263
  (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
264
    (if (not (setq skip (text-property-not-all skip (point-max)
265
					       'help-echo nil)))
266 267 268 269 270 271 272 273 274 275 276
	(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))
277
		(get-text-property (point) 'help-echo))
278 279 280
      (forward-char -1))
    ;; Find the previous link.
    (while (and (not (bobp))
281
		(not (setq found (get-text-property (point) 'help-echo))))
282 283 284 285 286 287 288
      (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))
289
		  (get-text-property (point) 'help-echo))
290 291 292 293
	(forward-char -1))
      (forward-char 1)
      (message "%s" (get-text-property (point) 'help-echo)))))

294 295 296 297 298 299 300 301
(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))))

302 303 304 305 306
(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")
307
  (let ((url (get-text-property (point) 'image-url)))
308 309 310 311 312 313 314 315 316
    (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
317
      (message "Browsing %s..." url)
318
      (browse-url url)))))
319

320 321 322
(defun shr-insert-image ()
  "Insert the image under point into the buffer."
  (interactive)
323
  (let ((url (get-text-property (point) 'image-url)))
324 325 326 327 328
    (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))
329
		    t t))))
330

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
(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))))

365 366
;;; Utility functions.

367 368 369 370 371 372 373 374
(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)
375
	  (push (cons 'text sub) result)
376 377 378
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

379 380 381 382 383 384 385
(defun shr-retransform-dom (dom)
  "Transform the shr DOM back into the libxml DOM."
  (let ((tag (car dom))
	(attributes nil)
	(sub-nodes nil))
    (dolist (elem (cdr dom))
      (cond
386
       ((and (stringp (cdr elem))
387
	     (eq (car elem) 'text))
388
	(push (cdr elem) sub-nodes))
389
       ((not (listp (cdr elem)))
390 391 392 393 394 395
	(push (cons (intern (substring (symbol-name (car elem)) 1) obarray)
		    (cdr elem))
	      attributes))
       (t
	(push (shr-retransform-dom elem) sub-nodes))))
    (append (list tag (nreverse attributes))
396
	    (nreverse sub-nodes))))
397

398 399 400 401 402 403 404 405
(defsubst shr-generic (cont)
  (dolist (sub cont)
    (cond
     ((eq (car sub) 'text)
      (shr-insert (cdr sub)))
     ((listp (cdr sub))
      (shr-descend sub)))))

406
(defun shr-descend (dom)
407 408 409 410 411 412
  (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)))
413
	(style (cdr (assq :style (cdr dom))))
414
	(shr-stylesheet shr-stylesheet)
415
	(shr-depth (1+ shr-depth))
416
	(start (point)))
417 418 419
    ;; 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'")
420
      (when style
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
	(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)
	    (funcall function (cdr dom))
	  (shr-generic (cdr dom)))
	(when (and shr-target-id
		   (equal (cdr (assq :id (cdr dom))) shr-target-id))
	  ;; 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))))))))
443

444 445 446 447 448 449 450 451 452 453 454 455 456
(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."
457 458 459
  `(let ((char ,char))
     (and (not (eq char ?'))
	  (aref (char-category-set char) ?>))))
460 461 462 463 464 465
(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))

466
(defun shr-insert (text)
467
  (when (and (eq shr-state 'image)
468
	     (not (bolp))
469
	     (not (string-match "\\`[ \t\n]+\\'" text)))
470 471 472 473 474 475
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
    (insert text))
   (t
476
    (when (and (string-match "\\`[ \t\n ]" text)
477 478 479
	       (not (bolp))
	       (not (eq (char-after (1- (point))) ? )))
      (insert " "))
480
    (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
481 482 483 484
      (when (and (bolp)
		 (> shr-indentation 0))
	(shr-indent))
      ;; No space is needed behind a wide character categorized as
485 486
      ;; kinsoku-bol, between characters both categorized as nospace,
      ;; or at the beginning of a line.
487
      (let (prev)
488 489
	(when (and (> (current-column) shr-indentation)
		   (eq (preceding-char) ? )
490
		   (or (= (line-beginning-position) (1- (point)))
491 492 493 494 495
		       (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)))))
496
	  (delete-char -1)))
497 498 499 500 501
      ;; 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)))
502
      (insert elem)
503
      (setq shr-state nil)
504
      (let (found)
505 506
	(while (and (> (current-column) shr-internal-width)
		    (> shr-internal-width 0)
507 508 509
		    (progn
		      (setq found (shr-find-fill-point))
		      (not (eolp))))
510 511 512 513
	  (when (eq (preceding-char) ? )
	    (delete-char -1))
	  (insert "\n")
	  (unless found
514 515 516 517 518 519
	    ;; 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))
520
	(if (<= (current-column) shr-internal-width)
521 522
	    (insert " ")
	  ;; In case we couldn't get a valid break point (because of a
523
	  ;; word that's longer than `shr-internal-width'), just break anyway.
524 525 526
	  (insert "\n")
	  (when (> shr-indentation 0)
	    (shr-indent)))))
527
    (unless (string-match "[ \t\r\n ]\\'" text)
528
      (delete-char -1)))))
529

530
(defun shr-find-fill-point ()
531
  (when (> (move-to-column shr-internal-width) shr-internal-width)
532
    (backward-char 1))
533 534
  (let ((bp (point))
	failed)
535
    (while (not (or (setq failed (<= (current-column) shr-indentation))
536 537 538 539
		    (eq (preceding-char) ? )
		    (eq (following-char) ? )
		    (shr-char-breakable-p (preceding-char))
		    (shr-char-breakable-p (following-char))
540 541 542
		    (and (shr-char-kinsoku-bol-p (preceding-char))
			 (shr-char-breakable-p (following-char))
			 (not (shr-char-kinsoku-bol-p (following-char))))
543 544
		    (shr-char-kinsoku-eol-p (following-char))
		    (bolp)))
545 546
      (backward-char 1))
    (if failed
547
	;; There's no breakable point, so we give it up.
548 549 550
	(let (found)
	  (goto-char bp)
	  (unless shr-kinsoku-shorten
551 552 553
	    (while (setq found (re-search-forward
				"\\(\\c>\\)\\| \\|\\c<\\|\\c|"
				(line-end-position) 'move)))
554 555
	    (if (and found
		     (not (match-beginning 1)))
556
		(goto-char (match-beginning 0)))))
557 558
      (or
       (eolp)
559 560 561 562 563 564 565
       ;; 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))
566
	 (when (setq failed (<= (current-column) shr-indentation))
567 568 569 570
	   ;; There's no breakable point that doesn't violate kinsoku,
	   ;; so we look for the second best position.
	   (while (and (progn
			 (forward-char 1)
571
			 (<= (current-column) shr-internal-width))
572 573 574 575 576
		       (progn
			 (setq bp (point))
			 (shr-char-kinsoku-eol-p (following-char)))))
	   (goto-char bp)))
	((shr-char-kinsoku-eol-p (preceding-char))
577 578 579 580 581 582 583 584 585
	 ;; 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)))))))
586
	 (when (setq failed (<= (current-column) shr-indentation))
587 588 589 590 591
	   ;; 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))))
592
	((shr-char-kinsoku-bol-p (following-char))
593 594 595 596 597
	 ;; Find forward the point where kinsoku-bol characters end.
	 (let ((count 4))
	   (while (progn
		    (forward-char 1)
		    (and (>= (setq count (1- count)) 0)
598
			 (shr-char-kinsoku-bol-p (following-char))
599
			 (shr-char-breakable-p (following-char))))))))
600 601 602
       (when (eq (following-char) ? )
	 (forward-char 1))))
    (not failed)))
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))))
Ivan Shmakov's avatar
Ivan Shmakov committed
608 609
  ;; NB: <base href="" > URI may itself be relative to the document s URI
  (setq url (shr-expand-url url))
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  (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)))

625 626
(autoload 'url-expand-file-name "url-expand")

Glenn Morris's avatar
Glenn Morris committed
627 628
;; FIXME This needs some tests writing.
;; Does it even need to exist, given that url-expand-file-name does?
629 630 631
(defun shr-expand-url (url &optional base)
  (setq base
	(if base
Ivan Shmakov's avatar
Ivan Shmakov committed
632
	    ;; shr-parse-base should never call this with non-nil base!
633 634 635 636 637 638 639 640
	    (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
641 642
	 ;; Absolute or empty URI
	 (or url (nth 3 base)))
643 644 645 646 647 648 649 650 651 652 653 654
	((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.
655
	 (url-expand-file-name url (concat (car base) (cadr base))))))
656

657 658 659
(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))
660 661 662

(defun shr-ensure-paragraph ()
  (unless (bobp)
663
    (if (<= (current-column) shr-indentation)
664 665 666
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
667 668 669
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
670 671 672 673 674 675 676 677
	    ;; 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)))))
678
	  (delete-region (match-beginning 0) (match-end 0))
679 680
	(insert "\n\n")))))

681
(defun shr-indent ()
682 683
  (when (> shr-indentation 0)
    (insert (make-string shr-indentation ? ))))
684

685
(defun shr-fontize-cont (cont &rest types)
686 687
  (let (shr-start)
    (shr-generic cont)
688 689
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
690

691 692 693
;; 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.
694
(defun shr-add-font (start end type)
695 696 697 698 699 700 701 702 703 704
  (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))))))
705

706 707 708 709 710 711
(defun shr-mouse-browse-url (ev)
  "Browse the URL under the mouse cursor."
  (interactive "e")
  (mouse-set-point ev)
  (shr-browse-url))

712
(defun shr-browse-url (&optional external mouse-event)
713 714
  "Browse the URL under point.
If EXTERNAL, browse the URL using `shr-external-browser'."
715 716
  (interactive (list current-prefix-arg last-nonmenu-event))
  (mouse-set-point mouse-event)
717
  (let ((url (get-text-property (point) 'shr-url)))
718 719 720 721
    (cond
     ((not url)
      (message "No link under point"))
     ((string-match "^mailto:" url)
722
      (browse-url-mail url))
723
     (t
724 725 726
      (if external
	  (funcall shr-external-browser url)
	(browse-url url))))))
727

728 729 730 731 732 733 734
(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)
735 736
		    'shr-store-contents (list url directory)
		    nil t))))
737 738 739 740 741 742 743 744 745

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

746
(defun shr-image-fetched (status buffer start end &optional flags)
747 748 749 750 751 752
  (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))
753
	(let ((data (shr-parse-image-data)))
754 755 756
	  (with-current-buffer buffer
	    (save-excursion
	      (let ((alt (buffer-substring start end))
757
		    (properties (text-properties-at start))
758 759 760
		    (inhibit-read-only t))
		(delete-region start end)
		(goto-char start)
761 762 763 764 765 766
		(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))))))))))
767
    (kill-buffer image-buffer)))
768

769 770 771 772 773 774 775 776 777 778 779
(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)))

780 781 782 783
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))

784 785 786 787
(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."
788
  (if (display-graphic-p)
789
      (let* ((size (cdr (assq 'size flags)))
790 791 792 793 794
	     (data (if (consp spec)
		       (car spec)
		     spec))
	     (content-type (and (consp spec)
				(cadr spec)))
795 796 797
	     (start (point))
	     (image (cond
		     ((eq size 'original)
798
		      (create-image data nil t :ascent 100
799
				    :format content-type))
800 801
		     ((eq content-type 'image/svg+xml)
		      (create-image data 'svg t :ascent 100))
802 803
		     ((eq size 'full)
		      (ignore-errors
804
			(shr-rescale-image data content-type)))
805 806
		     (t
		      (ignore-errors
807
			(shr-rescale-image data content-type))))))
808
        (when image
809 810 811 812 813
	  ;; 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"))
814
	  (if (eq size 'original)
815
	      (insert-sliced-image image (or alt "*") nil 20 1)
816 817
	    (insert-image image (or alt "*")))
	  (put-text-property start (point) 'image-size size)
818 819
	  (when (and shr-image-animate
                     (cond ((fboundp 'image-multi-frame-p)
820 821 822
		       ;; Only animate multi-frame things that specify a
		       ;; delay; eg animated gifs as opposed to
		       ;; multi-page tiffs.  FIXME?
823 824 825 826
                            (cdr (image-multi-frame-p image)))
                           ((fboundp 'image-animated-p)
                            (image-animated-p image))))
            (image-animate image nil 60)))
827
	image)
828
    (insert alt)))
829

830 831 832 833
(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))))
834 835 836 837 838 839 840 841 842
      (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
843
				(- (nth 3 edges) (nth 1 edges))))
844
       :format content-type))))
845

Glenn Morris's avatar
Glenn Morris committed
846 847 848
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
849
(autoload 'browse-url-mail "browse-url")
Glenn Morris's avatar
Glenn Morris committed
850

851 852 853 854 855
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
856
    (when (ignore-errors
857
	    (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
858 859 860
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
861 862 863
	(shr-parse-image-data)))))

(defun shr-parse-image-data ()
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
  (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
	     (shr-transform-dom
	      (libxml-parse-xml-region (point) (point-max))))))
    (list data content-type)))
883

884 885 886 887
(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
888
START, and END.  Note that START and END should be markers."
889
  `(lambda (url start end)
890 891 892 893 894 895 896
     (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)
897
		   (funcall shr-put-image-function
898
			    image (buffer-substring start end))
899
		   (delete-region (point) end))))
900 901
	 (url-retrieve url 'shr-image-fetched
		       (list (current-buffer) start end)
902
		       t t)))))
903

904 905 906 907 908
(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

909
(defun shr-urlify (start url &optional title)
910
  (shr-add-font start (point) 'shr-link)
911 912 913
  (add-text-properties
   start (point)
   (list 'shr-url url
914
	 'help-echo (if title (format "%s (%s)" url title) url)
915
	 'follow-link t
916
	 'mouse-face 'highlight
917
	 'keymap shr-map)))
918 919 920 921 922

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

923 924
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947

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

948
(defun shr-colorize-region (start end fg &optional bg)
949 950
  (when (and (not shr-inhibit-decoration)
	     (or fg bg))
951
    (let ((new-colors (shr-color-check fg bg)))
952
      (when new-colors
953
	(when fg
954 955 956
	  (add-face-text-property start end
				  (list :foreground (cadr new-colors))
				  t))
957
	(when bg
958 959 960
	  (add-face-text-property start end
				  (list :background (car new-colors))
				  t)))
961
      new-colors)))
962

963 964
(defun shr-expand-newlines (start end color)
  (save-restriction