-;;; gnus-html.el --- Quoted-Printable functions
+;;; gnus-html.el --- Render HTML in a buffer.
;; Copyright (C) 2010 Free Software Foundation, Inc.
;;; Code:
+(eval-when-compile (require 'cl))
+(eval-when-compile (require 'mm-decode))
+
+(require 'gnus-art)
(require 'mm-url)
+(require 'url)
+(require 'url-cache)
+(require 'xml)
+(require 'browse-url)
+(require 'help-fns)
-(defcustom gnus-html-cache-directory (nnheader-concat gnus-directory "html-cache/")
- "Where Gnus will cache images it downloads from the web."
+(defcustom gnus-html-image-cache-ttl (days-to-time 7)
+ "Time used to determine if we should use images from the cache."
+ :version "24.1"
:group 'gnus-art
- :type 'directory)
+ :type 'integer)
-(defcustom gnus-html-cache-size 500000000
- "The size of the Gnus image cache."
+(defcustom gnus-html-image-automatic-caching t
+ "Whether automatically cache retrieve images."
+ :version "24.1"
:group 'gnus-art
- :type 'integer)
+ :type 'boolean)
(defcustom gnus-html-frame-width 70
"What width to use when rendering HTML."
+ :version "24.1"
:group 'gnus-art
:type 'integer)
+(defcustom gnus-blocked-images "."
+ "Images that have URLs matching this regexp will be blocked."
+ :version "24.1"
+ :group 'gnus-art
+ :type 'regexp)
+
+(defcustom gnus-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 'gnus-art
+ :type 'float)
+
+(defvar gnus-html-image-map
+ (let ((map (make-sparse-keymap)))
+ (define-key map "u" 'gnus-article-copy-string)
+ (define-key map "i" 'gnus-html-insert-image)
+ (define-key map "v" 'gnus-html-browse-url)
+ map))
+
+(defvar gnus-html-displayed-image-map
+ (let ((map (make-sparse-keymap)))
+ (define-key map "a" 'gnus-html-show-alt-text)
+ (define-key map "i" 'gnus-html-browse-image)
+ (define-key map "\r" 'gnus-html-browse-url)
+ (define-key map "u" 'gnus-article-copy-string)
+ (define-key map [tab] 'widget-forward)
+ map))
+
+(eval-and-compile
+ (defalias 'gnus-html-encode-url-chars
+ (if (fboundp 'browse-url-url-encode-chars)
+ 'browse-url-url-encode-chars
+ (lambda (text chars)
+ "URL-encode the chars in TEXT that match CHARS.
+CHARS is a regexp-like character alternative (e.g., \"[)$]\")."
+ (let ((encoded-text (copy-sequence text))
+ (s 0))
+ (while (setq s (string-match chars encoded-text s))
+ (setq encoded-text
+ (replace-match (format "%%%x"
+ (string-to-char
+ (match-string 0 encoded-text)))
+ t t encoded-text)
+ s (1+ s)))
+ encoded-text))))
+ ;; XEmacs does not have window-inside-pixel-edges
+ (defalias 'gnus-window-inside-pixel-edges
+ (if (fboundp 'window-inside-pixel-edges)
+ 'window-inside-pixel-edges
+ 'window-pixel-edges)))
+
+(defun gnus-html-encode-url (url)
+ "Encode URL."
+ (gnus-html-encode-url-chars url "[)$ ]"))
+
+(defun gnus-html-cache-expired (url ttl)
+ "Check if URL is cached for more than TTL."
+ (cond (url-standalone-mode
+ (not (file-exists-p (url-cache-create-filename url))))
+ (t (let ((cache-time (url-is-cached url)))
+ (if cache-time
+ (time-less-p
+ (time-add
+ cache-time
+ ttl)
+ (current-time))
+ t)))))
+
;;;###autoload
-(defun gnus-article-html (handle)
+(defun gnus-article-html (&optional handle)
(let ((article-buffer (current-buffer)))
+ (unless handle
+ (setq handle (mm-dissect-buffer t)))
(save-restriction
(narrow-to-region (point) (point))
(save-excursion
(let* ((coding-system-for-read 'utf-8)
(coding-system-for-write 'utf-8)
(default-process-coding-system
- (cons coding-system-for-read coding-system-for-write)))
+ (cons coding-system-for-read coding-system-for-write))
+ (charset (mail-content-type-get (mm-handle-type handle)
+ 'charset)))
+ (when (and charset
+ (setq charset (mm-charset-to-coding-system charset))
+ (not (eq charset 'ascii)))
+ (insert (prog1
+ (mm-decode-coding-string (buffer-string) charset)
+ (erase-buffer)
+ (mm-enable-multibyte))))
(call-process-region (point-min) (point-max)
- "w3m"
+ "w3m"
nil article-buffer nil
"-halfdump"
"-no-cookie"
"-I" "UTF-8"
"-O" "UTF-8"
"-o" "ext_halfdump=1"
+ "-o" "display_ins_del=2"
"-o" "pre_conv=1"
"-t" (format "%s" tab-width)
"-cols" (format "%s" gnus-html-frame-width)
- "-o" "display_image=off"
+ "-o" "display_image=on"
"-T" "text/html"))))
(gnus-html-wash-tags))))
+(defvar gnus-article-mouse-face)
+
+(defun gnus-html-pre-wash ()
+ (goto-char (point-min))
+ (while (re-search-forward " *<pre_int> *</pre_int> *\n" nil t)
+ (replace-match "" t t))
+ (goto-char (point-min))
+ (while (re-search-forward "<a name[^\n>]+>" nil t)
+ (replace-match "" t t)))
+
+(defun gnus-html-wash-images ()
+ "Run through current buffer and replace img tags by images."
+ (let (tag parameters string start end images url)
+ (goto-char (point-min))
+ ;; Search for all the images first.
+ (while (re-search-forward "<img_alt \\([^>]*\\)>" nil t)
+ (setq parameters (match-string 1)
+ start (match-beginning 0))
+ (delete-region start (point))
+ (when (search-forward "</img_alt>" (line-end-position) t)
+ (delete-region (match-beginning 0) (match-end 0)))
+ (setq end (point))
+ (when (string-match "src=\"\\([^\"]+\\)" parameters)
+ (setq url (gnus-html-encode-url (match-string 1 parameters)))
+ (gnus-message 8 "gnus-html-wash-tags: fetching image URL %s" url)
+ (if (string-match "^cid:\\(.*\\)" url)
+ ;; URLs with cid: have their content stashed in other
+ ;; parts of the MIME structure, so just insert them
+ ;; immediately.
+ (let ((handle (mm-get-content-id
+ (setq url (match-string 1 url))))
+ image)
+ (when handle
+ (mm-with-part handle
+ (setq image (gnus-create-image (buffer-string)
+ nil t))))
+ (when image
+ (let ((string (buffer-substring start end)))
+ (delete-region start end)
+ (gnus-put-image image (gnus-string-or string "*") 'cid)
+ (gnus-add-image 'cid image))))
+ ;; Normal, external URL.
+ (let ((alt-text (when (string-match "\\(alt\\|title\\)=\"\\([^\"]+\\)"
+ parameters)
+ (xml-substitute-special (match-string 2 parameters)))))
+ (gnus-put-text-property start end 'gnus-image-url url)
+ (if (gnus-html-image-url-blocked-p
+ url
+ (if (buffer-live-p gnus-summary-buffer)
+ (with-current-buffer gnus-summary-buffer
+ gnus-blocked-images)
+ gnus-blocked-images))
+ (progn
+ (widget-convert-button
+ 'link start end
+ :action 'gnus-html-insert-image
+ :help-echo url
+ :keymap gnus-html-image-map
+ :button-keymap gnus-html-image-map)
+ (let ((overlay (gnus-make-overlay start end))
+ (spec (list url start end alt-text)))
+ (gnus-overlay-put overlay 'local-map gnus-html-image-map)
+ (gnus-overlay-put overlay 'gnus-image spec)
+ (gnus-put-text-property
+ start end
+ 'gnus-image spec)))
+ ;; Non-blocked url
+ (let ((width
+ (when (string-match "width=\"?\\([0-9]+\\)" parameters)
+ (string-to-number (match-string 1 parameters))))
+ (height
+ (when (string-match "height=\"?\\([0-9]+\\)" parameters)
+ (string-to-number (match-string 1 parameters)))))
+ ;; Don't fetch images that are really small. They're
+ ;; probably tracking pictures.
+ (when (and (or (null height)
+ (> height 4))
+ (or (null width)
+ (> width 4)))
+ (gnus-html-display-image url start end alt-text))))))))))
+
+(defun gnus-html-display-image (url start end alt-text)
+ "Display image at URL on text from START to END.
+Use ALT-TEXT for the image string."
+ (if (gnus-html-cache-expired url gnus-html-image-cache-ttl)
+ ;; We don't have it, so schedule it for fetching
+ ;; asynchronously.
+ (gnus-html-schedule-image-fetching
+ (current-buffer)
+ (list url alt-text))
+ ;; It's already cached, so just insert it.
+ (gnus-html-put-image (gnus-html-get-image-data url) url alt-text)))
+
(defun gnus-html-wash-tags ()
(let (tag parameters string start end images url)
- (mm-url-decode-entities)
+ (gnus-html-pre-wash)
+ (gnus-html-wash-images)
+
(goto-char (point-min))
+ ;; Then do the other tags.
(while (re-search-forward "<\\([^ />]+\\)\\([^>]*\\)>" nil t)
(setq tag (match-string 1)
parameters (match-string 2)
(setq end (point))
(cond
;; Fetch and insert a picture.
- ((equal tag "img_alt")
- (when (string-match "src=\"\\([^\"]+\\)" parameters)
- (setq url (match-string 1 parameters))
- (when (or (null mm-w3m-safe-url-regexp)
- (string-match mm-w3m-safe-url-regexp url))
- (if (string-match "^cid:\\(.*\\)" url)
- ;; URLs with cid: have their content stashed in other
- ;; parts of the MIME structure, so just insert them
- ;; immediately.
- (let ((handle (mm-get-content-id
- (setq url (match-string 1 url))))
- image)
- (when handle
- (mm-with-part handle
- (setq image (gnus-create-image (buffer-string)
- nil t))))
- (when image
- (delete-region start end)
- (gnus-put-image image)))
- ;; Normal, external URL.
- (let ((file (gnus-html-image-id url)))
- (if (file-exists-p file)
- ;; It's already cached, so just insert it.
- (when (gnus-html-put-image file (point))
- ;; Delete the ALT text.
- (delete-region start end))
- ;; We don't have it, so schedule it for fetching
- ;; asynchronously.
- (push (list url
- (set-marker (make-marker) start)
- (point-marker))
- images)))))))
+ ((equal tag "img_alt"))
;; Add a link.
- ((equal tag "a")
+ ((or (equal tag "a")
+ (equal tag "A"))
(when (string-match "href=\"\\([^\"]+\\)" parameters)
(setq url (match-string 1 parameters))
+ (gnus-message 8 "gnus-html-wash-tags: fetching link URL %s" url)
(gnus-article-add-button start end
'browse-url url
url)
(let ((overlay (gnus-make-overlay start end)))
(gnus-overlay-put overlay 'evaporate t)
(gnus-overlay-put overlay 'gnus-button-url url)
+ (gnus-put-text-property start end 'gnus-string url)
(when gnus-article-mouse-face
(gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))))
+ ;; The upper-case IMG_ALT is apparently just an artifact that
+ ;; should be deleted.
+ ((equal tag "IMG_ALT")
+ (delete-region start end))
+ ;; w3m does not normalize the case
+ ((or (equal tag "b")
+ (equal tag "B"))
+ (gnus-overlay-put (gnus-make-overlay start end) 'face 'gnus-emphasis-bold))
+ ((or (equal tag "u")
+ (equal tag "U"))
+ (gnus-overlay-put (gnus-make-overlay start end) 'face 'gnus-emphasis-underline))
+ ((or (equal tag "i")
+ (equal tag "I"))
+ (gnus-overlay-put (gnus-make-overlay start end) 'face 'gnus-emphasis-italic))
+ ((or (equal tag "s")
+ (equal tag "S"))
+ (gnus-overlay-put (gnus-make-overlay start end) 'face 'gnus-emphasis-strikethru))
+ ((or (equal tag "ins")
+ (equal tag "INS"))
+ (gnus-overlay-put (gnus-make-overlay start end) 'face 'gnus-emphasis-underline))
+ ;; Handle different UL types
+ ((equal tag "_SYMBOL")
+ (when (string-match "TYPE=\\(.+\\)" parameters)
+ (let ((type (string-to-number (match-string 1 parameters))))
+ (delete-region start end)
+ (cond ((= type 33) (insert " "))
+ ((= type 34) (insert " "))
+ ((= type 35) (insert " "))
+ ((= type 36) (insert " "))
+ ((= type 37) (insert " "))
+ ((= type 38) (insert " "))
+ ((= type 39) (insert " "))
+ ((= type 40) (insert " "))
+ ((= type 42) (insert " "))
+ ((= type 43) (insert " "))
+ (t (insert " "))))))
;; Whatever. Just ignore the tag.
(t
))
(goto-char (point-min))
;; The output from -halfdump isn't totally regular, so strip
;; off any </pre_int>s that were left over.
- (while (re-search-forward "</pre_int>" nil t)
+ (while (re-search-forward "</pre_int>\\|</internal>" nil t)
(replace-match "" t t))
- (when images
- (gnus-html-schedule-image-fetching (current-buffer) (nreverse images)))))
-
-(defun gnus-html-schedule-image-fetching (buffer images)
- (let* ((url (caar images))
- (process (start-process
- "images" nil "curl"
- "-s" "--create-dirs"
- "--location"
- "--max-time" "60"
- "-o" (gnus-html-image-id url)
- url)))
- (process-kill-without-query process)
- (set-process-sentinel process 'gnus-html-curl-sentinel)
- (set-process-plist process (list 'images images
- 'buffer buffer))))
-
-(defun gnus-html-image-id (url)
- (expand-file-name (sha1 url) gnus-html-cache-directory))
-
-(defun gnus-html-curl-sentinel (process event)
- (when (string-match "finished" event)
- (let* ((images (getf (process-plist process) 'images))
- (buffer (getf (process-plist process) 'buffer))
- (spec (pop images))
- (file (gnus-html-image-id (car spec))))
- (when (and (buffer-live-p buffer)
- ;; If the position of the marker is 1, then that
- ;; means that the text is was in has been deleted;
- ;; i.e., that the user has selected a different
- ;; article before the image arrived.
- (not (= (marker-position (cadr spec)) 1)))
- (save-excursion
- (set-buffer buffer)
- (let ((buffer-read-only nil))
- (when (gnus-html-put-image file (cadr spec))
- (delete-region (1+ (cadr spec)) (caddr spec))))))
- (when images
- (gnus-html-schedule-image-fetching buffer images)))))
-
-(defun gnus-html-put-image (file point)
- (when (display-graphic-p)
- (let ((image (ignore-errors
- (gnus-create-image file))))
- (save-excursion
- (goto-char point)
- (if (and image
- ;; Kludge to avoid displaying 30x30 gif images, which
- ;; seems to be a signal of a broken image.
- (not (and (listp image)
- (eq (getf (cdr image) :type) 'gif)
- (= (car (image-size image t)) 30)
- (= (cdr (image-size image t)) 30))))
- (progn
- (gnus-put-image image)
- t)
- (when (fboundp 'find-image)
- (gnus-put-image (find-image
- '((:type xpm :file "lock-broken.xpm")))))
- nil)))))
-
-(defun gnus-html-prune-cache ()
- (let ((total-size 0)
- files)
- (dolist (file (directory-files gnus-html-cache-directory t nil t))
- (let ((attributes (file-attributes file)))
- (unless (nth 0 attributes)
- (incf total-size (nth 7 attributes))
- (push (list (time-to-seconds (nth 5 attributes))
- (nth 7 attributes) file)
- files))))
- (when (> total-size gnus-html-cache-size)
- (setq files (sort files (lambda (f1 f2)
- (< (car f1) (car f2)))))
- (dolist (file files)
- (when (> total-size gnus-html-cache-size)
- (decf total-size (cadr file))
- (delete-file (nth 2 file)))))))
+ (mm-url-decode-entities)))
+
+(defun gnus-html-insert-image ()
+ "Fetch and insert the image under point."
+ (interactive)
+ (apply 'gnus-html-display-image (get-text-property (point) 'gnus-image)))
+
+(defun gnus-html-show-alt-text ()
+ "Show the ALT text of the image under point."
+ (interactive)
+ (message "%s" (get-text-property (point) 'gnus-alt-text)))
+
+(defun gnus-html-browse-image ()
+ "Browse the image under point."
+ (interactive)
+ (browse-url (get-text-property (point) 'gnus-image-url)))
+
+(defun gnus-html-browse-url ()
+ "Browse the image under point."
+ (interactive)
+ (let ((url (get-text-property (point) 'gnus-string)))
+ (if (not url)
+ (message "No URL at point")
+ (browse-url url))))
+
+(defun gnus-html-schedule-image-fetching (buffer image)
+ "Retrieve IMAGE, and place it into BUFFER on arrival."
+ (gnus-message 8 "gnus-html-schedule-image-fetching: buffer %s, image %s"
+ buffer image)
+ (let ((args (list (car image)
+ 'gnus-html-image-fetched
+ (list buffer image))))
+ (when (> (length (help-function-arglist 'url-retrieve)) 4)
+ (setq args (nconc args (list t))))
+ (apply #'url-retrieve args)))
+
+(defun gnus-html-image-fetched (status buffer image)
+ "Callback function called when image has been fetched."
+ (unless (plist-get status :error)
+ (when gnus-html-image-automatic-caching
+ (url-store-in-cache (current-buffer)))
+ (when (and (or (search-forward "\n\n" nil t)
+ (search-forward "\r\n\r\n" nil t))
+ (buffer-live-p buffer))
+ (let ((data (buffer-substring (point) (point-max))))
+ (with-current-buffer buffer
+ (let ((inhibit-read-only t))
+ (gnus-html-put-image data (car image) (cadr image)))))))
+ (kill-buffer (current-buffer)))
+
+(defun gnus-html-get-image-data (url)
+ "Get image data for URL.
+Return a string with image data."
+ (with-temp-buffer
+ (mm-disable-multibyte)
+ (url-cache-extract (url-cache-create-filename url))
+ (when (or (search-forward "\n\n" nil t)
+ (search-forward "\r\n\r\n" nil t))
+ (buffer-substring (point) (point-max)))))
+
+(defun gnus-html-put-image (data url &optional alt-text)
+ (when (gnus-graphic-display-p)
+ (let* ((start (text-property-any (point-min) (point-max)
+ 'gnus-image-url url))
+ (end (when start
+ (next-single-property-change start 'gnus-image-url))))
+ ;; Image found?
+ (when start
+ (let* ((image
+ (ignore-errors
+ (gnus-create-image data nil t)))
+ (size (and image
+ (if (featurep 'xemacs)
+ (cons (glyph-width image) (glyph-height image))
+ (image-size image t)))))
+ (save-excursion
+ (goto-char start)
+ (let ((alt-text (or alt-text
+ (buffer-substring-no-properties start end))))
+ (if (and image
+ ;; Kludge to avoid displaying 30x30 gif images, which
+ ;; seems to be a signal of a broken image.
+ (not (and (if (featurep 'xemacs)
+ (glyphp image)
+ (listp image))
+ (eq (if (featurep 'xemacs)
+ (let ((d (cdadar
+ (specifier-spec-list
+ (glyph-image image)))))
+ (and (vectorp d)
+ (aref d 0)))
+ (plist-get (cdr image) :type))
+ 'gif)
+ (= (car size) 30)
+ (= (cdr size) 30))))
+ ;; Good image, add it!
+ (let ((image (gnus-html-rescale-image image data size)))
+ (delete-region start end)
+ (gnus-put-image image alt-text 'external)
+ (gnus-put-text-property start (point) 'help-echo alt-text)
+ (gnus-overlay-put
+ (gnus-make-overlay start (point)) 'local-map
+ gnus-html-displayed-image-map)
+ (gnus-put-text-property start (point)
+ 'gnus-alt-text alt-text)
+ (when url
+ (gnus-put-text-property start (point)
+ 'gnus-image-url url))
+ (gnus-add-image 'external image)
+ t)
+ ;; Bad image, try to show something else
+ (when (fboundp 'find-image)
+ (delete-region start end)
+ (setq image (find-image
+ '((:type xpm :file "lock-broken.xpm"))))
+ (gnus-put-image image alt-text 'internal)
+ (gnus-add-image 'internal image))
+ nil))))))))
+
+(defun gnus-html-rescale-image (image data size)
+ (if (or (not (fboundp 'imagemagick-types))
+ (not (get-buffer-window (current-buffer))))
+ image
+ (let* ((width (car size))
+ (height (cdr size))
+ (edges (gnus-window-inside-pixel-edges
+ (get-buffer-window (current-buffer))))
+ (window-width (truncate (* gnus-max-image-proportion
+ (- (nth 2 edges) (nth 0 edges)))))
+ (window-height (truncate (* gnus-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)))
+
+(defun gnus-html-image-url-blocked-p (url blocked-images)
+ "Find out if URL is blocked by BLOCKED-IMAGES."
+ (let ((ret (and blocked-images
+ (string-match blocked-images url))))
+ (if ret
+ (gnus-message 8 "gnus-html-image-url-blocked-p: %s blocked by regex %s"
+ url blocked-images)
+ (gnus-message 9 "gnus-html-image-url-blocked-p: %s passes regex %s"
+ url blocked-images))
+ ret))
+
+(defun gnus-html-show-images ()
+ "Show any images that are in the HTML-rendered article buffer.
+This only works if the article in question is HTML."
+ (interactive)
+ (gnus-with-article-buffer
+ (dolist (overlay (overlays-in (point-min) (point-max)))
+ (let ((o (overlay-get overlay 'gnus-image)))
+ (when o
+ (apply 'gnus-html-display-image o))))))
;;;###autoload
(defun gnus-html-prefetch-images (summary)
- (let (safe-url-regexp urls)
- (when (buffer-live-p summary)
- (save-excursion
- (set-buffer summary)
- (setq safe-url-regexp mm-w3m-safe-url-regexp))
+ (when (buffer-live-p summary)
+ (let ((blocked-images (with-current-buffer summary
+ gnus-blocked-images)))
(save-match-data
- (while (re-search-forward "<img.*src=[\"']\\([^\"']+\\)" nil t)
- (let ((url (match-string 1)))
- (when (or (null safe-url-regexp)
- (string-match safe-url-regexp url))
- (unless (file-exists-p (gnus-html-image-id url))
- (push url urls)
- (push (gnus-html-image-id url) urls)
- (push "-o" urls)))))
- (let ((process
- (apply 'start-process
- "images" nil "curl"
- "-s" "--create-dirs"
- "--location"
- "--max-time" "60"
- urls)))
- (process-kill-without-query process))))))
+ (while (re-search-forward "<img[^>]+src=[\"']\\([^\"']+\\)" nil t)
+ (let ((url (gnus-html-encode-url (match-string 1))))
+ (unless (gnus-html-image-url-blocked-p url blocked-images)
+ (when (gnus-html-cache-expired url gnus-html-image-cache-ttl)
+ (gnus-html-schedule-image-fetching nil
+ (list url))))))))))
(provide 'gnus-html)
projects / gnus / blobdiff