// Vikunja is a to-do list application to facilitate your life. // Copyright 2018-present 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 Affero General Public Licensee 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 Affero General Public Licensee for more details. // // You should have received a copy of the GNU Affero General Public Licensee // along with this program. If not, see . package models import ( "math" "strconv" "strings" "time" "code.vikunja.io/api/pkg/config" "code.vikunja.io/api/pkg/db" "code.vikunja.io/api/pkg/events" "code.vikunja.io/api/pkg/files" "code.vikunja.io/api/pkg/log" "code.vikunja.io/api/pkg/user" "code.vikunja.io/api/pkg/utils" "code.vikunja.io/web" "xorm.io/builder" "xorm.io/xorm" ) // Project represents a project of tasks type Project struct { // The unique, numeric id of this project. ID int64 `xorm:"bigint autoincr not null unique pk" json:"id" param:"project"` // The title of the project. You'll see this in the overview. Title string `xorm:"varchar(250) not null" json:"title" valid:"required,runelength(1|250)" minLength:"1" maxLength:"250"` // The description of the project. Description string `xorm:"longtext null" json:"description"` // The unique project short identifier. Used to build task identifiers. Identifier string `xorm:"varchar(10) null" json:"identifier" valid:"runelength(0|10)" minLength:"0" maxLength:"10"` // The hex color of this project HexColor string `xorm:"varchar(6) null" json:"hex_color" valid:"runelength(0|7)" maxLength:"7"` OwnerID int64 `xorm:"bigint INDEX not null" json:"-"` ParentProjectID int64 `xorm:"bigint INDEX null" json:"parent_project_id"` ParentProject *Project `xorm:"-" json:"-"` // The ID of the bucket where new tasks without a bucket are added to. By default, this is the leftmost bucket in a project. DefaultBucketID int64 `xorm:"bigint INDEX null" json:"default_bucket_id"` // If tasks are moved to the done bucket, they are marked as done. If they are marked as done individually, they are moved into the done bucket. DoneBucketID int64 `xorm:"bigint INDEX null" json:"done_bucket_id"` // The user who created this project. Owner *user.User `xorm:"-" json:"owner" valid:"-"` // Whether a project is archived. IsArchived bool `xorm:"not null default false" json:"is_archived" query:"is_archived"` // The id of the file this project has set as background BackgroundFileID int64 `xorm:"null" json:"-"` // Holds extra information about the background set since some background providers require attribution or similar. If not null, the background can be accessed at /projects/{projectID}/background BackgroundInformation interface{} `xorm:"-" json:"background_information"` // Contains a very small version of the project background to use as a blurry preview until the actual background is loaded. Check out https://blurha.sh/ to learn how it works. BackgroundBlurHash string `xorm:"varchar(50) null" json:"background_blur_hash"` // True if a project is a favorite. Favorite projects show up in a separate parent project. This value depends on the user making the call to the api. IsFavorite bool `xorm:"-" json:"is_favorite"` // The subscription status for the user reading this project. You can only read this property, use the subscription endpoints to modify it. // Will only returned when retreiving one project. Subscription *Subscription `xorm:"-" json:"subscription,omitempty"` // The position this project has when querying all projects. See the tasks.position property on how to use this. Position float64 `xorm:"double null" json:"position"` // A timestamp when this project was created. You cannot change this value. Created time.Time `xorm:"created not null" json:"created"` // A timestamp when this project was last updated. You cannot change this value. Updated time.Time `xorm:"updated not null" json:"updated"` web.CRUDable `xorm:"-" json:"-"` web.Rights `xorm:"-" json:"-"` } type ProjectWithTasksAndBuckets struct { Project ChildProjects []*ProjectWithTasksAndBuckets `xorm:"-" json:"child_projects"` // An array of tasks which belong to the project. Tasks []*TaskWithComments `xorm:"-" json:"tasks"` // Only used for migration. Buckets []*Bucket `xorm:"-" json:"buckets"` BackgroundFileID int64 `xorm:"null" json:"background_file_id"` } // TableName returns a better name for the projects table func (p *Project) TableName() string { return "projects" } // ProjectBackgroundType holds a project background type type ProjectBackgroundType struct { Type string } // ProjectBackgroundUpload represents the project upload background type const ProjectBackgroundUpload string = "upload" // FavoritesPseudoProject holds all tasks marked as favorites var FavoritesPseudoProject = Project{ ID: -1, Title: "Favorites", Description: "This project has all tasks marked as favorites.", IsFavorite: true, Position: -1, Created: time.Now(), Updated: time.Now(), } // ReadAll gets all projects a user has access to // @Summary Get all projects a user has access to // @Description Returns all projects a user has access to. // @tags project // @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 projects by title." // @Param is_archived query bool false "If true, also returns all archived projects." // @Security JWTKeyAuth // @Success 200 {array} models.Project "The projects" // @Failure 403 {object} web.HTTPError "The user does not have access to the project" // @Failure 500 {object} models.Message "Internal error" // @Router /projects [get] func (p *Project) ReadAll(s *xorm.Session, a web.Auth, search string, page int, perPage int) (result interface{}, resultCount int, totalItems int64, err error) { // Check if we're dealing with a share auth shareAuth, ok := a.(*LinkSharing) if ok { project, err := GetProjectSimpleByID(s, shareAuth.ProjectID) if err != nil { return nil, 0, 0, err } projects := []*Project{project} err = addProjectDetails(s, projects, a) return projects, 0, 0, err } doer, err := user.GetFromAuth(a) if err != nil { return nil, 0, 0, err } prs, resultCount, totalItems, err := getRawProjectsForUser( s, &projectOptions{ search: search, user: doer, page: page, perPage: perPage, getArchived: p.IsArchived, }) if err != nil { return nil, 0, 0, err } ///////////////// // Saved Filters savedFiltersProject, err := getSavedFilterProjects(s, doer) if err != nil { return nil, 0, 0, err } if len(savedFiltersProject) > 0 { prs = append(prs, savedFiltersProject...) } ///////////////// // Add project details (favorite state, among other things) err = addProjectDetails(s, prs, a) if err != nil { return } ////////////////////////// // Putting it all together return prs, resultCount, totalItems, err } // ReadOne gets one project by its ID // @Summary Gets one project // @Description Returns a project by its ID. // @tags project // @Accept json // @Produce json // @Security JWTKeyAuth // @Param id path int true "Project ID" // @Success 200 {object} models.Project "The project" // @Failure 403 {object} web.HTTPError "The user does not have access to the project" // @Failure 500 {object} models.Message "Internal error" // @Router /projects/{id} [get] func (p *Project) ReadOne(s *xorm.Session, a web.Auth) (err error) { if p.ID == FavoritesPseudoProject.ID { // Already "built" the project in CanRead return nil } // Check for saved filters filterID := getSavedFilterIDFromProjectID(p.ID) isFilter := filterID > 0 if isFilter { sf, err := getSavedFilterSimpleByID(s, filterID) if err != nil { return err } p.Title = sf.Title p.Description = sf.Description p.Created = sf.Created p.Updated = sf.Updated p.OwnerID = sf.OwnerID } // Get project owner p.Owner, err = user.GetUserByID(s, p.OwnerID) if err != nil { return err } // Check if the project is archived and set it to archived if it is not already archived individually. if !p.IsArchived && !isFilter { err = p.CheckIsArchived(s) if err != nil { p.IsArchived = true } } // Get any background information if there is one set if p.BackgroundFileID != 0 { // Unsplash image p.BackgroundInformation, err = GetUnsplashPhotoByFileID(s, p.BackgroundFileID) if err != nil && !files.IsErrFileIsNotUnsplashFile(err) { return } if err != nil && files.IsErrFileIsNotUnsplashFile(err) { p.BackgroundInformation = &ProjectBackgroundType{Type: ProjectBackgroundUpload} } } p.IsFavorite, err = isFavorite(s, p.ID, a, FavoriteKindProject) if err != nil { return } p.Subscription, err = GetSubscription(s, SubscriptionEntityProject, p.ID, a) if err != nil && IsErrProjectDoesNotExist(err) && isFilter { return nil } return } // GetProjectSimpleByID gets a project with only the basic items, aka no tasks or user objects. Returns an error if the project does not exist. func GetProjectSimpleByID(s *xorm.Session, projectID int64) (project *Project, err error) { project = &Project{} if projectID < 1 { return nil, ErrProjectDoesNotExist{ID: projectID} } exists, err := s. Where("id = ?", projectID). OrderBy("position"). Get(project) if err != nil { return } if !exists { return nil, ErrProjectDoesNotExist{ID: projectID} } return } // GetProjectSimplByTaskID gets a project by a task id func GetProjectSimplByTaskID(s *xorm.Session, taskID int64) (l *Project, err error) { // We need to re-init our project object, because otherwise xorm creates a "where for every item in that project object, // leading to not finding anything if the id is good, but for example the title is different. var project Project exists, err := s. Select("projects.*"). Table(Project{}). Join("INNER", "tasks", "projects.id = tasks.project_id"). Where("tasks.id = ?", taskID). Get(&project) if err != nil { return } if !exists { return &Project{}, ErrProjectDoesNotExist{ID: l.ID} } return &project, nil } // GetProjectsSimplByTaskIDs gets a list of projects by a task ids func GetProjectsSimplByTaskIDs(s *xorm.Session, taskIDs []int64) (ps map[int64]*Project, err error) { ps = make(map[int64]*Project) err = s. Select("projects.*"). Table(Project{}). Join("INNER", "tasks", "projects.id = tasks.project_id"). In("tasks.id", taskIDs). Find(&ps) return } // GetProjectsByIDs returns a map of projects from a slice with project ids func GetProjectsByIDs(s *xorm.Session, projectIDs []int64) (projects map[int64]*Project, err error) { projects = make(map[int64]*Project, len(projectIDs)) if len(projectIDs) == 0 { return } err = s.In("id", projectIDs).Find(&projects) return } type projectOptions struct { search string user *user.User page int perPage int getArchived bool } func getUserProjectsStatement(parentProjectIDs []int64, userID int64, search string, getArchived bool) *builder.Builder { dialect := config.DatabaseType.GetString() if dialect == "sqlite" { dialect = builder.SQLITE } // Adding a 1=1 condition by default here because xorm always needs a condition and cannot handle nil conditions var getArchivedCond builder.Cond = builder.Eq{"1": 1} if !getArchived { getArchivedCond = builder.And( builder.Eq{"l.is_archived": false}, ) } var filterCond builder.Cond ids := []int64{} if search != "" { vals := strings.Split(search, ",") for _, val := range vals { v, err := strconv.ParseInt(val, 10, 64) if err != nil { log.Debugf("Project search string part '%s' is not a number: %s", val, err) continue } ids = append(ids, v) } } filterCond = db.ILIKE("l.title", search) if len(ids) > 0 { filterCond = builder.In("l.id", ids) } var parentCondition builder.Cond if search == "" { parentCondition = builder.Or( builder.IsNull{"l.parent_project_id"}, builder.Eq{"l.parent_project_id": 0}, // else check for shared sub projects with a parent builder.And( builder.Or( builder.NotNull{"tm2.user_id"}, builder.NotNull{"ul.user_id"}, ), builder.NotNull{"l.parent_project_id"}, ), ) } projectCol := "id" if len(parentProjectIDs) > 0 { parentCondition = builder.In("l.parent_project_id", parentProjectIDs) projectCol = "parent_project_id" } return builder.Dialect(dialect). Select("l.*"). From("projects", "l"). Join("LEFT", "team_projects tl", "tl.project_id = l."+projectCol). Join("LEFT", "team_members tm2", "tm2.team_id = tl.team_id"). Join("LEFT", "users_projects ul", "ul.project_id = l."+projectCol). Where(builder.And( builder.Or( builder.Eq{"tm2.user_id": userID}, builder.Eq{"ul.user_id": userID}, builder.Eq{"l.owner_id": userID}, ), filterCond, getArchivedCond, parentCondition, builder.NotIn("l.id", parentProjectIDs), )). OrderBy("position"). GroupBy("l.id") } func getAllProjectsForUser(s *xorm.Session, userID int64, parentProjectIDs []int64, opts *projectOptions, projects *[]*Project, oldTotalCount int64, archivedProjects map[int64]bool) (resultCount int, totalCount int64, err error) { limit, start := getLimitFromPageIndex(opts.page, opts.perPage) query := getUserProjectsStatement(parentProjectIDs, userID, opts.search, opts.getArchived) if limit > 0 { query = query.Limit(limit, start) } currentProjects := []*Project{} err = s.SQL(query).Find(¤tProjects) if err != nil { return 0, 0, err } if len(currentProjects) == 0 { return 0, oldTotalCount, err } query = getUserProjectsStatement(parentProjectIDs, userID, opts.search, opts.getArchived) totalCount, err = s. SQL(query.Select("count(*)")). Count(&Project{}) if err != nil { return 0, 0, err } parentIDsMap := make(map[int64]bool, len(parentProjectIDs)) for _, id := range parentProjectIDs { parentIDsMap[id] = true } for _, project := range currentProjects { parentIDsMap[project.ID] = true } newParentIDs := []int64{} for _, project := range currentProjects { if project.IsArchived { archivedProjects[project.ID] = true } if archivedProjects[project.ParentProjectID] { project.IsArchived = true } // Filter out parent project ids which we're not looking for to avoid leaking // information about parent projects if !parentIDsMap[project.ParentProjectID] { project.ParentProjectID = 0 } newParentIDs = append(newParentIDs, project.ID) } *projects = append(*projects, currentProjects...) // If we don't reset the limit for subprojects, it will be impossible to fetch all subprojects. opts.page = -1 return getAllProjectsForUser(s, userID, newParentIDs, opts, projects, oldTotalCount+totalCount, archivedProjects) } // Gets the projects with their children without any tasks func getRawProjectsForUser(s *xorm.Session, opts *projectOptions) (projects []*Project, resultCount int, totalItems int64, err error) { fullUser, err := user.GetUserByID(s, opts.user.ID) if err != nil { return nil, 0, 0, err } allProjects := []*Project{} archivedProjects := make(map[int64]bool) resultCount, totalItems, err = getAllProjectsForUser(s, fullUser.ID, nil, opts, &allProjects, 0, archivedProjects) if err != nil { return } favoriteCount, err := s. Where(builder.And( builder.Eq{"user_id": opts.user.ID}, builder.Eq{"kind": FavoriteKindTask}, )). Count(&Favorite{}) if err != nil { return } if favoriteCount > 0 { favoritesProject := &Project{} *favoritesProject = FavoritesPseudoProject allProjects = append(allProjects, favoritesProject) } if len(allProjects) == 0 { return nil, 0, totalItems, nil } return allProjects, len(allProjects), totalItems, err } func getSavedFilterProjects(s *xorm.Session, doer *user.User) (savedFiltersProjects []*Project, err error) { savedFilters, err := getSavedFiltersForUser(s, doer) if err != nil { return } if len(savedFilters) == 0 { return nil, nil } for _, filter := range savedFilters { filterProject := filter.toProject() filterProject.Owner = doer savedFiltersProjects = append(savedFiltersProjects, filterProject) } return } // GetAllParentProjects returns all parents of a given project func (p *Project) GetAllParentProjects(s *xorm.Session) (err error) { if p.ParentProjectID == 0 { return } parent, err := GetProjectSimpleByID(s, p.ParentProjectID) if err != nil { return err } p.ParentProject = parent return parent.GetAllParentProjects(s) } // addProjectDetails adds owner user objects and project tasks to all projects in the slice func addProjectDetails(s *xorm.Session, projects []*Project, a web.Auth) (err error) { if len(projects) == 0 { return } var ownerIDs []int64 var projectIDs []int64 var fileIDs []int64 for _, p := range projects { ownerIDs = append(ownerIDs, p.OwnerID) projectIDs = append(projectIDs, p.ID) fileIDs = append(fileIDs, p.BackgroundFileID) } owners, err := user.GetUsersByIDs(s, ownerIDs) if err != nil { return err } favs, err := getFavorites(s, projectIDs, a, FavoriteKindProject) if err != nil { return err } subscriptions, err := GetSubscriptions(s, SubscriptionEntityProject, projectIDs, a) if err != nil { log.Errorf("An error occurred while getting project subscriptions for a project: %s", err.Error()) subscriptions = make(map[int64][]*Subscription) } for _, p := range projects { if o, exists := owners[p.OwnerID]; exists { p.Owner = o } if p.BackgroundFileID != 0 { p.BackgroundInformation = &ProjectBackgroundType{Type: ProjectBackgroundUpload} } // Don't override the favorite state if it was already set from before (favorite saved filters do this) if p.IsFavorite { continue } p.IsFavorite = favs[p.ID] if subscription, exists := subscriptions[p.ID]; exists && len(subscription) > 0 { p.Subscription = subscription[0] } } if len(fileIDs) == 0 { return } // Unsplash background file info us := []*UnsplashPhoto{} err = s.In("file_id", fileIDs).Find(&us) if err != nil { return } unsplashPhotos := make(map[int64]*UnsplashPhoto, len(us)) for _, u := range us { unsplashPhotos[u.FileID] = u } // Build it all into the projects slice for _, l := range projects { // Only override the file info if we have info for unsplash backgrounds if _, exists := unsplashPhotos[l.BackgroundFileID]; exists { l.BackgroundInformation = unsplashPhotos[l.BackgroundFileID] } } return } // CheckIsArchived returns an ErrProjectIsArchived if the project or any of its parent projects is archived. func (p *Project) CheckIsArchived(s *xorm.Session) (err error) { if p.ParentProjectID > 0 { p := &Project{ID: p.ParentProjectID} return p.CheckIsArchived(s) } if p.ID == 0 { // don't check new projects return nil } project, err := GetProjectSimpleByID(s, p.ID) if err != nil { return err } if project.IsArchived { return ErrProjectIsArchived{ProjectID: p.ID} } return nil } func checkProjectBeforeUpdateOrDelete(s *xorm.Session, project *Project) (err error) { if project.ParentProjectID < 0 { return &ErrProjectCannotBelongToAPseudoParentProject{ProjectID: project.ID, ParentProjectID: project.ParentProjectID} } // Check if the parent project exists if project.ParentProjectID > 0 { if project.ParentProjectID == project.ID { return &ErrProjectCannotBeChildOfItself{ ProjectID: project.ID, } } var parent *Project parent, err = GetProjectSimpleByID(s, project.ParentProjectID) if err != nil { return err } // Check if there's a cycle in the parent relation parentsVisited := make(map[int64]bool) parentsVisited[project.ID] = true for { if parent.ParentProjectID == 0 { break } // FIXME: Can we do this with better performance? parent, err = GetProjectSimpleByID(s, parent.ParentProjectID) if err != nil { return err } if parentsVisited[parent.ID] { return &ErrProjectCannotHaveACyclicRelationship{ ProjectID: project.ID, } } parentsVisited[parent.ID] = true } } // Check if the identifier is unique and not empty if project.Identifier != "" { exists, err := s. Where("identifier = ?", project.Identifier). And("id != ?", project.ID). Exist(&Project{}) if err != nil { return err } if exists { return ErrProjectIdentifierIsNotUnique{Identifier: project.Identifier} } } return nil } func CreateProject(s *xorm.Session, project *Project, auth web.Auth, createBacklogBucket bool) (err error) { err = project.CheckIsArchived(s) if err != nil { return err } doer, err := user.GetFromAuth(auth) if err != nil { return err } project.OwnerID = doer.ID project.Owner = doer err = checkProjectBeforeUpdateOrDelete(s, project) if err != nil { return } project.HexColor = utils.NormalizeHex(project.HexColor) _, err = s.Insert(project) if err != nil { return } project.Position = calculateDefaultPosition(project.ID, project.Position) _, err = s.Where("id = ?", project.ID).Update(project) if err != nil { return } if project.IsFavorite { if err := addToFavorites(s, project.ID, auth, FavoriteKindProject); err != nil { return err } } if createBacklogBucket { // Create a new first bucket for this project b := &Bucket{ ProjectID: project.ID, Title: "Backlog", } err = b.Create(s, auth) if err != nil { return } } return events.Dispatch(&ProjectCreatedEvent{ Project: project, Doer: doer, }) } // CreateNewProjectForUser creates a new inbox project for a user. To prevent import cycles, we can't do that // directly in the user.Create function. func CreateNewProjectForUser(s *xorm.Session, u *user.User) (err error) { p := &Project{ Title: "Inbox", } err = p.Create(s, u) if err != nil { return err } if u.DefaultProjectID != 0 { return err } u.DefaultProjectID = p.ID _, err = user.UpdateUser(s, u, false) return err } func UpdateProject(s *xorm.Session, project *Project, auth web.Auth, updateProjectBackground bool) (err error) { err = checkProjectBeforeUpdateOrDelete(s, project) if err != nil { return } if project.IsArchived { isDefaultProject, err := project.isDefaultProject(s) if err != nil { return err } if isDefaultProject { return &ErrCannotArchiveDefaultProject{ProjectID: project.ID} } } // We need to specify the cols we want to update here to be able to un-archive projects colsToUpdate := []string{ "title", "is_archived", "identifier", "hex_color", "parent_project_id", "position", "done_bucket_id", "default_bucket_id", } if project.Description != "" { colsToUpdate = append(colsToUpdate, "description") } if updateProjectBackground { colsToUpdate = append(colsToUpdate, "background_file_id", "background_blur_hash") } if project.Position < 0.1 { err = recalculateProjectPositions(s, project.ParentProjectID) if err != nil { return err } } wasFavorite, err := isFavorite(s, project.ID, auth, FavoriteKindProject) if err != nil { return err } if project.IsFavorite && !wasFavorite { if err := addToFavorites(s, project.ID, auth, FavoriteKindProject); err != nil { return err } } if !project.IsFavorite && wasFavorite { if err := removeFromFavorite(s, project.ID, auth, FavoriteKindProject); err != nil { return err } } project.HexColor = utils.NormalizeHex(project.HexColor) _, err = s. ID(project.ID). Cols(colsToUpdate...). Update(project) if err != nil { return err } err = events.Dispatch(&ProjectUpdatedEvent{ Project: project, Doer: auth, }) if err != nil { return err } l, err := GetProjectSimpleByID(s, project.ID) if err != nil { return err } *project = *l err = project.ReadOne(s, auth) return } func recalculateProjectPositions(s *xorm.Session, parentProjectID int64) (err error) { allProjects := []*Project{} err = s. Where("parent_project_id = ?", parentProjectID). OrderBy("position asc"). Find(&allProjects) if err != nil { return } maxPosition := math.Pow(2, 32) for i, project := range allProjects { currentPosition := maxPosition / float64(len(allProjects)) * (float64(i + 1)) _, err = s.Cols("position"). Where("id = ?", project.ID). Update(&Project{Position: currentPosition}) if err != nil { return } } return } // Update implements the update method of CRUDable // @Summary Updates a project // @Description Updates a project. This does not include adding a task (see below). // @tags project // @Accept json // @Produce json // @Security JWTKeyAuth // @Param id path int true "Project ID" // @Param project body models.Project true "The project with updated values you want to update." // @Success 200 {object} models.Project "The updated project." // @Failure 400 {object} web.HTTPError "Invalid project object provided." // @Failure 403 {object} web.HTTPError "The user does not have access to the project" // @Failure 500 {object} models.Message "Internal error" // @Router /projects/{id} [post] func (p *Project) Update(s *xorm.Session, a web.Auth) (err error) { fid := getSavedFilterIDFromProjectID(p.ID) if fid > 0 { f, err := getSavedFilterSimpleByID(s, fid) if err != nil { return err } f.Title = p.Title f.Description = p.Description f.IsFavorite = p.IsFavorite err = f.Update(s, a) if err != nil { return err } *p = *f.toProject() return nil } return UpdateProject(s, p, a, false) } func updateProjectLastUpdated(s *xorm.Session, project *Project) error { _, err := s.ID(project.ID).Cols("updated").Update(project) return err } func updateProjectByTaskID(s *xorm.Session, taskID int64) (err error) { // need to get the task to update the project last updated timestamp task, err := GetTaskByIDSimple(s, taskID) if err != nil { return err } return updateProjectLastUpdated(s, &Project{ID: task.ProjectID}) } // Create implements the create method of CRUDable // @Summary Creates a new project // @Description Creates a new project. If a parent project is provided the user needs to have write access to that project. // @tags project // @Accept json // @Produce json // @Security JWTKeyAuth // @Param project body models.Project true "The project you want to create." // @Success 201 {object} models.Project "The created project." // @Failure 400 {object} web.HTTPError "Invalid project object provided." // @Failure 403 {object} web.HTTPError "The user does not have access to the project" // @Failure 500 {object} models.Message "Internal error" // @Router /projects [put] func (p *Project) Create(s *xorm.Session, a web.Auth) (err error) { err = CreateProject(s, p, a, true) if err != nil { return } return p.ReadOne(s, a) } func (p *Project) isDefaultProject(s *xorm.Session) (is bool, err error) { return s. Where("default_project_id = ?", p.ID). Exist(&user.User{}) } // Delete implements the delete method of CRUDable // @Summary Deletes a project // @Description Delets a project // @tags project // @Produce json // @Security JWTKeyAuth // @Param id path int true "Project ID" // @Success 200 {object} models.Message "The project was successfully deleted." // @Failure 400 {object} web.HTTPError "Invalid project object provided." // @Failure 403 {object} web.HTTPError "The user does not have access to the project" // @Failure 500 {object} models.Message "Internal error" // @Router /projects/{id} [delete] func (p *Project) Delete(s *xorm.Session, a web.Auth) (err error) { isDefaultProject, err := p.isDefaultProject(s) if err != nil { return err } // Owners should be allowed to delete the default project if isDefaultProject && p.OwnerID != a.GetID() { return &ErrCannotDeleteDefaultProject{ProjectID: p.ID} } // Delete all tasks on that project // Using the loop to make sure all related entities to all tasks are properly deleted as well. tasks, _, _, err := getRawTasksForProjects(s, []*Project{p}, a, &taskSearchOptions{}) if err != nil { return } for _, task := range tasks { err = task.Delete(s, a) if err != nil { return err } } fullProject, err := GetProjectSimpleByID(s, p.ID) if err != nil { return } err = fullProject.DeleteBackgroundFileIfExists() if err != nil { return } // If we're deleting a default project, remove it as default if isDefaultProject { _, err = s.Where("default_project_id = ?", p.ID). Cols("default_project_id"). Update(&user.User{DefaultProjectID: 0}) if err != nil { return } } // Delete the project _, err = s.ID(p.ID).Delete(&Project{}) if err != nil { return } err = events.Dispatch(&ProjectDeletedEvent{ Project: fullProject, Doer: a, }) if err != nil { return } childProjects := []*Project{} err = s.Where("parent_project_id = ?", fullProject.ID).Find(&childProjects) if err != nil { return } for _, child := range childProjects { err = child.Delete(s, a) if err != nil { return } } return } // DeleteBackgroundFileIfExists deletes the list's background file from the db and the filesystem, // if one exists func (p *Project) DeleteBackgroundFileIfExists() (err error) { if p.BackgroundFileID == 0 { return } file := files.File{ID: p.BackgroundFileID} err = file.Delete() if err != nil && files.IsErrFileDoesNotExist(err) { return nil } return err } // SetProjectBackground sets a background file as project background in the db func SetProjectBackground(s *xorm.Session, projectID int64, background *files.File, blurHash string) (err error) { l := &Project{ ID: projectID, BackgroundFileID: background.ID, BackgroundBlurHash: blurHash, } _, err = s. Where("id = ?", l.ID). Cols("background_file_id", "background_blur_hash"). Update(l) return }