* modb-legacy.el (elmo-msgdb-append-entity): Fixed the last
[elisp/wanderlust.git] / elmo / modb-legacy.el
1 ;;; modb-legacy.el --- Legacy Implement of MODB.
2
3 ;; Copyright (C) 2003 Yuuichi Teranishi <teranisi@gohome.org>
4
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;;      Hiroya Murata <lapis-lazuli@pop06.odn.ne.jp>
7 ;; Keywords: mail, net news
8
9 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
10
11 ;; This program is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15 ;;
16 ;; This program is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20 ;;
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25 ;;
26
27 ;;; Commentary:
28 ;;
29
30 ;;; Code:
31 ;;
32
33 (eval-when-compile (require 'cl))
34
35 (require 'elmo-util)
36 (require 'modb)
37
38 ;;; legacy implement
39 ;;
40
41 (defconst modb-legacy-new-mark "N"
42   "Mark for new message.")
43
44 (defconst modb-legacy-unread-uncached-mark "U"
45   "Mark for unread and uncached message.")
46
47 (defconst modb-legacy-unread-cached-mark "!"
48   "Mark for unread but already cached message.")
49
50 (defconst modb-legacy-read-uncached-mark "u"
51   "Mark for read but uncached message.")
52
53 (defconst modb-legacy-answered-cached-mark "&"
54   "Mark for answered and cached message.")
55
56 (defconst modb-legacy-answered-uncached-mark "A"
57   "Mark for answered but cached message.")
58
59 (defconst modb-legacy-important-mark "$"
60   "Mark for important message.")
61
62 (eval-and-compile
63   (luna-define-class modb-legacy (modb-generic)
64                      (overview number-alist mark-alist index))
65   (luna-define-internal-accessors 'modb-legacy))
66
67 ;; for internal use only
68 (defsubst elmo-msgdb-get-overview (msgdb)
69   (modb-legacy-overview-internal msgdb))
70
71 (defsubst elmo-msgdb-get-number-alist (msgdb)
72   (modb-legacy-number-alist-internal msgdb))
73
74 (defsubst elmo-msgdb-get-mark-alist (msgdb)
75   (modb-legacy-mark-alist-internal msgdb))
76
77 (defsubst elmo-msgdb-get-index (msgdb)
78   (modb-legacy-index-internal msgdb))
79
80 (defsubst elmo-msgdb-get-entity-hashtb (msgdb)
81   (car (modb-legacy-index-internal msgdb)))
82
83 (defsubst elmo-msgdb-get-mark-hashtb (msgdb)
84   (cdr (modb-legacy-index-internal msgdb)))
85
86 (defsubst elmo-msgdb-get-path (msgdb)
87   (elmo-msgdb-location msgdb))
88
89 (defsubst elmo-msgdb-set-overview (msgdb overview)
90   (modb-legacy-set-overview-internal msgdb overview))
91
92 (defsubst elmo-msgdb-set-number-alist (msgdb number-alist)
93   (modb-legacy-set-number-alist-internal msgdb number-alist))
94
95 (defsubst elmo-msgdb-set-mark-alist (msgdb mark-alist)
96   (modb-legacy-set-mark-alist-internal msgdb mark-alist))
97
98 (defsubst elmo-msgdb-set-index (msgdb index)
99   (modb-legacy-set-index-internal msgdb index))
100
101 (defsubst elmo-msgdb-set-path (msgdb path)
102   (modb-generic-set-location-internal msgdb path))
103
104 ;;;
105 ;; Internal use only (obsolete interface)
106 ;;
107 (defsubst elmo-msgdb-overview-entity-get-id-internal (entity)
108   (and entity (car entity)))
109
110 (defsubst elmo-msgdb-overview-entity-get-number-internal (entity)
111   (and entity (aref (cdr entity) 0)))
112
113 ;;; load & save
114 (defun elmo-msgdb-number-load (dir)
115   (elmo-object-load
116    (expand-file-name elmo-msgdb-number-filename dir)))
117
118 (defun elmo-msgdb-overview-load (dir)
119   (elmo-object-load
120    (expand-file-name elmo-msgdb-overview-filename dir)))
121
122 (defun elmo-msgdb-mark-load (dir)
123   (elmo-object-load
124    (expand-file-name elmo-msgdb-mark-filename dir)))
125
126 (defun elmo-msgdb-number-save (dir obj)
127   (elmo-object-save
128    (expand-file-name elmo-msgdb-number-filename dir)
129    obj))
130
131 (defun elmo-msgdb-mark-save (dir obj)
132   (elmo-object-save
133    (expand-file-name elmo-msgdb-mark-filename dir)
134    obj))
135
136 (defsubst elmo-msgdb-overview-save (dir overview)
137   (elmo-object-save
138    (expand-file-name elmo-msgdb-overview-filename dir)
139    overview))
140
141 ;;;
142
143
144 (defvar modb-legacy-unread-marks-internal nil)
145 (defsubst modb-legacy-unread-marks ()
146   "Return an unread mark list"
147   (or modb-legacy-unread-marks-internal
148       (setq modb-legacy-unread-marks-internal
149             (list modb-legacy-new-mark
150                   modb-legacy-unread-uncached-mark
151                   modb-legacy-unread-cached-mark))))
152
153 (defvar modb-legacy-answered-marks-internal nil)
154 (defsubst modb-legacy-answered-marks ()
155   "Return an answered mark list"
156   (or modb-legacy-answered-marks-internal
157       (setq modb-legacy-answered-marks-internal
158             (list modb-legacy-answered-cached-mark
159                   modb-legacy-answered-uncached-mark))))
160
161 (defvar modb-legacy-uncached-marks-internal nil)
162 (defsubst modb-legacy-uncached-marks ()
163   (or modb-legacy-uncached-marks-internal
164       (setq modb-legacy-uncached-marks-internal
165             (list modb-legacy-new-mark
166                   modb-legacy-answered-uncached-mark
167                   modb-legacy-unread-uncached-mark
168                   modb-legacy-read-uncached-mark))))
169
170 (defsubst modb-legacy-mark-to-flags (mark)
171   (append
172    (and (string= mark modb-legacy-new-mark)
173         '(new))
174    (and (string= mark modb-legacy-important-mark)
175         '(important))
176    (and (member mark (modb-legacy-unread-marks))
177         '(unread))
178    (and (member mark (modb-legacy-answered-marks))
179         '(answered))
180    (and (not (member mark (modb-legacy-uncached-marks)))
181         '(cached))))
182
183 (defsubst modb-legacy-flags-to-mark (flags)
184   (cond ((memq 'new flags)
185          modb-legacy-new-mark)
186         ((memq 'important flags)
187          modb-legacy-important-mark)
188         ((memq 'answered flags)
189          (if (memq 'cached flags)
190              modb-legacy-answered-cached-mark
191            modb-legacy-answered-uncached-mark))
192         ((memq 'unread flags)
193          (if (memq 'cached flags)
194              modb-legacy-unread-cached-mark
195            modb-legacy-unread-uncached-mark))
196         (t
197          (if (memq 'cached flags)
198              nil
199            modb-legacy-read-uncached-mark))))
200
201 (defsubst elmo-msgdb-get-mark (msgdb number)
202   "Get mark string from MSGDB which corresponds to the message with NUMBER."
203   (cadr (elmo-get-hash-val (format "#%d" number)
204                            (elmo-msgdb-get-mark-hashtb msgdb))))
205
206 (defsubst elmo-msgdb-set-mark (msgdb number mark)
207   "Set MARK of the message with NUMBER in the MSGDB.
208 if MARK is nil, mark is removed."
209   (let ((elem (elmo-get-hash-val (format "#%d" number)
210                                  (elmo-msgdb-get-mark-hashtb msgdb))))
211     (if elem
212         (if mark
213             ;; Set mark of the elem
214             (setcar (cdr elem) mark)
215           ;; Delete elem from mark-alist
216           (elmo-msgdb-set-mark-alist
217            msgdb
218            (delq elem (elmo-msgdb-get-mark-alist msgdb)))
219           (elmo-clear-hash-val (format "#%d" number)
220                                (elmo-msgdb-get-mark-hashtb msgdb)))
221       (when mark
222         ;; Append new element.
223         (elmo-msgdb-set-mark-alist
224          msgdb
225          (nconc
226           (elmo-msgdb-get-mark-alist msgdb)
227           (list (setq elem (list number mark)))))
228         (elmo-set-hash-val (format "#%d" number) elem
229                            (elmo-msgdb-get-mark-hashtb msgdb))))
230     (modb-generic-set-flag-modified-internal msgdb t)
231     ;; return value.
232     t))
233
234 (defun elmo-msgdb-make-index (msgdb &optional overview mark-alist)
235   "Append OVERVIEW and MARK-ALIST to the index of MSGDB.
236 If OVERVIEW and MARK-ALIST are nil, make index for current MSGDB.
237 Return a list of message numbers which have duplicated message-ids."
238   (when msgdb
239     (let* ((overview (or overview (elmo-msgdb-get-overview msgdb)))
240            (mark-alist (or mark-alist (elmo-msgdb-get-mark-alist msgdb)))
241            (index (elmo-msgdb-get-index msgdb))
242            (ehash (or (car index) ;; append
243                       (elmo-make-hash (length overview))))
244            (mhash (or (cdr index) ;; append
245                       (elmo-make-hash (length overview))))
246            duplicates)
247       (while overview
248         ;; key is message-id
249         (if (elmo-get-hash-val (caar overview) ehash) ; duplicated.
250             (setq duplicates (cons
251                               (elmo-msgdb-overview-entity-get-number-internal
252                                (car overview))
253                               duplicates)))
254         (if (caar overview)
255             (elmo-set-hash-val (caar overview) (car overview) ehash))
256         ;; key is number
257         (elmo-set-hash-val
258          (format "#%d"
259                  (elmo-msgdb-overview-entity-get-number-internal
260                   (car overview)))
261          (car overview) ehash)
262         (setq overview (cdr overview)))
263       (while mark-alist
264         ;; key is number
265         (elmo-set-hash-val
266          (format "#%d" (car (car mark-alist)))
267          (car mark-alist) mhash)
268         (setq mark-alist (cdr mark-alist)))
269       (setq index (or index (cons ehash mhash)))
270       (elmo-msgdb-set-index msgdb index)
271       duplicates)))
272
273 (defun elmo-msgdb-clear-index (msgdb entity)
274   (let ((ehash (elmo-msgdb-get-entity-hashtb msgdb))
275         (mhash (elmo-msgdb-get-mark-hashtb msgdb))
276         number)
277     (when (and entity ehash)
278       (and (setq number (elmo-msgdb-overview-entity-get-number-internal
279                          entity))
280            (elmo-clear-hash-val (format "#%d" number) ehash))
281       (and (car entity) ;; message-id
282            (elmo-clear-hash-val (car entity) ehash)))
283     (when (and entity mhash)
284       (and (setq number (elmo-msgdb-overview-entity-get-number-internal
285                          entity))
286            (elmo-clear-hash-val (format "#%d" number) mhash)))))
287
288 ;;; Implement
289 ;;
290 (luna-define-method elmo-msgdb-load ((msgdb modb-legacy))
291   (let ((inhibit-quit t)
292         (path (elmo-msgdb-location msgdb)))
293     (when (file-exists-p (expand-file-name elmo-msgdb-mark-filename path))
294       (modb-legacy-set-overview-internal
295        msgdb
296        (elmo-msgdb-overview-load path))
297       (modb-legacy-set-number-alist-internal
298        msgdb
299        (elmo-msgdb-number-load path))
300       (modb-legacy-set-mark-alist-internal
301        msgdb
302        (elmo-msgdb-mark-load path))
303       (elmo-msgdb-make-index msgdb)
304       t)))
305
306 (luna-define-method elmo-msgdb-save ((msgdb modb-legacy))
307   (let ((path (elmo-msgdb-location msgdb)))
308     (when (elmo-msgdb-message-modified-p msgdb)
309       (elmo-msgdb-overview-save
310        path
311        (modb-legacy-overview-internal msgdb))
312       (elmo-msgdb-number-save
313        path
314        (modb-legacy-number-alist-internal msgdb))
315       (modb-generic-set-message-modified-internal msgdb nil))
316     (when (elmo-msgdb-flag-modified-p msgdb)
317       (elmo-msgdb-mark-save
318        path
319        (modb-legacy-mark-alist-internal msgdb))
320       (modb-generic-set-flag-modified-internal msgdb nil))))
321
322 (luna-define-method elmo-msgdb-append :around ((msgdb modb-legacy)
323                                                msgdb-append)
324   (if (eq (luna-class-name msgdb-append)
325           'modb-legacy)
326       (let (duplicates)
327         (elmo-msgdb-set-overview
328          msgdb
329          (nconc (elmo-msgdb-get-overview msgdb)
330                 (elmo-msgdb-get-overview msgdb-append)))
331         (elmo-msgdb-set-number-alist
332          msgdb
333          (nconc (elmo-msgdb-get-number-alist msgdb)
334                 (elmo-msgdb-get-number-alist msgdb-append)))
335         (elmo-msgdb-set-mark-alist
336          msgdb
337          (nconc (elmo-msgdb-get-mark-alist msgdb)
338                 (elmo-msgdb-get-mark-alist msgdb-append)))
339         (setq duplicates (elmo-msgdb-make-index
340                           msgdb
341                           (elmo-msgdb-get-overview msgdb-append)
342                           (elmo-msgdb-get-mark-alist msgdb-append)))
343         (elmo-msgdb-set-path
344          msgdb
345          (or (elmo-msgdb-get-path msgdb)
346              (elmo-msgdb-get-path msgdb-append)))
347         (modb-generic-set-message-modified-internal msgdb t)
348         (modb-generic-set-flag-modified-internal msgdb t)
349         duplicates)
350     (luna-call-next-method)))
351
352 (luna-define-method elmo-msgdb-clear :after ((msgdb modb-legacy))
353   (elmo-msgdb-set-overview msgdb nil)
354   (elmo-msgdb-set-number-alist msgdb nil)
355   (elmo-msgdb-set-mark-alist msgdb nil)
356   (elmo-msgdb-set-index msgdb nil))
357
358 (luna-define-method elmo-msgdb-length ((msgdb modb-legacy))
359   (length (modb-legacy-overview-internal msgdb)))
360
361 (luna-define-method elmo-msgdb-flags ((msgdb modb-legacy) number)
362   (modb-legacy-mark-to-flags (elmo-msgdb-get-mark msgdb number)))
363
364 (luna-define-method elmo-msgdb-set-flag ((msgdb modb-legacy)
365                                          number flag)
366   (case flag
367     (read
368      (elmo-msgdb-unset-flag msgdb number 'unread))
369     (uncached
370      (elmo-msgdb-unset-flag msgdb number 'cached))
371     (t
372      (let* ((cur-mark (elmo-msgdb-get-mark msgdb number))
373             (flags (modb-legacy-mark-to-flags cur-mark))
374             new-mark)
375        (and (memq 'new flags)
376             (setq flags (delq 'new flags)))
377        (or (memq flag flags)
378            (setq flags (cons flag flags)))
379        (when (and (eq flag 'unread)
380                   (memq 'answered flags))
381          (setq flags (delq 'answered flags)))
382        (setq new-mark (modb-legacy-flags-to-mark flags))
383        (unless (string= new-mark cur-mark)
384          (elmo-msgdb-set-mark msgdb number new-mark))))))
385
386 (luna-define-method elmo-msgdb-unset-flag ((msgdb modb-legacy)
387                                            number flag)
388   (case flag
389     (read
390      (elmo-msgdb-set-flag msgdb number 'unread))
391     (uncached
392      (elmo-msgdb-set-flag msgdb number 'cached))
393     (all
394      (elmo-msgdb-set-mark msgdb number nil))
395     (t
396      (let* ((cur-mark (elmo-msgdb-get-mark msgdb number))
397             (flags (modb-legacy-mark-to-flags cur-mark))
398             new-mark)
399        (and (memq 'new flags)
400             (setq flags (delq 'new flags)))
401        (and (memq flag flags)
402             (setq flags (delq flag flags)))
403        (when (and (eq flag 'unread)
404                   (memq 'answered flags))
405          (setq flags (delq 'answered flags)))
406        (setq new-mark (modb-legacy-flags-to-mark flags))
407        (unless (string= new-mark cur-mark)
408          (elmo-msgdb-set-mark msgdb number new-mark))))))
409
410 (luna-define-method elmo-msgdb-flag-count ((msgdb modb-legacy))
411   (let ((new 0)
412         (unread 0)
413         (answered 0))
414     (dolist (elem (elmo-msgdb-get-mark-alist msgdb))
415       (cond
416        ((string= (cadr elem) modb-legacy-new-mark)
417         (incf new)
418         (incf unread))
419        ((member (cadr elem) (modb-legacy-unread-marks))
420         (incf unread))
421        ((member (cadr elem) (modb-legacy-answered-marks))
422         (incf answered))))
423     (list (cons 'new new)
424           (cons 'unread unread)
425           (cons 'answered answered))))
426
427 (luna-define-method elmo-msgdb-list-messages ((msgdb modb-legacy))
428   (mapcar 'elmo-msgdb-overview-entity-get-number-internal
429           (elmo-msgdb-get-overview msgdb)))
430
431 (luna-define-method elmo-msgdb-list-flagged ((msgdb modb-legacy) flag)
432   (let ((case-fold-search nil)
433         mark-regexp matched)
434     (case flag
435       (new
436        (setq mark-regexp (regexp-quote modb-legacy-new-mark)))
437       (unread
438        (setq mark-regexp (elmo-regexp-opt (modb-legacy-unread-marks))))
439       (answered
440        (setq mark-regexp (elmo-regexp-opt (modb-legacy-answered-marks))))
441       (important
442        (setq mark-regexp (regexp-quote modb-legacy-important-mark)))
443       (read
444        (setq mark-regexp (elmo-regexp-opt (modb-legacy-unread-marks))))
445       (digest
446        (setq mark-regexp (elmo-regexp-opt
447                           (append (modb-legacy-unread-marks)
448                                   (list modb-legacy-important-mark)))))
449       (any
450        (setq mark-regexp (elmo-regexp-opt
451                           (append
452                            (modb-legacy-unread-marks)
453                            (modb-legacy-answered-marks)
454                            (list modb-legacy-important-mark))))))
455     (when mark-regexp
456       (if (eq flag 'read)
457           (dolist (number (elmo-msgdb-list-messages msgdb))
458             (let ((mark (elmo-msgdb-get-mark msgdb number)))
459               (unless (and mark (string-match mark-regexp mark))
460                 (setq matched (cons number matched)))))
461         (dolist (elem (elmo-msgdb-get-mark-alist msgdb))
462           (if (string-match mark-regexp (cadr elem))
463               (setq matched (cons (car elem) matched))))))
464     matched))
465
466 (luna-define-method elmo-msgdb-search ((msgdb modb-legacy)
467                                        condition &optional numbers)
468   (if (vectorp condition)
469       (let ((key (elmo-filter-key condition))
470             results)
471         (cond
472          ((and (string= key "flag")
473                (eq (elmo-filter-type condition) 'match))
474           (setq results (elmo-msgdb-list-flagged
475                          msgdb
476                          (intern (elmo-filter-value condition))))
477           (if numbers
478               (elmo-list-filter numbers results)
479             results))
480          ((member key '("first" "last"))
481           (let* ((numbers (or numbers (elmo-msgdb-list-messages msgdb)))
482                  (len (length numbers))
483                  (lastp (string= key "last"))
484                  (value (string-to-number (elmo-filter-value condition))))
485             (when (eq (elmo-filter-type condition) 'unmatch)
486               (setq lastp (not lastp)
487                     value (- len value)))
488             (if lastp
489                 (nthcdr (max (- len value) 0) numbers)
490               (when (> value 0)
491                 (let* ((numbers (copy-sequence numbers))
492                        (last (nthcdr (1- value) numbers)))
493                   (when last
494                     (setcdr last nil))
495                   numbers)))))
496          (t
497           t)))
498     t))
499
500 (luna-define-method elmo-msgdb-append-entity ((msgdb modb-legacy)
501                                               entity &optional flags)
502   (when entity
503     (let ((number (elmo-msgdb-overview-entity-get-number-internal entity))
504           (message-id (elmo-msgdb-overview-entity-get-id-internal entity))
505           mark cell)
506       (elmo-msgdb-set-overview
507        msgdb
508        (nconc (elmo-msgdb-get-overview msgdb)
509               (list entity)))
510       (elmo-msgdb-set-number-alist
511        msgdb
512        (nconc (elmo-msgdb-get-number-alist msgdb)
513               (list (cons number message-id))))
514       (modb-generic-set-message-modified-internal msgdb t)
515       (when (setq mark (modb-legacy-flags-to-mark flags))
516         (setq cell (list number mark))
517         (elmo-msgdb-set-mark-alist
518          msgdb
519          (nconc (elmo-msgdb-get-mark-alist msgdb) (list cell)))
520         (modb-generic-set-flag-modified-internal msgdb t))
521       (elmo-msgdb-make-index
522        msgdb
523        (list entity)
524        (and cell (list cell))))))
525
526 (luna-define-method elmo-msgdb-delete-messages ((msgdb modb-legacy)
527                                                 numbers)
528   (let* ((overview (elmo-msgdb-get-overview msgdb))
529          (number-alist (elmo-msgdb-get-number-alist msgdb))
530          (mark-alist (elmo-msgdb-get-mark-alist msgdb))
531          (index (elmo-msgdb-get-index msgdb))
532          ov-entity)
533     ;; remove from current database.
534     (dolist (number numbers)
535       (setq overview
536             (delq
537              (setq ov-entity
538                    (elmo-msgdb-message-entity msgdb number))
539              overview))
540       (setq number-alist (delq (assq number number-alist) number-alist))
541       (setq mark-alist (delq (assq number mark-alist) mark-alist))
542       ;;
543       (when index (elmo-msgdb-clear-index msgdb ov-entity)))
544     (elmo-msgdb-set-overview msgdb overview)
545     (elmo-msgdb-set-number-alist msgdb number-alist)
546     (elmo-msgdb-set-mark-alist msgdb mark-alist)
547     (elmo-msgdb-set-index msgdb index)
548     (modb-generic-set-message-modified-internal msgdb t)
549     (modb-generic-set-flag-modified-internal msgdb t)
550     t)) ;return value
551
552 (luna-define-method elmo-msgdb-sort-entities ((msgdb modb-legacy)
553                                               predicate &optional app-data)
554   (message "Sorting...")
555   (let ((overview (elmo-msgdb-get-overview msgdb)))
556     (elmo-msgdb-set-overview
557      msgdb
558      (sort overview (lambda (a b) (funcall predicate a b app-data))))
559     (message "Sorting...done")
560     msgdb))
561
562 (luna-define-method elmo-msgdb-message-entity ((msgdb modb-legacy) key)
563   (when key
564     (elmo-get-hash-val
565      (cond ((stringp key) key)
566            ((numberp key) (format "#%d" key)))
567      (elmo-msgdb-get-entity-hashtb msgdb))))
568
569 (require 'product)
570 (product-provide (provide 'modb-legacy) (require 'elmo-version))
571
572 ;;; modb-legacy.el ends here