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-message-fetch (folder location
  78                                                     strategy
  79                                                     &optional
  80                                                     section
  81                                                     unseen)
  82   "")
  83
  84 (luna-define-generic elmo-map-folder-list-unreads (folder)
  85   "")
  86
  87 (luna-define-generic elmo-map-folder-list-importants (folder)
  88   "")
  89
  90 (luna-define-method elmo-map-folder-list-importants ((folder elmo-map-folder))
  91   t)
  92
  93 (luna-define-generic elmo-map-folder-delete-messages (folder locations)
  94   "")
  95
  96 (luna-define-method elmo-folder-status ((folder elmo-map-folder))
  97   (elmo-folder-open-internal folder)
  98   (prog1
  99       (let ((numbers (mapcar
 100                       'car
 101                       (elmo-map-folder-location-alist-internal folder))))
 102         (cons (elmo-max-of-list numbers)
 103               (length numbers)))
 104     ;; Don't close after status.
 105     (unless (elmo-folder-reserve-status-p folder)
 106       (elmo-folder-close-internal folder))))
 107
 108 (defun elmo-map-message-number (folder location)
 109   "Return number of the message in the FOLDER with LOCATION."
 110   (car (elmo-get-hash-val
 111         location
 112         (elmo-map-folder-location-hash-internal folder))))
 113
 114 (defun elmo-map-message-location (folder number)
 115   "Return location of the message in the FOLDER with NUMBER."
 116   (cdr (elmo-get-hash-val
 117         (concat "#" (int-to-string number))
 118         (elmo-map-folder-location-hash-internal folder))))
 119
 120 (luna-define-method elmo-folder-pack-number ((folder elmo-map-folder))
 121   (let* ((msgdb (elmo-folder-msgdb folder))
 122          (old-number-alist (elmo-msgdb-get-number-alist msgdb))
 123          (old-overview (elmo-msgdb-get-overview msgdb))
 124          (old-mark-alist (elmo-msgdb-get-mark-alist msgdb))
 125          (old-location (elmo-map-folder-location-alist-internal folder))
 126          old-number overview number-alist mark-alist location
 127          mark (number 1))
 128     (setq overview old-overview)
 129     (while old-overview
 130       (setq old-number
 131             (elmo-msgdb-overview-entity-get-number (car old-overview)))
 132       (elmo-msgdb-overview-entity-set-number (car old-overview) number)
 133       (setq number-alist
 134             (cons (cons number (cdr (assq old-number old-number-alist)))
 135                   number-alist))
 136       (when (setq mark (cadr (assq old-number old-mark-alist)))
 137         (setq mark-alist
 138               (elmo-msgdb-mark-append
 139                mark-alist number mark)))
 140       (setq location
 141             (cons (cons number
 142                         (elmo-map-message-location folder old-number))
 143                   location))
 144       (setq number (1+ number))
 145       (setq old-overview (cdr old-overview)))
 146     (elmo-map-folder-location-setup folder (nreverse location))
 147     (elmo-folder-set-msgdb-internal
 148      folder
 149      (list overview
 150            (nreverse number-alist)
 151            (nreverse mark-alist)
 152            (elmo-msgdb-make-overview-hashtb overview)))))
 153
 154 (defun elmo-map-folder-location-setup (folder locations)
 155   (elmo-map-folder-set-location-alist-internal
 156    folder
 157    locations)
 158   (elmo-map-folder-set-location-hash-internal
 159    folder (elmo-make-hash
 160            (* 2 (length locations))))
 161   (elmo-map-folder-set-number-max-internal folder 0)
 162   ;; Set number-max and hashtables.
 163   (dolist (location-cons locations)
 164     (if (< (elmo-map-folder-number-max-internal folder)
 165            (car location-cons))
 166         (elmo-map-folder-set-number-max-internal folder (car location-cons)))
 167     (elmo-set-hash-val (cdr location-cons)
 168                        location-cons
 169                        (elmo-map-folder-location-hash-internal folder))
 170     (elmo-set-hash-val (concat "#" (int-to-string (car location-cons)))
 171                        location-cons
 172                        (elmo-map-folder-location-hash-internal folder))))
 173
 174 (defun elmo-map-folder-update-locations (folder locations)
 175   ;; A subroutine to make location-alist.
 176   ;; location-alist is existing location-alist.
 177   ;; locations is the newest locations.
 178   (let* ((location-alist (elmo-map-folder-location-alist-internal folder))
 179          (locations-in-db (mapcar 'cdr location-alist))
 180          new-locs new-alist deleted-locs pair i)
 181     (setq new-locs
 182           (elmo-delete-if (function
 183                            (lambda (x) (member x locations-in-db)))
 184                           locations))
 185     (setq deleted-locs
 186           (elmo-delete-if (function
 187                            (lambda (x) (member x locations)))
 188                           locations-in-db))
 189     (dolist (location deleted-locs)
 190       (setq location-alist
 191             (delq (setq pair
 192                         (elmo-get-hash-val
 193                          location
 194                          (elmo-map-folder-location-hash-internal
 195                           folder)))
 196                   location-alist))
 197       (when pair
 198         (elmo-clear-hash-val (concat "#" (int-to-string (car pair)))
 199                              (elmo-map-folder-location-hash-internal
 200                               folder))
 201         (elmo-clear-hash-val location
 202                              (elmo-map-folder-location-hash-internal
 203                               folder))))
 204     (setq i (elmo-map-folder-number-max-internal folder))
 205     (dolist (location new-locs)
 206       (setq i (1+ i))
 207       (elmo-map-folder-set-number-max-internal folder i)
 208       (setq new-alist (cons (setq pair (cons i location)) new-alist))
 209       (setq new-alist (nreverse new-alist))
 210       (elmo-set-hash-val (concat "#" (int-to-string i))
 211                          pair
 212                          (elmo-map-folder-location-hash-internal
 213                           folder))
 214       (elmo-set-hash-val location
 215                          pair
 216                          (elmo-map-folder-location-hash-internal
 217                           folder)))
 218     (setq location-alist
 219           (sort (nconc location-alist new-alist)
 220                 (lambda (x y) (< (car x) (car y)))))
 221     (elmo-map-folder-set-location-alist-internal folder location-alist)))
 222
 223 (luna-define-method elmo-folder-open-internal ((folder elmo-map-folder))
 224   (elmo-map-folder-location-setup
 225    folder
 226    (elmo-msgdb-location-load (elmo-folder-msgdb-path folder)))
 227   (if (elmo-folder-plugged-p folder)
 228       (elmo-map-folder-update-locations
 229        folder
 230        (elmo-map-folder-list-message-locations folder))))
 231
 232 (luna-define-method elmo-folder-commit :after ((folder elmo-map-folder))
 233   (when (elmo-folder-persistent-p folder)
 234     (elmo-msgdb-location-save (elmo-folder-msgdb-path folder)
 235                               (elmo-map-folder-location-alist-internal
 236                                folder))))
 237
 238 (luna-define-method elmo-folder-close-internal ((folder elmo-map-folder))
 239   (elmo-map-folder-set-location-alist-internal folder nil)
 240   (elmo-map-folder-set-location-hash-internal folder nil))
 241
 242 (luna-define-method elmo-folder-check ((folder elmo-map-folder))
 243   (elmo-map-folder-update-locations
 244    folder
 245    (elmo-map-folder-list-message-locations folder)))
 246
 247 (luna-define-method elmo-folder-clear :around ((folder elmo-map-folder)
 248                                                &optional keep-killed)
 249   (unless keep-killed
 250     (elmo-map-folder-set-number-max-internal folder 0)
 251     (elmo-map-folder-set-location-alist-internal folder nil)
 252     ;; clear hashtable.
 253     (elmo-map-folder-set-location-hash-internal folder (elmo-make-hash)))
 254   (luna-call-next-method))
 255
 256 (luna-define-method elmo-folder-list-messages-internal
 257   ((folder elmo-map-folder) &optional nohide)
 258   (mapcar 'car (elmo-map-folder-location-alist-internal folder)))
 259
 260 (luna-define-method elmo-folder-unmark-important ((folder elmo-map-folder)
 261                                                   numbers)
 262   (elmo-map-folder-unmark-important
 263    folder
 264    (elmo-map-folder-numbers-to-locations folder numbers)))
 265
 266 (luna-define-method elmo-folder-mark-as-important ((folder elmo-map-folder)
 267                                                    numbers)
 268   (elmo-map-folder-mark-as-important
 269    folder
 270    (elmo-map-folder-numbers-to-locations folder numbers)))
 271
 272 (luna-define-method elmo-folder-unmark-read ((folder elmo-map-folder)
 273                                              numbers)
 274   (elmo-map-folder-unmark-read
 275    folder
 276    (elmo-map-folder-numbers-to-locations folder numbers)))
 277
 278 (luna-define-method elmo-folder-mark-as-read ((folder elmo-map-folder) numbers)
 279   (elmo-map-folder-mark-as-read
 280    folder
 281    (elmo-map-folder-numbers-to-locations folder numbers)))
 282
 283 (luna-define-method elmo-message-fetch-internal ((folder elmo-map-folder)
 284                                                  number strategy
 285                                                  &optional section unread)
 286   (elmo-map-message-fetch
 287    folder
 288    (elmo-map-message-location folder number)
 289    strategy section unread))
 290
 291 (luna-define-method elmo-folder-list-unreads-internal
 292   ((folder elmo-map-folder) unread-marks &optional mark-alist)
 293   (elmo-map-folder-locations-to-numbers
 294    folder
 295    (elmo-map-folder-list-unreads folder)))
 296
 297 (luna-define-method elmo-folder-list-importants-internal
 298   ((folder elmo-map-folder) important-mark)
 299   (let ((locations (elmo-map-folder-list-importants folder)))
 300     (if (listp locations)
 301         (elmo-map-folder-locations-to-numbers folder locations)
 302       t)))
 303
 304 (luna-define-method elmo-folder-delete-messages ((folder elmo-map-folder)
 305                                                  numbers)
 306   (elmo-map-folder-delete-messages
 307    folder
 308    (elmo-map-folder-numbers-to-locations folder numbers))
 309   (dolist (number numbers)
 310     (elmo-map-folder-set-location-alist-internal
 311      folder
 312      (delq (elmo-get-hash-val
 313             (concat "#" (int-to-string number))
 314             (elmo-map-folder-location-hash-internal
 315              folder))
 316            (elmo-map-folder-location-alist-internal folder))))
 317   t) ; success
 318
 319
 320 (require 'product)
 321 (product-provide (provide 'elmo-map) (require 'elmo-version))
 322
 323 ;;; elmo-map.el ends here