LibWeb+LibWebView+UI: Migrate to LibWebView's language settings

Author: https://github.com/trflynn89
Commit: a3ea4881e7
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/4215
Reviewed-by: https://github.com/gmta ✅

Libraries/LibWeb/HTML/NavigatorLanguage.h

@@ -7,8 +7,8 @@
 
 #pragma once
 
+#include <AK/Span.h>
 #include <AK/String.h>
-#include <AK/Vector.h>
 #include <LibWeb/Loader/ResourceLoader.h>
 
 namespace Web::HTML {
@@ -16,10 +16,10 @@ namespace Web::HTML {
 class NavigatorLanguageMixin {
 public:
     // https://html.spec.whatwg.org/multipage/system-state.html#dom-navigator-language
-    String language() const { return ResourceLoader::the().preferred_languages()[0]; }
+    String const& language() const { return ResourceLoader::the().preferred_languages()[0]; }
 
     // https://html.spec.whatwg.org/multipage/system-state.html#dom-navigator-languages
-    Vector<String> languages() const { return ResourceLoader::the().preferred_languages(); }
+    ReadonlySpan<String> languages() const { return ResourceLoader::the().preferred_languages(); }
 };
 
 }

Libraries/LibWeb/Loader/ResourceLoader.h

@@ -53,15 +53,11 @@ public:
     String const& platform() const { return m_platform; }
     void set_platform(String platform) { m_platform = move(platform); }
 
-    Vector<String> preferred_languages() const { return m_preferred_languages; }
+    Vector<String> const& preferred_languages() const { return m_preferred_languages; }
     void set_preferred_languages(Vector<String> preferred_languages)
     {
-        // Default to "en" if no preferred languages are specified.
+        m_preferred_languages = move(preferred_languages);
-        if (preferred_languages.is_empty() || (preferred_languages.size() == 1 && preferred_languages[0].is_empty())) {
+        VERIFY(!m_preferred_languages.is_empty());
-            m_preferred_languages = { "en"_string };
-        } else {
-            m_preferred_languages = move(preferred_languages);
-        }
     }
 
     NavigatorCompatibilityMode navigator_compatibility_mode() { return m_navigator_compatibility_mode; }

Libraries/LibWebView/ViewImplementation.cpp

@@ -252,11 +252,6 @@ void ViewImplementation::set_preferred_motion(Web::CSS::PreferredMotion motion)
     client().async_set_preferred_motion(page_id(), motion);
 }
 
-void ViewImplementation::set_preferred_languages(ReadonlySpan<String> preferred_languages)
-{
-    client().async_set_preferred_languages(page_id(), preferred_languages);
-}
-
 ByteString ViewImplementation::selected_text()
 {
     return client().get_selected_text(page_id());
@@ -599,6 +594,7 @@ void ViewImplementation::initialize_client(CreateNewClient create_new_client)
     if (auto const& user_agent_preset = Application::web_content_options().user_agent_preset; user_agent_preset.has_value())
         client().async_debug_request(m_client_state.page_index, "spoof-user-agent"sv, *user_agents.get(*user_agent_preset));
 
+    languages_changed();
     autoplay_settings_changed();
     do_not_track_changed();
 }
@@ -648,6 +644,12 @@ void ViewImplementation::handle_web_content_process_crash(LoadErrorPage load_err
     }
 }
 
+void ViewImplementation::languages_changed()
+{
+    auto const& languages = Application::settings().languages();
+    client().async_set_preferred_languages(page_id(), languages);
+}
+
 void ViewImplementation::autoplay_settings_changed()
 {
     auto const& autoplay_settings = Application::settings().autoplay_settings();

Libraries/LibWebView/ViewImplementation.h

@@ -80,8 +80,6 @@ public:
     void set_preferred_contrast(Web::CSS::PreferredContrast);
     void set_preferred_motion(Web::CSS::PreferredMotion);
 
-    void set_preferred_languages(ReadonlySpan<String>);
-
     ByteString selected_text();
     Optional<String> selected_text_with_whitespace_collapsed();
     void select_all();
@@ -262,6 +260,7 @@ protected:
     };
     void handle_web_content_process_crash(LoadErrorPage = LoadErrorPage::Yes);
 
+    virtual void languages_changed() override;
     virtual void autoplay_settings_changed() override;
     virtual void do_not_track_changed() override;
 

