blob: 38f8579d0bb30e350cf35ea0e25153471a360a0f [file] [log] [blame]
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_DOM_STORAGE_SESSION_STORAGE_NAMESPACE_IMPL_MOJO_H_
#define CONTENT_BROWSER_DOM_STORAGE_SESSION_STORAGE_NAMESPACE_IMPL_MOJO_H_
#include <map>
#include <memory>
#include <vector>
#include "base/callback.h"
#include "base/containers/flat_set.h"
#include "base/gtest_prod_util.h"
#include "base/memory/ref_counted.h"
#include "content/browser/dom_storage/session_storage_area_impl.h"
#include "content/browser/dom_storage/session_storage_data_map.h"
#include "content/browser/dom_storage/session_storage_metadata.h"
#include "mojo/public/cpp/bindings/binding.h"
#include "mojo/public/cpp/bindings/binding_set.h"
#include "mojo/public/cpp/bindings/interface_ptr_set.h"
#include "third_party/blink/public/mojom/dom_storage/session_storage_namespace.mojom.h"
#include "url/origin.h"
namespace content {
// Implements the mojo interface SessionStorageNamespace. Stores data maps per
// origin, which are accessible using the StorageArea interface with the
// |OpenArea| call. Supports cloning (shallow cloning with copy-on-write
// behavior) from another SessionStorageNamespaceImplMojo.
//
// This class is populated & bound in the following patterns:
// 1. The namespace is new or being populated from data on disk, and
// |PopulateFromMetadata| is called. Afterwards |Bind| can be called.
// 2. The namespace is being created as a clone from a |Clone| call on another
// SessionStorageNamespaceImplMojo. PopulateFromMetadata is called with the
// data from the other namespace, and then |Bind| can be called afterwards.
// 3. The namespace is being created as a clone, but the |Clone| call from the
// source namespace hasn't been called yet. |SetWaitingForClonePopulation| is
// called first, after which |Bind| can be called. The actually binding
// doesn't happen until |PopulateAsClone| is finally called with the source
// namespace data.
// Note: The reason for cases 2 and 3 is because there are two ways the Session
// Storage system knows about clones. First, it gets the |Clone| call on the
// source namespace, coming from the renderer doing the navigation, and in the
// correct order with any session storage modifications from that source
// renderer. Second, the RenderViewHostImpl of the navigated-to-frame will
// create the cloned namespace and expect to manage it's lifetime that way, and
// this can happen before the first case, as they are on different task runners.
class CONTENT_EXPORT SessionStorageNamespaceImplMojo final
: public blink::mojom::SessionStorageNamespace {
public:
using OriginAreas =
std::map<url::Origin, std::unique_ptr<SessionStorageAreaImpl>>;
class Delegate {
public:
virtual ~Delegate() = default;
// This is called when the |Clone()| method is called by mojo.
virtual void RegisterShallowClonedNamespace(
SessionStorageMetadata::NamespaceEntry source_namespace,
const std::string& destination_namespace,
const OriginAreas& areas_to_clone) = 0;
// This is called when |OpenArea()| is called. The map could have been
// purged in a call to |PurgeUnboundAreas| but the map could still be alive
// as a clone, used by another namespace.
// Returns nullptr if a data map was not found.
virtual scoped_refptr<SessionStorageDataMap> MaybeGetExistingDataMapForId(
const std::vector<uint8_t>& map_number_as_bytes) = 0;
};
// Constructs a namespace with the given |namespace_id|, expecting to be
// populated and bound later (see class comment). The |database| and
// |data_map_listener| are given to any data maps constructed for this
// namespace. The |delegate| is called when the |Clone| method
// is called by mojo, as well as when the |OpenArea| method is called and the
// map id for that origin is found in our metadata. The
// |register_new_map_callback| is given to the the SessionStorageAreaImpl's,
// used per-origin, that are bound to in OpenArea.
SessionStorageNamespaceImplMojo(
std::string namespace_id,
SessionStorageDataMap::Listener* data_map_listener,
SessionStorageAreaImpl::RegisterNewAreaMap register_new_map_callback,
Delegate* delegate);
~SessionStorageNamespaceImplMojo() override;
// Returns if a storage area exists for the given origin in this map.
bool HasAreaForOrigin(const url::Origin& origin) const;
void SetWaitingForClonePopulation() { waiting_on_clone_population_ = true; }
bool waiting_on_clone_population() { return waiting_on_clone_population_; }
// Called when this is a new namespace, or when the namespace was loaded from
// disk. Should be called before |Bind|.
void PopulateFromMetadata(
leveldb::mojom::LevelDBDatabase* database,
SessionStorageMetadata::NamespaceEntry namespace_metadata);
// Can either be called before |Bind|, or if the source namespace isn't
// available yet, |SetWaitingForClonePopulation| can be called. Then |Bind|
// will work, and hold onto the request until after this method is called.
void PopulateAsClone(
leveldb::mojom::LevelDBDatabase* database,
SessionStorageMetadata::NamespaceEntry namespace_metadata,
const OriginAreas& areas_to_clone);
// Resets to a pre-populated and pre-bound state. Used when the owner needs to
// delete & recreate the database. This call should happen on every namespace
// at once, and the logic relies on that.
// TODO(dmurph): It's unclear if we need this or not - we might just want to
// destruct the object instead of having this method.
void Reset();
SessionStorageMetadata::NamespaceEntry namespace_entry() {
return namespace_entry_;
}
bool IsPopulated() const { return populated_; }
// Must be preceded by a call to |PopulateFromMetadata|, |PopulateAsClone|, or
// |SetWaitingForClonePopulation|. For the later case, |PopulateAsClone| must
// eventually be called before the SessionStorageNamespaceRequest can be
// bound.
void Bind(blink::mojom::SessionStorageNamespaceRequest request,
int process_id);
bool IsBound() const {
return !bindings_.empty() || bind_waiting_on_clone_population_;
}
// Removes any StorageAreas bound in |OpenArea| that are no longer bound.
void PurgeUnboundAreas();
// Removes data for the given origin from this namespace. If there is no data
// map for that given origin, this does nothing. Expects that this namespace
// is either populated or waiting for clone population.
void RemoveOriginData(const url::Origin& origin, base::OnceClosure callback);
// SessionStorageNamespace:
// Connects the given database mojo request to the data map for the given
// origin. Before connection, it checks to make sure the |process_id| given to
// the |Bind| method can access the given origin.
void OpenArea(const url::Origin& origin,
blink::mojom::StorageAreaAssociatedRequest database) override;
// Simply calls the |add_namespace_callback_| callback with this namespace's
// data.
void Clone(const std::string& clone_to_namespace) override;
void FlushOriginForTesting(const url::Origin& origin);
void AddNamespacesWaitingForClone(const std::string& namespace_id) {
namespaces_waiting_for_clone_call_.insert(namespace_id);
}
bool HasNamespacesWaitingForClone() const {
return !namespaces_waiting_for_clone_call_.empty();
}
void CloneAllNamespacesWaitingForClone();
// This is only used on shutdown to avoid the DCHECK in the destructor.
// We are fine to drop clone calls during shutdown, even if this loses some
// data.
void ClearNamespacesWaitingForClone() {
namespaces_waiting_for_clone_call_.clear();
}
private:
FRIEND_TEST_ALL_PREFIXES(SessionStorageContextMojoTest,
PurgeMemoryDoesNotCrashOrHang);
FRIEND_TEST_ALL_PREFIXES(SessionStorageNamespaceImplMojoTest,
ReopenClonedAreaAfterPurge);
const std::string namespace_id_;
SessionStorageMetadata::NamespaceEntry namespace_entry_;
leveldb::mojom::LevelDBDatabase* database_ = nullptr;
SessionStorageDataMap::Listener* data_map_listener_;
SessionStorageAreaImpl::RegisterNewAreaMap register_new_map_callback_;
Delegate* delegate_;
bool waiting_on_clone_population_ = false;
bool bind_waiting_on_clone_population_ = false;
std::vector<base::OnceClosure> run_after_clone_population_;
// Namespaces that are waiting for the |Clone| call to be called on this
// namespace. If this namespace is destructed, then these namespaces are still
// waiting and should be unblocked.
base::flat_set<std::string> namespaces_waiting_for_clone_call_;
bool populated_ = false;
OriginAreas origin_areas_;
// The context is the process id.
mojo::BindingSet<blink::mojom::SessionStorageNamespace, int> bindings_;
};
} // namespace content
#endif // CONTENT_BROWSER_DOM_STORAGE_SESSION_STORAGE_NAMESPACE_IMPL_MOJO_H_