1 ;;; modb-standard.el --- Standartd Implement of MODB.
3 ;; Copyright (C) 2003 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Hiroya Murata <lapis-lazuli@pop06.odn.ne.jp>
7 ;; Keywords: mail, net news
9 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
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)
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.
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.
32 (eval-when-compile (require 'cl))
37 (defcustom modb-standard-divide-number 500
38 "*Standard modb divide entity number."
39 :type '(choice (const :tag "Not divide" nil)
43 (defvar modb-standard-entity-filename "entity"
44 "Message entity database.")
46 (defvar modb-standard-flag-filename "flag"
47 "Message number <=> Flag status database.")
49 (defvar modb-standard-msgid-filename "msgid"
50 "Message number <=> Message-Id database.")
53 (luna-define-class modb-standard (modb-generic)
54 (number-list ; sorted list of message numbers.
55 entity-map ; number, msg-id -> entity mapping.
56 flag-map ; number -> flag-list mapping
57 flag-count ; list of (FLAG . COUNT)
58 overview-handler ; instance of modb-entity-handler.
60 (luna-define-internal-accessors 'modb-standard))
62 ;; for internal use only
63 (defsubst modb-standard-key (number)
64 (concat "#" (number-to-string number)))
66 (defsubst modb-standard-entity-id (entity)
67 (if (eq 'autoload (car-safe entity))
69 (elmo-msgdb-message-entity-field
70 (elmo-message-entity-handler entity)
73 (defsubst modb-standard-entity-map (modb)
74 (or (modb-standard-entity-map-internal modb)
75 (modb-standard-set-entity-map-internal
77 (elmo-make-hash (elmo-msgdb-length modb)))))
79 (defsubst modb-standard-flag-map (modb)
80 (or (modb-standard-flag-map-internal modb)
81 (modb-standard-set-flag-map-internal
83 (elmo-make-hash (elmo-msgdb-length modb)))))
85 (defsubst modb-standard-set-message-modified (modb number)
86 (if modb-standard-divide-number
87 (let ((section (/ number modb-standard-divide-number))
88 (modified (modb-generic-message-modified-internal modb)))
89 (unless (memq section modified)
90 (modb-generic-set-message-modified-internal
91 modb (cons section modified))))
92 (modb-generic-set-message-modified-internal modb t)))
94 (defsubst modb-standard-set-flag-modified (modb number)
95 (modb-generic-set-flag-modified-internal modb t))
97 (defsubst modb-standard-message-flags (modb number)
98 (cdr (elmo-get-hash-val (modb-standard-key number)
99 (modb-standard-flag-map-internal modb))))
101 (defsubst modb-standard-match-flags (check-flags flags)
104 (when (memq (car check-flags) flags)
106 (setq check-flags (cdr check-flags)))))
108 (defsubst modb-standard-countup-flags (modb flags &optional delta)
109 (let ((flag-count (modb-standard-flag-count-internal modb))
113 (if (setq elem (assq flag flag-count))
114 (setcdr elem (+ (cdr elem) delta))
115 (setq flag-count (cons (cons flag delta) flag-count))))
116 (modb-standard-set-flag-count-internal modb flag-count)))
118 ;; save and load functions
119 (defun modb-standard-load-msgid (modb path)
120 (let* ((alist (elmo-object-load
121 (expand-file-name modb-standard-msgid-filename path)))
122 (table (or (modb-standard-entity-map-internal modb)
123 (elmo-make-hash (length alist))))
126 (setq info (cons 'autoload pair))
127 (elmo-set-hash-val (modb-standard-key (car pair)) info table)
128 (elmo-set-hash-val (cdr pair) info table)
129 (setq numbers (cons (car pair) numbers)))
130 (modb-standard-set-number-list-internal modb (nreverse numbers))
131 (modb-standard-set-entity-map-internal modb table)))
133 (defun modb-standard-save-msgid (modb path)
134 (let ((table (modb-standard-entity-map-internal modb))
136 (dolist (number (modb-standard-number-list-internal modb))
137 (setq entity (elmo-get-hash-val (modb-standard-key number) table))
138 (setq alist (cons (cons number (modb-standard-entity-id entity))
141 (expand-file-name modb-standard-msgid-filename path)
144 (defun modb-standard-load-flag (modb path)
145 (let ((table (or (modb-standard-flag-map-internal modb)
146 (elmo-make-hash (elmo-msgdb-length modb)))))
147 (dolist (info (elmo-object-load
148 (expand-file-name modb-standard-flag-filename path)))
149 (modb-standard-countup-flags modb (cdr info))
150 (elmo-set-hash-val (modb-standard-key (car info)) info table))
151 (modb-standard-set-flag-map-internal modb table)))
153 (defun modb-standard-save-flag (modb path)
154 (let (table flist info)
155 (when (setq table (modb-standard-flag-map-internal modb))
158 (setq info (symbol-value atom))
160 (setq flist (cons info flist))))
163 (expand-file-name modb-standard-flag-filename path)
166 (defsubst modb-standard-entity-filename (section)
168 (concat modb-standard-entity-filename
170 (number-to-string section))
171 modb-standard-entity-filename))
173 (defsubst modb-standard-loaded-message-id (msgdb number)
174 "Get message-id for autoloaded entity."
175 (let ((ret (elmo-get-hash-val
176 (modb-standard-key number)
177 (modb-standard-entity-map-internal msgdb))))
181 (elmo-clear-hash-val (modb-standard-key number)
182 (modb-standard-entity-map-internal msgdb))
184 ((eq (car-safe ret) 'autoload)
185 (cdr (cdr ret))) ; message-id.
186 ((elmo-msgdb-message-entity-field (elmo-message-entity-handler ret)
187 ret 'message-id)) ; Already loaded.
188 (t (error "Internal error: invalid msgdb status")))))
190 (defun modb-standard-load-entity (modb path &optional section)
191 (let ((table (or (modb-standard-entity-map-internal modb)
192 (elmo-make-hash (elmo-msgdb-length modb))))
193 (objects (elmo-object-load
195 (modb-standard-entity-filename section)
198 (cond ((eq (car objects) 'modb-standard-entity-handler)
199 ;; (standard PARAMETERS ENTITY*)
200 (let ((handler (apply #'luna-make-entity
202 (car (cdr objects))))
204 (dolist (element (cdr (cdr objects)))
205 (setq entity (cons handler (cons nil element))
206 number (elmo-msgdb-message-entity-number handler entity)
207 msgid (modb-standard-loaded-message-id modb number))
209 (elmo-msgdb-message-entity-set-field
210 handler entity 'message-id msgid)
211 (elmo-set-hash-val (modb-standard-key number) entity table)
212 (elmo-set-hash-val msgid entity table)))))
215 (dolist (entity objects)
216 (setq number (elmo-msgdb-message-entity-number
217 (elmo-message-entity-handler entity)
219 msgid (modb-standard-loaded-message-id modb number))
221 (setcar entity msgid)
222 (elmo-set-hash-val (modb-standard-key number) entity table)
223 (elmo-set-hash-val msgid entity table)))))
224 (modb-standard-set-entity-map-internal modb table)))
226 (defsubst modb-standard-save-entity-1 (modb path &optional section)
227 (let ((table (modb-standard-entity-map-internal modb))
228 (filename (expand-file-name
229 (modb-standard-entity-filename (car section)) path))
230 (handler (elmo-msgdb-message-entity-handler modb))
232 (dolist (number (or (cdr section)
233 (modb-standard-number-list-internal modb)))
234 (when (setq entity (elmo-msgdb-message-entity modb number))
235 (unless (modb-entity-handler-equal-p
237 (elmo-message-entity-handler entity))
238 (setq entity (elmo-msgdb-copy-message-entity
239 (elmo-message-entity-handler entity)
241 (setq entities (cons (cdr (cdr entity)) entities))))
243 (elmo-object-save filename
245 (list (luna-class-name handler)
246 (modb-entity-handler-dump-parameters handler))
248 (ignore-errors (delete-file filename)))))
250 (defun modb-standard-cleanup-stale-entities (modb path)
251 (message "Removing stale entities...")
253 (concat "^" modb-standard-entity-filename "-\\([0-9]+\\)"))
254 (entities (elmo-uniq-list
256 (lambda (x) (/ x modb-standard-divide-number))
257 (modb-standard-number-list-internal modb))))
258 (files (mapcar (lambda(x)
259 (when (string-match entity-regex x)
260 (string-to-number (match-string 1 x))))
261 (directory-files path nil entity-regex))))
262 (dolist (entity (car (elmo-list-diff-nonsortable files entities)))
263 (ignore-errors (delete-file
265 (modb-standard-entity-filename entity) path))))))
267 (defun modb-standard-save-entity (modb path)
268 (let ((modified (modb-generic-message-modified-internal modb)))
269 (cond ((listp modified)
270 (let ((sections (mapcar 'list modified))
272 (dolist (number (modb-standard-number-list-internal modb))
273 (when (setq section (assq (/ number modb-standard-divide-number)
275 (nconc section (list number))))
276 (dolist (section sections)
277 (modb-standard-save-entity-1 modb path section))))
279 (modb-standard-save-entity-1 modb path)))))
283 (luna-define-method elmo-msgdb-load ((msgdb modb-standard))
284 (let ((inhibit-quit t)
285 (path (elmo-msgdb-location msgdb)))
286 (when (file-exists-p (expand-file-name modb-standard-flag-filename path))
287 (modb-standard-load-msgid msgdb path)
288 (modb-standard-load-flag msgdb path)
289 (unless modb-standard-divide-number
290 (modb-standard-load-entity msgdb path))
293 (luna-define-method elmo-msgdb-save ((msgdb modb-standard))
294 (let ((path (elmo-msgdb-location msgdb))
296 (when (elmo-msgdb-message-modified-p msgdb)
297 (modb-standard-save-msgid msgdb path)
298 (modb-standard-save-entity msgdb path)
299 (modb-generic-set-message-modified-internal msgdb nil))
300 (when (elmo-msgdb-flag-modified-p msgdb)
301 (modb-standard-save-flag msgdb path)
302 (modb-generic-set-flag-modified-internal msgdb nil))))
304 (luna-define-method elmo-msgdb-append :around ((msgdb modb-standard)
306 (when (> (elmo-msgdb-length msgdb-append) 0)
307 (if (eq (luna-class-name msgdb-append) 'modb-standard)
308 (let ((numbers (modb-standard-number-list-internal msgdb-append))
311 (modb-standard-set-number-list-internal
313 (nconc (modb-standard-number-list-internal msgdb)
316 (let ((table (modb-standard-entity-map msgdb))
318 (dolist (number numbers)
319 (setq entity (elmo-msgdb-message-entity msgdb-append number)
320 msg-id (modb-standard-entity-id entity))
321 (if (elmo-get-hash-val msg-id table)
322 (setq duplicates (cons number duplicates))
323 (elmo-set-hash-val msg-id entity table))
324 (elmo-set-hash-val (modb-standard-key number)
328 (let ((table (modb-standard-flag-map msgdb)))
331 (elmo-set-hash-val (symbol-name atom)
334 (modb-standard-flag-map msgdb-append)))
336 (dolist (pair (modb-standard-flag-count-internal msgdb-append))
337 (modb-standard-countup-flags msgdb (list (car pair)) (cdr pair)))
338 ;; modification flags
339 (dolist (number (modb-standard-number-list-internal msgdb-append))
340 (modb-standard-set-message-modified msgdb number)
341 (modb-standard-set-flag-modified msgdb number))
343 (luna-call-next-method))))
345 (luna-define-method elmo-msgdb-clear :after ((msgdb modb-standard))
346 (modb-standard-set-number-list-internal msgdb nil)
347 (modb-standard-set-entity-map-internal msgdb nil)
348 (modb-standard-set-flag-map-internal msgdb nil)
349 (modb-standard-set-flag-count-internal msgdb nil))
351 (luna-define-method elmo-msgdb-length ((msgdb modb-standard))
352 (length (modb-standard-number-list-internal msgdb)))
354 (luna-define-method elmo-msgdb-flag-available-p ((msgdb modb-standard) flag)
357 (luna-define-method elmo-msgdb-flags ((msgdb modb-standard) number)
358 (modb-standard-message-flags msgdb number))
360 (luna-define-method elmo-msgdb-set-flag ((msgdb modb-standard)
364 (elmo-msgdb-unset-flag msgdb number 'unread))
366 (elmo-msgdb-unset-flag msgdb number 'cached))
368 (let ((cur-flags (modb-standard-message-flags msgdb number))
370 (unless (memq flag cur-flags)
371 (setq new-flags (cons flag cur-flags))
372 (setq diff (elmo-list-diff-nonsortable new-flags cur-flags))
373 (modb-standard-countup-flags msgdb (car diff))
374 (modb-standard-countup-flags msgdb (cadr diff) -1)
375 (elmo-set-hash-val (modb-standard-key number)
376 (cons number new-flags)
377 (modb-standard-flag-map msgdb))
378 (modb-standard-set-flag-modified msgdb number))))))
380 (luna-define-method elmo-msgdb-unset-flag ((msgdb modb-standard)
384 (elmo-msgdb-set-flag msgdb number 'unread))
386 (elmo-msgdb-set-flag msgdb number 'cached))
388 (modb-standard-countup-flags msgdb
389 (modb-standard-message-flags msgdb number)
391 (elmo-clear-hash-val (modb-standard-key number)
392 (modb-standard-flag-map msgdb)))
394 (let ((cur-flags (modb-standard-message-flags msgdb number))
397 (when (memq flag cur-flags)
398 (setq new-flags (delq flag (copy-sequence cur-flags)))
399 (setq diff (elmo-list-diff-nonsortable new-flags cur-flags))
400 (modb-standard-countup-flags msgdb (car diff))
401 (modb-standard-countup-flags msgdb (cadr diff) -1)
402 (elmo-set-hash-val (modb-standard-key number)
403 (cons number new-flags)
404 (modb-standard-flag-map msgdb))
405 (modb-standard-set-flag-modified msgdb number))
406 (when (eq flag 'unread)
407 (elmo-msgdb-unset-flag msgdb number 'new))))))
409 (luna-define-method elmo-msgdb-flag-count ((msgdb modb-standard))
410 (modb-standard-flag-count-internal msgdb))
412 (luna-define-method elmo-msgdb-list-messages ((msgdb modb-standard))
414 (modb-standard-number-list-internal msgdb)))
416 (luna-define-method elmo-msgdb-list-flagged ((msgdb modb-standard) flag)
420 (dolist (number (modb-standard-number-list-internal msgdb))
421 (unless (memq 'unread (modb-standard-message-flags msgdb number))
422 (setq matched (cons number matched)))))
424 (dolist (number (modb-standard-number-list-internal msgdb))
425 (unless (memq 'cached (modb-standard-message-flags msgdb number))
426 (setq matched (cons number matched)))))
430 (setq entry (symbol-value atom))
431 (unless (and (eq (length (cdr entry)) 1)
432 (eq (car (cdr entry)) 'cached))
433 ;; If there is a flag other than cached, then the message
435 (setq matched (cons (car entry) matched))))
436 (modb-standard-flag-map msgdb)))
438 (let ((flags (append elmo-digest-flags
439 (elmo-get-global-flags t t))))
442 (setq entry (symbol-value atom))
443 (when (modb-standard-match-flags flags (cdr entry))
444 (setq matched (cons (car entry) matched))))
445 (modb-standard-flag-map msgdb))))
449 (setq entry (symbol-value atom))
450 (when (memq flag (cdr entry))
451 (setq matched (cons (car entry) matched))))
452 (modb-standard-flag-map msgdb))))
455 (luna-define-method elmo-msgdb-search ((msgdb modb-standard)
456 condition &optional numbers)
457 (if (vectorp condition)
458 (let ((key (elmo-filter-key condition))
461 ((and (string= key "flag")
462 (eq (elmo-filter-type condition) 'match))
463 (setq results (elmo-msgdb-list-flagged
465 (intern (elmo-filter-value condition))))
467 (elmo-list-filter numbers results)
469 ((member key '("first" "last"))
470 (let* ((numbers (or numbers
471 (modb-standard-number-list-internal msgdb)))
472 (len (length numbers))
473 (lastp (string= key "last"))
474 (value (string-to-number (elmo-filter-value condition))))
475 (when (eq (elmo-filter-type condition) 'unmatch)
476 (setq lastp (not lastp)
477 value (- len value)))
479 (nthcdr (max (- len value) 0) numbers)
481 (let* ((numbers (copy-sequence numbers))
482 (last (nthcdr (1- value) numbers)))
490 (luna-define-method elmo-msgdb-append-entity ((msgdb modb-standard)
491 entity &optional flags)
493 (let ((number (elmo-msgdb-message-entity-number
494 (elmo-message-entity-handler entity) entity))
495 (msg-id (elmo-msgdb-message-entity-field
496 (elmo-message-entity-handler entity) entity 'message-id))
498 (when (and number msg-id)
500 (modb-standard-set-number-list-internal
502 (nconc (modb-standard-number-list-internal msgdb)
505 (let ((table (modb-standard-entity-map msgdb)))
506 (setq duplicate (elmo-get-hash-val msg-id table))
507 (elmo-set-hash-val (modb-standard-key number) entity table)
508 (elmo-set-hash-val msg-id entity table))
509 ;; modification flags
510 (modb-standard-set-message-modified msgdb number)
514 (modb-standard-key number)
516 (modb-standard-flag-map msgdb))
517 (modb-standard-countup-flags msgdb flags)
518 (modb-standard-set-flag-modified msgdb number))
521 (luna-define-method elmo-msgdb-update-entity ((msgdb modb-standard)
523 (let ((handler (elmo-message-entity-handler entity)))
524 (when (elmo-msgdb-message-entity-update-fields handler entity values)
525 (modb-standard-set-message-modified
527 (elmo-msgdb-message-entity-number handler entity))
530 (luna-define-method elmo-msgdb-delete-messages ((msgdb modb-standard)
532 (let ((number-list (modb-standard-number-list-internal msgdb))
533 (entity-map (modb-standard-entity-map-internal msgdb))
534 (flag-map (modb-standard-flag-map-internal msgdb))
536 (dolist (number numbers)
537 (setq key (modb-standard-key number)
538 entity (elmo-get-hash-val key entity-map))
541 (setq number-list (delq number number-list))
543 (elmo-clear-hash-val key entity-map)
544 (elmo-clear-hash-val (modb-standard-entity-id entity) entity-map)
545 ;; flag-count (must be BEFORE flag-map)
546 (modb-standard-countup-flags
548 (modb-standard-message-flags msgdb number)
551 (elmo-clear-hash-val key flag-map)
552 (modb-standard-set-message-modified msgdb number)
553 (modb-standard-set-flag-modified msgdb number)))
554 (modb-standard-set-number-list-internal msgdb number-list)
555 (modb-standard-set-entity-map-internal msgdb entity-map)
556 (modb-standard-set-flag-map-internal msgdb flag-map)
559 (luna-define-method elmo-msgdb-sort-entities ((msgdb modb-standard)
560 predicate &optional app-data)
561 (message "Sorting...")
562 (let ((numbers (modb-standard-number-list-internal msgdb)))
563 (modb-standard-set-number-list-internal
565 (sort numbers (lambda (a b)
567 (elmo-msgdb-message-entity msgdb a)
568 (elmo-msgdb-message-entity msgdb b)
570 (message "Sorting...done")
573 (defun modb-standard-message-entity (msgdb key load)
574 (let ((ret (elmo-get-hash-val
576 (modb-standard-entity-map-internal msgdb)))
578 (if (eq 'autoload (car-safe ret))
579 (when (and load modb-standard-divide-number)
580 (modb-standard-load-entity
582 (elmo-msgdb-location msgdb)
583 (/ (nth 1 ret) modb-standard-divide-number))
584 (modb-standard-message-entity msgdb key nil))
587 (luna-define-method elmo-msgdb-message-number ((msgdb modb-standard)
589 (let ((ret (elmo-get-hash-val
591 (modb-standard-entity-map-internal msgdb))))
592 (if (eq 'autoload (car-safe ret))
593 ;; Not loaded yet but can return number.
595 (elmo-message-entity-number ret))))
597 (luna-define-method elmo-msgdb-message-field ((msgdb modb-standard)
598 number field &optional type)
599 (let ((ret (elmo-get-hash-val
600 (modb-standard-key number)
601 (modb-standard-entity-map-internal msgdb))))
602 (if (and (eq 'autoload (car-safe ret)) (eq field 'message-id))
603 ;; Not loaded yet but can return message-id
605 (elmo-message-entity-field (elmo-msgdb-message-entity
606 msgdb (modb-standard-key number))
609 (luna-define-method elmo-msgdb-message-entity ((msgdb modb-standard) key)
611 (modb-standard-message-entity
613 (cond ((stringp key) key)
614 ((numberp key) (modb-standard-key key)))
617 (luna-define-method elmo-msgdb-message-entity-handler ((msgdb modb-standard))
618 (or (modb-standard-overview-handler-internal msgdb)
619 (modb-standard-set-overview-handler-internal
621 (luna-make-entity 'modb-standard-entity-handler
623 (modb-generic-mime-charset-internal msgdb)))))
626 (product-provide (provide 'modb-standard) (require 'elmo-version))
628 ;;; modb-standard.el ends here