summaryrefslogtreecommitdiffstats
path: root/routers/private
diff options
context:
space:
mode:
authorwxiaoguang <wxiaoguang@gmail.com>2023-03-29 14:32:26 +0800
committerGitHub <noreply@github.com>2023-03-29 14:32:26 +0800
commitf4538791f5fc82b173608fcf9c30e36ec01dc9d3 (patch)
treeeaeacc558e9b773eae9268a99146f351dd21a980 /routers/private
parent79e7a6ec1e14c820c8475173a37aee84f2f4f1e8 (diff)
downloadgitea-f4538791f5fc82b173608fcf9c30e36ec01dc9d3.tar.gz
gitea-f4538791f5fc82b173608fcf9c30e36ec01dc9d3.zip
Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687)
# Why this PR comes At first, I'd like to help users like #23636 (there are a lot) The unclear "Internal Server Error" is quite anonying, scare users, frustrate contributors, nobody knows what happens. So, it's always good to provide meaningful messages to end users (of course, do not leak sensitive information). When I started working on the "response message to end users", I found that the related code has a lot of technical debt. A lot of copy&paste code, unclear fields and usages. So I think it's good to make everything clear. # Tech Backgrounds Gitea has many sub-commands, some are used by admins, some are used by SSH servers or Git Hooks. Many sub-commands use "internal API" to communicate with Gitea web server. Before, Gitea server always use `StatusCode + Json "err" field` to return messages. * The CLI sub-commands: they expect to show all error related messages to site admin * The Serv/Hook sub-commands (for git clients): they could only show safe messages to end users, the error log could only be recorded by "SSHLog" to Gitea web server. In the old design, it assumes that: * If the StatusCode is 500 (in some functions), then the "err" field is error log, shouldn't be exposed to git client. * If the StatusCode is 40x, then the "err" field could be exposed. And some functions always read the "err" no matter what the StatusCode is. The old code is not strict, and it's difficult to distinguish the messages clearly and then output them correctly. # This PR To help to remove duplicate code and make everything clear, this PR introduces `ResponseExtra` and `requestJSONResp`. * `ResponseExtra` is a struct which contains "extra" information of a internal API response, including StatusCode, UserMsg, Error * `requestJSONResp` is a generic function which can be used for all cases to help to simplify the calls. * Remove all `map["err"]`, always use `private.Response{Err}` to construct error messages. * User messages and error messages are separated clearly, the `fail` and `handleCliResponseExtra` will output correct messages. * Replace all `Internal Server Error` messages with meaningful (still safe) messages. This PR saves more than 300 lines, while makes the git client messages more clear. Many gitea-serv/git-hook related essential functions are covered by tests. --------- Co-authored-by: delvh <dev.lh@web.de>
Diffstat (limited to 'routers/private')
-rw-r--r--routers/private/default_branch.go14
-rw-r--r--routers/private/hook_post_receive.go1
-rw-r--r--routers/private/hook_pre_receive.go39
-rw-r--r--routers/private/hook_proc_receive.go5
-rw-r--r--routers/private/hook_verification.go14
-rw-r--r--routers/private/internal.go2
-rw-r--r--routers/private/internal_repo.go26
-rw-r--r--routers/private/key.go1
-rw-r--r--routers/private/manager.go4
-rw-r--r--routers/private/manager_windows.go2
-rw-r--r--routers/private/serv.go141
11 files changed, 88 insertions, 161 deletions
diff --git a/routers/private/default_branch.go b/routers/private/default_branch.go
index 268ebbe443..b15d6ba33a 100644
--- a/routers/private/default_branch.go
+++ b/routers/private/default_branch.go
@@ -1,7 +1,6 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
@@ -14,19 +13,6 @@ import (
"code.gitea.io/gitea/modules/private"
)
-// ________ _____ .__ __
-// \______ \ _____/ ____\____ __ __| |_/ |_
-// | | \_/ __ \ __\\__ \ | | \ |\ __\
-// | ` \ ___/| | / __ \| | / |_| |
-// /_______ /\___ >__| (____ /____/|____/__|
-// \/ \/ \/
-// __________ .__
-// \______ \____________ ____ ____ | |__
-// | | _/\_ __ \__ \ / \_/ ___\| | \
-// | | \ | | \// __ \| | \ \___| Y \
-// |______ / |__| (____ /___| /\___ >___| /
-// \/ \/ \/ \/ \/
-
// SetDefaultBranch updates the default branch
func SetDefaultBranch(ctx *gitea_context.PrivateContext) {
ownerName := ctx.Params(":owner")
diff --git a/routers/private/hook_post_receive.go b/routers/private/hook_post_receive.go
index 75de47bdc4..cfe20be106 100644
--- a/routers/private/hook_post_receive.go
+++ b/routers/private/hook_post_receive.go
@@ -1,7 +1,6 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
diff --git a/routers/private/hook_pre_receive.go b/routers/private/hook_pre_receive.go
index c711fc9477..63b4a8622e 100644
--- a/routers/private/hook_pre_receive.go
+++ b/routers/private/hook_pre_receive.go
@@ -1,7 +1,6 @@
// Copyright 2019 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
@@ -69,8 +68,8 @@ func (ctx *preReceiveContext) AssertCanWriteCode() bool {
if ctx.Written() {
return false
}
- ctx.JSON(http.StatusForbidden, map[string]interface{}{
- "err": "User permission denied for writing.",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "User permission denied for writing.",
})
return false
}
@@ -95,8 +94,8 @@ func (ctx *preReceiveContext) AssertCreatePullRequest() bool {
if ctx.Written() {
return false
}
- ctx.JSON(http.StatusForbidden, map[string]interface{}{
- "err": "User permission denied for creating pull-request.",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "User permission denied for creating pull-request.",
})
return false
}
@@ -151,7 +150,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
if branchName == repo.DefaultBranch && newCommitID == git.EmptySHA {
log.Warn("Forbidden: Branch: %s is the default branch in %-v and cannot be deleted", branchName, repo)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("branch %s is the default branch and cannot be deleted", branchName),
+ UserMsg: fmt.Sprintf("branch %s is the default branch and cannot be deleted", branchName),
})
return
}
@@ -179,7 +178,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
if newCommitID == git.EmptySHA {
log.Warn("Forbidden: Branch: %s in %-v is protected from deletion", branchName, repo)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("branch %s is protected from deletion", branchName),
+ UserMsg: fmt.Sprintf("branch %s is protected from deletion", branchName),
})
return
}
@@ -196,7 +195,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
} else if len(output) > 0 {
log.Warn("Forbidden: Branch: %s in %-v is protected from force push", branchName, repo)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("branch %s is protected from force push", branchName),
+ UserMsg: fmt.Sprintf("branch %s is protected from force push", branchName),
})
return
@@ -217,7 +216,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
unverifiedCommit := err.(*errUnverifiedCommit).sha
log.Warn("Forbidden: Branch: %s in %-v is protected from unverified commit %s", branchName, repo, unverifiedCommit)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("branch %s is protected from unverified commit %s", branchName, unverifiedCommit),
+ UserMsg: fmt.Sprintf("branch %s is protected from unverified commit %s", branchName, unverifiedCommit),
})
return
}
@@ -272,7 +271,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
if changedProtectedfiles {
log.Warn("Forbidden: Branch: %s in %-v is protected from changing file %s", branchName, repo, protectedFilePath)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("branch %s is protected from changing file %s", branchName, protectedFilePath),
+ UserMsg: fmt.Sprintf("branch %s is protected from changing file %s", branchName, protectedFilePath),
})
return
}
@@ -297,7 +296,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
// Or we're simply not able to push to this protected branch
log.Warn("Forbidden: User %d is not allowed to push to protected branch: %s in %-v", ctx.opts.UserID, branchName, repo)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("Not allowed to push to protected branch %s", branchName),
+ UserMsg: fmt.Sprintf("Not allowed to push to protected branch %s", branchName),
})
return
}
@@ -333,7 +332,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
if !allowedMerge {
log.Warn("Forbidden: User %d is not allowed to push to protected branch: %s in %-v and is not allowed to merge pr #%d", ctx.opts.UserID, branchName, repo, pr.Index)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("Not allowed to push to protected branch %s", branchName),
+ UserMsg: fmt.Sprintf("Not allowed to push to protected branch %s", branchName),
})
return
}
@@ -347,7 +346,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
if changedProtectedfiles {
log.Warn("Forbidden: Branch: %s in %-v is protected from changing file %s", branchName, repo, protectedFilePath)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("branch %s is protected from changing file %s", branchName, protectedFilePath),
+ UserMsg: fmt.Sprintf("branch %s is protected from changing file %s", branchName, protectedFilePath),
})
return
}
@@ -357,7 +356,7 @@ func preReceiveBranch(ctx *preReceiveContext, oldCommitID, newCommitID, refFullN
if models.IsErrDisallowedToMerge(err) {
log.Warn("Forbidden: User %d is not allowed push to protected branch %s in %-v and pr #%d is not ready to be merged: %s", ctx.opts.UserID, branchName, repo, pr.Index, err.Error())
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("Not allowed to push to protected branch %s and pr #%d is not ready to be merged: %s", branchName, ctx.opts.PullRequestID, err.Error()),
+ UserMsg: fmt.Sprintf("Not allowed to push to protected branch %s and pr #%d is not ready to be merged: %s", branchName, ctx.opts.PullRequestID, err.Error()),
})
return
}
@@ -400,7 +399,7 @@ func preReceiveTag(ctx *preReceiveContext, oldCommitID, newCommitID, refFullName
if !isAllowed {
log.Warn("Forbidden: Tag %s in %-v is protected", tagName, ctx.Repo.Repository)
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("Tag %s is protected", tagName),
+ UserMsg: fmt.Sprintf("Tag %s is protected", tagName),
})
return
}
@@ -412,15 +411,15 @@ func preReceivePullRequest(ctx *preReceiveContext, oldCommitID, newCommitID, ref
}
if ctx.Repo.Repository.IsEmpty {
- ctx.JSON(http.StatusForbidden, map[string]interface{}{
- "err": "Can't create pull request for an empty repository.",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "Can't create pull request for an empty repository.",
})
return
}
if ctx.opts.IsWiki {
- ctx.JSON(http.StatusForbidden, map[string]interface{}{
- "err": "Pull requests are not supported on the wiki.",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "Pull requests are not supported on the wiki.",
})
return
}
@@ -443,7 +442,7 @@ func preReceivePullRequest(ctx *preReceiveContext, oldCommitID, newCommitID, ref
if !baseBranchExist {
ctx.JSON(http.StatusForbidden, private.Response{
- Err: fmt.Sprintf("Unexpected ref: %s", refFullName),
+ UserMsg: fmt.Sprintf("Unexpected ref: %s", refFullName),
})
return
}
diff --git a/routers/private/hook_proc_receive.go b/routers/private/hook_proc_receive.go
index 05921e6f58..5577120770 100644
--- a/routers/private/hook_proc_receive.go
+++ b/routers/private/hook_proc_receive.go
@@ -1,7 +1,6 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
@@ -30,8 +29,8 @@ func HookProcReceive(ctx *gitea_context.PrivateContext) {
ctx.Error(http.StatusBadRequest, "UserDoesNotHaveAccessToRepo", err.Error())
} else {
log.Error(err.Error())
- ctx.JSON(http.StatusInternalServerError, map[string]interface{}{
- "Err": err.Error(),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: err.Error(),
})
}
diff --git a/routers/private/hook_verification.go b/routers/private/hook_verification.go
index 8ccde4f3d7..caf3874ec3 100644
--- a/routers/private/hook_verification.go
+++ b/routers/private/hook_verification.go
@@ -1,7 +1,6 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
@@ -16,19 +15,6 @@ import (
"code.gitea.io/gitea/modules/log"
)
-// _________ .__ __
-// \_ ___ \ ____ _____ _____ |__|/ |_
-// / \ \/ / _ \ / \ / \| \ __\
-// \ \___( <_> ) Y Y \ Y Y \ || |
-// \______ /\____/|__|_| /__|_| /__||__|
-// \/ \/ \/
-// ____ ____ .__ _____.__ __ .__
-// \ \ / /___________|__|/ ____\__| ____ _____ _/ |_|__| ____ ____
-// \ Y // __ \_ __ \ \ __\| |/ ___\\__ \\ __\ |/ _ \ / \
-// \ /\ ___/| | \/ || | | \ \___ / __ \| | | ( <_> ) | \
-// \___/ \___ >__| |__||__| |__|\___ >____ /__| |__|\____/|___| /
-// \/ \/ \/ \/
-//
// This file contains commit verification functions for refs passed across in hooks
func verifyCommits(oldCommitID, newCommitID string, repo *git.Repository, env []string) error {
diff --git a/routers/private/internal.go b/routers/private/internal.go
index 306e4ffb00..4acede3370 100644
--- a/routers/private/internal.go
+++ b/routers/private/internal.go
@@ -1,7 +1,7 @@
// Copyright 2017 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
+// Package private contains all internal routes. The package name "internal" isn't usable because Golang reserves it for disabling cross-package usage.
package private
import (
diff --git a/routers/private/internal_repo.go b/routers/private/internal_repo.go
index bd8db0a185..5e7e82b03c 100644
--- a/routers/private/internal_repo.go
+++ b/routers/private/internal_repo.go
@@ -1,7 +1,6 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
@@ -13,23 +12,10 @@ import (
gitea_context "code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/git"
"code.gitea.io/gitea/modules/log"
+ "code.gitea.io/gitea/modules/private"
)
-// __________
-// \______ \ ____ ______ ____
-// | _// __ \\____ \ / _ \
-// | | \ ___/| |_> > <_> )
-// |____|_ /\___ > __/ \____/
-// \/ \/|__|
-// _____ .__ __
-// / _ \ ______ _____|__| ____ ____ _____ ____ _____/ |_
-// / /_\ \ / ___// ___/ |/ ___\ / \ / \_/ __ \ / \ __\
-// / | \\___ \ \___ \| / /_/ > | \ Y Y \ ___/| | \ |
-// \____|__ /____ >____ >__\___ /|___| /__|_| /\___ >___| /__|
-// \/ \/ \/ /_____/ \/ \/ \/ \/
-
-// This file contains common functions relating to setting the Repository for the
-// internal routes
+// This file contains common functions relating to setting the Repository for the internal routes
// RepoAssignment assigns the repository and gitrepository to the private context
func RepoAssignment(ctx *gitea_context.PrivateContext) context.CancelFunc {
@@ -45,8 +31,8 @@ func RepoAssignment(ctx *gitea_context.PrivateContext) context.CancelFunc {
gitRepo, err := git.OpenRepository(ctx, repo.RepoPath())
if err != nil {
log.Error("Failed to open repository: %s/%s Error: %v", ownerName, repoName, err)
- ctx.JSON(http.StatusInternalServerError, map[string]interface{}{
- "Err": fmt.Sprintf("Failed to open repository: %s/%s Error: %v", ownerName, repoName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Failed to open repository: %s/%s Error: %v", ownerName, repoName, err),
})
return nil
}
@@ -71,8 +57,8 @@ func loadRepository(ctx *gitea_context.PrivateContext, ownerName, repoName strin
repo, err := repo_model.GetRepositoryByOwnerAndName(ctx, ownerName, repoName)
if err != nil {
log.Error("Failed to get repository: %s/%s Error: %v", ownerName, repoName, err)
- ctx.JSON(http.StatusInternalServerError, map[string]interface{}{
- "Err": fmt.Sprintf("Failed to get repository: %s/%s Error: %v", ownerName, repoName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Failed to get repository: %s/%s Error: %v", ownerName, repoName, err),
})
return nil
}
diff --git a/routers/private/key.go b/routers/private/key.go
index b536019dd7..a13b4c12ae 100644
--- a/routers/private/key.go
+++ b/routers/private/key.go
@@ -1,7 +1,6 @@
// Copyright 2018 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
diff --git a/routers/private/manager.go b/routers/private/manager.go
index a56fe9d123..38ad83326f 100644
--- a/routers/private/manager.go
+++ b/routers/private/manager.go
@@ -31,14 +31,14 @@ func FlushQueues(ctx *context.PrivateContext) {
}
}()
ctx.JSON(http.StatusAccepted, private.Response{
- Err: "Flushing",
+ UserMsg: "Flushing",
})
return
}
err := queue.GetManager().FlushAll(ctx, opts.Timeout)
if err != nil {
ctx.JSON(http.StatusRequestTimeout, private.Response{
- Err: fmt.Sprintf("%v", err),
+ UserMsg: fmt.Sprintf("%v", err),
})
}
ctx.PlainText(http.StatusOK, "success")
diff --git a/routers/private/manager_windows.go b/routers/private/manager_windows.go
index b5382c7d91..bd3c3c30d0 100644
--- a/routers/private/manager_windows.go
+++ b/routers/private/manager_windows.go
@@ -16,7 +16,7 @@ import (
// Restart is not implemented for Windows based servers as they can't fork
func Restart(ctx *context.PrivateContext) {
ctx.JSON(http.StatusNotImplemented, private.Response{
- Err: "windows servers cannot be gracefully restarted - shutdown and restart manually",
+ UserMsg: "windows servers cannot be gracefully restarted - shutdown and restart manually",
})
}
diff --git a/routers/private/serv.go b/routers/private/serv.go
index 23ac011cf5..b1efc58800 100644
--- a/routers/private/serv.go
+++ b/routers/private/serv.go
@@ -1,7 +1,6 @@
// Copyright 2019 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
-// Package private includes all internal routes. The package name internal is ideal but Golang is not allowed, so we use private as package name instead.
package private
import (
@@ -29,7 +28,7 @@ func ServNoCommand(ctx *context.PrivateContext) {
keyID := ctx.ParamsInt64(":keyid")
if keyID <= 0 {
ctx.JSON(http.StatusBadRequest, private.Response{
- Err: fmt.Sprintf("Bad key id: %d", keyID),
+ UserMsg: fmt.Sprintf("Bad key id: %d", keyID),
})
}
results := private.KeyAndOwner{}
@@ -38,7 +37,7 @@ func ServNoCommand(ctx *context.PrivateContext) {
if err != nil {
if asymkey_model.IsErrKeyNotExist(err) {
ctx.JSON(http.StatusUnauthorized, private.Response{
- Err: fmt.Sprintf("Cannot find key: %d", keyID),
+ UserMsg: fmt.Sprintf("Cannot find key: %d", keyID),
})
return
}
@@ -55,7 +54,7 @@ func ServNoCommand(ctx *context.PrivateContext) {
if err != nil {
if user_model.IsErrUserNotExist(err) {
ctx.JSON(http.StatusUnauthorized, private.Response{
- Err: fmt.Sprintf("Cannot find owner with id: %d for key: %d", key.OwnerID, keyID),
+ UserMsg: fmt.Sprintf("Cannot find owner with id: %d for key: %d", key.OwnerID, keyID),
})
return
}
@@ -67,7 +66,7 @@ func ServNoCommand(ctx *context.PrivateContext) {
}
if !user.IsActive || user.ProhibitLogin {
ctx.JSON(http.StatusForbidden, private.Response{
- Err: "Your account is disabled.",
+ UserMsg: "Your account is disabled.",
})
return
}
@@ -113,23 +112,20 @@ func ServCommand(ctx *context.PrivateContext) {
if user_model.IsErrUserNotExist(err) {
// User is fetching/cloning a non-existent repository
log.Warn("Failed authentication attempt (cannot find repository: %s/%s) from %s", results.OwnerName, results.RepoName, ctx.RemoteAddr())
- ctx.JSON(http.StatusNotFound, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Cannot find repository: %s/%s", results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusNotFound, private.Response{
+ UserMsg: fmt.Sprintf("Cannot find repository: %s/%s", results.OwnerName, results.RepoName),
})
return
}
log.Error("Unable to get repository owner: %s/%s Error: %v", results.OwnerName, results.RepoName, err)
- ctx.JSON(http.StatusForbidden, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get repository owner: %s/%s %v", results.OwnerName, results.RepoName, err),
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: fmt.Sprintf("Unable to get repository owner: %s/%s %v", results.OwnerName, results.RepoName, err),
})
return
}
if !owner.IsOrganization() && !owner.IsActive {
- ctx.JSON(http.StatusForbidden, private.ErrServCommand{
- Results: results,
- Err: "Repository cannot be accessed, you could retry it later",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "Repository cannot be accessed, you could retry it later",
})
return
}
@@ -144,18 +140,16 @@ func ServCommand(ctx *context.PrivateContext) {
if verb == "git-upload-pack" {
// User is fetching/cloning a non-existent repository
log.Warn("Failed authentication attempt (cannot find repository: %s/%s) from %s", results.OwnerName, results.RepoName, ctx.RemoteAddr())
- ctx.JSON(http.StatusNotFound, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Cannot find repository: %s/%s", results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusNotFound, private.Response{
+ UserMsg: fmt.Sprintf("Cannot find repository: %s/%s", results.OwnerName, results.RepoName),
})
return
}
}
} else {
log.Error("Unable to get repository: %s/%s Error: %v", results.OwnerName, results.RepoName, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get repository: %s/%s %v", results.OwnerName, results.RepoName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Unable to get repository: %s/%s %v", results.OwnerName, results.RepoName, err),
})
return
}
@@ -167,26 +161,23 @@ func ServCommand(ctx *context.PrivateContext) {
results.RepoID = repo.ID
if repo.IsBeingCreated() {
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: "Repository is being created, you could retry after it finished",
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: "Repository is being created, you could retry after it finished",
})
return
}
if repo.IsBroken() {
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: "Repository is in a broken state",
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: "Repository is in a broken state",
})
return
}
// We can shortcut at this point if the repo is a mirror
if mode > perm.AccessModeRead && repo.IsMirror {
- ctx.JSON(http.StatusForbidden, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Mirror Repository %s/%s is read-only", results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: fmt.Sprintf("Mirror Repository %s/%s is read-only", results.OwnerName, results.RepoName),
})
return
}
@@ -196,16 +187,14 @@ func ServCommand(ctx *context.PrivateContext) {
key, err := asymkey_model.GetPublicKeyByID(keyID)
if err != nil {
if asymkey_model.IsErrKeyNotExist(err) {
- ctx.JSON(http.StatusNotFound, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Cannot find key: %d", keyID),
+ ctx.JSON(http.StatusNotFound, private.Response{
+ UserMsg: fmt.Sprintf("Cannot find key: %d", keyID),
})
return
}
log.Error("Unable to get public key: %d Error: %v", keyID, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get key: %d Error: %v", keyID, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Unable to get key: %d Error: %v", keyID, err),
})
return
}
@@ -215,9 +204,8 @@ func ServCommand(ctx *context.PrivateContext) {
// If repo doesn't exist, deploy key doesn't make sense
if !repoExist && key.Type == asymkey_model.KeyTypeDeploy {
- ctx.JSON(http.StatusNotFound, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Cannot find repository %s/%s", results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusNotFound, private.Response{
+ UserMsg: fmt.Sprintf("Cannot find repository %s/%s", results.OwnerName, results.RepoName),
})
return
}
@@ -232,16 +220,14 @@ func ServCommand(ctx *context.PrivateContext) {
deployKey, err = asymkey_model.GetDeployKeyByRepo(ctx, key.ID, repo.ID)
if err != nil {
if asymkey_model.IsErrDeployKeyNotExist(err) {
- ctx.JSON(http.StatusNotFound, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Public (Deploy) Key: %d:%s is not authorized to %s %s/%s.", key.ID, key.Name, modeString, results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusNotFound, private.Response{
+ UserMsg: fmt.Sprintf("Public (Deploy) Key: %d:%s is not authorized to %s %s/%s.", key.ID, key.Name, modeString, results.OwnerName, results.RepoName),
})
return
}
log.Error("Unable to get deploy for public (deploy) key: %d in %-v Error: %v", key.ID, repo, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get Deploy Key for Public Key: %d:%s in %s/%s.", key.ID, key.Name, results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Unable to get Deploy Key for Public Key: %d:%s in %s/%s.", key.ID, key.Name, results.OwnerName, results.RepoName),
})
return
}
@@ -262,23 +248,21 @@ func ServCommand(ctx *context.PrivateContext) {
user, err = user_model.GetUserByID(ctx, key.OwnerID)
if err != nil {
if user_model.IsErrUserNotExist(err) {
- ctx.JSON(http.StatusUnauthorized, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Public Key: %d:%s owner %d does not exist.", key.ID, key.Name, key.OwnerID),
+ ctx.JSON(http.StatusUnauthorized, private.Response{
+ UserMsg: fmt.Sprintf("Public Key: %d:%s owner %d does not exist.", key.ID, key.Name, key.OwnerID),
})
return
}
log.Error("Unable to get owner: %d for public key: %d:%s Error: %v", key.OwnerID, key.ID, key.Name, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get Owner: %d for Deploy Key: %d:%s in %s/%s.", key.OwnerID, key.ID, key.Name, ownerName, repoName),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Unable to get Owner: %d for Deploy Key: %d:%s in %s/%s.", key.OwnerID, key.ID, key.Name, ownerName, repoName),
})
return
}
if !user.IsActive || user.ProhibitLogin {
ctx.JSON(http.StatusForbidden, private.Response{
- Err: "Your account is disabled.",
+ UserMsg: "Your account is disabled.",
})
return
}
@@ -291,9 +275,8 @@ func ServCommand(ctx *context.PrivateContext) {
// Don't allow pushing if the repo is archived
if repoExist && mode > perm.AccessModeRead && repo.IsArchived {
- ctx.JSON(http.StatusUnauthorized, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Repo: %s/%s is archived.", results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusUnauthorized, private.Response{
+ UserMsg: fmt.Sprintf("Repo: %s/%s is archived.", results.OwnerName, results.RepoName),
})
return
}
@@ -307,9 +290,8 @@ func ServCommand(ctx *context.PrivateContext) {
setting.Service.RequireSignInView) {
if key.Type == asymkey_model.KeyTypeDeploy {
if deployKey.Mode < mode {
- ctx.JSON(http.StatusUnauthorized, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Deploy Key: %d:%s is not authorized to %s %s/%s.", key.ID, key.Name, modeString, results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusUnauthorized, private.Response{
+ UserMsg: fmt.Sprintf("Deploy Key: %d:%s is not authorized to %s %s/%s.", key.ID, key.Name, modeString, results.OwnerName, results.RepoName),
})
return
}
@@ -322,9 +304,8 @@ func ServCommand(ctx *context.PrivateContext) {
perm, err := access_model.GetUserRepoPermission(ctx, repo, user)
if err != nil {
log.Error("Unable to get permissions for %-v with key %d in %-v Error: %v", user, key.ID, repo, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get permissions for user %d:%s with key %d in %s/%s Error: %v", user.ID, user.Name, key.ID, results.OwnerName, results.RepoName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Unable to get permissions for user %d:%s with key %d in %s/%s Error: %v", user.ID, user.Name, key.ID, results.OwnerName, results.RepoName, err),
})
return
}
@@ -333,9 +314,8 @@ func ServCommand(ctx *context.PrivateContext) {
if userMode < mode {
log.Warn("Failed authentication attempt for %s with key %s (not authorized to %s %s/%s) from %s", user.Name, key.Name, modeString, ownerName, repoName, ctx.RemoteAddr())
- ctx.JSON(http.StatusUnauthorized, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("User: %d:%s with Key: %d:%s is not authorized to %s %s/%s.", user.ID, user.Name, key.ID, key.Name, modeString, ownerName, repoName),
+ ctx.JSON(http.StatusUnauthorized, private.Response{
+ UserMsg: fmt.Sprintf("User: %d:%s with Key: %d:%s is not authorized to %s %s/%s.", user.ID, user.Name, key.ID, key.Name, modeString, ownerName, repoName),
})
return
}
@@ -346,24 +326,21 @@ func ServCommand(ctx *context.PrivateContext) {
if !repoExist {
owner, err := user_model.GetUserByName(ctx, ownerName)
if err != nil {
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Unable to get owner: %s %v", results.OwnerName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Unable to get owner: %s %v", results.OwnerName, err),
})
return
}
if owner.IsOrganization() && !setting.Repository.EnablePushCreateOrg {
- ctx.JSON(http.StatusForbidden, private.ErrServCommand{
- Results: results,
- Err: "Push to create is not enabled for organizations.",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "Push to create is not enabled for organizations.",
})
return
}
if !owner.IsOrganization() && !setting.Repository.EnablePushCreateUser {
- ctx.JSON(http.StatusForbidden, private.ErrServCommand{
- Results: results,
- Err: "Push to create is not enabled for users.",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "Push to create is not enabled for users.",
})
return
}
@@ -371,9 +348,8 @@ func ServCommand(ctx *context.PrivateContext) {
repo, err = repo_service.PushCreateRepo(ctx, user, owner, results.RepoName)
if err != nil {
log.Error("pushCreateRepo: %v", err)
- ctx.JSON(http.StatusNotFound, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Cannot find repository: %s/%s", results.OwnerName, results.RepoName),
+ ctx.JSON(http.StatusNotFound, private.Response{
+ UserMsg: fmt.Sprintf("Cannot find repository: %s/%s", results.OwnerName, results.RepoName),
})
return
}
@@ -384,16 +360,14 @@ func ServCommand(ctx *context.PrivateContext) {
// Ensure the wiki is enabled before we allow access to it
if _, err := repo.GetUnit(ctx, unit.TypeWiki); err != nil {
if repo_model.IsErrUnitTypeNotExist(err) {
- ctx.JSON(http.StatusForbidden, private.ErrServCommand{
- Results: results,
- Err: "repository wiki is disabled",
+ ctx.JSON(http.StatusForbidden, private.Response{
+ UserMsg: "repository wiki is disabled",
})
return
}
log.Error("Failed to get the wiki unit in %-v Error: %v", repo, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Failed to get the wiki unit in %s/%s Error: %v", ownerName, repoName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Failed to get the wiki unit in %s/%s Error: %v", ownerName, repoName, err),
})
return
}
@@ -401,9 +375,8 @@ func ServCommand(ctx *context.PrivateContext) {
// Finally if we're trying to touch the wiki we should init it
if err = wiki_service.InitWiki(ctx, repo); err != nil {
log.Error("Failed to initialize the wiki in %-v Error: %v", repo, err)
- ctx.JSON(http.StatusInternalServerError, private.ErrServCommand{
- Results: results,
- Err: fmt.Sprintf("Failed to initialize the wiki in %s/%s Error: %v", ownerName, repoName, err),
+ ctx.JSON(http.StatusInternalServerError, private.Response{
+ Err: fmt.Sprintf("Failed to initialize the wiki in %s/%s Error: %v", ownerName, repoName, err),
})
return
}