mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-31 09:31:53 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			438 lines
		
	
	
		
			12 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			438 lines
		
	
	
		
			12 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2021 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package rubygems
 | |
| 
 | |
| import (
 | |
| 	"compress/gzip"
 | |
| 	"compress/zlib"
 | |
| 	"crypto/md5"
 | |
| 	"errors"
 | |
| 	"fmt"
 | |
| 	"io"
 | |
| 	"net/http"
 | |
| 	"strings"
 | |
| 
 | |
| 	packages_model "code.gitea.io/gitea/models/packages"
 | |
| 	"code.gitea.io/gitea/modules/optional"
 | |
| 	packages_module "code.gitea.io/gitea/modules/packages"
 | |
| 	rubygems_module "code.gitea.io/gitea/modules/packages/rubygems"
 | |
| 	"code.gitea.io/gitea/modules/util"
 | |
| 	"code.gitea.io/gitea/routers/api/packages/helper"
 | |
| 	"code.gitea.io/gitea/services/context"
 | |
| 	packages_service "code.gitea.io/gitea/services/packages"
 | |
| )
 | |
| 
 | |
| func apiError(ctx *context.Context, status int, obj any) {
 | |
| 	helper.LogAndProcessError(ctx, status, obj, func(message string) {
 | |
| 		ctx.PlainText(status, message)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| // EnumeratePackages serves the package list
 | |
| func EnumeratePackages(ctx *context.Context) {
 | |
| 	packages, err := packages_model.GetVersionsByPackageType(ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	enumeratePackages(ctx, "specs.4.8", packages)
 | |
| }
 | |
| 
 | |
| // EnumeratePackagesLatest serves the list of the latest version of every package
 | |
| func EnumeratePackagesLatest(ctx *context.Context) {
 | |
| 	pvs, _, err := packages_model.SearchLatestVersions(ctx, &packages_model.PackageSearchOptions{
 | |
| 		OwnerID:    ctx.Package.Owner.ID,
 | |
| 		Type:       packages_model.TypeRubyGems,
 | |
| 		IsInternal: optional.Some(false),
 | |
| 	})
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	enumeratePackages(ctx, "latest_specs.4.8", pvs)
 | |
| }
 | |
| 
 | |
| // EnumeratePackagesPreRelease is not supported and serves an empty list
 | |
| func EnumeratePackagesPreRelease(ctx *context.Context) {
 | |
| 	enumeratePackages(ctx, "prerelease_specs.4.8", []*packages_model.PackageVersion{})
 | |
| }
 | |
| 
 | |
| func enumeratePackages(ctx *context.Context, filename string, pvs []*packages_model.PackageVersion) {
 | |
| 	pds, err := packages_model.GetPackageDescriptors(ctx, pvs)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	specs := make([]any, 0, len(pds))
 | |
| 	for _, p := range pds {
 | |
| 		specs = append(specs, []any{
 | |
| 			p.Package.Name,
 | |
| 			&rubygems_module.RubyUserMarshal{
 | |
| 				Name:  "Gem::Version",
 | |
| 				Value: []string{p.Version.Version},
 | |
| 			},
 | |
| 			p.Metadata.(*rubygems_module.Metadata).Platform,
 | |
| 		})
 | |
| 	}
 | |
| 
 | |
| 	ctx.SetServeHeaders(&context.ServeHeaderOptions{
 | |
| 		Filename: filename + ".gz",
 | |
| 	})
 | |
| 
 | |
| 	zw := gzip.NewWriter(ctx.Resp)
 | |
| 	defer zw.Close()
 | |
| 
 | |
| 	zw.Name = filename
 | |
| 
 | |
| 	if err := rubygems_module.NewMarshalEncoder(zw).Encode(specs); err != nil {
 | |
| 		ctx.ServerError("Download file failed", err)
 | |
| 	}
 | |
| }
 | |
| 
 | |
| // ServePackageSpecification serves the compressed Gemspec file of a package
 | |
| func ServePackageSpecification(ctx *context.Context) {
 | |
| 	filename := ctx.PathParam("filename")
 | |
| 
 | |
| 	if !strings.HasSuffix(filename, ".gemspec.rz") {
 | |
| 		apiError(ctx, http.StatusNotImplemented, nil)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	pvs, err := getVersionsByFilename(ctx, filename[:len(filename)-10]+"gem")
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	if len(pvs) != 1 {
 | |
| 		apiError(ctx, http.StatusNotFound, nil)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	pd, err := packages_model.GetPackageDescriptor(ctx, pvs[0])
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	ctx.SetServeHeaders(&context.ServeHeaderOptions{
 | |
| 		Filename: filename,
 | |
| 	})
 | |
| 
 | |
| 	zw := zlib.NewWriter(ctx.Resp)
 | |
| 	defer zw.Close()
 | |
| 
 | |
| 	metadata := pd.Metadata.(*rubygems_module.Metadata)
 | |
| 
 | |
| 	// create a Ruby Gem::Specification object
 | |
| 	spec := &rubygems_module.RubyUserDef{
 | |
| 		Name: "Gem::Specification",
 | |
| 		Value: []any{
 | |
| 			"3.2.3", // @rubygems_version
 | |
| 			4,       // @specification_version,
 | |
| 			pd.Package.Name,
 | |
| 			&rubygems_module.RubyUserMarshal{
 | |
| 				Name:  "Gem::Version",
 | |
| 				Value: []string{pd.Version.Version},
 | |
| 			},
 | |
| 			nil,               // date
 | |
| 			metadata.Summary,  // @summary
 | |
| 			nil,               // @required_ruby_version
 | |
| 			nil,               // @required_rubygems_version
 | |
| 			metadata.Platform, // @original_platform
 | |
| 			[]any{},           // @dependencies
 | |
| 			nil,               // rubyforge_project
 | |
| 			"",                // @email
 | |
| 			metadata.Authors,
 | |
| 			metadata.Description,
 | |
| 			metadata.ProjectURL,
 | |
| 			true,              // has_rdoc
 | |
| 			metadata.Platform, // @new_platform
 | |
| 			nil,
 | |
| 			metadata.Licenses,
 | |
| 		},
 | |
| 	}
 | |
| 
 | |
| 	if err := rubygems_module.NewMarshalEncoder(zw).Encode(spec); err != nil {
 | |
| 		ctx.ServerError("Download file failed", err)
 | |
| 	}
 | |
| }
 | |
| 
 | |
| // DownloadPackageFile serves the content of a package
 | |
| func DownloadPackageFile(ctx *context.Context) {
 | |
| 	filename := ctx.PathParam("filename")
 | |
| 
 | |
| 	pvs, err := getVersionsByFilename(ctx, filename)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	if len(pvs) != 1 {
 | |
| 		apiError(ctx, http.StatusNotFound, nil)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	s, u, pf, err := packages_service.GetFileStreamByPackageVersion(
 | |
| 		ctx,
 | |
| 		pvs[0],
 | |
| 		&packages_service.PackageFileInfo{
 | |
| 			Filename: filename,
 | |
| 		},
 | |
| 	)
 | |
| 	if err != nil {
 | |
| 		if errors.Is(err, packages_model.ErrPackageFileNotExist) {
 | |
| 			apiError(ctx, http.StatusNotFound, err)
 | |
| 			return
 | |
| 		}
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	helper.ServePackageFile(ctx, s, u, pf)
 | |
| }
 | |
| 
 | |
| // UploadPackageFile adds a file to the package. If the package does not exist, it gets created.
 | |
| func UploadPackageFile(ctx *context.Context) {
 | |
| 	upload, needToClose, err := ctx.UploadStream()
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusBadRequest, err)
 | |
| 		return
 | |
| 	}
 | |
| 	if needToClose {
 | |
| 		defer upload.Close()
 | |
| 	}
 | |
| 
 | |
| 	buf, err := packages_module.CreateHashedBufferFromReader(upload)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 	defer buf.Close()
 | |
| 
 | |
| 	rp, err := rubygems_module.ParsePackageMetaData(buf)
 | |
| 	if err != nil {
 | |
| 		if errors.Is(err, util.ErrInvalidArgument) {
 | |
| 			apiError(ctx, http.StatusBadRequest, err)
 | |
| 		} else {
 | |
| 			apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		}
 | |
| 		return
 | |
| 	}
 | |
| 	if _, err := buf.Seek(0, io.SeekStart); err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	filename := makeGemFullFileName(rp.Name, rp.Version, rp.Metadata.Platform)
 | |
| 
 | |
| 	_, _, err = packages_service.CreatePackageAndAddFile(
 | |
| 		ctx,
 | |
| 		&packages_service.PackageCreationInfo{
 | |
| 			PackageInfo: packages_service.PackageInfo{
 | |
| 				Owner:       ctx.Package.Owner,
 | |
| 				PackageType: packages_model.TypeRubyGems,
 | |
| 				Name:        rp.Name,
 | |
| 				Version:     rp.Version,
 | |
| 			},
 | |
| 			SemverCompatible: true,
 | |
| 			Creator:          ctx.Doer,
 | |
| 			Metadata:         rp.Metadata,
 | |
| 		},
 | |
| 		&packages_service.PackageFileCreationInfo{
 | |
| 			PackageFileInfo: packages_service.PackageFileInfo{
 | |
| 				Filename: filename,
 | |
| 			},
 | |
| 			Creator: ctx.Doer,
 | |
| 			Data:    buf,
 | |
| 			IsLead:  true,
 | |
| 		},
 | |
| 	)
 | |
| 	if err != nil {
 | |
| 		switch err {
 | |
| 		case packages_model.ErrDuplicatePackageVersion:
 | |
| 			apiError(ctx, http.StatusConflict, err)
 | |
| 		case packages_service.ErrQuotaTotalCount, packages_service.ErrQuotaTypeSize, packages_service.ErrQuotaTotalSize:
 | |
| 			apiError(ctx, http.StatusForbidden, err)
 | |
| 		default:
 | |
| 			apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		}
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	ctx.Status(http.StatusCreated)
 | |
| }
 | |
| 
 | |
| // DeletePackage deletes a package
 | |
| func DeletePackage(ctx *context.Context) {
 | |
| 	// Go populates the form only for POST, PUT and PATCH requests
 | |
| 	if err := ctx.Req.ParseMultipartForm(32 << 20); err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 	packageName := ctx.FormString("gem_name")
 | |
| 	packageVersion := ctx.FormString("version")
 | |
| 
 | |
| 	err := packages_service.RemovePackageVersionByNameAndVersion(
 | |
| 		ctx,
 | |
| 		ctx.Doer,
 | |
| 		&packages_service.PackageInfo{
 | |
| 			Owner:       ctx.Package.Owner,
 | |
| 			PackageType: packages_model.TypeRubyGems,
 | |
| 			Name:        packageName,
 | |
| 			Version:     packageVersion,
 | |
| 		},
 | |
| 	)
 | |
| 	if err != nil {
 | |
| 		if errors.Is(err, packages_model.ErrPackageNotExist) {
 | |
| 			apiError(ctx, http.StatusNotFound, err)
 | |
| 			return
 | |
| 		}
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 	}
 | |
| }
 | |
| 
 | |
| // GetPackageInfo returns a custom text based format for the single rubygem with a line for each version of the rubygem
 | |
| // ref: https://guides.rubygems.org/rubygems-org-compact-index-api/
 | |
| func GetPackageInfo(ctx *context.Context) {
 | |
| 	packageName := ctx.PathParam("packagename")
 | |
| 	versions, err := packages_model.GetVersionsByPackageName(ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems, packageName)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 	if len(versions) == 0 {
 | |
| 		apiError(ctx, http.StatusNotFound, nil)
 | |
| 		return
 | |
| 	}
 | |
| 	infoContent, err := makePackageInfo(ctx, versions)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 	ctx.PlainText(http.StatusOK, infoContent)
 | |
| }
 | |
| 
 | |
| // GetAllPackagesVersions returns a custom text based format containing information about all versions of all rubygems.
 | |
| // ref: https://guides.rubygems.org/rubygems-org-compact-index-api/
 | |
| func GetAllPackagesVersions(ctx *context.Context) {
 | |
| 	packages, err := packages_model.GetPackagesByType(ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems)
 | |
| 	if err != nil {
 | |
| 		apiError(ctx, http.StatusInternalServerError, err)
 | |
| 		return
 | |
| 	}
 | |
| 
 | |
| 	out := &strings.Builder{}
 | |
| 	out.WriteString("---\n")
 | |
| 	for _, pkg := range packages {
 | |
| 		versions, err := packages_model.GetVersionsByPackageName(ctx, ctx.Package.Owner.ID, packages_model.TypeRubyGems, pkg.Name)
 | |
| 		if err != nil {
 | |
| 			apiError(ctx, http.StatusInternalServerError, err)
 | |
| 			return
 | |
| 		}
 | |
| 		if len(versions) == 0 {
 | |
| 			continue
 | |
| 		}
 | |
| 
 | |
| 		info, err := makePackageInfo(ctx, versions)
 | |
| 		if err != nil {
 | |
| 			apiError(ctx, http.StatusInternalServerError, err)
 | |
| 			return
 | |
| 		}
 | |
| 
 | |
| 		// format: RUBYGEM [-]VERSION_PLATFORM[,VERSION_PLATFORM],...] MD5
 | |
| 		_, _ = fmt.Fprintf(out, "%s ", pkg.Name)
 | |
| 		for i, v := range versions {
 | |
| 			sep := util.Iif(i == len(versions)-1, "", ",")
 | |
| 			_, _ = fmt.Fprintf(out, "%s%s", v.Version, sep)
 | |
| 		}
 | |
| 		_, _ = fmt.Fprintf(out, " %x\n", md5.Sum([]byte(info)))
 | |
| 	}
 | |
| 
 | |
| 	ctx.PlainText(http.StatusOK, out.String())
 | |
| }
 | |
| 
 | |
| func writePackageVersionRequirements(prefix string, reqs []rubygems_module.VersionRequirement, out *strings.Builder) {
 | |
| 	out.WriteString(prefix)
 | |
| 	if len(reqs) == 0 {
 | |
| 		reqs = []rubygems_module.VersionRequirement{{Restriction: ">=", Version: "0"}}
 | |
| 	}
 | |
| 	for i, req := range reqs {
 | |
| 		sep := util.Iif(i == 0, "", "&")
 | |
| 		_, _ = fmt.Fprintf(out, "%s%s %s", sep, req.Restriction, req.Version)
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func makePackageVersionDependency(ctx *context.Context, version *packages_model.PackageVersion) (string, error) {
 | |
| 	// format: VERSION[-PLATFORM] [DEPENDENCY[,DEPENDENCY,...]]|REQUIREMENT[,REQUIREMENT,...]
 | |
| 	// DEPENDENCY: GEM:CONSTRAINT[&CONSTRAINT]
 | |
| 	// REQUIREMENT: KEY:VALUE (always contains "checksum")
 | |
| 	pd, err := packages_model.GetPackageDescriptor(ctx, version)
 | |
| 	if err != nil {
 | |
| 		return "", err
 | |
| 	}
 | |
| 
 | |
| 	metadata := pd.Metadata.(*rubygems_module.Metadata)
 | |
| 	fullFilename := makeGemFullFileName(pd.Package.Name, version.Version, metadata.Platform)
 | |
| 	file, err := packages_model.GetFileForVersionByName(ctx, version.ID, fullFilename, "")
 | |
| 	if err != nil {
 | |
| 		return "", err
 | |
| 	}
 | |
| 	blob, err := packages_model.GetBlobByID(ctx, file.BlobID)
 | |
| 	if err != nil {
 | |
| 		return "", err
 | |
| 	}
 | |
| 
 | |
| 	buf := &strings.Builder{}
 | |
| 	buf.WriteString(version.Version)
 | |
| 	buf.WriteByte(' ')
 | |
| 	for i, dep := range metadata.RuntimeDependencies {
 | |
| 		sep := util.Iif(i == 0, "", ",")
 | |
| 		writePackageVersionRequirements(fmt.Sprintf("%s%s:", sep, dep.Name), dep.Version, buf)
 | |
| 	}
 | |
| 	_, _ = fmt.Fprintf(buf, "|checksum:%s", blob.HashSHA256)
 | |
| 	if len(metadata.RequiredRubyVersion) != 0 {
 | |
| 		writePackageVersionRequirements(",ruby:", metadata.RequiredRubyVersion, buf)
 | |
| 	}
 | |
| 	if len(metadata.RequiredRubygemsVersion) != 0 {
 | |
| 		writePackageVersionRequirements(",rubygems:", metadata.RequiredRubygemsVersion, buf)
 | |
| 	}
 | |
| 	return buf.String(), nil
 | |
| }
 | |
| 
 | |
| func makePackageInfo(ctx *context.Context, versions []*packages_model.PackageVersion) (string, error) {
 | |
| 	ret := "---\n"
 | |
| 	for _, v := range versions {
 | |
| 		dep, err := makePackageVersionDependency(ctx, v)
 | |
| 		if err != nil {
 | |
| 			return "", err
 | |
| 		}
 | |
| 		ret += dep + "\n"
 | |
| 	}
 | |
| 	return ret, nil
 | |
| }
 | |
| 
 | |
| func makeGemFullFileName(gemName, version, platform string) string {
 | |
| 	var basename string
 | |
| 	if platform == "" || platform == "ruby" {
 | |
| 		basename = fmt.Sprintf("%s-%s", gemName, version)
 | |
| 	} else {
 | |
| 		basename = fmt.Sprintf("%s-%s-%s", gemName, version, platform)
 | |
| 	}
 | |
| 	return strings.ToLower(basename) + ".gem"
 | |
| }
 | |
| 
 | |
| func getVersionsByFilename(ctx *context.Context, filename string) ([]*packages_model.PackageVersion, error) {
 | |
| 	pvs, _, err := packages_model.SearchVersions(ctx, &packages_model.PackageSearchOptions{
 | |
| 		OwnerID:         ctx.Package.Owner.ID,
 | |
| 		Type:            packages_model.TypeRubyGems,
 | |
| 		HasFileWithName: filename,
 | |
| 		IsInternal:      optional.Some(false),
 | |
| 	})
 | |
| 	return pvs, err
 | |
| }
 |