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