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