1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-29 10:47:36 +00:00

Browser: Store default config values in a single place

Note that this fixes contradictory default values for group
"Preferences", key "Home". This is exactly the kind of errors I want to
prevent with this new style.

The hope is that this can later be used to:
- verify that all accesses to the same key use the same default value,
- and extract the default values more easily.
This commit is contained in:
Ben Wiederhake 2023-06-01 14:21:06 +02:00 committed by Jelle Raaijmakers
parent 9ee098b119
commit 2420effa7d
8 changed files with 55 additions and 37 deletions

View file

@ -6,6 +6,7 @@
#include "AutoplaySettingsWidget.h"
#include <Applications/BrowserSettings/AutoplaySettingsWidgetGML.h>
#include <Applications/BrowserSettings/Defaults.h>
#include <LibConfig/Client.h>
#include <LibCore/StandardPaths.h>
#include <LibGUI/Button.h>
@ -15,8 +16,6 @@
#include <LibGUI/ListView.h>
#include <LibGUI/Menu.h>
static constexpr bool default_allow_autoplay_on_all_websites = false;
ErrorOr<String> AutoplayAllowlistModel::filter_list_file_path() const
{
return String::formatted("{}/BrowserAutoplayAllowlist.txt", Core::StandardPaths::config_directory());
@ -38,7 +37,7 @@ ErrorOr<NonnullRefPtr<AutoplaySettingsWidget>> AutoplaySettingsWidget::create()
TRY(widget->load_from_gml(autoplay_settings_widget_gml));
widget->m_allow_autoplay_on_all_websites_checkbox = widget->find_descendant_of_type_named<GUI::CheckBox>("allow_autoplay_on_all_websites_checkbox");
widget->m_allow_autoplay_on_all_websites_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "AllowAutoplayOnAllWebsites"sv, default_allow_autoplay_on_all_websites), GUI::AllowCallback::No);
widget->m_allow_autoplay_on_all_websites_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "AllowAutoplayOnAllWebsites"sv, Browser::default_allow_autoplay_on_all_websites), GUI::AllowCallback::No);
widget->m_allow_autoplay_on_all_websites_checkbox->on_checked = [widget](auto) {
widget->set_modified(true);
};
@ -86,5 +85,5 @@ void AutoplaySettingsWidget::apply_settings()
void AutoplaySettingsWidget::reset_default_values()
{
m_allowlist_model->reset_default_values();
m_allow_autoplay_on_all_websites_checkbox->set_checked(default_allow_autoplay_on_all_websites);
m_allow_autoplay_on_all_websites_checkbox->set_checked(Browser::default_allow_autoplay_on_all_websites);
}

View file

@ -7,19 +7,13 @@
#include "BrowserSettingsWidget.h"
#include <Applications/BrowserSettings/BrowserSettingsWidgetGML.h>
#include <Applications/BrowserSettings/Defaults.h>
#include <LibConfig/Client.h>
#include <LibGUI/JsonArrayModel.h>
#include <LibGUI/Label.h>
#include <LibGUI/MessageBox.h>
#include <LibGUI/Model.h>
static DeprecatedString default_homepage_url = "file:///res/html/misc/welcome.html";
static DeprecatedString default_new_tab_url = "file:///res/html/misc/new-tab.html";
static DeprecatedString default_search_engine = "";
static DeprecatedString default_color_scheme = "auto";
static bool default_show_bookmarks_bar = true;
static bool default_auto_close_download_windows = false;
struct ColorScheme {
DeprecatedString title;
DeprecatedString setting_value;
@ -71,22 +65,22 @@ ErrorOr<NonnullRefPtr<BrowserSettingsWidget>> BrowserSettingsWidget::create()
ErrorOr<void> BrowserSettingsWidget::setup()
{
m_homepage_url_textbox = find_descendant_of_type_named<GUI::TextBox>("homepage_url_textbox");
m_homepage_url_textbox->set_text(Config::read_string("Browser"sv, "Preferences"sv, "Home"sv, default_homepage_url), GUI::AllowCallback::No);
m_homepage_url_textbox->set_text(Config::read_string("Browser"sv, "Preferences"sv, "Home"sv, Browser::default_homepage_url), GUI::AllowCallback::No);
m_homepage_url_textbox->on_change = [&]() { set_modified(true); };
m_new_tab_url_textbox = find_descendant_of_type_named<GUI::TextBox>("new_tab_url_textbox");
m_new_tab_url_textbox->set_text(Config::read_string("Browser"sv, "Preferences"sv, "NewTab"sv, default_new_tab_url), GUI::AllowCallback::No);
m_new_tab_url_textbox->set_text(Config::read_string("Browser"sv, "Preferences"sv, "NewTab"sv, Browser::default_new_tab_url), GUI::AllowCallback::No);
m_new_tab_url_textbox->on_change = [&]() { set_modified(true); };
m_color_scheme_combobox = find_descendant_of_type_named<GUI::ComboBox>("color_scheme_combobox");
m_color_scheme_combobox->set_only_allow_values_from_model(true);
m_color_scheme_combobox->set_model(adopt_ref(*new ColorSchemeModel()));
m_color_scheme_combobox->set_selected_index(0, GUI::AllowCallback::No);
set_color_scheme(Config::read_string("Browser"sv, "Preferences"sv, "ColorScheme"sv, default_color_scheme));
set_color_scheme(Config::read_string("Browser"sv, "Preferences"sv, "ColorScheme"sv, Browser::default_color_scheme));
m_color_scheme_combobox->on_change = [&](auto, auto) { set_modified(true); };
m_show_bookmarks_bar_checkbox = find_descendant_of_type_named<GUI::CheckBox>("show_bookmarks_bar_checkbox");
m_show_bookmarks_bar_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "ShowBookmarksBar"sv, default_show_bookmarks_bar), GUI::AllowCallback::No);
m_show_bookmarks_bar_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "ShowBookmarksBar"sv, Browser::default_show_bookmarks_bar), GUI::AllowCallback::No);
m_show_bookmarks_bar_checkbox->on_checked = [&](auto) { set_modified(true); };
m_enable_search_engine_checkbox = find_descendant_of_type_named<GUI::CheckBox>("enable_search_engine_checkbox");
@ -120,10 +114,10 @@ ErrorOr<void> BrowserSettingsWidget::setup()
m_custom_search_engine_group->set_enabled(m_is_custom_search_engine);
set_modified(true);
};
set_search_engine_url(Config::read_string("Browser"sv, "Preferences"sv, "SearchEngine"sv, default_search_engine));
set_search_engine_url(Config::read_string("Browser"sv, "Preferences"sv, "SearchEngine"sv, Browser::default_search_engine));
m_auto_close_download_windows_checkbox = find_descendant_of_type_named<GUI::CheckBox>("auto_close_download_windows_checkbox");
m_auto_close_download_windows_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "CloseDownloadWidgetOnFinish"sv, default_auto_close_download_windows), GUI::AllowCallback::No);
m_auto_close_download_windows_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "CloseDownloadWidgetOnFinish"sv, Browser::default_close_download_widget_on_finish), GUI::AllowCallback::No);
m_auto_close_download_windows_checkbox->on_checked = [&](auto) { set_modified(true); };
return {};
@ -218,10 +212,10 @@ void BrowserSettingsWidget::apply_settings()
void BrowserSettingsWidget::reset_default_values()
{
m_homepage_url_textbox->set_text(default_homepage_url);
m_new_tab_url_textbox->set_text(default_new_tab_url);
m_show_bookmarks_bar_checkbox->set_checked(default_show_bookmarks_bar);
set_color_scheme(default_color_scheme);
m_auto_close_download_windows_checkbox->set_checked(default_auto_close_download_windows);
set_search_engine_url(default_search_engine);
m_homepage_url_textbox->set_text(Browser::default_homepage_url);
m_new_tab_url_textbox->set_text(Browser::default_new_tab_url);
m_show_bookmarks_bar_checkbox->set_checked(Browser::default_show_bookmarks_bar);
set_color_scheme(Browser::default_color_scheme);
m_auto_close_download_windows_checkbox->set_checked(Browser::default_close_download_widget_on_finish);
set_search_engine_url(Browser::default_search_engine);
}

