diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index c7e693e2f..2ec105e2a 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -8,8 +8,9 @@ jobs: runs-on: ubuntu-latest permissions: issues: write + actions: write steps: - - uses: actions/stale@v8 + - uses: actions/stale@v9 with: days-before-issue-stale: 15 days-before-issue-close: 15 @@ -22,4 +23,4 @@ jobs: only-labels: "pending user feedback" exempt-issue-labels: "bug,enhancement,good first issue,backend enhancement,backend issue,backup corruption,bounty,bugreport attached,core logic,docker,filters,help wanted,linux,localization,MacOS,mono,performance issue,reproduced,server side,ssl/tls issue,Synology,tests,translation,UI,windows" repo-token: ${{ secrets.GITHUB_TOKEN }} - + operations-per-run: 500 diff --git a/.vscode/launch.json b/.vscode/launch.json index bbcfbf328..4cbe7b3a7 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -31,7 +31,7 @@ "type": "coreclr", "request": "launch", "preLaunchTask": "build", - "program": "${workspaceFolder}/Executables/net8/Duplicati.Server/bin/Debug/net8.0/Duplicati.CommandLine", + "program": "${workspaceFolder}/Executables/net8/Duplicati.CommandLine/bin/Debug/net8.0/Duplicati.CommandLine", "args": [], "cwd": "${workspaceFolder}", "stopAtEntry": false, @@ -48,6 +48,28 @@ "stopAtEntry": false, "console": "internalConsole" }, + { + "name": "Launch ConfigurationImporter executable", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + "program": "${workspaceFolder}/Executables/net8/Duplicati.CommandLine.ConfigurationImporter/bin/Debug/net8.0/Duplicati.CommandLine.ConfigurationImporter", + "args": [], + "cwd": "${workspaceFolder}", + "stopAtEntry": false, + "console": "internalConsole" + }, + { + "name": "Launch RecoveryTool executable", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + "program": "${workspaceFolder}/Executables/net8/Duplicati.CommandLine.RecoveryTool/bin/Debug/net8.0/Duplicati.CommandLine.RecoveryTool", + "args": [], + "cwd": "${workspaceFolder}", + "stopAtEntry": false, + "console": "internalConsole" + }, { "name": "C#: Duplicati.GUI.TrayIcon Debug", "type": "dotnet", diff --git a/BuildTools/LicenseUpdater/LicenseUpdater.csproj b/BuildTools/LicenseUpdater/LicenseUpdater.csproj index a44450dc4..cc6ad9d95 100755 --- a/BuildTools/LicenseUpdater/LicenseUpdater.csproj +++ b/BuildTools/LicenseUpdater/LicenseUpdater.csproj @@ -1,11 +1,13 @@ - - - - Exe - net8.0 - license_upgrader - enable - enable - - - + + + + Exe + net8.0 + license_upgrader + enable + enable + Copyright © 2024 Team Duplicati, MIT license + + + + diff --git a/Duplicati.Library.RestAPI/Abstractions/IScheduler.cs b/Duplicati.Library.RestAPI/Abstractions/IScheduler.cs new file mode 100644 index 000000000..9ddadfe73 --- /dev/null +++ b/Duplicati.Library.RestAPI/Abstractions/IScheduler.cs @@ -0,0 +1,45 @@ +using System; +using System.Collections.Generic; +using Duplicati.Library.Utility; +using Duplicati.Server; +using Duplicati.Server.Serialization.Interface; + +namespace Duplicati.WebserverCore.Abstractions; + +public interface IScheduler +{ + /// + /// Initializes scheduler + /// + /// The worker thread + void Init(WorkerThread worker); + + IList> GetSchedulerQueueIds(); + + /// + /// Terminates the thread. Any items still in queue will be removed + /// + /// True if the call should block until the thread has exited, false otherwise + void Terminate(bool wait); + + /// + /// Subscribes to the event that is triggered when the schedule changes + /// + void SubScribeToNewSchedule(Action handler); + + /// + /// A snapshot copy of the current schedule list + /// + List> Schedule { get; } + + /// + /// A snapshot copy of the current worker queue, that is items that are scheduled, but waiting for execution + /// + List WorkerQueue { get; } + + /// + /// Forces the scheduler to re-evaluate the order. + /// Call this method if something changes + /// + void Reschedule(); +} \ No newline at end of file diff --git a/Duplicati.Library.RestAPI/Abstractions/IWorkerThreadsManager.cs b/Duplicati.Library.RestAPI/Abstractions/IWorkerThreadsManager.cs new file mode 100644 index 000000000..fad7d506a --- /dev/null +++ b/Duplicati.Library.RestAPI/Abstractions/IWorkerThreadsManager.cs @@ -0,0 +1,17 @@ +#nullable enable +using System; +using Duplicati.Library.Utility; +using Duplicati.Server; + +namespace Duplicati.Library.RestAPI.Abstractions; + +public interface IWorkerThreadsManager +{ + void Spawn(Action item); + + Tuple? CurrentTask { get; } + WorkerThread? WorkerThread { get; } + void UpdateThrottleSpeeds(); + + long AddTask(Runner.IRunnerData data, bool skipQueue = false); +} \ No newline at end of file diff --git a/Duplicati.Library.RestAPI/BackupImportExportHandler.cs b/Duplicati.Library.RestAPI/BackupImportExportHandler.cs new file mode 100644 index 000000000..c1f6b569c --- /dev/null +++ b/Duplicati.Library.RestAPI/BackupImportExportHandler.cs @@ -0,0 +1,134 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Duplicati.Server.Database; +using Duplicati.Server.Serialization; +using Duplicati.Server.Serialization.Interface; + +namespace Duplicati.Library.RestAPI; + +public static class BackupImportExportHandler +{ + public static void RemovePasswords(IBackup backup) + { + backup.SanitizeSettings(); + backup.SanitizeTargetUrl(); + } + + public static byte[] ExportToJSON(Connection connection, IBackup backup, string passphrase) + { + Server.Serializable.ImportExportStructure ipx = connection.PrepareBackupForExport(backup); + + byte[] data; + using (var ms = new System.IO.MemoryStream()) + { + using (var sw = new System.IO.StreamWriter(ms)) + { + Serializer.SerializeJson(sw, ipx, true); + + if (!string.IsNullOrWhiteSpace(passphrase)) + { + ms.Position = 0; + using (var ms2 = new System.IO.MemoryStream()) + { + using (var m = new Duplicati.Library.Encryption.AESEncryption(passphrase, new Dictionary())) + { + m.Encrypt(ms, ms2); + data = ms2.ToArray(); + } + } + } + else + { + data = ms.ToArray(); + } + } + } + + return data; + } + + public static Server.Serializable.ImportExportStructure ImportBackup(string configurationFile, bool importMetadata, Func getPassword, Dictionary advancedOptions) + { + // This removes the ID and DBPath from the backup configuration. + Server.Serializable.ImportExportStructure importedStructure = LoadConfiguration(configurationFile, importMetadata, getPassword); + + // This will create the Duplicati-server.sqlite database file if it doesn't exist. + using (Duplicati.Server.Database.Connection connection = FIXMEGlobal.GetDatabaseConnection(advancedOptions)) + { + if (connection.Backups.Any(x => x.Name.Equals(importedStructure.Backup.Name, StringComparison.OrdinalIgnoreCase))) + { + throw new InvalidOperationException($"A backup with the name {importedStructure.Backup.Name} already exists."); + } + + string error = connection.ValidateBackup(importedStructure.Backup, importedStructure.Schedule); + if (!string.IsNullOrWhiteSpace(error)) + { + throw new InvalidOperationException(error); + } + + // This creates a new ID and DBPath. + connection.AddOrUpdateBackupAndSchedule(importedStructure.Backup, importedStructure.Schedule); + } + + return importedStructure; + } + + public static Server.Serializable.ImportExportStructure LoadConfiguration(string filename, bool importMetadata, Func getPassword) + { + Server.Serializable.ImportExportStructure ipx; + + var buf = new byte[3]; + using (var fs = System.IO.File.OpenRead(filename)) + { + Duplicati.Library.Utility.Utility.ForceStreamRead(fs, buf, buf.Length); + + fs.Position = 0; + if (buf[0] == 'A' && buf[1] == 'E' && buf[2] == 'S') + { + using (var m = new Duplicati.Library.Encryption.AESEncryption(getPassword(), new Dictionary())) + { + using (var m2 = m.Decrypt(fs)) + { + using (var sr = new System.IO.StreamReader(m2)) + { + ipx = Serializer.Deserialize(sr); + } + } + } + } + else + { + using (var sr = new System.IO.StreamReader(fs)) + { + ipx = Serializer.Deserialize(sr); + } + } + } + + if (ipx.Backup == null) + { + throw new Exception("No backup found in document"); + } + + if (ipx.Backup.Metadata == null) + { + ipx.Backup.Metadata = new Dictionary(); + } + + if (!importMetadata) + { + ipx.Backup.Metadata.Clear(); + } + + ipx.Backup.ID = null; + ipx.Backup.DBPath = null; + + if (ipx.Schedule != null) + { + ipx.Schedule.ID = -1; + } + + return ipx; + } +} diff --git a/Duplicati.Library.RestAPI/Database/Backup.cs b/Duplicati.Library.RestAPI/Database/Backup.cs index 117253942..333c2ec41 100644 --- a/Duplicati.Library.RestAPI/Database/Backup.cs +++ b/Duplicati.Library.RestAPI/Database/Backup.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using Duplicati.Server.Serialization.Interface; using System.Collections.Generic; @@ -46,7 +50,7 @@ namespace Duplicati.Server.Database { this.ID = null; } - + internal void LoadChildren(Connection con) { if (this.IsTemporary) @@ -65,7 +69,9 @@ namespace Duplicati.Server.Database this.Metadata = con.GetMetadata(id); } } - + + protected void SetDBPath(string path) => this.DBPath = path; + /// /// The backup ID /// @@ -90,27 +96,27 @@ namespace Duplicati.Server.Database /// The path to the local database /// public string DBPath { get; internal set; } - + /// /// The backup source folders and files /// public string[] Sources { get; set; } - + /// /// The backup settings /// public ISetting[] Settings { get; set; } - + /// /// The filters applied to the source files /// public IFilter[] Filters { get; set; } - + /// /// The backup metadata /// - public IDictionary Metadata { get; set; } - + public IDictionary Metadata { get; set; } + /// /// Gets a value indicating if this instance is not persisted to the database /// diff --git a/Duplicati.Library.RestAPI/Database/Connection.cs b/Duplicati.Library.RestAPI/Database/Connection.cs index fc47340ef..2590a68f1 100644 --- a/Duplicati.Library.RestAPI/Database/Connection.cs +++ b/Duplicati.Library.RestAPI/Database/Connection.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using System.Collections.Generic; using System.Linq; @@ -38,15 +42,15 @@ namespace Duplicati.Server.Database m_connection = connection; m_errorcmd = m_connection.CreateCommand(); m_errorcmd.CommandText = @"INSERT INTO ""ErrorLog"" (""BackupID"", ""Message"", ""Exception"", ""Timestamp"") VALUES (?,?,?,?)"; - for(var i = 0; i < 4; i++) + for (var i = 0; i < 4; i++) m_errorcmd.Parameters.Add(m_errorcmd.CreateParameter()); - + this.ApplicationSettings = new ServerSettings(this); } - + public void LogError(string backupid, string message, Exception ex) { - lock(m_lock) + lock (m_lock) { if (!long.TryParse(backupid, out long id)) id = -1; @@ -57,49 +61,50 @@ namespace Duplicati.Server.Database m_errorcmd.ExecuteNonQuery(); } } - - internal void ExecuteWithCommand(Action f) + + public void ExecuteWithCommand(Action f) { - lock(m_lock) - using(var cmd = m_connection.CreateCommand()) + lock (m_lock) + using (var cmd = m_connection.CreateCommand()) f(cmd); } - internal Serializable.ImportExportStructure PrepareBackupForExport(IBackup backup) + public Serializable.ImportExportStructure PrepareBackupForExport(IBackup backup) { var scheduleId = GetScheduleIDsFromTags(new string[] { "ID=" + backup.ID }); - return new Serializable.ImportExportStructure() { - CreatedByVersion = System.Reflection.Assembly.GetExecutingAssembly().GetName().Version.ToString(), - Backup = (Database.Backup)backup, - Schedule = (Database.Schedule)(scheduleId.Any() ? GetSchedule(scheduleId.First()) : null), - DisplayNames = SpecialFolders.GetSourceNames(backup) - }; + return new Serializable.ImportExportStructure() + { + CreatedByVersion = System.Reflection.Assembly.GetExecutingAssembly().GetName().Version.ToString(), + Backup = (Database.Backup)backup, + Schedule = (Database.Schedule)(scheduleId.Any() ? GetSchedule(scheduleId.First()) : null), + DisplayNames = SpecialFolders.GetSourceNames(backup) + }; } - + public string RegisterTemporaryBackup(IBackup backup) { - lock(m_lock) + lock (m_lock) { if (backup == null) throw new ArgumentNullException(nameof(backup)); if (backup.ID != null) throw new ArgumentException("Backup is already active, cannot make temporary"); - + backup.ID = Guid.NewGuid().ToString("D"); m_temporaryBackups.Add(backup.ID, (Backup)backup); return backup.ID; } } - + public void UnregisterTemporaryBackup(IBackup backup) { - lock(m_lock) + lock (m_lock) m_temporaryBackups.Remove(backup.ID); } public void UpdateTemporaryBackup(IBackup backup) { - lock(m_lock) + lock (m_lock) if (m_temporaryBackups.Remove(backup.ID)) m_temporaryBackups.Add(backup.ID, (Backup)backup); } @@ -108,8 +113,8 @@ namespace Duplicati.Server.Database { if (string.IsNullOrEmpty(id)) return null; - - lock(m_lock) + + lock (m_lock) { Backup b; m_temporaryBackups.TryGetValue(id, out b); @@ -118,10 +123,10 @@ namespace Duplicati.Server.Database } public ServerSettings ApplicationSettings { get; private set; } - + internal IDictionary GetMetadata(long id) { - lock(m_lock) + lock (m_lock) return ReadFromDb( (rd) => new KeyValuePair( ConvertToString(rd, 0), @@ -130,11 +135,11 @@ namespace Duplicati.Server.Database @"SELECT ""Name"", ""Value"" FROM ""Metadata"" WHERE ""BackupID"" = ? ", id) .ToDictionary((k) => k.Key, (k) => k.Value); } - + internal void SetMetadata(IDictionary values, long id, System.Data.IDbTransaction transaction) { - lock(m_lock) - using(var tr = transaction == null ? m_connection.BeginTransaction() : null) + lock (m_lock) + using (var tr = transaction == null ? m_connection.BeginTransaction() : null) { OverwriteAndUpdateDb( tr, @@ -143,29 +148,30 @@ namespace Duplicati.Server.Database @"INSERT INTO ""Metadata"" (""BackupID"", ""Name"", ""Value"") VALUES (?, ?, ?)", (f) => new object[] { id, f.Key, f.Value } ); - + if (tr != null) tr.Commit(); } } - + internal IFilter[] GetFilters(long id) { - lock(m_lock) + lock (m_lock) return ReadFromDb( - (rd) => (IFilter)new Filter() { - Order = ConvertToInt64(rd, 0), + (rd) => (IFilter)new Filter() + { + Order = ConvertToInt64(rd, 0), Include = ConvertToBoolean(rd, 1), Expression = ConvertToString(rd, 2) ?? "" }, @"SELECT ""Order"", ""Include"", ""Expression"" FROM ""Filter"" WHERE ""BackupID"" = ? ORDER BY ""Order"" ", id) .ToArray(); } - + internal void SetFilters(IEnumerable values, long id, System.Data.IDbTransaction transaction = null) { - lock(m_lock) - using(var tr = transaction == null ? m_connection.BeginTransaction() : null) + lock (m_lock) + using (var tr = transaction == null ? m_connection.BeginTransaction() : null) { OverwriteAndUpdateDb( tr, @@ -174,7 +180,7 @@ namespace Duplicati.Server.Database @"INSERT INTO ""Filter"" (""BackupID"", ""Order"", ""Include"", ""Expression"") VALUES (?, ?, ?, ?)", (f) => new object[] { id, f.Order, f.Include, f.Expression } ); - + if (tr != null) tr.Commit(); } @@ -182,9 +188,10 @@ namespace Duplicati.Server.Database public ISetting[] GetSettings(long id) { - lock(m_lock) + lock (m_lock) return ReadFromDb( - (rd) => (ISetting)new Setting() { + (rd) => (ISetting)new Setting() + { Filter = ConvertToString(rd, 0) ?? "", Name = ConvertToString(rd, 1) ?? "", Value = ConvertToString(rd, 2) ?? "" @@ -193,42 +200,43 @@ namespace Duplicati.Server.Database @"SELECT ""Filter"", ""Name"", ""Value"" FROM ""Option"" WHERE ""BackupID"" = ?", id) .ToArray(); } - + internal void SetSettings(IEnumerable values, long id, System.Data.IDbTransaction transaction = null) { - lock(m_lock) - using(var tr = transaction == null ? m_connection.BeginTransaction() : null) + lock (m_lock) + using (var tr = transaction == null ? m_connection.BeginTransaction() : null) { OverwriteAndUpdateDb( tr, @"DELETE FROM ""Option"" WHERE ""BackupID"" = ?", new object[] { id }, values, @"INSERT INTO ""Option"" (""BackupID"", ""Filter"", ""Name"", ""Value"") VALUES (?, ?, ?, ?)", - (f) => { - if (Duplicati.Server.WebServer.Server.PASSWORD_PLACEHOLDER.Equals(f.Value)) + (f) => + { + if (FIXMEGlobal.PASSWORD_PLACEHOLDER.Equals(f.Value)) throw new Exception("Attempted to save a property with the placeholder password"); return new object[] { id, f.Filter ?? "", f.Name, f.Value ?? "" }; } - ); - + ); + if (tr != null) tr.Commit(); } } - + internal string[] GetSources(long id) { - lock(m_lock) + lock (m_lock) return ReadFromDb( (rd) => ConvertToString(rd, 0), @"SELECT ""Path"" FROM ""Source"" WHERE ""BackupID"" = ?", id) .ToArray(); } - + internal void SetSources(IEnumerable values, long id, System.Data.IDbTransaction transaction) { - lock(m_lock) - using(var tr = transaction == null ? m_connection.BeginTransaction() : null) + lock (m_lock) + using (var tr = transaction == null ? m_connection.BeginTransaction() : null) { OverwriteAndUpdateDb( tr, @@ -236,8 +244,8 @@ namespace Duplicati.Server.Database values, @"INSERT INTO ""Source"" (""BackupID"", ""Path"") VALUES (?, ?)", (f) => new object[] { id, f } - ); - + ); + if (tr != null) tr.Commit(); } @@ -247,16 +255,16 @@ namespace Duplicati.Server.Database { if (tags == null || tags.Length == 0) return new long[0]; - + if (tags.Length == 1 && tags[0].StartsWith("ID=", StringComparison.Ordinal)) return new long[] { long.Parse(tags[0].Substring("ID=".Length)) }; - - lock(m_lock) - using(var cmd = m_connection.CreateCommand()) + + lock (m_lock) + using (var cmd = m_connection.CreateCommand()) { var sb = new StringBuilder(); - - foreach(var t in tags) + + foreach (var t in tags) { if (sb.Length != 0) sb.Append(" OR "); @@ -268,12 +276,12 @@ namespace Duplicati.Server.Database } cmd.CommandText = @"SELECT ""ID"" FROM ""Backup"" WHERE " + sb; - + return Read(cmd, (rd) => ConvertToInt64(rd, 0)).ToArray(); } } - internal IBackup GetBackup(string id) + public IBackup GetBackup(string id) { if (string.IsNullOrWhiteSpace(id)) throw new ArgumentNullException(nameof(id)); @@ -283,10 +291,11 @@ namespace Duplicati.Server.Database internal IBackup GetBackup(long id) { - lock(m_lock) + lock (m_lock) { var bk = ReadFromDb( - (rd) => new Backup { + (rd) => new Backup + { ID = ConvertToInt64(rd, 0).ToString(), Name = ConvertToString(rd, 1), Description = ConvertToString(rd, 2), @@ -296,20 +305,21 @@ namespace Duplicati.Server.Database }, @"SELECT ""ID"", ""Name"", ""Description"", ""Tags"", ""TargetURL"", ""DBPath"" FROM ""Backup"" WHERE ID = ?", id) .FirstOrDefault(); - + if (bk != null) bk.LoadChildren(this); - + return bk; } } - - internal ISchedule GetSchedule(long id) + + public ISchedule GetSchedule(long id) { - lock(m_lock) + lock (m_lock) { var bk = ReadFromDb( - (rd) => new Schedule { + (rd) => new Schedule + { ID = ConvertToInt64(rd, 0), Tags = (ConvertToString(rd, 1) ?? "").Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries), Time = ConvertToDateTime(rd, 2), @@ -324,7 +334,7 @@ namespace Duplicati.Server.Database } } - internal Boolean IsUnencryptedOrPassphraseStored(long id) + public bool IsUnencryptedOrPassphraseStored(long id) { lock (m_lock) { @@ -345,17 +355,17 @@ namespace Duplicati.Server.Database } } - internal long[] GetScheduleIDsFromTags(string[] tags) + public long[] GetScheduleIDsFromTags(string[] tags) { if (tags == null || tags.Length == 0) return new long[0]; - - lock(m_lock) - using(var cmd = m_connection.CreateCommand()) + + lock (m_lock) + using (var cmd = m_connection.CreateCommand()) { var sb = new StringBuilder(); - - foreach(var t in tags) + + foreach (var t in tags) { if (sb.Length != 0) sb.Append(" OR "); @@ -367,7 +377,7 @@ namespace Duplicati.Server.Database } cmd.CommandText = @"SELECT ""ID"" FROM ""Schedule"" WHERE " + sb; - + return Read(cmd, (rd) => ConvertToInt64(rd, 0)).ToArray(); } } @@ -387,7 +397,7 @@ namespace Duplicati.Server.Database if (item.Sources == null || item.Sources.Any(x => string.IsNullOrWhiteSpace(x)) || item.Sources.Length == 0) return "Invalid source list"; - + var disabled_encryption = false; var passphrase = string.Empty; var gpgAsymmetricEncryption = false; @@ -449,7 +459,8 @@ namespace Duplicati.Server.Database if (!string.IsNullOrWhiteSpace(s.Value) && s.Value.Contains("-")) return "The prefix cannot contain hyphens (-)"; } - else if (string.Equals(s.Name, "--gpg-encryption-command", StringComparison.OrdinalIgnoreCase)) { + else if (string.Equals(s.Name, "--gpg-encryption-command", StringComparison.OrdinalIgnoreCase)) + { gpgAsymmetricEncryption = string.Equals(s.Value, "--encrypt", StringComparison.OrdinalIgnoreCase); } } @@ -475,7 +486,7 @@ namespace Duplicati.Server.Database return null; } - internal void UpdateBackupDBPath(IBackup item, string path) + public void UpdateBackupDBPath(IBackup item, string path) { lock (m_lock) { @@ -485,9 +496,9 @@ namespace Duplicati.Server.Database { cmd.Transaction = tr; cmd.Parameters.Add(cmd.CreateParameter()); - ((System.Data.IDbDataParameter) cmd.Parameters[0]).Value = path; + ((System.Data.IDbDataParameter)cmd.Parameters[0]).Value = path; cmd.Parameters.Add(cmd.CreateParameter()); - ((System.Data.IDbDataParameter) cmd.Parameters[1]).Value = item.ID; + ((System.Data.IDbDataParameter)cmd.Parameters[1]).Value = item.ID; cmd.CommandText = @"UPDATE ""Backup"" SET ""DBPath""=? WHERE ""ID""=?"; cmd.ExecuteNonQuery(); @@ -496,13 +507,13 @@ namespace Duplicati.Server.Database } } - FIXMEGlobal.IncrementLastDataUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } private void AddOrUpdateBackup(IBackup item, bool updateSchedule, ISchedule schedule) { - lock(m_lock) + lock (m_lock) { bool update = item.ID != null; if (!update && item.DBPath == null) @@ -511,7 +522,7 @@ namespace Duplicati.Server.Database if (!System.IO.Directory.Exists(folder)) System.IO.Directory.CreateDirectory(folder); - for(var i = 0; i < 100; i++) + for (var i = 0; i < 100; i++) { var guess = System.IO.Path.Combine(folder, System.IO.Path.ChangeExtension(Duplicati.Library.Main.DatabaseLocator.GenerateRandomName(), ".sqlite")); if (!System.IO.File.Exists(guess)) @@ -520,12 +531,12 @@ namespace Duplicati.Server.Database break; } } - + if (item.DBPath == null) throw new Exception("Unable to generate a unique database file name"); } - using(var tr = m_connection.BeginTransaction()) + using (var tr = m_connection.BeginTransaction()) { OverwriteAndUpdateDb( tr, @@ -535,13 +546,14 @@ namespace Duplicati.Server.Database update ? @"UPDATE ""Backup"" SET ""Name""=?, ""Description""=?, ""Tags""=?, ""TargetURL""=? WHERE ""ID""=?" : @"INSERT INTO ""Backup"" (""Name"", ""Description"", ""Tags"", ""TargetURL"", ""DBPath"") VALUES (?,?,?,?,?)", - (n) => { - - if (n.TargetURL.IndexOf(Duplicati.Server.WebServer.Server.PASSWORD_PLACEHOLDER, StringComparison.Ordinal) >= 0) + (n) => + { + + if (n.TargetURL.IndexOf(FIXMEGlobal.PASSWORD_PLACEHOLDER, StringComparison.Ordinal) >= 0) throw new Exception("Attempted to save a backup with the password placeholder"); if (update && long.Parse(n.ID) <= 0) throw new Exception("Invalid update, cannot update application settings through update method"); - + return new object[] { n.Name, n.Description ?? "" , // Description is optional but the column is set to NOT NULL, an additional check is welcome @@ -552,13 +564,13 @@ namespace Duplicati.Server.Database }); if (!update) - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) { cmd.Transaction = tr; cmd.CommandText = @"SELECT last_insert_rowid();"; item.ID = ExecuteScalarInt64(cmd).ToString(); } - + var id = long.Parse(item.ID); if (long.Parse(item.ID) <= 0) @@ -568,10 +580,10 @@ namespace Duplicati.Server.Database SetSettings(item.Settings, id, tr); SetFilters(item.Filters, id, tr); SetMetadata(item.Metadata, id, tr); - + if (updateSchedule) { - var tags = new string[] { "ID=" + item.ID }; + var tags = new string[] { "ID=" + item.ID }; var existing = GetScheduleIDsFromTags(tags); if (schedule == null && existing.Any()) DeleteFromDb("Schedule", existing.First(), tr); @@ -584,41 +596,41 @@ namespace Duplicati.Server.Database cur.Repeat = schedule.Repeat; cur.Tags = schedule.Tags; cur.Time = schedule.Time; - + schedule = cur; } else { schedule.ID = -1; } - + schedule.Tags = tags; AddOrUpdateSchedule(schedule, tr); } } - + tr.Commit(); - FIXMEGlobal.IncrementLastDataUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } } } - + internal void AddOrUpdateSchedule(ISchedule item) { - lock(m_lock) - using(var tr = m_connection.BeginTransaction()) + lock (m_lock) + using (var tr = m_connection.BeginTransaction()) { AddOrUpdateSchedule(item, tr); tr.Commit(); - FIXMEGlobal.IncrementLastDataUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } } - + private void AddOrUpdateSchedule(ISchedule item, System.Data.IDbTransaction tr) { - lock(m_lock) + lock (m_lock) { bool update = item.ID >= 0; OverwriteAndUpdateDb( @@ -637,9 +649,9 @@ namespace Duplicati.Server.Database n.Rule ?? "", update ? (object)item.ID : null }); - + if (!update) - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) { cmd.Transaction = tr; cmd.CommandText = @"SELECT last_insert_rowid();"; @@ -652,10 +664,10 @@ namespace Duplicati.Server.Database { if (ID < 0) return; - - lock(m_lock) + + lock (m_lock) { - using(var tr = m_connection.BeginTransaction()) + using (var tr = m_connection.BeginTransaction()) { var existing = GetScheduleIDsFromTags(new string[] { "ID=" + ID.ToString() }); if (existing.Any()) @@ -669,15 +681,15 @@ namespace Duplicati.Server.Database DeleteFromDb("Source", ID, "BackupID", tr); DeleteFromDb("Backup", ID, tr); - + tr.Commit(); } } - FIXMEGlobal.IncrementLastDataUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } - + public void DeleteBackup(IBackup backup) { if (backup.IsTemporary) @@ -685,32 +697,33 @@ namespace Duplicati.Server.Database else DeleteBackup(long.Parse(backup.ID)); } - + public void DeleteSchedule(long ID) { if (ID < 0) return; - - lock(m_lock) + + lock (m_lock) DeleteFromDb("Schedule", ID); - - FIXMEGlobal.IncrementLastDataUpdateID(); + + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } - + public void DeleteSchedule(ISchedule schedule) { DeleteSchedule(schedule.ID); } - + public IBackup[] Backups { get { - lock(m_lock) + lock (m_lock) { var lst = ReadFromDb( - (rd) => (IBackup)new Backup() { + (rd) => (IBackup)new Backup() + { ID = ConvertToInt64(rd, 0).ToString(), Name = ConvertToString(rd, 1), Description = ConvertToString(rd, 2), @@ -720,23 +733,24 @@ namespace Duplicati.Server.Database }, @"SELECT ""ID"", ""Name"", ""Description"", ""Tags"", ""TargetURL"", ""DBPath"" FROM ""Backup"" ") .ToArray(); - - foreach(var n in lst) + + foreach (var n in lst) n.Metadata = GetMetadata(long.Parse(n.ID)); - - + + return lst; } } } - + public ISchedule[] Schedules { get { - lock(m_lock) + lock (m_lock) return ReadFromDb( - (rd) => (ISchedule)new Schedule() { + (rd) => (ISchedule)new Schedule() + { ID = ConvertToInt64(rd, 0), Tags = (ConvertToString(rd, 1) ?? "").Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries), Time = ConvertToDateTime(rd, 2), @@ -746,16 +760,16 @@ namespace Duplicati.Server.Database }, @"SELECT ""ID"", ""Tags"", ""Time"", ""Repeat"", ""LastRun"", ""Rule"" FROM ""Schedule"" ") .ToArray(); - } + } } - - + + public IFilter[] Filters { get { return GetFilters(ANY_BACKUP_ID); } set { SetFilters(value, ANY_BACKUP_ID); } } - + public ISetting[] Settings { get { return GetSettings(ANY_BACKUP_ID); } @@ -764,13 +778,13 @@ namespace Duplicati.Server.Database public INotification[] GetNotifications() { - lock(m_lock) + lock (m_lock) return ReadFromDb(null).Cast().ToArray(); } public bool DismissNotification(long id) { - lock(m_lock) + lock (m_lock) { var notifications = GetNotifications(); var cur = notifications.FirstOrDefault(x => x.ID == id); @@ -782,7 +796,7 @@ namespace Duplicati.Server.Database FIXMEGlobal.DataConnection.ApplicationSettings.UnackedWarning = notifications.Any(x => x.ID != id && x.Type == Duplicati.Server.Serialization.NotificationType.Warning); } - FIXMEGlobal.IncrementLastNotificationUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastNotificationUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); return true; @@ -790,7 +804,7 @@ namespace Duplicati.Server.Database public void RegisterNotification(Serialization.NotificationType type, string title, string message, Exception ex, string backupid, string action, string logid, string messageid, string logtag, Func conflicthandler) { - lock(m_lock) + lock (m_lock) { var notification = new Notification() { @@ -810,7 +824,7 @@ namespace Duplicati.Server.Database var conflictResult = conflicthandler(notification, GetNotifications()); if (conflictResult == null) return; - + if (conflictResult != notification) DeleteFromDb(typeof(Notification).Name, conflictResult.ID); @@ -822,14 +836,14 @@ namespace Duplicati.Server.Database FIXMEGlobal.DataConnection.ApplicationSettings.UnackedWarning = true; } - FIXMEGlobal.IncrementLastNotificationUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastNotificationUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } //Workaround to clean up the database after invalid settings update public void FixInvalidBackupId() { - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) using (var tr = m_connection.BeginTransaction()) { cmd.Transaction = tr; @@ -858,7 +872,7 @@ namespace Duplicati.Server.Database public string[] GetUISettingsSchemes() { - lock(m_lock) + lock (m_lock) return ReadFromDb( (rd) => ConvertToString(rd, 0) ?? "", @"SELECT DISTINCT ""Scheme"" FROM ""UIStorage""") @@ -867,33 +881,34 @@ namespace Duplicati.Server.Database public IDictionary GetUISettings(string scheme) { - lock(m_lock) + lock (m_lock) return ReadFromDb( (rd) => new KeyValuePair( ConvertToString(rd, 0) ?? "", ConvertToString(rd, 1) ?? "" ), - @"SELECT ""Key"", ""Value"" FROM ""UIStorage"" WHERE ""Scheme"" = ?", + @"SELECT ""Key"", ""Value"" FROM ""UIStorage"" WHERE ""Scheme"" = ?", scheme) .GroupBy(x => x.Key) .ToDictionary(x => x.Key, x => x.Last().Value); } - + public void SetUISettings(string scheme, IDictionary values, System.Data.IDbTransaction transaction = null) { - lock(m_lock) - using(var tr = transaction == null ? m_connection.BeginTransaction() : null) + lock (m_lock) + using (var tr = transaction == null ? m_connection.BeginTransaction() : null) { OverwriteAndUpdateDb( tr, @"DELETE FROM ""UIStorage"" WHERE ""Scheme"" = ?", new object[] { scheme }, values, @"INSERT INTO ""UIStorage"" (""Scheme"", ""Key"", ""Value"") VALUES (?, ?, ?)", - (f) => { + (f) => + { return new object[] { scheme, f.Key ?? "", f.Value ?? "" }; } - ); - + ); + if (tr != null) tr.Commit(); } @@ -922,19 +937,20 @@ namespace Duplicati.Server.Database public TempFile[] GetTempFiles() { - lock(m_lock) + lock (m_lock) return ReadFromDb(null).ToArray(); } public void DeleteTempFile(long id) { - lock(m_lock) + lock (m_lock) DeleteFromDb(typeof(TempFile).Name, id); } public long RegisterTempFile(string origin, string path, DateTime expires) { - var tempfile = new TempFile() { + var tempfile = new TempFile() + { Timestamp = DateTime.Now, Origin = origin, Path = path, @@ -950,8 +966,8 @@ namespace Duplicati.Server.Database { var t = Library.Utility.Utility.NormalizeDateTimeToEpochSeconds(purgeDate); - using(var tr = m_connection.BeginTransaction()) - using(var cmd = m_connection.CreateCommand()) + using (var tr = m_connection.BeginTransaction()) + using (var cmd = m_connection.CreateCommand()) { cmd.Transaction = tr; cmd.CommandText = @"DELETE FROM ""ErrorLog"" WHERE ""Timestamp"" < ?"; @@ -962,7 +978,7 @@ namespace Duplicati.Server.Database tr.Commit(); } } - + private static DateTime ConvertToDateTime(System.Data.IDataReader rd, int index) { var unixTime = ConvertToInt64(rd, index); @@ -973,7 +989,7 @@ namespace Duplicati.Server.Database { return ConvertToInt64(rd, index) == 1; } - + private static string ConvertToString(System.Data.IDataReader rd, int index) { var r = rd.GetValue(index); @@ -996,13 +1012,13 @@ namespace Duplicati.Server.Database private static long ExecuteScalarInt64(System.Data.IDbCommand cmd, long defaultValue = -1) { - using(var rd = cmd.ExecuteReader()) + using (var rd = cmd.ExecuteReader()) return rd.Read() ? ConvertToInt64(rd, 0) : defaultValue; } private static string ExecuteScalarString(System.Data.IDbCommand cmd) { - using(var rd = cmd.ExecuteReader()) + using (var rd = cmd.ExecuteReader()) return rd.Read() ? ConvertToString(rd, 0) : null; } @@ -1029,9 +1045,9 @@ namespace Duplicati.Server.Database // New function that allows to delete rows from tables with arbitrary identifier values (e.g. ID or BackupID) private bool DeleteFromDb(string tablename, long id, string identifier, System.Data.IDbTransaction transaction = null) { - if (transaction == null) + if (transaction == null) { - using(var tr = m_connection.BeginTransaction()) + using (var tr = m_connection.BeginTransaction()) { var r = DeleteFromDb(tablename, id, tr); tr.Commit(); @@ -1040,14 +1056,14 @@ namespace Duplicati.Server.Database } else { - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) { cmd.Transaction = transaction; cmd.CommandText = string.Format(@"DELETE FROM ""{0}"" WHERE ""{1}""=?", tablename, identifier); var p = cmd.CreateParameter(); p.Value = id; cmd.Parameters.Add(p); - + var r = cmd.ExecuteNonQuery(); // Roll back the transaction if more than 1 ID was deleted. Multiple "BackupID" rows being deleted isn't a problem. if (identifier == "ID" && r > 1) @@ -1056,24 +1072,24 @@ namespace Duplicati.Server.Database } } } - + private static IEnumerable Read(System.Data.IDbCommand cmd, Func f) { - using(var rd = cmd.ExecuteReader()) - while(rd.Read()) + using (var rd = cmd.ExecuteReader()) + while (rd.Read()) yield return f(rd); } - + private static IEnumerable Read(System.Data.IDataReader rd, Func f) { - while(rd.Read()) + while (rd.Read()) yield return f(); } private System.Reflection.PropertyInfo[] GetORMFields() { - var flags = - System.Reflection.BindingFlags.FlattenHierarchy | + var flags = + System.Reflection.BindingFlags.FlattenHierarchy | System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public; @@ -1084,10 +1100,10 @@ namespace Duplicati.Server.Database typeof(DateTime) }; - return + return (from n in typeof(T).GetProperties(flags) - where supportedPropertyTypes.Contains(n.PropertyType) || n.PropertyType.IsEnum - select n).ToArray(); + where supportedPropertyTypes.Contains(n.PropertyType) || n.PropertyType.IsEnum + select n).ToArray(); } private IEnumerable ReadFromDb(string whereclause, params object[] args) @@ -1102,26 +1118,27 @@ namespace Duplicati.Server.Database whereclause ?? "" ); - return ReadFromDb((rd) => { - var item = Activator.CreateInstance(); - for(var i = 0; i < properties.Length; i++) - { - var prop = properties[i]; + return ReadFromDb((rd) => + { + var item = Activator.CreateInstance(); + for (var i = 0; i < properties.Length; i++) + { + var prop = properties[i]; - if (prop.PropertyType.IsEnum) - prop.SetValue(item, ConvertToEnum(prop.PropertyType, rd, i, Enum.GetValues(prop.PropertyType).GetValue(0)), null); - else if (prop.PropertyType == typeof(string)) - prop.SetValue(item, ConvertToString(rd, i), null); - else if (prop.PropertyType == typeof(long)) - prop.SetValue(item, ConvertToInt64(rd, i), null); - else if (prop.PropertyType == typeof(bool)) - prop.SetValue(item, ConvertToBoolean(rd, i), null); - else if (prop.PropertyType == typeof(DateTime)) - prop.SetValue(item, ConvertToDateTime(rd, i), null); - } + if (prop.PropertyType.IsEnum) + prop.SetValue(item, ConvertToEnum(prop.PropertyType, rd, i, Enum.GetValues(prop.PropertyType).GetValue(0)), null); + else if (prop.PropertyType == typeof(string)) + prop.SetValue(item, ConvertToString(rd, i), null); + else if (prop.PropertyType == typeof(long)) + prop.SetValue(item, ConvertToInt64(rd, i), null); + else if (prop.PropertyType == typeof(bool)) + prop.SetValue(item, ConvertToBoolean(rd, i), null); + else if (prop.PropertyType == typeof(DateTime)) + prop.SetValue(item, ConvertToDateTime(rd, i), null); + } - return item; - }, sql, args); + return item; + }, sql, args); } private void OverwriteAndUpdateDb(System.Data.IDbTransaction transaction, string deleteSql, object[] deleteArgs, IEnumerable values, bool updateExisting) @@ -1144,7 +1161,7 @@ namespace Duplicati.Server.Database } else { - + sql = string.Format( @"INSERT INTO ""{0}"" (""{1}"") VALUES ({2})", typeof(T).Name, @@ -1164,12 +1181,12 @@ namespace Duplicati.Server.Database else if (x.PropertyType == typeof(DateTime)) val = Library.Utility.Utility.NormalizeDateTimeToEpochSeconds((DateTime)val); - return val; + return val; }).ToArray(); }); if (!updateExisting && values.Count() == 1 && idfield != null) - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) { cmd.Transaction = transaction; cmd.CommandText = @"SELECT last_insert_rowid();"; @@ -1179,64 +1196,64 @@ namespace Duplicati.Server.Database idfield.SetValue(values.First(), ExecuteScalarInt64(cmd), null); } } - + private IEnumerable ReadFromDb(Func f, string sql, params object[] args) { - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) { cmd.CommandText = sql; if (args != null) - foreach(var a in args) + foreach (var a in args) { var p = cmd.CreateParameter(); p.Value = a; cmd.Parameters.Add(p); } - + return Read(cmd, f).ToArray(); } } - + private void OverwriteAndUpdateDb(System.Data.IDbTransaction transaction, string deleteSql, object[] deleteArgs, IEnumerable values, string insertSql, Func f) { - using(var cmd = m_connection.CreateCommand()) + using (var cmd = m_connection.CreateCommand()) { cmd.Transaction = transaction; - + if (!string.IsNullOrEmpty(deleteSql)) { cmd.CommandText = deleteSql; if (deleteArgs != null) - foreach(var a in deleteArgs) + foreach (var a in deleteArgs) { var p = cmd.CreateParameter(); p.Value = a; cmd.Parameters.Add(p); } - + cmd.ExecuteNonQuery(); cmd.Parameters.Clear(); } - + cmd.CommandText = insertSql; - - foreach(var n in values) + + foreach (var n in values) { var r = f(n); if (r == null) continue; - + while (cmd.Parameters.Count < r.Length) cmd.Parameters.Add(cmd.CreateParameter()); - - for(var i = 0; i < r.Length; i++) + + for (var i = 0; i < r.Length; i++) ((System.Data.IDbDataParameter)cmd.Parameters[i]).Value = r[i]; - + cmd.ExecuteNonQuery(); } } } - + #region IDisposable implementation public void Dispose() { @@ -1257,6 +1274,6 @@ namespace Duplicati.Server.Database } #endregion } - + } diff --git a/Duplicati.Library.RestAPI/Database/Database schema/7. Add Token Family.sql b/Duplicati.Library.RestAPI/Database/Database schema/7. Add Token Family.sql new file mode 100644 index 000000000..e91f9864c --- /dev/null +++ b/Duplicati.Library.RestAPI/Database/Database schema/7. Add Token Family.sql @@ -0,0 +1,9 @@ +/* +Token Family table +*/ +CREATE TABLE "TokenFamily" ( + "ID" TEXT PRIMARY KEY, + "UserId" TEXT NOT NULL, + "Counter" INTEGER NOT NULL, + "LastUpdated" INTEGER NOT NULL +); \ No newline at end of file diff --git a/Duplicati.Library.RestAPI/Database/Database schema/Schema.sql b/Duplicati.Library.RestAPI/Database/Database schema/Schema.sql index b05876d22..5b692931d 100644 --- a/Duplicati.Library.RestAPI/Database/Database schema/Schema.sql +++ b/Duplicati.Library.RestAPI/Database/Database schema/Schema.sql @@ -154,5 +154,15 @@ CREATE TABLE "TempFile" ( "Expires" INTEGER NOT NULL ); -INSERT INTO "Version" ("Version") VALUES (6); +/* +Token Family table +*/ +CREATE TABLE "TokenFamily" ( + "ID" TEXT PRIMARY KEY, + "UserId" TEXT NOT NULL, + "Counter" INTEGER NOT NULL, + "LastUpdated" INTEGER NOT NULL +); + +INSERT INTO "Version" ("Version") VALUES (7); diff --git a/Duplicati.Library.RestAPI/Database/Filter.cs b/Duplicati.Library.RestAPI/Database/Filter.cs index 7f14e2bda..904b2bf4c 100644 --- a/Duplicati.Library.RestAPI/Database/Filter.cs +++ b/Duplicati.Library.RestAPI/Database/Filter.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; namespace Duplicati.Server.Database diff --git a/Duplicati.Library.RestAPI/Database/Notification.cs b/Duplicati.Library.RestAPI/Database/Notification.cs index 22b507701..a14d4f6c4 100644 --- a/Duplicati.Library.RestAPI/Database/Notification.cs +++ b/Duplicati.Library.RestAPI/Database/Notification.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; namespace Duplicati.Server.Database @@ -29,7 +33,7 @@ namespace Duplicati.Server.Database public string Exception { get; set; } public string BackupID { get; set; } public string Action { get; set; } - public DateTime Timestamp { get; set; } + public DateTime Timestamp { get; set; } public string LogEntryID { get; set; } public string MessageID { get; set; } public string MessageLogTag { get; set; } diff --git a/Duplicati.Library.RestAPI/Database/Schedule.cs b/Duplicati.Library.RestAPI/Database/Schedule.cs index 7df817d40..5a9d28202 100644 --- a/Duplicati.Library.RestAPI/Database/Schedule.cs +++ b/Duplicati.Library.RestAPI/Database/Schedule.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using System.Linq; using Duplicati.Server.Serialization.Interface; @@ -29,38 +33,38 @@ namespace Duplicati.Server.Database public string Repeat { get; set; } public DateTime LastRun { get; set; } public string Rule { get; set; } - + public DayOfWeek[] AllowedDays - { + { get { if (string.IsNullOrEmpty(this.Rule)) return null; - - var days = (from n in this.Rule.Split(new string[] { ";" }, StringSplitOptions.RemoveEmptyEntries) - where n.StartsWith("AllowedWeekDays=", StringComparison.OrdinalIgnoreCase) - select n.Substring("AllowedWeekDays=".Length).Split(new char[] {','}, StringSplitOptions.RemoveEmptyEntries)) + + var days = (from n in this.Rule.Split(new string[] { ";" }, StringSplitOptions.RemoveEmptyEntries) + where n.StartsWith("AllowedWeekDays=", StringComparison.OrdinalIgnoreCase) + select n.Substring("AllowedWeekDays=".Length).Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries)) .FirstOrDefault(); - - + + if (days == null) return null; - return (from n in days + return (from n in days where Enum.TryParse(n, true, out _) select (DayOfWeek)Enum.Parse(typeof(DayOfWeek), n, true)) .ToArray(); } set { - - var parts = - string.IsNullOrEmpty(this.Rule) ? + + var parts = + string.IsNullOrEmpty(this.Rule) ? new string[0] : - (from n in this.Rule.Split(new string[] { ";" }, StringSplitOptions.RemoveEmptyEntries) - where !n.StartsWith("AllowedWeekDays=", StringComparison.OrdinalIgnoreCase) - select n); - + (from n in this.Rule.Split(new string[] { ";" }, StringSplitOptions.RemoveEmptyEntries) + where !n.StartsWith("AllowedWeekDays=", StringComparison.OrdinalIgnoreCase) + select n); + if (value != null && value.Length != 0) parts = parts.Union(new string[] { "AllowedWeekDays=" + @@ -70,7 +74,7 @@ namespace Duplicati.Server.Database select Enum.GetName(typeof(DayOfWeek), n)).Distinct() ) }).Distinct(); - + this.Rule = string.Join(";", parts); } } diff --git a/Duplicati.Library.RestAPI/Database/ServerSettings.cs b/Duplicati.Library.RestAPI/Database/ServerSettings.cs index 92b02bcfa..758168f24 100644 --- a/Duplicati.Library.RestAPI/Database/ServerSettings.cs +++ b/Duplicati.Library.RestAPI/Database/ServerSettings.cs @@ -1,33 +1,38 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using System.Linq; using System.Collections.Generic; using System.Security.Cryptography; using System.Security.Cryptography.X509Certificates; -using Duplicati.Library.Common; using Duplicati.Library.RestAPI; +using System.Text.Json; +using System.Text; namespace Duplicati.Server.Database { public class ServerSettings { - private static class CONST + public static class CONST { public const string STARTUP_DELAY = "startup-delay"; public const string DOWNLOAD_SPEED_LIMIT = "max-download-speed"; @@ -38,8 +43,6 @@ namespace Duplicati.Server.Database public const string SERVER_PORT_CHANGED = "server-port-changed"; public const string SERVER_PASSPHRASE = "server-passphrase"; public const string SERVER_PASSPHRASE_SALT = "server-passphrase-salt"; - public const string SERVER_PASSPHRASETRAYICON = "server-passphrase-trayicon"; - public const string SERVER_PASSPHRASETRAYICONHASH = "server-passphrase-trayicon-hash"; public const string UPDATE_CHECK_LAST = "last-update-check"; public const string UPDATE_CHECK_INTERVAL = "update-check-interval"; public const string UPDATE_CHECK_NEW_VERSION = "update-check-latest"; @@ -50,10 +53,12 @@ namespace Duplicati.Server.Database public const string HAS_FIXED_INVALID_BACKUPID = "has-fixed-invalid-backup-id"; public const string UPDATE_CHANNEL = "update-channel"; public const string USAGE_REPORTER_LEVEL = "usage-reporter-level"; - public const string HAS_ASKED_FOR_PASSWORD_PROTECTION = "has-asked-for-password-protection"; public const string DISABLE_TRAY_ICON_LOGIN = "disable-tray-icon-login"; public const string SERVER_ALLOWED_HOSTNAMES = "allowed-hostnames"; - } + public const string JWT_CONFIG = "jwt-config"; + public const string PBKDF_CONFIG = "pbkdf-config"; + public const string AUTOGENERATED_PASSPHRASE = "autogenerated-passphrase"; + } private readonly Dictionary settings; private readonly Connection databaseConnection; @@ -68,12 +73,12 @@ namespace Duplicati.Server.Database public void ReloadSettings() { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) { settings.Clear(); - foreach(var n in typeof(CONST).GetFields(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.DeclaredOnly | System.Reflection.BindingFlags.Static).Select(x => (string)x.GetValue(null))) + foreach (var n in typeof(CONST).GetFields(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.DeclaredOnly | System.Reflection.BindingFlags.Static).Select(x => (string)x.GetValue(null))) settings[n] = null; - foreach(var n in databaseConnection.GetSettings(Connection.SERVER_SETTINGS_ID)) + foreach (var n in databaseConnection.GetSettings(Connection.SERVER_SETTINGS_ID)) settings[n.Name] = n.Value; } } @@ -83,59 +88,64 @@ namespace Duplicati.Server.Database if (newsettings == null) throw new ArgumentNullException(); - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) { m_latestUpdate = null; if (clearExisting) settings.Clear(); - foreach(var k in newsettings) + foreach (var k in newsettings) if (!clearExisting && newsettings[k.Key] == null && k.Key.StartsWith("--", StringComparison.Ordinal)) settings.Remove(k.Key); else settings[k.Key] = newsettings[k.Key]; + // Prevent user from logging themselves out, by disabling the login and not knowing the password + if (DisableTrayIconLogin && AutogeneratedPassphrase) + settings[CONST.DISABLE_TRAY_ICON_LOGIN] = false.ToString(); } SaveSettings(); - - if (newsettings.Keys.Contains(CONST.SERVER_PASSPHRASE)) - GenerateWebserverPasswordTrayIcon(); } - + private void SaveSettings() { databaseConnection.SetSettings( from n in settings - select (Duplicati.Server.Serialization.Interface.ISetting)new Setting() { + select (Duplicati.Server.Serialization.Interface.ISetting)new Setting() + { Filter = "", Name = n.Key, Value = n.Value - }, Database.Connection.SERVER_SETTINGS_ID); + }, Database.Connection.SERVER_SETTINGS_ID); - FIXMEGlobal.IncrementLastDataUpdateID(); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); + if (FIXMEGlobal.IsServerStarted) + { + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); + FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); + // If throttle options were changed, update now + FIXMEGlobal.WorkerThreadsManager.UpdateThrottleSpeeds(); + } - // In case the usage reporter is enabled or disabled, refresh now - FIXMEGlobal.StartOrStopUsageReporter(); - // If throttle options were changed, update now - FIXMEGlobal.UpdateThrottleSpeeds(); + // In case the usage reporter is enabled or disabled, refresh now + if (FIXMEGlobal.StartOrStopUsageReporter != null) + FIXMEGlobal.StartOrStopUsageReporter(); } - + public string StartupDelayDuration { - get + get { return settings[CONST.STARTUP_DELAY]; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.STARTUP_DELAY] = value; SaveSettings(); } } - + public System.Threading.ThreadPriority? ThreadPriorityOverride { get @@ -143,43 +153,43 @@ namespace Duplicati.Server.Database var tp = settings[CONST.THREAD_PRIORITY]; if (string.IsNullOrEmpty(tp)) return null; - - System.Threading.ThreadPriority r; + + System.Threading.ThreadPriority r; if (Enum.TryParse(tp, true, out r)) return r; - + return null; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.THREAD_PRIORITY] = value.HasValue ? Enum.GetName(typeof(System.Threading.ThreadPriority), value.Value) : null; } } - + public string DownloadSpeedLimit { - get + get { return settings[CONST.DOWNLOAD_SPEED_LIMIT]; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.DOWNLOAD_SPEED_LIMIT] = value; SaveSettings(); } } - + public string UploadSpeedLimit { - get + get { return settings[CONST.UPLOAD_SPEED_LIMIT]; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UPLOAD_SPEED_LIMIT] = value; SaveSettings(); } @@ -192,23 +202,9 @@ namespace Duplicati.Server.Database return Duplicati.Library.Utility.Utility.ParseBoolOption(settings, CONST.IS_FIRST_RUN); } set - { - lock(databaseConnection.m_lock) - settings[CONST.IS_FIRST_RUN] = value.ToString(); - SaveSettings(); - } - } - - public bool HasAskedForPasswordProtection - { - get - { - return Duplicati.Library.Utility.Utility.ParseBoolOption(settings, CONST.HAS_ASKED_FOR_PASSWORD_PROTECTION); - } - set { lock (databaseConnection.m_lock) - settings[CONST.HAS_ASKED_FOR_PASSWORD_PROTECTION] = value.ToString(); + settings[CONST.IS_FIRST_RUN] = value.ToString(); SaveSettings(); } } @@ -221,7 +217,7 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UNACKED_ERROR] = value.ToString(); SaveSettings(); } @@ -235,7 +231,7 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UNACKED_WARNING] = value.ToString(); SaveSettings(); } @@ -249,7 +245,7 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.SERVER_PORT_CHANGED] = value.ToString(); SaveSettings(); } @@ -269,6 +265,14 @@ namespace Duplicati.Server.Database } } + public bool AutogeneratedPassphrase + { + get + { + return Duplicati.Library.Utility.Utility.ParseBool(settings[CONST.AUTOGENERATED_PASSPHRASE], false); + } + } + public int LastWebserverPort { get @@ -282,57 +286,150 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.LAST_WEBSERVER_PORT] = value.ToString(); SaveSettings(); } } - public string WebserverPassword + /// + /// This class is used to store the PBKDF configuration parameters + /// + private record PbkdfConfig(string Algorithm, int Version, string Salt, int Iterations, string HashAlorithm, string Hash) { - get + /// + /// The version to embed in the configuration + /// + private const int _Version = 1; + /// + /// The algorithm to use + /// + private const string _Algorithm = "PBKDF2"; + /// + /// The hash algorithm to use + /// + private const string _HashAlorithm = "SHA256"; + /// + /// The number of iterations to use + /// + private const int _Iterations = 10000; + /// + /// The size of the hash + /// + private const int _HashSize = 32; + + /// + /// Creates a new PBKDF2 configuration with a random salt + /// + /// The password to hash + public static PbkdfConfig CreatePBKDF2(string password) { - return settings[CONST.SERVER_PASSPHRASE]; + var prng = RandomNumberGenerator.Create(); + var buf = new byte[_HashSize]; + prng.GetBytes(buf); + + var salt = Convert.ToBase64String(buf); + var pbkdf2 = new Rfc2898DeriveBytes(password, buf, _Iterations, new HashAlgorithmName(_HashAlorithm)); + var pwd = Convert.ToBase64String(pbkdf2.GetBytes(_HashSize)); + + return new PbkdfConfig(_Algorithm, _Version, salt, _Iterations, _HashAlorithm, pwd); + } + + /// + /// Verifies a password against a PBKDF2 configuration + /// + /// The password to verify + /// True if the password matches the configuration + public bool VerifyPassword(string password) + { + var pbkdf2 = new Rfc2898DeriveBytes(password, Convert.FromBase64String(Salt), Iterations, new HashAlgorithmName(HashAlorithm)); + var pwd = Convert.ToBase64String(pbkdf2.GetBytes(_HashSize)); + + return pwd == Hash; } } - public string WebserverPasswordSalt + /// + /// Verifies a password against the stored PBKDF configuration + /// + public bool VerifyWebserverPassword(string password) { - get - { - return settings[CONST.SERVER_PASSPHRASE_SALT]; - } + var config = settings[CONST.PBKDF_CONFIG]; + if (string.IsNullOrWhiteSpace(password) || string.IsNullOrWhiteSpace(config)) + return false; + + return JsonSerializer.Deserialize(config).VerifyPassword(LegacyPreparePassword(password)); } + /// + /// Prepares a password by pre-hashing it with a legacy salt, if needed + /// + /// The password to hash + /// The hashed password + private string LegacyPreparePassword(string password) + { + if (string.IsNullOrWhiteSpace(settings[CONST.SERVER_PASSPHRASE_SALT])) + return password; + + var buf = Convert.FromBase64String(settings[CONST.SERVER_PASSPHRASE_SALT]); + var sha256 = SHA256.Create(); + var str = Encoding.UTF8.GetBytes(password); + + sha256.TransformBlock(str, 0, str.Length, str, 0); + sha256.TransformFinalBlock(buf, 0, buf.Length); + return Convert.ToBase64String(sha256.Hash); + } + + /// + /// Upgrades the password to a PBKDF configuration, if using the legacy password setup + /// + public void UpgradePasswordToKBDF() + { + if (!string.IsNullOrWhiteSpace(settings[CONST.PBKDF_CONFIG])) + return; + + // Generate a random password if one is not set + var password = settings[CONST.SERVER_PASSPHRASE]; + var autogenerated = false; + if (string.IsNullOrWhiteSpace(password)) + { + password = Convert.ToBase64String(RandomNumberGenerator.GetBytes(32)); + settings[CONST.SERVER_PASSPHRASE_SALT] = null; + autogenerated = true; + } + + // This will create a new PBKDF2 configuration + // In case the password already exists in the database, + // it will need use the pre-salted password as the password + var config = PbkdfConfig.CreatePBKDF2(password); + lock (databaseConnection.m_lock) + { + settings[CONST.PBKDF_CONFIG] = JsonSerializer.Serialize(config); + settings[CONST.SERVER_PASSPHRASE] = null; + settings[CONST.AUTOGENERATED_PASSPHRASE] = autogenerated.ToString(); + if (autogenerated) + settings[CONST.DISABLE_TRAY_ICON_LOGIN] = false.ToString(); + } + + SaveSettings(); + } + + /// + /// Sets the webserver password + /// + /// The password to set public void SetWebserverPassword(string password) { if (string.IsNullOrWhiteSpace(password)) + throw new Exception("Disabling password protection is not supported"); + + var config = PbkdfConfig.CreatePBKDF2(password); + lock (databaseConnection.m_lock) { - lock(databaseConnection.m_lock) - { - settings[CONST.SERVER_PASSPHRASE] = ""; - settings[CONST.SERVER_PASSPHRASE_SALT] = ""; - } - } - else - { - var prng = RandomNumberGenerator.Create(); - var buf = new byte[32]; - prng.GetBytes(buf); - var salt = Convert.ToBase64String(buf); - - var sha256 = System.Security.Cryptography.SHA256.Create(); - var str = System.Text.Encoding.UTF8.GetBytes(password); - - sha256.TransformBlock(str, 0, str.Length, str, 0); - sha256.TransformFinalBlock(buf, 0, buf.Length); - var pwd = Convert.ToBase64String(sha256.Hash); - - lock(databaseConnection.m_lock) - { - settings[CONST.SERVER_PASSPHRASE] = pwd; - settings[CONST.SERVER_PASSPHRASE_SALT] = salt; - } + settings[CONST.SERVER_PASSPHRASE] = null; + settings[CONST.SERVER_PASSPHRASE_SALT] = null; + settings[CONST.AUTOGENERATED_PASSPHRASE] = false.ToString(); + settings[CONST.PBKDF_CONFIG] = JsonSerializer.Serialize(config); } SaveSettings(); @@ -346,42 +443,22 @@ namespace Duplicati.Server.Database SaveSettings(); } - public string WebserverPasswordTrayIcon => settings[CONST.SERVER_PASSPHRASETRAYICON]; - - public string WebserverPasswordTrayIconHash => settings[CONST.SERVER_PASSPHRASETRAYICONHASH]; - public string AllowedHostnames => settings[CONST.SERVER_ALLOWED_HOSTNAMES]; - public void GenerateWebserverPasswordTrayIcon() + public string JWTConfig { - var password = ""; - var pwd = ""; - - if (!string.IsNullOrEmpty(settings[CONST.SERVER_PASSPHRASE])) + get => settings[CONST.JWT_CONFIG]; + set { - password = Guid.NewGuid().ToString(); - var buf = Convert.FromBase64String(settings[CONST.SERVER_PASSPHRASE_SALT]); - - var sha256 = System.Security.Cryptography.SHA256.Create(); - var str = System.Text.Encoding.UTF8.GetBytes(password); - - sha256.TransformBlock(str, 0, str.Length, str, 0); - sha256.TransformFinalBlock(buf, 0, buf.Length); - pwd = Convert.ToBase64String(sha256.Hash); + lock (databaseConnection.m_lock) + settings[CONST.JWT_CONFIG] = value; + SaveSettings(); } - - lock (databaseConnection.m_lock) - { - settings[CONST.SERVER_PASSPHRASETRAYICON] = password; - settings[CONST.SERVER_PASSPHRASETRAYICONHASH] = pwd; - } - - SaveSettings(); } public DateTime LastUpdateCheck { - get + get { long t; if (long.TryParse(settings[CONST.UPDATE_CHECK_LAST], out t)) @@ -391,7 +468,7 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UPDATE_CHECK_LAST] = value.ToUniversalTime().Ticks.ToString(); SaveSettings(); } @@ -409,7 +486,7 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UPDATE_CHECK_INTERVAL] = value; SaveSettings(); FIXMEGlobal.UpdatePoller.Reschedule(); @@ -443,7 +520,7 @@ namespace Duplicati.Server.Database if (m_latestUpdate != null) return m_latestUpdate; - using(var tr = new System.IO.StringReader(settings[CONST.UPDATE_CHECK_NEW_VERSION])) + using (var tr = new System.IO.StringReader(settings[CONST.UPDATE_CHECK_NEW_VERSION])) return m_latestUpdate = Server.Serialization.Serializer.Deserialize(tr); } catch @@ -458,14 +535,14 @@ namespace Duplicati.Server.Database if (value != null) { var sb = new System.Text.StringBuilder(); - using(var tw = new System.IO.StringWriter(sb)) + using (var tw = new System.IO.StringWriter(sb)) Server.Serialization.Serializer.SerializeJson(tw, value); result = sb.ToString(); } m_latestUpdate = value; - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UPDATE_CHECK_NEW_VERSION] = result; SaveSettings(); @@ -474,13 +551,13 @@ namespace Duplicati.Server.Database public string ServerListenInterface { - get + get { return settings[CONST.SERVER_LISTEN_INTERFACE]; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.SERVER_LISTEN_INTERFACE] = value; SaveSettings(); } @@ -493,7 +570,7 @@ namespace Duplicati.Server.Database if (String.IsNullOrEmpty(settings[CONST.SERVER_SSL_CERTIFICATE])) return null; - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) return new X509Certificate2(Convert.FromBase64String(settings[CONST.SERVER_SSL_CERTIFICATE])); else return new X509Certificate2(Convert.FromBase64String(settings[CONST.SERVER_SSL_CERTIFICATE]), ""); @@ -507,7 +584,7 @@ namespace Duplicati.Server.Database } else { - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) lock (databaseConnection.m_lock) settings[CONST.SERVER_SSL_CERTIFICATE] = Convert.ToBase64String(value.Export(X509ContentType.Pkcs12)); else @@ -526,7 +603,7 @@ namespace Duplicati.Server.Database } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.HAS_FIXED_INVALID_BACKUPID] = value.ToString(); SaveSettings(); } @@ -534,13 +611,13 @@ namespace Duplicati.Server.Database public string UpdateChannel { - get + get { return settings[CONST.UPDATE_CHANNEL]; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.UPDATE_CHANNEL] = value; SaveSettings(); } @@ -548,13 +625,13 @@ namespace Duplicati.Server.Database public string UsageReporterLevel { - get + get { return settings[CONST.USAGE_REPORTER_LEVEL]; } set { - lock(databaseConnection.m_lock) + lock (databaseConnection.m_lock) settings[CONST.USAGE_REPORTER_LEVEL] = value; SaveSettings(); } diff --git a/Duplicati.Library.RestAPI/Database/Setting.cs b/Duplicati.Library.RestAPI/Database/Setting.cs index 84150bf1a..3c5cff529 100644 --- a/Duplicati.Library.RestAPI/Database/Setting.cs +++ b/Duplicati.Library.RestAPI/Database/Setting.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; namespace Duplicati.Server.Database diff --git a/Duplicati.Library.RestAPI/Database/TempFile.cs b/Duplicati.Library.RestAPI/Database/TempFile.cs index b652a2920..284403531 100644 --- a/Duplicati.Library.RestAPI/Database/TempFile.cs +++ b/Duplicati.Library.RestAPI/Database/TempFile.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; namespace Duplicati.Server.Database diff --git a/Duplicati.Library.RestAPI/Duplicati.Library.RestAPI.csproj b/Duplicati.Library.RestAPI/Duplicati.Library.RestAPI.csproj index e10690aa5..e0df1df58 100644 --- a/Duplicati.Library.RestAPI/Duplicati.Library.RestAPI.csproj +++ b/Duplicati.Library.RestAPI/Duplicati.Library.RestAPI.csproj @@ -1,7 +1,8 @@ - + net8.0 + Copyright © 2024 Team Duplicati, MIT license @@ -12,16 +13,9 @@ - - + - - - ..\thirdparty\HttpServer\HttpServer.dll - - - @@ -32,4 +26,9 @@ + + + + + diff --git a/Duplicati.Library.RestAPI/EventPollNotify.cs b/Duplicati.Library.RestAPI/EventPollNotify.cs index 777dc4a1e..4c32f1943 100644 --- a/Duplicati.Library.RestAPI/EventPollNotify.cs +++ b/Duplicati.Library.RestAPI/EventPollNotify.cs @@ -1,7 +1,5 @@ using System; using System.Collections.Generic; -using System.Linq; -using System.Text; namespace Duplicati.Server { diff --git a/Duplicati.Library.RestAPI/FIXMEGlobal.cs b/Duplicati.Library.RestAPI/FIXMEGlobal.cs index 2a8fc3148..b034f8f4a 100644 --- a/Duplicati.Library.RestAPI/FIXMEGlobal.cs +++ b/Duplicati.Library.RestAPI/FIXMEGlobal.cs @@ -2,6 +2,10 @@ using Duplicati.Server; using System; using System.Collections.Generic; +using Duplicati.Library.RestAPI.Abstractions; +using Duplicati.Library.Utility; +using Duplicati.WebserverCore.Abstractions; +using Microsoft.Extensions.DependencyInjection; namespace Duplicati.Library.RestAPI { @@ -11,17 +15,18 @@ namespace Duplicati.Library.RestAPI */ public static class FIXMEGlobal { + /// + /// The placeholder for passwords in the UI + /// + public const string PASSWORD_PLACEHOLDER = "**********"; + + public static IServiceProvider Provider { get; set; } /// /// This is the only access to the database /// public static Server.Database.Connection DataConnection; - /// - /// The controller interface for pause/resume and throttle options - /// - public static LiveControls LiveControl; - /// /// A delegate method for creating a copy of the current progress state /// @@ -30,24 +35,28 @@ namespace Duplicati.Library.RestAPI /// /// The status event signaler, used to control long polling of status updates /// - public static readonly EventPollNotify StatusEventNotifyer = new EventPollNotify(); + public static EventPollNotify StatusEventNotifyer => Provider.GetRequiredService(); + + /// + /// For keeping and incrementing last last events Ids of db save and last notification + /// + public static INotificationUpdateService NotificationUpdateService => Provider.GetRequiredService(); + /// + /// Checks if the server has started and is listening for events + /// + public static bool IsServerStarted => Provider != null; /// /// This is the working thread /// - public static Duplicati.Library.Utility.WorkerThread WorkThread; + public static WorkerThread WorkThread => + Provider.GetRequiredService().WorkerThread; - public static Func PeekLastDataUpdateID; - public static Func PeekLastNotificationUpdateID; - - public static Action IncrementLastDataUpdateID; - - public static Action IncrementLastNotificationUpdateID; + public static IWorkerThreadsManager WorkerThreadsManager => + Provider.GetRequiredService(); public static Action StartOrStopUsageReporter; - public static Action UpdateThrottleSpeeds; - /// /// Gets the folder where Duplicati data is stored /// @@ -56,7 +65,7 @@ namespace Duplicati.Library.RestAPI /// /// This is the scheduling thread /// - public static Scheduler Scheduler; + public static IScheduler Scheduler => Provider.GetRequiredService(); /// /// The log redirect handler @@ -68,7 +77,7 @@ namespace Duplicati.Library.RestAPI /// /// The update poll thread. /// - public static UpdatePollThread UpdatePoller; + public static UpdatePollThread UpdatePoller => Provider.GetRequiredService(); /// @@ -93,5 +102,6 @@ namespace Duplicati.Library.RestAPI /// This is the lock to be used before manipulating the shared resources /// public static readonly object MainLock = new object(); + } } diff --git a/Duplicati.Library.RestAPI/LiveControls.cs b/Duplicati.Library.RestAPI/LiveControls.cs index 1a51636a3..66db81114 100644 --- a/Duplicati.Library.RestAPI/LiveControls.cs +++ b/Duplicati.Library.RestAPI/LiveControls.cs @@ -1,27 +1,28 @@ -#region Disclaimer / License -// Copyright (C) 2015, The Duplicati Team -// http://www.duplicati.com, info@duplicati.com +// Copyright (C) 2024, The Duplicati Team +// https://duplicati.com, hello@duplicati.com // -// This library is free software; you can redistribute it and/or -// modify it under the terms of the GNU Lesser General Public -// License as published by the Free Software Foundation; either -// version 2.1 of the License, or (at your option) any later version. +// 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: // -// This library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. // -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -// -#endregion +// 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.Text; -using Duplicati.Library.Common; -using Duplicati.Library.RestAPI; +using System.Runtime.Versioning; +using Duplicati.Library.IO; +using Duplicati.Server.Database; namespace Duplicati.Server { @@ -29,7 +30,7 @@ namespace Duplicati.Server /// This class keeps track of the users modifications regarding /// throttling and pause/resume /// - public class LiveControls + public class LiveControls : ILiveControls { /// /// The tag used for logging @@ -86,6 +87,8 @@ namespace Duplicati.Server /// public LiveControlState State { get { return m_state; } } + public bool IsPaused => State == LiveControlState.Paused; + /// /// The internal variable that tracks the the priority /// @@ -109,8 +112,8 @@ namespace Duplicati.Server /// /// Gets the current overridden thread priority /// - public System.Threading.ThreadPriority? ThreadPriority - { + public System.Threading.ThreadPriority? ThreadPriority + { get { return m_priority; } set { @@ -126,8 +129,8 @@ namespace Duplicati.Server /// /// Gets the current upload limit in bps /// - public long? UploadLimit - { + public long? UploadLimit + { get { return m_uploadLimit; } set { @@ -143,8 +146,8 @@ namespace Duplicati.Server /// /// Gets the download limit in bps /// - public long? DownloadLimit - { + public long? DownloadLimit + { get { return m_downloadLimit; } set { @@ -160,18 +163,34 @@ namespace Duplicati.Server /// /// The timer that is activated after a pause period. /// - private readonly System.Threading.Timer m_waitTimer; + private System.Threading.Timer m_waitTimer; /// /// The time that the current pause is expected to expire /// private DateTime m_waitTimeExpiration = new DateTime(0); + /// + /// The connection to use + /// + private readonly Connection m_connection; + /// /// Constructs a new instance of the LiveControl /// - public LiveControls(Database.ServerSettings settings) + /// The connection to use + public LiveControls(Connection connection) { + m_connection = connection; + Init(); + } + + /// + /// Constructs a new instance of the LiveControl + /// + private void Init() + { + var settings = m_connection.ApplicationSettings; m_state = LiveControlState.Running; m_waitTimer = new System.Threading.Timer(m_waitTimer_Tick, this, System.Threading.Timeout.Infinite, System.Threading.Timeout.Infinite); @@ -179,7 +198,7 @@ namespace Duplicati.Server { long milliseconds = 0; try { milliseconds = (long)Duplicati.Library.Utility.Timeparser.ParseTimeSpan(settings.StartupDelayDuration).TotalMilliseconds; } - catch {} + catch { } if (milliseconds > 0) { @@ -212,7 +231,7 @@ namespace Duplicati.Server try { - if (!Platform.IsClientPosix) + if (OperatingSystem.IsWindows()) RegisterHibernateMonitor(); } catch { } @@ -222,7 +241,7 @@ namespace Duplicati.Server /// Event that occurs when the timeout duration is exceeded /// /// The sender of the event - private void m_waitTimer_Tick(object sender) + private void m_waitTimer_Tick(object sender) { lock (m_lock) Resume(); @@ -269,7 +288,7 @@ namespace Duplicati.Server /// public void Pause() { - lock(m_lock) + lock (m_lock) { var fireEvent = m_waitTimeExpiration.Ticks != 0 && m_state == LiveControlState.Paused && StateChanged != null; @@ -337,6 +356,7 @@ namespace Duplicati.Server /// /// Method for calling a Win32 API /// + [SupportedOSPlatform("windows")] private void RegisterHibernateMonitor() { Microsoft.Win32.SystemEvents.PowerModeChanged += new Microsoft.Win32.PowerModeChangedEventHandler(SystemEvents_PowerModeChanged); @@ -347,6 +367,7 @@ namespace Duplicati.Server /// /// Unused sender parameter /// The event information + [SupportedOSPlatform("windows")] private void SystemEvents_PowerModeChanged(object sender, object _e) { Microsoft.Win32.PowerModeChangedEventArgs e = _e as Microsoft.Win32.PowerModeChangedEventArgs; @@ -380,7 +401,7 @@ namespace Duplicati.Server { long delayTicks = (m_suspendMinimumPause - DateTime.Now).Ticks; - var appset = FIXMEGlobal.DataConnection.ApplicationSettings; + var appset = m_connection.ApplicationSettings; if (!string.IsNullOrEmpty(appset.StartupDelayDuration) && appset.StartupDelayDuration != "0") try { delayTicks = Math.Max(delayTicks, Library.Utility.Timeparser.ParseTimeSpan(appset.StartupDelayDuration).Ticks); } catch { } diff --git a/Duplicati.Library.RestAPI/LogWriteHandler.cs b/Duplicati.Library.RestAPI/LogWriteHandler.cs index 640886f66..1d8259e19 100644 --- a/Duplicati.Library.RestAPI/LogWriteHandler.cs +++ b/Duplicati.Library.RestAPI/LogWriteHandler.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using System.Linq; using Duplicati.Library.Logging; @@ -130,7 +134,7 @@ namespace Duplicati.Server this.ExceptionID = exception.HelpID; else this.ExceptionID = entry.Exception.GetType().FullName; - + } } @@ -150,15 +154,15 @@ namespace Duplicati.Server { m_buffer = new T[size]; if (initial != null) - foreach(var t in initial) + foreach (var t in initial) this.Enqueue(t); } - + public int Length { get { return m_length; } } public void Enqueue(T item) { - lock(m_lock) + lock (m_lock) { m_key++; m_buffer[m_head] = item; @@ -174,7 +178,7 @@ namespace Duplicati.Server public IEnumerator GetEnumerator() { var k = m_key; - for(var i = 0; i < m_length; i++) + for (var i = 0; i < m_length; i++) if (m_key != k) throw new InvalidOperationException("Buffer was modified while reading"); else @@ -190,7 +194,7 @@ namespace Duplicati.Server public T[] FlatArray(Func filter = null) { - lock(m_lock) + lock (m_lock) if (filter == null) return this.ToArray(); else @@ -218,7 +222,7 @@ namespace Duplicati.Server public void RenewTimeout(LogMessageType type) { - lock(m_lock) + lock (m_lock) { m_timeouts[(int)type] = DateTime.Now.AddSeconds(30); m_anytimeouts = true; @@ -245,12 +249,12 @@ namespace Duplicati.Server UpdateLogLevel(); offset = offset.ToUniversalTime(); - lock(m_lock) + lock (m_lock) { if (m_buffer == null) return new LogEntry[0]; - - return m_buffer.FlatArray((x) => x.When > offset && x.Type >= level ); + + return m_buffer.FlatArray((x) => x.When > offset && x.Type >= level); } } @@ -259,18 +263,20 @@ namespace Duplicati.Server RenewTimeout(level); UpdateLogLevel(); - lock(m_lock) + lock (m_lock) { if (m_buffer == null) return new LogEntry[0]; - - var buffer = m_buffer.FlatArray((x) => x.ID > id && x.Type >= level ); + + var buffer = m_buffer.FlatArray((x) => x.ID > id && x.Type >= level); // Return the newest entries - if (buffer.Length > pagesize) { + if (buffer.Length > pagesize) + { var index = buffer.Length - pagesize; return buffer.Skip(index).Take(pagesize).ToArray(); } - else { + else + { return buffer; } } @@ -280,13 +286,13 @@ namespace Duplicati.Server { var i = 0; return (from n in m_timeouts - let ix = i++ - where n > DateTime.Now - select ix).ToArray(); + let ix = i++ + where n > DateTime.Now + select ix).ToArray(); } private void UpdateLogLevel() - { + { m_logLevel = (LogMessageType)(GetActiveTimeouts().Union(new int[] { (int)m_serverloglevel }).Min()); } @@ -296,9 +302,9 @@ namespace Duplicati.Server public void WriteMessage(Duplicati.Library.Logging.LogEntry entry) { - if (entry.Level < m_logLevel) + if (entry.Level < m_logLevel) return; - + if (m_serverfile != null && entry.Level >= m_serverloglevel) try { @@ -308,7 +314,7 @@ namespace Duplicati.Server { } - lock(m_lock) + lock (m_lock) { if (m_anytimeouts) { diff --git a/Duplicati.Library.RestAPI/NotificationUpdateService.cs b/Duplicati.Library.RestAPI/NotificationUpdateService.cs new file mode 100644 index 000000000..2bbec0ce3 --- /dev/null +++ b/Duplicati.Library.RestAPI/NotificationUpdateService.cs @@ -0,0 +1,50 @@ +namespace Duplicati.Library.RestAPI; + +public interface INotificationUpdateService +{ + /// + /// An event ID that increases whenever the database is updated + /// + long LastDataUpdateId { get; } + + /// + /// An event ID that increases whenever a notification is updated + /// + long LastNotificationUpdateId { get; } + + void IncrementLastDataUpdateId(); + void IncrementLastNotificationUpdateId(); +} + +public class NotificationUpdateService : INotificationUpdateService +{ + /// + /// An event ID that increases whenever the database is updated + /// + public long LastDataUpdateId { get; private set; } = 0; + + private readonly object _lastDataUpdateIdLock = new(); + + /// + /// An event ID that increases whenever a notification is updated + /// + public long LastNotificationUpdateId { get; private set; } = 0; + + private readonly object _lastNotificationUpdateIdLock = new(); + + public void IncrementLastDataUpdateId() + { + lock (_lastDataUpdateIdLock) + { + LastDataUpdateId++; + } + } + + public void IncrementLastNotificationUpdateId() + { + lock (_lastNotificationUpdateIdLock) + { + LastNotificationUpdateId++; + } + } +} \ No newline at end of file diff --git a/Duplicati.Library.RestAPI/RESTMethods/Acknowledgements.cs b/Duplicati.Library.RestAPI/RESTMethods/Acknowledgements.cs deleted file mode 100644 index f9b558c5b..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Acknowledgements.cs +++ /dev/null @@ -1,57 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Library.Common.IO; -using Duplicati.Library.Utility; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Acknowledgements : IRESTMethodGET, IRESTMethodDocumented - { - private class GetResponse - { - public string Status; - public string Acknowledgements; - } - - public void GET(string key, RequestInfo info) - { - var path = SystemIO.IO_OS.PathCombine(System.IO.Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location), "acknowledgements.txt"); - info.OutputOK(new GetResponse() { - Status = "OK", - Acknowledgements = System.IO.File.ReadAllText(path) - }); - } - public string Description { get { return "Gets all acknowledgements"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(GetResponse)), - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Backup.cs b/Duplicati.Library.RestAPI/RESTMethods/Backup.cs deleted file mode 100644 index e18730fea..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Backup.cs +++ /dev/null @@ -1,742 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Server.Serialization; -using System.IO; -using System.Linq; -using Duplicati.Server.Serialization.Interface; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Backup : IRESTMethodGET, IRESTMethodPUT, IRESTMethodPOST, IRESTMethodDELETE, IRESTMethodDocumented - { - public class GetResponse - { - public class GetResponseData - { - public Serialization.Interface.ISchedule Schedule; - public Serialization.Interface.IBackup Backup; - public Dictionary DisplayNames; - } - - public bool success; - - public GetResponseData data; - } - - private void SearchFiles(IBackup backup, string filterstring, RequestInfo info) - { - var filter = filterstring; - var timestring = info.Request.QueryString["time"].Value; - var allversion = Duplicati.Library.Utility.Utility.ParseBool(info.Request.QueryString["all-versions"].Value, false); - - if (string.IsNullOrWhiteSpace(timestring) && !allversion) - { - info.ReportClientError("Invalid or missing time", System.Net.HttpStatusCode.BadRequest); - return; - } - - var prefixonly = Duplicati.Library.Utility.Utility.ParseBool(info.Request.QueryString["prefix-only"].Value, false); - var foldercontents = Duplicati.Library.Utility.Utility.ParseBool(info.Request.QueryString["folder-contents"].Value, false); - var time = new DateTime(); - if (!allversion) - time = Duplicati.Library.Utility.Timeparser.ParseTimeInterval(timestring, DateTime.Now); - - var r = Runner.Run(Runner.CreateListTask(backup, new string[] { filter }, prefixonly, allversion, foldercontents, time), false) as Duplicati.Library.Interface.IListResults; - - var result = new Dictionary(); - - foreach(HttpServer.HttpInputItem n in info.Request.QueryString) - result[n.Name] = n.Value; - - result["Filesets"] = r.Filesets; - result["Files"] = r.Files - // Group directories first - support either directory separator here as we may be restoring data from an alternate platform - .OrderByDescending(f => (f.Path.StartsWith("/", StringComparison.Ordinal) && f.Path.EndsWith("/", StringComparison.Ordinal)) || (!f.Path.StartsWith("/", StringComparison.Ordinal) && f.Path.EndsWith("\\", StringComparison.Ordinal))) - // Sort both groups (directories and files) alphabetically - .ThenBy(f => f.Path); - - info.OutputOK(result); - - } - - private void ListFileSets(IBackup backup, RequestInfo info) - { - var input = info.Request.QueryString; - var extra = new Dictionary - { - ["list-sets-only"] = "true" - }; - if (input["include-metadata"].Value != null) - extra["list-sets-only"] = (!Library.Utility.Utility.ParseBool(input["include-metadata"].Value, false)).ToString(); - if (input["from-remote-only"].Value != null) - extra["no-local-db"] = Library.Utility.Utility.ParseBool(input["from-remote-only"].Value, false).ToString(); - - var r = Runner.Run(Runner.CreateTask(DuplicatiOperation.List, backup, extra), false) as Duplicati.Library.Interface.IListResults; - - if (r.EncryptedFiles && backup.Settings.Any(x => string.Equals("--no-encryption", x.Name, StringComparison.OrdinalIgnoreCase))) - info.ReportServerError("encrypted-storage"); - else - info.OutputOK(r.Filesets); - } - - private void FetchLogData(IBackup backup, RequestInfo info) - { - using(var con = Duplicati.Library.SQLiteHelper.SQLiteLoader.LoadConnection(backup.DBPath)) - using(var cmd = con.CreateCommand()) - info.OutputOK(LogData.DumpTable(cmd, "LogData", "ID", info.Request.QueryString["offset"].Value, info.Request.QueryString["pagesize"].Value)); - } - - private void FetchRemoteLogData(IBackup backup, RequestInfo info) - { - using(var con = Duplicati.Library.SQLiteHelper.SQLiteLoader.LoadConnection(backup.DBPath)) - using(var cmd = con.CreateCommand()) - { - var dt = LogData.DumpTable(cmd, "RemoteOperation", "ID", info.Request.QueryString["offset"].Value, info.Request.QueryString["pagesize"].Value); - - // Unwrap raw data to a string - foreach(var n in dt) - try { n["Data"] = System.Text.Encoding.UTF8.GetString((byte[])n["Data"]); } - catch { } - - info.OutputOK(dt); - } - } - private void IsDBUsedElseWhere(IBackup backup, RequestInfo info) - { - info.OutputOK(new { inuse = Library.Main.DatabaseLocator.IsDatabasePathInUse(backup.DBPath) }); - } - - public static void RemovePasswords(IBackup backup) - { - backup.SanitizeSettings(); - backup.SanitizeTargetUrl(); - } - - private void Export(IBackup backup, RequestInfo info) - { - var cmdline = Library.Utility.Utility.ParseBool(info.Request.QueryString["cmdline"].Value, false); - var argsonly = Library.Utility.Utility.ParseBool(info.Request.QueryString["argsonly"].Value, false); - var exportPasswords = Library.Utility.Utility.ParseBool(info.Request.QueryString["export-passwords"].Value, false); - if (!exportPasswords) - { - Backup.RemovePasswords(backup); - } - - if (cmdline) - { - info.OutputOK(new { Command = Runner.GetCommandLine(Runner.CreateTask(DuplicatiOperation.Backup, backup)) }); - } - else if (argsonly) - { - var parts = Runner.GetCommandLineParts(Runner.CreateTask(DuplicatiOperation.Backup, backup)); - - info.OutputOK(new { - Backend = parts.First(), - Arguments = parts.Skip(1).Where(x => !x.StartsWith("--", StringComparison.Ordinal)), - Options = parts.Skip(1).Where(x => x.StartsWith("--", StringComparison.Ordinal)) - }); - } - else - { - var passphrase = info.Request.QueryString["passphrase"].Value; - byte[] data = Backup.ExportToJSON(backup, passphrase); - - string filename = Library.Utility.Uri.UrlEncode(backup.Name) + "-duplicati-config.json"; - if (!string.IsNullOrWhiteSpace(passphrase)) - { - filename += ".aes"; - } - - info.Response.ContentLength = data.Length; - info.Response.AddHeader("Content-Disposition", string.Format("attachment; filename={0}", filename)); - info.Response.ContentType = "application/octet-stream"; - - info.BodyWriter.SetOK(); - info.Response.SendHeaders(); - info.Response.SendBody(data); - } - } - - public static byte[] ExportToJSON(IBackup backup, string passphrase) - { - Serializable.ImportExportStructure ipx = FIXMEGlobal.DataConnection.PrepareBackupForExport(backup); - - byte[] data; - using (MemoryStream ms = new System.IO.MemoryStream()) - { - using (StreamWriter sw = new System.IO.StreamWriter(ms)) - { - Serializer.SerializeJson(sw, ipx, true); - - if (!string.IsNullOrWhiteSpace(passphrase)) - { - ms.Position = 0; - using (MemoryStream ms2 = new System.IO.MemoryStream()) - { - using (Library.Encryption.AESEncryption m = new Duplicati.Library.Encryption.AESEncryption(passphrase, new Dictionary())) - { - m.Encrypt(ms, ms2); - data = ms2.ToArray(); - } - } - } - else - { - data = ms.ToArray(); - } - } - } - - return data; - } - - private void RestoreFiles(IBackup backup, RequestInfo info) - { - var input = info.Request.Form; - - string[] filters = parsePaths(input["paths"].Value ?? string.Empty); - - var passphrase = string.IsNullOrEmpty(input["passphrase"].Value) ? null : input["passphrase"].Value; - - var time = Duplicati.Library.Utility.Timeparser.ParseTimeInterval(input["time"].Value, DateTime.Now); - var restoreTarget = input["restore-path"].Value; - var overwrite = Duplicati.Library.Utility.Utility.ParseBool(input["overwrite"].Value, false); - - var permissions = Duplicati.Library.Utility.Utility.ParseBool(input["permissions"].Value, false); - var skip_metadata = Duplicati.Library.Utility.Utility.ParseBool(input["skip-metadata"].Value, false); - - var task = Runner.CreateRestoreTask(backup, filters, time, restoreTarget, overwrite, permissions, skip_metadata, passphrase); - - FIXMEGlobal.WorkThread.AddTask(task); - - info.OutputOK(new { TaskID = task.TaskID }); - } - - private void CreateReport(IBackup backup, RequestInfo info) - { - var task = Runner.CreateTask(DuplicatiOperation.CreateReport, backup); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new { Status = "OK", ID = task.TaskID }); - } - - private void ReportRemoteSize(IBackup backup, RequestInfo info) - { - var task = Runner.CreateTask(DuplicatiOperation.ListRemote, backup); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new { Status = "OK", ID = task.TaskID }); - } - - private void Repair(IBackup backup, RequestInfo info) - { - DoRepair(backup, info, false); - } - - private void RepairUpdate(IBackup backup, RequestInfo info) - { - DoRepair(backup, info, true); - } - - private void Vacuum(IBackup backup, RequestInfo info) - { - var task = Runner.CreateTask(DuplicatiOperation.Vacuum, backup); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new { Status = "OK", ID = task.TaskID }); - } - - private void Verify(IBackup backup, RequestInfo info) - { - var task = Runner.CreateTask(DuplicatiOperation.Verify, backup); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new {Status = "OK", ID = task.TaskID}); - } - - private void Compact(IBackup backup, RequestInfo info) - { - var task = Runner.CreateTask(DuplicatiOperation.Compact, backup); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new { Status = "OK", ID = task.TaskID }); - } - - private string[] parsePaths(string paths) - { - string[] filters; - var rawpaths = (paths ?? string.Empty).Trim(); - - // We send the file list as a JSON array to avoid encoding issues with the path separator - // as it is an allowed character in file and path names. - // We also accept the old way, for compatibility with the greeno theme - if (!string.IsNullOrWhiteSpace(rawpaths) && rawpaths.StartsWith("[", StringComparison.Ordinal) && rawpaths.EndsWith("]", StringComparison.Ordinal)) - filters = Newtonsoft.Json.JsonConvert.DeserializeObject(rawpaths); - else - filters = paths.Split(new string[] { System.IO.Path.PathSeparator.ToString() }, StringSplitOptions.RemoveEmptyEntries); - - return filters; - } - - private void DoRepair(IBackup backup, RequestInfo info, bool repairUpdate) - { - var input = info.Request.Form; - string[] filters = null; - var extra = new Dictionary(); - if (input["only-paths"].Value != null) - extra["repair-only-paths"] = (Library.Utility.Utility.ParseBool(input["only-paths"].Value, false)).ToString(); - if (input["time"].Value != null) - extra["time"] = input["time"].Value; - if (input["version"].Value != null) - extra["version"] = input["version"].Value; - if (input["paths"].Value != null) - filters = parsePaths(input["paths"].Value); - - var task = Runner.CreateTask(repairUpdate ? DuplicatiOperation.RepairUpdate : DuplicatiOperation.Repair, backup, extra, filters); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new {Status = "OK", ID = task.TaskID}); - } - - private void RunBackup(IBackup backup, RequestInfo info) - { - var t = FIXMEGlobal.WorkThread.CurrentTask; - var bt = t == null ? null : t.Backup; - if (bt != null && backup.ID == bt.ID) - { - // Already running - } - else if (FIXMEGlobal.WorkThread.CurrentTasks.Any(x => { - var bn = x?.Backup; - return bn == null || bn.ID == backup.ID; - })) - { - // Already in queue - } - else - { - FIXMEGlobal.WorkThread.AddTask(Runner.CreateTask(DuplicatiOperation.Backup, backup), true); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - } - - info.OutputOK(); - } - - private void IsActive(IBackup backup, RequestInfo info) - { - var t = FIXMEGlobal.WorkThread.CurrentTask; - var bt = t?.Backup; - if (bt != null && backup.ID == bt.ID) - { - info.OutputOK(new { Status = "OK", Active = true }); - return; - } - else if (FIXMEGlobal.WorkThread.CurrentTasks.Any(x => - { - var bn = x?.Backup; - return bn == null || bn.ID == backup.ID; - })) - { - info.OutputOK(new { Status = "OK", Active = true }); - return; - } - else - { - info.OutputOK(new { Status = "OK", Active = false }); - return; - } - } - - private void UpdateDatabasePath(IBackup backup, RequestInfo info, bool move) - { - var np = info.Request.Form["path"].Value; - if (string.IsNullOrWhiteSpace(np)) - info.ReportClientError("No target path supplied", System.Net.HttpStatusCode.BadRequest); - else if (!Path.IsPathRooted(np)) - info.ReportClientError("Target path is relative, please supply a fully qualified path", System.Net.HttpStatusCode.BadRequest); - else - { - if (move && (File.Exists(np) || Directory.Exists(np))) - info.ReportClientError("A file already exists at the new location", System.Net.HttpStatusCode.Conflict); - else - { - if (move) - File.Move(backup.DBPath, np); - - FIXMEGlobal.DataConnection.UpdateBackupDBPath(backup, np); - } - - } - - } - - public void GET(string key, RequestInfo info) - { - var parts = (key ?? "").Split(new char[] { '/' }, 2); - var bk = FIXMEGlobal.DataConnection.GetBackup(parts.First()); - if (bk == null) - info.ReportClientError("Invalid or missing backup id", System.Net.HttpStatusCode.NotFound); - else - { - if (parts.Length > 1) - { - var operation = parts.Last().Split(new char[] {'/'}).First().ToLowerInvariant(); - - switch (operation) - { - case "files": - var filter = parts.Last().Split(new char[] { '/' }, 2).Skip(1).FirstOrDefault(); - if (!string.IsNullOrWhiteSpace(info.Request.QueryString["filter"].Value)) - filter = info.Request.QueryString["filter"].Value; - SearchFiles(bk, filter, info); - return; - case "log": - FetchLogData(bk, info); - return; - case "remotelog": - FetchRemoteLogData(bk, info); - return; - case "filesets": - ListFileSets(bk, info); - return; - case "export": - Export(bk, info); - return; - case "isdbusedelsewhere": - IsDBUsedElseWhere(bk, info); - return; - case "isactive": - IsActive(bk, info); - return; - default: - info.ReportClientError(string.Format("Invalid component: {0}", operation), System.Net.HttpStatusCode.BadRequest); - return; - } - - } - - var scheduleId = FIXMEGlobal.DataConnection.GetScheduleIDsFromTags(new string[] { "ID=" + bk.ID }); - var schedule = scheduleId.Any() ? FIXMEGlobal.DataConnection.GetSchedule(scheduleId.First()) : null; - var sourcenames = SpecialFolders.GetSourceNames(bk); - - //TODO: Filter out the password in both settings and the target url - - info.OutputOK(new GetResponse() - { - success = true, - data = new GetResponse.GetResponseData { - Schedule = schedule, - Backup = bk, - DisplayNames = sourcenames - } - }); - } - } - - public void POST(string key, RequestInfo info) - { - var parts = (key ?? "").Split(new char[] { '/' }, 2); - var bk = FIXMEGlobal.DataConnection.GetBackup(parts.First()); - if (bk == null) - info.ReportClientError("Invalid or missing backup id", System.Net.HttpStatusCode.NotFound); - else - { - if (parts.Length > 1) - { - var operation = parts.Last().Split(new char[] { '/' }).First().ToLowerInvariant(); - - switch (operation) - { - case "deletedb": - System.IO.File.Delete(bk.DBPath); - info.OutputOK(); - return; - - case "movedb": - UpdateDatabasePath(bk, info, true); - return; - - case "updatedb": - UpdateDatabasePath(bk, info, false); - return; - - case "restore": - RestoreFiles(bk, info); - return; - - case "createreport": - CreateReport(bk, info); - return; - - case "repair": - Repair(bk, info); - return; - - case "repairupdate": - RepairUpdate(bk, info); - return; - - case "vacuum": - Vacuum(bk, info); - return; - - case "verify": - Verify(bk, info); - return; - - case "compact": - Compact(bk, info); - return; - - case "start": - case "run": - RunBackup(bk, info); - return; - - case "report-remote-size": - ReportRemoteSize(bk, info); - return; - - case "copytotemp": - var ipx = Serializer.Deserialize(new StringReader(Newtonsoft.Json.JsonConvert.SerializeObject(bk))); - - using(var tf = new Duplicati.Library.Utility.TempFile()) - ipx.DBPath = tf; - ipx.ID = null; - - info.OutputOK(new { status = "OK", ID = FIXMEGlobal.DataConnection.RegisterTemporaryBackup(ipx) }); - return; - } - } - - info.ReportClientError("Invalid request", System.Net.HttpStatusCode.BadRequest); - } - } - - public void PUT(string key, RequestInfo info) - { - string str = info.Request.Form["data"].Value; - if (string.IsNullOrWhiteSpace(str)) - str = System.Threading.Tasks.Task.Run(async () => - { - using (var sr = new System.IO.StreamReader(info.Request.Body, System.Text.Encoding.UTF8, true)) - - return await sr.ReadToEndAsync(); - }).GetAwaiter().GetResult(); - - if (string.IsNullOrWhiteSpace(str)) - { - info.ReportClientError("Missing backup object", System.Net.HttpStatusCode.BadRequest); - return; - } - - Backups.AddOrUpdateBackupData data = null; - try - { - data = Serializer.Deserialize(new StringReader(str)); - if (data.Backup == null) - { - info.ReportClientError("Data object had no backup entry", System.Net.HttpStatusCode.BadRequest); - return; - } - - if (!string.IsNullOrEmpty(key)) - data.Backup.ID = key; - - if (string.IsNullOrEmpty(data.Backup.ID)) - { - info.ReportClientError("Invalid or missing backup id", System.Net.HttpStatusCode.BadRequest); - return; - } - - - if (data.Backup.IsTemporary) - { - var backup = FIXMEGlobal.DataConnection.GetBackup(data.Backup.ID); - if (backup.IsTemporary) - throw new InvalidDataException("External is temporary but internal is not?"); - - FIXMEGlobal.DataConnection.UpdateTemporaryBackup(backup); - info.OutputOK(); - } - else - { - lock(FIXMEGlobal.DataConnection.m_lock) - { - var backup = FIXMEGlobal.DataConnection.GetBackup(data.Backup.ID); - if (backup == null) - { - info.ReportClientError("Invalid or missing backup id", System.Net.HttpStatusCode.NotFound); - return; - } - - if (FIXMEGlobal.DataConnection.Backups.Any(x => x.Name.Equals(data.Backup.Name, StringComparison.OrdinalIgnoreCase) && x.ID != data.Backup.ID)) - { - info.ReportClientError("There already exists a backup with the name: " + data.Backup.Name, System.Net.HttpStatusCode.Conflict); - return; - } - - var err = FIXMEGlobal.DataConnection.ValidateBackup(data.Backup, data.Schedule); - if (!string.IsNullOrWhiteSpace(err)) - { - info.ReportClientError(err, System.Net.HttpStatusCode.BadRequest); - return; - } - - //TODO: Merge in real passwords where the placeholder is found - FIXMEGlobal.DataConnection.AddOrUpdateBackupAndSchedule(data.Backup, data.Schedule); - - } - - info.OutputOK(); - } - } - catch (Exception ex) - { - if (data == null) - info.ReportClientError(string.Format("Unable to parse backup or schedule object: {0}", ex.Message), System.Net.HttpStatusCode.BadRequest); - else - info.ReportClientError(string.Format("Unable to save backup or schedule: {0}", ex.Message), System.Net.HttpStatusCode.InternalServerError); - } - } - - public void DELETE(string key, RequestInfo info) - { - var backup = FIXMEGlobal.DataConnection.GetBackup(key); - if (backup == null) - { - info.ReportClientError("Invalid or missing backup id", System.Net.HttpStatusCode.NotFound); - return; - } - - var delete_remote_files = Library.Utility.Utility.ParseBool(info.Request.Param["delete-remote-files"].Value, false); - - if (delete_remote_files) - { - var captcha_token = info.Request.Param["captcha-token"].Value; - var captcha_answer = info.Request.Param["captcha-answer"].Value; - if (string.IsNullOrWhiteSpace(captcha_token) || string.IsNullOrWhiteSpace(captcha_answer)) - { - info.ReportClientError("Missing captcha", System.Net.HttpStatusCode.Unauthorized); - return; - } - - if (!Captcha.SolvedCaptcha(captcha_token, "DELETE /backup/" + backup.ID, captcha_answer)) - { - info.ReportClientError("Invalid captcha", System.Net.HttpStatusCode.Forbidden); - return; - } - } - - if (FIXMEGlobal.WorkThread.Active) - { - try - { - //TODO: It's not safe to access the values like this, - //because the runner thread might interfere - var nt = FIXMEGlobal.WorkThread.CurrentTask; - if (backup.Equals(nt == null ? null : nt.Backup)) - { - bool force; - if (!bool.TryParse(info.Request.QueryString["force"].Value, out force)) - force = false; - - if (!force) - { - info.OutputError(new { status = "failed", reason = "backup-in-progress" }); - return; - } - - bool hasPaused = FIXMEGlobal.LiveControl.State == LiveControls.LiveControlState.Paused; - FIXMEGlobal.LiveControl.Pause(); - - for(int i = 0; i < 10; i++) - if (FIXMEGlobal.WorkThread.Active) - { - var t = FIXMEGlobal.WorkThread.CurrentTask; - if (backup.Equals(t == null ? null : t.Backup)) - System.Threading.Thread.Sleep(1000); - else - break; - } - else - break; - - if (FIXMEGlobal.WorkThread.Active) - { - var t = FIXMEGlobal.WorkThread.CurrentTask; - if (backup.Equals(t == null ? null : t.Backup)) - { - if (hasPaused) - FIXMEGlobal.LiveControl.Resume(); - info.OutputError(new { status = "failed", reason = "backup-unstoppable" }); - return; - } - } - - if (hasPaused) - FIXMEGlobal.LiveControl.Resume(); - } - } - catch (Exception ex) - { - info.OutputError(new { status = "error", message = ex.Message }); - return; - } - } - - var extra = new Dictionary(); - if (!string.IsNullOrWhiteSpace(info.Request.Param["delete-local-db"].Value)) - extra["delete-local-db"] = info.Request.Param["delete-local-db"].Value; - if (delete_remote_files) - extra["delete-remote-files"] = "true"; - - var task = Runner.CreateTask(DuplicatiOperation.Delete, backup, extra); - FIXMEGlobal.WorkThread.AddTask(task); - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - info.OutputOK(new { Status = "OK", ID = task.TaskID }); - } - public string Description { get { return "Retrieves, updates or deletes an existing backup and schedule"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(GetResponse)), - new KeyValuePair(HttpServer.Method.Put, typeof(Backups.AddOrUpdateBackupData)), - new KeyValuePair(HttpServer.Method.Delete, typeof(long)) - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/BackupDefaults.cs b/Duplicati.Library.RestAPI/RESTMethods/BackupDefaults.cs deleted file mode 100644 index 4d6675520..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/BackupDefaults.cs +++ /dev/null @@ -1,141 +0,0 @@ -// 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; -using System.Linq; -using Duplicati.Library.Common.IO; -using Duplicati.Library.RestAPI; -using Duplicati.Library.Utility; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class BackupDefaults : IRESTMethodGET - { - - private static readonly string LOGTAG = Library.Logging.Log.LogTagFromType(); - - public void GET(string key, RequestInfo info) - { - // Start with a scratch object - var o = new Newtonsoft.Json.Linq.JObject(); - - // Add application wide settings - o.Add("ApplicationOptions", new Newtonsoft.Json.Linq.JArray( - from n in FIXMEGlobal.DataConnection.Settings - select Newtonsoft.Json.Linq.JObject.FromObject(n) - )); - - try - { - // Add built-in defaults - Newtonsoft.Json.Linq.JObject n; - using(var s = new System.IO.StreamReader(System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream(typeof(FIXMEGlobal), "newbackup.json"))) - n = (Newtonsoft.Json.Linq.JObject)Newtonsoft.Json.JsonConvert.DeserializeObject(s.ReadToEnd()); - - MergeJsonObjects(o, n); - } - catch (Exception e) - { - Library.Logging.Log.WriteErrorMessage(LOGTAG, "BackupDefaultsError", e, "Failed to locate embeded backup defaults"); - } - - try - { - // Add install defaults/overrides, if present - var path = SystemIO.IO_OS.PathCombine(Library.AutoUpdater.UpdaterManager.INSTALLATIONDIR, "newbackup.json"); - if (System.IO.File.Exists(path)) - { - Newtonsoft.Json.Linq.JObject n; - n = (Newtonsoft.Json.Linq.JObject)Newtonsoft.Json.JsonConvert.DeserializeObject(System.IO.File.ReadAllText(path)); - - MergeJsonObjects(o, n); - } - } - catch (Exception e) - { - Library.Logging.Log.WriteErrorMessage(LOGTAG, "BackupDefaultsError", e, "Failed to process newbackup.json"); - } - - info.OutputOK(new - { - success = true, - data = o - }); - } - - private static void MergeJsonObjects(Newtonsoft.Json.Linq.JObject self, Newtonsoft.Json.Linq.JObject other) - { - foreach(var p in other.Properties()) - { - var sp = self.Property(p.Name); - if (sp == null) - self.Add(p); - else - { - switch (p.Type) - { - // Primitives override - case Newtonsoft.Json.Linq.JTokenType.Boolean: - case Newtonsoft.Json.Linq.JTokenType.Bytes: - case Newtonsoft.Json.Linq.JTokenType.Comment: - case Newtonsoft.Json.Linq.JTokenType.Constructor: - case Newtonsoft.Json.Linq.JTokenType.Date: - case Newtonsoft.Json.Linq.JTokenType.Float: - case Newtonsoft.Json.Linq.JTokenType.Guid: - case Newtonsoft.Json.Linq.JTokenType.Integer: - case Newtonsoft.Json.Linq.JTokenType.String: - case Newtonsoft.Json.Linq.JTokenType.TimeSpan: - case Newtonsoft.Json.Linq.JTokenType.Uri: - case Newtonsoft.Json.Linq.JTokenType.None: - case Newtonsoft.Json.Linq.JTokenType.Null: - case Newtonsoft.Json.Linq.JTokenType.Undefined: - self.Replace(p); - break; - - // Arrays merge - case Newtonsoft.Json.Linq.JTokenType.Array: - if (sp.Type == Newtonsoft.Json.Linq.JTokenType.Array) - sp.Value = new Newtonsoft.Json.Linq.JArray(((Newtonsoft.Json.Linq.JArray)sp.Value).Union((Newtonsoft.Json.Linq.JArray)p.Value)); - else - { - var a = new Newtonsoft.Json.Linq.JArray(sp.Value); - sp.Value = new Newtonsoft.Json.Linq.JArray(a.Union((Newtonsoft.Json.Linq.JArray)p.Value)); - } - - break; - - // Objects merge - case Newtonsoft.Json.Linq.JTokenType.Object: - if (sp.Type == Newtonsoft.Json.Linq.JTokenType.Object) - MergeJsonObjects((Newtonsoft.Json.Linq.JObject)sp.Value, (Newtonsoft.Json.Linq.JObject)p.Value); - else - sp.Value = p.Value; - break; - - // Ignore other stuff - default: - break; - } - } - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Backups.cs b/Duplicati.Library.RestAPI/RESTMethods/Backups.cs deleted file mode 100644 index bae68fa57..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Backups.cs +++ /dev/null @@ -1,310 +0,0 @@ -// 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; -using System.Linq; -using System.Collections.Generic; -using Duplicati.Server.Serialization; -using System.IO; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Backups : IRESTMethodGET, IRESTMethodPOST, IRESTMethodDocumented - { - public class AddOrUpdateBackupData - { - public Boolean IsUnencryptedOrPassphraseStored { get; set;} - public Database.Schedule Schedule { get; set;} - public Database.Backup Backup { get; set;} - } - - public void GET(string key, RequestInfo info) - { - var schedules = FIXMEGlobal.DataConnection.Schedules; - var backups = FIXMEGlobal.DataConnection.Backups; - - var all = from n in backups - select new AddOrUpdateBackupData { - IsUnencryptedOrPassphraseStored = FIXMEGlobal.DataConnection.IsUnencryptedOrPassphraseStored(long.Parse(n.ID)), - Backup = (Database.Backup)n, - Schedule = - (from x in schedules - where x.Tags != null && x.Tags.Contains("ID=" + n.ID) - select (Database.Schedule)x).FirstOrDefault() - }; - - info.BodyWriter.OutputOK(all.ToArray()); - } - - private void ImportBackup(RequestInfo info) - { - var output_template = ""; - //output_template = ""; - try - { - var input = info.Request.Form; - var cmdline = Library.Utility.Utility.ParseBool(input["cmdline"].Value, false); - var import_metadata = Library.Utility.Utility.ParseBool(input["import_metadata"].Value, false); - var direct = Library.Utility.Utility.ParseBool(input["direct"].Value, false); - output_template = output_template.Replace("CBM", input["callback"].Value); - if (cmdline) - { - info.Response.ContentType = "text/html"; - info.BodyWriter.Write(output_template.Replace("MSG", "Import from commandline not yet implemented")); - } - else - { - var file = info.Request.Form.GetFile("config"); - if (file == null) - throw new Exception("No file uploaded"); - - Serializable.ImportExportStructure ipx = Backups.LoadConfiguration(file.Filename, import_metadata, () => input["passphrase"].Value); - if (direct) - { - lock (FIXMEGlobal.DataConnection.m_lock) - { - var basename = ipx.Backup.Name; - var c = 0; - while (c++ < 100 && FIXMEGlobal.DataConnection.Backups.Any(x => x.Name.Equals(ipx.Backup.Name, StringComparison.OrdinalIgnoreCase))) - ipx.Backup.Name = basename + " (" + c.ToString() + ")"; - - if (FIXMEGlobal.DataConnection.Backups.Any(x => x.Name.Equals(ipx.Backup.Name, StringComparison.OrdinalIgnoreCase))) - { - info.BodyWriter.SetOK(); - info.Response.ContentType = "text/html"; - info.BodyWriter.Write(output_template.Replace("MSG", "There already exists a backup with the name: " + basename.Replace("\'", "\\'"))); - } - - var err = FIXMEGlobal.DataConnection.ValidateBackup(ipx.Backup, ipx.Schedule); - if (!string.IsNullOrWhiteSpace(err)) - { - info.ReportClientError(err, System.Net.HttpStatusCode.BadRequest); - return; - } - - FIXMEGlobal.DataConnection.AddOrUpdateBackupAndSchedule(ipx.Backup, ipx.Schedule); - } - - info.Response.ContentType = "text/html"; - info.BodyWriter.Write(output_template.Replace("MSG", "OK")); - - } - else - { - using (var sw = new StringWriter()) - { - Serializer.SerializeJson(sw, ipx, true); - output_template = output_template.Replace("'JSO'", sw.ToString()); - } - info.BodyWriter.Write(output_template.Replace("MSG", "Import completed, but a browser issue prevents loading the contents. Try using the direct import method instead.")); - } - } - } - catch (Exception ex) - { - FIXMEGlobal.DataConnection.LogError("", "Failed to import backup", ex); - info.Response.ContentType = "text/html"; - info.BodyWriter.Write(output_template.Replace("MSG", ex.Message.Replace("\'", "\\'").Replace("\r", "\\r").Replace("\n", "\\n"))); - } - } - - public static Serializable.ImportExportStructure ImportBackup(string configurationFile, bool importMetadata, Func getPassword, Dictionary advancedOptions) - { - // This removes the ID and DBPath from the backup configuration. - Serializable.ImportExportStructure importedStructure = Backups.LoadConfiguration(configurationFile, importMetadata, getPassword); - - // This will create the Duplicati-server.sqlite database file if it doesn't exist. - using (Duplicati.Server.Database.Connection connection = FIXMEGlobal.GetDatabaseConnection(advancedOptions)) - { - if (connection.Backups.Any(x => x.Name.Equals(importedStructure.Backup.Name, StringComparison.OrdinalIgnoreCase))) - { - throw new InvalidOperationException($"A backup with the name {importedStructure.Backup.Name} already exists."); - } - - string error = connection.ValidateBackup(importedStructure.Backup, importedStructure.Schedule); - if (!string.IsNullOrWhiteSpace(error)) - { - throw new InvalidOperationException(error); - } - - // This creates a new ID and DBPath. - connection.AddOrUpdateBackupAndSchedule(importedStructure.Backup, importedStructure.Schedule); - } - - return importedStructure; - } - - private static Serializable.ImportExportStructure LoadConfiguration(string filename, bool importMetadata, Func getPassword) - { - Serializable.ImportExportStructure ipx; - - var buf = new byte[3]; - using (var fs = System.IO.File.OpenRead(filename)) - { - Duplicati.Library.Utility.Utility.ForceStreamRead(fs, buf, buf.Length); - - fs.Position = 0; - if (buf[0] == 'A' && buf[1] == 'E' && buf[2] == 'S') - { - using (var m = new Duplicati.Library.Encryption.AESEncryption(getPassword(), new Dictionary())) - { - using (var m2 = m.Decrypt(fs)) - { - using (var sr = new System.IO.StreamReader(m2)) - { - ipx = Serializer.Deserialize(sr); - } - } - } - } - else - { - using (var sr = new System.IO.StreamReader(fs)) - { - ipx = Serializer.Deserialize(sr); - } - } - } - - if (ipx.Backup == null) - { - throw new Exception("No backup found in document"); - } - - if (ipx.Backup.Metadata == null) - { - ipx.Backup.Metadata = new Dictionary(); - } - - if (!importMetadata) - { - ipx.Backup.Metadata.Clear(); - } - - ipx.Backup.ID = null; - ipx.Backup.DBPath = null; - - if (ipx.Schedule != null) - { - ipx.Schedule.ID = -1; - } - - return ipx; - } - - public void POST(string key, RequestInfo info) - { - if ("import".Equals(key, StringComparison.OrdinalIgnoreCase)) - { - ImportBackup(info); - return; - } - - AddOrUpdateBackupData data = null; - try - { - var str = info.Request.Form["data"].Value; - if (string.IsNullOrWhiteSpace(str)) { - str = System.Threading.Tasks.Task.Run(async () => - { - using (var sr = new System.IO.StreamReader(info.Request.Body, System.Text.Encoding.UTF8, true)) - - return await sr.ReadToEndAsync(); - }).GetAwaiter().GetResult(); - } - - data = Serializer.Deserialize(new StringReader(str)); - if (data.Backup == null) - { - info.ReportClientError("Data object had no backup entry", System.Net.HttpStatusCode.BadRequest); - return; - } - - data.Backup.ID = null; - - if (Duplicati.Library.Utility.Utility.ParseBool(info.Request.Form["temporary"].Value, false)) - { - using(var tf = new Duplicati.Library.Utility.TempFile()) - data.Backup.DBPath = tf; - - data.Backup.Filters = data.Backup.Filters ?? new Duplicati.Server.Serialization.Interface.IFilter[0]; - data.Backup.Settings = data.Backup.Settings ?? new Duplicati.Server.Serialization.Interface.ISetting[0]; - - FIXMEGlobal.DataConnection.RegisterTemporaryBackup(data.Backup); - - info.OutputOK(new { status = "OK", ID = data.Backup.ID }); - } - else - { - if (Library.Utility.Utility.ParseBool(info.Request.Form["existing_db"].Value, false)) - { - data.Backup.DBPath = Library.Main.DatabaseLocator.GetDatabasePath(data.Backup.TargetURL, null, false, false); - if (string.IsNullOrWhiteSpace(data.Backup.DBPath)) - throw new Exception("Unable to find remote db path?"); - } - - - lock(FIXMEGlobal.DataConnection.m_lock) - { - if (FIXMEGlobal.DataConnection.Backups.Any(x => x.Name.Equals(data.Backup.Name, StringComparison.OrdinalIgnoreCase))) - { - info.ReportClientError("There already exists a backup with the name: " + data.Backup.Name, System.Net.HttpStatusCode.Conflict); - return; - } - - var err = FIXMEGlobal.DataConnection.ValidateBackup(data.Backup, data.Schedule); - if (!string.IsNullOrWhiteSpace(err)) - { - info.ReportClientError(err, System.Net.HttpStatusCode.BadRequest); - return; - } - - FIXMEGlobal.DataConnection.AddOrUpdateBackupAndSchedule(data.Backup, data.Schedule); - } - - info.OutputOK(new { status = "OK", ID = data.Backup.ID }); - } - } - catch (Exception ex) - { - if (data == null) - info.ReportClientError(string.Format("Unable to parse backup or schedule object: {0}", ex.Message), System.Net.HttpStatusCode.BadRequest); - else - info.ReportClientError(string.Format("Unable to save schedule or backup object: {0}", ex.Message), System.Net.HttpStatusCode.InternalServerError); - } - } - - - public string Description { get { return "Return a list of current backups and their schedules"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(AddOrUpdateBackupData[])), - new KeyValuePair(HttpServer.Method.Post, typeof(AddOrUpdateBackupData)) - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/BugReport.cs b/Duplicati.Library.RestAPI/RESTMethods/BugReport.cs deleted file mode 100644 index 388a32aad..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/BugReport.cs +++ /dev/null @@ -1,62 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Linq; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class BugReport : IRESTMethodGET - { - public void GET(string key, RequestInfo info) - { - long id; - long.TryParse(key, out id); - - var tf = FIXMEGlobal.DataConnection.GetTempFiles().FirstOrDefault(x => x.ID == id); - if (tf == null) - { - info.ReportClientError("Invalid or missing bugreport id", System.Net.HttpStatusCode.NotFound); - return; - } - - if (!System.IO.File.Exists(tf.Path)) - { - info.ReportClientError("File is missing", System.Net.HttpStatusCode.NotFound); - return; - } - - var filename = "bugreport.zip"; - using(var fs = System.IO.File.OpenRead(tf.Path)) - { - info.Response.ContentLength = fs.Length; - info.Response.AddHeader("Content-Disposition", string.Format("attachment; filename={0}", filename)); - info.Response.ContentType = "application/octet-stream"; - - info.BodyWriter.SetOK(); - info.Response.SendHeaders(); - fs.CopyTo(info.Response.Body); - info.Response.Send(); - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Captcha.cs b/Duplicati.Library.RestAPI/RESTMethods/Captcha.cs deleted file mode 100644 index 93345c8f8..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Captcha.cs +++ /dev/null @@ -1,172 +0,0 @@ -// 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; -using System.Linq; -using System.Collections.Generic; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Captcha : IRESTMethodGET, IRESTMethodPOST - { - private class CaptchaEntry - { - public readonly string Answer; - public readonly string Target; - public int Attempts; - public readonly DateTime Expires; - - public CaptchaEntry(string answer, string target) - { - Answer = answer; - Target = target; - Attempts = 4; - Expires = DateTime.Now.AddMinutes(2); - } - } - - private static readonly object m_lock = new object(); - private static readonly Dictionary m_captchas = new Dictionary(); - - public static bool SolvedCaptcha(string token, string target, string answer) - { - lock(m_lock) - { - CaptchaEntry tp; - m_captchas.TryGetValue(token ?? string.Empty, out tp); - if (tp == null) - return false; - - if (tp.Attempts > 0) - tp.Attempts--; - - return tp.Attempts >= 0 && string.Equals(tp.Answer, answer, StringComparison.OrdinalIgnoreCase) && tp.Target == target && tp.Expires >= DateTime.Now; - } - } - - public void GET(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - info.ReportClientError("Missing token value", System.Net.HttpStatusCode.Unauthorized); - return; - } - else - { - string answer = null; - lock (m_lock) - { - CaptchaEntry tp; - m_captchas.TryGetValue(key, out tp); - if (tp != null && tp.Expires > DateTime.Now) - answer = tp.Answer; - } - - if (string.IsNullOrWhiteSpace(answer)) - { - info.ReportClientError("No such entry", System.Net.HttpStatusCode.NotFound); - return; - } - - using (var bmp = CaptchaUtil.CreateCaptcha(answer)) - using (var ms = new System.IO.MemoryStream()) - { - info.Response.ContentType = "image/jpeg"; - info.Response.ContentLength = ms.Length; - bmp.Save(ms, System.Drawing.Imaging.ImageFormat.Jpeg); - ms.Position = 0; - - info.Response.ContentType = "image/jpeg"; - info.Response.ContentLength = ms.Length; - info.Response.SendHeaders(); - ms.CopyTo(info.Response.Body); - info.Response.Send(); - } - } - } - - public void POST(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - var target = info.Request.Param["target"].Value; - if (string.IsNullOrWhiteSpace(target)) - { - info.ReportClientError("Missing target parameter", System.Net.HttpStatusCode.BadRequest); - return; - } - - var answer = CaptchaUtil.CreateRandomAnswer(minlength: 6, maxlength: 6); - var nonce = Guid.NewGuid().ToString(); - - string token; - using (var ms = new System.IO.MemoryStream()) - { - var bytes = System.Text.Encoding.UTF8.GetBytes(answer + nonce); - ms.Write(bytes, 0, bytes.Length); - ms.Position = 0; - using(var hasher = Library.Utility.HashFactory.CreateHasher(Library.Utility.HashFactory.SHA256)){ - token = Library.Utility.Utility.Base64PlainToBase64Url(Convert.ToBase64String(hasher.ComputeHash(ms))); - } - } - - lock (m_lock) - { - var expired = m_captchas.Where(x => x.Value.Expires < DateTime.Now).Select(x => x.Key).ToArray(); - foreach (var x in expired) - m_captchas.Remove(x); - - if (m_captchas.Count > 3) - { - info.ReportClientError("Too many captchas, wait 2 minutes and try again", System.Net.HttpStatusCode.ServiceUnavailable); - return; - } - - m_captchas[token] = new CaptchaEntry(answer, target); - } - - info.OutputOK(new - { - token = token - }); - } - else - { - var answer = info.Request.Param["answer"].Value; - var target = info.Request.Param["target"].Value; - if (string.IsNullOrWhiteSpace(answer)) - { - info.ReportClientError("Missing answer parameter", System.Net.HttpStatusCode.BadRequest); - return; - } - if (string.IsNullOrWhiteSpace(target)) - { - info.ReportClientError("Missing target parameter", System.Net.HttpStatusCode.BadRequest); - return; - } - - if (SolvedCaptcha(key, target, answer)) - info.OutputOK(); - else - info.ReportClientError("Incorrect", System.Net.HttpStatusCode.Forbidden); - } - } - } -} diff --git a/Duplicati.Library.RestAPI/RESTMethods/Changelog.cs b/Duplicati.Library.RestAPI/RESTMethods/Changelog.cs deleted file mode 100644 index 7a9712562..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Changelog.cs +++ /dev/null @@ -1,79 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Changelog : IRESTMethodGET, IRESTMethodDocumented - { - private class GetResponse - { - public string Status; - public string Version; - public string Changelog; - } - - public void GET(string key, RequestInfo info) - { - var fromUpdate = info.Request.QueryString["from-update"].Value; - if (!Library.Utility.Utility.ParseBool(fromUpdate, false)) - { - var path = System.IO.Path.Combine(System.IO.Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location), "changelog.txt"); - info.OutputOK(new GetResponse() { - Status = "OK", - Version = System.Reflection.Assembly.GetExecutingAssembly().GetName().Version.ToString(), - Changelog = System.IO.File.ReadAllText(path) - }); - } - else - { - var updateInfo = FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion; - if (updateInfo == null) - { - info.ReportClientError("No update found", System.Net.HttpStatusCode.NotFound); - } - else - { - info.OutputOK(new GetResponse() { - Status = "OK", - Version = updateInfo.Version, - Changelog = updateInfo.ChangeInfo - }); - } - } - } - - public string Description { get { return "Gets the current changelog"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(GetResponse)), - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/CommandLine.cs b/Duplicati.Library.RestAPI/RESTMethods/CommandLine.cs deleted file mode 100644 index e4ff87db9..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/CommandLine.cs +++ /dev/null @@ -1,293 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Text; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class CommandLine : IRESTMethodGET, IRESTMethodPOST - { - private static readonly string LOGTAG = Library.Logging.Log.LogTagFromType(); - - private class LogWriter : System.IO.TextWriter - { - private readonly ActiveRun m_target; - private readonly StringBuilder m_sb = new StringBuilder(); - private int m_newlinechars = 0; - - public LogWriter(ActiveRun target) - { - m_target = target; - } - - public override Encoding Encoding { get { return System.Text.Encoding.UTF8; } } - - public override void Write(char value) - { - lock(m_target.Lock) - { - m_sb.Append(value); - if (NewLine[m_newlinechars] == value) - { - m_newlinechars++; - if (m_newlinechars == NewLine.Length) - WriteLine(string.Empty); - } - else - m_newlinechars = 0; - } - } - - public override void WriteLine(string value) - { - value = value ?? string.Empty; - lock(m_target.Lock) - { - m_target.LastAccess = DateTime.Now; - - //Avoid writing the log if it does not exist - if (m_target.IsLogDisposed) - { - FIXMEGlobal.LogHandler.WriteMessage(new Library.Logging.LogEntry("Attempted to write message after closing: {0}", new object[] { value }, Library.Logging.LogMessageType.Warning, LOGTAG, "CommandLineOutputAfterLogClosed", null)); - return; - } - - try - { - if (m_sb.Length != 0) - { - m_target.Log.Add(m_sb + value); - m_sb.Length = 0; - m_newlinechars = 0; - } - else - { - m_target.Log.Add(value); - } - } - catch (Exception ex) - { - // This can happen on a very unlucky race where IsLogDisposed is set right after the check - FIXMEGlobal.LogHandler.WriteMessage(new Library.Logging.LogEntry("Failed to forward commandline message: {0}", new object[] { value }, Library.Logging.LogMessageType.Warning, LOGTAG, "CommandLineOutputAfterLogClosed", ex)); - } - } - } - } - - private class ActiveRun - { - public readonly string ID = Guid.NewGuid().ToString(); - public DateTime LastAccess = DateTime.Now; - public readonly Library.Utility.FileBackedStringList Log = new Library.Utility.FileBackedStringList(); - public Runner.IRunnerData Task; - public LogWriter Writer; - public readonly object Lock = new object(); - public bool Finished = false; - public bool Started = false; - public bool IsLogDisposed = false; - public System.Threading.Thread Thread; - } - - private readonly Dictionary m_activeItems = new Dictionary(); - private System.Threading.Tasks.Task m_cleanupTask; - - public void POST(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - string[] args; - var str = System.Threading.Tasks.Task.Run(async () => - { - using (var sr = new System.IO.StreamReader(info.Request.Body, System.Text.Encoding.UTF8, true)) - - return await sr.ReadToEndAsync(); - }).GetAwaiter().GetResult(); - args = Newtonsoft.Json.JsonConvert.DeserializeObject(str); - - var k = new ActiveRun(); - k.Writer = new LogWriter(k); - - m_activeItems[k.ID] = k; - StartCleanupTask(); - - k.Task = Runner.CreateCustomTask((sink) => - { - try - { - k.Thread = System.Threading.Thread.CurrentThread; - k.Started = true; - - var code = Duplicati.CommandLine.Program.RunCommandLine(k.Writer, k.Writer, c => { - k.Task.SetController(c); - c.AppendSink(sink); - }, args); - k.Writer.WriteLine("Return code: {0}", code); - } - catch (Exception ex) - { - var rx = ex; - if (rx is System.Reflection.TargetInvocationException) - rx = rx.InnerException; - - if (rx is Library.Interface.UserInformationException) - k.Log.Add(rx.Message); - else - k.Log.Add(rx.ToString()); - - throw rx; - } - finally - { - k.Finished = true; - k.Thread = null; - } - }); - - FIXMEGlobal.WorkThread.AddTask(k.Task); - - info.OutputOK(new - { - ID = k.ID - }); - } - else - { - if (!key.EndsWith("/abort", StringComparison.OrdinalIgnoreCase)) - { - info.ReportClientError("Only abort commands are allowed", System.Net.HttpStatusCode.BadRequest); - return; - } - - key = key.Substring(0, key.Length - "/abort".Length); - if (string.IsNullOrWhiteSpace(key)) - { - info.ReportClientError("No task key found", System.Net.HttpStatusCode.BadRequest); - return; - } - - ActiveRun t; - if (!m_activeItems.TryGetValue(key, out t)) - { - info.OutputError(code: System.Net.HttpStatusCode.NotFound); - return; - } - - var tt = t.Task; - if (tt != null) - tt.Abort(); - - var tr = t.Thread; - if (tr != null) - tr.Interrupt(); - - info.OutputOK(); - } - } - - private void StartCleanupTask() - { - if (m_cleanupTask == null || m_cleanupTask.IsCompleted || m_cleanupTask.IsFaulted || m_cleanupTask.IsCanceled) - m_cleanupTask = RunCleanupAsync(); - } - - private async System.Threading.Tasks.Task RunCleanupAsync() - { - while (m_activeItems.Count > 0) - { - var oldest = m_activeItems.Values - .OrderBy(x => x.LastAccess) - .FirstOrDefault(); - - if (oldest != null) - { - // If the task has finished, we just wait a little to allow the UI to pick it up - var timeout = oldest.Finished ? TimeSpan.FromMinutes(5) : TimeSpan.FromDays(1); - if (DateTime.Now - oldest.LastAccess > timeout) - { - oldest.IsLogDisposed = true; - m_activeItems.Remove(oldest.ID); - oldest.Log.Dispose(); - - // Fix all expired, or stop running - continue; - } - } - - await System.Threading.Tasks.Task.Delay(TimeSpan.FromMinutes(1)).ConfigureAwait(false); - } - } - - public void GET(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - info.OutputOK( - Duplicati.CommandLine.Program.SupportedCommands - ); - } - else - { - ActiveRun t; - if (!m_activeItems.TryGetValue(key, out t)) - { - info.OutputError(code: System.Net.HttpStatusCode.NotFound); - return; - } - - int pagesize; - int offset; - - int.TryParse(info.Request.QueryString["pagesize"].Value, out pagesize); - int.TryParse(info.Request.QueryString["offset"].Value, out offset); - pagesize = Math.Max(10, Math.Min(500, pagesize)); - offset = Math.Max(0, offset); - var items = new List(); - long count; - bool started; - bool finished; - - lock(t.Lock) - { - t.LastAccess = DateTime.Now; - count = t.Log.Count; - offset = Math.Min((int)count, offset); - items.AddRange(t.Log.Skip(offset).Take(pagesize)); - finished = t.Finished; - started = t.Started; - } - - info.OutputOK(new - { - Pagesize = pagesize, - Offset = offset, - Count = count, - Items = items, - Finished = finished, - Started = started - }); - } - } - } -} diff --git a/Duplicati.Library.RestAPI/RESTMethods/Filesystem.cs b/Duplicati.Library.RestAPI/RESTMethods/Filesystem.cs deleted file mode 100644 index cc77df60e..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Filesystem.cs +++ /dev/null @@ -1,277 +0,0 @@ -// 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; -using System.Collections.Generic; -using System.Linq; -using System.IO; -using Duplicati.Library.Snapshots; -using Duplicati.Library.Common.IO; -using Duplicati.Library.Common; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Filesystem : IRESTMethodGET, IRESTMethodPOST, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - var parts = (key ?? "").Split(new char[] { '/' }); - var path = Duplicati.Library.Utility.Uri.UrlDecode((parts.Length == 2 ? parts.FirstOrDefault() : key ?? "")); - var command = parts.Length == 2 ? parts.Last() : null; - if (string.IsNullOrEmpty(path)) - path = info.Request.QueryString["path"].Value; - - Process(command, path, info); - } - - private void Process(string command, string path, RequestInfo info) - { - if (string.IsNullOrEmpty(path)) - { - info.ReportClientError("No path parameter was found", System.Net.HttpStatusCode.BadRequest); - return; - } - - bool skipFiles = Library.Utility.Utility.ParseBool(info.Request.QueryString["onlyfolders"].Value, false); - bool showHidden = Library.Utility.Utility.ParseBool(info.Request.QueryString["showhidden"].Value, false); - - string specialpath = null; - string specialtoken = null; - - if (path.StartsWith("%", StringComparison.Ordinal)) - { - var ix = path.IndexOf("%", 1, StringComparison.Ordinal); - if (ix > 0) - { - var tk = path.Substring(0, ix + 1); - var node = SpecialFolders.Nodes.FirstOrDefault(x => x.id.Equals(tk, StringComparison.OrdinalIgnoreCase)); - if (node != null) - { - specialpath = node.resolvedpath; - specialtoken = node.id; - } - } - } - - path = SpecialFolders.ExpandEnvironmentVariables(path); - - if (Platform.IsClientPosix && !path.StartsWith("/", StringComparison.Ordinal)) - { - info.ReportClientError("The path parameter must start with a forward-slash", System.Net.HttpStatusCode.BadRequest); - return; - } - - if (!string.IsNullOrWhiteSpace(command)) - { - if ("validate".Equals(command, StringComparison.OrdinalIgnoreCase)) - { - try - { - if (System.IO.Path.IsPathRooted(path) && (System.IO.Directory.Exists(path) || System.IO.File.Exists(path))) - { - info.OutputOK(); - return; - } - } - catch - { - } - - info.ReportServerError("File or folder not found", System.Net.HttpStatusCode.NotFound); - return; - } - else - { - info.ReportClientError(string.Format("No such operation found: {0}", command), System.Net.HttpStatusCode.NotFound); - return; - } - } - - try - { - if (path != "" && path != "/") - path = Util.AppendDirSeparator(path); - - IEnumerable res; - - if (!Platform.IsClientPosix && (path.Equals("/") || path.Equals(""))) - { - res = DriveInfo.GetDrives() - .Where(di => - (di.DriveType == DriveType.Fixed || di.DriveType == DriveType.Network || di.DriveType == DriveType.Removable) - && di.IsReady // Only try to create TreeNode entries for drives who were ready 'now' - ) - .Select(TryCreateTreeNodeForDrive) // This will try to create a TreeNode for selected drives - .Where(tn => tn != null); // This filters out such entries that could not be created - } - else - { - res = ListFolderAsNodes(path, skipFiles, showHidden); - } - - if ((path.Equals("/") || path.Equals("")) && specialtoken == null) - { - // Prepend special folders - res = SpecialFolders.Nodes.Union(res); - } - - if (specialtoken != null) - { - res = res.Select(x => { - x.resolvedpath = x.id; - x.id = specialtoken + x.id.Substring(specialpath.Length); - return x; - }); - } - - // We have to resolve the query before giving it to OutputOK - // If we do not do this, and the query throws an exception when OutputOK resolves it, - // the exception would not be handled properly - res = res.ToList(); - - info.OutputOK(res); - } - catch (Exception ex) - { - info.ReportClientError("Failed to process the path: " + ex.Message, System.Net.HttpStatusCode.InternalServerError); - } - } - - /// - /// Try to create a new TreeNode instance for the given DriveInfo instance. - /// - /// - /// If an exception occurs during creation (most likely the device became unavailable), a null is returned instead. - /// - /// - /// DriveInfo to try create a TreeNode for. Cannot be null. - /// A new TreeNode instance on success; null if an exception occurred during creation. - private static Serializable.TreeNode TryCreateTreeNodeForDrive(DriveInfo driveInfo) - { - if (driveInfo == null) throw new ArgumentNullException(nameof(driveInfo)); - - try - { - // Try to create the TreeNode - // This may still fail as the drive might become unavailable in the meanwhile - return new Serializable.TreeNode - { - id = driveInfo.RootDirectory.FullName, - text = - ( - string.IsNullOrWhiteSpace(driveInfo.VolumeLabel) - ? driveInfo.RootDirectory.FullName.Replace('\\', ' ') - : driveInfo.VolumeLabel + " - " + driveInfo.RootDirectory.FullName.Replace('\\', ' ') - ) + "(" + driveInfo.DriveType + ")", - iconCls = "x-tree-icon-drive" - }; - } - catch - { - // Drive became unavailable in the meanwhile or another exception occurred - // Return a null as fall back - return null; - } - } - - private static IEnumerable ListFolderAsNodes(string entrypath, bool skipFiles, bool showHidden) - { - //Helper function for finding out if a folder has sub elements - Func hasSubElements = (p) => skipFiles ? Directory.EnumerateDirectories(p).Any() : Directory.EnumerateFileSystemEntries(p).Any(); - - //Helper function for dealing with exceptions when accessing off-limits folders - Func isEmptyFolder = (p) => - { - try { return !hasSubElements(p); } - catch { } - return true; - }; - - //Helper function for dealing with exceptions when accessing off-limits folders - Func canAccess = (p) => - { - try { hasSubElements(p); return true; } - catch { } - return false; - }; - - foreach (var s in SystemIO.IO_OS.EnumerateFileSystemEntries(entrypath) - // Group directories first - .OrderByDescending(f => SystemIO.IO_OS.GetFileAttributes(f) & FileAttributes.Directory) - // Sort both groups (directories and files) alphabetically - .ThenBy(f => f)) - { - Serializable.TreeNode tn = null; - try - { - var attr = SystemIO.IO_OS.GetFileAttributes(s); - var isSymlink = SystemIO.IO_OS.IsSymlink(s, attr); - var isFolder = (attr & FileAttributes.Directory) != 0; - var isFile = !isFolder; - var isHidden = (attr & FileAttributes.Hidden) != 0; - - var accessible = isFile || canAccess(s); - var isLeaf = isFile || !accessible || isEmptyFolder(s); - - var rawid = isFolder ? Util.AppendDirSeparator(s) : s; - if (skipFiles && !isFolder) - continue; - - if (!showHidden && isHidden) - continue; - - tn = new Serializable.TreeNode() - { - id = rawid, - text = SystemIO.IO_OS.PathGetFileName(s), - hidden = isHidden, - symlink = isSymlink, - iconCls = isFolder ? (accessible ? (isSymlink ? "x-tree-icon-symlink" : "x-tree-icon-parent") : "x-tree-icon-locked") : "x-tree-icon-leaf", - leaf = isLeaf - }; - } - catch - { - } - - if (tn != null) - yield return tn; - } - } - - public void POST(string key, RequestInfo info) - { - Process(key, info.Request.Form["path"].Value, info); - } - - public string Description { get { return "Enumerates the server filesystem"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(string[])), - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Help.cs b/Duplicati.Library.RestAPI/RESTMethods/Help.cs deleted file mode 100644 index b409b7f77..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Help.cs +++ /dev/null @@ -1,104 +0,0 @@ -// 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; -using System.Linq; -using System.Text; -using Newtonsoft.Json; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Help : IRESTMethodGET - { - public void GET(string key, RequestInfo info) - { - var sb = new StringBuilder(); - if (string.IsNullOrWhiteSpace(key)) - { - foreach(var m in RESTHandler.Modules.Keys.OrderBy(x => x)) - { - var mod = RESTHandler.Modules[m]; - if (mod == this) - continue; - - var desc = mod.GetType().Name; - if (mod is IRESTMethodDocumented documented) - desc = documented.Description; - sb.AppendFormat(ITEM_TEMPLATE, RESTHandler.API_URI_PATH, m, mod.GetType().Name, desc); - } - - - var data = Encoding.UTF8.GetBytes(string.Format(TEMPLATE, "API Information", "", sb)); - - info.Response.ContentType = "text/html"; - info.Response.ContentLength = data.Length; - info.Response.Body.Write(data, 0, data.Length); - info.Response.Send(); - } - else - { - IRESTMethod m; - RESTHandler.Modules.TryGetValue(key, out m); - if (m == null) - { - info.Response.Status = System.Net.HttpStatusCode.NotFound; - info.Response.Reason = "Module not found"; - } - else - { - var desc = ""; - if (m is IRESTMethodDocumented doc) - { - desc = doc.Description; - foreach(var t in doc.Types) - sb.AppendFormat(METHOD_TEMPLATE, t.Key, JsonConvert.SerializeObject(t.Value)); //TODO: Format the type - } - - var data = Encoding.UTF8.GetBytes(string.Format(TEMPLATE, m.GetType().Name, desc, sb)); - - info.Response.ContentType = "text/html"; - info.Response.ContentLength = data.Length; - info.Response.Body.Write(data, 0, data.Length); - info.Response.Send(); - - } - } - } - - private const string TEMPLATE = @" -{0} - -

{0}

-

{1}

-
    -{2} -
- -"; - private const string ITEM_TEMPLATE = @" -
  • {2}: {3}
    • -"; - - private const string METHOD_TEMPLATE = @" -{0}:
    {1}
    -"; - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/HyperV.cs b/Duplicati.Library.RestAPI/RESTMethods/HyperV.cs deleted file mode 100644 index b957cfd48..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/HyperV.cs +++ /dev/null @@ -1,93 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Library.Interface; -using System.Linq; -using System.Security.Principal; -using Duplicati.Library.Snapshots; -using Duplicati.Library.Common; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class HyperV : IRESTMethodGET, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - // Early exit in case we are non-windows to prevent attempting to load Windows-only components - if (Platform.IsClientWindows) - RealGET(key, info); - else - info.OutputOK(new string[0]); - } - - // Make sure the JIT does not attempt to inline this call and thus load - // referenced types from System.Management here - [System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.NoInlining)] - private void RealGET(string key, RequestInfo info) - { - var hypervUtility = new HyperVUtility(); - - if (!hypervUtility.IsHyperVInstalled || !new WindowsPrincipal(WindowsIdentity.GetCurrent()).IsInRole(WindowsBuiltInRole.Administrator)) - { - info.OutputOK(new string[0]); - return; - } - - try - { - if (string.IsNullOrEmpty(key)) - { - hypervUtility.QueryHyperVGuestsInfo(); - info.OutputOK(hypervUtility.Guests.Select(x => new { id = x.ID, name = x.Name }).ToList()); - } - else - { - hypervUtility.QueryHyperVGuestsInfo(true); - var foundVMs = hypervUtility.Guests.FindAll(x => x.ID.Equals(new Guid(key))); - - if (foundVMs.Count == 1) - info.OutputOK(foundVMs[0].DataPaths.Select(x => new { text = x, id = x, cls = "folder", iconCls = "x-tree-icon-leaf", check = "false", leaf = "true" }).ToList()); - else - info.ReportClientError(string.Format("Cannot find VM with ID {0}.", key), System.Net.HttpStatusCode.NotFound); - } - } - catch (Exception ex) - { - info.ReportServerError("Failed to enumerate Hyper-V virtual machines: " + ex.Message); - } - } - - public string Description { get { return "Return a list of Hyper-V virtual machines"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(ICommandLineArgument[])) - }; - } - } - - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/IRESTMethod.cs b/Duplicati.Library.RestAPI/RESTMethods/IRESTMethod.cs deleted file mode 100644 index 488f4ce1d..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/IRESTMethod.cs +++ /dev/null @@ -1,60 +0,0 @@ -// 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; -using System.Collections.Generic; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public interface IRESTMethod - { - } - - public interface IRESTMethodDocumented - { - string Description { get; } - IEnumerable> Types { get; } - } - - public interface IRESTMethodGET : IRESTMethod - { - void GET(string key, RequestInfo info); - } - public interface IRESTMethodPUT : IRESTMethod - { - void PUT(string key, RequestInfo info); - } - - public interface IRESTMethodPOST : IRESTMethod - { - void POST(string key, RequestInfo info); - } - - public interface IRESTMethodDELETE : IRESTMethod - { - void DELETE(string key, RequestInfo info); - } - - public interface IRESTMethodPATCH : IRESTMethod - { - void PATCH(string key, RequestInfo info); - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Licenses.cs b/Duplicati.Library.RestAPI/RESTMethods/Licenses.cs deleted file mode 100644 index 39bd5d754..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Licenses.cs +++ /dev/null @@ -1,44 +0,0 @@ -// 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; -using System.IO; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Licenses : IRESTMethodGET - { - public void GET(string key, RequestInfo info) - { - var exefolder = System.IO.Path.GetDirectoryName(Duplicati.Library.Utility.Utility.getEntryAssembly().Location); - var path = System.IO.Path.Combine(exefolder, "licenses"); - if (Duplicati.Library.Common.Platform.IsClientOSX && !Directory.Exists(path)) - { - // Go up one, as the licenses cannot be in the binary folder in MacOS Packages - exefolder = Path.GetDirectoryName(exefolder); - var test = Path.Combine(exefolder, "Licenses"); - if (Directory.Exists(test)) - path = test; - } - info.OutputOK(Duplicati.License.LicenseReader.ReadLicenses(path)); - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/LogData.cs b/Duplicati.Library.RestAPI/RESTMethods/LogData.cs deleted file mode 100644 index 1b78b4898..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/LogData.cs +++ /dev/null @@ -1,122 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class LogData : IRESTMethodGET, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - if ("poll".Equals(key, StringComparison.OrdinalIgnoreCase)) - { - var input = info.Request.QueryString; - var level_str = input["level"].Value ?? ""; - var id_str = input["id"].Value ?? ""; - - int pagesize; - if (!int.TryParse(info.Request.QueryString["pagesize"].Value, out pagesize)) - pagesize = 100; - - pagesize = Math.Max(1, Math.Min(500, pagesize)); - - Library.Logging.LogMessageType level; - long id; - - long.TryParse(id_str, out id); - Enum.TryParse(level_str, true, out level); - - info.OutputOK(FIXMEGlobal.LogHandler.AfterID(id, level, pagesize)); - } - else - { - - List> res = null; - FIXMEGlobal.DataConnection.ExecuteWithCommand(x => - { - res = DumpTable(x, "ErrorLog", "Timestamp", info.Request.QueryString["offset"].Value, info.Request.QueryString["pagesize"].Value); - }); - - info.OutputOK(res); - } - } - - - public static List> DumpTable(System.Data.IDbCommand cmd, string tablename, string pagingfield, string offset_str, string pagesize_str) - { - var result = new List>(); - - long pagesize; - if (!long.TryParse(pagesize_str, out pagesize)) - pagesize = 100; - - pagesize = Math.Max(10, Math.Min(500, pagesize)); - - cmd.CommandText = "SELECT * FROM \"" + tablename + "\""; - long offset = 0; - if (!string.IsNullOrWhiteSpace(offset_str) && long.TryParse(offset_str, out offset) && !string.IsNullOrEmpty(pagingfield)) - { - var p = cmd.CreateParameter(); - p.Value = offset; - cmd.Parameters.Add(p); - - cmd.CommandText += " WHERE \"" + pagingfield + "\" < ?"; - } - - if (!string.IsNullOrEmpty(pagingfield)) - cmd.CommandText += " ORDER BY \"" + pagingfield + "\" DESC"; - cmd.CommandText += " LIMIT " + pagesize.ToString(); - - using(var rd = cmd.ExecuteReader()) - { - var names = new List(); - for(var i = 0; i < rd.FieldCount; i++) - names.Add(rd.GetName(i)); - - while (rd.Read()) - { - var dict = new Dictionary(); - for(int i = 0; i < names.Count; i++) - dict[names[i]] = rd.GetValue(i); - - result.Add(dict); - } - } - - return result; - } - - public string Description { get { return "Retrieves system log data"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(Dictionary[])), - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/MSSQL.cs b/Duplicati.Library.RestAPI/RESTMethods/MSSQL.cs deleted file mode 100644 index be873efdb..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/MSSQL.cs +++ /dev/null @@ -1,91 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Library.Interface; -using System.Linq; -using System.Security.Principal; -using Duplicati.Library.Snapshots; -using Duplicati.Library.Common; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class MSSQL : IRESTMethodGET, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - // Early exit in case we are non-windows to prevent attempting to load Windows-only components - if (Platform.IsClientWindows) - RealGET(key, info); - else - info.OutputOK(new string[0]); - } - - // Make sure the JIT does not attempt to inline this call and thus load - // referenced types from System.Management here - [System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.NoInlining)] - private void RealGET(string key, RequestInfo info) - { - var mssqlUtility = new MSSQLUtility(); - - if (!mssqlUtility.IsMSSQLInstalled || !new WindowsPrincipal(WindowsIdentity.GetCurrent()).IsInRole(WindowsBuiltInRole.Administrator)) - { - info.OutputOK(new string[0]); - return; - } - - try - { - mssqlUtility.QueryDBsInfo(); - - if (string.IsNullOrEmpty(key)) - info.OutputOK(mssqlUtility.DBs.Select(x => new { id = x.ID, name = x.Name }).ToList()); - else - { - var foundDBs = mssqlUtility.DBs.FindAll(x => x.ID.Equals(key, StringComparison.OrdinalIgnoreCase)); - - if (foundDBs.Count == 1) - info.OutputOK(foundDBs[0].DataPaths.Select(x => new { text = x, id = x, cls = "folder", iconCls = "x-tree-icon-leaf", check = "false", leaf = "true" }).ToList()); - else - info.ReportClientError(string.Format("Cannot find DB with ID {0}.", key), System.Net.HttpStatusCode.NotFound); - } - } - catch (Exception ex) - { - info.ReportServerError("Failed to enumerate Microsoft SQL Server databases: " + ex.Message); - } - } - - public string Description { get { return "Return a list of Microsoft SQL Server databases"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(ICommandLineArgument[])) - }; - } - } - - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Notification.cs b/Duplicati.Library.RestAPI/RESTMethods/Notification.cs deleted file mode 100644 index 24199cf0b..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Notification.cs +++ /dev/null @@ -1,65 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Linq; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Notification : IRESTMethodGET, IRESTMethodDELETE - { - public void GET(string key, RequestInfo info) - { - long id; - if (!long.TryParse(key, out id)) - { - info.ReportClientError("Invalid ID", System.Net.HttpStatusCode.BadRequest); - return; - } - - var el = FIXMEGlobal.DataConnection.GetNotifications().FirstOrDefault(x => x.ID == id); - if (el == null) - info.ReportClientError("No such notification", System.Net.HttpStatusCode.NotFound); - else - info.OutputOK(el); - } - - public void DELETE(string key, RequestInfo info) - { - long id; - if (!long.TryParse(key, out id)) - { - info.ReportClientError("Invalid ID", System.Net.HttpStatusCode.BadRequest); - return; - } - - var el = FIXMEGlobal.DataConnection.GetNotifications().FirstOrDefault(x => x.ID == id); - if (el == null) - info.ReportClientError("No such notification", System.Net.HttpStatusCode.NotFound); - else - { - FIXMEGlobal.DataConnection.DismissNotification(id); - info.OutputOK(); - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Notifications.cs b/Duplicati.Library.RestAPI/RESTMethods/Notifications.cs deleted file mode 100644 index 3e4bb7b8b..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Notifications.cs +++ /dev/null @@ -1,34 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Notifications : IRESTMethodGET - { - public void GET(string key, RequestInfo info) - { - info.OutputOK(FIXMEGlobal.DataConnection.GetNotifications()); - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/ProgressState.cs b/Duplicati.Library.RestAPI/RESTMethods/ProgressState.cs deleted file mode 100644 index e85974dd4..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/ProgressState.cs +++ /dev/null @@ -1,50 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class ProgressState : IRESTMethodGET, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - if (FIXMEGlobal.GenerateProgressState == null) - info.ReportClientError("No active backup", System.Net.HttpStatusCode.NotFound); - else - info.OutputOK(FIXMEGlobal.GenerateProgressState()); - } - - public string Description { get { return "Return the progress of the currently running operation."; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(Serialization.Interface.IProgressEventData)) - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/RemoteOperation.cs b/Duplicati.Library.RestAPI/RESTMethods/RemoteOperation.cs deleted file mode 100644 index f9a8ded5e..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/RemoteOperation.cs +++ /dev/null @@ -1,254 +0,0 @@ -// 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; -using System.Collections.Generic; -using System.Linq; -using System.Threading; -using Duplicati.Library.Interface; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class RemoteOperation : IRESTMethodGET, IRESTMethodPOST - { - private void LocateDbUri(string uri, RequestInfo info) - { - var path = Library.Main.DatabaseLocator.GetDatabasePath(uri, null, false, false); - info.OutputOK(new { - Exists = !string.IsNullOrWhiteSpace(path), - Path = path - }); - } - - private Dictionary ParseUrlOptions(Library.Utility.Uri uri) - { - var qp = uri.QueryParameters; - - var opts = Runner.GetCommonOptions(); - foreach (var k in qp.Keys.Cast()) - opts[k] = qp[k]; - - return opts; - } - - private IEnumerable ConfigureModules(IDictionary opts) - { - // TODO: This works because the generic modules are implemented - // with pre .NetCore logic, using static methods - // The modules are created to allow multipe dispose, - // which violates the .Net patterns - var modules = (from n in Library.DynamicLoader.GenericLoader.Modules - where n is Library.Interface.IConnectionModule - select n).ToArray(); - - foreach (var n in modules) - n.Configure(opts); - - return modules; - } - - - private class TupleDisposeWrapper : IDisposable - { - public IBackend Backend { get; set; } - public IEnumerable Modules { get; set; } - - public void Dispose() - { - Backend.Dispose(); - DisposeModules(); - } - - public void DisposeModules() - { - foreach (var n in Modules) - if (n is IDisposable disposable) - disposable.Dispose(); - } - } - - private TupleDisposeWrapper GetBackend(string url) - { - var uri = new Library.Utility.Uri(url); - var opts = ParseUrlOptions(uri); - var modules = ConfigureModules(opts); - var backend = Duplicati.Library.DynamicLoader.BackendLoader.GetBackend(url, new Dictionary()); - return new TupleDisposeWrapper() { Backend = backend, Modules = modules }; - } - - private void CreateFolder(string uri, RequestInfo info) - { - using(var b = Duplicati.Library.DynamicLoader.BackendLoader.GetBackend(uri, new Dictionary())) - b.CreateFolder(); - - info.OutputOK(); - } - - private void UploadFile(string uri, RequestInfo info) - { - var data = info.Request.QueryString["data"].Value; - var remotename = info.Request.QueryString["filename"].Value; - - using(var ms = new System.IO.MemoryStream()) - using(var b = GetBackend(uri)) - { - using(var tf = new Library.Utility.TempFile()) - { - System.IO.File.WriteAllText(tf, data); - b.Backend.PutAsync(remotename, tf, CancellationToken.None).Wait(); - } - } - - info.OutputOK(); - } - - private void ListFolder(string uri, RequestInfo info) - { - using(var b = GetBackend(uri)) - info.OutputOK(b.Backend.List()); - } - - private void TestConnection(string url, RequestInfo info) - { - bool autoCreate = info.Request.Param.Contains("autocreate") - ? Library.Utility.Utility.ParseBool(info.Request.Param["autocreate"].Value, false) - : false; - - TupleDisposeWrapper wrapper = null; - - try - { - wrapper = GetBackend(url); - - using (var b = wrapper.Backend) - { - try { b.Test(); } - catch (FolderMissingException) - { - if (!autoCreate) - throw; - - b.CreateFolder(); - b.Test(); - } - info.OutputOK(); - } - } - catch (Duplicati.Library.Interface.FolderMissingException) - { - if (!autoCreate) { - info.ReportServerError("missing-folder"); - } else { - info.ReportServerError("error-creating-folder"); - } - } - catch (Duplicati.Library.Utility.SslCertificateValidator.InvalidCertificateException icex) - { - if (string.IsNullOrWhiteSpace(icex.Certificate)) - info.ReportServerError(icex.Message); - else - info.ReportServerError("incorrect-cert:" + icex.Certificate); - } - catch (Duplicati.Library.Utility.HostKeyException hex) - { - if (string.IsNullOrWhiteSpace(hex.ReportedHostKey)) - info.ReportServerError(hex.Message); - else - { - info.ReportServerError(string.Format( - @"incorrect-host-key:""{0}"", accepted-host-key:""{1}""", - hex.ReportedHostKey, - hex.AcceptedHostKey - )); - } - } - finally - { - if (wrapper != null) - wrapper.DisposeModules(); - } - } - - public void GET(string key, RequestInfo info) - { - var parts = (key ?? "").Split(new char[] { '/' }, 2); - - if (parts.Length <= 1) - { - info.ReportClientError("No url or operation supplied", System.Net.HttpStatusCode.BadRequest); - return; - } - - var url = Library.Utility.Uri.UrlDecode(parts.First()); - var operation = parts.Last().ToLowerInvariant(); - - switch (operation) - { - case "dbpath": - LocateDbUri(url, info); - return; - case "list": - ListFolder(url, info); - return; - case "create": - CreateFolder(url, info); - return; - case "test": - TestConnection(url, info); - return; - default: - info.ReportClientError("No such method", System.Net.HttpStatusCode.BadRequest); - return; - } - } - - public void POST(string key, RequestInfo info) - { - string url; - - using(var sr = new System.IO.StreamReader(info.Request.Body, System.Text.Encoding.UTF8, true)) - url = sr.ReadToEnd(); - - switch (key) - { - case "dbpath": - LocateDbUri(url, info); - return; - case "list": - ListFolder(url, info); - return; - case "create": - CreateFolder(url, info); - return; - case "put": - UploadFile(url, info); - return; - case "test": - TestConnection(url, info); - return; - default: - info.ReportClientError("No such method", System.Net.HttpStatusCode.BadRequest); - return; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/RequestInfo.cs b/Duplicati.Library.RestAPI/RESTMethods/RequestInfo.cs deleted file mode 100644 index 2069b6cf9..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/RequestInfo.cs +++ /dev/null @@ -1,117 +0,0 @@ -// 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; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class RequestInfo : IDisposable - { - public HttpServer.IHttpRequest Request { get; private set; } - public HttpServer.IHttpResponse Response { get; private set; } - public HttpServer.Sessions.IHttpSession Session { get; private set; } - public BodyWriter BodyWriter { get; private set; } - public RequestInfo(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - Request = request; - Response = response; - Session = session; - BodyWriter = new BodyWriter(response, request); - } - - public void ReportServerError(string message, System.Net.HttpStatusCode code = System.Net.HttpStatusCode.InternalServerError) - { - Response.Status = code; - Response.Reason = message; - - BodyWriter.WriteJsonObject(new { Error = message }); - } - - public void ReportClientError(string message, System.Net.HttpStatusCode code = System.Net.HttpStatusCode.BadRequest) - { - ReportServerError(message, code); - } - - public bool LongPollCheck(EventPollNotify poller, ref long id, out bool isError) - { - HttpServer.HttpInput input = String.Equals(Request.Method, "POST", StringComparison.OrdinalIgnoreCase) ? Request.Form : Request.QueryString; - if (Library.Utility.Utility.ParseBool(input["longpoll"].Value, false)) - { - long lastEventId; - if (!long.TryParse(input["lasteventid"].Value, out lastEventId)) - { - ReportClientError("When activating long poll, the request must include the last event id", System.Net.HttpStatusCode.BadRequest); - isError = true; - return false; - } - - TimeSpan ts; - try { ts = Library.Utility.Timeparser.ParseTimeSpan(input["duration"].Value); } - catch (Exception ex) - { - ReportClientError("Invalid duration: " + ex.Message, System.Net.HttpStatusCode.BadRequest); - isError = true; - return false; - } - - if (ts <= TimeSpan.FromSeconds(10) || ts.TotalMilliseconds > int.MaxValue) - { - ReportClientError("Invalid duration, must be at least 10 seconds, and less than " + int.MaxValue + " milliseconds", System.Net.HttpStatusCode.BadRequest); - isError = true; - return false; - } - - isError = false; - id = poller.Wait(lastEventId, (int)ts.TotalMilliseconds); - return true; - } - - isError = false; - return false; - } - - public void OutputOK(object item = null) - { - BodyWriter.OutputOK(item); - } - - public void OutputError(object item = null, System.Net.HttpStatusCode code = System.Net.HttpStatusCode.InternalServerError, string reason = null) - { - Response.Status = code; - Response.Reason = reason ?? "Error"; - if(item == null && reason != null) - { - item = new { Error = reason }; - } - BodyWriter.WriteJsonObject(item); - } - - public void Dispose() - { - if (BodyWriter != null) - { - var bw = BodyWriter; - BodyWriter = null; - bw.Dispose(); - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/ServerSetting.cs b/Duplicati.Library.RestAPI/RESTMethods/ServerSetting.cs deleted file mode 100644 index 418589837..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/ServerSetting.cs +++ /dev/null @@ -1,116 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; -using System.Linq; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class ServerSetting : IRESTMethodGET, IRESTMethodPUT, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - info.OutputError(null, System.Net.HttpStatusCode.BadRequest, "Key is missing"); - return; - } - - if (key.Equals("server-ssl-certificate", StringComparison.OrdinalIgnoreCase) || key.Equals("ServerSSLCertificate", StringComparison.OrdinalIgnoreCase)) - { - info.OutputOK(FIXMEGlobal.DataConnection.ApplicationSettings.ServerSSLCertificate == null ? "False" : "True"); - return; - } - - if (key.StartsWith("--", StringComparison.Ordinal)) - { - var prop = FIXMEGlobal.DataConnection.Settings.FirstOrDefault(x => string.Equals(key, x.Name, StringComparison.OrdinalIgnoreCase)); - info.OutputOK(prop == null ? null : prop.Value); - } - else - { - var prop = typeof(Database.ServerSettings).GetProperty(key); - if (prop == null) - info.OutputError(null, System.Net.HttpStatusCode.NotFound, "Not found"); - else - info.OutputOK(prop.GetValue(FIXMEGlobal.DataConnection.ApplicationSettings)); - } - } - - public void PUT(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - info.OutputError(null, System.Net.HttpStatusCode.BadRequest, "Key is missing"); - return; - } - - if (key.Equals("server-ssl-certificate", StringComparison.OrdinalIgnoreCase) || key.Equals("ServerSSLCertificate", StringComparison.OrdinalIgnoreCase)) - { - info.OutputError(null, System.Net.HttpStatusCode.BadRequest, "Can only update SSL certificate from commandline"); - return; - } - - if (key.StartsWith("--", StringComparison.Ordinal)) - { - var settings = FIXMEGlobal.DataConnection.Settings.ToList(); - - var prop = settings.FirstOrDefault(x => string.Equals(key, x.Name, StringComparison.OrdinalIgnoreCase)); - if (prop == null) - settings.Add(prop = new Database.Setting() { Name = key, Value = info.Request.Form["data"].Value }); - else - prop.Value = info.Request.Form["data"].Value; - - FIXMEGlobal.DataConnection.Settings = settings.ToArray(); - - info.OutputOK(prop == null ? null : prop.Value); - } - else - { - var prop = typeof(Database.ServerSettings).GetProperty(key); - if (prop == null) - info.OutputError(null, System.Net.HttpStatusCode.NotFound, "Not found"); - else - { - var dict = new Dictionary(); - dict[key] = info.Request.Form["data"].Value; - FIXMEGlobal.DataConnection.ApplicationSettings.UpdateSettings(dict, false); - info.OutputOK(); - } - } - } - - public string Description { get { return "Return a list of settings for the server"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(string)), - new KeyValuePair(HttpServer.Method.Put, typeof(string)) - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/ServerSettings.cs b/Duplicati.Library.RestAPI/RESTMethods/ServerSettings.cs deleted file mode 100644 index 77258f307..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/ServerSettings.cs +++ /dev/null @@ -1,136 +0,0 @@ -// 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; -using System.Linq; -using System.Collections.Generic; -using Duplicati.Server.Database; -using System.IO; -using Duplicati.Server.Serialization; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class ServerSettings : IRESTMethodGET, IRESTMethodPATCH, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - // Join server settings and global settings - var adv_props = - FIXMEGlobal.DataConnection.GetSettings(Database.Connection.SERVER_SETTINGS_ID) - .Where(x => !string.IsNullOrWhiteSpace(x.Name)) - .Union( - FIXMEGlobal.DataConnection.Settings - .Where(x => !string.IsNullOrWhiteSpace(x.Name) && x.Name.StartsWith("--", StringComparison.Ordinal)) - ); - - var dict = new Dictionary(); - foreach (var n in adv_props) - dict[n.Name] = n.Value; - - string sslcert; - dict.TryGetValue("server-ssl-certificate", out sslcert); - dict["server-ssl-certificate"] = (!string.IsNullOrWhiteSpace(sslcert)).ToString(); - - info.OutputOK(dict); - } - - public void PATCH(string key, RequestInfo info) - { - string str = info.Request.Form["data"].Value; - - if (string.IsNullOrWhiteSpace(str)) - str = System.Threading.Tasks.Task.Run(async () => - { - using (var sr = new System.IO.StreamReader(info.Request.Body, System.Text.Encoding.UTF8, true)) - - return await sr.ReadToEndAsync(); - }).GetAwaiter().GetResult(); - - if (string.IsNullOrWhiteSpace(str)) - { - info.ReportClientError("Missing data object", System.Net.HttpStatusCode.BadRequest); - return; - } - - Dictionary data = null; - try - { - data = Serializer.Deserialize>(new StringReader(str)); - if (data == null) - { - info.ReportClientError("Data object had no entry", System.Net.HttpStatusCode.BadRequest); - return; - } - - // Split into server settings and global settings - - var serversettings = data.Where(x => !string.IsNullOrWhiteSpace(x.Key)).ToDictionary(x => x.Key, x => x.Key.StartsWith("--", StringComparison.Ordinal) ? null : x.Value); - var globalsettings = data.Where(x => !string.IsNullOrWhiteSpace(x.Key) && x.Key.StartsWith("--", StringComparison.Ordinal)); - - serversettings.Remove("server-ssl-certificate"); - serversettings.Remove("ServerSSLCertificate"); - - if (serversettings.Any()) - FIXMEGlobal.DataConnection.ApplicationSettings.UpdateSettings(serversettings, false); - - if (globalsettings.Any()) - { - // Update based on inputs - var existing = FIXMEGlobal.DataConnection.Settings.ToDictionary(x => x.Name, x => x); - foreach (var g in globalsettings) - if (g.Value == null) - existing.Remove(g.Key); - else - { - if (existing.ContainsKey(g.Key)) - existing[g.Key].Value = g.Value; - else - existing[g.Key] = new Setting() { Name = g.Key, Value = g.Value }; - } - - FIXMEGlobal.DataConnection.Settings = existing.Select(x => x.Value).ToArray(); - } - - info.OutputOK(); - } - catch (Exception ex) - { - if (data == null) - info.ReportClientError(string.Format("Unable to parse data object: {0}", ex.Message), System.Net.HttpStatusCode.BadRequest); - else - info.ReportClientError(string.Format("Unable to save settings: {0}", ex.Message), System.Net.HttpStatusCode.InternalServerError); - } - } - - public string Description { get { return "Return a list of settings for the server"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(Database.ServerSettings)) - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/ServerState.cs b/Duplicati.Library.RestAPI/RESTMethods/ServerState.cs deleted file mode 100644 index bd1fa914a..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/ServerState.cs +++ /dev/null @@ -1,104 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class ServerState : IRESTMethodGET, IRESTMethodPOST, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - bool isError; - long id = 0; - long.TryParse(key, out id); - - if (info.LongPollCheck(FIXMEGlobal.StatusEventNotifyer, ref id, out isError)) - { - //Make sure we do not report a higher number than the eventnotifier says - var st = new Serializable.ServerStatus(); - st.LastEventID = id; - info.OutputOK(st); - } - else if (!isError) - { - info.OutputOK(new Serializable.ServerStatus()); - } - } - - public void POST(string key, RequestInfo info) - { - var input = info.Request.Form; - switch ((key ?? "").ToLowerInvariant()) - { - case "pause": - if (input.Contains("duration") && !string.IsNullOrWhiteSpace(input["duration"].Value)) - { - TimeSpan ts; - try - { - ts = Library.Utility.Timeparser.ParseTimeSpan(input["duration"].Value); - } - catch (Exception ex) - { - info.ReportClientError(ex.Message, System.Net.HttpStatusCode.BadRequest); - return; - } - if (ts.TotalMilliseconds > 0) - FIXMEGlobal.LiveControl.Pause(ts); - else - FIXMEGlobal.LiveControl.Pause(); - } - else - { - FIXMEGlobal.LiveControl.Pause(); - } - - info.OutputOK(); - return; - - case "resume": - FIXMEGlobal.LiveControl.Resume(); - info.OutputOK(); - return; - - default: - info.ReportClientError("No such action", System.Net.HttpStatusCode.NotFound); - return; - } - } - - public string Description { get { return "Return the state of the server. This method can be long-polled."; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(Serializable.ServerStatus)), - new KeyValuePair(HttpServer.Method.Post, typeof(Serializable.ServerStatus)) - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/SystemInfo.cs b/Duplicati.Library.RestAPI/RESTMethods/SystemInfo.cs deleted file mode 100644 index 3c84ad5c6..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/SystemInfo.cs +++ /dev/null @@ -1,109 +0,0 @@ -// 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; -using System.Linq; -using System.Collections.Generic; -using Duplicati.Library.Interface; -using Duplicati.Library.Common; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class SystemInfo : IRESTMethodGET, IRESTMethodDocumented - { - public string Description { get { return "Gets various system properties"; } } - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, SystemData(null).GetType()) - }; - } - } - - public void GET(string key, RequestInfo info) - { - info.BodyWriter.OutputOK(SystemData(info)); - } - - private static object SystemData(RequestInfo info) - { - var browserlanguage = RESTHandler.ParseDefaultRequestCulture(info) ?? System.Globalization.CultureInfo.InvariantCulture; - - return new - { - APIVersion = 1, - PasswordPlaceholder = Duplicati.Server.WebServer.Server.PASSWORD_PLACEHOLDER, - ServerVersion = System.Reflection.Assembly.GetExecutingAssembly().GetName().Version.ToString(), - ServerVersionName = Duplicati.License.VersionNumbers.Version, - ServerVersionType = Duplicati.Library.AutoUpdater.UpdaterManager.SelfVersion.ReleaseType, - StartedBy = FIXMEGlobal.Origin, - DefaultUpdateChannel = Duplicati.Library.AutoUpdater.AutoUpdateSettings.DefaultUpdateChannel, - DefaultUsageReportLevel = Duplicati.Library.UsageReporter.Reporter.DefaultReportLevel, - ServerTime = DateTime.Now, - OSType = Platform.IsClientPosix ? (Platform.IsClientOSX ? "OSX" : "Linux") : "Windows", - DirectorySeparator = System.IO.Path.DirectorySeparatorChar, - PathSeparator = System.IO.Path.PathSeparator, - CaseSensitiveFilesystem = Duplicati.Library.Utility.Utility.IsFSCaseSensitive, - MachineName = System.Environment.MachineName, - PackageTypeId = Duplicati.Library.AutoUpdater.UpdaterManager.PackageTypeId, - UserName = System.Environment.UserName, - NewLine = System.Environment.NewLine, - CLRVersion = System.Environment.Version.ToString(), - CLROSInfo = new - { - Platform = System.Environment.OSVersion.Platform.ToString(), - ServicePack = System.Environment.OSVersion.ServicePack, - Version = System.Environment.OSVersion.Version.ToString(), - VersionString = System.Environment.OSVersion.VersionString - }, - Options = Serializable.ServerSettings.Options, - CompressionModules = Serializable.ServerSettings.CompressionModules, - EncryptionModules = Serializable.ServerSettings.EncryptionModules, - BackendModules = Serializable.ServerSettings.BackendModules, - GenericModules = Serializable.ServerSettings.GenericModules, - WebModules = Serializable.ServerSettings.WebModules, - ConnectionModules = Serializable.ServerSettings.ConnectionModules, - ServerModules = Serializable.ServerSettings.ServerModules, - UsingAlternateUpdateURLs = Duplicati.Library.AutoUpdater.AutoUpdateSettings.UsesAlternateURLs, - LogLevels = Enum.GetNames(typeof(Duplicati.Library.Logging.LogMessageType)), - SpecialFolders = from n in SpecialFolders.Nodes select new { ID = n.id, Path = n.resolvedpath }, - BrowserLocale = new - { - Code = browserlanguage.Name, - EnglishName = browserlanguage.EnglishName, - DisplayName = browserlanguage.NativeName - }, - SupportedLocales = - Library.Localization.LocalizationService.SupportedCultures - .Select(x => new { - Code = x, - EnglishName = new System.Globalization.CultureInfo(x).EnglishName, - DisplayName = new System.Globalization.CultureInfo(x).NativeName - } - ), - BrowserLocaleSupported = Library.Localization.LocalizationService.isCultureSupported(browserlanguage) - }; - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/SystemWideSettings.cs b/Duplicati.Library.RestAPI/RESTMethods/SystemWideSettings.cs deleted file mode 100644 index 09eebe706..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/SystemWideSettings.cs +++ /dev/null @@ -1,48 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Library.Interface; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class SystemWideSettings : IRESTMethodGET, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - info.OutputOK(new Duplicati.Library.Main.Options(new Dictionary()).SupportedCommands); - } - - public string Description { get { return "Return a list of settings that can be applied to all backups on a system-wide basis"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(ICommandLineArgument[])) - }; - } - } - - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Tags.cs b/Duplicati.Library.RestAPI/RESTMethods/Tags.cs deleted file mode 100644 index 90333250a..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Tags.cs +++ /dev/null @@ -1,59 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Tags : IRESTMethodGET, IRESTMethodDocumented - { - public void GET(string key, RequestInfo info) - { - var r = - from n in - Serializable.ServerSettings.CompressionModules - .Union(Serializable.ServerSettings.EncryptionModules) - .Union(Serializable.ServerSettings.BackendModules) - .Union(Serializable.ServerSettings.GenericModules) - select n.Key.ToLower(CultureInfo.InvariantCulture); - - // Append all known tags - r = r.Union(from n in FIXMEGlobal.DataConnection.Backups select n.Tags into p from x in p select x.ToLower(CultureInfo.InvariantCulture)); - info.OutputOK(r); - } - - public string Description { get { return "Gets the list of tags"; } } - - public IEnumerable> Types - { - get - { - return new KeyValuePair[] { - new KeyValuePair(HttpServer.Method.Get, typeof(string[])), - }; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Task.cs b/Duplicati.Library.RestAPI/RESTMethods/Task.cs deleted file mode 100644 index 1af624e61..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Task.cs +++ /dev/null @@ -1,113 +0,0 @@ -// 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; -using System.Linq; -using System.Collections.Generic; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Task : IRESTMethodGET, IRESTMethodPOST - { - public void GET(string key, RequestInfo info) - { - var parts = (key ?? "").Split(new char[] { '/' }, 2); - long taskid; - if (long.TryParse(parts.FirstOrDefault(), out taskid)) - { - var task = FIXMEGlobal.WorkThread.CurrentTask; - var tasks = FIXMEGlobal.WorkThread.CurrentTasks; - - if (task != null && task.TaskID == taskid) - { - info.OutputOK(new { Status = "Running" }); - return; - } - - if (tasks.FirstOrDefault(x => x.TaskID == taskid) == null) - { - KeyValuePair[] matches; - lock(FIXMEGlobal.MainLock) - matches = FIXMEGlobal.TaskResultCache.Where(x => x.Key == taskid).ToArray(); - - if (matches.Length == 0) - info.ReportClientError("No such task found", System.Net.HttpStatusCode.NotFound); - else - info.OutputOK(new { - Status = matches[0].Value == null ? "Completed" : "Failed", - ErrorMessage = matches[0].Value == null ? null : matches[0].Value.Message, - Exception = matches[0].Value == null ? null : matches[0].Value.ToString() - }); - } - else - { - info.OutputOK(new { Status = "Waiting" }); - } - } - else - { - info.ReportClientError("Invalid request", System.Net.HttpStatusCode.BadRequest); - } - } - - public void POST(string key, RequestInfo info) - { - var parts = (key ?? "").Split(new char[] { '/' }, 2); - long taskid; - if (parts.Length == 2 && long.TryParse(parts.First(), out taskid)) - { - var task = FIXMEGlobal.WorkThread.CurrentTask; - var tasks = FIXMEGlobal.WorkThread.CurrentTasks; - - if (task != null) - tasks.Insert(0, task); - - task = tasks.FirstOrDefault(x => x.TaskID == taskid); - if (task == null) - { - info.ReportClientError("No such task", System.Net.HttpStatusCode.NotFound); - return; - } - - switch (parts.Last().ToLowerInvariant()) - { - case "stopaftercurrentfile": - task.Stop(allowCurrentFileToFinish: true); - info.OutputOK(); - return; - - case "stopnow": - task.Stop(allowCurrentFileToFinish: false); - info.OutputOK(); - return; - - case "abort": - task.Abort(); - info.OutputOK(); - return; - } - } - - info.ReportClientError("Invalid or missing task id", System.Net.HttpStatusCode.NotFound); - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Tasks.cs b/Duplicati.Library.RestAPI/RESTMethods/Tasks.cs deleted file mode 100644 index cd900c522..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Tasks.cs +++ /dev/null @@ -1,41 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; -using System.Collections.Generic; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Tasks : IRESTMethodGET - { - public void GET(string key, RequestInfo info) - { - var cur = FIXMEGlobal.WorkThread.CurrentTask; - var n = FIXMEGlobal.WorkThread.CurrentTasks; - - if (cur != null) - n.Insert(0, cur); - - info.OutputOK(n); - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/UISettings.cs b/Duplicati.Library.RestAPI/RESTMethods/UISettings.cs deleted file mode 100644 index 37330516d..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/UISettings.cs +++ /dev/null @@ -1,82 +0,0 @@ -// 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; -using System.Collections.Generic; -using Duplicati.Server.Serialization; -using System.IO; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class UISettings : IRESTMethodGET, IRESTMethodPOST, IRESTMethodPATCH - { - public void GET(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - info.OutputOK(FIXMEGlobal.DataConnection.GetUISettingsSchemes()); - } - else - { - info.OutputOK(FIXMEGlobal.DataConnection.GetUISettings(key)); - } - } - - public void POST(string key, RequestInfo info) - { - PATCH(key, info); - } - - public void PATCH(string key, RequestInfo info) - { - if (string.IsNullOrWhiteSpace(key)) - { - info.ReportClientError("Scheme is missing", System.Net.HttpStatusCode.BadRequest); - return; - } - - IDictionary data; - try - { - data = Serializer.Deserialize>(new StreamReader(info.Request.Body)); - } - catch (Exception ex) - { - info.ReportClientError(string.Format("Unable to parse settings object: {0}", ex.Message), System.Net.HttpStatusCode.BadRequest); - return; - } - - if (data == null) - { - info.ReportClientError("Unable to parse settings object", System.Net.HttpStatusCode.BadRequest); - return; - } - - if (info.Request.Method == "POST") - FIXMEGlobal.DataConnection.SetUISettings(key, data); - else - FIXMEGlobal.DataConnection.UpdateUISettings(key, data); - info.OutputOK(); - } - - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/Updates.cs b/Duplicati.Library.RestAPI/RESTMethods/Updates.cs deleted file mode 100644 index 94abc4491..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/Updates.cs +++ /dev/null @@ -1,44 +0,0 @@ -// 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 Duplicati.Library.RestAPI; -using System; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class Updates : IRESTMethodPOST - { - public void POST(string key, RequestInfo info) - { - switch ((key ?? "").ToLowerInvariant()) - { - case "check": - FIXMEGlobal.UpdatePoller.CheckNow(); - info.OutputOK(); - return; - - default: - info.ReportClientError("No such action", System.Net.HttpStatusCode.NotFound); - return; - } - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/WebModule.cs b/Duplicati.Library.RestAPI/RESTMethods/WebModule.cs deleted file mode 100644 index 676b3c963..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/WebModule.cs +++ /dev/null @@ -1,45 +0,0 @@ -// 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; -using System.Linq; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class WebModule : IRESTMethodPOST - { - public void POST(string key, RequestInfo info) - { - var m = Duplicati.Library.DynamicLoader.WebLoader.Modules.FirstOrDefault(x => x.Key.Equals(key, StringComparison.OrdinalIgnoreCase)); - if (m == null) - { - info.ReportClientError(string.Format("No such command {0}", key), System.Net.HttpStatusCode.NotFound); - return; - } - - info.OutputOK(new { - Status = "OK", - Result = m.Execute(info.Request.Form.Where(x => !x.Name.Equals("command", StringComparison.OrdinalIgnoreCase) - ).ToDictionary(x => x.Name, x => x.Value)) - }); - } - } -} - diff --git a/Duplicati.Library.RestAPI/RESTMethods/WebModules.cs b/Duplicati.Library.RestAPI/RESTMethods/WebModules.cs deleted file mode 100644 index 9f90d91db..000000000 --- a/Duplicati.Library.RestAPI/RESTMethods/WebModules.cs +++ /dev/null @@ -1,34 +0,0 @@ -// 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; -using System.Linq; - -namespace Duplicati.Server.WebServer.RESTMethods -{ - public class WebModules : IRESTMethodGET - { - public void GET(string key, RequestInfo info) - { - info.OutputOK(Duplicati.Library.DynamicLoader.WebLoader.Modules); - } - } -} - diff --git a/Duplicati.Library.RestAPI/Runner.cs b/Duplicati.Library.RestAPI/Runner.cs index 544bb3f92..be732d71e 100644 --- a/Duplicati.Library.RestAPI/Runner.cs +++ b/Duplicati.Library.RestAPI/Runner.cs @@ -690,7 +690,7 @@ namespace Duplicati.Server if (ex is UserInformationException exception) messageid = exception.HelpID; - FIXMEGlobal.IncrementLastDataUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.DataConnection.RegisterNotification( NotificationType.Error, backup.IsTemporary ? @@ -856,6 +856,12 @@ namespace Duplicati.Server ? string.Format("Got {0} warning(s)", result.Warnings.Count()) : string.Format("Got {0} error(s)", result.Errors.Count()); + // If there is only one error or warning, show the message + if (result.ParsedResult == ParsedResultType.Warning && result.Warnings.Count() == 1) + message = $"Warning: {result.Warnings.Single()}"; + else if (result.ParsedResult == ParsedResultType.Error && result.Errors.Count() == 1) + message = $"Error: {result.Errors.Single()}"; + FIXMEGlobal.DataConnection.RegisterNotification( type, title, @@ -873,7 +879,7 @@ namespace Duplicati.Server if (!backup.IsTemporary) FIXMEGlobal.DataConnection.SetMetadata(backup.Metadata, long.Parse(backup.ID), null); - FIXMEGlobal.IncrementLastDataUpdateID(); + FIXMEGlobal.NotificationUpdateService.IncrementLastDataUpdateId(); FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); } @@ -942,7 +948,7 @@ namespace Duplicati.Server return filter; } - internal static Dictionary GetCommonOptions() + public static Dictionary GetCommonOptions() { return (from n in FIXMEGlobal.DataConnection.Settings diff --git a/Duplicati.Library.RestAPI/Scheduler.cs b/Duplicati.Library.RestAPI/Scheduler.cs index 81a8cdf41..bd61ba9f0 100644 --- a/Duplicati.Library.RestAPI/Scheduler.cs +++ b/Duplicati.Library.RestAPI/Scheduler.cs @@ -1,25 +1,26 @@ -#region Disclaimer / License -// Copyright (C) 2015, The Duplicati Team -// http://www.duplicati.com, info@duplicati.com +// Copyright (C) 2024, The Duplicati Team +// https://duplicati.com, hello@duplicati.com // -// This library is free software; you can redistribute it and/or -// modify it under the terms of the GNU Lesser General Public -// License as published by the Free Software Foundation; either -// version 2.1 of the License, or (at your option) any later version. +// 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: // -// This library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +// 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 Duplicati.Server.Serialization.Interface; - -#endregion using System; using System.Collections.Generic; using System.Text; @@ -28,6 +29,9 @@ using System.Threading; using Duplicati.Library.Utility; using Duplicati.Library.RestAPI; +// TODO: Rewrite this class. +// It should just signal what new backups to run, and not mix with the worker thread. + namespace Duplicati.Server { /// @@ -40,19 +44,23 @@ namespace Duplicati.Server /// /// The thread that runs the scheduler /// - private readonly Thread m_thread; + private Thread m_thread; + /// /// A termination flag /// private volatile bool m_terminate; + /// /// The worker thread that is invoked to do work /// - private readonly WorkerThread m_worker; + private WorkerThread m_worker; + /// /// The wait event /// - private readonly AutoResetEvent m_event; + private AutoResetEvent m_event; + /// /// The data synchronization lock /// @@ -67,17 +75,24 @@ namespace Duplicati.Server /// The currently scheduled items /// private KeyValuePair[] m_schedule; - + /// /// List of update tasks, used to set the timestamp on the schedule once completed /// - private readonly Dictionary> m_updateTasks; + private Dictionary> m_updateTasks; /// /// Constructs a new scheduler /// + public Scheduler() + { + } + + /// + /// Initializes scheduler + /// /// The worker thread - public Scheduler(WorkerThread worker) + public void Init(WorkerThread worker) { m_thread = new Thread(new ThreadStart(Runner)); m_worker = worker; @@ -92,6 +107,13 @@ namespace Duplicati.Server m_thread.Start(); } + public IList> GetSchedulerQueueIds() + { + return (from n in WorkerQueue + where n.Backup != null + select new Tuple(n.TaskID, n.Backup.ID)).ToList(); + } + /// /// Forces the scheduler to re-evaluate the order. /// Call this method if something changes @@ -104,13 +126,13 @@ namespace Duplicati.Server /// /// A snapshot copy of the current schedule list /// - public List> Schedule - { - get + public List> Schedule + { + get { lock (m_lock) return m_schedule.ToList(); - } + } } /// @@ -118,10 +140,7 @@ namespace Duplicati.Server /// public List WorkerQueue { - get - { - return (from t in m_worker.CurrentTasks where t != null select t).ToList(); - } + get { return (from t in m_worker.CurrentTasks where t != null select t).ToList(); } } /// @@ -135,8 +154,13 @@ namespace Duplicati.Server if (wait) { - try { m_thread.Join(); } - catch { } + try + { + m_thread.Join(); + } + catch + { + } } } @@ -148,7 +172,8 @@ namespace Duplicati.Server /// The repetition interval /// The days the backup is allowed to run /// The next valid date, or throws an exception if no such date can be found - public static DateTime GetNextValidTime(DateTime basetime, DateTime firstdate, string repetition, DayOfWeek[] allowedDays) + public static DateTime GetNextValidTime(DateTime basetime, DateTime firstdate, string repetition, + DayOfWeek[] allowedDays) { var res = basetime; @@ -195,26 +220,25 @@ namespace Duplicati.Server throw new Exception(Strings.Scheduler.InvalidTimeSetupError(basetime, repetition, sb.ToString())); } - + return res; } - + private void OnCompleted(WorkerThread worker, Runner.IRunnerData task) { Tuple t = null; - lock(m_lock) + lock (m_lock) { if (task != null && m_updateTasks.TryGetValue(task, out t)) m_updateTasks.Remove(task); } - + if (t != null) { t.Item1.Time = t.Item2; t.Item1.LastRun = t.Item3; FIXMEGlobal.DataConnection.AddOrUpdateSchedule(t.Item1); } - } private void OnStartingWork(WorkerThread worker, Runner.IRunnerData task) @@ -223,8 +247,8 @@ namespace Duplicati.Server { return; } - - lock(m_lock) + + lock (m_lock) { if (m_updateTasks.TryGetValue(task, out Tuple scheduleInfo)) { @@ -245,10 +269,10 @@ namespace Duplicati.Server { //TODO: As this is executed repeatedly we should cache it // to avoid frequent db lookups - + //Determine schedule list var lst = FIXMEGlobal.DataConnection.Schedules; - foreach(var sc in lst) + foreach (var sc in lst) { if (!string.IsNullOrEmpty(sc.Repeat)) { @@ -267,7 +291,7 @@ namespace Duplicati.Server { start = startkey.Value; } - + try { // Recover from timedrift issues by overriding the dates if the last run date is in the future. @@ -276,11 +300,13 @@ namespace Duplicati.Server start = DateTime.UtcNow; last = DateTime.UtcNow; } + start = GetNextValidTime(start, last, sc.Repeat, sc.AllowedDays); } catch (Exception ex) { - FIXMEGlobal.DataConnection.LogError(sc.ID.ToString(), "Scheduler failed to find next date", ex); + FIXMEGlobal.DataConnection.LogError(sc.ID.ToString(), "Scheduler failed to find next date", + ex); } //If time is exceeded, run it now @@ -288,15 +314,17 @@ namespace Duplicati.Server { var jobsToRun = new List(); //TODO: Cache this to avoid frequent lookups - foreach(var id in FIXMEGlobal.DataConnection.GetBackupIDsForTags(sc.Tags).Distinct().Select(x => x.ToString())) + foreach (var id in FIXMEGlobal.DataConnection.GetBackupIDsForTags(sc.Tags).Distinct() + .Select(x => x.ToString())) { //See if it is already queued var tmplst = from n in m_worker.CurrentTasks - where n.Operation == Duplicati.Server.Serialization.DuplicatiOperation.Backup - select n.Backup; + where n.Operation == Duplicati.Server.Serialization.DuplicatiOperation.Backup + select n.Backup; var tastTemp = m_worker.CurrentTask; - if (tastTemp != null && tastTemp.Operation == Duplicati.Server.Serialization.DuplicatiOperation.Backup) - tmplst = tmplst.Union(new [] { tastTemp.Backup }); + if (tastTemp != null && tastTemp.Operation == + Duplicati.Server.Serialization.DuplicatiOperation.Backup) + tmplst = tmplst.Union(new[] { tastTemp.Backup }); //If it is not already in queue, put it there if (!tmplst.Any(x => x.ID == id)) @@ -306,13 +334,18 @@ namespace Duplicati.Server { Dictionary options = Duplicati.Server.Runner.GetCommonOptions(); Duplicati.Server.Runner.ApplyOptions(entry, options); - if ((new Duplicati.Library.Main.Options(options)).DisableOnBattery && (Duplicati.Library.Utility.Power.PowerSupply.GetSource() == Duplicati.Library.Utility.Power.PowerSupply.Source.Battery)) + if ((new Duplicati.Library.Main.Options(options)).DisableOnBattery && + (Duplicati.Library.Utility.Power.PowerSupply.GetSource() == + Duplicati.Library.Utility.Power.PowerSupply.Source.Battery)) { - Duplicati.Library.Logging.Log.WriteInformationMessage(LOGTAG, "BackupDisabledOnBattery", "Scheduled backup disabled while on battery power."); + Duplicati.Library.Logging.Log.WriteInformationMessage(LOGTAG, + "BackupDisabledOnBattery", + "Scheduled backup disabled while on battery power."); } else { - jobsToRun.Add(Server.Runner.CreateTask(Duplicati.Server.Serialization.DuplicatiOperation.Backup, entry)); + jobsToRun.Add(Server.Runner.CreateTask( + Duplicati.Server.Serialization.DuplicatiOperation.Backup, entry)); } } } @@ -321,27 +354,32 @@ namespace Duplicati.Server // Calculate next time, by finding the first entry later than now try { - start = GetNextValidTime(start, new DateTime(Math.Max(DateTime.UtcNow.AddSeconds(1).Ticks, start.AddSeconds(1).Ticks), DateTimeKind.Utc), sc.Repeat, sc.AllowedDays); + start = GetNextValidTime(start, + new DateTime( + Math.Max(DateTime.UtcNow.AddSeconds(1).Ticks, start.AddSeconds(1).Ticks), + DateTimeKind.Utc), sc.Repeat, sc.AllowedDays); } - catch(Exception ex) + catch (Exception ex) { - FIXMEGlobal.DataConnection.LogError(sc.ID.ToString(), "Scheduler failed to find next date", ex); + FIXMEGlobal.DataConnection.LogError(sc.ID.ToString(), + "Scheduler failed to find next date", ex); continue; } - + Server.Runner.IRunnerData lastJob = jobsToRun.LastOrDefault(); if (lastJob != null) { lock (m_lock) { // The actual last run time will be updated when the StartingWork event is raised. - m_updateTasks[lastJob] = new Tuple(sc, start, DateTime.UtcNow); + m_updateTasks[lastJob] = + new Tuple(sc, start, DateTime.UtcNow); } } foreach (var job in jobsToRun) m_worker.AddTask(job); - + if (start < DateTime.UtcNow) { //TODO: Report this somehow @@ -349,23 +387,24 @@ namespace Duplicati.Server } } - scheduled[sc.ID] = new KeyValuePair(scticks, start); + scheduled[sc.ID] = new KeyValuePair(scticks, start); } } var existing = lst.ToDictionary(x => x.ID); //Sort them, lock as we assign the m_schedule variable - lock(m_lock) + lock (m_lock) m_schedule = (from n in scheduled - where existing.ContainsKey(n.Key) - orderby n.Value.Value - select new KeyValuePair(n.Value.Value, existing[n.Key])).ToArray(); + where existing.ContainsKey(n.Key) + orderby n.Value.Value + select new KeyValuePair(n.Value.Value, existing[n.Key])).ToArray(); // Remove unused entries - foreach(var c in (from n in scheduled where !existing.ContainsKey(n.Key) select n.Key).ToArray()) + foreach (var c in (from n in scheduled where !existing.ContainsKey(n.Key) select n.Key).ToArray()) scheduled.Remove(c); //Raise event if needed + // TODO: This triggers a new data event and a reconnect with long-poll if (NewSchedule != null) NewSchedule(this, null); @@ -384,6 +423,7 @@ namespace Duplicati.Server } else { + // TODO: This should be handled with events, instead of one wakeup per minute //No tasks, check back later waittime = 60 * 1000; } @@ -406,8 +446,7 @@ namespace Duplicati.Server if (allowedDays == null || allowedDays.Length == 0) return true; else - return Array.IndexOf(allowedDays, localTime.DayOfWeek) >= 0; + return Array.IndexOf(allowedDays, localTime.DayOfWeek) >= 0; } - } -} +} \ No newline at end of file diff --git a/Duplicati.Library.RestAPI/Serializable/ServerStatus.cs b/Duplicati.Library.RestAPI/Serializable/ServerStatus.cs index dfe41f5e4..76f5f3ec5 100644 --- a/Duplicati.Library.RestAPI/Serializable/ServerStatus.cs +++ b/Duplicati.Library.RestAPI/Serializable/ServerStatus.cs @@ -29,21 +29,21 @@ namespace Duplicati.Server.Serializable /// /// This class collects all reportable status properties into a single class that can be exported as JSON /// - public class ServerStatus : Duplicati.Server.Serialization.Interface.IServerStatus + public class ServerStatus(LiveControls liveControls) : Duplicati.Server.Serialization.Interface.IServerStatus { public LiveControlState ProgramState { - get { return EnumConverter.Convert(FIXMEGlobal.LiveControl.State); } + get { return EnumConverter.Convert(liveControls.State); } } - public string UpdatedVersion - { - get - { + public string UpdatedVersion + { + get + { var u = FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion; if (u == null) return null; - + Version v; if (!Version.TryParse(u.Version, out v)) return null; @@ -51,7 +51,7 @@ namespace Duplicati.Server.Serializable if (v <= System.Reflection.Assembly.GetExecutingAssembly().GetName().Version) return null; - return u.Displayname; + return u.Displayname; } } @@ -64,8 +64,8 @@ namespace Duplicati.Server.Serializable public Tuple ActiveTask { - get - { + get + { var t = FIXMEGlobal.WorkThread.CurrentTask; if (t == null) return null; @@ -85,18 +85,18 @@ namespace Duplicati.Server.Serializable { return ( from n in FIXMEGlobal.Scheduler.Schedule - let backupid = (from t in n.Value.Tags - where t != null && t.StartsWith("ID=", StringComparison.Ordinal) - select t.Substring("ID=".Length)).FirstOrDefault() - where !string.IsNullOrWhiteSpace(backupid) - select new Tuple(backupid, n.Key) + let backupid = (from t in n.Value.Tags + where t != null && t.StartsWith("ID=", StringComparison.Ordinal) + select t.Substring("ID=".Length)).FirstOrDefault() + where !string.IsNullOrWhiteSpace(backupid) + select new Tuple(backupid, n.Key) ).ToList(); } } - + public bool HasWarning { get { return FIXMEGlobal.DataConnection.ApplicationSettings.UnackedWarning; } } public bool HasError { get { return FIXMEGlobal.DataConnection.ApplicationSettings.UnackedError; } } - + public SuggestedStatusIcon SuggestedStatusIcon { get @@ -105,12 +105,12 @@ namespace Duplicati.Server.Serializable { if (this.ProgramState == LiveControlState.Paused) return SuggestedStatusIcon.Paused; - + if (this.HasError) return SuggestedStatusIcon.ReadyError; if (this.HasWarning) return SuggestedStatusIcon.ReadyWarning; - + return SuggestedStatusIcon.Ready; } else @@ -123,26 +123,25 @@ namespace Duplicati.Server.Serializable } } - public DateTime EstimatedPauseEnd + public DateTime EstimatedPauseEnd { - get - { - return FIXMEGlobal.LiveControl.EstimatedPauseEnd; + get + { + return liveControls.EstimatedPauseEnd; } } private long m_lastEventID = FIXMEGlobal.StatusEventNotifyer.EventNo; - public long LastEventID - { + public long LastEventID + { get { return m_lastEventID; } set { m_lastEventID = value; } } - public long LastDataUpdateID { get { return FIXMEGlobal.PeekLastDataUpdateID(); } } - - public long LastNotificationUpdateID { get { return FIXMEGlobal.PeekLastNotificationUpdateID(); } } + public long LastDataUpdateID => FIXMEGlobal.NotificationUpdateService.LastDataUpdateId; + public long LastNotificationUpdateID => FIXMEGlobal.NotificationUpdateService.LastNotificationUpdateId; } } diff --git a/Duplicati.Library.RestAPI/Serializable/TreeNode.cs b/Duplicati.Library.RestAPI/Serializable/TreeNode.cs index 02a107971..cf8d3c8e8 100644 --- a/Duplicati.Library.RestAPI/Serializable/TreeNode.cs +++ b/Duplicati.Library.RestAPI/Serializable/TreeNode.cs @@ -1,60 +1,72 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; - -namespace Duplicati.Server.Serializable -{ - /// - /// Implementation of a ExtJS treenode-like class for easy JSON export - /// - public class TreeNode - { - /// - /// The text displayed for the node - /// - public string text { get; set; } - /// - /// The node id - /// - public string id { get; set; } - /// - /// The class applied to the node - /// - public string cls { get; set; } - /// - /// The class applied to the icon - /// - public string iconCls { get; set; } - /// - /// True if the element should be checked - /// - public bool check { get; set; } - /// - /// True if the element is a leaf node - /// - public bool leaf { get; set; } - /// - /// Gets or sets the current path, if the item is a symbolic path - /// - public string resolvedpath { get; set; } - /// - /// True if the element is hidden - /// - public bool hidden { get; set; } - /// - /// True if the element is a symlink - /// - public bool symlink { get; set; } - - /// - /// Constructs a new TreeNode - /// - public TreeNode() - { - this.cls = "folder"; - this.iconCls = "x-tree-icon-parent"; - this.check = false; - } - } -} +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; + +namespace Duplicati.Server.Serializable +{ + /// + /// Implementation of a ExtJS treenode-like class for easy JSON export + /// + public class TreeNode + { + /// + /// The text displayed for the node + /// + public string text { get; set; } + /// + /// The node id + /// + public string id { get; set; } + /// + /// The class applied to the node + /// + public string cls { get; set; } + /// + /// The class applied to the icon + /// + public string iconCls { get; set; } + /// + /// True if the element should be checked + /// + public bool check { get; set; } + /// + /// True if the element is a leaf node + /// + public bool leaf { get; set; } + /// + /// Gets or sets the current path, if the item is a symbolic path + /// + public string resolvedpath { get; set; } + /// + /// True if the element is hidden + /// + public bool hidden { get; set; } + /// + /// True if the element has the system file attribute + /// + public bool systemFile { get; set; } + /// + /// True if the element is marked as temporary + /// + public bool temporary { get; set; } + /// + /// True if the element is a symlink + /// + public bool symlink { get; set; } + /// + /// Size of the file. -1 if directory or inaccessible + /// + public long fileSize { get; set; } + + /// + /// Constructs a new TreeNode + /// + public TreeNode() + { + this.cls = "folder"; + this.iconCls = "x-tree-icon-parent"; + this.check = false; + } + } +} diff --git a/Duplicati.Library.RestAPI/SpecialFolders.cs b/Duplicati.Library.RestAPI/SpecialFolders.cs index 5bcbd239f..2c914a562 100644 --- a/Duplicati.Library.RestAPI/SpecialFolders.cs +++ b/Duplicati.Library.RestAPI/SpecialFolders.cs @@ -1,20 +1,24 @@ -// Copyright (C) 2015, The Duplicati Team +// 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. -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using System.Linq; using System.Collections.Generic; @@ -31,7 +35,7 @@ namespace Duplicati.Server public static string ExpandEnvironmentVariables(string path) { - foreach(var n in Nodes) + foreach (var n in Nodes) if (path.StartsWith(n.id, StringComparison.Ordinal)) path = path.Replace(n.id, n.resolvedpath); return Environment.ExpandEnvironmentVariables(path); @@ -54,21 +58,21 @@ namespace Duplicati.Server }); } - public static string TranslateToPath(string str) + public static string TranslateToPath(string str) { string res; if (PathMap.TryGetValue(str, out res)) return res; - + return null; } - public static string TranslateToDisplayString(string str) + public static string TranslateToDisplayString(string str) { string res; if (DisplayMap.TryGetValue(str, out res)) return res; - + return null; } @@ -109,12 +113,12 @@ namespace Duplicati.Server { } } - + static SpecialFolders() { var lst = new List(); - - if (Platform.IsClientWindows) + + if (OperatingSystem.IsWindows()) { TryAdd(lst, Environment.SpecialFolder.MyDocuments, "%MY_DOCUMENTS%", "My Documents"); TryAdd(lst, Environment.SpecialFolder.MyMusic, "%MY_MUSIC%", "My Music"); @@ -147,7 +151,7 @@ namespace Duplicati.Server Nodes = lst.ToArray(); } - internal static Dictionary GetSourceNames(Serialization.Interface.IBackup backup) + public static Dictionary GetSourceNames(Serialization.Interface.IBackup backup) { if (backup.Sources == null || backup.Sources.Length == 0) return new Dictionary(); @@ -181,7 +185,7 @@ namespace Duplicati.Server // Handle duplicates var result = new Dictionary(); - foreach(var x in sources) + foreach (var x in sources) result[x.Key] = x.Value; return result; diff --git a/Duplicati.Library.RestAPI/Strings.cs b/Duplicati.Library.RestAPI/Strings.cs index d925113eb..83cfbdd7e 100644 --- a/Duplicati.Library.RestAPI/Strings.cs +++ b/Duplicati.Library.RestAPI/Strings.cs @@ -2,8 +2,10 @@ using System.Collections.Generic; using Duplicati.Library.Localization.Short; using System.Linq; -namespace Duplicati.Server.Strings { - public static class Program { +namespace Duplicati.Server.Strings +{ + public static class Program + { public static string AnotherInstanceDetected { get { return LC.L(@"Another instance is running, and was notified"); } } public static string DatabaseOpenError(string message) { return LC.L(@"Failed to create, open or upgrade the database. Error message: {0}", message); } @@ -42,11 +44,13 @@ Error message: {0}", error); } public static string ServerencryptionkeyLong(string envname, string decryptionoption) { return LC.L(@"This option sets the encryption key used to scramble the local settings database. This option can also be set with the environment variable {0}. Use the option --{1} to disable the database scrambling.", envname, decryptionoption); } public static string TempdirShort { get { return LC.L(@"Temporary storage folder"); } } public static string TempdirLong { get { return LC.L(@"This option can be used to supply an alternative folder for temporary storage. By default the system default temporary folder is used. Note that also SQLite will put temporary files in this temporary folder."); } } -} - internal static class Scheduler { + public static string WebserverResetJwtConfigDescription { get { return LC.L(@"Resets the JWT configuration, invalidating any issued login tokens"); } } + } + internal static class Scheduler + { public static string InvalidTimeSetupError(System.DateTime startdate, string interval, string alloweddays) { return LC.L(@"Unable to find a valid date, given the start date {0}, the repetition interval {1} and the allowed days {2}", startdate, interval, alloweddays); } } - internal static class Server + public static class Server { public static string DefectSSLCertInDatabase { get { return @"Unable to create SSL certificate using data from database. Starting without SSL."; } } public static string StartedServer(string ip, int port) { return LC.L(@"Server has started and is listening on {0}, port {1}", ip, port); } diff --git a/Duplicati.Library.RestAPI/UpdatePollThread.cs b/Duplicati.Library.RestAPI/UpdatePollThread.cs index fb3890b67..6f0ce0ac7 100644 --- a/Duplicati.Library.RestAPI/UpdatePollThread.cs +++ b/Duplicati.Library.RestAPI/UpdatePollThread.cs @@ -1,205 +1,211 @@ -// Copyright (C) 2015, The Duplicati Team - -// http://www.duplicati.com, info@duplicati.com -// -// This library is free software; you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as -// published by the Free Software Foundation; either version 2.1 of the -// License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, but -// WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -using System; -using System.Linq; -using System.Threading; -using Duplicati.Library.RestAPI; -using Duplicati.Server.Serialization; - -namespace Duplicati.Server -{ - /// - /// The thread that checks on the update server if new versions are available - /// - public class UpdatePollThread - { - private readonly Thread m_thread; - private volatile bool m_terminated = false; - private volatile bool m_forceCheck = false; - private readonly object m_lock = new object(); - private readonly AutoResetEvent m_waitSignal; - private double m_downloadProgress; - - public bool IsUpdateRequested { get; private set; } = false; - - public UpdatePollerStates ThreadState { get; private set; } - public double DownloadProgess - { - get { return m_downloadProgress; } - - private set - { - var oldv = m_downloadProgress; - m_downloadProgress = value; - if ((int)(oldv * 100) != (int)(value * 100)) - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - } - } - - public UpdatePollThread() - { - m_waitSignal = new AutoResetEvent(false); - ThreadState = UpdatePollerStates.Waiting; - m_thread = new Thread(Run); - m_thread.IsBackground = true; - m_thread.Name = "UpdatePollThread"; - m_thread.Start(); - } - - public void CheckNow() - { - lock (m_lock) - { - m_forceCheck = true; - m_waitSignal.Set(); - } - } - - public void Terminate() - { - lock (m_lock) - { - m_terminated = true; - m_waitSignal.Set(); - } - } - - public void Reschedule() - { - m_waitSignal.Set(); - } - - private void Run() - { - // Wait on startup - m_waitSignal.WaitOne(TimeSpan.FromMinutes(1), true); - - while (!m_terminated) - { - var nextCheck = FIXMEGlobal.DataConnection.ApplicationSettings.NextUpdateCheck; - - var maxcheck = TimeSpan.FromDays(7); - try - { - maxcheck = Library.Utility.Timeparser.ParseTimeSpan(FIXMEGlobal.DataConnection.ApplicationSettings.UpdateCheckInterval); - } - catch - { - } - - // If we have some weirdness, just check now - if (nextCheck - DateTime.UtcNow > maxcheck) - nextCheck = DateTime.UtcNow - TimeSpan.FromSeconds(1); - - if (nextCheck < DateTime.UtcNow || m_forceCheck) - { - lock (m_lock) - m_forceCheck = false; - - ThreadState = UpdatePollerStates.Checking; - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - - DateTime started = DateTime.UtcNow; - FIXMEGlobal.DataConnection.ApplicationSettings.LastUpdateCheck = started; - nextCheck = FIXMEGlobal.DataConnection.ApplicationSettings.NextUpdateCheck; - - Library.AutoUpdater.ReleaseType rt; - if (!Enum.TryParse(FIXMEGlobal.DataConnection.ApplicationSettings.UpdateChannel, true, out rt)) - rt = Duplicati.Library.AutoUpdater.ReleaseType.Unknown; - - // Choose the default channel in case we have unknown - rt = rt == Duplicati.Library.AutoUpdater.ReleaseType.Unknown ? Duplicati.Library.AutoUpdater.AutoUpdateSettings.DefaultUpdateChannel : rt; - - try - { - var update = Duplicati.Library.AutoUpdater.UpdaterManager.CheckForUpdate(rt); - if (update != null) - FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion = update; - } - catch - { - } - - // It could be that we have registered an update from a more unstable channel, - // but the user has switched to a more stable channel. - // In that case we discard the old update to avoid offering it. - if (FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion != null) - { - Library.AutoUpdater.ReleaseType updatert; - var updatertstring = FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion.ReleaseType; - if (string.Equals(updatertstring, "preview", StringComparison.OrdinalIgnoreCase)) - updatertstring = Library.AutoUpdater.ReleaseType.Experimental.ToString(); - - if (!Enum.TryParse(updatertstring, true, out updatert)) - updatert = Duplicati.Library.AutoUpdater.ReleaseType.Nightly; - - if (updatert == Duplicati.Library.AutoUpdater.ReleaseType.Unknown) - updatert = Duplicati.Library.AutoUpdater.ReleaseType.Nightly; - - if (updatert > rt) - FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion = null; - } - - var updatedinfo = FIXMEGlobal.DataConnection.ApplicationSettings.UpdatedVersion; - if (updatedinfo != null && Duplicati.Library.AutoUpdater.UpdaterManager.TryParseVersion(updatedinfo.Version) > System.Reflection.Assembly.GetExecutingAssembly().GetName().Version) - { - var package = updatedinfo.FindPackage(); - - FIXMEGlobal.DataConnection.RegisterNotification( - NotificationType.Information, - "Found update", - updatedinfo.Displayname, - null, - null, - "update:new", - null, - "NewUpdateFound", - null, - (self, all) => - { - return all.FirstOrDefault(x => x.Action == "update:new") ?? self; - } - ); - } - } - - DownloadProgess = 0; - - if (ThreadState != UpdatePollerStates.Waiting) - { - ThreadState = UpdatePollerStates.Waiting; - FIXMEGlobal.StatusEventNotifyer.SignalNewEvent(); - } - - var waitTime = nextCheck - DateTime.UtcNow; - - // Guard against spin-loop - if (waitTime.TotalSeconds < 5) - waitTime = TimeSpan.FromSeconds(5); - - // Guard against year-long waits - // A re-check does not cause an update check - if (waitTime.TotalDays > 1) - waitTime = TimeSpan.FromDays(1); - - m_waitSignal.WaitOne(waitTime, true); - } - } - } -} - +// 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; +using System.Linq; +using System.Threading; +using Duplicati.Server.Database; +using Duplicati.Server.Serialization; + +namespace Duplicati.Server +{ + /// + /// The thread that checks on the update server if new versions are available + /// + public class UpdatePollThread(Connection connection, EventPollNotify eventPollNotify) + { + private Thread m_thread; + private volatile bool m_terminated = false; + private volatile bool m_forceCheck = false; + private readonly object m_lock = new object(); + private AutoResetEvent m_waitSignal; + private double m_downloadProgress; + + public bool IsUpdateRequested { get; private set; } = false; + + public UpdatePollerStates ThreadState { get; private set; } + public double DownloadProgess + { + get { return m_downloadProgress; } + + private set + { + var oldv = m_downloadProgress; + m_downloadProgress = value; + if ((int)(oldv * 100) != (int)(value * 100)) + eventPollNotify.SignalNewEvent(); + } + } + + public void Init() + { + m_waitSignal = new AutoResetEvent(false); + ThreadState = UpdatePollerStates.Waiting; + m_thread = new Thread(Run) + { + IsBackground = true, + Name = "UpdatePollThread" + }; + m_thread.Start(); + } + + public void CheckNow() + { + lock (m_lock) + { + m_forceCheck = true; + m_waitSignal.Set(); + } + } + + public void Terminate() + { + lock (m_lock) + { + m_terminated = true; + m_waitSignal.Set(); + } + } + + public void Reschedule() + { + m_waitSignal.Set(); + } + + private void Run() + { + // Wait on startup + m_waitSignal.WaitOne(TimeSpan.FromMinutes(1), true); + + while (!m_terminated) + { + var nextCheck = connection.ApplicationSettings.NextUpdateCheck; + + var maxcheck = TimeSpan.FromDays(7); + try + { + maxcheck = Library.Utility.Timeparser.ParseTimeSpan(connection.ApplicationSettings.UpdateCheckInterval); + } + catch + { + } + + // If we have some weirdness, just check now + if (nextCheck - DateTime.UtcNow > maxcheck) + nextCheck = DateTime.UtcNow - TimeSpan.FromSeconds(1); + + if (nextCheck < DateTime.UtcNow || m_forceCheck) + { + lock (m_lock) + m_forceCheck = false; + + ThreadState = UpdatePollerStates.Checking; + eventPollNotify.SignalNewEvent(); + + DateTime started = DateTime.UtcNow; + connection.ApplicationSettings.LastUpdateCheck = started; + nextCheck = connection.ApplicationSettings.NextUpdateCheck; + + Library.AutoUpdater.ReleaseType rt; + if (!Enum.TryParse(connection.ApplicationSettings.UpdateChannel, true, out rt)) + rt = Duplicati.Library.AutoUpdater.ReleaseType.Unknown; + + // Choose the default channel in case we have unknown + rt = rt == Duplicati.Library.AutoUpdater.ReleaseType.Unknown ? Duplicati.Library.AutoUpdater.AutoUpdateSettings.DefaultUpdateChannel : rt; + + try + { + var update = Duplicati.Library.AutoUpdater.UpdaterManager.CheckForUpdate(rt); + if (update != null) + connection.ApplicationSettings.UpdatedVersion = update; + } + catch + { + } + + // It could be that we have registered an update from a more unstable channel, + // but the user has switched to a more stable channel. + // In that case we discard the old update to avoid offering it. + if (connection.ApplicationSettings.UpdatedVersion != null) + { + Library.AutoUpdater.ReleaseType updatert; + var updatertstring = connection.ApplicationSettings.UpdatedVersion.ReleaseType; + if (string.Equals(updatertstring, "preview", StringComparison.OrdinalIgnoreCase)) + updatertstring = Library.AutoUpdater.ReleaseType.Experimental.ToString(); + + if (!Enum.TryParse(updatertstring, true, out updatert)) + updatert = Duplicati.Library.AutoUpdater.ReleaseType.Nightly; + + if (updatert == Duplicati.Library.AutoUpdater.ReleaseType.Unknown) + updatert = Duplicati.Library.AutoUpdater.ReleaseType.Nightly; + + if (updatert > rt) + connection.ApplicationSettings.UpdatedVersion = null; + } + + var updatedinfo = connection.ApplicationSettings.UpdatedVersion; + if (updatedinfo != null && Duplicati.Library.AutoUpdater.UpdaterManager.TryParseVersion(updatedinfo.Version) > System.Reflection.Assembly.GetExecutingAssembly().GetName().Version) + { + var package = updatedinfo.FindPackage(); + + connection.RegisterNotification( + NotificationType.Information, + "Found update", + updatedinfo.Displayname, + null, + null, + "update:new", + null, + "NewUpdateFound", + null, + (self, all) => + { + return all.FirstOrDefault(x => x.Action == "update:new") ?? self; + } + ); + } + } + + DownloadProgess = 0; + + if (ThreadState != UpdatePollerStates.Waiting) + { + ThreadState = UpdatePollerStates.Waiting; + eventPollNotify.SignalNewEvent(); + } + + var waitTime = nextCheck - DateTime.UtcNow; + + // Guard against spin-loop + if (waitTime.TotalSeconds < 5) + waitTime = TimeSpan.FromSeconds(5); + + // Guard against year-long waits + // A re-check does not cause an update check + if (waitTime.TotalDays > 1) + waitTime = TimeSpan.FromDays(1); + + m_waitSignal.WaitOne(waitTime, true); + } + } + } +} + diff --git a/Duplicati.Library.RestAPI/WebServer/AuthenticationHandler.cs b/Duplicati.Library.RestAPI/WebServer/AuthenticationHandler.cs deleted file mode 100644 index a7ad72356..000000000 --- a/Duplicati.Library.RestAPI/WebServer/AuthenticationHandler.cs +++ /dev/null @@ -1,342 +0,0 @@ -// 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; -using System.Collections.Concurrent; -using System.Linq; -using HttpServer; -using HttpServer.HttpModules; -using System.Collections.Generic; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer -{ - public class AuthenticationHandler : HttpModule - { - private const string AUTH_COOKIE_NAME = "session-auth"; - private const string NONCE_COOKIE_NAME = "session-nonce"; - - private const string XSRF_COOKIE_NAME = "xsrf-token"; - private const string XSRF_HEADER_NAME = "X-XSRF-Token"; - - private const string TRAYICONPASSWORDSOURCE_HEADER = "X-TrayIcon-PasswordSource"; - - public const string LOGIN_SCRIPT_URI = "/login.cgi"; - public const string LOGOUT_SCRIPT_URI = "/logout.cgi"; - public const string CAPTCHA_IMAGE_URI = RESTHandler.API_URI_PATH + "/captcha/"; - - private const int XSRF_TIMEOUT_MINUTES = 10; - private const int AUTH_TIMEOUT_MINUTES = 10; - - private readonly ConcurrentDictionary m_activeTokens = new ConcurrentDictionary(); - private readonly ConcurrentDictionary> m_activeNonces = new ConcurrentDictionary>(); - private readonly ConcurrentDictionary m_activexsrf = new ConcurrentDictionary(); - - readonly System.Security.Cryptography.RandomNumberGenerator m_prng = System.Security.Cryptography.RNGCryptoServiceProvider.Create(); - - private string FindXSRFToken(HttpServer.IHttpRequest request) - { - string xsrftoken = request.Headers[XSRF_HEADER_NAME] ?? ""; - - if (string.IsNullOrWhiteSpace(xsrftoken)) - { - var xsrfq = request.Form[XSRF_HEADER_NAME] ?? request.Form[Duplicati.Library.Utility.Uri.UrlEncode(XSRF_HEADER_NAME)]; - xsrftoken = (xsrfq == null || string.IsNullOrWhiteSpace(xsrfq.Value)) ? "" : xsrfq.Value; - } - - if (string.IsNullOrWhiteSpace(xsrftoken)) - { - var xsrfq = request.QueryString[XSRF_HEADER_NAME] ?? request.QueryString[Duplicati.Library.Utility.Uri.UrlEncode(XSRF_HEADER_NAME)]; - xsrftoken = (xsrfq == null || string.IsNullOrWhiteSpace(xsrfq.Value)) ? "" : xsrfq.Value; - } - - return xsrftoken; - } - - private bool AddXSRFTokenToRespone(HttpServer.IHttpResponse response) - { - if (m_activexsrf.Count > 500) - return false; - - var buf = new byte[32]; - var expires = DateTime.UtcNow.AddMinutes(XSRF_TIMEOUT_MINUTES); - m_prng.GetBytes(buf); - var token = Convert.ToBase64String(buf); - - m_activexsrf.AddOrUpdate(token, key => expires, (key, existingExpires) => - { - // Simulate the original behavior => if the random token, against all odds, is already used - // we throw an ArgumentException - throw new ArgumentException("An element with the same key already exists in the dictionary."); - }); - - response.Cookies.Add(new HttpServer.ResponseCookie(XSRF_COOKIE_NAME, token, expires)); - return true; - } - - private string FindAuthCookie(HttpServer.IHttpRequest request) - { - var authcookie = request.Cookies[AUTH_COOKIE_NAME] ?? request.Cookies[Library.Utility.Uri.UrlEncode(AUTH_COOKIE_NAME)]; - var authform = request.Form["auth-token"] ?? request.Form[Library.Utility.Uri.UrlEncode("auth-token")]; - var authquery = request.QueryString["auth-token"] ?? request.QueryString[Library.Utility.Uri.UrlEncode("auth-token")]; - - var auth_token = string.IsNullOrWhiteSpace(authcookie?.Value) ? null : authcookie.Value; - if (!string.IsNullOrWhiteSpace(authquery?.Value)) - auth_token = authquery.Value; - if (!string.IsNullOrWhiteSpace(authform?.Value)) - auth_token = authform.Value; - - return auth_token; - } - - private bool HasXSRFCookie(HttpServer.IHttpRequest request) - { - // Clean up expired XSRF cookies - foreach (var k in (from n in m_activexsrf where DateTime.UtcNow > n.Value select n.Key)) - m_activexsrf.TryRemove(k, out _); - - var xsrfcookie = request.Cookies[XSRF_COOKIE_NAME] ?? request.Cookies[Library.Utility.Uri.UrlEncode(XSRF_COOKIE_NAME)]; - var value = xsrfcookie == null ? null : xsrfcookie.Value; - if (string.IsNullOrWhiteSpace(value)) - return false; - - if (m_activexsrf.ContainsKey(value)) - { - m_activexsrf[value] = DateTime.UtcNow.AddMinutes(XSRF_TIMEOUT_MINUTES); - return true; - } - else if (m_activexsrf.ContainsKey(Library.Utility.Uri.UrlDecode(value))) - { - m_activexsrf[Library.Utility.Uri.UrlDecode(value)] = DateTime.UtcNow.AddMinutes(XSRF_TIMEOUT_MINUTES); - return true; - } - - return false; - } - - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - HttpServer.HttpInput input = String.Equals(request.Method, "POST", StringComparison.OrdinalIgnoreCase) ? request.Form : request.QueryString; - - var auth_token = FindAuthCookie(request); - var xsrf_token = FindXSRFToken(request); - - if (!HasXSRFCookie(request)) - { - var cookieAdded = AddXSRFTokenToRespone(response); - - if (!cookieAdded) - { - response.Status = System.Net.HttpStatusCode.ServiceUnavailable; - response.Reason = "Too Many Concurrent Request, try again later"; - return true; - } - } - - if (LOGOUT_SCRIPT_URI.Equals(request.Uri.AbsolutePath, StringComparison.OrdinalIgnoreCase)) - { - if (!string.IsNullOrWhiteSpace(auth_token)) - { - // Remove the active auth token - m_activeTokens.TryRemove(auth_token, out _); - } - - response.Status = System.Net.HttpStatusCode.NoContent; - response.Reason = "OK"; - - return true; - } - else if (LOGIN_SCRIPT_URI.Equals(request.Uri.AbsolutePath, StringComparison.OrdinalIgnoreCase)) - { - // Remove expired nonces - foreach(var k in (from n in m_activeNonces where DateTime.UtcNow > n.Value.Item1 select n.Key)) - m_activeNonces.TryRemove(k, out _); - - if (input["get-nonce"] != null && !string.IsNullOrWhiteSpace(input["get-nonce"].Value)) - { - if (m_activeNonces.Count > 50) - { - response.Status = System.Net.HttpStatusCode.ServiceUnavailable; - response.Reason = "Too many active login attempts"; - return true; - } - - var password = FIXMEGlobal.DataConnection.ApplicationSettings.WebserverPassword; - - if (request.Headers[TRAYICONPASSWORDSOURCE_HEADER] == "database") - password = FIXMEGlobal.DataConnection.ApplicationSettings.WebserverPasswordTrayIconHash; - - var buf = new byte[32]; - var expires = DateTime.UtcNow.AddMinutes(AUTH_TIMEOUT_MINUTES); - m_prng.GetBytes(buf); - var nonce = Convert.ToBase64String(buf); - - var sha256 = System.Security.Cryptography.SHA256.Create(); - sha256.TransformBlock(buf, 0, buf.Length, buf, 0); - buf = Convert.FromBase64String(password); - sha256.TransformFinalBlock(buf, 0, buf.Length); - var pwd = Convert.ToBase64String(sha256.Hash); - - m_activeNonces.AddOrUpdate(nonce, key => new Tuple(expires, pwd), (key, existingValue) => - { - // Simulate the original behavior => if the nonce, against all odds, is already used - // we throw an ArgumentException - throw new ArgumentException("An element with the same key already exists in the dictionary."); - }); - - response.Cookies.Add(new HttpServer.ResponseCookie(NONCE_COOKIE_NAME, nonce, expires)); - using(var bw = new BodyWriter(response, request)) - { - bw.OutputOK(new { - Status = "OK", - Nonce = nonce, - Salt = FIXMEGlobal.DataConnection.ApplicationSettings.WebserverPasswordSalt - }); - } - return true; - } - else - { - if (input["password"] != null && !string.IsNullOrWhiteSpace(input["password"].Value)) - { - var nonce_el = request.Cookies[NONCE_COOKIE_NAME] ?? request.Cookies[Library.Utility.Uri.UrlEncode(NONCE_COOKIE_NAME)]; - var nonce = nonce_el == null || string.IsNullOrWhiteSpace(nonce_el.Value) ? "" : nonce_el.Value; - var urldecoded = nonce == null ? "" : Duplicati.Library.Utility.Uri.UrlDecode(nonce); - if (m_activeNonces.ContainsKey(urldecoded)) - nonce = urldecoded; - - if (!m_activeNonces.ContainsKey(nonce)) - { - response.Status = System.Net.HttpStatusCode.Unauthorized; - response.Reason = "Unauthorized"; - response.ContentType = "application/json"; - return true; - } - - var pwd = m_activeNonces[nonce].Item2; - - // Remove the nonce - m_activeNonces.TryRemove(nonce, out _); - - if (pwd != input["password"].Value) - { - response.Status = System.Net.HttpStatusCode.Unauthorized; - response.Reason = "Unauthorized"; - response.ContentType = "application/json"; - return true; - } - - var buf = new byte[32]; - var expires = DateTime.UtcNow.AddHours(1); - m_prng.GetBytes(buf); - var token = Duplicati.Library.Utility.Utility.Base64UrlEncode(buf); - while (token.Length > 0 && token.EndsWith("=", StringComparison.Ordinal)) - token = token.Substring(0, token.Length - 1); - - m_activeTokens.AddOrUpdate(token, key => expires, (key, existingValue) => - { - // Simulate the original behavior => if the token, against all odds, is already used - // we throw an ArgumentException - throw new ArgumentException("An element with the same key already exists in the dictionary."); - }); - - response.Cookies.Add(new HttpServer.ResponseCookie(AUTH_COOKIE_NAME, token, expires)); - - using(var bw = new BodyWriter(response, request)) - bw.OutputOK(); - - return true; - } - } - } - - var limitedAccess = - request.Uri.AbsolutePath.StartsWith(RESTHandler.API_URI_PATH, StringComparison.OrdinalIgnoreCase) - ; - - // Override to allow the CAPTCHA call to go through - if (request.Uri.AbsolutePath.StartsWith(CAPTCHA_IMAGE_URI, StringComparison.OrdinalIgnoreCase) && request.Method == "GET") - limitedAccess = false; - - if (limitedAccess) - { - if (xsrf_token != null && m_activexsrf.ContainsKey(xsrf_token)) - { - var expires = DateTime.UtcNow.AddMinutes(XSRF_TIMEOUT_MINUTES); - m_activexsrf[xsrf_token] = expires; - response.Cookies.Add(new ResponseCookie(XSRF_COOKIE_NAME, xsrf_token, expires)); - } - else - { - response.Status = System.Net.HttpStatusCode.BadRequest; - response.Reason = "Missing XSRF Token. Please reload the page"; - - return true; - } - } - - if (string.IsNullOrWhiteSpace(FIXMEGlobal.DataConnection.ApplicationSettings.WebserverPassword)) - return false; - - foreach(var k in (from n in m_activeTokens where DateTime.UtcNow > n.Value select n.Key)) - m_activeTokens.TryRemove(k, out _); - - - // If we have a valid token, proceed - if (!string.IsNullOrWhiteSpace(auth_token)) - { - DateTime expires; - var found = m_activeTokens.TryGetValue(auth_token, out expires); - if (!found) - { - auth_token = Duplicati.Library.Utility.Uri.UrlDecode(auth_token); - found = m_activeTokens.TryGetValue(auth_token, out expires); - } - - if (found && DateTime.UtcNow < expires) - { - expires = DateTime.UtcNow.AddHours(1); - - m_activeTokens[auth_token] = expires; - response.Cookies.Add(new ResponseCookie(AUTH_COOKIE_NAME, auth_token, expires)); - return false; - } - } - - if ("/".Equals(request.Uri.AbsolutePath, StringComparison.OrdinalIgnoreCase) || "/index.html".Equals(request.Uri.AbsolutePath, StringComparison.OrdinalIgnoreCase)) - { - response.Redirect("/login.html"); - return true; - } - - if (limitedAccess) - { - response.Status = System.Net.HttpStatusCode.Unauthorized; - response.Reason = "Not logged in"; - response.AddHeader("Location", "login.html"); - - return true; - } - - return false; - } - } -} - diff --git a/Duplicati.Library.RestAPI/WebServer/BodyWriter.cs b/Duplicati.Library.RestAPI/WebServer/BodyWriter.cs deleted file mode 100644 index a411d98ac..000000000 --- a/Duplicati.Library.RestAPI/WebServer/BodyWriter.cs +++ /dev/null @@ -1,124 +0,0 @@ -// 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; -using System.Globalization; -using System.Threading.Tasks; -using Duplicati.Server.Serialization; - -namespace Duplicati.Server.WebServer -{ - public class BodyWriter : IDisposable, IAsyncDisposable - { - private readonly HttpServer.IHttpResponse m_resp; - private readonly string m_jsonp; - private static readonly object SUCCESS_RESPONSE = new { Status = "OK" }; - private readonly System.IO.StreamWriter m_bodyStreamWriter; - - public BodyWriter(HttpServer.IHttpResponse resp, HttpServer.IHttpRequest request) - : this(resp, request.QueryString["jsonp"].Value) - { - } - - public BodyWriter(HttpServer.IHttpResponse resp, string jsonp) - { - m_bodyStreamWriter = new System.IO.StreamWriter(resp.Body, resp.Encoding); - m_resp = resp; - m_jsonp = jsonp; - if (!m_resp.HeadersSent) - m_resp.AddHeader("Cache-Control", "no-cache, no-store, must-revalidate, max-age=0"); - } - public void SetOK() - { - m_resp.Reason = "OK"; - m_resp.Status = System.Net.HttpStatusCode.OK; - } - - public void OutputOK(object result = null) - { - SetOK(); - WriteJsonObject(result ?? SUCCESS_RESPONSE); - } - - public void WriteJsonObject(object o) - { - if (!m_resp.HeadersSent) - m_resp.ContentType = "application/json"; - - Task.Run(async () => { - - if (!string.IsNullOrEmpty(m_jsonp)) - { - await m_bodyStreamWriter.WriteAsync(m_jsonp); - await m_bodyStreamWriter.WriteAsync('('); - } - - var oldCulture = CultureInfo.CurrentCulture; - CultureInfo.CurrentCulture = CultureInfo.InvariantCulture; - await Serializer.SerializeJsonAsync(m_bodyStreamWriter, o, true); - CultureInfo.CurrentCulture = oldCulture; - - if (!string.IsNullOrEmpty(m_jsonp)) - { - await m_bodyStreamWriter.WriteAsync(')'); - await m_bodyStreamWriter.FlushAsync(); - } - }).GetAwaiter().GetResult(); - } - - public void Dispose() - { - Task.Run(async () => { - await DisposeAsync(); - }).GetAwaiter().GetResult(); - } - - private bool disposed = false; - public async ValueTask DisposeAsync() - { - if(disposed) return; - disposed = true; - - if (!m_resp.HeadersSent) - { - await m_bodyStreamWriter.FlushAsync(); - m_resp.ContentLength = m_bodyStreamWriter.BaseStream.Length; - m_resp.Send(); - } - await m_bodyStreamWriter.DisposeAsync(); - } - - internal void Flush() - { - Task.Run(async () => { - await m_bodyStreamWriter.FlushAsync(); - }).GetAwaiter().GetResult(); - } - - internal void Write(string v) - { - Task.Run(async () => { - await m_bodyStreamWriter.WriteAsync(v); - }).GetAwaiter().GetResult(); - } - } - -} - diff --git a/Duplicati.Library.RestAPI/WebServer/CaptchaUtil.cs b/Duplicati.Library.RestAPI/WebServer/CaptchaUtil.cs deleted file mode 100644 index 4146e2768..000000000 --- a/Duplicati.Library.RestAPI/WebServer/CaptchaUtil.cs +++ /dev/null @@ -1,133 +0,0 @@ -// 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; -using System.Linq; -using System.Drawing; -using System.Drawing.Drawing2D; -using System.Drawing.Text; - -namespace Duplicati.Server.WebServer -{ - /// - /// Helper class for creating Captcha images - /// - public static class CaptchaUtil - { - /// - /// A lookup string with characters to use - /// - private static readonly string DEFAULT_CHARS = "ACDEFGHJKLMNPQRTUVWXY34679"; - - /// - /// A range of possible brush colors - /// - private static readonly Brush[] BRUSH_COLORS = - typeof(Brushes) - .GetProperties(System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.Public) - .Where(x => x.PropertyType == typeof(Brush)) - .Select(x => x.GetValue(null, null) as Brush) - .Where(x => x != null) - .ToArray(); - - /// - /// Approximate the size in pixels of text drawn at the given fontsize - /// - private static int ApproxTextWidth(string text, FontFamily fontfamily, int fontsize) - { - using (var font = new Font(fontfamily, fontsize, GraphicsUnit.Pixel)) - using (var graphics = Graphics.FromImage(new Bitmap(1, 1))) { - return (int) graphics.MeasureString(text, font).Width; - } - } - - /// - /// Creates a random answer. - /// - /// The random answer. - /// The list of allowed chars, supply a character multiple times to change frequency. - /// The minimum answer length. - /// The maximum answer length. - public static string CreateRandomAnswer(string allowedchars = null, int minlength = 10, int maxlength = 12) - { - allowedchars = allowedchars ?? DEFAULT_CHARS; - var rnd = new Random(); - var len = rnd.Next(Math.Min(minlength, maxlength), Math.Max(minlength, maxlength) + 1); - if (len <= 0) - throw new ArgumentException($"The values ${minlength} and ${maxlength} gave a final length of {len} and it must be greater than 0"); - - return new string(Enumerable.Range(0, len).Select(x => allowedchars[rnd.Next(0, allowedchars.Length)]).ToArray()); - } - - /// - /// Creates a captcha image. - /// - /// The captcha image. - /// The captcha solution string. - /// The size of the image, omit to get a size based on the string. - /// The size of the font used to create the captcha, in pixels. - public static Bitmap CreateCaptcha(string answer, Size size = default(Size), int fontsize = 40) - { - var fontfamily = FontFamily.GenericSansSerif; - var text_width = ApproxTextWidth(answer, fontfamily, fontsize); - if (size.Width == 0 || size.Height == 0) - size = new Size((int) (text_width * 1.2), (int) (fontsize * 1.2)); - - var bmp = new Bitmap(size.Width, size.Height); - var rnd = new Random(); - var stray_x = fontsize / 2; - var stray_y = size.Height / 4; - var ans_stray_x = fontsize / 3; - var ans_stray_y = size.Height / 6; - using (var graphics = Graphics.FromImage(bmp)) - using (var font1 = new Font(fontfamily, fontsize, GraphicsUnit.Pixel)) - using (var font2 = new Font(fontfamily, fontsize, GraphicsUnit.Pixel)) - using (var font3 = new HatchBrush(HatchStyle.Shingle, Color.GhostWhite, Color.DarkBlue)) - { - graphics.Clear(Color.White); - graphics.TextRenderingHint = TextRenderingHint.AntiAlias; - - // Apply a some background string to make it hard to do OCR - foreach (var color in new[] { Color.Yellow, Color.LightGreen, Color.GreenYellow }) - using (var brush = new SolidBrush(color)) - graphics.DrawString(CreateRandomAnswer(minlength: answer.Length, maxlength: answer.Length), font2, brush, rnd.Next(-stray_x, stray_x), rnd.Next(-stray_y, stray_y)); - - - var spacing = (size.Width / fontsize) + rnd.Next(0, stray_x); - - // Create a vertical background lines - for (var i = rnd.Next(0, stray_x); i < size.Width; i += spacing) - using (var pen = new Pen(BRUSH_COLORS[rnd.Next(0, BRUSH_COLORS.Length)])) - graphics.DrawLine(pen, i + rnd.Next(-stray_x, stray_x), rnd.Next(0, stray_y), i + rnd.Next(-stray_x, stray_x), size.Height - rnd.Next(0, stray_y)); - - spacing = (size.Height / fontsize) + rnd.Next(0, stray_y); - // Create a horizontal background lines - for (var i = rnd.Next(0, stray_y); i < size.Height; i += spacing) - using (var pen = new Pen(BRUSH_COLORS[rnd.Next(0, BRUSH_COLORS.Length)])) - graphics.DrawLine(pen, rnd.Next(0, stray_x), i + rnd.Next(-stray_y, stray_y), size.Width - rnd.Next(0, stray_x), i + rnd.Next(-stray_y, stray_y)); - - // Draw the actual answer - graphics.DrawString(answer, font1, font3, ((size.Width - text_width) / 2) + rnd.Next(-ans_stray_x, ans_stray_x), ((size.Height - fontsize) / 2) + rnd.Next(-ans_stray_y, ans_stray_y)); - - return bmp; - } - } - } -} diff --git a/Duplicati.Library.RestAPI/WebServer/IndexHtmlHandler.cs b/Duplicati.Library.RestAPI/WebServer/IndexHtmlHandler.cs deleted file mode 100644 index fe6c70478..000000000 --- a/Duplicati.Library.RestAPI/WebServer/IndexHtmlHandler.cs +++ /dev/null @@ -1,82 +0,0 @@ -// 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; -using System.Linq; -using HttpServer; -using HttpServer.HttpModules; -using HttpServer.Exceptions; -using Duplicati.Library.Common.IO; - -namespace Duplicati.Server.WebServer -{ - internal class IndexHtmlHandler : HttpModule - { - private readonly string m_webroot; - - private static readonly string[] ForbiddenChars = new string[] {"\\", "..", ":"}.Union(from n in System.IO.Path.GetInvalidPathChars() select n.ToString()).Distinct().ToArray(); - private static readonly string DirSep = Util.DirectorySeparatorString; - - public IndexHtmlHandler(string webroot) { m_webroot = webroot; } - - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - var path = this.GetPath(request.Uri); - var html = System.IO.Path.Combine(path, "index.html"); - var htm = System.IO.Path.Combine(path, "index.htm"); - - if (System.IO.Directory.Exists(path) && (System.IO.File.Exists(html) || System.IO.File.Exists(htm))) - { - if (!request.Uri.AbsolutePath.EndsWith("/", StringComparison.Ordinal)) - { - response.Redirect(request.Uri.AbsolutePath + "/"); - return true; - } - - response.Status = System.Net.HttpStatusCode.OK; - response.Reason = "OK"; - response.ContentType = "text/html; charset=utf-8"; - response.AddHeader("Cache-Control", "no-cache, no-store, must-revalidate, max-age=0"); - - using (var fs = System.IO.File.OpenRead(System.IO.File.Exists(html) ? html : htm)) - { - response.ContentLength = fs.Length; - response.Body = fs; - response.Send(); - } - - return true; - } - - return false; - } - - private string GetPath(Uri uri) - { - if (ForbiddenChars.Any(x => uri.AbsolutePath.Contains(x))) - throw new BadRequestException("Illegal path"); - var uripath = Uri.UnescapeDataString(uri.AbsolutePath); - while(uripath.Length > 0 && (uripath.StartsWith("/", StringComparison.Ordinal) || uripath.StartsWith(DirSep, StringComparison.Ordinal))) - uripath = uripath.Substring(1); - return System.IO.Path.Combine(m_webroot, uripath.Replace('/', System.IO.Path.DirectorySeparatorChar)); - } - } -} - diff --git a/Duplicati.Library.RestAPI/WebServer/RESTHandler.cs b/Duplicati.Library.RestAPI/WebServer/RESTHandler.cs deleted file mode 100644 index 10c147b76..000000000 --- a/Duplicati.Library.RestAPI/WebServer/RESTHandler.cs +++ /dev/null @@ -1,263 +0,0 @@ -// 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; -using System.Collections.Concurrent; -using System.Collections.Generic; -using System.Linq; -using HttpServer.HttpModules; - -using Duplicati.Server.WebServer.RESTMethods; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer -{ - public class RESTHandler : HttpModule - { - public const string API_URI_PATH = "/api/v1"; - public static readonly int API_URI_SEGMENTS = API_URI_PATH.Split(new char[] {'/'}).Length; - - private static readonly Dictionary _modules = new Dictionary(StringComparer.OrdinalIgnoreCase); - - public static IDictionary Modules { get { return _modules; } } - - /// - /// Loads all REST modules in the Duplicati.Server.WebServer.RESTMethods namespace - /// - static RESTHandler() - { - var lst = - from n in typeof(IRESTMethod).Assembly.GetTypes() - where - n.Namespace == typeof(IRESTMethod).Namespace - && - typeof(IRESTMethod).IsAssignableFrom(n) - && - !n.IsAbstract - && - !n.IsInterface - select n; - - foreach(var t in lst) - { - var m = (IRESTMethod)Activator.CreateInstance(t); - _modules.Add(t.Name.ToLowerInvariant(), m); - } - } - - public static void HandleControlCGI(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session, Type module) - { - var method = request.Method; - if (!string.IsNullOrWhiteSpace(request.Headers["X-HTTP-Method-Override"])) - method = request.Headers["X-HTTP-Method-Override"]; - - DoProcess(request, response, session, method, module.Name.ToLowerInvariant(), (String.Equals(request.Method, "POST", StringComparison.OrdinalIgnoreCase) ? request.Form : request.QueryString)["id"].Value); - } - - private static readonly ConcurrentDictionary _cultureCache = new ConcurrentDictionary(StringComparer.OrdinalIgnoreCase); - - private static System.Globalization.CultureInfo ParseRequestCulture(RequestInfo info) - { - // Inject the override - return ParseRequestCulture(string.Format("{0},{1}", info.Request.Headers["X-UI-Language"], info.Request.Headers["Accept-Language"])); - } - - public static System.Globalization.CultureInfo ParseDefaultRequestCulture(RequestInfo info) - { - if (info == null) - return null; - return ParseRequestCulture(info.Request.Headers["Accept-Language"]); - } - - private static System.Globalization.CultureInfo ParseRequestCulture(string acceptheader) - { - acceptheader = acceptheader ?? string.Empty; - - // Lock-free read - System.Globalization.CultureInfo ci; - if (_cultureCache.TryGetValue(acceptheader, out ci)) - return ci; - - // Lock-free assignment, we might compute the value twice - return _cultureCache[acceptheader] = - // Parse headers like "Accept-Language: da, en-gb;q=0.8, en;q=0.7" - acceptheader - .Split(new[] { "," }, StringSplitOptions.RemoveEmptyEntries) - .Select(x => - { - var opts = x.Split(new[] { ";" }, StringSplitOptions.RemoveEmptyEntries); - var lang = opts.FirstOrDefault(); - var weight = - opts.Where(y => y.StartsWith("q=", StringComparison.OrdinalIgnoreCase)) - .Select(y => - { - float f; - float.TryParse(y.Substring(2), System.Globalization.NumberStyles.Float, System.Globalization.CultureInfo.InvariantCulture, out f); - return f; - }).FirstOrDefault(); - - // Set the default weight=1 - if (weight <= 0.001 && weight >= 0) - weight = 1; - - return new KeyValuePair(lang, weight); - }) - // Handle priority - .OrderByDescending(x => x.Value) - .Select(x => x.Key) - .Distinct() - // Filter invalid/unsupported items - .Where(x => !string.IsNullOrWhiteSpace(x) && Library.Localization.LocalizationService.ParseCulture(x) != null) - .Select(x => Library.Localization.LocalizationService.ParseCulture(x)) - // And get the first that works - .FirstOrDefault(); - - } - - public static void DoProcess(RequestInfo info, string method, string module, string key) - { - var ci = ParseRequestCulture(info); - - using (Library.Localization.LocalizationService.TemporaryContext(ci)) - { - try - { - if (ci != null) - info.Response.AddHeader("Content-Language", ci.Name); - - IRESTMethod mod; - _modules.TryGetValue(module, out mod); - - if (mod == null) - { - info.Response.Status = System.Net.HttpStatusCode.NotFound; - info.Response.Reason = "No such module"; - } - else if (method == HttpServer.Method.Get && mod is IRESTMethodGET get) - { - if (info.Request.Form != HttpServer.HttpForm.EmptyForm) - { - if (info.Request.QueryString == HttpServer.HttpInput.Empty) - { - var r = info.Request.GetType().GetField("_queryString", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance); - r.SetValue(info.Request, new HttpServer.HttpInput("formdata")); - } - - foreach (HttpServer.HttpInputItem v in info.Request.Form) - if (!info.Request.QueryString.Contains(v.Name)) - info.Request.QueryString.Add(v.Name, v.Value); - } - - get.GET(key, info); - } - else if (method == HttpServer.Method.Put && mod is IRESTMethodPUT put) - put.PUT(key, info); - else if (method == HttpServer.Method.Post && mod is IRESTMethodPOST post) - { - if (info.Request.Form == HttpServer.HttpForm.EmptyForm || info.Request.Form == HttpServer.HttpInput.Empty) - { - var r = info.Request.GetType().GetMethod("AssignForm", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance, null, new Type[] {typeof(HttpServer.HttpForm)}, null); - r.Invoke(info.Request, new object[] {new HttpServer.HttpForm(info.Request.QueryString)}); - } - else - { - foreach (HttpServer.HttpInputItem v in info.Request.QueryString) - if (!info.Request.Form.Contains(v.Name)) - info.Request.Form.Add(v.Name, v.Value); - } - - post.POST(key, info); - } - else if (method == HttpServer.Method.Delete && mod is IRESTMethodDELETE delete) - delete.DELETE(key, info); - else if (method == "PATCH" && mod is IRESTMethodPATCH patch) - patch.PATCH(key, info); - else - { - info.Response.Status = System.Net.HttpStatusCode.MethodNotAllowed; - info.Response.Reason = "Method is not allowed"; - } - } - catch (Exception ex) - { - FIXMEGlobal.DataConnection.LogError("", string.Format("Request for {0} gave error", info.Request.Uri), ex); - Console.WriteLine(ex); - - try - { - if (!info.Response.HeadersSent) - { - info.Response.Status = System.Net.HttpStatusCode.InternalServerError; - info.Response.Reason = "Error"; - info.Response.ContentType = "text/plain"; - - var wex = ex; - while (wex is System.Reflection.TargetInvocationException && wex.InnerException != wex) - wex = wex.InnerException; - - info.BodyWriter.WriteJsonObject(new - { - Message = wex.Message, - Type = wex.GetType().Name, -#if DEBUG - Stacktrace = wex.ToString() -#endif - }); - info.BodyWriter.Flush(); - } - } - catch (Exception flex) - { - FIXMEGlobal.DataConnection.LogError("", "Reporting error gave error", flex); - } - } - } - } - - public static void DoProcess(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session, string method, string module, string key) - { - using(var reqinfo = new RequestInfo(request, response, session)) - DoProcess(reqinfo, method, module, key); - } - - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - if (!request.Uri.AbsolutePath.StartsWith(API_URI_PATH, StringComparison.OrdinalIgnoreCase)) - return false; - - var module = request.Uri.Segments.Skip(API_URI_SEGMENTS).FirstOrDefault(); - if (string.IsNullOrWhiteSpace(module)) - module = "help"; - - module = module.Trim('/'); - - var key = string.Join("", request.Uri.Segments.Skip(API_URI_SEGMENTS + 1)).Trim('/'); - - var method = request.Method; - if (!string.IsNullOrWhiteSpace(request.Headers["X-HTTP-Method-Override"])) - method = request.Headers["X-HTTP-Method-Override"]; - - DoProcess(request, response, session, method, module, key); - - return true; - } - } -} - diff --git a/Duplicati.Library.RestAPI/WebServer/Server.cs b/Duplicati.Library.RestAPI/WebServer/Server.cs deleted file mode 100644 index c215c5ab5..000000000 --- a/Duplicati.Library.RestAPI/WebServer/Server.cs +++ /dev/null @@ -1,441 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.Linq; -using HttpServer.HttpModules; -using System.Security.Cryptography.X509Certificates; -using Duplicati.Library.Common.IO; -using Duplicati.Library.RestAPI; - -namespace Duplicati.Server.WebServer -{ - public class Server - { - /// - /// The tag used for logging - /// - private static readonly string LOGTAG = Duplicati.Library.Logging.Log.LogTagFromType(); - - /// - /// Option for changing the webroot folder - /// - public const string OPTION_WEBROOT = "webservice-webroot"; - - /// - /// Option for changing the webservice listen port - /// - public const string OPTION_PORT = "webservice-port"; - - /// - /// Option for changing the webservice listen interface - /// - public const string OPTION_INTERFACE = "webservice-interface"; - - /// - /// The default path to the web root - /// - public const string DEFAULT_OPTION_WEBROOT = "webroot"; - - /// - /// The default listening port - /// - public const int DEFAULT_OPTION_PORT = 8200; - - /// - /// Option for setting the webservice SSL certificate - /// - public const string OPTION_SSLCERTIFICATEFILE = "webservice-sslcertificatefile"; - - /// - /// Option for setting the webservice SSL certificate key - /// - public const string OPTION_SSLCERTIFICATEFILEPASSWORD = "webservice-sslcertificatepassword"; - - /// - /// The default listening interface - /// - public const string DEFAULT_OPTION_INTERFACE = "loopback"; - - /// - /// The single webserver instance - /// - private readonly HttpServer.HttpServer m_server; - - /// - /// The webserver listening port - /// - public readonly int Port; - - /// - /// A string that is sent out instead of password values - /// - public const string PASSWORD_PLACEHOLDER = "**********"; - - /// - /// Sets up the webserver and starts it - /// - /// A set of options - public Server(IDictionary options) - { - string portstring; - IEnumerable ports = null; - options.TryGetValue(OPTION_PORT, out portstring); - if (!string.IsNullOrEmpty(portstring)) - ports = - from n in portstring.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries) - where int.TryParse(n, out _) - select int.Parse(n); - - if (ports == null || !ports.Any()) - ports = new int[] { DEFAULT_OPTION_PORT }; - - string interfacestring; - System.Net.IPAddress listenInterface; - options.TryGetValue(OPTION_INTERFACE, out interfacestring); - - if (string.IsNullOrWhiteSpace(interfacestring)) - interfacestring = FIXMEGlobal.DataConnection.ApplicationSettings.ServerListenInterface; - if (string.IsNullOrWhiteSpace(interfacestring)) - interfacestring = DEFAULT_OPTION_INTERFACE; - - if (interfacestring.Trim() == "*" || interfacestring.Trim().Equals("any", StringComparison.OrdinalIgnoreCase) || interfacestring.Trim().Equals("all", StringComparison.OrdinalIgnoreCase)) - listenInterface = System.Net.IPAddress.Any; - else if (interfacestring.Trim() == "loopback") - listenInterface = System.Net.IPAddress.Loopback; - else - listenInterface = System.Net.IPAddress.Parse(interfacestring); - - string certificateFile; - options.TryGetValue(OPTION_SSLCERTIFICATEFILE, out certificateFile); - - string certificateFilePassword; - options.TryGetValue(OPTION_SSLCERTIFICATEFILEPASSWORD, out certificateFilePassword); - - X509Certificate2 cert = null; - bool certValid = false; - - if (certificateFile == null) - { - try - { - cert = FIXMEGlobal.DataConnection.ApplicationSettings.ServerSSLCertificate; - - if (cert != null) - certValid = cert.HasPrivateKey; - } - catch (Exception ex) - { - Duplicati.Library.Logging.Log.WriteWarningMessage(LOGTAG, "DefectStoredSSLCert", ex, Strings.Server.DefectSSLCertInDatabase); - } - } - else if (certificateFile.Length == 0) - { - FIXMEGlobal.DataConnection.ApplicationSettings.ServerSSLCertificate = null; - } - else - { - try - { - if (string.IsNullOrWhiteSpace(certificateFilePassword)) - cert = new X509Certificate2(certificateFile, "", X509KeyStorageFlags.Exportable); - else - cert = new X509Certificate2(certificateFile, certificateFilePassword, X509KeyStorageFlags.Exportable); - - certValid = cert.HasPrivateKey; - } - catch (Exception ex) - { - throw new Exception(Strings.Server.SSLCertificateFailure(ex.Message), ex); - } - } - - // If we are in hosted mode with no specified port, - // then try different ports - foreach (var p in ports) - try - { - // Due to the way the server is initialized, - // we cannot try to start it again on another port, - // so we create a new server for each attempt - - var server = CreateServer(options); - - if (certValid) - { - server.Start(listenInterface, p, cert, System.Security.Authentication.SslProtocols.None, null, false); - } - else - { - server.Start(listenInterface, p); - } - - m_server = server; - m_server.ServerName = string.Format("{0} v{1}", Library.AutoUpdater.AutoUpdateSettings.AppName, System.Reflection.Assembly.GetExecutingAssembly().GetName().Version); - this.Port = p; - - if (interfacestring != FIXMEGlobal.DataConnection.ApplicationSettings.ServerListenInterface) - FIXMEGlobal.DataConnection.ApplicationSettings.ServerListenInterface = interfacestring; - - if (certValid && !cert.Equals(FIXMEGlobal.DataConnection.ApplicationSettings.ServerSSLCertificate)) - FIXMEGlobal.DataConnection.ApplicationSettings.ServerSSLCertificate = cert; - - Duplicati.Library.Logging.Log.WriteInformationMessage(LOGTAG, "ServerListening", Strings.Server.StartedServer(listenInterface.ToString(), p)); - - return; - } - catch (System.Net.Sockets.SocketException) - { - } - - throw new Exception(Strings.Server.ServerStartFailure(ports)); - } - - private static void AddMimeTypes(FileModule fm) - { - fm.AddDefaultMimeTypes(); - fm.MimeTypes["htc"] = "text/x-component"; - fm.MimeTypes["json"] = "application/json"; - fm.MimeTypes["map"] = "application/json"; - fm.MimeTypes["htm"] = "text/html; charset=utf-8"; - fm.MimeTypes["html"] = "text/html; charset=utf-8"; - fm.MimeTypes["hbs"] = "application/x-handlebars-template"; - fm.MimeTypes["woff"] = "application/font-woff"; - fm.MimeTypes["woff2"] = "application/font-woff"; - } - - private static HttpServer.HttpServer CreateServer(IDictionary options) - { - HttpServer.HttpServer server = new HttpServer.HttpServer(); - - server.Add(new HostHeaderChecker()); - - if (string.Equals(Environment.GetEnvironmentVariable("SYNO_DSM_AUTH") ?? string.Empty, "1")) - server.Add(new SynologyAuthenticationHandler()); - - server.Add(new AuthenticationHandler()); - - server.Add(new RESTHandler()); - - string webroot = Library.AutoUpdater.UpdaterManager.INSTALLATIONDIR; - string install_webroot = System.IO.Path.Combine(webroot, "webroot"); - -#if DEBUG - // Easy test for extensions while debugging - install_webroot = Library.AutoUpdater.UpdaterManager.INSTALLATIONDIR; - - if (!System.IO.Directory.Exists(System.IO.Path.Combine(webroot, "webroot"))) - { - //For debug we go "../../../.." to get out of "GUI/Duplicati.GUI.TrayIcon/bin/debug" - string tmpwebroot = System.IO.Path.GetFullPath(System.IO.Path.Combine(webroot, "..", "..", "..", "..")); - tmpwebroot = System.IO.Path.Combine(tmpwebroot, "Server"); - if (System.IO.Directory.Exists(System.IO.Path.Combine(tmpwebroot, "webroot"))) - webroot = tmpwebroot; - else - { - //If we are running the server standalone, we only need to exit "bin/Debug" - tmpwebroot = System.IO.Path.GetFullPath(System.IO.Path.Combine(webroot, "..", "..")); - if (System.IO.Directory.Exists(System.IO.Path.Combine(tmpwebroot, "webroot"))) - webroot = tmpwebroot; - } - } -#endif - - webroot = System.IO.Path.Combine(webroot, "webroot"); - - if (options.ContainsKey(OPTION_WEBROOT)) - { - string userroot = options[OPTION_WEBROOT]; -#if DEBUG - //In debug mode we do not care where the path points -#else - //In release mode we check that the user supplied path is located - // in the same folders as the running application, to avoid users - // that inadvertently expose top level folders - if (!string.IsNullOrWhiteSpace(userroot) - && userroot.StartsWith(Util.AppendDirSeparator(Duplicati.Library.Utility.Utility.getEntryAssembly().Location), Library.Utility.Utility.ClientFilenameStringComparison)) -#endif - { - webroot = userroot; - install_webroot = webroot; - } - } - - if (install_webroot != webroot && System.IO.Directory.Exists(System.IO.Path.Combine(install_webroot, "customized"))) - { - var customized_files = new CacheControlFileHandler("/customized/", System.IO.Path.Combine(install_webroot, "customized")); - AddMimeTypes(customized_files); - server.Add(customized_files); - } - - if (install_webroot != webroot && System.IO.Directory.Exists(System.IO.Path.Combine(install_webroot, "oem"))) - { - var oem_files = new CacheControlFileHandler("/oem/", System.IO.Path.Combine(install_webroot, "oem")); - AddMimeTypes(oem_files); - server.Add(oem_files); - } - - if (install_webroot != webroot && System.IO.Directory.Exists(System.IO.Path.Combine(install_webroot, "package"))) - { - var proxy_files = new CacheControlFileHandler("/proxy/", System.IO.Path.Combine(install_webroot, "package")); - AddMimeTypes(proxy_files); - server.Add(proxy_files); - } - - var fh = new CacheControlFileHandler("/", webroot, true); - AddMimeTypes(fh); - server.Add(fh); - - server.Add(new IndexHtmlHandler(webroot)); -#if DEBUG - //For debugging, it is nice to know when we get a 404 - server.Add(new DebugReportHandler()); -#endif - return server; - } - - private class DebugReportHandler : HttpModule - { - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - System.Diagnostics.Trace.WriteLine(string.Format("Rejecting request for {0}", request.Uri)); - return false; - } - } - - private class CacheControlFileHandler : FileModule - { - public CacheControlFileHandler(string baseUri, string basePath, bool useLastModifiedHeader = false) - : base(baseUri, basePath, useLastModifiedHeader) - { - - } - - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - if (!this.CanHandle(request.Uri)) - return false; - - if (request.Uri.AbsolutePath.EndsWith("index.html", StringComparison.Ordinal) || request.Uri.AbsolutePath.EndsWith("index.htm", StringComparison.Ordinal)) - response.AddHeader("Cache-Control", "no-cache, no-store, must-revalidate, max-age=0"); - else - response.AddHeader("Cache-Control", "max-age=" + (60 * 60 * 24)); - return base.Process(request, response, session); - } - } - - /// - /// Module for injecting host header verification - /// - private class HostHeaderChecker : HttpModule - { - /// - /// The hostnames that we allow - /// - private string[] m_lastSplitNames; - - /// - /// The string used to generate m_lastSplitNames; - /// - private string m_lastAllowed; - - /// - /// A regex to detect potential IPv4 addresses. - /// Note that this also detects things that are not valid IPv4. - /// - private static readonly System.Text.RegularExpressions.Regex IPV4 = new System.Text.RegularExpressions.Regex(@"((\d){1,3}\.){3}(\d){1,3}"); - /// - /// A regex to detect potential IPv6 addresses. - /// Note that this also detects things that are not valid IPv6. - /// - private static readonly System.Text.RegularExpressions.Regex IPV6 = new System.Text.RegularExpressions.Regex(@"(\:)?(\:?[A-Fa-f0-9]{1,4}\:?){1,8}(\:)?"); - - /// - /// The hostnames that are always allowed - /// - private static readonly string[] DEFAULT_ALLOWED = new string[] { "localhost", "127.0.0.1", "::1", "localhost.localdomain" }; - - /// - /// Process the received request - /// - /// A flag indicating if the request is handled. - /// The received request. - /// The response object. - /// The session state. - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - string[] h = null; - var hstring = FIXMEGlobal.DataConnection.ApplicationSettings.AllowedHostnames; - - if (!string.IsNullOrWhiteSpace(hstring)) - { - h = m_lastSplitNames; - if (hstring != m_lastAllowed) - { - m_lastAllowed = hstring; - h = m_lastSplitNames = (hstring ?? string.Empty).Split(new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries); - } - - if (h == null || h.Length == 0) - h = null; - } - - // For some reason, the web server strips out the host header - var host = request.Headers["Host"]; - if (string.IsNullOrWhiteSpace(host)) - host = request.Uri.Host; - - // This should not happen - if (string.IsNullOrWhiteSpace(host)) - { - response.Reason = "Invalid request, missing host header"; - response.Status = System.Net.HttpStatusCode.Forbidden; - var msg = System.Text.Encoding.ASCII.GetBytes(response.Reason); - response.ContentType = "text/plain"; - response.ContentLength = msg.Length; - response.Body.Write(msg, 0, msg.Length); - response.Send(); - return true; - } - - // Check the hostnames we always allow - if (DEFAULT_ALLOWED.Contains(host, StringComparer.OrdinalIgnoreCase)) - return false; - - // Then the user specified ones - if (h != null && h.Contains(host, StringComparer.OrdinalIgnoreCase)) - return false; - - // Disable checks if we have an asterisk - if (h != null && Array.IndexOf(h, "*") >= 0) - return false; - - // Finally, check if we have a potential IP address - var v4 = IPV4.Match(host); - var v6 = IPV6.Match(host); - - if ((v4.Success && v4.Length == host.Length) || (v6.Success && v6.Length == host.Length)) - { - try - { - // Verify that the hostname is indeed a valid IP address - System.Net.IPAddress.Parse(host); - return false; - } - catch - { } - } - - // Failed to find a valid header - response.Reason = $"The host header sent by the client is not allowed"; - response.Status = System.Net.HttpStatusCode.Forbidden; - var txt = System.Text.Encoding.ASCII.GetBytes(response.Reason); - response.ContentType = "text/plain"; - response.ContentLength = txt.Length; - response.Body.Write(txt, 0, txt.Length); - response.Send(); - return true; - - } - } - } -} diff --git a/Duplicati.Library.RestAPI/WebServer/SynologyAuthenticationHandler.cs b/Duplicati.Library.RestAPI/WebServer/SynologyAuthenticationHandler.cs deleted file mode 100644 index cf16695e5..000000000 --- a/Duplicati.Library.RestAPI/WebServer/SynologyAuthenticationHandler.cs +++ /dev/null @@ -1,293 +0,0 @@ -// 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; -using System.Collections.Concurrent; -using System.Collections.Generic; -using System.Diagnostics; -using System.IO; -using System.Linq; -using System.Text.RegularExpressions; -using System.Threading.Tasks; -using HttpServer.HttpModules; - -namespace Duplicati.Server.WebServer -{ - /// - /// Helper class for enforcing the built-in authentication on Synology DSM - /// - public class SynologyAuthenticationHandler : HttpModule - { - /// - /// The path to the login.cgi script - /// - private readonly string LOGIN_CGI = GetEnvArg("SYNO_LOGIN_CGI", "/usr/syno/synoman/webman/login.cgi"); - /// - /// The path to the authenticate.cgi script - /// - private readonly string AUTH_CGI = GetEnvArg("SYNO_AUTHENTICATE_CGI", "/usr/syno/synoman/webman/modules/authenticate.cgi"); - /// - /// A flag indicating if only admins are allowed - /// - private readonly bool ADMIN_ONLY = !(GetEnvArg("SYNO_ALL_USERS", "0") == "1"); - /// - /// A flag indicating if the XSRF token should be fetched automatically - /// - private readonly bool AUTO_XSRF = GetEnvArg("SYNO_AUTO_XSRF", "1") == "1"; - - /// - /// A flag indicating that the auth-module is fully disabled - /// - private readonly bool FULLY_DISABLED; - - /// - /// Re-evaluate the logins periodically to ensure it is still valid - /// - private readonly TimeSpan CACHE_TIMEOUT = TimeSpan.FromMinutes(3); - - /// - /// A cache of previously authenticated logins - /// - private readonly ConcurrentDictionary m_logincache = new ConcurrentDictionary(); - - /// - /// Initializes a new instance of the class. - /// - public SynologyAuthenticationHandler() - { - Console.WriteLine("Enabling Synology integrated authentication handler"); - var disable = false; - if (!File.Exists(LOGIN_CGI)) - { - Console.WriteLine("Disabling webserver as the login script is not found: {0}", LOGIN_CGI); - disable = true; - } - if (!File.Exists(AUTH_CGI)) - { - Console.WriteLine("Disabling webserver as the auth script is not found: {0}", AUTH_CGI); - disable = true; - } - - FULLY_DISABLED = disable; - } - - /// - /// Processes the request - /// - /// true if the request is handled false otherwise. - /// The request. - /// The response. - /// The session. - public override bool Process(HttpServer.IHttpRequest request, HttpServer.IHttpResponse response, HttpServer.Sessions.IHttpSession session) - { - if (FULLY_DISABLED) - { - response.Status = System.Net.HttpStatusCode.ServiceUnavailable; - response.Reason = "The system is incorrectly configured"; - return true; - } - - var limitedAccess = - request.Uri.AbsolutePath.StartsWith(RESTHandler.API_URI_PATH, StringComparison.OrdinalIgnoreCase) - || - request.Uri.AbsolutePath.StartsWith(AuthenticationHandler.LOGIN_SCRIPT_URI, StringComparison.OrdinalIgnoreCase) - || - request.Uri.AbsolutePath.StartsWith(AuthenticationHandler.LOGOUT_SCRIPT_URI, StringComparison.OrdinalIgnoreCase); - - if (!limitedAccess) - return false; - - var tmpenv = new Dictionary(); - - tmpenv["REMOTE_ADDR"] = request.RemoteEndPoint.Address.ToString(); - tmpenv["REMOTE_PORT"] = request.RemoteEndPoint.Port.ToString(); - - if (!string.IsNullOrWhiteSpace(request.Headers["X-Real-IP"])) - tmpenv["REMOTE_ADDR"] = request.Headers["X-Real-IP"]; - if (!string.IsNullOrWhiteSpace(request.Headers["X-Real-IP"])) - tmpenv["REMOTE_PORT"] = request.Headers["X-Real-Port"]; - - var loginid = request.Cookies["id"]?.Value; - if (!string.IsNullOrWhiteSpace(loginid)) - tmpenv["HTTP_COOKIE"] = "id=" + loginid; - - var xsrftoken = request.Headers["X-Syno-Token"]; - if (string.IsNullOrWhiteSpace(xsrftoken)) - xsrftoken = request.QueryString["SynoToken"]?.Value; - - var cachestring = BuildCacheKey(tmpenv, xsrftoken); - - DateTime cacheExpires; - if (m_logincache.TryGetValue(cachestring, out cacheExpires) && cacheExpires > DateTime.Now) - { - // We do not refresh the cache, as we need to ask the synology auth system periodically - return false; - } - - if (string.IsNullOrWhiteSpace(xsrftoken) && AUTO_XSRF) - { - var authre = new Regex(@"""SynoToken""\s?\:\s?""(?[^""]+)"""); - try - { - var resp = ShellExec(LOGIN_CGI, env: tmpenv).Result; - - var m = authre.Match(resp); - if (m.Success) - xsrftoken = m.Groups["token"].Value; - else - throw new Exception("Unable to get XSRF token"); - } - catch (Exception) - { - response.Status = System.Net.HttpStatusCode.InternalServerError; - response.Reason = "The system is incorrectly configured"; - return true; - - } - } - - if (!string.IsNullOrWhiteSpace(xsrftoken)) - tmpenv["HTTP_X_SYNO_TOKEN"] = xsrftoken; - - cachestring = BuildCacheKey(tmpenv, xsrftoken); - - var username = GetEnvArg("SYNO_USERNAME"); - if (string.IsNullOrWhiteSpace(username)) - { - try - { - username = ShellExec(AUTH_CGI, shell: false, exitcode: 0, env: tmpenv).Result; - } - catch (Exception) - { - response.Status = System.Net.HttpStatusCode.InternalServerError; - response.Reason = "The system is incorrectly configured"; - return true; - } - } - - if (string.IsNullOrWhiteSpace(username)) - { - response.Status = System.Net.HttpStatusCode.Forbidden; - response.Reason = "Permission denied, not logged in"; - return true; - } - - username = username.Trim(); - - if (ADMIN_ONLY) - { - var groups = GetEnvArg("SYNO_GROUP_IDS"); - - if (string.IsNullOrWhiteSpace(groups)) - { - groups = ShellExec("id", "-G '" + username.Trim().Replace("'", "\\'") + "'", exitcode: 0).Result ?? string.Empty; - groups = groups.Replace(Environment.NewLine, String.Empty); - } - - if (!groups.Split(new char[] { ' ' }).Contains("101")) - { - response.Status = System.Net.HttpStatusCode.Forbidden; - response.Reason = "Administrator login required"; - return true; - } - } - - // We are now authenticated, add to cache - m_logincache[cachestring] = DateTime.Now + CACHE_TIMEOUT; - return false; - } - - /// - /// Builds a cache key from the environment data - /// - /// The cache key. - /// The environment. - /// The XSRF token. - private static string BuildCacheKey(Dictionary values, string xsrftoken) - { - if (!values.ContainsKey("REMOTE_ADDR") || !values.ContainsKey("REMOTE_PORT") || !values.ContainsKey("HTTP_COOKIE")) - return null; - - return string.Format("{0}:{1}/{2}?{3}", values["REMOTE_ADDR"], values["REMOTE_PORT"], values["HTTP_COOKIE"], xsrftoken); - } - - /// - /// Runs an external command - /// - /// The stdout data. - /// The executable - /// The executable and the arguments. - /// If set to true use the shell context for execution. - /// Set the value to check for a particular exitcode. - private static async Task ShellExec(string command, string args = null, bool shell = false, int exitcode = -1, Dictionary env = null) - { - var psi = new ProcessStartInfo() - { - FileName = command, - Arguments = shell ? null : args, - UseShellExecute = false, - RedirectStandardInput = shell, - RedirectStandardOutput = true, - RedirectStandardError = false - }; - - if (env != null) - foreach (var pk in env) - psi.EnvironmentVariables[pk.Key] = pk.Value; - - using (var p = System.Diagnostics.Process.Start(psi)) - { - if (shell && args != null) - await p.StandardInput.WriteLineAsync(args); - - var res = p.StandardOutput.ReadToEndAsync(); - - var tries = 10; - var ms = (int)TimeSpan.FromSeconds(0.5).TotalMilliseconds; - while (tries > 0 && !p.HasExited) - { - tries--; - p.WaitForExit(ms); - } - - if (!p.HasExited) - try { p.Kill(); } - catch { } - - if (!p.HasExited || (p.ExitCode != exitcode && exitcode != -1)) - throw new Exception(string.Format("Exit code was: {0}, stdout: {1}", p.ExitCode, res)); - return await res; - } - } - - /// - /// Gets the environment variable argument. - /// - /// The environment variable. - /// The name of the environment variable. - /// The default value. - private static string GetEnvArg(string key, string @default = null) - { - var res = Environment.GetEnvironmentVariable(key); - return string.IsNullOrWhiteSpace(res) ? @default : res.Trim(); - } - } -} diff --git a/Duplicati.Library.RestAPI/newbackup.json b/Duplicati.Library.RestAPI/newbackup.json index 3fbb3c65b..0053b721c 100644 --- a/Duplicati.Library.RestAPI/newbackup.json +++ b/Duplicati.Library.RestAPI/newbackup.json @@ -1,15 +1,15 @@ { - Backup: { - Settings: [ - {Name: "encryption-module", Value: "aes"}, - {Name: "compression-module", Value: "zip"}, - {Name: "dblock-size", Value: "50mb"}, - {Name: "keep-time", Value: ""} - ] - }, - Schedule: { - Repeat: "1D", - Time: "13:00:00", - AllowedDays: ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] - } -} \ No newline at end of file + "Backup": { + "Settings": [ + { "Name": "encryption-module", "Value": "aes" }, + { "Name": "compression-module", "Value": "zip" }, + { "Name": "dblock-size", "Value": "50mb" }, + { "Name": "keep-time", "Value": "" } + ] + }, + "Schedule": { + "Repeat": "1D", + "Time": "13:00:00", + "AllowedDays": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] + } +} diff --git a/Duplicati.sln b/Duplicati.sln index ea9134d4c..1a186da55 100644 --- a/Duplicati.sln +++ b/Duplicati.sln @@ -109,7 +109,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "net8", "net8", "{6B46F6B1-1 EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duplicati.CommandLine.AutoUpdater", "Executables\net8\Duplicati.CommandLine.AutoUpdater\Duplicati.CommandLine.AutoUpdater.csproj", "{95B7DD83-2C5A-4F1E-8EA7-39654B2B236A}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duplicati.Service", "Executables\net8\Duplicati_Service\Duplicati.Service.csproj", "{34149709-F3ED-4FB5-A087-43EB195C948B}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duplicati.Service", "Executables\net8\Duplicati.Service\Duplicati.Service.csproj", "{34149709-F3ED-4FB5-A087-43EB195C948B}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duplicati.CommandLine.BackendTester", "Executables\net8\Duplicati.CommandLine.BackendTester\Duplicati.CommandLine.BackendTester.csproj", "{2F1C0C8D-5C15-4BC0-811F-87F2C98D9790}" EndProject @@ -148,6 +148,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duplicati.Library.RestAPI", EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Duplicati.Library.Backend.AliyunOSS", "Duplicati\Library\Backend\AliyunOSS\Duplicati.Library.Backend.AliyunOSS.csproj", "{4EB3DABC-D412-4C12-8876-41A1427A389E}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Duplicati.CommandLine.SharpAESCrypt", "Executables\net8\Duplicati.CommandLine.SharpAESCrypt\Duplicati.CommandLine.SharpAESCrypt.csproj", "{FE6FD36C-E171-4599-8D55-62DA579C0864}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Duplicati.CommandLine.Snapshots", "Executables\net8\Duplicati.CommandLine.Snapshots\Duplicati.CommandLine.Snapshots.csproj", "{0364E724-1929-445E-9145-90A70B01DDC0}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -418,6 +422,14 @@ Global {4EB3DABC-D412-4C12-8876-41A1427A389E}.Debug|Any CPU.Build.0 = Debug|Any CPU {4EB3DABC-D412-4C12-8876-41A1427A389E}.Release|Any CPU.ActiveCfg = Release|Any CPU {4EB3DABC-D412-4C12-8876-41A1427A389E}.Release|Any CPU.Build.0 = Release|Any CPU + {FE6FD36C-E171-4599-8D55-62DA579C0864}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FE6FD36C-E171-4599-8D55-62DA579C0864}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FE6FD36C-E171-4599-8D55-62DA579C0864}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FE6FD36C-E171-4599-8D55-62DA579C0864}.Release|Any CPU.Build.0 = Release|Any CPU + {0364E724-1929-445E-9145-90A70B01DDC0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {0364E724-1929-445E-9145-90A70B01DDC0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {0364E724-1929-445E-9145-90A70B01DDC0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {0364E724-1929-445E-9145-90A70B01DDC0}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -471,6 +483,8 @@ Global {0F5A1F4E-25FA-4D02-920D-CA2138498081} = {6B46F6B1-1898-49B8-ADA7-5CAF68EB77E3} {6B594D23-B629-465C-B799-70EE9E56C218} = {E1A9B303-F281-45C5-A4F6-CADD9DE3F3C4} {D19A38DD-68F1-4EF5-BF5F-8966CE0D9A5B} = {FA88A246-EF8E-46E3-90AF-539B8C0A6ADE} + {FE6FD36C-E171-4599-8D55-62DA579C0864} = {6B46F6B1-1898-49B8-ADA7-5CAF68EB77E3} + {0364E724-1929-445E-9145-90A70B01DDC0} = {6B46F6B1-1898-49B8-ADA7-5CAF68EB77E3} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {8B40BAFE-D862-4397-9495-8F5EAF5CE80C} diff --git a/Duplicati/CommandLine/AutoUpdater/Duplicati.CommandLine.AutoUpdater.csproj b/Duplicati/CommandLine/AutoUpdater/Duplicati.CommandLine.AutoUpdater.csproj index 5a2137134..2bdf033a4 100644 --- a/Duplicati/CommandLine/AutoUpdater/Duplicati.CommandLine.AutoUpdater.csproj +++ b/Duplicati/CommandLine/AutoUpdater/Duplicati.CommandLine.AutoUpdater.csproj @@ -1,9 +1,10 @@ - + net8.0 Duplicati.CommandLine.AutoUpdater.Implementation Duplicati.CommandLine.AutoUpdater + Copyright © 2024 Team Duplicati, MIT license @@ -20,3 +21,4 @@ + diff --git a/Duplicati/CommandLine/BackendTester/Duplicati.CommandLine.BackendTester.csproj b/Duplicati/CommandLine/BackendTester/Duplicati.CommandLine.BackendTester.csproj index 900907483..f71a978e1 100644 --- a/Duplicati/CommandLine/BackendTester/Duplicati.CommandLine.BackendTester.csproj +++ b/Duplicati/CommandLine/BackendTester/Duplicati.CommandLine.BackendTester.csproj @@ -1,9 +1,10 @@ - + net8.0 A backend debugging tool for Duplicati Duplicati.CommandLine.BackendTester.Implementation + Copyright © 2024 Team Duplicati, MIT license @@ -27,3 +28,4 @@ + diff --git a/Duplicati/CommandLine/BackendTool/Duplicati.CommandLine.BackendTool.csproj b/Duplicati/CommandLine/BackendTool/Duplicati.CommandLine.BackendTool.csproj index f265daf71..93d68ae44 100644 --- a/Duplicati/CommandLine/BackendTool/Duplicati.CommandLine.BackendTool.csproj +++ b/Duplicati/CommandLine/BackendTool/Duplicati.CommandLine.BackendTool.csproj @@ -1,8 +1,9 @@ - + net8.0 Duplicati.CommandLine.BackendTool.Implementation + Copyright © 2024 Team Duplicati, MIT license @@ -20,3 +21,4 @@ + diff --git a/Duplicati/CommandLine/CLI/Commands.cs b/Duplicati/CommandLine/CLI/Commands.cs index f209384bc..b492520e3 100644 --- a/Duplicati/CommandLine/CLI/Commands.cs +++ b/Duplicati/CommandLine/CLI/Commands.cs @@ -134,13 +134,15 @@ namespace Duplicati.CommandLine public static int Examples(TextWriter outwriter, Action setup, List args, Dictionary options, Library.Utility.IFilter filter) { - Duplicati.CommandLine.Help.PrintUsage(outwriter, "example", options); + using (new Duplicati.Library.Main.LocaleChange(options)) + Duplicati.CommandLine.Help.PrintUsage(outwriter, "example", options); return 0; } public static int Help(TextWriter outwriter, Action setup, List args, Dictionary options, Library.Utility.IFilter filter) { - Duplicati.CommandLine.Help.PrintUsage(outwriter, args.Count > 1? args[1] : "help", options); + using (new Duplicati.Library.Main.LocaleChange(options)) + Duplicati.CommandLine.Help.PrintUsage(outwriter, args.Count > 1 ? args[1] : "help", options); return 0; } @@ -175,8 +177,8 @@ namespace Duplicati.CommandLine options["no-encryption"] = "true"; } - using(var console = new ConsoleOutput(outwriter, options)) - using(var i = new Library.Main.Controller(backend, options, console)) + using (var console = new ConsoleOutput(outwriter, options)) + using (var i = new Library.Main.Controller(backend, options, console)) { setup(i); i.ListAffected(args, res => @@ -259,7 +261,7 @@ namespace Duplicati.CommandLine if (!containsSeparators && arg.StartsWith("@", StringComparison.Ordinal)) { // Convert to Regexp filter and prefix with ".*/" - return $"[.*{Utility.ConvertLiteralToRegExp(Util.DirectorySeparatorString + arg.Substring(1))}]"; + return $"[.*{Library.Utility.Utility.ConvertLiteralToRegExp(Util.DirectorySeparatorString + arg.Substring(1))}]"; } else if (!containsSeparators && !containsWildcards && !arg.StartsWith("[", StringComparison.Ordinal)) { @@ -290,7 +292,7 @@ namespace Duplicati.CommandLine if (endsWithSeparator && arg.StartsWith("@", StringComparison.Ordinal)) { // Convert to Regexp filter and suffix with ".*" - return $"[{Utility.ConvertLiteralToRegExp(arg.Substring(1))}.*]"; + return $"[{Library.Utility.Utility.ConvertLiteralToRegExp(arg.Substring(1))}.*]"; } else if (endsWithSeparator && !containsWildcards && !arg.StartsWith("[", StringComparison.Ordinal)) { @@ -324,7 +326,7 @@ namespace Duplicati.CommandLine filter = new Duplicati.Library.Utility.FilterExpression(); using (var console = new ConsoleOutput(outwriter, options)) - using(var i = new Library.Main.Controller(args[0], options, console)) + using (var i = new Library.Main.Controller(args[0], options, console)) { setup(i); var backend = args[0]; @@ -412,7 +414,7 @@ namespace Duplicati.CommandLine { outwriter.WriteLine("Listing filesets:"); - foreach(var e in res.Filesets) + foreach (var e in res.Filesets) { if (e.FileCount >= 0) outwriter.WriteLine("{0}\t: {1} ({2} files, {3})", e.Version, e.Time, e.FileCount, Library.Utility.Utility.FormatSizeString(e.FileSizes)); @@ -444,10 +446,10 @@ namespace Duplicati.CommandLine else { outwriter.WriteLine("Listing files and versions:"); - foreach(var e in res.Files) + foreach (var e in res.Files) { outwriter.WriteLine(e.Path); - foreach(var nx in res.Filesets.Zip(e.Sizes, (a, b) => new { Index = a.Version, Time = a.Time, Size = b } )) + foreach (var nx in res.Filesets.Zip(e.Sizes, (a, b) => new { Index = a.Version, Time = a.Time, Size = b })) outwriter.WriteLine("{0}\t: {1} {2}", nx.Index, nx.Time, nx.Size < 0 ? " - " : Library.Utility.Utility.FormatSizeString(nx.Size)); outwriter.WriteLine(); @@ -471,7 +473,7 @@ namespace Duplicati.CommandLine } using (var console = new ConsoleOutput(outwriter, options)) - using(var i = new Library.Main.Controller(args[0], options, console)) + using (var i = new Library.Main.Controller(args[0], options, console)) { setup(i); args.RemoveAt(0); @@ -488,7 +490,7 @@ namespace Duplicati.CommandLine else outwriter.WriteLine(Strings.Program.DeletedBackups); - foreach(var f in res.DeletedSets) + foreach (var f in res.DeletedSets) outwriter.WriteLine("{0}: {1}", f.Item1, f.Item2); } } @@ -525,7 +527,7 @@ namespace Duplicati.CommandLine args = SuffixArgsWithAsterisk(PrefixArgsWithAsterisk(args)).ToList(); - using(var output = new ConsoleOutput(outwriter, options)) + using (var output = new ConsoleOutput(outwriter, options)) using (var i = new Library.Main.Controller(backend, options, output)) { output.MessageEvent(string.Format("Restore started at {0}", DateTime.Now)); @@ -717,7 +719,7 @@ namespace Duplicati.CommandLine if (args.Count != 1) return PrintWrongNumberOfArguments(outwriter, args, 1); - using(var console = new ConsoleOutput(outwriter, options)) + using (var console = new ConsoleOutput(outwriter, options)) using (var i = new Library.Main.Controller(args[0], options, console)) { setup(i); @@ -766,7 +768,7 @@ namespace Duplicati.CommandLine } else { - foreach(var n in result.Verifications) + foreach (var n in result.Verifications) { var changecount = n.Value.Count(); if (changecount == 0) @@ -1001,7 +1003,7 @@ namespace Duplicati.CommandLine } using (var console = new ConsoleOutput(outwriter, options)) - using(var i = new Library.Main.Controller("dummy://", options, console)) + using (var i = new Library.Main.Controller("dummy://", options, console)) { setup(i); var result = i.TestFilter(args.ToArray(), filter); diff --git a/Duplicati/CommandLine/CLI/Duplicati.CommandLine.csproj b/Duplicati/CommandLine/CLI/Duplicati.CommandLine.csproj index 7b6f5b54f..96f680beb 100644 --- a/Duplicati/CommandLine/CLI/Duplicati.CommandLine.csproj +++ b/Duplicati/CommandLine/CLI/Duplicati.CommandLine.csproj @@ -1,10 +1,11 @@ - + net8.0 A commandline version of Duplicati Duplicati.CommandLine.Implementation TrayWarning.ico + Copyright © 2024 Team Duplicati, MIT license @@ -34,4 +35,4 @@ - \ No newline at end of file + diff --git a/Duplicati/CommandLine/CLI/Help.cs b/Duplicati/CommandLine/CLI/Help.cs index 528788ccf..e5a3e51ae 100644 --- a/Duplicati/CommandLine/CLI/Help.cs +++ b/Duplicati/CommandLine/CLI/Help.cs @@ -33,18 +33,17 @@ namespace Duplicati.CommandLine public static class Help { private static readonly Dictionary _document; - private const string RESOURCE_NAME = "Duplicati.CommandLine.help.txt"; + private const string RESOURCE_NAME = "help.txt"; private static readonly System.Text.RegularExpressions.Regex NAMEDOPTION_REGEX = new System.Text.RegularExpressions.Regex("\\%OPTION\\:(?[^\\%]+)\\%"); static Help() { - _document = new Dictionary(StringComparer.OrdinalIgnoreCase); - - using (System.IO.StreamReader sr = new System.IO.StreamReader(System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream(RESOURCE_NAME))) + _document = new Dictionary(StringComparer.OrdinalIgnoreCase); + using (var sr = new StreamReader(System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream(typeof(Help), RESOURCE_NAME))) { List keywords = new List(); StringBuilder sb = new StringBuilder(); - foreach(var line in sr.ReadToEnd().Split(new string[] { "\r\n", "\n", "\r" }, StringSplitOptions.None)) + foreach (var line in sr.ReadToEnd().Split(new string[] { "\r\n", "\n", "\r" }, StringSplitOptions.None)) { if (line.Trim().StartsWith("#", StringComparison.Ordinal)) continue; @@ -54,14 +53,14 @@ namespace Duplicati.CommandLine if (sb.Length > 0) { string s = sb.ToString(); - foreach(var k in keywords) + foreach (var k in keywords) _document[k] = s; keywords.Clear(); sb.Clear(); } - string[] elems = line.Split(new string[] {" ", "\t"}, StringSplitOptions.RemoveEmptyEntries); + string[] elems = line.Split(new string[] { " ", "\t" }, StringSplitOptions.RemoveEmptyEntries); if (elems.Length >= 2 && string.Equals(elems[elems.Length - 2], "help", StringComparison.OrdinalIgnoreCase)) keywords.Add(elems[elems.Length - 1]); else if (elems.Length == 3 && string.Equals(elems[elems.Length - 1], "help", StringComparison.OrdinalIgnoreCase)) @@ -76,7 +75,7 @@ namespace Duplicati.CommandLine if (sb.Length > 0) { string s = sb.ToString(); - foreach(var k in keywords) + foreach (var k in keywords) _document[k] = s; } } @@ -116,13 +115,14 @@ namespace Duplicati.CommandLine string tp = _document[topic]; Library.Main.Options opts = new Library.Main.Options(new Dictionary()); + tp = tp.Replace("%CLI_EXE%", PackageHelper.GetExecutableName(PackageHelper.NamedExecutable.CommandLine)); tp = tp.Replace("%VERSION%", License.VersionNumbers.Version); tp = tp.Replace("%BACKENDS%", string.Join(", ", Library.DynamicLoader.BackendLoader.Keys)); tp = tp.Replace("%APP_PATH%", Path.Combine(UpdaterManager.INSTALLATIONDIR, PackageHelper.GetExecutableName(PackageHelper.NamedExecutable.CommandLine))); tp = tp.Replace("%PATH_SEPARATOR%", System.IO.Path.PathSeparator.ToString()); - tp = tp.Replace("%EXAMPLE_SOURCE_PATH%", Platform.IsClientPosix ? "/source" : @"D:\source"); - tp = tp.Replace("%EXAMPLE_SOURCE_FILE%", Platform.IsClientPosix ? "/source/myfile.txt" : @"D:\source\file.txt"); - tp = tp.Replace("%EXAMPLE_RESTORE_PATH%", Platform.IsClientPosix ? "/restore" : @"D:\restore"); + tp = tp.Replace("%EXAMPLE_SOURCE_PATH%", !OperatingSystem.IsWindows() ? "/source" : @"D:\source"); + tp = tp.Replace("%EXAMPLE_SOURCE_FILE%", !OperatingSystem.IsWindows() ? "/source/myfile.txt" : @"D:\source\file.txt"); + tp = tp.Replace("%EXAMPLE_RESTORE_PATH%", !OperatingSystem.IsWindows() ? "/restore" : @"D:\restore"); tp = tp.Replace("%ENCRYPTIONMODULES%", string.Join(", ", Library.DynamicLoader.EncryptionLoader.Keys)); tp = tp.Replace("%COMPRESSIONMODULES%", string.Join(", ", Library.DynamicLoader.CompressionLoader.Keys)); tp = tp.Replace("%DEFAULTENCRYPTIONMODULE%", opts.EncryptionModule); @@ -132,7 +132,7 @@ namespace Duplicati.CommandLine tp = tp.Replace("%FILTER_GROUPS_SHORT%", string.Join(Environment.NewLine + " ", metaGroupNames.Concat(Enum.GetNames(typeof(FilterGroup)).Except(metaGroupNames, StringComparer.OrdinalIgnoreCase).OrderBy(x => x, StringComparer.OrdinalIgnoreCase)).Select(group => "{" + group + "}"))); tp = tp.Replace("%FILTER_GROUPS_LONG%", Library.Utility.FilterGroups.GetOptionDescriptions(4, true)); - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) { // These properties are only valid for Windows tp = tp.Replace("%EXAMPLE_WILDCARD_DRIVE_SOURCE_PATH%", @"*:\source"); @@ -205,7 +205,7 @@ namespace Duplicati.CommandLine tp = tp.Replace("%ALLOPTIONS%", string.Join(Environment.NewLine, lines.ToArray())); } - + if (tp.Contains("%MODULEOPTIONS%")) { //Figure out which module we are in @@ -261,7 +261,7 @@ namespace Duplicati.CommandLine } if (NAMEDOPTION_REGEX.IsMatch(tp)) - tp = NAMEDOPTION_REGEX.Replace(tp, new Matcher().MathEvaluator); + tp = NAMEDOPTION_REGEX.Replace(tp, new Matcher().MathEvaluator); PrintFormatted(outwriter, tp.Split(new string[] { Environment.NewLine }, StringSplitOptions.None)); } @@ -398,15 +398,15 @@ namespace Duplicati.CommandLine private static void PrintFormatted(TextWriter outwriter, IEnumerable lines) { int windowWidth = 80; - - try + + try { // This can go wrong if we have no attached console if (outwriter == Console.Out) - windowWidth = Math.Max(12, Console.WindowWidth == 0 ? 80 : Console.WindowWidth); + windowWidth = Math.Max(12, Console.WindowWidth == 0 ? 80 : Console.WindowWidth); } catch { } - + foreach (string s in lines) { if (string.IsNullOrEmpty(s) || s.Trim().Length == 0) @@ -472,7 +472,7 @@ namespace Duplicati.CommandLine foreach (Duplicati.Library.Interface.IGenericModule mod in Library.DynamicLoader.GenericLoader.Modules) if (mod.SupportedCommands != null) foundArgs.Add(mod.SupportedCommands); - + foreach (IEnumerable arglst in foundArgs) if (arglst != null) { @@ -510,7 +510,7 @@ namespace Duplicati.CommandLine return ""; List lines = new List(); - foreach(Duplicati.Library.Interface.ICommandLineArgument arg in args) + foreach (Duplicati.Library.Interface.ICommandLineArgument arg in args) if (!arg.Deprecated) lines.Add(PrintArgSimple(arg, arg.Name)); diff --git a/Duplicati/CommandLine/CLI/Strings.cs b/Duplicati/CommandLine/CLI/Strings.cs index 8ae82ce50..5ab5f4c56 100644 --- a/Duplicati/CommandLine/CLI/Strings.cs +++ b/Duplicati/CommandLine/CLI/Strings.cs @@ -20,8 +20,10 @@ // DEALINGS IN THE SOFTWARE. using Duplicati.Library.Localization.Short; -namespace Duplicati.CommandLine.Strings { - internal static class Program { +namespace Duplicati.CommandLine.Strings +{ + internal static class Program + { public static string DeleteCommandNeedsOptions(string commandname, string[] options) { return LC.L(@"The command {0} needs at least one of the following options set: {1}", commandname, string.Join(", ", options)); } public static string WrongNumberOfCommandsError_v2(int actualcommands, int expectedcommands, string[] commands) { return LC.L(@"Found {0} commands but expected {1}, commands: {2}", actualcommands, expectedcommands, string.Join(System.Environment.NewLine, commands ?? new string[0])); } @@ -47,13 +49,12 @@ namespace Duplicati.CommandLine.Strings { public static string IncludeShort { get { return LC.L(@"Include files"); } } public static string ExcludeLong { get { return LC.L(@"Exclude files that match this filter. The special character * means any number of character, and the special character ? means any single character, use *.txt to exclude all files with a txt extension. Regular expressions are also supported and can be supplied by using hard braces, i.e. [.*\.txt]. Filter groups (which encapsulate a built-in set of well-known files and folders) can be specified by using curly braces, i.e. {{TemporaryFiles}}."); } } public static string ExcludeShort { get { return LC.L(@"Exclude files"); } } - public static string ControlFilesOptionShort { get { return LC.L(@"If this option is used with a backup operation, it is interpreted as a list of files to add to the filesets. When used with list or restore, it will list or restore the control files instead of the normal files."); } } - public static string ControlFilesOptionLong { get { return LC.L(@"Use control files"); } } + public static string ControlFilesOptionShort { get { return LC.L(@"Use control files"); } } + public static string ControlFilesOptionLong { get { return LC.L(@"If this option is used with a backup operation, it is interpreted as a list of files to add to the filesets. When used with list or restore, it will list or restore the control files instead of the normal files."); } } public static string QuietConsoleOptionLong { get { return LC.L(@"If this option is set, progress reports and other messages that would normally go to the console will be redirected to the log."); } } public static string QuietConsoleOptionShort { get { return LC.L(@"Disable console output"); } } public static string SkippingSourceArgumentsOnNonBackupOperation { get { return @"The --source argument was specified in the parameter file, but the current operation is not a backup operation, so the argument is ignored"; } } - - + // ReSharper disable once UnusedMember.Global // This is a placeholder message that is intended to be used with the code // for each error and log message. The idea is that the commandline will diff --git a/Duplicati/CommandLine/CLI/help.txt b/Duplicati/CommandLine/CLI/help.txt index d282b71ca..8b4bea26b 100644 --- a/Duplicati/CommandLine/CLI/help.txt +++ b/Duplicati/CommandLine/CLI/help.txt @@ -9,14 +9,14 @@ > duplicati.commandline.exe > duplicati.commandline.exe help -See duplicati.commandline.exe help for more information. +See %CLI_EXE% help for more information. General: example, changelog Commands: backup, find, restore, delete, compact, test, compare, purge, vacuum Repair: repair, affected, list-broken-files, purge-broken-files Debug: debug, logging, create-report, test-filters, system-info, send-mail Targets: %BACKENDS% Modules: %ENCRYPTIONMODULES%, %COMPRESSIONMODULES%, %GENERICMODULES% - Formats: date, time, size, encryption, compression + Formats: date, time, size, decimal, encryption, compression Advanced: mail, advanced, returncodes, filter, filter-groups, None, - + /// /// Stores only block lookup information in the index files /// Lookup, - + /// /// Stores both block lookup and block lists in the index files /// Full - + } private static readonly string DEFAULT_COMPRESSED_EXTENSION_FILE = System.IO.Path.Combine(Duplicati.Library.AutoUpdater.UpdaterManager.INSTALLATIONDIR, "default_compressed_extensions.txt"); @@ -291,13 +290,13 @@ namespace Duplicati.Library.Main new CommandLineArgument("asynchronous-upload-limit", CommandLineArgument.ArgumentType.Integer, Strings.Options.AsynchronousuploadlimitShort, Strings.Options.AsynchronousuploadlimitLong, "4"), new CommandLineArgument("asynchronous-concurrent-upload-limit", CommandLineArgument.ArgumentType.Integer, Strings.Options.AsynchronousconcurrentuploadlimitShort, Strings.Options.AsynchronousconcurrentuploadlimitLong, "4"), new CommandLineArgument("asynchronous-upload-folder", CommandLineArgument.ArgumentType.Path, Strings.Options.AsynchronousuploadfolderShort, Strings.Options.AsynchronousuploadfolderLong, System.IO.Path.GetTempPath()), - + new CommandLineArgument("disable-streaming-transfers", CommandLineArgument.ArgumentType.Boolean, Strings.Options.DisableStreamingShort, Strings.Options.DisableStreamingLong, "false"), new CommandLineArgument("throttle-upload", CommandLineArgument.ArgumentType.Size, Strings.Options.ThrottleuploadShort, Strings.Options.ThrottleuploadLong, "0kb"), new CommandLineArgument("throttle-download", CommandLineArgument.ArgumentType.Size, Strings.Options.ThrottledownloadShort, Strings.Options.ThrottledownloadLong, "0kb"), new CommandLineArgument("skip-files-larger-than", CommandLineArgument.ArgumentType.Size, Strings.Options.SkipfileslargerthanShort, Strings.Options.SkipfileslargerthanLong), - + new CommandLineArgument("upload-unchanged-backups", CommandLineArgument.ArgumentType.Boolean, Strings.Options.UploadUnchangedBackupsShort, Strings.Options.UploadUnchangedBackupsLong, "false"), new CommandLineArgument("snapshot-policy", CommandLineArgument.ArgumentType.Enumeration, Strings.Options.SnapshotpolicyShort, Strings.Options.SnapshotpolicyLong, "off", null, Enum.GetNames(typeof(OptimizationStrategy))), @@ -332,6 +331,7 @@ namespace Duplicati.Library.Main new CommandLineArgument("quota-size", CommandLineArgument.ArgumentType.Size, Strings.Options.QuotasizeShort, Strings.Options.QuotasizeLong), new CommandLineArgument("quota-warning-threshold", CommandLineArgument.ArgumentType.Integer, Strings.Options.QuotaWarningThresholdShort, Strings.Options.QuotaWarningThresholdLong, DEFAULT_QUOTA_WARNING_THRESHOLD.ToString()), + new CommandLineArgument("quota-disable", CommandLineArgument.ArgumentType.Boolean, Strings.Options.QuotaDisableShort, Strings.Options.QuotaDisableLong("quota-size"), "false"), new CommandLineArgument("symlink-policy", CommandLineArgument.ArgumentType.Enumeration, Strings.Options.SymlinkpolicyShort, Strings.Options.SymlinkpolicyLong("store", "ignore", "follow"), Enum.GetName(typeof(SymlinkStrategy), SymlinkStrategy.Store), null, Enum.GetNames(typeof(SymlinkStrategy))), new CommandLineArgument("hardlink-policy", CommandLineArgument.ArgumentType.Enumeration, Strings.Options.HardlinkpolicyShort, Strings.Options.HardlinkpolicyLong("first", "all", "none"), Enum.GetName(typeof(HardlinkStrategy), HardlinkStrategy.All), null, Enum.GetNames(typeof(HardlinkStrategy))), @@ -363,7 +363,7 @@ namespace Duplicati.Library.Main new CommandLineArgument("index-file-policy", CommandLineArgument.ArgumentType.Enumeration, Strings.Options.IndexfilepolicyShort, Strings.Options.IndexfilepolicyLong, IndexFileStrategy.Full.ToString(), null, Enum.GetNames(typeof(IndexFileStrategy))), new CommandLineArgument("no-backend-verification", CommandLineArgument.ArgumentType.Boolean, Strings.Options.NobackendverificationShort, Strings.Options.NobackendverificationLong, "false"), new CommandLineArgument("backup-test-samples", CommandLineArgument.ArgumentType.Integer, Strings.Options.BackendtestsamplesShort, Strings.Options.BackendtestsamplesLong("no-backend-verification"), "1"), - new CommandLineArgument("backup-test-percentage", CommandLineArgument.ArgumentType.Integer, Strings.Options.BackendtestpercentageShort, Strings.Options.BackendtestpercentageLong, "0"), + new CommandLineArgument("backup-test-percentage", CommandLineArgument.ArgumentType.Decimal, Strings.Options.BackendtestpercentageShort, Strings.Options.BackendtestpercentageLong, "0.1"), new CommandLineArgument("full-remote-verification", CommandLineArgument.ArgumentType.Enumeration, Strings.Options.FullremoteverificationShort, Strings.Options.FullremoteverificationLong("no-backend-verification"), Enum.GetName(typeof(RemoteTestStrategy), RemoteTestStrategy.False), null, Enum.GetNames(typeof(RemoteTestStrategy))), new CommandLineArgument("dry-run", CommandLineArgument.ArgumentType.Boolean, Strings.Options.DryrunShort, Strings.Options.DryrunLong, "false", new string[] { "dryrun" }), @@ -375,7 +375,7 @@ namespace Duplicati.Library.Main new CommandLineArgument("small-file-size", CommandLineArgument.ArgumentType.Size, Strings.Options.SmallfilesizeShort, Strings.Options.SmallfilesizeLong), new CommandLineArgument("small-file-max-count", CommandLineArgument.ArgumentType.Integer, Strings.Options.SmallfilemaxcountShort, Strings.Options.SmallfilemaxcountLong, DEFAULT_SMALL_FILE_MAX_COUNT.ToString()), - new CommandLineArgument("patch-with-local-blocks", CommandLineArgument.ArgumentType.Boolean, Strings.Options.PatchwithlocalblocksShort, Strings.Options.PatchwithlocalblocksLong, "false"), + new CommandLineArgument("patch-with-local-blocks", CommandLineArgument.ArgumentType.Boolean, Strings.Options.PatchwithlocalblocksShort, Strings.Options.PatchwithlocalblocksLong, "false", null, null, Strings.Options.PatchwithlocalblocksDeprecated("restore-with-local-blocks")), new CommandLineArgument("no-local-db", CommandLineArgument.ArgumentType.Boolean, Strings.Options.NolocaldbShort, Strings.Options.NolocaldbLong, "false"), new CommandLineArgument("dont-compress-restore-paths", CommandLineArgument.ArgumentType.Boolean, Strings.Options.DontcompressrestorepathsShort, Strings.Options.DontcompressrestorepathsLong, "false"), @@ -384,7 +384,8 @@ namespace Duplicati.Library.Main new CommandLineArgument("retention-policy", CommandLineArgument.ArgumentType.String, Strings.Options.RetentionPolicyShort, Strings.Options.RetentionPolicyLong), new CommandLineArgument("upload-verification-file", CommandLineArgument.ArgumentType.Boolean, Strings.Options.UploadverificationfileShort, Strings.Options.UploadverificationfileLong, "false"), new CommandLineArgument("allow-passphrase-change", CommandLineArgument.ArgumentType.Boolean, Strings.Options.AllowpassphrasechangeShort, Strings.Options.AllowpassphrasechangeLong, "false"), - new CommandLineArgument("no-local-blocks", CommandLineArgument.ArgumentType.Boolean, Strings.Options.NolocalblocksShort, Strings.Options.NolocalblocksLong, "false"), + new CommandLineArgument("no-local-blocks", CommandLineArgument.ArgumentType.Boolean, Strings.Options.NolocalblocksShort, Strings.Options.NolocalblocksLong, "false", null, null, Strings.Options.NolocalblocksDeprecated("restore-with-local-blocks")), + new CommandLineArgument("restore-with-local-blocks", CommandLineArgument.ArgumentType.Boolean, Strings.Options.RestorewithlocalblocksShort, Strings.Options.RestorewithlocalblocksLong, "false"), new CommandLineArgument("full-block-verification", CommandLineArgument.ArgumentType.Boolean, Strings.Options.FullblockverificationShort, Strings.Options.FullblockverificationLong, "false"), new CommandLineArgument("allow-full-removal", CommandLineArgument.ArgumentType.Boolean, Strings.Options.AllowfullremovalShort, Strings.Options.AllowfullremovalLong, "false"), @@ -400,7 +401,7 @@ namespace Duplicati.Library.Main new CommandLineArgument("concurrency-max-threads", CommandLineArgument.ArgumentType.Integer, Strings.Options.ConcurrencymaxthreadsShort, Strings.Options.ConcurrencymaxthreadsLong, "0"), new CommandLineArgument("concurrency-block-hashers", CommandLineArgument.ArgumentType.Integer, Strings.Options.ConcurrencyblockhashersShort, Strings.Options.ConcurrencyblockhashersLong, DEFAULT_BLOCK_HASHERS.ToString()), new CommandLineArgument("concurrency-compressors", CommandLineArgument.ArgumentType.Integer, Strings.Options.ConcurrencycompressorsShort, Strings.Options.ConcurrencycompressorsLong, DEFAULT_COMPRESSORS.ToString()), - + new CommandLineArgument("auto-vacuum", CommandLineArgument.ArgumentType.Boolean, Strings.Options.AutoVacuumShort, Strings.Options.AutoVacuumLong, "false"), new CommandLineArgument("disable-file-scanner", CommandLineArgument.ArgumentType.Boolean, Strings.Options.DisablefilescannerShort, Strings.Options.DisablefilescannerLong, "false"), new CommandLineArgument("disable-filelist-consistency-checks", CommandLineArgument.ArgumentType.Boolean, Strings.Options.DisablefilelistconsistencychecksShort, Strings.Options.DisablefilelistconsistencychecksLong, "false"), @@ -422,7 +423,7 @@ namespace Duplicati.Library.Main /// /// Gets or sets the current main action of the instance /// - public OperationMode MainAction + public OperationMode MainAction { get { return (OperationMode)Enum.Parse(typeof(OperationMode), m_options["main-action"]); } set { m_options["main-action"] = value.ToString(); } @@ -509,7 +510,7 @@ namespace Duplicati.Library.Main return Library.Utility.Timeparser.ParseTimeInterval(m_options["time"], DateTime.Now); } } - + /// /// Gets the versions the restore or list operation is limited to /// @@ -521,23 +522,23 @@ namespace Duplicati.Library.Main m_options.TryGetValue("version", out v); if (string.IsNullOrEmpty(v)) return null; - - var versions = v.Split(new char[]{','}, StringSplitOptions.RemoveEmptyEntries); + + var versions = v.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries); if (v.Length == 0) return null; - + var res = new List(); - foreach(var n in versions) + foreach (var n in versions) if (n.Contains('-')) { //TODO: Throw errors if too many entries? - var parts = n.Split(new char[]{'-'}, StringSplitOptions.RemoveEmptyEntries).Select(x => Convert.ToInt64(x.Trim())).ToArray(); - for(var i = Math.Min(parts[0], parts[1]); i <= Math.Max(parts[0], parts[1]); i++) + var parts = n.Split(new char[] { '-' }, StringSplitOptions.RemoveEmptyEntries).Select(x => Convert.ToInt64(x.Trim())).ToArray(); + for (var i = Math.Min(parts[0], parts[1]); i <= Math.Max(parts[0], parts[1]); i++) res.Add(i); } else res.Add(Convert.ToInt64(n)); - + return res.ToArray(); } } @@ -658,7 +659,7 @@ namespace Duplicati.Library.Main m_options.TryGetValue("prefix", out v); if (!string.IsNullOrEmpty(v)) return v; - + return "duplicati"; } } @@ -674,7 +675,7 @@ namespace Duplicati.Library.Main m_options.TryGetValue("keep-versions", out v); if (string.IsNullOrEmpty(v)) return DEFAULT_KEEP_VERSIONS; - + return Math.Max(0, int.Parse(v)); } } @@ -688,7 +689,7 @@ namespace Duplicati.Library.Main { string v; m_options.TryGetValue("keep-time", out v); - + if (string.IsNullOrEmpty(v)) return new DateTime(0); @@ -706,12 +707,14 @@ namespace Duplicati.Library.Main /// public List RetentionPolicy { - get { + get + { var retentionPolicyConfig = new List(); string v; m_options.TryGetValue("retention-policy", out v); - if (string.IsNullOrEmpty(v)) { + if (string.IsNullOrEmpty(v)) + { return retentionPolicyConfig; } @@ -853,7 +856,7 @@ namespace Duplicati.Library.Main { get { - lock(m_lock) + lock (m_lock) { string v; m_options.TryGetValue("throttle-upload", out v); @@ -1071,7 +1074,7 @@ namespace Duplicati.Library.Main return value; } } - + /// /// Gets the logfile filename /// @@ -1105,7 +1108,7 @@ namespace Duplicati.Library.Main if (s.Equals(value, StringComparison.OrdinalIgnoreCase)) return (Duplicati.Library.Logging.LogMessageType)Enum.Parse(typeof(Duplicati.Library.Logging.LogMessageType), s); - if (Dryrun) + if (Dryrun) return Duplicati.Library.Logging.LogMessageType.DryRun; else return Duplicati.Library.Logging.LogMessageType.Warning; @@ -1157,9 +1160,9 @@ namespace Duplicati.Library.Main if (s.Equals(value, StringComparison.OrdinalIgnoreCase)) return (Duplicati.Library.Logging.LogMessageType)Enum.Parse(typeof(Duplicati.Library.Logging.LogMessageType), s); - if (Dryrun) + if (Dryrun) return Duplicati.Library.Logging.LogMessageType.DryRun; - else + else return Duplicati.Library.Logging.LogMessageType.Warning; } } @@ -1181,7 +1184,7 @@ namespace Duplicati.Library.Main if (!m_options.TryGetValue("exclude-files-attributes", out v)) return res; - foreach(string s in v.Split(new string[] {","}, StringSplitOptions.RemoveEmptyEntries)) + foreach (string s in v.Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries)) { System.IO.FileAttributes f; if (Enum.TryParse(s.Trim(), true, out f)) @@ -1213,7 +1216,7 @@ namespace Duplicati.Library.Main public bool Overwrite { get { return GetBool("overwrite"); } } /// - /// Gets the total size in bytes that the backend supports, returns -1 if there is no upper limit + /// Gets the total size in bytes that the backup should use, returns -1 if there is no upper limit /// public long QuotaSize { @@ -1249,6 +1252,15 @@ namespace Duplicati.Library.Main } } + /// + /// Gets a flag indicating that backup quota reported by the backend should be ignored + /// + /// This is necessary because in some cases the backend might report a wrong quota (especially with some Linux mounts). + public bool QuotaDisable + { + get { return Library.Utility.Utility.ParseBoolOption(m_options, "quota-disable"); } + } + /// /// Gets the display name of the backup /// @@ -1329,15 +1341,15 @@ namespace Duplicati.Library.Main long blocksize = Library.Utility.Sizeparser.ParseSize(tmp, "kb"); if (blocksize > int.MaxValue || blocksize < 1024) throw new ArgumentOutOfRangeException(nameof(blocksize), string.Format("The blocksize cannot be less than {0}, nor larger than {1}", 1024, int.MaxValue)); - + return (int)blocksize; } } - - /// + + /// /// Cache for the block hash size value, to avoid creating new hash instances just to get the size /// - private KeyValuePair m_cachedBlockHashSize; + private KeyValuePair m_cachedBlockHashSize; /// /// Gets the size of the blockhash in bytes. @@ -1347,10 +1359,10 @@ namespace Duplicati.Library.Main { get { - if (m_cachedBlockHashSize.Key != BlockHashAlgorithm) - m_cachedBlockHashSize = new KeyValuePair(BlockHashAlgorithm, HashFactory.HashSizeBytes(BlockHashAlgorithm)); - - return m_cachedBlockHashSize.Value; + if (m_cachedBlockHashSize.Key != BlockHashAlgorithm) + m_cachedBlockHashSize = new KeyValuePair(BlockHashAlgorithm, HashFactory.HashSizeBytes(BlockHashAlgorithm)); + + return m_cachedBlockHashSize.Value; } } @@ -1414,8 +1426,8 @@ namespace Duplicati.Library.Main return Library.Utility.Utility.ParseBoolOption(m_options, "use-block-cache"); } } - - + + /// /// Gets the compact threshold /// @@ -1447,7 +1459,7 @@ namespace Duplicati.Library.Main return Library.Utility.Sizeparser.ParseSize(v, "mb"); } } - + /// /// Gets the maximum number of small volumes /// @@ -1463,7 +1475,7 @@ namespace Duplicati.Library.Main return Convert.ToInt64(v); } } - + /// /// List of files to check for changes /// @@ -1523,26 +1535,26 @@ namespace Duplicati.Library.Main return v; } } - + /// /// Gets the index file usage method /// public IndexFileStrategy IndexfilePolicy { - get - { + get + { string strategy; if (!m_options.TryGetValue("index-file-policy", out strategy)) strategy = ""; - + IndexFileStrategy res; if (!Enum.TryParse(strategy, true, out res)) res = IndexFileStrategy.Full; - + return res; } } - + /// /// Gets a flag indicating if the check for files on the remote storage should be omitted /// @@ -1550,24 +1562,24 @@ namespace Duplicati.Library.Main { get { return Library.Utility.Utility.ParseBoolOption(m_options, "no-backend-verification"); } } - + /// /// Gets the percentage of samples to test during a backup operation /// - public long BackupTestPercentage + public decimal BackupTestPercentage { get { m_options.TryGetValue("backup-test-percentage", out string s); if (string.IsNullOrEmpty(s)) { - return 0; + return 0.1m; } - long percentage; + decimal percentage; try { - percentage = long.Parse(s); + percentage = decimal.Parse(s, CultureInfo.InvariantCulture); } catch (Exception ex) { @@ -1588,17 +1600,17 @@ namespace Duplicati.Library.Main /// public long BackupTestSampleCount { - get - { + get + { string s; m_options.TryGetValue("backup-test-samples", out s); if (string.IsNullOrEmpty(s)) return 1; - + return long.Parse(s); } } - + /// /// Gets a flag indicating if compacting should not be done automatically /// @@ -1628,21 +1640,21 @@ namespace Duplicati.Library.Main { get { return Library.Utility.Utility.ParseBoolOption(m_options, "allow-missing-source"); } } - + /// /// Gets a value indicating if a verification file should be uploaded after changing the remote store /// public bool UploadVerificationFile { - get { return Library.Utility.Utility.ParseBoolOption(m_options, "upload-verification-file"); } + get { return Library.Utility.Utility.ParseBoolOption(m_options, "upload-verification-file"); } } - + /// /// Gets a value indicating if a passphrase change is allowed /// public bool AllowPassphraseChange { - get { return Library.Utility.Utility.ParseBoolOption(m_options, "allow-passphrase-change"); } + get { return Library.Utility.Utility.ParseBoolOption(m_options, "allow-passphrase-change"); } } /// @@ -1650,12 +1662,12 @@ namespace Duplicati.Library.Main /// public bool Dryrun { - get + get { if (m_options.ContainsKey("dry-run")) - return Library.Utility.Utility.ParseBoolOption(m_options, "dry-run"); + return Library.Utility.Utility.ParseBoolOption(m_options, "dry-run"); else - return Library.Utility.Utility.ParseBoolOption(m_options, "dryrun"); + return Library.Utility.Utility.ParseBoolOption(m_options, "dryrun"); } } @@ -1677,7 +1689,7 @@ namespace Duplicati.Library.Main return r; } } - + /// /// The block hash algorithm to use /// @@ -1711,20 +1723,12 @@ namespace Duplicati.Library.Main } /// - /// Gets a flag indicating if the current operation is intended to delete files older than a certain threshold - /// - public bool PatchWithLocalBlocks - { - get { return Library.Utility.Utility.ParseBoolOption(m_options, "patch-with-local-blocks"); } - } - - /// - /// Gets a value indicating whether local blocks usage should be skipped. + /// Gets a value indicating whether local blocks usage should be used for restore. /// /// true if no local blocks; otherwise, false. - public bool NoLocalBlocks + public bool UseLocalBlocks { - get { return Library.Utility.Utility.ParseBoolOption(m_options, "no-local-blocks"); } + get { return Library.Utility.Utility.ParseBoolOption(m_options, "restore-with-local-blocks"); } } /// diff --git a/Duplicati/Library/Main/ProcessController.cs b/Duplicati/Library/Main/ProcessController.cs index 93faede5b..4ac7035ff 100755 --- a/Duplicati/Library/Main/ProcessController.cs +++ b/Duplicati/Library/Main/ProcessController.cs @@ -104,7 +104,7 @@ namespace Duplicati.Library.Main /// private void StartSleepPrevention() { - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) { try { @@ -116,7 +116,7 @@ namespace Duplicati.Library.Main Logging.Log.WriteWarningMessage(LOGTAG, "SleepPrevetionError", ex, "Failed to set sleep prevention"); } } - else if (Platform.IsClientOSX) + else if (OperatingSystem.IsMacOS()) { try { @@ -150,7 +150,7 @@ namespace Duplicati.Library.Main { var pid = System.Diagnostics.Process.GetCurrentProcess().Id; - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) { var handle = System.Diagnostics.Process.GetCurrentProcess().Handle; @@ -187,7 +187,7 @@ namespace Duplicati.Library.Main } else { - if (Platform.IsClientOSX) + if (OperatingSystem.IsMacOS()) { var data = RunProcessAndGetResult("ps", $"-onice -p {pid}"); if (data.Item1 != 0) @@ -253,7 +253,7 @@ namespace Duplicati.Library.Main // // See https://docs.microsoft.com/en-us/windows-hardware/drivers/ddi/ntifs/nf-ntifs-rtlqueryprocessplaceholdercompatibilitymode - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) { try { @@ -286,7 +286,7 @@ namespace Duplicati.Library.Main /// private void StopSleepPrevention() { - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) { try { @@ -301,7 +301,7 @@ namespace Duplicati.Library.Main Logging.Log.WriteWarningMessage(LOGTAG, "SleepPrevetionError", ex, "Failed to set sleep prevention"); } } - else if (Platform.IsClientOSX) + else if (OperatingSystem.IsMacOS()) { try { @@ -334,7 +334,7 @@ namespace Duplicati.Library.Main /// private void DeactivateBackgroundIOPriority() { - if (Platform.IsClientWindows) + if (OperatingSystem.IsWindows()) { try { @@ -377,7 +377,7 @@ namespace Duplicati.Library.Main var pid = System.Diagnostics.Process.GetCurrentProcess().Id; Tuple data; - if (Platform.IsClientOSX) + if (OperatingSystem.IsMacOS()) { // TODO: We can only give lower priority, thus not reset it ... data = RunProcessAndGetResult($"renice", $"{m_originalNiceLevel} -p {pid}"); diff --git a/Duplicati/Library/Main/Strings.cs b/Duplicati/Library/Main/Strings.cs index c14d05586..a1375c815 100644 --- a/Duplicati/Library/Main/Strings.cs +++ b/Duplicati/Library/Main/Strings.cs @@ -1,23 +1,23 @@ -// 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. +// 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; using Duplicati.Library.Localization.Short; @@ -35,7 +35,7 @@ namespace Duplicati.Library.Main.Strings public static string UnsupportedBooleanValue(string optionname, string value) { return LC.L(@"The value ""{1}"" supplied to --{0} does not parse into a valid boolean, this will be treated as if it was set to ""true""", optionname, value); } public static string UnsupportedEnumerationValue(string optionname, string value, string[] values) { return LC.L(@"The option --{0} does not support the value ""{1}"", supported values are: {2}", optionname, value, string.Join(", ", values)); } public static string UnsupportedFlagsValue(string optionname, string value, string[] values) { return LC.L(@"The option --{0} does not support the value ""{1}"", supported flag values are: {2}", optionname, value, string.Join(", ", values)); } - public static string UnsupportedIntegerValue(string optionname, string value) { return LC.L(@"The value ""{1}"" supplied to --{0} does not represent a valid integer", optionname, value); } + public static string UnsupportedIntegerValue(string optionname, string value) { return LC.L(@"The value ""{1}"" supplied to --{0} does not represent a valid integer", optionname, value); } public static string UnsupportedOptionDisabledModuleWarning(string optionname, string modulename) { return LC.L(@"The option --{0} is not supported because the module {1} is not currently loaded", optionname, modulename); } public static string UnsupportedOptionWarning(string optionname) { return LC.L(@"The supplied option --{0} is not supported and will be ignored", optionname); } public static string UnsupportedPathValue(string optionname, string value) { return LC.L(@"The value ""{1}"" supplied to --{0} does not represent a valid path", optionname, value); } @@ -143,10 +143,12 @@ namespace Duplicati.Library.Main.Strings public static string DebugretryerrorsShort { get { return LC.L(@"Show error messages when a retry is performed"); } } public static string UploadUnchangedBackupsLong { get { return LC.L(@"If no files have changed, Duplicati will not upload a backup set. If the backup data is used to verify that a backup was executed, this option will make Duplicati upload a backupset even if it is empty"); } } public static string UploadUnchangedBackupsShort { get { return LC.L(@"Upload empty backup files"); } } - public static string QuotasizeLong { get { return LC.L(@"This value can be used to set a known upper limit on the amount of space a backend has. If the backend reports the size itself, this value is ignored"); } } - public static string QuotasizeShort { get { return LC.L(@"A reported maximum storage"); } } + public static string QuotasizeLong { get { return LC.L(@"Set a limit to the amount of storage used on the backend (by this backup). This is in addition to the full backend quota, if available. Note: Backups will continue past the quota. This only creates warnings and error messages."); } } + public static string QuotasizeShort { get { return LC.L(@"Limit storage use"); } } public static string QuotaWarningThresholdLong { get { return LC.L(@"Sets a threshold for when to warn about the backend quota being nearly exceeded. It is given as a percentage, and a warning is generated if the amount of available quota is less than this percentage of the total backup size. If the backend does not report the quota information, this value will be ignored"); } } public static string QuotaWarningThresholdShort { get { return LC.L(@"Threshold for warning about low quota"); } } + public static string QuotaDisableLong(string optionname) { return LC.L(@"Disable the quota reported by the backend. --{0} can still be used to set a manual quota", optionname); } + public static string QuotaDisableShort { get { return LC.L(@"Disable backend quota"); } } public static string SymlinkpolicyShort { get { return LC.L(@"Symlink handling"); } } public static string SymlinkpolicyLong(string store, string ignore, string follow) { return LC.L(@"Use this option to handle symlinks differently. The ""{0}"" option will simply record a symlink with its name and destination, and a restore will recreate the symlink as a link. Use the option ""{1}"" to ignore all symlinks and not store any information about them. The option ""{2}"" will cause the symlinked target to be backed up and restored as a normal file with the symlink name. Early versions of Duplicati did not support this option and bevhaved as if ""{2}"" was specified.", store, ignore, follow); } public static string HardlinkpolicyShort { get { return LC.L(@"Hardlink handling"); } } @@ -195,6 +197,7 @@ namespace Duplicati.Library.Main.Strings public static string SmallfilemaxcountShort { get { return LC.L(@"Maximum number of small volumes"); } } public static string PatchwithlocalblocksLong { get { return LC.L(@"Enable this option to look into other files on this machine to find existing blocks. This is a fairly slow operation but can limit the size of downloads."); } } public static string PatchwithlocalblocksShort { get { return LC.L(@"Use local file data when restoring"); } } + public static string PatchwithlocalblocksDeprecated(string optionname) { return LC.L(@"Use the option --{0} instead", optionname); } public static string NolocaldbShort { get { return LC.L(@"Disables the local database"); } } public static string NolocaldbLong { get { return LC.L(@"When listing contents or when restoring files, the local database can be skipped. This is usually slower, but can be used to verify the actual contents of the remote store"); } } public static string KeepversionsShort { get { return LC.L(@"Keep a number of versions"); } } @@ -235,6 +238,10 @@ namespace Duplicati.Library.Main.Strings public static string SkiprestoreverificationLong { get { return LC.L(@"After restoring files, the file hash of all restored files are checked to verify that the restore was successful. Use this option to disable the check and avoid waiting for the verification."); } } public static string NolocalblocksShort { get { return LC.L(@"Do not use local data"); } } public static string NolocalblocksLong { get { return LC.L(@"Duplicati will attempt to use data from source files to minimize the amount of downloaded data. Use this option to skip this optimization and only use remote data."); } } + public static string NolocalblocksDeprecated(string alternativeOptionName) { return LC.L(@"The default is now to not use local blocks for restore. To opt-in for using local blocks, set the option --{0}", alternativeOptionName); } + public static string RestorewithlocalblocksShort { get { return LC.L(@"Use existing data for restore"); } } + public static string RestorewithlocalblocksLong { get { return LC.L(@"Use this option to allow Duplicati to use blocks found on disk when performing restores, instead of only using files in remote storage."); } } + public static string FullblockverificationShort { get { return LC.L(@"Check block hashes"); } } public static string FullblockverificationLong { get { return LC.L(@"Use this option to increase verification by checking the hash of blocks read from a volume before patching restored files with the data."); } } public static string LogretentionShort { get { return LC.L(@"Clean up old log data"); } } @@ -245,13 +252,13 @@ namespace Duplicati.Library.Main.Strings public static string ForcelocaleLong { get { return LC.L(@"By default, your system locale and culture settings will be used. In some cases you may prefer to run with another locale, for example to get messages in another language. This option can be used to set the locale. Supply a blank string to choose the ""Invariant Culture""."); } } public static string ForceActualDateShort { get { return LC.L(@"Forces the display of the actual date instead of calendar date"); } } public static string ForceActualDateLong { get { return LC.L(@"By default, dates are displayed in the calendar format, meaning ""Today"" or ""Last Thursday"". By setting this option, only the actual dates are displayed, ""Nov 12, 2018, 8:01 AM"" for example."); } } - public static string DisablepipingShort{ get { return LC.L(@"Handle file communication with backend using threaded pipes"); } } + public static string DisablepipingShort { get { return LC.L(@"Handle file communication with backend using threaded pipes"); } } public static string DisablepipingLong { get { return LC.L(@"Use this option to disable multithreaded handling of up- and downloads, that can significantly speed up backend operations depending on the hardware you're running on and the transfer rate of your backend."); } } - public static string ConcurrencymaxthreadsShort{ get { return LC.L(@"Limit number of concurrent threads"); } } + public static string ConcurrencymaxthreadsShort { get { return LC.L(@"Limit number of concurrent threads"); } } public static string ConcurrencymaxthreadsLong { get { return LC.L(@"Use this option to set the maximum number of threads used. Setting this value to zero or less will dynamically balance the number of active threads to fit the hardware."); } } - public static string ConcurrencyblockhashersShort{ get { return LC.L(@"Specify the number of concurrent hashing processes"); } } + public static string ConcurrencyblockhashersShort { get { return LC.L(@"Specify the number of concurrent hashing processes"); } } public static string ConcurrencyblockhashersLong { get { return LC.L(@"Use this option to set the number of processes that perform hashing of data."); } } - public static string ConcurrencycompressorsShort{ get { return LC.L(@"Specify the number of concurrent compression processes"); } } + public static string ConcurrencycompressorsShort { get { return LC.L(@"Specify the number of concurrent compression processes"); } } public static string ConcurrencycompressorsLong { get { return LC.L(@"Use this option to set the number of processes that perform compression of output data."); } } public static string DisablesyntehticfilelistLong { get { return LC.L(@"If Duplicati detects that the previous backup did not complete, it will generate a filelist that is a merge of the last completed backup and the contents that were uploaded in the incomplete backup session."); } } public static string DisablesyntheticfilelistShort { get { return LC.L(@"Disables synthetic filelist"); } } @@ -280,24 +287,24 @@ namespace Duplicati.Library.Main.Strings public static string UsebackgroundiopriorityShort { get { return LC.L("Sets the process to use low IO priority"); } } public static string UsebackgroundiopriorityLong { get { return LC.L("This option instructions the operating system to set the current process to use the lowest IO priority level, which can make operations run slower but will interfere less with other operations running at the same time"); } } - public static string ExcludeemptyfoldersShort { get { return "Excludes empty folders"; } } - public static string ExcludeemptyfoldersLong { get { return "Use this option to remove all empty folders from a backup."; } } + public static string ExcludeemptyfoldersShort { get { return LC.L("Excludes empty folders"); } } + public static string ExcludeemptyfoldersLong { get { return LC.L("Use this option to remove all empty folders from a backup."); } } public static string IgnorefilenamesShort { get { return LC.L("List of filenames that exclude folders"); } } public static string IgnorefilenamesLong { get { return LC.L("Use this option to set a filename, or list of filenames, that indicate exclusion of a folder which contains it. A common use would be to have a file named something like \".nobackup\" and place this file into folders that should not be backed up."); } } - public static string RestoresymlinkmetadataShort { get { return "Apply metadata to symlinks"; } } - public static string RestoresymlinkmetadataLong { get { return "If symlink metadata is applied, it will usually mean changing the symlink target, instead of the symlink itself. For this reason, metadata is not applied to symlinks, but this option can be used to override this, such that metadata is applied to symlinks as well."; } } - public static string UnittestmodeShort { get { return "Activate unittest mode"; } } - public static string UnittestmodeLong { get { return "When running in unittest mode, no automatic fixes are applied, which assumes that the input data is always in perfect shape. This option is not intended for use in daily backups, but required for testing purposes to reveal potential problems."; } } + public static string RestoresymlinkmetadataShort { get { return LC.L("Apply metadata to symlinks"); } } + public static string RestoresymlinkmetadataLong { get { return LC.L("If symlink metadata is applied, it will usually mean changing the symlink target, instead of the symlink itself. For this reason, metadata is not applied to symlinks, but this option can be used to override this, such that metadata is applied to symlinks as well."); } } + public static string UnittestmodeShort { get { return LC.L("Activate unittest mode"); } } + public static string UnittestmodeLong { get { return LC.L("When running in unittest mode, no automatic fixes are applied, which assumes that the input data is always in perfect shape. This option is not intended for use in daily backups, but required for testing purposes to reveal potential problems."); } } public static string ProfilealldatabasequeriesShort { get { return LC.L("Activates logging of all database queries"); } } public static string ProfilealldatabasequeriesLong { get { return LC.L("To improve performance of the backups, frequent database queries are not logged by default. Enable this option to log all database queries, and remember to set either --{0}={2} or --{1}={2} to report the additional log data", "console-log-level", "log-file-log-level", nameof(Logging.LogMessageType.Profiling)); } } - public static string RebuildmissingdblockfilesShort { get { return "Rebuild dblock files when missing"; } } - public static string RebuildmissingdblockfilesLong { get { return "If dblock files are missing from the destination, you can attempt to rebuild them using local source data. However, since the local data may have changed, it may not be possible to retrieve all the required data and the process may be slow. Use this option to attempt to rebuild missing dblock files."; } } + public static string RebuildmissingdblockfilesShort { get { return LC.L("Rebuild dblock files when missing"); } } + public static string RebuildmissingdblockfilesLong { get { return LC.L("If dblock files are missing from the destination, you can attempt to rebuild them using local source data. However, since the local data may have changed, it may not be possible to retrieve all the required data and the process may be slow. Use this option to attempt to rebuild missing dblock files."); } } - public static string AutoCompactIntervalShort { get { return "Minimum time between auto compactions"; } } - public static string AutoCompactIntervalLong { get { return "The minimum amount of time that must elapse after the last compaction before another will be automatically triggered at the end of a backup job. Automatic compaction can be a long-running process and may not be desirable to run after every single backup."; } } - public static string AutoVacuumIntervalShort { get { return "Minimum time between auto vacuums"; } } - public static string AutoVacuumIntervalLong { get { return "The minimum amount of time that must elapse after the last vacuum before another will be automatically triggered at the end of a backup job. Automatic vacuum can be a long-running process and may not be desirable to run after every single backup."; } } + public static string AutoCompactIntervalShort { get { return LC.L("Minimum time between auto compactions"); } } + public static string AutoCompactIntervalLong { get { return LC.L("The minimum amount of time that must elapse after the last compaction before another will be automatically triggered at the end of a backup job. Automatic compaction can be a long-running process and may not be desirable to run after every single backup."); } } + public static string AutoVacuumIntervalShort { get { return LC.L("Minimum time between auto vacuums"); } } + public static string AutoVacuumIntervalLong { get { return LC.L("The minimum amount of time that must elapse after the last vacuum before another will be automatically triggered at the end of a backup job. Automatic vacuum can be a long-running process and may not be desirable to run after every single backup."); } } } internal static class Common diff --git a/Duplicati/Library/Main/Utility.cs b/Duplicati/Library/Main/Utility.cs index afdf638a0..d7ac964c5 100644 --- a/Duplicati/Library/Main/Utility.cs +++ b/Duplicati/Library/Main/Utility.cs @@ -22,11 +22,11 @@ using System; using System.Collections.Generic; using System.IO; -using System.Security.Cryptography; using Newtonsoft.Json; using System.Text; using Duplicati.Library.Main.Database; using Duplicati.Library.Utility; +using System.Linq; namespace Duplicati.Library.Main { @@ -49,44 +49,44 @@ namespace Duplicati.Library.Main /// The lookup table with elements /// private readonly Dictionary m_values; - + public Metahash(Dictionary values, Options options) { m_values = values; - + using (var ms = new System.IO.MemoryStream()) using (var w = new StreamWriter(ms, Encoding.UTF8)) - using(var filehasher = HashFactory.CreateHasher(options.FileHashAlgorithm)) + using (var filehasher = HashFactory.CreateHasher(options.FileHashAlgorithm)) { if (filehasher == null) throw new Duplicati.Library.Interface.UserInformationException(Strings.Common.InvalidHashAlgorithm(options.FileHashAlgorithm), "FileHashAlgorithmNotSupported"); - + w.Write(JsonConvert.SerializeObject(values)); w.Flush(); - + m_blob = ms.ToArray(); - + ms.Position = 0; m_filehash = Convert.ToBase64String(filehasher.ComputeHash(ms)); } } - + public string FileHash { get { return m_filehash; } } - + public byte[] Blob { get { return m_blob; } } - + public Dictionary Values { get { return m_values; } } } - + /// /// Constructs a container for a given metadata dictionary /// @@ -97,11 +97,17 @@ namespace Duplicati.Library.Main return new Metahash(values, options); } + /// + /// Updates the options with settings from the data, if any + /// + /// The database to read from + /// The options to update + /// The transaction to use, if any internal static void UpdateOptionsFromDb(LocalDatabase db, Options options, System.Data.IDbTransaction transaction = null) { string n = null; var opts = db.GetDbOptions(transaction); - if(opts.ContainsKey("blocksize") && (!options.RawOptions.TryGetValue("blocksize", out n) || string.IsNullOrEmpty(n))) + if (opts.ContainsKey("blocksize") && (!options.RawOptions.TryGetValue("blocksize", out n) || string.IsNullOrEmpty(n))) options.RawOptions["blocksize"] = opts["blocksize"] + "b"; if (opts.ContainsKey("blockhash") && (!options.RawOptions.TryGetValue("block-hash-algorithm", out n) || string.IsNullOrEmpty(n))) @@ -110,7 +116,24 @@ namespace Duplicati.Library.Main options.RawOptions["file-hash-algorithm"] = opts["filehash"]; } - internal static void VerifyParameters(LocalDatabase db, Options options, System.Data.IDbTransaction transaction = null) + /// + /// Checks if the database contains options that need to be verified, such as the blocksize + /// + /// The database to check + /// true if the database contains options that need to be verified; false otherwise + internal static bool ContainsOptionsForVerification(LocalDatabase db) + { + var opts = db.GetDbOptions(); + return new[] { "blocksize", "blockhash", "filehash", "passphrase" }.Any(opts.ContainsKey); + } + + /// + /// Verifies the parameters in the database, and updates the database if needed + /// + /// The database to check + /// The options to verify + /// The transaction to use, if any + internal static void VerifyOptionsAndUpdateDatabase(LocalDatabase db, Options options, System.Data.IDbTransaction transaction = null) { var newDict = new Dictionary { @@ -119,7 +142,7 @@ namespace Duplicati.Library.Main { "filehash", options.FileHashAlgorithm } }; var opts = db.GetDbOptions(transaction); - + if (options.NoEncryption) { newDict.Add("passphrase", "no-encryption"); @@ -138,15 +161,15 @@ namespace Duplicati.Library.Main } newDict["passphrase-salt"] = salt; - + // We avoid storing the passphrase directly, // instead we salt and rehash repeatedly newDict.Add("passphrase", Library.Utility.Utility.ByteArrayAsHexString(Library.Utility.Utility.RepeatedHashWithSalt(options.Passphrase, salt, 1200))); } - - + + var needsUpdate = false; - foreach(var k in newDict) + foreach (var k in newDict) if (!opts.ContainsKey(k.Key)) needsUpdate = true; else if (opts[k.Key] != k.Value) @@ -165,21 +188,21 @@ namespace Duplicati.Library.Main } else throw new Duplicati.Library.Interface.UserInformationException(string.Format("You have attempted to change the parameter \"{0}\" from \"{1}\" to \"{2}\", which is not supported. Please configure a new clean backup if you want to change the parameter.", k.Key, opts[k.Key], k.Value), "ParameterChangeNotSupported"); - + } - + //Extra sanity check if (db.GetBlocksLargerThan(options.Blocksize) > 0) throw new Duplicati.Library.Interface.UserInformationException("You have attempted to change the block-size on an existing backup, which is not supported. Please configure a new clean backup if you want to change the block-size.", "BlockSizeChangeNotSupported"); - + if (needsUpdate) { // Make sure we do not lose values - foreach(var k in opts) + foreach (var k in opts) if (!newDict.ContainsKey(k.Key)) newDict[k.Key] = k.Value; - - db.SetDbOptions(newDict, transaction); + + db.SetDbOptions(newDict, transaction); } } } diff --git a/Duplicati/Library/Main/Volumes/VolumeReaderBase.cs b/Duplicati/Library/Main/Volumes/VolumeReaderBase.cs index 414bf9aad..5283adca3 100644 --- a/Duplicati/Library/Main/Volumes/VolumeReaderBase.cs +++ b/Duplicati/Library/Main/Volumes/VolumeReaderBase.cs @@ -1,23 +1,23 @@ -// 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. +// 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 Duplicati.Library.Interface; using Newtonsoft.Json; using System; @@ -34,7 +34,7 @@ namespace Duplicati.Library.Main.Volumes protected readonly bool m_disposeCompression = false; protected ICompression m_compression; protected Stream m_stream; - + private static ICompression LoadCompressor(string compressor, Stream stream, Options options) { var tmp = DynamicLoader.CompressionLoader.GetModule(compressor, stream, Interface.ArchiveMode.Read, options.RawOptions); @@ -64,7 +64,7 @@ namespace Duplicati.Library.Main.Volumes ReadFileset(); ReadManifests(options); - + m_disposeCompression = true; } @@ -130,6 +130,12 @@ namespace Duplicati.Library.Main.Volumes } } + /// + /// Updates the options with data from the manifest file, but does not overwrite existing values + /// + /// The compressor to use + /// The file to read the manifest from + /// The options to update public static void UpdateOptionsFromManifest(string compressor, string file, Options options) { using (var stream = new System.IO.FileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read)) @@ -170,13 +176,13 @@ namespace Duplicati.Library.Main.Volumes using (var fs = compression.OpenRead(filename)) { int s; - var read = 0L; + var read = 0L; while ((s = Library.Utility.Utility.ForceStreamRead(fs, buffer, buffer.Length)) != 0) { if (s != buffer.Length) - throw new InvalidDataException($"Premature End-of-stream encountered while reading blocklist hashes for {filename}. Got {s} bytes of {buffer.Length} at offset {read * buffer.Length}"); + throw new InvalidDataException($"Premature End-of-stream encountered while reading blocklist hashes for {filename}. Got {s} bytes of {buffer.Length} at offset {read * buffer.Length}"); - read++; + read++; yield return Convert.ToBase64String(buffer); } } diff --git a/Duplicati/Library/Modules/Builtin/ConsolePasswordInput.cs b/Duplicati/Library/Modules/Builtin/ConsolePasswordInput.cs index bdef9e9b1..405468e0e 100644 --- a/Duplicati/Library/Modules/Builtin/ConsolePasswordInput.cs +++ b/Duplicati/Library/Modules/Builtin/ConsolePasswordInput.cs @@ -85,7 +85,7 @@ namespace Duplicati.Library.Modules.Builtin catch (InvalidOperationException) { // Handle redirect issues on Windows only - if (!Platform.IsClientWindows) + if (!OperatingSystem.IsWindows()) throw; commandlineOptions["passphrase"] = ReadPassphraseFromStdin(confirm); diff --git a/Duplicati/Library/Modules/Builtin/Duplicati.Library.Modules.Builtin.csproj b/Duplicati/Library/Modules/Builtin/Duplicati.Library.Modules.Builtin.csproj index 4a27be489..379952fbe 100644 --- a/Duplicati/Library/Modules/Builtin/Duplicati.Library.Modules.Builtin.csproj +++ b/Duplicati/Library/Modules/Builtin/Duplicati.Library.Modules.Builtin.csproj @@ -1,15 +1,15 @@ - + net8.0 Library Duplicati.Library.Modules.Builtin + Copyright © 2024 Team Duplicati, MIT license + - - @@ -38,3 +38,4 @@ + diff --git a/Duplicati/Library/Modules/Builtin/HyperVOptions.cs b/Duplicati/Library/Modules/Builtin/HyperVOptions.cs index 4a56822ab..7f63be226 100644 --- a/Duplicati/Library/Modules/Builtin/HyperVOptions.cs +++ b/Duplicati/Library/Modules/Builtin/HyperVOptions.cs @@ -22,6 +22,7 @@ using System; using System.Collections.Generic; using System.Linq; +using System.Runtime.Versioning; using System.Text.RegularExpressions; using Duplicati.Library.Common; using Duplicati.Library.Snapshots; @@ -56,7 +57,7 @@ namespace Duplicati.Library.Modules.Builtin public bool LoadAsDefault { - get { return Platform.IsClientWindows; } + get { return OperatingSystem.IsWindows(); } } public IList SupportedCommands @@ -75,7 +76,7 @@ namespace Duplicati.Library.Modules.Builtin public Dictionary ParseSourcePaths(ref string[] paths, ref string filter, Dictionary commandlineOptions) { // Early exit in case we are non-windows to prevent attempting to load Windows-only components - if (!Platform.IsClientWindows) + if (!OperatingSystem.IsWindows()) { Logging.Log.WriteWarningMessage(LOGTAG, "HyperVWindowsOnly", null, "Hyper-V backup works only on Windows OS"); @@ -99,6 +100,7 @@ namespace Duplicati.Library.Modules.Builtin // Make sure the JIT does not attempt to inline this call and thus load // referenced types from System.Management here [System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.NoInlining)] + [SupportedOSPlatform("windows")] private Dictionary RealParseSourcePaths(ref string[] paths, ref string filter, Dictionary commandlineOptions) { var changedOptions = new Dictionary(); @@ -216,7 +218,7 @@ namespace Duplicati.Library.Modules.Builtin public bool ContainFilesForBackup(string[] paths) { - if (paths == null || !Platform.IsClientWindows) + if (paths == null || !OperatingSystem.IsWindows()) return false; return paths.Where(x => !string.IsNullOrWhiteSpace(x)).Any(x => x.Equals(m_HyperVPathAllRegExp, StringComparison.OrdinalIgnoreCase) || Regex.IsMatch(x, m_HyperVPathGuidRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant)); diff --git a/Duplicati/Library/Modules/Builtin/MSSQLOptions.cs b/Duplicati/Library/Modules/Builtin/MSSQLOptions.cs index 6bf5ebf19..fa637843c 100644 --- a/Duplicati/Library/Modules/Builtin/MSSQLOptions.cs +++ b/Duplicati/Library/Modules/Builtin/MSSQLOptions.cs @@ -22,6 +22,7 @@ using System; using System.Collections.Generic; using System.Linq; +using System.Runtime.Versioning; using System.Text.RegularExpressions; using Duplicati.Library.Common; using Duplicati.Library.Snapshots; @@ -57,7 +58,7 @@ namespace Duplicati.Library.Modules.Builtin public bool LoadAsDefault { - get { return Platform.IsClientWindows; } + get { return OperatingSystem.IsWindows(); } } public IList SupportedCommands @@ -76,7 +77,7 @@ namespace Duplicati.Library.Modules.Builtin public Dictionary ParseSourcePaths(ref string[] paths, ref string filter, Dictionary commandlineOptions) { // Early exit in case we are non-windows to prevent attempting to load Windows-only components - if (!Platform.IsClientWindows) + if (!OperatingSystem.IsWindows()) { Logging.Log.WriteWarningMessage(LOGTAG, "MSSqlWindowsOnly", null, "Microsoft SQL Server databases backup works only on Windows OS"); @@ -100,6 +101,7 @@ namespace Duplicati.Library.Modules.Builtin // Make sure the JIT does not attempt to inline this call and thus load // referenced types from System.Management here [System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.NoInlining)] + [SupportedOSPlatform("windows")] private Dictionary RealParseSourcePaths(ref string[] paths, ref string filter, Dictionary commandlineOptions) { var changedOptions = new Dictionary(); @@ -214,7 +216,7 @@ namespace Duplicati.Library.Modules.Builtin public bool ContainFilesForBackup(string[] paths) { - if (paths == null || !Platform.IsClientWindows) + if (paths == null || !OperatingSystem.IsWindows()) return false; return paths.Where(x => !string.IsNullOrWhiteSpace(x)).Any(x => x.Equals(m_MSSQLPathAllRegExp, StringComparison.OrdinalIgnoreCase) || Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant)); diff --git a/Duplicati/Library/Modules/Builtin/RunScript.cs b/Duplicati/Library/Modules/Builtin/RunScript.cs index 379f45c33..c482e95e6 100644 --- a/Duplicati/Library/Modules/Builtin/RunScript.cs +++ b/Duplicati/Library/Modules/Builtin/RunScript.cs @@ -20,19 +20,18 @@ // DEALINGS IN THE SOFTWARE. using System; -using System.Diagnostics; using System.IO; -using System.Text; using System.Collections.Generic; using Duplicati.Library.Utility; using Duplicati.Library.Interface; -using System.Linq; using Duplicati.Library.Modules.Builtin.ResultSerialization; using System.Threading.Tasks; +using System.Text.RegularExpressions; +using System.Linq; namespace Duplicati.Library.Modules.Builtin { - public class RunScript : Duplicati.Library.Interface.IGenericCallbackModule + public class RunScript : IGenericCallbackModule { /// /// The tag used for logging @@ -43,10 +42,20 @@ namespace Duplicati.Library.Modules.Builtin /// private const Logging.LogMessageType DEFAULT_LOG_LEVEL = Logging.LogMessageType.Warning; + /// + /// The regex used to parse arguments + /// + private static readonly Regex ARGREGEX = new Regex( + @"(?(?<=\s|^)(""(?[^""\\]*(?:\\.[^""\\]*)*)""|'(?[^'\\]*(?:\\.[^'\\]*)*)'|(?[^\s]+))\s?)", + RegexOptions.Compiled | RegexOptions.ExplicitCapture + ); + + private const string STARTUP_OPTION = "run-script-before"; private const string FINISH_OPTION = "run-script-after"; private const string REQUIRED_OPTION = "run-script-before-required"; private const string TIMEOUT_OPTION = "run-script-timeout"; + private const string ENABLE_ARGUMENTS_OPTION = "run-script-with-arguments"; /// /// Option used to set the log level for mail reports /// @@ -64,6 +73,7 @@ namespace Duplicati.Library.Modules.Builtin private string m_startScript = null; private string m_finishScript = null; private int m_timeout = 0; + private bool m_enableArguments = false; private string m_operationName; private string m_remoteurl; @@ -78,7 +88,7 @@ namespace Duplicati.Library.Modules.Builtin /// /// The log storage /// - private Utility.FileBackedStringList m_logstorage; + private FileBackedStringList m_logstorage; #region IGenericModule implementation @@ -87,20 +97,21 @@ namespace Duplicati.Library.Modules.Builtin commandlineOptions.TryGetValue(STARTUP_OPTION, out m_startScript); commandlineOptions.TryGetValue(REQUIRED_OPTION, out m_requiredScript); commandlineOptions.TryGetValue(FINISH_OPTION, out m_finishScript); + m_enableArguments = Utility.Utility.ParseBoolOption(commandlineOptions, ENABLE_ARGUMENTS_OPTION); - string tmpResultFormat; ResultExportFormat resultFormat; - if (!commandlineOptions.TryGetValue(RESULT_FORMAT_OPTION, out tmpResultFormat)) { + if (!commandlineOptions.TryGetValue(RESULT_FORMAT_OPTION, out var tmpResultFormat)) + { resultFormat = ResultExportFormat.Duplicati; } - else if (!Enum.TryParse(tmpResultFormat, true, out resultFormat)) { + else if (!Enum.TryParse(tmpResultFormat, true, out resultFormat)) + { resultFormat = ResultExportFormat.Duplicati; } resultFormatSerializer = ResultFormatSerializerProvider.GetSerializer(resultFormat); - string t; - if (!commandlineOptions.TryGetValue(TIMEOUT_OPTION, out t)) + if (!commandlineOptions.TryGetValue(TIMEOUT_OPTION, out var t)) t = DEFAULT_TIMEOUT; m_timeout = (int)Utility.Timeparser.ParseTimeSpan(t).TotalMilliseconds; @@ -108,11 +119,12 @@ namespace Duplicati.Library.Modules.Builtin m_options = commandlineOptions; m_options.TryGetValue(OPTION_LOG_FILTER, out var logfilterstring); - var filter = Utility.FilterExpression.ParseLogFilter(logfilterstring); + var filter = FilterExpression.ParseLogFilter(logfilterstring); var logLevel = Utility.Utility.ParseEnumOption(m_options, OPTION_LOG_LEVEL, DEFAULT_LOG_LEVEL); m_logstorage = new FileBackedStringList(); - m_logscope = Logging.Log.StartScope(m => m_logstorage.Add(m.AsString(true)), m => { + m_logscope = Logging.Log.StartScope(m => m_logstorage.Add(m.AsString(true)), m => + { if (filter.Matches(m.FilterTag, out var result, out var match)) return result; @@ -126,17 +138,18 @@ namespace Duplicati.Library.Modules.Builtin public string Key { get { return "runscript"; } } public string DisplayName { get { return Strings.RunScript.DisplayName; } } public string Description { get { return Strings.RunScript.Description; } } - public bool LoadAsDefault { get { return true; } } + public bool LoadAsDefault { get { return true; } } - public IList SupportedCommands + public IList SupportedCommands { get { - string[] resultOutputFormatOptions = new string[] { ResultExportFormat.Duplicati.ToString(), ResultExportFormat.Json.ToString() }; - return new List(new Duplicati.Library.Interface.ICommandLineArgument[] { - new Duplicati.Library.Interface.CommandLineArgument(STARTUP_OPTION, Duplicati.Library.Interface.CommandLineArgument.ArgumentType.Path, Strings.RunScript.StartupoptionShort, Strings.RunScript.StartupoptionLong), - new Duplicati.Library.Interface.CommandLineArgument(FINISH_OPTION, Duplicati.Library.Interface.CommandLineArgument.ArgumentType.Path, Strings.RunScript.FinishoptionShort, Strings.RunScript.FinishoptionLong), - new Duplicati.Library.Interface.CommandLineArgument(REQUIRED_OPTION, Duplicati.Library.Interface.CommandLineArgument.ArgumentType.Path, Strings.RunScript.RequiredoptionShort, Strings.RunScript.RequiredoptionLong), + string[] resultOutputFormatOptions = [ResultExportFormat.Duplicati.ToString(), ResultExportFormat.Json.ToString()]; + return new List([ + new CommandLineArgument(STARTUP_OPTION, CommandLineArgument.ArgumentType.Path, Strings.RunScript.StartupoptionShort, Strings.RunScript.StartupoptionLong), + new CommandLineArgument(FINISH_OPTION, CommandLineArgument.ArgumentType.Path, Strings.RunScript.FinishoptionShort, Strings.RunScript.FinishoptionLong), + new CommandLineArgument(REQUIRED_OPTION, CommandLineArgument.ArgumentType.Path, Strings.RunScript.RequiredoptionShort, Strings.RunScript.RequiredoptionLong), + new CommandLineArgument(ENABLE_ARGUMENTS_OPTION, CommandLineArgument.ArgumentType.Boolean, Strings.RunScript.EnableArgumentsShort, Strings.RunScript.EnableArgumentsLong), new CommandLineArgument(RESULT_FORMAT_OPTION, CommandLineArgument.ArgumentType.Enumeration, Strings.RunScript.ResultFormatShort, @@ -144,11 +157,11 @@ namespace Duplicati.Library.Modules.Builtin ResultExportFormat.Duplicati.ToString(), null, resultOutputFormatOptions), - new Duplicati.Library.Interface.CommandLineArgument(TIMEOUT_OPTION, Duplicati.Library.Interface.CommandLineArgument.ArgumentType.Timespan, Strings.RunScript.TimeoutoptionShort, Strings.RunScript.TimeoutoptionLong, DEFAULT_TIMEOUT), + new CommandLineArgument(TIMEOUT_OPTION, CommandLineArgument.ArgumentType.Timespan, Strings.RunScript.TimeoutoptionShort, Strings.RunScript.TimeoutoptionLong, DEFAULT_TIMEOUT), new CommandLineArgument(OPTION_LOG_LEVEL, CommandLineArgument.ArgumentType.Enumeration, Strings.ReportHelper.OptionLoglevellShort, Strings.ReportHelper.OptionLoglevelLong, DEFAULT_LOG_LEVEL.ToString(), null, Enum.GetNames(typeof(Logging.LogMessageType))), new CommandLineArgument(OPTION_LOG_FILTER, CommandLineArgument.ArgumentType.String, Strings.ReportHelper.OptionLogfilterShort, Strings.ReportHelper.OptionLogfilterLong), - }); + ]); } } #endregion @@ -158,10 +171,10 @@ namespace Duplicati.Library.Modules.Builtin public void OnStart(string operationname, ref string remoteurl, ref string[] localpath) { if (!string.IsNullOrEmpty(m_requiredScript)) - Execute(m_requiredScript, "BEFORE", operationname, ref remoteurl, ref localpath, m_timeout, true, m_options, null, null); + Execute(m_requiredScript, "BEFORE", operationname, ref remoteurl, ref localpath, m_timeout, true, m_enableArguments, m_options, null, null); if (!string.IsNullOrEmpty(m_startScript)) - Execute(m_startScript, "BEFORE", operationname, ref remoteurl, ref localpath, m_timeout, false, m_options, null, null); + Execute(m_startScript, "BEFORE", operationname, ref remoteurl, ref localpath, m_timeout, false, m_enableArguments, m_options, null, null); // Save options that might be set by a --run-script-before script so that the OnFinish method // references the same values. @@ -170,7 +183,7 @@ namespace Duplicati.Library.Modules.Builtin m_localpath = localpath; } - public void OnFinish (object result, Exception exception) + public void OnFinish(object result, Exception exception) { // Dispose the current log scope if (m_logscope != null) @@ -215,16 +228,28 @@ namespace Duplicati.Library.Modules.Builtin using (var streamWriter = new StreamWriter(tmpfile)) streamWriter.Write(resultFormatSerializer.Serialize(result, exception, m_logstorage, null)); - Execute(m_finishScript, "AFTER", m_operationName, ref m_remoteurl, ref m_localpath, m_timeout, false, m_options, tmpfile, level); + Execute(m_finishScript, "AFTER", m_operationName, ref m_remoteurl, ref m_localpath, m_timeout, false, m_enableArguments, m_options, tmpfile, level); } } #endregion - private static void Execute(string scriptpath, string eventname, string operationname, ref string remoteurl, ref string[] localpath, int timeout, bool requiredScript, IDictionary options, string datafile, ParsedResultType? level) + private static void Execute(string scriptpath, string eventname, string operationname, ref string remoteurl, ref string[] localpath, int timeout, bool requiredScript, bool enableArguments, IDictionary options, string datafile, ParsedResultType? level) { try { - System.Diagnostics.ProcessStartInfo psi = new System.Diagnostics.ProcessStartInfo(scriptpath) + var arguments = new List(); + if (enableArguments) + { + var args = ARGREGEX.Matches(scriptpath); + if (args.Any()) + { + arguments = args.AsEnumerable().Select(m => m.Groups["value"].Value).ToList(); + scriptpath = arguments[0]; + arguments.RemoveAt(0); + } + } + + var psi = new System.Diagnostics.ProcessStartInfo(scriptpath, arguments) { WindowStyle = System.Diagnostics.ProcessWindowStyle.Hidden, CreateNoWindow = true, @@ -267,9 +292,9 @@ namespace Duplicati.Library.Modules.Builtin if (requiredScript) { if (!p.HasExited) - throw new Duplicati.Library.Interface.UserInformationException(Strings.RunScript.ScriptTimeoutError(scriptpath), "RunScriptTimeout"); + throw new UserInformationException(Strings.RunScript.ScriptTimeoutError(scriptpath), "RunScriptTimeout"); else if (p.ExitCode != 0) - throw new Duplicati.Library.Interface.UserInformationException(Strings.RunScript.InvalidExitCodeError(scriptpath, p.ExitCode), "RunScriptInvalidExitCode"); + throw new UserInformationException(Strings.RunScript.InvalidExitCodeError(scriptpath, p.ExitCode), "RunScriptInvalidExitCode"); } if (p.HasExited) diff --git a/Duplicati/Library/Modules/Builtin/SendHttpMessage.cs b/Duplicati/Library/Modules/Builtin/SendHttpMessage.cs index 81950443d..a3d4dd354 100644 --- a/Duplicati/Library/Modules/Builtin/SendHttpMessage.cs +++ b/Duplicati/Library/Modules/Builtin/SendHttpMessage.cs @@ -286,6 +286,8 @@ namespace Duplicati.Library.Modules.Builtin response.ReasonPhrase, responseContent ); + + response.EnsureSuccessStatusCode(); } catch (Exception ex) { diff --git a/Duplicati/Library/Modules/Builtin/SendJabberMessage.cs b/Duplicati/Library/Modules/Builtin/SendJabberMessage.cs index 697d16370..ccb214666 100644 --- a/Duplicati/Library/Modules/Builtin/SendJabberMessage.cs +++ b/Duplicati/Library/Modules/Builtin/SendJabberMessage.cs @@ -25,7 +25,7 @@ using Duplicati.Library.Interface; using Duplicati.Library.Logging; using System.Net.NetworkInformation; using Duplicati.Library.Modules.Builtin.ResultSerialization; -using Sharp.Xmpp.Client; +using Artalk.Xmpp.Client; namespace Duplicati.Library.Modules.Builtin { @@ -119,7 +119,7 @@ namespace Duplicati.Library.Modules.Builtin /// /// A localized string describing the module with a friendly name /// - public override string DisplayName { get { return Strings.SendJabberMessage.DisplayName;} } + public override string DisplayName { get { return Strings.SendJabberMessage.DisplayName; } } /// /// A localized description of the module @@ -203,31 +203,32 @@ namespace Duplicati.Library.Modules.Builtin if (string.IsNullOrWhiteSpace(resource)) resource = "Duplicati"; - using (XmppClient client = new XmppClient(uri.Host, uri.Username, string.IsNullOrWhiteSpace(m_password) ? uri.Password : m_password, uri.Port == -1 ? (uri.Scheme == "https" ? 5223 :5222) : uri.Port)) + using (ArtalkXmppClient client = new ArtalkXmppClient(uri.Host, uri.Username, string.IsNullOrWhiteSpace(m_password) ? uri.Password : m_password, uri.Port == -1 ? (uri.Scheme == "https" ? 5223 : 5222) : uri.Port)) { client.Connect(resource); try { - foreach(var recipient in m_to.Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries)) + foreach (var recipient in m_to.Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries)) { - client.SendMessage(recipient, new Dictionary(){ {"en", body} }); + Artalk.Xmpp.Jid jid = new Artalk.Xmpp.Jid(recipient); + client.SendMessage(jid, new Dictionary() { { "en", body } }); // hack to work around a failure to send the second time // (the xmpp server reports a read failure) - try - { - client.Ping(recipient); - } - catch {} + try + { + client.Ping(jid); + } + catch { } } - } + } catch (Exception e) { Logging.Log.WriteWarningMessage(LOGTAG, "XMPPSendError", e, "Failed to send to XMPP messages: {0}", e.Message); } - finally - { + finally + { client.Close(); - } + } } } diff --git a/Duplicati/Library/Modules/Builtin/Strings.cs b/Duplicati/Library/Modules/Builtin/Strings.cs index 791ccb135..f895a679f 100644 --- a/Duplicati/Library/Modules/Builtin/Strings.cs +++ b/Duplicati/Library/Modules/Builtin/Strings.cs @@ -93,6 +93,8 @@ namespace Duplicati.Library.Modules.Builtin.Strings public static string StdErrorReport(string script, string message) { return LC.L(@"The script ""{0}"" reported error messages: {1}", script, message); } public static string TimeoutoptionLong { get { return LC.L(@"Sets the maximum time a script is allowed to execute. If the script has not completed within this time, it will continue to execute but the operation will continue too, and no script output will be processed."); } } public static string TimeoutoptionShort { get { return LC.L(@"Sets the script timeout"); } } + public static string EnableArgumentsShort { get { return LC.L(@"Enable script arguments"); } } + public static string EnableArgumentsLong { get { return LC.L(@"This option enables the use of script arguments. If this option is enabled, the script arguments are treated as commandline strings. Use single or double quotes to separate arguments."); } } } internal static class SendMail { diff --git a/Duplicati/Library/Modules/Builtin/run-script-example.bat b/Duplicati/Library/Modules/Builtin/run-script-example.bat index 7f879f74c..e858bbc2b 100644 --- a/Duplicati/Library/Modules/Builtin/run-script-example.bat +++ b/Duplicati/Library/Modules/Builtin/run-script-example.bat @@ -11,6 +11,7 @@ REM --run-script-before = REM --run-script-before-required = REM --run-script-timeout =