mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-15 22:38:31 +01:00
e1fe3bbdc0
This is an implementation of a quota engine, and the API routes to manage its settings. This does *not* contain any enforcement code: this is just the bedrock, the engine itself. The goal of the engine is to be flexible and future proof: to be nimble enough to build on it further, without having to rewrite large parts of it. It might feel a little more complicated than necessary, because the goal was to be able to support scenarios only very few Forgejo instances need, scenarios the vast majority of mostly smaller instances simply do not care about. The goal is to support both big and small, and for that, we need a solid, flexible foundation. There are thee big parts to the engine: counting quota use, setting limits, and evaluating whether the usage is within the limits. Sounds simple on paper, less so in practice! Quota counting ============== Quota is counted based on repo ownership, whenever possible, because repo owners are in ultimate control over the resources they use: they can delete repos, attachments, everything, even if they don't *own* those themselves. They can clean up, and will always have the permission and access required to do so. Would we count quota based on the owning user, that could lead to situations where a user is unable to free up space, because they uploaded a big attachment to a repo that has been taken private since. It's both more fair, and much safer to count quota against repo owners. This means that if user A uploads an attachment to an issue opened against organization O, that will count towards the quota of organization O, rather than user A. One's quota usage stats can be queried using the `/user/quota` API endpoint. To figure out what's eating into it, the `/user/repos?order_by=size`, `/user/quota/attachments`, `/user/quota/artifacts`, and `/user/quota/packages` endpoints should be consulted. There's also `/user/quota/check?subject=<...>` to check whether the signed-in user is within a particular quota limit. Quotas are counted based on sizes stored in the database. Setting quota limits ==================== There are different "subjects" one can limit usage for. At this time, only size-based limits are implemented, which are: - `size:all`: As the name would imply, the total size of everything Forgejo tracks. - `size:repos:all`: The total size of all repositories (not including LFS). - `size:repos:public`: The total size of all public repositories (not including LFS). - `size:repos:private`: The total size of all private repositories (not including LFS). - `sizeall`: The total size of all git data (including all repositories, and LFS). - `size
102 lines
2.9 KiB
Go
102 lines
2.9 KiB
Go
// Copyright 2024 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package shared
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
quota_model "code.gitea.io/gitea/models/quota"
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
|
"code.gitea.io/gitea/services/context"
|
|
"code.gitea.io/gitea/services/convert"
|
|
)
|
|
|
|
func GetQuota(ctx *context.APIContext, userID int64) {
|
|
used, err := quota_model.GetUsedForUser(ctx, userID)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "quota_model.GetUsedForUser", err)
|
|
return
|
|
}
|
|
|
|
groups, err := quota_model.GetGroupsForUser(ctx, userID)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "quota_model.GetGroupsForUser", err)
|
|
return
|
|
}
|
|
|
|
result := convert.ToQuotaInfo(used, groups, false)
|
|
ctx.JSON(http.StatusOK, &result)
|
|
}
|
|
|
|
func CheckQuota(ctx *context.APIContext, userID int64) {
|
|
subjectQuery := ctx.FormTrim("subject")
|
|
|
|
subject, err := quota_model.ParseLimitSubject(subjectQuery)
|
|
if err != nil {
|
|
ctx.Error(http.StatusUnprocessableEntity, "quota_model.ParseLimitSubject", err)
|
|
return
|
|
}
|
|
|
|
ok, err := quota_model.EvaluateForUser(ctx, userID, subject)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "quota_model.EvaluateForUser", err)
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, &ok)
|
|
}
|
|
|
|
func ListQuotaAttachments(ctx *context.APIContext, userID int64) {
|
|
opts := utils.GetListOptions(ctx)
|
|
count, attachments, err := quota_model.GetQuotaAttachmentsForUser(ctx, userID, opts)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetQuotaAttachmentsForUser", err)
|
|
return
|
|
}
|
|
|
|
result, err := convert.ToQuotaUsedAttachmentList(ctx, *attachments)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "convert.ToQuotaUsedAttachmentList", err)
|
|
}
|
|
|
|
ctx.SetLinkHeader(int(count), opts.PageSize)
|
|
ctx.SetTotalCountHeader(count)
|
|
ctx.JSON(http.StatusOK, result)
|
|
}
|
|
|
|
func ListQuotaPackages(ctx *context.APIContext, userID int64) {
|
|
opts := utils.GetListOptions(ctx)
|
|
count, packages, err := quota_model.GetQuotaPackagesForUser(ctx, userID, opts)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetQuotaPackagesForUser", err)
|
|
return
|
|
}
|
|
|
|
result, err := convert.ToQuotaUsedPackageList(ctx, *packages)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "convert.ToQuotaUsedPackageList", err)
|
|
}
|
|
|
|
ctx.SetLinkHeader(int(count), opts.PageSize)
|
|
ctx.SetTotalCountHeader(count)
|
|
ctx.JSON(http.StatusOK, result)
|
|
}
|
|
|
|
func ListQuotaArtifacts(ctx *context.APIContext, userID int64) {
|
|
opts := utils.GetListOptions(ctx)
|
|
count, artifacts, err := quota_model.GetQuotaArtifactsForUser(ctx, userID, opts)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetQuotaArtifactsForUser", err)
|
|
return
|
|
}
|
|
|
|
result, err := convert.ToQuotaUsedArtifactList(ctx, *artifacts)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "convert.ToQuotaUsedArtifactList", err)
|
|
}
|
|
|
|
ctx.SetLinkHeader(int(count), opts.PageSize)
|
|
ctx.SetTotalCountHeader(count)
|
|
ctx.JSON(http.StatusOK, result)
|
|
}
|