mirror of
https://github.com/RGBCube/serenity
synced 2025-07-27 17:17:45 +00:00
Userland: Introduce ConfigServer and LibConfig
ConfigServer is an IPC service that provides access to application configuration and settings. The idea is to replace all uses of Core::ConfigFile with IPC requests to ConfigServer. This first cut of the API is pretty similar to Core::ConfigFile. The old: auto config = Core::ConfigFile::open_for_app("App"); auto value = config->read_entry("Group", "Key"); The new: auto value = Config::read_string("App", "Group", "Key"); ConfigServer uses the ~/.config directory as its backing store and all the files remain human-editable. :^)
This commit is contained in:
parent
c97f7ea23b
commit
bdcd0abf9d
12 changed files with 319 additions and 0 deletions
|
@ -1,6 +1,7 @@
|
|||
add_subdirectory(AudioServer)
|
||||
add_subdirectory(ChessEngine)
|
||||
add_subdirectory(Clipboard)
|
||||
add_subdirectory(ConfigServer)
|
||||
add_subdirectory(CrashDaemon)
|
||||
add_subdirectory(DHCPClient)
|
||||
add_subdirectory(EchoServer)
|
||||
|
|
18
Userland/Services/ConfigServer/CMakeLists.txt
Normal file
18
Userland/Services/ConfigServer/CMakeLists.txt
Normal file
|
@ -0,0 +1,18 @@
|
|||
serenity_component(
|
||||
ConfigServer
|
||||
REQUIRED
|
||||
TARGETS ConfigServer
|
||||
)
|
||||
|
||||
compile_ipc(ConfigServer.ipc ConfigServerEndpoint.h)
|
||||
compile_ipc(ConfigClient.ipc ConfigClientEndpoint.h)
|
||||
|
||||
set(SOURCES
|
||||
ClientConnection.cpp
|
||||
main.cpp
|
||||
ConfigServerEndpoint.h
|
||||
ConfigClientEndpoint.h
|
||||
)
|
||||
|
||||
serenity_bin(ConfigServer)
|
||||
target_link_libraries(ConfigServer LibIPC)
|
72
Userland/Services/ConfigServer/ClientConnection.cpp
Normal file
72
Userland/Services/ConfigServer/ClientConnection.cpp
Normal file
|
@ -0,0 +1,72 @@
|
|||
/*
|
||||
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include "ClientConnection.h"
|
||||
#include <ConfigServer/ConfigClientEndpoint.h>
|
||||
#include <LibCore/ConfigFile.h>
|
||||
|
||||
namespace ConfigServer {
|
||||
|
||||
static HashMap<int, RefPtr<ClientConnection>> s_connections;
|
||||
|
||||
ClientConnection::ClientConnection(NonnullRefPtr<Core::LocalSocket> client_socket, int client_id)
|
||||
: IPC::ClientConnection<ConfigClientEndpoint, ConfigServerEndpoint>(*this, move(client_socket), client_id)
|
||||
{
|
||||
s_connections.set(client_id, *this);
|
||||
}
|
||||
|
||||
ClientConnection::~ClientConnection()
|
||||
{
|
||||
}
|
||||
|
||||
void ClientConnection::die()
|
||||
{
|
||||
s_connections.remove(client_id());
|
||||
}
|
||||
|
||||
Messages::ConfigServer::ReadStringValueResponse ClientConnection::read_string_value(String const& domain, String const& group, String const& key)
|
||||
{
|
||||
auto config = Core::ConfigFile::open_for_app(domain);
|
||||
if (!config->has_key(group, key))
|
||||
return Optional<String> {};
|
||||
return Optional<String> { config->read_entry(group, key) };
|
||||
}
|
||||
|
||||
Messages::ConfigServer::ReadI32ValueResponse ClientConnection::read_i32_value(String const& domain, String const& group, String const& key)
|
||||
{
|
||||
auto config = Core::ConfigFile::open_for_app(domain);
|
||||
if (!config->has_key(group, key))
|
||||
return Optional<i32> {};
|
||||
return Optional<i32> { config->read_num_entry(group, key) };
|
||||
}
|
||||
|
||||
Messages::ConfigServer::ReadBoolValueResponse ClientConnection::read_bool_value(String const& domain, String const& group, String const& key)
|
||||
{
|
||||
auto config = Core::ConfigFile::open_for_app(domain);
|
||||
if (!config->has_key(group, key))
|
||||
return Optional<bool> {};
|
||||
return Optional<bool> { config->read_bool_entry(group, key) };
|
||||
}
|
||||
|
||||
void ClientConnection::write_string_value(String const& domain, String const& group, String const& key, String const& value)
|
||||
{
|
||||
auto config = Core::ConfigFile::open_for_app(domain, Core::ConfigFile::AllowWriting::Yes);
|
||||
config->write_entry(group, key, value);
|
||||
}
|
||||
|
||||
void ClientConnection::write_i32_value(String const& domain, String const& group, String const& key, i32 value)
|
||||
{
|
||||
auto config = Core::ConfigFile::open_for_app(domain, Core::ConfigFile::AllowWriting::Yes);
|
||||
config->write_num_entry(group, key, value);
|
||||
}
|
||||
|
||||
void ClientConnection::write_bool_value(String const& domain, String const& group, String const& key, bool value)
|
||||
{
|
||||
auto config = Core::ConfigFile::open_for_app(domain, Core::ConfigFile::AllowWriting::Yes);
|
||||
config->write_bool_entry(group, key, value);
|
||||
}
|
||||
|
||||
}
|
34
Userland/Services/ConfigServer/ClientConnection.h
Normal file
34
Userland/Services/ConfigServer/ClientConnection.h
Normal file
|
@ -0,0 +1,34 @@
|
|||
/*
|
||||
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <LibIPC/ClientConnection.h>
|
||||
|
||||
#include <ConfigServer/ConfigClientEndpoint.h>
|
||||
#include <ConfigServer/ConfigServerEndpoint.h>
|
||||
|
||||
namespace ConfigServer {
|
||||
|
||||
class ClientConnection final : public IPC::ClientConnection<ConfigClientEndpoint, ConfigServerEndpoint> {
|
||||
C_OBJECT(ClientConnection)
|
||||
public:
|
||||
~ClientConnection() override;
|
||||
|
||||
virtual void die() override;
|
||||
|
||||
private:
|
||||
explicit ClientConnection(NonnullRefPtr<Core::LocalSocket>, int client_id);
|
||||
|
||||
virtual Messages::ConfigServer::ReadStringValueResponse read_string_value([[maybe_unused]] String const& domain, [[maybe_unused]] String const& group, [[maybe_unused]] String const& key) override;
|
||||
virtual Messages::ConfigServer::ReadI32ValueResponse read_i32_value([[maybe_unused]] String const& domain, [[maybe_unused]] String const& group, [[maybe_unused]] String const& key) override;
|
||||
virtual Messages::ConfigServer::ReadBoolValueResponse read_bool_value([[maybe_unused]] String const& domain, [[maybe_unused]] String const& group, [[maybe_unused]] String const& key) override;
|
||||
virtual void write_string_value([[maybe_unused]] String const& domain, [[maybe_unused]] String const& group, [[maybe_unused]] String const& key, [[maybe_unused]] String const& value) override;
|
||||
virtual void write_i32_value([[maybe_unused]] String const& domain, [[maybe_unused]] String const& group, [[maybe_unused]] String const& key, [[maybe_unused]] i32 value) override;
|
||||
virtual void write_bool_value([[maybe_unused]] String const& domain, [[maybe_unused]] String const& group, [[maybe_unused]] String const& key, [[maybe_unused]] bool value) override;
|
||||
};
|
||||
|
||||
}
|
3
Userland/Services/ConfigServer/ConfigClient.ipc
Normal file
3
Userland/Services/ConfigServer/ConfigClient.ipc
Normal file
|
@ -0,0 +1,3 @@
|
|||
endpoint ConfigClient
|
||||
{
|
||||
}
|
10
Userland/Services/ConfigServer/ConfigServer.ipc
Normal file
10
Userland/Services/ConfigServer/ConfigServer.ipc
Normal file
|
@ -0,0 +1,10 @@
|
|||
endpoint ConfigServer
|
||||
{
|
||||
read_string_value(String domain, String group, String key) => (Optional<String> value)
|
||||
read_i32_value(String domain, String group, String key) => (Optional<i32> value)
|
||||
read_bool_value(String domain, String group, String key) => (Optional<bool> value)
|
||||
|
||||
write_string_value(String domain, String group, String key, String value) =|
|
||||
write_i32_value(String domain, String group, String key, i32 value) =|
|
||||
write_bool_value(String domain, String group, String key, bool value) =|
|
||||
}
|
43
Userland/Services/ConfigServer/main.cpp
Normal file
43
Userland/Services/ConfigServer/main.cpp
Normal file
|
@ -0,0 +1,43 @@
|
|||
/*
|
||||
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include "ClientConnection.h"
|
||||
#include <LibCore/LocalServer.h>
|
||||
#include <LibCore/StandardPaths.h>
|
||||
#include <unistd.h>
|
||||
|
||||
int main(int, char**)
|
||||
{
|
||||
if (pledge("stdio accept rpath wpath cpath", nullptr) < 0) {
|
||||
perror("pledge");
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (unveil(Core::StandardPaths::config_directory().characters(), "rwc") < 0) {
|
||||
perror("unveil");
|
||||
return 1;
|
||||
}
|
||||
|
||||
unveil(nullptr, nullptr);
|
||||
|
||||
Core::EventLoop event_loop;
|
||||
auto server = Core::LocalServer::construct();
|
||||
|
||||
bool ok = server->take_over_from_system_server();
|
||||
VERIFY(ok);
|
||||
server->on_ready_to_accept = [&] {
|
||||
auto client_socket = server->accept();
|
||||
if (!client_socket) {
|
||||
dbgln("ConfigServer: accept failed.");
|
||||
return;
|
||||
}
|
||||
static int s_next_client_id = 0;
|
||||
int client_id = ++s_next_client_id;
|
||||
IPC::new_client_connection<ConfigServer::ClientConnection>(client_socket.release_nonnull(), client_id);
|
||||
};
|
||||
|
||||
return event_loop.exec();
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue