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 (defun elmo-filter-folder-copy-flag-count (flag-counts)
  96   (mapcar (lambda (pair) (cons (car pair) (cdr pair))) flag-counts))
  97
  98 (luna-define-method elmo-folder-open :after ((folder elmo-filter-folder)
  99                                              &optional load-msgdb)
 100   (when load-msgdb
 101     (elmo-filter-folder-number-list folder)
 102     (elmo-filter-folder-flag-count folder)
 103     (elmo-folder-msgdb (elmo-filter-folder-target-internal folder))))
 104
 105 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
 106   (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
 107
 108 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
 109   (when (elmo-filter-folder-require-msgdb-internal folder)
 110     (elmo-folder-synchronize (elmo-filter-folder-target-internal folder))))
 111
 112 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
 113   (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
 114
 115 (luna-define-method elmo-folder-close :after ((folder elmo-filter-folder))
 116   (elmo-filter-folder-set-number-list-internal folder nil)
 117   (elmo-filter-folder-set-flag-count-internal folder nil)
 118   (elmo-folder-set-msgdb-internal
 119    (elmo-filter-folder-target-internal folder) nil))
 120
 121 (luna-define-method elmo-folder-commit ((folder elmo-filter-folder))
 122   (elmo-folder-commit (elmo-filter-folder-target-internal folder))
 123   (when (elmo-folder-persistent-p folder)
 124     (elmo-folder-set-info-max-by-numdb
 125      folder
 126      (elmo-folder-list-messages folder nil 'in-msgdb))
 127     (elmo-msgdb-killed-list-save
 128      (elmo-folder-msgdb-path folder)
 129      (elmo-folder-killed-list-internal folder))
 130     (elmo-filter-number-list-save
 131      (elmo-folder-msgdb-path folder)
 132      (elmo-filter-folder-number-list-internal folder))))
 133
 134 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 135                                                     elmo-filter-folder))
 136   (expand-file-name
 137    (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
 138    (expand-file-name "filter" elmo-msgdb-directory)))
 139
 140 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
 141                                                           elmo-filter-folder)
 142                                                          condition)
 143   (elmo-folder-search-requires-msgdb-p
 144    (elmo-filter-folder-target-internal folder) condition))
 145
 146 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
 147   (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
 148
 149 (luna-define-method elmo-find-fetch-strategy ((folder elmo-filter-folder)
 150                                               number
 151                                               &optional
 152                                               ignore-cache
 153                                               require-entireness)
 154   (elmo-find-fetch-strategy
 155    (elmo-filter-folder-target-internal folder)
 156    number ignore-cache require-entireness))
 157
 158 (luna-define-method elmo-folder-get-primitive-list ((folder
 159                                                      elmo-filter-folder))
 160   (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
 161
 162 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
 163                                                type)
 164   (elmo-folder-contains-type
 165    (elmo-filter-folder-target-internal folder)
 166    type))
 167
 168 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
 169                                                &optional flag number)
 170   (elmo-folder-append-buffer
 171    (elmo-filter-folder-target-internal folder)
 172    flag number))
 173
 174 (luna-define-method elmo-message-fetch-bodystructure ((folder
 175                                                        elmo-filter-folder)
 176                                                       number strategy)
 177   (elmo-message-fetch-bodystructure
 178    (elmo-filter-folder-target-internal folder)
 179    number strategy))
 180
 181 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
 182                                         number strategy
 183                                         &optional unseen section)
 184   (unless unseen
 185     (elmo-filter-folder-countup-message-flags folder (list number) -1))
 186   (when (elmo-message-fetch (elmo-filter-folder-target-internal folder)
 187                             number strategy unseen section)
 188     (unless unseen
 189       (elmo-filter-folder-countup-message-flags folder (list number))
 190       (elmo-folder-notify-event folder 'flag-changed (list number)))
 191     t))
 192
 193 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
 194                                                  numbers)
 195   (let ((flag-count (elmo-filter-folder-copy-flag-count
 196                      (elmo-filter-folder-flag-count-internal folder)))
 197         (messages (copy-sequence
 198                    (elmo-filter-folder-number-list-internal folder)))
 199         success)
 200     (elmo-folder-detach-messages folder numbers)
 201     (unless (setq success
 202                   (elmo-folder-delete-messages
 203                    (elmo-filter-folder-target-internal folder) numbers))
 204       (elmo-filter-folder-set-flag-count-internal folder flag-count)
 205       (elmo-filter-folder-set-number-list-internal folder messages))
 206     success))
 207
 208 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
 209                                                &optional visible-only in-msgdb)
 210   (let ((list (if in-msgdb
 211                   t
 212                 (elmo-folder-list-messages-internal folder visible-only)))
 213         (killed-list (elmo-folder-killed-list-internal folder)))
 214     (unless (listp list)
 215       ;; Use current list.
 216       (setq list (elmo-filter-folder-number-list folder)))
 217     (if visible-only
 218         (elmo-living-messages list killed-list)
 219       (if (and in-msgdb killed-list list)
 220           (elmo-uniq-sorted-list
 221            (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
 222            #'eq)
 223         list))))
 224
 225 (luna-define-method elmo-folder-list-messages-internal
 226   ((folder elmo-filter-folder) &optional nohide)
 227   (let ((target (elmo-filter-folder-target-internal folder)))
 228     (if (or (elmo-folder-plugged-p target)
 229             (not (elmo-folder-persistent-p folder)))
 230         ;; search target folder
 231         (elmo-folder-search
 232          target
 233          (elmo-filter-folder-condition-internal folder))
 234       ;; not available
 235       t)))
 236
 237 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
 238                                               flag
 239                                               &optional in-msgdb)
 240   (elmo-list-filter
 241    (elmo-folder-list-messages folder nil t)
 242    (elmo-folder-list-flagged
 243     (elmo-filter-folder-target-internal folder) flag in-msgdb)))
 244
 245 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 246                                                  &optional one-level)
 247   (let* ((target (elmo-filter-folder-target-internal folder))
 248          (prefix (and (string-match
 249                        (concat "^\\(.*\\)"
 250                                (regexp-quote
 251                                 (elmo-folder-name-internal
 252                                  target))
 253                                "$")
 254                        (elmo-folder-name-internal folder))
 255                       (match-string 1 (elmo-folder-name-internal
 256                                        folder)))))
 257     (elmo-mapcar-list-of-list
 258      (lambda (x) (concat prefix x))
 259      (elmo-folder-list-subfolders target one-level))))
 260
 261 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
 262   (let ((condition (elmo-filter-folder-condition-internal folder))
 263         diff)
 264     (if (vectorp condition)
 265         (cond
 266          ((and (string= (elmo-filter-key condition) "flag")
 267                (or (string= (elmo-filter-value condition) "any")
 268                    (string= (elmo-filter-value condition) "digest")
 269                    (string= (elmo-filter-value condition) "unread")))
 270           (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
 271                                         folder)))
 272           (if (consp (cdr diff))
 273               ;; new unread unread
 274               (list (car diff) (nth 1 diff) (nth 1 diff))
 275             (cons (car diff) (car diff))))
 276          ((string= "last" (elmo-filter-key condition))
 277           (luna-call-next-method))
 278          (t
 279           (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 280                                             folder))))))
 281       (luna-call-next-method))))
 282
 283 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 284   (elmo-folder-status
 285    (elmo-filter-folder-target-internal folder)))
 286
 287 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 288   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 289
 290 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 291   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 292
 293 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 294   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 295
 296 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 297   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 298
 299 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 300                                         condition &optional numbers)
 301   ;; search from messages in this folder
 302   (let ((result (elmo-folder-search
 303                  (elmo-filter-folder-target-internal folder)
 304                  condition
 305                  (elmo-folder-list-messages folder))))
 306     (if numbers
 307         (elmo-list-filter numbers result)
 308       result)))
 309
 310 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 311                                               number)
 312   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 313                             number))
 314
 315 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 316   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 317
 318 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
 319   (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
 320
 321 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 322   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 323
 324 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 325                                              plugged &optional add)
 326   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 327                            plugged add))
 328
 329 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 330                                             number)
 331   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 332                           number))
 333
 334 (luna-define-method elmo-message-flag-available-p ((folder
 335                                                     elmo-filter-folder) number
 336                                                     flag)
 337   (elmo-message-flag-available-p
 338    (elmo-filter-folder-target-internal folder)
 339    number flag))
 340
 341 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
 342   (elmo-message-flags (elmo-filter-folder-target-internal folder)
 343                       number))
 344
 345 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
 346                                              number cached)
 347   (elmo-message-set-cached
 348    (elmo-filter-folder-target-internal folder) number cached)
 349   (elmo-folder-notify-event folder 'cache-changed number))
 350
 351 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
 352                                          message-id)
 353   (elmo-message-number (elmo-filter-folder-target-internal folder)
 354                        message-id))
 355
 356 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
 357   (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
 358
 359 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
 360                                                 entity)
 361   (let ((parent (elmo-message-entity-parent
 362                  (elmo-filter-folder-target-internal folder)
 363                  entity)))
 364     (when (memq (elmo-message-entity-number parent)
 365                 (elmo-filter-folder-number-list folder))
 366       parent)))
 367
 368 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
 369                                             &optional if-exists)
 370   (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
 371                           if-exists))
 372
 373 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
 374   (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
 375
 376 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
 377   (elmo-filter-folder-flag-count folder))
 378
 379 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
 380                                           numbers
 381                                           flag
 382                                           &optional is-local)
 383   (elmo-filter-folder-countup-message-flags folder numbers -1)
 384   (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
 385                         numbers flag is-local)
 386   (elmo-filter-folder-countup-message-flags folder numbers)
 387   (elmo-folder-notify-event folder 'flag-changed numbers))
 388
 389 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
 390                                             numbers
 391                                             flag
 392                                             &optional is-local)
 393   (elmo-filter-folder-countup-message-flags folder numbers -1)
 394   (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
 395                           numbers flag is-local)
 396   (elmo-filter-folder-countup-message-flags folder numbers)
 397   (elmo-folder-notify-event folder 'flag-changed numbers))
 398
 399 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
 400                                          number)
 401   (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
 402
 403 (luna-define-method elmo-message-field ((folder elmo-filter-folder)
 404                                         number field)
 405   (elmo-message-field
 406    (elmo-filter-folder-target-internal folder) number field))
 407
 408 (luna-define-method elmo-message-set-field ((folder elmo-filter-folder)
 409                                             number field value)
 410   (elmo-message-set-field
 411    (elmo-filter-folder-target-internal folder) number field value))
 412
 413 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
 414                                        &optional keep-killed)
 415   (unless keep-killed
 416     (elmo-folder-set-killed-list-internal folder nil))
 417   (elmo-filter-folder-set-number-list-internal folder nil)
 418   (elmo-filter-folder-set-flag-count-internal folder nil))
 419
 420 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
 421                                              &optional
 422                                              disable-killed
 423                                              ignore-msgdb
 424                                              no-check
 425                                              mask)
 426   (let ((killed-list (elmo-folder-killed-list-internal folder))
 427         numbers)
 428     (unless no-check
 429       (when (elmo-filter-folder-require-msgdb-internal folder)
 430         (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
 431                                  disable-killed
 432                                  ignore-msgdb
 433                                  no-check
 434                                  mask)))
 435     (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
 436     (when (and numbers
 437                (not (elmo-filter-folder-require-msgdb-internal folder)))
 438       (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
 439                                'disable-killed
 440                                ignore-msgdb
 441                                no-check
 442                                (if mask
 443                                    (elmo-list-filter mask numbers)
 444                                  numbers)))
 445     (when (and disable-killed ignore-msgdb)
 446       (elmo-folder-set-killed-list-internal folder nil))
 447     (elmo-filter-folder-set-number-list-internal folder numbers)
 448     (elmo-filter-folder-set-flag-count-internal folder nil)
 449     0))
 450
 451 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
 452                                                  numbers)
 453   (elmo-filter-folder-countup-message-flags folder numbers -1)
 454   (elmo-filter-folder-set-number-list-internal
 455    folder
 456    (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq))
 457   t)
 458
 459 (luna-define-method elmo-folder-length ((folder elmo-filter-folder))
 460   (length (elmo-filter-folder-number-list-internal folder)))
 461
 462 (require 'product)
 463 (product-provide (provide 'elmo-filter) (require 'elmo-version))
 464
 465 ;;; elmo-filter.el ends here