elmo/elmo-filter.el

   1 ;;; elmo-filter.el --- Filtered Folder Interface for ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 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 (require 'elmo)
  33 (require 'elmo-msgdb)
  34
  35 (defvar elmo-filter-number-filename "number-list"
  36   "File name for message number database.")
  37
  38 ;;; ELMO filter folder
  39 (eval-and-compile
  40   (luna-define-class elmo-filter-folder (elmo-folder)
  41                      (condition target require-msgdb number-list flag-count))
  42   (luna-define-internal-accessors 'elmo-filter-folder))
  43
  44 (luna-define-method elmo-folder-initialize ((folder elmo-filter-folder)
  45                                             name)
  46   (let (pair)
  47     (setq pair (elmo-parse-search-condition name))
  48     (elmo-filter-folder-set-condition-internal folder
  49                                                (car pair))
  50     (if (string-match "^ */\\(.*\\)$" (cdr pair))
  51         (elmo-filter-folder-set-target-internal
  52          folder
  53          (elmo-make-folder (elmo-match-string 1 (cdr pair))))
  54       (error "Folder syntax error `%s'" (elmo-folder-name-internal folder)))
  55     (elmo-filter-folder-set-require-msgdb-internal
  56      folder
  57      (elmo-folder-search-requires-msgdb-p
  58       (elmo-filter-folder-target-internal folder)
  59       (elmo-filter-folder-condition-internal folder)))
  60     folder))
  61
  62 (defun elmo-filter-number-list-load (dir)
  63   (elmo-object-load
  64    (expand-file-name elmo-filter-number-filename dir)))
  65
  66 (defun elmo-filter-number-list-save (dir number-list)
  67   (elmo-object-save
  68    (expand-file-name elmo-filter-number-filename dir)
  69    number-list))
  70
  71 (defun elmo-filter-folder-number-list (folder)
  72   (or (elmo-filter-folder-number-list-internal folder)
  73       (elmo-filter-folder-set-number-list-internal
  74        folder
  75        (elmo-filter-number-list-load (elmo-folder-msgdb-path folder)))))
  76
  77 (defsubst elmo-filter-folder-countup-message-flags (folder numbers
  78                                                            &optional delta)
  79   (let ((flag-count (elmo-filter-folder-flag-count-internal folder))
  80         (delta (or delta 1))
  81         elem)
  82     (dolist (number numbers)
  83       (dolist (flag (elmo-message-flags folder number))
  84         (if (setq elem (assq flag flag-count))
  85             (setcdr elem (+ (cdr elem) delta))
  86           (setq flag-count (cons (cons flag delta) flag-count)))))
  87     (elmo-filter-folder-set-flag-count-internal folder flag-count)))
  88
  89 (defun elmo-filter-folder-flag-count (folder)
  90   (or (elmo-filter-folder-flag-count-internal folder)
  91       (elmo-filter-folder-countup-message-flags
  92        folder
  93        (elmo-folder-list-messages folder t t))))
  94
  95 (luna-define-method elmo-folder-open :after ((folder elmo-filter-folder)
  96                                              &optional load-msgdb)
  97   (when load-msgdb
  98     (elmo-filter-folder-number-list folder)
  99     (elmo-filter-folder-flag-count folder)
 100     (elmo-folder-msgdb (elmo-filter-folder-target-internal folder))))
 101
 102 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
 103   (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
 104
 105 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
 106   (when (elmo-filter-folder-require-msgdb-internal folder)
 107     (elmo-folder-synchronize (elmo-filter-folder-target-internal folder))))
 108
 109 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
 110   (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
 111
 112 (luna-define-method elmo-folder-close :after ((folder elmo-filter-folder))
 113   (elmo-filter-folder-set-number-list-internal folder nil)
 114   (elmo-filter-folder-set-flag-count-internal folder nil)
 115   (elmo-folder-set-msgdb-internal
 116    (elmo-filter-folder-target-internal folder) nil))
 117
 118 (luna-define-method elmo-folder-commit ((folder elmo-filter-folder))
 119   (elmo-folder-commit (elmo-filter-folder-target-internal folder))
 120   (when (elmo-folder-persistent-p folder)
 121     (elmo-folder-set-info-max-by-numdb
 122      folder
 123      (elmo-folder-list-messages folder nil 'in-msgdb))
 124     (elmo-msgdb-killed-list-save
 125      (elmo-folder-msgdb-path folder)
 126      (elmo-folder-killed-list-internal folder))
 127     (elmo-filter-number-list-save
 128      (elmo-folder-msgdb-path folder)
 129      (elmo-filter-folder-number-list-internal folder))))
 130
 131 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 132                                                     elmo-filter-folder))
 133   (expand-file-name
 134    (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
 135    (expand-file-name "filter" elmo-msgdb-directory)))
 136
 137 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
 138                                                           elmo-filter-folder)
 139                                                          condition)
 140   (elmo-folder-search-requires-msgdb-p
 141    (elmo-filter-folder-target-internal folder) condition))
 142
 143 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
 144   (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
 145
 146 (luna-define-method elmo-find-fetch-strategy
 147   ((folder elmo-filter-folder) entity &optional ignore-cache)
 148   (elmo-find-fetch-strategy
 149    (elmo-filter-folder-target-internal folder)
 150    entity ignore-cache))
 151
 152 (luna-define-method elmo-folder-get-primitive-list ((folder
 153                                                      elmo-filter-folder))
 154   (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
 155
 156 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
 157                                                type)
 158   (elmo-folder-contains-type
 159    (elmo-filter-folder-target-internal folder)
 160    type))
 161
 162 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
 163                                                &optional flag number)
 164   (elmo-folder-append-buffer
 165    (elmo-filter-folder-target-internal folder)
 166    flag number))
 167
 168 (luna-define-method elmo-message-fetch-bodystructure ((folder
 169                                                        elmo-filter-folder)
 170                                                       number strategy)
 171   (elmo-message-fetch-bodystructure
 172    (elmo-filter-folder-target-internal folder)
 173    number strategy))
 174
 175 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
 176                                         number strategy
 177                                         &optional section outbuf unseen)
 178   (elmo-message-fetch
 179    (elmo-filter-folder-target-internal folder)
 180    number strategy section outbuf unseen))
 181
 182 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
 183                                                  numbers)
 184   (elmo-folder-delete-messages
 185    (elmo-filter-folder-target-internal folder) numbers))
 186
 187 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
 188                                                &optional visible-only in-msgdb)
 189   (let ((list (if in-msgdb
 190                   t
 191                 (elmo-folder-list-messages-internal folder visible-only)))
 192         (killed-list (elmo-folder-killed-list-internal folder)))
 193     (unless (listp list)
 194       ;; Use current list.
 195       (setq list (elmo-filter-folder-number-list folder)))
 196     (if visible-only
 197         (elmo-living-messages list killed-list)
 198       (if (and in-msgdb killed-list list)
 199           (elmo-uniq-sorted-list
 200            (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
 201            #'eq)
 202         list))))
 203
 204 (luna-define-method elmo-folder-list-messages-internal
 205   ((folder elmo-filter-folder) &optional nohide)
 206   (let ((target (elmo-filter-folder-target-internal folder)))
 207     (if (or (elmo-folder-plugged-p target)
 208             (not (elmo-folder-persistent-p folder)))
 209         ;; search target folder
 210         (elmo-folder-search
 211          target
 212          (elmo-filter-folder-condition-internal folder))
 213       ;; not available
 214       t)))
 215
 216 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
 217                                               flag
 218                                               &optional in-msgdb)
 219   (elmo-list-filter
 220    (elmo-folder-list-messages folder nil t)
 221    (elmo-folder-list-flagged
 222     (elmo-filter-folder-target-internal folder) flag in-msgdb)))
 223
 224 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 225                                                  &optional one-level)
 226   (let* ((target (elmo-filter-folder-target-internal folder))
 227          (prefix (and (string-match
 228                        (concat "^\\(.*\\)"
 229                                (regexp-quote
 230                                 (elmo-folder-name-internal
 231                                  target))
 232                                "$")
 233                        (elmo-folder-name-internal folder))
 234                       (match-string 1 (elmo-folder-name-internal
 235                                        folder)))))
 236     (elmo-mapcar-list-of-list
 237      (lambda (x) (concat prefix x))
 238      (elmo-folder-list-subfolders target one-level))))
 239
 240 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
 241   (let ((condition (elmo-filter-folder-condition-internal folder))
 242         diff)
 243     (if (vectorp condition)
 244         (cond
 245          ((and (string= (elmo-filter-key condition) "flag")
 246                (or (string= (elmo-filter-value condition) "any")
 247                    (string= (elmo-filter-value condition) "digest")
 248                    (string= (elmo-filter-value condition) "unread")))
 249           (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
 250                                         folder)))
 251           (if (consp (cdr diff))
 252               ;; new unread unread
 253               (list (car diff) (nth 1 diff) (nth 1 diff))
 254             (cons (car diff) (car diff))))
 255          ((string= "last" (elmo-filter-key condition))
 256           (luna-call-next-method))
 257          (t
 258           (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 259                                             folder))))))
 260       (luna-call-next-method))))
 261
 262 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 263   (elmo-folder-status
 264    (elmo-filter-folder-target-internal folder)))
 265
 266 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 267   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 268
 269 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 270   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 271
 272 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 273   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 274
 275 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 276   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 277
 278 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 279                                         condition &optional numbers)
 280   ;; search from messages in this folder
 281   (let ((result (elmo-folder-search
 282                  (elmo-filter-folder-target-internal folder)
 283                  condition
 284                  (elmo-folder-list-messages folder))))
 285     (if numbers
 286         (elmo-list-filter numbers result)
 287       result)))
 288
 289 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 290                                               number)
 291   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 292                             number))
 293
 294 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 295   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 296
 297 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
 298   (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
 299
 300 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 301   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 302
 303 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 304                                              plugged &optional add)
 305   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 306                            plugged add))
 307
 308 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 309                                             number)
 310   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 311                           number))
 312
 313 (luna-define-method elmo-message-flag-available-p ((folder
 314                                                     elmo-filter-folder) number
 315                                                     flag)
 316   (elmo-message-flag-available-p
 317    (elmo-filter-folder-target-internal folder)
 318    number flag))
 319
 320 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
 321   (elmo-message-flags (elmo-filter-folder-target-internal folder)
 322                       number))
 323
 324 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
 325                                              number cached)
 326   (elmo-message-set-cached
 327    (elmo-filter-folder-target-internal folder) number cached))
 328
 329 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
 330                                          message-id)
 331   (elmo-message-number (elmo-filter-folder-target-internal folder)
 332                        message-id))
 333
 334 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
 335   (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
 336
 337 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
 338                                                 entity)
 339   (let ((parent (elmo-message-entity-parent
 340                  (elmo-filter-folder-target-internal folder)
 341                  entity)))
 342     (when (memq (elmo-message-entity-number parent)
 343                 (elmo-filter-folder-number-list folder))
 344       parent)))
 345
 346 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
 347                                             &optional if-exists)
 348   (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
 349                           if-exists))
 350
 351 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
 352   (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
 353
 354 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
 355   (elmo-filter-folder-flag-count folder))
 356
 357 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
 358                                           numbers
 359                                           flag
 360                                           &optional is-local)
 361   (elmo-filter-folder-countup-message-flags folder numbers -1)
 362   (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
 363                         numbers flag is-local)
 364   (elmo-filter-folder-countup-message-flags folder numbers))
 365
 366 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
 367                                             numbers
 368                                             flag
 369                                             &optional is-local)
 370   (elmo-filter-folder-countup-message-flags folder numbers -1)
 371   (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
 372                           numbers flag is-local)
 373   (elmo-filter-folder-countup-message-flags folder numbers))
 374
 375 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
 376                                          number)
 377   (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
 378
 379 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
 380                                        &optional keep-killed)
 381   (unless keep-killed
 382     (elmo-folder-set-killed-list-internal folder nil))
 383   (elmo-filter-folder-set-number-list-internal folder nil)
 384   (elmo-filter-folder-set-flag-count-internal folder nil))
 385
 386 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
 387                                              &optional
 388                                              disable-killed
 389                                              ignore-msgdb
 390                                              no-check
 391                                              mask)
 392   (let ((killed-list (elmo-folder-killed-list-internal folder))
 393         numbers)
 394     (unless no-check
 395       (when (elmo-filter-folder-require-msgdb-internal folder)
 396         (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
 397                                  disable-killed
 398                                  ignore-msgdb
 399                                  no-check
 400                                  mask)))
 401     (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
 402     (when (and numbers
 403                (not (elmo-filter-folder-require-msgdb-internal folder)))
 404       (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
 405                                'disable-killed
 406                                ignore-msgdb
 407                                no-check
 408                                (if mask
 409                                    (elmo-list-filter mask numbers)
 410                                  numbers)))
 411     (when (and disable-killed ignore-msgdb)
 412       (elmo-folder-set-killed-list-internal folder nil))
 413     (elmo-filter-folder-set-number-list-internal folder numbers)
 414     (elmo-filter-folder-set-flag-count-internal folder nil)
 415     0))
 416
 417 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
 418                                                  numbers)
 419   (elmo-filter-folder-countup-message-flags folder numbers -1)
 420   (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq)
 421   (elmo-folder-detach-messages
 422    (elmo-filter-folder-target-internal folder) numbers))
 423
 424 (luna-define-method elmo-folder-length ((folder elmo-filter-folder))
 425   (length (elmo-filter-folder-number-list-internal folder)))
 426
 427 (require 'product)
 428 (product-provide (provide 'elmo-filter) (require 'elmo-version))
 429
 430 ;;; elmo-filter.el ends here