// Copyright 2016 The Gogs Authors. All rights reserved. // Copyright 2018 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package repo import ( "fmt" "net/http" "strings" "time" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/context" issue_indexer "code.gitea.io/gitea/modules/indexer/issues" "code.gitea.io/gitea/modules/setting" api "code.gitea.io/gitea/modules/structs" "code.gitea.io/gitea/modules/timeutil" "code.gitea.io/gitea/modules/util" issue_service "code.gitea.io/gitea/services/issue" milestone_service "code.gitea.io/gitea/services/milestone" ) // ListIssues list the issues of a repository func ListIssues(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/issues issue issueListIssues // --- // summary: List a repository's issues // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: state // in: query // description: whether issue is open or closed // type: string // - name: labels // in: query // description: comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded // type: string // - name: page // in: query // description: page number of requested issues // type: integer // - name: q // in: query // description: search string // type: string // responses: // "200": // "$ref": "#/responses/IssueList" var isClosed util.OptionalBool switch ctx.Query("state") { case "closed": isClosed = util.OptionalBoolTrue case "all": isClosed = util.OptionalBoolNone default: isClosed = util.OptionalBoolFalse } var issues []*models.Issue keyword := strings.Trim(ctx.Query("q"), " ") if strings.IndexByte(keyword, 0) >= 0 { keyword = "" } var issueIDs []int64 var labelIDs []int64 var err error if len(keyword) > 0 { issueIDs, err = issue_indexer.SearchIssuesByKeyword(ctx.Repo.Repository.ID, keyword) } if splitted := strings.Split(ctx.Query("labels"), ","); len(splitted) > 0 { labelIDs, err = models.GetLabelIDsInRepoByNames(ctx.Repo.Repository.ID, splitted) if err != nil { ctx.Error(500, "GetLabelIDsInRepoByNames", err) return } } // Only fetch the issues if we either don't have a keyword or the search returned issues // This would otherwise return all issues if no issues were found by the search. if len(keyword) == 0 || len(issueIDs) > 0 || len(labelIDs) > 0 { issues, err = models.Issues(&models.IssuesOptions{ RepoIDs: []int64{ctx.Repo.Repository.ID}, Page: ctx.QueryInt("page"), PageSize: setting.UI.IssuePagingNum, IsClosed: isClosed, IssueIDs: issueIDs, LabelIDs: labelIDs, }) } if err != nil { ctx.Error(500, "Issues", err) return } apiIssues := make([]*api.Issue, len(issues)) for i := range issues { apiIssues[i] = issues[i].APIFormat() } ctx.SetLinkHeader(ctx.Repo.Repository.NumIssues, setting.UI.IssuePagingNum) ctx.JSON(200, &apiIssues) } // GetIssue get an issue of a repository func GetIssue(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/issues/{index} issue issueGetIssue // --- // summary: Get an issue // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue to get // type: integer // format: int64 // required: true // responses: // "200": // "$ref": "#/responses/Issue" issue, err := models.GetIssueWithAttrsByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } ctx.JSON(200, issue.APIFormat()) } // CreateIssue create an issue of a repository func CreateIssue(ctx *context.APIContext, form api.CreateIssueOption) { // swagger:operation POST /repos/{owner}/{repo}/issues issue issueCreateIssue // --- // summary: Create an issue. If using deadline only the date will be taken into account, and time of day ignored. // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: body // in: body // schema: // "$ref": "#/definitions/CreateIssueOption" // responses: // "201": // "$ref": "#/responses/Issue" var deadlineUnix timeutil.TimeStamp if form.Deadline != nil && ctx.Repo.CanWrite(models.UnitTypeIssues) { deadlineUnix = timeutil.TimeStamp(form.Deadline.Unix()) } issue := &models.Issue{ RepoID: ctx.Repo.Repository.ID, Repo: ctx.Repo.Repository, Title: form.Title, PosterID: ctx.User.ID, Poster: ctx.User, Content: form.Body, DeadlineUnix: deadlineUnix, } var assigneeIDs = make([]int64, 0) var err error if ctx.Repo.CanWrite(models.UnitTypeIssues) { issue.MilestoneID = form.Milestone assigneeIDs, err = models.MakeIDsFromAPIAssigneesToAdd(form.Assignee, form.Assignees) if err != nil { if models.IsErrUserNotExist(err) { ctx.Error(422, "", fmt.Sprintf("Assignee does not exist: [name: %s]", err)) } else { ctx.Error(500, "AddAssigneeByName", err) } return } // Check if the passed assignees is assignable for _, aID := range assigneeIDs { assignee, err := models.GetUserByID(aID) if err != nil { ctx.Error(500, "GetUserByID", err) return } valid, err := models.CanBeAssigned(assignee, ctx.Repo.Repository, false) if err != nil { ctx.Error(500, "canBeAssigned", err) return } if !valid { ctx.Error(422, "canBeAssigned", models.ErrUserDoesNotHaveAccessToRepo{UserID: aID, RepoName: ctx.Repo.Repository.Name}) return } } } else { // setting labels is not allowed if user is not a writer form.Labels = make([]int64, 0) } if err := issue_service.NewIssue(ctx.Repo.Repository, issue, form.Labels, nil, assigneeIDs); err != nil { if models.IsErrUserDoesNotHaveAccessToRepo(err) { ctx.Error(400, "UserDoesNotHaveAccessToRepo", err) return } ctx.Error(500, "NewIssue", err) return } if form.Closed { if err := issue_service.ChangeStatus(issue, ctx.User, true); err != nil { if models.IsErrDependenciesLeft(err) { ctx.Error(http.StatusPreconditionFailed, "DependenciesLeft", "cannot close this issue because it still has open dependencies") return } ctx.Error(500, "ChangeStatus", err) return } } // Refetch from database to assign some automatic values issue, err = models.GetIssueByID(issue.ID) if err != nil { ctx.Error(500, "GetIssueByID", err) return } ctx.JSON(201, issue.APIFormat()) } // EditIssue modify an issue of a repository func EditIssue(ctx *context.APIContext, form api.EditIssueOption) { // swagger:operation PATCH /repos/{owner}/{repo}/issues/{index} issue issueEditIssue // --- // summary: Edit an issue. If using deadline only the date will be taken into account, and time of day ignored. // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue to edit // type: integer // format: int64 // required: true // - name: body // in: body // schema: // "$ref": "#/definitions/EditIssueOption" // responses: // "201": // "$ref": "#/responses/Issue" issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } issue.Repo = ctx.Repo.Repository err = issue.LoadAttributes() if err != nil { ctx.Error(500, "LoadAttributes", err) return } if !issue.IsPoster(ctx.User.ID) && !ctx.Repo.CanWrite(models.UnitTypeIssues) { ctx.Status(403) return } if len(form.Title) > 0 { issue.Title = form.Title } if form.Body != nil { issue.Content = *form.Body } // Update the deadline if form.Deadline != nil && ctx.Repo.CanWrite(models.UnitTypeIssues) { deadlineUnix := timeutil.TimeStamp(form.Deadline.Unix()) if err := models.UpdateIssueDeadline(issue, deadlineUnix, ctx.User); err != nil { ctx.Error(500, "UpdateIssueDeadline", err) return } issue.DeadlineUnix = deadlineUnix } // Add/delete assignees // Deleting is done the GitHub way (quote from their api documentation): // https://developer.github.com/v3/issues/#edit-an-issue // "assignees" (array): Logins for Users to assign to this issue. // Pass one or more user logins to replace the set of assignees on this Issue. // Send an empty array ([]) to clear all assignees from the Issue. if ctx.Repo.CanWrite(models.UnitTypeIssues) && (form.Assignees != nil || form.Assignee != nil) { oneAssignee := "" if form.Assignee != nil { oneAssignee = *form.Assignee } err = issue_service.UpdateAssignees(issue, oneAssignee, form.Assignees, ctx.User) if err != nil { ctx.Error(500, "UpdateAssignees", err) return } } if ctx.Repo.CanWrite(models.UnitTypeIssues) && form.Milestone != nil && issue.MilestoneID != *form.Milestone { oldMilestoneID := issue.MilestoneID issue.MilestoneID = *form.Milestone if err = milestone_service.ChangeMilestoneAssign(issue, ctx.User, oldMilestoneID); err != nil { ctx.Error(500, "ChangeMilestoneAssign", err) return } } if err = models.UpdateIssue(issue); err != nil { ctx.Error(500, "UpdateIssue", err) return } if form.State != nil { if err = issue_service.ChangeStatus(issue, ctx.User, api.StateClosed == api.StateType(*form.State)); err != nil { if models.IsErrDependenciesLeft(err) { ctx.Error(http.StatusPreconditionFailed, "DependenciesLeft", "cannot close this issue because it still has open dependencies") return } ctx.Error(500, "ChangeStatus", err) return } } // Refetch from database to assign some automatic values issue, err = models.GetIssueByID(issue.ID) if err != nil { ctx.Error(500, "GetIssueByID", err) return } ctx.JSON(201, issue.APIFormat()) } // UpdateIssueDeadline updates an issue deadline func UpdateIssueDeadline(ctx *context.APIContext, form api.EditDeadlineOption) { // swagger:operation POST /repos/{owner}/{repo}/issues/{index}/deadline issue issueEditIssueDeadline // --- // summary: Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored. // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue to create or update a deadline on // type: integer // format: int64 // required: true // - name: body // in: body // schema: // "$ref": "#/definitions/EditDeadlineOption" // responses: // "201": // "$ref": "#/responses/IssueDeadline" // "403": // description: Not repo writer // "404": // description: Issue not found issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWrite(models.UnitTypeIssues) { ctx.Status(403) return } var deadlineUnix timeutil.TimeStamp var deadline time.Time if form.Deadline != nil && !form.Deadline.IsZero() { deadline = time.Date(form.Deadline.Year(), form.Deadline.Month(), form.Deadline.Day(), 23, 59, 59, 0, form.Deadline.Location()) deadlineUnix = timeutil.TimeStamp(deadline.Unix()) } if err := models.UpdateIssueDeadline(issue, deadlineUnix, ctx.User); err != nil { ctx.Error(500, "UpdateIssueDeadline", err) return } ctx.JSON(201, api.IssueDeadline{Deadline: &deadline}) } // StartIssueStopwatch creates a stopwatch for the given issue. func StartIssueStopwatch(ctx *context.APIContext) { // swagger:operation POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start issue issueStartStopWatch // --- // summary: Start stopwatch on an issue. // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue to create the stopwatch on // type: integer // format: int64 // required: true // responses: // "201": // "$ref": "#/responses/empty" // "403": // description: Not repo writer, user does not have rights to toggle stopwatch // "404": // description: Issue not found // "409": // description: Cannot start a stopwatch again if it already exists issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWrite(models.UnitTypeIssues) { ctx.Status(403) return } if !ctx.Repo.CanUseTimetracker(issue, ctx.User) { ctx.Status(403) return } if models.StopwatchExists(ctx.User.ID, issue.ID) { ctx.Error(409, "StopwatchExists", "a stopwatch has already been started for this issue") return } if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil { ctx.Error(500, "CreateOrStopIssueStopwatch", err) return } ctx.Status(201) } // StopIssueStopwatch stops a stopwatch for the given issue. func StopIssueStopwatch(ctx *context.APIContext) { // swagger:operation POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop issue issueStopWatch // --- // summary: Stop an issue's existing stopwatch. // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue to stop the stopwatch on // type: integer // format: int64 // required: true // responses: // "201": // "$ref": "#/responses/empty" // "403": // description: Not repo writer, user does not have rights to toggle stopwatch // "404": // description: Issue not found // "409": // description: Cannot stop a non existent stopwatch issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } if !ctx.Repo.CanWrite(models.UnitTypeIssues) { ctx.Status(403) return } if !ctx.Repo.CanUseTimetracker(issue, ctx.User) { ctx.Status(403) return } if !models.StopwatchExists(ctx.User.ID, issue.ID) { ctx.Error(409, "StopwatchExists", "cannot stop a non existent stopwatch") return } if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil { ctx.Error(500, "CreateOrStopIssueStopwatch", err) return } ctx.Status(201) } // AddIssueSubscription add user to subscription list func AddIssueSubscription(ctx *context.APIContext) { // swagger:operation PUT /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} issue issueAddSubscription // --- // summary: Add user to subscription list // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue // type: integer // format: int64 // required: true // - name: user // in: path // description: user witch subscribe to issue // type: string // required: true // responses: // "201": // "$ref": "#/responses/empty" // "304": // description: User has no right to add subscribe of other user // "404": // description: Issue not found issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } user, err := models.GetUserByName(ctx.Params(":user")) if err != nil { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetUserByName", err) return } } if user.ID != ctx.User.ID && !ctx.User.IsAdmin { ctx.Error(403, "User", nil) return } if err := models.CreateOrUpdateIssueWatch(user.ID, issue.ID, true); err != nil { ctx.Error(500, "CreateOrUpdateIssueWatch", err) return } ctx.Status(201) } // DelIssueSubscription remove user to subscription list func DelIssueSubscription(ctx *context.APIContext) { // swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} issue issueDeleteSubscription // --- // summary: Delete user from subscription list // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue // type: integer // format: int64 // required: true // - name: user // in: path // description: user witch unsubscribe to issue // type: string // required: true // responses: // "201": // "$ref": "#/responses/empty" // "304": // description: User has no right to remove subscribe of other user // "404": // description: Issue not found issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } user, err := models.GetUserByName(ctx.Params(":user")) if err != nil { if models.IsErrUserNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetUserByName", err) return } } if user.ID != ctx.User.ID && !ctx.User.IsAdmin { ctx.Error(403, "User", nil) return } if err := models.CreateOrUpdateIssueWatch(user.ID, issue.ID, false); err != nil { ctx.Error(500, "CreateOrUpdateIssueWatch", err) return } ctx.Status(201) } // GetIssueWatchers return subscribers of an issue func GetIssueWatchers(ctx *context.APIContext, form api.IssueWatchers) { // swagger:operation GET /repos/{owner}/{repo}/issues/{index}/subscriptions issue issueSubscriptions // --- // summary: Get users who subscribed on an issue. // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: index // in: path // description: index of the issue // type: integer // format: int64 // required: true // responses: // "201": // "$ref": "#/responses/empty" // "404": // description: Issue not found issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index")) if err != nil { if models.IsErrIssueNotExist(err) { ctx.NotFound() } else { ctx.Error(500, "GetIssueByIndex", err) } return } var subscribers []string iw, err := models.GetIssueWatchers(issue.ID) if err != nil { ctx.Error(500, "GetIssueWatchers", err) return } for _, s := range iw { user, err := models.GetUserByID(s.UserID) if err != nil { continue } subscribers = append(subscribers, user.LoginName) } ctx.JSON(200, api.IssueWatchers{Subscribers: subscribers}) }