UI/Qt/BrowserWindow.cpp

@@ -20,7 +20,6 @@
 #include <UI/Qt/BrowserWindow.h>
 #include <UI/Qt/Icon.h>
 #include <UI/Qt/Settings.h>
-#include <UI/Qt/SettingsDialog.h>
 #include <UI/Qt/StringUtils.h>
 #include <UI/Qt/TabBar.h>
 #include <UI/Qt/WebContentView.h>
@@ -97,18 +96,6 @@ BrowserWindow::BrowserWindow(Vector<URL::URL> const& initial_urls, IsPopupWindow
         });
     }
 
-    QObject::connect(Settings::the(), &Settings::preferred_languages_changed, this, [this](QStringList languages) {
-        Vector<String> preferred_languages;
-        preferred_languages.ensure_capacity(languages.length());
-        for (auto& language : languages) {
-            preferred_languages.append(ak_string_from_qstring(language));
-        }
-
-        for_each_tab([preferred_languages](auto& tab) {
-            tab.set_preferred_languages(preferred_languages);
-        });
-    });
-
     m_hamburger_menu = new HamburgerMenu(this);
 
     if (!Settings::the()->show_menubar())
@@ -198,18 +185,6 @@ BrowserWindow::BrowserWindow(Vector<URL::URL> const& initial_urls, IsPopupWindow
         new_tab_from_url(URL::URL::about("settings"_string), Web::HTML::ActivateTab::Yes);
     });
 
-    auto* deprecated_settings_action = new QAction("Qt Settings", this);
-    deprecated_settings_action->setIcon(load_icon_from_uri("resource://icons/16x16/settings.png"sv));
-    edit_menu->addAction(deprecated_settings_action);
-    QObject::connect(deprecated_settings_action, &QAction::triggered, this, [this] {
-        if (!m_settings_dialog) {
-            m_settings_dialog = new SettingsDialog(this);
-        }
-
-        m_settings_dialog->show();
-        m_settings_dialog->setFocus();
-    });
-
     auto* view_menu = m_hamburger_menu->addMenu("&View");
     menuBar()->addMenu(view_menu);
 
@@ -853,19 +828,12 @@ void BrowserWindow::initialize_tab(Tab* tab)
     m_tabs_container->setTabIcon(m_tabs_container->indexOf(tab), tab->favicon());
     create_close_button_for_tab(tab);
 
-    Vector<String> preferred_languages;
-    preferred_languages.ensure_capacity(Settings::the()->preferred_languages().length());
-    for (auto& language : Settings::the()->preferred_languages()) {
-        preferred_languages.append(ak_string_from_qstring(language));
-    }
-
     tab->set_line_box_borders(m_show_line_box_borders_action->isChecked());
     tab->set_scripting(m_enable_scripting_action->isChecked());
     tab->set_content_filtering(m_enable_content_filtering_action->isChecked());
     tab->set_block_popups(m_block_pop_ups_action->isChecked());
     tab->set_same_origin_policy(m_enable_same_origin_policy_action->isChecked());
     tab->set_user_agent_string(user_agent_string());
-    tab->set_preferred_languages(preferred_languages);
     tab->set_navigator_compatibility_mode(navigator_compatibility_mode());
     tab->view().set_preferred_color_scheme(m_preferred_color_scheme);
 }

UI/Qt/BrowserWindow.h

