// V3 implementation - called directly from the integrated Visual Studio client
public static void WriteSearchResult(
JsonWriter jsonWriter,
NuGetIndexSearcher searcher,
string scheme,
TopDocs topDocs,
int skip,
int take,
bool includePrerelease,
bool includeExplanation,
NuGetVersion semVerLevel,
Query query)
{
Uri baseAddress;
var useSemVer2Registration = SemVerHelpers.ShouldIncludeSemVer2Results(semVerLevel);
RegistrationBaseAddresses registrationAddresses = searcher.Manager.RegistrationBaseAddresses;
switch (scheme)
{
case "https":
baseAddress = (useSemVer2Registration ? registrationAddresses.SemVer2Https : registrationAddresses.LegacyHttps);
break;
case "http":
default:
// if scheme specified is invalid, fall back to using as much information as we can
baseAddress = (useSemVer2Registration ? registrationAddresses.SemVer2Http : registrationAddresses.LegacyHttp);
break;
}
jsonWriter.WriteStartObject();
WriteInfo(jsonWriter, baseAddress, searcher, topDocs);
WriteData(jsonWriter, searcher, topDocs, skip, take, baseAddress, includePrerelease, includeExplanation, semVerLevel, query);
jsonWriter.WriteEndObject();
}
private static void WriteVersions(JsonWriter jsonWriter,
Uri baseAddress,
string id,
bool includePrerelease,
NuGetVersion semVerLevel,
VersionResult versionResult)
{
var includeSemVer2 = SemVerHelpers.ShouldIncludeSemVer2Results(semVerLevel);
jsonWriter.WritePropertyName("versions");
jsonWriter.WriteStartArray();
var results = includePrerelease
? (includeSemVer2 ? versionResult.SemVer2VersionDetails : versionResult.LegacyVersionDetails)
: (includeSemVer2 ? versionResult.StableSemVer2VersionDetails : versionResult.StableLegacyVersionDetails);
foreach (var item in results.Where(r => r.IsListed))
{
var relativeAddress = UriFormatter.MakePackageRelativeAddress(id, item.NormalizedVersion);
var absoluteAddress = new Uri(baseAddress, relativeAddress).AbsoluteUri;
jsonWriter.WriteStartObject();
WriteProperty(jsonWriter, "version", item.FullVersion);
WriteProperty(jsonWriter, "downloads", item.Downloads);
WriteProperty(jsonWriter, "@id", absoluteAddress);
jsonWriter.WriteEndObject();
}
jsonWriter.WriteEndArray();
}
public bool TryGetFilter(bool includeUnlisted, bool includePrerelease, NuGetVersion semVerLevel, string curatedFeed, out Filter filter)
{
var includeSemVer2 = SemVerHelpers.ShouldIncludeSemVer2Results(semVerLevel);
LatestListedMask filterMask = (includeUnlisted ? LatestListedMask.IncludeUnlisted : 0) |
(includePrerelease ? LatestListedMask.IncludePrerelease : 0) |
(includeSemVer2 ? LatestListedMask.IncludeSemVer2 : 0);
Filter visibilityFilter = _latest[filterMask];
Filter curatedFeedFilter;
if (!string.IsNullOrEmpty(curatedFeed) && _curatedFeeds.TryGetValue(curatedFeed, out curatedFeedFilter))
{
filter = new ChainedFilter(new[] { visibilityFilter, curatedFeedFilter }, ChainedFilter.Logic.AND);
return(true);
}
filter = visibilityFilter;
return(true);
}
private static void WriteVersions(JsonWriter jsonWriter, NuGetIndexSearcher searcher, bool includePrerelease, NuGetVersion semVerLevel, TopDocs topDocs)
{
var includeSemVer2 = SemVerHelpers.ShouldIncludeSemVer2Results(semVerLevel);
jsonWriter.WritePropertyName("data");
jsonWriter.WriteStartArray();
if (topDocs.TotalHits > 0)
{
ScoreDoc scoreDoc = topDocs.ScoreDocs[0];
var versions = includePrerelease
? searcher.Versions[scoreDoc.Doc].GetVersions(onlyListed: true, includeSemVer2: includeSemVer2)
: searcher.Versions[scoreDoc.Doc].GetStableVersions(onlyListed: true, includeSemVer2: includeSemVer2);
foreach (var version in versions)
{
jsonWriter.WriteValue(version);
}
}
jsonWriter.WriteEndArray();
}
private static void WriteDataV2(JsonWriter jsonWriter, NuGetIndexSearcher searcher, TopDocs topDocs, int skip, int take, NuGetVersion semVerLevel)
{
jsonWriter.WritePropertyName("data");
jsonWriter.WriteStartArray();
var includeSemVer2 = SemVerHelpers.ShouldIncludeSemVer2Results(semVerLevel);
var isLatestBitSet = includeSemVer2 ? searcher.LatestSemVer2BitSet : searcher.LatestBitSet;
var isLatestStableBitSet = includeSemVer2 ? searcher.LatestStableSemVer2BitSet : searcher.LatestStableBitSet;
for (int i = skip; i < Math.Min(skip + take, topDocs.ScoreDocs.Length); i++)
{
ScoreDoc scoreDoc = topDocs.ScoreDocs[i];
Document document = searcher.Doc(scoreDoc.Doc);
string id = document.Get("Id");
string normalizedVersion = document.Get(LuceneMetadataConstants.NormalizedVersionPropertyName);
string fullVersion = document.Get(LuceneMetadataConstants.FullVersionPropertyName);
Tuple <int, int> downloadCounts = NuGetIndexSearcher.DownloadCounts(searcher.Versions[scoreDoc.Doc], normalizedVersion);
bool isVerified = searcher.VerifiedPackages.Contains(id);
bool isLatest = isLatestBitSet.Get(scoreDoc.Doc);
bool isLatestStable = isLatestStableBitSet.Get(scoreDoc.Doc);
jsonWriter.WriteStartObject();
WriteRegistrationV2(jsonWriter, id, downloadCounts.Item1, NuGetIndexSearcher.GetOwners(searcher, id), isVerified);
WriteDocumentValue(jsonWriter, "Version", document, LuceneMetadataConstants.VerbatimVersionPropertyName);
WriteProperty(jsonWriter, "NormalizedVersion", normalizedVersion);
WriteDocumentValue(jsonWriter, "Title", document, "Title");
WriteDocumentValue(jsonWriter, "Description", document, "Description");
WriteDocumentValue(jsonWriter, "Summary", document, "Summary");
WriteDocumentValue(jsonWriter, "Authors", document, "Authors");
WriteDocumentValue(jsonWriter, "Copyright", document, "Copyright");
WriteDocumentValue(jsonWriter, "Language", document, "Language");
WriteDocumentValue(jsonWriter, "Tags", document, "Tags");
WriteDocumentValue(jsonWriter, "ReleaseNotes", document, "ReleaseNotes");
WriteDocumentValue(jsonWriter, "ProjectUrl", document, "ProjectUrl");
WriteDocumentValue(jsonWriter, "IconUrl", document, "IconUrl");
WriteProperty(jsonWriter, "IsLatestStable", isLatestStable);
WriteProperty(jsonWriter, "IsLatest", isLatest);
WriteProperty(jsonWriter, "Listed", bool.Parse(document.Get("Listed") ?? "true"));
WriteDocumentValue(jsonWriter, "Created", document, "OriginalCreated");
WriteDocumentValue(jsonWriter, "Published", document, "OriginalPublished");
WriteDocumentValue(jsonWriter, "LastUpdated", document, "OriginalPublished");
WriteDocumentValue(jsonWriter, "LastEdited", document, "OriginalLastEdited");
WriteProperty(jsonWriter, "DownloadCount", downloadCounts.Item2);
WriteDocumentValue(jsonWriter, "FlattenedDependencies", document, "FlattenedDependencies");
jsonWriter.WritePropertyName("Dependencies");
jsonWriter.WriteRawValue(document.Get("Dependencies") ?? "[]");
jsonWriter.WritePropertyName("SupportedFrameworks");
jsonWriter.WriteRawValue(document.Get("SupportedFrameworks") ?? "[]");
WriteDocumentValue(jsonWriter, "MinClientVersion", document, "MinClientVersion");
WriteDocumentValue(jsonWriter, "Hash", document, "PackageHash");
WriteDocumentValue(jsonWriter, "HashAlgorithm", document, "PackageHashAlgorithm");
WriteProperty(jsonWriter, "PackageFileSize", int.Parse(document.Get("PackageSize") ?? "0"));
WriteDocumentValue(jsonWriter, "LicenseUrl", document, "LicenseUrl");
WriteProperty(jsonWriter, "RequiresLicenseAcceptance", bool.Parse(document.Get("RequiresLicenseAcceptance") ?? "false"));
jsonWriter.WriteEndObject();
}
jsonWriter.WriteEndArray();
}
public static void Search(JsonWriter jsonWriter,
NuGetSearcherManager searcherManager,
string q,
bool countOnly,
bool includePrerelease,
NuGetVersion semVerLevel,
string sortBy,
int skip,
int take,
string feed,
bool ignoreFilter,
bool luceneQuery)
{
if (jsonWriter == null)
{
throw new ArgumentNullException(nameof(jsonWriter));
}
if (searcherManager == null)
{
throw new ArgumentNullException(nameof(searcherManager));
}
var searcher = searcherManager.Get();
try
{
// The old V2 search service would treat "id:" queries (~match) in the same way as it did "packageid:" (==match).
// If "id:" is in the query, replace it.
if (luceneQuery && !string.IsNullOrEmpty(q) && q.StartsWith("id:", StringComparison.OrdinalIgnoreCase))
{
q = "packageid:" + q.Substring(3);
}
// Build the query
Query query = NuGetQuery.MakeQuery(q, searcher.Owners);
// Build filter
bool includeUnlisted = ignoreFilter;
includePrerelease = ignoreFilter || includePrerelease;
feed = ignoreFilter ? null : feed;
var combinedQuery = new BooleanQuery();
combinedQuery.Add(query, Occur.SHOULD);
// Add this clause to the query here so we still respect semVerLevel that is passed when ignoring filters.
if (!SemVerHelpers.ShouldIncludeSemVer2Results(semVerLevel))
{
combinedQuery.Add(
NuGetQuery.ConstructClauseQuery(
new StandardAnalyzer(Lucene.Net.Util.Version.LUCENE_30),
MetadataConstants.LuceneMetadata.SemVerLevelPropertyName,
new List <string> {
SemVerHelpers.SemVerLevelKeySemVer2
}),
Occur.MUST_NOT);
}
query = combinedQuery;
Filter filter = null;
if (!ignoreFilter && searcher.TryGetFilter(includeUnlisted, includePrerelease, semVerLevel, feed, out filter))
{
// Filter before running the query (make the search set smaller)
query = new FilteredQuery(query, filter);
}
if (countOnly)
{
DocumentCountImpl(jsonWriter, searcher, query);
}
else
{
ListDocumentsImpl(jsonWriter, searcher, query, sortBy, skip, take, semVerLevel);
}
}
finally
{
searcherManager.Release(searcher);
}
}
