mirror of
https://github.com/duplicati/duplicati.git
synced 2025-11-28 03:20:25 +08:00
c8b9fb5c73
This PR adds the ability to subscribe to messages over a websocket. To prevent polling data, the server can now push messages through the websocket, so the client can instantly update when new data is available. The change is backwards compatible, still serving the status updates over the socket. If the client is providing the authentication token, it is auto-subscried to the legacy status message. If the client is using the new authentication message, it needs to subscribe to get the status updates (and any other services it needs). The event system has been extended to support new, and more accurate, events. This is the first step towards removing the general status update and the long-poll mechanism. This also re-introduces the blocking marker, so the client can know if the operation is halted due to too many pending transfers. Some endpoints have been moved to service implementations, to allow serving the exact same data from both endpoints and websocket. This PR also updates the way the progress is handled, so that all transfers are returned to the client, and the transfer speeds for each transfer is calculated based on a small sample buffer, so the values are more accurate even if the program is paused during transfers.
57 lines
No EOL
2.6 KiB
C#
57 lines
No EOL
2.6 KiB
C#
// Copyright (C) 2025, 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.
|
|
|
|
namespace Duplicati.WebserverCore.Abstractions;
|
|
|
|
public interface ISettingsService
|
|
{
|
|
/// <summary>
|
|
/// Gets the current server settings.
|
|
/// </summary>
|
|
/// <returns>The current server settings.</returns>
|
|
ServerSettings GetSettings();
|
|
|
|
/// <summary>
|
|
/// Gets the current server settings with sensitive information masked.
|
|
/// </summary>
|
|
/// <returns>A dictionary of settings with sensitive information masked.</returns>
|
|
Dictionary<string, string> GetSettingsMasked();
|
|
|
|
/// <summary>
|
|
/// Patches the server settings with the provided values, ignoring any sensitive information.
|
|
/// </summary>
|
|
/// <param name="values">A dictionary of values to patch the settings with.</param>
|
|
void PatchSettingsMasked(Dictionary<string, object?>? values);
|
|
|
|
/// <summary>
|
|
/// Gets a specific setting value, masking sensitive information if necessary.
|
|
/// </summary>
|
|
/// <param name="key">The key of the setting to retrieve.</param>
|
|
/// <returns>The value of the setting, or null if not found.</returns>
|
|
string? GetSettingMasked(string key);
|
|
|
|
/// <summary>
|
|
/// Patches a specific setting with a masked value, ignoring any sensitive information.
|
|
/// </summary>
|
|
/// <param name="key">The key of the setting to patch.</param>
|
|
/// <param name="value">The masked value to set for the setting.</param>
|
|
void PatchSettingMasked(string key, string value);
|
|
} |