cgit.sxemacs.org Git - gnus/blob - lisp/shr.el

   1 ;;; shr.el --- Simple HTML Renderer
   2
   3 ;; Copyright (C) 2010 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 (defgroup shr nil
  34   "Simple HTML Renderer"
  35   :group 'mail)
  36
  37 (defcustom shr-max-image-proportion 0.9
  38   "How big pictures displayed are in relation to the window they're in.
  39 A value of 0.7 means that they are allowed to take up 70% of the
  40 width and height of the window.  If they are larger than this,
  41 and Emacs supports it, then the images will be rescaled down to
  42 fit these criteria."
  43   :version "24.1"
  44   :group 'shr
  45   :type 'float)
  46
  47 (defcustom shr-blocked-images nil
  48   "Images that have URLs matching this regexp will be blocked."
  49   :version "24.1"
  50   :group 'shr
  51   :type 'regexp)
  52
  53 (defvar shr-folding-mode nil)
  54 (defvar shr-state nil)
  55 (defvar shr-start nil)
  56 (defvar shr-indentation 0)
  57
  58 (defvar shr-width 70)
  59
  60 (defun shr-transform-dom (dom)
  61   (let ((result (list (pop dom))))
  62     (dolist (arg (pop dom))
  63       (push (cons (intern (concat ":" (symbol-name (car arg))) obarray)
  64                   (cdr arg))
  65             result))
  66     (dolist (sub dom)
  67       (if (stringp sub)
  68           (push (cons :text sub) result)
  69         (push (shr-transform-dom sub) result)))
  70     (nreverse result)))
  71
  72 ;;;###autoload
  73 (defun shr-insert-document (dom)
  74   (let ((shr-state nil)
  75         (shr-start nil))
  76     (shr-descend (shr-transform-dom dom))))
  77
  78 (defun shr-descend (dom)
  79   (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray)))
  80     (if (fboundp function)
  81         (funcall function (cdr dom))
  82       (shr-generic (cdr dom)))))
  83
  84 (defun shr-generic (cont)
  85   (dolist (sub cont)
  86     (cond
  87      ((eq (car sub) :text)
  88       (shr-insert (cdr sub)))
  89      ((listp (cdr sub))
  90       (shr-descend sub)))))
  91
  92 (defun shr-tag-p (cont)
  93   (unless (bobp)
  94     (shr-ensure-newline)
  95     (insert "\n"))
  96   (shr-generic cont)
  97   (insert "\n"))
  98
  99 (defun shr-tag-b (cont)
 100   (shr-fontize-cont cont 'bold))
 101
 102 (defun shr-tag-i (cont)
 103   (shr-fontize-cont cont 'italic))
 104
 105 (defun shr-tag-u (cont)
 106   (shr-fontize-cont cont 'underline))
 107
 108 (defun shr-s (cont)
 109   (shr-fontize-cont cont 'strikethru))
 110
 111 (defun shr-fontize-cont (cont type)
 112   (let (shr-start)
 113     (shr-generic cont)
 114     (shr-add-font (or shr-start (point)) (point) type)))
 115
 116 (defun shr-add-font (start end type)
 117   (let ((overlay (make-overlay start end)))
 118     (overlay-put overlay 'face type)))
 119
 120 (defun shr-tag-a (cont)
 121   (let ((url (cdr (assq :href cont)))
 122         shr-start)
 123     (shr-generic cont)
 124     (widget-convert-button
 125      'link shr-start (point)
 126      :action 'shr-browse-url
 127      :url url
 128      :keymap widget-keymap
 129      :help-echo url)))
 130
 131 (defun shr-browse-url (widget &rest stuff)
 132   (browse-url (widget-get widget :url)))
 133
 134 (defun shr-tag-img (cont)
 135   (when (and (plusp (current-column))
 136              (not (eq shr-state 'image)))
 137     (insert "\n"))
 138   (let ((start (point-marker)))
 139     (let ((alt (cdr (assq :alt cont)))
 140           (url (cdr (assq :src cont))))
 141       (when (zerop (length alt))
 142         (setq alt "[img]"))
 143       (cond
 144        ((and shr-blocked-images
 145              (string-match shr-blocked-images url))
 146         (insert alt))
 147        ((url-is-cached (browse-url-url-encode-chars url "[&)$ ]"))
 148         (shr-put-image (shr-get-image-data url) (point) alt))
 149        (t
 150         (insert alt)
 151         (url-retrieve url 'shr-image-fetched
 152                       (list (current-buffer) start (point-marker))
 153                       t)))
 154       (insert " ")
 155       (setq shr-state 'image))))
 156
 157 (defun shr-image-fetched (status buffer start end)
 158   (when (and (buffer-name buffer)
 159              (not (plist-get status :error)))
 160     (url-store-in-cache (current-buffer))
 161     (when (or (search-forward "\n\n" nil t)
 162               (search-forward "\r\n\r\n" nil t))
 163       (let ((data (buffer-substring (point) (point-max))))
 164         (with-current-buffer buffer
 165           (let ((alt (buffer-substring start end))
 166                 (inhibit-read-only t))
 167             (delete-region start end)
 168             (shr-put-image data start alt))))))
 169   (kill-buffer (current-buffer)))
 170
 171 (defun shr-put-image (data point alt)
 172   (if (not (display-graphic-p))
 173       (insert alt)
 174     (let ((image (ignore-errors
 175                    (shr-rescale-image data))))
 176       (when image
 177         (put-image image point alt)))))
 178
 179 (defun shr-rescale-image (data)
 180   (if (or (not (fboundp 'imagemagick-types))
 181           (not (get-buffer-window (current-buffer))))
 182       (create-image data nil t)
 183     (let* ((image (create-image data nil t))
 184            (size (image-size image t))
 185            (width (car size))
 186            (height (cdr size))
 187            (edges (window-inside-pixel-edges
 188                    (get-buffer-window (current-buffer))))
 189            (window-width (truncate (* shr-max-image-proportion
 190                                       (- (nth 2 edges) (nth 0 edges)))))
 191            (window-height (truncate (* shr-max-image-proportion
 192                                        (- (nth 3 edges) (nth 1 edges)))))
 193            scaled-image)
 194       (when (> height window-height)
 195         (setq image (or (create-image data 'imagemagick t
 196                                       :height window-height)
 197                         image))
 198         (setq size (image-size image t)))
 199       (when (> (car size) window-width)
 200         (setq image (or
 201                      (create-image data 'imagemagick t
 202                                    :width window-width)
 203                      image)))
 204       image)))
 205
 206 (defun shr-tag-pre (cont)
 207   (let ((shr-folding-mode nil))
 208     (shr-ensure-newline)
 209     (shr-generic cont)
 210     (shr-ensure-newline)))
 211
 212 (defun shr-tag-blockquote (cont)
 213   (let ((shr-indentation (+ shr-indentation 4)))
 214     (shr-tag-pre cont)))
 215
 216 (defun shr-ensure-newline ()
 217   (unless (zerop (current-column))
 218     (insert "\n")))
 219
 220 (defun shr-insert (text)
 221   (when (eq shr-state 'image)
 222     (insert "\n")
 223     (setq shr-state nil))
 224   (cond
 225    ((eq shr-folding-mode 'none)
 226     (insert t))
 227    (t
 228     (let (column)
 229       (dolist (elem (split-string text))
 230         (setq column (current-column))
 231         (when (plusp column)
 232           (if (> (+ column (length elem) 1) shr-width)
 233               (insert "\n")
 234             (insert " ")))
 235         (when (and (bolp)
 236                    (plusp shr-indentation))
 237           (insert (make-string shr-indentation ? )))
 238         ;; The shr-start is a special variable that is used to pass
 239         ;; upwards the first point in the buffer where the text really
 240         ;; starts.
 241         (unless shr-start
 242           (setq shr-start (point)))
 243         (insert elem))))))
 244
 245 (defun shr-get-image-data (url)
 246   "Get image data for URL.
 247 Return a string with image data."
 248   (with-temp-buffer
 249     (mm-disable-multibyte)
 250     (url-cache-extract (url-cache-create-filename url))
 251     (when (or (search-forward "\n\n" nil t)
 252               (search-forward "\r\n\r\n" nil t))
 253       (buffer-substring (point) (point-max)))))
 254
 255 (defvar shr-list-mode nil)
 256
 257 (defun shr-tag-ul (cont)
 258   (let ((shr-list-mode 'ul))
 259     (shr-generic cont)))
 260
 261 (defun shr-tag-ol (cont)
 262   (let ((shr-list-mode 1))
 263     (shr-generic cont)))
 264
 265 (defun shr-tag-li (cont)
 266   (shr-ensure-newline)
 267   (if (numberp shr-list-mode)
 268       (progn
 269         (insert (format "%d " shr-list-mode))
 270         (setq shr-list-mode (1+ shr-list-mode)))
 271     (insert "* "))
 272   (shr-generic cont))
 273
 274 (defun shr-tag-br (cont)
 275   (shr-ensure-newline)
 276   (shr-generic cont))
 277
 278 (provide 'shr)
 279
 280 ;;; shr.el ends here