/// <summary>
/// Catalog index page.
/// </summary>
public static async Task <JObject> CreateCatalogPageAsync(Uri indexUri, Uri rootUri, List <JObject> packageDetails, Guid commitId)
{
var json = JsonUtility.Create(rootUri, "CatalogPage");
json.Add("commitId", commitId.ToString().ToLowerInvariant());
json.Add("commitTimeStamp", DateTimeOffset.UtcNow.GetDateString());
json.Add("count", packageDetails.Count);
json.Add("parent", indexUri.AbsoluteUri);
var itemArray = new JArray();
json.Add("items", itemArray);
foreach (var entry in packageDetails
.OrderBy(e => e["commitTimeStamp"].ToObject <DateTimeOffset>())
.ThenBy(e => e["@id"].ToString()))
{
itemArray.Add(entry);
}
var context = await JsonUtility.GetContextAsync("CatalogPage");
json.Add("@context", context);
return(JsonLDTokenComparer.Format(json));
}
public async Task <JObject> CreatePackageBlobAsync(PackageInput packageInput)
{
var rootUri = GetPackageUri(packageInput.Identity);
var json = JsonUtility.Create(rootUri, new string[] { "Package", "http://schema.nuget.org/catalog#Permalink" });
json.Add("catalogEntry", packageInput.PackageDetails.GetIdUri().AbsoluteUri);
json.Add("packageContent", packageInput.PackageDetails["packageContent"].ToString());
json.Add("registration", GetIndexUri(packageInput.Identity));
var copyProperties = new List <string>()
{
"listed",
"published",
};
JsonUtility.CopyProperties(packageInput.PackageDetails, json, copyProperties, skipEmpty: true);
// Copy the catalog entry into the package blob. This allows the feed to
// save this info even if the catalog is disabled.
// Note that this is different from NuGet.org, so the sleet: namespace is used.
var catalogEntry = (JObject)packageInput.PackageDetails.DeepClone();
// Clear packageEntries, this can be very large in some cases.
catalogEntry.Remove("packageEntries");
json.Add("sleet:catalogEntry", catalogEntry);
var context = await JsonUtility.GetContextAsync("Package");
json.Add("@context", context);
return(JsonLDTokenComparer.Format(json));
}
/// <summary>
/// Create PackageDetails for a delete
/// </summary>
public static async Task <JObject> CreateDeleteDetailsAsync(PackageIdentity package, string reason, Uri catalogBaseURI, Guid commitId)
{
var now = DateTimeOffset.UtcNow;
var pageId = Guid.NewGuid().ToString().ToLowerInvariant();
var rootUri = UriUtility.GetPath(catalogBaseURI, $"data/{pageId}.json");
var json = JsonUtility.Create(rootUri, new List <string>()
{
"PackageDelete", "catalog:Permalink"
});
json.Add("commitId", commitId.ToString().ToLowerInvariant());
json.Add("commitTimeStamp", now.GetDateString());
json.Add("sleet:operation", "remove");
var context = await JsonUtility.GetContextAsync("Catalog");
json.Add("@context", context);
json.Add("id", package.Id);
json.Add("version", package.Version.ToFullVersionString());
json.Add("created", DateTimeOffset.UtcNow.GetDateString());
json.Add("sleet:removeReason", reason);
json.Add("sleet:toolVersion", AssemblyVersionHelper.GetVersion().ToFullVersionString());
return(JsonLDTokenComparer.Format(json));
}
public async Task <JObject> CreateIndexAsync(Uri indexUri, List <JObject> packageDetails)
{
var json = JsonUtility.Create(indexUri,
new string[] {
"catalog:CatalogRoot",
"PackageRegistration",
"catalog:Permalink"
});
json.Add("commitId", _context.CommitId.ToString().ToLowerInvariant());
json.Add("commitTimeStamp", DateTimeOffset.UtcNow.GetDateString());
var itemsArray = new JArray();
json.Add("items", itemsArray);
json.Add("count", 1);
// Add everything to a single page
var pageJson = CreatePage(indexUri, packageDetails);
itemsArray.Add(pageJson);
var context = await JsonUtility.GetContextAsync("Registration");
json.Add("@context", context);
return(JsonLDTokenComparer.Format(json));
}
/// <summary>
/// Create a PackageDetails page that contains all the package information and an exact uri.
/// </summary>
public static async Task <JObject> CreatePackageDetailsWithExactUriAsync(PackageInput packageInput, Uri detailsUri, Uri nupkgUri, Guid commitId, bool writeFileList)
{
var now = DateTimeOffset.UtcNow;
var nuspecReader = packageInput.Nuspec;
var json = JsonUtility.Create(detailsUri, new List <string>()
{
"PackageDetails", "catalog:Permalink"
});
json.Add("commitId", commitId.ToString().ToLowerInvariant());
json.Add("commitTimeStamp", DateTimeOffset.UtcNow.GetDateString());
json.Add("sleet:operation", "add");
var context = await JsonUtility.GetContextAsync("Catalog");
json.Add("@context", context);
json.Add("id", packageInput.Identity.Id);
json.Add("version", packageInput.Identity.Version.ToFullVersionString());
json.Add("created", now.GetDateString());
json.Add("lastEdited", "0001-01-01T00:00:00Z");
var copyProperties = new List <string>()
{
"authors",
"copyright",
"description",
"iconUrl",
"projectUrl",
"licenseUrl",
"language",
"summary",
"owners",
"releaseNotes"
};
foreach (var propertyName in copyProperties)
{
json.Add(CreateProperty(propertyName, propertyName, nuspecReader));
}
json.Add("isPrerelease", packageInput.Identity.Version.IsPrerelease);
// Unused?
json.Add("licenseNames", string.Empty);
json.Add("licenseReportUrl", string.Empty);
// All packages are listed
json.Add("listed", true);
var titleValue = GetEntry(nuspecReader, "title");
if (!string.IsNullOrEmpty(titleValue))
{
json.Add("title", titleValue);
}
// Avoid hashing the package for virtual catalog pages, it takes
// a long time for machines with slow disks. It also isn't used
// anywhere except in the real catalog.
if (writeFileList)
{
using (var stream = File.OpenRead(packageInput.PackagePath))
{
using (var sha512 = SHA512.Create())
{
var packageHash = Convert.ToBase64String(sha512.ComputeHash(stream));
json.Add("packageHash", packageHash);
json.Add("packageHashAlgorithm", "SHA512");
}
json.Add("packageSize", stream.Length);
}
}
json.Add("published", now.GetDateString());
json.Add("requireLicenseAcceptance", GetEntry(nuspecReader, "requireLicenseAcceptance").Equals("true", StringComparison.OrdinalIgnoreCase));
var minVersion = nuspecReader.GetMinClientVersion();
if (minVersion != null)
{
json.Add("minClientVersion", minVersion.ToIdentityString());
}
// Tags
var tagSet = new HashSet <string>(GetEntry(nuspecReader, "tags").Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries), StringComparer.OrdinalIgnoreCase);
tagSet.Remove(string.Empty);
var tagArray = new JArray(tagSet);
json.Add("tags", tagArray);
// Framework assemblies
var fwrGroups = nuspecReader.GetFrameworkAssemblyGroups();
var fwrArray = new JArray();
json.Add("frameworkAssemblyGroup", fwrArray);
foreach (var group in fwrGroups.OrderBy(e => e.TargetFramework.GetShortFolderName(), StringComparer.OrdinalIgnoreCase))
{
var groupTFM = group.TargetFramework.GetShortFolderName().ToLowerInvariant();
var groupNode = JsonUtility.Create(detailsUri, $"frameworkassemblygroup/{groupTFM}".ToLowerInvariant(), "FrameworkAssemblyGroup");
// Leave the framework property out for the 'any' group
if (!group.TargetFramework.IsAny)
{
groupNode.Add("targetFramework", groupTFM);
}
fwrArray.Add(groupNode);
if (group.Items.Any())
{
var assemblyArray = new JArray();
groupNode.Add("assembly", assemblyArray);
foreach (var fwAssembly in group.Items.Distinct().OrderBy(e => e, StringComparer.OrdinalIgnoreCase))
{
assemblyArray.Add(fwAssembly);
}
}
}
// Dependencies
var dependencyGroups = nuspecReader.GetDependencyGroups();
var depArray = new JArray();
json.Add("dependencyGroups", depArray);
foreach (var group in dependencyGroups.OrderBy(e => e.TargetFramework.GetShortFolderName(), StringComparer.OrdinalIgnoreCase))
{
var groupTFM = group.TargetFramework.GetShortFolderName().ToLowerInvariant();
var groupNode = JsonUtility.Create(detailsUri, $"dependencygroup/{groupTFM}".ToLowerInvariant(), "PackageDependencyGroup");
// Leave the framework property out for the 'any' group
if (!group.TargetFramework.IsAny)
{
groupNode.Add("targetFramework", groupTFM);
}
depArray.Add(groupNode);
if (group.Packages.Any())
{
var packageArray = new JArray();
groupNode.Add("dependencies", packageArray);
foreach (var depPackage in group.Packages.Distinct().OrderBy(e => e.Id, StringComparer.OrdinalIgnoreCase))
{
var packageNode = JsonUtility.Create(detailsUri, $"dependencygroup/{groupTFM}/{depPackage.Id}".ToLowerInvariant(), "PackageDependency");
packageNode.Add("id", depPackage.Id);
packageNode.Add("range", depPackage.VersionRange.ToNormalizedString());
packageArray.Add(packageNode);
}
}
}
json.Add("packageContent", nupkgUri.AbsoluteUri);
if (writeFileList)
{
// Write out all files contained in the package
var packageEntriesArray = new JArray();
json.Add("packageEntries", packageEntriesArray);
using (var zip = packageInput.CreateZip())
{
AddZipEntry(zip, detailsUri, packageEntriesArray);
}
}
json.Add("sleet:toolVersion", AssemblyVersionHelper.GetVersion().ToFullVersionString());
return(JsonLDTokenComparer.Format(json));
}