elmo/elmo-map.el

   1 ;;; elmo-map.el --- A ELMO folder class with message number mapping.
   2
   3 ;; Copyright (C) 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 ;; Folders which do not have unique message numbers but unique message names
  28 ;; should inherit this folder.
  29
  30 ;;; Code:
  31 ;;
  32 (require 'elmo)
  33 (require 'elmo-msgdb)
  34
  35 (eval-when-compile (require 'cl))
  36
  37 (eval-and-compile
  38   ;; location-hash: location->number mapping
  39   ;; number-hash:   number->location mapping
  40   (luna-define-class elmo-map-folder (elmo-folder)
  41                      (location-alist number-max location-hash))
  42   (luna-define-internal-accessors 'elmo-map-folder))
  43
  44 (defun elmo-map-folder-numbers-to-locations (folder numbers)
  45   (let (locations pair)
  46     (dolist (number numbers)
  47       (if (setq pair (elmo-get-hash-val
  48                       (concat "#" (int-to-string number))
  49                       (elmo-map-folder-location-hash-internal folder)))
  50           (setq locations (cons (cdr pair) locations))))
  51     (nreverse locations)))
  52
  53 (defun elmo-map-folder-locations-to-numbers (folder locations)
  54   (let (numbers pair)
  55     (dolist (location locations)
  56       (if (setq pair (elmo-get-hash-val
  57                       location
  58                       (elmo-map-folder-location-hash-internal folder)))
  59           (setq numbers (cons (car pair) numbers))))
  60     (nreverse numbers)))
  61
  62 (luna-define-generic elmo-map-folder-list-message-locations (folder)
  63   "Return a location list of the FOLDER.")
  64
  65 (luna-define-generic elmo-map-folder-unmark-important (folder locations)
  66   "")
  67
  68 (luna-define-generic elmo-map-folder-mark-as-important (folder locations)
  69   "")
  70
  71 (luna-define-generic elmo-map-folder-unmark-read (folder locations)
  72   "")
  73
  74 (luna-define-generic elmo-map-folder-mark-as-read (folder locations)
  75   "")
  76
  77 (luna-define-generic elmo-map-folder-unmark-answered (folder locations)
  78   "")
  79
  80 (luna-define-generic elmo-map-folder-mark-as-answered (folder locations)
  81   "")
  82
  83 (luna-define-generic elmo-map-message-fetch (folder location
  84                                                     strategy
  85                                                     &optional
  86                                                     section
  87                                                     unseen)
  88   "")
  89
  90 (luna-define-generic elmo-map-folder-list-unreads (folder)
  91   "")
  92
  93 (luna-define-method elmo-map-folder-list-unreads ((folder elmo-map-folder))
  94   t)
  95
  96 (luna-define-generic elmo-map-folder-list-importants (folder)
  97   "")
  98
  99 (luna-define-method elmo-map-folder-list-importants ((folder elmo-map-folder))
 100   t)
 101
 102 (luna-define-generic elmo-map-folder-list-answereds (folder)
 103   "")
 104
 105 (luna-define-method elmo-map-folder-list-answereds ((folder elmo-map-folder))
 106   t)
 107
 108 (luna-define-generic elmo-map-folder-delete-messages (folder locations)
 109   "")
 110
 111 (luna-define-method elmo-folder-status ((folder elmo-map-folder))
 112   (elmo-folder-open-internal folder)
 113   (elmo-folder-set-killed-list-internal
 114    folder
 115    (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder)))
 116   (let ((numbers (mapcar
 117                   'car
 118                   (elmo-map-folder-location-alist-internal folder))))
 119     (setq numbers (elmo-living-messages numbers (elmo-folder-killed-list-internal folder)))
 120     (prog1
 121         (cons (elmo-max-of-list numbers)
 122               (length numbers))
 123       ;; Don't close after status.
 124       (unless (elmo-folder-reserve-status-p folder)
 125         (elmo-folder-close-internal folder)))))
 126
 127 (defun elmo-map-message-number (folder location)
 128   "Return number of the message in the FOLDER with LOCATION."
 129   (car (elmo-get-hash-val
 130         location
 131         (elmo-map-folder-location-hash-internal folder))))
 132
 133 (defun elmo-map-message-location (folder number)
 134   "Return location of the message in the FOLDER with NUMBER."
 135   (cdr (elmo-get-hash-val
 136         (concat "#" (int-to-string number))
 137         (elmo-map-folder-location-hash-internal folder))))
 138
 139 (luna-define-method elmo-folder-pack-numbers ((folder elmo-map-folder))
 140   (let* ((msgdb (elmo-folder-msgdb folder))
 141          (numbers (sort (elmo-folder-list-messages folder 'in-db) '<))
 142          (new-msgdb (elmo-make-msgdb))
 143          (number 1)
 144          total location entity)
 145     (elmo-msgdb-set-path new-msgdb (elmo-folder-msgdb-path folder))
 146     (setq total (length numbers))
 147     (elmo-with-progress-display (> total elmo-display-progress-threshold)
 148         (elmo-folder-pack-numbers total "Packing...")
 149       (dolist (old-number numbers)
 150         (setq entity (elmo-msgdb-message-entity msgdb old-number))
 151         (elmo-msgdb-overview-entity-set-number entity number)
 152         (elmo-msgdb-append-entity new-msgdb entity
 153                                   (elmo-msgdb-get-mark msgdb old-number))
 154         (setq location
 155               (cons (cons number
 156                           (elmo-map-message-location folder old-number))
 157                     location))
 158         (setq number (1+ number))))
 159     (message "Packing...done")
 160     (elmo-map-folder-location-setup folder (nreverse location))
 161     (elmo-folder-set-msgdb-internal folder new-msgdb)))
 162
 163 (defun elmo-map-folder-location-setup (folder locations)
 164   (elmo-map-folder-set-location-alist-internal
 165    folder
 166    locations)
 167   (elmo-map-folder-set-location-hash-internal
 168    folder (elmo-make-hash
 169            (* 2 (length locations))))
 170   (elmo-map-folder-set-number-max-internal folder 0)
 171   ;; Set number-max and hashtables.
 172   (dolist (location-cons locations)
 173     (if (< (elmo-map-folder-number-max-internal folder)
 174            (car location-cons))
 175         (elmo-map-folder-set-number-max-internal folder (car location-cons)))
 176     (elmo-set-hash-val (cdr location-cons)
 177                        location-cons
 178                        (elmo-map-folder-location-hash-internal folder))
 179     (elmo-set-hash-val (concat "#" (int-to-string (car location-cons)))
 180                        location-cons
 181                        (elmo-map-folder-location-hash-internal folder))))
 182
 183 (defun elmo-map-folder-update-locations (folder locations)
 184   ;; A subroutine to make location-alist.
 185   ;; location-alist is existing location-alist.
 186   ;; locations is the newest locations.
 187   (let* ((location-alist (elmo-map-folder-location-alist-internal folder))
 188          (locations-in-db (mapcar 'cdr location-alist))
 189          new-locs new-alist deleted-locs pair i)
 190     (setq new-locs
 191           (elmo-delete-if (function
 192                            (lambda (x) (member x locations-in-db)))
 193                           locations))
 194     (setq deleted-locs
 195           (elmo-delete-if (function
 196                            (lambda (x) (member x locations)))
 197                           locations-in-db))
 198     (dolist (location deleted-locs)
 199       (setq location-alist
 200             (delq (setq pair
 201                         (elmo-get-hash-val
 202                          location
 203                          (elmo-map-folder-location-hash-internal
 204                           folder)))
 205                   location-alist))
 206       (when pair
 207         (elmo-clear-hash-val (concat "#" (int-to-string (car pair)))
 208                              (elmo-map-folder-location-hash-internal
 209                               folder))
 210         (elmo-clear-hash-val location
 211                              (elmo-map-folder-location-hash-internal
 212                               folder))))
 213     (setq i (elmo-map-folder-number-max-internal folder))
 214     (dolist (location new-locs)
 215       (setq i (1+ i))
 216       (elmo-map-folder-set-number-max-internal folder i)
 217       (setq new-alist (cons (setq pair (cons i location)) new-alist))
 218       (setq new-alist (nreverse new-alist))
 219       (elmo-set-hash-val (concat "#" (int-to-string i))
 220                          pair
 221                          (elmo-map-folder-location-hash-internal
 222                           folder))
 223       (elmo-set-hash-val location
 224                          pair
 225                          (elmo-map-folder-location-hash-internal
 226                           folder)))
 227     (setq location-alist
 228           (sort (nconc location-alist new-alist)
 229                 (lambda (x y) (< (car x) (car y)))))
 230     (elmo-map-folder-set-location-alist-internal folder location-alist)))
 231
 232 (luna-define-method elmo-folder-open-internal ((folder elmo-map-folder))
 233   (elmo-map-folder-location-setup
 234    folder
 235    (elmo-msgdb-location-load (elmo-folder-msgdb-path folder)))
 236   (if (elmo-folder-plugged-p folder)
 237       (elmo-map-folder-update-locations
 238        folder
 239        (elmo-map-folder-list-message-locations folder))))
 240
 241 (luna-define-method elmo-folder-commit :after ((folder elmo-map-folder))
 242   (when (elmo-folder-persistent-p folder)
 243     (elmo-msgdb-location-save (elmo-folder-msgdb-path folder)
 244                               (elmo-map-folder-location-alist-internal
 245                                folder))))
 246
 247 (luna-define-method elmo-folder-close-internal ((folder elmo-map-folder))
 248   (elmo-map-folder-set-location-alist-internal folder nil)
 249   (elmo-map-folder-set-location-hash-internal folder nil))
 250
 251 (luna-define-method elmo-folder-check ((folder elmo-map-folder))
 252   (elmo-map-folder-update-locations
 253    folder
 254    (elmo-map-folder-list-message-locations folder)))
 255
 256 (luna-define-method elmo-folder-clear :around ((folder elmo-map-folder)
 257                                                &optional keep-killed)
 258   (unless keep-killed
 259     (elmo-map-folder-set-number-max-internal folder 0)
 260     (elmo-map-folder-set-location-alist-internal folder nil)
 261     ;; clear hashtable.
 262     (elmo-map-folder-set-location-hash-internal folder (elmo-make-hash)))
 263   (luna-call-next-method))
 264
 265 (luna-define-method elmo-folder-list-messages-internal
 266   ((folder elmo-map-folder) &optional nohide)
 267   (mapcar 'car (elmo-map-folder-location-alist-internal folder)))
 268
 269 (luna-define-method elmo-folder-unmark-important :before ((folder
 270                                                            elmo-map-folder)
 271                                                           numbers
 272                                                           &optional
 273                                                           ignore-flags)
 274   (unless ignore-flags
 275     (elmo-map-folder-unmark-important
 276      folder
 277      (elmo-map-folder-numbers-to-locations folder numbers))))
 278
 279 (luna-define-method elmo-folder-mark-as-important :before ((folder
 280                                                             elmo-map-folder)
 281                                                            numbers
 282                                                            &optional
 283                                                            ignore-flags)
 284   (unless ignore-flags
 285     (elmo-map-folder-mark-as-important
 286      folder
 287      (elmo-map-folder-numbers-to-locations folder numbers))))
 288
 289 (luna-define-method elmo-folder-unmark-read :before ((folder elmo-map-folder)
 290                                                      numbers
 291                                                      &optional ignore-flags)
 292   (unless ignore-flags
 293     (elmo-map-folder-unmark-read
 294      folder
 295      (elmo-map-folder-numbers-to-locations folder numbers))))
 296
 297 (luna-define-method elmo-folder-mark-as-read :before ((folder
 298                                                        elmo-map-folder)
 299                                                       numbers
 300                                                       &optional ignore-flags)
 301   (unless ignore-flags
 302     (elmo-map-folder-mark-as-read
 303      folder
 304      (elmo-map-folder-numbers-to-locations folder numbers))))
 305
 306 (luna-define-method elmo-folder-unmark-answered :before ((folder
 307                                                           elmo-map-folder)
 308                                                          numbers)
 309   (elmo-map-folder-unmark-answered
 310    folder
 311    (elmo-map-folder-numbers-to-locations folder numbers)))
 312
 313 (luna-define-method elmo-folder-mark-as-answered :before ((folder
 314                                                           elmo-map-folder)
 315                                                          numbers)
 316   (elmo-map-folder-mark-as-answered
 317    folder
 318    (elmo-map-folder-numbers-to-locations folder numbers)))
 319
 320 (luna-define-method elmo-message-fetch-internal ((folder elmo-map-folder)
 321                                                  number strategy
 322                                                  &optional section unread)
 323   (elmo-map-message-fetch
 324    folder
 325    (elmo-map-message-location folder number)
 326    strategy section unread))
 327
 328 (luna-define-method elmo-folder-list-unreads :around ((folder elmo-map-folder))
 329   (let ((locations (elmo-map-folder-list-unreads folder)))
 330     (if (listp locations)
 331         (elmo-map-folder-locations-to-numbers folder locations)
 332       (luna-call-next-method))))
 333
 334 (luna-define-method elmo-folder-list-importants :around ((folder
 335                                                           elmo-map-folder))
 336   (let ((locations (elmo-map-folder-list-importants folder)))
 337     (if (listp locations)
 338         (elmo-map-folder-locations-to-numbers folder locations)
 339       (luna-call-next-method))))
 340
 341 (luna-define-method elmo-folder-list-answereds :around ((folder
 342                                                          elmo-map-folder))
 343   (let ((locations (elmo-map-folder-list-answereds folder)))
 344     (if (listp locations)
 345         (elmo-map-folder-locations-to-numbers folder locations)
 346       (luna-call-next-method))))
 347
 348 (luna-define-method elmo-folder-delete-messages ((folder elmo-map-folder)
 349                                                  numbers)
 350   (elmo-map-folder-delete-messages
 351    folder
 352    (elmo-map-folder-numbers-to-locations folder numbers))
 353   (dolist (number numbers)
 354     (elmo-map-folder-set-location-alist-internal
 355      folder
 356      (delq (elmo-get-hash-val
 357             (concat "#" (int-to-string number))
 358             (elmo-map-folder-location-hash-internal
 359              folder))
 360            (elmo-map-folder-location-alist-internal folder))))
 361   t) ; success
 362
 363 (require 'product)
 364 (product-provide (provide 'elmo-map) (require 'elmo-version))
 365
 366 ;;; elmo-map.el ends here