summaryrefslogtreecommitdiffstats
path: root/dom/cache/DBAction.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/cache/DBAction.h')
-rw-r--r--dom/cache/DBAction.h76
1 files changed, 76 insertions, 0 deletions
diff --git a/dom/cache/DBAction.h b/dom/cache/DBAction.h
new file mode 100644
index 0000000000..4bd0c86064
--- /dev/null
+++ b/dom/cache/DBAction.h
@@ -0,0 +1,76 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=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_cache_DBAction_h
+#define mozilla_dom_cache_DBAction_h
+
+#include "CacheCipherKeyManager.h"
+#include "mozilla/dom/cache/Action.h"
+#include "mozilla/RefPtr.h"
+#include "nsString.h"
+
+class mozIStorageConnection;
+class nsIFile;
+
+namespace mozilla::dom::cache {
+
+Result<nsCOMPtr<mozIStorageConnection>, nsresult> OpenDBConnection(
+ const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile& aDBFile,
+ const Maybe<CipherKey>& aMaybeCipherKey);
+
+class DBAction : public Action {
+ protected:
+ // The mode specifies whether the database should already exist or if its
+ // ok to create a new database.
+ enum Mode { Existing, Create };
+
+ explicit DBAction(Mode aMode);
+
+ // Action objects are deleted through their base pointer
+ virtual ~DBAction();
+
+ // Just as the resolver must be ref'd until resolve, you may also
+ // ref the DB connection. The connection can only be referenced from the
+ // target thread and must be released upon resolve.
+ virtual void RunWithDBOnTarget(
+ SafeRefPtr<Resolver> aResolver,
+ const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile* aDBDir,
+ mozIStorageConnection* aConn) = 0;
+
+ private:
+ void RunOnTarget(SafeRefPtr<Resolver> aResolver,
+ const Maybe<CacheDirectoryMetadata>& aDirectoryMetadata,
+ Data* aOptionalData,
+ const Maybe<CipherKey>& aMaybeCipherKey) override;
+
+ Result<nsCOMPtr<mozIStorageConnection>, nsresult> OpenConnection(
+ const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile& aDBDir,
+ const Maybe<CipherKey>& aMaybeCipherKey);
+
+ const Mode mMode;
+};
+
+class SyncDBAction : public DBAction {
+ protected:
+ explicit SyncDBAction(Mode aMode);
+
+ // Action objects are deleted through their base pointer
+ virtual ~SyncDBAction();
+
+ virtual nsresult RunSyncWithDBOnTarget(
+ const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile* aDBDir,
+ mozIStorageConnection* aConn) = 0;
+
+ private:
+ virtual void RunWithDBOnTarget(
+ SafeRefPtr<Resolver> aResolver,
+ const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile* aDBDir,
+ mozIStorageConnection* aConn) override;
+};
+
+} // namespace mozilla::dom::cache
+
+#endif // mozilla_dom_cache_DBAction_h