mirror of
https://github.com/go-gitea/gitea.git
synced 2025-07-10 12:39:53 +00:00
f88800d545
Fixes #21291, allowing icons and other missing attributes to appear for NuGet packages from inside Visual Studio like they do with GitHub Nuget packages. Adds additional NuGet package information, particularly `IconURL`, to bring the Gitea NuGet API more in-line with GitHub's NuGet API. ref: https://learn.microsoft.com/en-us/nuget/api/search-query-service-resource
316 lines
13 KiB
Go
316 lines
13 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package nuget
|
|
|
|
import (
|
|
"sort"
|
|
"time"
|
|
|
|
packages_model "code.gitea.io/gitea/models/packages"
|
|
nuget_module "code.gitea.io/gitea/modules/packages/nuget"
|
|
|
|
"golang.org/x/text/collate"
|
|
"golang.org/x/text/language"
|
|
)
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/service-index#resources
|
|
type ServiceIndexResponseV3 struct {
|
|
Version string `json:"version"`
|
|
Resources []ServiceResource `json:"resources"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/service-index#resource
|
|
type ServiceResource struct {
|
|
ID string `json:"@id"`
|
|
Type string `json:"@type"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#response
|
|
type RegistrationIndexResponse struct {
|
|
RegistrationIndexURL string `json:"@id"`
|
|
Type []string `json:"@type"`
|
|
Count int `json:"count"`
|
|
Pages []*RegistrationIndexPage `json:"items"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-page-object
|
|
type RegistrationIndexPage struct {
|
|
RegistrationPageURL string `json:"@id"`
|
|
Lower string `json:"lower"`
|
|
Upper string `json:"upper"`
|
|
Count int `json:"count"`
|
|
Items []*RegistrationIndexPageItem `json:"items"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-leaf-object-in-a-page
|
|
type RegistrationIndexPageItem struct {
|
|
RegistrationLeafURL string `json:"@id"`
|
|
PackageContentURL string `json:"packageContent"`
|
|
CatalogEntry *CatalogEntry `json:"catalogEntry"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#catalog-entry
|
|
type CatalogEntry struct {
|
|
CatalogLeafURL string `json:"@id"`
|
|
Authors string `json:"authors"`
|
|
Copyright string `json:"copyright"`
|
|
DependencyGroups []*PackageDependencyGroup `json:"dependencyGroups"`
|
|
Description string `json:"description"`
|
|
IconURL string `json:"iconUrl"`
|
|
ID string `json:"id"`
|
|
IsPrerelease bool `json:"isPrerelease"`
|
|
Language string `json:"language"`
|
|
LicenseURL string `json:"licenseUrl"`
|
|
PackageContentURL string `json:"packageContent"`
|
|
ProjectURL string `json:"projectUrl"`
|
|
RequireLicenseAcceptance bool `json:"requireLicenseAcceptance"`
|
|
Summary string `json:"summary"`
|
|
Tags string `json:"tags"`
|
|
Version string `json:"version"`
|
|
ReleaseNotes string `json:"releaseNotes"`
|
|
Published time.Time `json:"published"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#package-dependency-group
|
|
type PackageDependencyGroup struct {
|
|
TargetFramework string `json:"targetFramework"`
|
|
Dependencies []*PackageDependency `json:"dependencies"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#package-dependency
|
|
type PackageDependency struct {
|
|
ID string `json:"id"`
|
|
Range string `json:"range"`
|
|
}
|
|
|
|
func createRegistrationIndexResponse(l *linkBuilder, pds []*packages_model.PackageDescriptor) *RegistrationIndexResponse {
|
|
sort.Slice(pds, func(i, j int) bool {
|
|
return pds[i].SemVer.LessThan(pds[j].SemVer)
|
|
})
|
|
|
|
items := make([]*RegistrationIndexPageItem, 0, len(pds))
|
|
for _, p := range pds {
|
|
items = append(items, createRegistrationIndexPageItem(l, p))
|
|
}
|
|
|
|
return &RegistrationIndexResponse{
|
|
RegistrationIndexURL: l.GetRegistrationIndexURL(pds[0].Package.Name),
|
|
Type: []string{"catalog:CatalogRoot", "PackageRegistration", "catalog:Permalink"},
|
|
Count: 1,
|
|
Pages: []*RegistrationIndexPage{
|
|
{
|
|
RegistrationPageURL: l.GetRegistrationIndexURL(pds[0].Package.Name),
|
|
Count: len(pds),
|
|
Lower: pds[0].Version.Version,
|
|
Upper: pds[len(pds)-1].Version.Version,
|
|
Items: items,
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
func createRegistrationIndexPageItem(l *linkBuilder, pd *packages_model.PackageDescriptor) *RegistrationIndexPageItem {
|
|
metadata := pd.Metadata.(*nuget_module.Metadata)
|
|
|
|
return &RegistrationIndexPageItem{
|
|
RegistrationLeafURL: l.GetRegistrationLeafURL(pd.Package.Name, pd.Version.Version),
|
|
PackageContentURL: l.GetPackageDownloadURL(pd.Package.Name, pd.Version.Version),
|
|
CatalogEntry: &CatalogEntry{
|
|
CatalogLeafURL: l.GetRegistrationLeafURL(pd.Package.Name, pd.Version.Version),
|
|
Authors: metadata.Authors,
|
|
Copyright: metadata.Copyright,
|
|
DependencyGroups: createDependencyGroups(pd),
|
|
Description: metadata.Description,
|
|
IconURL: metadata.IconURL,
|
|
ID: pd.Package.Name,
|
|
IsPrerelease: pd.Version.IsPrerelease(),
|
|
Language: metadata.Language,
|
|
LicenseURL: metadata.LicenseURL,
|
|
PackageContentURL: l.GetPackageDownloadURL(pd.Package.Name, pd.Version.Version),
|
|
ProjectURL: metadata.ProjectURL,
|
|
RequireLicenseAcceptance: metadata.RequireLicenseAcceptance,
|
|
Summary: metadata.Summary,
|
|
Tags: metadata.Tags,
|
|
Version: pd.Version.Version,
|
|
ReleaseNotes: metadata.ReleaseNotes,
|
|
Published: pd.Version.CreatedUnix.AsLocalTime(),
|
|
},
|
|
}
|
|
}
|
|
|
|
func createDependencyGroups(pd *packages_model.PackageDescriptor) []*PackageDependencyGroup {
|
|
metadata := pd.Metadata.(*nuget_module.Metadata)
|
|
|
|
dependencyGroups := make([]*PackageDependencyGroup, 0, len(metadata.Dependencies))
|
|
for k, v := range metadata.Dependencies {
|
|
dependencies := make([]*PackageDependency, 0, len(v))
|
|
for _, dep := range v {
|
|
dependencies = append(dependencies, &PackageDependency{
|
|
ID: dep.ID,
|
|
Range: dep.Version,
|
|
})
|
|
}
|
|
|
|
dependencyGroups = append(dependencyGroups, &PackageDependencyGroup{
|
|
TargetFramework: k,
|
|
Dependencies: dependencies,
|
|
})
|
|
}
|
|
return dependencyGroups
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-leaf
|
|
type RegistrationLeafResponse struct {
|
|
RegistrationLeafURL string `json:"@id"`
|
|
Type []string `json:"@type"`
|
|
PackageContentURL string `json:"packageContent"`
|
|
RegistrationIndexURL string `json:"registration"`
|
|
CatalogEntry CatalogEntry `json:"catalogEntry"`
|
|
}
|
|
|
|
func createRegistrationLeafResponse(l *linkBuilder, pd *packages_model.PackageDescriptor) *RegistrationLeafResponse {
|
|
registrationLeafURL := l.GetRegistrationLeafURL(pd.Package.Name, pd.Version.Version)
|
|
packageDownloadURL := l.GetPackageDownloadURL(pd.Package.Name, pd.Version.Version)
|
|
metadata := pd.Metadata.(*nuget_module.Metadata)
|
|
return &RegistrationLeafResponse{
|
|
RegistrationLeafURL: registrationLeafURL,
|
|
RegistrationIndexURL: l.GetRegistrationIndexURL(pd.Package.Name),
|
|
PackageContentURL: packageDownloadURL,
|
|
Type: []string{"Package", "http://schema.nuget.org/catalog#Permalink"},
|
|
CatalogEntry: CatalogEntry{
|
|
CatalogLeafURL: registrationLeafURL,
|
|
Authors: metadata.Authors,
|
|
Copyright: metadata.Copyright,
|
|
DependencyGroups: createDependencyGroups(pd),
|
|
Description: metadata.Description,
|
|
IconURL: metadata.IconURL,
|
|
ID: pd.Package.Name,
|
|
IsPrerelease: pd.Version.IsPrerelease(),
|
|
Language: metadata.Language,
|
|
LicenseURL: metadata.LicenseURL,
|
|
PackageContentURL: packageDownloadURL,
|
|
ProjectURL: metadata.ProjectURL,
|
|
RequireLicenseAcceptance: metadata.RequireLicenseAcceptance,
|
|
Summary: metadata.Summary,
|
|
Tags: metadata.Tags,
|
|
Version: pd.Version.Version,
|
|
ReleaseNotes: metadata.ReleaseNotes,
|
|
Published: pd.Version.CreatedUnix.AsLocalTime(),
|
|
},
|
|
}
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/package-base-address-resource#response
|
|
type PackageVersionsResponse struct {
|
|
Versions []string `json:"versions"`
|
|
}
|
|
|
|
func createPackageVersionsResponse(pvs []*packages_model.PackageVersion) *PackageVersionsResponse {
|
|
versions := make([]string, 0, len(pvs))
|
|
for _, pv := range pvs {
|
|
versions = append(versions, pv.Version)
|
|
}
|
|
|
|
return &PackageVersionsResponse{
|
|
Versions: versions,
|
|
}
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource#response
|
|
type SearchResultResponse struct {
|
|
TotalHits int64 `json:"totalHits"`
|
|
Data []*SearchResult `json:"data"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource#search-result
|
|
type SearchResult struct {
|
|
Authors string `json:"authors"`
|
|
Copyright string `json:"copyright"`
|
|
DependencyGroups []*PackageDependencyGroup `json:"dependencyGroups"`
|
|
Description string `json:"description"`
|
|
IconURL string `json:"iconUrl"`
|
|
ID string `json:"id"`
|
|
IsPrerelease bool `json:"isPrerelease"`
|
|
Language string `json:"language"`
|
|
LicenseURL string `json:"licenseUrl"`
|
|
ProjectURL string `json:"projectUrl"`
|
|
RequireLicenseAcceptance bool `json:"requireLicenseAcceptance"`
|
|
Summary string `json:"summary"`
|
|
Tags string `json:"tags"`
|
|
Title string `json:"title"`
|
|
TotalDownloads int64 `json:"totalDownloads"`
|
|
Version string `json:"version"`
|
|
Versions []*SearchResultVersion `json:"versions"`
|
|
RegistrationIndexURL string `json:"registration"`
|
|
}
|
|
|
|
// https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource#search-result
|
|
type SearchResultVersion struct {
|
|
RegistrationLeafURL string `json:"@id"`
|
|
Version string `json:"version"`
|
|
Downloads int64 `json:"downloads"`
|
|
}
|
|
|
|
func createSearchResultResponse(l *linkBuilder, totalHits int64, pds []*packages_model.PackageDescriptor) *SearchResultResponse {
|
|
grouped := make(map[string][]*packages_model.PackageDescriptor)
|
|
for _, pd := range pds {
|
|
grouped[pd.Package.Name] = append(grouped[pd.Package.Name], pd)
|
|
}
|
|
|
|
keys := make([]string, 0, len(grouped))
|
|
for key := range grouped {
|
|
keys = append(keys, key)
|
|
}
|
|
collate.New(language.English, collate.IgnoreCase).SortStrings(keys)
|
|
|
|
data := make([]*SearchResult, 0, len(pds))
|
|
for _, key := range keys {
|
|
data = append(data, createSearchResult(l, grouped[key]))
|
|
}
|
|
|
|
return &SearchResultResponse{
|
|
TotalHits: totalHits,
|
|
Data: data,
|
|
}
|
|
}
|
|
|
|
func createSearchResult(l *linkBuilder, pds []*packages_model.PackageDescriptor) *SearchResult {
|
|
latest := pds[0]
|
|
versions := make([]*SearchResultVersion, 0, len(pds))
|
|
totalDownloads := int64(0)
|
|
for _, pd := range pds {
|
|
if latest.SemVer.LessThan(pd.SemVer) {
|
|
latest = pd
|
|
}
|
|
totalDownloads += pd.Version.DownloadCount
|
|
versions = append(versions, &SearchResultVersion{
|
|
RegistrationLeafURL: l.GetRegistrationLeafURL(pd.Package.Name, pd.Version.Version),
|
|
Version: pd.Version.Version,
|
|
})
|
|
}
|
|
|
|
metadata := latest.Metadata.(*nuget_module.Metadata)
|
|
|
|
return &SearchResult{
|
|
Authors: metadata.Authors,
|
|
Copyright: metadata.Copyright,
|
|
Description: metadata.Description,
|
|
DependencyGroups: createDependencyGroups(latest),
|
|
IconURL: metadata.IconURL,
|
|
ID: latest.Package.Name,
|
|
IsPrerelease: latest.Version.IsPrerelease(),
|
|
Language: metadata.Language,
|
|
LicenseURL: metadata.LicenseURL,
|
|
ProjectURL: metadata.ProjectURL,
|
|
RequireLicenseAcceptance: metadata.RequireLicenseAcceptance,
|
|
Summary: metadata.Summary,
|
|
Tags: metadata.Tags,
|
|
Title: metadata.Title,
|
|
TotalDownloads: totalDownloads,
|
|
Version: latest.Version.Version,
|
|
Versions: versions,
|
|
RegistrationIndexURL: l.GetRegistrationIndexURL(latest.Package.Name),
|
|
}
|
|
}
|