0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-13 09:03:01 +01:00
construct/include/ircd/m/homeserver.h

159 lines
4.2 KiB
C++

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_M_HOMESERVER_H
namespace ircd::m
{
struct homeserver;
IRCD_M_EXCEPTION(error, NOT_MY_HOMESERVER, http::NOT_FOUND)
IRCD_M_EXCEPTION(error, NOT_A_HOMESERVER, http::SERVICE_UNAVAILABLE)
string_view origin(const homeserver &);
string_view server_name(const homeserver &);
bool origin(const homeserver &, const string_view &);
bool server_name(const homeserver &, const string_view &);
string_view public_key_id(const homeserver &);
const ed25519::sk &secret_key(const homeserver &);
bool for_each(const std::function<bool (homeserver &)> &);
bool my_origin(const string_view &origin);
bool myself(const m::user::id &);
homeserver &my(const string_view &origin);
homeserver &my(); // primary
user::id me(const string_view &origin);
user::id me(); // primary
}
struct ircd::m::homeserver
:instance_map<string_view, homeserver, std::less<>>
{
struct key;
struct cert;
struct opts;
struct conf;
/// Internal state; use m::my().
static homeserver *primary;
/// Options from the user.
const struct opts *opts;
/// Federation key related.
std::unique_ptr<struct key> key;
/// Database
std::shared_ptr<dbs::init> database;
/// An inscription of `\@ircd:network.name` to root various references to
/// a user representing the server.
m::user::id::buf self;
/// Configuration
std::unique_ptr<struct conf> conf;
/// Requested modules.
struct modules
:std::vector<string_view>
{
using std::vector<string_view>::vector;
~modules() noexcept;
}
modules;
void bootstrap();
homeserver(const struct opts *const &);
~homeserver() noexcept;
/// Factory to create homeserver with single procedure for shlib purposes.
static homeserver *init(const struct opts *);
static void fini(homeserver *) noexcept;
};
struct ircd::m::homeserver::key
{
/// Current secret key path
std::string secret_key_path;
/// Current federation public key instance
ed25519::pk public_key;
/// Current federation secret key instance
ed25519::sk secret_key;
/// Current federation public key base64
std::string public_key_b64;
/// Current ed25519:ident string
std::string public_key_id;
/// Current verify_keys (json::object) (m::keys)
std::string verify_keys;
key(const struct opts &);
key() = default;
};
struct ircd::m::homeserver::conf
{
/// !conf:origin
m::room::id::buf room_id;
/// Convenience
m::room room;
/// Register the conf item init callback //TODO: XXX
decltype(ircd::conf::on_init)::callback item_init;
/// Register the !conf room item message hook.
hookfn<vm::eval &> conf_updated;
// Interface
bool get(const string_view &key, const std::function<void (const string_view &)> &) const;
event::id::buf set(const string_view &key, const string_view &val) const;
size_t defaults(const string_view &prefix = {}) const;
size_t load(const string_view &prefix = {}) const;
size_t store(const string_view &prefix = {}, const bool &force = false) const;
conf(const struct opts &);
};
struct ircd::m::homeserver::opts
{
/// Network name. This is the mxid hostpart (i.e `\@user:origin`).
string_view origin;
/// This server's name. This is the unique domain-name of this server
/// participating in the cluster to serve the origin. The servername may
/// be the origin itself; otherwise, SRV/well-known indirection is required
/// to reach the servername starting from the origin.
string_view server_name;
/// When instantiating a homeserver with a fresh database, the file found
/// at this path can supplement for any initial bootstrapping. This vector
/// may contain additional events as well; the server will continue its
/// operation after having processed these events.
string_view bootstrap_vector_path;
/// Whether to run initial backfill jobs after startup.
bool backfill {true};
/// Whether to permit automatic execution of managed apps.
bool autoapps {true};
};