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