/// <summary>
/// Read dependency info from a nuspec.
/// </summary>
/// <remarks>This also verifies minClientVersion.</remarks>
protected static FindPackageByIdDependencyInfo GetDependencyInfo(NuspecReader reader)
{
// Since this is the first place a package is read after selecting it as the best version
// check the minClientVersion here to verify we are okay to read this package.
MinClientVersionUtility.VerifyMinClientVersion(reader);
// Create dependency info
return(new FindPackageByIdDependencyInfo(
reader.GetIdentity(),
reader.GetDependencyGroups(),
reader.GetFrameworkAssemblyGroups()));
}
/// <summary>
/// Add framework references.
/// </summary>
private static void AddFrameworkReferences(LockFileTargetLibrary lockFileLib, NuGetFramework framework, NuspecReader nuspec)
{
// Exclude framework references for package based frameworks.
if (!framework.IsPackageBased)
{
var frameworkAssemblies = nuspec.GetFrameworkAssemblyGroups().GetNearest(framework);
if (frameworkAssemblies != null)
{
foreach (var assemblyReference in frameworkAssemblies.Items)
{
lockFileLib.FrameworkAssemblies.Add(assemblyReference);
}
}
}
// Related to: FrameworkReference item, added first in .NET Core 3.0
var frameworkRef = nuspec.GetFrameworkRefGroups().GetNearest(framework);
if (frameworkRef != null)
{
lockFileLib.FrameworkReferences.AddRange(frameworkRef.FrameworkReferences.Select(e => e.Name));
}
}
/// <summary>
/// Gets package metadata from a the provided <see cref="NuspecReader"/> instance.
/// </summary>
/// <param name="nuspecReader">The <see cref="NuspecReader"/> instance used to read the <see cref="PackageMetadata"/></param>
/// <param name="strict">
/// Whether or not to be strict when reading the <see cref="NuspecReader"/>. This should be <code>true</code>
/// on initial ingestion but false when a package that has already been accepted is being processed.</param>
/// <exception cref="PackagingException">
/// We default to use a strict version-check on dependency groups.
/// When an invalid dependency version range is detected, a <see cref="PackagingException"/> will be thrown.
/// </exception>
public static PackageMetadata FromNuspecReader(NuspecReader nuspecReader, bool strict)
{
var strictNuspecReader = new StrictNuspecReader(nuspecReader.Xml);
var metadataLookup = strictNuspecReader.GetMetadataLookup();
if (strict)
{
var duplicates = metadataLookup
.Where(g => g.Count() > 1)
.Select(g => g.Key)
.ToList();
if (duplicates.Any())
{
throw new PackagingException(string.Format(
CoreStrings.Manifest_DuplicateMetadataElements,
string.Join("', '", duplicates)));
}
}
// Reject invalid metadata element names. Today this only rejects element names that collide with
// properties generated downstream.
var metadataKeys = new HashSet <string>(metadataLookup.Select(g => g.Key));
metadataKeys.IntersectWith(RestrictedMetadataElements);
if (metadataKeys.Any())
{
throw new PackagingException(string.Format(
CoreStrings.Manifest_InvalidMetadataElements,
string.Join("', '", metadataKeys.OrderBy(x => x))));
}
// Reject non-boolean values for boolean metadata.
foreach (var booleanName in BooleanMetadataElements)
{
foreach (var unparsedBoolean in metadataLookup[booleanName])
{
if (!bool.TryParse(unparsedBoolean, out var parsedBoolean))
{
throw new PackagingException(string.Format(
CoreStrings.Manifest_InvalidBooleanMetadata,
booleanName));
}
}
}
// Reject invalid package types.
foreach (var packageType in nuspecReader.GetPackageTypes())
{
if (!NuGet.Packaging.PackageIdValidator.IsValidPackageId(packageType.Name))
{
throw new PackagingException(string.Format(
CoreStrings.Manifest_InvalidPackageTypeName,
packageType.Name));
}
}
return(new PackageMetadata(
nuspecReader.GetMetadata().ToDictionary(kvp => kvp.Key, kvp => kvp.Value),
nuspecReader.GetDependencyGroups(useStrictVersionCheck: strict),
nuspecReader.GetFrameworkAssemblyGroups(),
nuspecReader.GetPackageTypes(),
nuspecReader.GetMinClientVersion(),
nuspecReader.GetRepositoryMetadata(),
nuspecReader.GetLicenseMetadata()));
}
