cgit.sxemacs.org Git - gnus/blob - 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 (defvar shr-put-image-function 'shr-put-image
  91   "Function called to put image and alt string.")
  92
  93 (defface shr-strike-through '((t (:strike-through t)))
  94   "Font for <s> elements."
  95   :group 'shr)
  96
  97 (defface shr-link
  98   '((t (:inherit link)))
  99   "Font for link elements."
 100   :group 'shr)
 101
 102 ;;; Internal variables.
 103
 104 (defvar shr-folding-mode nil)
 105 (defvar shr-state nil)
 106 (defvar shr-start nil)
 107 (defvar shr-indentation 0)
 108 (defvar shr-inhibit-images nil)
 109 (defvar shr-list-mode nil)
 110 (defvar shr-content-cache nil)
 111 (defvar shr-kinsoku-shorten nil)
 112 (defvar shr-table-depth 0)
 113 (defvar shr-stylesheet nil)
 114 (defvar shr-base nil)
 115
 116 (defvar shr-map
 117   (let ((map (make-sparse-keymap)))
 118     (define-key map "a" 'shr-show-alt-text)
 119     (define-key map "i" 'shr-browse-image)
 120     (define-key map "I" 'shr-insert-image)
 121     (define-key map "u" 'shr-copy-url)
 122     (define-key map "v" 'shr-browse-url)
 123     (define-key map "o" 'shr-save-contents)
 124     (define-key map "\r" 'shr-browse-url)
 125     map))
 126
 127 ;; Public functions and commands.
 128
 129 (defun shr-visit-file (file)
 130   (interactive "fHTML file name: ")
 131   (pop-to-buffer "*html*")
 132   (erase-buffer)
 133   (shr-insert-document
 134    (with-temp-buffer
 135      (insert-file-contents file)
 136      (libxml-parse-html-region (point-min) (point-max)))))
 137
 138 ;;;###autoload
 139 (defun shr-insert-document (dom)
 140   (setq shr-content-cache nil)
 141   (let ((shr-state nil)
 142         (shr-start nil)
 143         (shr-base nil)
 144         (shr-width (or shr-width (window-width))))
 145     (shr-descend (shr-transform-dom dom))))
 146
 147 (defun shr-copy-url ()
 148   "Copy the URL under point to the kill ring.
 149 If called twice, then try to fetch the URL and see whether it
 150 redirects somewhere else."
 151   (interactive)
 152   (let ((url (get-text-property (point) 'shr-url)))
 153     (cond
 154      ((not url)
 155       (message "No URL under point"))
 156      ;; Resolve redirected URLs.
 157      ((equal url (car kill-ring))
 158       (url-retrieve
 159        url
 160        (lambda (a)
 161          (when (and (consp a)
 162                     (eq (car a) :redirect))
 163            (with-temp-buffer
 164              (insert (cadr a))
 165              (goto-char (point-min))
 166              ;; Remove common tracking junk from the URL.
 167              (when (re-search-forward ".utm_.*" nil t)
 168                (replace-match "" t t))
 169              (message "Copied %s" (buffer-string))
 170              (copy-region-as-kill (point-min) (point-max)))))))
 171      ;; Copy the URL to the kill ring.
 172      (t
 173       (with-temp-buffer
 174         (insert url)
 175         (copy-region-as-kill (point-min) (point-max))
 176         (message "Copied %s" url))))))
 177
 178 (defun shr-show-alt-text ()
 179   "Show the ALT text of the image under point."
 180   (interactive)
 181   (let ((text (get-text-property (point) 'shr-alt)))
 182     (if (not text)
 183         (message "No image under point")
 184       (message "%s" text))))
 185
 186 (defun shr-browse-image (&optional copy-url)
 187   "Browse the image under point.
 188 If COPY-URL (the prefix if called interactively) is non-nil, copy
 189 the URL of the image to the kill buffer instead."
 190   (interactive "P")
 191   (let ((url (get-text-property (point) 'image-url)))
 192     (cond
 193      ((not url)
 194       (message "No image under point"))
 195      (copy-url
 196       (with-temp-buffer
 197         (insert url)
 198         (copy-region-as-kill (point-min) (point-max))
 199         (message "Copied %s" url)))
 200      (t
 201       (message "Browsing %s..." url)
 202       (browse-url url)))))
 203
 204 (defun shr-insert-image ()
 205   "Insert the image under point into the buffer."
 206   (interactive)
 207   (let ((url (get-text-property (point) 'image-url)))
 208     (if (not url)
 209         (message "No image under point")
 210       (message "Inserting %s..." url)
 211       (url-retrieve url 'shr-image-fetched
 212                     (list (current-buffer) (1- (point)) (point-marker))
 213                     t))))
 214
 215 ;;; Utility functions.
 216
 217 (defun shr-transform-dom (dom)
 218   (let ((result (list (pop dom))))
 219     (dolist (arg (pop dom))
 220       (push (cons (intern (concat ":" (symbol-name (car arg))) obarray)
 221                   (cdr arg))
 222             result))
 223     (dolist (sub dom)
 224       (if (stringp sub)
 225           (push (cons 'text sub) result)
 226         (push (shr-transform-dom sub) result)))
 227     (nreverse result)))
 228
 229 (defun shr-descend (dom)
 230   (let ((function (intern (concat "shr-tag-" (symbol-name (car dom))) obarray))
 231         (style (cdr (assq :style (cdr dom))))
 232         (shr-stylesheet shr-stylesheet)
 233         (start (point)))
 234     (when style
 235       (if (string-match "color" style)
 236           (setq shr-stylesheet (nconc (shr-parse-style style)
 237                                       shr-stylesheet))
 238         (setq style nil)))
 239     (if (fboundp function)
 240         (funcall function (cdr dom))
 241       (shr-generic (cdr dom)))
 242     ;; If style is set, then this node has set the color.
 243     (when style
 244       (shr-colorize-region start (point)
 245                            (cdr (assq 'color shr-stylesheet))
 246                            (cdr (assq 'background-color shr-stylesheet))))))
 247
 248 (defun shr-generic (cont)
 249   (dolist (sub cont)
 250     (cond
 251      ((eq (car sub) 'text)
 252       (shr-insert (cdr sub)))
 253      ((listp (cdr sub))
 254       (shr-descend sub)))))
 255
 256 (defmacro shr-char-breakable-p (char)
 257   "Return non-nil if a line can be broken before and after CHAR."
 258   `(aref fill-find-break-point-function-table ,char))
 259 (defmacro shr-char-nospace-p (char)
 260   "Return non-nil if no space is required before and after CHAR."
 261   `(aref fill-nospace-between-words-table ,char))
 262
 263 ;; KINSOKU is a Japanese word meaning a rule that should not be violated.
 264 ;; In Emacs, it is a term used for characters, e.g. punctuation marks,
 265 ;; parentheses, and so on, that should not be placed in the beginning
 266 ;; of a line or the end of a line.
 267 (defmacro shr-char-kinsoku-bol-p (char)
 268   "Return non-nil if a line ought not to begin with CHAR."
 269   `(aref (char-category-set ,char) ?>))
 270 (defmacro shr-char-kinsoku-eol-p (char)
 271   "Return non-nil if a line ought not to end with CHAR."
 272   `(aref (char-category-set ,char) ?<))
 273 (unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
 274   (load "kinsoku" nil t))
 275
 276 (defun shr-insert (text)
 277   (when (and (eq shr-state 'image)
 278              (not (string-match "\\`[ \t\n]+\\'" text)))
 279     (insert "\n")
 280     (setq shr-state nil))
 281   (cond
 282    ((eq shr-folding-mode 'none)
 283     (insert text))
 284    (t
 285     (when (and (string-match "\\`[ \t\n]" text)
 286                (not (bolp))
 287                (not (eq (char-after (1- (point))) ? )))
 288       (insert " "))
 289     (dolist (elem (split-string text))
 290       (when (and (bolp)
 291                  (> shr-indentation 0))
 292         (shr-indent))
 293       ;; No space is needed behind a wide character categorized as
 294       ;; kinsoku-bol, between characters both categorized as nospace,
 295       ;; or at the beginning of a line.
 296       (let (prev)
 297         (when (and (> (current-column) shr-indentation)
 298                    (eq (preceding-char) ? )
 299                    (or (= (line-beginning-position) (1- (point)))
 300                        (and (shr-char-breakable-p
 301                              (setq prev (char-after (- (point) 2))))
 302                             (shr-char-kinsoku-bol-p prev))
 303                        (and (shr-char-nospace-p prev)
 304                             (shr-char-nospace-p (aref elem 0)))))
 305           (delete-char -1)))
 306       ;; The shr-start is a special variable that is used to pass
 307       ;; upwards the first point in the buffer where the text really
 308       ;; starts.
 309       (unless shr-start
 310         (setq shr-start (point)))
 311       (insert elem)
 312       (let (found)
 313         (while (and (> (current-column) shr-width)
 314                     (progn
 315                       (setq found (shr-find-fill-point))
 316                       (not (eolp))))
 317           (when (eq (preceding-char) ? )
 318             (delete-char -1))
 319           (insert "\n")
 320           (unless found
 321             (put-text-property (1- (point)) (point) 'shr-break t)
 322             ;; No space is needed at the beginning of a line.
 323             (when (eq (following-char) ? )
 324               (delete-char 1)))
 325           (when (> shr-indentation 0)
 326             (shr-indent))
 327           (end-of-line))
 328         (insert " ")))
 329     (unless (string-match "[ \t\n]\\'" text)
 330       (delete-char -1)))))
 331
 332 (defun shr-find-fill-point ()
 333   (when (> (move-to-column shr-width) shr-width)
 334     (backward-char 1))
 335   (let ((bp (point))
 336         failed)
 337     (while (not (or (setq failed (= (current-column) shr-indentation))
 338                     (eq (preceding-char) ? )
 339                     (eq (following-char) ? )
 340                     (shr-char-breakable-p (preceding-char))
 341                     (shr-char-breakable-p (following-char))
 342                     (if (eq (preceding-char) ?')
 343                         (not (memq (char-after (- (point) 2))
 344                                    (list nil ?\n ? )))
 345                       (and (shr-char-kinsoku-bol-p (preceding-char))
 346                            (shr-char-breakable-p (following-char))
 347                            (not (shr-char-kinsoku-bol-p (following-char)))))
 348                     (shr-char-kinsoku-eol-p (following-char))))
 349       (backward-char 1))
 350     (if (and (not (or failed (eolp)))
 351              (eq (preceding-char) ?'))
 352         (while (not (or (setq failed (eolp))
 353                         (eq (following-char) ? )
 354                         (shr-char-breakable-p (following-char))
 355                         (shr-char-kinsoku-eol-p (following-char))))
 356           (forward-char 1)))
 357     (if failed
 358         ;; There's no breakable point, so we give it up.
 359         (let (found)
 360           (goto-char bp)
 361           (unless shr-kinsoku-shorten
 362             (while (and (setq found (re-search-forward
 363                                      "\\(\\c>\\)\\| \\|\\c<\\|\\c|"
 364                                      (line-end-position) 'move))
 365                         (eq (preceding-char) ?')))
 366             (if (and found (not (match-beginning 1)))
 367                 (goto-char (match-beginning 0)))))
 368       (or
 369        (eolp)
 370        ;; Don't put kinsoku-bol characters at the beginning of a line,
 371        ;; or kinsoku-eol characters at the end of a line.
 372        (cond
 373         (shr-kinsoku-shorten
 374          (while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
 375                      (shr-char-kinsoku-eol-p (preceding-char)))
 376            (backward-char 1))
 377          (when (setq failed (= (current-column) shr-indentation))
 378            ;; There's no breakable point that doesn't violate kinsoku,
 379            ;; so we look for the second best position.
 380            (while (and (progn
 381                          (forward-char 1)
 382                          (<= (current-column) shr-width))
 383                        (progn
 384                          (setq bp (point))
 385                          (shr-char-kinsoku-eol-p (following-char)))))
 386            (goto-char bp)))
 387         ((shr-char-kinsoku-eol-p (preceding-char))
 388          (if (shr-char-kinsoku-eol-p (following-char))
 389              ;; There are consecutive kinsoku-eol characters.