Split CreationClubPlugins out from Game

Author: Ortham

resources/l10n/template.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: LOOT 0.25.2\n"
 "Report-Msgid-Bugs-To: https://github.com/loot/loot/issues\n"
-"POT-Creation-Date: 2025-04-03 18:20+0100\n"
+"POT-Creation-Date: 2025-04-03 20:52+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -23,11 +23,11 @@ msgstr ""
 msgid "\"{0}\" contains a condition that could not be evaluated. Details: {1}"
 msgstr ""
 
-#: src/gui/plugin_item.cpp:194
+#: src/gui/plugin_item.cpp:195
 msgid "Location"
 msgstr ""
 
-#: src/gui/plugin_item.cpp:199
+#: src/gui/plugin_item.cpp:200
 #, c++-format
 msgid "Location {0}"
 msgstr ""
@@ -1177,17 +1177,7 @@ msgstr ""
 msgid "The group \"{0}\" does not exist."
 msgstr ""
 
-#: src/gui/state/game/game.cpp:821
-msgid ""
-"Sorting failed because there is at least one installed plugin that depends "
-"on at least one plugin that is not installed."
-msgstr ""
-
-#: src/gui/state/game/game.cpp:858
-msgid "You have not sorted your load order this session."
-msgstr ""
-
-#: src/gui/state/game/game.cpp:936
+#: src/gui/state/game/game.cpp:570
 #, c++-format
 msgid ""
 "An error occurred while parsing the metadata list(s): {0}.\n"
@@ -1206,7 +1196,17 @@ msgid ""
 "[LOOT's website]({1})."
 msgstr ""
 
-#: src/gui/state/game/game.cpp:1115
+#: src/gui/state/game/game.cpp:970
+msgid ""
+"Sorting failed because there is at least one installed plugin that depends "
+"on at least one plugin that is not installed."
+msgstr ""
+
+#: src/gui/state/game/game.cpp:1007
+msgid "You have not sorted your load order this session."
+msgstr ""
+
+#: src/gui/state/game/game.cpp:1127
 msgid ""
 "Failed to load the current load order, information displayed may be "
 "incorrect."

src/gui/plugin_item.cpp

