various improvements, NS HELP support

Author: internet-catte

sable_ircd/src/command/handlers/help.rs

@@ -3,7 +3,7 @@ use super::*;
 use itertools::Itertools;
 
 #[command_handler("HELP", "UHELP")]
-/// HELP [<topic>]
+/// HELP \[\<topic\>\]
 ///
 /// HELP displays information for topic requested.
 /// If no topic is requested, it will list available
@@ -15,60 +15,119 @@ fn help_handler(
     source: UserSource,
     topic: Option<&str>,
 ) -> CommandResult {
-    // TODO: oper help? (and if oper help is on the same command, UHELP like solanum?)
+    // TODO: better restricted mechanism?
     // TODO: non-command help topics
     let is_oper = command.command().to_ascii_uppercase() != "UHELP" && source.is_oper();
 
     match topic {
-        Some(s) => {
-            let topic = s.to_ascii_uppercase();
-            let topic = topic
-                .split_once(' ')
-                .map_or(topic.clone(), |(t, _)| t.to_string());
+        Some(t) => {
+            let topic = t.to_ascii_uppercase();
+            let topic = topic.split_once(' ').map_or(topic.clone(), |(t, _)| t.to_string());
+            if let Some(mut lines) = get_help(&server.command_dispatcher, &topic, is_oper) {
+                response.numeric(make_numeric!(
+                    HelpStart,
+                    &topic,
+                    lines.next().unwrap().as_ref()
+                ));
+                for line in lines {
+                    response.numeric(make_numeric!(HelpText, &topic, line.as_ref()));
+                }
+                response.numeric(make_numeric!(EndOfHelp, &topic));
+                return Ok(());
+            } else {
+                response.numeric(make_numeric!(HelpNotFound, &topic));
+            }
+        }
+        None => {
+            let topic = "*";
+            response.numeric(make_numeric!(HelpStart, &topic, "Available help topics:"));
+            response.numeric(make_numeric!(HelpText, &topic, ""));
+            for line in list_help(&server.command_dispatcher, is_oper) {
+                response.numeric(make_numeric!(HelpText, &topic, line.as_ref()));
+            }
+            response.numeric(make_numeric!(EndOfHelp, &topic));
+        }
+    };
+    Ok(())
+}
 
-            if let Some(cmd) = server.get_command(&topic) {
-                if cmd.docs.len() > 0 {
-                    // TODO
-                    if cmd.restricted && is_oper {
-                        response.numeric(make_numeric!(HelpNotFound, &topic));
-                        return Ok(());
-                    }
-                    let mut lines = cmd.docs.iter();
-                    response.numeric(make_numeric!(
-                        HelpStart,
-                        &topic,
-                        lines.next().unwrap_or(&topic.as_str())
-                    ));
-                    for line in lines {
-                        response.numeric(make_numeric!(HelpText, &topic, line));
-                    }
-                    response.numeric(make_numeric!(EndOfHelp, &topic));
-                    return Ok(());
+#[command_handler("HELP", "UHELP", in("NS"))]
+/// NS HELP \[\<topic\>\]
+///
+/// Displays information about the topic requested.
+fn ns_help_handler(
+    command: &dyn Command,
+    response: &dyn CommandResponse,
+    server: &ClientServer,
+    source: UserSource,
+    topic: Option<&str>,
+) -> CommandResult {
+    let is_oper = command.command().to_ascii_uppercase() != "UHELP" && source.is_oper();
+    let dispatcher = CommandDispatcher::with_category("NS");
+
+    match topic {
+        Some(t) => {
+            let topic = t.to_ascii_uppercase();
+            let topic = topic.split_once(' ').map_or(topic.clone(), |(t, _)| t.to_string());
+            if let Some(mut lines) = get_help(&dispatcher, &topic, is_oper) {
+                response.numeric(make_numeric!(
+                    HelpStart,
+                    &topic,
+                    lines.next().unwrap().as_ref()
+                ));
+                for line in lines {
+                    response.numeric(make_numeric!(HelpText, &topic, line.as_ref()));
                 }
+                response.numeric(make_numeric!(EndOfHelp, &topic));
+                return Ok(());
+            } else {
+                response.numeric(make_numeric!(HelpNotFound, &topic));
             }
-            response.numeric(make_numeric!(HelpNotFound, &topic));
         }
         None => {
             let topic = "*";
-            response.numeric(make_numeric!(HelpStart, topic, "Available help topics:"));
-            response.numeric(make_numeric!(HelpText, topic, ""));
-            for chunk in &server
-                .iter_commands()
-                .filter_map(|(k, v)| {
-                    if !v.restricted || is_oper {
-                        Some(k.to_ascii_uppercase())
-                    } else {
-                        None
-                    }
-                })
-                .sorted()
-                .chunks(4)
-            {
-                let line = format!("{:16}", chunk.format(" "));
-                response.numeric(make_numeric!(HelpText, topic, &line));
+            response.numeric(make_numeric!(HelpStart, &topic, "Available help topics:"));
+            response.numeric(make_numeric!(HelpText, &topic, ""));
+            for line in list_help(&dispatcher, is_oper) {
+                response.numeric(make_numeric!(HelpText, &topic, line.as_ref()));
             }
-            response.numeric(make_numeric!(EndOfHelp, topic));
+            response.numeric(make_numeric!(EndOfHelp, &topic));
         }
     };
     Ok(())
 }
+
+fn get_help(
+    dispatcher: &CommandDispatcher,
+    topic: &str,
+    is_oper: bool,
+) -> Option<impl Iterator<Item = impl AsRef<str>>> {
+    if let Some(cmd) = dispatcher.get_command(&topic) {
+        if cmd.docs.len() > 0 {
+            if cmd.restricted && !is_oper {
+                return None;
+            }
+            return Some(cmd.docs.iter());
+        }
+    }
+    return None;
+}
+
+fn list_help(dispatcher: &CommandDispatcher, is_oper: bool) -> Vec<impl AsRef<str>> {
+    let mut lines = vec![];
+    for chunk in &dispatcher
+        .iter_commands()
+        .filter_map(|(k, v)| {
+            if (!v.restricted || is_oper) && (v.docs.len() > 0) {
+                Some(k.to_ascii_uppercase())
+            } else {
+                None
+            }
+        })
+        .sorted()
+        .chunks(4)
+    {
+        lines.push(format!("{:16}", chunk.format(" ")));
+    }
+    lines
+}

sable_ircd/src/server/mod.rs

@@ -74,7 +74,7 @@ pub struct ClientServer {
     stored_response_sinks: RwLock<MessageSinkRepository>,
 
     action_submitter: UnboundedSender<CommandAction>,
-    command_dispatcher: command::CommandDispatcher,
+    pub command_dispatcher: command::CommandDispatcher,
 
     connections: RwLock<ConnectionCollection>,
     /// Connections which either did not complete registration or completed it recently,

sable_macros/src/command_handler.rs

@@ -59,7 +59,9 @@ pub fn command_docs(attrs: &[Attribute]) -> Vec<String> {
             })) => Some(s.value()),
             _ => None,
         })
-        .map(|s| s.strip_prefix(' ').unwrap_or(&s).trim_end().to_owned())
+        // XXX: markdown-stripping could be a bit more robust
+        .map(|s| s.strip_prefix(' ').unwrap_or(&s).trim_end()
+             .replace(r"\[", "[").replace(r"\]", "]").replace(r"\<", "<").replace(r"\>", ">"))
         .collect()
 }