[bpt/emacs.git] / lisp / mail / pmailsort.el

;;; pmailsort.el --- Pmail: sort messages

;; Copyright (C) 1990, 1993, 1994, 2001, 2002, 2003, 2004,
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.

;; Author: Masanobu UMEDA <umerin@mse.kyutech.ac.jp>
;; Maintainer: FSF
;; Keywords: mail

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;; Code:

(eval-when-compile
  (require 'mail-utils)
  (require 'sort)
  (require 'pmail))

(autoload 'timezone-make-date-sortable "timezone")

;; Sorting messages in Pmail buffer

;;;###autoload
(defun pmail-sort-by-date (reverse)
  "Sort messages of current Pmail file by date.
If prefix argument REVERSE is non-nil, sort them in reverse order."
  (interactive "P")
  (pmail-sort-messages reverse
		       (function
			(lambda (msg)
			  (pmail-make-date-sortable
			   (pmail-fetch-field msg "Date"))))))

;;;###autoload
(defun pmail-sort-by-subject (reverse)
  "Sort messages of current Pmail file by subject.
If prefix argument REVERSE is non-nil, sort them in reverse order."
  (interactive "P")
  (pmail-sort-messages reverse
		       (function
			(lambda (msg)
			  (let ((key (or (pmail-fetch-field msg "Subject") ""))
				(case-fold-search t))
			    ;; Remove `Re:'
			    (if (string-match "^\\(re:[ \t]*\\)*" key)
				(substring key (match-end 0))
			      key))))))

;;;###autoload
(defun pmail-sort-by-author (reverse)
  "Sort messages of current Pmail file by author.
If prefix argument REVERSE is non-nil, sort them in reverse order."
  (interactive "P")
  (pmail-sort-messages reverse
		       (function
			(lambda (msg)
			  (downcase	;Canonical name
			   (mail-strip-quoted-names
			    (or (pmail-fetch-field msg "From")
				(pmail-fetch-field msg "Sender") "")))))))

;;;###autoload
(defun pmail-sort-by-recipient (reverse)
  "Sort messages of current Pmail file by recipient.
If prefix argument REVERSE is non-nil, sort them in reverse order."
  (interactive "P")
  (pmail-sort-messages reverse
		       (function
			(lambda (msg)
			  (downcase	;Canonical name
			   (mail-strip-quoted-names
			    (or (pmail-fetch-field msg "To")
				(pmail-fetch-field msg "Apparently-To") "")
			    ))))))

;;;###autoload
(defun pmail-sort-by-correspondent (reverse)
  "Sort messages of current Pmail file by other correspondent.
If prefix argument REVERSE is non-nil, sort them in reverse order."
  (interactive "P")
  (pmail-sort-messages reverse
		       (function
			(lambda (msg)
			  (pmail-select-correspondent
			   msg
			   '("From" "Sender" "To" "Apparently-To"))))))

(defun pmail-select-correspondent (msg fields)
  (let ((ans ""))
    (while (and fields (string= ans ""))
      (setq ans
	    (pmail-dont-reply-to
	     (mail-strip-quoted-names
	      (or (pmail-fetch-field msg (car fields)) ""))))
      (setq fields (cdr fields)))
    ans))

;;;###autoload
(defun pmail-sort-by-lines (reverse)
  "Sort messages of current Pmail file by number of lines.
If prefix argument REVERSE is non-nil, sort them in reverse order."
  (interactive "P")
  (pmail-sort-messages reverse
		       (function
			(lambda (msg)
			  (count-lines (pmail-desc-get-start msg)
				       (pmail-desc-get-end msg))))))

;;;###autoload
(defun pmail-sort-by-labels (reverse labels)
  "Sort messages of current Pmail file by labels.
If prefix argument REVERSE is non-nil, sort them in reverse order.
KEYWORDS is a comma-separated list of labels."
  (interactive "P\nsSort by labels: ")
  (or (string-match "[^ \t]" labels)
      (error "No labels specified"))
  (setq labels (concat (substring labels (match-beginning 0)) ","))
  (let (labelvec)
    (while (string-match "[ \t]*,[ \t]*" labels)
      (setq labelvec (cons
		      (concat ", ?\\("
			      (substring labels 0 (match-beginning 0))
			      "\\),")
		      labelvec))
      (setq labels (substring labels (match-end 0))))
    (setq labelvec (apply 'vector (nreverse labelvec)))
    (pmail-sort-messages reverse
			 (function
			  (lambda (msg)
			    (let ((n 0))
			      (while (and (< n (length labelvec))
					  (not (pmail-message-labels-p
						msg (aref labelvec n))))
				(setq n (1+ n)))
			      n))))))
\f
;; Basic functions

(declare-function pmail-update-summary "pmailsum" (&rest ignore))

(defun pmail-sort-messages (reverse keyfun)
  "Sort messages of current Pmail file.
If 1st argument REVERSE is non-nil, sort them in reverse order.
2nd argument KEYFUN is called with a message number, and should return a key."
  (save-current-buffer
    ;; If we are in a summary buffer, operate on the Pmail buffer.
    (if (eq major-mode 'pmail-summary-mode)
	(set-buffer pmail-buffer))
    (let ((buffer-read-only nil)
	  (point-offset (- (point) (point-min)))
	  (predicate nil)			;< or string-lessp
	  (sort-lists nil))
      (message "Finding sort keys...")
      (pmail-header-show-headers)
      (widen)
      (let ((msgnum 1))
	(while (>= pmail-total-messages msgnum)
	  (setq sort-lists
		(cons (list (funcall keyfun msgnum) ;Make sorting key
			    (eq pmail-current-message msgnum) ;True if current
			    (pmail-desc-get-marker-start msgnum)
			    (pmail-desc-get-marker-end msgnum))
		      sort-lists))
	  (if (zerop (% msgnum 10))
	      (message "Finding sort keys...%d" msgnum))
	  (setq msgnum (1+ msgnum))))
      (or reverse (setq sort-lists (nreverse sort-lists)))
      ;; Decide predicate: < or string-lessp
      (if (numberp (car (car sort-lists))) ;Is a key numeric?
	  (setq predicate (function <))
	(setq predicate (function string-lessp)))
      (setq sort-lists
	    (sort sort-lists
		  (function
		   (lambda (a b)
		     (funcall predicate (car a) (car b))))))
      (if reverse (setq sort-lists (nreverse sort-lists)))
      ;; Now we enter critical region.  So, keyboard quit is disabled.
      (message "Reordering messages...")
      (let ((inhibit-quit t)		;Inhibit quit
	    (current-message nil)
	    (msgnum 1)
	    (msginfo nil))
	;; There's little hope that we can easily undo after that.
	(buffer-disable-undo (current-buffer))
	(goto-char (pmail-desc-get-start 1))
	;; To force update of all markers.
	(insert-before-markers ?Z)
	(backward-char 1)
	;; Now reorder messages.
	(while sort-lists
	  (setq msginfo (car sort-lists))
	  ;; Swap two messages.
	  (insert-buffer-substring
	   (current-buffer) (nth 2 msginfo) (nth 3 msginfo))
	  (delete-region  (nth 2 msginfo) (nth 3 msginfo))
	  ;; Is current message?
	  (if (nth 1 msginfo)
	      (setq current-message msgnum))
	  (setq sort-lists (cdr sort-lists))
	  (if (zerop (% msgnum 10))
	      (message "Reordering messages...%d" msgnum))
	  (setq msgnum (1+ msgnum)))
	;; Delete the garbage inserted before.
	(delete-char 1)
	(setq quit-flag nil)
	(buffer-enable-undo)
        (goto-char (point-min))
	(pmail-initialize-messages)
	(pmail-show-message current-message)
	(if (pmail-summary-exists)
	    (pmail-select-summary
	     (pmail-update-summary)))))))

;; mbox: ready
(defun pmail-fetch-field (msg field)
  "Return the value of the header FIELD of MSG.
Arguments are MSG and FIELD."
  (save-restriction
    (widen)
    (narrow-to-region
     (pmail-desc-get-start msg)
     (pmail-desc-get-end msg))
    (pmail-header-get-header field)))

(defun pmail-make-date-sortable (date)
  "Make DATE sortable using the function string-lessp."
  ;; Assume the default time zone is GMT.
  (timezone-make-date-sortable date "GMT" "GMT"))

(provide 'pmailsort)

;; arch-tag: 665da245-f6a7-4115-ad8c-ba19216988d5
;;; pmailsort.el ends here
Commit	Line	Data
e131541f PR	1	;;; pmailsort.el --- Pmail: sort messages
	2
	3	;; Copyright (C) 1990, 1993, 1994, 2001, 2002, 2003, 2004,
	4	;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
	5
	6	;; Author: Masanobu UMEDA <umerin@mse.kyutech.ac.jp>
	7	;; Maintainer: FSF
	8	;; Keywords: mail
	9
	10	;; This file is part of GNU Emacs.
	11
	12	;; GNU Emacs is free software: you can redistribute it and/or modify
	13	;; it under the terms of the GNU General Public License as published by
	14	;; the Free Software Foundation, either version 3 of the License, or
	15	;; (at your option) any later version.
	16
	17	;; GNU Emacs is distributed in the hope that it will be useful,
	18	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	;; GNU General Public License for more details.
	21
	22	;; You should have received a copy of the GNU General Public License
	23	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
	24
	25	;;; Commentary:
	26
	27	;;; Code:
	28
	29	(eval-when-compile
	30	(require 'mail-utils)
	31	(require 'sort)
	32	(require 'pmail))
	33
	34	(autoload 'timezone-make-date-sortable "timezone")
	35
	36	;; Sorting messages in Pmail buffer
	37
	38	;;;###autoload
	39	(defun pmail-sort-by-date (reverse)
	40	"Sort messages of current Pmail file by date.
	41	If prefix argument REVERSE is non-nil, sort them in reverse order."
	42	(interactive "P")
	43	(pmail-sort-messages reverse
	44	(function
	45	(lambda (msg)
	46	(pmail-make-date-sortable
	47	(pmail-fetch-field msg "Date"))))))
	48
	49	;;;###autoload
	50	(defun pmail-sort-by-subject (reverse)
	51	"Sort messages of current Pmail file by subject.
	52	If prefix argument REVERSE is non-nil, sort them in reverse order."
	53	(interactive "P")
	54	(pmail-sort-messages reverse
	55	(function
	56	(lambda (msg)
	57	(let ((key (or (pmail-fetch-field msg "Subject") ""))
	58	(case-fold-search t))
	59	;; Remove `Re:'
	60	(if (string-match "^\\(re:[ \t]\\)" key)
	61	(substring key (match-end 0))
	62	key))))))
	63
	64	;;;###autoload
65	(defun pmail-sort-by-author (reverse)
66	"Sort messages of current Pmail file by author.
67	If prefix argument REVERSE is non-nil, sort them in reverse order."
68	(interactive "P")
69	(pmail-sort-messages reverse
70	(function
71	(lambda (msg)
72	(downcase ;Canonical name
73	(mail-strip-quoted-names
74	(or (pmail-fetch-field msg "From")
75	(pmail-fetch-field msg "Sender") "")))))))
76
77	;;;###autoload
78	(defun pmail-sort-by-recipient (reverse)
79	"Sort messages of current Pmail file by recipient.
80	If prefix argument REVERSE is non-nil, sort them in reverse order."
81	(interactive "P")
82	(pmail-sort-messages reverse
83	(function
84	(lambda (msg)
85	(downcase ;Canonical name
86	(mail-strip-quoted-names
87	(or (pmail-fetch-field msg "To")
88	(pmail-fetch-field msg "Apparently-To") "")
89	))))))
90
91	;;;###autoload
92	(defun pmail-sort-by-correspondent (reverse)
93	"Sort messages of current Pmail file by other correspondent.
94	If prefix argument REVERSE is non-nil, sort them in reverse order."
95	(interactive "P")
96	(pmail-sort-messages reverse
97	(function
98	(lambda (msg)
99	(pmail-select-correspondent
100	msg
101	'("From" "Sender" "To" "Apparently-To"))))))
102
103	(defun pmail-select-correspondent (msg fields)
104	(let ((ans ""))
105	(while (and fields (string= ans ""))
106	(setq ans
107	(pmail-dont-reply-to
108	(mail-strip-quoted-names
109	(or (pmail-fetch-field msg (car fields)) ""))))
110	(setq fields (cdr fields)))
111	ans))
112
113	;;;###autoload
114	(defun pmail-sort-by-lines (reverse)
115	"Sort messages of current Pmail file by number of lines.
116	If prefix argument REVERSE is non-nil, sort them in reverse order."
117	(interactive "P")
118	(pmail-sort-messages reverse
119	(function
120	(lambda (msg)
121	(count-lines (pmail-desc-get-start msg)
122	(pmail-desc-get-end msg))))))
123
124	;;;###autoload
125	(defun pmail-sort-by-labels (reverse labels)
126	"Sort messages of current Pmail file by labels.
127	If prefix argument REVERSE is non-nil, sort them in reverse order.
128	KEYWORDS is a comma-separated list of labels."
129	(interactive "P\nsSort by labels: ")
130	(or (string-match "[^ \t]" labels)
131	(error "No labels specified"))
132	(setq labels (concat (substring labels (match-beginning 0)) ","))
133	(let (labelvec)
134	(while (string-match "[ \t],[ \t]" labels)
135	(setq labelvec (cons
136	(concat ", ?\\("
137	(substring labels 0 (match-beginning 0))
138	"\\),")
139	labelvec))
140	(setq labels (substring labels (match-end 0))))
141	(setq labelvec (apply 'vector (nreverse labelvec)))
142	(pmail-sort-messages reverse
143	(function
144	(lambda (msg)
145	(let ((n 0))
146	(while (and (< n (length labelvec))
147	(not (pmail-message-labels-p
148	msg (aref labelvec n))))
149	(setq n (1+ n)))
150	n))))))
151	\f
152	;; Basic functions
153
154	(declare-function pmail-update-summary "pmailsum" (&rest ignore))
155
156	(defun pmail-sort-messages (reverse keyfun)
157	"Sort messages of current Pmail file.
158	If 1st argument REVERSE is non-nil, sort them in reverse order.
159	2nd argument KEYFUN is called with a message number, and should return a key."
160	(save-current-buffer
161	;; If we are in a summary buffer, operate on the Pmail buffer.
162	(if (eq major-mode 'pmail-summary-mode)
163	(set-buffer pmail-buffer))
164	(let ((buffer-read-only nil)
165	(point-offset (- (point) (point-min)))
166	(predicate nil) ;< or string-lessp
167	(sort-lists nil))
168	(message "Finding sort keys...")
169	(pmail-header-show-headers)
170	(widen)
171	(let ((msgnum 1))
172	(while (>= pmail-total-messages msgnum)
173	(setq sort-lists
174	(cons (list (funcall keyfun msgnum) ;Make sorting key
175	(eq pmail-current-message msgnum) ;True if current
176	(pmail-desc-get-marker-start msgnum)
177	(pmail-desc-get-marker-end msgnum))
178	sort-lists))
179	(if (zerop (% msgnum 10))
180	(message "Finding sort keys...%d" msgnum))
181	(setq msgnum (1+ msgnum))))
182	(or reverse (setq sort-lists (nreverse sort-lists)))
183	;; Decide predicate: < or string-lessp
184	(if (numberp (car (car sort-lists))) ;Is a key numeric?
185	(setq predicate (function <))
186	(setq predicate (function string-lessp)))
187	(setq sort-lists
188	(sort sort-lists
189	(function
190	(lambda (a b)
191	(funcall predicate (car a) (car b))))))
192	(if reverse (setq sort-lists (nreverse sort-lists)))
193	;; Now we enter critical region. So, keyboard quit is disabled.
194	(message "Reordering messages...")
195	(let ((inhibit-quit t) ;Inhibit quit
196	(current-message nil)
197	(msgnum 1)
198	(msginfo nil))
199	;; There's little hope that we can easily undo after that.
200	(buffer-disable-undo (current-buffer))
201	(goto-char (pmail-desc-get-start 1))
202	;; To force update of all markers.
203	(insert-before-markers ?Z)
204	(backward-char 1)
205	;; Now reorder messages.
206	(while sort-lists
207	(setq msginfo (car sort-lists))
208	;; Swap two messages.
209	(insert-buffer-substring
210	(current-buffer) (nth 2 msginfo) (nth 3 msginfo))
211	(delete-region (nth 2 msginfo) (nth 3 msginfo))
212	;; Is current message?
213	(if (nth 1 msginfo)
214	(setq current-message msgnum))
215	(setq sort-lists (cdr sort-lists))
216	(if (zerop (% msgnum 10))
217	(message "Reordering messages...%d" msgnum))
218	(setq msgnum (1+ msgnum)))
219	;; Delete the garbage inserted before.
220	(delete-char 1)
221	(setq quit-flag nil)
222	(buffer-enable-undo)
223	(goto-char (point-min))
224	(pmail-initialize-messages)
225	(pmail-show-message current-message)
226	(if (pmail-summary-exists)
227	(pmail-select-summary
228	(pmail-update-summary)))))))
229
230	;; mbox: ready
231	(defun pmail-fetch-field (msg field)
232	"Return the value of the header FIELD of MSG.
233	Arguments are MSG and FIELD."
234	(save-restriction
235	(widen)
236	(narrow-to-region
237	(pmail-desc-get-start msg)
238	(pmail-desc-get-end msg))
239	(pmail-header-get-header field)))
240
241	(defun pmail-make-date-sortable (date)
242	"Make DATE sortable using the function string-lessp."
243	;; Assume the default time zone is GMT.
244	(timezone-make-date-sortable date "GMT" "GMT"))
245
246	(provide 'pmailsort)
247
0faeefbb	248	;; arch-tag: 665da245-f6a7-4115-ad8c-ba19216988d5
e131541f	249	;;; pmailsort.el ends here