Back to index

lightning-sunbird  0.9+nobinonly
nsDOMStorageDB.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Initial Developer of the Original Code is
00016  * Mozilla Corporation.
00017  * Portions created by the Initial Developer are Copyright (C) 2006
00018  * the Initial Developer. All Rights Reserved.
00019  *
00020  * Contributor(s):
00021  *   Neil Deakin <enndeakin@sympatico.ca>
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either of the GNU General Public License Version 2 or later (the "GPL"),
00025  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #ifndef nsDOMStorageDB_h___
00038 #define nsDOMStorageDB_h___
00039 
00040 #include "nscore.h"
00041 #include "mozIStorageConnection.h"
00042 #include "mozIStorageStatement.h"
00043 #include "nsTHashtable.h"
00044 
00045 class nsDOMStorage;
00046 class nsSessionStorageEntry;
00047 
00048 class nsDOMStorageDB
00049 {
00050 public:
00051   nsDOMStorageDB() {};
00052   ~nsDOMStorageDB() {};
00053 
00054   nsresult
00055   Init();
00056 
00060   nsresult
00061   GetAllKeys(const nsAString& aDomain,
00062              nsDOMStorage* aStorage,
00063              nsTHashtable<nsSessionStorageEntry>* aKeys);
00064 
00070   nsresult
00071   GetKeyValue(const nsAString& aDomain,
00072               const nsAString& aKey,
00073               nsAString& aValue,
00074               PRBool* aSecure,
00075               nsAString& aOwner);
00076 
00080   nsresult
00081   SetKey(const nsAString& aDomain,
00082          const nsAString& aKey,
00083          const nsAString& aValue,
00084          PRBool aSecure,
00085          const nsAString& aOwner,
00086          PRInt32 aQuota);
00087 
00092   nsresult
00093   SetSecure(const nsAString& aDomain,
00094             const nsAString& aKey,
00095             const PRBool aSecure);
00096 
00100   nsresult
00101   RemoveKey(const nsAString& aDomain,
00102             const nsAString& aKey,
00103             const nsAString& aOwner,
00104             PRInt32 aKeyUsage);
00105 
00109   nsresult
00110   RemoveAll();
00111 
00112 protected:
00113 
00114   nsresult GetUsage(const nsAString &aOwner, PRInt32 *aUsage);
00115 
00116   nsCOMPtr<mozIStorageConnection> mConnection;
00117 
00118   nsCOMPtr<mozIStorageStatement> mGetAllKeysStatement;
00119   nsCOMPtr<mozIStorageStatement> mGetKeyValueStatement;
00120   nsCOMPtr<mozIStorageStatement> mInsertKeyStatement;
00121   nsCOMPtr<mozIStorageStatement> mUpdateKeyStatement;
00122   nsCOMPtr<mozIStorageStatement> mSetSecureStatement;
00123   nsCOMPtr<mozIStorageStatement> mRemoveKeyStatement;
00124   nsCOMPtr<mozIStorageStatement> mRemoveAllStatement;
00125   nsCOMPtr<mozIStorageStatement> mGetUsageStatement;
00126 
00127   nsAutoString mCachedOwner;
00128   PRInt32 mCachedUsage;
00129 };
00130 
00131 #endif /* nsDOMStorageDB_h___ */