mime-view.el

   1 ;;; mime-view.el --- interactive MIME viewer for GNU Emacs
   2
   3 ;; Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.
   4
   5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
   6 ;; Created: 1994/7/13
   7 ;;      Renamed: 1994/8/31 from tm-body.el
   8 ;;      Renamed: 1997/02/19 from tm-view.el
   9 ;; Keywords: MIME, multimedia, mail, news
  10
  11 ;; This file is part of SEMI (Sophisticated Emacs MIME Interfaces).
  12
  13 ;; This program is free software; you can redistribute it and/or
  14 ;; modify it under the terms of the GNU General Public License as
  15 ;; published by the Free Software Foundation; either version 2, or (at
  16 ;; your option) any later version.
  17
  18 ;; This program is distributed in the hope that it will be useful, but
  19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 ;; General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  26 ;; Boston, MA 02111-1307, USA.
  27
  28 ;;; Code:
  29
  30 (require 'std11)
  31 (require 'mel)
  32 (require 'eword-decode)
  33 (require 'mime-parse)
  34 (require 'mime-text)
  35
  36
  37 ;;; @ version
  38 ;;;
  39
  40 (defconst mime-view-version-string
  41   `,(concat "SEMI MIME-View "
  42             (mapconcat #'number-to-string (cdr semi-version) ".")
  43             " (" (car semi-version) ")"))
  44
  45
  46 ;;; @ buffer local variables
  47 ;;;
  48
  49 ;;; @@ in raw-buffer
  50 ;;;
  51
  52 (defvar mime-raw-message-info
  53   "Information about structure of message.
  54 Please use reference function `mime-entity-SLOT' to get value of SLOT.
  55
  56 Following is a list of slots of the structure:
  57
  58 node-id         reversed entity-number (list of integers)
  59 point-min       beginning point of region in raw-buffer
  60 point-max       end point of region in raw-buffer
  61 type            media-type (symbol)
  62 subtype         media-subtype (symbol)
  63 type/subtype    media-type/subtype (string or nil)
  64 parameters      parameter of Content-Type field (association list)
  65 encoding        Content-Transfer-Encoding (string or nil)
  66 children        entities included in this entity (list of content-infos)
  67
  68 If an entity includes other entities in its body, such as multipart or
  69 message/rfc822, `mime-entity' structures of them are included in
  70 `children', so the `mime-entity' structure become a tree.")
  71 (make-variable-buffer-local 'mime-raw-message-info)
  72
  73 (defvar mime-preview-buffer nil
  74   "MIME-preview buffer corresponding with the (raw) buffer.")
  75 (make-variable-buffer-local 'mime-preview-buffer)
  76
  77
  78 ;;; @@ in preview-buffer
  79 ;;;
  80
  81 (defvar mime-mother-buffer nil
  82   "Mother buffer corresponding with the (MIME-preview) buffer.
  83 If current MIME-preview buffer is generated by other buffer, such as
  84 message/partial, it is called `mother-buffer'.")
  85 (make-variable-buffer-local 'mime-mother-buffer)
  86
  87 (defvar mime-raw-buffer nil
  88   "Raw buffer corresponding with the (MIME-preview) buffer.")
  89 (make-variable-buffer-local 'mime-raw-buffer)
  90
  91 (defvar mime-preview-original-major-mode nil
  92   "Major-mode of mime-raw-buffer.")
  93 (make-variable-buffer-local 'mime-preview-original-major-mode)
  94
  95 (make-variable-buffer-local 'mime-preview-original-window-configuration)
  96
  97
  98 ;;; @ entity button
  99 ;;;
 100
 101 (defvar mime-view-content-button-visible-ctype-list
 102   '("application/pgp"))
 103
 104 (defun mime-view-insert-entity-button (entity message-info subj)
 105   "Insert entity-button of ENTITY."
 106   (let ((entity-node-id (mime-entity-node-id entity))
 107         (params (mime-entity-parameters entity)))
 108     (mime-insert-button
 109      (let ((access-type (assoc "access-type" params))
 110            (num (or (cdr (assoc "x-part-number" params))
 111                     (if (consp entity-node-id)
 112                         (mapconcat (function
 113                                     (lambda (num)
 114                                       (format "%s" (1+ num))
 115                                       ))
 116                                    (reverse entity-node-id) ".")
 117                       "0"))
 118                 ))
 119        (cond (access-type
 120               (let ((server (assoc "server" params)))
 121                 (setq access-type (cdr access-type))
 122                 (if server
 123                     (format "%s %s ([%s] %s)"
 124                             num subj access-type (cdr server))
 125                 (let ((site (cdr (assoc "site" params)))
 126                       (dir (cdr (assoc "directory" params)))
 127                       )
 128                   (format "%s %s ([%s] %s:%s)"
 129                           num subj access-type site dir)
 130                   )))
 131             )
 132            (t
 133             (let ((media-type (mime-entity-media-type entity))
 134                   (media-subtype (mime-entity-media-subtype entity))
 135                   (charset (cdr (assoc "charset" params)))
 136                   (encoding (mime-entity-encoding entity)))
 137               (concat
 138                num " " subj
 139                (let ((rest
 140                       (format " <%s/%s%s%s>"
 141                               media-type media-subtype
 142                               (if charset
 143                                   (concat "; " charset)
 144                                 "")
 145                               (if encoding
 146                                   (concat " (" encoding ")")
 147                                 ""))))
 148                  (if (>= (+ (current-column)(length rest))(window-width))
 149                      "\n\t")
 150                  rest)))
 151             )))
 152      (function mime-preview-play-current-entity))
 153     ))
 154
 155 (defun mime-view-entity-button-function (entity message-info subj)
 156   "Insert entity-button of ENTITY conditionally.
 157 Please redefine this function if you want to change default setting."
 158   (let ((entity-node-id (mime-entity-node-id entity))
 159         (media-type (mime-entity-media-type entity))
 160         (media-subtype (mime-entity-media-subtype entity)))
 161     (or (null entity-node-id)
 162         (and (eq media-type 'application)
 163              (or (eq media-subtype 'x-selection)
 164                  (and (eq media-subtype 'octet-stream)
 165                       (let ((mother-entity
 166                              (mime-raw-find-entity-from-node-id
 167                               (cdr entity-node-id) message-info)))
 168                         (and (eq (mime-entity-media-type mother-entity)
 169                                  'multipart)
 170                              (eq (mime-entity-media-subtype mother-entity)
 171                                  'encrypted)
 172                              )))))
 173         (mime-view-insert-entity-button entity message-info subj)
 174         )))
 175
 176
 177 ;;; @ entity header
 178 ;;;
 179
 180 ;;; @@ predicate function
 181 ;;;
 182
 183 (defvar mime-view-childrens-header-showing-Content-Type-list
 184   '("message/rfc822" "message/news"))
 185
 186 (defun mime-view-header-visible-p (entity message-info)
 187   "Return non-nil if header of ENTITY is visible."
 188   (let ((entity-node-id (mime-entity-node-id entity)))
 189     (or (null entity-node-id)
 190         (member (mime-entity-type/subtype
 191                  (mime-raw-find-entity-from-node-id
 192                   (cdr entity-node-id) message-info))
 193                 mime-view-childrens-header-showing-Content-Type-list)
 194         )))
 195
 196 ;;; @@ entity header filter
 197 ;;;
 198
 199 (defvar mime-view-content-header-filter-alist nil)
 200
 201 (defun mime-view-default-content-header-filter ()
 202   (mime-view-cut-header)
 203   (eword-decode-header)
 204   )
 205
 206 (defun mime-view-display-header (beg end)
 207   (save-restriction
 208     (narrow-to-region (point)(point))
 209     (insert-buffer-substring mime-raw-buffer beg end)
 210     (let ((f (cdr (assq mime-preview-original-major-mode
 211                         mime-view-content-header-filter-alist))))
 212       (if (functionp f)
 213           (funcall f)
 214         (mime-view-default-content-header-filter)
 215         ))
 216     (run-hooks 'mime-view-content-header-filter-hook)
 217     ))
 218
 219 ;;; @@ entity field cutter
 220 ;;;
 221
 222 (defvar mime-view-ignored-field-list
 223   '(".*Received" ".*Path" ".*Id" "References"
 224     "Replied" "Errors-To"
 225     "Lines" "Sender" ".*Host" "Xref"
 226     "Content-Type" "Precedence"
 227     "Status" "X-VM-.*")
 228   "All fields that match this list will be hidden in MIME preview buffer.
 229 Each elements are regexp of field-name.")
 230
 231 (defvar mime-view-ignored-field-regexp
 232   (concat "^"
 233           (apply (function regexp-or) mime-view-ignored-field-list)
 234           ":"))
 235
 236 (defvar mime-view-visible-field-list '("Dnas.*" "Message-Id")
 237   "All fields that match this list will be displayed in MIME preview buffer.
 238 Each elements are regexp of field-name.")
 239
 240 (defun mime-view-cut-header ()
 241   (goto-char (point-min))
 242   (while (re-search-forward mime-view-ignored-field-regexp nil t)
 243     (let* ((beg (match-beginning 0))
 244            (end (match-end 0))
 245            (name (buffer-substring beg end))
 246            )
 247       (catch 'visible
 248         (let ((rest mime-view-visible-field-list))
 249           (while rest
 250             (if (string-match (car rest) name)
 251                 (throw 'visible nil)
 252               )
 253             (setq rest (cdr rest))))
 254         (delete-region beg
 255                        (save-excursion
 256                          (if (re-search-forward "^\\([^ \t]\\|$\\)" nil t)
 257                              (match-beginning 0)
 258                            (point-max))))
 259         ))))
 260
 261
 262 ;;; @ entity-body
 263 ;;;
 264
 265 ;;; @@ predicate function
 266 ;;;
 267
 268 (defvar mime-view-visible-media-type-list
 269   '("text/plain" nil "text/richtext" "text/enriched"
 270     "text/rfc822-headers"
 271     "text/x-latex" "application/x-latex"
 272     "message/delivery-status"
 273     "application/pgp" "text/x-pgp"
 274     "application/octet-stream"
 275     "application/x-selection" "application/x-comment")
 276   "*List of media-types to be able to display in MIME-preview buffer.
 277 Each elements are string of TYPE/SUBTYPE, e.g. \"text/plain\".")
 278
 279 (defun mime-view-body-visible-p (entity message-info)
 280   "Return non-nil if body of ENTITY is visible."
 281   (let ((media-type (mime-entity-media-type entity))
 282         (media-subtype (mime-entity-media-subtype entity))
 283         (ctype (mime-entity-type/subtype entity)))
 284     (and (member ctype mime-view-visible-media-type-list)
 285          (if (and (eq media-type 'application)
 286                   (eq media-subtype 'octet-stream))
 287              (member (mime-entity-encoding entity) '(nil "7bit" "8bit"))
 288            t))))
 289
 290
 291 ;;; @@ entity filter
 292 ;;;
 293
 294 (defvar mime-view-content-filter-alist
 295   '(("text/enriched" . mime-view-filter-for-text/enriched)
 296     ("text/richtext" . mime-view-filter-for-text/richtext)
 297     (t . mime-view-filter-for-text/plain)
 298     )
 299   "Alist of media-types vs. corresponding MIME-preview filter functions.
 300 Each element looks like (TYPE/SUBTYPE . FUNCTION) or (t . FUNCTION).
 301 TYPE/SUBTYPE is a string of media-type and FUNCTION is a filter
 302 function.  t means default media-type.")
 303
 304 (defun mime-view-display-body (start end entity message-info subj)
 305   (save-restriction
 306     (narrow-to-region (point-max)(point-max))
 307     (insert-buffer-substring mime-raw-buffer start end)
 308     (let* ((ctype (mime-entity-type/subtype entity))
 309            (params (mime-entity-parameters entity))
 310            (encoding (mime-entity-encoding entity))
 311            (f (cdr (or (assoc ctype mime-view-content-filter-alist)
 312                        (assq t mime-view-content-filter-alist)))))
 313       (and (functionp f)
 314            (funcall f ctype params encoding))
 315       )))
 316
 317 (defvar mime-view-announcement-for-message/partial
 318   (if (and (>= emacs-major-version 19) window-system)
 319       "\
 320 \[[ This is message/partial style split message. ]]
 321 \[[ Please press `v' key in this buffer          ]]
 322 \[[ or click here by mouse button-2.             ]]"
 323     "\
 324 \[[ This is message/partial style split message. ]]
 325 \[[ Please press `v' key in this buffer.         ]]"
 326     ))
 327
 328 (defun mime-view-insert-message/partial-button ()
 329   (save-restriction
 330     (goto-char (point-max))
 331     (if (not (search-backward "\n\n" nil t))
 332         (insert "\n")
 333       )
 334     (goto-char (point-max))
 335     (narrow-to-region (point-max)(point-max))
 336     (insert mime-view-announcement-for-message/partial)
 337     (mime-add-button (point-min)(point-max)
 338                      #'mime-preview-play-current-entity)
 339     ))
 340
 341
 342 ;;; @ entity separator
 343 ;;;
 344
 345 (defun mime-view-entity-separator-function (entity message-info)
 346   "Insert entity-separator of ENTITY conditionally.
 347 Please redefine this function if you want to change default setting."
 348   (or (mime-view-header-visible-p entity message-info)
 349       (mime-view-body-visible-p entity message-info)
 350       (progn
 351         (goto-char (point-max))
 352         (insert "\n")
 353         )))
 354
 355
 356 ;;; @ acting-condition
 357 ;;;
 358
 359 (defvar mime-acting-condition
 360   '(((type . text)(subtype . plain)
 361      (method "tm-plain" nil 'file "" 'encoding 'mode 'name)
 362      (mode "play" "print")
 363      )
 364     ((type . text)(subtype . html)
 365      (method "tm-html" nil 'file "" 'encoding 'mode 'name)
 366      (mode . "play")
 367      )
 368     ((type . text)(subtype . x-rot13-47)
 369      (method . mime-method-to-display-caesar)
 370      (mode . "play")
 371      )
 372     ((type . text)(subtype . x-rot13-47-48)
 373      (method . mime-method-to-display-caesar)
 374      (mode . "play")
 375      )
 376
 377     ((type . audio)(subtype . basic)
 378      (method "tm-au"    nil 'file "" 'encoding 'mode 'name)
 379      (mode . "play")
 380      )
 381
 382     ((type . image)
 383      (method "tm-image" nil 'file "" 'encoding 'mode 'name)
 384      (mode "play" "print")
 385      )
 386
 387     ((type . video)(subtype . mpeg)
 388      (method "tm-mpeg"  nil 'file "" 'encoding 'mode 'name)
 389      (mode . "play")
 390      )
 391
 392     ((type . application)(subtype . postscript)
 393      (method "tm-ps" nil 'file "" 'encoding 'mode 'name)
 394      (mode "play" "print")
 395      )
 396     ((type . application)(subtype . octet-stream)
 397      (method . mime-method-to-save)(mode "play" "print")
 398      )
 399
 400     ((type . message)(subtype . external-body)
 401      ("access-type" . "anon-ftp")
 402      (method . mime-method-to-display-message/external-ftp)
 403      )
 404     ((type . message)(subtype . rfc822)
 405      (method . mime-method-to-display-message/rfc822)
 406      (mode . "play")
 407      )
 408     ((type . message)(subtype . partial)
 409      (method . mime-method-to-store-message/partial)
 410      (mode . "play")
 411      )
 412
 413     ((method "metamail" t "-m" "tm" "-x" "-d" "-z" "-e" 'file)
 414      (mode . "play")
 415      )
 416     ((method . mime-method-to-save)(mode . "extract"))
 417     ))
 418
 419
 420 ;;; @ quitting method
 421 ;;;
 422
 423 (defvar mime-preview-quitting-method-alist
 424   '((mime-show-message-mode
 425      . mime-preview-quitting-method-for-mime-show-message-mode))
 426   "Alist of major-mode vs. quitting-method of mime-view.")
 427
 428 (defvar mime-view-over-to-previous-method-alist nil)
 429 (defvar mime-view-over-to-next-method-alist nil)
 430
 431 (defvar mime-view-show-summary-method nil
 432   "Alist of major-mode vs. show-summary-method.")
 433
 434
 435 ;;; @ following method
 436 ;;;
 437
 438 (defvar mime-view-following-method-alist nil
 439   "Alist of major-mode vs. following-method of mime-view.")
 440
 441 (defvar mime-view-following-required-fields-list
 442   '("From"))
 443
 444
 445 ;;; @ X-Face
 446 ;;;
 447
 448 ;; hack from Gnus 5.0.4.
 449
 450 (defvar mime-view-x-face-to-pbm-command
 451   "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm")
 452
 453 (defvar mime-view-x-face-command
 454   (concat mime-view-x-face-to-pbm-command
 455           " | xv -quit -")
 456   "String to be executed to display an X-Face field.
 457 The command will be executed in a sub-shell asynchronously.
 458 The compressed face will be piped to this command.")
 459
 460 (defun mime-view-x-face-function ()
 461   "Function to display X-Face field. You can redefine to customize."
 462   ;; 1995/10/12 (c.f. tm-eng:130)
 463   ;;    fixed by Eric Ding <ericding@San-Jose.ate.slb.com>
 464   (save-restriction
 465     (narrow-to-region (point-min) (re-search-forward "^$" nil t))
 466     ;; end
 467     (goto-char (point-min))
 468     (if (re-search-forward "^X-Face:[ \t]*" nil t)
 469         (let ((beg (match-end 0))
 470               (end (std11-field-end))
 471               )
 472           (call-process-region beg end "sh" nil 0 nil
 473                                "-c" mime-view-x-face-command)
 474           ))))
 475
 476
 477 ;;; @ miscellaneous
 478 ;;;
 479
 480 (defvar mime-view-uuencode-encoding-name-list '("x-uue" "x-uuencode"))
 481
 482 (defvar mime-raw-coding-system-alist
 483   `((mh-show-mode . no-conversion)
 484     (t . ,(mime-charset-to-coding-system default-mime-charset)))
 485   "Alist of major-mode vs. corresponding coding-system.")
 486
 487
 488 ;;; @ buffer setup
 489 ;;;
 490
 491 (defvar mime-view-redisplay nil)
 492
 493 (defun mime-view-setup-buffers (&optional ctl encoding ibuf obuf)
 494   (if ibuf
 495       (progn
 496         (get-buffer ibuf)
 497         (set-buffer ibuf)
 498         ))
 499   (or mime-view-redisplay
 500       (setq mime-raw-message-info (mime-parse-message ctl encoding))
 501       )
 502   (let* ((message-info mime-raw-message-info)
 503          (pcl (mime-raw-flatten-message-info message-info))
 504          (the-buf (current-buffer))
 505          (mode major-mode)
 506          )
 507     (or obuf
 508         (setq obuf (concat "*Preview-" (buffer-name the-buf) "*")))
 509     (set-buffer (get-buffer-create obuf))
 510     (let ((inhibit-read-only t))
 511       ;;(setq buffer-read-only nil)
 512       (widen)
 513       (erase-buffer)
 514       (setq mime-raw-buffer the-buf)
 515       (setq mime-preview-original-major-mode mode)
 516       (setq major-mode 'mime-view-mode)
 517       (setq mode-name "MIME-View")
 518       (while pcl
 519         (mime-view-display-entity (car pcl) message-info the-buf obuf)
 520         (setq pcl (cdr pcl))
 521         )
 522       (set-buffer-modified-p nil)
 523       )
 524     (setq buffer-read-only t)
 525     (set-buffer the-buf)
 526     )
 527   (setq mime-preview-buffer obuf)
 528   )
 529
 530 (defun mime-view-display-entity (entity message-info ibuf obuf)
 531   "Display ENTITY."
 532   (let* ((beg (mime-entity-point-min entity))
 533          (end (mime-entity-point-max entity))
 534          (media-type (mime-entity-media-type entity))
 535          (media-subtype (mime-entity-media-subtype entity))
 536          (ctype (if media-type
 537                     (if media-subtype
 538                         (format "%s/%s" media-type media-subtype)
 539                       (symbol-name media-type)
 540                       )))
 541          (params (mime-entity-parameters entity))
 542          (encoding (mime-entity-encoding entity))
 543          (entity-node-id (mime-entity-node-id entity))
 544          he e nb ne subj)
 545     (set-buffer ibuf)
 546     (goto-char beg)
 547     (setq he (if (re-search-forward "^$" nil t)
 548                  (1+ (match-end 0))
 549                end))
 550     (if (> he end)
 551         (setq he end)
 552       )
 553     (save-restriction
 554       (narrow-to-region beg end)
 555       (setq subj
 556             (eword-decode-string
 557              (mime-raw-get-subject params encoding)))
 558       )
 559     (set-buffer obuf)
 560     (setq nb (point))
 561     (narrow-to-region nb nb)
 562     (mime-view-entity-button-function entity message-info subj)
 563     (if (mime-view-header-visible-p entity message-info)
 564         (mime-view-display-header beg he)
 565       )
 566     (if (and (null entity-node-id)
 567              (member
 568               ctype mime-view-content-button-visible-ctype-list))
 569         (save-excursion
 570           (goto-char (point-max))
 571           (mime-view-insert-entity-button entity message-info subj)
 572           ))
 573     (cond ((mime-view-body-visible-p entity message-info)
 574            (mime-view-display-body he end entity message-info subj)
 575            )
 576           ((and (eq media-type 'message)(eq media-subtype 'partial))
 577            (mime-view-insert-message/partial-button)
 578            )
 579           ((and (null entity-node-id)
 580                 (null (mime-entity-children message-info))
 581                 )
 582            (goto-char (point-max))
 583            (mime-view-insert-entity-button entity message-info subj)
 584            ))
 585     (mime-view-entity-separator-function entity message-info)
 586     (setq ne (point-max))
 587     (widen)
 588     (put-text-property nb ne 'mime-view-raw-buffer ibuf)
 589     (put-text-property nb ne 'mime-view-entity entity)
 590     (goto-char ne)
 591     ))
 592
 593 (defun mime-raw-get-uu-filename (param &optional encoding)
 594   (if (member (or encoding
 595                   (cdr (assq 'encoding param))
 596                   )
 597               mime-view-uuencode-encoding-name-list)
 598       (save-excursion
 599         (or (if (re-search-forward "^begin [0-9]+ " nil t)
 600                 (if (looking-at ".+$")
 601                     (buffer-substring (match-beginning 0)(match-end 0))
 602                   ))
 603             ""))
 604     ))
 605
 606 (defun mime-raw-get-subject (param &optional encoding)
 607   (or (std11-find-field-body '("Content-Description" "Subject"))
 608       (let (ret)
 609         (if (or (and (setq ret (mime/Content-Disposition))
 610                      (setq ret (assoc "filename" (cdr ret)))
 611                      )
 612                 (setq ret (assoc "name" param))
 613                 (setq ret (assoc "x-name" param))
 614                 )
 615             (std11-strip-quoted-string (cdr ret))
 616           ))
 617       (mime-raw-get-uu-filename param encoding)
 618       ""))
 619
 620
 621 ;;; @ entity information
 622 ;;;
 623
 624 (defsubst mime-raw-find-entity-from-node-id (entity-node-id
 625                                              &optional message-info)
 626   "Return entity from ENTITY-NODE-ID in mime-raw-buffer.
 627 If optional argument MESSAGE-INFO is not specified,
 628 `mime-raw-message-info' is used."
 629   (mime-raw-find-entity-from-number (reverse entity-node-id) message-info))
 630
 631 (defun mime-raw-find-entity-from-number (entity-number &optional message-info)
 632   "Return entity from ENTITY-NUMBER in mime-raw-buffer.
 633 If optional argument MESSAGE-INFO is not specified,
 634 `mime-raw-message-info' is used."
 635   (or message-info
 636       (setq message-info mime-raw-message-info))
 637   (if (eq entity-number t)
 638       message-info
 639     (let ((sn (car entity-number)))
 640       (if (null sn)
 641           message-info
 642         (let ((rc (nth sn (mime-entity-children message-info))))
 643           (if rc
 644               (mime-raw-find-entity-from-number (cdr entity-number) rc)
 645             ))
 646         ))))
 647
 648 (defun mime-raw-find-entity-from-point (point &optional message-info)
 649   "Return entity from POINT in mime-raw-buffer.
 650 If optional argument MESSAGE-INFO is not specified,
 651 `mime-raw-message-info' is used."
 652   (or message-info
 653       (setq message-info mime-raw-message-info))
 654   (if (and (<= (mime-entity-point-min message-info) point)
 655            (<= point (mime-entity-point-max message-info)))
 656       (let ((children (mime-entity-children message-info)))
 657         (catch 'tag
 658           (while children
 659             (let ((ret
 660                    (mime-raw-find-entity-from-point point (car children))))
 661               (if ret
 662                   (throw 'tag ret)
 663                 ))
 664             (setq children (cdr children)))
 665           message-info))))
 666
 667 (defsubst mime-raw-point-to-entity-node-id (point &optional message-info)
 668   "Return entity-node-id from POINT in mime-raw-buffer.
 669 If optional argument MESSAGE-INFO is not specified,
 670 `mime-raw-message-info' is used."
 671   (mime-entity-node-id (mime-raw-find-entity-from-point point message-info)))
 672
 673 (defsubst mime-raw-point-to-entity-number (point &optional message-info)
 674   "Return entity-number from POINT in mime-raw-buffer.
 675 If optional argument MESSAGE-INFO is not specified,
 676 `mime-raw-message-info' is used."
 677   (reverse (mime-raw-point-to-entity-node-id point message-id)))
 678
 679 (defun mime-raw-flatten-message-info (&optional message-info)
 680   "Return list of entity in mime-raw-buffer.
 681 If optional argument MESSAGE-INFO is not specified,
 682 `mime-raw-message-info' is used."
 683   (or message-info
 684       (setq message-info mime-raw-message-info))
 685   (let ((dest (list message-info))
 686         (rcl (mime-entity-children message-info)))
 687     (while rcl
 688       (setq dest (nconc dest (mime-raw-flatten-message-info (car rcl))))
 689       (setq rcl (cdr rcl)))
 690     dest))
 691
 692
 693 ;;; @ MIME viewer mode
 694 ;;;
 695
 696 (defconst mime-view-menu-title "MIME-View")
 697 (defconst mime-view-menu-list
 698   '((up          "Move to upper entity"    mime-preview-move-to-upper)
 699     (previous    "Move to previous entity" mime-preview-move-to-previous)
 700     (next        "Move to next entity"     mime-preview-move-to-next)
 701     (scroll-down "Scroll-down"             mime-preview-scroll-down-entity)
 702     (scroll-up   "Scroll-up"               mime-preview-scroll-up-entity)
 703     (play        "Play current entity"     mime-preview-play-current-entity)
 704     (extract     "Extract current entity"  mime-preview-extract-current-entity)
 705     (print       "Print current entity"    mime-preview-print-current-entity)
 706     (x-face      "Show X Face"             mime-preview-display-x-face)
 707     )
 708   "Menu for MIME Viewer")
 709
 710 (cond (running-xemacs
 711        (defvar mime-view-xemacs-popup-menu
 712          (cons mime-view-menu-title
 713                (mapcar (function
 714                         (lambda (item)
 715                           (vector (nth 1 item)(nth 2 item) t)
 716                           ))
 717                        mime-view-menu-list)))
 718        (defun mime-view-xemacs-popup-menu (event)
 719          "Popup the menu in the MIME Viewer buffer"
 720          (interactive "e")
 721          (select-window (event-window event))
 722          (set-buffer (event-buffer event))
 723          (popup-menu 'mime-view-xemacs-popup-menu))
 724        (defvar mouse-button-2 'button2)
 725        )
 726       (t
 727        (defvar mouse-button-2 [mouse-2])
 728        ))
 729
 730 (defun mime-view-define-keymap (&optional default)
 731   (let ((mime-view-mode-map (if (keymapp default)
 732                                 (copy-keymap default)
 733                               (make-sparse-keymap)
 734                               )))
 735     (define-key mime-view-mode-map
 736       "u"        (function mime-preview-move-to-upper))
 737     (define-key mime-view-mode-map
 738       "p"        (function mime-preview-move-to-previous))
 739     (define-key mime-view-mode-map
 740       "n"        (function mime-preview-move-to-next))
 741     (define-key mime-view-mode-map
 742       "\e\t"     (function mime-preview-move-to-previous))
 743     (define-key mime-view-mode-map
 744       "\t"       (function mime-preview-move-to-next))
 745     (define-key mime-view-mode-map
 746       " "        (function mime-preview-scroll-up-entity))
 747     (define-key mime-view-mode-map
 748       "\M- "     (function mime-preview-scroll-down-entity))
 749     (define-key mime-view-mode-map
 750       "\177"     (function mime-preview-scroll-down-entity))
 751     (define-key mime-view-mode-map
 752       "\C-m"     (function mime-preview-next-line-entity))
 753     (define-key mime-view-mode-map
 754       "\C-\M-m"  (function mime-preview-previous-line-entity))
 755     (define-key mime-view-mode-map
 756       "v"        (function mime-preview-play-current-entity))
 757     (define-key mime-view-mode-map
 758       "e"        (function mime-preview-extract-current-entity))
 759     (define-key mime-view-mode-map
 760       "\C-c\C-p" (function mime-preview-print-current-entity))
 761     (define-key mime-view-mode-map
 762       "a"        (function mime-preview-follow-current-entity))
 763     (define-key mime-view-mode-map
 764       "q"        (function mime-preview-quit))
 765     (define-key mime-view-mode-map
 766       "h"        (function mime-preview-show-summary))
 767     (define-key mime-view-mode-map
 768       "\C-c\C-x" (function mime-preview-kill-buffer))
 769     ;; (define-key mime-view-mode-map
 770     ;;   "<"        (function beginning-of-buffer))
 771     ;; (define-key mime-view-mode-map
 772     ;;   ">"        (function end-of-buffer))
 773     (define-key mime-view-mode-map
 774       "?"        (function describe-mode))
 775     (define-key mime-view-mode-map
 776       [tab] (function mime-preview-move-to-next))
 777     (define-key mime-view-mode-map
 778       [delete] (function mime-preview-scroll-down-entity))
 779     (define-key mime-view-mode-map
 780       [backspace] (function mime-preview-scroll-down-entity))
 781     (if (functionp default)
 782         (cond (running-xemacs
 783                (set-keymap-default-binding mime-view-mode-map default)
 784                )
 785               (t
 786                (setq mime-view-mode-map
 787                      (append mime-view-mode-map (list (cons t default))))
 788                )))
 789     (if mouse-button-2
 790         (define-key mime-view-mode-map
 791           mouse-button-2 (function mime-button-dispatcher))
 792       )
 793     (cond (running-xemacs
 794            (define-key mime-view-mode-map
 795              mouse-button-3 (function mime-view-xemacs-popup-menu))
 796            )
 797           ((>= emacs-major-version 19)
 798            (define-key mime-view-mode-map [menu-bar mime-view]
 799              (cons mime-view-menu-title
 800                    (make-sparse-keymap mime-view-menu-title)))
 801            (mapcar (function
 802                     (lambda (item)
 803                       (define-key mime-view-mode-map
 804                         (vector 'menu-bar 'mime-view (car item))
 805                         (cons (nth 1 item)(nth 2 item))
 806                         )
 807                       ))
 808                    (reverse mime-view-menu-list)
 809                    )
 810            ))
 811     (use-local-map mime-view-mode-map)
 812     (run-hooks 'mime-view-define-keymap-hook)
 813     ))
 814
 815 (defsubst mime-maybe-hide-echo-buffer ()
 816   "Clear mime-echo buffer and delete window for it."
 817   (let ((buf (get-buffer mime-echo-buffer-name)))
 818     (if buf
 819         (save-excursion
 820           (set-buffer buf)
 821           (erase-buffer)
 822           (let ((win (get-buffer-window buf)))
 823             (if win
 824                 (delete-window win)
 825               ))
 826           (bury-buffer buf)
 827           ))))
 828
 829 (defun mime-view-mode (&optional mother ctl encoding ibuf obuf
 830                                  default-keymap-or-function)
 831   "Major mode for viewing MIME message.
 832
 833 Here is a list of the standard keys for mime-view-mode.
 834
 835 key             feature
 836 ---             -------
 837
 838 u               Move to upper content
 839 p or M-TAB      Move to previous content
 840 n or TAB        Move to next content
 841 SPC             Scroll up or move to next content
 842 M-SPC or DEL    Scroll down or move to previous content
 843 RET             Move to next line
 844 M-RET           Move to previous line
 845 v               Decode current content as `play mode'
 846 e               Decode current content as `extract mode'
 847 C-c C-p         Decode current content as `print mode'
 848 a               Followup to current content.
 849 x               Display X-Face
 850 q               Quit
 851 button-2        Move to point under the mouse cursor
 852                 and decode current content as `play mode'
 853 "
 854   (interactive)
 855   (mime-maybe-hide-echo-buffer)
 856   (let ((ret (mime-view-setup-buffers ctl encoding ibuf obuf))
 857         (win-conf (current-window-configuration))
 858         )
 859     (prog1
 860         (switch-to-buffer ret)
 861       (setq mime-preview-original-window-configuration win-conf)
 862       (if mother
 863           (progn
 864             (setq mime-mother-buffer mother)
 865             ))
 866       (mime-view-define-keymap default-keymap-or-function)
 867       (let ((point
 868              (next-single-property-change (point-min) 'mime-view-entity)))
 869         (if point
 870             (goto-char point)
 871           (goto-char (point-min))
 872           (search-forward "\n\n" nil t)
 873           ))
 874       (run-hooks 'mime-view-mode-hook)
 875       )))
 876
 877
 878 ;;; @@ playing
 879 ;;;
 880
 881 (autoload 'mime-preview-play-current-entity "mime-play"
 882   "Play current entity." t)
 883
 884 (defun mime-preview-extract-current-entity ()
 885   "Extract current entity into file (maybe).
 886 It decodes current entity to call internal or external method as
 887 \"extract\" mode.  The method is selected from variable
 888 `mime-acting-condition'."
 889   (interactive)
 890   (mime-preview-play-current-entity "extract")
 891   )
 892
 893 (defun mime-preview-print-current-entity ()
 894   "Print current entity (maybe).
 895 It decodes current entity to call internal or external method as
 896 \"print\" mode.  The method is selected from variable
 897 `mime-acting-condition'."
 898   (interactive)
 899   (mime-preview-play-current-entity "print")
 900   )
 901
 902
 903 ;;; @@ following
 904 ;;;
 905
 906 (defun mime-preview-original-major-mode ()
 907   "Return major-mode of original buffer.
 908 If a current buffer has mime-mother-buffer, return original major-mode
 909 of the mother-buffer."
 910   (if mime-mother-buffer
 911       (save-excursion
 912         (set-buffer mime-mother-buffer)
 913         (mime-preview-original-major-mode)
 914         )
 915     mime-preview-original-major-mode))
 916
 917 (defun mime-preview-follow-current-entity ()
 918   "Write follow message to current entity.
 919 It calls following-method selected from variable
 920 `mime-view-following-method-alist'."
 921   (interactive)
 922   (let ((message-info (get-text-property (point-min) 'mime-view-entity))
 923         entity)
 924     (while (null (setq entity
 925                        (get-text-property (point) 'mime-view-entity)))
 926       (backward-char)
 927       )
 928     (let* ((p-beg
 929             (previous-single-property-change (point) 'mime-view-entity))
 930            p-end
 931            (entity-node-id (mime-entity-node-id entity))
 932            (len (length entity-node-id))
 933            )
 934       (cond ((null p-beg)
 935              (setq p-beg
 936                    (if (eq (next-single-property-change (point-min)
 937                                                         'mime-view-entity)
 938                            (point))
 939                        (point)
 940                      (point-min)))
 941              )
 942             ((eq (next-single-property-change p-beg 'mime-view-entity)
 943                  (point))
 944              (setq p-beg (point))
 945              ))
 946       (setq p-end (next-single-property-change p-beg 'mime-view-entity))
 947       (cond ((null p-end)
 948              (setq p-end (point-max))
 949              )
 950             ((null entity-node-id)
 951              (setq p-end (point-max))
 952              )
 953             (t
 954              (save-excursion
 955                (goto-char p-end)
 956                (catch 'tag
 957                  (let (e)
 958                    (while (setq e
 959                                 (next-single-property-change
 960                                  (point) 'mime-view-entity))
 961                      (goto-char e)
 962                      (let ((rc (mime-entity-node-id
 963                                 (get-text-property (point)
 964                                                    'mime-view-entity))))
 965                        (or (equal entity-node-id
 966                                   (nthcdr (- (length rc) len) rc))
 967                            (throw 'tag nil)
 968                            ))
 969                      (setq p-end e)
 970                      ))
 971                  (setq p-end (point-max))
 972                  ))
 973              ))
 974       (let* ((mode (mime-preview-original-major-mode))
 975              (new-name
 976               (format "%s-%s" (buffer-name) (reverse entity-node-id)))
 977              new-buf
 978              (the-buf (current-buffer))
 979              (a-buf mime-raw-buffer)
 980              fields)
 981         (save-excursion
 982           (set-buffer (setq new-buf (get-buffer-create new-name)))
 983           (erase-buffer)
 984           (insert-buffer-substring the-buf p-beg p-end)
 985           (goto-char (point-min))
 986           (if (mime-view-header-visible-p entity message-info)
 987               (delete-region (goto-char (point-min))
 988                              (if (re-search-forward "^$" nil t)
 989                                  (match-end 0)
 990                                (point-min)))
 991             )
 992           (goto-char (point-min))
 993           (insert "\n")
 994           (goto-char (point-min))
 995           (let ((entity-node-id (mime-entity-node-id entity)) ci str)
 996             (while (progn
 997                      (setq
 998                       str
 999                       (save-excursion
1000                         (set-buffer a-buf)
1001                         (setq
1002                          ci
1003                          (mime-raw-find-entity-from-node-id entity-node-id))
1004                         (save-restriction
1005                           (narrow-to-region
1006                            (mime-entity-point-min ci)
1007                            (mime-entity-point-max ci)
1008                            )
1009                           (std11-header-string-except
1010                            (concat "^"
1011                                    (apply (function regexp-or) fields)
1012                                    ":") ""))))
1013                      (if (and
1014                           (eq (mime-entity-media-type ci) 'message)
1015                           (eq (mime-entity-media-subtype ci) 'rfc822))
1016                          nil
1017                        (if str
1018                            (insert str)
1019                          )
1020                        entity-node-id))
1021               (setq fields (std11-collect-field-names)
1022                     entity-node-id (cdr entity-node-id))
1023               )
1024             )
1025           (let ((rest mime-view-following-required-fields-list))
1026             (while rest
1027               (let ((field-name (car rest)))
1028                 (or (std11-field-body field-name)
1029                     (insert
1030                      (format
1031                       (concat field-name
1032                               ": "
1033                               (save-excursion
1034                                 (set-buffer the-buf)
1035                                 (set-buffer mime-mother-buffer)
1036                                 (set-buffer mime-raw-buffer)
1037                                 (std11-field-body field-name)
1038                                 )
1039                               "\n")))
1040                     ))
1041               (setq rest (cdr rest))
1042               ))
1043           (eword-decode-header)
1044           )
1045         (let ((f (cdr (assq mode mime-view-following-method-alist))))
1046           (if (functionp f)
1047               (funcall f new-buf)
1048             (message
1049              (format
1050               "Sorry, following method for %s is not implemented yet."
1051               mode))
1052             ))
1053         ))))
1054
1055
1056 ;;; @@ X-Face
1057 ;;;
1058
1059 (defun mime-preview-display-x-face ()
1060   (interactive)
1061   (save-window-excursion
1062     (set-buffer mime-raw-buffer)
1063     (mime-view-x-face-function)
1064     ))
1065
1066
1067 ;;; @@ moving
1068 ;;;
1069
1070 (defun mime-preview-move-to-upper ()
1071   "Move to upper entity.
1072 If there is no upper entity, call function `mime-preview-quit'."
1073   (interactive)
1074   (let (cinfo)
1075     (while (null (setq cinfo
1076                        (get-text-property (point) 'mime-view-entity)))
1077       (backward-char)
1078       )
1079     (let ((r (mime-raw-find-entity-from-node-id
1080               (cdr (mime-entity-node-id cinfo))
1081               (get-text-property 1 'mime-view-entity)))
1082           point)
1083       (catch 'tag
1084         (while (setq point (previous-single-property-change
1085                             (point) 'mime-view-entity))
1086           (goto-char point)
1087           (if (eq r (get-text-property (point) 'mime-view-entity))
1088               (throw 'tag t)
1089             )
1090           )
1091         (mime-preview-quit)
1092         ))))
1093
1094 (defun mime-preview-move-to-previous ()
1095   "Move to previous entity.
1096 If there is no previous entity, it calls function registered in
1097 variable `mime-view-over-to-previous-method-alist'."
1098   (interactive)
1099   (while (null (get-text-property (point) 'mime-view-entity))
1100     (backward-char)
1101     )
1102   (let ((point
1103          (previous-single-property-change (point) 'mime-view-entity)))
1104     (if point
1105         (goto-char point)
1106       (let ((f (assq mime-preview-original-major-mode
1107                      mime-view-over-to-previous-method-alist)))
1108         (if f
1109             (funcall (cdr f))
1110           ))
1111       )))
1112
1113 (defun mime-preview-move-to-next ()
1114   "Move to next entity.
1115 If there is no previous entity, it calls function registered in
1116 variable `mime-view-over-to-next-method-alist'."
1117   (interactive)
1118   (let ((point (next-single-property-change (point) 'mime-view-entity)))
1119     (if point
1120         (goto-char point)
1121       (let ((f (assq mime-preview-original-major-mode
1122                      mime-view-over-to-next-method-alist)))
1123         (if f
1124             (funcall (cdr f))
1125           ))
1126       )))
1127
1128 (defun mime-preview-scroll-up-entity (&optional h)
1129   "Scroll up current entity.
1130 If reached to (point-max), it calls function registered in variable
1131 `mime-view-over-to-next-method-alist'."
1132   (interactive)
1133   (or h
1134       (setq h (1- (window-height)))
1135       )
1136   (if (= (point) (point-max))
1137       (let ((f (assq mime-preview-original-major-mode
1138                      mime-view-over-to-next-method-alist)))
1139         (if f
1140             (funcall (cdr f))
1141           ))
1142     (let ((point
1143            (or (next-single-property-change (point) 'mime-view-entity)
1144                (point-max))))
1145       (forward-line h)
1146       (if (> (point) point)
1147           (goto-char point)
1148         )
1149       )))
1150
1151 (defun mime-preview-scroll-down-entity (&optional h)
1152   "Scroll down current entity.
1153 If reached to (point-min), it calls function registered in variable
1154 `mime-view-over-to-previous-method-alist'."
1155   (interactive)
1156   (or h
1157       (setq h (1- (window-height)))
1158       )
1159   (if (= (point) (point-min))
1160       (let ((f (assq mime-preview-original-major-mode
1161                      mime-view-over-to-previous-method-alist)))
1162         (if f
1163             (funcall (cdr f))
1164           ))
1165     (let (point)
1166       (save-excursion
1167         (catch 'tag
1168           (while (> (point) 1)
1169             (if (setq point
1170                       (previous-single-property-change (point)
1171                                                        'mime-view-entity))
1172                 (throw 'tag t)
1173               )
1174             (backward-char)
1175             )
1176           (setq point (point-min))
1177           ))
1178       (forward-line (- h))
1179       (if (< (point) point)
1180           (goto-char point)
1181         ))))
1182
1183 (defun mime-preview-next-line-entity ()
1184   (interactive)
1185   (mime-preview-scroll-up-entity 1)
1186   )
1187
1188 (defun mime-preview-previous-line-entity ()
1189   (interactive)
1190   (mime-preview-scroll-down-entity 1)
1191   )
1192
1193
1194 ;;; @@ quitting
1195 ;;;
1196
1197 (defun mime-preview-quit ()
1198   "Quit from MIME-preview buffer.
1199 It calls function registered in variable
1200 `mime-preview-quitting-method-alist'."
1201   (interactive)
1202   (let ((r (assq mime-preview-original-major-mode
1203                  mime-preview-quitting-method-alist)))
1204     (if r
1205         (funcall (cdr r))
1206       )))
1207
1208 (defun mime-preview-show-summary ()
1209   "Show summary.
1210 It calls function registered in variable
1211 `mime-view-show-summary-method'."
1212   (interactive)
1213   (let ((r (assq mime-preview-original-major-mode
1214                  mime-view-show-summary-method)))
1215     (if r
1216         (funcall (cdr r))
1217       )))
1218
1219 (defun mime-preview-kill-buffer ()
1220   (interactive)
1221   (kill-buffer (current-buffer))
1222   )
1223
1224
1225 ;;; @ end
1226 ;;;
1227
1228 (provide 'mime-view)
1229
1230 (run-hooks 'mime-view-load-hook)
1231
1232 ;;; mime-view.el ends here