184 Commits

Author SHA1 Message Date
00d33c2c69 remove arm64 pipeline [CI SKIP]
All checks were successful
continuous-integration/drone/pr Build is passing
2022-04-15 10:22:39 +02:00
126609a605 try arm64 ci only
Some checks reported errors
continuous-integration/drone/push Build was killed
2022-04-15 10:16:55 +02:00
e4078bd1ba specify triggers twice
Some checks reported errors
continuous-integration/drone/push Build was killed
2022-04-15 09:48:39 +02:00
4662b15ba3 remove unnecessary to_owned
Some checks reported errors
continuous-integration/drone/push Build was killed
2022-04-07 14:20:41 +02:00
abde4ce1b4 only specify triggers once
Some checks reported errors
continuous-integration/drone/push Build was killed
continuous-integration/drone/pr Build was killed
2022-04-06 12:07:45 +02:00
c792aea2f6 add build step and arm64 pipeline
Some checks reported errors
continuous-integration/drone/push Build was killed
2022-04-06 11:55:00 +02:00
b158fba147 separate ci pipeline into discreet steps
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 11:44:14 +02:00
da8d8f0ec3 add rustfmt and cargo check to ci pipeline
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 11:37:11 +02:00
271aa14322 add build status badge to root readme
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 11:33:52 +02:00
d31825f688 add tests to ci and fail on clippy warnings
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 11:13:31 +02:00
defb8f5f09 try to fix probes build issue again
All checks were successful
continuous-integration/drone/push Build is passing
2022-04-06 10:55:41 +02:00
27e9a8295c update probes and lockfile to fix time build error
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 10:50:37 +02:00
9ad580b86f install clippy in pipeline
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 10:43:35 +02:00
a76ec08da6 move drone config to repo root and add triggers
Some checks failed
continuous-integration/drone/push Build is failing
2022-04-06 10:36:10 +02:00
cf64cd9c76 add drone ci config with clippy for amd64 2022-04-06 10:32:12 +02:00
169149d607 Merge pull request 'Replace absolute paths with relative paths for system command calls' (#100) from fix_sys_cmd_paths into main
Reviewed-on: #100
2022-04-06 08:17:41 +00:00
f1eaa07f7b replace absolute paths with relative paths for system command calls 2022-04-06 10:13:52 +02:00
52c3e88b44 Merge pull request 'Fix Scuttlebutt Status page title' (#99) from fix_status_title into main
Reviewed-on: #99
2022-04-06 08:04:59 +00:00
e659102495 update body template comment 2022-04-06 09:59:17 +02:00
57b1a786a4 fix status page title 2022-04-06 09:57:32 +02:00
fded48908d Merge pull request 'Replace Rocket and Tera with Rouille and Maud' (#88) from rouille_maud into main
Reviewed-on: #88
2022-03-25 08:07:15 +00:00
46ded85feb resolve merge conflicts 2022-03-25 10:06:00 +02:00
f29659669c add route to handle resetting default sbot config 2022-03-25 09:39:06 +02:00
d6695b291d tweak no-peers element 2022-03-25 09:26:44 +02:00
aefa1525fb clarify missing name and description 2022-03-25 09:19:43 +02:00
367f0307b6 autofocus password input 2022-03-25 09:19:28 +02:00
b1c5c701e5 reduce specificity of peach-lib dependencies 2022-03-25 08:45:10 +02:00
2ae9cb5c48 remove ellipsis label class width 2022-03-25 08:43:32 +02:00
30aff5d7ac add clarity to empty peers list message 2022-03-25 08:43:15 +02:00
25e3a145fc fix alt attribute for logout icon 2022-03-24 13:42:02 +02:00
0bfad25d3d add follow, unfollow, block and unblock routes and sbot helper functions 2022-03-24 13:41:49 +02:00
952951515b update readme 2022-03-24 09:43:31 +02:00
c65f568e40 authenticate session if disable_auth env var is true 2022-03-24 09:43:25 +02:00
979ec4eb64 reintroduce logging statements 2022-03-24 09:27:06 +02:00
d9019d6a4b update git ignore and remove outdated code 2022-03-24 09:19:39 +02:00
07147f8a4f remove rocket config, context and tests 2022-03-24 09:13:25 +02:00
5fc0094146 remove tera templates 2022-03-24 09:11:26 +02:00
50afb61955 update dependencies and bump minor version 2022-03-24 09:09:08 +02:00
928afb35d3 update application configuration 2022-03-24 09:07:43 +02:00
1bdacf3632 add application configuration to replace Rocket.toml 2022-03-24 09:05:53 +02:00
deaedc4428 add temporary password reset routes 2022-03-24 09:05:26 +02:00
4a94f14dc5 update golgi dependency to use git path 2022-03-23 14:59:33 +02:00
b78fafe84d update dependencies 2022-03-23 14:56:44 +02:00
5d37c12913 implement authentication with separate public and private routers 2022-03-23 14:56:31 +02:00
3a05396afb mount blobstore and add theme support for all routes 2022-03-23 11:41:47 +02:00
41bd39d422 add themes, add public and private msg publishing 2022-03-23 11:41:21 +02:00
77c1ccb1c7 add form handler and helper for sbot config updates 2022-03-23 09:14:54 +02:00
7d9bc2d7cd reduce code repetition with class splices 2022-03-22 16:13:50 +02:00
b20822a644 satisfy clippy 2022-03-22 16:13:34 +02:00
65f0ac7630 update flash message class width 2022-03-22 16:12:47 +02:00
703f35d8b1 add profile_update module 2022-03-22 16:12:28 +02:00
084af1b486 add profile update template and route handler 2022-03-22 16:11:52 +02:00
3e918f66cf fix error flash value 2022-03-22 16:11:13 +02:00
98121f4922 use splices for rendering and url-encode the public key link 2022-03-21 16:43:22 +02:00
e19fa0f99d import profile module 2022-03-21 16:42:16 +02:00
3a7b499742 use splices for template rendering 2022-03-21 16:41:52 +02:00
85231a20c7 add profile template and route handler 2022-03-21 16:40:54 +02:00
602c6a90f1 use class splices to reduce code repetition 2022-03-21 15:17:16 +02:00
34b4cbff32 add search and invite templates and route handlers 2022-03-21 13:27:32 +02:00
112cfca67b add url comment 2022-03-21 13:26:32 +02:00
a379de179d add sbot error template 2022-03-21 11:17:42 +02:00
0353586705 add friends, follows and blocks route handlers and templates 2022-03-21 11:17:30 +02:00
4e8d93c388 move routes to the router 2022-03-20 17:17:17 +02:00
6db5e7c169 add routes and helpers for starting, stopping and restarting the sbot 2022-03-20 16:38:32 +02:00
60539adf41 add max-age and date for flash cookies 2022-03-20 16:37:53 +02:00
e8b9cb2cc1 remove default rouille features 2022-03-20 15:37:02 +02:00
cad3fc94c8 update theme import 2022-03-20 15:36:37 +02:00
976fac973d add flash messages to admin settings and auth routes 2022-03-20 15:36:24 +02:00
cd7c2bc230 move sbot helper functions to utils 2022-03-20 12:28:08 +02:00
40c4f8aaf2 implement flash cookies for auth change routes 2022-03-20 12:27:00 +02:00
70f7ad0dc6 add sbot utils, move theme utils and add flash message trait 2022-03-20 12:26:04 +02:00
31628a7155 remove old scuttlebutt routes file 2022-03-18 11:33:27 +02:00
3c49c067dd fix big circle background colour when sbot status is failed 2022-03-18 11:33:10 +02:00
729580729c add scuttlebutt peers menu and inactive template 2022-03-18 11:32:51 +02:00
59739cf6e5 further refinement of the sbot status page 2022-03-18 11:30:59 +02:00
7fe919d9a1 refine sbot status pattern matching 2022-03-18 11:25:53 +02:00
7cdf8c553d complete scuttlebutt status route 2022-03-17 16:30:26 +02:00
fe04195030 update lockfile and remove old auth routes file 2022-03-17 11:02:04 +02:00
8455e8089c add base templates, settings routes and auth routes 2022-03-17 11:01:36 +02:00
97206e0573 add links for submitting bug reports and feature suggestions 2022-03-14 11:17:54 +02:00
7acf6ef395 tiny wording change to bug issue template 2022-03-14 11:11:08 +02:00
3828998769 Merge pull request 'Add feature suggestion template' (#87) from bug_report_template into main
Reviewed-on: #87
2022-03-14 09:09:46 +00:00
440d6f9bd5 add feature suggestion template 2022-03-14 11:08:32 +02:00
59a6c7fdca Merge pull request 'Move issue template to repo root' (#86) from bug_report_template into main
Reviewed-on: #86
2022-03-14 08:27:19 +00:00
3a4b0ffffd move issue template to repo root 2022-03-14 10:26:23 +02:00
447f81a41c Merge pull request 'Add issue template for bug reporting' (#85) from bug_report_template into main
Reviewed-on: #85
2022-03-14 08:23:01 +00:00
fadad1c30b formatting 2022-03-14 10:21:50 +02:00
6395fb05e3 add issue template for bug reporting 2022-03-14 10:20:40 +02:00
d652f1a020 tiny guide typo and bold fixes 2022-03-14 10:12:44 +02:00
7c98cfcd5d add admin menu and config routes; start thinking about flash msgs 2022-03-14 09:17:31 +02:00
4a1d3e81c1 Merge pull request 'Fix and improve all login and password-related workflows' (#83) from fix_login_flows into main
Reviewed-on: #83
2022-03-13 09:14:06 +00:00
5a07eda910 update golgi dependency path 2022-03-13 11:12:12 +02:00
580771ebf2 update notes and add sbot settings config route to router 2022-03-13 11:09:39 +02:00
c794d398b8 add sbot settings config route 2022-03-13 11:09:00 +02:00
4d06eb167f incomplete sbot config route 2022-03-12 10:36:40 +02:00
eba15605c2 add scuttlebutt settings menu 2022-03-11 15:33:04 +02:00
07c18ea64d create settings menu route and move home route 2022-03-11 14:28:31 +02:00
ec288658f3 implement basic config 2022-03-11 14:27:40 +02:00
6b145d66f8 add basic application config and parser 2022-03-11 10:19:00 +02:00
23d6870f77 home template is working 2022-03-10 11:09:26 +02:00
b7cf3c1aab fix a test and update guide links 2022-03-09 13:04:44 +02:00
5b70353d6f update readme 2022-03-08 10:53:06 +02:00
67c727716c fix dark theme styling and button widths 2022-03-07 12:02:03 +02:00
5ab47cf742 made select css classes wider 2022-03-07 11:36:49 +02:00
b092f1e1c4 minor wording change for temporary password request 2022-03-07 11:36:24 +02:00
983aa0689c improve messaging for when sbot is inactive 2022-03-07 11:36:03 +02:00
1a8ac3f57f change help to guide and add text 2022-03-07 11:35:19 +02:00
af34829cb0 add reset password option to admin menu 2022-03-07 11:34:10 +02:00
824cbdbc0c save default peachcloud config if file does not exist 2022-03-07 11:26:52 +02:00
84656ff251 set default password 2022-03-07 11:26:13 +02:00
6cdd6dc41b remove unnecessary serde derivations, state-based remplate rendering, styling improvements 2022-03-04 10:58:50 +02:00
3572fd4e7b remove password hash logging 2022-03-04 10:56:07 +02:00
7fdf88eaa8 fix and improve all login and password-related workflows 2022-03-04 10:53:49 +02:00
10049f0bc6 Merge pull request 'Integrate golgi into peach_web' (#81) from golgi_integration into main
Reviewed-on: #81
2022-03-03 07:37:23 +00:00
486518002d add latest lockfile 2022-03-03 09:36:48 +02:00
3991af11c7 only render private if sbot is active, fix type in profile 2022-03-03 09:34:30 +02:00
59ef5960a4 reduce code repetition 2022-03-03 09:33:45 +02:00
69a8cc262e renamed context file 2022-03-03 08:55:58 +02:00
1479a65d59 rename sbot context module to match all scuttlebutt.rs files 2022-03-03 08:55:37 +02:00
ffe190148d minor css tweaks 2022-03-02 15:24:40 +02:00
b1724f6eb4 update sbot status context and add latest seq num 2022-03-02 15:24:05 +02:00
9a07ab3ac0 add query param for private msgs 2022-03-02 13:51:02 +02:00
06a55ade06 remove blob rendering for blocked peers 2022-03-02 13:35:21 +02:00
6cba477f15 add private message publishing 2022-03-02 11:57:10 +02:00
020d18731b add block list and implement (un)follow and (un)block 2022-03-02 08:58:54 +02:00
a38394054d implement peer search with key validation 2022-03-01 10:53:45 +02:00
814162ce7d update friends list handler and remove followers 2022-02-28 16:25:31 +02:00
03028a2278 add context builder for friends list 2022-02-28 16:25:06 +02:00
e10468c337 add basic peer lookup, improve follows and profile route handlers 2022-02-28 16:08:05 +02:00
436a516c3e add conditional rendering for profile and peers list 2022-02-28 16:06:52 +02:00
786e3f41d9 add utility to check blobstore for file 2022-02-28 16:05:53 +02:00
a491892bd9 assign public key id to profile context 2022-02-25 10:49:37 +02:00
02a1078ece make profile capsule border pink 2022-02-25 09:10:09 +02:00
6d2502257d add profile image uploader and blob saver 2022-02-25 09:09:41 +02:00
ebbcc35fbb add deps for base64 and temp dir creation 2022-02-25 09:09:07 +02:00
e3eb3be2e3 use local blobstore path util function 2022-02-25 09:08:48 +02:00
799d9de001 add io error variant and blob writer function 2022-02-25 09:08:21 +02:00
e05de8284d get profile image blob path and render in template 2022-02-23 11:54:34 +02:00
9013ccb3d6 determine blobstore path and mount blob file server 2022-02-23 11:54:08 +02:00
a37288225a remove decimal from memory and blobstore size 2022-02-23 10:22:52 +02:00
4665a9e6fa fix icon permissions; remove executable 2022-02-23 10:22:21 +02:00
1a3ddccbd6 add invite creation and display 2022-02-23 10:21:58 +02:00
fe1da62058 add template for profile update form 2022-02-11 10:32:59 +02:00
68c926609e routes and logic for profiles and publishing name, description and post 2022-02-11 10:32:39 +02:00
17ea3e7f44 add golgi dependency and error variant 2022-02-11 10:31:31 +02:00
a174027ff5 add context builders for sbot 2022-02-11 10:31:07 +02:00
f459fe47d1 add display for warning flash msgs 2022-02-11 10:30:27 +02:00
4709ec77f9 Merge pull request 'Introduce theme support (plus blobstore size)' (#80) from theme_support into main
Reviewed-on: #80
2022-02-07 07:56:30 +00:00
4e6bb15a23 update templates to use theme variables and classes 2022-02-03 16:31:17 +02:00
62191e5509 theme icons and updated hermies icons 2022-02-03 16:30:26 +02:00
da976ff4fe introduce theme attributes and variables 2022-02-03 16:29:53 +02:00
0737c435a8 add theme setter and getter, update route handlers 2022-02-03 16:29:20 +02:00
435e819648 add blobstore size lookup for sbot status 2022-02-03 16:27:20 +02:00
8f49fa55ad Merge pull request 'Add configuration reading and writing for go-sbot' (#79) from sbot_config into main
Reviewed-on: #79
2022-02-03 08:09:03 +00:00
f6292407d0 add save and restart option for config form 2022-02-02 16:32:10 +02:00
dfc173d941 add clarity about need for restart after config update 2022-02-02 16:20:30 +02:00
a46b58b206 add repair fs config option 2022-02-02 14:49:36 +02:00
33604ac0dc change form width for better mobile styling 2022-02-02 14:49:14 +02:00
f0d972f46b add repair parameter to SbotConfig 2022-02-02 14:48:39 +02:00
89b502be25 add configuration routes for the sbot 2022-02-02 14:14:12 +02:00
90a90096f4 remove option type wrappers and implement defaults for SbotConfig 2022-02-02 14:13:02 +02:00
46926bf468 add config writer method and required error variants 2022-02-01 16:07:19 +02:00
d801c957bd introduce sbot status data 2022-02-01 10:06:45 +02:00
3397e5eb75 add config file reader for go-sbot 2022-02-01 10:03:46 +02:00
e474ea519f Merge pull request 'Start and stop go-sbot process' (#78) from sbot_process_start_stop into main
Reviewed-on: #78
2022-01-27 09:24:58 +00:00
f715644e25 display system startup mode 2022-01-27 11:01:12 +02:00
c7cc310a32 add form element to enable / disable running go-sbot on startup 2022-01-27 10:57:21 +02:00
4470f949bd add ability to stop, start and restart go-sbot process 2022-01-27 10:56:39 +02:00
8e5c29ca6d add sbot stats to home template and set inner circle colour accordingly 2022-01-27 10:55:44 +02:00
00554706cb add go-sbot enabled / disabled check 2022-01-27 10:55:04 +02:00
6d9ced5ebc Merge pull request 'Improve Scuttlebutt status page' (#77) from add_sbot_status into main
Reviewed-on: #77
2022-01-26 10:10:49 +00:00
abda4373ae conditional font colour rendering 2022-01-26 12:10:28 +02:00
e718889485 update sbot status page and add live data retrieval 2022-01-26 11:48:34 +02:00
b7ec1a42be conditionally render network settings button 2022-01-26 11:47:44 +02:00
445c05e3ee style horizontal lines 2022-01-26 11:46:49 +02:00
476eaa540e add managed state for conditional template element rendering 2022-01-26 11:46:14 +02:00
6f03063f8d add managed state for conditional template element rendering 2022-01-26 11:45:59 +02:00
de9b8f5d73 serialize sbot stat struct 2022-01-26 11:45:25 +02:00
51eff6a298 add sbot status-related icons 2022-01-26 11:44:25 +02:00
1c90e45f11 merge latest changes from main 2022-01-25 11:48:32 +02:00
178af281ed Merge pull request 'Retrieve go-sbot systemd process statistics' (#76) from sbot_stats into main
Reviewed-on: #76
2022-01-25 09:46:50 +00:00
e1aa7b1bb6 add sbot docs and bump version 2022-01-25 11:39:28 +02:00
816d6c8a73 add sbot process stats function, struct and error variants 2022-01-25 11:36:24 +02:00
b098f73a5f Merge pull request 'Load values from Rocket.toml into managed state' (#74) from rocket_config into main
Reviewed-on: #74
2022-01-25 09:35:39 +00:00
138 changed files with 7670 additions and 5229 deletions

34
.drone.yml Normal file
View File

@ -0,0 +1,34 @@
kind: pipeline
type: docker
name: test-on-amd64
platform:
arch: amd64
steps:
- name: rustfmt
image: rust:buster
commands:
- rustup component add rustfmt
- cargo fmt --check
- name: clippy
image: rust:buster
commands:
- rustup component add clippy
- cargo clippy -- -D warnings
- name: test
image: rust:buster
commands:
- cargo test
- name: build
image: rust:buster
commands:
- cargo build
trigger:
event:
- push
- pull_request

2314
Cargo.lock generated

File diff suppressed because it is too large Load Diff

View File

@ -4,6 +4,8 @@ _Better [Scuttlebutt](https://scuttlebutt.nz) cloud infrastructure as a hardware
[**_Support us on OpenCollective!_**](https://opencollective.com/peachcloud)
[![Build Status](https://build.coopcloud.tech/api/badges/PeachCloud/peach-workspace/status.svg?ref=refs/heads/main)](https://build.coopcloud.tech/PeachCloud/peach-workspace)
## Background
- April 2018 project proposal: [`%HqwAsltORROCh4uyOq6iV+SsqU3OuNUevnq+5dwCqVI=.sha256`](https://viewer.scuttlebot.io/%25HqwAsltORROCh4uyOq6iV%2BSsqU3OuNUevnq%2B5dwCqVI%3D.sha256)
@ -56,4 +58,4 @@ _Better [Scuttlebutt](https://scuttlebutt.nz) cloud infrastructure as a hardware
- [GitHub](https://github.com/peachcloud)
- [Twitter](https://twitter.com/peachcloudorg)
- [Email](mailto:peachcloudorg@gmail.com)
- [OpenCollective](https://opencollective.com/peachcloud)
- [OpenCollective](https://opencollective.com/peachcloud)

View File

@ -0,0 +1,34 @@
---
name: "Bug Report Template"
about: "This template is for submitting bugs."
title: "[BUG] "
ref: "main"
labels:
- bug
- "help needed"
---
> Please fill out the sections below.
> Be kind and objective when writing in text.
> Thanks for the report! :)
**Brief description of the bug:**
**Steps to reproduce the bug:**
**Expected behaviour:**
**Technical details:**
_Is peach-web running on an x86-64 or arm64 machine?_
_What operating system distribution is it running on?_

View File

@ -0,0 +1,15 @@
---
name: "Feature Suggestion Template"
about: "This template is for submitting feature suggestions."
title: "[FEATURE] "
ref: "main"
labels:
- enhancement
---
**Brief description of the feature you'd like to suggest:**

View File

@ -47,8 +47,8 @@ pub fn update_microservices() -> Result<(), PeachConfigError> {
cmd(&["apt-get", "update"])?;
// filter out peach-config from list of services
let services_to_update: Vec<&str> = SERVICES
.to_vec()
.into_iter()
.iter()
.copied()
.filter(|&x| x != "peach-config")
.collect();

View File

@ -5,15 +5,19 @@ authors = ["Andrew Reid <glyph@mycelial.technology>"]
edition = "2018"
[dependencies]
chrono = "0.4.19"
fslock="0.1.6"
async-std = "1.10"
chrono = "0.4"
dirs = "4.0"
fslock="0.1"
golgi = { git = "https://git.coopcloud.tech/golgi-ssb/golgi" }
jsonrpc-client-core = "0.5"
jsonrpc-client-http = "0.5"
jsonrpc-core = "8.0.1"
jsonrpc-core = "8.0"
log = "0.4"
nanorand = "0.6.1"
nanorand = "0.6"
regex = "1"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
serde_yaml = "0.8"
sha3 = "0.10.0"
toml = "0.5"
sha3 = "0.10"

View File

@ -1,12 +1,14 @@
//! Interfaces for writing and reading PeachCloud configurations, stored in yaml.
//!
//! Different PeachCloud microservices import peach-lib, so that they can share this interface.
//! Different PeachCloud microservices import peach-lib, so that they can share
//! this interface.
//!
//! The configuration file is located at: "/var/lib/peachcloud/config.yml"
use std::fs;
use fslock::LockFile;
use log::debug;
use serde::{Deserialize, Serialize};
use crate::error::PeachError;
@ -49,7 +51,7 @@ pub struct PeachConfig {
}
// helper functions for serializing and deserializing PeachConfig from disc
fn save_peach_config(peach_config: PeachConfig) -> Result<PeachConfig, PeachError> {
pub fn save_peach_config(peach_config: PeachConfig) -> Result<PeachConfig, PeachError> {
// use a file lock to avoid race conditions while saving config
let mut lock = LockFile::open(LOCK_FILE_PATH)?;
lock.lock()?;
@ -72,6 +74,7 @@ pub fn load_peach_config() -> Result<PeachConfig, PeachError> {
let peach_config_exists = std::path::Path::new(YAML_PATH).exists();
let peach_config: PeachConfig = if !peach_config_exists {
debug!("Loading peach config: {} does not exist", YAML_PATH);
PeachConfig {
external_domain: "".to_string(),
dyn_domain: "".to_string(),
@ -81,12 +84,14 @@ pub fn load_peach_config() -> Result<PeachConfig, PeachError> {
dyn_tsig_key_path: "".to_string(),
dyn_enabled: false,
ssb_admin_ids: Vec::new(),
admin_password_hash: "".to_string(),
// default password is `peach`
admin_password_hash: "146".to_string(),
temporary_password_hash: "".to_string(),
}
}
// otherwise we load peach config from disk
else {
debug!("Loading peach config: {} exists", YAML_PATH);
let contents = fs::read_to_string(YAML_PATH).map_err(|source| PeachError::Read {
source,
path: YAML_PATH.to_string(),

View File

@ -99,7 +99,7 @@ pub fn is_domain_available(domain: &str) -> std::result::Result<bool, PeachError
/// Helper function to get public ip address of PeachCloud device.
fn get_public_ip_address() -> Result<String, PeachError> {
// TODO: consider other ways to get public IP address
let output = Command::new("/usr/bin/curl").arg("ifconfig.me").output()?;
let output = Command::new("curl").arg("ifconfig.me").output()?;
let command_output = String::from_utf8(output.stdout)?;
Ok(command_output)
}
@ -127,7 +127,7 @@ pub fn dyndns_update_ip() -> Result<bool, PeachError> {
Ok(false)
} else {
// call nsupdate passing appropriate configs
let mut nsupdate_command = Command::new("/usr/bin/nsupdate");
let mut nsupdate_command = Command::new("nsupdate");
nsupdate_command
.arg("-k")
.arg(&peach_config.dyn_tsig_key_path)

View File

@ -7,6 +7,9 @@ use std::{io, str, string};
/// This type represents all possible errors that can occur when interacting with the PeachCloud library.
#[derive(Debug)]
pub enum PeachError {
/// Represents a failure to determine the path of the user's home directory.
HomeDir,
/// Represents all other cases of `std::io::Error`.
Io(io::Error),
@ -58,15 +61,18 @@ pub enum PeachError {
/// Represents a failure to parse or compile a regular expression.
Regex(regex::Error),
/// Represents a failure to successfully execute an sbot command.
SbotCli {
/// The `stderr` output from the sbot command.
msg: String,
},
/// Represents a failure to successfully execute an sbot command (via golgi).
Sbot(String),
/// Represents a failure to serialize or deserialize JSON.
SerdeJson(serde_json::error::Error),
/// Represents a failure to deserialize TOML.
TomlDeser(toml::de::Error),
/// Represents a failure to serialize TOML.
TomlSer(toml::ser::Error),
/// Represents a failure to serialize or deserialize YAML.
SerdeYaml(serde_yaml::Error),
@ -87,7 +93,7 @@ pub enum PeachError {
Write {
/// The underlying source of the error.
source: io::Error,
/// The file path for the write attemp.
/// The file path for the write attempt.
path: String,
},
}
@ -95,6 +101,7 @@ pub enum PeachError {
impl std::error::Error for PeachError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match *self {
PeachError::HomeDir => None,
PeachError::Io(_) => None,
PeachError::JsonRpcClientCore(_) => None,
PeachError::JsonRpcCore(_) => None,
@ -107,10 +114,12 @@ impl std::error::Error for PeachError {
PeachError::PasswordNotSet => None,
PeachError::Read { ref source, .. } => Some(source),
PeachError::Regex(_) => None,
PeachError::SbotCli { .. } => None,
PeachError::Sbot(_) => None,
PeachError::SerdeJson(_) => None,
PeachError::SerdeYaml(_) => None,
PeachError::SsbAdminIdNotFound { .. } => None,
PeachError::TomlDeser(_) => None,
PeachError::TomlSer(_) => None,
PeachError::Utf8ToStr(_) => None,
PeachError::Utf8ToString(_) => None,
PeachError::Write { ref source, .. } => Some(source),
@ -121,6 +130,12 @@ impl std::error::Error for PeachError {
impl std::fmt::Display for PeachError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match *self {
PeachError::HomeDir => {
write!(
f,
"Unable to determine the path of the user's home directory"
)
}
PeachError::Io(ref err) => err.fmt(f),
PeachError::JsonRpcClientCore(ref err) => err.fmt(f),
PeachError::JsonRpcCore(ref err) => {
@ -135,22 +150,19 @@ impl std::fmt::Display for PeachError {
write!(f, "Date/time parse error: {}", path)
}
PeachError::PasswordIncorrect => {
write!(f, "Password error: user-supplied password is incorrect")
write!(f, "password is incorrect")
}
PeachError::PasswordMismatch => {
write!(f, "Password error: user-supplied passwords do not match")
write!(f, "passwords do not match")
}
PeachError::PasswordNotSet => {
write!(
f,
"Password error: hash value in YAML configuration file is empty"
)
write!(f, "hash value in YAML configuration file is empty")
}
PeachError::Read { ref path, .. } => {
write!(f, "Read error: {}", path)
}
PeachError::Regex(ref err) => err.fmt(f),
PeachError::SbotCli { ref msg } => {
PeachError::Sbot(ref msg) => {
write!(f, "Sbot error: {}", msg)
}
PeachError::SerdeJson(ref err) => err.fmt(f),
@ -158,6 +170,8 @@ impl std::fmt::Display for PeachError {
PeachError::SsbAdminIdNotFound { ref id } => {
write!(f, "Config error: SSB admin ID `{}` not found", id)
}
PeachError::TomlDeser(ref err) => err.fmt(f),
PeachError::TomlSer(ref err) => err.fmt(f),
PeachError::Utf8ToStr(ref err) => err.fmt(f),
PeachError::Utf8ToString(ref err) => err.fmt(f),
PeachError::Write { ref path, .. } => {
@ -209,6 +223,18 @@ impl From<serde_yaml::Error> for PeachError {
}
}
impl From<toml::de::Error> for PeachError {
fn from(err: toml::de::Error) -> PeachError {
PeachError::TomlDeser(err)
}
}
impl From<toml::ser::Error> for PeachError {
fn from(err: toml::ser::Error) -> PeachError {
PeachError::TomlSer(err)
}
}
impl From<str::Utf8Error> for PeachError {
fn from(err: str::Utf8Error) -> PeachError {
PeachError::Utf8ToStr(err)

View File

@ -4,7 +4,7 @@ pub mod error;
pub mod network_client;
pub mod oled_client;
pub mod password_utils;
pub mod sbot_client;
pub mod sbot;
pub mod stats_client;
// re-export error types

View File

@ -1,7 +1,10 @@
use async_std::task;
use golgi::Sbot;
use log::debug;
use nanorand::{Rng, WyRand};
use sha3::{Digest, Sha3_256};
use crate::{config_manager, error::PeachError, sbot_client};
use crate::{config_manager, error::PeachError, sbot::SbotConfig};
/// Returns Ok(()) if the supplied password is correct,
/// and returns Err if the supplied password is incorrect.
@ -83,7 +86,7 @@ pub fn send_password_reset() -> Result<(), PeachError> {
"Your new temporary password is: {}
If you are on the same WiFi network as your PeachCloud device you can reset your password \
using this link: http://peach.local/reset_password",
using this link: http://peach.local/auth/reset",
temporary_password
);
// if there is an external domain, then include remote link in message
@ -92,7 +95,7 @@ using this link: http://peach.local/reset_password",
Some(domain) => {
format!(
"\n\nOr if you are on a different WiFi network, you can reset your password \
using the the following link: {}/reset_password",
using the the following link: {}/auth/reset",
domain
)
}
@ -102,7 +105,37 @@ using this link: http://peach.local/reset_password",
// finally send the message to the admins
let peach_config = config_manager::load_peach_config()?;
for ssb_admin_id in peach_config.ssb_admin_ids {
sbot_client::private_message(&msg, &ssb_admin_id)?;
// use golgi to send a private message on scuttlebutt
match task::block_on(publish_private_msg(&msg, &ssb_admin_id)) {
Ok(_) => (),
Err(e) => return Err(PeachError::Sbot(e)),
}
}
Ok(())
}
async fn publish_private_msg(msg: &str, recipient: &str) -> Result<(), String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
let msg = msg.to_string();
let recipient = vec![recipient.to_string()];
// initialise sbot connection with ip:port and shscap from config file
let mut sbot_client = match sbot_config {
// TODO: panics if we pass `Some(conf.shscap)` as second arg
Some(conf) => {
let ip_port = conf.lis.clone();
Sbot::init(Some(ip_port), None)
.await
.map_err(|e| e.to_string())?
}
None => Sbot::init(None, None).await.map_err(|e| e.to_string())?,
};
debug!("Publishing a Scuttlebutt private message with temporary password");
match sbot_client.publish_private(msg, recipient).await {
Ok(_) => Ok(()),
Err(e) => Err(format!("Failed to publish private message: {}", e)),
}
}

235
peach-lib/src/sbot.rs Normal file
View File

@ -0,0 +1,235 @@
//! Data types and associated methods for monitoring and configuring go-sbot.
use std::{fs, fs::File, io, io::Write, path::PathBuf, process::Command, str};
use serde::{Deserialize, Serialize};
use crate::error::PeachError;
/* HELPER FUNCTIONS */
// iterate over the given directory path to determine the size of the directory
fn dir_size(path: impl Into<PathBuf>) -> io::Result<u64> {
fn dir_size(mut dir: fs::ReadDir) -> io::Result<u64> {
dir.try_fold(0, |acc, file| {
let file = file?;
let size = match file.metadata()? {
data if data.is_dir() => dir_size(fs::read_dir(file.path())?)?,
data => data.len(),
};
Ok(acc + size)
})
}
dir_size(fs::read_dir(path.into())?)
}
/* SBOT-RELATED TYPES AND METHODS */
/// go-sbot process status.
#[derive(Debug, Serialize, Deserialize)]
pub struct SbotStatus {
/// Current process state.
pub state: Option<String>,
/// Current process boot state.
pub boot_state: Option<String>,
/// Current process memory usage in bytes.
pub memory: Option<u32>,
/// Uptime for the process (if state is `active`).
pub uptime: Option<String>,
/// Downtime for the process (if state is `inactive`).
pub downtime: Option<String>,
/// Size of the blobs directory in bytes.
pub blobstore: Option<u64>,
}
/// Default builder for `SbotStatus`.
impl Default for SbotStatus {
fn default() -> Self {
Self {
state: None,
boot_state: None,
memory: None,
uptime: None,
downtime: None,
blobstore: None,
}
}
}
impl SbotStatus {
/// Retrieve statistics for the go-sbot systemd process by querying `systemctl`.
pub fn read() -> Result<Self, PeachError> {
let mut status = SbotStatus::default();
let info_output = Command::new("systemctl")
.arg("--user")
.arg("show")
.arg("go-sbot.service")
.arg("--no-page")
.output()?;
let service_info = std::str::from_utf8(&info_output.stdout)?;
for line in service_info.lines() {
if line.starts_with("ActiveState=") {
if let Some(state) = line.strip_prefix("ActiveState=") {
status.state = Some(state.to_string())
}
} else if line.starts_with("MemoryCurrent=") {
if let Some(memory) = line.strip_prefix("MemoryCurrent=") {
status.memory = memory.parse().ok()
}
}
}
let status_output = Command::new("systemctl")
.arg("--user")
.arg("status")
.arg("go-sbot.service")
.output()?;
let service_status = str::from_utf8(&status_output.stdout)?;
//.map_err(PeachError::Utf8ToStr)?;
for line in service_status.lines() {
// example of the output line we're looking for:
// `Loaded: loaded (/home/glyph/.config/systemd/user/go-sbot.service; enabled; vendor
// preset: enabled)`
if line.contains("Loaded:") {
let before_boot_state = line.find(';');
let after_boot_state = line.rfind(';');
if let (Some(start), Some(end)) = (before_boot_state, after_boot_state) {
// extract the enabled / disabled from the `Loaded: ...` line
// using the index of the first ';' + 2 and the last ';'
status.boot_state = Some(line[start + 2..end].to_string());
}
// example of the output line we're looking for here:
// `Active: active (running) since Mon 2022-01-24 16:22:51 SAST; 4min 14s ago`
} else if line.contains("Active:") {
let before_time = line.find(';');
let after_time = line.find(" ago");
if let (Some(start), Some(end)) = (before_time, after_time) {
// extract the uptime / downtime from the `Active: ...` line
// using the index of ';' + 2 and the index of " ago"
let time = Some(&line[start + 2..end]);
// if service is active then the `time` reading is uptime
if status.state == Some("active".to_string()) {
status.uptime = time.map(|t| t.to_string())
// if service is inactive then the `time` reading is downtime
} else if status.state == Some("inactive".to_string()) {
status.downtime = time.map(|t| t.to_string())
}
}
}
}
// determine path of user's home directory
let mut blobstore_path = dirs::home_dir().ok_or(PeachError::HomeDir)?;
// append the blobstore path
blobstore_path.push(".ssb-go/blobs/sha256");
// determine the size of the blobstore directory in bytes
status.blobstore = dir_size(blobstore_path).ok();
Ok(status)
}
}
/// go-sbot configuration parameters.
#[derive(Debug, Serialize, Deserialize)]
#[serde(default)]
pub struct SbotConfig {
// TODO: maybe define as a Path type?
/// Directory path for the log and indexes.
pub repo: String,
/// Directory path for writing debug output.
pub debugdir: String,
/// Secret-handshake app-key (aka. network key).
pub shscap: String,
/// HMAC hash used to sign messages.
pub hmac: String,
/// Replication hops (1: friends, 2: friends of friends).
pub hops: u8,
/// Address to listen on.
pub lis: String,
/// Address to listen on for WebSocket connections.
pub wslis: String,
/// Address to for metrics and pprof HTTP server.
pub debuglis: String,
/// Enable sending local UDP broadcasts.
pub localadv: bool,
/// Enable listening for UDP broadcasts and connecting.
pub localdiscov: bool,
/// Enable syncing by using epidemic-broadcast-trees (EBT).
#[serde(rename(serialize = "enable_ebt", deserialize = "enable-ebt"))]
pub enable_ebt: bool,
/// Bypass graph auth and fetch remote's feed (useful for pubs that are restoring their data
/// from peer; user beware - caveats about).
pub promisc: bool,
/// Disable the UNIX socket RPC interface.
pub nounixsock: bool,
/// Attempt to repair the filesystem before starting.
pub repair: bool,
}
/// Default configuration values for go-sbot.
impl Default for SbotConfig {
fn default() -> Self {
Self {
repo: ".ssb-go".to_string(),
debugdir: "".to_string(),
shscap: "1KHLiKZvAvjbY1ziZEHMXawbCEIM6qwjCDm3VYRan/s=".to_string(),
hmac: "".to_string(),
hops: 1,
lis: ":8008".to_string(),
wslis: ":8989".to_string(),
debuglis: "localhost:6078".to_string(),
localadv: false,
localdiscov: false,
enable_ebt: false,
promisc: false,
nounixsock: false,
repair: false,
}
}
}
impl SbotConfig {
/// Read the go-sbot `config.toml` file from file and deserialize into `SbotConfig`.
pub fn read() -> Result<Self, PeachError> {
// determine path of user's home directory
let mut config_path = dirs::home_dir().ok_or(PeachError::HomeDir)?;
config_path.push(".ssb-go/config.toml");
let config_contents = fs::read_to_string(config_path)?;
let config: SbotConfig = toml::from_str(&config_contents)?;
Ok(config)
}
/// Write the given `SbotConfig` to the go-sbot `config.toml` file.
pub fn write(config: SbotConfig) -> Result<(), PeachError> {
let repo_comment = "# For details about go-sbot configuration, please visit the repo: https://github.com/cryptoscope/ssb\n".to_string();
// convert the provided `SbotConfig` instance to a string
let config_string = toml::to_string(&config)?;
// determine path of user's home directory
let mut config_path = dirs::home_dir().ok_or(PeachError::HomeDir)?;
config_path.push(".ssb-go/config.toml");
// open config file for writing
let mut file = File::create(config_path)?;
// write the repo comment to file
write!(file, "{}", repo_comment)?;
// write the config string to file
write!(file, "{}", config_string)?;
Ok(())
}
}

View File

@ -1,111 +0,0 @@
//! Interfaces for monitoring and configuring go-sbot using sbotcli.
use std::process::Command;
use serde::{Deserialize, Serialize};
use crate::error::PeachError;
pub fn is_sbot_online() -> Result<bool, PeachError> {
let output = Command::new("/usr/bin/systemctl")
.arg("status")
.arg("peach-go-sbot")
.output()?;
let status = output.status;
// returns true if the service had an exist status of 0 (is running)
let is_running = status.success();
Ok(is_running)
}
/// currently go-sbotcli determines where the working directory is
/// using the home directory of th user that invokes it
/// this could be changed to be supplied as CLI arg
/// but for now all sbotcli commands must first become peach-go-sbot before running
/// the sudoers file is configured to allow this to happen without a password
pub fn sbotcli_command() -> Command {
let mut command = Command::new("sudo");
command
.arg("-u")
.arg("peach-go-sbot")
.arg("/usr/bin/sbotcli");
command
}
pub fn post(msg: &str) -> Result<(), PeachError> {
let mut command = sbotcli_command();
let output = command.arg("publish").arg("post").arg(msg).output()?;
if output.status.success() {
Ok(())
} else {
let stderr = std::str::from_utf8(&output.stderr)?;
Err(PeachError::SbotCli {
msg: format!("Error making ssb post: {}", stderr),
})
}
}
#[derive(Serialize, Deserialize)]
struct WhoAmIValue {
id: String,
}
pub fn whoami() -> Result<String, PeachError> {
let mut command = sbotcli_command();
let output = command.arg("call").arg("whoami").output()?;
let text_output = std::str::from_utf8(&output.stdout)?;
let value: WhoAmIValue = serde_json::from_str(text_output)?;
let id = value.id;
Ok(id)
}
pub fn create_invite(uses: i32) -> Result<String, PeachError> {
let mut command = sbotcli_command();
let output = command
.arg("invite")
.arg("create")
.arg("--uses")
.arg(uses.to_string())
.output()?;
let text_output = std::str::from_utf8(&output.stdout)?;
let output = text_output.replace('\n', "");
Ok(output)
}
pub fn update_pub_name(new_name: &str) -> Result<(), PeachError> {
let pub_ssb_id = whoami()?;
let mut command = sbotcli_command();
let output = command
.arg("publish")
.arg("about")
.arg("--name")
.arg(new_name)
.arg(pub_ssb_id)
.output()?;
if output.status.success() {
Ok(())
} else {
let stderr = std::str::from_utf8(&output.stderr)?;
Err(PeachError::SbotCli {
msg: format!("Error updating pub name: {}", stderr),
})
}
}
pub fn private_message(msg: &str, recipient: &str) -> Result<(), PeachError> {
let mut command = sbotcli_command();
let output = command
.arg("publish")
.arg("post")
.arg("--recps")
.arg(recipient)
.arg(msg)
.output()?;
if output.status.success() {
Ok(())
} else {
let stderr = std::str::from_utf8(&output.stderr)?;
Err(PeachError::SbotCli {
msg: format!("Error sending ssb private message: {}", stderr),
})
}
}

View File

@ -1,6 +1,6 @@
[package]
name = "peach-stats"
version = "0.2.0"
version = "0.3.0"
authors = ["Andrew Reid <glyph@mycelial.technology>"]
edition = "2018"
description = "Query system statistics. Provides a wrapper around the probes and systemstat crates."

View File

@ -1,10 +1,10 @@
# peach-stats
![Generic badge](https://img.shields.io/badge/version-0.2.0-<COLOR>.svg)
![Generic badge](https://img.shields.io/badge/version-0.3.0-<COLOR>.svg)
System statistics library for PeachCloud. Provides a wrapper around the [probes](https://crates.io/crates/probes) and [systemstat](https://crates.io/crates/systemstat) crates.
Currently offers the following statistics and associated data structures:
Currently offers the following system statistics and associated data structures:
- CPU: `user`, `system`, `nice`, `idle` (as values or percentages)
- Disk usage: `filesystem`, `one_k_blocks`, `one_k_blocks_used`,
@ -13,10 +13,14 @@ Currently offers the following statistics and associated data structures:
- Memory: `total`, `free`, `used`
- Uptime: `seconds`
As well as the following go-sbot process statistics:
- Sbot: `state`, `memory`, `uptime`, `downtime`
## Example Usage
```rust
use peach_stats::{stats, StatsError};
use peach_stats::{sbot, stats, StatsError};
fn main() -> Result<(), StatsError> {
let cpu = stats::cpu_stats()?;
@ -25,6 +29,7 @@ fn main() -> Result<(), StatsError> {
let load = stats::load_average()?;
let mem = stats::mem_stats()?;
let uptime = stats::uptime()?;
let sbot_process = sbot::sbot_stats()?;
// do things with the retrieved values...

View File

@ -1,7 +1,7 @@
//! Custom error type for `peach-stats`.
use probes::ProbeError;
use std::{error, fmt, io::Error as IoError};
use std::{error, fmt, io::Error as IoError, str::Utf8Error};
/// Custom error type encapsulating all possible errors when retrieving system
/// statistics.
@ -17,6 +17,10 @@ pub enum StatsError {
MemStat(ProbeError),
/// Failed to retrieve system uptime.
Uptime(IoError),
/// Systemctl command returned an error.
Systemctl(IoError),
/// Failed to interpret sequence of `u8` as a string.
Utf8String(Utf8Error),
}
impl error::Error for StatsError {}
@ -39,6 +43,12 @@ impl fmt::Display for StatsError {
StatsError::Uptime(ref source) => {
write!(f, "Failed to retrieve system uptime: {}", source)
}
StatsError::Systemctl(ref source) => {
write!(f, "Systemctl command returned an error: {}", source)
}
StatsError::Utf8String(ref source) => {
write!(f, "Failed to convert stdout to string: {}", source)
}
}
}
}

View File

@ -43,6 +43,7 @@
//! ```
pub mod error;
pub mod sbot;
pub mod stats;
pub use crate::error::StatsError;

111
peach-stats/src/sbot.rs Normal file
View File

@ -0,0 +1,111 @@
//! Systemd go-sbot process statistics retrieval functions and associated data types.
use std::{process::Command, str};
#[cfg(feature = "miniserde_support")]
use miniserde::{Deserialize, Serialize};
#[cfg(feature = "serde_support")]
use serde::{Deserialize, Serialize};
use crate::StatsError;
/// go-sbot process statistics.
#[derive(Debug)]
#[cfg_attr(feature = "miniserde_support", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde_support", derive(Serialize, Deserialize))]
pub struct SbotStat {
/// Current process state.
pub state: Option<String>,
/// Current process boot state.
pub boot_state: Option<String>,
/// Current process memory usage in bytes.
pub memory: Option<u32>,
/// Uptime for the process (if state is `active`).
pub uptime: Option<String>,
/// Downtime for the process (if state is `inactive`).
pub downtime: Option<String>,
}
impl SbotStat {
/// Default builder for `SbotStat`.
fn default() -> Self {
Self {
state: None,
boot_state: None,
memory: None,
uptime: None,
downtime: None,
}
}
}
/// Retrieve statistics for the go-sbot systemd process by querying `systemctl`.
pub fn sbot_stats() -> Result<SbotStat, StatsError> {
let mut status = SbotStat::default();
let info_output = Command::new("/usr/bin/systemctl")
.arg("--user")
.arg("show")
.arg("go-sbot.service")
.arg("--no-page")
.output()
.map_err(StatsError::Systemctl)?;
let service_info = std::str::from_utf8(&info_output.stdout).map_err(StatsError::Utf8String)?;
for line in service_info.lines() {
if line.starts_with("ActiveState=") {
if let Some(state) = line.strip_prefix("ActiveState=") {
status.state = Some(state.to_string())
}
} else if line.starts_with("MemoryCurrent=") {
if let Some(memory) = line.strip_prefix("MemoryCurrent=") {
status.memory = memory.parse().ok()
}
}
}
let status_output = Command::new("/usr/bin/systemctl")
.arg("--user")
.arg("status")
.arg("go-sbot.service")
.output()
.map_err(StatsError::Systemctl)?;
let service_status = str::from_utf8(&status_output.stdout).map_err(StatsError::Utf8String)?;
for line in service_status.lines() {
// example of the output line we're looking for:
// `Loaded: loaded (/home/glyph/.config/systemd/user/go-sbot.service; enabled; vendor
// preset: enabled)`
if line.contains("Loaded:") {
let before_boot_state = line.find(';');
let after_boot_state = line.rfind(';');
if let (Some(start), Some(end)) = (before_boot_state, after_boot_state) {
// extract the enabled / disabled from the `Loaded: ...` line
// using the index of the first ';' + 2 and the last ';'
status.boot_state = Some(line[start + 2..end].to_string());
}
// example of the output line we're looking for here:
// `Active: active (running) since Mon 2022-01-24 16:22:51 SAST; 4min 14s ago`
} else if line.contains("Active:") {
let before_time = line.find(';');
let after_time = line.find(" ago");
if let (Some(start), Some(end)) = (before_time, after_time) {
// extract the uptime / downtime from the `Active: ...` line
// using the index of ';' + 2 and the index of " ago"
let time = Some(&line[start + 2..end]);
// if service is active then the `time` reading is uptime
if status.state == Some("active".to_string()) {
status.uptime = time.map(|t| t.to_string())
// if service is inactive then the `time` reading is downtime
} else if status.state == Some("inactive".to_string()) {
status.downtime = time.map(|t| t.to_string())
}
}
}
}
Ok(status)
}

View File

@ -1,8 +1,5 @@
*.bak
static/icons/optimized/*
api_docs.md
js_docs.md
hashmap_notes
notes
target
**/*.rs.bk
leftovers

View File

@ -1,6 +1,6 @@
[package]
name = "peach-web"
version = "0.5.0"
version = "0.6.0"
authors = ["Andrew Reid <gnomad@cryptolab.net>"]
edition = "2018"
description = "peach-web is a web application which provides a web interface for monitoring and interacting with the PeachCloud device. This allows administration of the single-board computer (ie. Raspberry Pi) running PeachCloud, as well as the ssb-server and related plugins."
@ -21,8 +21,6 @@ maintainer-scripts="debian"
systemd-units = { unit-name = "peach-web" }
assets = [
["target/release/peach-web", "/usr/bin/", "755"],
["Rocket.toml", "/usr/share/peach-web/Rocket.toml", "644"],
["templates/**/*", "/usr/share/peach-web/templates/", "644"],
["static/*", "/usr/share/peach-web/static/", "644"],
["static/css/*", "/usr/share/peach-web/static/css/", "644"],
["static/icons/*", "/usr/share/peach-web/static/icons/", "644"],
@ -35,18 +33,20 @@ travis-ci = { repository = "peachcloud/peach-web", branch = "master" }
maintenance = { status = "actively-developed" }
[dependencies]
async-std = "1.10"
base64 = "0.13"
chrono = "0.4"
dirs = "4.0"
env_logger = "0.8"
futures = "0.3"
golgi = { git = "https://git.coopcloud.tech/golgi-ssb/golgi.git" }
lazy_static = "1.4"
log = "0.4"
nest = "1.0.0"
maud = "0.23"
peach-lib = { path = "../peach-lib" }
peach-network = { path = "../peach-network", features = ["serde_support"] }
peach-stats = { path = "../peach-stats", features = ["serde_support"] }
rocket = { version = "0.5.0-rc.1", features = ["json", "secrets"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
tera = { version = "1.12.1", features = ["builtins"] }
xdg = "2.2.0"
[dependencies.rocket_dyn_templates]
version = "0.1.0-rc.1"
features = ["tera"]
# these will be reintroduced when the full peachcloud mode is added
#peach-network = { path = "../peach-network" }
#peach-stats = { path = "../peach-stats" }
rouille = { version = "3.5", default-features = false }
temporary = "0.6"
xdg = "2.2"

View File

@ -1,18 +1,27 @@
# peach-web
[![Build Status](https://travis-ci.com/peachcloud/peach-web.svg?branch=master)](https://travis-ci.com/peachcloud/peach-web) ![Generic badge](https://img.shields.io/badge/version-0.5.0-<COLOR>.svg)
![Generic badge](https://img.shields.io/badge/version-0.6.0-<COLOR>.svg)
## Web Interface for PeachCloud
**peach-web** provides a web interface for the PeachCloud device.
Initial development is focused on administration of the device itself, beginning with networking functionality, with SSB-related administration to be integrated at a later stage.
The web interface is primarily designed as a means of managing a Scuttlebutt pub. As such, it exposes the following features:
The peach-web stack currently consists of [Rocket](https://rocket.rs/) (Rust web framework), [Tera](http://tera.netlify.com/) (Rust template engine), HTML and CSS.
- Create a Scuttlebutt profile
- Follow, unfollow, block and unblock peers
- Generate pub invite codes
- Configure the sbot (hops, log directory, LAN discovery etc.)
- Send private messages
- Stop, start and restart the sbot
Additional features are focused on administration of the device itself. This includes networking functionality and device statistics.
The peach-web stack currently consists of [Rouille](https://crates.io/crates/rouille) (Rust web framework), [Maud](https://maud.lambda.xyz/) (Rust template engine), HTML and CSS. Scuttlebutt functionality is provided by [golgi](http://golgi.mycelial.technology).
_Note: This is a work-in-progress._
### Setup
## Setup
Clone the `peach-workspace` repo:
@ -23,41 +32,23 @@ Move into the repo and compile:
`cd peach-workspace/peach-web`
`cargo build --release`
Run the tests:
`ROCKET_DISABLE_AUTH=true ROCKET_STANDALONE_MODE=false cargo test`
Move back to the `peach-workspace` directory:
`cd ..`
Run the binary:
`./target/release/peach-web`
`../target/release/peach-web`
### Environment
## Environment
**Deployment Profile**
### Configuration Mode
The web application deployment profile can be configured with the `ROCKET_ENV` environment variable:
The web application can be run with a minimal set of routes and functionality (PeachPub - a simple sbot manager) or with the full-suite of capabilities, including network management and access to device statistics (PeachCloud). The mode is enabled by default (as defined in `Rocket.toml`) but can be overwritten using the `STANDALONE_MODE` environment variable: `true` or `false`. If the variable is unset or the value is incorrectly set, the application defaults to standalone mode.
`export ROCKET_ENV=stage`
### Authentication
Default configuration parameters are defined in `Rocket.toml`. This file defines a set of default parameters, some of which are overwritten when running in `debug` mode (ie. `cargo run` or `cargo build`) or `release` mode (ie. `cargo run --release` or `cargo build --release`).
Authentication is enabled by default when running the application. It can be disabled by setting the `DISABLE_AUTH` environment variable to `true`:
Read the [Rocket Environment Configurations docs](https://rocket.rs/v0.5-rc/guide/configuration/#environment-variables) for further information.
`export DISABLE_AUTH=true`
**Configuration Mode**
The web application can be run with a minimal set of routes and functionality (PeachPub - a simple sbot manager) or with the full-suite of capabilities, including network management and access to device statistics (PeachCloud). The mode is enabled by default (as defined in `Rocket.toml`) but can be overwritten using the `ROCKET_STANDALONE_MODE` environment variable: `true` or `false`. If the variable is unset or the value is incorrectly set, the application defaults to standalone mode.
**Authentication**
Authentication is disabled in `debug` mode and enabled by default when running the application in `release` mode. It can be disabled by setting the `ROCKET_DISABLE_AUTH` environment variable to `true`:
`export ROCKET_DISABLE_AUTH=true`
**Logging**
### Logging
Logging is made available with `env_logger`:
@ -65,7 +56,7 @@ Logging is made available with `env_logger`:
Other logging levels include `debug`, `warn` and `error`.
### Debian Packaging
## Debian Packaging
A `systemd` service file and Debian maintainer scripts are included in the `debian` directory, allowing `peach-web` to be easily bundled as a Debian package (`.deb`). The `cargo-deb` [crate](https://crates.io/crates/cargo-deb) can be used to achieve this.
@ -97,17 +88,13 @@ Remove configuration files (not removed with `apt-get remove`):
`sudo apt-get purge peach-web`
### Design
`peach-web` is built on the Rocket webserver and Tera templating engine. It presents a web interface for interacting with the device. HTML is rendered server-side. Request handlers call `peach-` libraries and serve HTML and assets. Each Tera template is passed a context object. In the case of Rust, this object is a `struct` and must implement `Serialize`. The fields of the context object are available in the context of the template to be rendered.
### Configuration
## Configuration
Configuration variables are stored in /var/lib/peachcloud/config.yml.
Peach-web also updates this file when changes are made to configurations via
the web interface. peach-web has no database, so all configurations are stored in this file.
#### Dynamic DNS Configuration
### Dynamic DNS Configuration
Most users will want to use the default PeachCloud dynamic dns server.
If the config dyn_use_custom_server=false, then default values will be used.
@ -115,6 +102,10 @@ If the config dyn_use_custom_server=true, then a value must also be set for dyn_
This value is the URL of the instance of peach-dyndns-server that requests will be sent to for domain registration.
Using a custom value can here can be useful for testing.
### Licensing
## Design
`peach-web` has been designed with simplicity and resource minimalism in mind. Both the dependencies used by the project, as well as the code itself, reflect these design priorities. The Rouille micro-web-framework and Maud templating engine have been used to present a web interface for interacting with the device. HTML is rendered server-side and request handlers call `peach-` libraries and serve HTML and assets. The optimised binary for `peach-web` can be compiled on a RPi 3 B+ in approximately 30 minutes.
## Licensing
AGPL-3.0

View File

@ -1,11 +0,0 @@
[default]
secret_key = "VYVUDivXvu8g6llxeJd9F92pMfocml5xl/Jjv5Sk4yw="
disable_auth = false
standalone_mode = true
[debug]
template_dir = "templates/"
disable_auth = true
[release]
template_dir = "templates/"

53
peach-web/src/config.rs Normal file
View File

@ -0,0 +1,53 @@
//! Define the configuration parameters for the web application.
//!
//! Sets default values and updates them if the corresponding environment
//! variables have been set.
use std::env;
// environment variable keys to check for
const ENV_VARS: [&str; 4] = ["STANDALONE_MODE", "DISABLE_AUTH", "ADDR", "PORT"];
pub struct Config {
pub standalone_mode: bool,
pub disable_auth: bool,
pub addr: String,
pub port: String,
}
impl Default for Config {
fn default() -> Self {
Self {
standalone_mode: true,
disable_auth: false,
addr: "127.0.0.1".to_string(),
port: "8000".to_string(),
}
}
}
impl Config {
pub fn new() -> Config {
// define default config values
let mut config = Config::default();
// check for the environment variables in our config
for key in ENV_VARS {
// if a variable (key) has been set, check the value
if let Ok(val) = env::var(key) {
// if the value is of the correct type, update the config value
match key {
"STANDALONE_MODE" if val.as_str() == "true" => config.standalone_mode = true,
"STANDALONE_MODE" if val.as_str() == "false" => config.standalone_mode = false,
"DISABLE_AUTH" if val.as_str() == "true" => config.disable_auth = true,
"DISABLE_AUTH" if val.as_str() == "false" => config.disable_auth = false,
"ADDR" => config.addr = val,
"PORT" => config.port = val,
_ => (),
}
}
}
config
}
}

View File

@ -1,36 +0,0 @@
use peach_lib::{config_manager, dyndns_client};
use rocket::serde::Serialize;
#[derive(Debug, Serialize)]
pub struct ConfigureDNSContext {
pub external_domain: String,
pub dyndns_subdomain: String,
pub enable_dyndns: bool,
pub is_dyndns_online: bool,
pub back: Option<String>,
pub title: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
}
impl ConfigureDNSContext {
pub fn build() -> ConfigureDNSContext {
// TODO: replace `unwrap` with resilient error handling
let peach_config = config_manager::load_peach_config().unwrap();
let dyndns_fulldomain = peach_config.dyn_domain;
let is_dyndns_online = dyndns_client::is_dns_updater_online().unwrap();
let dyndns_subdomain =
dyndns_client::get_dyndns_subdomain(&dyndns_fulldomain).unwrap_or(dyndns_fulldomain);
ConfigureDNSContext {
external_domain: peach_config.external_domain,
dyndns_subdomain,
enable_dyndns: peach_config.dyn_enabled,
is_dyndns_online,
back: None,
title: None,
flash_name: None,
flash_msg: None,
}
}
}

View File

@ -1,2 +0,0 @@
pub mod dns;
pub mod network;

View File

@ -1,398 +0,0 @@
//! Data retrieval for the purpose of serving routes and hydrating
//! network-related HTML templates.
use std::collections::HashMap;
use rocket::{
form::FromForm,
serde::{Deserialize, Serialize},
UriDisplayQuery,
};
use peach_network::{
network,
network::{Scan, Status, Traffic},
};
use crate::{
utils::{
monitor,
monitor::{Alert, Data, Threshold},
},
AP_IFACE, WLAN_IFACE,
};
#[derive(Debug, Serialize)]
pub struct AccessPoint {
pub detail: Option<Scan>,
pub signal: Option<i32>,
pub state: String,
}
pub fn ap_state() -> String {
match network::state(&*AP_IFACE) {
Ok(Some(state)) => state,
_ => "Interface unavailable".to_string(),
}
}
#[derive(Debug, Deserialize, FromForm, UriDisplayQuery)]
pub struct Ssid {
pub ssid: String,
}
#[derive(Debug, Deserialize, FromForm)]
pub struct WiFi {
pub ssid: String,
pub pass: String,
}
fn convert_traffic(traffic: Traffic) -> Option<IfaceTraffic> {
// modify traffic values & assign measurement unit
// based on received and transmitted values
let (rx, rx_unit) = if traffic.received > 1_047_527_424 {
// convert to GB
(traffic.received / 1_073_741_824, "GB".to_string())
} else if traffic.received > 0 {
// otherwise, convert it to MB
((traffic.received / 1024) / 1024, "MB".to_string())
} else {
(0, "MB".to_string())
};
let (tx, tx_unit) = if traffic.transmitted > 1_047_527_424 {
// convert to GB
(traffic.transmitted / 1_073_741_824, "GB".to_string())
} else if traffic.transmitted > 0 {
((traffic.transmitted / 1024) / 1024, "MB".to_string())
} else {
(0, "MB".to_string())
};
Some(IfaceTraffic {
rx,
rx_unit,
tx,
tx_unit,
})
}
#[derive(Debug, Serialize)]
pub struct IfaceTraffic {
pub rx: u64,
pub rx_unit: String,
pub tx: u64,
pub tx_unit: String,
}
#[derive(Debug, Serialize)]
pub struct NetworkAlertContext {
pub alert: Alert,
pub back: Option<String>,
pub data_total: Option<Data>, // combined stored and current wifi traffic in bytes
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub threshold: Threshold,
pub title: Option<String>,
pub traffic: Option<IfaceTraffic>, // current wifi traffic in bytes (since boot)
}
impl NetworkAlertContext {
pub fn build() -> NetworkAlertContext {
let alert = monitor::get_alerts().unwrap();
// stored wifi data values as bytes
let stored_traffic = monitor::get_data().unwrap();
let threshold = monitor::get_thresholds().unwrap();
let (traffic, data_total) = match network::traffic(&*WLAN_IFACE) {
// convert bytes to mb or gb and add appropriate units
Ok(Some(t)) => {
let current_traffic = t.received + t.transmitted;
let traffic = convert_traffic(t);
let total = stored_traffic.total + current_traffic;
let data_total = Data { total };
(traffic, Some(data_total))
}
_ => (None, None),
};
NetworkAlertContext {
alert,
back: None,
data_total,
flash_name: None,
flash_msg: None,
threshold,
title: None,
traffic,
}
}
}
#[derive(Debug, Serialize)]
pub struct NetworkDetailContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub selected: Option<String>,
pub title: Option<String>,
pub saved_aps: Vec<String>,
pub wlan_ip: String,
pub wlan_networks: HashMap<String, AccessPoint>,
pub wlan_rssi: Option<String>,
pub wlan_ssid: String,
pub wlan_state: String,
pub wlan_status: Option<Status>,
pub wlan_traffic: Option<IfaceTraffic>,
}
impl NetworkDetailContext {
pub fn build() -> NetworkDetailContext {
let wlan_ip = match network::ip(&*WLAN_IFACE) {
Ok(Some(ip)) => ip,
_ => "x.x.x.x".to_string(),
};
// list of networks saved in wpa_supplicant.conf
let wlan_list = match network::saved_networks() {
Ok(Some(ssids)) => ssids,
_ => Vec::new(),
};
// list of networks saved in wpa_supplicant.conf
let saved_aps = wlan_list.clone();
let wlan_rssi = match network::rssi_percent(&*WLAN_IFACE) {
Ok(rssi) => rssi,
Err(_) => None,
};
// list of networks currently in range (online & accessible)
let wlan_scan = match network::available_networks(&*WLAN_IFACE) {
Ok(Some(networks)) => networks,
_ => Vec::new(),
};
let wlan_ssid = match network::ssid(&*WLAN_IFACE) {
Ok(Some(ssid)) => ssid,
_ => "Not connected".to_string(),
};
let wlan_state = match network::state(&*WLAN_IFACE) {
Ok(Some(state)) => state,
_ => "Interface unavailable".to_string(),
};
let wlan_status = match network::status(&*WLAN_IFACE) {
Ok(status) => status,
// interface unavailable
_ => None,
};
let wlan_traffic = match network::traffic(&*WLAN_IFACE) {
// convert bytes to mb or gb and add appropriate units
Ok(Some(traffic)) => convert_traffic(traffic),
_ => None,
};
// create a hashmap to combine wlan_list & wlan_scan without repetition
let mut wlan_networks = HashMap::new();
for ap in wlan_scan {
let ssid = ap.ssid.clone();
let rssi = ap.signal_level.clone();
// parse the string to a signed integer (for math)
let rssi_parsed = rssi.parse::<i32>().unwrap();
// perform rssi (dBm) to quality (%) conversion
let quality_percent = 2 * (rssi_parsed + 100);
let ap_detail = AccessPoint {
detail: Some(ap),
state: "Available".to_string(),
signal: Some(quality_percent),
};
wlan_networks.insert(ssid, ap_detail);
}
for network in wlan_list {
// avoid repetition by checking that ssid is not already in list
if !wlan_networks.contains_key(&network) {
let ssid = network.clone();
let net_detail = AccessPoint {
detail: None,
state: "Not in range".to_string(),
signal: None,
};
wlan_networks.insert(ssid, net_detail);
}
}
NetworkDetailContext {
back: None,
flash_name: None,
flash_msg: None,
selected: None,
title: None,
saved_aps,
wlan_ip,
wlan_networks,
wlan_rssi,
wlan_ssid,
wlan_state,
wlan_status,
wlan_traffic,
}
}
}
#[derive(Debug, Serialize)]
pub struct NetworkListContext {
pub ap_state: String,
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
pub wlan_networks: HashMap<String, String>,
pub wlan_ssid: String,
}
impl NetworkListContext {
pub fn build() -> NetworkListContext {
// list of networks saved in wpa_supplicant.conf
let wlan_list = match network::saved_networks() {
Ok(Some(ssids)) => ssids,
_ => Vec::new(),
};
// list of networks currently in range (online & accessible)
let wlan_scan = match network::available_networks(&*WLAN_IFACE) {
Ok(Some(networks)) => networks,
_ => Vec::new(),
};
let wlan_ssid = match network::ssid(&*WLAN_IFACE) {
Ok(Some(ssid)) => ssid,
_ => "Not connected".to_string(),
};
// create a hashmap to combine wlan_list & wlan_scan without repetition
let mut wlan_networks = HashMap::new();
for ap in wlan_scan {
wlan_networks.insert(ap.ssid, "Available".to_string());
}
for network in wlan_list {
// insert ssid (with state) only if it doesn't already exist
wlan_networks
.entry(network)
.or_insert_with(|| "Not in range".to_string());
}
let ap_state = match network::state(&*AP_IFACE) {
Ok(Some(state)) => state,
_ => "Interface unavailable".to_string(),
};
NetworkListContext {
ap_state,
back: None,
flash_msg: None,
flash_name: None,
title: None,
wlan_networks,
wlan_ssid,
}
}
}
#[derive(Debug, Serialize)]
pub struct NetworkStatusContext {
pub ap_ip: String,
pub ap_ssid: String,
pub ap_state: String,
pub ap_traffic: Option<IfaceTraffic>,
pub wlan_ip: String,
pub wlan_rssi: Option<String>,
pub wlan_ssid: String,
pub wlan_state: String,
pub wlan_status: Option<Status>,
pub wlan_traffic: Option<IfaceTraffic>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
// passing in the ssid of a chosen access point
pub selected: Option<String>,
pub title: Option<String>,
pub back: Option<String>,
}
impl NetworkStatusContext {
pub fn build() -> Self {
let ap_ip = match network::ip(&*AP_IFACE) {
Ok(Some(ip)) => ip,
_ => "x.x.x.x".to_string(),
};
let ap_ssid = match network::ssid(&*AP_IFACE) {
Ok(Some(ssid)) => ssid,
_ => "Not currently activated".to_string(),
};
let ap_state = match network::state(&*AP_IFACE) {
Ok(Some(state)) => state,
_ => "Interface unavailable".to_string(),
};
let ap_traffic = match network::traffic(&*AP_IFACE) {
// convert bytes to mb or gb and add appropriate units
Ok(Some(traffic)) => convert_traffic(traffic),
_ => None,
};
let wlan_ip = match network::ip(&*WLAN_IFACE) {
Ok(Some(ip)) => ip,
_ => "x.x.x.x".to_string(),
};
let wlan_rssi = match network::rssi_percent(&*WLAN_IFACE) {
Ok(rssi) => rssi,
_ => None,
};
let wlan_ssid = match network::ssid(&*WLAN_IFACE) {
Ok(Some(ssid)) => ssid,
_ => "Not connected".to_string(),
};
let wlan_state = match network::state(&*WLAN_IFACE) {
Ok(Some(state)) => state,
_ => "Interface unavailable".to_string(),
};
let wlan_status = match network::status(&*WLAN_IFACE) {
Ok(status) => status,
_ => None,
};
let wlan_traffic = match network::traffic(&*WLAN_IFACE) {
// convert bytes to mb or gb and add appropriate units
Ok(Some(traffic)) => convert_traffic(traffic),
_ => None,
};
NetworkStatusContext {
ap_ip,
ap_ssid,
ap_state,
ap_traffic,
wlan_ip,
wlan_rssi,
wlan_ssid,
wlan_state,
wlan_status,
wlan_traffic,
flash_name: None,
flash_msg: None,
selected: None,
title: None,
back: None,
}
}
}

View File

@ -1,5 +1,8 @@
//! Custom error type representing all possible error variants for peach-web.
use std::io::Error as IoError;
use golgi::GolgiError;
use peach_lib::error::PeachError;
use peach_lib::{serde_json, serde_yaml};
use serde_json::error::Error as JsonError;
@ -8,19 +11,27 @@ use serde_yaml::Error as YamlError;
/// Custom error type encapsulating all possible errors for the web application.
#[derive(Debug)]
pub enum PeachWebError {
Json(JsonError),
Yaml(YamlError),
FailedToRegisterDynDomain(String),
Golgi(GolgiError),
HomeDir,
Io(IoError),
Json(JsonError),
OsString,
PeachLib { source: PeachError, msg: String },
Yaml(YamlError),
}
impl std::error::Error for PeachWebError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match *self {
PeachWebError::Json(ref source) => Some(source),
PeachWebError::Yaml(ref source) => Some(source),
PeachWebError::FailedToRegisterDynDomain(_) => None,
PeachWebError::Golgi(ref source) => Some(source),
PeachWebError::HomeDir => None,
PeachWebError::Io(ref source) => Some(source),
PeachWebError::Json(ref source) => Some(source),
PeachWebError::OsString => None,
PeachWebError::PeachLib { ref source, .. } => Some(source),
PeachWebError::Yaml(ref source) => Some(source),
}
}
}
@ -28,28 +39,44 @@ impl std::error::Error for PeachWebError {
impl std::fmt::Display for PeachWebError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match *self {
PeachWebError::Json(ref source) => write!(f, "Serde JSON error: {}", source),
PeachWebError::Yaml(ref source) => write!(f, "Serde YAML error: {}", source),
PeachWebError::FailedToRegisterDynDomain(ref msg) => {
write!(f, "DYN DNS error: {}", msg)
}
PeachWebError::Golgi(ref source) => write!(f, "Golgi error: {}", source),
PeachWebError::HomeDir => write!(
f,
"Filesystem error: failed to determine home directory path"
),
PeachWebError::Io(ref source) => write!(f, "IO error: {}", source),
PeachWebError::Json(ref source) => write!(f, "Serde JSON error: {}", source),
PeachWebError::OsString => write!(
f,
"Filesystem error: failed to convert OsString to String for go-ssb directory path"
),
PeachWebError::PeachLib { ref source, .. } => write!(f, "{}", source),
PeachWebError::Yaml(ref source) => write!(f, "Serde YAML error: {}", source),
}
}
}
impl From<GolgiError> for PeachWebError {
fn from(err: GolgiError) -> PeachWebError {
PeachWebError::Golgi(err)
}
}
impl From<IoError> for PeachWebError {
fn from(err: IoError) -> PeachWebError {
PeachWebError::Io(err)
}
}
impl From<JsonError> for PeachWebError {
fn from(err: JsonError) -> PeachWebError {
PeachWebError::Json(err)
}
}
impl From<YamlError> for PeachWebError {
fn from(err: YamlError) -> PeachWebError {
PeachWebError::Yaml(err)
}
}
impl From<PeachError> for PeachWebError {
fn from(err: PeachError) -> PeachWebError {
PeachWebError::PeachLib {
@ -58,3 +85,9 @@ impl From<PeachError> for PeachWebError {
}
}
}
impl From<YamlError> for PeachWebError {
fn from(err: YamlError) -> PeachWebError {
PeachWebError::Yaml(err)
}
}

View File

@ -8,90 +8,122 @@
//! ## Design
//!
//! `peach-web` is written primarily in Rust and presents a web interface for
//! interacting with the device. The stack currently consists of Rocket (Rust
//! web framework), Tera (Rust template engine inspired by Jinja2 and the Django
//! template language), HTML, CSS and JavaScript. Additional functionality is
//! provided by JSON-RPC clients for the `peach-network` and `peach-stats`
//! microservices.
//!
//! HTML is rendered server-side. Request handlers call JSON-RPC microservices
//! and serve HTML and assets. A JSON API is exposed for remote calls and
//! dynamic client-side content updates via vanilla JavaScript following
//! unobstructive design principles. Each Tera template is passed a context
//! object. In the case of Rust, this object is a `struct` and must implement
//! `Serialize`. The fields of the context object are available in the context
//! of the template to be rendered.
//! interacting with the device. The stack currently consists of Rouille (Rust
//! micro-web-framework), Maud (an HTML template engine for Rust), HTML and
//! CSS.
#![feature(proc_macro_hygiene, decl_macro)]
mod context;
mod config;
pub mod error;
mod router;
pub mod routes;
#[cfg(test)]
mod tests;
mod private_router;
mod public_router;
mod routes;
mod templates;
pub mod utils;
use std::process;
use std::{
collections::HashMap,
sync::{Mutex, RwLock},
};
use log::{debug, error, info};
use rocket::{fairing::AdHoc, serde::Deserialize, Build, Rocket};
use lazy_static::lazy_static;
use log::{debug, info};
use peach_lib::{config_manager, config_manager::YAML_PATH as PEACH_CONFIG};
pub type BoxError = Box<dyn std::error::Error>;
// crate-local dependencies
use config::Config;
use utils::theme::Theme;
/// Application configuration parameters.
/// These values are extracted from Rocket's default configuration provider:
/// `Config::figment()`. As such, the values are drawn from `Rocket.toml` or
/// the TOML file path in the `ROCKET_CONFIG` environment variable. The TOML
/// file parameters are automatically overruled by any `ROCKET_` variables
/// which might be set.
#[derive(Debug, Deserialize)]
pub struct RocketConfig {
disable_auth: bool,
standalone_mode: bool,
// load the application configuration and create the theme switcher
lazy_static! {
static ref CONFIG: Config = Config::new();
static ref THEME: RwLock<Theme> = RwLock::new(Theme::Light);
}
static WLAN_IFACE: &str = "wlan0";
static AP_IFACE: &str = "ap0";
pub fn init_rocket() -> Rocket<Build> {
info!("Initializing Rocket");
// build a basic rocket instance
let rocket = rocket::build();
// return the default provider figment used by `rocket::build()`
let figment = rocket.figment();
// deserialize configuration parameters into our `RocketConfig` struct (defined above)
// since we're in the intialisation phase, panic if the extraction fails
let config: RocketConfig = figment.extract().expect("configuration extraction failed");
debug!("{:?}", config);
info!("Mounting Rocket routes");
let mounted_rocket = if config.standalone_mode {
router::mount_peachpub_routes(rocket)
} else {
router::mount_peachcloud_routes(rocket)
};
info!("Attaching application configuration to managed state");
mounted_rocket.attach(AdHoc::config::<RocketConfig>())
/// Session data for each authenticated client.
#[derive(Debug, Clone)]
pub struct SessionData {
_login: String,
}
/// Launch the peach-web rocket server.
#[rocket::main]
async fn main() {
/// Launch the peach-web server.
fn main() {
// initialize logger
env_logger::init();
// initialize rocket
let rocket = init_rocket();
// check if /var/lib/peachcloud/config.yml exists
if !std::path::Path::new(PEACH_CONFIG).exists() {
debug!("PeachCloud configuration file not found; loading default values");
// since we're in the intialisation phase, panic if the loading fails
let config =
config_manager::load_peach_config().expect("peachcloud configuration loading failed");
// launch rocket
info!("Launching Rocket");
if let Err(e) = rocket.launch().await {
error!("Error in Rocket application: {}", e);
process::exit(1);
debug!("Saving default PeachCloud configuration values to file");
// this ensures a config file is created if it does not already exist
config_manager::save_peach_config(config).expect("peachcloud configuration saving failed");
}
// set ip address / hostname and port for the webserver
// defaults to "127.0.0.1:8000"
let addr_and_port = format!("{}:{}", CONFIG.addr, CONFIG.port);
// store the session data for each session and a hashmap that associates
// each session id with the data
// note: we are storing this data in memory. all sessions are erased when
// the program is restarted.
let sessions_storage: Mutex<HashMap<String, SessionData>> = Mutex::new(HashMap::new());
info!("Launching web server on {}", addr_and_port);
// the `start_server` starts listening forever on the given address
rouille::start_server(addr_and_port, move |request| {
// assign a unique id to each client (appends a cookie to the response
// with a name of "SID" and a duration of one hour (3600 seconds)
rouille::session::session(request, "SID", 3600, |session| {
// if the "DISABLE_AUTH" env var is true, authenticate the session
let mut session_data = if CONFIG.disable_auth {
Some(SessionData {
_login: "success".to_string(),
})
// if the client already has an identifier from a previous request,
// try to load the existing session data. if successful, make a
// copy of the data in order to avoid locking the session for too
// long
} else if session.client_has_sid() {
sessions_storage.lock().unwrap().get(session.id()).cloned()
} else {
None
};
// pass the request to the public router
//
// the public router includes authentication-related routes which
// do not require the user to be authenticated (ie. login and reset
// password)
//
// if the user is already authenticated, their request will be
// passed to the private router by public_router::handle_route()
//
// we pass a mutable reference to the `Option<SessionData>` so that
// the function is free to modify it
let response = public_router::handle_route(request, &mut session_data);
// since the function call to `handle_route` can modify the session
// data, we have to store it back in the `sessions_storage` after
// the request has been handled
if let Some(data) = session_data {
sessions_storage
.lock()
.unwrap()
.insert(session.id().to_owned(), data);
} else if session.client_has_sid() {
// if the content of the `Option` was erased (ie. due to
// deauthentication on logout), remove the session from the
// storage. this is only done if the client already has an
// identifier, otherwise calling `session.id()` will assign one
sessions_storage.lock().unwrap().remove(session.id());
}
response
})
});
}

View File

@ -0,0 +1,197 @@
use rouille::{router, Request, Response};
use crate::{routes, templates, utils::flash::FlashResponse, SessionData};
// TODO: add mount_peachcloud_routes()
// https://github.com/tomaka/rouille/issues/232#issuecomment-919225104
/// Define the PeachPub router.
///
/// Takes an incoming request and matches on the defined routes,
/// returning either a template or a redirect.
///
/// All of these routes require the user to be authenticated. See the
/// `public_router` for publically-accessible, authentication-related routes.
///
/// Excludes settings and status routes related to networking and the device
/// (memory, hard disk, CPU etc.).
pub fn mount_peachpub_routes(
request: &Request,
session_data: &mut Option<SessionData>,
) -> Response {
router!(request,
(GET) (/) => {
Response::html(routes::home::build_template())
},
(GET) (/auth/change) => {
// build the html template
Response::html(routes::authentication::change::build_template(request))
// reset the flash msg cookies in the response object
.reset_flash()
},
(POST) (/auth/change) => {
routes::authentication::change::handle_form(request)
},
(GET) (/auth/logout) => {
routes::authentication::logout::deauthenticate(session_data)
},
(GET) (/guide) => {
Response::html(routes::guide::build_template())
},
(POST) (/scuttlebutt/block) => {
routes::scuttlebutt::block::handle_form(request)
},
(GET) (/scuttlebutt/blocks) => {
Response::html(routes::scuttlebutt::blocks::build_template())
},
(POST) (/scuttlebutt/follow) => {
routes::scuttlebutt::follow::handle_form(request)
},
(GET) (/scuttlebutt/follows) => {
Response::html(routes::scuttlebutt::follows::build_template())
},
(GET) (/scuttlebutt/friends) => {
Response::html(routes::scuttlebutt::friends::build_template())
},
(GET) (/scuttlebutt/invites) => {
Response::html(routes::scuttlebutt::invites::build_template(request))
.reset_flash()
},
(POST) (/scuttlebutt/invites) => {
routes::scuttlebutt::invites::handle_form(request)
},
(GET) (/scuttlebutt/peers) => {
Response::html(routes::scuttlebutt::peers::build_template())
},
(GET) (/scuttlebutt/private) => {
Response::html(routes::scuttlebutt::private::build_template(request, None))
},
(POST) (/scuttlebutt/private) => {
routes::scuttlebutt::private::handle_form(request)
},
(GET) (/scuttlebutt/private/{ssb_id: String}) => {
Response::html(routes::scuttlebutt::private::build_template(request, Some(ssb_id)))
},
(GET) (/scuttlebutt/profile) => {
Response::html(routes::scuttlebutt::profile::build_template(request, None))
.reset_flash()
},
(GET) (/scuttlebutt/profile/update) => {
Response::html(routes::scuttlebutt::profile_update::build_template(request))
.reset_flash()
},
(POST) (/scuttlebutt/profile/update) => {
routes::scuttlebutt::profile_update::handle_form(request)
},
(GET) (/scuttlebutt/profile/{ssb_id: String}) => {
Response::html(routes::scuttlebutt::profile::build_template(request, Some(ssb_id)))
},
(POST) (/scuttlebutt/publish) => {
routes::scuttlebutt::publish::handle_form(request)
},
(GET) (/scuttlebutt/search) => {
Response::html(routes::scuttlebutt::search::build_template(request))
.reset_flash()
},
(POST) (/scuttlebutt/search) => {
routes::scuttlebutt::search::handle_form(request)
},
(POST) (/scuttlebutt/unblock) => {
routes::scuttlebutt::unblock::handle_form(request)
},
(POST) (/scuttlebutt/unfollow) => {
routes::scuttlebutt::unfollow::handle_form(request)
},
(GET) (/settings) => {
Response::html(routes::settings::menu::build_template())
},
(GET) (/settings/admin) => {
Response::html(routes::settings::admin::menu::build_template())
},
(POST) (/settings/admin/add) => {
routes::settings::admin::add::handle_form(request)
},
(GET) (/settings/admin/configure) => {
Response::html(routes::settings::admin::configure::build_template(request))
.reset_flash()
},
(POST) (/settings/admin/delete) => {
routes::settings::admin::delete::handle_form(request)
},
(GET) (/settings/scuttlebutt) => {
Response::html(routes::settings::scuttlebutt::menu::build_template(request))
.reset_flash()
},
(GET) (/settings/scuttlebutt/restart) => {
routes::settings::scuttlebutt::restart::restart_sbot()
},
(GET) (/settings/scuttlebutt/start) => {
routes::settings::scuttlebutt::start::start_sbot()
},
(GET) (/settings/scuttlebutt/stop) => {
routes::settings::scuttlebutt::stop::stop_sbot()
},
(GET) (/settings/scuttlebutt/configure) => {
Response::html(routes::settings::scuttlebutt::configure::build_template(request))
.reset_flash()
},
(POST) (/settings/scuttlebutt/configure) => {
routes::settings::scuttlebutt::configure::handle_form(request, false)
},
(POST) (/settings/scuttlebutt/configure/restart) => {
routes::settings::scuttlebutt::configure::handle_form(request, true)
},
(GET) (/settings/scuttlebutt/configure/default) => {
routes::settings::scuttlebutt::default::write_config()
},
(GET) (/settings/theme/{theme: String}) => {
routes::settings::theme::set_theme(theme)
},
(GET) (/status/scuttlebutt) => {
Response::html(routes::status::scuttlebutt::build_template())
},
// render the not_found template and set a 404 status code if none of
// the other blocks matches the request
_ => Response::html(templates::not_found::build_template()).with_status_code(404)
)
}

View File

@ -0,0 +1,103 @@
use log::{error, info};
use rouille::{router, Request, Response};
use crate::{
private_router, routes,
utils::{flash::FlashResponse, sbot},
SessionData,
};
/// Request handler.
///
/// Mount the fileservers for static assets and define the
/// publically-accessible routes (including per-route handlers). Includes
/// logging of all incoming requests.
///
/// If the request is for a private route (ie. a route requiring successful
/// authentication to view), check the authentication status of the user
/// by querying the `session_data`. If the user is authenticated, pass their
/// request to the private router. Otherwise, redirect them to the login page.
pub fn handle_route(request: &Request, session_data: &mut Option<SessionData>) -> Response {
// static file server
// matches on assets in the `static` directory
let static_response = rouille::match_assets(request, "static");
if static_response.is_success() {
return static_response;
}
// set the `.ssb-go` path in order to mount the blob fileserver
let ssb_path = sbot::get_go_ssb_path().expect("define ssb-go dir path");
let blobstore = format!("{}/blobs/sha256", ssb_path);
// blobstore file server
// removes the /blob url prefix and serves blobs from blobstore
// matches on assets in the `static` directory
if let Some(request) = request.remove_prefix("/blob") {
return rouille::match_assets(&request, &blobstore);
}
// get the current time (for logging purposes)
let now = chrono::Utc::now().format("%Y-%m-%d %H:%M:%S%.6f");
// define the success logger for incoming requests
let log_ok = |req: &Request, _resp: &Response, _elap: std::time::Duration| {
info!("{} {} {}", now, req.method(), req.raw_url());
};
// define the error logger for incoming requests
let log_err = |req: &Request, _elap: std::time::Duration| {
error!(
"{} Handler panicked: {} {}",
now,
req.method(),
req.raw_url()
);
};
// instantiate request logging
rouille::log_custom(request, log_ok, log_err, || {
// handle the routes which are always accessible (ie. whether logged-in
// or not)
router!(request,
(GET) (/auth/forgot) => {
Response::html(routes::authentication::forgot::build_template(request))
.reset_flash()
},
(GET) (/auth/login) => {
Response::html(routes::authentication::login::build_template(request))
.reset_flash()
},
(POST) (/auth/login) => {
routes::authentication::login::handle_form(request, session_data)
},
(GET) (/auth/reset) => {
Response::html(routes::authentication::reset::build_template(request))
.reset_flash()
},
(POST) (/auth/reset) => {
routes::authentication::reset::handle_form(request)
},
(POST) (/auth/temporary) => {
routes::authentication::temporary::handle_form()
},
_ => {
// now that we handled all the routes that are accessible in all
// circumstances, we check that the user is logged in before proceeding
if let Some(_session) = session_data.as_ref() {
// logged in:
// mount the routes which require authentication to view
private_router::mount_peachpub_routes(request, session_data)
} else {
// not logged in:
Response::redirect_303("/auth/login")
}
}
)
})
}

View File

@ -1,95 +0,0 @@
use rocket::{catchers, fs::FileServer, routes, Build, Rocket};
use rocket_dyn_templates::Template;
use crate::routes::{
authentication::*,
catchers::*,
index::*,
scuttlebutt::*,
settings::{admin::*, dns::*, menu::*, network::*, scuttlebutt::*},
status::{device::*, network::*, scuttlebutt::*},
};
/// Create a Rocket instance and mount PeachPub routes, fileserver and
/// catchers. This gives us everything we need to run PeachPub and excludes
/// settings and status routes related to networking and the device (memory,
/// hard disk, CPU etc.).
pub fn mount_peachpub_routes(rocket: Rocket<Build>) -> Rocket<Build> {
rocket
.mount(
"/",
routes![
help,
home,
login,
login_post,
logout,
reboot_cmd,
shutdown_cmd,
power_menu,
settings_menu,
],
)
.mount(
"/settings/admin",
routes![
admin_menu,
configure_admin,
add_admin,
add_admin_post,
delete_admin_post,
change_password,
change_password_post,
reset_password,
reset_password_post,
forgot_password_page,
send_password_reset_post,
],
)
.mount(
"/settings/scuttlebutt",
routes![ssb_settings_menu, configure_sbot],
)
.mount(
"/scuttlebutt",
routes![
peers, friends, follows, followers, blocks, profile, private, follow, unfollow,
block, publish,
],
)
.mount("/status", routes![scuttlebutt_status])
.mount("/", FileServer::from("static"))
.register("/", catchers![not_found, internal_error, forbidden])
.attach(Template::fairing())
}
/// Create a Rocket instance with PeachPub routes, fileserver and catchers by
/// calling `mount_peachpub_routes()` and then mount all additional routes
/// required to run a complete PeachCloud build.
pub fn mount_peachcloud_routes(rocket: Rocket<Build>) -> Rocket<Build> {
mount_peachpub_routes(rocket)
.mount(
"/settings/network",
routes![
add_credentials,
connect_wifi,
configure_dns,
configure_dns_post,
disconnect_wifi,
deploy_ap,
deploy_client,
forget_wifi,
network_home,
add_ssid,
add_wifi,
network_detail,
wifi_list,
wifi_password,
wifi_set_password,
wifi_usage,
wifi_usage_alerts,
wifi_usage_reset,
],
)
.mount("/status", routes![device_status, network_status])
}

View File

@ -1,320 +0,0 @@
use log::info;
use rocket::{
form::{Form, FromForm},
get,
http::{Cookie, CookieJar, Status},
post,
request::{self, FlashMessage, FromRequest, Request},
response::{Flash, Redirect},
serde::Deserialize,
};
use rocket_dyn_templates::{tera::Context, Template};
use peach_lib::{error::PeachError, password_utils};
use crate::error::PeachWebError;
use crate::utils::TemplateOrRedirect;
//use crate::DisableAuth;
use crate::RocketConfig;
// HELPERS AND STRUCTS FOR AUTHENTICATION WITH COOKIES
pub const AUTH_COOKIE_KEY: &str = "peachweb_auth";
pub const ADMIN_USERNAME: &str = "admin";
/// Note: Currently we use an empty struct for the Authenticated request guard
/// because there is only one user to be authenticated, and no data needs to be stored here.
/// In a multi-user authentication scheme, we would store the user_id in this struct,
/// and retrieve the correct user via the user_id stored in the cookie.
pub struct Authenticated;
#[derive(Debug)]
pub enum LoginError {
UserNotLoggedIn,
}
/// Request guard which returns an empty Authenticated struct from the request
/// if and only if the user has a cookie which proves they are authenticated with peach-web.
///
/// Note that cookies.get_private uses encryption, which means that this private cookie
/// cannot be inspected, tampered with, or manufactured by clients.
#[rocket::async_trait]
impl<'r> FromRequest<'r> for Authenticated {
type Error = LoginError;
async fn from_request(req: &'r Request<'_>) -> request::Outcome<Self, Self::Error> {
// retrieve auth state from managed state (returns `Option<bool>`).
// this value is read from the Rocket.toml config file on start-up
let authentication_is_disabled: bool = *req
.rocket()
.state::<RocketConfig>()
.map(|config| (&config.disable_auth))
.unwrap_or(&false);
if authentication_is_disabled {
let auth = Authenticated {};
request::Outcome::Success(auth)
} else {
let authenticated = req
.cookies()
.get_private(AUTH_COOKIE_KEY)
.and_then(|cookie| cookie.value().parse().ok())
.map(|_value: String| Authenticated {});
match authenticated {
Some(auth) => request::Outcome::Success(auth),
None => request::Outcome::Failure((Status::Forbidden, LoginError::UserNotLoggedIn)),
}
}
}
}
// HELPERS AND ROUTES FOR /login
#[get("/login")]
pub fn login(flash: Option<FlashMessage>) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Login".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("login", &context.into_json())
}
#[derive(Debug, Deserialize, FromForm)]
pub struct LoginForm {
pub username: String,
pub password: String,
}
/// Takes in a LoginForm and returns Ok(()) if username and password
/// are correct to authenticate with peach-web.
///
/// Note: currently there is only one user, and the username should always
/// be "admin".
pub fn verify_login_form(login_form: LoginForm) -> Result<(), PeachError> {
password_utils::verify_password(&login_form.password)
}
#[post("/login", data = "<login_form>")]
pub fn login_post(login_form: Form<LoginForm>, cookies: &CookieJar<'_>) -> TemplateOrRedirect {
match verify_login_form(login_form.into_inner()) {
Ok(_) => {
// if successful login, add a cookie indicating the user is authenticated
// and redirect to home page
// NOTE: since we currently have just one user, the value of the cookie
// is just admin (this is arbitrary).
// If we had multiple users, we could put the user_id here.
cookies.add_private(Cookie::new(AUTH_COOKIE_KEY, ADMIN_USERNAME));
TemplateOrRedirect::Redirect(Redirect::to("/"))
}
Err(_) => {
// if unsuccessful login, render /login page again
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Login".to_string()));
context.insert("flash_name", &("error".to_string()));
context.insert("flash_msg", &("Invalid password".to_string()));
TemplateOrRedirect::Template(Template::render("login", &context.into_json()))
}
}
}
// HELPERS AND ROUTES FOR /logout
#[get("/logout")]
pub fn logout(cookies: &CookieJar<'_>) -> Flash<Redirect> {
// logout authenticated user
info!("Attempting deauthentication of user.");
cookies.remove_private(Cookie::named(AUTH_COOKIE_KEY));
Flash::success(Redirect::to("/login"), "Logged out")
}
// HELPERS AND ROUTES FOR /reset_password
#[derive(Debug, Deserialize, FromForm)]
pub struct ResetPasswordForm {
pub temporary_password: String,
pub new_password1: String,
pub new_password2: String,
}
/// Verify, validate and save the submitted password. This function is publicly exposed for users who have forgotten their password.
pub fn save_reset_password_form(password_form: ResetPasswordForm) -> Result<(), PeachWebError> {
info!(
"reset password!: {} {} {}",
password_form.temporary_password, password_form.new_password1, password_form.new_password2
);
password_utils::verify_temporary_password(&password_form.temporary_password)?;
// if the previous line did not throw an error, then the secret_link is correct
password_utils::validate_new_passwords(
&password_form.new_password1,
&password_form.new_password2,
)?;
// if the previous line did not throw an error, then the new password is valid
password_utils::set_new_password(&password_form.new_password1)?;
Ok(())
}
/// Password reset request handler. This route is used by a user who is not logged in
/// and is specifically for users who have forgotten their password.
#[get("/reset_password")]
pub fn reset_password(flash: Option<FlashMessage>) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Reset Password".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("settings/admin/reset_password", &context.into_json())
}
/// Password reset form request handler. This route is used by a user who is not logged in
/// and is specifically for users who have forgotten their password.
#[post("/reset_password", data = "<reset_password_form>")]
pub fn reset_password_post(reset_password_form: Form<ResetPasswordForm>) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Reset Password".to_string()));
let (flash_name, flash_msg) = match save_reset_password_form(reset_password_form.into_inner()) {
Ok(_) => (
"success".to_string(),
"New password is now saved. Return home to login".to_string(),
),
Err(err) => (
"error".to_string(),
format!("Failed to reset password: {}", err),
),
};
context.insert("flash_name", &Some(flash_name));
context.insert("flash_msg", &Some(flash_msg));
Template::render("settings/admin/reset_password", &context.into_json())
}
// HELPERS AND ROUTES FOR /send_password_reset
/// Page for users who have forgotten their password.
/// This route is used by a user who is not logged in
/// to initiate the sending of a new password reset.
#[get("/forgot_password")]
pub fn forgot_password_page(flash: Option<FlashMessage>) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Send Password Reset".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("settings/admin/forgot_password", &context.into_json())
}
/// Send password reset request handler. This route is used by a user who is not logged in
/// and is specifically for users who have forgotten their password. A successful request results
/// in a Scuttlebutt private message being sent to the account of the device admin.
#[post("/send_password_reset")]
pub fn send_password_reset_post() -> Template {
info!("++ send password reset post");
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Send Password Reset".to_string()));
let (flash_name, flash_msg) = match password_utils::send_password_reset() {
Ok(_) => (
"success".to_string(),
"A password reset link has been sent to the admin of this device".to_string(),
),
Err(err) => (
"error".to_string(),
format!("Failed to send password reset link: {}", err),
),
};
context.insert("flash_name", &Some(flash_name));
context.insert("flash_msg", &Some(flash_msg));
Template::render("settings/admin/forgot_password", &context.into_json())
}
// HELPERS AND ROUTES FOR /settings/change_password
#[derive(Debug, Deserialize, FromForm)]
pub struct PasswordForm {
pub old_password: String,
pub new_password1: String,
pub new_password2: String,
}
/// Password save form request handler. This function is for use by a user who is already logged in to change their password.
pub fn save_password_form(password_form: PasswordForm) -> Result<(), PeachWebError> {
info!(
"change password!: {} {} {}",
password_form.old_password, password_form.new_password1, password_form.new_password2
);
password_utils::verify_password(&password_form.old_password)?;
// if the previous line did not throw an error, then the old password is correct
password_utils::validate_new_passwords(
&password_form.new_password1,
&password_form.new_password2,
)?;
// if the previous line did not throw an error, then the new password is valid
password_utils::set_new_password(&password_form.new_password1)?;
Ok(())
}
/// Change password request handler. This is used by a user who is already logged in.
#[get("/change_password")]
pub fn change_password(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings/admin".to_string()));
context.insert("title", &Some("Change Password".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("settings/admin/change_password", &context.into_json())
}
/// Change password form request handler. This route is used by a user who is already logged in.
#[post("/change_password", data = "<password_form>")]
pub fn change_password_post(password_form: Form<PasswordForm>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings/admin".to_string()));
context.insert("title", &Some("Change Password".to_string()));
let (flash_name, flash_msg) = match save_password_form(password_form.into_inner()) {
Ok(_) => (
"success".to_string(),
"New password is now saved".to_string(),
),
Err(err) => (
"error".to_string(),
format!("Failed to save new password: {}", err),
),
};
context.insert("flash_name", &Some(flash_name));
context.insert("flash_msg", &Some(flash_msg));
Template::render("settings/admin/change_password", &context.into_json())
}

View File

@ -0,0 +1,116 @@
use log::info;
use maud::{html, PreEscaped};
use peach_lib::password_utils;
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
error::PeachWebError,
templates,
utils::{
flash::{FlashRequest, FlashResponse},
theme,
},
};
// HELPER AND ROUTES FOR /auth/change (GET and POST)
/// Password change form template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let form_template = html! {
(PreEscaped("<!-- CHANGE PASSWORD FORM -->"))
div class="card center" {
form id="changePassword" class="center" action="/auth/change" method="post" {
div style="display: flex; flex-direction: column; margin-bottom: 1rem;" {
(PreEscaped("<!-- input for current password -->"))
label for="currentPassword" class="center label-small font-gray" style="width: 80%;" { "CURRENT PASSWORD" }
input id="currentPassword" class="center input" name="current_password" type="password" title="Current password" autofocus;
(PreEscaped("<!-- input for new password -->"))
label for="newPassword" class="center label-small font-gray" style="width: 80%;" { "NEW PASSWORD" }
input id="newPassword" class="center input" name="new_password1" type="password" title="New password";
(PreEscaped("<!-- input for duplicate new password -->"))
label for="newPasswordDuplicate" class="center label-small font-gray" style="width: 80%;" { "RE-ENTER NEW PASSWORD" }
input id="newPasswordDuplicate" class="center input" name="new_password2" type="password" title="New password duplicate";
(PreEscaped("<!-- save (form submission) button -->"))
input id="savePassword" class="button button-primary center" title="Add" type="submit" value="Save";
a class="button button-secondary center" href="/settings/admin" title="Cancel"{ "Cancel" }
}
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(form_template, "Change Password", Some("/settings/admin"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
/// Verify, validate and set a new password, overwriting the current password.
pub fn save_password(
current_password: &str,
new_password1: &str,
new_password2: &str,
) -> Result<(), PeachWebError> {
info!(
"Attempting password change: {} {} {}",
current_password, new_password1, new_password2
);
// check that the supplied value matches the actual current password
password_utils::verify_password(current_password)?;
// ensure that both new_password values match
password_utils::validate_new_passwords(new_password1, new_password2)?;
// hash the password and save the hash to file
password_utils::set_new_password(new_password1)?;
Ok(())
}
/// Parse current and new passwords from the submitted form, save the new
/// password hash to file (`/var/lib/peachcloud/config.yml`) and redirect
/// to the change password form URL.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
current_password: String,
new_password1: String,
new_password2: String,
}));
// save submitted admin id to file
// match on the result and set flash name and msg accordingly
let (flash_name, flash_msg) = match save_password(
&data.current_password,
&data.new_password1,
&data.new_password2,
) {
Ok(_) => (
// <cookie-name>=<cookie-value>
"flash_name=success".to_string(),
"flash_msg=New password has been saved".to_string(),
),
Err(err) => (
"flash_name=error".to_string(),
format!("flash_msg=Failed to save new password: {}", err),
),
};
// set the flash cookie headers and redirect to the change password page
Response::redirect_303("/auth/change").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,56 @@
use maud::{html, PreEscaped};
use rouille::Request;
use crate::{
templates,
utils::{flash::FlashRequest, theme},
};
// ROUTE: /auth/forgot
/// Forgot password template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let password_reset_template = html! {
(PreEscaped("<!-- PASSWORD RESET REQUEST CARD -->"))
div class="card center" {
div class="capsule capsule-container border-info" {
p class="card-text" {
"Click the 'Send Temporary Password' button to send a new temporary password which can be used to change your device password."
}
p class="card-text" style="margin-top: 1rem;" {
"The temporary password will be sent in an SSB private message to the admin of this device."
}
p class="card-text" style="margin-top: 1rem;" {
"Once you have the temporary password, click the 'Set New Password' button to reach the password reset page."
}
}
form id="sendPasswordReset" action="/auth/temporary" method="post" {
div id="buttonDiv" {
input class="button button-primary center" style="margin-top: 1rem;" type="submit" value="Send Temporary Password" title="Send temporary password to Scuttlebutt admin(s)";
a href="/auth/reset_password" class="button button-primary center" title="Set a new password using the temporary password" {
"Set New Password"
}
}
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(password_reset_template, "Send Password Reset", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,87 @@
use log::debug;
use maud::{html, PreEscaped};
use peach_lib::password_utils;
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
templates,
utils::{
flash::{FlashRequest, FlashResponse},
theme,
},
SessionData,
};
// HELPER AND ROUTES FOR /auth/login (GET and POST)
/// Login form template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let form_template = html! {
(PreEscaped("<!-- LOGIN FORM -->"))
div class="card center" {
form id="login_form" class="center" action="/auth/login" method="post" {
div style="display: flex; flex-direction: column; margin-bottom: 1rem;" {
(PreEscaped("<!-- input for password -->"))
label for="password" class="center label-small font-gray" style="width: 80%;" { "PASSWORD" }
input id="password" name="password" class="center input" type="password" title="Password for given username" autofocus;
(PreEscaped("<!-- login (form submission) button -->"))
input id="loginUser" class="button button-primary center" title="Login" type="submit" value="Login";
div class="center-text" style="margin-top: 1rem;" {
a href="/auth/forgot" class="label-small link font-gray" { "Forgot Password?" }
}
}
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body = templates::nav::build_template(form_template, "Login", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
/// Parse and verify the submitted password. If verification succeeds, set the
/// auth session cookie and redirect to the home page. If not, set a flash
/// message and redirect to the login page.
pub fn handle_form(request: &Request, session_data: &mut Option<SessionData>) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, { password: String }));
match password_utils::verify_password(&data.password) {
Ok(_) => {
debug!("Successful login attempt");
// if password verification is successful, write to `session_data`
// to authenticate the user
*session_data = Some(SessionData {
_login: "success".to_string(),
});
Response::redirect_303("/")
}
Err(err) => {
debug!("Unsuccessful login attempt");
let err_msg = format!("Invalid password: {}", err);
let (flash_name, flash_msg) = (
"flash_name=error".to_string(),
format!("flash_msg={}", err_msg),
);
// if unsuccessful login, render /login page again
Response::redirect_303("/auth/login").add_flash(flash_name, flash_msg)
}
}
}

View File

@ -0,0 +1,23 @@
use log::info;
use rouille::Response;
use crate::{utils::flash::FlashResponse, SessionData};
// ROUTE: /auth/logout (GET)
/// Deauthenticate the logged-in user by erasing the session data.
/// Redirect to the login page.
pub fn deauthenticate(session_data: &mut Option<SessionData>) -> Response {
info!("Attempting deauthentication of user.");
// erase the content of `session_data` to deauthenticate the user
*session_data = None;
let (flash_name, flash_msg) = (
"flash_name=success".to_string(),
"flash_msg=Logged out".to_string(),
);
// set the flash cookie headers and redirect to the login page
Response::redirect_303("/auth/login".to_string()).add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,6 @@
pub mod change;
pub mod forgot;
pub mod login;
pub mod logout;
pub mod reset;
pub mod temporary;

View File

@ -0,0 +1,114 @@
use log::info;
use maud::{html, PreEscaped};
use peach_lib::password_utils;
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
error::PeachWebError,
templates,
utils::{
flash::{FlashRequest, FlashResponse},
theme,
},
};
// HELPER AND ROUTES FOR /auth/reset (GET and POST)
/// Password reset form template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let form_template = html! {
(PreEscaped("<!-- RESET PASSWORD PAGE -->"))
div class="card center" {
form id="resetPassword" class="center" action="/auth/reset" method="post" {
div style="display: flex; flex-direction: column; margin-bottom: 1rem;" {
(PreEscaped("<!-- input for temporary password -->"))
label for="temporaryPassword" class="center label-small font-gray" style="width: 80%;" { "TEMPORARY PASSWORD" }
input id="temporaryPassword" class="center input" name="temporary_password" type="password" title="Temporary password" autofocus;
(PreEscaped("<!-- input for new password1 -->"))
label for="newPassword" class="center label-small font-gray" style="width: 80%;" { "NEW PASSWORD" }
input id="newPassword" class="center input" name="new_password1" type="password" title="New password";
(PreEscaped("<!-- input for duplicate new password -->"))
label for="newPasswordDuplicate" class="center label-small font-gray" style="width: 80%;" { "RE-ENTER NEW PASSWORD" }
input id="newPasswordDuplicate" class="center input" name="new_password2" type="password" title="New password duplicate";
(PreEscaped("<!-- save (form submission) button -->"))
input id="savePassword" class="button button-primary center" title="Add" type="submit" value="Save";
a class="button button-secondary center" href="/settings/admin" title="Cancel"{ "Cancel" }
}
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(form_template, "Reset Password", Some("/settings/admin"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
/// Verify, validate and set a new password, overwriting the current password.
pub fn save_password(
temporary_password: &str,
new_password1: &str,
new_password2: &str,
) -> Result<(), PeachWebError> {
info!(
"Attempting password reset: {} {} {}",
temporary_password, new_password1, new_password2
);
// check that the supplied value matches the actual temporary password
password_utils::verify_temporary_password(temporary_password)?;
// ensure that both new_password values match
password_utils::validate_new_passwords(new_password1, new_password2)?;
// hash the password and save the hash to file
password_utils::set_new_password(new_password1)?;
Ok(())
}
/// Parse temporary and new passwords from the submitted form, save the new
/// password hash to file (`/var/lib/peachcloud/config.yml`) and redirect
/// to the reset password form URL.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
temporary_password: String,
new_password1: String,
new_password2: String,
}));
// save submitted admin id to file
let (flash_name, flash_msg) = match save_password(
&data.temporary_password,
&data.new_password1,
&data.new_password2,
) {
Ok(_) => (
"flash_name=success".to_string(),
"flash_msg=New password has been saved. Return home to login".to_string(),
),
Err(err) => (
"flash_name=error".to_string(),
format!("flash_msg=Failed to reset password: {}", err),
),
};
// redirect to the configure admin page
Response::redirect_303("/auth/reset").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,42 @@
use log::debug;
use peach_lib::password_utils;
use rouille::Response;
use crate::utils::flash::FlashResponse;
// ROUTE: /auth/temporary (POST)
/// Send a temporary password as a Scuttlebutt private message to the admin(s).
///
/// This route is used by a user who is not logged in and is specifically for
/// users who have forgotten their password. A successful request results
/// in a Scuttlebutt private message being sent to the account of the device
/// admin.
///
/// Redirects to the Send Password Reset page a flash message describing the
/// outcome of the action (may be successful or unsuccessful).
pub fn handle_form() -> Response {
// save submitted admin id to file
let (flash_name, flash_msg) = match password_utils::send_password_reset() {
Ok(_) => {
debug!("Sent temporary password to device admin(s)");
(
"flash_name=success".to_string(),
"flash_msg=A temporary password has been sent to the admin(s) of this device"
.to_string(),
)
}
Err(err) => {
debug!(
"Received an error while trying to send temporary password to device admin(s): {}",
err
);
(
"error".to_string(),
format!("Failed to send temporary password: {}", err),
)
}
};
Response::redirect_303("/auth/forgot").add_flash(flash_name, flash_msg)
}

View File

@ -1,60 +0,0 @@
use log::debug;
use rocket::catch;
use rocket::response::Redirect;
use rocket_dyn_templates::Template;
use serde::Serialize;
// HELPERS AND ROUTES FOR 404 ERROR
#[derive(Debug, Serialize)]
pub struct ErrorContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl ErrorContext {
pub fn build() -> ErrorContext {
ErrorContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
#[catch(404)]
pub fn not_found() -> Template {
debug!("404 Page Not Found");
let mut context = ErrorContext::build();
context.back = Some("/".to_string());
context.title = Some("404: Page Not Found".to_string());
context.flash_name = Some("error".to_string());
context.flash_msg = Some("No resource found for given URL".to_string());
Template::render("catchers/not_found", context)
}
// HELPERS AND ROUTES FOR 500 ERROR
#[catch(500)]
pub fn internal_error() -> Template {
debug!("500 Internal Server Error");
let mut context = ErrorContext::build();
context.back = Some("/".to_string());
context.title = Some("500: Internal Server Error".to_string());
context.flash_name = Some("error".to_string());
context.flash_msg = Some("Internal server error".to_string());
Template::render("catchers/internal_error", context)
}
// HELPERS AND ROUTES FOR 403 FORBIDDEN
#[catch(403)]
pub fn forbidden() -> Redirect {
debug!("403 Forbidden");
Redirect::to("/login")
}

View File

@ -0,0 +1,106 @@
use maud::{html, PreEscaped};
use crate::{templates, utils::theme};
/// Guide template builder.
pub fn build_template() -> PreEscaped<String> {
// render the guide template html
let guide_template = html! {
(PreEscaped("<!-- GUIDE -->"))
div class="card card-wide center" {
div class="capsule capsule-container border-info" {
(PreEscaped("<!-- GETTING STARTED -->"))
details {
summary class="card-text link" { "Getting started" }
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"The Scuttlebutt server (sbot) will be inactive when you first run PeachCloud. This is to allow configuration parameters to be set before it is activated for the first time. Navigate to the "
strong {
a href="/settings/scuttlebutt/configure" class="link font-gray" {
"Sbot Configuration"
}
}
" page to configure your system. The default configuration will be fine for most usecases."
}
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"Once the configuration is set, navigate to the "
strong {
a href="/settings/scuttlebutt" class="link font-gray" {
"Scuttlebutt settings menu"
}
}
" to start the sbot. If the server starts successfully, you will see a green smiley face on the home page. If the face is orange and sleeping, that means the sbot is still inactive (ie. the process is not running). If the face is red and dead, that means the sbot failed to start - indicated an error. For now, the best way to gain insight into the problem is to check the systemd log. Open a terminal and enter: "
code { "systemctl --user status go-sbot.service" }
". The log output may give some clues about the source of the error."
}
}
(PreEscaped("<!-- BUG REPORTS -->"))
details {
summary class="card-text link" { "Submit a bug report" }
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"Bug reports can be submitted by "
strong {
a href="https://git.coopcloud.tech/PeachCloud/peach-workspace/issues/new?template=BUG_TEMPLATE.md" class="link font-gray" {
"filing an issue"
}
}
" on the peach-workspace git repo. Before filing a report, first check to see if an issue already exists for the bug you've encountered. If not, you're invited to submit a new report; the template will guide you through several questions."
}
}
(PreEscaped("<!-- REQUEST SUPPORT -->"))
details {
summary class="card-text link" { "Share feedback & request support" }
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"You're invited to share your thoughts and experiences of PeachCloud in the #peachcloud channel on Scuttlebutt. The channel is also a good place to ask for help."
}
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"Alternatively, we have a "
strong {
a href="https://matrix.to/#/#peachcloud:matrix.org" class="link font-gray" {
"Matrix channel"
}
}
" for discussion about PeachCloud and you can also reach out to @glyph "
strong {
a href="mailto:glyph@mycelial.technology" class="link font-gray" {
"via email"
}
}
"."
}
}
(PreEscaped("<!-- CONTRIBUTE -->"))
details {
summary class="card-text link" { "Contribute to PeachCloud" }
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"PeachCloud is free, open-source software and relies on donations and grants to fund develop. Donations can be made on our "
strong {
a href="https://opencollective.com/peachcloud" class="link font-gray" {
"Open Collective"
}
}
" page."
}
p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;" {
"Programmers, designers, artists and writers are also welcome to contribute to the project. Please visit the "
strong {
a href="https://git.coopcloud.tech/PeachCloud/peach-workspace" class="link font-gray" {
"main PeachCloud git repository"
}
}
" to find out more details or contact the team via Scuttlebutt, Matrix or email."
}
}
}
}
};
// wrap the nav bars around the home template content
// title is "" and back button link is `None` because this is the homepage
let body = templates::nav::build_template(guide_template, "Guide", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,105 @@
use maud::{html, PreEscaped};
use peach_lib::sbot::SbotStatus;
use crate::{templates, utils::theme};
/// Read the state of the go-sbot process and define status-related
/// elements accordingly.
fn render_status_elements<'a>() -> (&'a str, &'a str, &'a str) {
// retrieve go-sbot systemd process status
let sbot_status = SbotStatus::read();
// conditionally render the center circle class, center circle text and
// status circle class color based on the go-sbot process state
if let Ok(status) = sbot_status {
if status.state == Some("active".to_string()) {
("circle-success", "^_^", "border-success")
} else if status.state == Some("inactive".to_string()) {
("circle-warning", "z_z", "border-warning")
} else {
("circle-error", "x_x", "border-danger")
}
} else {
("circle-error", "x_x", "border-danger")
}
}
/// Home template builder.
pub fn build_template() -> PreEscaped<String> {
let (circle_color, center_circle_text, circle_border) = render_status_elements();
// render the home template html
let home_template = html! {
(PreEscaped("<!-- RADIAL MENU -->"))
div class="grid" {
(PreEscaped("<!-- top-left -->"))
(PreEscaped("<!-- PEERS LINK AND ICON -->"))
a class="top-left" href="/scuttlebutt/peers" title="Scuttlebutt Peers" {
div class="circle circle-small border-circle-small border-ssb" {
img class="icon-medium" src="/icons/users.svg";
}
}
(PreEscaped("<!-- top-middle -->"))
(PreEscaped("<!-- CURRENT USER LINK AND ICON -->"))
a class="top-middle" href="/scuttlebutt/profile" title="Profile" {
div class="circle circle-small border-circle-small border-ssb" {
img class="icon-medium" src="/icons/user.svg";
}
}
(PreEscaped("<!-- top-right -->"))
(PreEscaped("<!-- MESSAGES LINK AND ICON -->"))
a class="top-right" href="/scuttlebutt/private" title="Private Messages" {
div class="circle circle-small border-circle-small border-ssb" {
img class="icon-medium" src="/icons/envelope.svg";
}
}
(PreEscaped("<!-- middle -->"))
a class="middle" {
div class={ "circle circle-large " (circle_color) } {
p style="font-size: 4rem; color: var(--near-black);" {
(center_circle_text)
}
}
}
(PreEscaped("<!-- bottom-left -->"))
(PreEscaped("<!-- SYSTEM STATUS LINK AND ICON -->"))
a class="bottom-left" href="/status/scuttlebutt" title="Status" {
div class={ "circle circle-small border-circle-small " (circle_border) } {
img class="icon-medium" src="/icons/heart-pulse.svg";
}
}
/*
TODO: render the path of the status circle button based on the mode
{%- if standalone_mode == true -%}
<a class="bottom-left" href="/status/scuttlebutt" title="Status">
{% else -%}
<a class="bottom-left" href="/status" title="Status">
{%- endif -%}
*/
(PreEscaped("<!-- bottom-middle -->"))
(PreEscaped("<!-- PEACHCLOUD GUIDEBOOK LINK AND ICON -->"))
a class="bottom-middle" href="/guide" title="Guide" {
div class="circle circle-small border-circle-small border-info" {
img class="icon-medium" src="/icons/book.svg";
}
}
(PreEscaped("<!-- bottom-right -->"))
(PreEscaped("<!-- SYSTEM SETTINGS LINK AND ICON -->"))
a class="bottom-right" href="/settings" title="Settings" {
div class="circle circle-small border-circle-small border-settings" {
img class="icon-medium" src="/icons/cog.svg";
}
}
}
};
// wrap the nav bars around the home template content
// title is "" and back button link is `None` because this is the homepage
let body = templates::nav::build_template(home_template, "", None);
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -1,37 +0,0 @@
use rocket::{get, request::FlashMessage, State};
use rocket_dyn_templates::{tera::Context, Template};
use crate::routes::authentication::Authenticated;
use crate::RocketConfig;
// HELPERS AND ROUTES FOR / (HOME PAGE)
#[get("/")]
pub fn home(_auth: Authenticated, config: &State<RocketConfig>) -> Template {
let mut context = Context::new();
context.insert("flash_name", &None::<()>);
context.insert("flash_msg", &None::<()>);
context.insert("title", &None::<()>);
// pass in mode from managed state so we can define appropriate urls in template
context.insert("standalone_mode", &config.standalone_mode);
Template::render("home", &context.into_json())
}
// HELPERS AND ROUTES FOR /help
#[get("/help")]
pub fn help(flash: Option<FlashMessage>) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Help".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("help", &context.into_json())
}

View File

@ -1,6 +1,8 @@
pub mod authentication;
pub mod catchers;
pub mod index;
//pub mod catchers;
//pub mod index;
pub mod guide;
pub mod home;
pub mod scuttlebutt;
pub mod settings;
pub mod status;

View File

@ -1,365 +0,0 @@
//! Routes for Scuttlebutt related functionality.
use rocket::{
form::{Form, FromForm},
get, post,
request::FlashMessage,
response::{Flash, Redirect},
serde::{Deserialize, Serialize},
uri,
};
use rocket_dyn_templates::Template;
use crate::routes::authentication::Authenticated;
// HELPERS AND ROUTES FOR /private
#[derive(Debug, Serialize)]
pub struct PrivateContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl PrivateContext {
pub fn build() -> PrivateContext {
PrivateContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A private message composition and publication page.
#[get("/private")]
pub fn private(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = PrivateContext::build();
context.back = Some("/".to_string());
context.title = Some("Private Messages".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/messages", &context)
}
// HELPERS AND ROUTES FOR /peers
#[derive(Debug, Serialize)]
pub struct PeerContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl PeerContext {
pub fn build() -> PeerContext {
PeerContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A peer menu which allows navigating to lists of friends, follows, followers and blocks.
#[get("/peers")]
pub fn peers(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = PeerContext::build();
context.back = Some("/".to_string());
context.title = Some("Scuttlebutt Peers".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/peers", &context)
}
// HELPERS AND ROUTES FOR /post/publish
#[derive(Debug, Deserialize, FromForm)]
pub struct Post {
pub text: String,
}
/// Publish a public Scuttlebutt post. Redirects to profile page of the PeachCloud local identity with a flash message describing the outcome of the action (may be successful or unsuccessful).
#[post("/publish", data = "<post>")]
pub fn publish(
post: Form<Post>,
flash: Option<FlashMessage>,
_auth: Authenticated,
) -> Flash<Redirect> {
let post_text = &post.text;
// perform the sbotcli publish action using post_text
// if successful, redirect to home profile page and flash "success"
// if error, redirect to home profile page and flash "error"
// redirect to the profile template without public key ("home" / local profile)
let pub_key: std::option::Option<&str> = None;
let profile_url = uri!(profile(pub_key));
// consider adding the message reference to the flash message (or render it in the template for
// `profile`
Flash::success(Redirect::to(profile_url), "Published public post")
}
// HELPERS AND ROUTES FOR /follow
#[derive(Debug, Deserialize, FromForm)]
pub struct PublicKey {
pub key: String,
}
/// Follow a Scuttlebutt profile specified by the given public key. Redirects to the appropriate profile page with a flash message describing the outcome of the action (may be successful or unsuccessful).
#[post("/follow", data = "<pub_key>")]
pub fn follow(
pub_key: Form<PublicKey>,
flash: Option<FlashMessage>,
_auth: Authenticated,
) -> Flash<Redirect> {
let public_key = &pub_key.key;
// perform the sbotcli follow action using &pub_key.0
// if successful, redirect to profile page with provided public key and flash "success"
// if error, redirect to profile page with provided public key and flash "error"
// redirect to the profile template with provided public key
let profile_url = uri!(profile(Some(public_key)));
let success_msg = format!("Followed {}", public_key);
Flash::success(Redirect::to(profile_url), success_msg)
}
// HELPERS AND ROUTES FOR /unfollow
/// Unfollow a Scuttlebutt profile specified by the given public key. Redirects to the appropriate profile page with a flash message describing the outcome of the action (may be successful or unsuccessful).
#[post("/unfollow", data = "<pub_key>")]
pub fn unfollow(
pub_key: Form<PublicKey>,
flash: Option<FlashMessage>,
_auth: Authenticated,
) -> Flash<Redirect> {
let public_key = &pub_key.key;
// perform the sbotcli unfollow action using &pub_key.0
// if successful, redirect to profile page with provided public key and flash "success"
// if error, redirect to profile page with provided public key and flash "error"
// redirect to the profile template with provided public key
let profile_url = uri!(profile(Some(public_key)));
let success_msg = format!("Unfollowed {}", public_key);
Flash::success(Redirect::to(profile_url), success_msg)
}
// HELPERS AND ROUTES FOR /block
/// Block a Scuttlebutt profile specified by the given public key. Redirects to the appropriate profile page with a flash message describing the outcome of the action (may be successful or unsuccessful).
#[post("/block", data = "<pub_key>")]
pub fn block(
pub_key: Form<PublicKey>,
flash: Option<FlashMessage>,
_auth: Authenticated,
) -> Flash<Redirect> {
let public_key = &pub_key.key;
// perform the sbotcli block action using &pub_key.0
// if successful, redirect to profile page with provided public key and flash "success"
// if error, redirect to profile page with provided public key and flash "error"
// redirect to the profile template with provided public key
let profile_url = uri!(profile(Some(public_key)));
let success_msg = format!("Blocked {}", public_key);
Flash::success(Redirect::to(profile_url), success_msg)
}
// HELPERS AND ROUTES FOR /profile
#[derive(Debug, Serialize)]
pub struct ProfileContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl ProfileContext {
pub fn build() -> ProfileContext {
ProfileContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A Scuttlebutt profile, specified by a public key. It may be our own profile or the profile of a peer. If not public key query parameter is provided, the local profile is displayed (ie. the profile of the public key associated with the local PeachCloud device).
#[get("/profile?<pub_key>")]
pub fn profile(
pub_key: Option<&str>,
flash: Option<FlashMessage>,
_auth: Authenticated,
) -> Template {
let mut context = ProfileContext::build();
context.back = Some("/".to_string());
context.title = Some("Profile".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/profile", &context)
}
// HELPERS AND ROUTES FOR /friends
#[derive(Debug, Serialize)]
pub struct FriendsContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl FriendsContext {
pub fn build() -> FriendsContext {
FriendsContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A list of friends (mutual follows), with each list item displaying the name, image and public
/// key of the peer.
#[get("/friends")]
pub fn friends(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = FriendsContext::build();
context.back = Some("/scuttlebutt/peers".to_string());
context.title = Some("Friends".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/peers_list", &context)
}
// HELPERS AND ROUTES FOR /follows
#[derive(Debug, Serialize)]
pub struct FollowsContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl FollowsContext {
pub fn build() -> FollowsContext {
FollowsContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A list of follows (peers we follow who do not follow us), with each list item displaying the name, image and public
/// key of the peer.
#[get("/follows")]
pub fn follows(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = FollowsContext::build();
context.back = Some("/scuttlebutt/peers".to_string());
context.title = Some("Follows".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/peers_list", &context)
}
// HELPERS AND ROUTES FOR /followers
#[derive(Debug, Serialize)]
pub struct FollowersContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl FollowersContext {
pub fn build() -> FollowersContext {
FollowersContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A list of followers (peers who follow us but who we do not follow), with each list item displaying the name, image and public
/// key of the peer.
#[get("/followers")]
pub fn followers(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = FollowersContext::build();
context.back = Some("/scuttlebutt/peers".to_string());
context.title = Some("Followers".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/peers_list", &context)
}
// HELPERS AND ROUTES FOR /blocks
#[derive(Debug, Serialize)]
pub struct BlocksContext {
pub back: Option<String>,
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
pub title: Option<String>,
}
impl BlocksContext {
pub fn build() -> BlocksContext {
BlocksContext {
back: None,
flash_name: None,
flash_msg: None,
title: None,
}
}
}
/// A list of blocks (peers we've blocked previously), with each list item displaying the name, image and public
/// key of the peer.
#[get("/blocks")]
pub fn blocks(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = BlocksContext::build();
context.back = Some("/scuttlebutt/peers".to_string());
context.title = Some("Blocks".to_string());
// check to see if there is a flash message to display
if let Some(flash) = flash {
// add flash message contents to the context object
context.flash_name = Some(flash.kind().to_string());
context.flash_msg = Some(flash.message().to_string());
};
Template::render("scuttlebutt/peers_list", &context)
}

View File

@ -0,0 +1,42 @@
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::{flash::FlashResponse, sbot};
// ROUTE: /scuttlebutt/block
/// Block a Scuttlebutt profile specified by the given public key.
///
/// Parse the public key from the submitted form and publish a contact message.
/// Redirect to the appropriate profile page with a flash message describing
/// the outcome of the action (may be successful or unsuccessful).
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
public_key: String,
}));
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
match sbot::block_peer(&data.public_key) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Social interactions are unavailable.".to_string(),
),
};
let url = format!("/scuttlebutt/profile/{}", data.public_key);
Response::redirect_303(url).add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,29 @@
use maud::PreEscaped;
use crate::{
templates,
utils::{sbot, theme},
};
// ROUTE: /scuttlebutt/blocks
/// Scuttlebutt blocks list template builder.
pub fn build_template() -> PreEscaped<String> {
// retrieve the list of blocked peers
match sbot::get_blocks_list() {
// populate the peers_list template with blocks and render it
Ok(blocks) => templates::peers_list::build_template(blocks, "Blocks"),
Err(e) => {
// render the sbot error template with the error message
let error_template = templates::error::build_template(e.to_string());
// wrap the nav bars around the error template content
let body = templates::nav::build_template(error_template, "Blocks", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
}
}

View File

@ -0,0 +1,42 @@
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::{flash::FlashResponse, sbot};
// ROUTE: /scuttlebutt/follow
/// Follow a Scuttlebutt profile specified by the given public key.
///
/// Parse the public key from the submitted form and publish a contact message.
/// Redirect to the appropriate profile page with a flash message describing
/// the outcome of the action (may be successful or unsuccessful).
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
public_key: String,
}));
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
match sbot::follow_peer(&data.public_key) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Social interactions are unavailable.".to_string(),
),
};
let url = format!("/scuttlebutt/profile/{}", data.public_key);
Response::redirect_303(url).add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,29 @@
use maud::PreEscaped;
use crate::{
templates,
utils::{sbot, theme},
};
// ROUTE: /scuttlebutt/follows
/// Scuttlebutt follows list template builder.
pub fn build_template() -> PreEscaped<String> {
// retrieve the list of follows
match sbot::get_follows_list() {
// populate the peers_list template with follows
Ok(follows) => templates::peers_list::build_template(follows, "Follows"),
Err(e) => {
// render the sbot error template with the error message
let error_template = templates::error::build_template(e.to_string());
// wrap the nav bars around the error template content
let body = templates::nav::build_template(error_template, "Follows", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
}
}

View File

@ -0,0 +1,29 @@
use maud::PreEscaped;
use crate::{
templates,
utils::{sbot, theme},
};
// ROUTE: /scuttlebutt/friends
/// Scuttlebutt friends list template builder.
pub fn build_template() -> PreEscaped<String> {
// retrieve the list of friends
match sbot::get_friends_list() {
// populate the peers_list template with friends and render it
Ok(friends) => templates::peers_list::build_template(friends, "Friends"),
Err(e) => {
// render the sbot error template with the error message
let error_template = templates::error::build_template(e.to_string());
// wrap the nav bars around the error template content
let body = templates::nav::build_template(error_template, "Friends", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
}
}

View File

@ -0,0 +1,97 @@
use maud::{html, Markup, PreEscaped};
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
templates,
utils::{
flash::{FlashRequest, FlashResponse},
sbot, theme,
},
};
// ROUTE: /scuttlebutt/invites
/// Render the invite form template.
fn invite_form_template(
flash_name: Option<&str>,
flash_msg: Option<&str>,
invite_code: Option<&str>,
) -> Markup {
html! {
(PreEscaped("<!-- SCUTTLEBUTT INVITE FORM -->"))
div class="card center" {
form id="invites" class="center" action="/scuttlebutt/invites" method="post" {
div class="center" style="width: 80%;" {
label for="inviteUses" class="label-small font-gray" title="Number of times the invite code can be reused" { "USES" }
input type="number" id="inviteUses" name="uses" min="1" max="150" size="3" value="1";
@if let Some(code) = invite_code {
p class="card-text" style="margin-top: 1rem; user-select: all;" title="Invite code" {
(code)
}
}
}
(PreEscaped("<!-- BUTTONS -->"))
input id="createInvite" class="button button-primary center" style="margin-top: 1rem;" type="submit" title="Create a new invite code" value="Create";
a id="cancel" class="button button-secondary center" href="/scuttlebutt/peers" title="Cancel" { "Cancel" }
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
// avoid displaying the invite code-containing flash msg
@if name != "code" {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
}
}
}
/// Scuttlebutt invite template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
// if flash_name is "code" then flash_msg will be an invite code
let invite_code = if flash_name == Some("code") {
flash_msg
} else {
None
};
let invite_form_template = match SbotStatus::read() {
// only render the invite form template if the sbot is active
Ok(status) if status.state == Some("active".to_string()) => {
html! { (invite_form_template(flash_name, flash_msg, invite_code)) }
}
_ => {
// the sbot is not active; render a message instead of the invite form
templates::inactive::build_template("Invite creation is unavailable.")
}
};
let body =
templates::nav::build_template(invite_form_template, "Invites", Some("/scuttlebutt/peers"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
templates::base::build_template(body, theme)
}
/// Parse the invite uses data and attempt to generate an invite code.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
// the number of times the invite code can be used
uses: u16,
}));
let (flash_name, flash_msg) = match sbot::create_invite(data.uses) {
Ok(code) => ("flash_name=code".to_string(), format!("flash_msg={}", code)),
Err(e) => ("flash_name=error".to_string(), format!("flash_msg={}", e)),
};
Response::redirect_303("/scuttlebutt/invites").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,14 @@
pub mod block;
pub mod blocks;
pub mod follow;
pub mod follows;
pub mod friends;
pub mod invites;
pub mod peers;
pub mod private;
pub mod profile;
pub mod profile_update;
pub mod publish;
pub mod search;
pub mod unblock;
pub mod unfollow;

View File

@ -0,0 +1,45 @@
use maud::{html, PreEscaped};
use peach_lib::sbot::SbotStatus;
use crate::{templates, utils::theme};
/// Scuttlebutt peer menu template builder.
///
/// A peer menu which allows navigating to lists of friends, follows, followers
/// and blocks, as well as accessing the invite creation form.
pub fn build_template() -> PreEscaped<String> {
let menu_template = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
// render the scuttlebutt peers menu
html! {
(PreEscaped("<!-- SCUTTLEBUTT PEERS -->"))
div class="card center" {
div class="card-container" {
(PreEscaped("<!-- BUTTONS -->"))
div id="buttons" {
a id="search" class="button button-primary center" href="/scuttlebutt/search" title="Search for a peer" { "Search" }
a id="friends" class="button button-primary center" href="/scuttlebutt/friends" title="List friends" { "Friends" }
a id="follows" class="button button-primary center" href="/scuttlebutt/follows" title="List follows" { "Follows" }
a id="blocks" class="button button-primary center" href="/scuttlebutt/blocks" title="List blocks" { "Blocks" }
a id="invites" class="button button-primary center" href="/scuttlebutt/invites" title="Create invites" { "Invites" }
}
}
}
}
}
_ => {
// the sbot is not active; render a message instead of the menu
templates::inactive::build_template("Social lists and interactions are unavailable.")
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body = templates::nav::build_template(menu_template, "Scuttlebutt Peers", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,131 @@
use maud::{html, Markup, PreEscaped};
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
templates,
utils::{
flash::{FlashRequest, FlashResponse},
sbot, theme,
},
};
// ROUTE: /scuttlebutt/private
fn public_key_input_template(ssb_id: &Option<String>) -> Markup {
match ssb_id {
Some(id) => {
html! { input type="text" id="publicKey" name="recipient" placeholder="@xYz...=.ed25519" value=(id); }
}
// render the input with autofocus if no ssb_id has been provided
None => {
html! { input type="text" id="publicKey" name="recipient" placeholder="@xYz...=.ed25519" autofocus; }
}
}
}
fn private_message_textarea_template(ssb_id: &Option<String>) -> Markup {
match ssb_id {
Some(_) => {
html! { textarea id="privatePost" class="center input message-input" name="text" title="Compose a private message" placeholder="Write a private message..." autofocus { "" } }
}
// render the textarea with autofocus if an ssb_id has been provided
None => {
html! { textarea id="privatePost" class="center input message-input" name="text" title="Compose a private message" placeholder="Write a private message..." { "" } }
}
}
}
/// Scuttlebutt private message template builder.
///
/// Render a form for publishing a provate message. The recipient input field
/// is populated with the provided ssb_id. If no recipient is provided, the
/// template autofocuses on the recipient input field.
pub fn build_template(request: &Request, ssb_id: Option<String>) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let profile_template = match SbotStatus::read() {
// only render the private message elements if the sbot is active
Ok(status) if status.state == Some("active".to_string()) => {
// retrieve the local public key (set to blank if an error is returned)
let local_id = match sbot::get_local_id() {
Ok(id) => id,
Err(_) => "".to_string(),
};
html! {
(PreEscaped("<!-- SCUTTLEBUTT PRIVATE MESSAGE FORM -->"))
div class="card card-wide center" {
form id="sbotConfig" class="center" action="/scuttlebutt/private" method="post" {
div class="center" style="display: flex; flex-direction: column; margin-bottom: 1rem;" title="Public key (ID) of the peer being written to" {
label for="publicKey" class="label-small font-gray" {
"PUBLIC KEY"
}
(public_key_input_template(&ssb_id))
}
(PreEscaped("<!-- input for message contents -->"))
(private_message_textarea_template(&ssb_id))
(PreEscaped("<!-- hidden input field to pass the public key of the local peer -->"))
input type="hidden" id="localId" name="id" value=(local_id);
(PreEscaped("<!-- BUTTONS -->"))
input id="publish" class="button button-primary center" type="submit" style="margin-top: 1rem;" title="Publish private message to peer" value="Publish";
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
}
}
_ => templates::inactive::build_template("Private messaging is unavailable."),
};
let body = templates::nav::build_template(profile_template, "Profile", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
templates::base::build_template(body, theme)
}
/// Publish a private message.
///
/// Parse the public key and private message text from the submitted form
/// and publish the message. Set a flash message communicating the outcome
/// of the publishing attempt and redirect to the private message page.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
id: String,
text: String,
recipient: String
}));
// now we need to add the local id to the recipients vector,
// otherwise the local id will not be able to read the message.
let recipients = vec![data.id, data.recipient];
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
match sbot::publish_private_msg(data.text, recipients) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Private messaging is unavailable.".to_string(),
),
};
Response::redirect_303("/scuttlebutt/private").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,178 @@
use maud::{html, Markup, PreEscaped};
use peach_lib::sbot::SbotStatus;
use rouille::Request;
use crate::{
templates,
utils::{flash::FlashRequest, sbot, sbot::Profile, theme},
};
// ROUTE: /scuttlebutt/profile
fn public_post_form_template() -> Markup {
html! {
(PreEscaped("<!-- PUBLIC POST FORM -->"))
form id="postForm" class="center" action="/scuttlebutt/publish" method="post" {
(PreEscaped("<!-- input for message contents -->"))
textarea id="publicPost" class="center input message-input" name="text" title="Compose Public Post" placeholder="Write a public post..." { }
input id="publishPost" class="button button-primary center" title="Publish" type="submit" value="Publish";
}
}
}
fn profile_info_box_template(profile: &Profile) -> Markup {
html! {
(PreEscaped("<!-- PROFILE INFO BOX -->"))
div class="capsule capsule-profile border-ssb" title="Scuttlebutt account profile information" {
@if profile.is_local_profile {
(PreEscaped("<!-- edit profile button -->"))
a class="nav-icon-right" href="/scuttlebutt/profile/update" title="Edit your profile" {
img id="editProfile" class="icon-small icon-active" src="/icons/pencil.svg" alt="Edit";
}
}
// render the profile bio: picture, id, name, image & description
(profile_bio_template(profile))
}
}
}
fn profile_bio_template(profile: &Profile) -> Markup {
html! {
(PreEscaped("<!-- PROFILE BIO -->"))
(PreEscaped("<!-- profile picture -->"))
// only try to render profile pic if we have the blob
@match &profile.blob_path {
Some(blob_path) if profile.blob_exists => {
img id="profilePicture" class="icon-large" src={ "/blob/" (blob_path) } title="Profile picture" alt="Profile picture";
},
_ => {
// use a placeholder image if we don't have the blob
img id="peerImage" class="icon icon-active list-icon" src="/icons/user.svg" alt="Placeholder profile image";
}
}
(PreEscaped("<!-- name, public key & description -->"))
p id="profileName" class="card-text" title="Name" {
@if let Some(name) = &profile.name {
(name)
} @else {
i { "Name is unavailable or has not been set" }
}
}
label class="label-small label-ellipsis font-gray" style="user-select: all;" for="profileName" title="Public Key" {
@if let Some(id) = &profile.id {
(id)
} @else {
"Public key unavailable"
}
}
p id="profileDescription" style="margin-top: 1rem" class="card-text" title="Description" {
@if let Some(description) = &profile.description {
(description)
} @else {
i { "Description is unavailable or has not been set" }
}
}
}
}
fn social_interaction_buttons_template(profile: &Profile) -> Markup {
html! {
(PreEscaped("<!-- BUTTONS -->"))
div id="buttons" style="margin-top: 2rem;" {
@match (profile.following, &profile.id) {
(Some(false), Some(ssb_id)) => {
form id="followForm" class="center" action="/scuttlebutt/follow" method="post" {
input type="hidden" id="publicKey" name="public_key" value=(ssb_id);
input id="followPeer" class="button button-primary center" type="submit" title="Follow Peer" value="Follow";
}
},
(Some(true), Some(ssb_id)) => {
form id="unfollowForm" class="center" action="/scuttlebutt/unfollow" method="post" {
input type="hidden" id="publicKey" name="public_key" value=(ssb_id);
input id="unfollowPeer" class="button button-primary center" type="submit" title="Unfollow Peer" value="Unfollow";
}
},
_ => p { "Unable to determine follow state" }
}
@match (profile.blocking, &profile.id) {
(Some(false), Some(ssb_id)) => {
form id="blockForm" class="center" action="/scuttlebutt/block" method="post" {
input type="hidden" id="publicKey" name="public_key" value=(ssb_id);
input id="blockPeer" class="button button-primary center" type="submit" title="Block Peer" value="Block";
}
},
(Some(true), Some(ssb_id)) => {
form id="unblockForm" class="center" action="/scuttlebutt/unblock" method="post" {
input type="hidden" id="publicKey" name="public_key" value=(ssb_id);
input id="unblockPeer" class="button button-primary center" type="submit" title="Unblock Peer" value="Unblock";
}
},
_ => p { "Unable to determine block state" }
}
@if let Some(ssb_id) = &profile.id {
form class="center" {
a id="privateMessage" class="button button-primary center" href={ "/scuttlebutt/private/" (ssb_id) } title="Private Message" {
"Send Private Message"
}
}
}
}
}
}
/// Scuttlebutt profile template builder.
///
/// Render a Scuttlebutt profile, either for the local profile or for a peer
/// specified by a public key. If the public key query parameter is not
/// provided, the local profile is displayed (ie. the profile of the public key
/// associated with the local PeachCloud device).
pub fn build_template(request: &Request, ssb_id: Option<String>) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let profile_template = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
// TODO: validate ssb_id and return error template
// retrieve the profile info
match sbot::get_profile_info(ssb_id) {
Ok(profile) => {
// render the profile template
html! {
(PreEscaped("<!-- SSB PROFILE -->"))
div class="card card-wide center" {
// render profile info box
(profile_info_box_template(&profile))
@if profile.is_local_profile {
// render the public post form template
(public_post_form_template())
} @else {
// render follow / unfollow, block / unblock and
// private message buttons
(social_interaction_buttons_template(&profile))
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
}
}
Err(e) => {
// render the sbot error template with the error message
templates::error::build_template(e.to_string())
}
}
}
_ => templates::inactive::build_template("Profile is unavailable."),
};
let body = templates::nav::build_template(profile_template, "Profile", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,173 @@
use maud::{html, PreEscaped};
use peach_lib::sbot::SbotStatus;
use rouille::{input::post::BufferedFile, post_input, try_or_400, Request, Response};
use crate::{
templates,
utils::{
flash::{FlashRequest, FlashResponse},
sbot,
sbot::Profile,
theme,
},
};
// ROUTE: /scuttlebutt/profile/update
fn parse_profile_info(profile: Profile) -> (String, String, String) {
let id = match profile.id {
Some(id) => id,
_ => "Public key unavailable".to_string(),
};
let name = match profile.name {
Some(name) => name,
_ => "Name unavailable".to_string(),
};
let description = match profile.description {
Some(description) => description,
_ => "Description unavailable".to_string(),
};
(id, name, description)
}
/// Scuttlebutt profile update template builder.
///
/// Serve a form for the purpose of updating the name, description and picture
/// for the local Scuttlebutt profile.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let profile_update_template = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
// retrieve the local profile info
match sbot::get_profile_info(None) {
Ok(profile) => {
let (id, name, description) = parse_profile_info(profile);
// render the scuttlebutt profile update form
html! {
(PreEscaped("<!-- SSB PROFILE UPDATE FORM -->"))
div class="card card-wide center" {
form id="profileInfo" class="center" enctype="multipart/form-data" action="/scuttlebutt/profile/update" method="post" {
div style="display: flex; flex-direction: column" {
label for="name" class="label-small font-gray" {
"NAME"
}
input style="margin-bottom: 1rem;" type="text" id="name" name="new_name" placeholder="Choose a name for your profile..." value=(name);
label for="description" class="label-small font-gray" {
"DESCRIPTION"
}
textarea id="description" class="message-input" style="margin-bottom: 1rem;" name="new_description" placeholder="Write a description for your profile..." {
(description)
}
label for="image" class="label-small font-gray" {
"IMAGE"
}
input type="file" id="fileInput" class="font-normal" name="image";
}
input type="hidden" name="id" value=(id);
input type="hidden" name="current_name" value=(name);
input type="hidden" name="current_description" value=(description);
div id="buttonDiv" style="margin-top: 2rem;" {
input id="updateProfile" class="button button-primary center" title="Publish" type="submit" value="Publish";
a class="button button-secondary center" href="/scuttlebutt/profile" title="Cancel" { "Cancel" }
}
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
}
}
Err(e) => {
// render the sbot error template with the error message
templates::error::build_template(e.to_string())
}
}
}
_ => {
// the sbot is not active; render a message instead of the form
templates::inactive::build_template("Profile is unavailable.")
}
};
let body = templates::nav::build_template(
profile_update_template,
"Profile",
Some("/scuttlebutt/profile"),
);
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
templates::base::build_template(body, theme)
}
/// Update the name, description and picture for the local Scuttlebutt profile.
///
/// Redirects to profile page of the PeachCloud local identity with a flash
/// message describing the outcome of the action (may be successful or
/// unsuccessful).
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
id: String,
current_name: String,
current_description: String,
new_name: Option<String>,
new_description: Option<String>,
image: Option<BufferedFile>,
}));
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
// we can't pass `data` into the function (due to macro creation)
// so we pass in each individual value instead
match sbot::update_profile_info(
data.current_name,
data.current_description,
data.new_name,
data.new_description,
data.image,
) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Profile is unavailable.".to_string(),
),
};
Response::redirect_303("/scuttlebutt/profile/update").add_flash(flash_name, flash_msg)
}
/*
match sbot::validate_public_key(&data.public_key) {
Ok(_) => {
let url = format!("/scuttlebutt/profile?={}", &data.public_key);
Response::redirect_303(url)
}
Err(err) => {
let (flash_name, flash_msg) =
("flash_name=error".to_string(), format!("flash_msg={}", err));
Response::redirect_303("/scuttlebutt/search").add_flash(flash_name, flash_msg)
}
}
}
*/

View File

@ -0,0 +1,41 @@
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::{flash::FlashResponse, sbot};
// ROUTE: /scuttlebutt/publish
/// Publish a public Scuttlebutt post.
///
/// Parse the post text from the submitted form and publish the message.
/// Redirect to the profile page of the PeachCloud local identity with a flash
/// message describing the outcome of the action (may be successful or
/// unsuccessful).
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
text: String,
}));
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
match sbot::publish_public_post(data.text) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Public posting is unavailable.".to_string(),
),
};
Response::redirect_303("/scuttlebutt/profile").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,69 @@
use maud::{html, PreEscaped};
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
templates,
utils::{
flash::{FlashRequest, FlashResponse},
sbot, theme,
},
};
// ROUTE: /scuttlebutt/search
/// Scuttlebutt peer search template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let search_template = html! {
(PreEscaped("<!-- PEER SEARCH FORM -->"))
div class="card center" {
form id="sbotConfig" class="center" action="/scuttlebutt/search" method="post" {
div class="center" style="display: flex; flex-direction: column; margin-bottom: 2rem;" title="Public key (ID) of a peer" {
label for="publicKey" class="label-small font-gray" { "PUBLIC KEY" }
input type="text" id="publicKey" name="public_key" placeholder="@xYz...=.ed25519" autofocus;
}
(PreEscaped("<!-- BUTTONS -->"))
input id="search" class="button button-primary center" type="submit" title="Search for peer" value="Search";
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
}
};
let body =
templates::nav::build_template(search_template, "Search", Some("/scuttlebutt/peers"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
templates::base::build_template(body, theme)
}
/// Parse the public key, verify that it's valid and then redirect to the
/// profile of the given key.
///
/// If the public key is invalid, set an error flash message and redirect.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
public_key: String,
}));
match sbot::validate_public_key(&data.public_key) {
Ok(_) => {
let url = format!("/scuttlebutt/profile/{}", &data.public_key);
Response::redirect_303(url)
}
Err(err) => {
let (flash_name, flash_msg) =
("flash_name=error".to_string(), format!("flash_msg={}", err));
Response::redirect_303("/scuttlebutt/search").add_flash(flash_name, flash_msg)
}
}
}

View File

@ -0,0 +1,42 @@
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::{flash::FlashResponse, sbot};
// ROUTE: /scuttlebutt/unblock
/// Unblock a Scuttlebutt profile specified by the given public key.
///
/// Parse the public key from the submitted form and publish a contact message.
/// Redirect to the appropriate profile page with a flash message describing
/// the outcome of the action (may be successful or unsuccessful).
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
public_key: String,
}));
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
match sbot::unblock_peer(&data.public_key) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Social interactions are unavailable.".to_string(),
),
};
let url = format!("/scuttlebutt/profile/{}", data.public_key);
Response::redirect_303(url).add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,42 @@
use peach_lib::sbot::SbotStatus;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::{flash::FlashResponse, sbot};
// ROUTE: /scuttlebutt/unfollow
/// Unfollow a Scuttlebutt profile specified by the given public key.
///
/// Parse the public key from the submitted form and publish a contact message.
/// Redirect to the appropriate profile page with a flash message describing
/// the outcome of the action (may be successful or unsuccessful).
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
public_key: String,
}));
let (flash_name, flash_msg) = match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => {
match sbot::unfollow_peer(&data.public_key) {
Ok(success_msg) => (
"flash_name=success".to_string(),
format!("flash_msg={}", success_msg),
),
Err(error_msg) => (
"flash_name=error".to_string(),
format!("flash_msg={}", error_msg),
),
}
}
_ => (
"flash_name=warning".to_string(),
"Social interactions are unavailable.".to_string(),
),
};
let url = format!("/scuttlebutt/profile/{}", data.public_key);
Response::redirect_303(url).add_flash(flash_name, flash_msg)
}

View File

@ -1,126 +0,0 @@
use rocket::{
form::{Form, FromForm},
get, post,
request::FlashMessage,
response::{Flash, Redirect},
serde::Deserialize,
uri,
};
use rocket_dyn_templates::{tera::Context, Template};
use peach_lib::config_manager;
use crate::error::PeachWebError;
use crate::routes::authentication::Authenticated;
// HELPERS AND ROUTES FOR /settings/admin
/// Administrator settings menu.
#[get("/")]
pub fn admin_menu(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings".to_string()));
context.insert("title", &Some("Administrator Settings".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("settings/admin/menu", &context.into_json())
}
// HELPERS AND ROUTES FOR /settings/admin/configure
/// View and delete currently configured admin.
#[get("/configure")]
pub fn configure_admin(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings/admin".to_string()));
context.insert("title", &Some("Configure Admin".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
// load the peach configuration vector
match config_manager::load_peach_config() {
Ok(config) => {
// retrieve the vector of ssb admin ids
let ssb_admin_ids = config.ssb_admin_ids;
context.insert("ssb_admin_ids", &ssb_admin_ids);
}
// if load fails, overwrite the flash_name and flash_msg
Err(e) => {
context.insert("flash_name", &Some("error".to_string()));
context.insert(
"flash_msg",
&Some(format!("Failed to load Peach config: {}", e)),
);
}
}
Template::render("settings/admin/configure_admin", &context.into_json())
}
// HELPERS AND ROUTES FOR /settings/admin/add
#[derive(Debug, Deserialize, FromForm)]
pub struct AddAdminForm {
pub ssb_id: String,
}
pub fn save_add_admin_form(admin_form: AddAdminForm) -> Result<(), PeachWebError> {
let _result = config_manager::add_ssb_admin_id(&admin_form.ssb_id)?;
// if the previous line didn't throw an error then it was a success
Ok(())
}
#[get("/add")]
pub fn add_admin(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings/admin/configure".to_string()));
context.insert("title", &Some("Add Admin".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
// template_dir is set in Rocket.toml
Template::render("settings/admin/add_admin", &context.into_json())
}
#[post("/add", data = "<add_admin_form>")]
pub fn add_admin_post(add_admin_form: Form<AddAdminForm>, _auth: Authenticated) -> Flash<Redirect> {
let result = save_add_admin_form(add_admin_form.into_inner());
let url = uri!("/settings/admin/configure");
match result {
Ok(_) => Flash::success(Redirect::to(url), "Successfully added new admin"),
Err(_) => Flash::error(Redirect::to(url), "Failed to add new admin"),
}
}
// HELPERS AND ROUTES FOR /settings/admin/delete
#[derive(Debug, Deserialize, FromForm)]
pub struct DeleteAdminForm {
pub ssb_id: String,
}
#[post("/delete", data = "<delete_admin_form>")]
pub fn delete_admin_post(
delete_admin_form: Form<DeleteAdminForm>,
_auth: Authenticated,
) -> Flash<Redirect> {
let result = config_manager::delete_ssb_admin_id(&delete_admin_form.ssb_id);
let url = uri!(configure_admin);
match result {
Ok(_) => Flash::success(Redirect::to(url), "Successfully removed admin id"),
Err(_) => Flash::error(Redirect::to(url), "Failed to remove admin id"),
}
}

View File

@ -0,0 +1,35 @@
use peach_lib::config_manager;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::flash::FlashResponse;
// HELPER AND ROUTES FOR /settings/admin/add
/// Parse an `admin_id` from the submitted form, save it to file
/// (`/var/lib/peachcloud/config.yml`) and redirect to the administrator
/// configuration URL.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
// the public key of a desired administrator
ssb_id: String,
}));
// TODO: verify that the given ssb_id is valid
// save submitted admin id to file
let (flash_name, flash_msg) = match config_manager::add_ssb_admin_id(&data.ssb_id) {
Ok(_) => (
"flash_name=success".to_string(),
"flash_msg=Added SSB administrator".to_string(),
),
Err(err) => (
"flash_name=error".to_string(),
format!("flash_msg=Failed to add new administrator: {}", err),
),
};
// redirect to the configure admin page
Response::redirect_303("/settings/admin/configure").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,79 @@
use maud::{html, PreEscaped};
use peach_lib::config_manager;
use rouille::Request;
use crate::{
templates,
utils::{flash::FlashRequest, theme},
};
/// Administrator settings menu template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (mut flash_name, mut flash_msg) = request.retrieve_flash();
// attempt to load peachcloud config file
let ssb_admins = match config_manager::load_peach_config() {
Ok(config) => Some(config.ssb_admin_ids),
// note: this will overwrite any received flash cookie values
// TODO: find a way to include the `err` in the flash_msg
// currently produces an error because we end up with Some(String)
// instead of Some(str)
Err(_err) => {
flash_name = Some("flash_name=error");
flash_msg = Some("flash_msg=Failed to read PeachCloud configuration file");
None
}
};
let menu_template = html! {
(PreEscaped("<!-- CONFIGURE ADMIN PAGE -->"))
div class="card center" {
div class="capsule capsule-profile center-text font-normal border-info" style="font-family: var(--sans-serif); font-size: var(--font-size-6); margin-bottom: 1.5rem;" {
"Administrators are identified and added by their Scuttlebutt public keys. These accounts will be sent private messages on Scuttlebutt when a password reset is requested."
}
@if let Some(ref ssb_admin_ids) = ssb_admins {
@for admin in ssb_admin_ids {
form class="center" action="/settings/admin/delete" method="post" {
div class="center" style="display: flex; justify-content: space-between;" {
input type="hidden" name="ssb_id" value=(admin);
p class="label-small label-ellipsis font-gray" style="user-select: all;" { (admin) }
input style="width: 30%;" type="submit" class="button button-warning" value="Delete" title="Delete SSB administrator";
}
}
}
} @else {
div class="card-text" {
"There are no currently configured admins."
}
}
form id="addAdmin" class="center" style="margin-top: 2rem;" action="/settings/admin/add" method="post" {
div class="center" style="display: flex; flex-direction: column; margin-bottom: 2rem;" title="Public key (ID) of a desired administrator" {
label for="publicKey" class="label-small font-gray" { "PUBLIC KEY" }
input type="text" id="publicKey" name="ssb_id" placeholder="@xYz...=.ed25519" autofocus;
}
(PreEscaped("<!-- BUTTONS -->"))
input class="button button-primary center" type="submit" title="Add SSB administrator" value="Add Admin";
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body = templates::nav::build_template(
menu_template,
"Configure Administrators",
Some("/settings/admin"),
);
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,35 @@
use peach_lib::config_manager;
use rouille::{post_input, try_or_400, Request, Response};
use crate::utils::flash::FlashResponse;
// HELPERS AND ROUTES FOR /settings/admin/delete
/// Parse an `admin_id` from the submitted form, delete it from file
/// (`/var/lib/peachcloud/config.yml`) and redirect to the administrator
/// configuration URL.
pub fn handle_form(request: &Request) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
// the public key of a desired administrator
ssb_id: String,
}));
// remove submitted admin id from file
// match on the result and set flash name and msg accordingly
let (flash_name, flash_msg) = match config_manager::delete_ssb_admin_id(&data.ssb_id) {
Ok(_) => (
// <cookie-name>=<cookie-value>
"flash_name=success".to_string(),
"flash_msg=Removed SSB administrator".to_string(),
),
Err(err) => (
"flash_name=error".to_string(),
format!("flash_msg=Failed to remove administrator: {}", err),
),
};
// set the flash cookie headers and redirect to the configure admin page
Response::redirect_303("/settings/admin/configure").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,30 @@
use maud::{html, PreEscaped};
use crate::{templates, utils::theme};
/// Administrator settings menu template builder.
pub fn build_template() -> PreEscaped<String> {
let menu_template = html! {
(PreEscaped("<!-- ADMIN SETTINGS MENU -->"))
div class="card center" {
(PreEscaped("<!-- BUTTONS -->"))
div id="settingsButtons" {
a id="configure" class="button button-primary center" href="/settings/admin/configure" title="Configure Admin" { "Configure Admin" }
a id="change" class="button button-primary center" href="/auth/change" title="Change Password" { "Change Password" }
a id="reset" class="button button-primary center" href="/auth/reset" title="Reset Password" { "Reset Password" }
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(menu_template, "Administrator Settings", Some("/settings"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,4 @@
pub mod add;
pub mod configure;
pub mod delete;
pub mod menu;

View File

@ -3,7 +3,6 @@ use rocket::{
form::{Form, FromForm},
get, post,
request::FlashMessage,
serde::Deserialize,
};
use rocket_dyn_templates::Template;
@ -16,9 +15,10 @@ use peach_lib::{
use crate::{
context::dns::ConfigureDNSContext, error::PeachWebError, routes::authentication::Authenticated,
utils,
};
#[derive(Debug, Deserialize, FromForm)]
#[derive(Debug, FromForm)]
pub struct DnsForm {
pub external_domain: String,
pub enable_dyndns: bool,
@ -76,11 +76,14 @@ pub fn save_dns_configuration(dns_form: DnsForm) -> Result<(), PeachWebError> {
#[get("/dns")]
pub fn configure_dns(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = ConfigureDNSContext::build();
// retrieve current ui theme
let theme = utils::get_theme();
let mut context = ConfigureDNSContext::build();
// set back icon link to network route
context.back = Some("/settings/network".to_string());
context.title = Some("Configure DNS".to_string());
context.theme = Some(theme);
// check to see if there is a flash message to display
if let Some(flash) = flash {

View File

@ -1,22 +1,33 @@
use rocket::{get, request::FlashMessage};
use rocket_dyn_templates::{tera::Context, Template};
use maud::{html, PreEscaped};
use crate::routes::authentication::Authenticated;
use crate::{templates, utils::theme, CONFIG};
// HELPERS AND ROUTES FOR /settings
// ROUTE: /settings
/// View and delete currently configured admin.
#[get("/settings")]
pub fn settings_menu(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Settings".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
/// Settings menu template builder.
pub fn build_template() -> PreEscaped<String> {
let menu_template = html! {
(PreEscaped("<!-- SETTINGS MENU -->"))
div class="card center" {
(PreEscaped("<!-- BUTTONS -->"))
div id="settingsButtons" {
// render the network settings button if we're not in standalone mode
@if !CONFIG.standalone_mode {
a id="network" class="button button-primary center" href="/settings/network" title="Network Settings" { "Network" }
}
a id="scuttlebutt" class="button button-primary center" href="/settings/scuttlebutt" title="Scuttlebutt Settings" { "Scuttlebutt" }
a id="admin" class="button button-primary center" href="/settings/admin" title="Administrator Settings" { "Administration" }
}
}
};
Template::render("settings/menu", &context.into_json())
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body = templates::nav::build_template(menu_template, "Settings", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -1,5 +1,6 @@
pub mod admin;
pub mod dns;
//pub mod dns;
pub mod menu;
pub mod network;
//pub mod network;
pub mod scuttlebutt;
pub mod theme;

View File

@ -4,7 +4,6 @@ use rocket::{
get, post,
request::FlashMessage,
response::{Flash, Redirect},
serde::Deserialize,
uri, UriDisplayQuery,
};
use rocket_dyn_templates::{tera::Context, Template};
@ -21,12 +20,12 @@ use crate::{
// STRUCTS USED BY NETWORK ROUTES
#[derive(Debug, Deserialize, FromForm, UriDisplayQuery)]
#[derive(Debug, FromForm, UriDisplayQuery)]
pub struct Ssid {
pub ssid: String,
}
#[derive(Debug, Deserialize, FromForm)]
#[derive(Debug, FromForm)]
pub struct WiFi {
pub ssid: String,
pub pass: String,

View File

@ -1,36 +0,0 @@
use rocket::{get, request::FlashMessage};
use rocket_dyn_templates::{tera::Context, Template};
use crate::routes::authentication::Authenticated;
// HELPERS AND ROUTES FOR /settings/scuttlebutt
/// Scuttlebutt settings menu.
#[get("/")]
pub fn ssb_settings_menu(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings".to_string()));
context.insert("title", &Some("Scuttlebutt Settings".to_string()));
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("settings/scuttlebutt/menu", &context.into_json())
}
/// Sbot configuration page (includes form for updating configuration parameters).
#[get("/configure")]
pub fn configure_sbot(flash: Option<FlashMessage>, _auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("back", &Some("/settings/scuttlebutt".to_string()));
context.insert("title", &Some("Sbot Configuration".to_string()));
if let Some(flash) = flash {
context.insert("flash_name", &Some(flash.kind().to_string()));
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("settings/scuttlebutt/configure_sbot", &context.into_json())
}

View File

@ -0,0 +1,267 @@
use log::{debug, warn};
use maud::{html, PreEscaped};
use peach_lib::sbot::{SbotConfig, SbotStatus};
use rouille::{post_input, try_or_400, Request, Response};
use crate::{
templates,
utils::{
flash::{FlashRequest, FlashResponse},
sbot, theme,
},
};
/// Read the status and configuration of the sbot.
/// Define fallback values if an error is returned from either read function.
fn read_status_and_config() -> (String, SbotConfig, String, String) {
// retrieve go-sbot systemd process status
let run_on_startup = if let Ok(status) = SbotStatus::read() {
// if the read is ok, return the value or "disabled" if no value is set
match status.boot_state {
Some(state) => state,
None => "disabled".to_string(),
}
} else {
// if the read returns an error, set the value to "disabled"
"disabled".to_string()
};
// retrieve sbot config parameters
let sbot_config = match SbotConfig::read() {
Ok(config) => config,
// build default config if an error is returned from the read attempt
Err(_) => SbotConfig::default(),
};
// split the listen address into ip and port
let (ip, port) = match sbot_config.lis.find(':') {
Some(index) => {
let (ip, port) = sbot_config.lis.split_at(index);
// remove the : from the port
(ip.to_string(), port.replace(':', ""))
}
// if no ':' separator is found, assume an ip has been configured (without port)
None => (sbot_config.lis.to_string(), String::new()),
};
(run_on_startup, sbot_config, ip, port)
}
/// Scuttlebutt settings menu template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let (run_on_startup, sbot_config, ip, port) = read_status_and_config();
let menu_template = html! {
(PreEscaped("<!-- SBOT CONFIGURATION FORM -->"))
div class="card center" {
form id="sbotConfig" class="center" action="/settings/scuttlebutt/configure" method="post" {
div class="center" style="display: flex; flex-direction: column; margin-bottom: 2rem;" title="Number of hops to replicate" {
label for="hops" class="label-small font-gray" { "HOPS" }
div id="hops" style="display: flex; justify-content: space-evenly;" {
div {
@if sbot_config.hops == 0 {
input type="radio" id="hops_0" name="hops" value="0" checked;
} @else {
input type="radio" id="hops_0" name="hops" value="0";
}
label class="font-normal" for="hops_0" { "0" }
}
div {
@if sbot_config.hops == 1 {
input type="radio" id="hops_1" name="hops" value="1" checked;
} @else {
input type="radio" id="hops_1" name="hops" value="1";
}
label class="font-normal" for="hops_1" { "1" }
}
div {
@if sbot_config.hops == 2 {
input type="radio" id="hops_2" name="hops" value="2" checked;
} @else {
input type="radio" id="hops_2" name="hops" value="2";
}
label class="font-normal" for="hops_2" { "2" }
}
div {
@if sbot_config.hops == 3 {
input type="radio" id="hops_3" name="hops" value="3" checked;
} @else {
input type="radio" id="hops_3" name="hops" value="3";
}
label class="font-normal" for="hops_3" { "3" }
}
div {
@if sbot_config.hops == 4 {
input type="radio" id="hops_4" name="hops" value="4" checked;
} @else {
input type="radio" id="hops_4" name="hops" value="4";
}
label class="font-normal" for="hops_4" { "4" }
}
}
}
div class="center" style="display: flex; justify-content: space-between;" {
div style="display: flex; flex-direction: column; width: 60%; margin-bottom: 2rem;" title="IP address on which the sbot runs" {
label for="ip" class="label-small font-gray" { "IP ADDRESS" }
input type="text" id="ip" name="lis_ip" value=(ip);
}
div style="display: flex; flex-direction: column; width: 20%; margin-bottom: 2rem;" title="Port on which the sbot runs" {
label for="port" class="label-small font-gray" { "PORT" }
input type="text" id="port" name="lis_port" value=(port);
}
}
div class="center" style="display: flex; flex-direction: column; margin-bottom: 2rem;" title="Network key (aka 'caps key') to define the Scuttleverse in which the sbot operates in" {
label for="network_key" class="label-small font-gray" { "NETWORK KEY" }
input type="text" id="network_key" name="shscap" value=(sbot_config.shscap);
}
div class="center" style="display: flex; flex-direction: column; margin-bottom: 2rem;" title="Directory in which the sbot database is saved" {
label for="database_dir" class="label-small font-gray" { "DATABASE DIRECTORY" }
input type="text" id="database_dir" name="repo" value=(sbot_config.repo);
}
div class="center" {
@if sbot_config.localadv {
input type="checkbox" id="lanBroadcast" style="margin-bottom: 1rem;" name="localadv" checked;
} @else {
input type="checkbox" id="lanBroadcast" style="margin-bottom: 1rem;" name="localadv";
}
label class="font-normal" for="lanBroadcast" title="Broadcast the IP and port of this sbot instance so that local peers can discovery it and attempt to connect" {
"Enable LAN Broadcasting"
}
br;
@if sbot_config.localdiscov {
input type="checkbox" id="lanDiscovery" style="margin-bottom: 1rem;" name="localdiscov" checked;
} @else {
input type="checkbox" id="lanDiscovery" style="margin-bottom: 1rem;" name="localdiscov";
}
label class="font-normal" for="lanDiscovery" title="Listen for the presence of local peers and attempt to connect if found" { "Enable LAN Discovery" }
br;
@if run_on_startup == "enabled" {
input type="checkbox" id="startup" style="margin-bottom: 1rem;" name="startup" checked;
} @else {
input type="checkbox" id="startup" style="margin-bottom: 1rem;" name="startup";
}
label class="font-normal" for="startup" title="Run the pub automatically on system startup" { "Run pub when computer starts" }
br;
@if sbot_config.repair {
input type="checkbox" id="repair" name="repair" checked;
} @else {
input type="checkbox" id="repair" name="repair";
}
label class="font-normal" for="repair" title="Attempt to repair the filesystem when starting the pub" { "Attempt filesystem repair when pub starts" }
}
(PreEscaped("<!-- hidden input elements for all other config variables -->"))
input type="hidden" id="debugdir" name="debugdir" value=(sbot_config.debugdir);
input type="hidden" id="hmac" name="hmac" value=(sbot_config.hmac);
input type="hidden" id="wslis" name="wslis" value=(sbot_config.wslis);
input type="hidden" id="debuglis" name="debuglis" value=(sbot_config.debuglis);
input type="hidden" id="enable_ebt" name="enable_ebt" value=(sbot_config.enable_ebt);
input type="hidden" id="promisc" name="promisc" value=(sbot_config.promisc);
input type="hidden" id="nounixsock" name="nounixsock" value=(sbot_config.nounixsock);
(PreEscaped("<!-- BUTTONS -->"))
input id="saveConfig" class="button button-primary center" style="margin-top: 2rem;" type="submit" title="Save configuration parameters to file" value="Save";
input id="saveRestartConfig" class="button button-primary center" type="submit" title="Save configuration parameters to file and then (re)start the pub" value="Save & Restart" formaction="/settings/scuttlebutt/configure/restart";
a id="restoreDefaults" class="button button-warning center" href="/settings/scuttlebutt/configure/default" title="Restore default configuration parameters and save them to file" { "Restore Defaults" }
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(menu_template, "Scuttlebutt Settings", Some("/settings"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}
/// Parse the sbot configuration values and write to file.
pub fn handle_form(request: &Request, restart: bool) -> Response {
// query the request body for form data
// return a 400 error if the admin_id field is missing
let data = try_or_400!(post_input!(request, {
repo: String,
debugdir: String,
shscap: String,
hmac: String,
hops: u8,
lis_ip: String,
lis_port: String,
wslis: String,
debuglis: String,
localadv: bool,
localdiscov: bool,
enable_ebt: bool,
promisc: bool,
nounixsock: bool,
startup: bool,
repair: bool,
}));
// concat the ip and port for listen address
let lis = format!("{}:{}", data.lis_ip, data.lis_port);
// instantiate `SbotConfig` from form data
let config = SbotConfig {
lis,
hops: data.hops,
repo: data.repo,
debugdir: data.debugdir,
shscap: data.shscap,
localadv: data.localadv,
localdiscov: data.localdiscov,
hmac: data.hmac,
wslis: data.wslis,
debuglis: data.debuglis,
enable_ebt: data.enable_ebt,
promisc: data.promisc,
nounixsock: data.nounixsock,
repair: data.repair,
};
match data.startup {
true => {
debug!("Enabling go-sbot.service");
if let Err(e) = sbot::systemctl_sbot_cmd("enable") {
warn!("Failed to enable go-sbot.service: {}", e)
}
}
false => {
debug!("Disabling go-sbot.service");
if let Err(e) = sbot::systemctl_sbot_cmd("disable") {
warn!("Failed to disable go-sbot.service: {}", e)
}
}
};
// write config to file
let (name, msg) = match SbotConfig::write(config) {
Ok(_) => {
// if `restart` query parameter is `true`, attempt sbot process (re)start
if restart {
// returns a tuple of (name, msg) based on the outcome (success or error)
sbot::restart_sbot_process()
} else {
("success".to_string(), "Updated configuration".to_string())
}
}
Err(err) => (
"error".to_string(),
format!("Failed to update configuration: {}", err),
),
};
let (flash_name, flash_msg) = (format!("flash_name={}", name), format!("flash_msg={}", msg));
Response::redirect_303("/settings/scuttlebutt/configure").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,21 @@
use peach_lib::sbot::SbotConfig;
use rouille::Response;
use crate::utils::flash::FlashResponse;
/// Set default configuration parameters for the go-sbot and save them to file.
pub fn write_config() -> Response {
let default_config = SbotConfig::default();
// write default config to file
let (name, msg) = match SbotConfig::write(default_config) {
Ok(_) => ("success", "Restored default configuration".to_string()),
Err(e) => (
"error",
format!("Failed to restore default configuration: {}", e),
),
};
let (flash_name, flash_msg) = (format!("flash_name={}", name), format!("flash_msg={}", msg));
Response::redirect_303("/settings/scuttlebutt/configure").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,66 @@
use maud::{html, PreEscaped};
use peach_lib::sbot::SbotStatus;
use rouille::Request;
use crate::{
templates,
utils::{flash::FlashRequest, theme},
};
/// Read the status of the go-sbot service and render buttons accordingly.
fn render_process_buttons() -> PreEscaped<String> {
// retrieve go-sbot systemd process status
let sbot_status = SbotStatus::read();
html! {
// render the stop and restart buttons if sbot process is currently active
@if let Ok(status) = sbot_status {
@if status.state == Some("active".to_string()) {
a id="stop" class="button button-primary center" href="/settings/scuttlebutt/stop" title="Stop Sbot" { "Stop Sbot" }
a id="restart" class="button button-primary center" href="/settings/scuttlebutt/restart" title="Restart Sbot" { "Restart Sbot" }
// render the start button if sbot process is currently inactive
} @else {
a id="start" class="button button-primary center" href="/settings/scuttlebutt/start" title="Start Sbot" { "Start Sbot" }
}
// render the start button if an error was returned by the status query
} @else {
a id="start" class="button button-primary center" href="/settings/scuttlebutt/start" title="Start Sbot" { "Start Sbot" }
}
}
}
// ROUTE: /settings/scuttlebutt
/// Scuttlebutt settings menu template builder.
pub fn build_template(request: &Request) -> PreEscaped<String> {
// check for flash cookies; will be (None, None) if no flash cookies are found
let (flash_name, flash_msg) = request.retrieve_flash();
let menu_template = html! {
(PreEscaped("<!-- SCUTTLEBUTT SETTINGS MENU -->"))
div class="card center" {
(PreEscaped("<!-- BUTTONS -->"))
div id="settingsButtons" {
a id="configureSbot" class="button button-primary center" href="/settings/scuttlebutt/configure" title="Configure Sbot" { "Configure Sbot" }
// conditionally render the start / stop / restart buttons
(render_process_buttons())
}
// render flash message if cookies were found in the request
@if let (Some(name), Some(msg)) = (flash_name, flash_msg) {
(PreEscaped("<!-- FLASH MESSAGE -->"))
(templates::flash::build_template(name, msg))
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(menu_template, "Scuttlebutt Settings", Some("/settings"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,6 @@
pub mod configure;
pub mod default;
pub mod menu;
pub mod restart;
pub mod start;
pub mod stop;

View File

@ -0,0 +1,33 @@
use log::info;
use rouille::Response;
use crate::utils::{flash::FlashResponse, sbot::systemctl_sbot_cmd};
// ROUTE: /settings/scuttlebutt/restart
/// Attempt to restart the go-sbot.service process.
/// Redirect to the Scuttlebutt settings menu and communicate the outcome of
/// the attempt via a flash message.
pub fn restart_sbot() -> Response {
info!("Restarting go-sbot.service");
let (flash_name, flash_msg) = match systemctl_sbot_cmd("stop") {
// if stop was successful, try to start the process
Ok(_) => match systemctl_sbot_cmd("start") {
Ok(_) => (
"flash_name=success".to_string(),
"flash_msg=Sbot process has been restarted".to_string(),
),
Err(e) => (
"flash_name=error".to_string(),
format!("flash_msg=Failed to start the sbot process: {}", e),
),
},
Err(e) => (
"flash_name=error".to_string(),
format!("flash_msg=Failed to stop the sbot process: {}", e),
),
};
// redirect to the scuttlebutt settings menu
Response::redirect_303("/settings/scuttlebutt").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,26 @@
use log::info;
use rouille::Response;
use crate::utils::{flash::FlashResponse, sbot::systemctl_sbot_cmd};
// ROUTE: /settings/scuttlebutt/start
/// Attempt to start the go-sbot.service process.
/// Redirect to the Scuttlebutt settings menu and communicate the outcome of
/// the attempt via a flash message.
pub fn start_sbot() -> Response {
info!("Starting go-sbot.service");
let (flash_name, flash_msg) = match systemctl_sbot_cmd("start") {
Ok(_) => (
"flash_name=success".to_string(),
"flash_msg=Sbot process has been started".to_string(),
),
Err(_) => (
"flash_name=error".to_string(),
"flash_msg=Failed to start the sbot process".to_string(),
),
};
// redirect to the scuttlebutt settings menu
Response::redirect_303("/settings/scuttlebutt").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,26 @@
use log::info;
use rouille::Response;
use crate::utils::{flash::FlashResponse, sbot::systemctl_sbot_cmd};
// ROUTE: /settings/scuttlebutt/stop
/// Attempt to stop the go-sbot.service process.
/// Redirect to the Scuttlebutt settings menu and communicate the outcome of
/// the attempt via a flash message.
pub fn stop_sbot() -> Response {
info!("Stopping go-sbot.service");
let (flash_name, flash_msg) = match systemctl_sbot_cmd("stop") {
Ok(_) => (
"flash_name=success".to_string(),
"flash_msg=Sbot process has been stopped".to_string(),
),
Err(_) => (
"flash_name=error".to_string(),
"flash_msg=Failed to stop the sbot process".to_string(),
),
};
// redirect to the scuttlebutt settings menu
Response::redirect_303("/settings/scuttlebutt").add_flash(flash_name, flash_msg)
}

View File

@ -0,0 +1,16 @@
use rouille::Response;
use crate::utils::{theme, theme::Theme};
// ROUTE: /settings/theme/{theme}
/// Set the user-interface theme according to the query parameter value.
pub fn set_theme(theme: String) -> Response {
match theme.as_str() {
"light" => theme::set_theme(Theme::Light),
"dark" => theme::set_theme(Theme::Dark),
_ => (),
}
Response::redirect_303("/")
}

View File

@ -12,7 +12,7 @@ use std::{
};
use peach_lib::{
config_manager::load_peach_config, dyndns_client, network_client, oled_client, sbot_client,
config_manager::load_peach_config, dyndns_client, network_client, oled_client, sbot::SbotStatus,
};
use peach_stats::{
stats,
@ -117,10 +117,11 @@ impl StatusContext {
}
// test if go-sbot is running
let sbot_is_online_result = sbot_client::is_sbot_online();
let sbot_is_online: bool = match sbot_is_online_result {
Ok(val) => val,
Err(_err) => false,
let sbot_status = SbotStatus::read();
let sbot_is_online: bool = match sbot_status {
// return true if state is active
Ok(status) => matches!(status.state == Some("active".to_string()), true),
_ => false,
};
StatusContext {

View File

@ -1,3 +1,3 @@
pub mod device;
pub mod network;
//pub mod device;
//pub mod network;
pub mod scuttlebutt;

View File

@ -1,16 +1,284 @@
use rocket::get;
use rocket_dyn_templates::{tera::Context, Template};
use maud::{html, Markup, PreEscaped};
use peach_lib::sbot::{SbotConfig, SbotStatus};
use crate::routes::authentication::Authenticated;
use crate::{
templates,
utils::{sbot, theme},
};
// HELPERS AND ROUTES FOR /status/scuttlebutt
// HTML RENDERING FOR ELEMENTS
#[get("/scuttlebutt")]
pub fn scuttlebutt_status(_auth: Authenticated) -> Template {
let mut context = Context::new();
context.insert("flash_name", &None::<()>);
context.insert("flash_msg", &None::<()>);
context.insert("title", &Some("Scuttlebutt Status"));
// TODO: refactor this to make better use of splices
// https://maud.lambda.xyz/splices-toggles.html
Template::render("status/scuttlebutt", &context.into_json())
fn downtime_element(downtime: &Option<String>) -> Markup {
match downtime {
Some(time) => {
html! {
label class="label-small font-gray" for="sbotDowntime" title="go-sbot downtime" style="margin-top: 0.5rem;" { "DOWNTIME" }
p id="sbotDowntime" class="card-text" title="Downtime" { (time) }
}
}
_ => html! { (PreEscaped("")) },
}
}
fn uptime_element(uptime: &Option<String>) -> Markup {
match uptime {
Some(time) => {
html! {
label class="label-small font-gray" for="sbotUptime" title="go-sbot uptime" style="margin-top: 0.5rem;" { "UPTIME" }
p id="sbotUptime" class="card-text" title="Uptime" { (time) }
}
}
_ => html! { (PreEscaped("")) },
}
}
fn run_on_startup_element(boot_state: &Option<String>) -> Markup {
match boot_state {
Some(state) if state == "enabled" => {
html! {
p id="runOnStartup" class="card-text" title="Enabled" { "Enabled" }
}
}
_ => {
html! {
p id="runOnStartup" class="card-text" title="Disabled" { "Disabled" }
}
}
}
}
fn database_element(state: &str) -> Markup {
// retrieve the sequence number of the latest message in the sbot database
let sequence_num = sbot::latest_sequence_number();
match (state, sequence_num) {
// if the state is "active" and latest_sequence_number() was successful
("active", Ok(number)) => {
html! {
label class="card-text" style="margin-right: 5px;" { (number) }
label class="label-small font-gray" { "MESSAGES IN LOCAL DATABASE" }
}
}
(_, _) => html! { label class="label-small font-gray" { "DATABASE UNAVAILABLE" } },
}
}
fn memory_element(memory: Option<u32>) -> Markup {
let (memory, img_class, medium_label_class, small_label_class) = match memory {
Some(mem) => {
// convert memory to mb representation
let memory_rounded = mem / 1024 / 1024;
(
memory_rounded.to_string(),
"icon icon-active",
"label-medium font-normal",
"label-small font-gray",
)
}
_ => (
0.to_string(),
"icon icon-inactive",
"label-medium font-gray",
"label-small font-gray",
),
};
html! {
div class="stack" {
img class=(img_class) title="Memory" src="/icons/ram.png";
div class="flex-grid" style="padding-top: 0.5rem;" {
label class=(medium_label_class) style="padding-right: 3px;" title="Memory usage of the go-sbot process in MB" { (memory) }
label class=(small_label_class) { "MB" }
}
label class=(small_label_class) { "MEMORY" }
}
}
}
fn hops_element() -> Markup {
// retrieve go-sbot systemd process status
let hops = match SbotConfig::read() {
Ok(conf) => conf.hops,
_ => 0,
};
html! {
div class="stack" {
img class="icon icon-active" title="Hops" src="/icons/orbits.png";
div class="flex-grid" style="padding-top: 0.5rem;" {
label class="label-medium font-normal" style="padding-right: 3px;" title="Replication hops" {
(hops)
}
}
label class="label-small font-gray" { "HOPS" }
}
}
}
fn blobs_element(blobstore: Option<u64>) -> Markup {
let blobstore_size = match blobstore {
// convert blobstore size to mb representation
Some(blobs) => blobs / 1024 / 1024,
None => 0,
};
html! {
div class="stack" {
img class="icon icon-active" title="Blobs" src="/icons/image-file.png";
div class="flex-grid" style="padding-top: 0.5rem;" {
label class="label-medium font-normal" style="padding-right: 3px;" title="Blobstore size in MB" { (blobstore_size) }
label class="label-small font-normal" { "MB" }
}
label class="label-small font-gray" { "BLOBSTORE" }
}
}
}
/// Read the state of the go-sbot process and define status-related
/// elements accordingly.
fn render_status_elements<'a>() -> (
String,
&'a str,
&'a str,
Markup,
Markup,
Markup,
Markup,
Markup,
) {
// retrieve go-sbot systemd process status
match SbotStatus::read() {
Ok(status) if status.state == Some("active".to_string()) => (
"ACTIVE".to_string(),
"capsule capsule-container border-success",
"center icon icon-active",
uptime_element(&status.uptime),
run_on_startup_element(&status.boot_state),
database_element("active"),
memory_element(status.memory),
blobs_element(status.blobstore),
),
Ok(status) if status.state == Some("inactive".to_string()) => (
"INACTIVE".to_string(),
"capsule capsule-container border-warning",
"center icon icon-inactive",
downtime_element(&status.downtime),
run_on_startup_element(&status.boot_state),
database_element("inactive"),
memory_element(None),
blobs_element(status.blobstore),
),
// state is neither active nor inactive (might be "failed")
Ok(status) if status.state.is_some() => (
status.state.unwrap().to_uppercase(),
"capsule capsule-container border-danger",
"center icon icon-inactive",
downtime_element(&None),
run_on_startup_element(&status.boot_state),
database_element("failed"),
memory_element(None),
blobs_element(status.blobstore),
),
Ok(status) if status.state.is_none() => (
"UNAVAILABLE".to_string(),
"capsule capsule-container border-danger",
"center icon icon-inactive",
downtime_element(&None),
run_on_startup_element(&status.boot_state),
database_element("unavailable"),
memory_element(None),
blobs_element(status.blobstore),
),
_ => (
"PROCESS QUERY FAILED".to_string(),
"capsule capsule-container border-danger",
"center icon icon-inactive",
downtime_element(&None),
run_on_startup_element(&None),
database_element("error"),
memory_element(None),
blobs_element(None),
),
}
}
/// Scuttlebutt status template builder.
pub fn build_template() -> PreEscaped<String> {
let (
sbot_state,
capsule_class,
sbot_icon_class,
uptime_downtime_element,
run_on_startup_element,
database_element,
memory_element,
blobs_element,
) = render_status_elements();
let hops_element = hops_element();
let status_template = html! {
(PreEscaped("<!-- SCUTTLEBUTT STATUS -->"))
div class="card center" {
(PreEscaped("<!-- SBOT INFO BOX -->"))
div class=(capsule_class) {
(PreEscaped("<!-- SBOT STATUS GRID -->"))
div class="two-grid" title="go-sbot process state" {
(PreEscaped("<!-- top-right config icon -->"))
a class="link two-grid-top-right" href="/settings/scuttlebutt" title="Configure Scuttlebutt settings" {
img id="configureNetworking" class="icon-small icon-active" src="/icons/cog.svg" alt="Configure";
}
(PreEscaped("<!-- left column -->"))
(PreEscaped("<!-- go-sbot state icon with label -->"))
div class="grid-column-1" {
img id="sbotStateIcon" class=(sbot_icon_class) src="/icons/hermies.svg" alt="Hermies";
label id="sbotStateLabel" for="sbotStateIcon" class="center label-small font-gray" style="margin-top: 0.5rem;" title="Sbot state" {
(sbot_state)
}
}
(PreEscaped("<!-- right column -->"))
(PreEscaped("<!-- go-sbot version and uptime / downtime with labels -->"))
div class="grid-column-2" {
label class="label-small font-gray" for="sbotVersion" title="go-sbot version" {
"VERSION"
}
p id="sbotVersion" class="card-text" title="Version" {
"1.1.0-alpha"
}
(uptime_downtime_element)
label class="label-small font-gray" for="sbotBootState" title="go-sbot boot state" style="margin-top: 0.5rem;" { "RUN ON STARTUP" }
(run_on_startup_element)
}
}
hr style="color: var(--light-gray);";
div id="middleSection" style="margin-top: 1rem;" {
div id="sbotInfo" class="center" style="display: flex; justify-content: space-between; width: 90%;" {
div class="center" style="display: flex; align-items: last baseline;" {
(database_element)
}
}
}
hr style="color: var(--light-gray);";
(PreEscaped("<!-- THREE-ACROSS STACK -->"))
div class="three-grid card-container" style="margin-top: 1rem;" {
(hops_element)
(blobs_element)
(memory_element)
}
}
}
};
// wrap the nav bars around the scuttlebutt status card template content
// parameters are template, title and back url
let body = templates::nav::build_template(status_template, "Status", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,23 @@
use maud::{html, PreEscaped, DOCTYPE};
/// Base template builder.
///
/// Takes an HTML body as input and splices it into the base template.
pub fn build_template(body: PreEscaped<String>, theme: String) -> PreEscaped<String> {
html! {
(DOCTYPE)
html lang="en" data-theme=(theme);
head {
meta charset="utf-8";
meta name="description" content="PeachCloud web interface";
meta name="author" content="glyph and notplants";
meta name="viewport" content="width=devide-width, initial-scale=1.0";
link rel="stylesheet" href="/css/peachcloud.css";
link rel="stylesheet" href="/css/_variables.css";
title { "PeachCloud" }
}
body {
(body)
}
}
}

View File

@ -0,0 +1,27 @@
use maud::{html, Markup, PreEscaped};
/// Sbot error template builder.
///
/// Display a message to the operator when an sbot command returns an error.
pub fn build_template(error_msg: String) -> Markup {
html! {
(PreEscaped("<!-- SBOT ERROR -->"))
div class="card center" {
div class="capsule capsule-container border-danger center-text" {
p class="card-text" style="font-size: var(--font-size-4);" {
"Sbot Error"
}
p class="card-text" { (error_msg) }
p class="card-text" {
"Visit the "
strong {
a href="/settings/scuttlebutt" class="link" {
"Scuttlebutt settings menu"
}
}
" to start the Sbot and then try again."
}
}
}
}
}

View File

@ -0,0 +1,22 @@
use maud::{html, Markup};
/// Flash message template builder.
///
/// Render a flash elements based on the given flash name and message.
pub fn build_template(flash_name: &str, flash_msg: &str) -> Markup {
let common_classes = "capsule center center-text flash-message font-normal ";
let border_class = match flash_name {
"success" => "border-success",
"info" => "border-info",
"warning" => "border-warning",
"error" => "border-danger",
_ => "",
};
html! {
div class={ (common_classes) (border_class) } {
(flash_msg)
}
}
}

View File

@ -0,0 +1,28 @@
use maud::{html, Markup, PreEscaped};
/// Sbot inactive template builder.
///
/// Display a message to the operator when the sbot is inactive and
/// therefore some functionality is not available.
pub fn build_template(unavailable_msg: &str) -> Markup {
html! {
(PreEscaped("<!-- SBOT INACTIVE -->"))
div class="card center" {
div class="capsule capsule-container border-warning center-text" {
p class="card-text" style="font-size: var(--font-size-4);" {
"Sbot Inactive"
}
p class="card-text" { (unavailable_msg) }
p class="card-text" {
"Visit the "
strong {
a href="/settings/scuttlebutt" class="link" {
"Scuttlebutt settings menu"
}
}
" to start the Sbot and then try again."
}
}
}
}
}

View File

@ -0,0 +1,7 @@
pub mod base;
pub mod error;
pub mod flash;
pub mod inactive;
pub mod nav;
pub mod not_found;
pub mod peers_list;

View File

@ -0,0 +1,63 @@
use maud::{html, PreEscaped};
use crate::utils::theme;
/// Navigation template builder.
///
/// Takes the main HTML content as input and splices it into the navigation template.
pub fn build_template(
main: PreEscaped<String>,
title: &str,
back: Option<&str>,
) -> PreEscaped<String> {
// retrieve the current theme value
let theme = theme::get_theme();
// conditionally render the hermies icon and theme-switcher icon with correct link
let (hermies, switcher) = match theme.as_str() {
// if we're using the dark theme, render light icons and "light" query param
"dark" => (
"/icons/hermies_hex_light.svg",
html! {
a class="nav-item" href="/settings/theme/light" {
img class="icon-medium nav-icon-right icon-active" title="Toggle theme" src="/icons/sun.png" alt="Sun";
}
},
),
// otherwise, assume we're using light mode
_ => (
"/icons/hermies_hex.svg",
html! {
a class="nav-item" href="/settings/theme/dark" {
img class="icon-medium nav-icon-right icon-active" title="Toggle theme" src="/icons/moon.png" alt="Moon";
}
},
),
};
html! {
(PreEscaped("<!-- Top navigation bar -->"))
nav class="nav-bar" {
a class="nav-item" href=[back] title="Back" {
img class="icon-medium nav-icon-left icon-active" src="/icons/back.svg" alt="Back";
}
h1 class="nav-title" { (title) }
a class="nav-item" id="logoutButton" href="/auth/logout" title="Logout" {
img class="icon-medium nav-icon-right icon-active" src="/icons/enter.svg" alt="Logout";
}
}
(PreEscaped("<!-- Main content container -->"))
main { (main) }
(PreEscaped("<!-- Bottom navigation bar -->"))
nav class="nav-bar" {
a class="nav-item" href="https://scuttlebutt.nz/" {
img class="icon-medium nav-icon-left" title="Scuttlebutt Website" src=(hermies) alt="Secure Scuttlebutt";
}
a class="nav-item" href="/" {
img class="icon nav-icon-left" src="/icons/peach-icon.png" alt="PeachCloud" title="Home";
}
// render the pre-defined theme-switcher icon
(switcher)
}
}
}

View File

@ -0,0 +1,34 @@
use maud::{html, PreEscaped};
use crate::{templates, utils::theme};
// 404 ROUTE NOT FOUND CATCHER
/// 404 template builder.
pub fn build_template() -> PreEscaped<String> {
let not_found_template = html! {
div class="card center" {
div class="capsule-container" {
div class="capsule info-border" {
p {
"No PeachCloud resource exists for this URL. Please ensure that the URL in the address bar is correct."
}
p {
"Click the back arrow in the top-left or the PeachCloud logo at the bottom of your screen to return Home."
}
}
}
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(not_found_template, "404: Route Not Found", Some("/"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -0,0 +1,79 @@
use std::collections::HashMap;
use maud::{html, Markup, PreEscaped};
use peach_lib::sbot::SbotStatus;
use crate::{templates, utils::theme};
/// Render an unordered list of peers with one list element for each peer.
fn peers_template(peers: Vec<HashMap<String, String>>) -> Markup {
html! {
ul class="center list" {
@for peer in peers {
@let (name, name_alt) = match peer.get("name") {
Some(name) => (
name.to_owned(),
format!("{}'s profile image", name)
),
None => (
// set a fall-back value for name in case the data is unavailable
"Name unavailable".to_string(),
"Profile image".to_string()
)
};
@let url_safe_peer_id = peer["id"].replace('/', "%2F");
li {
a class="list-item link" href={ "/scuttlebutt/profile/" (url_safe_peer_id) } {
@if peer.get("blob_path").is_some() && peer["blob_exists"] == "true" {
img id="peerImage" class="icon list-icon" src={ "/blob/" (peer["blob_path"]) } alt=(name_alt);
} @else {
// use a placeholder image if we don't have the blob
img id="peerImage" class="icon icon-active list-icon" src="/icons/user.svg" alt="Placeholder profile image";
}
p id="peerName" class="font-normal list-text " { (name) };
label class="label-small label-ellipsis list-label font-gray" for="peerName" title={ (name) "'s public key" } {
(peer["id"])
}
}
}
}
}
}
}
/// Scuttlebutt peers list template builder.
///
/// A list of peers. Currently used to render lists of friends, follows and
/// blocks. The title of the page is set according to the provided parameter.
pub fn build_template(peers: Vec<HashMap<String, String>>, title: &str) -> PreEscaped<String> {
let peer_list_template = match SbotStatus::read() {
// only render the complete peers list if the sbot is active
Ok(status) if status.state == Some("active".to_string()) => {
html! {
div class="card center" {
@if !peers.is_empty() {
// render the peers list template
(peers_template(peers))
} @else {
p class="center-text font-normal" { "None found" }
}
}
}
}
_ => {
// the sbot is not active; render a message instead of the menu
templates::inactive::build_template("Social lists and interactions are unavailable.")
}
};
// wrap the nav bars around the settings menu template content
// parameters are template, title and back url
let body =
templates::nav::build_template(peer_list_template, title, Some("/scuttlebutt/peers"));
// query the current theme so we can pass it into the base template builder
let theme = theme::get_theme();
// render the base template with the provided body
templates::base::build_template(body, theme)
}

View File

@ -1,568 +0,0 @@
use std::fs::File;
use std::io::Read;
use rocket::http::{ContentType, Status};
use rocket::local::blocking::Client;
use rocket::{Build, Config, Rocket};
use super::init_rocket;
// define authentication mode
const DISABLE_AUTH: bool = true;
/// Wrapper around `init_rocket()` to simplify the process of invoking the application with the desired authentication status. This is particularly useful for testing purposes.
fn init_test_rocket(disable_auth: bool) -> Rocket<Build> {
// set authentication based on provided `disable_auth` value
Config::figment().merge(("disable_auth", disable_auth));
init_rocket()
}
// helper function to test correct retrieval and content of a file
fn test_query_file<T>(path: &str, file: T, status: Status)
where
T: Into<Option<&'static str>>,
{
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).unwrap();
let response = client.get(path).dispatch();
assert_eq!(response.status(), status);
let body_data = response.into_bytes();
if let Some(filename) = file.into() {
let expected_data = read_file_content(filename);
assert!(body_data.map_or(false, |s| s == expected_data));
}
}
// helper function to return the content of a file, given a path
fn read_file_content(path: &str) -> Vec<u8> {
let mut fp = File::open(&path).expect(&format!("Can't open {}", path));
let mut file_content = vec![];
fp.read_to_end(&mut file_content)
.expect(&format!("Reading {} failed.", path));
file_content
}
// WEB PAGE ROUTES
#[test]
fn index_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("/peers"));
assert!(body.contains("/profile"));
assert!(body.contains("/private"));
assert!(body.contains("/status"));
assert!(body.contains("/help"));
assert!(body.contains("/settings"));
}
#[test]
fn help_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/help").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Help"));
}
#[test]
fn login_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/login").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Login"));
}
#[test]
fn logout_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/logout").dispatch();
// check for 303 status (redirect to "/login")
assert_eq!(response.status(), Status::SeeOther);
assert_eq!(response.content_type(), None);
}
#[test]
fn power_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/power").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Shutdown Device"));
}
/*
NOTE: these tests are comment-out for the moment, due to the fact that they invoke system commands (resulting in a `sudo` password request during test execution). see if we can find a way to test the results without triggering the shutdown or restart.
#[test]
fn reboot() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/power/reboot").dispatch();
// check for redirect
assert_eq!(response.status(), Status::SeeOther);
}
#[test]
fn shutdown() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/power/shutdown").dispatch();
// check for redirect
assert_eq!(response.status(), Status::SeeOther);
}
*/
// SCUTTLEBUTT ROUTES
#[test]
fn block() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/scuttlebutt/block")
.header(ContentType::Form)
.body("key=HEqy940T6uB+T+d9Jaa58aNfRzLx9eRWqkZljBmnkmk=.ed25519")
.dispatch();
assert_eq!(response.status(), Status::SeeOther);
}
#[test]
fn blocks_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/blocks").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Blocks"));
}
#[test]
fn follow() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/scuttlebutt/follow")
.header(ContentType::Form)
.body("key=@HEqy940T6uB+T+d9Jaa58aNfRzLx9eRWqkZljBmnkmk=.ed25519")
.dispatch();
// ensure we redirect (303)
assert_eq!(response.status(), Status::SeeOther);
}
#[test]
fn follows_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/follows").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Follows"));
}
#[test]
fn followers_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/followers").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Followers"));
}
#[test]
fn friends_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/friends").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Friends"));
}
#[test]
fn peers_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/peers").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Scuttlebutt Peers"));
}
#[test]
fn private_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/private").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Private Messages"));
}
#[test]
fn profile_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/scuttlebutt/profile").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Profile"));
}
#[test]
fn publish_post() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/scuttlebutt/publish")
.header(ContentType::Form)
.body("text='golden ripples in the meshwork'")
.dispatch();
assert_eq!(response.status(), Status::SeeOther);
}
#[test]
fn unfollow() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/scuttlebutt/unfollow")
.header(ContentType::Form)
.body("key=@HEqy940T6uB+T+d9Jaa58aNfRzLx9eRWqkZljBmnkmk=.ed25519")
.dispatch();
assert_eq!(response.status(), Status::SeeOther);
}
// ADMIN SETTINGS ROUTES
#[test]
fn admin_settings_menu_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/admin").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Administrator Settings"));
assert!(body.contains("Change Password"));
assert!(body.contains("Configure Admin"));
}
#[test]
fn add_admin_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/admin/add").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Add Admin"));
assert!(body.contains("SSB ID"));
assert!(body.contains("Add"));
assert!(body.contains("Cancel"));
}
#[test]
fn add_admin() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/settings/admin/add")
.header(ContentType::Form)
.body("ssb_id=@HEqy940T6uB+T+d9Jaa58aNfRzLx9eRWqkZljBmnkmk=.ed25519")
.dispatch();
// check for redirect
assert_eq!(response.status(), Status::SeeOther);
}
#[test]
fn change_password_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/admin/change_password").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Change Password"));
assert!(body.contains("Current password"));
assert!(body.contains("New password"));
assert!(body.contains("New password duplicate"));
assert!(body.contains("Save"));
}
#[test]
fn configure_admin_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/admin/configure").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Configure Admin"));
assert!(body.contains("Current Admins"));
assert!(body.contains("Add Admin"));
}
#[test]
fn forgot_password_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/admin/forgot_password").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Send Password Reset"));
}
// NETWORK SETTINGS ROUTES
#[test]
fn network_settings_menu_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Network Configuration"));
}
/*
NOTE: these tests are commented-out for the moment, due to the fact that they
invoke system commands (resulting in a `sudo` password request during
test execution). see if we can find a way to test the results without
triggering the `systemctl` call.
#[test]
fn deploy_ap() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/ap/activate").dispatch();
// check for 303 status (redirect)
assert_eq!(response.status(), Status::SeeOther);
assert_eq!(response.content_type(), None);
}
#[test]
fn deploy_client() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/wifi/activate").dispatch();
// check for 303 status (redirect)
assert_eq!(response.status(), Status::SeeOther);
assert_eq!(response.content_type(), None);
}
*/
#[test]
fn dns_settings_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/dns").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Configure DNS"));
assert!(body.contains("External Domain (optional)"));
assert!(body.contains("Enable Dynamic DNS"));
assert!(body.contains("Dynamic DNS Domain"));
assert!(body.contains("Save"));
}
#[test]
fn list_aps_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/wifi").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("WiFi Networks"));
assert!(body.contains("No saved or available networks found."));
}
// TODO: needs further testing once template has been refactored
#[test]
fn ap_details_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/wifi?ssid=Home").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
//let body = response.into_string().unwrap();
//assert!(body.contains("Network not found"));
}
#[test]
fn add_ap_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/wifi/add").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Add WiFi Network"));
assert!(body.contains("SSID"));
assert!(body.contains("Password"));
assert!(body.contains("Add"));
assert!(body.contains("Cancel"));
}
#[test]
fn add_ap_ssid_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.get("/settings/network/wifi/add?ssid=Home")
.dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Add WiFi Network"));
assert!(body.contains("Home"));
assert!(body.contains("Password"));
assert!(body.contains("Add"));
assert!(body.contains("Cancel"));
}
#[test]
fn add_credentials() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/settings/network/wifi/add")
.header(ContentType::Form)
.body("ssid=Home&pass=Password")
.dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
}
#[test]
fn forget_wifi() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/settings/network/wifi/forget")
.header(ContentType::Form)
.body("ssid=Home")
.dispatch();
assert_eq!(response.status(), Status::SeeOther);
assert_eq!(response.content_type(), None);
}
#[test]
fn modify_password() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client
.post("/settings/network/wifi/modify")
.header(ContentType::Form)
.body("ssid=Home&pass=Password")
.dispatch();
assert_eq!(response.status(), Status::SeeOther);
assert_eq!(response.content_type(), None);
}
#[test]
fn data_usage_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/network/wifi/usage").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Network Data Usage"));
assert!(body.contains("WARNING THRESHOLD"));
assert!(body.contains("Update"));
assert!(body.contains("Cancel"));
}
// SCUTTLEBUTT SETTINGS HTML ROUTES
#[test]
fn scuttlebutt_settings_menu_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/settings/scuttlebutt").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Scuttlebutt Settings"));
assert!(body.contains("Set Network Key"));
assert!(body.contains("Set Replication Hops"));
assert!(body.contains("Remove Blocked Feeds"));
assert!(body.contains("Set Database Directory"));
assert!(body.contains("Check Filesystem"));
assert!(body.contains("Repair Filesystem"));
assert!(body.contains("Restart Sbot"));
}
// STATUS HTML ROUTES
#[test]
fn status_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/status").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Device Status"));
assert!(body.contains("Networking"));
assert!(body.contains("Display"));
assert!(body.contains("Statistics"));
}
#[test]
fn network_status_html() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).expect("valid rocket instance");
let response = client.get("/status/network").dispatch();
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.content_type(), Some(ContentType::HTML));
let body = response.into_string().unwrap();
assert!(body.contains("Network Status"));
assert!(body.contains("Mode"));
assert!(body.contains("SSID"));
assert!(body.contains("IP"));
assert!(body.contains("DOWNLOAD"));
assert!(body.contains("UPLOAD"));
}
// FILE TESTS
#[test]
fn nested_file() {
test_query_file(
"/images/placeholder.txt",
"static/images/placeholder.txt",
Status::Ok,
);
test_query_file(
"/images/placeholder.txt?v=1",
"static/images/placeholder.txt",
Status::Ok,
);
test_query_file(
"/images/placeholder.txt?v=1&a=b",
"static/images/placeholder.txt",
Status::Ok,
);
}
#[test]
fn icon_file() {
test_query_file(
"/icons/peach-icon.png",
"static/icons/peach-icon.png",
Status::Ok,
);
}
#[test]
fn invalid_path() {
test_query_file("/thou_shalt_not_exist", None, Status::NotFound);
test_query_file("/thou_shalt_not_exist", None, Status::NotFound);
test_query_file("/thou/shalt/not/exist?a=b&c=d", None, Status::NotFound);
}
#[test]
fn invalid_get_request() {
let client = Client::tracked(init_test_rocket(DISABLE_AUTH)).unwrap();
// try to get a path that doesn't exist
let res = client
.get("/message/99")
.header(ContentType::JSON)
.dispatch();
assert_eq!(res.status(), Status::NotFound);
let body = res.into_string().unwrap();
assert!(body.contains("404: Page Not Found"));
assert!(body.contains("No PeachCloud resource exists for this URL."));
}

View File

@ -1,23 +0,0 @@
pub mod monitor;
use rocket_dyn_templates::Template;
use rocket::response::{Redirect, Responder};
use rocket::serde::Serialize;
// HELPER FUNCTIONS
#[derive(Debug, Serialize)]
pub struct FlashContext {
pub flash_name: Option<String>,
pub flash_msg: Option<String>,
}
/// A helper enum which allows routes to either return a Template or a Redirect
/// from: https://github.com/SergioBenitez/Rocket/issues/253#issuecomment-532356066
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Responder)]
pub enum TemplateOrRedirect {
Template(Template),
Redirect(Redirect),
}

View File

@ -0,0 +1,50 @@
use rouille::{input, Request, Response};
/// Flash message trait for `Request`.
pub trait FlashRequest {
/// Retrieve the flash message cookie values from a `Request`.
fn retrieve_flash(&self) -> (Option<&str>, Option<&str>);
}
impl FlashRequest for Request {
fn retrieve_flash(&self) -> (Option<&str>, Option<&str>) {
// check for flash cookies
let flash_name = input::cookies(self)
.find(|&(n, _)| n == "flash_name")
// return the value of the cookie (key is already known)
.map(|key_val| key_val.1);
let flash_msg = input::cookies(self)
.find(|&(n, _)| n == "flash_msg")
.map(|key_val| key_val.1);
(flash_name, flash_msg)
}
}
/// Flash message trait for `Response`.
pub trait FlashResponse {
/// Add flash message cookies to a `Response`.
fn add_flash(self, flash_name: String, flash_msg: String) -> Response;
/// Reset flash message cookie values for a `Response`.
fn reset_flash(self) -> Response;
}
impl FlashResponse for Response {
fn add_flash(self, flash_name: String, flash_msg: String) -> Response {
// set the flash cookie headers
self.with_additional_header("Set-Cookie", format!("{}; Max-Age=1", flash_name))
.with_additional_header("Set-Cookie", format!("{}; Max-Age=1", flash_msg))
}
fn reset_flash(self) -> Response {
// set blank cookies to clear the flash msg from the previous request
self.with_additional_header(
"Set-Cookie",
"flash_name=; Max-Age=0; Expires=Fri, 21 Aug 1987 12:00:00 UTC",
)
.with_additional_header(
"Set-Cookie",
"flash_msg=; Max-Age=0; Expires=Fri, 21 Aug 1987 12:00:00 UTC",
)
}
}

View File

@ -0,0 +1,3 @@
pub mod flash;
pub mod sbot;
pub mod theme;

View File

@ -1,198 +0,0 @@
// Monitor data transmission totals, set thresholds and check alert flags
use std::convert::TryInto;
use nest::{Error, Store, Value};
use rocket::form::FromForm;
use rocket::serde::{Deserialize, Serialize};
use serde_json::json;
/// Network traffic data total
#[derive(Debug, Serialize)]
pub struct Data {
pub total: u64, // total traffic in bytes
}
impl Data {
/// Retrieve network traffic data values from the store
fn get(store: &Store) -> Data {
// retrieve previous network traffic statistics
let data_stored = match store.get(&["net", "traffic", "total"]) {
Ok(total) => total,
// return 0 if no value exists
Err(_) => Value::Uint(u64::MIN),
};
let mut data = Vec::new();
// retrieve u64 from Value type
if let Value::Uint(total) = data_stored {
data.push(total);
};
Data { total: data[0] }
}
}
/// Network traffic notification thresholds and flags (user-defined)
#[derive(Debug, Deserialize, Serialize, FromForm)]
pub struct Threshold {
warn: u64, // traffic warning threshold
cut: u64, // traffic cutoff threshold
warn_flag: bool, // traffic warning notification flag
cut_flag: bool, // traffic cutoff notification flag
}
impl Threshold {
/// Retrieve notification thresholds and flags from the store
fn get(store: &Store) -> Threshold {
let mut threshold = Vec::new();
let warn_val = store
.get(&["net", "notify", "warn"])
.unwrap_or(Value::Uint(0));
if let Value::Uint(val) = warn_val {
threshold.push(val);
};
let cut_val = store
.get(&["net", "notify", "cut"])
.unwrap_or(Value::Uint(0));
if let Value::Uint(val) = cut_val {
threshold.push(val);
};
let mut flag = Vec::new();
let warn_flag = store
.get(&["net", "notify", "warn_flag"])
.unwrap_or(Value::Bool(false));
if let Value::Bool(state) = warn_flag {
flag.push(state);
}
let cut_flag = store
.get(&["net", "notify", "cut_flag"])
.unwrap_or(Value::Bool(false));
if let Value::Bool(state) = cut_flag {
flag.push(state);
}
Threshold {
warn: threshold[0],
cut: threshold[1],
warn_flag: flag[0],
cut_flag: flag[1],
}
}
/// Store notification flags from user data
fn set(self, store: &Store) {
store
.set(&["net", "notify", "warn"], &Value::Uint(self.warn))
.unwrap();
store
.set(&["net", "notify", "cut"], &Value::Uint(self.cut))
.unwrap();
store
.set(
&["net", "notify", "warn_flag"],
&Value::Bool(self.warn_flag),
)
.unwrap();
store
.set(&["net", "notify", "cut_flag"], &Value::Bool(self.cut_flag))
.unwrap();
}
}
/// Warning and cutoff network traffic alert flags (programatically-defined)
#[derive(Debug, Serialize)]
pub struct Alert {
warn: bool,
cut: bool,
}
impl Alert {
/// Retrieve latest alert flags from the store
fn get(store: &Store) -> Alert {
let mut alert = Vec::new();
let warn_flag = store
.get(&["net", "alert", "warn"])
.unwrap_or(Value::Bool(false));
if let Value::Bool(flag) = warn_flag {
alert.push(flag);
}
let cut_flag = store
.get(&["net", "alert", "cut"])
.unwrap_or(Value::Bool(false));
if let Value::Bool(flag) = cut_flag {
alert.push(flag);
}
Alert {
warn: alert[0],
cut: alert[1],
}
}
}
fn create_store() -> std::result::Result<Store, Error> {
// define the path
let path = xdg::BaseDirectories::new()
.unwrap()
.create_data_directory("peachcloud")
.unwrap();
// define the schema
let schema = json!({
"net": {
"traffic": "json",
"alert": "json",
"notify": "json",
}
})
.try_into()?;
// create the data store
let store = Store::new(path, schema);
Ok(store)
}
pub fn get_alerts() -> std::result::Result<Alert, Error> {
let store = create_store()?;
let alerts = Alert::get(&store);
Ok(alerts)
}
pub fn get_data() -> std::result::Result<Data, Error> {
let store = create_store()?;
let data = Data::get(&store);
Ok(data)
}
pub fn get_thresholds() -> std::result::Result<Threshold, Error> {
let store = create_store()?;
let thresholds = Threshold::get(&store);
Ok(thresholds)
}
// set stored traffic total to 0
pub fn reset_data() -> std::result::Result<(), Error> {
let store = create_store()?;
store.set(&["net", "traffic", "total"], &Value::Uint(0))?;
Ok(())
}
pub fn update_store(threshold: Threshold) -> std::result::Result<(), Error> {
let store = create_store()?;
Threshold::set(threshold, &store);
Ok(())
}

698
peach-web/src/utils/sbot.rs Normal file
View File

@ -0,0 +1,698 @@
use std::{
collections::HashMap,
error::Error,
fs,
fs::File,
io,
io::prelude::*,
path::Path,
process::{Command, Output},
};
use async_std::task;
use dirs;
use futures::stream::TryStreamExt;
use golgi::{api::friends::RelationshipQuery, blobs, messages::SsbMessageValue, Sbot};
use log::debug;
use peach_lib::sbot::SbotConfig;
use rouille::input::post::BufferedFile;
use temporary::Directory;
use crate::{error::PeachWebError, utils::sbot};
// SBOT HELPER FUNCTIONS
/// Executes a systemctl command for the go-sbot.service process.
pub fn systemctl_sbot_cmd(cmd: &str) -> io::Result<Output> {
Command::new("systemctl")
.arg("--user")
.arg(cmd)
.arg("go-sbot.service")
.output()
}
/// Executes a systemctl stop command followed by start command.
/// Returns a redirect with a flash message stating the output of the restart attempt.
pub fn restart_sbot_process() -> (String, String) {
debug!("Restarting go-sbot.service");
match systemctl_sbot_cmd("stop") {
// if stop was successful, try to start the process
Ok(_) => match systemctl_sbot_cmd("start") {
Ok(_) => (
"success".to_string(),
"Updated configuration and restarted the sbot process".to_string(),
),
Err(err) => (
"error".to_string(),
format!(
"Updated configuration but failed to start the sbot process: {}",
err
),
),
},
Err(err) => (
"error".to_string(),
format!(
"Updated configuration but failed to stop the sbot process: {}",
err
),
),
}
}
/// Initialise an sbot client with the given configuration parameters.
pub async fn init_sbot_with_config(
sbot_config: &Option<SbotConfig>,
) -> Result<Sbot, PeachWebError> {
debug!("Initialising an sbot client with configuration parameters");
// initialise sbot connection with ip:port and shscap from config file
let sbot_client = match sbot_config {
// TODO: panics if we pass `Some(conf.shscap)` as second arg
Some(conf) => {
let ip_port = conf.lis.clone();
Sbot::init(Some(ip_port), None).await?
}
None => Sbot::init(None, None).await?,
};
Ok(sbot_client)
}
// SCUTTLEBUTT FUNCTIONS
/// Ensure that the given public key is a valid ed25519 key.
///
/// Return an error string if the key is invalid.
pub fn validate_public_key(public_key: &str) -> Result<(), String> {
// ensure the id starts with the correct sigil link
if !public_key.starts_with('@') {
return Err("Invalid key: expected '@' sigil as first character".to_string());
}
// find the dot index denoting the start of the algorithm definition tag
let dot_index = match public_key.rfind('.') {
Some(index) => index,
None => return Err("Invalid key: no dot index was found".to_string()),
};
// check hashing algorithm (must end with ".ed25519")
if !&public_key.ends_with(".ed25519") {
return Err("Invalid key: hashing algorithm must be ed25519".to_string());
}
// obtain the base64 portion (substring) of the public key
let base64_str = &public_key[1..dot_index];
// length of a base64 encoded ed25519 public key
if base64_str.len() != 44 {
return Err("Invalid key: base64 data length is incorrect".to_string());
}
Ok(())
}
/// Calculate the latest sequence number for the local profile.
///
/// Retrieves a list of all messages authored by the local public key,
/// reverses the list and reads the sequence number of the most recently
/// authored message. This gives us the size of the database in terms of
/// the total number of locally-authored messages.
pub fn latest_sequence_number() -> Result<u64, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
// retrieve the local id
let id = sbot_client.whoami().await?;
let history_stream = sbot_client.create_history_stream(id).await?;
let mut msgs: Vec<SsbMessageValue> = history_stream.try_collect().await?;
// there will be zero messages when the sbot is run for the first time
if msgs.is_empty() {
Ok(0)
} else {
// reverse the list of messages so we can easily reference the latest one
msgs.reverse();
// return the sequence number of the latest msg
Ok(msgs[0].sequence)
}
})
}
pub fn create_invite(uses: u16) -> Result<String, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
debug!("Generating Scuttlebutt invite code");
let invite_code = sbot_client.invite_create(uses).await?;
Ok(invite_code)
})
}
#[derive(Debug)]
pub struct Profile {
// is this the local profile or the profile of a peer?
pub is_local_profile: bool,
// an ssb_id which may or may not be the local public key
pub id: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub image: Option<String>,
// the path to the blob defined in the `image` field (aka the profile picture)
pub blob_path: Option<String>,
// whether or not the blob exists in the blobstore (ie. is saved on disk)
pub blob_exists: bool,
// relationship state (if the profile being viewed is not for the local public key)
pub following: Option<bool>,
pub blocking: Option<bool>,
}
impl Profile {
pub fn default() -> Self {
Profile {
is_local_profile: true,
id: None,
name: None,
description: None,
image: None,
blob_path: None,
blob_exists: false,
following: None,
blocking: None,
}
}
}
/// Retrieve the profile info for the given public key.
pub fn get_profile_info(ssb_id: Option<String>) -> Result<Profile, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
let local_id = sbot_client.whoami().await?;
let mut profile = Profile::default();
// if an ssb_id has been provided, we assume that the profile info
// being retrieved is for a peer (ie. not for our local profile)
let id = if let Some(peer_id) = ssb_id {
// we are not dealing with the local profile
profile.is_local_profile = false;
// determine relationship between peer and local id
let follow_query = RelationshipQuery {
source: local_id.clone(),
dest: peer_id.clone(),
};
// query follow state
profile.following = match sbot_client.friends_is_following(follow_query).await {
Ok(following) if following == "true" => Some(true),
Ok(following) if following == "false" => Some(false),
_ => None,
};
// TODO: i don't like that we have to instantiate the same query object
// twice. see if we can streamline this in golgi
let block_query = RelationshipQuery {
source: local_id.clone(),
dest: peer_id.clone(),
};
// query block state
profile.blocking = match sbot_client.friends_is_blocking(block_query).await {
Ok(blocking) if blocking == "true" => Some(true),
Ok(blocking) if blocking == "false" => Some(false),
_ => None,
};
peer_id
} else {
// if an ssb_id has not been provided, retrieve the local id using whoami
profile.is_local_profile = true;
local_id
};
// retrieve the profile info for the given id
let info = sbot_client.get_profile_info(&id).await?;
// set each profile field accordingly
for (key, val) in info {
match key.as_str() {
"name" => profile.name = Some(val),
"description" => profile.description = Some(val),
"image" => profile.image = Some(val),
_ => (),
}
}
// assign the ssb public key
// (could be for the local profile or a peer)
profile.id = Some(id);
// determine the path to the blob defined by the value of `profile.image`
if let Some(ref blob_id) = profile.image {
profile.blob_path = match blobs::get_blob_path(blob_id) {
Ok(path) => {
// if we get the path, check if the blob is in the blobstore.
// this allows us to default to a placeholder image in the template
if let Ok(exists) = blob_is_stored_locally(&path).await {
profile.blob_exists = exists
};
Some(path)
}
Err(_) => None,
}
}
Ok(profile)
})
}
/// Update the profile info for the local public key.
///
/// Profile info includes name, description and image.
pub fn update_profile_info(
current_name: String,
current_description: String,
new_name: Option<String>,
new_description: Option<String>,
image: Option<BufferedFile>,
) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
// track whether the name, description or image have been updated
let mut name_updated: bool = false;
let mut description_updated: bool = false;
let mut image_updated: bool = false;
// check if a new_name value has been submitted in the form
if let Some(name) = new_name {
// only update the name if it has changed
if name != current_name {
debug!("Publishing a new Scuttlebutt profile name");
if let Err(e) = sbot_client.publish_name(&name).await {
return Err(format!("Failed to update name: {}", e));
} else {
name_updated = true
}
}
}
if let Some(description) = new_description {
// only update the description if it has changed
if description != current_description {
debug!("Publishing a new Scuttlebutt profile description");
if let Err(e) = sbot_client.publish_description(&description).await {
return Err(format!("Failed to update description: {}", e));
} else {
description_updated = true
}
}
}
// only update the image if a file was uploaded
if let Some(img) = image {
// only write the blob if it has a filename and data > 0 bytes
if img.filename.is_some() && !img.data.is_empty() {
match write_blob_to_store(img).await {
Ok(blob_id) => {
// if the file was successfully added to the blobstore,
// publish an about image message with the blob id
if let Err(e) = sbot_client.publish_image(&blob_id).await {
return Err(format!("Failed to update image: {}", e));
} else {
image_updated = true
}
}
Err(e) => return Err(format!("Failed to add image to blobstore: {}", e)),
}
} else {
image_updated = false
}
}
if name_updated || description_updated || image_updated {
Ok("Profile updated".to_string())
} else {
// no updates were made but no errors were encountered either
Ok("Profile info unchanged".to_string())
}
})
}
/// Follow a peer.
pub fn follow_peer(public_key: &str) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
debug!("Following a Scuttlebutt peer");
match sbot_client.follow(public_key).await {
Ok(_) => Ok("Followed peer".to_string()),
Err(e) => Err(format!("Failed to follow peer: {}", e)),
}
})
}
/// Unfollow a peer.
pub fn unfollow_peer(public_key: &str) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
debug!("Unfollowing a Scuttlebutt peer");
match sbot_client.unfollow(public_key).await {
Ok(_) => Ok("Unfollowed peer".to_string()),
Err(e) => Err(format!("Failed to unfollow peer: {}", e)),
}
})
}
/// Block a peer.
pub fn block_peer(public_key: &str) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
debug!("Blocking a Scuttlebutt peer");
match sbot_client.block(public_key).await {
Ok(_) => Ok("Blocked peer".to_string()),
Err(e) => Err(format!("Failed to block peer: {}", e)),
}
})
}
/// Unblock a peer.
pub fn unblock_peer(public_key: &str) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
debug!("Unblocking a Scuttlebutt peer");
match sbot_client.unblock(public_key).await {
Ok(_) => Ok("Unblocked peer".to_string()),
Err(e) => Err(format!("Failed to unblock peer: {}", e)),
}
})
}
/// Retrieve a list of peers blocked by the local public key.
pub fn get_blocks_list() -> Result<Vec<HashMap<String, String>>, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
let blocks = sbot_client.get_blocks().await?;
// we'll use this to store the profile info for each peer whom we block
let mut peer_list = Vec::new();
if !blocks.is_empty() {
for peer in blocks.iter() {
// trim whitespace (including newline characters) and
// remove the inverted-commas around the id
let key = peer.trim().replace('"', "");
// retrieve the profile info for the given peer
let mut peer_info = sbot_client.get_profile_info(&key).await?;
// insert the public key of the peer into the info hashmap
peer_info.insert("id".to_string(), key.to_string());
// we do not even attempt to find the blob for a blocked peer,
// since it may be vulgar to cause distress to the local peer.
peer_info.insert("blob_exists".to_string(), "false".to_string());
// push profile info to peer_list vec
peer_list.push(peer_info)
}
}
// return the list of blocked peers
Ok(peer_list)
})
}
/// Retrieve a list of peers followed by the local public key.
pub fn get_follows_list() -> Result<Vec<HashMap<String, String>>, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
let follows = sbot_client.get_follows().await?;
// we'll use this to store the profile info for each peer who follows us
let mut peer_list = Vec::new();
if !follows.is_empty() {
for peer in follows.iter() {
// trim whitespace (including newline characters) and
// remove the inverted-commas around the id
let key = peer.trim().replace('"', "");
// retrieve the profile info for the given peer
let mut peer_info = sbot_client.get_profile_info(&key).await?;
// insert the public key of the peer into the info hashmap
peer_info.insert("id".to_string(), key.to_string());
// retrieve the profile image blob id for the given peer
if let Some(blob_id) = peer_info.get("image") {
// look-up the path for the image blob
if let Ok(blob_path) = blobs::get_blob_path(blob_id) {
// insert the image blob path of the peer into the info hashmap
peer_info.insert("blob_path".to_string(), blob_path.to_string());
// check if the blob is in the blobstore
// set a flag in the info hashmap
match blob_is_stored_locally(&blob_path).await {
Ok(exists) if exists => {
peer_info.insert("blob_exists".to_string(), "true".to_string())
}
_ => peer_info.insert("blob_exists".to_string(), "false".to_string()),
};
}
}
// push profile info to peer_list vec
peer_list.push(peer_info)
}
}
// return the list of peers
Ok(peer_list)
})
}
/// Retrieve a list of peers friended by the local public key.
pub fn get_friends_list() -> Result<Vec<HashMap<String, String>>, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
let local_id = sbot_client.whoami().await?;
let follows = sbot_client.get_follows().await?;
// we'll use this to store the profile info for each friend
let mut peer_list = Vec::new();
if !follows.is_empty() {
for peer in follows.iter() {
// trim whitespace (including newline characters) and
// remove the inverted-commas around the id
let peer_id = peer.trim().replace('"', "");
// retrieve the profile info for the given peer
let mut peer_info = sbot_client.get_profile_info(&peer_id).await?;
// insert the public key of the peer into the info hashmap
peer_info.insert("id".to_string(), peer_id.to_string());
// retrieve the profile image blob id for the given peer
if let Some(blob_id) = peer_info.get("image") {
// look-up the path for the image blob
if let Ok(blob_path) = blobs::get_blob_path(blob_id) {
// insert the image blob path of the peer into the info hashmap
peer_info.insert("blob_path".to_string(), blob_path.to_string());
// check if the blob is in the blobstore
// set a flag in the info hashmap
match sbot::blob_is_stored_locally(&blob_path).await {
Ok(exists) if exists => {
peer_info.insert("blob_exists".to_string(), "true".to_string())
}
_ => peer_info.insert("blob_exists".to_string(), "false".to_string()),
};
}
}
// check if the peer follows us (making us friends)
let follow_query = RelationshipQuery {
source: peer_id.to_string(),
dest: local_id.clone(),
};
// query follow state
match sbot_client.friends_is_following(follow_query).await {
Ok(following) if following == "true" => {
// only push profile info to peer_list vec if they follow us
peer_list.push(peer_info)
}
_ => (),
};
}
}
// return the list of peers
Ok(peer_list)
})
}
/// Retrieve the local public key (id).
pub fn get_local_id() -> Result<String, Box<dyn Error>> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config).await?;
let local_id = sbot_client.whoami().await?;
Ok(local_id)
})
}
/// Publish a public post.
pub fn publish_public_post(text: String) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
debug!("Publishing a new Scuttlebutt public post");
match sbot_client.publish_post(&text).await {
Ok(_) => Ok("Published post".to_string()),
Err(e) => Err(format!("Failed to publish post: {}", e)),
}
})
}
/// Publish a private message.
pub fn publish_private_msg(text: String, recipients: Vec<String>) -> Result<String, String> {
// retrieve latest go-sbot configuration parameters
let sbot_config = SbotConfig::read().ok();
task::block_on(async {
let mut sbot_client = init_sbot_with_config(&sbot_config)
.await
.map_err(|e| e.to_string())?;
debug!("Publishing a new Scuttlebutt private message");
match sbot_client
.publish_private(text.to_string(), recipients)
.await
{
Ok(_) => Ok("Published private message".to_string()),
Err(e) => Err(format!("Failed to publish private message: {}", e)),
}
})
}
// FILEPATH FUNCTIONS
/// Return the path of the ssb-go directory.
pub fn get_go_ssb_path() -> Result<String, PeachWebError> {
let go_ssb_path = match SbotConfig::read() {
Ok(conf) => conf.repo,
// return the default path if unable to read `config.toml`
Err(_) => {
// determine the home directory
let mut home_path = dirs::home_dir().ok_or(PeachWebError::HomeDir)?;
// add the go-ssb subdirectory
home_path.push(".ssb-go");
// convert the PathBuf to a String
home_path
.into_os_string()
.into_string()
.map_err(|_| PeachWebError::OsString)?
}
};
Ok(go_ssb_path)
}
/// Check whether a blob is in the blobstore.
pub async fn blob_is_stored_locally(blob_path: &str) -> Result<bool, PeachWebError> {
let go_ssb_path = get_go_ssb_path()?;
let complete_path = format!("{}/blobs/sha256/{}", go_ssb_path, blob_path);
let blob_exists_locally = Path::new(&complete_path).exists();
Ok(blob_exists_locally)
}
// take the path to a file, add it to the blobstore and return the blob id
pub async fn write_blob_to_store(image: BufferedFile) -> Result<String, PeachWebError> {
// we performed a `image.filename.is_some()` check before calling `write_blob_to_store`
// so it should be safe to do a simple unwrap here
let filename = image
.filename
.expect("retrieving filename from uploaded file");
// create temporary directory and path
let temp_dir = Directory::new("blob")?;
let temp_path = temp_dir.join(filename);
// write file to temporary path
fs::write(&temp_path, &image.data)?;
// open the file and read it into a buffer
let mut file = File::open(&temp_path)?;
let mut buffer = Vec::new();
file.read_to_end(&mut buffer)?;
// hash the bytes representing the file
let (hex_hash, blob_id) = blobs::hash_blob(&buffer)?;
// define the blobstore path and blob filename
let (blob_dir, blob_filename) = hex_hash.split_at(2);
let go_ssb_path = get_go_ssb_path()?;
let blobstore_sub_dir = format!("{}/blobs/sha256/{}", go_ssb_path, blob_dir);
// create the blobstore sub-directory
fs::create_dir_all(&blobstore_sub_dir)?;
// copy the file to the blobstore
let blob_path = format!("{}/{}", blobstore_sub_dir, blob_filename);
fs::copy(temp_path, blob_path)?;
Ok(blob_id)
}

