ladybird/Libraries/LibWeb/HTML/Storage.h
Shannon Booth 2066ed2318 LibWeb: Correctly initialize Storage objects on the Document
Instead of storing all storage objects in static memory, we now
follow the the spec by lazily creating a unique Storage object
on each document object.

Each Storage object now holds a 'proxy' to the underlying backing
storage. For now, this proxy is simply a reference to the backing
object. In the future, it will need to be some type of interface
object that stores on a SQLite database or similar.

Session storage is now correctly stored / tracked as part of the
TraversableNavigable object.

Local storage is still stored in a static map, but eventually this
should be factored into something that is stored at the user agent
level.
2025-01-02 11:31:15 +01:00

68 lines
2.3 KiB
C++

/*
* Copyright (c) 2022, Andreas Kling <andreas@ladybird.org>
* Copyright (c) 2023, Luke Wilde <lukew@serenityos.org>
* Copyright (c) 2024-2025, Shannon Booth <shannon@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/HashMap.h>
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/StorageAPI/StorageBottle.h>
#include <LibWeb/WebIDL/ExceptionOr.h>
namespace Web::HTML {
// https://html.spec.whatwg.org/multipage/webstorage.html#storage-2
class Storage : public Bindings::PlatformObject {
WEB_PLATFORM_OBJECT(Storage, Bindings::PlatformObject);
GC_DECLARE_ALLOCATOR(Storage);
public:
// https://html.spec.whatwg.org/multipage/webstorage.html#concept-storage-type
enum class Type {
Local,
Session,
};
[[nodiscard]] static GC::Ref<Storage> create(JS::Realm&, Type, NonnullRefPtr<StorageAPI::StorageBottle>);
~Storage();
size_t length() const;
Optional<String> key(size_t index);
Optional<String> get_item(StringView key) const;
WebIDL::ExceptionOr<void> set_item(String const& key, String const& value);
void remove_item(String const& key);
void clear();
auto const& map() const { return m_storage_bottle->map; }
auto& map() { return m_storage_bottle->map; }
Type type() const { return m_type; }
void dump() const;
private:
Storage(JS::Realm&, Type, NonnullRefPtr<StorageAPI::StorageBottle>);
virtual void initialize(JS::Realm&) override;
virtual void finalize() override;
// ^PlatformObject
virtual Optional<JS::Value> item_value(size_t index) const override;
virtual JS::Value named_item_value(FlyString const&) const override;
virtual WebIDL::ExceptionOr<DidDeletionFail> delete_value(String const&) override;
virtual Vector<FlyString> supported_property_names() const override;
virtual WebIDL::ExceptionOr<void> set_value_of_indexed_property(u32, JS::Value) override;
virtual WebIDL::ExceptionOr<void> set_value_of_named_property(String const& key, JS::Value value) override;
void reorder();
void broadcast(Optional<String> const& key, Optional<String> const& old_value, Optional<String> const& new_value);
Type m_type {};
NonnullRefPtr<StorageAPI::StorageBottle> m_storage_bottle;
u64 m_stored_bytes { 0 };
};
}