@@ -24,7 +24,6 @@
 
 namespace Ladybird {
 
-class SettingsDialog;
 class WebContentView;
 
 class BrowserWindow : public QMainWindow {
@@ -210,8 +209,6 @@ private:
     ByteString m_user_agent_string {};
     ByteString m_navigator_compatibility_mode {};
 
-    SettingsDialog* m_settings_dialog { nullptr };
-
     IsPopupWindow m_is_popup_window { IsPopupWindow::No };
 };
 

UI/Qt/CMakeLists.txt

@@ -7,7 +7,6 @@ target_sources(ladybird PRIVATE
     Icon.cpp
     LocationEdit.cpp
     Settings.cpp
-    SettingsDialog.cpp
     Tab.cpp
     TabBar.cpp
     TVGIconEngine.cpp

UI/Qt/Settings.cpp

@@ -54,17 +54,6 @@ void Settings::set_is_maximized(bool is_maximized)
     m_qsettings->setValue("is_maximized", is_maximized);
 }
 
-QStringList Settings::preferred_languages()
-{
-    return m_qsettings->value("preferred_languages").toStringList();
-}
-
-void Settings::set_preferred_languages(QStringList const& languages)
-{
-    m_qsettings->setValue("preferred_languages", languages);
-    emit preferred_languages_changed(languages);
-}
-
 bool Settings::show_menubar()
 {
     return m_qsettings->value("show_menubar", false).toBool();

UI/Qt/Settings.h

@@ -41,15 +41,11 @@ public:
     bool is_maximized();
     void set_is_maximized(bool is_maximized);
 
-    QStringList preferred_languages();
-    void set_preferred_languages(QStringList const& languages);
-
     bool show_menubar();
     void set_show_menubar(bool show_menubar);
 
 signals:
     void show_menubar_changed(bool show_menubar);
-    void preferred_languages_changed(QStringList const& languages);
     void enable_do_not_track_changed(bool enable);
 
 protected:

UI/Qt/SettingsDialog.cpp

@@ -1,42 +0,0 @@
-/*
- * Copyright (c) 2022, Filiph Sandström <filiph.sandstrom@filfatstudios.com>
- * Copyright (c) 2023, Cameron Youell <cameronyouell@gmail.com>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
-
-#include <LibURL/Parser.h>
-#include <LibURL/URL.h>
-#include <LibWebView/Application.h>
-#include <UI/Qt/Settings.h>
-#include <UI/Qt/SettingsDialog.h>
-#include <UI/Qt/StringUtils.h>
-
-#include <QLabel>
-#include <QMenu>
-
-namespace Ladybird {
-
-SettingsDialog::SettingsDialog(QMainWindow* window)
-    : QDialog(window)
-    , m_window(window)
-{
-    m_layout = new QFormLayout(this);
-
-    m_preferred_languages = new QLineEdit(this);
-    m_preferred_languages->setText(Settings::the()->preferred_languages().join(","));
-    QObject::connect(m_preferred_languages, &QLineEdit::editingFinished, this, [this] {
-        Settings::the()->set_preferred_languages(m_preferred_languages->text().split(","));
-    });
-    QObject::connect(m_preferred_languages, &QLineEdit::returnPressed, this, [this] {
-        close();
-    });
-
-    m_layout->addRow(new QLabel("Preferred Language(s)", this), m_preferred_languages);
-
-    setWindowTitle("Settings");
-    setLayout(m_layout);
-    resize(600, 250);
-}
-
-}

UI/Qt/SettingsDialog.h

@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2022, Filiph Sandström <filiph.sandstrom@filfatstudios.com>
- * Copyright (c) 2023, Cameron Youell <cameronyouell@gmail.com>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
-
-#pragma once
-
-#include <QCheckBox>
-#include <QDialog>
-#include <QFormLayout>
-#include <QLineEdit>
-#include <QMainWindow>
-#include <QPushButton>
-
-namespace Ladybird {
-
-class SettingsDialog : public QDialog {
-    Q_OBJECT
-
-public:
-    explicit SettingsDialog(QMainWindow* window);
-
-private:
-    QFormLayout* m_layout;
-    QMainWindow* m_window { nullptr };
-    QLineEdit* m_preferred_languages { nullptr };
-};
-
-}

UI/Qt/Tab.cpp

@@ -938,9 +938,4 @@ void Tab::set_navigator_compatibility_mode(ByteString const& compatibility_mode)
     debug_request("navigator-compatibility-mode", compatibility_mode);
 }
 
-void Tab::set_preferred_languages(ReadonlySpan<String> preferred_languages)
-{
-    m_view->set_preferred_languages(preferred_languages);
-}
-
 }

UI/Qt/Tab.h

@@ -88,8 +88,6 @@ public:
     void set_user_agent_string(ByteString const&);
     void set_navigator_compatibility_mode(ByteString const&);
 
-    void set_preferred_languages(ReadonlySpan<String> preferred_languages);
-
     bool url_is_hidden() const { return m_location_edit->url_is_hidden(); }
     void set_url_is_hidden(bool url_is_hidden) { m_location_edit->set_url_is_hidden(url_is_hidden); }