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