/* * Copyright (c) 2020-2021, Andreas Kling * Copyright (c) 2021, Sam Atkins * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::Bindings { WindowObject::WindowObject(DOM::Window& impl) : m_impl(impl) { impl.set_wrapper({}, *this); } void WindowObject::initialize_global_object() { Base::initialize_global_object(); Object::set_prototype(&ensure_web_prototype("EventTarget")); // FIXME: These should be native accessors, not properties define_direct_property("window", this, JS::Attribute::Enumerable); define_direct_property("frames", this, JS::Attribute::Enumerable); define_direct_property("self", this, JS::Attribute::Enumerable); define_native_accessor("top", top_getter, nullptr, JS::Attribute::Enumerable); define_native_accessor("parent", parent_getter, {}, JS::Attribute::Enumerable); define_native_accessor("document", document_getter, {}, JS::Attribute::Enumerable); define_native_accessor("history", history_getter, {}, JS::Attribute::Enumerable); define_native_accessor("performance", performance_getter, {}, JS::Attribute::Enumerable); define_native_accessor("crypto", crypto_getter, {}, JS::Attribute::Enumerable); define_native_accessor("screen", screen_getter, {}, JS::Attribute::Enumerable); define_native_accessor("innerWidth", inner_width_getter, {}, JS::Attribute::Enumerable); define_native_accessor("innerHeight", inner_height_getter, {}, JS::Attribute::Enumerable); define_native_accessor("devicePixelRatio", device_pixel_ratio_getter, {}, JS::Attribute::Enumerable | JS::Attribute::Configurable); u8 attr = JS::Attribute::Writable | JS::Attribute::Enumerable | JS::Attribute::Configurable; define_native_function("alert", alert, 0, attr); define_native_function("confirm", confirm, 0, attr); define_native_function("prompt", prompt, 0, attr); define_native_function("setInterval", set_interval, 1, attr); define_native_function("setTimeout", set_timeout, 1, attr); define_native_function("clearInterval", clear_interval, 1, attr); define_native_function("clearTimeout", clear_timeout, 1, attr); define_native_function("requestAnimationFrame", request_animation_frame, 1, attr); define_native_function("cancelAnimationFrame", cancel_animation_frame, 1, attr); define_native_function("atob", atob, 1, attr); define_native_function("btoa", btoa, 1, attr); define_native_function("queueMicrotask", queue_microtask, 1, attr); define_native_function("getComputedStyle", get_computed_style, 1, attr); define_native_function("matchMedia", match_media, 1, attr); define_native_function("getSelection", get_selection, 0, attr); // FIXME: These properties should be [Replaceable] according to the spec, but [Writable+Configurable] is the closest we have. define_native_accessor("scrollX", scroll_x_getter, {}, attr); define_native_accessor("pageXOffset", scroll_x_getter, {}, attr); define_native_accessor("scrollY", scroll_y_getter, {}, attr); define_native_accessor("pageYOffset", scroll_y_getter, {}, attr); define_native_function("scroll", scroll, 2, attr); define_native_function("scrollTo", scroll, 2, attr); define_native_function("scrollBy", scroll_by, 2, attr); define_native_accessor("screenX", screen_x_getter, {}, attr); define_native_accessor("screenY", screen_y_getter, {}, attr); define_native_accessor("screenLeft", screen_left_getter, {}, attr); define_native_accessor("screenTop", screen_top_getter, {}, attr); define_direct_property("CSS", heap().allocate(*this, *this), 0); // Legacy define_native_accessor("event", event_getter, event_setter, JS::Attribute::Enumerable); m_location_object = heap().allocate(*this, *this); define_direct_property("navigator", heap().allocate(*this, *this), JS::Attribute::Enumerable | JS::Attribute::Configurable); // NOTE: location is marked as [LegacyUnforgeable], meaning it isn't configurable. define_direct_property("location", m_location_object, JS::Attribute::Enumerable); // WebAssembly "namespace" define_direct_property("WebAssembly", heap().allocate(*this, *this), JS::Attribute::Enumerable | JS::Attribute::Configurable); // HTML::GlobalEventHandlers #define __ENUMERATE(attribute, event_name) \ define_native_accessor(#attribute, attribute##_getter, attribute##_setter, attr); ENUMERATE_GLOBAL_EVENT_HANDLERS(__ENUMERATE); #undef __ENUMERATE ADD_WINDOW_OBJECT_INTERFACES; } WindowObject::~WindowObject() { } void WindowObject::visit_edges(Visitor& visitor) { GlobalObject::visit_edges(visitor); visitor.visit(m_location_object); for (auto& it : m_prototypes) visitor.visit(it.value); for (auto& it : m_constructors) visitor.visit(it.value); } Origin WindowObject::origin() const { return impl().associated_document().origin(); } // https://webidl.spec.whatwg.org/#platform-object-setprototypeof JS::ThrowCompletionOr WindowObject::internal_set_prototype_of(JS::Object* prototype) { // 1. Return ? SetImmutablePrototype(O, V). return set_immutable_prototype(prototype); } static JS::ThrowCompletionOr impl_from(JS::VM& vm, JS::GlobalObject& global_object) { // Since this is a non built-in function we must treat it as non-strict mode // this means that a nullish this_value should be converted to the // global_object. Generally this does not matter as we try to convert the // this_value to a specific object type in the bindings. But since window is // the global object we make an exception here. // This allows calls like `setTimeout(f, 10)` to work. auto this_value = vm.this_value(global_object); if (this_value.is_nullish()) { this_value = global_object.value_of(); } auto* this_object = MUST(this_value.to_object(global_object)); if (StringView("WindowObject") != this_object->class_name()) return vm.throw_completion(global_object, JS::ErrorType::NotAnObjectOfType, "WindowObject"); return &static_cast(this_object)->impl(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::alert) { // https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#simple-dialogs // Note: This method is defined using two overloads, instead of using an optional argument, // for historical reasons. The practical impact of this is that alert(undefined) is // treated as alert("undefined"), but alert() is treated as alert(""). auto* impl = TRY(impl_from(vm, global_object)); String message = ""; if (vm.argument_count()) message = TRY(vm.argument(0).to_string(global_object)); impl->alert(message); return JS::js_undefined(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::confirm) { auto* impl = TRY(impl_from(vm, global_object)); String message = ""; if (!vm.argument(0).is_undefined()) message = TRY(vm.argument(0).to_string(global_object)); return JS::Value(impl->confirm(message)); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::prompt) { auto* impl = TRY(impl_from(vm, global_object)); String message = ""; String default_ = ""; if (!vm.argument(0).is_undefined()) message = TRY(vm.argument(0).to_string(global_object)); if (!vm.argument(1).is_undefined()) default_ = TRY(vm.argument(1).to_string(global_object)); auto response = impl->prompt(message, default_); if (response.is_null()) return JS::js_null(); return JS::js_string(vm, response); } // https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#dom-setinterval JS_DEFINE_NATIVE_FUNCTION(WindowObject::set_interval) { // FIXME: Ideally this would share more code with setTimeout() using the "timer initialization steps" // https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#timer-initialisation-steps auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountAtLeastOne, "setInterval"); JS::FunctionObject* callback; if (vm.argument(0).is_function()) { callback = &vm.argument(0).as_function(); } else { auto script_source = TRY(vm.argument(0).to_string(global_object)); // FIXME: This needs more work once we have a environment settings object. // The spec wants us to use a task for the "run function or script string" part, // using a NativeFunction for the latter is a workaround so that we can reuse the // DOM::Timer API unaltered (always expects a JS::FunctionObject). callback = JS::NativeFunction::create(global_object, "", [impl, script_source = move(script_source)](auto&, auto&) mutable { auto script = HTML::ClassicScript::create(impl->associated_document().url().to_string(), script_source, impl->associated_document().realm(), AK::URL()); return script->run(); }); } i32 interval = 0; if (vm.argument_count() >= 2) { interval = TRY(vm.argument(1).to_i32(global_object)); if (interval < 0) interval = 0; } // FIXME: Pass ...arguments to the callback function when it's invoked auto timer_id = impl->set_interval(*callback, interval); return JS::Value(timer_id); } // https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#dom-settimeout JS_DEFINE_NATIVE_FUNCTION(WindowObject::set_timeout) { // FIXME: Ideally this would share more code with setInterval() using the "timer initialization steps" // https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#timer-initialisation-steps auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountAtLeastOne, "setTimeout"); JS::FunctionObject* callback; if (vm.argument(0).is_function()) { callback = &vm.argument(0).as_function(); } else { auto script_source = TRY(vm.argument(0).to_string(global_object)); // FIXME: This needs more work once we have a environment settings object. // The spec wants us to use a task for the "run function or script string" part, // using a NativeFunction for the latter is a workaround so that we can reuse the // DOM::Timer API unaltered (always expects a JS::FunctionObject). callback = JS::NativeFunction::create(global_object, "", [impl, script_source = move(script_source)](auto&, auto&) mutable { auto script = HTML::ClassicScript::create(impl->associated_document().url().to_string(), script_source, impl->associated_document().realm(), AK::URL()); return script->run(); }); } i32 interval = 0; if (vm.argument_count() >= 2) { interval = TRY(vm.argument(1).to_i32(global_object)); if (interval < 0) interval = 0; } // FIXME: Pass ...arguments to the callback function when it's invoked auto timer_id = impl->set_timeout(*callback, interval); return JS::Value(timer_id); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::clear_timeout) { auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountAtLeastOne, "clearTimeout"); i32 timer_id = TRY(vm.argument(0).to_i32(global_object)); impl->clear_timeout(timer_id); return JS::js_undefined(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::clear_interval) { auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountAtLeastOne, "clearInterval"); i32 timer_id = TRY(vm.argument(0).to_i32(global_object)); impl->clear_interval(timer_id); return JS::js_undefined(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::request_animation_frame) { auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountOne, "requestAnimationFrame"); auto* callback_object = TRY(vm.argument(0).to_object(global_object)); if (!callback_object->is_function()) return vm.throw_completion(global_object, JS::ErrorType::NotAFunctionNoParam); return JS::Value(impl->request_animation_frame(*static_cast(callback_object))); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::cancel_animation_frame) { auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountOne, "cancelAnimationFrame"); auto id = TRY(vm.argument(0).to_i32(global_object)); impl->cancel_animation_frame(id); return JS::js_undefined(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::queue_microtask) { auto* impl = TRY(impl_from(vm, global_object)); if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountAtLeastOne, "queueMicrotask"); auto* callback_object = TRY(vm.argument(0).to_object(global_object)); if (!callback_object->is_function()) return vm.throw_completion(global_object, JS::ErrorType::NotAFunctionNoParam); impl->queue_microtask(static_cast(*callback_object)); return JS::js_undefined(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::atob) { if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountOne, "atob"); auto string = TRY(vm.argument(0).to_string(global_object)); auto decoded = decode_base64(StringView(string)); if (!decoded.has_value()) return vm.throw_completion(global_object, JS::ErrorType::InvalidFormat, "Base64"); // decode_base64() returns a byte string. LibJS uses UTF-8 for strings. Use Latin1Decoder to convert bytes 128-255 to UTF-8. auto decoder = TextCodec::decoder_for("windows-1252"); VERIFY(decoder); return JS::js_string(vm, decoder->to_utf8(decoded.value())); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::btoa) { if (!vm.argument_count()) return vm.throw_completion(global_object, JS::ErrorType::BadArgCountOne, "btoa"); auto string = TRY(vm.argument(0).to_string(global_object)); Vector byte_string; byte_string.ensure_capacity(string.length()); for (u32 code_point : Utf8View(string)) { if (code_point > 0xff) return vm.throw_completion(global_object, JS::ErrorType::NotAByteString, "btoa"); byte_string.append(code_point); } auto encoded = encode_base64(byte_string.span()); return JS::js_string(vm, move(encoded)); } // https://html.spec.whatwg.org/multipage/browsers.html#dom-top JS_DEFINE_NATIVE_FUNCTION(WindowObject::top_getter) { auto* impl = TRY(impl_from(vm, global_object)); auto* this_browsing_context = impl->associated_document().browsing_context(); if (!this_browsing_context) return JS::js_null(); VERIFY(this_browsing_context->top_level_browsing_context().active_document()); auto& top_window = this_browsing_context->top_level_browsing_context().active_document()->window(); return top_window.wrapper(); } // https://html.spec.whatwg.org/multipage/browsers.html#dom-parent JS_DEFINE_NATIVE_FUNCTION(WindowObject::parent_getter) { auto* impl = TRY(impl_from(vm, global_object)); auto* this_browsing_context = impl->associated_document().browsing_context(); if (!this_browsing_context) return JS::js_null(); if (this_browsing_context->parent()) { VERIFY(this_browsing_context->parent()->active_document()); auto& parent_window = this_browsing_context->parent()->active_document()->window(); return parent_window.wrapper(); } VERIFY(this_browsing_context == &this_browsing_context->top_level_browsing_context()); return impl->wrapper(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::document_getter) { auto* impl = TRY(impl_from(vm, global_object)); return wrap(global_object, impl->associated_document()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::performance_getter) { auto* impl = TRY(impl_from(vm, global_object)); return wrap(global_object, impl->performance()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::screen_getter) { auto* impl = TRY(impl_from(vm, global_object)); return wrap(global_object, impl->screen()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::event_getter) { auto* impl = TRY(impl_from(vm, global_object)); if (!impl->current_event()) return JS::js_undefined(); return wrap(global_object, const_cast(*impl->current_event())); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::event_setter) { REPLACEABLE_PROPERTY_SETTER(WindowObject, event); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::crypto_getter) { auto* impl = TRY(impl_from(vm, global_object)); return wrap(global_object, impl->crypto()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::inner_width_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->inner_width()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::inner_height_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->inner_height()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::device_pixel_ratio_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->device_pixel_ratio()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::get_computed_style) { auto* impl = TRY(impl_from(vm, global_object)); auto* object = TRY(vm.argument(0).to_object(global_object)); if (!is(object)) return vm.throw_completion(global_object, JS::ErrorType::NotAnObjectOfType, "DOM element"); return wrap(global_object, impl->get_computed_style(static_cast(object)->impl())); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::get_selection) { auto* impl = TRY(impl_from(vm, global_object)); auto* selection = impl->get_selection(); if (!selection) return JS::js_null(); return wrap(global_object, *selection); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::match_media) { auto* impl = TRY(impl_from(vm, global_object)); auto media = TRY(vm.argument(0).to_string(global_object)); return wrap(global_object, impl->match_media(move(media))); } // https://www.w3.org/TR/cssom-view/#dom-window-scrollx JS_DEFINE_NATIVE_FUNCTION(WindowObject::scroll_x_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->scroll_x()); } // https://www.w3.org/TR/cssom-view/#dom-window-scrolly JS_DEFINE_NATIVE_FUNCTION(WindowObject::scroll_y_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->scroll_y()); } enum class ScrollBehavior { Auto, Smooth }; // https://www.w3.org/TR/cssom-view/#perform-a-scroll static void perform_a_scroll(Page& page, double x, double y, ScrollBehavior) { // FIXME: Stop any existing smooth-scrolls // FIXME: Implement smooth-scroll page.client().page_did_request_scroll_to({ x, y }); } // https://www.w3.org/TR/cssom-view/#dom-window-scroll JS_DEFINE_NATIVE_FUNCTION(WindowObject::scroll) { auto* impl = TRY(impl_from(vm, global_object)); if (!impl->page()) return JS::js_undefined(); auto& page = *impl->page(); auto viewport_rect = page.top_level_browsing_context().viewport_rect(); auto x_value = JS::Value(viewport_rect.x()); auto y_value = JS::Value(viewport_rect.y()); String behavior_string = "auto"; if (vm.argument_count() == 1) { auto* options = TRY(vm.argument(0).to_object(global_object)); auto left = TRY(options->get("left")); if (!left.is_undefined()) x_value = left; auto top = TRY(options->get("top")); if (!top.is_undefined()) y_value = top; auto behavior_string_value = TRY(options->get("behavior")); if (!behavior_string_value.is_undefined()) behavior_string = TRY(behavior_string_value.to_string(global_object)); if (behavior_string != "smooth" && behavior_string != "auto") return vm.throw_completion(global_object, "Behavior is not one of 'smooth' or 'auto'"); } else if (vm.argument_count() >= 2) { // We ignore arguments 2+ in line with behavior of Chrome and Firefox x_value = vm.argument(0); y_value = vm.argument(1); } ScrollBehavior behavior = (behavior_string == "smooth") ? ScrollBehavior::Smooth : ScrollBehavior::Auto; double x = TRY(x_value.to_double(global_object)); x = JS::Value(x).is_finite_number() ? x : 0.0; double y = TRY(y_value.to_double(global_object)); y = JS::Value(y).is_finite_number() ? y : 0.0; // FIXME: Are we calculating the viewport in the way this function expects? // FIXME: Handle overflow-directions other than top-left to bottom-right perform_a_scroll(page, x, y, behavior); return JS::js_undefined(); } // https://www.w3.org/TR/cssom-view/#dom-window-scrollby JS_DEFINE_NATIVE_FUNCTION(WindowObject::scroll_by) { auto* impl = TRY(impl_from(vm, global_object)); if (!impl->page()) return JS::js_undefined(); auto& page = *impl->page(); JS::Object* options = nullptr; if (vm.argument_count() == 0) { options = JS::Object::create(global_object, nullptr); } else if (vm.argument_count() == 1) { options = TRY(vm.argument(0).to_object(global_object)); } else if (vm.argument_count() >= 2) { // We ignore arguments 2+ in line with behavior of Chrome and Firefox options = JS::Object::create(global_object, nullptr); MUST(options->set("left", vm.argument(0), ShouldThrowExceptions::No)); MUST(options->set("top", vm.argument(1), ShouldThrowExceptions::No)); MUST(options->set("behavior", JS::js_string(vm, "auto"), ShouldThrowExceptions::No)); } auto left_value = TRY(options->get("left")); auto left = TRY(left_value.to_double(global_object)); auto top_value = TRY(options->get("top")); auto top = TRY(top_value.to_double(global_object)); left = JS::Value(left).is_finite_number() ? left : 0.0; top = JS::Value(top).is_finite_number() ? top : 0.0; auto current_scroll_position = page.top_level_browsing_context().viewport_scroll_offset(); left = left + current_scroll_position.x(); top = top + current_scroll_position.y(); auto behavior_string_value = TRY(options->get("behavior")); auto behavior_string = behavior_string_value.is_undefined() ? "auto" : TRY(behavior_string_value.to_string(global_object)); if (behavior_string != "smooth" && behavior_string != "auto") return vm.throw_completion(global_object, "Behavior is not one of 'smooth' or 'auto'"); ScrollBehavior behavior = (behavior_string == "smooth") ? ScrollBehavior::Smooth : ScrollBehavior::Auto; // FIXME: Spec wants us to call scroll(options) here. // The only difference is that would invoke the viewport calculations that scroll() // is not actually doing yet, so this is the same for now. perform_a_scroll(page, left, top, behavior); return JS::js_undefined(); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::history_getter) { auto* impl = TRY(impl_from(vm, global_object)); return wrap(global_object, impl->associated_document().history()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::screen_left_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->screen_x()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::screen_top_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->screen_y()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::screen_x_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->screen_x()); } JS_DEFINE_NATIVE_FUNCTION(WindowObject::screen_y_getter) { auto* impl = TRY(impl_from(vm, global_object)); return JS::Value(impl->screen_y()); } #define __ENUMERATE(attribute, event_name) \ JS_DEFINE_NATIVE_FUNCTION(WindowObject::attribute##_getter) \ { \ auto* impl = TRY(impl_from(vm, global_object)); \ auto retval = impl->attribute(); \ if (retval.callback.is_null()) \ return JS::js_null(); \ return retval.callback.cell(); \ } \ JS_DEFINE_NATIVE_FUNCTION(WindowObject::attribute##_setter) \ { \ auto* impl = TRY(impl_from(vm, global_object)); \ auto value = vm.argument(0); \ HTML::EventHandler cpp_value; \ if (value.is_function()) { \ cpp_value.callback = JS::make_handle(&value.as_function()); \ } else if (value.is_string()) { \ cpp_value.string = value.as_string().string(); \ } else { \ return JS::js_undefined(); \ } \ TRY(throw_dom_exception_if_needed(global_object, [&] { \ return impl->set_##attribute(cpp_value); \ })); \ return JS::js_undefined(); \ } ENUMERATE_GLOBAL_EVENT_HANDLERS(__ENUMERATE) #undef __ENUMERATE }