(article-transform-date): Fix infinite recursion.
[gnus] / lisp / shr.el
1 ;;; shr.el --- Simple HTML Renderer
2
3 ;; Copyright (C) 2010-2011 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: html
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;; This package takes a HTML parse tree (as provided by
26 ;; libxml-parse-html-region) and renders it in the current buffer.  It
27 ;; does not do CSS, JavaScript or anything advanced: It's geared
28 ;; towards rendering typical short snippets of HTML, like what you'd
29 ;; find in HTML email and the like.
30
31 ;;; Code:
32
33 (eval-when-compile (require 'cl))
34 (require 'browse-url)
35
36 (defgroup shr nil
37   "Simple HTML Renderer"
38   :group 'mail)
39
40 (defcustom shr-max-image-proportion 0.9
41   "How big pictures displayed are in relation to the window they're in.
42 A value of 0.7 means that they are allowed to take up 70% of the
43 width and height of the window.  If they are larger than this,
44 and Emacs supports it, then the images will be rescaled down to
45 fit these criteria."
46   :version "24.1"
47   :group 'shr
48   :type 'float)
49
50 (defcustom shr-blocked-images nil
51   "Images that have URLs matching this regexp will be blocked."
52   :version "24.1"
53   :group 'shr
54   :type 'regexp)
55
56 (defcustom shr-table-horizontal-line ?-
57   "Character used to draw horizontal table lines."
58   :group 'shr
59   :type 'character)
60
61 (defcustom shr-table-vertical-line ?|
62   "Character used to draw vertical table lines."
63   :group 'shr
64   :type 'character)
65
66 (defcustom shr-table-corner ?+
67   "Character used to draw table corners."
68   :group 'shr
69   :type 'character)
70
71 (defcustom shr-hr-line ?-
72   "Character used to draw hr lines."
73   :group 'shr
74   :type 'character)
75
76 (defcustom shr-width fill-column
77   "Frame width to use for rendering.
78 May either be an integer specifying a fixed width in characters,
79 or nil, meaning that the full width of the window should be
80 used."
81   :type '(choice (integer :tag "Fixed width in characters")
82                  (const   :tag "Use the width of the window" nil))
83   :group 'shr)
84
85 (defvar shr-content-function nil
86   "If bound, this should be a function that will return the content.
87 This is used for cid: URLs, and the function is called with the
88 cid: URL as the argument.")
89
90 ;;; Internal variables.
91
92 (defvar shr-folding-mode nil)
93 (defvar shr-state nil)
94 (defvar shr-start nil)
95 (defvar shr-indentation 0)
96 (defvar shr-inhibit-images nil)
97 (defvar shr-list-mode nil)
98 (defvar shr-content-cache nil)
99 (defvar shr-kinsoku-shorten nil)
100 (defvar shr-table-depth 0)
101 (defvar shr-stylesheet nil)
102
103 (defvar shr-map
104   (let ((map (make-sparse-keymap)))
105     (define-key map "a" 'shr-show-alt-text)
106     (define-key map "i" 'shr-browse-image)
107     (define-key map "I" 'shr-insert-image)
108     (define-key map "u" 'shr-copy-url)
109     (define-key map "v" 'shr-browse-url)
110     (define-key map "o" 'shr-save-contents)
111     (define-key map "\r" 'shr-browse-url)
112     map))
113
114 ;; Public functions and commands.
115
116 ;;;###autoload
117 (defun shr-insert-document (dom)
118   (setq shr-content-cache nil)
119   (let ((shr-state nil)
120         (shr-start nil)
121         (shr-width (or shr-width (window-width))))
122     (shr-descend (shr-transform-dom dom))))
123
124 (defun shr-copy-url ()
125   "Copy the URL under point to the kill ring.
126 If called twice, then try to fetch the URL and see whether it
127 redirects somewhere else."
128   (interactive)
129   (let ((url (get-text-property (point) 'shr-url)))
130     (cond
131      ((not url)
132       (message "No URL under point"))
133      ;; Resolve redirected URLs.
134      ((equal url (car kill-ring))
135       (url-retrieve
136        url
137        (lambda (a)
138          (when (and (consp a)
139                     (eq (car a) :redirect))
140            (with-temp-buffer
141              (insert (cadr a))
142              (goto-char (point-min))
143              ;; Remove common tracking junk from the URL.
144              (when (re-search-forward ".utm_.*" nil t)
145                (replace-match "" t t))
146              (message "Copied %s" (buffer-string))
147              (copy-region-as-kill (point-min) (point-max)))))))
148      ;; Copy the URL to the kill ring.
149      (t
150       (with-temp-buffer
151         (insert url)
152         (copy-region-as-kill (point-min) (point-max))
153         (message "Copied %s" url))))))
154
155 (defun shr-show-alt-text ()
156   "Show the ALT text of the image under point."
157   (interactive)
158   (let ((text (get-text-property (point) 'shr-alt)))
159     (if (not text)
160         (message "No image under point")
161       (message "%s" text))))
162
163 (defun shr-browse-image ()
164   "Browse the image under point."
165   (interactive)
166   (let ((url (get-text-property (point) 'image-url)))
167     (if (not url)
168         (message "No image under point")
169       (message "Browsing %s..." url)
170       (browse-url url))))
171
172 (defun shr-insert-image ()
173   "Insert the image under point into the buffer."
174   (interactive)
175   (let ((url (get-text-property (point) 'image-url)))
176     (if (not url)
177         (message "No image under point")
178       (message "Inserting %s..." url)
179       (url-retrieve url 'shr-image-fetched
180                     (list (current-buffer) (1- (point)) (point-marker))
181                     t))))
182
183 ;;; Utility functions.
184
185 (defun shr-transform-dom (dom)
186   (let ((result (list (pop dom))))
187     (dolist (arg (pop dom))
188       (push (cons (intern (concat ":" (symbol-name (car arg))) obarray)
189                   (cdr arg))
190             result))
191     (dolist (sub dom)
192       (if (stringp sub)
193           (push (cons 'text sub) result)
194         (push (shr-transform-dom sub) result)))
195     (nreverse result)))
196
197 (defun shr-descend (dom)
198   (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray))
199         (style (cdr (assq :style (cdr dom))))
200         (shr-stylesheet shr-stylesheet)
201         (start (point)))
202     (when style
203       (if (string-match "color" style)
204           (setq shr-stylesheet (nconc (shr-parse-style style)
205                                       shr-stylesheet))
206         (setq style nil)))
207     (if (fboundp function)
208         (funcall function (cdr dom))
209       (shr-generic (cdr dom)))
210     ;; If style is set, then this node has set the color.
211     (when style
212       (shr-colorize-region start (point)
213                            (cdr (assq 'color shr-stylesheet))
214                            (cdr (assq 'background-color shr-stylesheet))))))
215
216 (defun shr-generic (cont)
217   (dolist (sub cont)
218     (cond
219      ((eq (car sub) 'text)
220       (shr-insert (cdr sub)))
221      ((listp (cdr sub))
222       (shr-descend sub)))))
223
224 (defmacro shr-char-breakable-p (char)
225   "Return non-nil if a line can be broken before and after CHAR."
226   `(aref fill-find-break-point-function-table ,char))
227 (defmacro shr-char-nospace-p (char)
228   "Return non-nil if no space is required before and after CHAR."
229   `(aref fill-nospace-between-words-table ,char))
230
231 ;; KINSOKU is a Japanese word meaning a rule that should not be violated.
232 ;; In Emacs, it is a term used for characters, e.g. punctuation marks,
233 ;; parentheses, and so on, that should not be placed in the beginning
234 ;; of a line or the end of a line.
235 (defmacro shr-char-kinsoku-bol-p (char)
236   "Return non-nil if a line ought not to begin with CHAR."
237   `(aref (char-category-set ,char) ?>))
238 (defmacro shr-char-kinsoku-eol-p (char)
239   "Return non-nil if a line ought not to end with CHAR."
240   `(aref (char-category-set ,char) ?<))
241 (unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
242   (load "kinsoku" nil t))
243
244 (defun shr-insert (text)
245   (when (and (eq shr-state 'image)
246              (not (string-match "\\`[ \t\n]+\\'" text)))
247     (insert "\n")
248     (setq shr-state nil))
249   (cond
250    ((eq shr-folding-mode 'none)
251     (insert text))
252    (t
253     (when (and (string-match "\\`[ \t\n]" text)
254                (not (bolp))
255                (not (eq (char-after (1- (point))) ? )))
256       (insert " "))
257     (dolist (elem (split-string text))
258       (when (and (bolp)
259                  (> shr-indentation 0))
260         (shr-indent))
261       ;; No space is needed behind a wide character categorized as
262       ;; kinsoku-bol, between characters both categorized as nospace,
263       ;; or at the beginning of a line.
264       (let (prev)
265         (when (and (> (current-column) shr-indentation)
266                    (eq (preceding-char) ? )
267                    (or (= (line-beginning-position) (1- (point)))
268                        (and (shr-char-breakable-p
269                              (setq prev (char-after (- (point) 2))))
270                             (shr-char-kinsoku-bol-p prev))
271                        (and (shr-char-nospace-p prev)
272                             (shr-char-nospace-p (aref elem 0)))))
273           (delete-char -1)))
274       ;; The shr-start is a special variable that is used to pass
275       ;; upwards the first point in the buffer where the text really
276       ;; starts.
277       (unless shr-start
278         (setq shr-start (point)))
279       (insert elem)
280       (let (found)
281         (while (and (> (current-column) shr-width)
282                     (progn
283                       (setq found (shr-find-fill-point))
284                       (not (eolp))))
285           (when (eq (preceding-char) ? )
286             (delete-char -1))
287           (insert "\n")
288           (unless found
289             (put-text-property (1- (point)) (point) 'shr-break t)
290             ;; No space is needed at the beginning of a line.
291             (when (eq (following-char) ? )
292               (delete-char 1)))
293           (when (> shr-indentation 0)
294             (shr-indent))
295           (end-of-line))
296         (insert " ")))
297     (unless (string-match "[ \t\n]\\'" text)
298       (delete-char -1)))))
299
300 (defun shr-find-fill-point ()
301   (when (> (move-to-column shr-width) shr-width)
302     (backward-char 1))
303   (let ((bp (point))
304         failed)
305     (while (not (or (setq failed (= (current-column) shr-indentation))
306                     (eq (preceding-char) ? )
307                     (eq (following-char) ? )
308                     (shr-char-breakable-p (preceding-char))
309                     (shr-char-breakable-p (following-char))
310                     (if (eq (preceding-char) ?')
311                         (not (memq (char-after (- (point) 2))
312                                    (list nil ?\n ? )))
313                       (and (shr-char-kinsoku-bol-p (preceding-char))
314                            (shr-char-breakable-p (following-char))
315                            (not (shr-char-kinsoku-bol-p (following-char)))))
316                     (shr-char-kinsoku-eol-p (following-char))))
317       (backward-char 1))
318     (if (and (not (or failed (eolp)))
319              (eq (preceding-char) ?'))
320         (while (not (or (setq failed (eolp))
321                         (eq (following-char) ? )
322                         (shr-char-breakable-p (following-char))
323                         (shr-char-kinsoku-eol-p (following-char))))
324           (forward-char 1)))
325     (if failed
326         ;; There's no breakable point, so we give it up.
327         (let (found)
328           (goto-char bp)
329           (unless shr-kinsoku-shorten
330             (while (and (setq found (re-search-forward
331                                      "\\(\\c>\\)\\| \\|\\c<\\|\\c|"
332                                      (line-end-position) 'move))
333                         (eq (preceding-char) ?')))
334             (if (and found (not (match-beginning 1)))
335                 (goto-char (match-beginning 0)))))
336       (or
337        (eolp)
338        ;; Don't put kinsoku-bol characters at the beginning of a line,
339        ;; or kinsoku-eol characters at the end of a line.
340        (cond
341         (shr-kinsoku-shorten
342          (while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
343                      (shr-char-kinsoku-eol-p (preceding-char)))
344            (backward-char 1))
345          (when (setq failed (= (current-column) shr-indentation))
346            ;; There's no breakable point that doesn't violate kinsoku,
347            ;; so we look for the second best position.
348            (while (and (progn
349                          (forward-char 1)
350                          (<= (current-column) shr-width))
351                        (progn
352                          (setq bp (point))
353                          (shr-char-kinsoku-eol-p (following-char)))))
354            (goto-char bp)))
355         ((shr-char-kinsoku-eol-p (preceding-char))
356          (if (shr-char-kinsoku-eol-p (following-char))
357              ;; There are consecutive kinsoku-eol characters.
358              (setq failed t)
359            (let ((count 4))
360              (while
361                  (progn
362                    (backward-char 1)
363                    (and (> (setq count (1- count)) 0)
364                         (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
365                         (or (shr-char-kinsoku-eol-p (preceding-char))
366                             (shr-char-kinsoku-bol-p (following-char)))))))
367            (if (setq failed (= (current-column) shr-indentation))
368                ;; There's no breakable point that doesn't violate kinsoku,
369                ;; so we go to the second best position.
370                (if (looking-at "\\(\\c<+\\)\\c<")
371                    (goto-char (match-end 1))
372                  (forward-char 1)))))
373         (t
374          (if (shr-char-kinsoku-bol-p (preceding-char))
375              ;; There are consecutive kinsoku-bol characters.
376              (setq failed t)
377            (let ((count 4))
378              (while (and (>= (setq count (1- count)) 0)
379                          (shr-char-kinsoku-bol-p (following-char))
380                          (shr-char-breakable-p (following-char)))
381                (forward-char 1))))))
382        (when (eq (following-char) ? )
383          (forward-char 1))))
384     (not failed)))
385
386 (defun shr-ensure-newline ()
387   (unless (zerop (current-column))
388     (insert "\n")))
389
390 (defun shr-ensure-paragraph ()
391   (unless (bobp)
392     (if (<= (current-column) shr-indentation)
393         (unless (save-excursion
394                   (forward-line -1)
395                   (looking-at " *$"))
396           (insert "\n"))
397       (if (save-excursion
398             (beginning-of-line)
399             (looking-at " *$"))
400           (insert "\n")
401         (insert "\n\n")))))
402
403 (defun shr-indent ()
404   (when (> shr-indentation 0)
405     (insert (make-string shr-indentation ? ))))
406
407 (defun shr-fontize-cont (cont &rest types)
408   (let (shr-start)
409     (shr-generic cont)
410     (dolist (type types)
411       (shr-add-font (or shr-start (point)) (point) type))))
412
413 ;; Add an overlay in the region, but avoid putting the font properties
414 ;; on blank text at the start of the line, and the newline at the end,
415 ;; to avoid ugliness.
416 (defun shr-add-font (start end type)
417   (save-excursion
418     (goto-char start)
419     (while (< (point) end)
420       (when (bolp)
421         (skip-chars-forward " "))
422       (let ((overlay (make-overlay (point) (min (line-end-position) end))))
423         (overlay-put overlay 'face type))
424       (if (< (line-end-position) end)
425           (forward-line 1)
426         (goto-char end)))))
427
428 (defun shr-browse-url ()
429   "Browse the URL under point."
430   (interactive)
431   (let ((url (get-text-property (point) 'shr-url)))
432     (cond
433      ((not url)
434       (message "No link under point"))
435      ((string-match "^mailto:" url)
436       (browse-url-mailto url))
437      (t
438       (browse-url url)))))
439
440 (defun shr-save-contents (directory)
441   "Save the contents from URL in a file."
442   (interactive "DSave contents of URL to directory: ")
443   (let ((url (get-text-property (point) 'shr-url)))
444     (if (not url)
445         (message "No link under point")
446       (url-retrieve (shr-encode-url url)
447                     'shr-store-contents (list url directory)))))
448
449 (defun shr-store-contents (status url directory)
450   (unless (plist-get status :error)
451     (when (or (search-forward "\n\n" nil t)
452               (search-forward "\r\n\r\n" nil t))
453       (write-region (point) (point-max)
454                     (expand-file-name (file-name-nondirectory url)
455                                       directory)))))
456
457 (defun shr-image-fetched (status buffer start end)
458   (when (and (buffer-name buffer)
459              (not (plist-get status :error)))
460     (url-store-in-cache (current-buffer))
461     (when (or (search-forward "\n\n" nil t)
462               (search-forward "\r\n\r\n" nil t))
463       (let ((data (buffer-substring (point) (point-max))))
464         (with-current-buffer buffer
465           (save-excursion
466             (let ((alt (buffer-substring start end))
467                   (inhibit-read-only t))
468               (delete-region start end)
469               (goto-char start)
470               (shr-put-image data alt)))))))
471   (kill-buffer (current-buffer)))
472
473 (defun shr-put-image (data alt)
474   (if (display-graphic-p)
475       (let ((image (ignore-errors
476                      (shr-rescale-image data))))
477         (when image
478           ;; When inserting big-ish pictures, put them at the
479           ;; beginning of the line.
480           (when (and (> (current-column) 0)
481                      (> (car (image-size image t)) 400))
482             (insert "\n"))
483           (insert-image image (or alt "*"))))
484     (insert alt)))
485
486 (defun shr-rescale-image (data)
487   (if (or (not (fboundp 'imagemagick-types))
488           (not (get-buffer-window (current-buffer))))
489       (create-image data nil t)
490     (let* ((image (create-image data nil t))
491            (size (image-size image t))
492            (width (car size))
493            (height (cdr size))
494            (edges (window-inside-pixel-edges
495                    (get-buffer-window (current-buffer))))
496            (window-width (truncate (* shr-max-image-proportion
497                                       (- (nth 2 edges) (nth 0 edges)))))
498            (window-height (truncate (* shr-max-image-proportion
499                                        (- (nth 3 edges) (nth 1 edges)))))
500            scaled-image)
501       (when (> height window-height)
502         (setq image (or (create-image data 'imagemagick t
503                                       :height window-height)
504                         image))
505         (setq size (image-size image t)))
506       (when (> (car size) window-width)
507         (setq image (or
508                      (create-image data 'imagemagick t
509                                    :width window-width)
510                      image)))
511       (when (and (fboundp 'create-animated-image)
512                  (eq (image-type data nil t) 'gif))
513         (setq image (create-animated-image data 'gif t)))
514       image)))
515
516 ;; url-cache-extract autoloads url-cache.
517 (declare-function url-cache-create-filename "url-cache" (url))
518 (autoload 'mm-disable-multibyte "mm-util")
519 (autoload 'browse-url-mailto "browse-url")
520
521 (defun shr-get-image-data (url)
522   "Get image data for URL.
523 Return a string with image data."
524   (with-temp-buffer
525     (mm-disable-multibyte)
526     (when (ignore-errors
527             (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
528             t)
529       (when (or (search-forward "\n\n" nil t)
530                 (search-forward "\r\n\r\n" nil t))
531         (buffer-substring (point) (point-max))))))
532
533 (defun shr-image-displayer (content-function)
534   "Return a function to display an image.
535 CONTENT-FUNCTION is a function to retrieve an image for a cid url that
536 is an argument.  The function to be returned takes three arguments URL,
537 START, and END.  Note that START and END should be merkers."
538   `(lambda (url start end)
539      (when url
540        (if (string-match "\\`cid:" url)
541            ,(when content-function
542               `(let ((image (funcall ,content-function
543                                      (substring url (match-end 0)))))
544                  (when image
545                    (goto-char start)
546                    (shr-put-image image
547                                   (buffer-substring-no-properties start end))
548                    (delete-region (point) end))))
549          (url-retrieve url 'shr-image-fetched
550                        (list (current-buffer) start end)
551                        t)))))
552
553 (defun shr-heading (cont &rest types)
554   (shr-ensure-paragraph)
555   (apply #'shr-fontize-cont cont types)
556   (shr-ensure-paragraph))
557
558 (autoload 'widget-convert-button "wid-edit")
559
560 (defun shr-urlify (start url &optional title)
561   (widget-convert-button
562    'url-link start (point)
563    :help-echo (if title (format "%s (%s)" url title) url)
564    :keymap shr-map
565    url)
566   (put-text-property start (point) 'shr-url url))
567
568 (defun shr-encode-url (url)
569   "Encode URL."
570   (browse-url-url-encode-chars url "[)$ ]"))
571
572 (autoload 'shr-color-visible "shr-color")
573 (autoload 'shr-color->hexadecimal "shr-color")
574
575 (defun shr-color-check (fg bg)
576   "Check that FG is visible on BG.
577 Returns (fg bg) with corrected values.
578 Returns nil if the colors that would be used are the default
579 ones, in case fg and bg are nil."
580   (when (or fg bg)
581     (let ((fixed (cond ((null fg) 'fg)
582                        ((null bg) 'bg))))
583       ;; Convert colors to hexadecimal, or set them to default.
584       (let ((fg (or (shr-color->hexadecimal fg)
585                     (frame-parameter nil 'foreground-color)))
586             (bg (or (shr-color->hexadecimal bg)
587                     (frame-parameter nil 'background-color))))
588         (cond ((eq fixed 'bg)
589                ;; Only return the new fg
590                (list nil (cadr (shr-color-visible bg fg t))))
591               ((eq fixed 'fg)
592                ;; Invert args and results and return only the new bg
593                (list (cadr (shr-color-visible fg bg t)) nil))
594               (t
595                (shr-color-visible bg fg)))))))
596
597 (defun shr-colorize-region (start end fg &optional bg)
598   (when (or fg bg)
599     (let ((new-colors (shr-color-check fg bg)))
600       (when new-colors
601         (when fg
602           (shr-put-color start end :foreground (cadr new-colors)))
603         (when bg
604           (shr-put-color start end :background (car new-colors)))))))
605
606 ;; Put a color in the region, but avoid putting colors on on blank
607 ;; text at the start of the line, and the newline at the end, to avoid
608 ;; ugliness.  Also, don't overwrite any existing color information,
609 ;; since this can be called recursively, and we want the "inner" color
610 ;; to win.
611 (defun shr-put-color (start end type color)
612   (save-excursion
613     (goto-char start)
614     (while (< (point) end)
615       (when (and (bolp)
616                  (not (eq type :background)))
617         (skip-chars-forward " "))
618       (when (> (line-end-position) (point))
619         (shr-put-color-1 (point) (min (line-end-position) end) type color))
620       (if (< (line-end-position) end)
621           (forward-line 1)
622         (goto-char end)))
623     (when (and (eq type :background)
624                (= shr-table-depth 0))
625       (shr-expand-newlines start end color))))
626
627 (defun shr-expand-newlines (start end color)
628   (save-restriction
629     ;; Skip past all white space at the start and ends.
630     (goto-char start)
631     (skip-chars-forward " \t\n")
632     (beginning-of-line)
633     (setq start (point))
634     (goto-char end)
635     (skip-chars-backward " \t\n")
636     (forward-line 1)
637     (setq end (point))
638     (narrow-to-region start end)
639     (let ((width (shr-natural-width))
640           column)
641       (goto-char (point-min))
642       (while (not (eobp))
643         (end-of-line)
644         (when (and (< (setq column (current-column)) width)
645                    (< (setq column (shr-previous-newline-padding-width column))
646                       width))
647           (let ((overlay (make-overlay (point) (1+ (point)))))
648             (overlay-put overlay 'before-string
649                          (concat
650                           (mapconcat
651                            (lambda (overlay)
652                              (let ((string (plist-get
653                                             (overlay-properties overlay)
654                                             'before-string)))
655                                (if (not string)
656                                    ""
657                                  (overlay-put overlay 'before-string "")
658                                  string)))
659                            (overlays-at (point))
660                            "")
661                           (propertize (make-string (- width column) ? )
662                                       'face (list :background color))))))
663         (forward-line 1)))))
664
665 (defun shr-previous-newline-padding-width (width)
666   (let ((overlays (overlays-at (point)))
667         (previous-width 0))
668     (if (null overlays)
669         width
670       (dolist (overlay overlays)
671         (setq previous-width
672               (+ previous-width
673                  (length (plist-get (overlay-properties overlay)
674                                     'before-string)))))
675       (+ width previous-width))))
676
677 (defun shr-put-color-1 (start end type color)
678   (let* ((old-props (get-text-property start 'face))
679          (do-put (not (memq type old-props)))
680          change)
681     (while (< start end)
682       (setq change (next-single-property-change start 'face nil end))
683       (when do-put
684         (put-text-property start change 'face
685                            (nconc (list type color) old-props)))
686       (setq old-props (get-text-property change 'face))
687       (setq do-put (not (memq type old-props)))
688       (setq start change))
689     (when (and do-put
690                (> end start))
691       (put-text-property start end 'face
692                          (nconc (list type color old-props))))))
693
694 ;;; Tag-specific rendering rules.
695
696 (defun shr-tag-body (cont)
697   (let* ((start (point))
698          (fgcolor (cdr (assq :fgcolor cont)))
699          (bgcolor (cdr (assq :bgcolor cont)))
700          (shr-stylesheet (list (cons 'color fgcolor)
701                                (cons 'background-color bgcolor))))
702     (shr-generic cont)
703     (shr-colorize-region start (point) fgcolor bgcolor)))
704
705 (defun shr-tag-style (cont)
706   )
707
708 (defun shr-tag-script (cont)
709   )
710
711 (defun shr-tag-label (cont)
712   (shr-generic cont)
713   (shr-ensure-paragraph))
714
715 (defun shr-tag-p (cont)
716   (shr-ensure-paragraph)
717   (shr-indent)
718   (shr-generic cont)
719   (shr-ensure-paragraph))
720
721 (defun shr-tag-div (cont)
722   (shr-ensure-newline)
723   (shr-indent)
724   (shr-generic cont)
725   (shr-ensure-newline))
726
727 (defun shr-tag-b (cont)
728   (shr-fontize-cont cont 'bold))
729
730 (defun shr-tag-i (cont)
731   (shr-fontize-cont cont 'italic))
732
733 (defun shr-tag-em (cont)
734   (shr-fontize-cont cont 'bold))
735
736 (defun shr-tag-strong (cont)
737   (shr-fontize-cont cont 'bold))
738
739 (defun shr-tag-u (cont)
740   (shr-fontize-cont cont 'underline))
741
742 (defun shr-tag-s (cont)
743   (shr-fontize-cont cont 'strike-through))
744
745 (defun shr-parse-style (style)
746   (when style
747     (save-match-data
748       (when (string-match "\n" style)
749         (setq style (replace-match " " t t style))))
750     (let ((plist nil))
751       (dolist (elem (split-string style ";"))
752         (when elem
753           (setq elem (split-string elem ":"))
754           (when (and (car elem)
755                      (cadr elem))
756             (let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
757                   (value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
758               (when (string-match " *!important\\'" value)
759                 (setq value (substring value 0 (match-beginning 0))))
760               (push (cons (intern name obarray)
761                           value)
762                     plist)))))
763       plist)))
764
765 (defun shr-tag-a (cont)
766   (let ((url (cdr (assq :href cont)))
767         (title (cdr (assq :title cont)))
768         (start (point))
769         shr-start)
770     (shr-generic cont)
771     (shr-urlify (or shr-start start) url title)))
772
773 (defun shr-tag-object (cont)
774   (let ((start (point))
775         url)
776     (dolist (elem cont)
777       (when (eq (car elem) 'embed)
778         (setq url (or url (cdr (assq :src (cdr elem))))))
779       (when (and (eq (car elem) 'param)
780                  (equal (cdr (assq :name (cdr elem))) "movie"))
781         (setq url (or url (cdr (assq :value (cdr elem)))))))
782     (when url
783       (shr-insert " [multimedia] ")
784       (shr-urlify start url))
785     (shr-generic cont)))
786
787 (defun shr-tag-video (cont)
788   (let ((image (cdr (assq :poster cont)))
789         (url (cdr (assq :src cont)))
790         (start (point)))
791     (shr-tag-img nil image)
792     (shr-urlify start url)))
793
794 (defun shr-tag-img (cont &optional url)
795   (when (or url
796             (and cont
797                  (cdr (assq :src cont))))
798     (when (and (> (current-column) 0)
799                (not (eq shr-state 'image)))
800       (insert "\n"))
801     (let ((alt (cdr (assq :alt cont)))
802           (url (or url (cdr (assq :src cont)))))
803       (let ((start (point-marker)))
804         (when (zerop (length alt))
805           (setq alt "*"))
806         (cond
807          ((or (member (cdr (assq :height cont)) '("0" "1"))
808               (member (cdr (assq :width cont)) '("0" "1")))
809           ;; Ignore zero-sized or single-pixel images.
810           )
811          ((and (not shr-inhibit-images)
812                (string-match "\\`cid:" url))
813           (let ((url (substring url (match-end 0)))
814                 image)
815             (if (or (not shr-content-function)
816                     (not (setq image (funcall shr-content-function url))))
817                 (insert alt)
818               (shr-put-image image alt))))
819          ((or shr-inhibit-images
820               (and shr-blocked-images
821                    (string-match shr-blocked-images url)))
822           (setq shr-start (point))
823           (let ((shr-state 'space))
824             (if (> (string-width alt) 8)
825                 (shr-insert (truncate-string-to-width alt 8))
826               (shr-insert alt))))
827          ((url-is-cached (shr-encode-url url))
828           (shr-put-image (shr-get-image-data url) alt))
829          (t
830           (insert alt)
831           (ignore-errors
832             (url-retrieve (shr-encode-url url) 'shr-image-fetched
833                           (list (current-buffer) start (point-marker))
834                           t))))
835         (put-text-property start (point) 'keymap shr-map)
836         (put-text-property start (point) 'shr-alt alt)
837         (put-text-property start (point) 'image-url url)
838         (put-text-property start (point) 'image-displayer
839                            (shr-image-displayer shr-content-function))
840         (put-text-property start (point) 'help-echo alt)
841         (setq shr-state 'image)))))
842
843 (defun shr-tag-pre (cont)
844   (let ((shr-folding-mode 'none))
845     (shr-ensure-newline)
846     (shr-indent)
847     (shr-generic cont)
848     (shr-ensure-newline)))
849
850 (defun shr-tag-blockquote (cont)
851   (shr-ensure-paragraph)
852   (shr-indent)
853   (let ((shr-indentation (+ shr-indentation 4)))
854     (shr-generic cont))
855   (shr-ensure-paragraph))
856
857 (defun shr-tag-ul (cont)
858   (shr-ensure-paragraph)
859   (let ((shr-list-mode 'ul))
860     (shr-generic cont))
861   (shr-ensure-paragraph))
862
863 (defun shr-tag-ol (cont)
864   (shr-ensure-paragraph)
865   (let ((shr-list-mode 1))
866     (shr-generic cont))
867   (shr-ensure-paragraph))
868
869 (defun shr-tag-li (cont)
870   (shr-ensure-paragraph)
871   (shr-indent)
872   (let* ((bullet
873           (if (numberp shr-list-mode)
874               (prog1
875                   (format "%d " shr-list-mode)
876                 (setq shr-list-mode (1+ shr-list-mode)))
877             "* "))
878          (shr-indentation (+ shr-indentation (length bullet))))
879     (insert bullet)
880     (shr-generic cont)))
881
882 (defun shr-tag-br (cont)
883   (unless (bobp)
884     (insert "\n")
885     (shr-indent))
886   (shr-generic cont))
887
888 (defun shr-tag-h1 (cont)
889   (shr-heading cont 'bold 'underline))
890
891 (defun shr-tag-h2 (cont)
892   (shr-heading cont 'bold))
893
894 (defun shr-tag-h3 (cont)
895   (shr-heading cont 'italic))
896
897 (defun shr-tag-h4 (cont)
898   (shr-heading cont))
899
900 (defun shr-tag-h5 (cont)
901   (shr-heading cont))
902
903 (defun shr-tag-h6 (cont)
904   (shr-heading cont))
905
906 (defun shr-tag-hr (cont)
907   (shr-ensure-newline)
908   (insert (make-string shr-width shr-hr-line) "\n"))
909
910 (defun shr-tag-title (cont)
911   (shr-heading cont 'bold 'underline))
912
913 (defun shr-tag-font (cont)
914   (let* ((start (point))
915          (color (cdr (assq :color cont)))
916          (shr-stylesheet (nconc (list (cons 'color color))
917                                 shr-stylesheet)))
918     (shr-generic cont)
919     (when color
920       (shr-colorize-region start (point) color
921                            (cdr (assq 'background-color shr-stylesheet))))))
922
923 ;;; Table rendering algorithm.
924
925 ;; Table rendering is the only complicated thing here.  We do this by
926 ;; first counting how many TDs there are in each TR, and registering
927 ;; how wide they think they should be ("width=45%", etc).  Then we
928 ;; render each TD separately (this is done in temporary buffers, so
929 ;; that we can use all the rendering machinery as if we were in the
930 ;; main buffer).  Now we know how much space each TD really takes, so
931 ;; we then render everything again with the new widths, and finally
932 ;; insert all these boxes into the main buffer.
933 (defun shr-tag-table-1 (cont)
934   (setq cont (or (cdr (assq 'tbody cont))
935                  cont))
936   (let* ((shr-inhibit-images t)
937          (shr-table-depth (1+ shr-table-depth))
938          (shr-kinsoku-shorten t)
939          ;; Find all suggested widths.
940          (columns (shr-column-specs cont))
941          ;; Compute how many characters wide each TD should be.
942          (suggested-widths (shr-pro-rate-columns columns))
943          ;; Do a "test rendering" to see how big each TD is (this can
944          ;; be smaller (if there's little text) or bigger (if there's
945          ;; unbreakable text).
946          (sketch (shr-make-table cont suggested-widths))
947          (sketch-widths (shr-table-widths sketch suggested-widths)))
948     ;; This probably won't work very well.
949     (when (> (+ (loop for width across sketch-widths
950                       summing (1+ width))
951                 shr-indentation 1)
952              (frame-width))
953       (setq truncate-lines t))
954     ;; Then render the table again with these new "hard" widths.
955     (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths))
956   ;; Finally, insert all the images after the table.  The Emacs buffer
957   ;; model isn't strong enough to allow us to put the images actually
958   ;; into the tables.
959   (when (zerop shr-table-depth)
960     (dolist (elem (shr-find-elements cont 'img))
961       (shr-tag-img (cdr elem)))))
962
963 (defun shr-tag-table (cont)
964   (shr-ensure-paragraph)
965   (let* ((caption (cdr (assq 'caption cont)))
966          (header (cdr (assq 'thead cont)))
967          (body (or (cdr (assq 'tbody cont)) cont))
968          (footer (cdr (assq 'tfoot cont)))
969          (bgcolor (cdr (assq :bgcolor cont)))
970          (start (point))
971          (shr-stylesheet (nconc (list (cons 'background-color bgcolor))
972                                 shr-stylesheet))
973          (nheader (if header (shr-max-columns header)))
974          (nbody (if body (shr-max-columns body)))
975          (nfooter (if footer (shr-max-columns footer))))
976     (shr-tag-table-1
977      (nconc
978       (if caption `((tr (td ,@caption))))
979       (if header
980           (if footer
981               ;; hader + body + footer
982               (if (= nheader nbody)
983                   (if (= nbody nfooter)
984                       `((tr (td (table (tbody ,@header ,@body ,@footer)))))
985                     (nconc `((tr (td (table (tbody ,@header ,@body)))))
986                            (if (= nfooter 1)
987                                footer
988                              `((tr (td (table (tbody ,@footer))))))))
989                 (nconc `((tr (td (table (tbody ,@header)))))
990                        (if (= nbody nfooter)
991                            `((tr (td (table (tbody ,@body ,@footer)))))
992                          (nconc `((tr (td (table (tbody ,@body)))))
993                                 (if (= nfooter 1)
994                                     footer
995                                   `((tr (td (table (tbody ,@footer))))))))))
996             ;; header + body
997             (if (= nheader nbody)
998                 `((tr (td (table (tbody ,@header ,@body)))))
999               (if (= nheader 1)
1000                   `(,@header (tr (td (table (tbody ,@body)))))
1001                 `((tr (td (table (tbody ,@header))))
1002                   (tr (td (table (tbody ,@body))))))))
1003         (if footer
1004             ;; body + footer
1005             (if (= nbody nfooter)
1006                 `((tr (td (table (tbody ,@body ,@footer)))))
1007               (nconc `((tr (td (table (tbody ,@body)))))
1008                      (if (= nfooter 1)
1009                          footer
1010                        `((tr (td (table (tbody ,@footer))))))))
1011           (if caption
1012               `((tr (td (table (tbody ,@body)))))
1013             body)))))
1014     (when bgcolor
1015       (shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
1016                            bgcolor))))
1017
1018 (defun shr-find-elements (cont type)
1019   (let (result)
1020     (dolist (elem cont)
1021       (cond ((eq (car elem) type)
1022              (push elem result))
1023             ((consp (cdr elem))
1024              (setq result (nconc (shr-find-elements (cdr elem) type) result)))))
1025     (nreverse result)))
1026
1027 (defun shr-insert-table (table widths)
1028   (shr-insert-table-ruler widths)
1029   (dolist (row table)
1030     (let ((start (point))
1031           (height (let ((max 0))
1032                     (dolist (column row)
1033                       (setq max (max max (cadr column))))
1034                     max)))
1035       (dotimes (i height)
1036         (shr-indent)
1037         (insert shr-table-vertical-line "\n"))
1038       (dolist (column row)
1039         (goto-char start)
1040         (let ((lines (nth 2 column))
1041               (overlay-lines (nth 3 column))
1042               overlay overlay-line)
1043           (dolist (line lines)
1044             (setq overlay-line (pop overlay-lines))
1045             (end-of-line)
1046             (insert line shr-table-vertical-line)
1047             (dolist (overlay overlay-line)
1048               (let ((o (make-overlay (- (point) (nth 0 overlay) 1)
1049                                      (- (point) (nth 1 overlay) 1)))
1050                     (properties (nth 2 overlay)))
1051                 (while properties
1052                   (overlay-put o (pop properties) (pop properties)))))
1053             (forward-line 1))
1054           ;; Add blank lines at padding at the bottom of the TD,
1055           ;; possibly.
1056           (dotimes (i (- height (length lines)))
1057             (end-of-line)
1058             (insert (make-string (string-width (car lines)) ? )
1059                     shr-table-vertical-line)
1060             (forward-line 1)))))
1061     (shr-insert-table-ruler widths)))
1062
1063 (defun shr-insert-table-ruler (widths)
1064   (when (and (bolp)
1065              (> shr-indentation 0))
1066     (shr-indent))
1067   (insert shr-table-corner)
1068   (dotimes (i (length widths))
1069     (insert (make-string (aref widths i) shr-table-horizontal-line)
1070             shr-table-corner))
1071   (insert "\n"))
1072
1073 (defun shr-table-widths (table suggested-widths)
1074   (let* ((length (length suggested-widths))
1075          (widths (make-vector length 0))
1076          (natural-widths (make-vector length 0)))
1077     (dolist (row table)
1078       (let ((i 0))
1079         (dolist (column row)
1080           (aset widths i (max (aref widths i)
1081                               (car column)))
1082           (aset natural-widths i (max (aref natural-widths i)
1083                                       (cadr column)))
1084           (setq i (1+ i)))))
1085     (let ((extra (- (apply '+ (append suggested-widths nil))
1086                     (apply '+ (append widths nil))))
1087           (expanded-columns 0))
1088       (when (> extra 0)
1089         (dotimes (i length)
1090           ;; If the natural width is wider than the rendered width, we
1091           ;; want to allow the column to expand.
1092           (when (> (aref natural-widths i) (aref widths i))
1093             (setq expanded-columns (1+ expanded-columns))))
1094         (dotimes (i length)
1095           (when (> (aref natural-widths i) (aref widths i))
1096             (aset widths i (min
1097                             (1+ (aref natural-widths i))
1098                             (+ (/ extra expanded-columns)
1099                                (aref widths i))))))))
1100     widths))
1101
1102 (defun shr-make-table (cont widths &optional fill)
1103   (let ((trs nil))
1104     (dolist (row cont)
1105       (when (eq (car row) 'tr)
1106         (let ((tds nil)
1107               (columns (cdr row))
1108               (i 0)
1109               column)
1110           (while (< i (length widths))
1111             (setq column (pop columns))
1112             (when (or (memq (car column) '(td th))
1113                       (null column))
1114               (push (shr-render-td (cdr column) (aref widths i) fill)
1115                     tds)
1116               (setq i (1+ i))))
1117           (push (nreverse tds) trs))))
1118     (nreverse trs)))
1119
1120 (defun shr-render-td (cont width fill)
1121   (with-temp-buffer
1122     (let ((bgcolor (cdr (assq :bgcolor cont)))
1123           (fgcolor (cdr (assq :fgcolor cont)))
1124           (style (cdr (assq :style cont)))
1125           (shr-stylesheet shr-stylesheet)
1126           overlays)
1127       (when style
1128         (setq style (and (string-match "color" style)
1129                          (shr-parse-style style))))
1130       (when bgcolor
1131         (setq style (nconc (list (cons 'background-color bgcolor)) style)))
1132       (when fgcolor
1133         (setq style (nconc (list (cons 'color fgcolor)) style)))
1134       (when style
1135         (setq shr-stylesheet (append style shr-stylesheet)))
1136       (let ((cache (cdr (assoc (cons width cont) shr-content-cache))))
1137         (if cache
1138             (progn
1139               (insert (car cache))
1140               (let ((end (length (car cache))))
1141                 (dolist (overlay (cadr cache))
1142                   (let ((new-overlay
1143                          (make-overlay (1+ (- end (nth 0 overlay)))
1144                                        (1+ (- end (nth 1 overlay)))))
1145                         (properties (nth 2 overlay)))
1146                     (while properties
1147                       (overlay-put new-overlay
1148                                    (pop properties) (pop properties)))))))
1149           (let ((shr-width width)
1150                 (shr-indentation 0))
1151             (shr-descend (cons 'td cont)))
1152           (delete-region
1153            (point)
1154            (+ (point)
1155               (skip-chars-backward " \t\n")))
1156           (push (list (cons width cont) (buffer-string)
1157                       (shr-overlays-in-region (point-min) (point-max)))
1158                 shr-content-cache)))
1159       (goto-char (point-min))
1160       (let ((max 0))
1161         (while (not (eobp))
1162           (end-of-line)
1163           (setq max (max max (current-column)))
1164           (forward-line 1))
1165         (when fill
1166           (goto-char (point-min))
1167           ;; If the buffer is totally empty, then put a single blank
1168           ;; line here.
1169           (if (zerop (buffer-size))
1170               (insert (make-string width ? ))
1171             ;; Otherwise, fill the buffer.
1172             (while (not (eobp))
1173               (end-of-line)
1174               (when (> (- width (current-column)) 0)
1175                 (insert (make-string (- width (current-column)) ? )))
1176               (forward-line 1))))
1177         (when style
1178           (shr-colorize-region
1179            (point-min) (point-max)
1180            (cdr (assq 'color shr-stylesheet))
1181            (cdr (assq 'background-color shr-stylesheet))))
1182         (if fill
1183             (list max
1184                   (count-lines (point-min) (point-max))
1185                   (split-string (buffer-string) "\n")
1186                   (shr-collect-overlays))
1187           (list max
1188                 (shr-natural-width)))))))
1189
1190 (defun shr-natural-width ()
1191   (goto-char (point-min))
1192   (let ((current 0)
1193         (max 0))
1194     (while (not (eobp))
1195       (end-of-line)
1196       (setq current (+ current (current-column)))
1197       (unless (get-text-property (point) 'shr-break)
1198         (setq max (max max current)
1199               current 0))
1200       (forward-line 1))
1201     max))
1202
1203 (defun shr-collect-overlays ()
1204   (save-excursion
1205     (goto-char (point-min))
1206     (let ((overlays nil))
1207       (while (not (eobp))
1208         (push (shr-overlays-in-region (point) (line-end-position))
1209               overlays)
1210         (forward-line 1))
1211       (nreverse overlays))))
1212
1213 (defun shr-overlays-in-region (start end)
1214   (let (result)
1215     (dolist (overlay (overlays-in start end))
1216       (push (list (if (> start (overlay-start overlay))
1217                       (- end start)
1218                     (- end (overlay-start overlay)))
1219                   (if (< end (overlay-end overlay))
1220                       0
1221                     (- end (overlay-end overlay)))
1222                   (overlay-properties overlay))
1223             result))
1224     (nreverse result)))
1225
1226 (defun shr-pro-rate-columns (columns)
1227   (let ((total-percentage 0)
1228         (widths (make-vector (length columns) 0)))
1229     (dotimes (i (length columns))
1230       (setq total-percentage (+ total-percentage (aref columns i))))
1231     (setq total-percentage (/ 1.0 total-percentage))
1232     (dotimes (i (length columns))
1233       (aset widths i (max (truncate (* (aref columns i)
1234                                        total-percentage
1235                                        (- shr-width (1+ (length columns)))))
1236                           10)))
1237     widths))
1238
1239 ;; Return a summary of the number and shape of the TDs in the table.
1240 (defun shr-column-specs (cont)
1241   (let ((columns (make-vector (shr-max-columns cont) 1)))
1242     (dolist (row cont)
1243       (when (eq (car row) 'tr)
1244         (let ((i 0))
1245           (dolist (column (cdr row))
1246             (when (memq (car column) '(td th))
1247               (let ((width (cdr (assq :width (cdr column)))))
1248                 (when (and width
1249                            (string-match "\\([0-9]+\\)%" width))
1250                   (aset columns i
1251                         (/ (string-to-number (match-string 1 width))
1252                            100.0))))
1253               (setq i (1+ i)))))))
1254     columns))
1255
1256 (defun shr-count (cont elem)
1257   (let ((i 0))
1258     (dolist (sub cont)
1259       (when (eq (car sub) elem)
1260         (setq i (1+ i))))
1261     i))
1262
1263 (defun shr-max-columns (cont)
1264   (let ((max 0))
1265     (dolist (row cont)
1266       (when (eq (car row) 'tr)
1267         (setq max (max max (+ (shr-count (cdr row) 'td)
1268                               (shr-count (cdr row) 'th))))))
1269     max))
1270
1271 (provide 'shr)
1272
1273 ;;; shr.el ends here