elmo/modb.el

   1 ;;; modb.el --- Message Orchestration DataBase.
   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 'luna)
  36 (require 'modb-entity)
  37
  38 (eval-and-compile
  39   (luna-define-class modb-generic () (location         ; location for save.
  40                                       message-modified ; message is modified.
  41                                       flag-modified    ; flag is modified.
  42                                       ))
  43   (luna-define-internal-accessors 'modb-generic))
  44
  45 (luna-define-generic elmo-msgdb-load (msgdb)
  46   "Load the MSGDB.")
  47
  48 (luna-define-generic elmo-msgdb-save (msgdb)
  49   "Save the MSGDB.")
  50
  51 (luna-define-generic elmo-msgdb-location (msgdb)
  52   "Return the location of MSGDB.")
  53
  54 (luna-define-generic elmo-msgdb-message-modified-p (msgdb)
  55   "Return non-nil if message is modified.")
  56
  57 (luna-define-generic elmo-msgdb-flag-modified-p (msgdb)
  58   "Return non-nil if flag is modified.")
  59
  60 (luna-define-generic elmo-msgdb-append (msgdb msgdb-append)
  61   "Append the MSGDB-APPEND to the MSGDB.
  62 Return a list of messages which have duplicated message-id.")
  63
  64 (luna-define-generic elmo-msgdb-clear (msgdb)
  65   "Clear the MSGDB structure.")
  66
  67 (luna-define-generic elmo-msgdb-length (msgdb)
  68   "Return number of messages in the MSGDB")
  69
  70 (luna-define-generic elmo-msgdb-flags (msgdb number)
  71   "Return a list of flag which corresponds to the message with NUMBER.")
  72
  73 (luna-define-generic elmo-msgdb-set-flag (msgdb number flag)
  74   "Set message flag.
  75 MSGDB is the ELMO msgdb.
  76 NUMBER is a message number to set flag.
  77 FLAG is a symbol which is one of the following:
  78 `new'       ... Message which is new.
  79 `read'      ... Message which is already read.
  80 `important' ... Message which is important.
  81 `answered'  ... Message which is answered.
  82 `cached'    ... Message which is cached.")
  83
  84 (luna-define-generic elmo-msgdb-unset-flag (msgdb number flag)
  85   "Unset message flag.
  86 MSGDB is the ELMO msgdb.
  87 NUMBER is a message number to set flag.
  88 FLAG is a symbol which is one of the following:
  89 `new'       ... Message which is new.
  90 `read'      ... Message which is already read.
  91 `important' ... Message which is important.
  92 `answered'  ... Message which is answered.
  93 `cached'    ... Message which is cached.")
  94
  95 (luna-define-generic elmo-msgdb-list-messages (msgdb)
  96   "Return a list of message numbers in the MSGDB.")
  97
  98 (luna-define-generic elmo-msgdb-list-flagged (msgdb flag)
  99   "Return a list of message numbers which is set FLAG in the MSGDB.")
 100
 101 (luna-define-generic elmo-msgdb-search (msgdb condition &optional numbers)
 102   "Search and return list of message numbers.
 103 MSGDB is the ELMO msgdb structure.
 104 CONDITION is a condition structure for searching.
 105 If optional argument NUMBERS is specified and is a list of message numbers,
 106 messages are searched from the list.
 107 Return t if the condition is unsupported.")
 108
 109 (luna-define-generic elmo-msgdb-match-condition (msgdb condition number
 110                                                        &optional numbers)
 111   "Check whether the condition of the message is satisfied or not.
 112 MSGDB is the msgdb to search from.
 113 CONDITION is the search condition.
 114 NUMBER is the message number to check.
 115 If optional argument NUMBERS is specified and is a list of message numbers,
 116 messages are searched from the list.
 117 Return CONDITION itself if no entity exists in msgdb.")
 118
 119 (luna-define-generic elmo-msgdb-append-entity (msgdb entity &optional flags)
 120   "Append a ENTITY with FLAGS into the MSGDB.
 121 Return non-nil if message-id of entity is duplicated.")
 122
 123 (luna-define-generic elmo-msgdb-delete-messages (msgdb numbers)
 124   "Delete messages which are contained NUMBERS from MSGDB.")
 125
 126 (luna-define-generic elmo-msgdb-sort-entities (msgdb predicate
 127                                                      &optional app-data)
 128   "Sort entities of MSGDB, comparing with PREDICATE.
 129 PREDICATE is called with two entities and APP-DATA.
 130 Should return non-nil if the first entity is \"less\" than the second.")
 131
 132 (luna-define-generic elmo-msgdb-message-entity (msgdb key)
 133   "Return the message-entity structure which matches to the KEY.
 134 KEY is a number or a string.
 135 A number is for message number in the MSGDB.
 136 A string is for message-id of the message.")
 137
 138 (luna-define-generic elmo-msgdb-message-entity-handler (msgdb)
 139   "Get modb entity handler instance which corresponds to the MSGDB.")
 140
 141 ;;; generic implement
 142 ;;
 143 (luna-define-method elmo-msgdb-load ((msgdb modb-generic))
 144   t)
 145
 146 (luna-define-method elmo-msgdb-location ((msgdb modb-generic))
 147   (modb-generic-location-internal msgdb))
 148
 149 (luna-define-method elmo-msgdb-message-modified-p ((msgdb modb-generic))
 150   (modb-generic-message-modified-internal msgdb))
 151
 152 (luna-define-method elmo-msgdb-flag-modified-p ((msgdb modb-generic))
 153   (modb-generic-flag-modified-internal msgdb))
 154
 155 (luna-define-method elmo-msgdb-append ((msgdb modb-generic) msgdb-append)
 156   (let (duplicates)
 157     (dolist (number (elmo-msgdb-list-messages msgdb-append))
 158       (when (elmo-msgdb-append-entity
 159              msgdb
 160              (elmo-msgdb-message-entity msgdb-append number)
 161              (elmo-msgdb-flags msgdb-append number))
 162         (setq duplicates (cons number duplicates))))
 163     duplicates))
 164
 165 (luna-define-method elmo-msgdb-clear ((msgdb modb-generic))
 166   (modb-generic-set-message-modified-internal msgdb nil)
 167   (modb-generic-set-flag-modified-internal msgdb nil))
 168
 169 (luna-define-method elmo-msgdb-length ((msgdb modb-generic))
 170   0)
 171
 172 (luna-define-method elmo-msgdb-search ((msgdb modb-generic)
 173                                        condition &optional numbers)
 174   t)
 175
 176 (luna-define-method elmo-msgdb-match-condition ((msgdb modb-generic)
 177                                                 condition
 178                                                 number
 179                                                 &optional numbers)
 180   (let ((entity (elmo-msgdb-message-entity msgdb number)))
 181     (if entity
 182         (elmo-msgdb-message-match-condition
 183          (elmo-msgdb-message-entity-handler msgdb)
 184          condition
 185          entity
 186          (elmo-msgdb-flags msgdb number)
 187          (or numbers (elmo-msgdb-list-messages msgdb)))
 188       condition)))
 189
 190 (luna-define-method elmo-msgdb-message-entity-handler ((msgdb modb-generic))
 191   (or modb-entity-default-cache-internal
 192       (setq modb-entity-default-cache-internal
 193             (luna-make-entity modb-entity-default-handler))))
 194
 195 ;; for on demand loading
 196 (provide 'modb-generic)
 197
 198 (require 'product)
 199 (product-provide (provide 'modb) (require 'elmo-version))
 200
 201 ;;; modb.el ends here