View File

@ -0,0 +1,25 @@
use log::info;
use crate::THEME;
// THEME FUNCTIONS
#[derive(Debug, Copy, Clone)]
pub enum Theme {
Light,
Dark,
}
pub fn get_theme() -> String {
let current_theme = THEME.read().unwrap();
match *current_theme {
Theme::Dark => "dark".to_string(),
_ => "light".to_string(),
}
}
pub fn set_theme(theme: Theme) {
info!("set ui theme to: {:?}", theme);
let mut writable_theme = THEME.write().unwrap();
*writable_theme = theme;
}

View File

@ -166,12 +166,43 @@
--light: var(--light-gray);
--dark: var(--near-black);
/* we need to add shades for each accent colour
*
* --info-100
* --info-200
* --info-300 -> var(--blue)
* --info-400
* --info-500
*/
/* LIGHT (default) THEME VARIABLES */
--background: var(--moon-gray);
--button-background: var(--light-gray);
--button-border: var(--near-black);
--circle-background: var(--light-gray);
--circle-small-hover-background: var(--white);
--color-ssb: var(--hot-pink);
--color-settings: var(--purple);
--color-status: var(--green);
--color-info: var(--info);
--capsule-background: var(--light-gray);
--list-background: var(--light-gray);
--text-color-normal: var(--near-black);
--text-color-gray: var(--mid-gray);
--text-color-light-gray: var(--moon-gray);
--text-color-light: var(--white);
--icon-normal: invert(0%) sepia(1%) saturate(100%) hue-rotate(79deg) brightness(86%) contrast(87%);
--icon-gray: invert(72%) sepia(8%) saturate(14%) hue-rotate(316deg) brightness(93%) contrast(92%);
--icon-light: invert();
/* DARK THEME VARIABLES */
--background-dark: #222;
--button-background-dark: var(--mid-gray);
--button-border-dark: var(--silver);
--capsule-background-dark: #333;
--circle-background-dark: var(--silver);
--circle-small-hover-background-dark: var(--moon-gray);
--list-background-dark: #333;
}

