api.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810
  1. package api
  2. import (
  3. ctx "context"
  4. "encoding/json"
  5. "connectrpc.com/connect"
  6. apiv1 "github.com/OliveTin/OliveTin/gen/olivetin/api/v1"
  7. apiv1connect "github.com/OliveTin/OliveTin/gen/olivetin/api/v1/apiv1connect"
  8. "github.com/google/uuid"
  9. log "github.com/sirupsen/logrus"
  10. "fmt"
  11. "net/http"
  12. acl "github.com/OliveTin/OliveTin/internal/acl"
  13. auth "github.com/OliveTin/OliveTin/internal/auth"
  14. config "github.com/OliveTin/OliveTin/internal/config"
  15. entities "github.com/OliveTin/OliveTin/internal/entities"
  16. executor "github.com/OliveTin/OliveTin/internal/executor"
  17. installationinfo "github.com/OliveTin/OliveTin/internal/installationinfo"
  18. )
  19. type oliveTinAPI struct {
  20. executor *executor.Executor
  21. cfg *config.Config
  22. connectedClients []*connectedClients
  23. }
  24. type connectedClients struct {
  25. channel chan *apiv1.EventStreamResponse
  26. AuthenticatedUser *acl.AuthenticatedUser
  27. }
  28. func (api *oliveTinAPI) KillAction(ctx ctx.Context, req *connect.Request[apiv1.KillActionRequest]) (*connect.Response[apiv1.KillActionResponse], error) {
  29. ret := &apiv1.KillActionResponse{
  30. ExecutionTrackingId: req.Msg.ExecutionTrackingId,
  31. }
  32. var execReqLogEntry *executor.InternalLogEntry
  33. execReqLogEntry, ret.Found = api.executor.GetLog(req.Msg.ExecutionTrackingId)
  34. if !ret.Found {
  35. log.Warnf("Killing execution request not possible - not found by tracking ID: %v", req.Msg.ExecutionTrackingId)
  36. return connect.NewResponse(ret), nil
  37. }
  38. log.Warnf("Killing execution request by tracking ID: %v", req.Msg.ExecutionTrackingId)
  39. action := execReqLogEntry.Binding.Action
  40. if action == nil {
  41. log.Warnf("Killing execution request not possible - action not found: %v", execReqLogEntry.ActionTitle)
  42. ret.Killed = false
  43. return connect.NewResponse(ret), nil
  44. }
  45. user := acl.UserFromContext(ctx, req, api.cfg)
  46. api.killActionByTrackingId(user, action, execReqLogEntry, ret)
  47. return connect.NewResponse(ret), nil
  48. }
  49. func (api *oliveTinAPI) killActionByTrackingId(user *acl.AuthenticatedUser, action *config.Action, execReqLogEntry *executor.InternalLogEntry, ret *apiv1.KillActionResponse) {
  50. if !acl.IsAllowedKill(api.cfg, user, action) {
  51. log.Warnf("Killing execution request not possible - user not allowed to kill this action: %v", execReqLogEntry.ExecutionTrackingID)
  52. ret.Killed = false
  53. }
  54. err := api.executor.Kill(execReqLogEntry)
  55. if err != nil {
  56. log.Warnf("Killing execution request err: %v", err)
  57. ret.AlreadyCompleted = true
  58. ret.Killed = false
  59. } else {
  60. ret.Killed = true
  61. }
  62. }
  63. func (api *oliveTinAPI) StartAction(ctx ctx.Context, req *connect.Request[apiv1.StartActionRequest]) (*connect.Response[apiv1.StartActionResponse], error) {
  64. args := make(map[string]string)
  65. for _, arg := range req.Msg.Arguments {
  66. args[arg.Name] = arg.Value
  67. }
  68. pair := api.executor.FindBindingByID(req.Msg.BindingId)
  69. if pair == nil || pair.Action == nil {
  70. return nil, connect.NewError(connect.CodeNotFound, fmt.Errorf("action with ID %s not found", req.Msg.BindingId))
  71. }
  72. authenticatedUser := acl.UserFromContext(ctx, req, api.cfg)
  73. execReq := executor.ExecutionRequest{
  74. Binding: pair,
  75. TrackingID: req.Msg.UniqueTrackingId,
  76. Arguments: args,
  77. AuthenticatedUser: authenticatedUser,
  78. Cfg: api.cfg,
  79. }
  80. api.executor.ExecRequest(&execReq)
  81. ret := &apiv1.StartActionResponse{
  82. ExecutionTrackingId: execReq.TrackingID,
  83. }
  84. return connect.NewResponse(ret), nil
  85. }
  86. func (api *oliveTinAPI) PasswordHash(ctx ctx.Context, req *connect.Request[apiv1.PasswordHashRequest]) (*connect.Response[apiv1.PasswordHashResponse], error) {
  87. hash, err := createHash(req.Msg.Password)
  88. if err != nil {
  89. return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("error creating hash: %w", err))
  90. }
  91. ret := &apiv1.PasswordHashResponse{
  92. Hash: hash,
  93. }
  94. return connect.NewResponse(ret), nil
  95. }
  96. func (api *oliveTinAPI) LocalUserLogin(ctx ctx.Context, req *connect.Request[apiv1.LocalUserLoginRequest]) (*connect.Response[apiv1.LocalUserLoginResponse], error) {
  97. match := checkUserPassword(api.cfg, req.Msg.Username, req.Msg.Password)
  98. response := connect.NewResponse(&apiv1.LocalUserLoginResponse{
  99. Success: match,
  100. })
  101. if match {
  102. // Set authentication cookie for successful login
  103. user := api.cfg.FindUserByUsername(req.Msg.Username)
  104. if user != nil {
  105. sid := uuid.NewString()
  106. // Register the session in the session storage
  107. auth.RegisterUserSession(api.cfg, "local", sid, user.Username)
  108. log.WithFields(log.Fields{
  109. "username": user.Username,
  110. }).Info("LocalUserLogin: Session created and registered")
  111. // Set the authentication cookie in the response headers
  112. cookie := &http.Cookie{
  113. Name: "olivetin-sid-local",
  114. Value: sid,
  115. MaxAge: 31556952, // 1 year
  116. HttpOnly: true,
  117. Path: "/",
  118. }
  119. response.Header().Set("Set-Cookie", cookie.String())
  120. }
  121. log.WithFields(log.Fields{
  122. "username": req.Msg.Username,
  123. }).Info("LocalUserLogin: User logged in successfully.")
  124. } else {
  125. log.WithFields(log.Fields{
  126. "username": req.Msg.Username,
  127. }).Warn("LocalUserLogin: User login failed.")
  128. }
  129. return response, nil
  130. }
  131. func (api *oliveTinAPI) StartActionAndWait(ctx ctx.Context, req *connect.Request[apiv1.StartActionAndWaitRequest]) (*connect.Response[apiv1.StartActionAndWaitResponse], error) {
  132. args := make(map[string]string)
  133. for _, arg := range req.Msg.Arguments {
  134. args[arg.Name] = arg.Value
  135. }
  136. user := acl.UserFromContext(ctx, req, api.cfg)
  137. execReq := executor.ExecutionRequest{
  138. Binding: api.executor.FindBindingByID(req.Msg.ActionId),
  139. TrackingID: uuid.NewString(),
  140. Arguments: args,
  141. AuthenticatedUser: user,
  142. Cfg: api.cfg,
  143. }
  144. wg, _ := api.executor.ExecRequest(&execReq)
  145. wg.Wait()
  146. internalLogEntry, ok := api.executor.GetLog(execReq.TrackingID)
  147. if ok {
  148. return connect.NewResponse(&apiv1.StartActionAndWaitResponse{
  149. LogEntry: api.internalLogEntryToPb(internalLogEntry, user),
  150. }), nil
  151. } else {
  152. return nil, fmt.Errorf("execution not found")
  153. }
  154. }
  155. func (api *oliveTinAPI) StartActionByGet(ctx ctx.Context, req *connect.Request[apiv1.StartActionByGetRequest]) (*connect.Response[apiv1.StartActionByGetResponse], error) {
  156. args := make(map[string]string)
  157. execReq := executor.ExecutionRequest{
  158. Binding: api.executor.FindBindingByID(req.Msg.ActionId),
  159. TrackingID: uuid.NewString(),
  160. Arguments: args,
  161. AuthenticatedUser: acl.UserFromContext(ctx, req, api.cfg),
  162. Cfg: api.cfg,
  163. }
  164. _, uniqueTrackingId := api.executor.ExecRequest(&execReq)
  165. return connect.NewResponse(&apiv1.StartActionByGetResponse{
  166. ExecutionTrackingId: uniqueTrackingId,
  167. }), nil
  168. }
  169. func (api *oliveTinAPI) StartActionByGetAndWait(ctx ctx.Context, req *connect.Request[apiv1.StartActionByGetAndWaitRequest]) (*connect.Response[apiv1.StartActionByGetAndWaitResponse], error) {
  170. args := make(map[string]string)
  171. user := acl.UserFromContext(ctx, req, api.cfg)
  172. execReq := executor.ExecutionRequest{
  173. Binding: api.executor.FindBindingByID(req.Msg.ActionId),
  174. TrackingID: uuid.NewString(),
  175. Arguments: args,
  176. AuthenticatedUser: user,
  177. Cfg: api.cfg,
  178. }
  179. wg, _ := api.executor.ExecRequest(&execReq)
  180. wg.Wait()
  181. internalLogEntry, ok := api.executor.GetLog(execReq.TrackingID)
  182. if ok {
  183. return connect.NewResponse(&apiv1.StartActionByGetAndWaitResponse{
  184. LogEntry: api.internalLogEntryToPb(internalLogEntry, user),
  185. }), nil
  186. } else {
  187. return nil, connect.NewError(connect.CodeNotFound, fmt.Errorf("execution not found"))
  188. }
  189. }
  190. func (api *oliveTinAPI) internalLogEntryToPb(logEntry *executor.InternalLogEntry, authenticatedUser *acl.AuthenticatedUser) *apiv1.LogEntry {
  191. pble := &apiv1.LogEntry{
  192. ActionTitle: logEntry.ActionTitle,
  193. ActionIcon: logEntry.ActionIcon,
  194. ActionId: logEntry.ActionId,
  195. DatetimeStarted: logEntry.DatetimeStarted.Format("2006-01-02 15:04:05"),
  196. DatetimeFinished: logEntry.DatetimeFinished.Format("2006-01-02 15:04:05"),
  197. DatetimeIndex: logEntry.Index,
  198. Output: logEntry.Output,
  199. TimedOut: logEntry.TimedOut,
  200. Blocked: logEntry.Blocked,
  201. ExitCode: logEntry.ExitCode,
  202. Tags: logEntry.Tags,
  203. ExecutionTrackingId: logEntry.ExecutionTrackingID,
  204. ExecutionStarted: logEntry.ExecutionStarted,
  205. ExecutionFinished: logEntry.ExecutionFinished,
  206. User: logEntry.Username,
  207. }
  208. if !pble.ExecutionFinished {
  209. pble.CanKill = acl.IsAllowedKill(api.cfg, authenticatedUser, logEntry.Binding.Action)
  210. }
  211. return pble
  212. }
  213. func getExecutionStatusByTrackingID(api *oliveTinAPI, executionTrackingId string) *executor.InternalLogEntry {
  214. logEntry, ok := api.executor.GetLog(executionTrackingId)
  215. if !ok {
  216. return nil
  217. }
  218. return logEntry
  219. }
  220. func getMostRecentExecutionStatusById(api *oliveTinAPI, actionId string) *executor.InternalLogEntry {
  221. var ile *executor.InternalLogEntry
  222. logs := api.executor.GetLogsByActionId(actionId)
  223. if len(logs) == 0 {
  224. return nil
  225. } else {
  226. // Get last log entry
  227. ile = logs[len(logs)-1]
  228. }
  229. return ile
  230. }
  231. func (api *oliveTinAPI) ExecutionStatus(ctx ctx.Context, req *connect.Request[apiv1.ExecutionStatusRequest]) (*connect.Response[apiv1.ExecutionStatusResponse], error) {
  232. res := &apiv1.ExecutionStatusResponse{}
  233. user := acl.UserFromContext(ctx, req, api.cfg)
  234. var ile *executor.InternalLogEntry
  235. if req.Msg.ExecutionTrackingId != "" {
  236. ile = getExecutionStatusByTrackingID(api, req.Msg.ExecutionTrackingId)
  237. } else {
  238. ile = getMostRecentExecutionStatusById(api, req.Msg.ActionId)
  239. }
  240. if ile == nil {
  241. return nil, connect.NewError(connect.CodeNotFound, fmt.Errorf("execution not found for tracking ID %s or action ID %s", req.Msg.ExecutionTrackingId, req.Msg.ActionId))
  242. } else {
  243. res.LogEntry = api.internalLogEntryToPb(ile, user)
  244. }
  245. return connect.NewResponse(res), nil
  246. }
  247. func (api *oliveTinAPI) Logout(ctx ctx.Context, req *connect.Request[apiv1.LogoutRequest]) (*connect.Response[apiv1.LogoutResponse], error) {
  248. // user := acl.UserFromContext(ctx, cfg)
  249. return nil, nil
  250. }
  251. func (api *oliveTinAPI) GetActionBinding(ctx ctx.Context, req *connect.Request[apiv1.GetActionBindingRequest]) (*connect.Response[apiv1.GetActionBindingResponse], error) {
  252. binding := api.executor.FindBindingByID(req.Msg.BindingId)
  253. return connect.NewResponse(&apiv1.GetActionBindingResponse{
  254. Action: buildAction(binding, &DashboardRenderRequest{
  255. cfg: api.cfg,
  256. AuthenticatedUser: acl.UserFromContext(ctx, req, api.cfg),
  257. ex: api.executor,
  258. }),
  259. }), nil
  260. }
  261. func (api *oliveTinAPI) GetDashboard(ctx ctx.Context, req *connect.Request[apiv1.GetDashboardRequest]) (*connect.Response[apiv1.GetDashboardResponse], error) {
  262. user := acl.UserFromContext(ctx, req, api.cfg)
  263. if err := api.checkDashboardAccess(user); err != nil {
  264. return nil, err
  265. }
  266. dashboardRenderRequest := api.createDashboardRenderRequest(user)
  267. if api.isDefaultDashboard(req.Msg.Title) {
  268. return api.buildDefaultDashboardResponse(dashboardRenderRequest)
  269. }
  270. return api.buildCustomDashboardResponse(dashboardRenderRequest, req.Msg.Title)
  271. }
  272. func (api *oliveTinAPI) checkDashboardAccess(user *acl.AuthenticatedUser) error {
  273. if user.IsGuest() && api.cfg.AuthRequireGuestsToLogin {
  274. return connect.NewError(connect.CodePermissionDenied, fmt.Errorf("guests are not allowed to access the dashboard"))
  275. }
  276. return nil
  277. }
  278. func (api *oliveTinAPI) createDashboardRenderRequest(user *acl.AuthenticatedUser) *DashboardRenderRequest {
  279. return &DashboardRenderRequest{
  280. AuthenticatedUser: user,
  281. cfg: api.cfg,
  282. ex: api.executor,
  283. }
  284. }
  285. func (api *oliveTinAPI) isDefaultDashboard(title string) bool {
  286. return title == "default" || title == "" || title == "Actions"
  287. }
  288. func (api *oliveTinAPI) buildDefaultDashboardResponse(rr *DashboardRenderRequest) (*connect.Response[apiv1.GetDashboardResponse], error) {
  289. db := buildDefaultDashboard(rr)
  290. res := &apiv1.GetDashboardResponse{
  291. Dashboard: db,
  292. }
  293. return connect.NewResponse(res), nil
  294. }
  295. func (api *oliveTinAPI) buildCustomDashboardResponse(rr *DashboardRenderRequest, title string) (*connect.Response[apiv1.GetDashboardResponse], error) {
  296. res := &apiv1.GetDashboardResponse{
  297. Dashboard: renderDashboard(rr, title),
  298. }
  299. return connect.NewResponse(res), nil
  300. }
  301. func (api *oliveTinAPI) GetLogs(ctx ctx.Context, req *connect.Request[apiv1.GetLogsRequest]) (*connect.Response[apiv1.GetLogsResponse], error) {
  302. user := acl.UserFromContext(ctx, req, api.cfg)
  303. ret := &apiv1.GetLogsResponse{}
  304. logEntries, pagingResult := api.executor.GetLogTrackingIds(req.Msg.StartOffset, api.cfg.LogHistoryPageSize)
  305. for _, logEntry := range logEntries {
  306. action := logEntry.Binding.Action
  307. if action == nil || acl.IsAllowedLogs(api.cfg, user, action) {
  308. pbLogEntry := api.internalLogEntryToPb(logEntry, user)
  309. ret.Logs = append(ret.Logs, pbLogEntry)
  310. }
  311. }
  312. ret.CountRemaining = pagingResult.CountRemaining
  313. ret.PageSize = pagingResult.PageSize
  314. ret.TotalCount = pagingResult.TotalCount
  315. ret.StartOffset = pagingResult.StartOffset
  316. return connect.NewResponse(ret), nil
  317. }
  318. /*
  319. This function is ONLY a helper for the UI - the arguments are validated properly
  320. on the StartAction -> Executor chain. This is here basically to provide helpful
  321. error messages more quickly before starting the action.
  322. */
  323. func (api *oliveTinAPI) ValidateArgumentType(ctx ctx.Context, req *connect.Request[apiv1.ValidateArgumentTypeRequest]) (*connect.Response[apiv1.ValidateArgumentTypeResponse], error) {
  324. err := executor.TypeSafetyCheck("", req.Msg.Value, req.Msg.Type)
  325. desc := ""
  326. if err != nil {
  327. desc = err.Error()
  328. }
  329. return connect.NewResponse(&apiv1.ValidateArgumentTypeResponse{
  330. Valid: err == nil,
  331. Description: desc,
  332. }), nil
  333. }
  334. func (api *oliveTinAPI) WhoAmI(ctx ctx.Context, req *connect.Request[apiv1.WhoAmIRequest]) (*connect.Response[apiv1.WhoAmIResponse], error) {
  335. user := acl.UserFromContext(ctx, req, api.cfg)
  336. res := &apiv1.WhoAmIResponse{
  337. AuthenticatedUser: user.Username,
  338. Usergroup: user.UsergroupLine,
  339. Provider: user.Provider,
  340. Sid: user.SID,
  341. Acls: user.Acls,
  342. }
  343. return connect.NewResponse(res), nil
  344. }
  345. func (api *oliveTinAPI) SosReport(ctx ctx.Context, req *connect.Request[apiv1.SosReportRequest]) (*connect.Response[apiv1.SosReportResponse], error) {
  346. sos := installationinfo.GetSosReport()
  347. if !api.cfg.InsecureAllowDumpSos {
  348. log.Info(sos)
  349. sos = "Your SOS Report has been logged to OliveTin logs.\n\nIf you are in a safe network, you can temporarily set `insecureAllowDumpSos: true` in your config.yaml, restart OliveTin, and refresh this page - it will put the output directly in the browser."
  350. }
  351. ret := &apiv1.SosReportResponse{
  352. Alert: sos,
  353. }
  354. return connect.NewResponse(ret), nil
  355. }
  356. func (api *oliveTinAPI) DumpVars(ctx ctx.Context, req *connect.Request[apiv1.DumpVarsRequest]) (*connect.Response[apiv1.DumpVarsResponse], error) {
  357. res := &apiv1.DumpVarsResponse{}
  358. if !api.cfg.InsecureAllowDumpVars {
  359. res.Alert = "Dumping variables is not allowed by default because it is insecure."
  360. return connect.NewResponse(res), nil
  361. }
  362. jsonstring, _ := json.MarshalIndent(entities.GetAll(), "", " ")
  363. fmt.Printf("%s", &jsonstring)
  364. res.Alert = "Dumping variables has been enabled in the configuration. Please set InsecureAllowDumpVars = false again after you don't need it anymore"
  365. return connect.NewResponse(res), nil
  366. }
  367. func (api *oliveTinAPI) DumpPublicIdActionMap(ctx ctx.Context, req *connect.Request[apiv1.DumpPublicIdActionMapRequest]) (*connect.Response[apiv1.DumpPublicIdActionMapResponse], error) {
  368. res := &apiv1.DumpPublicIdActionMapResponse{}
  369. res.Contents = make(map[string]*apiv1.ActionEntityPair)
  370. if !api.cfg.InsecureAllowDumpActionMap {
  371. res.Alert = "Dumping Public IDs is disallowed."
  372. return connect.NewResponse(res), nil
  373. }
  374. api.executor.MapActionIdToBindingLock.RLock()
  375. for k, v := range api.executor.MapActionIdToBinding {
  376. res.Contents[k] = &apiv1.ActionEntityPair{
  377. ActionTitle: v.Action.Title,
  378. EntityPrefix: "?",
  379. }
  380. }
  381. api.executor.MapActionIdToBindingLock.RUnlock()
  382. res.Alert = "Dumping variables has been enabled in the configuration. Please set InsecureAllowDumpActionMap = false again after you don't need it anymore"
  383. return connect.NewResponse(res), nil
  384. }
  385. func (api *oliveTinAPI) GetReadyz(ctx ctx.Context, req *connect.Request[apiv1.GetReadyzRequest]) (*connect.Response[apiv1.GetReadyzResponse], error) {
  386. res := &apiv1.GetReadyzResponse{
  387. Status: "OK",
  388. }
  389. return connect.NewResponse(res), nil
  390. }
  391. func (api *oliveTinAPI) EventStream(ctx ctx.Context, req *connect.Request[apiv1.EventStreamRequest], srv *connect.ServerStream[apiv1.EventStreamResponse]) error {
  392. log.Debugf("EventStream: %v", req.Msg)
  393. client := &connectedClients{
  394. channel: make(chan *apiv1.EventStreamResponse, 10), // Buffered channel to hold Events
  395. AuthenticatedUser: acl.UserFromContext(ctx, req, api.cfg),
  396. }
  397. log.Infof("EventStream: client connected: %v", client.AuthenticatedUser.Username)
  398. api.connectedClients = append(api.connectedClients, client)
  399. // loop over client channel and send events to connectedClient
  400. for msg := range client.channel {
  401. log.Debugf("Sending event to client: %v", msg)
  402. if err := srv.Send(msg); err != nil {
  403. log.Errorf("Error sending event to client: %v", err)
  404. }
  405. }
  406. log.Infof("EventStream: client disconnected")
  407. return nil
  408. }
  409. func (api *oliveTinAPI) OnActionMapRebuilt() {
  410. for _, client := range api.connectedClients {
  411. select {
  412. case client.channel <- &apiv1.EventStreamResponse{
  413. Event: &apiv1.EventStreamResponse_ConfigChanged{
  414. ConfigChanged: &apiv1.EventConfigChanged{},
  415. },
  416. }:
  417. default:
  418. log.Warnf("EventStream: client channel is full, dropping message")
  419. }
  420. }
  421. }
  422. func (api *oliveTinAPI) OnExecutionStarted(ex *executor.InternalLogEntry) {
  423. for _, client := range api.connectedClients {
  424. select {
  425. case client.channel <- &apiv1.EventStreamResponse{
  426. Event: &apiv1.EventStreamResponse_ExecutionStarted{
  427. ExecutionStarted: &apiv1.EventExecutionStarted{
  428. LogEntry: api.internalLogEntryToPb(ex, client.AuthenticatedUser),
  429. },
  430. },
  431. }:
  432. default:
  433. log.Warnf("EventStream: client channel is full, dropping message")
  434. }
  435. }
  436. }
  437. func (api *oliveTinAPI) OnExecutionFinished(ex *executor.InternalLogEntry) {
  438. for _, client := range api.connectedClients {
  439. select {
  440. case client.channel <- &apiv1.EventStreamResponse{
  441. Event: &apiv1.EventStreamResponse_ExecutionFinished{
  442. ExecutionFinished: &apiv1.EventExecutionFinished{
  443. LogEntry: api.internalLogEntryToPb(ex, client.AuthenticatedUser),
  444. },
  445. },
  446. }:
  447. default:
  448. log.Warnf("EventStream: client channel is full, dropping message")
  449. }
  450. }
  451. }
  452. func (api *oliveTinAPI) GetDiagnostics(ctx ctx.Context, req *connect.Request[apiv1.GetDiagnosticsRequest]) (*connect.Response[apiv1.GetDiagnosticsResponse], error) {
  453. res := &apiv1.GetDiagnosticsResponse{
  454. SshFoundKey: installationinfo.Runtime.SshFoundKey,
  455. SshFoundConfig: installationinfo.Runtime.SshFoundConfig,
  456. }
  457. return connect.NewResponse(res), nil
  458. }
  459. func (api *oliveTinAPI) Init(ctx ctx.Context, req *connect.Request[apiv1.InitRequest]) (*connect.Response[apiv1.InitResponse], error) {
  460. user := acl.UserFromContext(ctx, req, api.cfg)
  461. res := &apiv1.InitResponse{
  462. ShowFooter: api.cfg.ShowFooter,
  463. ShowNavigation: api.cfg.ShowNavigation,
  464. ShowNewVersions: api.cfg.ShowNewVersions,
  465. AvailableVersion: installationinfo.Runtime.AvailableVersion,
  466. CurrentVersion: installationinfo.Build.Version,
  467. PageTitle: api.cfg.PageTitle,
  468. SectionNavigationStyle: api.cfg.SectionNavigationStyle,
  469. DefaultIconForBack: api.cfg.DefaultIconForBack,
  470. EnableCustomJs: api.cfg.EnableCustomJs,
  471. AuthLoginUrl: api.cfg.AuthLoginUrl,
  472. AuthLocalLogin: api.cfg.AuthLocalUsers.Enabled,
  473. OAuth2Providers: buildPublicOAuth2ProvidersList(api.cfg),
  474. AdditionalLinks: buildAdditionalLinks(api.cfg.AdditionalNavigationLinks),
  475. StyleMods: api.cfg.StyleMods,
  476. RootDashboards: api.buildRootDashboards(user, api.cfg.Dashboards),
  477. AuthenticatedUser: user.Username,
  478. AuthenticatedUserProvider: user.Provider,
  479. EffectivePolicy: buildEffectivePolicy(user.EffectivePolicy),
  480. BannerMessage: api.cfg.BannerMessage,
  481. BannerCss: api.cfg.BannerCSS,
  482. ShowDiagnostics: user.EffectivePolicy.ShowDiagnostics,
  483. ShowLogList: user.EffectivePolicy.ShowLogList,
  484. }
  485. return connect.NewResponse(res), nil
  486. }
  487. func (api *oliveTinAPI) buildRootDashboards(user *acl.AuthenticatedUser, dashboards []*config.DashboardComponent) []string {
  488. var rootDashboards []string
  489. dashboardRenderRequest := api.createDashboardRenderRequest(user)
  490. api.addDefaultDashboardIfNeeded(&rootDashboards, dashboardRenderRequest)
  491. api.addCustomDashboards(&rootDashboards, dashboards, dashboardRenderRequest)
  492. return rootDashboards
  493. }
  494. func (api *oliveTinAPI) addDefaultDashboardIfNeeded(rootDashboards *[]string, rr *DashboardRenderRequest) {
  495. defaultDashboard := buildDefaultDashboard(rr)
  496. if defaultDashboard != nil && len(defaultDashboard.Contents) > 0 {
  497. log.Infof("defaultDashboard: %+v", defaultDashboard.Contents)
  498. *rootDashboards = append(*rootDashboards, "Actions")
  499. }
  500. }
  501. func (api *oliveTinAPI) addCustomDashboards(rootDashboards *[]string, dashboards []*config.DashboardComponent, rr *DashboardRenderRequest) {
  502. for _, dashboard := range dashboards {
  503. // We have to build the dashboard response instead of just looping over config.dashboards,
  504. // because we need to check if the user has access to the dashboard
  505. db := renderDashboard(rr, dashboard.Title)
  506. if db != nil {
  507. *rootDashboards = append(*rootDashboards, dashboard.Title)
  508. }
  509. }
  510. }
  511. func buildPublicOAuth2ProvidersList(cfg *config.Config) []*apiv1.OAuth2Provider {
  512. var publicProviders []*apiv1.OAuth2Provider
  513. for _, provider := range cfg.AuthOAuth2Providers {
  514. publicProviders = append(publicProviders, &apiv1.OAuth2Provider{
  515. Title: provider.Title,
  516. Url: provider.AuthUrl,
  517. Icon: provider.Icon,
  518. })
  519. }
  520. return publicProviders
  521. }
  522. func buildAdditionalLinks(links []*config.NavigationLink) []*apiv1.AdditionalLink {
  523. var additionalLinks []*apiv1.AdditionalLink
  524. for _, link := range links {
  525. additionalLinks = append(additionalLinks, &apiv1.AdditionalLink{
  526. Title: link.Title,
  527. Url: link.Url,
  528. })
  529. }
  530. return additionalLinks
  531. }
  532. func (api *oliveTinAPI) OnOutputChunk(content []byte, executionTrackingId string) {
  533. for _, client := range api.connectedClients {
  534. select {
  535. case client.channel <- &apiv1.EventStreamResponse{
  536. Event: &apiv1.EventStreamResponse_OutputChunk{
  537. OutputChunk: &apiv1.EventOutputChunk{
  538. Output: string(content),
  539. ExecutionTrackingId: executionTrackingId,
  540. },
  541. },
  542. }:
  543. default:
  544. log.Warnf("EventStream: client channel is full, dropping message")
  545. }
  546. }
  547. }
  548. func (api *oliveTinAPI) GetEntities(ctx ctx.Context, req *connect.Request[apiv1.GetEntitiesRequest]) (*connect.Response[apiv1.GetEntitiesResponse], error) {
  549. res := &apiv1.GetEntitiesResponse{
  550. EntityDefinitions: make([]*apiv1.EntityDefinition, 0),
  551. }
  552. for name, entityInstances := range entities.GetEntities() {
  553. def := &apiv1.EntityDefinition{
  554. Title: name,
  555. UsedOnDashboards: findDashboardsForEntity(name, api.cfg.Dashboards),
  556. }
  557. for _, e := range entityInstances {
  558. entity := &apiv1.Entity{
  559. Title: e.Title,
  560. UniqueKey: e.UniqueKey,
  561. Type: name,
  562. }
  563. def.Instances = append(def.Instances, entity)
  564. }
  565. res.EntityDefinitions = append(res.EntityDefinitions, def)
  566. }
  567. return connect.NewResponse(res), nil
  568. }
  569. func findDashboardsForEntity(entityTitle string, dashboards []*config.DashboardComponent) []string {
  570. var foundDashboards []string
  571. findEntityInComponents(entityTitle, "", dashboards, &foundDashboards)
  572. return foundDashboards
  573. }
  574. func findEntityInComponents(entityTitle string, parentTitle string, components []*config.DashboardComponent, foundDashboards *[]string) {
  575. for _, component := range components {
  576. if component.Entity == entityTitle {
  577. *foundDashboards = append(*foundDashboards, parentTitle)
  578. }
  579. if len(component.Contents) > 0 {
  580. findEntityInComponents(entityTitle, component.Title, component.Contents, foundDashboards)
  581. }
  582. }
  583. }
  584. func (api *oliveTinAPI) GetEntity(ctx ctx.Context, req *connect.Request[apiv1.GetEntityRequest]) (*connect.Response[apiv1.Entity], error) {
  585. res := &apiv1.Entity{}
  586. instances := entities.GetEntityInstances(req.Msg.Type)
  587. log.Infof("msg: %+v", req.Msg)
  588. if len(instances) == 0 {
  589. return nil, connect.NewError(connect.CodeNotFound, fmt.Errorf("entity type %s not found", req.Msg.Type))
  590. }
  591. if entity, ok := instances[req.Msg.UniqueKey]; !ok {
  592. return nil, connect.NewError(connect.CodeNotFound, fmt.Errorf("entity with unique key %s not found in type %s", req.Msg.UniqueKey, req.Msg.Type))
  593. } else {
  594. res.Title = entity.Title
  595. return connect.NewResponse(res), nil
  596. }
  597. }
  598. func (api *oliveTinAPI) RestartAction(ctx ctx.Context, req *connect.Request[apiv1.RestartActionRequest]) (*connect.Response[apiv1.StartActionResponse], error) {
  599. ret := &apiv1.StartActionResponse{
  600. ExecutionTrackingId: req.Msg.ExecutionTrackingId,
  601. }
  602. var execReqLogEntry *executor.InternalLogEntry
  603. execReqLogEntry, found := api.executor.GetLog(req.Msg.ExecutionTrackingId)
  604. if !found {
  605. log.Warnf("Restarting execution request not possible - not found by tracking ID: %v", req.Msg.ExecutionTrackingId)
  606. return connect.NewResponse(ret), nil
  607. }
  608. log.Warnf("Restarting execution request by tracking ID: %v", req.Msg.ExecutionTrackingId)
  609. action := execReqLogEntry.Binding.Action
  610. if action == nil {
  611. log.Warnf("Restarting execution request not possible - action not found: %v", execReqLogEntry.ActionTitle)
  612. return connect.NewResponse(ret), nil
  613. }
  614. return api.StartAction(ctx, &connect.Request[apiv1.StartActionRequest]{
  615. Msg: &apiv1.StartActionRequest{
  616. // FIXME
  617. UniqueTrackingId: req.Msg.ExecutionTrackingId,
  618. },
  619. })
  620. }
  621. func newServer(ex *executor.Executor) *oliveTinAPI {
  622. server := oliveTinAPI{}
  623. server.cfg = ex.Cfg
  624. server.executor = ex
  625. ex.AddListener(&server)
  626. return &server
  627. }
  628. func GetNewHandler(ex *executor.Executor) (string, http.Handler) {
  629. server := newServer(ex)
  630. return apiv1connect.NewOliveTinApiServiceHandler(server)
  631. }