cached_plugin_descriptors.h

// SPDX-FileCopyrightText: © 2020-2021, 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
#include "gui/dsp/plugin_descriptor.h"
#include "utils/serialization.h"

 
namespace zrythm::gui::old_dsp::plugins
{

class CachedPluginDescriptors final
{
public:
  static std::unique_ptr<CachedPluginDescriptors> read_or_new ();

  void serialize_to_file ();

  void serialize_to_file_no_throw ()
  {
    try
      {
        serialize_to_file ();
      }
    catch (const ZrythmException &e)
      {
        z_warning (e.what ());
      }
  }
 
  static constexpr int  get_format_major_version () { return 6; }
  static constexpr int  get_format_minor_version () { return 0; }
  static constexpr auto get_document_type ()
  {
    return "CachedPluginDescriptors"sv;
  }

  bool is_blacklisted (std::string_view sha1);

  std::vector<std::unique_ptr<PluginDescriptor>>
  get_valid_descriptors_for_sha1 (std::string_view sha1);

  bool
  contains_sha1 (std::string_view sha1, bool check_valid, bool check_blacklisted);
 
  bool contains_valid_sha1 (auto sha1)
  {
    return contains_sha1 (sha1, true, false);
  }
 
  bool contains_blacklisted_sha1 (auto sha1)
  {
    return contains_sha1 (sha1, false, true);
  }

  void blacklist (std::string_view sha1, bool serialize);

  void add (const PluginDescriptor &descr, bool serialize);

  void clear ();
 
  static constexpr auto kDescriptorsKey = "descriptors"sv;
  static constexpr auto kBlacklistedSha1sKey = "blacklistedSha1s"sv;
 
private:
  friend void to_json (nlohmann::json &j, const CachedPluginDescriptors &p)
  {
    j = nlohmann::json{
      { utils::serialization::kDocumentTypeKey, get_document_type ()        },
      { utils::serialization::kFormatMajorKey,  get_format_major_version () },
      { utils::serialization::kFormatMinorKey,  get_format_minor_version () },
      { kDescriptorsKey,                        p.descriptors_              },
      { kBlacklistedSha1sKey,                   p.blacklisted_sha1s_        },
    };
  }
  friend void from_json (const nlohmann::json &j, CachedPluginDescriptors &p);

  static void delete_file ();
 
  static fs::path get_file_path ();
 
public:
  std::vector<std::unique_ptr<PluginDescriptor>> descriptors_;

  std::vector<std::string> blacklisted_sha1s_;
};
 
} // namespace zrythm::gui::old_dsp::plugins