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\"."
244 (mime-delq-null-situation
245 (ctree-find-calist mime-acting-condition
246 (mime-entity-situation entity situation)
247 mime-view-find-every-acting-situation)
248 'method ignored-method))
249 (or (assq 'ignore-examples situation)
257 (let ((situation (car rest))
258 (examples mime-acting-situation-example-list))
261 (mime-compare-situation-with-example
262 situation (caar examples)))
263 (ret-score (car ret)))
264 (cond ((> ret-score max-score)
265 (setq max-score ret-score
266 max-escore (cdar examples)
267 max-examples (list (cdr ret))
268 max-situations (list situation))
270 ((= ret-score max-score)
271 (cond ((> (cdar examples) max-escore)
272 (setq max-escore (cdar examples)
273 max-examples (list (cdr ret))
274 max-situations (list situation))
276 ((= (cdar examples) max-escore)
278 (cons (cdr ret) max-examples))
279 (or (member situation max-situations)
281 (cons situation max-situations)))
283 (setq examples (cdr examples))))
284 (setq rest (cdr rest)))
286 (setq ret max-situations)
288 (let* ((example (car max-examples))
290 (assoc example mime-acting-situation-example-list)))
292 (setcdr cell (1+ (cdr cell)))
293 (setq mime-acting-situation-example-list
294 (cons (cons example 0)
295 mime-acting-situation-example-list))
297 (setq max-examples (cdr max-examples))
300 (setq ret (select-menu-alist
306 (cdr (assq 'method situation)))
309 (setq ret (mime-sort-situation ret))
310 (add-to-list 'mime-acting-situation-example-list (cons ret 0))
315 (setq method (cdr (assq 'method ret)))
316 (cond ((and (symbolp method)
318 (funcall method entity ret)
321 (mime-activate-mailcap-method entity ret)
323 ;; ((and (listp method)(stringp (car method)))
324 ;; (mime-activate-external-method entity ret)
327 (mime-show-echo-buffer "No method are specified for %s\n"
328 (mime-entity-type/subtype entity))
333 ;;; @ external decoder
336 (defvar mime-mailcap-method-filename-alist nil)
338 (defun mime-activate-mailcap-method (entity situation)
339 (let ((method (cdr (assoc 'method situation)))
340 (name (mime-entity-safe-filename entity)))
342 (if (and name (not (string= name "")))
343 (expand-file-name name temporary-file-directory)
345 (expand-file-name "EMI" temporary-file-directory))
347 (mime-write-entity-content entity name)
348 (message "External method is starting...")
351 (mailcap-format-command
353 (cons (cons 'filename name) situation))))
354 (start-process command mime-echo-buffer-name
355 shell-file-name shell-command-switch command)
357 (set-alist 'mime-mailcap-method-filename-alist process name)
358 (set-process-sentinel process 'mime-mailcap-method-sentinel)
362 (defun mime-mailcap-method-sentinel (process event)
363 (let ((file (cdr (assq process mime-mailcap-method-filename-alist))))
364 (if (file-exists-p file)
367 (remove-alist 'mime-mailcap-method-filename-alist process)
368 (message (format "%s %s" process event)))
370 (defvar mime-echo-window-is-shared-with-bbdb
371 (module-installed-p 'bbdb)
372 "*If non-nil, mime-echo window is shared with BBDB window.")
374 (defvar mime-echo-window-height
377 (/ (window-height) 5)
379 "*Size of mime-echo window.
380 It allows function or integer. If it is function,
381 `mime-show-echo-buffer' calls it to get height of mime-echo window.
382 Otherwise `mime-show-echo-buffer' uses it as height of mime-echo
385 (defun mime-show-echo-buffer (&rest forms)
386 "Show mime-echo buffer to display MIME-playing information.
387 It returns the list of window, start and end positions of inserted text.
388 A window height of the buffer `mime-echo-buffer-name' will be determined
389 by `mime-echo-window-height' (its value or its return value) whenever
390 this function is called."
391 (get-buffer-create mime-echo-buffer-name)
392 (let ((the-win (selected-window))
393 (win (get-buffer-window mime-echo-buffer-name))
394 (height (if (functionp mime-echo-window-height)
395 (funcall mime-echo-window-height)
396 mime-echo-window-height))
401 (enlarge-window (- height (window-height)))
403 (unless (and mime-echo-window-is-shared-with-bbdb
406 (setq win (get-buffer-window bbdb-buffer-name))
409 (select-window (get-buffer-window (or mime-preview-buffer
411 (let ((window-min-height 1))
412 (setq win (split-window-vertically (- (window-height) height)))
414 (set-window-buffer win mime-echo-buffer-name)
417 (goto-char (setq start (point-max)))
419 (insert (apply (function format) forms))
422 (list win start (point))
423 (select-window the-win)
430 (defvar mime-view-file-name-char-regexp "[A-Za-z0-9+_-]")
432 (defvar mime-view-file-name-regexp-1
433 (concat mime-view-file-name-char-regexp "+\\."
434 mime-view-file-name-char-regexp "+"))
436 (defvar mime-view-file-name-regexp-2
437 (concat (regexp-* mime-view-file-name-char-regexp)
438 "\\(\\." mime-view-file-name-char-regexp "+\\)*"))
440 (defun mime-entity-safe-filename (entity)
442 (or (mime-entity-filename entity)
444 (or (mime-read-field 'Content-Description entity)
445 (mime-read-field 'Subject entity))))
447 (or (string-match mime-view-file-name-regexp-1 subj)
448 (string-match mime-view-file-name-regexp-2 subj)))
449 (substring subj (match-beginning 0)(match-end 0))
452 (replace-as-filename filename)
456 ;;; @ file extraction
459 (defun mime-save-content (entity situation)
460 (let* ((name (mime-entity-safe-filename entity))
461 (filename (if (and name (not (string-equal name "")))
462 (expand-file-name name
463 (save-window-excursion
467 (interactive "DDirectory: ")
469 (save-window-excursion
473 (interactive "FFilename: ")
474 (expand-file-name file)))))))
476 (if (file-exists-p filename)
477 (or (yes-or-no-p (format "File %s exists. Save anyway? " filename))
479 (mime-write-entity-content entity filename)
486 (defvar mime-magic-type-alist
487 '(("^\377\330\377[\340\356]..JFIF" image jpeg)
488 ("^\211PNG" image png)
489 ("^GIF8[79]" image gif)
490 ("^II\\*\000" image tiff)
491 ("^MM\000\\*" image tiff)
493 ("^\000\000\001\263" video mpeg)
495 "*Alist of regexp about magic-number vs. corresponding media-types.
496 Each element looks like (REGEXP TYPE SUBTYPE).
497 REGEXP is a regular expression to match against the beginning of the
499 TYPE is symbol to indicate primary type of media-type.
500 SUBTYPE is symbol to indicate subtype of media-type.")
502 (defun mime-detect-content (entity situation)
504 (let ((mdata (mime-entity-content entity))
505 (rest mime-magic-type-alist))
506 (while (not (let ((cell (car rest)))
508 (if (string-match (car cell) mdata)
509 (setq type (nth 1 cell)
510 subtype (nth 2 cell))
513 (setq rest (cdr rest))))
517 (put-alist 'type type
518 (put-alist 'subtype subtype
520 (copy-alist situation))))
521 'mime-detect-content)
526 ;;; @ mail/news message
529 (defun mime-preview-quitting-method-for-mime-show-message-mode ()
530 "Quitting method for mime-view.
531 It is registered to variable `mime-preview-quitting-method-alist'."
532 (let ((mother mime-mother-buffer)
533 (win-conf mime-preview-original-window-configuration)
535 (kill-buffer mime-raw-buffer)
536 (mime-preview-kill-buffer)
537 (set-window-configuration win-conf)
538 (pop-to-buffer mother)
541 (defun mime-view-message/rfc822 (entity situation)
543 (format "%s-%s" (buffer-name) (mime-entity-number entity)))
544 (mother (current-buffer))
545 (children (car (mime-entity-children entity))))
546 (set-buffer (get-buffer-create new-name))
548 (mime-insert-entity children)
549 (setq mime-message-structure children)
550 (setq major-mode 'mime-show-message-mode)
551 (mime-view-buffer (current-buffer) nil mother
552 nil (if (mime-entity-cooked-p entity) 'cooked))
556 ;;; @ message/partial
559 (defun mime-store-message/partial-piece (entity cal)
562 (concat "m-prts-" (user-login-name)) temporary-file-directory))
563 (id (cdr (assoc "id" cal)))
564 (number (cdr (assoc "number" cal)))
565 (total (cdr (assoc "total" cal)))
567 (mother (current-buffer))
569 (or (file-exists-p root-dir)
570 (make-directory root-dir)
572 (setq id (replace-as-filename id))
573 (setq root-dir (concat root-dir "/" id))
574 (or (file-exists-p root-dir)
575 (make-directory root-dir)
577 (setq file (concat root-dir "/FULL"))
578 (if (file-exists-p file)
579 (let ((full-buf (get-buffer-create "FULL"))
580 (pwin (or (get-buffer-window mother)
581 (get-largest-window)))
583 (save-window-excursion
584 (set-buffer full-buf)
586 (as-binary-input-file (insert-file-contents file))
587 (setq major-mode 'mime-show-message-mode)
588 (mime-view-buffer (current-buffer) nil mother)
590 (set-window-buffer pwin
592 (set-buffer full-buf)
593 mime-preview-buffer))
596 (setq file (concat root-dir "/" number))
597 (mime-write-entity-body entity file)
598 (let ((total-file (concat root-dir "/CT")))
602 (or (file-exists-p total-file)
605 (get-buffer-create mime-temp-buffer-name))
608 (write-region (point-min)(point-max) total-file)
609 (kill-buffer (current-buffer))
611 (string-to-number total)
613 (and (file-exists-p total-file)
615 (set-buffer (find-file-noselect total-file))
617 (and (re-search-forward "[0-9]+" nil t)
619 (buffer-substring (match-beginning 0)
622 (kill-buffer (current-buffer))
625 (if (and total (> total 0))
628 (set-buffer (get-buffer-create mime-temp-buffer-name))
629 (let ((full-buf (current-buffer)))
633 (setq file (concat root-dir "/" (int-to-string i)))
634 (or (file-exists-p file)
637 (as-binary-input-file (insert-file-contents file))
638 (goto-char (point-max))
641 (as-binary-output-file
642 (write-region (point-min)(point-max)
643 (expand-file-name "FULL" root-dir)))
646 (let ((file (format "%s/%d" root-dir i)))
647 (and (file-exists-p file)
652 (let ((file (expand-file-name "CT" root-dir)))
653 (and (file-exists-p file)
656 (save-window-excursion
657 (setq major-mode 'mime-show-message-mode)
658 (mime-view-buffer (current-buffer) nil mother)
660 (let ((pwin (or (get-buffer-window mother)
661 (get-largest-window)))
662 (pbuf (save-excursion
663 (set-buffer full-buf)
664 mime-preview-buffer)))
665 (set-window-buffer pwin pbuf)
671 ;;; @ message/external-body
674 (defvar mime-raw-dired-function
675 (if (and (>= emacs-major-version 19) window-system)
676 (function dired-other-frame)
677 (function mime-raw-dired-function-for-one-frame)
680 (defun mime-raw-dired-function-for-one-frame (dir)
681 (let ((win (or (get-buffer-window mime-preview-buffer)
682 (get-largest-window))))
687 (defun mime-view-message/external-anon-ftp (entity cal)
688 (let* ((site (cdr (assoc "site" cal)))
689 (directory (cdr (assoc "directory" cal)))
690 (name (cdr (assoc "name" cal)))
691 (pathname (concat "/anonymous@" site ":" directory)))
692 (message (concat "Accessing " (expand-file-name name pathname) " ..."))
693 (funcall mime-raw-dired-function pathname)
694 (goto-char (point-min))
695 (search-forward name)
698 (defvar mime-raw-browse-url-function mime-browse-url-function)
700 (defun mime-view-message/external-url (entity cal)
701 (let ((url (cdr (assoc "url" cal))))
702 (message (concat "Accessing " url " ..."))
703 (funcall mime-raw-browse-url-function url)))
709 (defun mime-view-caesar (entity situation)
710 "Internal method for mime-view to display ROT13-47-48 message."
711 (let ((buf (get-buffer-create
712 (format "%s-%s" (buffer-name) (mime-entity-number entity)))))
713 (with-current-buffer buf
714 (setq buffer-read-only nil)
716 (mime-insert-text-content entity)
717 (mule-caesar-region (point-min) (point-max))
718 (set-buffer-modified-p nil)
720 (let ((win (get-buffer-window (current-buffer))))
721 (or (eq (selected-window) win)
722 (select-window (or win (get-largest-window)))
725 (goto-char (point-min))
734 (let* ((file mime-acting-situation-examples-file)
735 (buffer (get-buffer-create " *mime-example*")))
736 (if (file-readable-p file)
741 (insert-file-contents file)
746 (while (and (> (length mime-acting-situation-example-list)
747 mime-acting-situation-example-list-max-size)
749 (mime-reduce-acting-situation-examples)
752 (error (setq mime-acting-situation-example-list nil)))
754 (kill-buffer buffer))))
756 ;;; mime-play.el ends here