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