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