/* * Copyright (c) 2022, Andreas Kling * Copyright (c) 2023, Luke Wilde * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include namespace Web::HTML { WebIDL::ExceptionOr> Storage::create(JS::Realm& realm) { return MUST_OR_THROW_OOM(realm.heap().allocate(realm, realm)); } Storage::Storage(JS::Realm& realm) : Bindings::LegacyPlatformObject(realm) { } Storage::~Storage() = default; JS::ThrowCompletionOr Storage::initialize(JS::Realm& realm) { MUST_OR_THROW_OOM(Base::initialize(realm)); set_prototype(&Bindings::ensure_web_prototype(realm, "Storage")); return {}; } // https://html.spec.whatwg.org/multipage/webstorage.html#dom-storage-length size_t Storage::length() const { // The length getter steps are to return this's map's size. return m_map.size(); } // https://html.spec.whatwg.org/multipage/webstorage.html#dom-storage-key DeprecatedString Storage::key(size_t index) { // 1. If index is greater than or equal to this's map's size, then return null. if (index >= m_map.size()) return {}; // 2. Let keys be the result of running get the keys on this's map. auto keys = m_map.keys(); // 3. Return keys[index]. return keys[index]; } // https://html.spec.whatwg.org/multipage/webstorage.html#dom-storage-getitem DeprecatedString Storage::get_item(DeprecatedString const& key) const { // 1. If this's map[key] does not exist, then return null. auto it = m_map.find(key); if (it == m_map.end()) return {}; // 2. Return this's map[key]. return it->value; } // https://html.spec.whatwg.org/multipage/webstorage.html#dom-storage-setitem WebIDL::ExceptionOr Storage::set_item(DeprecatedString const& key, DeprecatedString const& value) { // 1. Let oldValue be null. DeprecatedString old_value; // 2. Let reorder be true. bool reorder = true; // 3. If this's map[key] exists: if (auto it = m_map.find(key); it != m_map.end()) { // 1. Set oldValue to this's map[key]. old_value = it->value; // 2. If oldValue is value, then return. if (old_value == value) return {}; // 3. Set reorder to false. reorder = false; } // FIXME: 4. If value cannot be stored, then throw a "QuotaExceededError" DOMException exception. // 5. Set this's map[key] to value. m_map.set(key, value); // 6. If reorder is true, then reorder this. if (reorder) this->reorder(); // 7. Broadcast this with key, oldValue, and value. broadcast(key, old_value, value); return {}; } // https://html.spec.whatwg.org/multipage/webstorage.html#dom-storage-removeitem void Storage::remove_item(DeprecatedString const& key) { // 1. If this's map[key] does not exist, then return null. // FIXME: Return null? auto it = m_map.find(key); if (it == m_map.end()) return; // 2. Set oldValue to this's map[key]. auto old_value = it->value; // 3. Remove this's map[key]. m_map.remove(it); // 4. Reorder this. reorder(); // 5. Broadcast this with key, oldValue, and null. broadcast(key, old_value, {}); } // https://html.spec.whatwg.org/multipage/webstorage.html#dom-storage-clear void Storage::clear() { // 1. Clear this's map. m_map.clear(); // 2. Broadcast this with null, null, and null. broadcast({}, {}, {}); } // https://html.spec.whatwg.org/multipage/webstorage.html#concept-storage-reorder void Storage::reorder() { // To reorder a Storage object storage, reorder storage's map's entries in an implementation-defined manner. // NOTE: This basically means that we're not required to maintain any particular iteration order. } // https://html.spec.whatwg.org/multipage/webstorage.html#concept-storage-broadcast void Storage::broadcast(DeprecatedString const& key, DeprecatedString const& old_value, DeprecatedString const& new_value) { (void)key; (void)old_value; (void)new_value; // FIXME: Implement. } Vector Storage::supported_property_names() const { // The supported property names on a Storage object storage are the result of running get the keys on storage's map. return m_map.keys(); } WebIDL::ExceptionOr Storage::named_item_value(DeprecatedFlyString const& name) const { auto value = get_item(name); if (value.is_null()) return JS::js_null(); return JS::PrimitiveString::create(vm(), value); } WebIDL::ExceptionOr Storage::delete_value(DeprecatedString const& name) { remove_item(name); return DidDeletionFail::NotRelevant; } WebIDL::ExceptionOr Storage::set_value_of_named_property(DeprecatedString const& key, JS::Value unconverted_value) { // NOTE: Since LegacyPlatformObject does not know the type of value, we must convert it ourselves. // The type of `value` is `DOMString`. auto value = TRY(unconverted_value.to_deprecated_string(vm())); return set_item(key, value); } void Storage::dump() const { dbgln("Storage ({} key(s))", m_map.size()); size_t i = 0; for (auto const& it : m_map) { dbgln("[{}] \"{}\": \"{}\"", i, it.key, it.value); ++i; } } }