2007-03-22 10:30:00 -07:00
|
|
|
/* vim:set ts=2 sw=2 sts=2 et cin: */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is Mozilla.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is IBM Corporation.
|
|
|
|
* Portions created by IBM Corporation are Copyright (C) 2004
|
|
|
|
* IBM Corporation. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Darin Fisher <darin@meer.net>
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
2007-05-14 13:09:20 -07:00
|
|
|
#ifndef nsOfflineCacheDevice_h__
|
|
|
|
#define nsOfflineCacheDevice_h__
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
#include "nsCacheDevice.h"
|
2008-08-26 16:09:02 -07:00
|
|
|
#include "nsIApplicationCache.h"
|
|
|
|
#include "nsIApplicationCacheService.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
#include "nsILocalFile.h"
|
|
|
|
#include "nsIObserver.h"
|
|
|
|
#include "mozIStorageConnection.h"
|
2007-07-25 17:47:33 -07:00
|
|
|
#include "mozIStorageFunction.h"
|
|
|
|
#include "nsIFile.h"
|
|
|
|
#include "nsAutoPtr.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
#include "nsCOMPtr.h"
|
2007-07-25 17:47:33 -07:00
|
|
|
#include "nsCOMArray.h"
|
2008-08-26 16:09:02 -07:00
|
|
|
#include "nsInterfaceHashtable.h"
|
|
|
|
#include "nsClassHashtable.h"
|
|
|
|
#include "nsHashSets.h"
|
|
|
|
#include "nsWeakReference.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2008-09-30 11:34:23 -07:00
|
|
|
class nsIURI;
|
2007-07-25 17:47:33 -07:00
|
|
|
class nsOfflineCacheDevice;
|
|
|
|
|
2008-09-30 11:34:23 -07:00
|
|
|
class nsApplicationCacheNamespace : public nsIApplicationCacheNamespace
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIAPPLICATIONCACHENAMESPACE
|
|
|
|
|
|
|
|
nsApplicationCacheNamespace() : mItemType(0) {}
|
|
|
|
|
|
|
|
private:
|
|
|
|
PRUint32 mItemType;
|
|
|
|
nsCString mNamespaceSpec;
|
|
|
|
nsCString mData;
|
|
|
|
};
|
|
|
|
|
2007-07-25 17:47:33 -07:00
|
|
|
class nsOfflineCacheEvictionFunction : public mozIStorageFunction {
|
|
|
|
public:
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_MOZISTORAGEFUNCTION
|
|
|
|
|
|
|
|
nsOfflineCacheEvictionFunction(nsOfflineCacheDevice *device)
|
|
|
|
: mDevice(device)
|
|
|
|
{}
|
|
|
|
|
|
|
|
void Reset() { mItems.Clear(); }
|
|
|
|
void Apply();
|
|
|
|
|
|
|
|
private:
|
|
|
|
nsOfflineCacheDevice *mDevice;
|
|
|
|
nsCOMArray<nsIFile> mItems;
|
|
|
|
|
|
|
|
};
|
|
|
|
|
2007-05-14 13:09:20 -07:00
|
|
|
class nsOfflineCacheDevice : public nsCacheDevice
|
2008-08-26 16:09:02 -07:00
|
|
|
, public nsIApplicationCacheService
|
2007-03-22 10:30:00 -07:00
|
|
|
{
|
|
|
|
public:
|
2007-05-14 13:09:20 -07:00
|
|
|
nsOfflineCacheDevice();
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2008-08-26 16:09:02 -07:00
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIAPPLICATIONCACHESERVICE
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/**
|
|
|
|
* nsCacheDevice methods
|
|
|
|
*/
|
2007-05-14 13:09:20 -07:00
|
|
|
|
|
|
|
virtual ~nsOfflineCacheDevice();
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2008-08-26 16:09:02 -07:00
|
|
|
static nsOfflineCacheDevice *GetInstance();
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
virtual nsresult Init();
|
|
|
|
virtual nsresult Shutdown();
|
|
|
|
|
|
|
|
virtual const char * GetDeviceID(void);
|
|
|
|
virtual nsCacheEntry * FindEntry(nsCString * key, PRBool *collision);
|
|
|
|
virtual nsresult DeactivateEntry(nsCacheEntry * entry);
|
|
|
|
virtual nsresult BindEntry(nsCacheEntry * entry);
|
|
|
|
virtual void DoomEntry( nsCacheEntry * entry );
|
|
|
|
|
|
|
|
virtual nsresult OpenInputStreamForEntry(nsCacheEntry * entry,
|
|
|
|
nsCacheAccessMode mode,
|
|
|
|
PRUint32 offset,
|
|
|
|
nsIInputStream ** result);
|
|
|
|
|
|
|
|
virtual nsresult OpenOutputStreamForEntry(nsCacheEntry * entry,
|
|
|
|
nsCacheAccessMode mode,
|
|
|
|
PRUint32 offset,
|
|
|
|
nsIOutputStream ** result);
|
|
|
|
|
|
|
|
virtual nsresult GetFileForEntry(nsCacheEntry * entry,
|
|
|
|
nsIFile ** result);
|
|
|
|
|
|
|
|
virtual nsresult OnDataSizeChange(nsCacheEntry * entry, PRInt32 deltaSize);
|
|
|
|
|
|
|
|
virtual nsresult Visit(nsICacheVisitor * visitor);
|
|
|
|
|
|
|
|
virtual nsresult EvictEntries(const char * clientID);
|
|
|
|
|
2007-05-14 13:09:20 -07:00
|
|
|
/* Entry ownership */
|
2007-07-24 22:35:39 -07:00
|
|
|
nsresult GetOwnerDomains(const char * clientID,
|
|
|
|
PRUint32 * count,
|
|
|
|
char *** domains);
|
|
|
|
nsresult GetOwnerURIs(const char * clientID,
|
|
|
|
const nsACString & ownerDomain,
|
|
|
|
PRUint32 * count,
|
|
|
|
char *** uris);
|
2007-05-14 13:09:20 -07:00
|
|
|
nsresult SetOwnedKeys(const char * clientID,
|
|
|
|
const nsACString & ownerDomain,
|
|
|
|
const nsACString & ownerUrl,
|
|
|
|
PRUint32 count,
|
|
|
|
const char ** keys);
|
|
|
|
nsresult GetOwnedKeys(const char * clientID,
|
|
|
|
const nsACString & ownerDomain,
|
|
|
|
const nsACString & ownerUrl,
|
|
|
|
PRUint32 * count,
|
|
|
|
char *** keys);
|
|
|
|
nsresult AddOwnedKey(const char * clientID,
|
|
|
|
const nsACString & ownerDomain,
|
|
|
|
const nsACString & ownerURI,
|
|
|
|
const nsACString & key);
|
|
|
|
nsresult RemoveOwnedKey(const char * clientID,
|
|
|
|
const nsACString & ownerDomain,
|
|
|
|
const nsACString & ownerURI,
|
|
|
|
const nsACString & key);
|
|
|
|
nsresult KeyIsOwned(const char * clientID,
|
|
|
|
const nsACString & ownerDomain,
|
|
|
|
const nsACString & ownerURI,
|
|
|
|
const nsACString & key,
|
|
|
|
PRBool * isOwned);
|
|
|
|
|
|
|
|
nsresult ClearKeysOwnedByDomain(const char *clientID,
|
|
|
|
const nsACString &ownerDomain);
|
|
|
|
nsresult EvictUnownedEntries(const char *clientID);
|
|
|
|
|
2008-08-26 16:09:02 -07:00
|
|
|
nsresult ActivateCache(const nsCSubstring &group,
|
|
|
|
const nsCSubstring &clientID);
|
|
|
|
PRBool IsActiveCache(const nsCSubstring &group,
|
|
|
|
const nsCSubstring &clientID);
|
|
|
|
nsresult GetGroupForCache(const nsCSubstring &clientID,
|
|
|
|
nsCString &out);
|
2007-05-14 13:09:20 -07:00
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/**
|
|
|
|
* Preference accessors
|
|
|
|
*/
|
|
|
|
|
|
|
|
void SetCacheParentDirectory(nsILocalFile * parentDir);
|
|
|
|
void SetCapacity(PRUint32 capacity);
|
|
|
|
|
|
|
|
nsILocalFile * CacheDirectory() { return mCacheDirectory; }
|
|
|
|
PRUint32 CacheCapacity() { return mCacheCapacity; }
|
|
|
|
PRUint32 CacheSize();
|
|
|
|
PRUint32 EntryCount();
|
|
|
|
|
2007-05-14 13:09:20 -07:00
|
|
|
private:
|
2008-08-26 16:09:02 -07:00
|
|
|
friend class nsApplicationCache;
|
|
|
|
|
|
|
|
static PLDHashOperator ShutdownApplicationCache(const nsACString &key,
|
|
|
|
nsIWeakReference *weakRef,
|
|
|
|
void *ctx);
|
|
|
|
|
2008-08-27 18:15:32 -07:00
|
|
|
static PRBool GetStrictFileOriginPolicy();
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
PRBool Initialized() { return mDB != nsnull; }
|
2008-08-26 16:09:02 -07:00
|
|
|
|
|
|
|
nsresult InitActiveCaches();
|
2007-03-22 10:30:00 -07:00
|
|
|
nsresult UpdateEntry(nsCacheEntry *entry);
|
|
|
|
nsresult UpdateEntrySize(nsCacheEntry *entry, PRUint32 newSize);
|
|
|
|
nsresult DeleteEntry(nsCacheEntry *entry, PRBool deleteData);
|
|
|
|
nsresult DeleteData(nsCacheEntry *entry);
|
|
|
|
nsresult EnableEvictionObserver();
|
|
|
|
nsresult DisableEvictionObserver();
|
2008-08-26 16:09:02 -07:00
|
|
|
|
2008-09-30 11:34:23 -07:00
|
|
|
PRBool CanUseCache(nsIURI *keyURI, const nsCString &clientID);
|
|
|
|
|
2008-08-26 16:09:02 -07:00
|
|
|
nsresult MarkEntry(const nsCString &clientID,
|
|
|
|
const nsACString &key,
|
|
|
|
PRUint32 typeBits);
|
|
|
|
nsresult UnmarkEntry(const nsCString &clientID,
|
|
|
|
const nsACString &key,
|
|
|
|
PRUint32 typeBits);
|
2008-09-30 11:34:23 -07:00
|
|
|
|
|
|
|
nsresult CacheOpportunistically(const nsCString &clientID,
|
|
|
|
const nsACString &key);
|
2008-08-26 16:09:02 -07:00
|
|
|
nsresult GetTypes(const nsCString &clientID,
|
|
|
|
const nsACString &key,
|
|
|
|
PRUint32 *typeBits);
|
2008-09-30 11:34:23 -07:00
|
|
|
|
|
|
|
nsresult GetMatchingNamespace(const nsCString &clientID,
|
|
|
|
const nsACString &key,
|
|
|
|
nsIApplicationCacheNamespace **out);
|
2008-08-26 16:09:02 -07:00
|
|
|
nsresult GatherEntries(const nsCString &clientID,
|
|
|
|
PRUint32 typeBits,
|
|
|
|
PRUint32 *count,
|
|
|
|
char *** values);
|
2008-09-30 11:34:23 -07:00
|
|
|
nsresult AddNamespace(const nsCString &clientID,
|
|
|
|
nsIApplicationCacheNamespace *ns);
|
2008-08-26 16:09:02 -07:00
|
|
|
|
2009-02-22 11:09:10 -08:00
|
|
|
nsresult GetUsage(const nsACString &clientID,
|
|
|
|
PRUint32 *usage);
|
|
|
|
|
2007-07-24 22:35:39 -07:00
|
|
|
nsresult RunSimpleQuery(mozIStorageStatement *statment,
|
|
|
|
PRUint32 resultIndex,
|
|
|
|
PRUint32 * count,
|
|
|
|
char *** values);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2007-07-25 17:47:33 -07:00
|
|
|
nsCOMPtr<mozIStorageConnection> mDB;
|
|
|
|
nsRefPtr<nsOfflineCacheEvictionFunction> mEvictionFunction;
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_CacheSize;
|
2009-02-22 11:09:10 -08:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_ApplicationCacheSize;
|
2007-03-22 10:30:00 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_EntryCount;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_UpdateEntry;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_UpdateEntrySize;
|
2007-05-14 13:09:20 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_UpdateEntryFlags;
|
2007-03-22 10:30:00 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_DeleteEntry;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_FindEntry;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_BindEntry;
|
2007-05-14 13:09:20 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_ClearDomain;
|
2008-08-26 16:09:02 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_MarkEntry;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_UnmarkEntry;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_GetTypes;
|
2008-09-30 11:34:23 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_FindNamespaceEntry;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_InsertNamespaceEntry;
|
2008-08-26 16:09:02 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_CleanupUnmarked;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_GatherEntries;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_ActivateClient;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_DeactivateGroup;
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_FindClient;
|
2008-09-30 11:34:23 -07:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_FindClientByNamespace;
|
2009-02-22 11:09:10 -08:00
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement_EnumerateGroups;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
nsCOMPtr<nsILocalFile> mCacheDirectory;
|
2008-12-14 21:57:24 -08:00
|
|
|
PRUint32 mCacheCapacity; // in bytes
|
2007-03-22 10:30:00 -07:00
|
|
|
PRInt32 mDeltaCounter;
|
2008-08-26 16:09:02 -07:00
|
|
|
|
|
|
|
nsInterfaceHashtable<nsCStringHashKey, nsIWeakReference> mCaches;
|
|
|
|
nsClassHashtable<nsCStringHashKey, nsCString> mActiveCachesByGroup;
|
|
|
|
nsCStringHashSet mActiveCaches;
|
2010-08-23 18:06:23 -07:00
|
|
|
|
|
|
|
nsCOMPtr<nsIThread> mInitThread;
|
2007-03-22 10:30:00 -07:00
|
|
|
};
|
|
|
|
|
2007-05-14 13:09:20 -07:00
|
|
|
#endif // nsOfflineCacheDevice_h__
|