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