New commands to set keyboard layout (#663)

Co-authored-by: Luca Rinaldi <lucarin@protonmail.com>

Author: Xayton

cmd/arduino-app-cli/board/board.go

@@ -70,6 +70,10 @@ func NewBoardCmd() *cobra.Command {
 	fsCmd.AddCommand(newDisableNetworkModeCmd())
 	fsCmd.AddCommand(newNetworkModeStatusCmd())
 
+	fsCmd.AddCommand(listKeyboardLayouts())
+	fsCmd.AddCommand(getKeyboardLayout())
+	fsCmd.AddCommand(setKeyboardLayout())
+
 	return fsCmd
 }
 
@@ -247,3 +251,85 @@ func newNetworkModeStatusCmd() *cobra.Command {
 		},
 	}
 }
+
+func getKeyboardLayout() *cobra.Command {
+	return &cobra.Command{
+		Use:   "get-keyboard-layout",
+		Short: "Returns the current system keyboard layout code",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			conn := cmd.Context().Value(remoteConnKey).(remote.RemoteConn)
+
+			layoutCode, err := board.GetKeyboardLayout(cmd.Context(), conn)
+			if err != nil {
+				return fmt.Errorf("failed: %w", err)
+			}
+			feedback.Printf("Layout: %s", layoutCode)
+
+			return nil
+		},
+	}
+}
+
+func setKeyboardLayout() *cobra.Command {
+	return &cobra.Command{
+		Use:   "set-keyboard-layout <layout>",
+		Short: "Saves and applies the current system keyboard layout",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			conn := cmd.Context().Value(remoteConnKey).(remote.RemoteConn)
+			layoutCode := args[0]
+
+			err := validateKeyboardLayoutCode(conn, layoutCode)
+			if err != nil {
+				return fmt.Errorf("failed: %w", err)
+			}
+
+			err = board.SetKeyboardLayout(cmd.Context(), conn, layoutCode)
+			if err != nil {
+				return fmt.Errorf("failed: %w", err)
+			}
+
+			feedback.Printf("New layout applied: %s", layoutCode)
+			return nil
+		},
+	}
+}
+
+func validateKeyboardLayoutCode(conn remote.RemoteConn, layoutCode string) error {
+	// Make sure the input layout code is in the list of valid ones
+	layouts, err := board.ListKeyboardLayouts(conn)
+	if err != nil {
+		return fmt.Errorf("failed to fetch valid layouts: %w", err)
+	}
+
+	for _, layout := range layouts {
+		if layout.LayoutId == layoutCode {
+			return nil
+		}
+	}
+
+	return fmt.Errorf("invalid layout code: %s", layoutCode)
+}
+
+func listKeyboardLayouts() *cobra.Command {
+	return &cobra.Command{
+		Use:   "list-keyboard-layouts",
+		Short: "Returns the list of valid keyboard layouts, with a description",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			conn := cmd.Context().Value(remoteConnKey).(remote.RemoteConn)
+
+			layouts, err := board.ListKeyboardLayouts(conn)
+			if err != nil {
+				return fmt.Errorf("failed: %w", err)
+			}
+
+			for _, layout := range layouts {
+				feedback.Printf("%s, %s", layout.LayoutId, layout.Description)
+			}
+
+			return nil
+		},
+	}
+}

debian/arduino-app-cli/etc/sudoers.d/30-arduino-keyboard

@@ -0,0 +1 @@
+arduino ALL=(ALL) NOPASSWD: /usr/local/bin/arduino-set-keyboard-layout

debian/arduino-app-cli/usr/local/bin/arduino-set-keyboard-layout

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+LAYOUT="$1"
+if [ -z "$LAYOUT" ]; then
+  echo "No layout provided"
+  exit 1
+fi
+
+# Update the "XKBLAYOUT" line in /etc/default/keyboard
+sed -i "s/^XKBLAYOUT=\"[^\"]*\"/XKBLAYOUT=\"$LAYOUT\"/" /etc/default/keyboard
+
+# Then apply the changes
+udevadm trigger --subsystem-match=input --action=change

pkg/board/board_system.go

@@ -0,0 +1,99 @@
+package board
+
+import (
+	"bufio"
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/bcmi-labs/orchestrator/pkg/board/remote"
+)
+
+type KeyboardLayout struct {
+	LayoutId    string
+	Description string
+}
+
+func GetKeyboardLayout(ctx context.Context, conn remote.RemoteConn) (string, error) {
+	cmd := conn.GetCmd("localectl", "status")
+	output, err := cmd.Output(ctx)
+	if err != nil {
+		return "", fmt.Errorf("failed to get the keyboard layout: %w", err)
+	}
+
+	lines := strings.Split(string(output), "\n")
+
+	// Loop through each line of the output to find "X11 Layout"
+	for _, line := range lines {
+		line = strings.TrimSpace(line)
+		if strings.HasPrefix(line, "X11 Layout:") {
+			parts := strings.SplitN(line, ":", 2)
+			if len(parts) != 2 {
+				return "", fmt.Errorf("failed to get the keyboard layout, parsing error")
+			}
+
+			layout := strings.TrimSpace(parts[1])
+			return layout, nil
+		}
+	}
+
+	return "", fmt.Errorf("failed to get the keyboard layout, layout not found")
+}
+
+func SetKeyboardLayout(ctx context.Context, conn remote.RemoteConn, layoutCode string) error {
+	err := conn.GetCmd("sudo", "/usr/local/bin/arduino-set-keyboard-layout", layoutCode).Run(ctx)
+	if err != nil {
+		return fmt.Errorf("failed to start command: %w", err)
+	}
+
+	return nil
+}
+
+func ListKeyboardLayouts(conn remote.RemoteConn) ([]KeyboardLayout, error) {
+	// The file contains multiple things, including the list of valid keyboard layouts.
+	r, err := conn.ReadFile("/usr/share/X11/xkb/rules/base.lst")
+	if err != nil {
+		return nil, fmt.Errorf("failed opening the keyboard layouts file: %w", err)
+	}
+	defer r.Close()
+
+	var layouts []KeyboardLayout
+
+	scanner := bufio.NewScanner(r)
+	insideLayoutSection := false
+
+	for scanner.Scan() {
+		line := scanner.Text()
+
+		if strings.HasPrefix(line, "! layout") {
+			insideLayoutSection = true
+			continue
+		}
+
+		if !insideLayoutSection {
+			continue
+		}
+
+		// If the line is empty or starts with "!", it's the end of the layout section
+		if line == "" || strings.HasPrefix(line, "!") {
+			break
+		}
+
+		// Split the line into layout code and description
+		parts := strings.Fields(line)
+		if len(parts) >= 2 {
+			layout := KeyboardLayout{
+				LayoutId:    parts[0],
+				Description: strings.Join(parts[1:], " "),
+			}
+			layouts = append(layouts, layout)
+		}
+	}
+
+	// Check for scanner errors
+	if err := scanner.Err(); err != nil {
+		return nil, fmt.Errorf("error reading input: %v", err)
+	}
+
+	return layouts, nil
+}