This is a proposal for replacing the deprecated WebClient with the HttpClient. This commit implements the core functionality following the HttpClientFactory pattern as suggested by the framework. It also supports an alternative approach in areas where the HttpClient pattern is not desirable. The first backend component to be migrated is WebDav, and the HttpClient pattern is also applied to the update downloader. Once merged, other backend components can be migrated, eventually removing the deprecated WebClient from the codebase. Additionally, the debug-profind-file option from webdav, which was a remnant from early development, is removed as it is no longer useful for debugging different webdav server responses.
75 lines
2.8 KiB
C#
75 lines
2.8 KiB
C#
// Copyright (C) 2024, The Duplicati Team
|
|
// https://duplicati.com, hello@duplicati.com
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
using System.Net.Http;
|
|
|
|
namespace Duplicati.Library.Utility;
|
|
|
|
/// <summary>
|
|
/// This class was created as a proxy to access the HttpClientFactory
|
|
/// in places where dependency injection is not yet implemented or
|
|
/// desirable.
|
|
/// </summary>
|
|
public static class HttpClientHelper
|
|
{
|
|
|
|
/// <summary>
|
|
/// Central HttpClient singleton instance to be used across the application as
|
|
/// per the HttpClientFactory recommended pattern.
|
|
/// </summary>
|
|
public static HttpClient DefaultClient { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Reference to the HttpClientFactory instance so we can create specific clients
|
|
/// when the singleton pattnern is not desirable.
|
|
/// </summary>
|
|
private static IHttpClientFactory _factory {get;set;}
|
|
|
|
/// <summary>
|
|
/// Sets the factory reference.
|
|
/// </summary>
|
|
/// <param name="factory">IHttpClientFactory instance</param>
|
|
public static void Configure(IHttpClientFactory factory)
|
|
{
|
|
_factory = factory;
|
|
DefaultClient = factory.CreateClient();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new HttpClient instance, to be used in places where the singleton
|
|
/// pattern is not desirable.
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
public static HttpClient CreateClient()
|
|
{
|
|
return _factory.CreateClient();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new HttpClient instance with a specific handler, wherever its needed.
|
|
/// </summary>
|
|
/// <param name="handler">HttpClientHandler configured with authentication parameters</param>
|
|
/// <returns></returns>
|
|
public static HttpClient CreateClient(HttpClientHandler handler)
|
|
{
|
|
return new HttpClient(handler);
|
|
}
|
|
} |