View File

@ -15,6 +15,7 @@
* - HTML
* - FLASH MESSAGE
* - FONTS
* - FORMS
* - ICONS
* - INPUTS
* - LABELS
@ -25,6 +26,8 @@
* - NAVIGATION
* - PARAGRAPHS
* - SWITCHES / SLIDERS
* - TEXT
* - TITLES
*
\* ------------------------------ */
@ -127,32 +130,77 @@
*/
body {
background-color: var(--moon-gray);
background-color: var(--background);
height: 100%;
display: flex;
flex-direction: column;
margin: 0;
}
/*
* BORDERS
*/
.border-circle-small {
border: 4px solid;
}
.border-settings {
border-color: var(--color-settings);
}
.border-ssb {
border-color: var(--color-ssb);
}
.border-status {
border-color: var(--color-status);
}
.border-primary {
border-color: var(--primary);
}
.border-success {
border-color: var(--success);
}
.border-info {
border-color: var(--info);
}
.border-warning {
border-color: var(--warning);
}
.border-danger {
border-color: var(--danger);
}
.border-dark-gray {
border-color: var(--dark-gray);
}
/*
* BUTTONS
*/
.button {
border: 1px solid var(--near-black);
border: 1px solid var(--button-border);
border-radius: var(--border-radius-2);
/* Needed to render inputs & buttons of equal width */
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
box-sizing: border-box;
color: var(--near-black);
color: var(--button-text-color);
cursor: pointer;
padding: 10px;
text-align: center;
text-decoration: none;
font-size: var(--font-size-5);
font-family: var(--sans-serif);
width: 80%;
/* width: 80%; */
width: 16rem;
margin-top: 5px;
margin-bottom: 5px;
}
@ -168,37 +216,42 @@ body {
}
.button-primary {
background-color: var(--light-gray);
background-color: var(--button-background);
}
.button-primary:hover {
background-color: var(--primary);
color: var(--button-text-hover-color);
}
.button-primary:focus {
background-color: var(--primary);
color: var(--button-text-hover-color);
outline: none;
}
.button-secondary {
background-color: var(--light-gray);
background-color: var(--button-background);
}
.button-secondary:hover {
background-color: var(--light-silver);
color: var(--button-text-hover-color);
}
.button-secondary:focus {
background-color: var(--light-silver);
color: var(--button-text-hover-color);
outline: none;
}
.button-warning {
background-color: var(--light-gray);
background-color: var(--button-background);
}
.button-warning:hover {
background-color: var(--light-red);
color: var(--button-text-hover-color);
}
.button-warning:focus {
@ -212,9 +265,9 @@ body {
.capsule {
padding: 1rem;
border: var(--border-width-1) solid;
border-style: solid;
border-radius: var(--border-radius-3);
background-color: var(--light-gray);
background-color: var(--capsule-background);
/* margin-top: 1rem; */
/* margin-bottom: 1rem; */
}
@ -225,6 +278,18 @@ body {
padding-bottom: 1rem;
}
.capsule-profile {
margin-left: 1rem;
margin-right: 1rem;
}
@media only screen and (min-width: 600px) {
.capsule-profile {
margin-left: 0;
margin-right: 0;
}
}
@media only screen and (min-width: 600px) {
.capsule-container {
margin-left: 0;
@ -252,6 +317,12 @@ body {
}
}
@media only screen and (min-width: 600px) {
.card-wide {
width: 30rem;
}
}
.card-container {
justify-content: center;
padding: 0.5rem;
@ -271,9 +342,10 @@ body {
}
.card-text {
color: var(--text-color);
margin: 0;
font-size: var(--font-size-5);
padding-bottom: 0.3rem;
padding-bottom: 0.5rem;
}
.container {
@ -293,7 +365,7 @@ body {
.circle {
align-items: center;
background: var(--light-gray);
background: var(--circle-background);
border-radius: 50%;
box-shadow: var(--box-shadow-3);
display: flex;
@ -306,6 +378,15 @@ body {
width: 5rem;
}
.circle-small:hover {
background: var(--circle-small-hover-background);
}
.circle-small:focus {
background: var(--circle-small-hover-background);
outline: none;
}
.circle-medium {
height: 8rem;
width: 8rem;
@ -390,30 +471,6 @@ body {
background-color: var(--light);
}
.primary-border {
border-color: var(--primary);
}
.success-border {
border-color: var(--success);
}
.info-border {
border-color: var(--info);
}
.warning-border {
border-color: var(--warning);
}
.danger-border {
border-color: var(--danger);
}
.dark-gray-border {
border-color: var(--dark-gray);
}
/*
* GRIDS
*/
@ -554,6 +611,34 @@ body {
html {
height: 100%;
--background: var(--background);
--button-background: var(--button-background);
--button-border: var(--button-border);
--button-text-color: var(--text-color-normal);
--button-text-hover-color: var(--text-color-normal);
--circle-background: var(--circle-background);
--circle-small-hover-background: var(--circle-small-hover-background);
--icon-color: var(--icon-normal);
--list-background: var(--list-background);
--nav-icon-color: var(--nav-icon-color);
--text-color: var(--text-color-normal);
}
html[data-theme='dark'] {
--background: var(--background-dark);
--button-background: var(--button-background-dark);
--button-border: var(--button-border-dark);
--button-text-color: var(--text-color-light);
--button-text-hover-color: var(--text-color-normal);
--capsule-background: var(--capsule-background-dark);
--circle-background: var(--circle-background-dark);
--circle-small-hover-background: var(--circle-small-hover-background-dark);
--icon-color: var(--icon-light);
--list-background: var(--list-background-dark);
--nav-icon-color: var(--nav-icon-color-light);
--text-color: var(--text-color-light);
--text-color-gray: var(--text-color-light-gray);
}
/*
@ -563,37 +648,45 @@ html {
.flash-message {
font-family: var(--sans-serif);
font-size: var(--font-size-6);
margin-left: 2rem;
margin-right: 2rem;
/*margin-left: 2rem;*/
/*margin-right: 2rem;*/
margin-top: 1rem;
width: 14rem;
}
/*
* FONTS
*/
.font-normal {
color: var(--text-color);
}
.font-near-black {
color: var(--near-black);
}
.font-gray {
color: var(--mid-gray);
color: var(--text-color-gray);
}
.font-light-gray {
color: var(--silver);
/* color: var(--silver); */
color: var(--text-color-light-gray);
}
.font-success {
color: var(--success);
/*
* FORMS
*/
form {
width: 90%;
}
.font-warning {
color: var(--warning);
}
.font-failure {
color: var(--danger);
@media only screen and (min-width: 600px) {
form {
width: 100%;
}
}
/*
@ -622,12 +715,12 @@ html {
/* icon-active: sets color of icon svg to near-black */
.icon-active {
filter: invert(0%) sepia(1%) saturate(4171%) hue-rotate(79deg) brightness(86%) contrast(87%);
filter: var(--icon-color);
}
/* icon-inactive: sets color of icon svg to gray */
.icon-inactive {
filter: invert(72%) sepia(8%) saturate(14%) hue-rotate(316deg) brightness(93%) contrast(92%);
filter: var(--icon-gray);
}
/*
@ -639,7 +732,7 @@ html {
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
box-sizing: border-box;
margin-top: 0.5rem;
/* margin-top: 0.5rem; */
margin-bottom: 1rem;
padding-left: 5px;
line-height: 1.5rem;
@ -657,8 +750,10 @@ html {
.message-input {
height: 7rem;
margin-top: 0.5rem;
overflow: auto;
resize: vertical;
width: 100%;
}
.alert-input {
@ -700,7 +795,7 @@ html {
.label-ellipsis {
overflow: hidden;
text-overflow: ellipsis;
width: 10rem;
/*width: 10rem;*/
}
.input-label {
@ -713,7 +808,11 @@ html {
.link {
text-decoration: none;
color: var(--font-near-black);
color: var(--text-color);
}
.link:hover {
text-decoration: underline;
}
/*
@ -722,14 +821,20 @@ html {
.list {
padding-left: 0;
margin-left: 0;
max-width: var(--max-width-6);
width: 90%;
border: 1px solid var(--light-silver);
border-radius: var(--border-radius-2);
list-style-type: none;
font-family: var(--sans-serif);
}
@media only screen and (min-width: 600px) {
.list {
width: 100%;
max-width: var(--max-width-6);
}
}
.list-container {
width: var(--max-width-5);
}
@ -742,6 +847,7 @@ html {
}
.list-item {
background-color: var(--list-background);
display: grid;
padding: 1rem;
border-bottom-color: var(--light-silver);
@ -846,6 +952,7 @@ meter::-moz-meter-bar {
}
.nav-title {
color: var(--text-color);
font-family: var(--sans-serif);
font-size: var(--font-size-4);
font-weight: normal;
@ -961,6 +1068,26 @@ input:checked + .slider:before {
border-radius: 50%;
}
/*
* TEXT
*/
.text-info {
color: var(--info);
}
.text-danger {
color: var(--danger);
}
.text-success {
color: var(--success);
}
.text-warning {
color: var(--warning);
}
/*
* TITLES
*/

Some files were not shown because too many files have changed in this diff Show More