Merge branch 'LockConfig' into dev

Author: Neko-Box-Coder

cmd/micro/initlua.go

@@ -73,7 +73,6 @@ func luaImportMicroConfig() *lua.LTable {
 	ulua.L.SetField(pkg, "OptionComplete", luar.New(ulua.L, action.OptionComplete))
 	ulua.L.SetField(pkg, "OptionValueComplete", luar.New(ulua.L, action.OptionValueComplete))
 	ulua.L.SetField(pkg, "NoComplete", luar.New(ulua.L, nil))
-	ulua.L.SetField(pkg, "RegisterKeybinding", luar.New(ulua.L, action.RegisterKeybindingPlug))
 	ulua.L.SetField(pkg, "TryBindKey", luar.New(ulua.L, action.TryBindKeyPlug))
 	ulua.L.SetField(pkg, "Reload", luar.New(ulua.L, action.ReloadConfig))
 	ulua.L.SetField(pkg, "AddRuntimeFileFromMemory", luar.New(ulua.L, config.PluginAddRuntimeFileFromMemory))
@@ -89,8 +88,8 @@ func luaImportMicroConfig() *lua.LTable {
 	ulua.L.SetField(pkg, "RegisterCommonOption", luar.New(ulua.L, config.RegisterCommonOptionPlug))
 	ulua.L.SetField(pkg, "RegisterGlobalOption", luar.New(ulua.L, config.RegisterGlobalOptionPlug))
 	ulua.L.SetField(pkg, "GetGlobalOption", luar.New(ulua.L, config.GetGlobalOption))
-	ulua.L.SetField(pkg, "SetGlobalOption", luar.New(ulua.L, config.SetGlobalOptionPlug))
-	ulua.L.SetField(pkg, "SetGlobalOptionNative", luar.New(ulua.L, config.SetGlobalOptionNativePlug))
+	ulua.L.SetField(pkg, "SetGlobalOption", luar.New(ulua.L, action.SetGlobalOptionPlug))
+	ulua.L.SetField(pkg, "SetGlobalOptionNative", luar.New(ulua.L, action.SetGlobalOptionNativePlug))
 	ulua.L.SetField(pkg, "ConfigDir", luar.New(ulua.L, config.ConfigDir))
 
 	return pkg

internal/action/bindings.go

@@ -261,18 +261,13 @@ func eventsEqual(e1 Event, e2 Event) bool {
 	return e1 == e2
 }
 
-// RegisterKeybindingPlug registers a default keybinding for the plugin without writing to bindings.json.
+// TryBindKeyPlug tries to bind key for the plugin without writing to bindings.json.
 // This operation can be rejected by lockbindings to prevent unexpected actions by the user.
-func RegisterKeybindingPlug(k, v string) (bool, error) {
+func TryBindKeyPlug(k, v string, overwrite bool) (bool, error) {
 	if l, ok := config.GlobalSettings["lockbindings"]; ok && l.(bool) {
 		return false, errors.New("bindings is locked by the user")
 	}
-	return TryBindKey(k, v, false, false)
-}
-
-// **Deprecated**
-func TryBindKeyPlug(k, v string, overwrite bool) (bool, error) {
-	return RegisterKeybindingPlug(k, v)
+	return TryBindKey(k, v, overwrite, false)
 }
 
 // TryBindKey tries to bind a key by writing to config.ConfigDir/bindings.json

internal/action/command.go

@@ -654,14 +654,7 @@ func doSetGlobalOptionNative(option string, nativeValue any) error {
 	return nil
 }
 
-func SetGlobalOptionNativePlug(option string, nativeValue interface{}) error {
-	if l, ok := config.GlobalSettings["locksettings"]; ok && l.(bool) {
-		return errors.New("settings.json file locked by user for all plugins")
-	}
-	return SetGlobalOptionNative(option, nativeValue)
-}
-
-func SetGlobalOptionNative(option string, nativeValue interface{}) error {
+func SetGlobalOptionNative(option string, nativeValue any, writeToFile bool) error {
 	if err := config.OptionIsValid(option, nativeValue); err != nil {
 		return err
 	}
@@ -684,6 +677,10 @@ func SetGlobalOptionNative(option string, nativeValue interface{}) error {
 		delete(b.LocalSettings, option)
 	}
 
+	if !writeToFile {
+		return nil
+	}
+
 	err := config.WriteSettings(filepath.Join(config.ConfigDir, "settings.json"))
 	if err != nil {
 		if errors.Is(err, util.ErrOverwrite) {
@@ -696,14 +693,7 @@ func SetGlobalOptionNative(option string, nativeValue interface{}) error {
 	return nil
 }
 
-func SetGlobalOptionPlug(option, value string) error {
-	if l, ok := config.GlobalSettings["locksettings"]; ok && l.(bool) {
-		return errors.New("settings.json file locked by user for all plugins")
-	}
-	return SetGlobalOption(option, value)
-}
-
-func SetGlobalOption(option, value string) error {
+func SetGlobalOption(option, value string, writeToFile bool) error {
 	if _, ok := config.GlobalSettings[option]; !ok {
 		return config.ErrInvalidOption
 	}
@@ -713,7 +703,15 @@ func SetGlobalOption(option, value string) error {
 		return err
 	}
 
-	return SetGlobalOptionNative(option, nativeValue)
+	return SetGlobalOptionNative(option, nativeValue, writeToFile)
+}
+
+func SetGlobalOptionNativePlug(option string, nativeValue any) error {
+	return SetGlobalOptionNative(option, nativeValue, false)
+}
+
+func SetGlobalOptionPlug(option, value string) error {
+	return SetGlobalOption(option, value, false)
 }
 
 // ResetCmd resets a setting to its default value
@@ -727,7 +725,7 @@ func (h *BufPane) ResetCmd(args []string) {
 	defaults := config.DefaultAllSettings()
 
 	if _, ok := defaults[option]; ok {
-		SetGlobalOptionNative(option, defaults[option])
+		SetGlobalOptionNative(option, defaults[option], true)
 		return
 	}
 	InfoBar.Error(config.ErrInvalidOption)
@@ -743,7 +741,7 @@ func (h *BufPane) SetCmd(args []string) {
 	option := args[0]
 	value := args[1]
 
-	err := SetGlobalOption(option, value)
+	err := SetGlobalOption(option, value, true)
 	if err == config.ErrInvalidOption {
 		err := h.Buf.SetOption(option, value)
 		if err != nil {
@@ -799,7 +797,7 @@ func (h *BufPane) toggleOption(option string, local bool) error {
 			return err
 		}
 	} else {
-		if err := SetGlobalOptionNative(option, newVal); err != nil {
+		if err := SetGlobalOptionNative(option, newVal, true); err != nil {
 			return err
 		}
 	}

runtime/help/options.md

@@ -227,8 +227,9 @@ Here are the available options:
 
     default value: `false`
 
-* `lockbindings`: disable plugins to modify the `bindings.json` in your config
-   directory.
+* `lockbindings`: prevent plugins and lua scripts from binding any keys.
+   Any custom actions must be binded manually either via commands like `bind`
+   or by modifying the `bindings.json` file.
 
     default value: `false`
 

runtime/help/plugins.md

@@ -174,16 +174,12 @@ The packages and their contents are listed below (in Go type signatures):
        values afterwards
     - `NoComplete`: no autocompletion suggestions
 
-    - `RegisterKeybindingPlug(k, v string) (bool, error)`: registers a default
-       keybinding `k` with action `v` for the plugin without writing to
-       `bindings.json.` This operation can be rejected by `lockbindings` to
-       prevent unexpected actions by the user.
-
-    - **Drepecated** `TryBindKey(k, v string, overwrite bool) (bool, error)`:
-       bind the key `k` to the string `v` in the `bindings.json` file.
-       If `overwrite` is true, this will overwrite any existing binding to key
-       `k`. Returns true if the binding was made, and a possible error
-       (for example writing to `bindings.json` can cause an error).
+    - `TryBindKey(k, v string, overwrite bool) (bool, error)`:
+       bind the key `k` to the string `v`. If `overwrite` is true, this will
+       overwrite any existing binding to key `k`.
+       Returns true if the binding was made, and a possible error.
+       This operation can be rejected by `lockbindings` to prevent undesired
+       actions by the user.
 
     - `Reload()`: reload configuration files.
 
@@ -228,10 +224,10 @@ The packages and their contents are listed below (in Go type signatures):
     - `GetGlobalOption(name string) any`: returns the value of a
        given plugin in the `GlobalSettings` map.
 
-    - **Deprecated** `SetGlobalOption(option, value string) error`: sets an
-       option to a given value. Same as using the `> set` command. This will try
-       to convert the value into the proper type for the option. Can return an
-       error if the option name is not valid, or the value can not be converted.
+    - `SetGlobalOption(option, value string) error`: sets an option to a
+       given value. This will try to convert the value into the proper
+       type for the option. Can return an error if the option name is not
+       valid, or the value can not be converted.
 
     - **Deprecated** `SetGlobalOptionNative(option string, value interface{}) error`:
        sets an option to a given value, where the type of value is the actual