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   (and (elmo-folder-delete-messages
 185         (elmo-filter-folder-target-internal folder) numbers)
 186        (elmo-folder-detach-messages folder numbers)))
 187
 188 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
 189                                                &optional visible-only in-msgdb)
 190   (let ((list (if in-msgdb
 191                   t
 192                 (elmo-folder-list-messages-internal folder visible-only)))
 193         (killed-list (elmo-folder-killed-list-internal folder)))
 194     (unless (listp list)
 195       ;; Use current list.
 196       (setq list (elmo-filter-folder-number-list folder)))
 197     (if visible-only
 198         (elmo-living-messages list killed-list)
 199       (if (and in-msgdb killed-list list)
 200           (elmo-uniq-sorted-list
 201            (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
 202            #'eq)
 203         list))))
 204
 205 (luna-define-method elmo-folder-list-messages-internal
 206   ((folder elmo-filter-folder) &optional nohide)
 207   (let ((target (elmo-filter-folder-target-internal folder)))
 208     (if (or (elmo-folder-plugged-p target)
 209             (not (elmo-folder-persistent-p folder)))
 210         ;; search target folder
 211         (elmo-folder-search
 212          target
 213          (elmo-filter-folder-condition-internal folder))
 214       ;; not available
 215       t)))
 216
 217 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
 218                                               flag
 219                                               &optional in-msgdb)
 220   (elmo-list-filter
 221    (elmo-folder-list-messages folder nil t)
 222    (elmo-folder-list-flagged
 223     (elmo-filter-folder-target-internal folder) flag in-msgdb)))
 224
 225 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 226                                                  &optional one-level)
 227   (let* ((target (elmo-filter-folder-target-internal folder))
 228          (prefix (and (string-match
 229                        (concat "^\\(.*\\)"
 230                                (regexp-quote
 231                                 (elmo-folder-name-internal
 232                                  target))
 233                                "$")
 234                        (elmo-folder-name-internal folder))
 235                       (match-string 1 (elmo-folder-name-internal
 236                                        folder)))))
 237     (elmo-mapcar-list-of-list
 238      (lambda (x) (concat prefix x))
 239      (elmo-folder-list-subfolders target one-level))))
 240
 241 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
 242   (let ((condition (elmo-filter-folder-condition-internal folder))
 243         diff)
 244     (if (vectorp condition)
 245         (cond
 246          ((and (string= (elmo-filter-key condition) "flag")
 247                (or (string= (elmo-filter-value condition) "any")
 248                    (string= (elmo-filter-value condition) "digest")
 249                    (string= (elmo-filter-value condition) "unread")))
 250           (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
 251                                         folder)))
 252           (if (consp (cdr diff))
 253               ;; new unread unread
 254               (list (car diff) (nth 1 diff) (nth 1 diff))
 255             (cons (car diff) (car diff))))
 256          ((string= "last" (elmo-filter-key condition))
 257           (luna-call-next-method))
 258          (t
 259           (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 260                                             folder))))))
 261       (luna-call-next-method))))
 262
 263 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 264   (elmo-folder-status
 265    (elmo-filter-folder-target-internal folder)))
 266
 267 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 268   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 269
 270 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 271   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 272
 273 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 274   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 275
 276 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 277   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 278
 279 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 280                                         condition &optional numbers)
 281   ;; search from messages in this folder
 282   (let ((result (elmo-folder-search
 283                  (elmo-filter-folder-target-internal folder)
 284                  condition
 285                  (elmo-folder-list-messages folder))))
 286     (if numbers
 287         (elmo-list-filter numbers result)
 288       result)))
 289
 290 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 291                                               number)
 292   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 293                             number))
 294
 295 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 296   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 297
 298 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
 299   (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
 300
 301 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 302   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 303
 304 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 305                                              plugged &optional add)
 306   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 307                            plugged add))
 308
 309 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 310                                             number)
 311   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 312                           number))
 313
 314 (luna-define-method elmo-message-flag-available-p ((folder
 315                                                     elmo-filter-folder) number
 316                                                     flag)
 317   (elmo-message-flag-available-p
 318    (elmo-filter-folder-target-internal folder)
 319    number flag))
 320
 321 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
 322   (elmo-message-flags (elmo-filter-folder-target-internal folder)
 323                       number))
 324
 325 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
 326                                              number cached)
 327   (elmo-message-set-cached
 328    (elmo-filter-folder-target-internal folder) number cached))
 329
 330 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
 331                                          message-id)
 332   (elmo-message-number (elmo-filter-folder-target-internal folder)
 333                        message-id))
 334
 335 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
 336   (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
 337
 338 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
 339                                                 entity)
 340   (let ((parent (elmo-message-entity-parent
 341                  (elmo-filter-folder-target-internal folder)
 342                  entity)))
 343     (when (memq (elmo-message-entity-number parent)
 344                 (elmo-filter-folder-number-list folder))
 345       parent)))
 346
 347 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
 348                                             &optional if-exists)
 349   (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
 350                           if-exists))
 351
 352 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
 353   (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
 354
 355 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
 356   (elmo-filter-folder-flag-count folder))
 357
 358 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
 359                                           numbers
 360                                           flag
 361                                           &optional is-local)
 362   (elmo-filter-folder-countup-message-flags folder numbers -1)
 363   (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
 364                         numbers flag is-local)
 365   (elmo-filter-folder-countup-message-flags folder numbers))
 366
 367 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
 368                                             numbers
 369                                             flag
 370                                             &optional is-local)
 371   (elmo-filter-folder-countup-message-flags folder numbers -1)
 372   (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
 373                           numbers flag is-local)
 374   (elmo-filter-folder-countup-message-flags folder numbers))
 375
 376 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
 377                                          number)
 378   (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
 379
 380 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
 381                                        &optional keep-killed)
 382   (unless keep-killed
 383     (elmo-folder-set-killed-list-internal folder nil))
 384   (elmo-filter-folder-set-number-list-internal folder nil)
 385   (elmo-filter-folder-set-flag-count-internal folder nil))
 386
 387 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
 388                                              &optional
 389                                              disable-killed
 390                                              ignore-msgdb
 391                                              no-check
 392                                              mask)
 393   (let ((killed-list (elmo-folder-killed-list-internal folder))
 394         numbers)
 395     (unless no-check
 396       (when (elmo-filter-folder-require-msgdb-internal folder)
 397         (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
 398                                  disable-killed
 399                                  ignore-msgdb
 400                                  no-check
 401                                  mask)))
 402     (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
 403     (when (and numbers
 404                (not (elmo-filter-folder-require-msgdb-internal folder)))
 405       (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
 406                                'disable-killed
 407                                ignore-msgdb
 408                                no-check
 409                                (if mask
 410                                    (elmo-list-filter mask numbers)
 411                                  numbers)))
 412     (when (and disable-killed ignore-msgdb)
 413       (elmo-folder-set-killed-list-internal folder nil))
 414     (elmo-filter-folder-set-number-list-internal folder numbers)
 415     (elmo-filter-folder-set-flag-count-internal folder nil)
 416     0))
 417
 418 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
 419                                                  numbers)
 420   (elmo-filter-folder-countup-message-flags folder numbers -1)
 421   (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq)
 422   t)
 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