gecko/dom/quota/QuotaManager.h

362 lines
9.8 KiB
C
Raw Normal View History

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_quota_quotamanager_h__
#define mozilla_dom_quota_quotamanager_h__
#include "QuotaCommon.h"
#include "nsIObserver.h"
#include "nsIQuotaManager.h"
#include "mozilla/Mutex.h"
#include "nsClassHashtable.h"
#include "nsRefPtrHashtable.h"
#include "nsThreadUtils.h"
#include "ArrayCluster.h"
#include "Client.h"
#include "StoragePrivilege.h"
#define QUOTA_MANAGER_CONTRACTID "@mozilla.org/dom/quota/manager;1"
class nsIAtom;
class nsIOfflineStorage;
class nsIPrincipal;
class nsIThread;
class nsITimer;
class nsIURI;
class nsPIDOMWindow;
BEGIN_QUOTA_NAMESPACE
class AcquireListener;
class AsyncUsageRunnable;
class CheckQuotaHelper;
class OriginClearRunnable;
class OriginInfo;
class OriginOrPatternString;
class QuotaObject;
struct SynchronizedOp;
class QuotaManager MOZ_FINAL : public nsIQuotaManager,
public nsIObserver
{
friend class AsyncUsageRunnable;
friend class OriginClearRunnable;
friend class OriginInfo;
friend class QuotaObject;
enum MozBrowserPatternFlag
{
MozBrowser = 0,
NotMozBrowser,
IgnoreMozBrowser
};
typedef void
(*WaitingOnStoragesCallback)(nsTArray<nsCOMPtr<nsIOfflineStorage> >&, void*);
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIQUOTAMANAGER
NS_DECL_NSIOBSERVER
// Returns a non-owning reference.
static QuotaManager*
GetOrCreate();
// Returns a non-owning reference.
static QuotaManager*
Get();
// Returns an owning reference! No one should call this but the factory.
static QuotaManager*
FactoryCreate();
// Returns true if we've begun the shutdown process.
static bool IsShuttingDown();
void
InitQuotaForOrigin(const nsACString& aOrigin,
int64_t aLimitBytes,
int64_t aUsageBytes);
void
DecreaseUsageForOrigin(const nsACString& aOrigin,
int64_t aSize);
void
RemoveQuotaForPattern(const nsACString& aPattern);
already_AddRefed<QuotaObject>
GetQuotaObject(const nsACString& aOrigin,
nsIFile* aFile);
already_AddRefed<QuotaObject>
GetQuotaObject(const nsACString& aOrigin,
const nsAString& aPath);
// Set the Window that the current thread is doing operations for.
// The caller is responsible for ensuring that aWindow is held alive.
static void
SetCurrentWindow(nsPIDOMWindow* aWindow)
{
QuotaManager* quotaManager = Get();
NS_ASSERTION(quotaManager, "Must have a manager here!");
quotaManager->SetCurrentWindowInternal(aWindow);
}
static void
CancelPromptsForWindow(nsPIDOMWindow* aWindow)
{
NS_ASSERTION(aWindow, "Passed null window!");
QuotaManager* quotaManager = Get();
NS_ASSERTION(quotaManager, "Must have a manager here!");
quotaManager->CancelPromptsForWindowInternal(aWindow);
}
// Called when a storage is created.
bool
RegisterStorage(nsIOfflineStorage* aStorage);
// Called when a storage is being unlinked or destroyed.
void
UnregisterStorage(nsIOfflineStorage* aStorage);
// Called when a storage has been closed.
void
OnStorageClosed(nsIOfflineStorage* aStorage);
// Called when a window is being purged from the bfcache or the user leaves
// a page which isn't going into the bfcache. Forces any live storage
// objects to close themselves and aborts any running transactions.
void
AbortCloseStoragesForWindow(nsPIDOMWindow* aWindow);
// Used to check if there are running transactions in a given window.
bool
HasOpenTransactions(nsPIDOMWindow* aWindow);
// Waits for storages to be cleared and for version change transactions to
// complete before dispatching the given runnable.
nsresult
WaitForOpenAllowed(const OriginOrPatternString& aOriginOrPattern,
nsIAtom* aId,
nsIRunnable* aRunnable);
// Acquire exclusive access to the storage given (waits for all others to
// close). If storages need to close first, the callback will be invoked
// with an array of said storages.
nsresult
AcquireExclusiveAccess(nsIOfflineStorage* aStorage,
const nsACString& aOrigin,
AcquireListener* aListener,
WaitingOnStoragesCallback aCallback,
void* aClosure)
{
NS_ASSERTION(aStorage, "Need a storage here!");
return AcquireExclusiveAccess(aOrigin, aStorage, aListener, aCallback,
aClosure);
}
nsresult
AcquireExclusiveAccess(const nsACString& aOrigin,
AcquireListener* aListener,
WaitingOnStoragesCallback aCallback,
void* aClosure)
{
return AcquireExclusiveAccess(aOrigin, nullptr, aListener, aCallback,
aClosure);
}
void
AllowNextSynchronizedOp(const OriginOrPatternString& aOriginOrPattern,
nsIAtom* aId);
bool
IsClearOriginPending(const nsACString& aPattern)
{
return !!FindSynchronizedOp(aPattern, nullptr);
}
nsresult
GetDirectoryForOrigin(const nsACString& aASCIIOrigin,
nsIFile** aDirectory) const;
nsresult
EnsureOriginIsInitialized(const nsACString& aOrigin,
bool aTrackQuota,
nsIFile** aDirectory);
void
OriginClearCompleted(const nsACString& aPattern);
nsIThread*
IOThread()
{
NS_ASSERTION(mIOThread, "This should never be null!");
return mIOThread;
}
already_AddRefed<Client>
GetClient(Client::Type aClientType);
const nsString&
GetBaseDirectory() const
{
return mStorageBasePath;
}
static uint32_t
GetStorageQuotaMB();
static already_AddRefed<nsIAtom>
GetStorageId(const nsACString& aOrigin,
const nsAString& aName);
static nsresult
GetASCIIOriginFromURI(nsIURI* aURI,
uint32_t aAppId,
bool aInMozBrowser,
nsACString& aASCIIOrigin);
static nsresult
GetASCIIOriginFromPrincipal(nsIPrincipal* aPrincipal,
nsACString& aASCIIOrigin);
static nsresult
GetASCIIOriginFromWindow(nsPIDOMWindow* aWindow,
nsACString& aASCIIOrigin);
static void
GetOriginPatternString(uint32_t aAppId, bool aBrowserOnly,
const nsACString& aOrigin, nsAutoCString& _retval)
{
return GetOriginPatternString(aAppId,
aBrowserOnly ? MozBrowser : NotMozBrowser,
aOrigin, _retval);
}
static void
GetOriginPatternStringMaybeIgnoreBrowser(uint32_t aAppId, bool aBrowserOnly,
nsAutoCString& _retval)
{
return GetOriginPatternString(aAppId,
aBrowserOnly ? MozBrowser : IgnoreMozBrowser,
EmptyCString(), _retval);
}
private:
QuotaManager();
virtual ~QuotaManager();
nsresult
Init();
void
SetCurrentWindowInternal(nsPIDOMWindow* aWindow);
void
CancelPromptsForWindowInternal(nsPIDOMWindow* aWindow);
// Determine if the quota is lifted for the Window the current thread is
// using.
bool
LockedQuotaIsLifted();
nsresult
AcquireExclusiveAccess(const nsACString& aOrigin,
nsIOfflineStorage* aStorage,
AcquireListener* aListener,
WaitingOnStoragesCallback aCallback,
void* aClosure);
nsresult
RunSynchronizedOp(nsIOfflineStorage* aStorage,
SynchronizedOp* aOp);
SynchronizedOp*
FindSynchronizedOp(const nsACString& aPattern,
nsISupports* aId);
nsresult
ClearStoragesForApp(uint32_t aAppId, bool aBrowserOnly);
nsresult
MaybeUpgradeOriginDirectory(nsIFile* aDirectory);
void
ReleaseIOThreadObjects()
{
AssertIsOnIOThread();
for (uint32_t index = 0; index < Client::TYPE_MAX; index++) {
mClients[index]->ReleaseIOThreadObjects();
}
}
static void
GetOriginPatternString(uint32_t aAppId,
MozBrowserPatternFlag aBrowserFlag,
const nsACString& aOrigin,
nsAutoCString& _retval);
// TLS storage index for the current thread's window.
unsigned int mCurrentWindowIndex;
mozilla::Mutex mQuotaMutex;
nsRefPtrHashtable<nsCStringHashKey, OriginInfo> mOriginInfos;
// A map of Windows to the corresponding quota helper.
nsRefPtrHashtable<nsPtrHashKey<nsPIDOMWindow>,
CheckQuotaHelper> mCheckQuotaHelpers;
// Maintains a list of live storages per origin.
nsClassHashtable<nsCStringHashKey,
ArrayCluster<nsIOfflineStorage*> > mLiveStorages;
// Maintains a list of synchronized operatons that are in progress or queued.
nsAutoTArray<nsAutoPtr<SynchronizedOp>, 5> mSynchronizedOps;
// Thread on which IO is performed.
nsCOMPtr<nsIThread> mIOThread;
// A timer that gets activated at shutdown to ensure we close all storages.
nsCOMPtr<nsITimer> mShutdownTimer;
// A list of all successfully initialized origins. This list isn't protected
// by any mutex but it is only ever touched on the IO thread.
nsTArray<nsCString> mInitializedOrigins;
nsAutoTArray<nsRefPtr<Client>, Client::TYPE_MAX> mClients;
nsString mStorageBasePath;
};
class AutoEnterWindow
{
public:
AutoEnterWindow(nsPIDOMWindow* aWindow)
{
QuotaManager::SetCurrentWindow(aWindow);
}
~AutoEnterWindow()
{
QuotaManager::SetCurrentWindow(nullptr);
}
};
END_QUOTA_NAMESPACE
#endif /* mozilla_dom_quota_quotamanager_h__ */