1 ;;; mime-play.el --- Playback processing module for mime-view.el
3 ;; Copyright (C) 1994,1995,1996,1997,1998,1999 Free Software Foundation, Inc.
5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Created: 1995/9/26 (separated from tm-view.el)
7 ;; Renamed: 1997/2/21 from tm-play.el
8 ;; Keywords: MIME, multimedia, mail, news
10 ;; This file is part of SEMI (Secretariat of Emacs MIME Interfaces).
12 ;; This program is free software; you can redistribute it and/or
13 ;; modify it under the terms of the GNU General Public License as
14 ;; published by the Free Software Foundation; either version 2, or (at
15 ;; your option) any later version.
17 ;; This program is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ;; General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
36 (error (defvar bbdb-buffer-name nil)))
39 (defvar mime-acting-situation-example-list nil)
41 (defvar mime-acting-situation-example-list-max-size 16)
43 (defun mime-save-acting-situation-examples ()
44 (let* ((file mime-acting-situation-examples-file)
45 (buffer (get-buffer-create " *mime-example*")))
49 (setq buffer-file-name file)
51 (insert ";;; " (file-name-nondirectory file) "\n")
52 (insert "\n;; This file is generated automatically by "
53 mime-view-version "\n\n")
54 (insert ";;; Code:\n\n")
55 (pp `(setq mime-acting-situation-example-list
56 ',mime-acting-situation-example-list)
59 (file-name-nondirectory file)
62 (kill-buffer buffer))))
64 (add-hook 'kill-emacs-hook 'mime-save-acting-situation-examples)
66 (defun mime-reduce-acting-situation-examples ()
67 (let ((len (length mime-acting-situation-example-list))
75 ir mime-acting-situation-example-list)
79 jr mime-acting-situation-example-list)
83 (setq ret (mime-compare-situation-with-example (car ic)(car jc))
85 det-ret (+ (length (car ic))(length (car jc)))
86 det-org (length (cdr ret))
87 freq (+ (cdr ic)(cdr jc)))
88 (cond ((< max-sim sim)
95 dest (cons (cdr ret) freq))
98 (cond ((> min-det-ret det-ret)
99 (setq min-det-ret det-ret
104 dest (cons (cdr ret) freq))
106 ((= min-det-ret det-ret)
107 (cond ((> min-det-org det-org)
108 (setq min-det-org det-org
112 dest (cons (cdr ret) freq))
114 ((= min-det-org det-org)
115 (cond ((> min-freq freq)
119 dest (cons (cdr ret) freq))
133 (setq jr (nthcdr (1- d-j) mime-acting-situation-example-list))
134 (setcdr jr (cddr jr))
136 (setq mime-acting-situation-example-list
137 (cdr mime-acting-situation-example-list))
138 (setq ir (nthcdr (1- d-i) mime-acting-situation-example-list))
139 (setcdr ir (cddr ir))
141 (if (setq ir (assoc (car dest) mime-acting-situation-example-list))
142 (setcdr ir (+ (cdr ir)(cdr dest)))
143 (setq mime-acting-situation-example-list
144 (cons dest mime-acting-situation-example-list))
148 ;;; @ content decoder
152 (defun mime-preview-play-current-entity (&optional ignore-examples mode)
153 "Play current entity.
154 It decodes current entity to call internal or external method. The
155 method is selected from variable `mime-acting-condition'.
156 If IGNORE-EXAMPLES (C-u prefix) is specified, this function ignores
157 `mime-acting-situation-example-list'.
158 If MODE is specified, play as it. Default MODE is \"play\"."
160 (let ((entity (get-text-property (point) 'mime-view-entity)))
162 (let ((situation (list (cons 'mode (or mode "play")))))
165 (cons (cons 'ignore-examples ignore-examples)
167 (mime-play-entity entity situation)
170 (defun mime-sort-situation (situation)
180 (disposition-type . 6)
184 (let ((ret (assq a-t order)))
186 (setq a-order (cdr ret))
192 (let ((ret (assq b-t order)))
194 (setq b-order (cdr ret))
199 (if (= a-order b-order)
200 (string< (format "%s" a-t)(format "%s" b-t))
205 (defsubst mime-delq-null-situation (situations field
206 &optional ignored-value)
209 (let* ((situation (car situations))
210 (cell (assq field situation)))
212 (or (eq (cdr cell) ignored-value)
213 (setq dest (cons situation dest))
215 (setq situations (cdr situations)))
218 (defun mime-compare-situation-with-example (situation example)
219 (let ((example (copy-alist example))
222 (let* ((cell (car situation))
224 (ecell (assoc key example)))
226 (if (equal cell ecell)
227 (setq match (1+ match))
228 (setq example (delq ecell example))
231 (setq situation (cdr situation))
237 (defun mime-play-entity (entity &optional situation ignored-method)
238 "Play entity specified by ENTITY.
239 It decodes the entity to call internal or external method. The method
240 is selected from variable `mime-acting-condition'. If MODE is
241 specified, play as it. Default MODE is \"play\"."
243 (in-calist-package 'mime-view)
245 (mime-delq-null-situation
246 (ctree-find-calist mime-acting-condition
247 (mime-entity-situation entity situation)
248 mime-view-find-every-acting-situation)
249 'method ignored-method))
250 (or (assq 'ignore-examples situation)
258 (let ((situation (car rest))
259 (examples mime-acting-situation-example-list))
262 (mime-compare-situation-with-example
263 situation (caar examples)))
264 (ret-score (car ret)))
265 (cond ((> ret-score max-score)
266 (setq max-score ret-score
267 max-escore (cdar examples)
268 max-examples (list (cdr ret))
269 max-situations (list situation))
271 ((= ret-score max-score)
272 (cond ((> (cdar examples) max-escore)
273 (setq max-escore (cdar examples)
274 max-examples (list (cdr ret))
275 max-situations (list situation))
277 ((= (cdar examples) max-escore)
279 (cons (cdr ret) max-examples))
280 (or (member situation max-situations)
282 (cons situation max-situations)))
284 (setq examples (cdr examples))))
285 (setq rest (cdr rest)))
287 (setq ret max-situations)
289 (let* ((example (car max-examples))
291 (assoc example mime-acting-situation-example-list)))
293 (setcdr cell (1+ (cdr cell)))
294 (setq mime-acting-situation-example-list
295 (cons (cons example 0)
296 mime-acting-situation-example-list))
298 (setq max-examples (cdr max-examples))
301 (setq ret (select-menu-alist
307 (cdr (assq 'method situation)))
310 (setq ret (mime-sort-situation ret))
311 (add-to-list 'mime-acting-situation-example-list (cons ret 0))
316 (setq method (cdr (assq 'method ret)))
317 (cond ((and (symbolp method)
319 (funcall method entity ret)
322 (mime-activate-mailcap-method entity ret)
324 ;; ((and (listp method)(stringp (car method)))
325 ;; (mime-activate-external-method entity ret)
328 (mime-show-echo-buffer "No method are specified for %s\n"
329 (mime-type/subtype-string
330 (cdr (assq 'type situation))
331 (cdr (assq 'subtype situation))))
332 (if (y-or-n-p "Do you want to save current entity to disk?")
333 (mime-save-content entity situation))
338 ;;; @ external decoder
341 (defvar mime-mailcap-method-filename-alist nil)
343 (defun mime-activate-mailcap-method (entity situation)
344 (let ((method (cdr (assoc 'method situation)))
345 (name (mime-entity-safe-filename entity)))
347 (if (and name (not (string= name "")))
348 (expand-file-name name temporary-file-directory)
350 (expand-file-name "EMI" temporary-file-directory))
352 (mime-write-entity-content entity name)
353 (message "External method is starting...")
356 (mailcap-format-command
358 (cons (cons 'filename name) situation))))
359 (start-process command mime-echo-buffer-name
360 shell-file-name shell-command-switch command)
362 (set-alist 'mime-mailcap-method-filename-alist process name)
363 (set-process-sentinel process 'mime-mailcap-method-sentinel)
367 (defun mime-mailcap-method-sentinel (process event)
368 (let ((file (cdr (assq process mime-mailcap-method-filename-alist))))
369 (if (file-exists-p file)
372 (remove-alist 'mime-mailcap-method-filename-alist process)
373 (message (format "%s %s" process event)))
375 (defvar mime-echo-window-is-shared-with-bbdb
376 (module-installed-p 'bbdb)
377 "*If non-nil, mime-echo window is shared with BBDB window.")
379 (defvar mime-echo-window-height
382 (/ (window-height) 5)
384 "*Size of mime-echo window.
385 It allows function or integer. If it is function,
386 `mime-show-echo-buffer' calls it to get height of mime-echo window.
387 Otherwise `mime-show-echo-buffer' uses it as height of mime-echo
390 (defun mime-show-echo-buffer (&rest forms)
391 "Show mime-echo buffer to display MIME-playing information."
392 (get-buffer-create mime-echo-buffer-name)
393 (let ((the-win (selected-window))
394 (win (get-buffer-window mime-echo-buffer-name)))
396 (unless (and mime-echo-window-is-shared-with-bbdb
398 (setq win (get-buffer-window bbdb-buffer-name))
400 (select-window (get-buffer-window (or mime-preview-buffer
402 (setq win (split-window-vertically
404 (if (functionp mime-echo-window-height)
405 (funcall mime-echo-window-height)
406 mime-echo-window-height)
409 (set-window-buffer win mime-echo-buffer-name)
412 (goto-char (point-max))
414 (let ((buffer-read-only nil))
415 (insert (apply (function format) forms))
417 (select-window the-win)
424 (defvar mime-view-file-name-char-regexp "[A-Za-z0-9+_-]")
426 (defvar mime-view-file-name-regexp-1
427 (concat mime-view-file-name-char-regexp "+\\."
428 mime-view-file-name-char-regexp "+"))
430 (defvar mime-view-file-name-regexp-2
431 (concat (regexp-* mime-view-file-name-char-regexp)
432 "\\(\\." mime-view-file-name-char-regexp "+\\)*"))
434 (defun mime-entity-safe-filename (entity)
436 (or (mime-entity-filename entity)
438 (or (mime-entity-read-field entity 'Content-Description)
439 (mime-entity-read-field entity 'Subject))))
441 (or (string-match mime-view-file-name-regexp-1 subj)
442 (string-match mime-view-file-name-regexp-2 subj)))
443 (substring subj (match-beginning 0)(match-end 0))
446 (replace-as-filename filename)
450 ;;; @ file extraction
453 (defun mime-save-content (entity situation)
454 (let* ((name (mime-entity-safe-filename entity))
455 (filename (if (and name (not (string-equal name "")))
456 (expand-file-name name
457 (save-window-excursion
461 (interactive "DDirectory: ")
463 (save-window-excursion
467 (interactive "FFilename: ")
468 (expand-file-name file)))))))
470 (if (file-exists-p filename)
471 (or (yes-or-no-p (format "File %s exists. Save anyway? " filename))
473 (mime-write-entity-content entity filename)
480 (defvar mime-magic-type-alist
481 '(("^\377\330\377[\340\356]..JFIF" image jpeg)
482 ("^\211PNG" image png)
483 ("^GIF8[79]" image gif)
484 ("^II\\*\000" image tiff)
485 ("^MM\000\\*" image tiff)
487 ("^\000\000\001\263" video mpeg)
489 "*Alist of regexp about magic-number vs. corresponding media-types.
490 Each element looks like (REGEXP TYPE SUBTYPE).
491 REGEXP is a regular expression to match against the beginning of the
493 TYPE is symbol to indicate primary type of media-type.
494 SUBTYPE is symbol to indicate subtype of media-type.")
496 (defun mime-detect-content (entity situation)
498 (let ((mdata (mime-entity-content entity))
499 (rest mime-magic-type-alist))
500 (while (not (let ((cell (car rest)))
502 (if (string-match (car cell) mdata)
503 (setq type (nth 1 cell)
504 subtype (nth 2 cell))
507 (setq rest (cdr rest))))
508 (setq situation (del-alist 'method (copy-alist situation)))
509 (mime-play-entity entity
511 (put-alist 'type type
512 (put-alist 'subtype subtype
515 'mime-detect-content)))
518 ;;; @ mail/news message
521 (defun mime-preview-quitting-method-for-mime-show-message-mode ()
522 "Quitting method for mime-view.
523 It is registered to variable `mime-preview-quitting-method-alist'."
524 (let ((raw-buffer (mime-entity-buffer
525 (get-text-property (point-min) 'mime-view-entity)))
526 (mother mime-mother-buffer)
527 (win-conf mime-preview-original-window-configuration))
528 (kill-buffer raw-buffer)
529 (mime-preview-kill-buffer)
530 (set-window-configuration win-conf)
531 (pop-to-buffer mother)
534 (defun mime-view-message/rfc822 (entity situation)
536 (format "%s-%s" (buffer-name) (mime-entity-number entity)))
537 (mother (current-buffer))
538 (children (car (mime-entity-children entity)))
540 (mime-display-message
541 children new-name mother nil
542 (cdr (assq 'major-mode
543 (get-text-property (point) 'mime-view-situation))))))
544 (or (get-buffer-window preview-buffer)
545 (let ((m-win (get-buffer-window mother)))
547 (set-window-buffer m-win preview-buffer)
548 (switch-to-buffer preview-buffer)
552 ;;; @ message/partial
555 (defun mime-store-message/partial-piece (entity cal)
558 (concat "m-prts-" (user-login-name)) temporary-file-directory))
559 (id (cdr (assoc "id" cal)))
560 (number (cdr (assoc "number" cal)))
561 (total (cdr (assoc "total" cal)))
563 (mother (current-buffer)))
564 (or (file-exists-p root-dir)
565 (make-directory root-dir))
566 (setq id (replace-as-filename id))
567 (setq root-dir (concat root-dir "/" id))
568 (or (file-exists-p root-dir)
569 (make-directory root-dir))
570 (setq file (concat root-dir "/FULL"))
571 (if (file-exists-p file)
572 (let ((full-buf (get-buffer-create "FULL"))
573 (pwin (or (get-buffer-window mother)
574 (get-largest-window)))
576 (save-window-excursion
577 (set-buffer full-buf)
579 (as-binary-input-file (insert-file-contents file))
580 (setq major-mode 'mime-show-message-mode)
581 (mime-view-buffer (current-buffer) nil mother)
582 (setq pbuf (current-buffer))
584 (set-window-buffer pwin pbuf)
587 (setq file (concat root-dir "/" number))
588 (mime-write-entity-body entity file)
589 (let ((total-file (concat root-dir "/CT")))
593 (or (file-exists-p total-file)
596 (get-buffer-create mime-temp-buffer-name))
599 (write-region (point-min)(point-max) total-file)
600 (kill-buffer (current-buffer))
602 (string-to-number total)
604 (and (file-exists-p total-file)
606 (set-buffer (find-file-noselect total-file))
608 (and (re-search-forward "[0-9]+" nil t)
610 (buffer-substring (match-beginning 0)
613 (kill-buffer (current-buffer))
616 (if (and total (> total 0)
617 (>= (length (directory-files root-dir nil "^[0-9]+$" t))
621 (set-buffer (get-buffer-create mime-temp-buffer-name))
622 (let ((full-buf (current-buffer)))
626 (setq file (concat root-dir "/" (int-to-string i)))
627 (or (file-exists-p file)
630 (as-binary-input-file (insert-file-contents file))
631 (goto-char (point-max))
634 (as-binary-output-file
635 (write-region (point-min)(point-max)
636 (expand-file-name "FULL" root-dir)))
639 (let ((file (format "%s/%d" root-dir i)))
640 (and (file-exists-p file)
645 (let ((file (expand-file-name "CT" root-dir)))
646 (and (file-exists-p file)
649 (let ((pwin (or (get-buffer-window mother)
650 (get-largest-window)))
651 (pbuf (mime-display-message
652 (mime-open-entity 'buffer (current-buffer))
653 nil mother nil 'mime-show-message-mode)))
654 (set-window-buffer pwin pbuf)
660 ;;; @ message/external-body
663 (defvar mime-raw-dired-function
664 (if (and (>= emacs-major-version 19) window-system)
665 (function dired-other-frame)
666 (function mime-raw-dired-function-for-one-frame)
669 (defun mime-raw-dired-function-for-one-frame (dir)
670 (let ((win (or (get-buffer-window mime-preview-buffer)
671 (get-largest-window))))
676 (defun mime-view-message/external-anon-ftp (entity cal)
677 (let* ((site (cdr (assoc "site" cal)))
678 (directory (cdr (assoc "directory" cal)))
679 (name (cdr (assoc "name" cal)))
680 (pathname (concat "/anonymous@" site ":" directory)))
681 (message (concat "Accessing " (expand-file-name name pathname) " ..."))
682 (funcall mime-raw-dired-function pathname)
683 (goto-char (point-min))
684 (search-forward name)
687 (defvar mime-raw-browse-url-function mime-browse-url-function)
689 (defun mime-view-message/external-url (entity cal)
690 (let ((url (cdr (assoc "url" cal))))
691 (message (concat "Accessing " url " ..."))
692 (funcall mime-raw-browse-url-function url)))
698 (defun mime-view-caesar (entity situation)
699 "Internal method for mime-view to display ROT13-47-48 message."
700 (let ((buf (get-buffer-create
701 (format "%s-%s" (buffer-name) (mime-entity-number entity)))))
702 (with-current-buffer buf
703 (setq buffer-read-only nil)
705 (mime-insert-text-content entity)
706 (mule-caesar-region (point-min) (point-max))
707 (set-buffer-modified-p nil)
709 (let ((win (get-buffer-window (current-buffer))))
710 (or (eq (selected-window) win)
711 (select-window (or win (get-largest-window)))
714 (goto-char (point-min))
723 (let* ((file mime-acting-situation-examples-file)
724 (buffer (get-buffer-create " *mime-example*")))
725 (if (file-readable-p file)
730 (insert-file-contents file)
735 (while (and (> (length mime-acting-situation-example-list)
736 mime-acting-situation-example-list-max-size)
738 (mime-reduce-acting-situation-examples)
741 (error (setq mime-acting-situation-example-list nil)))
743 (kill-buffer buffer))))
745 ;;; mime-play.el ends here