dom/src/storage/nsDOMStorageMemoryDB.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Mozilla Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2009
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Honza Bambas <honzab@firemni.cz>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsDOMStorageMemoryDB_h___
  40 #define nsDOMStorageMemoryDB_h___
  41
  42 #include "nscore.h"
  43 #include "nsClassHashtable.h"
  44 #include "nsDataHashtable.h"
  45
  46 class nsDOMStoragePersistentDB;
  47
  48 class nsDOMStorageMemoryDB
  49 {
  50 public:
  51   nsDOMStorageMemoryDB() : mPreloading(PR_FALSE) {}
  52   ~nsDOMStorageMemoryDB() {}
  53
  54   class nsInMemoryItem
  55   {
  56   public:
  57     PRBool mSecure;
  58     nsString mValue;
  59   };
  60
  61   typedef nsClassHashtable<nsStringHashKey, nsInMemoryItem> nsStorageItemsTable;
  62
  63   class nsInMemoryStorage
  64   {
  65   public:
  66     nsStorageItemsTable mTable;
  67     PRInt32 mUsageDelta;
  68
  69     nsInMemoryStorage() : mUsageDelta(0) {}
  70   };
  71
  72   /**
  73    * @param aPreloadDB
  74    *    If non-null, data for a domain/origin will be preloaded from
  75    *    the provided database. Used for session-only cookies mode to
  76    *    provide existing data from the persistent database.
  77    */
  78   nsresult
  79   Init(nsDOMStoragePersistentDB* aPreloadDB = nsnull);
  80
  81   /**
  82    *
  83    */
  84   nsresult
  85   GetItemsTable(nsDOMStorage* aStorage,
  86                 nsInMemoryStorage** aMemoryStorage);
  87
  88   /**
  89    * Retrieve a list of all the keys associated with a particular domain.
  90    */
  91   nsresult
  92   GetAllKeys(nsDOMStorage* aStorage,
  93              nsTHashtable<nsSessionStorageEntry>* aKeys);
  94
  95   /**
  96    * Retrieve a value and secure flag for a key from storage.
  97    *
  98    * @throws NS_ERROR_DOM_NOT_FOUND_ERR if key not found
  99    */
 100   nsresult
 101   GetKeyValue(nsDOMStorage* aStorage,
 102               const nsAString& aKey,
 103               nsAString& aValue,
 104               PRBool* aSecure);
 105
 106   /**
 107    * Set the value and secure flag for a key in storage.
 108    */
 109   nsresult
 110   SetKey(nsDOMStorage* aStorage,
 111          const nsAString& aKey,
 112          const nsAString& aValue,
 113          PRBool aSecure,
 114          PRInt32 aQuota,
 115          PRBool aExcludeOfflineFromUsage,
 116          PRInt32* aNewUsage);
 117
 118   /**
 119    * Set the secure flag for a key in storage. Does nothing if the key was
 120    * not found.
 121    */
 122   nsresult
 123   SetSecure(nsDOMStorage* aStorage,
 124             const nsAString& aKey,
 125             const PRBool aSecure);
 126
 127   /**
 128    * Removes a key from storage.
 129    */
 130   nsresult
 131   RemoveKey(nsDOMStorage* aStorage,
 132             const nsAString& aKey,
 133             PRBool aExcludeOfflineFromUsage,
 134             PRInt32 aKeyUsage);
 135
 136   /**
 137     * Remove all keys belonging to this storage.
 138     */
 139   nsresult
 140   ClearStorage(nsDOMStorage* aStorage);
 141
 142   /**
 143    * If we have changed the persistent storage, drop any potential session storages
 144    */
 145   nsresult
 146   DropStorage(nsDOMStorage* aStorage);
 147
 148   /**
 149    * Removes all keys added by a given domain.
 150    */
 151   nsresult
 152   RemoveOwner(const nsACString& aOwner, PRBool aIncludeSubDomains);
 153
 154   /**
 155    * Removes keys owned by domains that either match or don't match the
 156    * list.
 157    */
 158   nsresult
 159   RemoveOwners(const nsTArray<nsString>& aOwners,
 160                PRBool aIncludeSubDomains, PRBool aMatch);
 161
 162   /**
 163    * Removes all keys from storage. Used when clearing storage.
 164    */
 165   nsresult
 166   RemoveAll();
 167
 168   /**
 169     * Returns usage for a storage using its GetQuotaDomainDBKey() as a key.
 170     */
 171   nsresult
 172   GetUsage(nsDOMStorage* aStorage, PRBool aExcludeOfflineFromUsage, PRInt32 *aUsage);
 173
 174   /**
 175     * Returns usage of the domain and optionaly by any subdomain.
 176     */
 177   nsresult
 178   GetUsage(const nsACString& aDomain, PRBool aIncludeSubDomains, PRInt32 *aUsage);
 179
 180 protected:
 181
 182   nsClassHashtable<nsCStringHashKey, nsInMemoryStorage> mData;
 183   nsDOMStoragePersistentDB* mPreloadDB;
 184   PRBool mPreloading;
 185
 186   nsresult
 187   GetUsageInternal(const nsACString& aQuotaDomainDBKey, PRBool aExcludeOfflineFromUsage, PRInt32 *aUsage);
 188 };
 189
 190 #endif