ladybird/Libraries/LibWeb/HTML/Navigator.h

/*
 * Copyright (c) 2022, Andrew Kaster <akaster@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/HTML/MimeTypeArray.h>
#include <LibWeb/HTML/NavigatorBeacon.h>
#include <LibWeb/HTML/NavigatorConcurrentHardware.h>
#include <LibWeb/HTML/NavigatorDeviceMemory.h>
#include <LibWeb/HTML/NavigatorID.h>
#include <LibWeb/HTML/NavigatorLanguage.h>
#include <LibWeb/HTML/NavigatorOnLine.h>
#include <LibWeb/HTML/PluginArray.h>
#include <LibWeb/HTML/UserActivation.h>
#include <LibWeb/MediaCapabilitiesAPI/MediaCapabilities.h>
#include <LibWeb/StorageAPI/NavigatorStorage.h>

namespace Web::HTML {

class Navigator : public Bindings::PlatformObject
    , public NavigatorBeaconMixin
    , public NavigatorConcurrentHardwareMixin
    , public NavigatorDeviceMemoryMixin
    , public NavigatorIDMixin
    , public NavigatorLanguageMixin
    , public NavigatorOnLineMixin
    , public StorageAPI::NavigatorStorage {
    WEB_PLATFORM_OBJECT(Navigator, Bindings::PlatformObject);
    JS_DECLARE_ALLOCATOR(Navigator);

public:
    [[nodiscard]] static JS::NonnullGCPtr<Navigator> create(JS::Realm&);

    // FIXME: Implement NavigatorContentUtilsMixin

    // NavigatorCookies
    // FIXME: Hook up to Agent level state
    // https://html.spec.whatwg.org/multipage/system-state.html#dom-navigator-cookieenabled
    bool cookie_enabled() const { return true; }

    // NavigatorPlugins
    // https://html.spec.whatwg.org/multipage/system-state.html#dom-navigator-javaenabled
    bool java_enabled() const { return false; }

    bool pdf_viewer_enabled() const;

    bool webdriver() const;

    [[nodiscard]] JS::NonnullGCPtr<MimeTypeArray> mime_types();
    [[nodiscard]] JS::NonnullGCPtr<PluginArray> plugins();
    [[nodiscard]] JS::NonnullGCPtr<Clipboard::Clipboard> clipboard();
    [[nodiscard]] JS::NonnullGCPtr<UserActivation> user_activation();

    Optional<FlyString> do_not_track() const;

    JS::NonnullGCPtr<ServiceWorkerContainer> service_worker();

    JS::NonnullGCPtr<MediaCapabilitiesAPI::MediaCapabilities> media_capabilities();

    static WebIDL::Long max_touch_points();

    virtual ~Navigator() override;

protected:
    virtual void visit_edges(Cell::Visitor&) override;

private:
    explicit Navigator(JS::Realm&);

    virtual void initialize(JS::Realm&) override;

    // ^StorageAPI::NavigatorStorage
    virtual Bindings::PlatformObject const& this_navigator_storage_object() const override { return *this; }

    JS::GCPtr<PluginArray> m_plugin_array;
    JS::GCPtr<MimeTypeArray> m_mime_type_array;

    // https://w3c.github.io/clipboard-apis/#dom-navigator-clipboard
    JS::GCPtr<Clipboard::Clipboard> m_clipboard;

    // https://html.spec.whatwg.org/multipage/interaction.html#dom-navigator-useractivation
    JS::GCPtr<UserActivation> m_user_activation;

    // https://w3c.github.io/ServiceWorker/#navigator-serviceworker
    JS::GCPtr<ServiceWorkerContainer> m_service_worker_container;

    // https://w3c.github.io/media-capabilities/#dom-navigator-mediacapabilities
    JS::GCPtr<MediaCapabilitiesAPI::MediaCapabilities> m_media_capabilities;
};

}