Skip to content

Commit ab4579a

Browse files
committed
Add API to support link package to repository and unlink it
1 parent 50873c1 commit ab4579a

File tree

6 files changed

+312
-16
lines changed

6 files changed

+312
-16
lines changed

models/packages/package.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,11 @@ func SetRepositoryLink(ctx context.Context, packageID, repoID int64) error {
228228
return err
229229
}
230230

231+
func UnlinkRepository(ctx context.Context, packageID int64) error {
232+
_, err := db.GetEngine(ctx).ID(packageID).Cols("repo_id").Update(&Package{RepoID: 0})
233+
return err
234+
}
235+
231236
// UnlinkRepositoryFromAllPackages unlinks every package from the repository
232237
func UnlinkRepositoryFromAllPackages(ctx context.Context, repoID int64) error {
233238
_, err := db.GetEngine(ctx).Where("repo_id = ?", repoID).Cols("repo_id").Update(&Package{})

routers/api/v1/api.go

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1510,13 +1510,19 @@ func Routes() *web.Router {
15101510

15111511
// NOTE: these are Gitea package management API - see packages.CommonRoutes and packages.DockerContainerRoutes for endpoints that implement package manager APIs
15121512
m.Group("/packages/{username}", func() {
1513-
m.Group("/{type}/{name}/{version}", func() {
1514-
m.Get("", reqToken(), packages.GetPackage)
1515-
m.Delete("", reqToken(), reqPackageAccess(perm.AccessModeWrite), packages.DeletePackage)
1516-
m.Get("/files", reqToken(), packages.ListPackageFiles)
1513+
m.Group("/{type}/{name}", func() {
1514+
m.Group("/{version}", func() {
1515+
m.Get("", packages.GetPackage)
1516+
m.Delete("", reqPackageAccess(perm.AccessModeWrite), packages.DeletePackage)
1517+
m.Get("/files", packages.ListPackageFiles)
1518+
})
1519+
1520+
m.Post("/-/link/{repo_name}", reqPackageAccess(perm.AccessModeWrite), packages.LinkPackage)
1521+
m.Post("/-/unlink", reqPackageAccess(perm.AccessModeWrite), packages.UnlinkPackage)
15171522
})
1518-
m.Get("/", reqToken(), packages.ListPackages)
1519-
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryPackage), context.UserAssignmentAPI(), context.PackageAssignmentAPI(), reqPackageAccess(perm.AccessModeRead), checkTokenPublicOnly())
1523+
1524+
m.Get("/", packages.ListPackages)
1525+
}, reqToken(), tokenRequiresScopes(auth_model.AccessTokenScopeCategoryPackage), context.UserAssignmentAPI(), context.PackageAssignmentAPI(), reqPackageAccess(perm.AccessModeRead), checkTokenPublicOnly())
15201526

15211527
// Organizations
15221528
m.Get("/user/orgs", reqToken(), tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser, auth_model.AccessTokenScopeCategoryOrganization), org.ListMyOrgs)

routers/api/v1/packages/package.go

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@
44
package packages
55

66
import (
7+
"errors"
78
"net/http"
89

910
"code.gitea.io/gitea/models/packages"
11+
repo_model "code.gitea.io/gitea/models/repo"
1012
"code.gitea.io/gitea/modules/optional"
1113
api "code.gitea.io/gitea/modules/structs"
14+
"code.gitea.io/gitea/modules/util"
1215
"code.gitea.io/gitea/routers/api/v1/utils"
1316
"code.gitea.io/gitea/services/context"
1417
"code.gitea.io/gitea/services/convert"
@@ -213,3 +216,116 @@ func ListPackageFiles(ctx *context.APIContext) {
213216

214217
ctx.JSON(http.StatusOK, apiPackageFiles)
215218
}
219+
220+
// LinkPackage sets a repository link for a package
221+
func LinkPackage(ctx *context.APIContext) {
222+
// swagger:operation POST /packages/{owner}/{type}/{name}/-/link/{repo_name} package linkPackage
223+
// ---
224+
// summary: Link a package to a repository
225+
// parameters:
226+
// - name: owner
227+
// in: path
228+
// description: owner of the package
229+
// type: string
230+
// required: true
231+
// - name: type
232+
// in: path
233+
// description: type of the package
234+
// type: string
235+
// required: true
236+
// - name: name
237+
// in: path
238+
// description: name of the package
239+
// type: string
240+
// required: true
241+
// - name: repo_name
242+
// in: query
243+
// description: Name of the repository to link.
244+
// type: string
245+
// required: false
246+
// responses:
247+
// "201":
248+
// "$ref": "#/responses/empty"
249+
// "404":
250+
// "$ref": "#/responses/notFound"
251+
252+
pkg, err := packages.GetPackageByName(ctx, ctx.ContextUser.ID, packages.Type(ctx.PathParam("type")), ctx.PathParam("name"))
253+
if err != nil {
254+
if errors.Is(err, util.ErrNotExist) {
255+
ctx.Error(http.StatusNotFound, "GetPackageByName", err)
256+
} else {
257+
ctx.Error(http.StatusInternalServerError, "GetPackageByName", err)
258+
}
259+
return
260+
}
261+
262+
repo, err := repo_model.GetRepositoryByName(ctx, ctx.ContextUser.ID, ctx.PathParam("repo_name"))
263+
if err != nil {
264+
if errors.Is(err, util.ErrNotExist) {
265+
ctx.Error(http.StatusNotFound, "GetRepositoryByName", err)
266+
} else {
267+
ctx.Error(http.StatusInternalServerError, "GetRepositoryByName", err)
268+
}
269+
return
270+
}
271+
272+
err = packages_service.LinkToRepository(ctx, pkg, repo, ctx.Doer)
273+
if err != nil {
274+
if errors.Is(err, util.ErrNotExist) {
275+
ctx.Error(http.StatusNotFound, "GetPackageByName", err)
276+
} else {
277+
ctx.Error(http.StatusInternalServerError, "GetPackageByName", err)
278+
}
279+
return
280+
}
281+
ctx.Status(http.StatusCreated)
282+
}
283+
284+
// UnlinkPackage sets a repository link for a package
285+
func UnlinkPackage(ctx *context.APIContext) {
286+
// swagger:operation POST /packages/{owner}/{type}/{name}/-/unlink package unlinkPackage
287+
// ---
288+
// summary: Unlink a package from a repository
289+
// parameters:
290+
// - name: owner
291+
// in: path
292+
// description: owner of the package
293+
// type: string
294+
// required: true
295+
// - name: type
296+
// in: path
297+
// description: type of the package
298+
// type: string
299+
// required: true
300+
// - name: name
301+
// in: path
302+
// description: name of the package
303+
// type: string
304+
// required: true
305+
// responses:
306+
// "201":
307+
// "$ref": "#/responses/empty"
308+
// "404":
309+
// "$ref": "#/responses/notFound"
310+
311+
pkg, err := packages.GetPackageByName(ctx, ctx.ContextUser.ID, packages.Type(ctx.PathParam("type")), ctx.PathParam("name"))
312+
if err != nil {
313+
if errors.Is(err, util.ErrNotExist) {
314+
ctx.Error(http.StatusNotFound, "GetPackageByName", err)
315+
} else {
316+
ctx.Error(http.StatusInternalServerError, "GetPackageByName", err)
317+
}
318+
return
319+
}
320+
321+
err = packages_service.UnlinkFromRepository(ctx, pkg, ctx.Doer)
322+
if err != nil {
323+
if errors.Is(err, util.ErrNotExist) {
324+
ctx.Error(http.StatusNotFound, "UnlinkFromRepository", err)
325+
} else {
326+
ctx.Error(http.StatusInternalServerError, "UnlinkFromRepository", err)
327+
}
328+
return
329+
}
330+
ctx.Status(http.StatusNoContent)
331+
}

services/packages/package_update.go

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Copyright 2025 The Gitea Authors. All rights reserved.
2+
// SPDX-License-Identifier: MIT
3+
4+
package packages
5+
6+
import (
7+
"context"
8+
"fmt"
9+
10+
org_model "code.gitea.io/gitea/models/organization"
11+
packages_model "code.gitea.io/gitea/models/packages"
12+
access_model "code.gitea.io/gitea/models/perm/access"
13+
repo_model "code.gitea.io/gitea/models/repo"
14+
"code.gitea.io/gitea/models/unit"
15+
user_model "code.gitea.io/gitea/models/user"
16+
"code.gitea.io/gitea/modules/util"
17+
)
18+
19+
func LinkToRepository(ctx context.Context, pkg *packages_model.Package, repo *repo_model.Repository, doer *user_model.User) error {
20+
if pkg.OwnerID != repo.OwnerID {
21+
return util.ErrNotExist
22+
}
23+
24+
perms, err := access_model.GetUserRepoPermission(ctx, repo, doer)
25+
if err != nil {
26+
return fmt.Errorf("error getting permissions for user %d on repository %d: %w", doer.ID, repo.ID, err)
27+
}
28+
29+
if !perms.CanWrite(unit.TypePackages) {
30+
return fmt.Errorf("no permission to link this package and repository, or packages are disabled")
31+
}
32+
33+
if err := packages_model.SetRepositoryLink(ctx, pkg.ID, repo.ID); err != nil {
34+
return fmt.Errorf("error updating package: %w", err)
35+
}
36+
return nil
37+
}
38+
39+
func UnlinkFromRepository(ctx context.Context, pkg *packages_model.Package, doer *user_model.User) error {
40+
user, err := user_model.GetUserByID(ctx, pkg.OwnerID)
41+
if err != nil {
42+
return err
43+
}
44+
if !user.IsAdmin {
45+
if !user.IsOrganization() {
46+
if doer.ID != pkg.OwnerID {
47+
return fmt.Errorf("No permission to unlink this package and repository, or packages are disabled")
48+
}
49+
} else {
50+
isOrgAdmin, err := org_model.OrgFromUser(user).IsOrgAdmin(ctx, doer.ID)
51+
if err != nil {
52+
return err
53+
} else if !isOrgAdmin {
54+
return fmt.Errorf("No permission to unlink this package and repository, or packages are disabled")
55+
}
56+
}
57+
}
58+
return packages_model.UnlinkRepository(ctx, pkg.ID)
59+
}

templates/swagger/v1_json.tmpl

Lines changed: 87 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)