// 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; using System.Collections.Generic; using System.Linq; using System.Text; using Duplicati.Library.Interface; namespace Duplicati.Library.Modules.Builtin.ResultSerialization { /// /// Provides a human-readable output for result data /// public class DuplicatiFormatSerializer : IResultFormatSerializer { /// /// Serialize the specified result and logLines. /// /// The serialized result string. /// The result to serialize. /// The exception, if any /// The log lines to serialize. /// Additional parameters to include public string Serialize(object result, Exception failException, IEnumerable loglines, Dictionary additional) { StringBuilder sb = new StringBuilder(); // Prepend the error message as the first two lines, to mimic previous behavior with only the exception text if (failException != null && result != failException) { sb.AppendLine(Serialize(failException, null, null, null)); } if (result == null) { sb.Append("null?"); } else if (result is IEnumerable resultEnumerable) { IEnumerator resultEnumerator = resultEnumerable.GetEnumerator(); resultEnumerator.Reset(); while (resultEnumerator.MoveNext()) { object current = resultEnumerator.Current; if (current == null) { continue; } if (current.GetType().IsGenericType && !current.GetType().IsGenericTypeDefinition && current.GetType().GetGenericTypeDefinition() == typeof(KeyValuePair<,>)) { object key = current.GetType().GetProperty("Key").GetValue(current, null); object value = current.GetType().GetProperty("Value").GetValue(current, null); sb.AppendFormat("{0}: {1}", key, value).AppendLine(); } else { sb.AppendLine(current.ToString()); } } } else if (result.GetType().IsArray) { Array array = (Array)result; for (int i = array.GetLowerBound(0); i <= array.GetUpperBound(0); i++) { object c = array.GetValue(i); if (c == null) { continue; } if (c.GetType().IsGenericType && !c.GetType().IsGenericTypeDefinition && c.GetType().GetGenericTypeDefinition() == typeof(KeyValuePair<,>)) { object key = c.GetType().GetProperty("Key").GetValue(c, null); object value = c.GetType().GetProperty("Value").GetValue(c, null); sb.AppendFormat("{0}: {1}", key, value).AppendLine(); } else { sb.AppendLine(c.ToString()); } } } else if (result is Exception exception) { //No localization, must be parseable by script sb.AppendFormat("Failed: {0}", exception.Message).AppendLine(); sb.AppendFormat("Details: {0}", exception).AppendLine(); } else { var ignore = new string[] { nameof(IBasicResults.Warnings), nameof(IBasicResults.Errors), nameof(IBasicResults.Messages) }; Utility.Utility.PrintSerializeObject(result, sb, (p, o) => !ignore.Contains(p.Name)); } if (additional != null && additional.Count > 0) sb.AppendLine(Serialize(additional, null, null, null)); if (loglines != null && loglines.Any()) { sb.AppendLine(); sb.AppendLine("Log data:"); foreach (var n in loglines) sb.AppendLine(n); } return sb.ToString(); } /// /// Returns the format that the serializer represents /// public ResultExportFormat Format => ResultExportFormat.Duplicati; } }