// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
#nullable enable
using System;
using System.Collections.Generic;
using System.Linq;
using Duplicati.Library.Logging;
namespace Duplicati.Library.Main
{
///
/// The log target handler for the controller, which sends to multiple log targets
///
public class ControllerMultiLogTarget : ILogDestination, IDisposable
{
///
/// The target entry for the log target
///
/// The log target.
/// The minimum log level to consider
/// The log filter.
private sealed record TargetEntry(ILogDestination Target, LogMessageType Level, Library.Utility.IFilter Filter);
///
/// The list of log targets to handle
///
private readonly List m_targets = new List();
///
/// The filter used to suppress warnings
///
private readonly HashSet? m_supressWarningFilter;
///
/// Initializes a new instance of the class.
///
/// The log target.
/// The minimum log level to consider
/// The log filter.
public ControllerMultiLogTarget(ILogDestination target, Logging.LogMessageType loglevel, Library.Utility.IFilter? filter, HashSet? supressWarningFilter)
{
m_supressWarningFilter = supressWarningFilter;
AddTarget(target, loglevel, filter);
}
///
/// Adds the target to the list.
///
/// The log target.
/// The minimum log level to consider
/// The log filter.
public void AddTarget(ILogDestination? target, LogMessageType loglevel, Library.Utility.IFilter? filter)
{
if (target == null)
return;
m_targets.Add(new TargetEntry(target, loglevel, filter ?? new Library.Utility.FilterExpression()));
}
///
/// Releases all resource used by the object.
///
/// Call when you are finished using the
/// . The method leaves the
/// in an unusable state. After calling
/// , you must release all references to the
/// so the garbage collector can reclaim the
/// memory that the was occupying.
public void Dispose()
{
foreach (var m in m_targets)
(m.Target as IDisposable)?.Dispose();
m_targets.Clear();
}
///
/// Gets the minimum log level of all the targets
///
public LogMessageType MinimumLevel
=> m_targets.Select(x => x.Level).DefaultIfEmpty(LogMessageType.Error).Min();
///
/// Writes the message to all the destinations.
///
/// Entry.
public void WriteMessage(LogEntry entry)
{
// If the message is a warning, check if we should suppress it
if (m_supressWarningFilter != null && entry.Level == LogMessageType.Warning && m_supressWarningFilter.Contains(entry.Id))
entry = new LogEntry(entry.Message, entry.Arguments, LogMessageType.Information, entry.Tag, entry.Id, entry.Exception);
foreach (var e in m_targets)
{
var found = e.Filter.Matches(entry.FilterTag, out var result, out var _);
// If there is a filter match, use that
if (found)
{
if (!result)
continue;
}
else
{
// Otherwise, filter by log-level
if (entry.Level < e.Level)
continue;
}
// If we get here, write the message
e.Target.WriteMessage(entry);
}
}
}
}