elmo/elmo-multi.el

   1 ;;; elmo-multi.el --- Multiple 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 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  10 ;; This program is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14 ;;
  15 ;; This program is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19 ;;
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24 ;;
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31 (eval-when-compile (require 'cl))
  32
  33 (require 'elmo)
  34 (require 'elmo-signal)
  35 (require 'luna)
  36
  37 (defvar elmo-multi-divide-number 100000
  38   "*Multi divider number.")
  39
  40 ;;; ELMO Multi folder
  41 (eval-and-compile
  42   (luna-define-class elmo-multi-folder (elmo-folder)
  43                      (children divide-number))
  44   (luna-define-internal-accessors 'elmo-multi-folder))
  45
  46 (defmacro elmo-multi-real-folder-number (folder number)
  47   "Returns a cons cell of real FOLDER and NUMBER."
  48   `(cons (nth (-
  49                (/ ,number
  50                   (elmo-multi-folder-divide-number-internal ,folder))
  51                1) (elmo-multi-folder-children-internal ,folder))
  52          (% ,number (elmo-multi-folder-divide-number-internal
  53                      ,folder))))
  54
  55 (luna-define-method elmo-folder-initialize ((folder
  56                                              elmo-multi-folder)
  57                                             name)
  58   (while (> (length (car (setq name (elmo-parse-token name ",")))) 0)
  59     (elmo-multi-folder-set-children-internal
  60      folder
  61      (nconc (elmo-multi-folder-children-internal
  62              folder)
  63             (list (elmo-get-folder (car name)))))
  64     (setq name (cdr name))
  65     (when (and (> (length name) 0)
  66                (eq (aref name 0) ?,))
  67       (setq name (substring name 1))))
  68   (elmo-multi-folder-set-divide-number-internal
  69    folder
  70    elmo-multi-divide-number)
  71   (elmo-multi-connect-signals folder)
  72   folder)
  73
  74 (defun elmo-multi-connect-signals (folder)
  75   (elmo-connect-signal
  76    nil 'flag-changing folder
  77    (elmo-define-signal-handler (folder child number old-flags new-flags)
  78      (elmo-emit-signal 'flag-changing folder
  79                        (car (elmo-multi-map-numbers folder child (list number)))
  80                        old-flags new-flags))
  81    (elmo-define-signal-filter (folder sender)
  82      (memq sender (elmo-multi-folder-children-internal folder))))
  83   (elmo-connect-signal
  84    nil 'flag-changed folder
  85    (elmo-define-signal-handler (folder child numbers)
  86      (elmo-emit-signal 'flag-changed folder
  87                        (elmo-multi-map-numbers folder child numbers)))
  88    (elmo-define-signal-filter (folder sender)
  89      (memq sender (elmo-multi-folder-children-internal folder))))
  90   (elmo-connect-signal
  91    nil 'status-changed folder
  92    (elmo-define-signal-handler (folder child numbers)
  93      (elmo-emit-signal 'status-changed folder
  94                        (elmo-multi-map-numbers folder child numbers)))
  95    (elmo-define-signal-filter (folder sender)
  96      (memq sender (elmo-multi-folder-children-internal folder))))
  97   (elmo-connect-signal
  98    nil 'update-overview folder
  99    (elmo-define-signal-handler (folder child number)
 100      (elmo-emit-signal
 101       'update-overview folder
 102       (car (elmo-multi-map-numbers folder child (list number)))))
 103    (elmo-define-signal-filter (folder sender)
 104      (memq sender (elmo-multi-folder-children-internal folder)))))
 105
 106 (defun elmo-multi-map-numbers (folder child numbers)
 107   (let ((multi (catch 'found
 108                  (let ((children (elmo-multi-folder-children-internal folder))
 109                        (index 0))
 110                    (while children
 111                      (setq index (1+ index))
 112                      (when (eq (car children) child)
 113                        (throw 'found index))
 114                      (setq children (cdr children)))))))
 115     (when multi
 116       (let ((offset (* (elmo-multi-folder-divide-number-internal folder)
 117                        multi)))
 118       (mapcar (lambda (number) (+ offset number))
 119               numbers)))))
 120
 121
 122 (luna-define-method elmo-folder-open-internal ((folder elmo-multi-folder))
 123   (dolist (fld (elmo-multi-folder-children-internal folder))
 124     (elmo-folder-open-internal fld)))
 125
 126 (luna-define-method elmo-folder-open-internal-p ((folder elmo-multi-folder))
 127   (let (open)
 128     (dolist (fld (elmo-multi-folder-children-internal folder))
 129       (setq open (and open (elmo-folder-open-internal-p fld))))))
 130
 131 (luna-define-method elmo-folder-check ((folder elmo-multi-folder))
 132   (dolist (fld (elmo-multi-folder-children-internal folder))
 133     (elmo-folder-check fld)))
 134
 135 (luna-define-method elmo-folder-close-internal ((folder elmo-multi-folder))
 136   (dolist (fld (elmo-multi-folder-children-internal folder))
 137     (elmo-folder-close-internal fld)))
 138
 139 (luna-define-method elmo-folder-close ((folder elmo-multi-folder))
 140   (elmo-generic-folder-close folder)
 141   (dolist (fld (elmo-multi-folder-children-internal folder))
 142     (elmo-folder-close fld)))
 143
 144 (luna-define-method elmo-message-killed-p ((folder elmo-multi-folder) number)
 145   (let ((pair (elmo-multi-real-folder-number folder number)))
 146     (elmo-message-killed-p (car pair) (cdr pair))))
 147
 148 (luna-define-method elmo-folder-synchronize ((folder elmo-multi-folder)
 149                                              &optional
 150                                              disable-killed
 151                                              ignore-msgdb
 152                                              no-check
 153                                              mask)
 154   (if mask
 155       (dolist (element (elmo-multi-split-numbers folder mask))
 156         (when (cdr element)
 157           (elmo-folder-synchronize (car element)
 158                                    disable-killed
 159                                    ignore-msgdb
 160                                    no-check
 161                                    (cdr element))))
 162     (dolist (fld (elmo-multi-folder-children-internal folder))
 163       (elmo-folder-synchronize fld disable-killed ignore-msgdb no-check)))
 164   0)
 165
 166 (luna-define-method elmo-folder-expand-msgdb-path ((folder
 167                                                     elmo-multi-folder))
 168   (expand-file-name (elmo-replace-string-as-filename
 169                      (elmo-folder-name-internal folder))
 170                     (expand-file-name "multi"
 171                                       elmo-msgdb-directory)))
 172
 173 (luna-define-method elmo-folder-newsgroups ((folder elmo-multi-folder))
 174   (apply  #'nconc
 175           (mapcar
 176            'elmo-folder-newsgroups
 177            (elmo-multi-folder-children-internal folder))))
 178
 179 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-multi-folder))
 180   (elmo-flatten
 181    (mapcar
 182     'elmo-folder-get-primitive-list
 183     (elmo-multi-folder-children-internal folder))))
 184
 185 (luna-define-method elmo-folder-contains-type ((folder elmo-multi-folder) type)
 186   (let ((children (elmo-multi-folder-children-internal folder))
 187         match)
 188     (while children
 189       (when (elmo-folder-contains-type (car children) type)
 190         (setq match t)
 191         (setq children nil))
 192       (setq children (cdr children)))
 193     match))
 194
 195 (luna-define-method elmo-message-folder ((folder elmo-multi-folder)
 196                                          number)
 197   (nth (- (/ number (elmo-multi-folder-divide-number-internal folder)) 1)
 198        (elmo-multi-folder-children-internal folder)))
 199
 200 (luna-define-method elmo-message-cached-p ((folder elmo-multi-folder) number)
 201   (let ((pair (elmo-multi-real-folder-number folder number)))
 202     (elmo-message-cached-p (car pair) (cdr pair))))
 203
 204 (luna-define-method elmo-message-set-cached ((folder elmo-multi-folder)
 205                                              number cached)
 206   (let ((pair (elmo-multi-real-folder-number folder number)))
 207     (elmo-message-set-cached (car pair) (cdr pair) cached)))
 208
 209 (luna-define-method elmo-find-fetch-strategy ((folder elmo-multi-folder)
 210                                               number
 211                                               &optional
 212                                               ignore-cache
 213                                               require-entireness)
 214   (let ((pair (elmo-multi-real-folder-number folder number)))
 215     (elmo-find-fetch-strategy (car pair)
 216                               (cdr pair)
 217                               ignore-cache
 218                               require-entireness)))
 219
 220 (luna-define-method elmo-message-number ((folder elmo-multi-folder)
 221                                          message-id)
 222   (let ((children (elmo-multi-folder-children-internal folder))
 223         match)
 224     (while children
 225       (when (setq match (elmo-message-number (car children) message-id))
 226         (setq children nil))
 227       (setq children (cdr children)))
 228     match))
 229
 230 (luna-define-method elmo-message-entity ((folder elmo-multi-folder) key)
 231   (cond
 232    ((numberp key)
 233     (let* ((pair (elmo-multi-real-folder-number folder key))
 234            (entity (elmo-message-entity (car pair) (cdr pair))))
 235       (when entity
 236         (setq entity (elmo-message-copy-entity entity))
 237         (elmo-message-entity-set-number entity key)
 238         entity)))
 239    ((stringp key)
 240     (let ((children (elmo-multi-folder-children-internal folder))
 241           (cur-number 0)
 242           match)
 243       (while children
 244         (setq cur-number (+ cur-number 1))
 245         (when (setq match (elmo-message-entity (car children) key))
 246           (setq match (elmo-message-copy-entity match))
 247           (elmo-message-entity-set-number
 248            match
 249            (+ (* (elmo-multi-folder-divide-number-internal folder)
 250                  cur-number)
 251               (elmo-message-entity-number match)))
 252           (setq children nil))
 253         (setq children (cdr children)))
 254       match))))
 255
 256 (luna-define-method elmo-message-entity-parent ((folder
 257                                                  elmo-multi-folder) entity)
 258   (elmo-message-entity
 259    folder
 260    (elmo-message-entity-field entity 'references)))
 261
 262 (luna-define-method elmo-message-field ((folder elmo-multi-folder)
 263                                         number field &optional type)
 264   (let ((pair (elmo-multi-real-folder-number folder number)))
 265     (elmo-message-field (car pair) (cdr pair) field type)))
 266
 267 (luna-define-method elmo-message-flag-available-p ((folder
 268                                                     elmo-multi-folder) number
 269                                                     flag)
 270   (let ((pair (elmo-multi-real-folder-number folder number)))
 271     (elmo-message-flag-available-p (car pair) (cdr pair) flag)))
 272
 273 (luna-define-method elmo-message-flags ((folder elmo-multi-folder) number)
 274   (let ((pair (elmo-multi-real-folder-number folder number)))
 275     (elmo-message-flags (car pair) (cdr pair))))
 276
 277 (defun elmo-multi-split-numbers (folder numlist &optional as-is)
 278   (let ((numbers (sort numlist '<))
 279         (folders (elmo-multi-folder-children-internal folder))
 280         (divider (elmo-multi-folder-divide-number-internal folder))
 281         (cur-number 0)
 282         one-list numbers-list)
 283     (while numbers
 284       (setq one-list (list (nth cur-number folders)))
 285       (setq cur-number (+ cur-number 1))
 286       (while (and numbers
 287                   (eq 0
 288                       (/ (- (car numbers)
 289                             (* divider cur-number))
 290                          divider)))
 291         (setq one-list (nconc
 292                         one-list
 293                         (list
 294                          (if as-is
 295                              (car numbers)
 296                            (% (car numbers)
 297                               (* divider cur-number))))))
 298         (setq numbers (cdr numbers)))
 299       (setq numbers-list (nconc numbers-list (list one-list))))
 300     numbers-list))
 301
 302 (luna-define-method elmo-folder-process-crosspost ((folder elmo-multi-folder))
 303   (dolist (child (elmo-multi-folder-children-internal folder))
 304     (elmo-folder-process-crosspost child)))
 305
 306 (luna-define-method elmo-message-fetch ((folder elmo-multi-folder)
 307                                         number strategy
 308                                         &optional unseen section)
 309   (let ((pair (elmo-multi-real-folder-number folder number)))
 310     (elmo-message-fetch (car pair) (cdr pair) strategy unseen section)))
 311
 312 (luna-define-method elmo-folder-delete-messages ((folder elmo-multi-folder)
 313                                                  numbers)
 314   (dolist (element (elmo-multi-split-numbers folder numbers))
 315     (when (cdr element)
 316       (elmo-folder-delete-messages (car element) (cdr element))))
 317   t)
 318
 319 (luna-define-method elmo-folder-detach-messages ((folder elmo-multi-folder)
 320                                                  numbers)
 321   (dolist (element (elmo-multi-split-numbers folder numbers))
 322     (when (cdr element)
 323       (elmo-folder-detach-messages (car element) (cdr element))))
 324   t)
 325
 326 (luna-define-method elmo-folder-diff ((folder elmo-multi-folder))
 327   (elmo-multi-folder-diff folder))
 328
 329 (defun elmo-multi-folder-diff (folder)
 330   (let ((news 0)
 331         (unreads 0)
 332         (alls 0)
 333         diff value)
 334     (dolist (child (elmo-multi-folder-children-internal folder))
 335       (setq diff (elmo-folder-diff child))
 336       (setq news    (and news
 337                          (setq value (elmo-diff-new diff))
 338                          (+ news value))
 339             unreads (and unreads
 340                          (setq value (elmo-diff-unread diff))
 341                          (+ unreads value))
 342             alls    (and alls
 343                          (setq value (elmo-diff-all diff))
 344                          (+ alls value))))
 345     (if unreads
 346         (list news unreads alls)
 347       (cons news alls))))
 348
 349 (luna-define-method elmo-folder-list-messages
 350   ((folder elmo-multi-folder) &optional visible-only in-msgdb)
 351   (let* ((flds (elmo-multi-folder-children-internal folder))
 352          (cur-number 0)
 353          list numbers)
 354     (while flds
 355       (setq cur-number (+ cur-number 1))
 356       (setq list (elmo-folder-list-messages (car flds) visible-only in-msgdb))
 357       (setq numbers
 358             (nconc
 359              numbers
 360              (mapcar
 361               (lambda (x)
 362                 (+
 363                  (* (elmo-multi-folder-divide-number-internal
 364                      folder) cur-number) x))
 365               list)))
 366       (setq flds (cdr flds)))
 367     numbers))
 368
 369 (luna-define-method elmo-folder-exists-p ((folder elmo-multi-folder))
 370   (let ((flds (elmo-multi-folder-children-internal folder)))
 371     (catch 'exists
 372       (while flds
 373         (unless (elmo-folder-exists-p (car flds))
 374           (throw 'exists nil))
 375         (setq flds (cdr flds)))
 376       t)))
 377
 378 (luna-define-method elmo-folder-creatable-p ((folder elmo-multi-folder))
 379   (let ((flds (elmo-multi-folder-children-internal folder)))
 380     (catch 'creatable
 381       (while flds
 382         (when (and (elmo-folder-creatable-p (car flds))
 383                    (not (elmo-folder-exists-p (car flds))))
 384           ;; If folder already exists, don't to `creatable'.
 385           ;; Because this function is called, when folder doesn't exists.
 386           (throw 'creatable t))
 387         (setq flds (cdr flds)))
 388       nil)))
 389
 390 (luna-define-method elmo-folder-create ((folder elmo-multi-folder))
 391   (let ((flds (elmo-multi-folder-children-internal folder)))
 392     (catch 'create
 393       (while flds
 394         (unless (or (elmo-folder-exists-p (car flds))
 395                     (elmo-folder-create (car flds)))
 396           (throw 'create nil))
 397         (setq flds (cdr flds)))
 398       t)))
 399
 400 (luna-define-method elmo-folder-search ((folder elmo-multi-folder)
 401                                         condition &optional numbers)
 402   (let* ((flds (elmo-multi-folder-children-internal folder))
 403          (cur-number 0)
 404          numlist
 405          matches)
 406     (setq numbers (or numbers
 407                       (elmo-folder-list-messages folder)))
 408     (while flds
 409       (setq cur-number (+ cur-number 1))
 410       (setq matches (append matches
 411                             (mapcar
 412                              (lambda (x)
 413                                (+
 414                                 (* (elmo-multi-folder-divide-number-internal
 415                                     folder)
 416                                    cur-number)
 417                                 x))
 418                              (elmo-folder-search
 419                               (car flds) condition))))
 420       (setq flds (cdr flds)))
 421     (elmo-list-filter numbers matches)))
 422
 423 (luna-define-method elmo-message-use-cache-p ((folder elmo-multi-folder)
 424                                               number)
 425   (let ((pair (elmo-multi-real-folder-number folder number)))
 426     (elmo-message-use-cache-p (car pair) (cdr pair))))
 427
 428 (luna-define-method elmo-message-file-p ((folder elmo-multi-folder) number)
 429   (let ((pair (elmo-multi-real-folder-number folder number)))
 430     (elmo-message-file-p (car pair) (cdr pair))))
 431
 432 (luna-define-method elmo-message-file-name ((folder elmo-multi-folder) number)
 433   (let ((pair (elmo-multi-real-folder-number folder number)))
 434     (elmo-message-file-name (car pair) (cdr pair))))
 435
 436 (luna-define-method elmo-folder-plugged-p ((folder elmo-multi-folder))
 437   (let ((flds (elmo-multi-folder-children-internal folder)))
 438     (catch 'plugged
 439       (while flds
 440         (unless (elmo-folder-plugged-p (car flds))
 441           (throw 'plugged nil))
 442         (setq flds (cdr flds)))
 443       t)))
 444
 445 (luna-define-method elmo-folder-set-plugged ((folder elmo-multi-folder)
 446                                              plugged add)
 447   (let ((flds  (elmo-multi-folder-children-internal folder)))
 448     (dolist (fld flds)
 449       (elmo-folder-set-plugged fld plugged add))))
 450
 451 (defun elmo-multi-folder-numbers-list-assoc (folder folder-numbers)
 452   (let (ent)
 453     (while folder-numbers
 454       (when (string= (elmo-folder-name-internal (car (car folder-numbers)))
 455                      (elmo-folder-name-internal folder))
 456         (setq ent (car folder-numbers)
 457               folder-numbers nil))
 458       (setq folder-numbers (cdr folder-numbers)))
 459     ent))
 460
 461 (defun elmo-multi-make-folder-numbers-list (folder msgs)
 462   (let ((msg-list msgs)
 463         pair fld-list
 464         ret-val)
 465     (while msg-list
 466       (when (and (numberp (car msg-list))
 467                  (> (car msg-list) 0))
 468         (setq pair (elmo-multi-real-folder-number folder (car msg-list)))
 469         (if (setq fld-list (elmo-multi-folder-numbers-list-assoc
 470                             (car pair)
 471                             ret-val))
 472             (setcdr fld-list (cons (cdr pair) (cdr fld-list)))
 473           (setq ret-val (cons (cons (car pair) (list (cdr pair))) ret-val))))
 474       (setq msg-list (cdr msg-list)))
 475     ret-val))
 476
 477 (luna-define-method elmo-folder-set-flag ((folder elmo-multi-folder)
 478                                           numbers
 479                                           flag
 480                                           &optional is-local)
 481   (dolist (pair (elmo-multi-make-folder-numbers-list folder numbers))
 482     (elmo-folder-set-flag (car pair) (cdr pair) flag is-local)))
 483
 484 (luna-define-method elmo-folder-unset-flag ((folder elmo-multi-folder)
 485                                             numbers
 486                                             flag
 487                                             &optional is-local)
 488   (dolist (pair (elmo-multi-make-folder-numbers-list folder numbers))
 489     (ignore-errors
 490      (elmo-folder-unset-flag (car pair) (cdr pair) flag is-local))))
 491
 492 (luna-define-method elmo-folder-list-flagged ((folder elmo-multi-folder)
 493                                               flag
 494                                               &optional in-msgdb)
 495   (let ((cur-number 0)
 496         numbers)
 497     (dolist (child (elmo-multi-folder-children-internal folder))
 498       (setq cur-number (+ cur-number 1)
 499             numbers
 500             (nconc
 501              numbers
 502              (mapcar
 503               (lambda (x)
 504                 (+
 505                  (* (elmo-multi-folder-divide-number-internal folder)
 506                     cur-number) x))
 507               (elmo-folder-list-flagged child flag in-msgdb)))))
 508     numbers))
 509
 510 (luna-define-method elmo-folder-commit ((folder elmo-multi-folder))
 511   (dolist (child (elmo-multi-folder-children-internal folder))
 512     (elmo-folder-commit child)))
 513
 514 (luna-define-method elmo-folder-length ((folder elmo-multi-folder))
 515   (let ((sum 0))
 516     (dolist (child (elmo-multi-folder-children-internal folder))
 517       (setq sum (+ sum (elmo-folder-length child))))
 518     sum))
 519
 520 (luna-define-method elmo-folder-count-flags ((folder elmo-multi-folder))
 521   (let (flag-alist element)
 522     (dolist (child (elmo-multi-folder-children-internal folder))
 523       (dolist (pair (elmo-folder-count-flags child))
 524         (if (setq element (assq (car pair) flag-alist))
 525             (setcdr element (+ (cdr element) (cdr pair)))
 526           (setq flag-alist (cons pair flag-alist)))))
 527     flag-alist))
 528
 529 (luna-define-method elmo-folder-recover-messages ((folder elmo-multi-folder)
 530                                                   numbers)
 531   (dolist (element (elmo-multi-split-numbers folder numbers))
 532     (when (cdr element)
 533       (elmo-folder-recover-messages (car element) (cdr element)))))
 534
 535 (defun elmo-folder-append-messages-multi-* (dst-folder
 536                                             src-folder
 537                                             numbers
 538                                             same-number)
 539   (if same-number
 540       (elmo-folder-append-messages dst-folder src-folder numbers same-number
 541                                    'elmo-folder-append-messages-multi-*)
 542     (let ((divider (elmo-multi-folder-divide-number-internal src-folder))
 543           (cur-number 0)
 544           succeeds)
 545       (dolist (element (elmo-multi-split-numbers src-folder numbers))
 546         (setq cur-number (+ cur-number 1))
 547         (when (cdr element)
 548           (setq succeeds
 549                 (nconc
 550                  succeeds
 551                  (mapcar
 552                   (lambda (x)
 553                     (+ (* divider cur-number) x))
 554                   (elmo-folder-append-messages
 555                    dst-folder (car element) (cdr element)))))))
 556       succeeds)))
 557
 558 (require 'product)
 559 (product-provide (provide 'elmo-multi) (require 'elmo-version))
 560
 561 ;;; elmo-multi.el ends here