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