Ability to lock bindings, migrate to register* functions instead

Author: Neko-Box-Coder

cmd/micro/initlua.go

@@ -73,7 +73,8 @@ 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, "TryBindKey", luar.New(ulua.L, action.TryBindKey))
+	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))
 	ulua.L.SetField(pkg, "AddRuntimeFilesFromDirectory", luar.New(ulua.L, config.PluginAddRuntimeFilesFromDirectory))
@@ -88,8 +89,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, action.SetGlobalOption))
-	ulua.L.SetField(pkg, "SetGlobalOptionNative", luar.New(ulua.L, action.SetGlobalOptionNative))
+	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, "ConfigDir", luar.New(ulua.L, config.ConfigDir))
 
 	return pkg

internal/action/bindings.go

@@ -261,9 +261,23 @@ func eventsEqual(e1 Event, e2 Event) bool {
 	return e1 == e2
 }
 
+// RegisterKeybindingPlug registers a default keybinding 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) {
+	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)
+}
+
 // TryBindKey tries to bind a key by writing to config.ConfigDir/bindings.json
-// Returns true if the keybinding already existed and a possible error
-func TryBindKey(k, v string, overwrite bool) (bool, error) {
+// Returns true if the keybinding already existed or is binded successfully and a possible error
+func TryBindKey(k, v string, overwrite bool, writeToFile bool) (bool, error) {
 	var e error
 	var parsed map[string]any
 
@@ -310,7 +324,12 @@ func TryBindKey(k, v string, overwrite bool) (bool, error) {
 
 		txt, _ := json.MarshalIndent(parsed, "", "    ")
 		txt = append(txt, '\n')
-		return true, writeFile(filename, txt)
+
+		if writeToFile {
+			return true, writeFile(filename, txt)
+		} else {
+			return true, nil
+		}
 	}
 	return false, e
 }

internal/action/command.go

@@ -844,7 +844,7 @@ func (h *BufPane) BindCmd(args []string) {
 		return
 	}
 
-	_, err := TryBindKey(parseKeyArg(args[0]), args[1], true)
+	_, err := TryBindKey(parseKeyArg(args[0]), args[1], true, true)
 	if err != nil {
 		if errors.Is(err, util.ErrOverwrite) {
 			screen.TermMessage(err)

internal/config/settings.go

@@ -118,6 +118,7 @@ var DefaultGlobalOnlySettings = map[string]any{
 	"helpsplit":      "hsplit",
 	"infobar":        true,
 	"keymenu":        false,
+	"lockbindings":   false,
 	"mouse":          true,
 	"multiopen":      "tab",
 	"parsecursor":    false,
@@ -408,6 +409,16 @@ func RegisterGlobalOptionPlug(pl string, name string, defaultvalue any) error {
 	return RegisterGlobalOption(pl+"."+name, defaultvalue)
 }
 
+// **Deprecated**
+func SetGlobalOptionNativePlug(option string, nativeValue interface{}) error {
+	return RegisterGlobalOption(option, nativeValue)
+}
+
+// **Deprecated**
+func SetGlobalOptionPlug(option, value string) error {
+	return RegisterGlobalOption(option, value)
+}
+
 // RegisterCommonOption creates a new option
 func RegisterCommonOption(name string, defaultvalue any) error {
 	if _, ok := GlobalSettings[name]; !ok {

runtime/help/options.md

@@ -231,6 +231,11 @@ Here are the available options:
 
     default value: `false`
 
+* `lockbindings`: disable plugins to modify the `bindings.json` in your config
+   directory.
+
+    default value: `false`
+
 * `matchbrace`: show matching braces for '()', '{}', '[]' when the cursor
    is on a brace character or (if `matchbraceleft` is enabled) next to it.
 

runtime/help/plugins.md

@@ -174,11 +174,16 @@ The packages and their contents are listed below (in Go type signatures):
        values afterwards
     - `NoComplete`: no autocompletion suggestions
 
-    - `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).
+    - `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).
 
     - `Reload()`: reload configuration files.
 
@@ -223,13 +228,13 @@ 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.
 
-    - `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.
+    - **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.
 
-    - `SetGlobalOptionNative(option string, value any) error`: sets
-       an option to a given value, where the type of value is the actual
+    - **Deprecated** `SetGlobalOptionNative(option string, value any) error`:
+       sets an option to a given value, where the type of value is the actual
        type of the value internally. Can return an error if the provided value
        is not valid for the given option.