12 "github.com/gin-gonic/gin"
13 common "github.com/iotbzh/xds-common/golib"
14 "github.com/iotbzh/xds-common/golib/eows"
19 // ExecArgs JSON parameters of /exec command
21 ID string `json:"id" binding:"required"`
22 SdkID string `json:"sdkid"` // sdk ID to use for setting env
23 Cmd string `json:"cmd" binding:"required"`
24 Args []string `json:"args"`
25 Env []string `json:"env"`
26 RPath string `json:"rpath"` // relative path into project
27 TTY bool `json:"tty"` // Use a tty, specific to gdb --tty option
28 TTYGdbserverFix bool `json:"ttyGdbserverFix"` // Set to true to activate gdbserver workaround about inferior output
29 ExitImmediate bool `json:"exitImmediate"` // when true, exit event sent immediately when command exited (IOW, don't wait file synchronization)
30 CmdTimeout int `json:"timeout"` // command completion timeout in Second
33 // ExecInMsg Message used to received input characters (stdin)
35 CmdID string `json:"cmdID"`
36 Timestamp string `json:"timestamp"`
37 Stdin string `json:"stdin"`
40 // ExecOutMsg Message used to send output characters (stdout+stderr)
42 CmdID string `json:"cmdID"`
43 Timestamp string `json:"timestamp"`
44 Stdout string `json:"stdout"`
45 Stderr string `json:"stderr"`
48 // ExecExitMsg Message sent when executed command exited
50 CmdID string `json:"cmdID"`
51 Timestamp string `json:"timestamp"`
52 Code int `json:"code"`
53 Error error `json:"error"`
56 // ExecSignalArgs JSON parameters of /exec/signal command
57 ExecSignalArgs struct {
58 CmdID string `json:"cmdID" binding:"required"` // command id
59 Signal string `json:"signal" binding:"required"` // signal number
64 // ExecInEvent Event send in WS when characters are sent (stdin)
65 ExecInEvent = "exec:input"
67 // ExecOutEvent Event send in WS when characters are received (stdout or stderr)
68 ExecOutEvent = "exec:output"
70 // ExecExitEvent Event send in WS when program exited
71 ExecExitEvent = "exec:exit"
73 // ExecInferiorInEvent Event send in WS when characters are sent to an inferior (used by gdb inferior/tty)
74 ExecInferiorInEvent = "exec:inferior-input"
76 // ExecInferiorOutEvent Event send in WS when characters are received by an inferior
77 ExecInferiorOutEvent = "exec:inferior-output"
82 // ExecCmd executes remotely a command
83 func (s *APIService) execCmd(c *gin.Context) {
84 var gdbPty, gdbTty *os.File
87 if c.BindJSON(&args) != nil {
88 common.APIError(c, "Invalid arguments")
92 // TODO: add permission ?
94 // Retrieve session info
95 sess := s.sessions.Get(c)
97 common.APIError(c, "Unknown sessions")
102 common.APIError(c, "Websocket not established")
106 // Allow to pass id in url (/exec/:id) or as JSON argument
112 common.APIError(c, "Invalid id")
116 f := s.mfolders.Get(id)
118 common.APIError(c, "Unknown id")
122 prj := fld.GetConfig()
124 // Build command line
126 // Setup env var regarding Sdk ID (used for example to setup cross toolchain)
127 if envCmd := s.sdks.GetEnvCmd(args.SdkID, prj.DefaultSdk); len(envCmd) > 0 {
128 cmd = append(cmd, envCmd...)
129 cmd = append(cmd, "&&")
131 // It's an error if no envcmd found while a sdkid has been provided
132 if args.SdkID != "" {
133 common.APIError(c, "Unknown sdkid")
138 cmd = append(cmd, "cd", fld.GetFullPath(args.RPath))
139 // FIXME - add 'exec' prevents to use syntax:
140 // xds-exec -l debug -c xds-config.env -- "cd build && cmake .."
141 // but exec is mandatory to allow to pass correctly signals
142 // As workaround, exec is set for now on client side (eg. in xds-gdb)
143 //cmd = append(cmd, "&&", "exec", args.Cmd)
144 cmd = append(cmd, "&&", args.Cmd)
146 // Process command arguments
147 cmdArgs := make([]string, len(args.Args)+1)
149 // Copy and Translate path from client to server
150 for _, aa := range args.Args {
151 if strings.Contains(aa, prj.ClientPath) {
152 cmdArgs = append(cmdArgs, fld.ConvPathCli2Svr(aa))
154 cmdArgs = append(cmdArgs, aa)
158 // Allocate pts if tty if used
160 gdbPty, gdbTty, err = pty.Open()
162 common.APIError(c, err.Error())
166 s.log.Debugf("Client command tty: %v %v\n", gdbTty.Name(), gdbTty.Name())
167 cmdArgs = append(cmdArgs, "--tty="+gdbTty.Name())
170 // Unique ID for each commands
171 cmdID := strconv.Itoa(execCommandID)
174 // Create new execution over WS context
175 execWS := eows.New(strings.Join(cmd, " "), cmdArgs, sop, sess.ID, cmdID)
178 // Append client project dir to environment
179 execWS.Env = append(args.Env, "CLIENT_PROJECT_DIR="+prj.ClientPath)
181 // Set command execution timeout
182 if args.CmdTimeout == 0 {
183 // 0 : default timeout
184 // TODO get default timeout from config.json file
185 execWS.CmdExecTimeout = 24 * 60 * 60 // 1 day
187 execWS.CmdExecTimeout = args.CmdTimeout
190 // Define callback for input (stdin)
191 execWS.InputEvent = ExecInEvent
192 execWS.InputCB = func(e *eows.ExecOverWS, stdin string) (string, error) {
193 s.log.Debugf("STDIN <<%v>>", strings.Replace(stdin, "\n", "\\n", -1))
196 if len(stdin) == 1 && stdin == "\x04" {
198 errMsg := fmt.Errorf("close stdin: %v", stdin)
204 prjID := (*data)["ID"].(string)
205 f := s.mfolders.Get(prjID)
207 s.log.Errorf("InputCB: Cannot get folder ID %s", prjID)
209 // Translate paths from client to server
210 stdin = (*f).ConvPathCli2Svr(stdin)
216 // Define callback for output (stdout+stderr)
217 execWS.OutputCB = func(e *eows.ExecOverWS, stdout, stderr string) {
218 // IO socket can be nil when disconnected
219 so := s.sessions.IOSocketGet(e.Sid)
221 s.log.Infof("%s not emitted: WS closed (sid:%s, msgid:%s)", ExecOutEvent, e.Sid, e.CmdID)
225 // Retrieve project ID and RootPath
227 prjID := (*data)["ID"].(string)
228 gdbServerTTY := (*data)["gdbServerTTY"].(string)
230 f := s.mfolders.Get(prjID)
232 s.log.Errorf("OutputCB: Cannot get folder ID %s", prjID)
234 // Translate paths from server to client
235 stdout = (*f).ConvPathSvr2Cli(stdout)
236 stderr = (*f).ConvPathSvr2Cli(stderr)
239 s.log.Debugf("%s emitted - WS sid[4:] %s - id:%s - prjID:%s", ExecOutEvent, e.Sid[4:], e.CmdID, prjID)
241 s.log.Debugf("STDOUT <<%v>>", strings.Replace(stdout, "\n", "\\n", -1))
244 s.log.Debugf("STDERR <<%v>>", strings.Replace(stderr, "\n", "\\n", -1))
247 // FIXME replace by .BroadcastTo a room
248 err := (*so).Emit(ExecOutEvent, ExecOutMsg{
250 Timestamp: time.Now().String(),
255 s.log.Errorf("WS Emit : %v", err)
258 // XXX - Workaround due to gdbserver bug that doesn't redirect
259 // inferior output (https://bugs.eclipse.org/bugs/show_bug.cgi?id=437532#c13)
260 if gdbServerTTY == "workaround" && len(stdout) > 1 && stdout[0] == '&' {
262 // Extract and cleanup string like &"bla bla\n"
263 re := regexp.MustCompile("&\"(.*)\"")
264 rer := re.FindAllStringSubmatch(stdout, -1)
266 if rer != nil && len(rer) > 0 {
267 for _, o := range rer {
269 out = strings.Replace(o[1], "\\n", "\n", -1)
270 out = strings.Replace(out, "\\r", "\r", -1)
271 out = strings.Replace(out, "\\t", "\t", -1)
273 s.log.Debugf("STDOUT INFERIOR: <<%v>>", out)
274 err := (*so).Emit(ExecInferiorOutEvent, ExecOutMsg{
276 Timestamp: time.Now().String(),
281 s.log.Errorf("WS Emit : %v", err)
286 s.log.Errorf("INFERIOR out parsing error: stdout=<%v>", stdout)
291 // Define callback for output
292 execWS.ExitCB = func(e *eows.ExecOverWS, code int, err error) {
293 s.log.Debugf("Command [Cmd ID %s] exited: code %d, error: %v", e.CmdID, code, err)
295 // IO socket can be nil when disconnected
296 so := s.sessions.IOSocketGet(e.Sid)
298 s.log.Infof("%s not emitted - WS closed (id:%s)", ExecExitEvent, e.CmdID)
302 // Retrieve project ID and RootPath
304 prjID := (*data)["ID"].(string)
305 exitImm := (*data)["ExitImmediate"].(bool)
307 // XXX - workaround to be sure that Syncthing detected all changes
308 if err := s.mfolders.ForceSync(prjID); err != nil {
309 s.log.Errorf("Error while syncing folder %s: %v", prjID, err)
312 // Wait end of file sync
313 // FIXME pass as argument
315 for t := tmo; t > 0; t-- {
316 s.log.Debugf("Wait file in-sync for %s (%d/%d)", prjID, t, tmo)
317 if sync, err := s.mfolders.IsFolderInSync(prjID); sync || err != nil {
319 s.log.Errorf("ERROR IsFolderInSync (%s): %v", prjID, err)
323 time.Sleep(time.Second)
335 // FIXME replace by .BroadcastTo a room
336 errSoEmit := (*so).Emit(ExecExitEvent, ExecExitMsg{
338 Timestamp: time.Now().String(),
342 if errSoEmit != nil {
343 s.log.Errorf("WS Emit : %v", errSoEmit)
347 // User data (used within callbacks)
348 data := make(map[string]interface{})
350 data["ExitImmediate"] = args.ExitImmediate
351 if args.TTY && args.TTYGdbserverFix {
352 data["gdbServerTTY"] = "workaround"
354 data["gdbServerTTY"] = ""
356 execWS.UserData = &data
358 // Start command execution
359 s.log.Infof("Execute [Cmd ID %s]: %v %v", execWS.CmdID, execWS.Cmd, execWS.Args)
363 common.APIError(c, err.Error())
367 c.JSON(http.StatusOK,
370 "cmdID": execWS.CmdID,
374 // ExecCmd executes remotely a command
375 func (s *APIService) execSignalCmd(c *gin.Context) {
376 var args ExecSignalArgs
378 if c.BindJSON(&args) != nil {
379 common.APIError(c, "Invalid arguments")
383 s.log.Debugf("Signal %s for command ID %s", args.Signal, args.CmdID)
385 e := eows.GetEows(args.CmdID)
387 common.APIError(c, "unknown cmdID")
391 err := e.Signal(args.Signal)
393 common.APIError(c, err.Error())
397 c.JSON(http.StatusOK,