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