Semaphore/api/projects/tasks.go

198 lines
5.3 KiB
Go
Raw Normal View History

package projects
import (
"github.com/ansible-semaphore/semaphore/api/helpers"
"github.com/ansible-semaphore/semaphore/db"
"github.com/ansible-semaphore/semaphore/util"
2017-02-23 00:21:49 +01:00
"github.com/gorilla/context"
2024-03-09 14:54:27 +01:00
log "github.com/sirupsen/logrus"
"net/http"
"strconv"
)
// AddTask inserts a task into the database and returns a header or returns error
func AddTask(w http.ResponseWriter, r *http.Request) {
project := context.Get(r, "project").(db.Project)
user := context.Get(r, "user").(*db.User)
var taskObj db.Task
if !helpers.Bind(w, r, &taskObj) {
return
}
newTask, err := helpers.TaskPool(r).AddTask(taskObj, &user.ID, project.ID)
if err != nil {
util.LogErrorWithFields(err, log.Fields{"error": "Cannot write new event to database"})
w.WriteHeader(http.StatusInternalServerError)
return
}
2021-04-09 23:02:19 +02:00
helpers.WriteJSON(w, http.StatusCreated, newTask)
}
2018-06-14 08:20:16 +02:00
// GetTasksList returns a list of tasks for the current project in desc order to limit or error
2017-07-25 06:44:09 +02:00
func GetTasksList(w http.ResponseWriter, r *http.Request, limit uint64) {
project := context.Get(r, "project").(db.Project)
2021-03-12 18:41:41 +01:00
tpl := context.Get(r, "template")
2021-03-12 18:41:41 +01:00
var err error
var tasks []db.TaskWithTpl
2020-11-02 11:57:46 +01:00
2021-03-12 18:41:41 +01:00
if tpl != nil {
tasks, err = helpers.Store(r).GetTemplateTasks(tpl.(db.Template).ProjectID, tpl.(db.Template).ID, db.RetrieveQueryParams{
2021-03-12 18:41:41 +01:00
Count: int(limit),
})
2020-11-02 11:57:46 +01:00
} else {
2021-03-12 18:41:41 +01:00
tasks, err = helpers.Store(r).GetProjectTasks(project.ID, db.RetrieveQueryParams{
Count: int(limit),
})
2017-07-25 06:44:09 +02:00
}
2021-03-12 18:41:41 +01:00
if err != nil {
2018-06-14 08:20:16 +02:00
util.LogErrorWithFields(err, log.Fields{"error": "Bad request. Cannot get tasks list from database"})
w.WriteHeader(http.StatusBadRequest)
return
}
helpers.WriteJSON(w, http.StatusOK, tasks)
}
// GetAllTasks returns all tasks for the current project
func GetAllTasks(w http.ResponseWriter, r *http.Request) {
GetTasksList(w, r, 0)
2017-07-25 06:44:09 +02:00
}
// GetLastTasks returns the hundred most recent tasks
func GetLastTasks(w http.ResponseWriter, r *http.Request) {
2021-10-25 22:15:14 +02:00
str := r.URL.Query().Get("limit")
limit, err := strconv.Atoi(str)
2022-01-26 12:52:31 +01:00
if err != nil || limit <= 0 || limit > 200 {
2021-10-25 22:15:14 +02:00
limit = 200
}
GetTasksList(w, r, uint64(limit))
2017-07-25 06:44:09 +02:00
}
// GetTask returns a task based on its id
func GetTask(w http.ResponseWriter, r *http.Request) {
task := context.Get(r, "task").(db.Task)
helpers.WriteJSON(w, http.StatusOK, task)
}
// GetTaskMiddleware is middleware that gets a task by id and sets the context to it or panics
func GetTaskMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2021-03-12 18:41:41 +01:00
project := context.Get(r, "project").(db.Project)
taskID, err := helpers.GetIntParam("task_id", w, r)
2021-03-12 18:41:41 +01:00
if err != nil {
2021-03-12 18:41:41 +01:00
util.LogErrorWithFields(err, log.Fields{"error": "Bad request. Cannot get task_id from request"})
w.WriteHeader(http.StatusBadRequest)
return
}
2021-03-12 18:41:41 +01:00
task, err := helpers.Store(r).GetTask(project.ID, taskID)
if err != nil {
util.LogErrorWithFields(err, log.Fields{"error": "Bad request. Cannot get task from database"})
w.WriteHeader(http.StatusBadRequest)
return
}
context.Set(r, "task", task)
next.ServeHTTP(w, r)
})
}
2018-06-14 08:20:16 +02:00
// GetTaskOutput returns the logged task output by id and writes it as json or returns error
func GetTaskOutput(w http.ResponseWriter, r *http.Request) {
task := context.Get(r, "task").(db.Task)
2021-03-12 18:41:41 +01:00
project := context.Get(r, "project").(db.Project)
var output []db.TaskOutput
2021-03-12 18:41:41 +01:00
output, err := helpers.Store(r).GetTaskOutputs(project.ID, task.ID)
if err != nil {
util.LogErrorWithFields(err, log.Fields{"error": "Bad request. Cannot get task output from database"})
w.WriteHeader(http.StatusBadRequest)
return
}
helpers.WriteJSON(w, http.StatusOK, output)
}
2024-03-09 14:54:27 +01:00
func ConfirmTask(w http.ResponseWriter, r *http.Request) {
targetTask := context.Get(r, "task").(db.Task)
project := context.Get(r, "project").(db.Project)
if targetTask.ProjectID != project.ID {
w.WriteHeader(http.StatusBadRequest)
return
}
err := helpers.TaskPool(r).ConfirmTask(targetTask)
if err != nil {
helpers.WriteError(w, err)
return
}
w.WriteHeader(http.StatusNoContent)
}
2021-08-25 17:37:19 +02:00
func StopTask(w http.ResponseWriter, r *http.Request) {
2021-08-30 21:42:11 +02:00
targetTask := context.Get(r, "task").(db.Task)
project := context.Get(r, "project").(db.Project)
2021-08-25 17:37:19 +02:00
if targetTask.ProjectID != project.ID {
w.WriteHeader(http.StatusBadRequest)
return
}
2021-08-30 21:42:11 +02:00
2023-09-12 20:58:44 +02:00
var stopObj struct {
Force bool `json:"force"`
}
if !helpers.Bind(w, r, &stopObj) {
return
}
err := helpers.TaskPool(r).StopTask(targetTask, stopObj.Force)
if err != nil {
helpers.WriteError(w, err)
return
2021-08-30 21:42:11 +02:00
}
2021-08-25 17:37:19 +02:00
w.WriteHeader(http.StatusNoContent)
}
// RemoveTask removes a task from the database
func RemoveTask(w http.ResponseWriter, r *http.Request) {
targetTask := context.Get(r, "task").(db.Task)
editor := context.Get(r, "user").(*db.User)
2021-03-12 18:41:41 +01:00
project := context.Get(r, "project").(db.Project)
activeTask := helpers.TaskPool(r).GetTask(targetTask.ID)
2021-08-31 14:03:52 +02:00
if activeTask != nil {
// can't delete task in queue or running
// task must be stopped firstly
w.WriteHeader(http.StatusBadRequest)
return
}
if !editor.Admin {
log.Warn(editor.Username + " is not permitted to delete task logs")
w.WriteHeader(http.StatusUnauthorized)
return
}
2021-08-31 14:03:52 +02:00
err := helpers.Store(r).DeleteTaskWithOutputs(project.ID, targetTask.ID)
2021-03-12 18:41:41 +01:00
if err != nil {
util.LogErrorWithFields(err, log.Fields{"error": "Bad request. Cannot delete task from database"})
w.WriteHeader(http.StatusBadRequest)
return
}
w.WriteHeader(http.StatusNoContent)
}