From 38b228af6a5d356454068d589dcfd50bb951454c Mon Sep 17 00:00:00 2001 From: Shivaram Lingamneni Date: Mon, 20 May 2019 02:56:49 -0400 Subject: [PATCH] review fixes --- irc/errors.go | 7 ++++-- irc/nickserv.go | 58 ++++++++++++++++++++--------------------------- irc/services.go | 21 +++++++++++++---- irc/utils/args.go | 21 +++++++++++++++++ 4 files changed, 67 insertions(+), 40 deletions(-) diff --git a/irc/errors.go b/irc/errors.go index 14e833ab..df47f8d2 100644 --- a/irc/errors.go +++ b/irc/errors.go @@ -5,7 +5,10 @@ package irc -import "errors" +import ( + "errors" + "github.com/oragono/oragono/irc/utils" +) // Runtime Errors var ( @@ -40,7 +43,7 @@ var ( errInvalidUsername = errors.New("Invalid username") errFeatureDisabled = errors.New(`That feature is disabled`) errBanned = errors.New("IP or nickmask banned") - errInvalidParams = errors.New("Invalid parameters") + errInvalidParams = utils.ErrInvalidParams ) // Socket Errors diff --git a/irc/nickserv.go b/irc/nickserv.go index 1b14b0f0..ab139df5 100644 --- a/irc/nickserv.go +++ b/irc/nickserv.go @@ -12,6 +12,7 @@ import ( "github.com/goshuirc/irc-go/ircfmt" "github.com/oragono/oragono/irc/modes" + "github.com/oragono/oragono/irc/utils" ) // "enabled" callbacks for specific nickserv commands @@ -209,46 +210,51 @@ information on the settings and their possible values, see HELP SET.`, capabs: []string{"accreg"}, }, "set": { - handler: nsSetHandler, - help: `Syntax $bSET $b + handler: nsSetHandler, + helpShort: `$bSET$b modifies your account settings`, + // these are broken out as separate strings so they can be translated separately + helpStrings: []string{ + `Syntax $bSET $b -Set modifies your account settings. The following settings ara available: +Set modifies your account settings. The following settings are available:`, -$bENFORCE$b + `$bENFORCE$b 'enforce' lets you specify a custom enforcement mechanism for your registered nicknames. Your options are: 1. 'none' [no enforcement, overriding the server default] 2. 'timeout' [anyone using the nick must authenticate before a deadline, or else they will be renamed] 3. 'strict' [you must already be authenticated to use the nick] -4. 'default' [use the server default] +4. 'default' [use the server default]`, -$bBOUNCER$b + `$bBOUNCER$b If 'bouncer' is enabled and you are already logged in and using a nick, a second client of yours that authenticates with SASL and requests the same nick is allowed to attach to the nick as well (this is comparable to the behavior of IRC "bouncers" like ZNC). Your options are 'on' (allow this behavior), -'off' (disallow it), and 'default' (use the server default value). +'off' (disallow it), and 'default' (use the server default value).`, -$bAUTOREPLAY-LINES$b + `$bAUTOREPLAY-LINES$b 'autoreplay-lines' controls the number of lines of channel history that will be replayed to you automatically when joining a channel. Your options are any positive number, 0 to disable the feature, and 'default' to use the server -default. +default.`, -$bAUTOREPLAY-JOINS$b + `$bAUTOREPLAY-JOINS$b 'autoreplay-joins' controls whether autoreplayed channel history will include lines for join and part. This provides more information about the context of -messages, but may be spammy. Your options are 'on' and 'off'. -`, - helpShort: `$bSET$b modifies your account settings`, +messages, but may be spammy. Your options are 'on' and 'off'.`, + }, authRequired: true, enabled: servCmdRequiresAccreg, minParams: 2, }, "saset": { - handler: nsSetHandler, - help: `Syntax: $bSASET $b`, + handler: nsSetHandler, + help: `Syntax: $bSASET $b + +SASET modifies the values of someone else's account settings. For more +information on the settings and their possible values, see HELP SET.`, helpShort: `$bSASET$b modifies another user's account settings`, enabled: servCmdRequiresAccreg, minParams: 3, @@ -328,22 +334,6 @@ func displaySetting(settingName string, settings AccountSettings, client *Client } } -func stringToBool(str string) (result bool, err error) { - switch strings.ToLower(str) { - case "on": - result = true - case "off": - result = false - case "true": - result = true - case "false": - result = false - default: - err = errInvalidParams - } - return -} - func nsSetHandler(server *Server, client *Client, command string, params []string, rb *ResponseBuffer) { var account string if command == "saset" { @@ -395,7 +385,7 @@ func nsSetHandler(server *Server, client *Client, command string, params []strin newValue = BouncerAllowedServerDefault } else { var enabled bool - enabled, err = stringToBool(params[1]) + enabled, err = utils.StringToBool(params[1]) if enabled { newValue = BouncerAllowedByUser } else { @@ -411,7 +401,7 @@ func nsSetHandler(server *Server, client *Client, command string, params []strin } case "autoreplay-joins": var newValue bool - newValue, err = stringToBool(params[1]) + newValue, err = utils.StringToBool(params[1]) if err == nil { munger = func(in AccountSettings) (out AccountSettings, err error) { out = in @@ -787,7 +777,7 @@ func nsPasswdHandler(server *Server, client *Client, command string, params []st } } default: - errorMessage = "Invalid parameters" + errorMessage = `Invalid parameters` } if errorMessage != "" { diff --git a/irc/services.go b/irc/services.go index 9b459946..8bde6ac4 100644 --- a/irc/services.go +++ b/irc/services.go @@ -30,6 +30,7 @@ type serviceCommand struct { capabs []string // oper capabs the given user has to have to access this command handler func(server *Server, client *Client, command string, params []string, rb *ResponseBuffer) help string + helpStrings []string helpShort string authRequired bool hidden bool @@ -228,8 +229,18 @@ func serviceHelpHandler(service *ircService, server *Server, client *Client, par if commandInfo == nil { sendNotice(client.t(fmt.Sprintf("Unknown command. To see available commands, run /%s HELP", service.ShortName))) } else { - for _, line := range strings.Split(ircfmt.Unescape(client.t(commandInfo.help)), "\n") { - sendNotice(line) + helpStrings := commandInfo.helpStrings + if helpStrings == nil { + hsArray := [1]string{commandInfo.help} + helpStrings = hsArray[:] + } + for i, helpString := range helpStrings { + if 0 < i { + sendNotice("") + } + for _, line := range strings.Split(ircfmt.Unescape(client.t(helpString)), "\n") { + sendNotice(line) + } } } } @@ -261,8 +272,10 @@ func initializeServices() { // force devs to write a help entry for every command for commandName, commandInfo := range service.Commands { - if commandInfo.aliasOf == "" && !commandInfo.hidden && (commandInfo.help == "" || commandInfo.helpShort == "") { - log.Fatal(fmt.Sprintf("help entry missing for %s command %s", serviceName, commandName)) + if commandInfo.aliasOf == "" && !commandInfo.hidden { + if (commandInfo.help == "" && commandInfo.helpStrings == nil) || commandInfo.helpShort == "" { + log.Fatal(fmt.Sprintf("help entry missing for %s command %s", serviceName, commandName)) + } } } } diff --git a/irc/utils/args.go b/irc/utils/args.go index 8f087423..6fe42a6b 100644 --- a/irc/utils/args.go +++ b/irc/utils/args.go @@ -3,6 +3,15 @@ package utils +import ( + "errors" + "strings" +) + +var ( + ErrInvalidParams = errors.New("Invalid parameters") +) + // ArgsToStrings takes the arguments and splits them into a series of strings, // each argument separated by delim and each string bounded by maxLength. func ArgsToStrings(maxLength int, arguments []string, delim string) []string { @@ -33,3 +42,15 @@ func ArgsToStrings(maxLength int, arguments []string, delim string) []string { return messages } + +func StringToBool(str string) (result bool, err error) { + switch strings.ToLower(str) { + case "on", "true", "t", "yes", "y": + result = true + case "off", "false", "f", "no", "n": + result = false + default: + err = ErrInvalidParams + } + return +}