View file

@ -9,6 +9,7 @@
#include <AK/NonnullRefPtr.h>
#include <AK/String.h>
#include <Applications/BrowserSettings/ContentFilterSettingsWidgetGML.h>
#include <Applications/BrowserSettings/Defaults.h>
#include <LibConfig/Client.h>
#include <LibCore/StandardPaths.h>
#include <LibGUI/CheckBox.h>
@ -18,8 +19,6 @@
#include <LibGUI/ListView.h>
#include <LibGUI/Menu.h>
static constexpr bool s_default_enable_content_filtering = true;
ErrorOr<String> DomainListModel::filter_list_file_path() const
{
return String::formatted("{}/BrowserContentFilters.txt", Core::StandardPaths::config_directory());
@ -126,7 +125,7 @@ ErrorOr<NonnullRefPtr<ContentFilterSettingsWidget>> ContentFilterSettingsWidget:
TRY(widget->load_from_gml(content_filter_settings_widget_gml));
widget->m_enable_content_filtering_checkbox = widget->find_descendant_of_type_named<GUI::CheckBox>("enable_content_filtering_checkbox");
widget->m_enable_content_filtering_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "EnableContentFilters"sv, s_default_enable_content_filtering), GUI::AllowCallback::No);
widget->m_enable_content_filtering_checkbox->set_checked(Config::read_bool("Browser"sv, "Preferences"sv, "EnableContentFilters"sv, Browser::default_enable_content_filters), GUI::AllowCallback::No);
widget->m_enable_content_filtering_checkbox->on_checked = [widget](auto) {
widget->set_modified(true);
};
@ -174,5 +173,5 @@ void ContentFilterSettingsWidget::apply_settings()
void ContentFilterSettingsWidget::reset_default_values()
{
m_domain_list_model->reset_default_values();
m_enable_content_filtering_checkbox->set_checked(s_default_enable_content_filtering);
m_enable_content_filtering_checkbox->set_checked(Browser::default_enable_content_filters);
}

View file

@ -0,0 +1,22 @@
/*
* Copyright (c) 2023, Ben Wiederhake <BenWiederhake.GitHub@gmx.de>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/StringView.h>
namespace Browser {
static constexpr StringView default_homepage_url = "file:///res/html/misc/welcome.html"sv;
static constexpr StringView default_new_tab_url = "file:///res/html/misc/new-tab.html"sv;
static constexpr StringView default_search_engine = ""sv;
static constexpr StringView default_color_scheme = "auto"sv;
static constexpr bool default_enable_content_filters = true;
static constexpr bool default_show_bookmarks_bar = true;
static constexpr bool default_close_download_widget_on_finish = false;
static constexpr bool default_allow_autoplay_on_all_websites = false;
}