mime-view.el

   1 ;;; mime-view.el --- interactive MIME viewer for GNU Emacs
   2
   3 ;; Copyright (C) 1995,96,97,98,99,2000 Free Software Foundation, Inc.
   4
   5 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
   6 ;; Created: 1994/07/13
   7 ;;      Renamed: 1994/08/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 (Sample of Elastic 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 'mime)
  31 (require 'semi-def)
  32 (require 'calist)
  33 (require 'alist)
  34 (require 'mime-conf)
  35 (require 'mcharset)
  36
  37 (eval-when-compile (require 'static))
  38
  39
  40 ;;; @ version
  41 ;;;
  42
  43 (defconst mime-view-version
  44   (concat (mime-product-name mime-user-interface-product) " MIME-View "
  45           (mapconcat #'number-to-string
  46                      (mime-product-version mime-user-interface-product) ".")
  47           " (" (mime-product-code-name mime-user-interface-product) ")"))
  48
  49
  50 ;;; @ variables
  51 ;;;
  52
  53 (defgroup mime-view nil
  54   "MIME view mode"
  55   :group 'mime)
  56
  57 (defcustom mime-situation-examples-file "~/.mime-example"
  58   "*File name of situation-examples demonstrated by user."
  59   :group 'mime-view
  60   :type 'file)
  61
  62 (defcustom mime-preview-move-scroll nil
  63   "*Decides whether to scroll when moving to next entity.
  64 When t, scroll the buffer. Non-nil but not t means scroll when
  65 the next entity is within next-screen-context-lines from top or
  66 buttom. Nil means don't scroll at all."
  67   :group 'mime-view
  68   :type '(choice (const :tag "Off" nil)
  69                  (const :tag "On" t)
  70                  (sexp :tag "Situation" 1)))
  71
  72 (defcustom mime-view-mailcap-files
  73   (let ((files '("/etc/mailcap" "/usr/etc/mailcap" "~/.mailcap")))
  74     (or (member mime-mailcap-file files)
  75         (setq files (cons mime-mailcap-file files)))
  76     files)
  77   "List of mailcap files."
  78   :group 'mime-view
  79   :type '(repeat file))
  80
  81 (defvar mime-view-automatic-conversion 'undecided)
  82
  83
  84 ;;; @ in raw-buffer (representation space)
  85 ;;;
  86
  87 (defvar mime-preview-buffer nil
  88   "MIME-preview buffer corresponding with the (raw) buffer.")
  89 (make-variable-buffer-local 'mime-preview-buffer)
  90
  91
  92 (defvar mime-raw-representation-type-alist
  93   '((mime-show-message-mode     . binary)
  94     (mime-temp-message-mode     . binary)
  95     (t                          . cooked))
  96   "Alist of major-mode vs. representation-type of mime-raw-buffer.
  97 Each element looks like (SYMBOL . REPRESENTATION-TYPE).  SYMBOL is
  98 major-mode or t.  t means default.  REPRESENTATION-TYPE must be
  99 `binary' or `cooked'.")
 100
 101
 102 ;;; @ in preview-buffer (presentation space)
 103 ;;;
 104
 105 (defvar mime-mother-buffer nil
 106   "Mother buffer corresponding with the (MIME-preview) buffer.
 107 If current MIME-preview buffer is generated by other buffer, such as
 108 message/partial, it is called `mother-buffer'.")
 109 (make-variable-buffer-local 'mime-mother-buffer)
 110
 111 ;; (defvar mime-raw-buffer nil
 112 ;;   "Raw buffer corresponding with the (MIME-preview) buffer.")
 113 ;; (make-variable-buffer-local 'mime-raw-buffer)
 114
 115 (defvar mime-preview-original-window-configuration nil
 116   "Window-configuration before mime-view-mode is called.")
 117 (make-variable-buffer-local 'mime-preview-original-window-configuration)
 118
 119 (defun mime-preview-original-major-mode (&optional recursive point)
 120   "Return major-mode of original buffer.
 121 If optional argument RECURSIVE is non-nil and current buffer has
 122 mime-mother-buffer, it returns original major-mode of the
 123 mother-buffer."
 124   (if (and recursive mime-mother-buffer)
 125       (save-excursion
 126         (set-buffer mime-mother-buffer)
 127         (mime-preview-original-major-mode recursive))
 128     (cdr (assq 'major-mode
 129                (get-text-property (or point
 130                                       (if (> (point) (buffer-size))
 131                                           (max (1- (point-max)) (point-min))
 132                                         (point)))
 133                                   'mime-view-situation)))))
 134
 135
 136 ;;; @ entity information
 137 ;;;
 138
 139 (defun mime-entity-situation (entity &optional situation)
 140   "Return situation of ENTITY."
 141   (let (rest param name)
 142     ;; Content-Type
 143     (unless (assq 'type situation)
 144       (setq rest (or (mime-entity-content-type entity)
 145                      (make-mime-content-type 'text 'plain))
 146             situation (cons (car rest) situation)
 147             rest (cdr rest)))
 148     (unless (assq 'subtype situation)
 149       (or rest
 150           (setq rest (or (cdr (mime-entity-content-type entity))
 151                          '((subtype . plain)))))
 152       (setq situation (cons (car rest) situation)
 153             rest (cdr rest)))
 154     (while rest
 155       (setq param (car rest))
 156       (or (assoc (car param) situation)
 157           (setq situation (cons param situation)))
 158       (setq rest (cdr rest)))
 159
 160     ;; Content-Disposition
 161     (setq rest nil)
 162     (unless (assq 'disposition-type situation)
 163       (setq rest (mime-entity-content-disposition entity))
 164       (if rest
 165           (setq situation (cons (cons 'disposition-type
 166                                       (mime-content-disposition-type rest))
 167                                 situation)
 168                 rest (mime-content-disposition-parameters rest))))
 169     (while rest
 170       (setq param (car rest)
 171             name (car param))
 172       (if (cond ((string= name "filename")
 173                  (if (assq 'filename situation)
 174                      nil
 175                    (setq name 'filename)))
 176                 ((string= name "creation-date")
 177                  (if (assq 'creation-date situation)
 178                      nil
 179                    (setq name 'creation-date)))
 180                 ((string= name "modification-date")
 181                  (if (assq 'modification-date situation)
 182                      nil
 183                    (setq name 'modification-date)))
 184                 ((string= name "read-date")
 185                  (if (assq 'read-date situation)
 186                      nil
 187                    (setq name 'read-date)))
 188                 ((string= name "size")
 189                  (if (assq 'size situation)
 190                      nil
 191                    (setq name 'size)))
 192                 (t (setq name (cons 'disposition name))
 193                    (if (assoc name situation)
 194                        nil
 195                      name)))
 196           (setq situation
 197                 (cons (cons name (cdr param))
 198                       situation)))
 199       (setq rest (cdr rest)))
 200
 201     ;; Content-Transfer-Encoding
 202     (or (assq 'encoding situation)
 203         (setq situation
 204               (cons (cons 'encoding (or (mime-entity-encoding entity)
 205                                         "7bit"))
 206                     situation)))
 207
 208     situation))
 209
 210 (defsubst mime-delq-null-situation (situations field
 211                                                &rest ignored-values)
 212   (let (dest)
 213     (while situations
 214       (let* ((situation (car situations))
 215              (cell (assq field situation)))
 216         (if cell
 217             (or (memq (cdr cell) ignored-values)
 218                 (setq dest (cons situation dest)))))
 219       (setq situations (cdr situations)))
 220     dest))
 221
 222 (defun mime-compare-situation-with-example (situation example)
 223   (let ((example (copy-alist example))
 224         (match 0))
 225     (while situation
 226       (let* ((cell (car situation))
 227              (key (car cell))
 228              (ecell (assoc key example)))
 229         (when ecell
 230           (if (equal cell ecell)
 231               (setq match (1+ match))
 232             (setq example (delq ecell example)))))
 233       (setq situation (cdr situation)))
 234     (cons match example)))
 235
 236 (defun mime-sort-situation (situation)
 237   (sort situation
 238         #'(lambda (a b)
 239             (let ((a-t (car a))
 240                   (b-t (car b))
 241                   (order '((type . 1)
 242                            (subtype . 2)
 243                            (mode . 3)
 244                            (method . 4)
 245                            (major-mode . 5)
 246                            (disposition-type . 6)))
 247                   a-order b-order)
 248               (if (symbolp a-t)
 249                   (let ((ret (assq a-t order)))
 250                     (if ret
 251                         (setq a-order (cdr ret))
 252                       (setq a-order 7)))
 253                 (setq a-order 8))
 254               (if (symbolp b-t)
 255                   (let ((ret (assq b-t order)))
 256                     (if ret
 257                         (setq b-order (cdr ret))
 258                       (setq b-order 7)))
 259                 (setq b-order 8))
 260               (if (= a-order b-order)
 261                   (string< (format "%s" a-t)(format "%s" b-t))
 262                 (< a-order b-order))))))
 263
 264 (defun mime-unify-situations (entity-situation
 265                               condition situation-examples
 266                               &optional required-name ignored-value
 267                               every-situations)
 268   (let (ret)
 269     (in-calist-package 'mime-view)
 270     (setq ret
 271           (ctree-find-calist condition entity-situation
 272                              every-situations))
 273     (if required-name
 274         (setq ret (mime-delq-null-situation ret required-name
 275                                             ignored-value t)))
 276     (or (assq 'ignore-examples entity-situation)
 277         (if (cdr ret)
 278             (let ((rest ret)
 279                   (max-score 0)
 280                   (max-escore 0)
 281                   max-examples
 282                   max-situations)
 283               (while rest
 284                 (let ((situation (car rest))
 285                       (examples situation-examples))
 286                   (while examples
 287                     (let* ((ret
 288                             (mime-compare-situation-with-example
 289                              situation (caar examples)))
 290                            (ret-score (car ret)))
 291                       (cond ((> ret-score max-score)
 292                              (setq max-score ret-score
 293                                    max-escore (cdar examples)
 294                                    max-examples (list (cdr ret))
 295                                    max-situations (list situation)))
 296                             ((= ret-score max-score)
 297                              (cond ((> (cdar examples) max-escore)
 298                                     (setq max-escore (cdar examples)
 299                                           max-examples (list (cdr ret))
 300                                           max-situations (list situation)))
 301                                    ((= (cdar examples) max-escore)
 302                                     (setq max-examples
 303                                           (cons (cdr ret) max-examples))
 304                                     (or (member situation max-situations)
 305                                         (setq max-situations
 306                                               (cons situation max-situations))))))))
 307                     (setq examples (cdr examples))))
 308                 (setq rest (cdr rest)))
 309               (when max-situations
 310                 (setq ret max-situations)
 311                 (while max-examples
 312                   (let* ((example (car max-examples))
 313                          (cell
 314                           (assoc example situation-examples)))
 315                     (if cell
 316                         (setcdr cell (1+ (cdr cell)))
 317                       (setq situation-examples
 318                             (cons (cons example 0)
 319                                   situation-examples))))
 320                   (setq max-examples (cdr max-examples)))))))
 321     (cons ret situation-examples)
 322     ;; ret: list of situations
 323     ;; situation-examples: new examples (notoce that contents of
 324     ;;                     argument `situation-examples' has bees modified)
 325     ))
 326
 327 (defun mime-view-entity-title (entity)
 328   (or (mime-entity-read-field entity 'Content-Description)
 329       (mime-entity-read-field entity 'Subject)
 330       (mime-entity-filename entity)
 331       ""))
 332
 333 (defvar mime-preview-situation-example-list nil)
 334 (defvar mime-preview-situation-example-list-max-size 16)
 335 ;; (defvar mime-preview-situation-example-condition nil)
 336
 337 (defun mime-find-entity-preview-situation (entity
 338                                            &optional default-situation)
 339   (or (let ((ret
 340              (mime-unify-situations
 341               (append (mime-entity-situation entity)
 342                       default-situation)
 343               mime-preview-condition
 344               mime-preview-situation-example-list)))
 345         (setq mime-preview-situation-example-list
 346               (cdr ret))
 347         (caar ret))
 348       default-situation))
 349
 350
 351 (defvar mime-acting-situation-example-list nil)
 352 (defvar mime-acting-situation-example-list-max-size 16)
 353 (defvar mime-situation-examples-file-coding-system nil)
 354
 355 (defun mime-view-read-situation-examples-file (&optional file)
 356   (or file
 357       (setq file mime-situation-examples-file))
 358   (if (and file
 359            (file-readable-p file))
 360       (with-temp-buffer
 361         (insert-file-contents file)
 362         (setq mime-situation-examples-file-coding-system
 363               (static-cond
 364                ((boundp 'buffer-file-coding-system)
 365                 (symbol-value 'buffer-file-coding-system))
 366                ((boundp 'file-coding-system)
 367                 (symbol-value 'file-coding-system))
 368                (t nil))
 369               ;; (and (boundp 'buffer-file-coding-system)
 370               ;;      buffer-file-coding-system)
 371               )
 372         (condition-case error
 373             (eval-buffer)
 374           (error (message "%s is broken: %s" file (cdr error))))
 375         ;; format check
 376         (condition-case nil
 377             (let ((i 0))
 378               (while (and (> (length mime-preview-situation-example-list)
 379                              mime-preview-situation-example-list-max-size)
 380                           (< i 16))
 381                 (setq mime-preview-situation-example-list
 382                       (mime-reduce-situation-examples
 383                        mime-preview-situation-example-list))
 384                 (setq i (1+ i))))
 385           (error (setq mime-preview-situation-example-list nil)))
 386         ;; (let ((rest mime-preview-situation-example-list))
 387         ;;   (while rest
 388         ;;     (ctree-set-calist-strictly 'mime-preview-condition
 389         ;;                                (caar rest))
 390         ;;     (setq rest (cdr rest))))
 391         (condition-case nil
 392             (let ((i 0))
 393               (while (and (> (length mime-acting-situation-example-list)
 394                              mime-acting-situation-example-list-max-size)
 395                           (< i 16))
 396                 (setq mime-acting-situation-example-list
 397                       (mime-reduce-situation-examples
 398                        mime-acting-situation-example-list))
 399                 (setq i (1+ i))))
 400           (error (setq mime-acting-situation-example-list nil))))))
 401
 402 (defun mime-save-situation-examples ()
 403   (if (or mime-preview-situation-example-list
 404           mime-acting-situation-example-list)
 405       (let ((file mime-situation-examples-file)
 406             print-length print-level)
 407         (with-temp-buffer
 408           (insert ";;; " (file-name-nondirectory file) "\n")
 409           (insert "\n;; This file is generated automatically by "
 410                   mime-view-version "\n\n")
 411           (insert ";;; Code:\n\n")
 412           (if mime-preview-situation-example-list
 413               (pp `(setq mime-preview-situation-example-list
 414                          ',mime-preview-situation-example-list)
 415                   (current-buffer)))
 416           (if mime-acting-situation-example-list
 417               (pp `(setq mime-acting-situation-example-list
 418                          ',mime-acting-situation-example-list)
 419                   (current-buffer)))
 420           (insert "\n;;; "
 421                   (file-name-nondirectory file)
 422                   " ends here.\n")
 423           (static-cond
 424            ((boundp 'buffer-file-coding-system)
 425             (setq buffer-file-coding-system
 426                   mime-situation-examples-file-coding-system))
 427            ((boundp 'file-coding-system)
 428             (setq file-coding-system
 429                   mime-situation-examples-file-coding-system)))
 430           ;; (setq buffer-file-coding-system
 431           ;;       mime-situation-examples-file-coding-system)
 432           (setq buffer-file-name file)
 433           (save-buffer)))))
 434
 435 (add-hook 'kill-emacs-hook 'mime-save-situation-examples)
 436
 437 (defun mime-reduce-situation-examples (situation-examples)
 438   (let ((len (length situation-examples))
 439         i ir ic j jr jc ret
 440         dest d-i d-j
 441         (max-sim 0) sim
 442         min-det-ret det-ret
 443         min-det-org det-org
 444         min-freq freq)
 445     (setq i 0
 446           ir situation-examples)
 447     (while (< i len)
 448       (setq ic (car ir)
 449             j 0
 450             jr situation-examples)
 451       (while (< j len)
 452         (unless (= i j)
 453           (setq jc (car jr))
 454           (setq ret (mime-compare-situation-with-example (car ic)(car jc))
 455                 sim (car ret)
 456                 det-ret (+ (length (car ic))(length (car jc)))
 457                 det-org (length (cdr ret))
 458                 freq (+ (cdr ic)(cdr jc)))
 459           (cond ((< max-sim sim)
 460                  (setq max-sim sim
 461                        min-det-ret det-ret
 462                        min-det-org det-org
 463                        min-freq freq
 464                        d-i i
 465                        d-j j
 466                        dest (cons (cdr ret) freq)))
 467                 ((= max-sim sim)
 468                  (cond ((> min-det-ret det-ret)
 469                         (setq min-det-ret det-ret
 470                               min-det-org det-org
 471                               min-freq freq
 472                               d-i i
 473                               d-j j
 474                               dest (cons (cdr ret) freq)))
 475                        ((= min-det-ret det-ret)
 476                         (cond ((> min-det-org det-org)
 477                                (setq min-det-org det-org
 478                                      min-freq freq
 479                                      d-i i
 480                                      d-j j
 481                                      dest (cons (cdr ret) freq)))
 482                               ((= min-det-org det-org)
 483                                (cond ((> min-freq freq)
 484                                       (setq min-freq freq
 485                                             d-i i
 486                                             d-j j
 487                                             dest (cons (cdr ret) freq)))))))))))
 488         (setq jr (cdr jr)
 489               j (1+ j)))
 490       (setq ir (cdr ir)
 491             i (1+ i)))
 492     (if (> d-i d-j)
 493         (setq i d-i
 494               d-i d-j
 495               d-j i))
 496     (setq jr (nthcdr (1- d-j) situation-examples))
 497     (setcdr jr (cddr jr))
 498     (if (= d-i 0)
 499         (setq situation-examples
 500               (cdr situation-examples))
 501       (setq ir (nthcdr (1- d-i) situation-examples))
 502       (setcdr ir (cddr ir)))
 503     (if (setq ir (assoc (car dest) situation-examples))
 504         (progn
 505           (setcdr ir (+ (cdr ir)(cdr dest)))
 506           situation-examples)
 507       (cons dest situation-examples)
 508       ;; situation-examples may be modified.
 509       )))
 510
 511
 512 ;;; @ presentation of preview
 513 ;;;
 514
 515 ;;; @@ entity-button
 516 ;;;
 517
 518 ;;; @@@ predicate function
 519 ;;;
 520
 521 ;; (defun mime-view-entity-button-visible-p (entity)
 522 ;;   "Return non-nil if header of ENTITY is visible.
 523 ;; Please redefine this function if you want to change default setting."
 524 ;;   (let ((media-type (mime-entity-media-type entity))
 525 ;;         (media-subtype (mime-entity-media-subtype entity)))
 526 ;;     (or (not (eq media-type 'application))
 527 ;;         (and (not (eq media-subtype 'x-selection))
 528 ;;              (or (not (eq media-subtype 'octet-stream))
 529 ;;                  (let ((mother-entity (mime-entity-parent entity)))
 530 ;;                    (or (not (eq (mime-entity-media-type mother-entity)
 531 ;;                                 'multipart))
 532 ;;                        (not (eq (mime-entity-media-subtype mother-entity)
 533 ;;                                 'encrypted)))
 534 ;;                    )
 535 ;;                  )))))
 536
 537 ;;; @@@ entity button generator
 538 ;;;
 539
 540 (defun mime-view-insert-entity-button (entity)
 541   "Insert entity-button of ENTITY."
 542   (let ((entity-node-id (mime-entity-node-id entity))
 543         (params (mime-entity-parameters entity))
 544         (subject (mime-view-entity-title entity)))
 545     (mime-insert-button
 546      (let ((access-type (assoc "access-type" params))
 547            (num (or (cdr (assoc "x-part-number" params))
 548                     (if (consp entity-node-id)
 549                         (mapconcat (function
 550                                     (lambda (num)
 551                                       (format "%s" (1+ num))))
 552                                    (reverse entity-node-id) ".")
 553                       "0"))))
 554        (cond (access-type
 555               (let ((server (assoc "server" params)))
 556                 (setq access-type (cdr access-type))
 557                 (if server
 558                     (format "%s %s ([%s] %s)"
 559                             num subject access-type (cdr server))
 560                 (let ((site (cdr (assoc "site" params)))
 561                       (dir (cdr (assoc "directory" params)))
 562                       (url (cdr (assoc "url" params))))
 563                   (if url
 564                       (format "%s %s ([%s] %s)"
 565                               num subject access-type url)
 566                     (format "%s %s ([%s] %s:%s)"
 567                             num subject access-type site dir))))))
 568            (t
 569             (let ((media-type (mime-entity-media-type entity))
 570                   (media-subtype (mime-entity-media-subtype entity))
 571                   (charset (cdr (assoc "charset" params)))
 572                   (encoding (mime-entity-encoding entity)))
 573               (concat
 574                num " " subject
 575                (let ((rest
 576                       (format " <%s/%s%s%s>"
 577                               media-type media-subtype
 578                               (if charset
 579                                   (concat "; " charset)
 580                                 "")
 581                               (if encoding
 582                                   (concat " (" encoding ")")
 583                                 ""))))
 584                  (if (>= (+ (current-column)(length rest))(window-width))
 585                      "\n\t")
 586                  rest))))))
 587      (function mime-preview-play-current-entity))))
 588
 589
 590 ;;; @@ entity-header
 591 ;;;
 592
 593 (defvar mime-header-presentation-method-alist nil
 594   "Alist of major mode vs. corresponding header-presentation-method functions.
 595 Each element looks like (SYMBOL . FUNCTION).
 596 SYMBOL must be major mode in raw-buffer or t.  t means default.
 597 Interface of FUNCTION must be (ENTITY SITUATION).")
 598
 599 (defvar mime-view-ignored-field-list
 600   '(".*Received:" ".*Path:" ".*Id:" "^References:"
 601     "^Replied:" "^Errors-To:"
 602     "^Lines:" "^Sender:" ".*Host:" "^Xref:"
 603     "^Content-Type:" "^Precedence:"
 604     "^Status:" "^X-VM-.*:")
 605   "All fields that match this list will be hidden in MIME preview buffer.
 606 Each elements are regexp of field-name.")
 607
 608 (defvar mime-view-visible-field-list '("^Dnas.*:" "^Message-Id:")
 609   "All fields that match this list will be displayed in MIME preview buffer.
 610 Each elements are regexp of field-name.")
 611
 612
 613 ;;; @@ entity-body
 614 ;;;
 615
 616 ;;; @@@ predicate function
 617 ;;;
 618
 619 (in-calist-package 'mime-view)
 620
 621 (defun mime-calist::field-match-method-as-default-rule (calist
 622                                                         field-type field-value)
 623   (let ((s-field (assq field-type calist)))
 624     (cond ((null s-field)
 625            (cons (cons field-type field-value) calist))
 626           (t calist))))
 627
 628 (define-calist-field-match-method
 629   'header #'mime-calist::field-match-method-as-default-rule)
 630
 631 (define-calist-field-match-method
 632   'body #'mime-calist::field-match-method-as-default-rule)
 633
 634
 635 (defvar mime-preview-condition nil
 636   "Condition-tree about how to display entity.")
 637
 638 (ctree-set-calist-strictly
 639  'mime-preview-condition '((type . application)(subtype . octet-stream)
 640                            (encoding . nil)
 641                            (body . visible)))
 642 (ctree-set-calist-strictly
 643  'mime-preview-condition '((type . application)(subtype . octet-stream)
 644                            (encoding . "7bit")
 645                            (body . visible)))
 646 (ctree-set-calist-strictly
 647  'mime-preview-condition '((type . application)(subtype . octet-stream)
 648                            (encoding . "8bit")
 649                            (body . visible)))
 650
 651 (ctree-set-calist-strictly
 652  'mime-preview-condition '((type . application)(subtype . pgp)
 653                            (body . visible)))
 654
 655 (ctree-set-calist-strictly
 656  'mime-preview-condition '((type . application)(subtype . x-latex)
 657                            (body . visible)))
 658
 659 (ctree-set-calist-strictly
 660  'mime-preview-condition '((type . application)(subtype . x-selection)
 661                            (body . visible)))
 662
 663 (ctree-set-calist-strictly
 664  'mime-preview-condition '((type . application)(subtype . x-comment)
 665                            (body . visible)))
 666
 667 (ctree-set-calist-strictly
 668  'mime-preview-condition '((type . message)(subtype . delivery-status)
 669                            (body . visible)))
 670
 671 (ctree-set-calist-strictly
 672  'mime-preview-condition
 673  '((body . visible)
 674    (body-presentation-method . mime-display-text/plain)))
 675
 676 (defvar mime-preview-fill-flowed-text
 677   (module-installed-p 'flow-fill)
 678   "If non-nil, fill RFC2646 \"flowed\" text.")
 679
 680 (autoload 'fill-flowed "flow-fill")
 681
 682 (defvar mime-preview-inline-fontify t
 683   "If non-nil, fontify the inline part.")
 684
 685 (ctree-set-calist-strictly
 686  'mime-preview-condition
 687  '((type . nil)
 688    (body . visible)
 689    (body-presentation-method . mime-display-text/plain)))
 690
 691 (ctree-set-calist-strictly
 692  'mime-preview-condition
 693  '((type . text)(subtype . enriched)
 694    (body . visible)
 695    (body-presentation-method . mime-display-text/enriched)))
 696
 697 (ctree-set-calist-strictly
 698  'mime-preview-condition
 699  '((type . text)(subtype . richtext)
 700    (body . visible)
 701    (body-presentation-method . mime-display-text/richtext)))
 702
 703 (autoload 'mime-display-application/x-postpet "postpet")
 704
 705 (ctree-set-calist-strictly
 706  'mime-preview-condition
 707  '((type . application)(subtype . x-postpet)
 708    (body . visible)
 709    (body-presentation-method . mime-display-application/x-postpet)))
 710
 711 (ctree-set-calist-strictly
 712  'mime-preview-condition
 713  '((type . application)(subtype . emacs-lisp)
 714    (body . visible)
 715    (body-presentation-method . mime-display-application/emacs-lisp)))
 716
 717 (ctree-set-calist-strictly
 718  'mime-preview-condition
 719  '((type . text)(subtype . t)
 720    (body . visible)
 721    (body-presentation-method . mime-display-text/plain)))
 722
 723 (ctree-set-calist-strictly
 724  'mime-preview-condition
 725  '((type . multipart)(subtype . alternative)
 726    (body . visible)
 727    (body-presentation-method . mime-display-multipart/alternative)))
 728
 729 (ctree-set-calist-strictly
 730  'mime-preview-condition
 731  '((type . multipart)(subtype . related)
 732    (body . visible)
 733    (body-presentation-method . mime-display-multipart/related)))
 734
 735 (ctree-set-calist-strictly
 736  'mime-preview-condition
 737  '((type . multipart)(subtype . t)
 738    (body . visible)
 739    (body-presentation-method . mime-display-multipart/mixed)))
 740
 741 (ctree-set-calist-strictly
 742  'mime-preview-condition
 743  '((type . message)(subtype . partial)
 744    (body . visible)
 745    (body-presentation-method . mime-display-message/partial-button)))
 746
 747 (ctree-set-calist-strictly
 748  'mime-preview-condition
 749  '((type . message)(subtype . rfc822)
 750    (body . visible)
 751    (body-presentation-method . mime-display-multipart/mixed)
 752    (childrens-situation (header . visible)
 753                         (entity-button . invisible))))
 754
 755 (ctree-set-calist-strictly
 756  'mime-preview-condition
 757  '((type . message)(subtype . news)
 758    (body . visible)
 759    (body-presentation-method . mime-display-multipart/mixed)
 760    (childrens-situation (header . visible)
 761                         (entity-button . invisible))))
 762
 763
 764 ;;; @@@ entity presentation
 765 ;;;
 766
 767 (defun mime-display-text/plain (entity situation)
 768   (save-restriction
 769     (narrow-to-region (point-max)(point-max))
 770     (condition-case nil
 771         (if (and mime-preview-inline-fontify
 772                  (mime-entity-filename entity)) ;should be an attachment.
 773             (mime-view-insert-fontified-text-content entity situation)
 774           (mime-view-insert-text-content entity situation))
 775       (error (progn
 776                (message "Can't decode current entity.")
 777                (sit-for 1))))
 778     (run-hooks 'mime-text-decode-hook)
 779     (goto-char (point-max))
 780     (if (not (eq (char-after (1- (point))) ?\n))
 781         (insert "\n"))
 782     (if (and mime-preview-fill-flowed-text
 783              (equal (cdr (assoc "format" situation)) "flowed"))
 784         (fill-flowed))
 785     (mime-add-url-buttons)
 786     (run-hooks 'mime-display-text/plain-hook)))
 787
 788 (defun mime-display-text/richtext (entity situation)
 789   (save-restriction
 790     (narrow-to-region (point-max)(point-max))
 791     (mime-view-insert-text-content entity situation)
 792     (run-hooks 'mime-text-decode-hook)
 793     (let ((beg (point-min)))
 794       (remove-text-properties beg (point-max) '(face nil))
 795       (richtext-decode beg (point-max)))))
 796
 797 (defun mime-display-text/enriched (entity situation)
 798   (save-restriction
 799     (narrow-to-region (point-max)(point-max))
 800     (mime-view-insert-text-content entity situation)
 801     (run-hooks 'mime-text-decode-hook)
 802     (let ((beg (point-min)))
 803       (remove-text-properties beg (point-max) '(face nil))
 804       (enriched-decode beg (point-max)))))
 805
 806 (defvar mime-view-announcement-for-message/partial
 807   "This is message/partial style split message.")
 808
 809 (defun mime-display-message/partial-button (&optional entity situation)
 810   (save-restriction
 811     (goto-char (point-max))
 812     (if (not (search-backward "\n\n" nil t))
 813         (insert "\n"))
 814     (goto-char (point-max))
 815     (mime-insert-button mime-view-announcement-for-message/partial
 816                         #'mime-preview-play-current-entity)))
 817
 818 (defun mime-display-multipart/mixed (entity situation)
 819   (let ((children (mime-entity-children entity))
 820         (original-major-mode-cell (assq 'major-mode situation))
 821         (default-situation
 822           (cdr (assq 'childrens-situation situation))))
 823     (if original-major-mode-cell
 824         (setq default-situation
 825               (cons original-major-mode-cell default-situation)))
 826     (while children
 827       (mime-display-entity (car children) nil default-situation)
 828       (setq children (cdr children)))))
 829
 830 (defcustom mime-view-type-subtype-score-alist
 831   '(((text . enriched) . 3)
 832     ((text . richtext) . 2)
 833     ((text . plain)    . 1)
 834     (t . 0))
 835   "Alist MEDIA-TYPE vs corresponding score.
 836 MEDIA-TYPE must be (TYPE . SUBTYPE), TYPE or t.  t means default."
 837   :group 'mime-view
 838   :type '(repeat (cons (choice :tag "Media-Type"
 839                                (cons :tag "Type/Subtype"
 840                                      (symbol :tag "Primary-type")
 841                                      (symbol :tag "Subtype"))
 842                                (symbol :tag "Type")
 843                                (const :tag "Default" t))
 844                        integer)))
 845
 846 (defun mime-display-multipart/alternative (entity situation)
 847   (let* ((children (mime-entity-children entity))
 848          (original-major-mode-cell (assq 'major-mode situation))
 849          (default-situation
 850            (cdr (assq 'childrens-situation situation)))
 851          (i 0)
 852          (p 0)
 853          (max-score 0)
 854          situations)
 855     (if original-major-mode-cell
 856         (setq default-situation
 857               (cons original-major-mode-cell default-situation)))
 858     (setq situations
 859           (mapcar (function
 860                    (lambda (child)
 861                      (let ((situation
 862                             (mime-find-entity-preview-situation
 863                              child default-situation)))
 864                        (if (cdr (assq 'body-presentation-method situation))
 865                            (let ((score
 866                                   (cdr
 867                                    (or (assoc
 868                                         (cons
 869                                          (cdr (assq 'type situation))
 870                                          (cdr (assq 'subtype situation)))
 871                                         mime-view-type-subtype-score-alist)
 872                                        (assq
 873                                         (cdr (assq 'type situation))
 874                                         mime-view-type-subtype-score-alist)
 875                                        (assq
 876                                         t
 877                                         mime-view-type-subtype-score-alist)))))
 878                              (if (> score max-score)
 879                                  (setq p i
 880                                        max-score score))))
 881                        (setq i (1+ i))
 882                        situation)))
 883                   children))
 884     (setq i 0)
 885     (while children
 886       (let ((child (car children))
 887             (situation (car situations)))
 888         (mime-display-entity child (if (= i p)
 889                                        situation
 890                                      (put-alist 'body 'invisible
 891                                                 (copy-alist situation)))))
 892       (setq children (cdr children)
 893             situations (cdr situations)
 894             i (1+ i)))))
 895
 896 (defun mime-display-multipart/related (entity situation)
 897   (let* ((param-start (mime-parse-msg-id
 898                        (std11-lexical-analyze
 899                         (cdr (assoc "start"
 900                                     (mime-content-type-parameters
 901                                      (mime-entity-content-type entity)))))))
 902          (start (or (and param-start (mime-find-entity-from-content-id
 903                                       param-start
 904                                       entity))
 905                     (car (mime-entity-children entity))))
 906          (original-major-mode-cell (assq 'major-mode situation))
 907          (default-situation (cdr (assq 'childrens-situation situation))))
 908     (if original-major-mode-cell
 909         (setq default-situation
 910               (cons original-major-mode-cell default-situation)))
 911     (mime-display-entity start nil default-situation)))
 912
 913 (defun mime-view-entity-content (entity situation)
 914   (mime-decode-string
 915    (mime-entity-body entity)
 916    (mime-view-guess-encoding entity situation)))
 917
 918 (defun mime-view-insert-text-content (entity situation)
 919   (let (compression-info)
 920     (cond
 921      ((and (mime-entity-filename entity)
 922            (featurep 'jka-compr)
 923            (jka-compr-installed-p)
 924            (setq compression-info (jka-compr-get-compression-info
 925                                    (mime-entity-filename entity))))
 926       (insert
 927        (mime-view-filter-text-content
 928         (mime-view-entity-content entity situation)
 929         (jka-compr-info-uncompress-program compression-info)
 930         (jka-compr-info-uncompress-args compression-info))))
 931      ((or (assq '*encoding situation)   ;should be specified by user
 932           (assq '*charset situation))   ;should be specified by user
 933       (insert
 934        (decode-mime-charset-string
 935         (mime-view-entity-content entity situation)
 936         (mime-view-guess-charset entity situation)
 937         'CRLF)))
 938      (t
 939       (mime-insert-text-content entity)))))
 940
 941 ;;; stolen (and renamed) from `mime-display-gzipped' of EMY 1.13.
 942 (defun mime-view-filter-text-content (content program args)
 943   (with-temp-buffer
 944     (static-cond
 945      ((featurep 'xemacs)
 946       (insert content)
 947       (apply #'binary-to-text-funcall
 948              mime-view-automatic-conversion
 949              #'call-process-region (point-min)(point-max)
 950              program t t args))
 951      (t
 952       (if (not (multibyte-string-p content))
 953           (set-buffer-multibyte nil))
 954       (insert content)
 955       (apply #'binary-funcall
 956              #'call-process-region (point-min)(point-max)
 957              program t t args)
 958       (set-buffer-multibyte t)
 959       (decode-coding-region (point-min)(point-max)
 960                             mime-view-automatic-conversion)))
 961     (buffer-string)))
 962
 963 ;;; stolen (and renamed) from mm-view.el.
 964 (defun mime-view-insert-fontified-text-content (entity situation
 965                                                        &optional mode)
 966   ;; XEmacs @#$@ version of font-lock refuses to fully turn itself
 967   ;; on for buffers whose name begins with " ".  That's why we use
 968   ;; save-current-buffer/get-buffer-create rather than
 969   ;; with-temp-buffer.
 970   (let ((buffer (generate-new-buffer "*fontification*"))
 971         filename)
 972     (unwind-protect
 973         (progn
 974           (save-current-buffer
 975             (set-buffer buffer)
 976             (buffer-disable-undo)
 977             (kill-all-local-variables)
 978             (mime-view-insert-text-content entity situation)
 979             (if mode
 980                 (funcall mode)
 981               (if (setq filename (mime-entity-filename entity))
 982                   (unwind-protect
 983                       (progn
 984                         (setq buffer-file-name filename)
 985                         (set-auto-mode))
 986                     (setq buffer-file-name nil))))
 987             (require 'font-lock)
 988             (let ((font-lock-verbose nil))
 989               ;; I find font-lock a bit too verbose.
 990               (font-lock-fontify-buffer))
 991             ;; By default, XEmacs font-lock uses non-duplicable text
 992             ;; properties.  This code forces all the text properties
 993             ;; to be copied along with the text.
 994             (static-when (fboundp 'extent-list)
 995               (map-extents (lambda (ext ignored)
 996                              (set-extent-property ext 'duplicable t)
 997                              nil)
 998                            nil nil nil nil nil 'text-prop)))
 999           (insert-buffer-substring buffer))
1000       (kill-buffer buffer))))
1001
1002 (defun mime-display-application/emacs-lisp (entity situation)
1003   (save-restriction
1004     (narrow-to-region (point-max)(point-max))
1005     (mime-view-insert-fontified-text-content entity situation 'emacs-lisp-mode)
1006     (run-hooks 'mime-text-decode-hook 'mime-display-text/plain-hook)))
1007
1008
1009 ;;; @ acting-condition
1010 ;;;
1011
1012 (defvar mime-acting-condition nil
1013   "Condition-tree about how to process entity.")
1014
1015 (defun mime-view-read-mailcap-files (&optional files)
1016   (or files
1017       (setq files mime-view-mailcap-files))
1018   (let (entries file)
1019     (while files
1020       (setq file (car files))
1021       (if (file-readable-p file)
1022           (setq entries (append entries (mime-parse-mailcap-file file))))
1023       (setq files (cdr files)))
1024     (while entries
1025       (let ((entry (car entries))
1026             view print shared)
1027         (while entry
1028           (let* ((field (car entry))
1029                  (field-type (car field)))
1030             (cond ((eq field-type 'view)  (setq view field))
1031                   ((eq field-type 'print) (setq print field))
1032                   ((memq field-type '(compose composetyped edit)))
1033                   (t (setq shared (cons field shared))))
1034             )
1035           (setq entry (cdr entry)))
1036         (setq shared (nreverse shared))
1037         (ctree-set-calist-with-default
1038          'mime-acting-condition
1039          (append shared (list '(mode . "play")(cons 'method (cdr view)))))
1040         (if print
1041             (ctree-set-calist-with-default
1042              'mime-acting-condition
1043              (append shared
1044                      (list '(mode . "print")(cons 'method (cdr view)))))))
1045       (setq entries (cdr entries)))))
1046
1047 (mime-view-read-mailcap-files)
1048
1049 (ctree-set-calist-strictly
1050  'mime-acting-condition
1051  '((type . application)(subtype . octet-stream)
1052    (mode . "play")
1053    (method . mime-detect-content)))
1054
1055 (ctree-set-calist-with-default
1056  'mime-acting-condition
1057  '((mode . "extract")
1058    (method . mime-save-content)))
1059
1060 (ctree-set-calist-strictly
1061  'mime-acting-condition
1062  '((type . text)(subtype . x-rot13-47)(mode . "play")
1063    (method . mime-view-caesar)))
1064 (ctree-set-calist-strictly
1065  'mime-acting-condition
1066  '((type . text)(subtype . x-rot13-47-48)(mode . "play")
1067    (method . mime-view-caesar)))
1068
1069 (ctree-set-calist-strictly
1070  'mime-acting-condition
1071  '((type . message)(subtype . rfc822)(mode . "play")
1072    (method . mime-view-message/rfc822)))
1073 (ctree-set-calist-strictly
1074  'mime-acting-condition
1075  '((type . message)(subtype . partial)(mode . "play")
1076    (method . mime-store-message/partial-piece)))
1077
1078 (ctree-set-calist-strictly
1079  'mime-acting-condition
1080  '((type . message)(subtype . external-body)
1081    ("access-type" . "anon-ftp")
1082    (method . mime-view-message/external-anon-ftp)))
1083
1084 (ctree-set-calist-strictly
1085  'mime-acting-condition
1086  '((type . message)(subtype . external-body)
1087    ("access-type" . "url")
1088    (method . mime-view-message/external-url)))
1089
1090 (ctree-set-calist-strictly
1091  'mime-acting-condition
1092  '((type . application)(subtype . octet-stream)
1093    (method . mime-save-content)))
1094
1095
1096 ;;; @ quitting method
1097 ;;;
1098
1099 (defvar mime-preview-quitting-method-alist
1100   '((mime-show-message-mode
1101      . mime-preview-quitting-method-for-mime-show-message-mode))
1102   "Alist of major-mode vs. quitting-method of mime-view.")
1103
1104 (defvar mime-preview-over-to-previous-method-alist nil
1105   "Alist of major-mode vs. over-to-previous-method of mime-view.")
1106
1107 (defvar mime-preview-over-to-next-method-alist nil
1108   "Alist of major-mode vs. over-to-next-method of mime-view.")
1109
1110
1111 ;;; @ following method
1112 ;;;
1113
1114 (defvar mime-preview-following-method-alist nil
1115   "Alist of major-mode vs. following-method of mime-view.")
1116
1117 (defvar mime-view-following-required-fields-list
1118   '("From"))
1119
1120
1121 ;;; @ buffer setup
1122 ;;;
1123
1124 (defun mime-display-entity (entity &optional situation
1125                                    default-situation preview-buffer)
1126   (or preview-buffer
1127       (setq preview-buffer (current-buffer)))
1128   (let* (e nb ne nhb nbb)
1129     (in-calist-package 'mime-view)
1130     (or situation
1131         (setq situation
1132               (mime-find-entity-preview-situation entity default-situation)))
1133     (let ((button-is-invisible
1134            (eq (cdr (or (assq '*entity-button situation)
1135                         (assq 'entity-button situation)))
1136                'invisible))
1137           (header-is-visible
1138            (eq (cdr (or (assq '*header situation)
1139                         (assq 'header situation)))
1140                'visible))
1141           (body-is-visible
1142            (eq (cdr (or (assq '*body situation)
1143                         (assq 'body situation)))
1144                'visible))
1145           (children (mime-entity-children entity)))
1146       (set-buffer preview-buffer)
1147       (setq nb (point))
1148       (narrow-to-region nb nb)
1149       (or button-is-invisible
1150           ;; (if (mime-view-entity-button-visible-p entity)
1151           (mime-view-insert-entity-button entity)
1152           ;;   )
1153           )
1154       (if header-is-visible
1155           (let ((header-presentation-method
1156                  (or (cdr (assq 'header-presentation-method situation))
1157                      (cdr (assq (cdr (assq 'major-mode situation))
1158                                 mime-header-presentation-method-alist)))))
1159             (setq nhb (point))
1160             (if header-presentation-method
1161                 (funcall header-presentation-method entity situation)
1162               (mime-insert-header entity
1163                                   mime-view-ignored-field-list
1164                                   mime-view-visible-field-list))
1165             (mime-add-url-buttons)
1166             (run-hooks 'mime-display-header-hook)
1167             (put-text-property nhb (point-max) 'mime-view-entity-header entity)
1168             (goto-char (point-max))
1169             (insert "\n")))
1170       (setq nbb (point))
1171       (unless children
1172         (if body-is-visible
1173             (let ((body-presentation-method
1174                    (cdr (assq 'body-presentation-method situation))))
1175               (if (functionp body-presentation-method)
1176                   (funcall body-presentation-method entity situation)
1177                 (mime-display-text/plain entity situation)))
1178           (when button-is-invisible
1179             (goto-char (point-max))
1180             (mime-view-insert-entity-button entity))
1181           (unless header-is-visible
1182             (goto-char (point-max))
1183             (insert "\n"))))
1184       (setq ne (point-max))
1185       (widen)
1186       (put-text-property nb ne 'mime-view-entity entity)
1187       (put-text-property nb ne 'mime-view-situation situation)
1188       (put-text-property nbb ne 'mime-view-entity-body entity)
1189       (goto-char ne)
1190       (if (and children body-is-visible)
1191           (let ((body-presentation-method
1192                  (cdr (assq 'body-presentation-method situation))))
1193             (if (functionp body-presentation-method)
1194                 (funcall body-presentation-method entity situation)
1195               (mime-display-multipart/mixed entity situation)))))))
1196
1197
1198 ;;; @ MIME viewer mode
1199 ;;;
1200
1201 (defconst mime-view-popup-menu-list
1202   '("MIME-View"
1203     ["Move to upper entity" mime-preview-move-to-upper]
1204     ["Move to previous entity" mime-preview-move-to-previous]
1205     ["Move to next entity" mime-preview-move-to-next]
1206     ["Scroll-down" mime-preview-scroll-down-entity]
1207     ["Scroll-up" mime-preview-scroll-up-entity]
1208     ["Play current entity" mime-preview-play-current-entity]
1209     ["Extract current entity" mime-preview-extract-current-entity]
1210     ["Print current entity" mime-preview-print-current-entity])
1211   "Menu for MIME Viewer")
1212
1213 (defun mime-view-popup-menu (event)
1214   "Popup the menu in the MIME Viewer buffer"
1215   (interactive "@e")
1216   (mime-popup-menu-popup mime-view-popup-menu-list event))
1217
1218 ;;; The current local map is taken precendence over `widget-keymap',
1219 ;;; because GNU Emacs' widget implementation doesn't set `local-map' property.
1220 ;;;  So we need to specify derivation.
1221 (defvar widget-keymap)
1222 (defun mime-view-maybe-inherit-widget-keymap ()
1223   (when (boundp 'widget-keymap)
1224     (set-keymap-parent (current-local-map) widget-keymap)))
1225
1226 (add-hook 'mime-view-mode-hook 'mime-view-maybe-inherit-widget-keymap)
1227
1228 (defun mime-view-define-keymap (&optional default)
1229   (let ((mime-view-mode-map (if (keymapp default)
1230                                 (copy-keymap default)
1231                               (make-sparse-keymap))))
1232     (define-key mime-view-mode-map
1233       "u"        (function mime-preview-move-to-upper))
1234     (define-key mime-view-mode-map
1235       "p"        (function mime-preview-move-to-previous))
1236     (define-key mime-view-mode-map
1237       "n"        (function mime-preview-move-to-next))
1238     (define-key mime-view-mode-map
1239       "\e\t"     (function mime-preview-move-to-previous))
1240     (define-key mime-view-mode-map
1241       "\t"       (function mime-preview-move-to-next))
1242     (define-key mime-view-mode-map
1243       " "        (function mime-preview-scroll-up-entity))
1244     (define-key mime-view-mode-map
1245       "\M- "     (function mime-preview-scroll-down-entity))
1246     (define-key mime-view-mode-map
1247       "\177"     (function mime-preview-scroll-down-entity))
1248     (define-key mime-view-mode-map
1249       "\C-m"     (function mime-preview-next-line-entity))
1250     (define-key mime-view-mode-map
1251       "\C-\M-m"  (function mime-preview-previous-line-entity))
1252     (define-key mime-view-mode-map
1253       "v"        (function mime-preview-play-current-entity))
1254     (define-key mime-view-mode-map
1255       "e"        (function mime-preview-extract-current-entity))
1256     (define-key mime-view-mode-map
1257       "\C-c\C-p" (function mime-preview-print-current-entity))
1258
1259     (define-key mime-view-mode-map
1260       "\C-c\C-t\C-f" (function mime-preview-toggle-header))
1261     (define-key mime-view-mode-map
1262       "\C-c\C-th" (function mime-preview-toggle-header))
1263     (define-key mime-view-mode-map
1264       "\C-c\C-t\C-c" (function mime-preview-toggle-content))
1265
1266     (define-key mime-view-mode-map
1267       "\C-c\C-v\C-f" (function mime-preview-show-header))
1268     (define-key mime-view-mode-map
1269       "\C-c\C-vh" (function mime-preview-show-header))
1270     (define-key mime-view-mode-map
1271       "\C-c\C-v\C-c" (function mime-preview-show-content))
1272
1273     (define-key mime-view-mode-map
1274       "\C-c\C-d\C-f" (function mime-preview-hide-header))
1275     (define-key mime-view-mode-map
1276       "\C-c\C-dh" (function mime-preview-hide-header))
1277     (define-key mime-view-mode-map
1278       "\C-c\C-d\C-c" (function mime-preview-hide-content))
1279
1280     (define-key mime-view-mode-map
1281       "a"        (function mime-preview-follow-current-entity))
1282     (define-key mime-view-mode-map
1283       "q"        (function mime-preview-quit))
1284     (define-key mime-view-mode-map
1285       "\C-c\C-x" (function mime-preview-kill-buffer))
1286     ;; (define-key mime-view-mode-map
1287     ;;   "<"        (function beginning-of-buffer))
1288     ;; (define-key mime-view-mode-map
1289     ;;   ">"        (function end-of-buffer))
1290     (define-key mime-view-mode-map
1291       "?"        (function describe-mode))
1292     (define-key mime-view-mode-map
1293       [tab] (function mime-preview-move-to-next))
1294     (define-key mime-view-mode-map
1295       [delete] (function mime-preview-scroll-down-entity))
1296     (define-key mime-view-mode-map
1297       [backspace] (function mime-preview-scroll-down-entity))
1298     (if (functionp default)
1299         (if (featurep 'xemacs)
1300             (set-keymap-default-binding mime-view-mode-map default)
1301           (setq mime-view-mode-map
1302                 (append mime-view-mode-map (list (cons t default))))))
1303     (define-key mime-view-mode-map
1304       [down-mouse-3] (function mime-view-popup-menu))
1305     ;; (run-hooks 'mime-view-define-keymap-hook)
1306     mime-view-mode-map))
1307
1308 (defvar mime-view-mode-default-map (mime-view-define-keymap))
1309
1310
1311 (defsubst mime-maybe-hide-echo-buffer ()
1312   "Clear mime-echo buffer and delete window for it."
1313   (let ((buf (get-buffer mime-echo-buffer-name)))
1314     (if buf
1315         (save-excursion
1316           (set-buffer buf)
1317           (erase-buffer)
1318           (let ((win (get-buffer-window buf)))
1319             (if win
1320                 (delete-window win)))
1321           (bury-buffer buf)))))
1322
1323 (defvar mime-view-redisplay nil)
1324
1325 ;;;###autoload
1326 (defun mime-display-message (message &optional preview-buffer
1327                                      mother default-keymap-or-function
1328                                      original-major-mode keymap)
1329   "View MESSAGE in MIME-View mode.
1330
1331 Optional argument PREVIEW-BUFFER specifies the buffer of the
1332 presentation.  It must be either nil or a name of preview buffer.
1333
1334 Optional argument MOTHER specifies mother-buffer of the preview-buffer.
1335
1336 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1337 function.  If it is a keymap, keymap of MIME-View mode will be added
1338 to it.  If it is a function, it will be bound as default binding of
1339 keymap of MIME-View mode.
1340
1341 Optional argument ORIGINAL-MAJOR-MODE is major-mode of representation
1342 buffer of MESSAGE.  If it is nil, current `major-mode' is used.
1343
1344 Optional argument KEYMAP is keymap of MIME-View mode.  If it is
1345 non-nil, DEFAULT-KEYMAP-OR-FUNCTION is ignored.  If it is nil,
1346 `mime-view-mode-default-map' is used."
1347   (mime-maybe-hide-echo-buffer)
1348   (let ((win-conf (current-window-configuration)))
1349     (or preview-buffer
1350         (setq preview-buffer
1351               (concat "*Preview-" (mime-entity-name message) "*")))
1352     (or original-major-mode
1353         (setq original-major-mode major-mode))
1354     (let ((inhibit-read-only t))
1355       (set-buffer (get-buffer-create preview-buffer))
1356       (widen)
1357       (erase-buffer)
1358       (if mother
1359           (setq mime-mother-buffer mother))
1360       (setq mime-preview-original-window-configuration win-conf)
1361       (setq major-mode 'mime-view-mode)
1362       (setq mode-name "MIME-View")
1363       (mime-display-entity message nil
1364                            `((entity-button . invisible)
1365                              (header . visible)
1366                              (major-mode . ,original-major-mode))
1367                            preview-buffer)
1368       (use-local-map
1369        (or keymap
1370            (if default-keymap-or-function
1371                (mime-view-define-keymap default-keymap-or-function)
1372              mime-view-mode-default-map)))
1373       (let ((point
1374              (next-single-property-change (point-min) 'mime-view-entity)))
1375         (if point
1376             (goto-char point)
1377           (goto-char (point-min))
1378           (search-forward "\n\n" nil t)))
1379       (run-hooks 'mime-view-mode-hook)
1380       (set-buffer-modified-p nil)
1381       (setq buffer-read-only t)
1382       preview-buffer)))
1383
1384 ;;;###autoload
1385 (defun mime-view-buffer (&optional raw-buffer preview-buffer mother
1386                                    default-keymap-or-function
1387                                    representation-type)
1388   "View RAW-BUFFER in MIME-View mode.
1389 Optional argument PREVIEW-BUFFER is either nil or a name of preview
1390 buffer.
1391 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1392 function.  If it is a keymap, keymap of MIME-View mode will be added
1393 to it.  If it is a function, it will be bound as default binding of
1394 keymap of MIME-View mode.
1395 Optional argument REPRESENTATION-TYPE is representation-type of
1396 message.  It must be nil, `binary' or `cooked'.  If it is nil,
1397 `cooked' is used as default."
1398   (interactive)
1399   (or raw-buffer
1400       (setq raw-buffer (current-buffer)))
1401   (or representation-type
1402       (setq representation-type
1403             (save-excursion
1404               (set-buffer raw-buffer)
1405               (cdr (or (assq major-mode mime-raw-representation-type-alist)
1406                        (assq t mime-raw-representation-type-alist))))))
1407   (if (eq representation-type 'binary)
1408       (setq representation-type 'buffer))
1409   (setq preview-buffer (mime-display-message
1410                         (mime-open-entity representation-type raw-buffer)
1411                         preview-buffer mother default-keymap-or-function))
1412   (or (get-buffer-window preview-buffer)
1413       (let ((r-win (get-buffer-window raw-buffer)))
1414         (if r-win
1415             (set-window-buffer r-win preview-buffer)
1416           (let ((m-win (and mother (get-buffer-window mother))))
1417             (if m-win
1418                 (set-window-buffer m-win preview-buffer)
1419               (switch-to-buffer preview-buffer)))))))
1420
1421 (defun mime-view-mode (&optional mother ctl encoding
1422                                  raw-buffer preview-buffer
1423                                  default-keymap-or-function)
1424   "Major mode for viewing MIME message.
1425
1426 Here is a list of the standard keys for mime-view-mode.
1427
1428 key             feature
1429 ---             -------
1430
1431 u               Move to upper content
1432 p or M-TAB      Move to previous content
1433 n or TAB        Move to next content
1434 SPC             Scroll up or move to next content
1435 M-SPC or DEL    Scroll down or move to previous content
1436 RET             Move to next line
1437 M-RET           Move to previous line
1438 v               Decode current content as `play mode'
1439 e               Decode current content as `extract mode'
1440 C-c C-p         Decode current content as `print mode'
1441 a               Followup to current content.
1442 q               Quit
1443 button-2        Move to point under the mouse cursor
1444                 and decode current content as `play mode'
1445 "
1446   (interactive)
1447   (unless mime-view-redisplay
1448     (save-excursion
1449       (if raw-buffer (set-buffer raw-buffer))
1450       (let ((type
1451              (cdr
1452               (or (assq major-mode mime-raw-representation-type-alist)
1453                   (assq t mime-raw-representation-type-alist)))))
1454         (if (eq type 'binary)
1455             (setq type 'buffer))
1456         (setq mime-message-structure (mime-open-entity type raw-buffer))
1457         (or (mime-entity-content-type mime-message-structure)
1458             (mime-entity-set-content-type mime-message-structure ctl)))
1459       (or (mime-entity-encoding mime-message-structure)
1460           (mime-entity-set-encoding mime-message-structure encoding))))
1461   (mime-display-message mime-message-structure preview-buffer
1462                         mother default-keymap-or-function))
1463
1464
1465 ;;; @@ utility
1466 ;;;
1467
1468 (defun mime-preview-find-boundary-info (&optional with-children)
1469   "Return boundary information of current part.
1470 If WITH-CHILDREN, refer boundary surrounding current part and its branches."
1471   (let (entity
1472         p-beg p-end
1473         entity-node-id len)
1474     (while (null (setq entity
1475                        (get-text-property (point) 'mime-view-entity)))
1476       (backward-char))
1477     (setq p-beg (previous-single-property-change (point) 'mime-view-entity))
1478     (setq entity-node-id (mime-entity-node-id entity))
1479     (setq len (length entity-node-id))
1480     (cond ((null p-beg)
1481            (setq p-beg
1482                  (if (eq (next-single-property-change (point-min)
1483                                                       'mime-view-entity)
1484                          (point))
1485                      (point)
1486                    (point-min))))
1487           ((eq (next-single-property-change p-beg 'mime-view-entity)
1488                (point))
1489            (setq p-beg (point))))
1490     (setq p-end (next-single-property-change p-beg 'mime-view-entity))
1491     (cond ((null p-end)
1492            (setq p-end (point-max)))
1493           ((null entity-node-id)
1494            (setq p-end (point-max)))
1495           (with-children
1496            (save-excursion
1497              (catch 'tag
1498                (let (e i)
1499                  (while (setq e
1500                               (next-single-property-change
1501                                (point) 'mime-view-entity))
1502                    (goto-char e)
1503                    (let ((rc (mime-entity-node-id
1504                               (get-text-property (point)
1505                                                  'mime-view-entity))))
1506                      (or (and (>= (setq i (- (length rc) len)) 0)
1507                               (equal entity-node-id (nthcdr i rc)))
1508                          (throw 'tag nil)))
1509                    (setq p-end (or (next-single-property-change
1510                                     (point) 'mime-view-entity)
1511                                    (point-max)))))
1512                (setq p-end (point-max))))))
1513     (vector p-beg p-end entity)))
1514
1515
1516 ;;; @@ playing
1517 ;;;
1518
1519 (autoload 'mime-preview-play-current-entity "mime-play"
1520   "Play current entity." t)
1521
1522 (defun mime-preview-extract-current-entity (&optional ignore-examples)
1523   "Extract current entity into file (maybe).
1524 It decodes current entity to call internal or external method as
1525 \"extract\" mode.  The method is selected from variable
1526 `mime-acting-condition'."
1527   (interactive "P")
1528   (mime-preview-play-current-entity ignore-examples "extract"))
1529
1530 (defun mime-preview-print-current-entity (&optional ignore-examples)
1531   "Print current entity (maybe).
1532 It decodes current entity to call internal or external method as
1533 \"print\" mode.  The method is selected from variable
1534 `mime-acting-condition'."
1535   (interactive "P")
1536   (mime-preview-play-current-entity ignore-examples "print"))
1537
1538
1539 ;;; @@ following
1540 ;;;
1541
1542 (defun mime-preview-follow-current-entity ()
1543   "Write follow message to current entity.
1544 It calls following-method selected from variable
1545 `mime-preview-following-method-alist'."
1546   (interactive)
1547   (let ((entity (mime-preview-find-boundary-info t))
1548         p-beg p-end
1549         pb-beg)
1550     (setq p-beg (aref entity 0)
1551           p-end (aref entity 1)
1552           entity (aref entity 2))
1553     (if (get-text-property p-beg 'mime-view-entity-body)
1554         (setq pb-beg p-beg)
1555       (setq pb-beg
1556             (next-single-property-change
1557              p-beg 'mime-view-entity-body nil
1558              (or (next-single-property-change p-beg 'mime-view-entity)
1559                  p-end))))
1560     (let* ((mode (mime-preview-original-major-mode 'recursive))
1561            (entity-node-id (mime-entity-node-id entity))
1562            (new-name
1563             (format "%s-%s" (buffer-name) (reverse entity-node-id)))
1564            new-buf
1565            (the-buf (current-buffer))
1566            fields)
1567       (save-excursion
1568         (set-buffer (setq new-buf (get-buffer-create new-name)))
1569         (erase-buffer)
1570         (insert ?\n)
1571         (insert-buffer-substring the-buf pb-beg p-end)
1572         (goto-char (point-min))
1573         (let ((current-entity
1574                (if (and (eq (mime-entity-media-type entity) 'message)
1575                         (eq (mime-entity-media-subtype entity) 'rfc822))
1576                    (car (mime-entity-children entity))
1577                  entity)))
1578           (while (and current-entity
1579                       (if (and (eq (mime-entity-media-type
1580                                     current-entity) 'message)
1581                                (eq (mime-entity-media-subtype
1582                                     current-entity) 'rfc822))
1583                           nil
1584                         (mime-insert-header current-entity fields)
1585                         t))
1586             (setq fields (std11-collect-field-names)
1587                   current-entity (mime-entity-parent current-entity))))
1588         (let ((rest mime-view-following-required-fields-list)
1589               field-name ret)
1590           (while rest
1591             (setq field-name (car rest))
1592             (or (std11-field-body field-name)
1593                 (progn
1594                   (save-excursion
1595                     (set-buffer the-buf)
1596                     (let ((entity (when mime-mother-buffer
1597                                     (set-buffer mime-mother-buffer)
1598                                     (get-text-property (point)
1599                                                        'mime-view-entity))))
1600                       (while (and entity
1601                                   (null (setq ret (mime-entity-fetch-field
1602                                                    entity field-name))))
1603                         (setq entity (mime-entity-parent entity)))))
1604                   (if ret
1605                       (insert (concat field-name ": " ret "\n")))))
1606             (setq rest (cdr rest)))))
1607       (let ((f (cdr (assq mode mime-preview-following-method-alist))))
1608         (if (functionp f)
1609             (funcall f new-buf)
1610           (message
1611            (format
1612             "Sorry, following method for %s is not implemented yet."
1613             mode)))))))
1614
1615
1616 ;;; @@ moving
1617 ;;;
1618
1619 (defun mime-preview-move-to-upper ()
1620   "Move to upper entity.
1621 If there is no upper entity, call function `mime-preview-quit'."
1622   (interactive)
1623   (let (cinfo)
1624     (while (null (setq cinfo
1625                        (get-text-property (point) 'mime-view-entity)))
1626       (backward-char))
1627     (let ((r (mime-entity-parent cinfo))
1628           point)
1629       (catch 'tag
1630         (while (setq point (previous-single-property-change
1631                             (point) 'mime-view-entity))
1632           (goto-char point)
1633           (when (eq r (get-text-property (point) 'mime-view-entity))
1634             (if (or (eq mime-preview-move-scroll t)
1635                     (and mime-preview-move-scroll
1636                          (>= point
1637                              (save-excursion
1638                                (move-to-window-line -1)
1639                                (forward-line (* -1 next-screen-context-lines))
1640                                (beginning-of-line)
1641                                (point)))))
1642                 (recenter next-screen-context-lines))
1643             (throw 'tag t)))
1644         (mime-preview-quit)))))
1645
1646 (defun mime-preview-move-to-previous ()
1647   "Move to previous entity.
1648 If there is no previous entity, it calls function registered in
1649 variable `mime-preview-over-to-previous-method-alist'."
1650   (interactive)
1651   (while (and (not (bobp))
1652               (null (get-text-property (point) 'mime-view-entity)))
1653     (backward-char))
1654   (let ((point (previous-single-property-change (point) 'mime-view-entity)))
1655     (if (and point
1656              (>= point (point-min)))
1657         (if (get-text-property (1- point) 'mime-view-entity)
1658             (progn (goto-char point)
1659                    (if
1660                     (or (eq mime-preview-move-scroll t)
1661                         (and mime-preview-move-scroll
1662                              (<= point
1663                                 (save-excursion
1664                                   (move-to-window-line 0)
1665                                   (forward-line next-screen-context-lines)
1666                                   (end-of-line)
1667                                   (point)))))
1668                         (recenter (* -1 next-screen-context-lines))))
1669           (goto-char (1- point))
1670           (mime-preview-move-to-previous))
1671       (let ((f (assq (mime-preview-original-major-mode)
1672                      mime-preview-over-to-previous-method-alist)))
1673         (if f
1674             (funcall (cdr f)))))))
1675
1676 (defun mime-preview-move-to-next ()
1677   "Move to next entity.
1678 If there is no previous entity, it calls function registered in
1679 variable `mime-preview-over-to-next-method-alist'."
1680   (interactive)
1681   (while (and (not (eobp))
1682               (null (get-text-property (point) 'mime-view-entity)))
1683     (forward-char))
1684   (let ((point (next-single-property-change (point) 'mime-view-entity)))
1685     (if (and point
1686              (<= point (point-max)))
1687         (progn
1688           (goto-char point)
1689           (if (null (get-text-property point 'mime-view-entity))
1690               (mime-preview-move-to-next)
1691             (and
1692              (or (eq mime-preview-move-scroll t)
1693                  (and mime-preview-move-scroll
1694                       (>= point
1695                          (save-excursion
1696                            (move-to-window-line -1)
1697                            (forward-line
1698                             (* -1 next-screen-context-lines))
1699                            (beginning-of-line)
1700                            (point)))))
1701                  (recenter next-screen-context-lines))))
1702       (let ((f (assq (mime-preview-original-major-mode)
1703                      mime-preview-over-to-next-method-alist)))
1704         (if f
1705             (funcall (cdr f)))))))
1706
1707 (defun mime-preview-scroll-up-entity (&optional h)
1708   "Scroll up current entity.
1709 If reached to (point-max), it calls function registered in variable
1710 `mime-preview-over-to-next-method-alist'."
1711   (interactive)
1712   (if (eobp)
1713       (let ((f (assq (mime-preview-original-major-mode)
1714                      mime-preview-over-to-next-method-alist)))
1715         (if f
1716             (funcall (cdr f))))
1717     (let ((point
1718            (or (next-single-property-change (point) 'mime-view-entity)
1719                (point-max)))
1720           (bottom (window-end (selected-window))))
1721       (if (and (not h)
1722                (> bottom point))
1723           (progn (goto-char point)
1724                  (recenter next-screen-context-lines))
1725         (condition-case nil
1726             (scroll-up h)
1727           (end-of-buffer
1728            (goto-char (point-max))))))))
1729
1730 (defun mime-preview-scroll-down-entity (&optional h)
1731   "Scroll down current entity.
1732 If reached to (point-min), it calls function registered in variable
1733 `mime-preview-over-to-previous-method-alist'."
1734   (interactive)
1735   (if (bobp)
1736       (let ((f (assq (mime-preview-original-major-mode)
1737                      mime-preview-over-to-previous-method-alist)))
1738         (if f
1739             (funcall (cdr f))))
1740     (let ((point
1741            (or (previous-single-property-change (point) 'mime-view-entity)
1742                (point-min)))
1743           (top (window-start (selected-window))))
1744       (if (and (not h)
1745                (< top point))
1746           (progn (goto-char point)
1747                  (recenter (* -1 next-screen-context-lines)))
1748         (condition-case nil
1749             (scroll-down h)
1750           (beginning-of-buffer
1751            (goto-char (point-min))))))))
1752
1753 (defun mime-preview-next-line-entity (&optional lines)
1754   "Scroll up one line (or prefix LINES lines).
1755 If LINES is negative, scroll down LINES lines."
1756   (interactive "p")
1757   (mime-preview-scroll-up-entity (or lines 1)))
1758
1759 (defun mime-preview-previous-line-entity (&optional lines)
1760   "Scrroll down one line (or prefix LINES lines).
1761 If LINES is negative, scroll up LINES lines."
1762   (interactive "p")
1763   (mime-preview-scroll-down-entity (or lines 1)))
1764
1765
1766 ;;; @@ display
1767 ;;;
1768
1769 (defun mime-view-guess-encoding (entity situation)
1770   (or (cdr (assq '*encoding situation))
1771       (cdr (assq 'encoding situation))
1772       (mime-entity-encoding entity)
1773       "7bit"))
1774
1775 (defun mime-view-read-encoding (entity situation)
1776   (let* ((default-encoding
1777            (mime-view-guess-encoding entity situation))
1778          (encoding
1779           (completing-read
1780            "Content Transfer Encoding: "
1781            (mime-encoding-alist) nil t default-encoding)))
1782     (unless (or (string= encoding "")
1783                 (string= encoding default-encoding))
1784       encoding)))
1785
1786 (defun mime-view-guess-charset (entity situation)
1787   (or (static-if (fboundp 'coding-system-to-mime-charset)
1788           ;; might be overridden by `universal-coding-system-argument'.
1789           (and coding-system-for-read
1790                (coding-system-to-mime-charset coding-system-for-read)))
1791       (cdr (assq '*charset situation))
1792       (cdr (assq 'charset situation))
1793       (let ((charset (cdr (assoc "charset" (mime-entity-parameters entity)))))
1794         (if charset
1795             (intern (downcase charset))))
1796       default-mime-charset))
1797
1798 (defun mime-view-read-charset (entity situation)
1799   (static-if (featurep 'mule)
1800       (let* ((default-charset
1801                (mime-view-guess-charset entity situation))
1802              (charset
1803               (intern (completing-read "MIME-charset: "
1804                                        (mapcar
1805                                         (lambda (sym)
1806                                           (list (symbol-name sym)))
1807                                         (mime-charset-list))
1808                                        nil t
1809                                        (symbol-name default-charset)))))
1810         (unless (eq charset default-charset)
1811           charset))
1812     default-charset))
1813
1814 (defun mime-preview-toggle-display (type &optional display)
1815   (let ((situation (mime-preview-find-boundary-info))
1816         (sym (intern (concat "*" (symbol-name type))))
1817         entity p-beg p-end encoding charset)
1818     (setq p-beg (aref situation 0)
1819           p-end (aref situation 1)
1820           entity (aref situation 2)
1821           situation (get-text-property p-beg 'mime-view-situation))
1822     (cond ((eq display 'invisible)
1823            (setq display nil))
1824           (display)
1825           (t
1826            (setq display
1827                  (memq (cdr (or (assq sym situation)
1828                                 (assq type situation)))
1829                        '(nil invisible)))))
1830     (setq situation (put-alist sym (if display
1831                                        'visible
1832                                      'invisible)
1833                                situation))
1834     (when (and current-prefix-arg
1835                (eq (cdr (assq sym situation)) 'visible))
1836       (if (setq encoding (mime-view-read-encoding entity situation))
1837           (setq situation (put-alist '*encoding encoding situation)))
1838       (if (setq charset (mime-view-read-charset entity situation))
1839           (setq situation (put-alist '*charset charset situation))))
1840     (save-excursion
1841       (let ((inhibit-read-only t))
1842         (delete-region p-beg p-end)
1843         (mime-display-entity entity situation)))
1844     (let ((ret (assoc situation mime-preview-situation-example-list)))
1845       (if ret
1846           (setcdr ret (1+ (cdr ret)))
1847         (add-to-list 'mime-preview-situation-example-list
1848                      (cons situation 0))))))
1849
1850 (defun mime-preview-toggle-header (&optional force-visible)
1851   (interactive "P")
1852   (mime-preview-toggle-display 'header force-visible))
1853
1854 (defun mime-preview-toggle-content (&optional force-visible)
1855   (interactive "P")
1856   (mime-preview-toggle-display 'body force-visible))
1857
1858 (defun mime-preview-show-header ()
1859   (interactive)
1860   (mime-preview-toggle-display 'header 'visible))
1861
1862 (defun mime-preview-show-content ()
1863   (interactive)
1864   (mime-preview-toggle-display 'body 'visible))
1865
1866 (defun mime-preview-hide-header ()
1867   (interactive)
1868   (mime-preview-toggle-display 'header 'invisible))
1869
1870 (defun mime-preview-hide-content ()
1871   (interactive)
1872   (mime-preview-toggle-display 'body 'invisible))
1873
1874
1875 ;;; @@ quitting
1876 ;;;
1877
1878 (defun mime-preview-quit ()
1879   "Quit from MIME-preview buffer.
1880 It calls function registered in variable
1881 `mime-preview-quitting-method-alist'."
1882   (interactive)
1883   (let ((r (assq (mime-preview-original-major-mode)
1884                  mime-preview-quitting-method-alist)))
1885     (if r
1886         (funcall (cdr r)))))
1887
1888 (defun mime-preview-kill-buffer ()
1889   (interactive)
1890   (kill-buffer (current-buffer)))
1891
1892
1893 ;;; @ end
1894 ;;;
1895
1896 (provide 'mime-view)
1897
1898 (eval-when-compile
1899   (setq mime-situation-examples-file nil)
1900   ;; to avoid to read situation-examples-file at compile time.
1901   )
1902
1903 (mime-view-read-situation-examples-file)
1904
1905 ;;; mime-view.el ends here