Skip to content

fix: make terminal raw in ssh command on windows #12990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions cli/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,18 @@ import (
"golang.org/x/xerrors"
"gvisor.dev/gvisor/pkg/tcpip/adapters/gonet"

"github.com/coder/retry"
"github.com/coder/serpent"

"cdr.dev/slog"
"cdr.dev/slog/sloggers/sloghuman"

"github.com/coder/coder/v2/cli/cliui"
"github.com/coder/coder/v2/cli/cliutil"
"github.com/coder/coder/v2/cli/xterminal"
"github.com/coder/coder/v2/coderd/autobuild/notify"
"github.com/coder/coder/v2/coderd/util/ptr"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/codersdk/workspacesdk"
"github.com/coder/coder/v2/cryptorand"
"github.com/coder/retry"
"github.com/coder/serpent"
)

var (
Expand Down Expand Up @@ -341,15 +340,22 @@ func (r *RootCmd) ssh() *serpent.Command {
}
}

stdoutFile, validOut := inv.Stdout.(*os.File)
stdinFile, validIn := inv.Stdin.(*os.File)
if validOut && validIn && isatty.IsTerminal(stdoutFile.Fd()) {
state, err := term.MakeRaw(int(stdinFile.Fd()))
stdoutFile, validOut := inv.Stdout.(*os.File)
if validIn && validOut && isatty.IsTerminal(stdinFile.Fd()) && isatty.IsTerminal(stdoutFile.Fd()) {
inState, err := xterminal.MakeInputRaw(stdinFile.Fd())
if err != nil {
return err
}
defer func() {
_ = xterminal.Restore(stdinFile.Fd(), inState)
}()
outState, err := xterminal.MakeOutputRaw(stdoutFile.Fd())
if err != nil {
return err
}
defer func() {
_ = term.Restore(int(stdinFile.Fd()), state)
_ = xterminal.Restore(stdoutFile.Fd(), outState)
}()

windowChange := listenWindowSize(ctx)
Expand Down
40 changes: 40 additions & 0 deletions cli/xterminal/terminal.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
//go:build !windows
// +build !windows

package xterminal

import (
"golang.org/x/term"
)

// State differs per-platform.
type State struct {
s *term.State
}

// MakeInputRaw calls term.MakeRaw on non-Windows platforms.
func MakeInputRaw(fd uintptr) (*State, error) {
s, err := term.MakeRaw(int(fd))
if err != nil {
return nil, err
}
return &State{
s: s,
}, nil
}

// MakeOutputRaw does nothing on non-Windows platforms.
func MakeOutputRaw(_ uintptr) (*State, error) {
return &State{
s: nil,
}, nil
}

// Restore terminal back to original state.
func Restore(fd uintptr, state *State) error {
if state == nil || state.s == nil {
return nil
}

return term.Restore(int(fd), state.s)
}
59 changes: 59 additions & 0 deletions cli/xterminal/terminal_windows.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
//go:build windows
// +build windows

package xterminal

import (
"golang.org/x/sys/windows"
)

// State differs per-platform.
type State struct {
mode uint32
}

// makeRaw sets the terminal in raw mode and returns the previous state so it can be restored.
func makeRaw(handle windows.Handle, input bool) (uint32, error) {
var prevState uint32
if err := windows.GetConsoleMode(handle, &prevState); err != nil {
return 0, err
}

var raw uint32
if input {
raw = prevState &^ (windows.ENABLE_ECHO_INPUT | windows.ENABLE_PROCESSED_INPUT | windows.ENABLE_LINE_INPUT | windows.ENABLE_PROCESSED_OUTPUT)
raw |= windows.ENABLE_VIRTUAL_TERMINAL_INPUT
} else {
raw = prevState | windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING
}

if err := windows.SetConsoleMode(handle, raw); err != nil {
return 0, err
}
return prevState, nil
}

// MakeInputRaw sets an input terminal to raw and enables VT100 processing.
func MakeInputRaw(handle uintptr) (*State, error) {
prevState, err := makeRaw(windows.Handle(handle), true)
if err != nil {
return nil, err
}

return &State{mode: prevState}, nil
}

// MakeOutputRaw sets an output terminal to raw and enables VT100 processing.
func MakeOutputRaw(handle uintptr) (*State, error) {
prevState, err := makeRaw(windows.Handle(handle), false)
if err != nil {
return nil, err
}

return &State{mode: prevState}, nil
}

// Restore terminal back to original state.
func Restore(handle uintptr, state *State) error {
return windows.SetConsoleMode(windows.Handle(handle), state.mode)
}
Loading