mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-07-06 00:51:51 +00:00
This change follows the pattern of our cookies persistence implementation: the "browser" process is responsible for interacting with the sqlite database, and WebContent communicates all storage operations via IPC. The new database table uses (storage_endpoint, storage_key, bottle_key) as the primary key. This design follows concepts from the https://storage.spec.whatwg.org/ and is intended to support reuse of the persistence layer for other APIs (e.g., CacheStorage, IndexedDB). For now, `storage_endpoint` is always "localStorage", `storage_key` is the website's origin, and `bottle_key` is the name of the localStorage key.
65 lines
2.2 KiB
C++
65 lines
2.2 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 <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, GC::Ref<StorageAPI::StorageBottle>);
|
|
|
|
~Storage();
|
|
|
|
size_t length() const;
|
|
Optional<String> key(size_t index);
|
|
Optional<String> get_item(String const& key) const;
|
|
WebIDL::ExceptionOr<void> set_item(String const& key, String const& value);
|
|
void remove_item(String const& key);
|
|
void clear();
|
|
Type type() const { return m_type; }
|
|
|
|
void dump() const;
|
|
|
|
private:
|
|
Storage(JS::Realm&, Type, GC::Ref<StorageAPI::StorageBottle>);
|
|
|
|
virtual void initialize(JS::Realm&) override;
|
|
virtual void finalize() override;
|
|
virtual void visit_edges(GC::Cell::Visitor&) 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 {};
|
|
GC::Ref<StorageAPI::StorageBottle> m_storage_bottle;
|
|
};
|
|
|
|
}
|