123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541 |
- // Copyright 2015 The Gogs Authors. All rights reserved.
- // Copyright 2020 The Gitea Authors.
- // Use of this source code is governed by a MIT-style
- // license that can be found in the LICENSE file.
-
- package repo
-
- import (
- "errors"
- "net/http"
-
- "code.gitea.io/gitea/models"
- "code.gitea.io/gitea/modules/context"
- "code.gitea.io/gitea/modules/convert"
- api "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/modules/web"
- "code.gitea.io/gitea/routers/api/v1/utils"
- comment_service "code.gitea.io/gitea/services/comments"
- )
-
- // ListIssueComments list all the comments of an issue
- func ListIssueComments(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/issues/{index}/comments issue issueGetComments
- // ---
- // summary: List all comments on 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
- // type: integer
- // format: int64
- // required: true
- // - name: since
- // in: query
- // description: if provided, only comments updated since the specified time are returned.
- // type: string
- // format: date-time
- // - name: before
- // in: query
- // description: if provided, only comments updated before the provided time are returned.
- // type: string
- // format: date-time
- // responses:
- // "200":
- // "$ref": "#/responses/CommentList"
-
- before, since, err := utils.GetQueryBeforeSince(ctx)
- if err != nil {
- ctx.Error(http.StatusUnprocessableEntity, "GetQueryBeforeSince", err)
- return
- }
- issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "GetRawIssueByIndex", err)
- return
- }
- issue.Repo = ctx.Repo.Repository
-
- opts := &models.FindCommentsOptions{
- IssueID: issue.ID,
- Since: since,
- Before: before,
- Type: models.CommentTypeComment,
- }
-
- comments, err := models.FindComments(opts)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "FindComments", err)
- return
- }
-
- totalCount, err := models.CountComments(opts)
- if err != nil {
- ctx.InternalServerError(err)
- return
- }
-
- if err := models.CommentList(comments).LoadPosters(); err != nil {
- ctx.Error(http.StatusInternalServerError, "LoadPosters", err)
- return
- }
-
- apiComments := make([]*api.Comment, len(comments))
- for i, comment := range comments {
- comment.Issue = issue
- apiComments[i] = convert.ToComment(comments[i])
- }
-
- ctx.SetTotalCountHeader(totalCount)
- ctx.JSON(http.StatusOK, &apiComments)
- }
-
- // ListRepoIssueComments returns all issue-comments for a repo
- func ListRepoIssueComments(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/issues/comments issue issueGetRepoComments
- // ---
- // summary: List all comments in a repository
- // 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: since
- // in: query
- // description: if provided, only comments updated since the provided time are returned.
- // type: string
- // format: date-time
- // - name: before
- // in: query
- // description: if provided, only comments updated before the provided time are returned.
- // type: string
- // format: date-time
- // - name: page
- // in: query
- // description: page number of results to return (1-based)
- // type: integer
- // - name: limit
- // in: query
- // description: page size of results
- // type: integer
- // responses:
- // "200":
- // "$ref": "#/responses/CommentList"
-
- before, since, err := utils.GetQueryBeforeSince(ctx)
- if err != nil {
- ctx.Error(http.StatusUnprocessableEntity, "GetQueryBeforeSince", err)
- return
- }
-
- opts := &models.FindCommentsOptions{
- ListOptions: utils.GetListOptions(ctx),
- RepoID: ctx.Repo.Repository.ID,
- Type: models.CommentTypeComment,
- Since: since,
- Before: before,
- }
-
- comments, err := models.FindComments(opts)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "FindComments", err)
- return
- }
-
- totalCount, err := models.CountComments(opts)
- if err != nil {
- ctx.InternalServerError(err)
- return
- }
-
- if err = models.CommentList(comments).LoadPosters(); err != nil {
- ctx.Error(http.StatusInternalServerError, "LoadPosters", err)
- return
- }
-
- apiComments := make([]*api.Comment, len(comments))
- if err := models.CommentList(comments).LoadIssues(); err != nil {
- ctx.Error(http.StatusInternalServerError, "LoadIssues", err)
- return
- }
- if err := models.CommentList(comments).LoadPosters(); err != nil {
- ctx.Error(http.StatusInternalServerError, "LoadPosters", err)
- return
- }
- if _, err := models.CommentList(comments).Issues().LoadRepositories(); err != nil {
- ctx.Error(http.StatusInternalServerError, "LoadRepositories", err)
- return
- }
- for i := range comments {
- apiComments[i] = convert.ToComment(comments[i])
- }
-
- ctx.SetTotalCountHeader(totalCount)
- ctx.JSON(http.StatusOK, &apiComments)
- }
-
- // CreateIssueComment create a comment for an issue
- func CreateIssueComment(ctx *context.APIContext) {
- // swagger:operation POST /repos/{owner}/{repo}/issues/{index}/comments issue issueCreateComment
- // ---
- // summary: Add a comment to 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
- // - name: body
- // in: body
- // schema:
- // "$ref": "#/definitions/CreateIssueCommentOption"
- // responses:
- // "201":
- // "$ref": "#/responses/Comment"
- // "403":
- // "$ref": "#/responses/forbidden"
- form := web.GetForm(ctx).(*api.CreateIssueCommentOption)
- issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err)
- return
- }
-
- if issue.IsLocked && !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) && !ctx.User.IsAdmin {
- ctx.Error(http.StatusForbidden, "CreateIssueComment", errors.New(ctx.Tr("repo.issues.comment_on_locked")))
- return
- }
-
- comment, err := comment_service.CreateIssueComment(ctx.User, ctx.Repo.Repository, issue, form.Body, nil)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "CreateIssueComment", err)
- return
- }
-
- ctx.JSON(http.StatusCreated, convert.ToComment(comment))
- }
-
- // GetIssueComment Get a comment by ID
- func GetIssueComment(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/issues/comments/{id} issue issueGetComment
- // ---
- // summary: Get a comment
- // 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: id
- // in: path
- // description: id of the comment
- // type: integer
- // format: int64
- // required: true
- // responses:
- // "200":
- // "$ref": "#/responses/Comment"
- // "204":
- // "$ref": "#/responses/empty"
- // "403":
- // "$ref": "#/responses/forbidden"
- // "404":
- // "$ref": "#/responses/notFound"
-
- comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
- if err != nil {
- if models.IsErrCommentNotExist(err) {
- ctx.NotFound(err)
- } else {
- ctx.Error(http.StatusInternalServerError, "GetCommentByID", err)
- }
- return
- }
-
- if err = comment.LoadIssue(); err != nil {
- ctx.InternalServerError(err)
- return
- }
- if comment.Issue.RepoID != ctx.Repo.Repository.ID {
- ctx.Status(http.StatusNotFound)
- return
- }
-
- if comment.Type != models.CommentTypeComment {
- ctx.Status(http.StatusNoContent)
- return
- }
-
- if err := comment.LoadPoster(); err != nil {
- ctx.Error(http.StatusInternalServerError, "comment.LoadPoster", err)
- return
- }
-
- ctx.JSON(http.StatusOK, convert.ToComment(comment))
- }
-
- // EditIssueComment modify a comment of an issue
- func EditIssueComment(ctx *context.APIContext) {
- // swagger:operation PATCH /repos/{owner}/{repo}/issues/comments/{id} issue issueEditComment
- // ---
- // summary: Edit a comment
- // 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: id
- // in: path
- // description: id of the comment to edit
- // type: integer
- // format: int64
- // required: true
- // - name: body
- // in: body
- // schema:
- // "$ref": "#/definitions/EditIssueCommentOption"
- // responses:
- // "200":
- // "$ref": "#/responses/Comment"
- // "204":
- // "$ref": "#/responses/empty"
- // "403":
- // "$ref": "#/responses/forbidden"
- // "404":
- // "$ref": "#/responses/notFound"
-
- form := web.GetForm(ctx).(*api.EditIssueCommentOption)
- editIssueComment(ctx, *form)
- }
-
- // EditIssueCommentDeprecated modify a comment of an issue
- func EditIssueCommentDeprecated(ctx *context.APIContext) {
- // swagger:operation PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id} issue issueEditCommentDeprecated
- // ---
- // summary: Edit a comment
- // deprecated: true
- // 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: this parameter is ignored
- // type: integer
- // required: true
- // - name: id
- // in: path
- // description: id of the comment to edit
- // type: integer
- // format: int64
- // required: true
- // - name: body
- // in: body
- // schema:
- // "$ref": "#/definitions/EditIssueCommentOption"
- // responses:
- // "200":
- // "$ref": "#/responses/Comment"
- // "204":
- // "$ref": "#/responses/empty"
- // "403":
- // "$ref": "#/responses/forbidden"
- // "404":
- // "$ref": "#/responses/notFound"
-
- form := web.GetForm(ctx).(*api.EditIssueCommentOption)
- editIssueComment(ctx, *form)
- }
-
- func editIssueComment(ctx *context.APIContext, form api.EditIssueCommentOption) {
- comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
- if err != nil {
- if models.IsErrCommentNotExist(err) {
- ctx.NotFound(err)
- } else {
- ctx.Error(http.StatusInternalServerError, "GetCommentByID", err)
- }
- return
- }
-
- if !ctx.IsSigned || (ctx.User.ID != comment.PosterID && !ctx.Repo.IsAdmin()) {
- ctx.Status(http.StatusForbidden)
- return
- } else if comment.Type != models.CommentTypeComment {
- ctx.Status(http.StatusNoContent)
- return
- }
-
- oldContent := comment.Content
- comment.Content = form.Body
- if err := comment_service.UpdateComment(comment, ctx.User, oldContent); err != nil {
- ctx.Error(http.StatusInternalServerError, "UpdateComment", err)
- return
- }
-
- ctx.JSON(http.StatusOK, convert.ToComment(comment))
- }
-
- // DeleteIssueComment delete a comment from an issue
- func DeleteIssueComment(ctx *context.APIContext) {
- // swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id} issue issueDeleteComment
- // ---
- // summary: Delete a comment
- // 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: id
- // in: path
- // description: id of comment to delete
- // type: integer
- // format: int64
- // required: true
- // responses:
- // "204":
- // "$ref": "#/responses/empty"
- // "403":
- // "$ref": "#/responses/forbidden"
- // "404":
- // "$ref": "#/responses/notFound"
-
- deleteIssueComment(ctx)
- }
-
- // DeleteIssueCommentDeprecated delete a comment from an issue
- func DeleteIssueCommentDeprecated(ctx *context.APIContext) {
- // swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id} issue issueDeleteCommentDeprecated
- // ---
- // summary: Delete a comment
- // deprecated: true
- // 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: this parameter is ignored
- // type: integer
- // required: true
- // - name: id
- // in: path
- // description: id of comment to delete
- // type: integer
- // format: int64
- // required: true
- // responses:
- // "204":
- // "$ref": "#/responses/empty"
- // "403":
- // "$ref": "#/responses/forbidden"
- // "404":
- // "$ref": "#/responses/notFound"
-
- deleteIssueComment(ctx)
- }
-
- func deleteIssueComment(ctx *context.APIContext) {
- comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
- if err != nil {
- if models.IsErrCommentNotExist(err) {
- ctx.NotFound(err)
- } else {
- ctx.Error(http.StatusInternalServerError, "GetCommentByID", err)
- }
- return
- }
-
- if !ctx.IsSigned || (ctx.User.ID != comment.PosterID && !ctx.Repo.IsAdmin()) {
- ctx.Status(http.StatusForbidden)
- return
- } else if comment.Type != models.CommentTypeComment {
- ctx.Status(http.StatusNoContent)
- return
- }
-
- if err = comment_service.DeleteComment(ctx.User, comment); err != nil {
- ctx.Error(http.StatusInternalServerError, "DeleteCommentByID", err)
- return
- }
-
- ctx.Status(http.StatusNoContent)
- }
|