Kenneth Skovhede
6c7843b332
This PR adds a unified way of supplying timeouts to each of the backends. It also adds an opt-in way of adding commonly used options, so parsing and usage can be standardized across multiple backends.
86 lines
5.3 KiB
C#
86 lines
5.3 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.
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Security.Authentication;
|
|
using Duplicati.Library.Interface;
|
|
using Duplicati.Library.Utility.Options;
|
|
using FluentFTP;
|
|
|
|
namespace Duplicati.Library.Backend;
|
|
|
|
|
|
/// <summary>
|
|
/// This classes exists to provide a way to use the FTP backend with the alternate name "AlternateFTPBackend",
|
|
/// and supporting all existing configured backups that were created using the "aftp" prefix.
|
|
///
|
|
/// The functionality is identical to the FTP backend
|
|
/// </summary>
|
|
public class AlternateFTPBackend : FTP
|
|
{
|
|
/*
|
|
These constants are overriden to provide transparent access to the alternate configuration keys
|
|
*/
|
|
protected override string CONFIG_KEY_FTP_ENCRYPTION_MODE => "aftp-encryption-mode";
|
|
protected override string CONFIG_KEY_FTP_DATA_CONNECTION_TYPE => "aftp-data-connection-type";
|
|
protected override string CONFIG_KEY_FTP_SSL_PROTOCOLS => "aftp-ssl-protocols";
|
|
protected override string CONFIG_KEY_FTP_UPLOAD_DELAY => "aftp-upload-delay";
|
|
protected override string CONFIG_KEY_FTP_LOGTOCONSOLE => "aftp-log-to-console";
|
|
protected override string CONFIG_KEY_FTP_LOGPRIVATEINFOTOCONSOLE => "aftp-log-privateinfo-to-console";
|
|
protected override string CONFIG_KEY_FTP_RELATIVE_PATH => "aftp-relative-path";
|
|
protected override string CONFIG_KEY_FTP_USE_CWD_NAMES => "aftp-use-cwd-names";
|
|
|
|
public override string Description => Strings.DescriptionAlternate;
|
|
|
|
public override string DisplayName => Strings.DisplayNameAlternate;
|
|
|
|
/*
|
|
* Likewise, this constant is overriden to provide transparent access to the alternate protocol key
|
|
*/
|
|
public override string ProtocolKey { get; } = "aftp";
|
|
|
|
public AlternateFTPBackend()
|
|
{
|
|
|
|
}
|
|
public AlternateFTPBackend(string url, Dictionary<string, string> options) : base(url, options)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Overriden so that for the alternate FTP backend, we need to support the alternate config keys starting with "aftp"
|
|
/// </summary>
|
|
public override IList<ICommandLineArgument> SupportedCommands =>
|
|
[
|
|
.. AuthOptionsHelper.GetOptions(),
|
|
new CommandLineArgument(CONFIG_KEY_DISABLE_UPLOAD_VERIFY, CommandLineArgument.ArgumentType.Boolean, Strings.DescriptionDisableUploadVerifyShort, Strings.DescriptionDisableUploadVerifyLong),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_RELATIVE_PATH, CommandLineArgument.ArgumentType.Boolean, Strings.DescriptionAbsolutePathShort, Strings.DescriptionAbsolutePathLong),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_USE_CWD_NAMES, CommandLineArgument.ArgumentType.Boolean, Strings.DescriptionUseCwdNamesShort, Strings.DescriptionUseCwdNamesLong),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_DATA_CONNECTION_TYPE, CommandLineArgument.ArgumentType.Enumeration, Strings.DescriptionFtpDataConnectionTypeShort, Strings.DescriptionFtpDataConnectionTypeLong, DEFAULT_DATA_CONNECTION_TYPE_STRING, null, Enum.GetNames(typeof(FtpDataConnectionType))),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_ENCRYPTION_MODE, CommandLineArgument.ArgumentType.Enumeration, Strings.DescriptionFtpEncryptionModeShort, Strings.DescriptionFtpEncryptionModeLong, DEFAULT_ENCRYPTION_MODE_STRING, null, Enum.GetNames(typeof(FtpEncryptionMode))),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_SSL_PROTOCOLS, CommandLineArgument.ArgumentType.Flags, Strings.DescriptionSslProtocolsShort, Strings.DescriptionSslProtocolsLong, DEFAULT_SSL_PROTOCOLS_STRING, null, Enum.GetNames(typeof(SslProtocols))),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_UPLOAD_DELAY, CommandLineArgument.ArgumentType.Timespan, Strings.DescriptionUploadDelayShort, Strings.DescriptionUploadDelayLong, DEFAULT_UPLOAD_DELAY_STRING),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_LOGTOCONSOLE, CommandLineArgument.ArgumentType.Boolean, Strings.DescriptionLogToConsoleShort, Strings.DescriptionLogToConsoleLong),
|
|
new CommandLineArgument(CONFIG_KEY_FTP_LOGPRIVATEINFOTOCONSOLE, CommandLineArgument.ArgumentType.Boolean, Strings.DescriptionLogPrivateInfoToConsoleShort, Strings.DescriptionLogPrivateInfoToConsoleLong, "false"),
|
|
.. SslOptionsHelper.GetCertOnlyOptions(),
|
|
.. TimeoutOptionsHelper.GetOptions(),
|
|
];
|
|
} |