magmaus3/continuwuity
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

contextualize handler in object

Browse source 
Signed-off-by: Jason Volk <jason@zemos.net>
This commit is contained in:
Jason Volk 2024-07-22 22:45:25 +00:00
parent ccfa939bd3
commit 5ed95ea357
1 changed files with 131 additions and 114 deletions
Download patch file Download diff file Expand all files Collapse all files

245
src/admin/handler.rs
View file

@ -12,16 +12,28 @@ use ruma::{
}; };
use conduit::{utils::string::common_prefix, Result}; use conduit::{utils::string::common_prefix, Result};
use service::admin::{Command, CommandOutput, CommandResult, HandlerResult}; use service::{
admin::{Command, CommandOutput, CommandResult, HandlerResult},
Services,
};
use crate::{admin, admin::AdminCommand, services}; use crate::{admin, admin::AdminCommand};
struct Handler<'a> {
services: &'a Services,
}
#[must_use]
pub(super) fn complete(line: &str) -> String {
Handler {
services: service::services(),
}
.complete_command(AdminCommand::command(), line)
}
#[must_use] #[must_use]
pub(super) fn handle(command: Command) -> HandlerResult { Box::pin(handle_command(command)) } pub(super) fn handle(command: Command) -> HandlerResult { Box::pin(handle_command(command)) }
#[must_use]
pub(super) fn complete(line: &str) -> String { complete_command(AdminCommand::command(), line) }
#[tracing::instrument(skip_all, name = "admin")] #[tracing::instrument(skip_all, name = "admin")]
async fn handle_command(command: Command) -> CommandResult { async fn handle_command(command: Command) -> CommandResult {
AssertUnwindSafe(process_command(&command)) AssertUnwindSafe(process_command(&command))
@ -32,9 +44,12 @@ async fn handle_command(command: Command) -> CommandResult {
} }
async fn process_command(command: &Command) -> CommandOutput { async fn process_command(command: &Command) -> CommandOutput {
process(&command.command) Handler {
.await services: service::services(),
.and_then(|content| reply(content, command.reply_id.clone())) }
.process(&command.command)
.await
.and_then(|content| reply(content, command.reply_id.clone()))
} }
fn handle_panic(error: &Error, command: Command) -> CommandResult { fn handle_panic(error: &Error, command: Command) -> CommandResult {
@ -55,122 +70,124 @@ fn reply(mut content: RoomMessageEventContent, reply_id: Option<OwnedEventId>) -
Some(content) Some(content)
} }
// Parse and process a message from the admin room impl Handler<'_> {
async fn process(msg: &str) -> CommandOutput { // Parse and process a message from the admin room
let mut lines = msg.lines().filter(|l| !l.trim().is_empty()); async fn process(&self, msg: &str) -> CommandOutput {
let command = lines.next().expect("each string has at least one line"); let mut lines = msg.lines().filter(|l| !l.trim().is_empty());
let body = lines.collect::<Vec<_>>(); let command = lines.next().expect("each string has at least one line");
let parsed = match parse_command(command) { let body = lines.collect::<Vec<_>>();
Ok(parsed) => parsed, let parsed = match self.parse_command(command) {
Err(error) => { Ok(parsed) => parsed,
let server_name = services().globals.server_name(); Err(error) => {
let message = error.replace("server.name", server_name.as_str()); let server_name = self.services.globals.server_name();
return Some(RoomMessageEventContent::notice_markdown(message)); let message = error.replace("server.name", server_name.as_str());
}, return Some(RoomMessageEventContent::notice_markdown(message));
}; },
};
let timer = Instant::now(); let timer = Instant::now();
let result = admin::process(parsed, body).await; let result = Box::pin(admin::process(parsed, body)).await;
let elapsed = timer.elapsed(); let elapsed = timer.elapsed();
conduit::debug!(?command, ok = result.is_ok(), "command processed in {elapsed:?}"); conduit::debug!(?command, ok = result.is_ok(), "command processed in {elapsed:?}");
match result { match result {
Ok(reply) => Some(reply), Ok(reply) => Some(reply),
Err(error) => Some(RoomMessageEventContent::notice_markdown(format!( Err(error) => Some(RoomMessageEventContent::notice_markdown(format!(
"Encountered an error while handling the command:\n```\n{error:#?}\n```" "Encountered an error while handling the command:\n```\n{error:#?}\n```"
))), ))),
}
} }
}
// Parse chat messages from the admin room into an AdminCommand object // Parse chat messages from the admin room into an AdminCommand object
fn parse_command(command_line: &str) -> Result<AdminCommand, String> { fn parse_command(&self, command_line: &str) -> Result<AdminCommand, String> {
let argv = parse_line(command_line); let argv = self.parse_line(command_line);
AdminCommand::try_parse_from(argv).map_err(|error| error.to_string()) AdminCommand::try_parse_from(argv).map_err(|error| error.to_string())
} }
fn complete_command(mut cmd: clap::Command, line: &str) -> String { fn complete_command(&self, mut cmd: clap::Command, line: &str) -> String {
let argv = parse_line(line); let argv = self.parse_line(line);
let mut ret = Vec::<String>::with_capacity(argv.len().saturating_add(1)); let mut ret = Vec::<String>::with_capacity(argv.len().saturating_add(1));
'token: for token in argv.into_iter().skip(1) { 'token: for token in argv.into_iter().skip(1) {
let cmd_ = cmd.clone(); let cmd_ = cmd.clone();
let mut choice = Vec::new(); let mut choice = Vec::new();
for sub in cmd_.get_subcommands() { for sub in cmd_.get_subcommands() {
let name = sub.get_name(); let name = sub.get_name();
if *name == token { if *name == token {
// token already complete; recurse to subcommand // token already complete; recurse to subcommand
ret.push(token); ret.push(token);
cmd.clone_from(sub); cmd.clone_from(sub);
continue 'token; continue 'token;
} else if name.starts_with(&token) { } else if name.starts_with(&token) {
// partial match; add to choices // partial match; add to choices
choice.push(name); choice.push(name);
}
} }
if choice.len() == 1 {
// One choice. Add extra space because it's complete
let choice = *choice.first().expect("only choice");
ret.push(choice.to_owned());
ret.push(String::new());
} else if choice.is_empty() {
// Nothing found, return original string
ret.push(token);
} else {
// Find the common prefix
ret.push(common_prefix(&choice).into());
}
// Return from completion
return ret.join(" ");
} }
if choice.len() == 1 { // Return from no completion. Needs a space though.
// One choice. Add extra space because it's complete ret.push(String::new());
let choice = *choice.first().expect("only choice"); ret.join(" ")
ret.push(choice.to_owned()); }
ret.push(String::new());
} else if choice.is_empty() { // Parse chat messages from the admin room into an AdminCommand object
// Nothing found, return original string fn parse_line(&self, command_line: &str) -> Vec<String> {
ret.push(token); let mut argv = command_line
} else { .split_whitespace()
// Find the common prefix .map(str::to_owned)
ret.push(common_prefix(&choice).into()); .collect::<Vec<String>>();
// Remove any escapes that came with a server-side escape command
if !argv.is_empty() && argv[0].ends_with("admin") {
argv[0] = argv[0].trim_start_matches('\\').into();
} }
// Return from completion // First indice has to be "admin" but for console convenience we add it here
return ret.join(" "); let server_user = self.services.globals.server_user.as_str();
} if !argv.is_empty() && !argv[0].ends_with("admin") && !argv[0].starts_with(server_user) {
argv.insert(0, "admin".to_owned());
}
// Return from no completion. Needs a space though. // Replace `help command` with `command --help`
ret.push(String::new()); // Clap has a help subcommand, but it omits the long help description.
ret.join(" ") if argv.len() > 1 && argv[1] == "help" {
} argv.remove(1);
argv.push("--help".to_owned());
// Parse chat messages from the admin room into an AdminCommand object }
fn parse_line(command_line: &str) -> Vec<String> {
let mut argv = command_line // Backwards compatibility with `register_appservice`-style commands
.split_whitespace() if argv.len() > 1 && argv[1].contains('_') {
.map(str::to_owned) argv[1] = argv[1].replace('_', "-");
.collect::<Vec<String>>(); }
// Remove any escapes that came with a server-side escape command // Backwards compatibility with `register_appservice`-style commands
if !argv.is_empty() && argv[0].ends_with("admin") { if argv.len() > 2 && argv[2].contains('_') {
argv[0] = argv[0].trim_start_matches('\\').into(); argv[2] = argv[2].replace('_', "-");
} }
// First indice has to be "admin" but for console convenience we add it here // if the user is using the `query` command (argv[1]), replace the database
let server_user = services().globals.server_user.as_str(); // function/table calls with underscores to match the codebase
if !argv.is_empty() && !argv[0].ends_with("admin") && !argv[0].starts_with(server_user) { if argv.len() > 3 && argv[1].eq("query") {
argv.insert(0, "admin".to_owned()); argv[3] = argv[3].replace('_', "-");
} }
// Replace `help command` with `command --help` trace!(?command_line, ?argv, "parse");
// Clap has a help subcommand, but it omits the long help description. argv
if argv.len() > 1 && argv[1] == "help" { }
argv.remove(1);
argv.push("--help".to_owned());
}
// Backwards compatibility with `register_appservice`-style commands
if argv.len() > 1 && argv[1].contains('_') {
argv[1] = argv[1].replace('_', "-");
}
// Backwards compatibility with `register_appservice`-style commands
if argv.len() > 2 && argv[2].contains('_') {
argv[2] = argv[2].replace('_', "-");
}
// if the user is using the `query` command (argv[1]), replace the database
// function/table calls with underscores to match the codebase
if argv.len() > 3 && argv[1].eq("query") {
argv[3] = argv[3].replace('_', "-");
}
trace!(?command_line, ?argv, "parse");
argv
} }