shr.el 18.1 KB
Newer Older
1 2 3 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
;;; shr.el --- Simple HTML Renderer

;; Copyright (C) 2010 Free Software Foundation, Inc.

;; 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 34
(require 'browse-url)

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
(defgroup shr nil
  "Simple HTML Renderer"
  :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
  :type 'regexp)

55 56 57 58 59
(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.")

60 61 62
(defvar shr-folding-mode nil)
(defvar shr-state nil)
(defvar shr-start nil)
63
(defvar shr-indentation 0)
64
(defvar shr-inhibit-images nil)
65 66 67

(defvar shr-width 70)

68 69 70 71 72 73 74 75 76 77
(defvar shr-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'shr-show-alt-text)
    (define-key map "i" 'shr-browse-image)
    (define-key map "I" 'shr-insert-image)
    (define-key map "u" 'shr-copy-url)
    (define-key map "v" 'shr-browse-url)
    (define-key map "\r" 'shr-browse-url)
    map))

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
(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)
	  (push (cons :text sub) result)
	(push (shr-transform-dom sub) result)))
    (nreverse result)))

;;;###autoload
(defun shr-insert-document (dom)
  (let ((shr-state nil)
	(shr-start nil))
    (shr-descend (shr-transform-dom dom))))

(defun shr-descend (dom)
97
  (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray)))
98 99 100 101 102 103 104 105 106
    (if (fboundp function)
	(funcall function (cdr dom))
      (shr-generic (cdr dom)))))

(defun shr-generic (cont)
  (dolist (sub cont)
    (cond
     ((eq (car sub) :text)
      (shr-insert (cdr sub)))
107
     ((listp (cdr sub))
108 109
      (shr-descend sub)))))

110 111
(defun shr-tag-p (cont)
  (shr-ensure-paragraph)
112
  (shr-generic cont)
113 114 115 116 117
  (shr-ensure-paragraph))

(defun shr-ensure-paragraph ()
  (unless (bobp)
    (if (bolp)
118 119 120
	(unless (save-excursion
		  (forward-line -1)
		  (looking-at " *$"))
121 122 123
	  (insert "\n"))
      (if (save-excursion
	    (beginning-of-line)
124
	    (looking-at " *$"))
125 126 127 128
	  (insert "\n")
	(insert "\n\n")))))

