Poushec.UpdateCatalogParser 4.2.0

Update Catalog Parser

This library was made to help me or anyone else to collect data from https://www.catalog.update.microsoft.com/ in a comfortable way.

Credits

Big thanks to ryan-jan (https://github.com/ryan-jan) for his MSCatalog PowerShell module. My original plan was to re-write this module as C# class library.)

Other implementations

• Java: zaladhaval/UpdateCatalogParseLib

How to use it

Instantiate the CatalogClient first:

CatalogClient catalogClient = new CatalogClient(new HttpClient(), pageReloadAttemptsAllowed = 3);

(Optional) If you want CatalogClient to use a particular instance of HttpClient you can pass it as a first argument to the constructor. If you will not provide it - it will be created for you.

(Optional) Use the pageReloadAttemptsAllowed argument to set the number of page refresh attempts allowed. Catalog can be unreliable at times and you almost certain to get at least one invalid page from it when working with a lot of search results. Default value: 3

List<CatalogSearchResult> searchResults = await catalogClient.SendSearchQueryAsync("SQL Server 2019", ignoreDuplicates = true);

This method will load and parse all available search result pages and return you a collection of CatalogSearchResult objects. Each of this objects represent search result from catalog.update.microsoft.com with data available through search results page only:

1. Update's ID
2. Title
3. Products
4. Classification
5. Last Updated date
6. Version
7. Size
8. Size in bytes

(Optional) If ignoreDuplicates argument is TRUE than function will return only updates with unique Title and SizeInBytes fields. Default: TRUE

If you're only interested in results from a first page (or just how many results there are) use this method instead:

CatalogResponse firstResultsPage = await catalogClient.GetFirstPageFromSearchQueryAsync("SQL Server 2019");

This method returns a CatalogResponse object representing the current search results page, specifically:

1. Collection of CatalogSearchResult objects which holds search results from current page (SearchResults)
2. Total search query results count (ResultsCount)
3. The field indicating if it is a final page (FinalPage)

Both of these methods has optional arguments sortBy and sortDirection. Use them if you want Catalog to sort your query results.

To get more info on a particular update (which you would normally get by following the link on the results list) pass one of the CatalogSearchResult objects you've got from SendSearchQueryAsync to this method:

UpdateInfo updateDetails = await catalogClient.GetUpdateDetailsAsync(CatalogSearchResult searchResult)

It will get you an instance of UpdateInfo class with all the collected details from the details and download pages, for example download links, HardwareIDs if it is a driver, Supersedes list if it is an Update etc.

Example Usage

Get all available results from a search query:

using Poushec.UpdateCatalogParser;

var client = new HttpClient();
var catalogClient = new CatalogClient(client);

var testSearchResults = await catalogClient.SendSearchQueryAsync("SQL Server 2022");
            
Console.WriteLine($"{testSearchResults.Count} updates found\n");

testSearchResults.ForEach(result => Console.WriteLine($"{result.Title} ({result.LastUpdated.ToString("yyyy/MM/dd")})"));

Output:

5 updates found

SQL Server 2022 RTM Cumulative Update (CU) 4 KB5026717 (2023/05/11)
SQL Server 2022 RTM Cumulative Update (CU) 3 KB5024396 (2023/04/13)
SQL Server 2022 RTM Cumulative Update (CU) 2 KB5023127 (2023/03/23)
SQL Server 2022 RTM Cumulative Update (CU) 1 KB5022375 (2023/03/10)
Security Update for SQL Server 2022 RTM GDR (KB5021522) (2023/03/05)

Get the first results page and iterate through next:

using Poushec.UpdateCatalogParser;

var client = new HttpClient();
var catalogClient = new CatalogClient(client);

var currentResultsPage = await catalogClient.GetFirstPageFromSearchQueryAsync("SQL Server 2016");
var allSearchResults = currentResultsPage.SearchResults;

Console.WriteLine($"{currentResultsPage.ResultsCount} updates found\n");
Console.WriteLine($"Results on current page: {currentResultsPage.SearchResults.Count}");

while (!currentResultsPage.FinalPage)
{
    currentResultsPage = await currentResultsPage.ParseNextPageAsync();
    allSearchResults.AddRange(currentResultsPage.SearchResults);

    Console.WriteLine($"Results on current page: {currentResultsPage.SearchResults.Count}");
}

Output:

79 updates found

Results on current page: 25
Results on current page: 25
Results on current page: 25
Results on current page: 4

Limitations

What this library does - is parse HTML pages from catalog.update.microsoft.com, so it derives it's limitations directly from it. For example, it cannot return more than 1000 search results from a single query.