From a30872e26b8de0c3b3031a2f0a31b83ccf07ba20 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Tue, 22 Jul 2025 08:19:00 +0200 Subject: [PATCH] refactor: rename mustGet* functions to get* --- cmd/cmds_ls.go | 2 +- cmd/config.go | 12 ++++++------ cmd/config_init.go | 38 +++++++++++++++++++------------------- cmd/config_set.go | 40 ++++++++++++++++++++-------------------- cmd/docs.go | 2 +- cmd/rules.go | 4 ++-- cmd/rules_add.go | 4 ++-- cmd/upgrade.go | 6 +++--- cmd/users.go | 28 ++++++++++++++-------------- cmd/users_add.go | 2 +- cmd/users_import.go | 4 ++-- cmd/users_update.go | 6 +++--- cmd/utils.go | 10 +++++----- 13 files changed, 79 insertions(+), 79 deletions(-) diff --git a/cmd/cmds_ls.go b/cmd/cmds_ls.go index 4f70d650..fa901a56 100644 --- a/cmd/cmds_ls.go +++ b/cmd/cmds_ls.go @@ -19,7 +19,7 @@ var cmdsLsCmd = &cobra.Command{ if err != nil { return err } - evt, err := mustGetString(cmd.Flags(), "event") + evt, err := getString(cmd.Flags(), "event") if err != nil { return err } diff --git a/cmd/config.go b/cmd/config.go index 3448b31b..5ce54ad9 100644 --- a/cmd/config.go +++ b/cmd/config.go @@ -56,7 +56,7 @@ func addConfigFlags(flags *pflag.FlagSet) { } func getAuthMethod(flags *pflag.FlagSet, defaults ...interface{}) (settings.AuthMethod, map[string]interface{}, error) { - methodStr, err := mustGetString(flags, "auth.method") + methodStr, err := getString(flags, "auth.method") if err != nil { return "", nil, err } @@ -87,7 +87,7 @@ func getAuthMethod(flags *pflag.FlagSet, defaults ...interface{}) (settings.Auth } func getProxyAuth(flags *pflag.FlagSet, defaultAuther map[string]interface{}) (auth.Auther, error) { - header, err := mustGetString(flags, "auth.header") + header, err := getString(flags, "auth.header") if err != nil { return nil, err } @@ -109,15 +109,15 @@ func getNoAuth() auth.Auther { func getJSONAuth(flags *pflag.FlagSet, defaultAuther map[string]interface{}) (auth.Auther, error) { jsonAuth := &auth.JSONAuth{} - host, err := mustGetString(flags, "recaptcha.host") + host, err := getString(flags, "recaptcha.host") if err != nil { return nil, err } - key, err := mustGetString(flags, "recaptcha.key") + key, err := getString(flags, "recaptcha.key") if err != nil { return nil, err } - secret, err := mustGetString(flags, "recaptcha.secret") + secret, err := getString(flags, "recaptcha.secret") if err != nil { return nil, err } @@ -145,7 +145,7 @@ func getJSONAuth(flags *pflag.FlagSet, defaultAuther map[string]interface{}) (au } func getHookAuth(flags *pflag.FlagSet, defaultAuther map[string]interface{}) (auth.Auther, error) { - command, err := mustGetString(flags, "auth.command") + command, err := getString(flags, "auth.command") if err != nil { return nil, err } diff --git a/cmd/config_init.go b/cmd/config_init.go index 63265bb6..ea756d0b 100644 --- a/cmd/config_init.go +++ b/cmd/config_init.go @@ -36,47 +36,47 @@ override the options.`, key := generateKey() - signup, err := mustGetBool(flags, "signup") + signup, err := getBool(flags, "signup") if err != nil { return err } - createUserDir, err := mustGetBool(flags, "create-user-dir") + createUserDir, err := getBool(flags, "create-user-dir") if err != nil { return err } - minLength, err := mustGetUint(flags, "minimum-password-length") + minLength, err := getUint(flags, "minimum-password-length") if err != nil { return err } - shell, err := mustGetString(flags, "shell") + shell, err := getString(flags, "shell") if err != nil { return err } - brandingName, err := mustGetString(flags, "branding.name") + brandingName, err := getString(flags, "branding.name") if err != nil { return err } - brandingDisableExternal, err := mustGetBool(flags, "branding.disableExternal") + brandingDisableExternal, err := getBool(flags, "branding.disableExternal") if err != nil { return err } - brandingDisableUsedPercentage, err := mustGetBool(flags, "branding.disableUsedPercentage") + brandingDisableUsedPercentage, err := getBool(flags, "branding.disableUsedPercentage") if err != nil { return err } - brandingTheme, err := mustGetString(flags, "branding.theme") + brandingTheme, err := getString(flags, "branding.theme") if err != nil { return err } - brandingFiles, err := mustGetString(flags, "branding.files") + brandingFiles, err := getString(flags, "branding.files") if err != nil { return err } @@ -98,52 +98,52 @@ override the options.`, }, } - s.FileMode, err = mustGetMode(flags, "file-mode") + s.FileMode, err = getMode(flags, "file-mode") if err != nil { return err } - s.DirMode, err = mustGetMode(flags, "file-mode") + s.DirMode, err = getMode(flags, "file-mode") if err != nil { return err } - address, err := mustGetString(flags, "address") + address, err := getString(flags, "address") if err != nil { return err } - socket, err := mustGetString(flags, "socket") + socket, err := getString(flags, "socket") if err != nil { return err } - root, err := mustGetString(flags, "root") + root, err := getString(flags, "root") if err != nil { return err } - baseURL, err := mustGetString(flags, "baseurl") + baseURL, err := getString(flags, "baseurl") if err != nil { return err } - tlsKey, err := mustGetString(flags, "key") + tlsKey, err := getString(flags, "key") if err != nil { return err } - cert, err := mustGetString(flags, "cert") + cert, err := getString(flags, "cert") if err != nil { return err } - port, err := mustGetString(flags, "port") + port, err := getString(flags, "port") if err != nil { return err } - log, err := mustGetString(flags, "log") + log, err := getString(flags, "log") if err != nil { return err } diff --git a/cmd/config_set.go b/cmd/config_set.go index d6242bd2..a7f66902 100644 --- a/cmd/config_set.go +++ b/cmd/config_set.go @@ -35,49 +35,49 @@ you want to change. Other options will remain unchanged.`, } switch flag.Name { case "baseurl": - ser.BaseURL, err = mustGetString(flags, flag.Name) + ser.BaseURL, err = getString(flags, flag.Name) case "root": - ser.Root, err = mustGetString(flags, flag.Name) + ser.Root, err = getString(flags, flag.Name) case "socket": - ser.Socket, err = mustGetString(flags, flag.Name) + ser.Socket, err = getString(flags, flag.Name) case "cert": - ser.TLSCert, err = mustGetString(flags, flag.Name) + ser.TLSCert, err = getString(flags, flag.Name) case "key": - ser.TLSKey, err = mustGetString(flags, flag.Name) + ser.TLSKey, err = getString(flags, flag.Name) case "address": - ser.Address, err = mustGetString(flags, flag.Name) + ser.Address, err = getString(flags, flag.Name) case "port": - ser.Port, err = mustGetString(flags, flag.Name) + ser.Port, err = getString(flags, flag.Name) case "log": - ser.Log, err = mustGetString(flags, flag.Name) + ser.Log, err = getString(flags, flag.Name) case "signup": - set.Signup, err = mustGetBool(flags, flag.Name) + set.Signup, err = getBool(flags, flag.Name) case "auth.method": hasAuth = true case "shell": var shell string - shell, err = mustGetString(flags, flag.Name) + shell, err = getString(flags, flag.Name) set.Shell = convertCmdStrToCmdArray(shell) case "create-user-dir": - set.CreateUserDir, err = mustGetBool(flags, flag.Name) + set.CreateUserDir, err = getBool(flags, flag.Name) case "minimum-password-length": - set.MinimumPasswordLength, err = mustGetUint(flags, flag.Name) + set.MinimumPasswordLength, err = getUint(flags, flag.Name) case "branding.name": - set.Branding.Name, err = mustGetString(flags, flag.Name) + set.Branding.Name, err = getString(flags, flag.Name) case "branding.color": - set.Branding.Color, err = mustGetString(flags, flag.Name) + set.Branding.Color, err = getString(flags, flag.Name) case "branding.theme": - set.Branding.Theme, err = mustGetString(flags, flag.Name) + set.Branding.Theme, err = getString(flags, flag.Name) case "branding.disableExternal": - set.Branding.DisableExternal, err = mustGetBool(flags, flag.Name) + set.Branding.DisableExternal, err = getBool(flags, flag.Name) case "branding.disableUsedPercentage": - set.Branding.DisableUsedPercentage, err = mustGetBool(flags, flag.Name) + set.Branding.DisableUsedPercentage, err = getBool(flags, flag.Name) case "branding.files": - set.Branding.Files, err = mustGetString(flags, flag.Name) + set.Branding.Files, err = getString(flags, flag.Name) case "file-mode": - set.FileMode, err = mustGetMode(flags, flag.Name) + set.FileMode, err = getMode(flags, flag.Name) case "dir-mode": - set.DirMode, err = mustGetMode(flags, flag.Name) + set.DirMode, err = getMode(flags, flag.Name) } }) diff --git a/cmd/docs.go b/cmd/docs.go index 941b0acd..d3ab00c4 100644 --- a/cmd/docs.go +++ b/cmd/docs.go @@ -40,7 +40,7 @@ var docsCmd = &cobra.Command{ Hidden: true, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, _ []string) error { - dir, err := mustGetString(cmd.Flags(), "path") + dir, err := getString(cmd.Flags(), "path") if err != nil { return err } diff --git a/cmd/rules.go b/cmd/rules.go index b3120bbe..417e0070 100644 --- a/cmd/rules.go +++ b/cmd/rules.go @@ -68,11 +68,11 @@ func runRules(st *storage.Storage, cmd *cobra.Command, usersFn func(*users.User) } func getUserIdentifier(flags *pflag.FlagSet) (interface{}, error) { - id, err := mustGetUint(flags, "id") + id, err := getUint(flags, "id") if err != nil { return nil, err } - username, err := mustGetString(flags, "username") + username, err := getString(flags, "username") if err != nil { return nil, err } diff --git a/cmd/rules_add.go b/cmd/rules_add.go index dae93572..9d1f0cf9 100644 --- a/cmd/rules_add.go +++ b/cmd/rules_add.go @@ -22,11 +22,11 @@ var rulesAddCmd = &cobra.Command{ Long: `Add a global rule or user rule.`, Args: cobra.ExactArgs(1), RunE: python(func(cmd *cobra.Command, args []string, d *pythonData) error { - allow, err := mustGetBool(cmd.Flags(), "allow") + allow, err := getBool(cmd.Flags(), "allow") if err != nil { return err } - regex, err := mustGetBool(cmd.Flags(), "regex") + regex, err := getBool(cmd.Flags(), "regex") if err != nil { return err } diff --git a/cmd/upgrade.go b/cmd/upgrade.go index 3976e9d9..7142b151 100644 --- a/cmd/upgrade.go +++ b/cmd/upgrade.go @@ -23,15 +23,15 @@ this version.`, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, _ []string) error { flags := cmd.Flags() - oldDB, err := mustGetString(flags, "old.database") + oldDB, err := getString(flags, "old.database") if err != nil { return err } - oldConf, err := mustGetString(flags, "old.config") + oldConf, err := getString(flags, "old.config") if err != nil { return err } - db, err := mustGetString(flags, "database") + db, err := getString(flags, "database") if err != nil { return err } diff --git a/cmd/users.go b/cmd/users.go index f5bc29b5..a70b5fe4 100644 --- a/cmd/users.go +++ b/cmd/users.go @@ -80,7 +80,7 @@ func addUserFlags(flags *pflag.FlagSet) { } func getViewMode(flags *pflag.FlagSet) (users.ViewMode, error) { - viewModeStr, err := mustGetString(flags, "viewMode") + viewModeStr, err := getString(flags, "viewMode") if err != nil { return "", err } @@ -101,35 +101,35 @@ func getUserDefaults(flags *pflag.FlagSet, defaults *settings.UserDefaults, all var err error switch flag.Name { case "scope": - defaults.Scope, err = mustGetString(flags, flag.Name) + defaults.Scope, err = getString(flags, flag.Name) case "locale": - defaults.Locale, err = mustGetString(flags, flag.Name) + defaults.Locale, err = getString(flags, flag.Name) case "viewMode": defaults.ViewMode, err = getViewMode(flags) case "singleClick": - defaults.SingleClick, err = mustGetBool(flags, flag.Name) + defaults.SingleClick, err = getBool(flags, flag.Name) case "perm.admin": - defaults.Perm.Admin, err = mustGetBool(flags, flag.Name) + defaults.Perm.Admin, err = getBool(flags, flag.Name) case "perm.execute": - defaults.Perm.Execute, err = mustGetBool(flags, flag.Name) + defaults.Perm.Execute, err = getBool(flags, flag.Name) case "perm.create": - defaults.Perm.Create, err = mustGetBool(flags, flag.Name) + defaults.Perm.Create, err = getBool(flags, flag.Name) case "perm.rename": - defaults.Perm.Rename, err = mustGetBool(flags, flag.Name) + defaults.Perm.Rename, err = getBool(flags, flag.Name) case "perm.modify": - defaults.Perm.Modify, err = mustGetBool(flags, flag.Name) + defaults.Perm.Modify, err = getBool(flags, flag.Name) case "perm.delete": - defaults.Perm.Delete, err = mustGetBool(flags, flag.Name) + defaults.Perm.Delete, err = getBool(flags, flag.Name) case "perm.share": - defaults.Perm.Share, err = mustGetBool(flags, flag.Name) + defaults.Perm.Share, err = getBool(flags, flag.Name) case "perm.download": - defaults.Perm.Download, err = mustGetBool(flags, flag.Name) + defaults.Perm.Download, err = getBool(flags, flag.Name) case "commands": defaults.Commands, err = flags.GetStringSlice(flag.Name) case "sorting.by": - defaults.Sorting.By, err = mustGetString(flags, flag.Name) + defaults.Sorting.By, err = getString(flags, flag.Name) case "sorting.asc": - defaults.Sorting.Asc, err = mustGetBool(flags, flag.Name) + defaults.Sorting.Asc, err = getBool(flags, flag.Name) } if err != nil { visitErr = err diff --git a/cmd/users_add.go b/cmd/users_add.go index 1358d7e1..9d763d3d 100644 --- a/cmd/users_add.go +++ b/cmd/users_add.go @@ -31,7 +31,7 @@ var usersAddCmd = &cobra.Command{ return err } - lockPassword, err := mustGetBool(cmd.Flags(), "lockPassword") + lockPassword, err := getBool(cmd.Flags(), "lockPassword") if err != nil { return err } diff --git a/cmd/users_import.go b/cmd/users_import.go index d7b32454..d20dca68 100644 --- a/cmd/users_import.go +++ b/cmd/users_import.go @@ -45,7 +45,7 @@ list or set it to 0.`, } } - replace, err := mustGetBool(cmd.Flags(), "replace") + replace, err := getBool(cmd.Flags(), "replace") if err != nil { return err } @@ -69,7 +69,7 @@ list or set it to 0.`, } } - overwrite, err := mustGetBool(cmd.Flags(), "overwrite") + overwrite, err := getBool(cmd.Flags(), "overwrite") if err != nil { return err } diff --git a/cmd/users_update.go b/cmd/users_update.go index ad3ab877..624bfda8 100644 --- a/cmd/users_update.go +++ b/cmd/users_update.go @@ -24,11 +24,11 @@ options you want to change.`, RunE: python(func(cmd *cobra.Command, args []string, d *pythonData) error { username, id := parseUsernameOrID(args[0]) flags := cmd.Flags() - password, err := mustGetString(flags, "password") + password, err := getString(flags, "password") if err != nil { return err } - newUsername, err := mustGetString(flags, "username") + newUsername, err := getString(flags, "username") if err != nil { return err } @@ -72,7 +72,7 @@ options you want to change.`, user.Perm = defaults.Perm user.Commands = defaults.Commands user.Sorting = defaults.Sorting - user.LockPassword, err = mustGetBool(flags, "lockPassword") + user.LockPassword, err = getBool(flags, "lockPassword") if err != nil { return err } diff --git a/cmd/utils.go b/cmd/utils.go index 97364ea5..a4eb4d14 100644 --- a/cmd/utils.go +++ b/cmd/utils.go @@ -30,13 +30,13 @@ func returnErr(err error) error { return nil } -func mustGetString(flags *pflag.FlagSet, flag string) (string, error) { +func getString(flags *pflag.FlagSet, flag string) (string, error) { s, err := flags.GetString(flag) return s, returnErr(err) } -func mustGetMode(flags *pflag.FlagSet, flag string) (fs.FileMode, error) { - s, err := mustGetString(flags, flag) +func getMode(flags *pflag.FlagSet, flag string) (fs.FileMode, error) { + s, err := getString(flags, flag) if err != nil { return 0, err } @@ -47,12 +47,12 @@ func mustGetMode(flags *pflag.FlagSet, flag string) (fs.FileMode, error) { return fs.FileMode(b), nil } -func mustGetBool(flags *pflag.FlagSet, flag string) (bool, error) { +func getBool(flags *pflag.FlagSet, flag string) (bool, error) { b, err := flags.GetBool(flag) return b, returnErr(err) } -func mustGetUint(flags *pflag.FlagSet, flag string) (uint, error) { +func getUint(flags *pflag.FlagSet, flag string) (uint, error) { b, err := flags.GetUint(flag) return b, returnErr(err) }