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 (luna-define-method elmo-message-flags ((folder elmo-multi-folder) number)
 193   (let ((pair (elmo-multi-real-folder-number folder number)))
 194     (elmo-message-flags (car pair) (cdr pair))))
 195
 196 (defun elmo-multi-split-numbers (folder numlist &optional as-is)
 197   (let ((numbers (sort numlist '<))
 198         (divider (elmo-multi-folder-divide-number-internal folder))
 199         (cur-number 0)
 200         one-list numbers-list)
 201     (while numbers
 202       (setq cur-number (+ cur-number 1))
 203       (setq one-list nil)
 204       (while (and numbers
 205                   (eq 0
 206                       (/ (- (car numbers)
 207                             (* divider cur-number))
 208                          divider)))
 209         (setq one-list (nconc
 210                         one-list
 211                         (list
 212                          (if as-is
 213                              (car numbers)
 214                            (% (car numbers)
 215                               (* divider cur-number))))))
 216         (setq numbers (cdr numbers)))
 217       (setq numbers-list (nconc numbers-list (list one-list))))
 218     numbers-list))
 219
 220 (luna-define-method elmo-folder-process-crosspost ((folder elmo-multi-folder))
 221   (dolist (child (elmo-multi-folder-children-internal folder))
 222     (elmo-folder-process-crosspost child)))
 223
 224 (luna-define-method elmo-message-fetch ((folder elmo-multi-folder)
 225                                         number strategy
 226                                         &optional section outbuf unseen)
 227   (let ((pair (elmo-multi-real-folder-number folder number)))
 228     (elmo-message-fetch (car pair) (cdr pair) strategy section outbuf unseen)))
 229
 230 (luna-define-method elmo-folder-delete-messages ((folder elmo-multi-folder)
 231                                                  numbers)
 232   (let ((flds (elmo-multi-folder-children-internal folder))
 233         one-list-list
 234         (cur-number 0))
 235     (setq one-list-list (elmo-multi-split-numbers folder numbers))
 236     (while (< cur-number (length flds))
 237       (elmo-folder-delete-messages (nth cur-number flds)
 238                                    (nth cur-number one-list-list))
 239       (setq cur-number (+ 1 cur-number)))
 240     t))
 241
 242 (luna-define-method elmo-folder-detach-messages ((folder elmo-multi-folder)
 243                                                  numbers)
 244   (let ((flds (elmo-multi-folder-children-internal folder))
 245         one-list-list
 246         (cur-number 0))
 247     (setq one-list-list (elmo-multi-split-numbers folder numbers))
 248     (while (< cur-number (length flds))
 249       (elmo-folder-detach-messages (nth cur-number flds)
 250                                    (nth cur-number one-list-list))
 251       (setq cur-number (+ 1 cur-number)))
 252     t))
 253
 254 (luna-define-method elmo-folder-diff ((folder elmo-multi-folder))
 255   (elmo-multi-folder-diff folder))
 256
 257 (defun elmo-multi-folder-diff (folder)
 258   (let ((flds (elmo-multi-folder-children-internal folder))
 259         (news 0)
 260         (unreads 0)
 261         (alls 0)
 262         no-unreads diff)
 263     (while flds
 264       (setq diff (elmo-folder-diff (car flds)))
 265       (cond
 266        ((consp (cdr diff)) ; (new unread all)
 267         (setq news    (+ news (nth 0 diff))
 268               unreads (+ unreads (nth 1 diff))
 269               alls    (+ alls (nth 2 diff))))
 270        (t
 271         (setq no-unreads t)
 272         (setq news    (+ news (car diff))
 273               alls    (+ alls (cdr diff)))))
 274       (setq flds (cdr flds)))
 275     (if no-unreads
 276         (cons news alls)
 277       (list news unreads alls))))
 278
 279 (luna-define-method elmo-folder-list-unreads ((folder elmo-multi-folder))
 280   (let ((cur-number 0)
 281         unreads)
 282     (dolist (child (elmo-multi-folder-children-internal folder))
 283       (setq cur-number (+ cur-number 1))
 284       (setq unreads
 285             (nconc
 286              unreads
 287              (mapcar (lambda (x)
 288                        (+ x (* cur-number
 289                                (elmo-multi-folder-divide-number-internal
 290                                 folder))))
 291                      (elmo-folder-list-unreads child)))))
 292     unreads))
 293
 294 (luna-define-method elmo-folder-list-answereds ((folder elmo-multi-folder))
 295   (let ((cur-number 0)
 296         answereds)
 297     (dolist (child (elmo-multi-folder-children-internal folder))
 298       (setq cur-number (+ cur-number 1))
 299       (setq answereds
 300             (nconc
 301              answereds
 302              (mapcar (lambda (x)
 303                        (+ x (* cur-number
 304                                (elmo-multi-folder-divide-number-internal
 305                                 folder))))
 306                      (elmo-folder-list-answereds child)))))
 307     answereds))
 308
 309 (luna-define-method elmo-folder-list-importants ((folder elmo-multi-folder))
 310   (let ((cur-number 0)
 311         importants)
 312     (dolist (child (elmo-multi-folder-children-internal folder))
 313       (setq cur-number (+ cur-number 1))
 314       (setq importants
 315             (nconc
 316              importants
 317              (mapcar (lambda (x)
 318                        (+ x (* cur-number
 319                                (elmo-multi-folder-divide-number-internal
 320                                 folder))))
 321                      (elmo-folder-list-importants child)))))
 322     (elmo-uniq-list
 323      (nconc importants
 324             (elmo-folder-list-messages-with-global-mark
 325              folder elmo-msgdb-important-mark)))))
 326
 327 (luna-define-method elmo-folder-list-messages
 328   ((folder elmo-multi-folder) &optional visible-only in-msgdb)
 329   (let* ((flds (elmo-multi-folder-children-internal folder))
 330          (cur-number 0)
 331          list numbers)
 332     (while flds
 333       (setq cur-number (+ cur-number 1))
 334       (setq list (elmo-folder-list-messages (car flds) visible-only in-msgdb))
 335       (setq numbers
 336             (nconc
 337              numbers
 338              (mapcar
 339               (function
 340                (lambda (x)
 341                  (+
 342                   (* (elmo-multi-folder-divide-number-internal
 343                       folder) cur-number) x)))
 344               list)))
 345       (setq flds (cdr flds)))
 346     numbers))
 347
 348 (luna-define-method elmo-folder-exists-p ((folder elmo-multi-folder))
 349   (let ((flds (elmo-multi-folder-children-internal folder)))
 350     (catch 'exists
 351       (while flds
 352         (unless (elmo-folder-exists-p (car flds))
 353           (throw 'exists nil))
 354         (setq flds (cdr flds)))
 355       t)))
 356
 357 (luna-define-method elmo-folder-creatable-p ((folder elmo-multi-folder))
 358   (let ((flds (elmo-multi-folder-children-internal folder)))
 359     (catch 'creatable
 360       (while flds
 361         (when (and (elmo-folder-creatable-p (car flds))
 362                    (not (elmo-folder-exists-p (car flds))))
 363           ;; If folder already exists, don't to `creatable'.
 364           ;; Because this function is called, when folder doesn't exists.
 365           (throw 'creatable t))
 366         (setq flds (cdr flds)))
 367       nil)))
 368
 369 (luna-define-method elmo-folder-create ((folder elmo-multi-folder))
 370   (let ((flds (elmo-multi-folder-children-internal folder)))
 371     (catch 'create
 372       (while flds
 373         (unless (or (elmo-folder-exists-p (car flds))
 374                     (elmo-folder-create (car flds)))
 375           (throw 'create nil))
 376         (setq flds (cdr flds)))
 377       t)))
 378
 379 (luna-define-method elmo-folder-search ((folder elmo-multi-folder)
 380                                         condition &optional numbers)
 381   (let* ((flds (elmo-multi-folder-children-internal folder))
 382          (cur-number 0)
 383          numlist
 384          matches)
 385     (setq numbers (or numbers
 386                       (elmo-folder-list-messages folder)))
 387     (while flds
 388       (setq cur-number (+ cur-number 1))
 389       (setq matches (append matches
 390                             (mapcar
 391                              (function
 392                               (lambda (x)
 393                                 (+
 394                                  (* (elmo-multi-folder-divide-number-internal
 395                                      folder)
 396                                     cur-number)
 397                                  x)))
 398                              (elmo-folder-search
 399                               (car flds) condition))))
 400       (setq flds (cdr flds)))
 401     (elmo-list-filter numbers matches)))
 402
 403 (luna-define-method elmo-message-use-cache-p ((folder elmo-multi-folder)
 404                                               number)
 405   (let ((pair (elmo-multi-real-folder-number folder number)))
 406     (elmo-message-use-cache-p (car pair) (cdr pair))))
 407
 408 (luna-define-method elmo-message-file-p ((folder elmo-multi-folder) number)
 409   (let ((pair (elmo-multi-real-folder-number folder number)))
 410     (elmo-message-file-p (car pair) (cdr pair))))
 411
 412 (luna-define-method elmo-message-file-name ((folder elmo-multi-folder) number)
 413   (let ((pair (elmo-multi-real-folder-number folder number)))
 414     (elmo-message-file-name (car pair) (cdr pair))))
 415
 416 (luna-define-method elmo-folder-plugged-p ((folder elmo-multi-folder))
 417   (let ((flds (elmo-multi-folder-children-internal folder)))
 418     (catch 'plugged
 419       (while flds
 420         (unless (elmo-folder-plugged-p (car flds))
 421           (throw 'plugged nil))
 422         (setq flds (cdr flds)))
 423       t)))
 424
 425 (luna-define-method elmo-folder-set-plugged ((folder elmo-multi-folder)
 426                                              plugged add)
 427   (let ((flds  (elmo-multi-folder-children-internal folder)))
 428     (dolist (fld flds)
 429       (elmo-folder-set-plugged fld plugged add))))
 430
 431 (defun elmo-multi-folder-numbers-list-assoc (folder folder-numbers)
 432   (let (ent)
 433     (while folder-numbers
 434       (when (string= (elmo-folder-name-internal (car (car folder-numbers)))
 435                      (elmo-folder-name-internal folder))
 436         (setq ent (car folder-numbers)
 437               folder-numbers nil))
 438       (setq folder-numbers (cdr folder-numbers)))
 439     ent))
 440
 441 (defun elmo-multi-make-folder-numbers-list (folder msgs)
 442   (let ((msg-list msgs)
 443         pair fld-list
 444         ret-val)
 445     (while msg-list
 446       (when (and (numberp (car msg-list))
 447                  (> (car msg-list) 0))
 448         (setq pair (elmo-multi-real-folder-number folder (car msg-list)))
 449         (if (setq fld-list (elmo-multi-folder-numbers-list-assoc
 450                             (car pair)
 451                             ret-val))
 452             (setcdr fld-list (cons (cdr pair) (cdr fld-list)))
 453           (setq ret-val (cons (cons (car pair) (list (cdr pair))) ret-val))))
 454       (setq msg-list (cdr msg-list)))
 455     ret-val))
 456
 457 (luna-define-method elmo-folder-mark-as-important ((folder
 458                                                     elmo-multi-folder)
 459                                                    numbers
 460                                                    &optional
 461                                                    ignore-flags)
 462   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
 463     (elmo-folder-mark-as-important (car folder-numbers)
 464                                    (cdr folder-numbers)
 465                                    ignore-flags)))
 466
 467 (luna-define-method elmo-folder-unmark-important ((folder
 468                                                    elmo-multi-folder)
 469                                                   numbers
 470                                                   &optional
 471                                                   ignore-flags)
 472   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
 473     (elmo-folder-unmark-important (car folder-numbers)
 474                                   (cdr folder-numbers)
 475                                   ignore-flags)))
 476
 477 (luna-define-method elmo-folder-mark-as-read ((folder
 478                                                elmo-multi-folder)
 479                                               numbers
 480                                               &optional ignore-flag)
 481   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
 482     (elmo-folder-mark-as-read (car folder-numbers)
 483                               (cdr folder-numbers)
 484                               ignore-flag)))
 485
 486 (luna-define-method elmo-folder-unmark-read ((folder
 487                                               elmo-multi-folder)
 488                                              numbers
 489                                              &optional ignore-flag)
 490   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
 491     (elmo-folder-unmark-read (car folder-numbers)
 492                              (cdr folder-numbers)
 493                              ignore-flag)))
 494
 495 (luna-define-method elmo-folder-mark-as-answered ((folder
 496                                                    elmo-multi-folder)
 497                                                   numbers)
 498   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
 499     (elmo-folder-mark-as-answered (car folder-numbers)
 500                                   (cdr folder-numbers))))
 501
 502 (luna-define-method elmo-folder-unmark-answered ((folder
 503                                                   elmo-multi-folder)
 504                                                  numbers)
 505   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
 506     (elmo-folder-unmark-answered (car folder-numbers)
 507                                  (cdr folder-numbers))))
 508
 509 (luna-define-method elmo-folder-list-flagged ((folder elmo-multi-folder)
 510                                               flag
 511                                               &optional in-msgdb)
 512   (let ((cur-number 0)
 513         numbers)
 514     (dolist (child (elmo-multi-folder-children-internal folder))
 515       (setq cur-number (+ cur-number 1)
 516             numbers
 517             (nconc
 518              numbers
 519              (mapcar
 520               (function
 521                (lambda (x)
 522                  (+
 523                   (* (elmo-multi-folder-divide-number-internal folder)
 524                      cur-number) x)))
 525               (elmo-folder-list-flagged child flag in-msgdb)))))
 526     numbers))
 527
 528 (luna-define-method elmo-folder-set-message-modified ((folder
 529                                                        elmo-multi-folder)
 530                                                       modified)
 531   (dolist (child (elmo-multi-folder-children-internal folder))
 532     (elmo-folder-set-message-modified child modified)))
 533
 534 (luna-define-method elmo-folder-commit ((folder elmo-multi-folder))
 535   (dolist (child (elmo-multi-folder-children-internal folder))
 536     (elmo-folder-commit child)))
 537
 538 (luna-define-method elmo-folder-length ((folder elmo-multi-folder))
 539   (let ((sum 0))
 540     (dolist (child (elmo-multi-folder-children-internal folder))
 541       (setq sum (+ sum (elmo-folder-length child))))
 542     sum))
 543
 544 (luna-define-method elmo-folder-count-flags ((folder elmo-multi-folder))
 545   (let ((new 0)
 546         (unreads 0)
 547         (answered 0)
 548         flags)
 549     (dolist (child (elmo-multi-folder-children-internal folder))
 550       (setq flags (elmo-folder-count-flags child))
 551       (setq new (+ new (nth 0 flags)))
 552       (setq unreads (+ unreads (nth 1 flags)))
 553       (setq answered (+ answered (nth 2 flags))))
 554     (list new unreads answered)))
 555
 556 (require 'product)
 557 (product-provide (provide 'elmo-multi) (require 'elmo-version))
 558
 559 ;;; elmo-multi.el ends here