7e9446ea07
fix copyright date Add more user tests More user tests More user tests Start refactoring user tests Docs Fix lint Fix db fixtures init in tests Fix models test Fix loading fixtures Fix ineffasign Fix lint Fix integration tests Fix init of test engine creation Fix user related tests Better handling of creating test enging Moved all fixtures to db package Moved all fixtures to db package Moved user related stuff to seperate package Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/123
288 lines
8.7 KiB
Go
288 lines
8.7 KiB
Go
// Vikunja is a todo-list application to facilitate your life.
|
|
// Copyright 2018-2020 Vikunja and contributors. All rights reserved.
|
|
//
|
|
// 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.
|
|
//
|
|
// 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.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package models
|
|
|
|
import (
|
|
"code.vikunja.io/api/pkg/metrics"
|
|
"code.vikunja.io/api/pkg/user"
|
|
"code.vikunja.io/web"
|
|
)
|
|
|
|
// Team holds a team object
|
|
type Team struct {
|
|
// The unique, numeric id of this team.
|
|
ID int64 `xorm:"int(11) autoincr not null unique pk" json:"id" param:"team"`
|
|
// The name of this team.
|
|
Name string `xorm:"varchar(250) not null" json:"name" valid:"required,runelength(5|250)" minLength:"5" maxLength:"250"`
|
|
// The team's description.
|
|
Description string `xorm:"longtext null" json:"description"`
|
|
CreatedByID int64 `xorm:"int(11) not null INDEX" json:"-"`
|
|
|
|
// The user who created this team.
|
|
CreatedBy *user.User `xorm:"-" json:"createdBy"`
|
|
// An array of all members in this team.
|
|
Members []*TeamUser `xorm:"-" json:"members"`
|
|
|
|
// A unix timestamp when this relation was created. You cannot change this value.
|
|
Created int64 `xorm:"created" json:"created"`
|
|
// A unix timestamp when this relation was last updated. You cannot change this value.
|
|
Updated int64 `xorm:"updated" json:"updated"`
|
|
|
|
web.CRUDable `xorm:"-" json:"-"`
|
|
web.Rights `xorm:"-" json:"-"`
|
|
}
|
|
|
|
// TableName makes beautiful table names
|
|
func (Team) TableName() string {
|
|
return "teams"
|
|
}
|
|
|
|
// AfterLoad gets the created by user object
|
|
func (t *Team) AfterLoad() {
|
|
// Get the owner
|
|
t.CreatedBy, _ = user.GetUserByID(t.CreatedByID)
|
|
|
|
// Get all members
|
|
x.Select("*").
|
|
Table("users").
|
|
Join("INNER", "team_members", "team_members.user_id = users.id").
|
|
Where("team_id = ?", t.ID).
|
|
Find(&t.Members)
|
|
}
|
|
|
|
// TeamMember defines the relationship between a user and a team
|
|
type TeamMember struct {
|
|
// The unique, numeric id of this team member relation.
|
|
ID int64 `xorm:"int(11) autoincr not null unique pk" json:"id"`
|
|
// The team id.
|
|
TeamID int64 `xorm:"int(11) not null INDEX" json:"-" param:"team"`
|
|
// The username of the member. We use this to prevent automated user id entering.
|
|
Username string `xorm:"-" json:"username" param:"user"`
|
|
// Used under the hood to manage team members
|
|
UserID int64 `xorm:"int(11) not null INDEX" json:"-"`
|
|
// Whether or not the member is an admin of the team. See the docs for more about what a team admin can do
|
|
Admin bool `xorm:"tinyint(1) INDEX null" json:"admin"`
|
|
|
|
// A unix timestamp when this relation was created. You cannot change this value.
|
|
Created int64 `xorm:"created not null" json:"created"`
|
|
|
|
web.CRUDable `xorm:"-" json:"-"`
|
|
web.Rights `xorm:"-" json:"-"`
|
|
}
|
|
|
|
// TableName makes beautiful table names
|
|
func (TeamMember) TableName() string {
|
|
return "team_members"
|
|
}
|
|
|
|
// TeamUser is the team member type
|
|
type TeamUser struct {
|
|
user.User `xorm:"extends"`
|
|
// Whether or not the member is an admin of the team. See the docs for more about what a team admin can do
|
|
Admin bool `json:"admin"`
|
|
}
|
|
|
|
// GetTeamByID gets a team by its ID
|
|
func GetTeamByID(id int64) (team Team, err error) {
|
|
if id < 1 {
|
|
return team, ErrTeamDoesNotExist{id}
|
|
}
|
|
|
|
exists, err := x.Where("id = ?", id).Get(&team)
|
|
if err != nil {
|
|
return
|
|
}
|
|
if !exists {
|
|
return team, ErrTeamDoesNotExist{id}
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
// ReadOne implements the CRUD method to get one team
|
|
// @Summary Gets one team
|
|
// @Description Returns a team by its ID.
|
|
// @tags team
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param id path int true "Team ID"
|
|
// @Success 200 {object} models.Team "The team"
|
|
// @Failure 403 {object} code.vikunja.io/web.HTTPError "The user does not have access to the team"
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /lists/{id} [get]
|
|
func (t *Team) ReadOne() (err error) {
|
|
*t, err = GetTeamByID(t.ID)
|
|
return
|
|
}
|
|
|
|
// ReadAll gets all teams the user is part of
|
|
// @Summary Get teams
|
|
// @Description Returns all teams the current user is part of.
|
|
// @tags team
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param page query int false "The page number. Used for pagination. If not provided, the first page of results is returned."
|
|
// @Param per_page query int false "The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page."
|
|
// @Param s query string false "Search teams by its name."
|
|
// @Security JWTKeyAuth
|
|
// @Success 200 {array} models.Team "The teams."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /teams [get]
|
|
func (t *Team) ReadAll(a web.Auth, search string, page int, perPage int) (result interface{}, resultCount int, numberOfTotalItems int64, err error) {
|
|
if _, is := a.(*LinkSharing); is {
|
|
return nil, 0, 0, ErrGenericForbidden{}
|
|
}
|
|
|
|
all := []*Team{}
|
|
err = x.Select("teams.*").
|
|
Table("teams").
|
|
Join("INNER", "team_members", "team_members.team_id = teams.id").
|
|
Where("team_members.user_id = ?", a.GetID()).
|
|
Limit(getLimitFromPageIndex(page, perPage)).
|
|
Where("teams.name LIKE ?", "%"+search+"%").
|
|
Find(&all)
|
|
if err != nil {
|
|
return nil, 0, 0, err
|
|
}
|
|
|
|
numberOfTotalItems, err = x.
|
|
Table("teams").
|
|
Join("INNER", "team_members", "team_members.team_id = teams.id").
|
|
Where("team_members.user_id = ?", a.GetID()).
|
|
Where("teams.name LIKE ?", "%"+search+"%").
|
|
Count(&Team{})
|
|
return all, len(all), numberOfTotalItems, err
|
|
}
|
|
|
|
// Create is the handler to create a team
|
|
// @Summary Creates a new team
|
|
// @Description Creates a new team in a given namespace. The user needs write-access to the namespace.
|
|
// @tags team
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param team body models.Team true "The team you want to create."
|
|
// @Success 200 {object} models.Team "The created team."
|
|
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Invalid team object provided."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /teams [put]
|
|
func (t *Team) Create(a web.Auth) (err error) {
|
|
doer, err := user.GetFromAuth(a)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Check if we have a name
|
|
if t.Name == "" {
|
|
return ErrTeamNameCannotBeEmpty{}
|
|
}
|
|
|
|
t.CreatedByID = doer.ID
|
|
t.CreatedBy = doer
|
|
|
|
_, err = x.Insert(t)
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
// Insert the current user as member and admin
|
|
tm := TeamMember{TeamID: t.ID, Username: doer.Username, Admin: true}
|
|
if err = tm.Create(doer); err != nil {
|
|
return err
|
|
}
|
|
|
|
metrics.UpdateCount(1, metrics.TeamCountKey)
|
|
return
|
|
}
|
|
|
|
// Delete deletes a team
|
|
// @Summary Deletes a team
|
|
// @Description Delets a team. This will also remove the access for all users in that team.
|
|
// @tags team
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param id path int true "Team ID"
|
|
// @Success 200 {object} models.Message "The team was successfully deleted."
|
|
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Invalid team object provided."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /teams/{id} [delete]
|
|
func (t *Team) Delete() (err error) {
|
|
|
|
// Delete the team
|
|
_, err = x.ID(t.ID).Delete(&Team{})
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
// Delete team members
|
|
_, err = x.Where("team_id = ?", t.ID).Delete(&TeamMember{})
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
// Delete team <-> namespace relations
|
|
_, err = x.Where("team_id = ?", t.ID).Delete(&TeamNamespace{})
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
// Delete team <-> lists relations
|
|
_, err = x.Where("team_id = ?", t.ID).Delete(&TeamList{})
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
metrics.UpdateCount(-1, metrics.TeamCountKey)
|
|
return
|
|
}
|
|
|
|
// Update is the handler to create a team
|
|
// @Summary Updates a team
|
|
// @Description Updates a team.
|
|
// @tags team
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Param id path int true "Team ID"
|
|
// @Param team body models.Team true "The team with updated values you want to update."
|
|
// @Success 200 {object} models.Team "The updated team."
|
|
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Invalid team object provided."
|
|
// @Failure 500 {object} models.Message "Internal error"
|
|
// @Router /teams/{id} [post]
|
|
func (t *Team) Update() (err error) {
|
|
// Check if we have a name
|
|
if t.Name == "" {
|
|
return ErrTeamNameCannotBeEmpty{}
|
|
}
|
|
|
|
// Check if the team exists
|
|
_, err = GetTeamByID(t.ID)
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
_, err = x.ID(t.ID).Update(t)
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
// Get the newly updated team
|
|
*t, err = GetTeamByID(t.ID)
|
|
|
|
return
|
|
}
|