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