/* * Copyright (c) 2020, Andreas Kling * Copyright (c) 2022, Linus Groh * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::Bindings { // https://html.spec.whatwg.org/multipage/history.html#the-location-interface LocationObject::LocationObject(JS::Realm& realm) : PlatformObject(realm) { set_prototype(&cached_web_prototype(realm, "Location")); } LocationObject::~LocationObject() = default; void LocationObject::visit_edges(Cell::Visitor& visitor) { Base::visit_edges(visitor); for (auto& property : m_default_properties) visitor.visit(property); } void LocationObject::initialize(JS::Realm& realm) { auto& vm = this->vm(); Object::initialize(realm); u8 attr = JS::Attribute::Writable | JS::Attribute::Enumerable; define_native_accessor(realm, "href", href_getter, href_setter, attr); define_native_accessor(realm, "host", host_getter, {}, attr); define_native_accessor(realm, "hostname", hostname_getter, {}, attr); define_native_accessor(realm, "pathname", pathname_getter, {}, attr); define_native_accessor(realm, "hash", hash_getter, {}, attr); define_native_accessor(realm, "search", search_getter, {}, attr); define_native_accessor(realm, "protocol", protocol_getter, {}, attr); define_native_accessor(realm, "port", port_getter, {}, attr); define_native_accessor(realm, "origin", origin_getter, {}, attr); define_native_function(realm, "reload", reload, 0, JS::Attribute::Enumerable); define_native_function(realm, "replace", replace, 1, JS::Attribute::Enumerable); define_native_function(realm, vm.names.toString, href_getter, 0, JS::Attribute::Enumerable); // 5. Set the value of the [[DefaultProperties]] internal slot of location to location.[[OwnPropertyKeys]](). // NOTE: In LibWeb this happens before the ESO is set up, so we must avoid location's custom [[OwnPropertyKeys]]. m_default_properties.extend(MUST(Object::internal_own_property_keys())); } // https://html.spec.whatwg.org/multipage/history.html#relevant-document DOM::Document const* LocationObject::relevant_document() const { // A Location object has an associated relevant Document, which is this Location object's // relevant global object's browsing context's active document, if this Location object's // relevant global object's browsing context is non-null, and null otherwise. auto* browsing_context = verify_cast(HTML::relevant_global_object(*this)).browsing_context(); return browsing_context ? browsing_context->active_document() : nullptr; } // https://html.spec.whatwg.org/multipage/history.html#concept-location-url AK::URL LocationObject::url() const { // A Location object has an associated url, which is this Location object's relevant Document's URL, // if this Location object's relevant Document is non-null, and about:blank otherwise. auto const* relevant_document = this->relevant_document(); return relevant_document ? relevant_document->url() : "about:blank"sv; } static JS::ThrowCompletionOr typed_this_value(JS::VM& vm) { auto this_value = vm.this_value(); if (!this_value.is_object() || !is(this_value.as_object())) return vm.throw_completion(JS::ErrorType::NotAnObjectOfType, "Location"); return static_cast(&this_value.as_object()); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-href JS_DEFINE_NATIVE_FUNCTION(LocationObject::href_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. Return this's url, serialized. return JS::js_string(vm, location_object->url().to_string()); } // https://html.spec.whatwg.org/multipage/history.html#the-location-interface:dom-location-href-2 JS_DEFINE_NATIVE_FUNCTION(LocationObject::href_setter) { auto& window = verify_cast(HTML::current_global_object()); // FIXME: 1. If this's relevant Document is null, then return. // 2. Parse the given value relative to the entry settings object. If that failed, throw a TypeError exception. auto new_href = TRY(vm.argument(0).to_string(vm)); auto href_url = window.associated_document().parse_url(new_href); if (!href_url.is_valid()) return vm.throw_completion(String::formatted("Invalid URL '{}'", new_href)); // 3. Location-object navigate given the resulting URL record. window.did_set_location_href({}, href_url); return JS::js_undefined(); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-pathname JS_DEFINE_NATIVE_FUNCTION(LocationObject::pathname_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. Return the result of URL path serializing this Location object's url. return JS::js_string(vm, location_object->url().path()); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-hostname JS_DEFINE_NATIVE_FUNCTION(LocationObject::hostname_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. If this's url's host is null, return the empty string. if (location_object->url().host().is_null()) return JS::js_string(vm, String::empty()); // 3. Return this's url's host, serialized. return JS::js_string(vm, location_object->url().host()); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-host JS_DEFINE_NATIVE_FUNCTION(LocationObject::host_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. Let url be this's url. auto url = location_object->url(); // 3. If url's host is null, return the empty string. if (url.host().is_null()) return JS::js_string(vm, String::empty()); // 4. If url's port is null, return url's host, serialized. if (!url.port().has_value()) return JS::js_string(vm, url.host()); // 5. Return url's host, serialized, followed by ":" and url's port, serialized. return JS::js_string(vm, String::formatted("{}:{}", url.host(), *url.port())); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-hash JS_DEFINE_NATIVE_FUNCTION(LocationObject::hash_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. If this's url's fragment is either null or the empty string, return the empty string. if (location_object->url().fragment().is_empty()) return JS::js_string(vm, String::empty()); // 3. Return "#", followed by this's url's fragment. return JS::js_string(vm, String::formatted("#{}", location_object->url().fragment())); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-search JS_DEFINE_NATIVE_FUNCTION(LocationObject::search_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. If this's url's query is either null or the empty string, return the empty string. if (location_object->url().query().is_empty()) return JS::js_string(vm, String::empty()); // 3. Return "?", followed by this's url's query. return JS::js_string(vm, String::formatted("?{}", location_object->url().query())); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-protocol JS_DEFINE_NATIVE_FUNCTION(LocationObject::protocol_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. Return this's url's scheme, followed by ":". return JS::js_string(vm, String::formatted("{}:", location_object->url().scheme())); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-port JS_DEFINE_NATIVE_FUNCTION(LocationObject::port_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. If this's url's port is null, return the empty string. if (!location_object->url().port().has_value()) return JS::js_string(vm, String::empty()); // 3. Return this's url's port, serialized. return JS::js_string(vm, String::number(*location_object->url().port())); } // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-location-origin JS_DEFINE_NATIVE_FUNCTION(LocationObject::origin_getter) { auto* location_object = TRY(typed_this_value(vm)); // FIXME: 1. If this's relevant Document is non-null and its origin is not same origin-domain with the entry settings object's origin, then throw a "SecurityError" DOMException. // 2. Return the serialization of this's url's origin. return JS::js_string(vm, location_object->url().serialize_origin()); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-reload JS_DEFINE_NATIVE_FUNCTION(LocationObject::reload) { auto& window = verify_cast(HTML::current_global_object()); window.did_call_location_reload({}); return JS::js_undefined(); } // https://html.spec.whatwg.org/multipage/history.html#dom-location-replace JS_DEFINE_NATIVE_FUNCTION(LocationObject::replace) { auto& window = verify_cast(HTML::current_global_object()); auto url = TRY(vm.argument(0).to_string(vm)); // FIXME: This needs spec compliance work. window.did_call_location_replace({}, move(url)); return JS::js_undefined(); } // 7.10.5.1 [[GetPrototypeOf]] ( ), https://html.spec.whatwg.org/multipage/history.html#location-getprototypeof JS::ThrowCompletionOr LocationObject::internal_get_prototype_of() const { // 1. If IsPlatformObjectSameOrigin(this) is true, then return ! OrdinaryGetPrototypeOf(this). if (HTML::is_platform_object_same_origin(*this)) return MUST(JS::Object::internal_get_prototype_of()); // 2. Return null. return nullptr; } // 7.10.5.2 [[SetPrototypeOf]] ( V ), https://html.spec.whatwg.org/multipage/history.html#location-setprototypeof JS::ThrowCompletionOr LocationObject::internal_set_prototype_of(Object* prototype) { // 1. Return ! SetImmutablePrototype(this, V). return MUST(set_immutable_prototype(prototype)); } // 7.10.5.3 [[IsExtensible]] ( ), https://html.spec.whatwg.org/multipage/history.html#location-isextensible JS::ThrowCompletionOr LocationObject::internal_is_extensible() const { // 1. Return true. return true; } // 7.10.5.4 [[PreventExtensions]] ( ), https://html.spec.whatwg.org/multipage/history.html#location-preventextensions JS::ThrowCompletionOr LocationObject::internal_prevent_extensions() { // 1. Return false. return false; } // 7.10.5.5 [[GetOwnProperty]] ( P ), https://html.spec.whatwg.org/multipage/history.html#location-getownproperty JS::ThrowCompletionOr> LocationObject::internal_get_own_property(JS::PropertyKey const& property_key) const { auto& vm = this->vm(); // 1. If IsPlatformObjectSameOrigin(this) is true, then: if (HTML::is_platform_object_same_origin(*this)) { // 1. Let desc be OrdinaryGetOwnProperty(this, P). auto descriptor = MUST(Object::internal_get_own_property(property_key)); // 2. If the value of the [[DefaultProperties]] internal slot of this contains P, then set desc.[[Configurable]] to true. auto property_key_value = property_key.is_symbol() ? JS::Value { property_key.as_symbol() } : JS::js_string(vm, property_key.to_string()); if (m_default_properties.contains_slow(property_key_value)) descriptor->configurable = true; // 3. Return desc. return descriptor; } // 2. Let property be CrossOriginGetOwnPropertyHelper(this, P). auto property = HTML::cross_origin_get_own_property_helper(const_cast(this), property_key); // 3. If property is not undefined, then return property. if (property.has_value()) return property; // 4. Return ? CrossOriginPropertyFallback(P). return TRY(HTML::cross_origin_property_fallback(vm, property_key)); } // 7.10.5.6 [[DefineOwnProperty]] ( P, Desc ), https://html.spec.whatwg.org/multipage/history.html#location-defineownproperty JS::ThrowCompletionOr LocationObject::internal_define_own_property(JS::PropertyKey const& property_key, JS::PropertyDescriptor const& descriptor) { // 1. If IsPlatformObjectSameOrigin(this) is true, then: if (HTML::is_platform_object_same_origin(*this)) { // 1. If the value of the [[DefaultProperties]] internal slot of this contains P, then return false. // 2. Return ? OrdinaryDefineOwnProperty(this, P, Desc). return JS::Object::internal_define_own_property(property_key, descriptor); } // 2. Throw a "SecurityError" DOMException. return throw_completion(WebIDL::SecurityError::create(realm(), String::formatted("Can't define property '{}' on cross-origin object", property_key))); } // 7.10.5.7 [[Get]] ( P, Receiver ), https://html.spec.whatwg.org/multipage/history.html#location-get JS::ThrowCompletionOr LocationObject::internal_get(JS::PropertyKey const& property_key, JS::Value receiver) const { auto& vm = this->vm(); // 1. If IsPlatformObjectSameOrigin(this) is true, then return ? OrdinaryGet(this, P, Receiver). if (HTML::is_platform_object_same_origin(*this)) return JS::Object::internal_get(property_key, receiver); // 2. Return ? CrossOriginGet(this, P, Receiver). return HTML::cross_origin_get(vm, static_cast(*this), property_key, receiver); } // 7.10.5.8 [[Set]] ( P, V, Receiver ), https://html.spec.whatwg.org/multipage/history.html#location-set JS::ThrowCompletionOr LocationObject::internal_set(JS::PropertyKey const& property_key, JS::Value value, JS::Value receiver) { auto& vm = this->vm(); // 1. If IsPlatformObjectSameOrigin(this) is true, then return ? OrdinarySet(this, P, V, Receiver). if (HTML::is_platform_object_same_origin(*this)) return JS::Object::internal_set(property_key, value, receiver); // 2. Return ? CrossOriginSet(this, P, V, Receiver). return HTML::cross_origin_set(vm, static_cast(*this), property_key, value, receiver); } // 7.10.5.9 [[Delete]] ( P ), https://html.spec.whatwg.org/multipage/history.html#location-delete JS::ThrowCompletionOr LocationObject::internal_delete(JS::PropertyKey const& property_key) { // 1. If IsPlatformObjectSameOrigin(this) is true, then return ? OrdinaryDelete(this, P). if (HTML::is_platform_object_same_origin(*this)) return JS::Object::internal_delete(property_key); // 2. Throw a "SecurityError" DOMException. return throw_completion(WebIDL::SecurityError::create(realm(), String::formatted("Can't delete property '{}' on cross-origin object", property_key))); } // 7.10.5.10 [[OwnPropertyKeys]] ( ), https://html.spec.whatwg.org/multipage/history.html#location-ownpropertykeys JS::ThrowCompletionOr> LocationObject::internal_own_property_keys() const { // 1. If IsPlatformObjectSameOrigin(this) is true, then return OrdinaryOwnPropertyKeys(this). if (HTML::is_platform_object_same_origin(*this)) return JS::Object::internal_own_property_keys(); // 2. Return CrossOriginOwnPropertyKeys(this). return HTML::cross_origin_own_property_keys(this); } }