aboutsummaryrefslogtreecommitdiffstats
path: root/routers/api/packages/nuget/api_v3.go
blob: 3262f2d9afb94f42ae8090916ea424a9dc98892d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
// 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),
	}
}