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