generated from PlexSheep/rs-base
feat: groundwork for the admin interface
cargo devel CI / cargo CI (push) Successful in 2m3s
Details
cargo devel CI / cargo CI (push) Successful in 2m3s
Details
This commit is contained in:
parent
50a7127e63
commit
8bd156b5fc
|
|
@ -19,6 +19,7 @@ libpt = { version = "0.7.1", features = ["cli", "log"] }
|
|||
rand = "0.8.5"
|
||||
serde = { version = "1.0.209", features = ["derive"] }
|
||||
serde_json = "1.0.128"
|
||||
tide = { version = "0.16.0", optional = true }
|
||||
tokio = { version = "1.40.0", features = [
|
||||
"macros",
|
||||
"net",
|
||||
|
|
@ -27,3 +28,7 @@ tokio = { version = "1.40.0", features = [
|
|||
"rt",
|
||||
"sync",
|
||||
] }
|
||||
|
||||
[features]
|
||||
default = ["admin-interface"]
|
||||
admin-interface = ["dep:tide"]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,244 @@
|
|||
<!doctype html>
|
||||
<html lang="en" data-bs-theme="auto">
|
||||
|
||||
<head>
|
||||
<script src="https://getbootstrap.com/docs/5.3/assets/js/color-modes.js"></script>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="description" content="">
|
||||
<meta name="author" content="Mark Otto, Jacob Thornton, and Bootstrap contributors">
|
||||
<meta name="generator" content="Hugo 0.122.0">
|
||||
<title>Starter Template · Bootstrap v5.3</title>
|
||||
|
||||
<link rel="canonical" href="https://getbootstrap.com/docs/5.3/examples/starter-template/">
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3">
|
||||
|
||||
<link href="https://getbootstrap.com/docs/5.3/dist/css/bootstrap.min.css" rel="stylesheet"
|
||||
integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
|
||||
|
||||
<!-- Favicons -->
|
||||
<!-- <link rel="apple-touch-icon" href="/docs/5.3/assets/img/favicons/apple-touch-icon.png" sizes="180x180"> -->
|
||||
<!-- <link rel="icon" href="/docs/5.3/assets/img/favicons/favicon-32x32.png" sizes="32x32" type="image/png"> -->
|
||||
<!-- <link rel="icon" href="/docs/5.3/assets/img/favicons/favicon-16x16.png" sizes="16x16" type="image/png"> -->
|
||||
<!-- <link rel="manifest" href="/docs/5.3/assets/img/favicons/manifest.json"> -->
|
||||
<!-- <link rel="mask-icon" href="/docs/5.3/assets/img/favicons/safari-pinned-tab.svg" color="#712cf9"> -->
|
||||
<!-- <link rel="icon" href="/docs/5.3/assets/img/favicons/favicon.ico"> -->
|
||||
<!-- <meta name="theme-color" content="#712cf9"> -->
|
||||
|
||||
<link rel="stylesheet" href="/styles.css">
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
|
||||
<symbol id="check2" viewBox="0 0 16 16">
|
||||
<path
|
||||
d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z" />
|
||||
</symbol>
|
||||
<symbol id="circle-half" viewBox="0 0 16 16">
|
||||
<path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z" />
|
||||
</symbol>
|
||||
<symbol id="moon-stars-fill" viewBox="0 0 16 16">
|
||||
<path
|
||||
d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z" />
|
||||
<path
|
||||
d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z" />
|
||||
</symbol>
|
||||
<symbol id="sun-fill" viewBox="0 0 16 16">
|
||||
<path
|
||||
d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z" />
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
|
||||
<button class="btn btn-bd-primary py-2 dropdown-toggle d-flex align-items-center" id="bd-theme" type="button"
|
||||
aria-expanded="false" data-bs-toggle="dropdown" aria-label="Toggle theme (auto)">
|
||||
<svg class="bi my-1 theme-icon-active" width="1em" height="1em">
|
||||
<use href="#circle-half"></use>
|
||||
</svg>
|
||||
<span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
|
||||
</button>
|
||||
<ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
|
||||
<li>
|
||||
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light"
|
||||
aria-pressed="false">
|
||||
<svg class="bi me-2 opacity-50" width="1em" height="1em">
|
||||
<use href="#sun-fill"></use>
|
||||
</svg>
|
||||
Light
|
||||
<svg class="bi ms-auto d-none" width="1em" height="1em">
|
||||
<use href="#check2"></use>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
<li>
|
||||
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="dark"
|
||||
aria-pressed="false">
|
||||
<svg class="bi me-2 opacity-50" width="1em" height="1em">
|
||||
<use href="#moon-stars-fill"></use>
|
||||
</svg>
|
||||
Dark
|
||||
<svg class="bi ms-auto d-none" width="1em" height="1em">
|
||||
<use href="#check2"></use>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
<li>
|
||||
<button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="auto"
|
||||
aria-pressed="true">
|
||||
<svg class="bi me-2 opacity-50" width="1em" height="1em">
|
||||
<use href="#circle-half"></use>
|
||||
</svg>
|
||||
Auto
|
||||
<svg class="bi ms-auto d-none" width="1em" height="1em">
|
||||
<use href="#check2"></use>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
|
||||
<symbol id="arrow-right-circle" viewBox="0 0 16 16">
|
||||
<path
|
||||
d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z" />
|
||||
</symbol>
|
||||
<symbol id="bootstrap" viewBox="0 0 118 94">
|
||||
<title>Bootstrap</title>
|
||||
<path fill-rule="evenodd" clip-rule="evenodd"
|
||||
d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z">
|
||||
</path>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<div class="col-lg-8 mx-auto p-4 py-md-5">
|
||||
<header class="d-flex align-items-center pb-3 mb-5 border-bottom">
|
||||
<a href="/" class="d-flex align-items-center text-body-emphasis text-decoration-none">
|
||||
<svg class="bi me-2" width="40" height="32">
|
||||
<use xlink:href="#bootstrap" />
|
||||
</svg>
|
||||
<span class="fs-4">Starter template</span>
|
||||
</a>
|
||||
</header>
|
||||
|
||||
<main>
|
||||
<h1 class="text-body-emphasis">{TITLE} Admin Interface</h1>
|
||||
<p class="fs-5 col-md-8">Quickly and easily get started with Bootstrap's compiled, production-ready files with
|
||||
this barebones example featuring some basic HTML and helpful links. Download all our examples to get started.
|
||||
</p>
|
||||
|
||||
<div class="mb-5">
|
||||
<a href="/docs/5.3/examples/" class="btn btn-primary btn-lg px-4">Download examples</a>
|
||||
</div>
|
||||
|
||||
<hr class="col-3 col-md-2 mb-5">
|
||||
|
||||
<div class="row g-5">
|
||||
<div class="col-md-6">
|
||||
<h2 class="text-body-emphasis">Starter projects</h2>
|
||||
<p>Ready to go beyond the starter template? Check out these open source projects that you can quickly
|
||||
duplicate to a new GitHub repository.</p>
|
||||
<ul class="list-unstyled ps-0">
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="https://github.com/twbs/examples/tree/main/icons-font" rel="noopener"
|
||||
target="_blank">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap npm starter
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="https://github.com/twbs/examples/tree/main/parcel" rel="noopener"
|
||||
target="_blank">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap Parcel starter
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="https://github.com/twbs/examples/tree/main/vite" rel="noopener"
|
||||
target="_blank">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap Vite starter
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="https://github.com/twbs/examples/tree/main/webpack" rel="noopener"
|
||||
target="_blank">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap Webpack starter
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="col-md-6">
|
||||
<h2 class="text-body-emphasis">Guides</h2>
|
||||
<p>Read more detailed instructions and documentation on using or contributing to Bootstrap.</p>
|
||||
<ul class="list-unstyled ps-0">
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="/docs/5.3/getting-started/introduction/">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap quick start guide
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="/docs/5.3/getting-started/webpack/">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap Webpack guide
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="/docs/5.3/getting-started/parcel/">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap Parcel guide
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="/docs/5.3/getting-started/vite/">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Bootstrap Vite guide
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="icon-link mb-1" href="/docs/5.3/getting-started/contribute/">
|
||||
<svg class="bi" width="16" height="16">
|
||||
<use xlink:href="#arrow-right-circle" />
|
||||
</svg>
|
||||
Contributing to Bootstrap
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
<footer class="pt-5 my-5 text-body-secondary border-top">
|
||||
Created by the Bootstrap team · © 2024
|
||||
</footer>
|
||||
</div>
|
||||
<script src="https://getbootstrap.com/docs/5.3/dist/js/bootstrap.bundle.min.js"
|
||||
integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
|
||||
crossorigin="anonymous"></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
.bd-placeholder-img {
|
||||
font-size: 1.125rem;
|
||||
text-anchor: middle;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
.bd-placeholder-img-lg {
|
||||
font-size: 3.5rem;
|
||||
}
|
||||
}
|
||||
|
||||
.b-example-divider {
|
||||
width: 100%;
|
||||
height: 3rem;
|
||||
background-color: rgba(0, 0, 0, .1);
|
||||
border: solid rgba(0, 0, 0, .15);
|
||||
border-width: 1px 0;
|
||||
box-shadow: inset 0 .5em 1.5em rgba(0, 0, 0, .1), inset 0 .125em .5em rgba(0, 0, 0, .15);
|
||||
}
|
||||
|
||||
.b-example-vr {
|
||||
flex-shrink: 0;
|
||||
width: 1.5rem;
|
||||
height: 100vh;
|
||||
}
|
||||
|
||||
.bi {
|
||||
vertical-align: -.125em;
|
||||
fill: currentColor;
|
||||
}
|
||||
|
||||
.nav-scroller {
|
||||
position: relative;
|
||||
z-index: 2;
|
||||
height: 2.75rem;
|
||||
overflow-y: hidden;
|
||||
}
|
||||
|
||||
.nav-scroller .nav {
|
||||
display: flex;
|
||||
flex-wrap: nowrap;
|
||||
padding-bottom: 1rem;
|
||||
margin-top: -1px;
|
||||
overflow-x: auto;
|
||||
text-align: center;
|
||||
white-space: nowrap;
|
||||
-webkit-overflow-scrolling: touch;
|
||||
}
|
||||
|
||||
.btn-bd-primary {
|
||||
--bd-violet-bg: #712cf9;
|
||||
--bd-violet-rgb: 112.520718, 44.062154, 249.437846;
|
||||
|
||||
--bs-btn-font-weight: 600;
|
||||
--bs-btn-color: var(--bs-white);
|
||||
--bs-btn-bg: var(--bd-violet-bg);
|
||||
--bs-btn-border-color: var(--bd-violet-bg);
|
||||
--bs-btn-hover-color: var(--bs-white);
|
||||
--bs-btn-hover-bg: #6528e0;
|
||||
--bs-btn-hover-border-color: #6528e0;
|
||||
--bs-btn-focus-shadow-rgb: var(--bd-violet-rgb);
|
||||
--bs-btn-active-color: var(--bs-btn-hover-color);
|
||||
--bs-btn-active-bg: #5a23c8;
|
||||
--bs-btn-active-border-color: #5a23c8;
|
||||
}
|
||||
|
||||
.bd-mode-toggle {
|
||||
z-index: 1500;
|
||||
}
|
||||
|
||||
.bd-mode-toggle .dropdown-menu .active .bi {
|
||||
display: block !important;
|
||||
}
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
use anyhow::Result;
|
||||
use serde;
|
||||
use tide::http::mime;
|
||||
use tide::prelude::*;
|
||||
use tide::Request;
|
||||
use tide::Response;
|
||||
|
||||
use crate::config::Config;
|
||||
use crate::vault::VaultRef;
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct Interface {
|
||||
vault: VaultRef,
|
||||
config: Config,
|
||||
}
|
||||
|
||||
pub async fn serve(vault: VaultRef, config: Config) -> Result<()> {
|
||||
let mut app = tide::with_state(Interface { vault, config });
|
||||
app.at("/").get(overview);
|
||||
app.at("/styles.css").get(styles);
|
||||
app.listen("127.0.0.1:8000").await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn overview(req: Request<Interface>) -> tide::Result {
|
||||
let r = Response::builder(200)
|
||||
.content_type(mime::HTML)
|
||||
.body(format!(
|
||||
include_str!("../../data/www/admin.html"),
|
||||
TITLE = "Wooly-Vault"
|
||||
));
|
||||
|
||||
Ok(r.into())
|
||||
}
|
||||
|
||||
async fn styles(_req: Request<Interface>) -> tide::Result {
|
||||
let r = Response::builder(200)
|
||||
.content_type(mime::CSS)
|
||||
.body(include_str!("../../data/www/styles.css"));
|
||||
Ok(r.into())
|
||||
}
|
||||
|
|
@ -21,6 +21,12 @@ pub struct C1 {
|
|||
|
||||
#[async_trait]
|
||||
impl Challenge for C1 {
|
||||
fn config(&self) -> Config {
|
||||
self.config.clone()
|
||||
}
|
||||
fn vault(&self) -> VaultRef {
|
||||
self.vault.clone()
|
||||
}
|
||||
fn new(config: Config, vault: VaultRef) -> Self {
|
||||
info!("Solution: {}", Self::solution());
|
||||
Self { config, vault }
|
||||
|
|
|
|||
|
|
@ -47,6 +47,12 @@ impl C2 {
|
|||
|
||||
#[async_trait]
|
||||
impl Challenge for C2 {
|
||||
fn config(&self) -> Config {
|
||||
self.config.clone()
|
||||
}
|
||||
fn vault(&self) -> VaultRef {
|
||||
self.vault.clone()
|
||||
}
|
||||
fn new(config: Config, vault: VaultRef) -> Self {
|
||||
info!("Solution: {}", Self::solution());
|
||||
Self { config, vault }
|
||||
|
|
|
|||
|
|
@ -207,6 +207,12 @@ impl C3 {
|
|||
|
||||
#[async_trait]
|
||||
impl Challenge for C3 {
|
||||
fn config(&self) -> Config {
|
||||
self.config.clone()
|
||||
}
|
||||
fn vault(&self) -> VaultRef {
|
||||
self.vault.clone()
|
||||
}
|
||||
fn new(config: Config, vault: VaultRef) -> Self {
|
||||
info!("Solution: {}", Self::solution());
|
||||
Self { config, vault }
|
||||
|
|
|
|||
|
|
@ -9,6 +9,9 @@ use async_trait::async_trait;
|
|||
use crate::config::Config;
|
||||
use crate::vault::VaultRef;
|
||||
|
||||
#[cfg(feature = "admin-interface")]
|
||||
pub mod admin;
|
||||
|
||||
pub mod c1;
|
||||
pub mod c2;
|
||||
pub mod c3;
|
||||
|
|
@ -21,6 +24,10 @@ pub trait Challenge
|
|||
where
|
||||
Self: Sized,
|
||||
{
|
||||
/// Getter for the [vault](VaultRef).
|
||||
fn vault(&self) -> VaultRef;
|
||||
/// Getter for the [Config].
|
||||
fn config(&self) -> Config;
|
||||
/// Creates a new instance of the challenge with the given configuration and vault.
|
||||
///
|
||||
/// # Arguments
|
||||
|
|
@ -34,7 +41,7 @@ where
|
|||
fn new(config: Config, vault: VaultRef) -> Self;
|
||||
/// Returns a list of hints for the challenge.
|
||||
///
|
||||
/// A hint is a short text to be given to the contestants in case the host thinks they need
|
||||
/// A hint is a short text to be given to the contestants in case the admin thinks they need
|
||||
/// it. The first hint is the most vague, afterwards the hints become more and more helpful.
|
||||
///
|
||||
/// # Returns
|
||||
|
|
@ -57,12 +64,42 @@ where
|
|||
///
|
||||
/// # Returns
|
||||
///
|
||||
/// A result indicating whether the challenge was successful ended.
|
||||
/// A result indicating whether the challenge was successfully served.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Will error when the challenge errors, for example when the network adress cannot be bound.
|
||||
async fn serve(self) -> anyhow::Result<()>;
|
||||
/// Serves a challenge and sets up the hint and monitoring service for the admin.
|
||||
///
|
||||
/// This method not only serves the challenge, but it also sets up a small webservice for the
|
||||
/// admin of the challenge, where they can see the hints, the solution, and the winners.
|
||||
///
|
||||
/// The admin interface will only be served when [Config::addr_admin] is set by the user.
|
||||
///
|
||||
/// Challenges should not typically implement this themselves, if they want to customize the
|
||||
/// admin interface, define [admin_interface](Self::adming_interface).
|
||||
/// The hadmin interface is not part of the challenge and just for monitoring.
|
||||
///
|
||||
/// # Returns
|
||||
///
|
||||
/// A result indicating whether the challenge and the admin interface were successfully served.
|
||||
async fn setup_and_start(self) -> anyhow::Result<()> {
|
||||
#[cfg(feature = "admin-interface")]
|
||||
if self.config().addr_admin.is_some() {
|
||||
let vault = self.vault();
|
||||
let config = self.config();
|
||||
tokio::spawn(Self::admin_interface(vault, config));
|
||||
}
|
||||
|
||||
let challenge_handle = self.serve();
|
||||
Ok(challenge_handle.await?)
|
||||
}
|
||||
#[cfg(feature = "admin-interface")]
|
||||
async fn admin_interface(vault: VaultRef, config: Config) -> anyhow::Result<()> {
|
||||
admin::serve(vault, config).await?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
/// Selects a challenge by index and serves it with the given configuration and vault.
|
||||
|
|
@ -83,9 +120,9 @@ where
|
|||
/// served errors.
|
||||
pub async fn select_and_start(index: u16, config: Config, vault: VaultRef) -> anyhow::Result<()> {
|
||||
match index {
|
||||
1 => c1::C1::new(config, vault).serve().await?,
|
||||
2 => c2::C2::new(config, vault).serve().await?,
|
||||
3 => c3::C3::new(config, vault).serve().await?,
|
||||
1 => c1::C1::new(config, vault).setup_and_start().await?,
|
||||
2 => c2::C2::new(config, vault).setup_and_start().await?,
|
||||
3 => c3::C3::new(config, vault).setup_and_start().await?,
|
||||
_ => {
|
||||
return Err(anyhow!(
|
||||
"no challenge with index {index} does currently exist"
|
||||
|
|
|
|||
|
|
@ -50,6 +50,9 @@ pub struct Config {
|
|||
pub challenge: u16,
|
||||
/// Network address to host the challenge on
|
||||
pub addr: SocketAddr,
|
||||
/// Network address to host the challenge on
|
||||
#[arg(short = 'a', long = "admin")]
|
||||
pub addr_admin: Option<SocketAddr>,
|
||||
#[command(flatten)]
|
||||
pub verbosity: VerbosityLevel,
|
||||
}
|
||||
|
|
@ -60,6 +63,7 @@ impl Default for Config {
|
|||
challenge: 1,
|
||||
addr: SocketAddr::from_str("127.0.0.1:1337").unwrap(),
|
||||
verbosity: VerbosityLevel::default(),
|
||||
addr_admin: Option::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -69,6 +73,7 @@ impl Debug for Config {
|
|||
f.debug_struct("Config")
|
||||
.field("addr", &self.addr)
|
||||
.field("verbosity", &self.verbosity.level())
|
||||
.field("admin", &self.addr_admin)
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue