wip: API for projects and boards

models/fixtures/project.yml

@@ -8,6 +8,16 @@
   board_type: 1
   type: 2
 
+-
+  id: 4
+  title: Fourth project
+  description: This is fourth project
+  repo_id: 1
+  is_closed: true
+  creator_id: 2
+  board_type: 1
+  type: 2
+
 -
   id: 2
   title: second project

models/project/board.go

@@ -9,6 +9,7 @@ import (
 	"regexp"
 
 	"code.gitea.io/gitea/models/db"
+	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/timeutil"
 
@@ -56,8 +57,10 @@ type Board struct {
 	Sorting int8   `xorm:"NOT NULL DEFAULT 0"`
 	Color   string `xorm:"VARCHAR(7)"`
 
-	ProjectID int64 `xorm:"INDEX NOT NULL"`
-	CreatorID int64 `xorm:"NOT NULL"`
+	ProjectID int64            `xorm:"INDEX NOT NULL"`
+	Project   *Project         `xorm:"-"`
+	CreatorID int64            `xorm:"NOT NULL"`
+	Creator   *user_model.User `xorm:"-"`
 
 	CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
 	UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
@@ -244,6 +247,22 @@ func GetBoards(ctx context.Context, projectID int64) (BoardList, error) {
 	return append([]*Board{defaultB}, boards...), nil
 }
 
+func GetBoardsAndCount(ctx context.Context, projectID int64) (BoardList, int64, error) {
+	engine := db.GetEngine(ctx)
+	boards := make([]*Board, 0, 10)
+
+	defaultB, err := getDefaultBoard(ctx, projectID)
+	if err != nil {
+		return nil, 0, err
+	}
+
+	count, err := engine.Where("project_id=? AND `default`=?", projectID, false).OrderBy("Sorting").FindAndCount(&boards)
+	if err != nil {
+		return nil, 0, err
+	}
+	return append([]*Board{defaultB}, boards...), count + 1, nil
+}
+
 // getDefaultBoard return default board and create a dummy if none exist
 func getDefaultBoard(ctx context.Context, projectID int64) (*Board, error) {
 	var board Board
@@ -294,3 +313,60 @@ func UpdateBoardSorting(bs BoardList) error {
 	}
 	return nil
 }
+
+// LoadBoardCreator load creator of project board.
+func (b *Board) LoadBoardCreator(ctx context.Context) (err error) {
+	if b.Creator == nil {
+		b.Creator, err = user_model.GetUserByID(ctx, b.CreatorID)
+		if err != nil {
+			return fmt.Errorf("getUserByID [%d]: %v", b.CreatorID, err)
+		}
+	}
+	return nil
+}
+
+// LoadProject load project of project board.
+func (b *Board) LoadProject(ctx context.Context) (err error) {
+	if b.Project == nil {
+		b.Project, err = GetProjectByID(ctx, b.ProjectID)
+		if err != nil {
+			return fmt.Errorf("getProjectByID [%d]: %v", b.CreatorID, err)
+		}
+	}
+	return nil
+}
+
+// LoadAttributes load projects and creators of project boards.
+func (bl BoardList) LoadAttributes(ctx context.Context) (err error) {
+	creators := make(map[int64]*user_model.User)
+	projects := make(map[int64]*Project)
+	var ok bool
+
+	for i := range bl {
+		if bl[i].Project == nil {
+			bl[i].Project, ok = projects[bl[i].ProjectID]
+			if !ok {
+				project, err := GetProjectByID(ctx, bl[i].ProjectID)
+				if err != nil {
+					return fmt.Errorf("getProjectByID [%d]: %v", bl[i].ProjectID, err)
+				}
+				bl[i].Project = project
+				projects[bl[i].ProjectID] = project
+			}
+		}
+
+		if bl[i].Creator == nil {
+			bl[i].Creator, ok = creators[bl[i].CreatorID]
+			if !ok {
+				creator, err := user_model.GetUserByID(ctx, bl[i].CreatorID)
+				if err != nil {
+					return fmt.Errorf("getUserByID [%d]: %v", bl[i].CreatorID, err)
+				}
+				bl[i].Creator = creator
+				creators[bl[i].CreatorID] = creator
+			}
+		}
+	}
+
+	return nil
+}

models/project/project.go

@@ -85,6 +85,9 @@ func (err ErrProjectBoardNotExist) Unwrap() error {
 	return util.ErrNotExist
 }
 
+// List is a list of projects
+// type List []*Project
+
 // Project represents a project board
 type Project struct {
 	ID          int64                  `xorm:"pk autoincr"`
@@ -95,6 +98,7 @@ type Project struct {
 	RepoID      int64                  `xorm:"INDEX"`
 	Repo        *repo_model.Repository `xorm:"-"`
 	CreatorID   int64                  `xorm:"NOT NULL"`
+	Creator     *user_model.User       `xorm:"-"`
 	IsClosed    bool                   `xorm:"INDEX"`
 	BoardType   BoardType
 	CardType    CardType
@@ -115,15 +119,6 @@ func (p *Project) LoadOwner(ctx context.Context) (err error) {
 	return err
 }
 
-func (p *Project) LoadRepo(ctx context.Context) (err error) {
-	if p.RepoID == 0 || p.Repo != nil {
-		return nil
-	}
-	p.Repo, err = repo_model.GetRepositoryByID(ctx, p.RepoID)
-	return err
-}
-
-// Link returns the project's relative URL.
 func (p *Project) Link() string {
 	if p.OwnerID > 0 {
 		err := p.LoadOwner(db.DefaultContext)
@@ -418,6 +413,28 @@ func DeleteProjectByID(ctx context.Context, id int64) error {
 	})
 }
 
+// LoadRepo load repo of the project.
+func (p *Project) LoadRepo(ctx context.Context) (err error) {
+	if p.Repo == nil {
+		p.Repo, err = repo_model.GetRepositoryByID(ctx, p.RepoID)
+		if err != nil {
+			return fmt.Errorf("getRepositoryByID [%d]: %v", p.RepoID, err)
+		}
+	}
+	return nil
+}
+
+// LoadCreator load creator of the project.
+func (p *Project) LoadCreator(ctx context.Context) (err error) {
+	if p.Creator == nil {
+		p.Creator, err = user_model.GetUserByID(ctx, p.CreatorID)
+		if err != nil {
+			return fmt.Errorf("getUserByID [%d]: %v", p.CreatorID, err)
+		}
+	}
+	return nil
+}
+
 func DeleteProjectByRepoID(ctx context.Context, repoID int64) error {
 	switch {
 	case setting.Database.Type.IsSQLite3():

models/project/project_list.go

@@ -0,0 +1,49 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+package project
+
+import (
+	"context"
+	"fmt"
+
+	repo_model "code.gitea.io/gitea/models/repo"
+	user_model "code.gitea.io/gitea/models/user"
+)
+
+// List is a list of projects
+type List []*Project
+
+// LoadAttributes load repos and creators of projects.
+func (pl List) LoadAttributes(ctx context.Context) (err error) {
+	repos := make(map[int64]*repo_model.Repository)
+	creators := make(map[int64]*user_model.User)
+	var ok bool
+
+	for i := range pl {
+		if pl[i].Repo == nil {
+			pl[i].Repo, ok = repos[pl[i].RepoID]
+			if !ok {
+				repo, err := repo_model.GetRepositoryByID(ctx, pl[i].RepoID)
+				if err != nil {
+					return fmt.Errorf("getRepositoryByID [%d]: %v", pl[i].RepoID, err)
+				}
+				pl[i].Repo = repo
+				repos[pl[i].RepoID] = repo
+			}
+		}
+
+		if pl[i].Creator == nil {
+			pl[i].Creator, ok = creators[pl[i].CreatorID]
+			if !ok {
+				creator, err := user_model.GetUserByID(ctx, pl[i].CreatorID)
+				if err != nil {
+					return fmt.Errorf("getUserByID [%d]: %v", pl[i].CreatorID, err)
+				}
+				pl[i].Creator = creator
+				creators[pl[i].CreatorID] = creator
+			}
+		}
+	}
+
+	return nil
+}

models/project/project_test.go

@@ -37,8 +37,8 @@ func TestGetProjects(t *testing.T) {
 	projects, _, err := FindProjects(db.DefaultContext, SearchOptions{RepoID: 1})
 	assert.NoError(t, err)
 
-	// 1 value for this repo exists in the fixtures
-	assert.Len(t, projects, 1)
+	// this repo has two projects in the fixtures
+	assert.Len(t, projects, 2)
 
 	projects, _, err = FindProjects(db.DefaultContext, SearchOptions{RepoID: 3})
 	assert.NoError(t, err)

modules/structs/project.go

@@ -0,0 +1,68 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package structs
+
+import "time"
+
+// swagger:model
+type NewProjectPayload struct {
+	// required:true
+	Title string `json:"title" binding:"Required"`
+	// required:true
+	BoardType   uint8  `json:"board_type"`
+	Description string `json:"description"`
+}
+
+// swagger:model
+type UpdateProjectPayload struct {
+	// required:true
+	Title       string `json:"title" binding:"Required"`
+	Description string `json:"description"`
+}
+
+type Project struct {
+	ID          int64  `json:"id"`
+	Title       string `json:"title"`
+	Description string `json:"description"`
+	BoardType   uint8  `json:"board_type"`
+	IsClosed    bool   `json:"is_closed"`
+	// swagger:strfmt date-time
+	Created time.Time `json:"created_at"`
+	// swagger:strfmt date-time
+	Updated time.Time `json:"updated_at"`
+	// swagger:strfmt date-time
+	Closed time.Time `json:"closed_at"`
+
+	Repo    *RepositoryMeta `json:"repository"`
+	Creator *User           `json:"creator"`
+}
+
+type ProjectBoard struct {
+	ID      int64    `json:"id"`
+	Title   string   `json:"title"`
+	Default bool     `json:"default"`
+	Color   string   `json:"color"`
+	Sorting int8     `json:"sorting"`
+	Project *Project `json:"project"`
+	Creator *User    `json:"creator"`
+	// swagger:strfmt date-time
+	Created time.Time `json:"created_at"`
+	// swagger:strfmt date-time
+	Updated time.Time `json:"updated_at"`
+}
+
+// swagger:model
+type NewProjectBoardPayload struct {
+	// required:true
+	Title   string `json:"title"`
+	Default bool   `json:"default"`
+	Color   string `json:"color"`
+	Sorting int8   `json:"sorting"`
+}
+
+// swagger:model
+type UpdateProjectBoardPayload struct {
+	Title string `json:"title"`
+	Color string `json:"color"`
+}

routers/api/v1/api.go

@@ -1036,6 +1036,11 @@ func Routes(ctx gocontext.Context) *web.Route {
 							Delete(reqToken(auth_model.AccessTokenScopeRepo), bind(api.IssueMeta{}), repo.RemoveIssueBlocking)
 					})
 				}, mustEnableIssuesOrPulls)
+				m.Group("/projects", func() {
+					m.Combo("").
+						Get(reqToken(auth_model.AccessTokenScopeRepo), repo.ListRepositoryProjects).
+						Post(reqToken(auth_model.AccessTokenScopeRepo), mustNotBeArchived, bind(api.NewProjectPayload{}), repo.CreateRepositoryProject)
+				})
 				m.Group("/labels", func() {
 					m.Combo("").Get(repo.ListLabels).
 						Post(reqToken(auth_model.AccessTokenScopeRepo), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.CreateLabelOption{}), repo.CreateLabel)
@@ -1293,6 +1298,27 @@ func Routes(ctx gocontext.Context) *web.Route {
 		m.Group("/topics", func() {
 			m.Get("/search", repo.TopicSearch)
 		})
+
+		// Projects
+		m.Group("/projects", func() {
+			m.Group("/{id}", func() {
+				m.Combo("").
+					Get(reqToken(auth_model.AccessTokenScopeRepo), reqRepoReader(unit.TypeProjects), repo.GetProject).
+					Patch(reqToken(auth_model.AccessTokenScopeRepo), reqRepoWriter(unit.TypeProjects), bind(api.UpdateProjectPayload{}), repo.UpdateProject).
+					Delete(reqToken(auth_model.AccessTokenScopeRepo), reqRepoWriter(unit.TypeProjects), repo.DeleteProject)
+
+				m.Combo("/boards").
+					Post(reqToken(auth_model.AccessTokenScopeRepo), reqRepoWriter(unit.TypeProjects), bind(api.NewProjectBoardPayload{}), repo.CreateProjectBoard).
+					Get(reqToken(auth_model.AccessTokenScopeRepo), reqRepoReader(unit.TypeProjects), repo.ListProjectBoards)
+			})
+
+			m.Group("/boards", func() {
+				m.Combo("/{id}").
+					Get(reqToken(auth_model.AccessTokenScopeRepo), repo.GetProjectBoard).
+					Patch(reqToken(auth_model.AccessTokenScopeRepo), bind(api.UpdateProjectBoardPayload{}), repo.UpdateProjectBoard).
+					Delete(reqToken(auth_model.AccessTokenScopeRepo), repo.DeleteProjectBoard)
+			})
+		})
 	}, sudo())
 
 	return m