vikunja-api/pkg/models/bulk_task.go

135 lines
3.7 KiB
Go
Raw Normal View History

2020-02-07 17:27:45 +01:00
// Vikunja is a to-do list application to facilitate your life.
2020-01-09 18:33:22 +01:00
// Copyright 2018-2020 Vikunja and contributors. All rights reserved.
2018-12-28 22:49:46 +01:00
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
2018-12-28 22:49:46 +01:00
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
2018-12-28 22:49:46 +01:00
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
2018-12-28 22:49:46 +01:00
package models
import (
"code.vikunja.io/web"
"github.com/imdario/mergo"
)
// BulkTask is the definition of a bulk update task
type BulkTask struct {
2019-01-03 23:22:06 +01:00
// A list of task ids to update
2019-08-14 22:19:04 +02:00
IDs []int64 `json:"task_ids"`
Tasks []*Task `json:"-"`
Task
2018-12-28 22:49:46 +01:00
}
func (bt *BulkTask) checkIfTasksAreOnTheSameList() (err error) {
// Get the tasks
err = bt.GetTasksByIDs()
if err != nil {
return err
}
if len(bt.Tasks) == 0 {
return ErrBulkTasksNeedAtLeastOne{}
}
// Check if all tasks are in the same list
var firstListID = bt.Tasks[0].ListID
for _, t := range bt.Tasks {
if t.ListID != firstListID {
return ErrBulkTasksMustBeInSameList{firstListID, t.ListID}
}
}
return nil
}
// CanUpdate checks if a user is allowed to update a task
2019-03-24 13:35:50 +01:00
func (bt *BulkTask) CanUpdate(a web.Auth) (bool, error) {
2018-12-28 22:49:46 +01:00
err := bt.checkIfTasksAreOnTheSameList()
if err != nil {
2019-03-24 13:35:50 +01:00
return false, err
2018-12-28 22:49:46 +01:00
}
// A user can update an task if he has write acces to its list
l := &List{ID: bt.Tasks[0].ListID}
return l.CanWrite(a)
2018-12-28 22:49:46 +01:00
}
// Update updates a bunch of tasks at once
// @Summary Update a bunch of tasks at once
// @Description Updates a bunch of tasks at once. This includes marking them as done. Note: although you could supply another ID, it will be ignored. Use task_ids instead.
// @tags task
// @Accept json
// @Produce json
2019-01-03 23:22:06 +01:00
// @Security JWTKeyAuth
2018-12-28 22:49:46 +01:00
// @Param task body models.BulkTask true "The task object. Looks like a normal task, the only difference is it uses an array of list_ids to update."
2019-08-14 22:19:04 +02:00
// @Success 200 {object} models.Task "The updated task object."
2020-06-28 16:25:46 +02:00
// @Failure 400 {object} web.HTTPError "Invalid task object provided."
// @Failure 403 {object} web.HTTPError "The user does not have access to the task (aka its list)"
2018-12-28 22:49:46 +01:00
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/bulk [post]
func (bt *BulkTask) Update() (err error) {
sess := x.NewSession()
defer sess.Close()
err = sess.Begin()
if err != nil {
return
}
for _, oldtask := range bt.Tasks {
// When a repeating task is marked as done, we update all deadlines and reminders and set it as undone
2019-08-14 22:19:04 +02:00
updateDone(oldtask, &bt.Task)
2018-12-28 22:49:46 +01:00
2018-12-29 15:29:50 +01:00
// Update the assignees
if err := oldtask.updateTaskAssignees(bt.Assignees); err != nil {
return err
}
2018-12-28 22:49:46 +01:00
// For whatever reason, xorm dont detect if done is updated, so we need to update this every time by hand
// Which is why we merge the actual task struct with the one we got from the
// The user struct overrides values in the actual one.
2019-08-14 22:19:04 +02:00
if err := mergo.Merge(oldtask, &bt.Task, mergo.WithOverride); err != nil {
2018-12-28 22:49:46 +01:00
return err
}
// And because a false is considered to be a null value, we need to explicitly check that case here.
2019-08-14 22:19:04 +02:00
if !bt.Task.Done {
2018-12-28 22:49:46 +01:00
oldtask.Done = false
}
_, err = sess.ID(oldtask.ID).
Cols("title",
2018-12-28 22:49:46 +01:00
"description",
"done",
"due_date",
"reminders",
2018-12-28 22:49:46 +01:00
"repeat_after",
"priority",
"start_date",
"end_date").
2018-12-28 22:49:46 +01:00
Update(oldtask)
if err != nil {
return sess.Rollback()
}
}
err = sess.Commit()
if err != nil {
return
}
return
}