// Copyright 2020 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT package project import ( "context" "fmt" "html/template" "code.gitea.io/gitea/models/db" repo_model "code.gitea.io/gitea/models/repo" user_model "code.gitea.io/gitea/models/user" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/optional" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/timeutil" "code.gitea.io/gitea/modules/util" "xorm.io/builder" ) type ( // BoardConfig is used to identify the type of board that is being created BoardConfig struct { BoardType BoardType Translation string } // CardConfig is used to identify the type of board card that is being used CardConfig struct { CardType CardType Translation string } // Type is used to identify the type of project in question and ownership Type uint8 ) const ( // TypeIndividual is a type of project board that is owned by an individual TypeIndividual Type = iota + 1 // TypeRepository is a project that is tied to a repository TypeRepository // TypeOrganization is a project that is tied to an organisation TypeOrganization ) // ErrProjectNotExist represents a "ProjectNotExist" kind of error. type ErrProjectNotExist struct { ID int64 RepoID int64 } // IsErrProjectNotExist checks if an error is a ErrProjectNotExist func IsErrProjectNotExist(err error) bool { _, ok := err.(ErrProjectNotExist) return ok } func (err ErrProjectNotExist) Error() string { return fmt.Sprintf("projects does not exist [id: %d]", err.ID) } func (err ErrProjectNotExist) Unwrap() error { return util.ErrNotExist } // ErrProjectBoardNotExist represents a "ProjectBoardNotExist" kind of error. type ErrProjectBoardNotExist struct { BoardID int64 } // IsErrProjectBoardNotExist checks if an error is a ErrProjectBoardNotExist func IsErrProjectBoardNotExist(err error) bool { _, ok := err.(ErrProjectBoardNotExist) return ok } func (err ErrProjectBoardNotExist) Error() string { return fmt.Sprintf("project board does not exist [id: %d]", err.BoardID) } func (err ErrProjectBoardNotExist) Unwrap() error { return util.ErrNotExist } // Project represents a project board type Project struct { ID int64 `xorm:"pk autoincr"` Title string `xorm:"INDEX NOT NULL"` Description string `xorm:"TEXT"` OwnerID int64 `xorm:"INDEX"` Owner *user_model.User `xorm:"-"` RepoID int64 `xorm:"INDEX"` Repo *repo_model.Repository `xorm:"-"` CreatorID int64 `xorm:"NOT NULL"` IsClosed bool `xorm:"INDEX"` BoardType BoardType CardType CardType Type Type RenderedContent template.HTML `xorm:"-"` CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"` UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"` ClosedDateUnix timeutil.TimeStamp } // Ghost Project is a project which has been deleted const GhostProjectID = -1 func (p *Project) IsGhost() bool { return p.ID == GhostProjectID } func (p *Project) LoadOwner(ctx context.Context) (err error) { if p.Owner != nil { return nil } p.Owner, err = user_model.GetUserByID(ctx, p.OwnerID) 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(ctx context.Context) string { if p.OwnerID > 0 { err := p.LoadOwner(ctx) if err != nil { log.Error("LoadOwner: %v", err) return "" } return fmt.Sprintf("%s/-/projects/%d", p.Owner.HomeLink(), p.ID) } if p.RepoID > 0 { err := p.LoadRepo(ctx) if err != nil { log.Error("LoadRepo: %v", err) return "" } return fmt.Sprintf("%s/projects/%d", p.Repo.Link(), p.ID) } return "" } func (p *Project) IconName() string { if p.IsRepositoryProject() { return "octicon-project" } return "octicon-project-symlink" } func (p *Project) IsOrganizationProject() bool { return p.Type == TypeOrganization } func (p *Project) IsRepositoryProject() bool { return p.Type == TypeRepository } func (p *Project) CanBeAccessedByOwnerRepo(ownerID int64, repo *repo_model.Repository) bool { if p.Type == TypeRepository { return repo != nil && p.RepoID == repo.ID // if a project belongs to a repository, then its OwnerID is 0 and can be ignored } return p.OwnerID == ownerID && p.RepoID == 0 } func init() { db.RegisterModel(new(Project)) } // GetBoardConfig retrieves the types of configurations project boards could have func GetBoardConfig() []BoardConfig { return []BoardConfig{ {BoardTypeNone, "repo.projects.type.none"}, {BoardTypeBasicKanban, "repo.projects.type.basic_kanban"}, {BoardTypeBugTriage, "repo.projects.type.bug_triage"}, } } // GetCardConfig retrieves the types of configurations project board cards could have func GetCardConfig() []CardConfig { return []CardConfig{ {CardTypeTextOnly, "repo.projects.card_type.text_only"}, {CardTypeImagesAndText, "repo.projects.card_type.images_and_text"}, } } // IsTypeValid checks if a project type is valid func IsTypeValid(p Type) bool { switch p { case TypeIndividual, TypeRepository, TypeOrganization: return true default: return false } } // SearchOptions are options for GetProjects type SearchOptions struct { db.ListOptions OwnerID int64 RepoID int64 IsClosed optional.Option[bool] OrderBy db.SearchOrderBy Type Type Title string } func (opts SearchOptions) ToConds() builder.Cond { cond := builder.NewCond() if opts.RepoID > 0 { cond = cond.And(builder.Eq{"repo_id": opts.RepoID}) } if opts.IsClosed.Has() { cond = cond.And(builder.Eq{"is_closed": opts.IsClosed.Value()}) } if opts.Type > 0 { cond = cond.And(builder.Eq{"type": opts.Type}) } if opts.OwnerID > 0 { cond = cond.And(builder.Eq{"owner_id": opts.OwnerID}) } if len(opts.Title) != 0 { cond = cond.And(db.BuildCaseInsensitiveLike("title", opts.Title)) } return cond } func (opts SearchOptions) ToOrders() string { return opts.OrderBy.String() } func GetSearchOrderByBySortType(sortType string) db.SearchOrderBy { switch sortType { case "oldest": return db.SearchOrderByOldest case "recentupdate": return db.SearchOrderByRecentUpdated case "leastupdate": return db.SearchOrderByLeastUpdated default: return db.SearchOrderByNewest } } // NewProject creates a new Project // The title will be cut off at 255 characters if it's longer than 255 characters. func NewProject(ctx context.Context, p *Project) error { if !IsBoardTypeValid(p.BoardType) { p.BoardType = BoardTypeNone } if !IsCardTypeValid(p.CardType) { p.CardType = CardTypeTextOnly } if !IsTypeValid(p.Type) { return util.NewInvalidArgumentErrorf("project type is not valid") } ctx, committer, err := db.TxContext(ctx) if err != nil { return err } defer committer.Close() p.Title, _ = util.SplitStringAtByteN(p.Title, 255) if err := db.Insert(ctx, p); err != nil { return err } if p.RepoID > 0 { if _, err := db.Exec(ctx, "UPDATE `repository` SET num_projects = num_projects + 1 WHERE id = ?", p.RepoID); err != nil { return err } } if err := createBoardsForProjectsType(ctx, p); err != nil { return err } return committer.Commit() } // GetProjectByID returns the projects in a repository func GetProjectByID(ctx context.Context, id int64) (*Project, error) { p := new(Project) has, err := db.GetEngine(ctx).ID(id).Get(p) if err != nil { return nil, err } else if !has { return nil, ErrProjectNotExist{ID: id} } return p, nil } // GetProjectForRepoByID returns the projects in a repository func GetProjectForRepoByID(ctx context.Context, repoID, id int64) (*Project, error) { p := new(Project) has, err := db.GetEngine(ctx).Where("id=? AND repo_id=?", id, repoID).Get(p) if err != nil { return nil, err } else if !has { return nil, ErrProjectNotExist{ID: id} } return p, nil } // GetAllProjectsIDsByOwnerID returns the all projects ids it owns func GetAllProjectsIDsByOwnerIDAndType(ctx context.Context, ownerID int64, projectType Type) ([]int64, error) { projects := make([]int64, 0) return projects, db.GetEngine(ctx).Table(&Project{}).Where("owner_id=? AND type=?", ownerID, projectType).Cols("id").Find(&projects) } // UpdateProject updates project properties func UpdateProject(ctx context.Context, p *Project) error { if !IsCardTypeValid(p.CardType) { p.CardType = CardTypeTextOnly } p.Title, _ = util.SplitStringAtByteN(p.Title, 255) _, err := db.GetEngine(ctx).ID(p.ID).Cols( "title", "description", "card_type", ).Update(p) return err } func updateRepositoryProjectCount(ctx context.Context, repoID int64) error { if _, err := db.GetEngine(ctx).Exec(builder.Update( builder.Eq{ "`num_projects`": builder.Select("count(*)").From("`project`"). Where(builder.Eq{"`project`.`repo_id`": repoID}. And(builder.Eq{"`project`.`type`": TypeRepository})), }).From("`repository`").Where(builder.Eq{"id": repoID})); err != nil { return err } if _, err := db.GetEngine(ctx).Exec(builder.Update( builder.Eq{ "`num_closed_projects`": builder.Select("count(*)").From("`project`"). Where(builder.Eq{"`project`.`repo_id`": repoID}. And(builder.Eq{"`project`.`type`": TypeRepository}). And(builder.Eq{"`project`.`is_closed`": true})), }).From("`repository`").Where(builder.Eq{"id": repoID})); err != nil { return err } return nil } // ChangeProjectStatusByRepoIDAndID toggles a project between opened and closed func ChangeProjectStatusByRepoIDAndID(ctx context.Context, repoID, projectID int64, isClosed bool) error { ctx, committer, err := db.TxContext(ctx) if err != nil { return err } defer committer.Close() p := new(Project) has, err := db.GetEngine(ctx).ID(projectID).Where("repo_id = ?", repoID).Get(p) if err != nil { return err } else if !has { return ErrProjectNotExist{ID: projectID, RepoID: repoID} } if err := changeProjectStatus(ctx, p, isClosed); err != nil { return err } return committer.Commit() } // ChangeProjectStatus toggle a project between opened and closed func ChangeProjectStatus(ctx context.Context, p *Project, isClosed bool) error { ctx, committer, err := db.TxContext(ctx) if err != nil { return err } defer committer.Close() if err := changeProjectStatus(ctx, p, isClosed); err != nil { return err } return committer.Commit() } func changeProjectStatus(ctx context.Context, p *Project, isClosed bool) error { p.IsClosed = isClosed p.ClosedDateUnix = timeutil.TimeStampNow() count, err := db.GetEngine(ctx).ID(p.ID).Where("repo_id = ? AND is_closed = ?", p.RepoID, !isClosed).Cols("is_closed", "closed_date_unix").Update(p) if err != nil { return err } if count < 1 { return nil } return updateRepositoryProjectCount(ctx, p.RepoID) } // DeleteProjectByID deletes a project from a repository. if it's not in a database // transaction, it will start a new database transaction func DeleteProjectByID(ctx context.Context, id int64) error { return db.WithTx(ctx, func(ctx context.Context) error { p, err := GetProjectByID(ctx, id) if err != nil { if IsErrProjectNotExist(err) { return nil } return err } if err := deleteProjectIssuesByProjectID(ctx, id); err != nil { return err } if err := deleteBoardByProjectID(ctx, id); err != nil { return err } if _, err = db.GetEngine(ctx).ID(p.ID).Delete(new(Project)); err != nil { return err } return updateRepositoryProjectCount(ctx, p.RepoID) }) } func DeleteProjectByRepoID(ctx context.Context, repoID int64) error { switch { case setting.Database.Type.IsSQLite3(): if _, err := db.GetEngine(ctx).Exec("DELETE FROM project_issue WHERE project_issue.id IN (SELECT project_issue.id FROM project_issue INNER JOIN project WHERE project.id = project_issue.project_id AND project.repo_id = ?)", repoID); err != nil { return err } if _, err := db.GetEngine(ctx).Exec("DELETE FROM project_board WHERE project_board.id IN (SELECT project_board.id FROM project_board INNER JOIN project WHERE project.id = project_board.project_id AND project.repo_id = ?)", repoID); err != nil { return err } if _, err := db.GetEngine(ctx).Table("project").Where("repo_id = ? ", repoID).Delete(&Project{}); err != nil { return err } case setting.Database.Type.IsPostgreSQL(): if _, err := db.GetEngine(ctx).Exec("DELETE FROM project_issue USING project WHERE project.id = project_issue.project_id AND project.repo_id = ? ", repoID); err != nil { return err } if _, err := db.GetEngine(ctx).Exec("DELETE FROM project_board USING project WHERE project.id = project_board.project_id AND project.repo_id = ? ", repoID); err != nil { return err } if _, err := db.GetEngine(ctx).Table("project").Where("repo_id = ? ", repoID).Delete(&Project{}); err != nil { return err } default: if _, err := db.GetEngine(ctx).Exec("DELETE project_issue FROM project_issue INNER JOIN project ON project.id = project_issue.project_id WHERE project.repo_id = ? ", repoID); err != nil { return err } if _, err := db.GetEngine(ctx).Exec("DELETE project_board FROM project_board INNER JOIN project ON project.id = project_board.project_id WHERE project.repo_id = ? ", repoID); err != nil { return err } if _, err := db.GetEngine(ctx).Table("project").Where("repo_id = ? ", repoID).Delete(&Project{}); err != nil { return err } } return updateRepositoryProjectCount(ctx, repoID) }