@@ -141,7 +141,8 @@ PluginItem::PluginItem(GameId gameId,
     isLightPlugin(plugin.IsLightPlugin()),
     isMediumPlugin(plugin.IsMediumPlugin()),
     loadsArchive(plugin.LoadsArchive()),
-    isCreationClubPlugin(game.IsCreationClubPlugin(plugin.GetName())) {
+    isCreationClubPlugin(
+        game.GetCreationClubPlugins().IsCreationClubPlugin(plugin.GetName())) {
   auto userMetadata = game.GetUserMetadata(plugin.GetName());
   if (userMetadata.has_value()) {
     hasUserMetadata =

src/gui/qt/main_window.cpp

@@ -1383,7 +1383,7 @@ void MainWindow::handleGameDataLoaded(QueryResult result) {
 
   filtersWidget->setGroups(GetGroupNames(state.GetCurrentGame()));
   filtersWidget->showCreationClubPluginsFilter(
-      state.GetCurrentGame().HadCreationClub());
+      HadCreationClub(state.GetCurrentGame().GetSettings().Id()));
 
   pluginEditorWidget->setBashTagCompletions(
       state.GetCurrentGame().GetKnownBashTags());

src/gui/query/types/get_game_data_query.h

@@ -43,8 +43,8 @@ class GetGameDataQuery : public Query {
       sendProgressUpdate_(sendProgressUpdate) {}
 
   QueryResult executeLogic() override {
-    sendProgressUpdate_(boost::locale::translate(
-        "Parsing, merging and evaluating metadata…"));
+    sendProgressUpdate_(
+        boost::locale::translate("Parsing, merging and evaluating metadata…"));
 
     /* If the game's plugins object is empty, this is the first time loading
        the game data, so also load the metadata lists. */
@@ -77,7 +77,8 @@ class GetGameDataQuery : public Query {
 
     threads.push_back(std::thread([&]() {
       try {
-        game_.LoadCreationClubPluginNames();
+        game_.GetCreationClubPlugins().Load(game_.GetSettings().Id(),
+                                            game_.GetSettings().GamePath());
       } catch (...) {
         if (exceptionPointer == nullptr) {
           exceptionPointer = std::current_exception();

src/gui/state/game/game.cpp

@@ -471,6 +471,55 @@ std::vector<LoadOrderTuple> MapToLoadOrderTuples(
   return data;
 }
 
+bool HadCreationClub(GameId gameId) {
+  return gameId == GameId::tes5se || gameId == GameId::fo4;
+}
+
+void CreationClubPlugins::Load(GameId gameId,
+                               const std::filesystem::path& gamePath) {
+  const auto logger = getLogger();
+
+  creationClubPlugins_.clear();
+
+  if (!HadCreationClub(gameId)) {
+    if (logger) {
+      logger->debug(
+          "The current game was not part of the Creation Club while it was "
+          "active, skipping loading Creation Club plugin names.");
+    }
+    return;
+  }
+
+  const auto cccFilename = GetCCCFilename(gameId);
+
+  if (!cccFilename.has_value()) {
+    if (logger) {
+      logger->debug(
+          "The current game does not have a CCC file, the Creation Club filter "
+          "will have no effect.");
+    }
+    return;
+  }
+
+  const auto cccFilePath = gamePath / cccFilename.value();
+
+  if (!fs::exists(cccFilePath)) {
+    if (logger) {
+      logger->debug(
+          "The CCC file at {} does not exist, the Creation Club filter "
+          "will have no effect.",
+          cccFilePath.u8string());
+    }
+    return;
+  }
+
+  creationClubPlugins_ = ReadFilenamesInFile(cccFilePath);
+}
+
+bool CreationClubPlugins::IsCreationClubPlugin(const std::string& name) const {
+  return creationClubPlugins_.count(Filename(name)) != 0;
+}
+
 namespace gui {
 Game::Game(const GameSettings& gameSettings,
            const std::filesystem::path& lootDataPath,
@@ -484,6 +533,7 @@ Game::Game(const GameSettings& gameSettings,
 
 Game::Game(Game&& game) {
   settings_ = std::move(game.settings_);
+  creationClubPlugins_ = std::move(game.creationClubPlugins_);
   gameHandle_ = std::move(game.gameHandle_);
   messages_ = std::move(game.messages_);
   lootDataPath_ = std::move(game.lootDataPath_);
@@ -497,6 +547,7 @@ Game::Game(Game&& game) {
 Game& Game::operator=(Game&& game) {
   if (&game != this) {
     settings_ = std::move(game.settings_);
+    creationClubPlugins_ = std::move(game.creationClubPlugins_);
     gameHandle_ = std::move(game.gameHandle_);
     messages_ = std::move(game.messages_);
     lootDataPath_ = std::move(game.lootDataPath_);
@@ -514,6 +565,14 @@ const GameSettings& Game::GetSettings() const { return settings_; }
 
 GameSettings& Game::GetSettings() { return settings_; }
 
+const CreationClubPlugins& Game::GetCreationClubPlugins() const {
+  return creationClubPlugins_;
+}
+
+CreationClubPlugins& Game::GetCreationClubPlugins() {
+  return creationClubPlugins_;
+}
+
 void Game::Init() {
   auto logger = getLogger();
   if (logger) {
@@ -596,52 +655,6 @@ void Game::RedatePlugins() {
   }
 }
 
-void Game::LoadCreationClubPluginNames() {
-  const auto logger = getLogger();
-
-  creationClubPlugins_.clear();
-
-  if (!HadCreationClub()) {
-    if (logger) {
-      logger->debug(
-          "The current game was not part of the Creation Club while it was "
-          "active, skipping loading Creation Club plugin names.");
-    }
-    return;
-  }
-
-  const auto cccFilename = GetCCCFilename(settings_.Id());
-
-  if (!cccFilename.has_value()) {
-    if (logger) {
-      logger->debug(
-          "The current game does not have a CCC file, the Creation Club filter "
-          "will have no effect.");
-    }
-    return;
-  }
-
-  const auto cccFilePath = settings_.GamePath() / cccFilename.value();
-
-  if (!fs::exists(cccFilePath)) {
-    if (logger) {
-      logger->debug(
-          "The CCC file at {} does not exist, the Creation Club filter "
-          "will have no effect.",
-          cccFilePath.u8string());
-    }
-    return;
-  }
-
-  creationClubPlugins_ = ReadFilenamesInFile(cccFilePath);
-}
-
-bool Game::HadCreationClub() const {
-  // The Creation Club has been replaced, but while it was active it was
-  // available for Skyrim SE and Fallout 4.
-  return settings_.Id() == GameId::tes5se || settings_.Id() == GameId::fo4;
-}
-
 void Game::LoadAllInstalledPlugins(bool headersOnly) {
   LoadCurrentLoadOrderState();
 
@@ -1081,10 +1094,6 @@ void Game::AppendMessages(std::vector<SourcedMessage> messages) {
   }
 }
 
-bool Game::IsCreationClubPlugin(const std::string& name) const {
-  return creationClubPlugins_.count(Filename(name)) != 0;
-}
-
 std::optional<std::filesystem::path> Game::ResolveGameFilePath(
     const std::string& filePath) const {
   return loot::ResolveGameFilePath(settings_.Id(),

src/gui/state/game/game.h

@@ -65,6 +65,21 @@ std::filesystem::path GetMasterlistPath(
 void InitLootGameFolder(const std::filesystem::path& lootDataPath_,
                         const GameSettings& settings);
 
+// The Creation Club has been replaced, but while it was active it was
+// available for Skyrim SE and Fallout 4.
+bool HadCreationClub(GameId gameId);
+
+class CreationClubPlugins {
+public:
+  void Load(GameId gameId, const std::filesystem::path& gamePath);
+
+  bool IsCreationClubPlugin(const std::string& name) const;
+
+private:
+  // Use Filename to benefit from libloot's case-insensitive comparisons.
+  std::set<Filename> creationClubPlugins_;
+};
+
 namespace gui {
 class Game {
 public:
@@ -81,6 +96,9 @@ class Game {
   const GameSettings& GetSettings() const;
   GameSettings& GetSettings();
 
+  const CreationClubPlugins& GetCreationClubPlugins() const;
+  CreationClubPlugins& GetCreationClubPlugins();
+
   void Init();
   bool IsInitialised() const;
 
@@ -93,10 +111,6 @@ class Game {
 
   void RedatePlugins();  // Change timestamps to match load order (Skyrim only).
 
-  void LoadCreationClubPluginNames();
-  bool HadCreationClub() const;
-  bool IsCreationClubPlugin(const std::string& name) const;
-
   void LoadAllInstalledPlugins(
       bool headersOnly);  // Loads all installed plugins.
   bool ArePluginsFullyLoaded()
@@ -165,6 +179,7 @@ class Game {
   void LoadCurrentLoadOrderState();
 
   GameSettings settings_;
+  CreationClubPlugins creationClubPlugins_;
   std::unique_ptr<GameInterface> gameHandle_;
   std::vector<SourcedMessage> messages_;
   std::filesystem::path lootDataPath_;
@@ -173,9 +188,6 @@ class Game {
   bool pluginsFullyLoaded_{false};
   bool isMicrosoftStoreInstall_{false};
   bool supportsLightPlugins_{false};
-
-  // Use Filename to benefit from libloot's case-insensitive comparisons.
-  std::set<Filename> creationClubPlugins_;
 };
 }