vikunja-api/pkg/models/namespace.go

160 lines
4.4 KiB
Go
Raw Normal View History

package models
// Namespace holds informations about a namespace
type Namespace struct {
2018-07-21 15:08:46 +02:00
ID int64 `xorm:"int(11) autoincr not null unique pk" json:"id" param:"namespace"`
2018-11-17 00:17:37 +01:00
Name string `xorm:"varchar(250)" json:"name" valid:"required,runelength(5|250)"`
Description string `xorm:"varchar(1000)" json:"description" valid:"runelength(0|250)"`
2018-10-05 18:46:01 +02:00
OwnerID int64 `xorm:"int(11) not null INDEX" json:"-"`
Owner User `xorm:"-" json:"owner"`
2018-06-14 17:43:00 +02:00
2018-11-17 00:17:37 +01:00
Created int64 `xorm:"created" json:"created" valid:"range(0|0)"`
Updated int64 `xorm:"updated" json:"updated" valid:"range(0|0)"`
CRUDable `xorm:"-" json:"-"`
2018-07-10 14:02:23 +02:00
Rights `xorm:"-" json:"-"`
}
// TableName makes beautiful table names
func (Namespace) TableName() string {
return "namespaces"
}
2018-07-10 14:02:23 +02:00
// GetNamespaceByID returns a namespace object by its ID
2018-07-04 08:15:47 +02:00
func GetNamespaceByID(id int64) (namespace Namespace, err error) {
if id < 1 {
return namespace, ErrNamespaceDoesNotExist{ID: id}
}
namespace.ID = id
2018-07-04 08:15:47 +02:00
exists, err := x.Get(&namespace)
if err != nil {
return namespace, err
}
if !exists {
return namespace, ErrNamespaceDoesNotExist{ID: id}
}
// Get the namespace Owner
2018-08-30 19:14:02 +02:00
namespace.Owner, err = GetUserByID(namespace.OwnerID)
if err != nil {
return namespace, err
}
return namespace, err
}
// ReadOne gets one namespace
// @Summary Gets one namespace
// @Description Returns a namespace by its ID.
// @tags namespace
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path int true "Namespace ID"
// @Success 200 {object} models.Namespace "The Namespace"
// @Failure 403 {object} models.HTTPError "The user does not have access to that namespace."
// @Failure 500 {object} models.Message "Internal error"
// @Router /namespaces/{id} [get]
2018-07-21 15:08:46 +02:00
func (n *Namespace) ReadOne() (err error) {
2018-10-05 19:17:39 +02:00
*n, err = GetNamespaceByID(n.ID)
return
}
// NamespaceWithLists represents a namespace with list meta informations
type NamespaceWithLists struct {
Namespace `xorm:"extends"`
Lists []*List `xorm:"-" json:"lists"`
}
// ReadAll gets all namespaces a user has access to
// @Summary Get all namespaces a user has access to
// @Description Returns all namespaces a user has access to.
// @tags namespace
// @Accept json
// @Produce json
// @Param p query int false "The page number. Used for pagination. If not provided, the first page of results is returned."
// @Param s query string false "Search namespaces by name."
// @Security ApiKeyAuth
// @Success 200 {array} models.NamespaceWithLists "The Namespaces."
// @Failure 500 {object} models.Message "Internal error"
// @Router /namespaces [get]
func (n *Namespace) ReadAll(search string, doer *User, page int) (interface{}, error) {
all := []*NamespaceWithLists{}
err := x.Select("namespaces.*").
Table("namespaces").
Join("LEFT", "team_namespaces", "namespaces.id = team_namespaces.namespace_id").
Join("LEFT", "team_members", "team_members.team_id = team_namespaces.team_id").
2018-09-06 08:46:34 +02:00
Join("LEFT", "users_namespace", "users_namespace.namespace_id = namespaces.id").
Where("team_members.user_id = ?", doer.ID).
Or("namespaces.owner_id = ?", doer.ID).
2018-09-06 08:46:34 +02:00
Or("users_namespace.user_id = ?", doer.ID).
GroupBy("namespaces.id").
2018-11-09 11:30:17 +01:00
Limit(getLimitFromPageIndex(page)).
Where("namespaces.name LIKE ?", "%"+search+"%").
Find(&all)
if err != nil {
return all, err
}
// Get all users
users := []*User{}
err = x.Select("users.*").
Table("namespaces").
Join("LEFT", "team_namespaces", "namespaces.id = team_namespaces.namespace_id").
Join("LEFT", "team_members", "team_members.team_id = team_namespaces.team_id").
Join("INNER", "users", "users.id = namespaces.owner_id").
Where("team_members.user_id = ?", doer.ID).
Or("namespaces.owner_id = ?", doer.ID).
GroupBy("users.id").
Find(&users)
if err != nil {
return all, err
}
2018-09-17 07:27:49 +02:00
// Make a list of namespace ids
var namespaceids []int64
for _, nsp := range all {
namespaceids = append(namespaceids, nsp.ID)
}
// Get all lists
lists := []*List{}
err = x.Table(&lists).
In("namespace_id", namespaceids).
Find(&lists)
if err != nil {
return all, err
}
// More details for the lists
2018-10-31 13:42:38 +01:00
AddListDetails(lists)
2018-09-17 07:27:49 +02:00
// Put objects in our namespace list
for i, n := range all {
2018-09-17 07:27:49 +02:00
// Users
for _, u := range users {
if n.OwnerID == u.ID {
all[i].Owner = *u
break
}
}
2018-09-17 07:27:49 +02:00
// List infos
for _, l := range lists {
if n.ID == l.NamespaceID {
all[i].Lists = append(all[i].Lists, l)
}
}
}
return all, nil
}