Aaru/Filters.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : Filters.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Filters.
//
// --[ Description ] ----------------------------------------------------------
//
//     Enumerates all filters and instantiates the correct one.
//
// --[ License ] --------------------------------------------------------------
//
//     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 © 2011-2023 Natalia Portillo
// ****************************************************************************/

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Console;

namespace Aaru.CommonTypes;

/// <summary>Manages the known filters</summary>
public sealed class FiltersList
{
    /// <summary>List of known filters</summary>
    public readonly SortedDictionary<string, IFilter> Filters;

    /// <summary>Fills the list of all known filters</summary>
    public FiltersList()
    {
        var assembly = Assembly.Load("Aaru.Filters");
        Filters = new SortedDictionary<string, IFilter>();

        foreach(Type type in assembly.GetTypes().Where(t => t.GetInterfaces().Contains(typeof(IFilter))))
            try
            {
                var filter = (IFilter)type.GetConstructor(Type.EmptyTypes)?.Invoke(Array.Empty<object>());

                if(filter != null &&
                   !Filters.ContainsKey(filter.Name.ToLower()))
                    Filters.Add(filter.Name.ToLower(), filter);
            }
            catch(Exception exception)
            {
                AaruConsole.ErrorWriteLine(Localization.Exception_0, exception);
            }
    }

    /// <summary>Gets the filter that allows to read the specified path</summary>
    /// <param name="path">Path</param>
    /// <returns>The filter that allows reading the specified path</returns>
    public IFilter GetFilter(string path)
    {
        IFilter noFilter = null;

        foreach(IFilter filter in Filters.Values)
            try
            {
                if(filter.Id != new Guid("12345678-AAAA-BBBB-CCCC-123456789000"))
                {
                    if(!filter.Identify(path))
                        continue;

                    var foundFilter = (IFilter)filter.GetType().GetConstructor(Type.EmptyTypes)?.
                                                      Invoke(Array.Empty<object>());

                    if(foundFilter?.Open(path) == ErrorNumber.NoError)
                        return foundFilter;
                }
                else
                    noFilter = filter;
            }
            catch(IOException)
            {
                // Ignore and continue
            }

        if(!noFilter?.Identify(path) == true)
            return null;

        noFilter?.Open(path);

        return noFilter;
    }
}