Return the group/article number, so that Gnus `^' works as expected.
[gnus] / lisp / gnus-html.el
index b492499..7ac3dd4 100644 (file)
 
 (eval-when-compile (require 'cl))
 (eval-when-compile (require 'mm-decode))
+
+(require 'gnus-art)
 (require 'mm-url)
+(require 'url)
 
 (defcustom gnus-html-cache-directory (nnheader-concat gnus-directory "html-cache/")
   "Where Gnus will cache images it downloads from the web."
@@ -72,9 +75,20 @@ fit these criteria."
     (define-key map "i" 'gnus-html-insert-image)
     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))
+
 ;;;###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
@@ -100,6 +114,7 @@ fit these criteria."
                                 "-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)
@@ -109,13 +124,104 @@ fit these criteria."
 
 (defvar gnus-article-mouse-face)
 
-(defun gnus-html-wash-tags ()
+(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 ()
   (let (tag parameters string start end images url)
-    (mm-url-decode-entities)
     (goto-char (point-min))
-    (while (re-search-forward "<pre_int> *</pre_int>\n" nil t)
-      (replace-match "" t t))
+    ;; 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 (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.
+         (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
+                                 (set-marker (make-marker) start)
+                                 (set-marker (make-marker) end))))
+                 (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)))
+           (let ((file (gnus-html-image-id url))
+                 width height alt-text)
+             (when (string-match "height=\"?\\([0-9]+\\)" parameters)
+               (setq height (string-to-number (match-string 1 parameters))))
+             (when (string-match "width=\"?\\([0-9]+\\)" parameters)
+               (setq width (string-to-number (match-string 1 parameters))))
+             (when (string-match "\\(alt\\|title\\)=\"\\([^\"]+\\)"
+                                 parameters)
+               (setq alt-text (match-string 2 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)))
+               (if (file-exists-p file)
+                   ;; It's already cached, so just insert it.
+                   (let ((string (buffer-substring start end)))
+                     ;; Delete the IMG text.
+                     (delete-region start end)
+                     (gnus-html-put-image file (point) string url alt-text))
+                 ;; We don't have it, so schedule it for fetching
+                 ;; asynchronously.
+                 (push (list url
+                             (set-marker (make-marker) start)
+                             (point-marker))
+                       images))))))))
+    (when images
+      (gnus-html-schedule-image-fetching (current-buffer) (nreverse images)))))
+
+(defun gnus-html-wash-tags ()
+  (let (tag parameters string start end images url)
+    (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)
@@ -128,68 +234,7 @@ fit these criteria."
       (setq end (point))
       (cond
        ;; Fetch and insert a picture.
-       ((equal tag "img_alt")
-        (when (string-match "src=\"\\([^\"]+\\)" parameters)
-         (setq 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 "*")))))
-           ;; Normal, external 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)
-                 (gnus-put-text-property
-                  start end
-                  'gnus-image (list url
-                                    (set-marker (make-marker) start)
-                                    (set-marker (make-marker) end))))
-             (let ((file (gnus-html-image-id url))
-                   width height)
-               (when (string-match "height=\"?\\([0-9]+\\)" parameters)
-                 (setq height (string-to-number (match-string 1 parameters))))
-               (when (string-match "width=\"?\\([0-9]+\\)" parameters)
-                 (setq width (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)))
-                 (if (file-exists-p file)
-                     ;; It's already cached, so just insert it.
-                     (let ((string (buffer-substring start end)))
-                       ;; Delete the ALT text.
-                       (delete-region start end)
-                       (gnus-html-put-image file (point) string))
-                   ;; 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.
        ((or (equal tag "a")
            (equal tag "A"))
@@ -209,6 +254,38 @@ fit these criteria."
        ;; 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
        ))
@@ -216,10 +293,9 @@ fit these criteria."
     (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)))))
+    (mm-url-decode-entities)))
 
 (defun gnus-html-insert-image ()
   "Fetch and insert the image under point."
@@ -227,46 +303,58 @@ fit these criteria."
   (gnus-html-schedule-image-fetching
    (current-buffer) (list (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)))
+
+(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 images)
   (gnus-message 8 "gnus-html-schedule-image-fetching: buffer %s, images %s"
                 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)
-    (gnus-set-process-plist process (list 'images images
-                                         'buffer buffer))))
+  (dolist (image images)
+    (ignore-errors
+      (url-retrieve (car image)
+                   'gnus-html-image-fetched
+                   (list buffer image)))))
 
 (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 (gnus-process-get process 'images))
-          (buffer (gnus-process-get 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 it was in has been deleted;
-                ;; i.e., that the user has selected a different
-                ;; article before the image arrived.
-                (not (= (marker-position (cadr spec)) (point-min))))
-       (with-current-buffer buffer
-         (let ((inhibit-read-only t)
-               (string (buffer-substring (cadr spec) (caddr spec))))
-           (delete-region (cadr spec) (caddr spec))
-           (gnus-html-put-image file (cadr spec) string))))
-      (when images
-       (gnus-html-schedule-image-fetching buffer images)))))
-
-(defun gnus-html-put-image (file point string)
+(defun gnus-html-image-fetched (status buffer image)
+  (let ((file (gnus-html-image-id (car image))))
+    ;; Search the start of the image data
+    (search-forward "\n\n")
+    ;; Write region (image data) silently
+    (write-region (point) (point-max) file nil 1)
+    (kill-buffer)
+    (when (and (buffer-live-p buffer)
+               ;; If the `image' has no marker, do not replace anything
+               (cadr image)
+               ;; If the position of the marker is 1, then that
+               ;; means that the text it was in has been deleted;
+               ;; i.e., that the user has selected a different
+               ;; article before the image arrived.
+               (not (= (marker-position (cadr image)) (point-min))))
+      (with-current-buffer buffer
+        (let ((inhibit-read-only t)
+              (string (buffer-substring (cadr image) (caddr image))))
+          (delete-region (cadr image) (caddr image))
+          (gnus-html-put-image file (cadr image) (car image) string))))))
+
+(defun gnus-html-put-image (file point string &optional url alt-text)
   (when (gnus-graphic-display-p)
     (let* ((image (ignore-errors
                   (gnus-create-image file)))
@@ -291,18 +379,26 @@ fit these criteria."
                               'gif)
                           (= (car size) 30)
                           (= (cdr size) 30))))
-           (progn
+           (let ((start (point)))
              (setq image (gnus-html-rescale-image image file size))
              (gnus-put-image image
                              (gnus-string-or string "*")
                              'external)
+             (let ((overlay (gnus-make-overlay start (point))))
+               (gnus-overlay-put overlay '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)))
              (gnus-add-image 'external image)
              t)
          (insert string)
          (when (fboundp 'find-image)
-           (gnus-put-image (find-image
-                            '((:type xpm :file "lock-broken.xpm")))
-                           (gnus-string-or string "*")))
+           (setq image (find-image '((:type xpm :file "lock-broken.xpm"))))
+           (gnus-put-image image
+                           (gnus-string-or string "*")
+                           'internal)
+           (gnus-add-image 'internal image))
          nil)))))
 
 (defun gnus-html-rescale-image (image file size)
@@ -348,7 +444,7 @@ fit these criteria."
          (delete-file (nth 2 file)))))))
 
 (defun gnus-html-image-url-blocked-p (url blocked-images)
-"Find out if URL is blocked by BLOCKED-IMAGES."
+  "Find out if URL is blocked by BLOCKED-IMAGES."
   (let ((ret (and blocked-images
                   (string-match blocked-images url))))
     (if ret
@@ -358,28 +454,34 @@ fit these criteria."
                     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
+    (let ((overlays (overlays-in (point-min) (point-max)))
+         overlay images)
+      (while (setq overlay (pop overlays))
+       (when (overlay-get overlay 'gnus-image)
+         (push (overlay-get overlay 'gnus-image) images)))
+      (if (not images)
+         (message "No images to show")
+       (gnus-html-schedule-image-fetching (current-buffer) images)))))
+
 ;;;###autoload
 (defun gnus-html-prefetch-images (summary)
-  (let (blocked-images urls)
-    (when (buffer-live-p summary)
-      (with-current-buffer summary
-       (setq blocked-images gnus-blocked-images))
+  (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)))
            (unless (gnus-html-image-url-blocked-p url blocked-images)
               (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))))))
+                (ignore-errors
+                  (url-retrieve (mm-url-decode-entities-string url)
+                                'gnus-html-image-fetched
+                               (list nil (list url))))))))))))
 
 (provide 'gnus-html)