-
Notifications
You must be signed in to change notification settings - Fork 104
feat(server): add screenshot command #1435
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| package server | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/hetznercloud/cli/internal/cmd/base" | ||
| "github.com/hetznercloud/cli/internal/cmd/cmpl" | ||
| "github.com/hetznercloud/cli/internal/cmd/server/screenshot" | ||
| "github.com/hetznercloud/cli/internal/hcapi2" | ||
| "github.com/hetznercloud/cli/internal/state" | ||
| ) | ||
|
|
||
| var ScreenshotCmd = base.Cmd{ | ||
| BaseCobraCommand: func(client hcapi2.Client) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "screenshot [options] <server>", | ||
| Short: "Take a screenshot of the Server VNC console", | ||
| ValidArgsFunction: cmpl.SuggestArgs(cmpl.SuggestCandidatesF(client.Server().Names)), | ||
| TraverseChildren: true, | ||
| DisableFlagsInUseLine: true, | ||
| } | ||
| cmd.Flags().StringP("output", "o", "screenshot.png", "Output file for the screenshot (must be a .png file).") | ||
| return cmd | ||
| }, | ||
| Run: func(s state.State, cmd *cobra.Command, args []string) error { | ||
| idOrName := args[0] | ||
| server, _, err := s.Client().Server().Get(s, idOrName) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if server == nil { | ||
| return fmt.Errorf("Server not found: %s", idOrName) | ||
| } | ||
|
|
||
| result, _, err := s.Client().Server().RequestConsole(s, server) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := s.WaitForActions(s, cmd, result.Action); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| output, _ := cmd.Flags().GetString("output") | ||
| if !strings.HasSuffix(strings.ToLower(output), ".png") { | ||
| cmd.Printf("Warning: Only .png output file are supported\n") | ||
| } | ||
|
|
||
| return screenshot.TakeScreenshot(s, result.WSSURL, output) | ||
| }, | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| package screenshot | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "fmt" | ||
| "image" | ||
| "image/color" | ||
| "image/png" | ||
| "io" | ||
| "log/slog" | ||
| "net/url" | ||
| "os" | ||
|
|
||
| "github.com/alexsnet/go-vnc" | ||
| "github.com/alexsnet/go-vnc/rfbflags" | ||
| "golang.org/x/net/websocket" | ||
| ) | ||
|
|
||
| func websocketOrigin(wsURL string) (string, error) { | ||
| u, err := url.Parse(wsURL) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| u.Scheme = "https" | ||
| return u.String(), nil | ||
| } | ||
|
|
||
| func dialWebsocket(ctx context.Context, wsURL string) (*websocket.Conn, error) { | ||
| origin, err := websocketOrigin(wsURL) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cfg, err := websocket.NewConfig(wsURL, origin) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| ws, err := cfg.DialContext(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| ws.PayloadType = websocket.BinaryFrame | ||
|
|
||
| return ws, nil | ||
| } | ||
|
|
||
| func TakeScreenshot(ctx context.Context, wsURL string, filename string) error { | ||
| slog.Debug("dialing websocket") | ||
| ws, err := dialWebsocket(ctx, wsURL) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer ws.Close() | ||
|
|
||
| slog.Debug("creating vnc client") | ||
| vncCfg := &vnc.ClientConfig{ | ||
| Auth: []vnc.ClientAuth{ | ||
| // Auth is managed at the HTTP/websocket level,therefore no password is | ||
| // needed for the VNC client. | ||
| &vnc.ClientAuthNone{}, | ||
| }, | ||
| ServerMessages: []vnc.ServerMessage{ | ||
| &vnc.FramebufferUpdate{}, | ||
| }, | ||
| ServerMessageCh: make(chan vnc.ServerMessage, 1), | ||
| } | ||
|
|
||
| slog.Debug("connecting vnc client") | ||
| vncConn, err := vnc.Connect(ctx, ws, vncCfg) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer vncConn.Close() | ||
|
|
||
| go func() { | ||
| slog.Debug("listening for vnc server messages") | ||
| if err := vncConn.ListenAndHandle(); err != nil { | ||
| slog.Error("failed to listen and handle incoming vnc server messages", "err", err) | ||
| } | ||
| }() | ||
|
|
||
| slog.Debug("requesting framebuffer update") | ||
| if err := vncConn.FramebufferUpdateRequest( | ||
| rfbflags.RFBFalse, | ||
| 0, 0, | ||
| vncConn.FramebufferWidth(), vncConn.FramebufferHeight(), | ||
| ); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| slog.Debug("waiting for server message") | ||
| msg := <-vncCfg.ServerMessageCh | ||
|
|
||
| framebufferUpdate, ok := msg.(*vnc.FramebufferUpdate) | ||
| if !ok { | ||
| return fmt.Errorf("received unexpected server message: %T", msg) | ||
| } | ||
|
|
||
| // Sanity checks | ||
| if len(framebufferUpdate.Rects) != 1 || | ||
| framebufferUpdate.Rects[0].X != 0 || | ||
| framebufferUpdate.Rects[0].Y != 0 || | ||
| framebufferUpdate.Rects[0].Width != vncConn.FramebufferWidth() || | ||
| framebufferUpdate.Rects[0].Height != vncConn.FramebufferHeight() { | ||
| return fmt.Errorf("received invalid frame buffer update") | ||
| } | ||
|
|
||
| width := int(vncConn.FramebufferWidth()) | ||
| height := int(vncConn.FramebufferHeight()) | ||
|
|
||
| slog.Debug("composing image from framebuffer") | ||
| img := image.NewRGBA(image.Rect(0, 0, width, height)) | ||
| { | ||
| rect := framebufferUpdate.Rects[0] | ||
| enc := rect.Enc.(*vnc.RawEncoding) | ||
| for index, clr := range enc.Colors { | ||
| x, y := index%width, index/width | ||
| img.Set(int(rect.X)+x, int(rect.Y)+y, color.RGBA{uint8(clr.R), uint8(clr.G), uint8(clr.B), 255}) | ||
| } | ||
| } | ||
|
|
||
| slog.Debug("encoding image") | ||
| imgData := bytes.NewBuffer(nil) | ||
| { | ||
| pngEncoder := png.Encoder{CompressionLevel: png.DefaultCompression} | ||
| if err := pngEncoder.Encode(io.Writer(imgData), img); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| slog.Debug("writing image to file") | ||
| if err := os.WriteFile(filename, imgData.Bytes(), 0600); err != nil { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This overwrites |
||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package screenshot | ||
|
|
||
| import ( | ||
| "context" | ||
| "log/slog" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/hetznercloud/hcloud-go/v2/hcloud" | ||
| ) | ||
|
|
||
| func TestTakeScreenshot(t *testing.T) { | ||
| t.Skip() | ||
|
|
||
| ctx := t.Context() | ||
|
|
||
| // TODO: Load token | ||
| client := hcloud.NewClient(hcloud.WithToken("TOKEN")) | ||
|
|
||
| // TODO: Create or use existing server | ||
| result, _, err := client.Server.RequestConsole(ctx, &hcloud.Server{ID: 0}) | ||
| require.NoError(t, err) | ||
|
|
||
| err = client.Action.WaitFor(ctx, result.Action) | ||
| require.NoError(t, err) | ||
|
|
||
| ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second) | ||
| defer cancel() | ||
|
|
||
| slog.SetDefault(slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: slog.LevelDebug}))) | ||
|
|
||
| err = TakeScreenshot(ctx, result.WSSURL, "screenshot.png") | ||
| require.NoError(t, err) | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The server message channel should be closed or we might end up waiting for it endlessly.