mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-25 05:37:29 +02:00
Use [chi](https://github.com/go-chi/chi) instead of the forked [macaron](https://gitea.com/macaron/macaron). Since macaron and chi have conflicts with session share, this big PR becomes a have-to thing. According my previous idea, we can replace macaron step by step but I'm wrong. :( Below is a list of big changes on this PR. - [x] Define `context.ResponseWriter` interface with an implementation `context.Response`. - [x] Use chi instead of macaron, and also a customize `Route` to wrap chi so that the router usage is similar as before. - [x] Create different routers for `web`, `api`, `internal` and `install` so that the codes will be more clear and no magic . - [x] Use https://github.com/unrolled/render instead of macaron's internal render - [x] Use https://github.com/NYTimes/gziphandler instead of https://gitea.com/macaron/gzip - [x] Use https://gitea.com/go-chi/session which is a modified version of https://gitea.com/macaron/session and removed `nodb` support since it will not be maintained. **BREAK** - [x] Use https://gitea.com/go-chi/captcha which is a modified version of https://gitea.com/macaron/captcha - [x] Use https://gitea.com/go-chi/cache which is a modified version of https://gitea.com/macaron/cache - [x] Use https://gitea.com/go-chi/binding which is a modified version of https://gitea.com/macaron/binding - [x] Use https://github.com/go-chi/cors instead of https://gitea.com/macaron/cors - [x] Dropped https://gitea.com/macaron/i18n and make a new one in `code.gitea.io/gitea/modules/translation` - [x] Move validation form structs from `code.gitea.io/gitea/modules/auth` to `code.gitea.io/gitea/modules/forms` to avoid dependency cycle. - [x] Removed macaron log service because it's not need any more. **BREAK** - [x] All form structs have to be get by `web.GetForm(ctx)` in the route function but not as a function parameter on routes definition. - [x] Move Git HTTP protocol implementation to use routers directly. - [x] Fix the problem that chi routes don't support trailing slash but macaron did. - [x] `/api/v1/swagger` now will be redirect to `/api/swagger` but not render directly so that `APIContext` will not create a html render. Notices: - Chi router don't support request with trailing slash - Integration test `TestUserHeatmap` maybe mysql version related. It's failed on my macOS(mysql 5.7.29 installed via brew) but succeed on CI. Co-authored-by: 6543 <6543@obermui.de>
299 lines
7.3 KiB
Go
299 lines
7.3 KiB
Go
// Copyright 2019 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 (
|
|
"net/http"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/convert"
|
|
"code.gitea.io/gitea/modules/log"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
|
)
|
|
|
|
// ListTopics returns list of current topics for repo
|
|
func ListTopics(ctx *context.APIContext) {
|
|
// swagger:operation GET /repos/{owner}/{repo}/topics repository repoListTopics
|
|
// ---
|
|
// summary: Get list of topics that a repository has
|
|
// 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: 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/TopicNames"
|
|
|
|
topics, err := models.FindTopics(&models.FindTopicOptions{
|
|
ListOptions: utils.GetListOptions(ctx),
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
})
|
|
if err != nil {
|
|
log.Error("ListTopics failed: %v", err)
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
topicNames := make([]string, len(topics))
|
|
for i, topic := range topics {
|
|
topicNames[i] = topic.Name
|
|
}
|
|
ctx.JSON(http.StatusOK, map[string]interface{}{
|
|
"topics": topicNames,
|
|
})
|
|
}
|
|
|
|
// UpdateTopics updates repo with a new set of topics
|
|
func UpdateTopics(ctx *context.APIContext) {
|
|
// swagger:operation PUT /repos/{owner}/{repo}/topics repository repoUpdateTopics
|
|
// ---
|
|
// summary: Replace list of topics for 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: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/RepoTopicOptions"
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "422":
|
|
// "$ref": "#/responses/invalidTopicsError"
|
|
|
|
form := web.GetForm(ctx).(*api.RepoTopicOptions)
|
|
topicNames := form.Topics
|
|
validTopics, invalidTopics := models.SanitizeAndValidateTopics(topicNames)
|
|
|
|
if len(validTopics) > 25 {
|
|
ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{
|
|
"invalidTopics": nil,
|
|
"message": "Exceeding maximum number of topics per repo",
|
|
})
|
|
return
|
|
}
|
|
|
|
if len(invalidTopics) > 0 {
|
|
ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{
|
|
"invalidTopics": invalidTopics,
|
|
"message": "Topic names are invalid",
|
|
})
|
|
return
|
|
}
|
|
|
|
err := models.SaveTopics(ctx.Repo.Repository.ID, validTopics...)
|
|
if err != nil {
|
|
log.Error("SaveTopics failed: %v", err)
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// AddTopic adds a topic name to a repo
|
|
func AddTopic(ctx *context.APIContext) {
|
|
// swagger:operation PUT /repos/{owner}/{repo}/topics/{topic} repository repoAddTopíc
|
|
// ---
|
|
// summary: Add a topic to 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: topic
|
|
// in: path
|
|
// description: name of the topic to add
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "422":
|
|
// "$ref": "#/responses/invalidTopicsError"
|
|
|
|
topicName := strings.TrimSpace(strings.ToLower(ctx.Params(":topic")))
|
|
|
|
if !models.ValidateTopic(topicName) {
|
|
ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{
|
|
"invalidTopics": topicName,
|
|
"message": "Topic name is invalid",
|
|
})
|
|
return
|
|
}
|
|
|
|
// Prevent adding more topics than allowed to repo
|
|
topics, err := models.FindTopics(&models.FindTopicOptions{
|
|
RepoID: ctx.Repo.Repository.ID,
|
|
})
|
|
if err != nil {
|
|
log.Error("AddTopic failed: %v", err)
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
if len(topics) >= 25 {
|
|
ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{
|
|
"message": "Exceeding maximum allowed topics per repo.",
|
|
})
|
|
return
|
|
}
|
|
|
|
_, err = models.AddTopic(ctx.Repo.Repository.ID, topicName)
|
|
if err != nil {
|
|
log.Error("AddTopic failed: %v", err)
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// DeleteTopic removes topic name from repo
|
|
func DeleteTopic(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /repos/{owner}/{repo}/topics/{topic} repository repoDeleteTopic
|
|
// ---
|
|
// summary: Delete a topic from 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: topic
|
|
// in: path
|
|
// description: name of the topic to delete
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// "$ref": "#/responses/empty"
|
|
// "422":
|
|
// "$ref": "#/responses/invalidTopicsError"
|
|
|
|
topicName := strings.TrimSpace(strings.ToLower(ctx.Params(":topic")))
|
|
|
|
if !models.ValidateTopic(topicName) {
|
|
ctx.JSON(http.StatusUnprocessableEntity, map[string]interface{}{
|
|
"invalidTopics": topicName,
|
|
"message": "Topic name is invalid",
|
|
})
|
|
return
|
|
}
|
|
|
|
topic, err := models.DeleteTopic(ctx.Repo.Repository.ID, topicName)
|
|
if err != nil {
|
|
log.Error("DeleteTopic failed: %v", err)
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
if topic == nil {
|
|
ctx.NotFound()
|
|
}
|
|
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// TopicSearch search for creating topic
|
|
func TopicSearch(ctx *context.APIContext) {
|
|
// swagger:operation GET /topics/search repository topicSearch
|
|
// ---
|
|
// summary: search topics via keyword
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: q
|
|
// in: query
|
|
// description: keywords to search
|
|
// required: true
|
|
// type: string
|
|
// - 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/TopicListResponse"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
|
|
if ctx.User == nil {
|
|
ctx.Error(http.StatusForbidden, "UserIsNil", "Only owners could change the topics.")
|
|
return
|
|
}
|
|
|
|
kw := ctx.Query("q")
|
|
|
|
listOptions := utils.GetListOptions(ctx)
|
|
|
|
topics, err := models.FindTopics(&models.FindTopicOptions{
|
|
Keyword: kw,
|
|
ListOptions: listOptions,
|
|
})
|
|
if err != nil {
|
|
log.Error("SearchTopics failed: %v", err)
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
topicResponses := make([]*api.TopicResponse, len(topics))
|
|
for i, topic := range topics {
|
|
topicResponses[i] = convert.ToTopicResponse(topic)
|
|
}
|
|
ctx.JSON(http.StatusOK, map[string]interface{}{
|
|
"topics": topicResponses,
|
|
})
|
|
}
|