(defun shr-tag-b (cont)
129 130
  (shr-fontize-cont cont 'bold))

131
(defun shr-tag-i (cont)
132 133
  (shr-fontize-cont cont 'italic))

134 135 136
(defun shr-tag-em (cont)
  (shr-fontize-cont cont 'bold))

137
(defun shr-tag-u (cont)
138 139
  (shr-fontize-cont cont 'underline))

140 141
(defun shr-tag-s (cont)
  (shr-fontize-cont cont 'strike-through))
142

143
(defun shr-fontize-cont (cont &rest types)
144 145
  (let (shr-start)
    (shr-generic cont)
146 147
    (dolist (type types)
      (shr-add-font (or shr-start (point)) (point) type))))
148 149 150 151 152

(defun shr-add-font (start end type)
  (let ((overlay (make-overlay start end)))
    (overlay-put overlay 'face type)))

153
(defun shr-tag-a (cont)
154
  (let ((url (cdr (assq :href cont)))
155
	(start (point))
156 157 158
	shr-start)
    (shr-generic cont)
    (widget-convert-button
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
     'link (or shr-start start) (point)
     :help-echo url)
    (put-text-property (or shr-start start) (point) 'keymap shr-map)
    (put-text-property (or shr-start start) (point) 'shr-url url)))

(defun shr-browse-url ()
  "Browse the URL under point."
  (interactive)
  (let ((url (get-text-property (point) 'shr-url)))
    (if (not url)
	(message "No link under point")
      (browse-url url))))

(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))
	     (copy-region-as-kill (point-min) (point-max)))))))
     ;; 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))))))
202

203 204 205 206
(defun shr-tag-img (cont)
  (when (and (> (current-column) 0)
	     (not (eq shr-state 'image)))
    (insert "\n"))
207 208 209 210 211 212
  (let ((start (point-marker)))
    (let ((alt (cdr (assq :alt cont)))
	  (url (cdr (assq :src cont))))
      (when (zerop (length alt))
	(setq alt "[img]"))
      (cond
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
       ((and (not shr-inhibit-images)
	     (string-match "\\`cid:" url))
	(let ((url (substring url (match-end 0)))
	      image)
	  (if (or (not shr-content-function)
		  (not (setq image (funcall shr-content-function url))))
	      (insert alt)
	    (shr-put-image image (point) alt))))
       ((or shr-inhibit-images
	    (and shr-blocked-images
		 (string-match shr-blocked-images url)))
	(setq shr-start (point))
	(let ((shr-state 'space))
	  (if (> (length alt) 8)
	      (shr-insert (substring alt 0 8))
	    (shr-insert alt))))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
229
       ((url-is-cached (browse-url-url-encode-chars url "[&)$ ]"))
230 231 232
	(shr-put-image (shr-get-image-data url) (point) alt))
       (t
	(insert alt)
233 234 235 236
	(ignore-errors
	  (url-retrieve url 'shr-image-fetched
			(list (current-buffer) start (point-marker))
			t))))
237
      (insert " ")
238 239 240
      (put-text-property start (point) 'keymap shr-map)
      (put-text-property start (point) 'shr-alt alt)
      (put-text-property start (point) 'shr-image url)
241 242
      (setq shr-state 'image))))

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
(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))))

(defun shr-browse-image ()
  "Browse the image under point."
  (interactive)
  (let ((url (get-text-property (point) 'shr-image)))
    (if (not url)
	(message "No image under point")
      (message "Browsing %s..." url)
      (browse-url url))))

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
(defun shr-image-fetched (status buffer start end)
  (when (and (buffer-name buffer)
	     (not (plist-get status :error)))
    (url-store-in-cache (current-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
          (let ((alt (buffer-substring start end))
		(inhibit-read-only t))
	    (delete-region start end)
	    (shr-put-image data start alt))))))
  (kill-buffer (current-buffer)))

(defun shr-put-image (data point alt)
  (if (not (display-graphic-p))
      (insert alt)
277 278 279 280
    (let ((image (ignore-errors
		   (shr-rescale-image data))))
      (when image
	(put-image image point alt)))))
281 282 283 284 285 286

(defun shr-rescale-image (data)
  (if (or (not (fboundp 'imagemagick-types))
	  (not (get-buffer-window (current-buffer))))
      (create-image data nil t)
    (let* ((image (create-image data nil t))
287
	   (size (image-size image t))
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	   (width (car size))
	   (height (cdr size))
	   (edges (window-inside-pixel-edges
		   (get-buffer-window (current-buffer))))
	   (window-width (truncate (* shr-max-image-proportion
				      (- (nth 2 edges) (nth 0 edges)))))
	   (window-height (truncate (* shr-max-image-proportion
				       (- (nth 3 edges) (nth 1 edges)))))
	   scaled-image)
      (when (> height window-height)
	(setq image (or (create-image data 'imagemagick t
				      :height window-height)
			image))
	(setq size (image-size image t)))
      (when (> (car size) window-width)
	(setq image (or
		     (create-image data 'imagemagick t
				   :width window-width)
		     image)))
      image)))

309
(defun shr-tag-pre (cont)
310
  (let ((shr-folding-mode 'none))
311 312 313 314
    (shr-ensure-newline)
    (shr-generic cont)
    (shr-ensure-newline)))

315
(defun shr-tag-blockquote (cont)
316
  (shr-ensure-paragraph)
317
  (let ((shr-indentation (+ shr-indentation 4)))
318 319
    (shr-generic cont))
  (shr-ensure-paragraph))
320 321 322 323 324 325 326 327 328 329 330

(defun shr-ensure-newline ()
  (unless (zerop (current-column))
    (insert "\n")))

(defun shr-insert (text)
  (when (eq shr-state 'image)
    (insert "\n")
    (setq shr-state nil))
  (cond
   ((eq shr-folding-mode 'none)
331
    (insert text))
332
   (t
333 334
    (let ((first t)
	  column)
335
      (when (and (string-match "\\`[ \t\n]" text)
336 337
		 (not (bolp)))
	(insert " "))
338 339
      (dolist (elem (split-string text))
	(setq column (current-column))
340
	(when (> column 0)
341
	  (cond
342 343 344
	   ((and (or (not first)
		     (eq shr-state 'space))
		 (> (+ column (length elem) 1) shr-width))
345 346 347 348 349 350
	    (insert "\n"))
	   ((not first)
	    (insert " "))))
	(setq first nil)
	(when (and (bolp)
		   (> shr-indentation 0))
351
	  (shr-indent))
352 353 354 355 356
	;; 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)))
357
	(insert elem))
358
      (setq shr-state nil)
359
      (when (and (string-match "[ \t\n]\\'" text)
360
		 (not (bolp)))
361 362
	(insert " ")
	(setq shr-state 'space))))))
363

364 365 366
(defun shr-indent ()
  (insert (make-string shr-indentation ? )))

367 368 369 370 371
(defun shr-get-image-data (url)
  "Get image data for URL.
Return a string with image data."
  (with-temp-buffer
    (mm-disable-multibyte)
372 373 374 375 376 377
    (when (ignore-errors
	    (url-cache-extract (url-cache-create-filename url))
	    t)
      (when (or (search-forward "\n\n" nil t)
		(search-forward "\r\n\r\n" nil t))
	(buffer-substring (point) (point-max))))))
378

379 380 381 382 383 384 385 386 387 388 389 390 391
(defvar shr-list-mode nil)

(defun shr-tag-ul (cont)
  (shr-ensure-paragraph)
  (let ((shr-list-mode 'ul))
    (shr-generic cont)))

(defun shr-tag-ol (cont)
  (let ((shr-list-mode 1))
    (shr-generic cont)))

(defun shr-tag-li (cont)
  (shr-ensure-newline)
392 393 394 395 396 397 398 399 400
  (let* ((bullet
	  (if (numberp shr-list-mode)
	      (prog1
		  (format "%d " shr-list-mode)
		(setq shr-list-mode (1+ shr-list-mode)))
	    "* "))
	 (shr-indentation (+ shr-indentation (length bullet))))
    (insert bullet)
    (shr-generic cont)))
401 402

(defun shr-tag-br (cont)
403 404
  (unless (bobp)
    (insert "\n"))
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
  (shr-generic cont))

(defun shr-tag-h1 (cont)
  (shr-heading cont 'bold 'underline))

(defun shr-tag-h2 (cont)
  (shr-heading cont 'bold))

(defun shr-tag-h3 (cont)
  (shr-heading cont 'italic))

(defun shr-tag-h4 (cont)
  (shr-heading cont))

(defun shr-tag-h5 (cont)
  (shr-heading cont))

(defun shr-tag-h6 (cont)
  (shr-heading cont))

(defun shr-heading (cont &rest types)
  (shr-ensure-paragraph)
  (apply #'shr-fontize-cont cont types)
  (shr-ensure-paragraph))

430 431 432 433 434 435 436 437
;; Table rendering is the only complicated thing here.  We do this by
;; first counting how many TDs there are in each TR, and registering
;; how wide they think they should be ("width=45%", etc).  Then we
;; render each TD separately (this is done in temporary buffers, so
;; that we can use all the rendering machinery as if we were in the
;; main buffer).  Now we know how much space each TD really takes, so
;; we then render everything again with the new widths, and finally
;; insert all these boxes into the main buffer.
438 439 440 441
(defun shr-tag-table (cont)
  (shr-ensure-paragraph)
  (setq cont (or (cdr (assq 'tbody cont))
		 cont))
442
  (let* ((shr-inhibit-images t)
443
	 ;; Find all suggested widths.
444
	 (columns (shr-column-specs cont))
445
	 ;; Compute how many characters wide each TD should be.
446
	 (suggested-widths (shr-pro-rate-columns columns))
447 448 449
	 ;; Do a "test rendering" to see how big each TD is (this can
	 ;; be smaller (if there's little text) or bigger (if there's
	 ;; unbreakable text).
450 451
	 (sketch (shr-make-table cont suggested-widths))
	 (sketch-widths (shr-table-widths sketch (length suggested-widths))))
452
    ;; Then render the table again with these new "hard" widths.
453
    (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths))
454 455 456
  ;; Finally, insert all the images after the table.  The Emacs buffer
  ;; model isn't strong enough to allow us to put the images actually
  ;; into the tables.
457 458 459 460 461 462 463 464 465 466 467
  (dolist (elem (shr-find-elements cont 'img))
    (shr-tag-img (cdr elem))))

(defun shr-find-elements (cont type)
  (let (result)
    (dolist (elem cont)
      (cond ((eq (car elem) type)
	     (push elem result))
	    ((consp (cdr elem))
	     (setq result (nconc (shr-find-elements (cdr elem) type) result)))))
    (nreverse result)))
468 469 470 471 472 473 474 475 476 477 478 479 480 481

(defun shr-insert-table (table widths)
  (shr-insert-table-ruler widths)
  (dolist (row table)
    (let ((start (point))
	  (height (let ((max 0))
		    (dolist (column row)
		      (setq max (max max (cadr column))))
		    max)))
      (dotimes (i height)
	(shr-indent)
	(insert "|\n"))
      (dolist (column row)
	(goto-char start)
482 483 484
	(let ((lines (split-string (nth 2 column) "\n"))
	      (overlay-lines (nth 3 column))
	      overlay overlay-line)
485
	  (dolist (line lines)
486
	    (setq overlay-line (pop overlay-lines))
487 488 489
	    (when (> (length line) 0)
	      (end-of-line)
	      (insert line "|")
490 491 492 493 494 495
	      (dolist (overlay overlay-line)
		(let ((o (make-overlay (- (point) (nth 0 overlay) 1)
				       (- (point) (nth 1 overlay) 1)))
		      (properties (nth 2 overlay)))
		  (while properties
		    (overlay-put o (pop properties) (pop properties)))))
496 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 523 524 525
	      (forward-line 1)))
	  ;; Add blank lines at padding at the bottom of the TD,
	  ;; possibly.
	  (dotimes (i (- height (length lines)))
	    (end-of-line)
	    (insert (make-string (length (car lines)) ? ) "|")
	    (forward-line 1)))))
    (shr-insert-table-ruler widths)))

(defun shr-insert-table-ruler (widths)
  (shr-indent)
  (insert "+")
  (dotimes (i (length widths))
    (insert (make-string (aref widths i) ?-) ?+))
  (insert "\n"))

(defun shr-table-widths (table length)
  (let ((widths (make-vector length 0)))
    (dolist (row table)
      (let ((i 0))
	(dolist (column row)
	  (aset widths i (max (aref widths i)
			      (car column)))
	  (incf i))))
    widths))

(defun shr-make-table (cont widths &optional fill)
  (let ((trs nil))
    (dolist (row cont)
      (when (eq (car row) 'tr)
526 527 528 529 530 531 532 533
	(let ((tds nil)
	      (columns (cdr row))
	      (i 0)
	      column)
	  (while (< i (length widths))
	    (setq column (pop columns))
	    (when (or (memq (car column) '(td th))
		      (null column))
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
	      (push (shr-render-td (cdr column) (aref widths i) fill)
		    tds)
	      (setq i (1+ i))))
	  (push (nreverse tds) trs))))
    (nreverse trs)))

(defun shr-render-td (cont width fill)
  (with-temp-buffer
    (let ((shr-width width)
	  (shr-indentation 0))
      (shr-generic cont))
    (while (re-search-backward "\n *$" nil t)
      (delete-region (match-beginning 0) (match-end 0)))
    (goto-char (point-min))
    (let ((max 0))
      (while (not (eobp))
	(end-of-line)
	(setq max (max max (current-column)))
	(forward-line 1))
      (when fill
	(goto-char (point-min))
555 556 557 558 559 560 561 562 563 564
	;; If the buffer is totally empty, then put a single blank
	;; line here.
	(if (zerop (buffer-size))
	    (insert (make-string width ? ))
	  ;; Otherwise, fill the buffer.
	  (while (not (eobp))
	    (end-of-line)
	    (when (> (- width (current-column)) 0)
	      (insert (make-string (- width (current-column)) ? )))
	    (forward-line 1))))
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
      (list max
	    (count-lines (point-min) (point-max))
	    (buffer-string)
	    (and fill
		 (shr-collect-overlays))))))

(defun shr-collect-overlays ()
  (save-excursion
    (goto-char (point-min))
    (let ((overlays nil))
      (while (not (eobp))
	(push (shr-overlays-in-region (point) (line-end-position))
	      overlays)
	(forward-line 1))
      (nreverse overlays))))

(defun shr-overlays-in-region (start end)
  (let (result)
    (dolist (overlay (overlays-in start end))
      (push (list (if (> start (overlay-start overlay))
		      (- end start)
		    (- end (overlay-start overlay)))
		  (if (< end (overlay-end overlay))
		      0
		    (- end (overlay-end overlay)))
		  (overlay-properties overlay))
	    result))
    (nreverse result)))
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619

(defun shr-pro-rate-columns (columns)
  (let ((total-percentage 0)
	(widths (make-vector (length columns) 0)))
    (dotimes (i (length columns))
      (incf total-percentage (aref columns i)))
    (setq total-percentage (/ 1.0 total-percentage))
    (dotimes (i (length columns))
      (aset widths i (max (truncate (* (aref columns i)
				       total-percentage
				       shr-width))
			  10)))
    widths))

;; Return a summary of the number and shape of the TDs in the table.
(defun shr-column-specs (cont)
  (let ((columns (make-vector (shr-max-columns cont) 1)))
    (dolist (row cont)
      (when (eq (car row) 'tr)
	(let ((i 0))
	  (dolist (column (cdr row))
	    (when (memq (car column) '(td th))
	      (let ((width (cdr (assq :width (cdr column)))))
		(when (and width
			   (string-match "\\([0-9]+\\)%" width))
		  (aset columns i
			(/ (string-to-number (match-string 1 width))
620 621
			   100.0))))
	      (setq i (1+ i)))))))
622 623 624 625 626 627 628 629 630 631 632 633 634
    columns))

(defun shr-count (cont elem)
  (let ((i 0))
    (dolist (sub cont)
      (when (eq (car sub) elem)
	(setq i (1+ i))))
    i))

(defun shr-max-columns (cont)
  (let ((max 0))
    (dolist (row cont)
      (when (eq (car row) 'tr)
635 636
	(setq max (max max (+ (shr-count (cdr row) 'td)
			      (shr-count (cdr row) 'th))))))
637 638
    max))

639
(provide 'shr)
640 641

;;; shr.el ends here