Skip to content

Commit

Permalink
Fix persistence of new collections, either from theme or custom name
Browse files Browse the repository at this point in the history
  • Loading branch information
@Gemba
Gemba committed Jul 1, 2024
1 parent 4a064a2 commit 3c41f15
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 81 deletions.
71 changes: 42 additions & 29 deletions es-app/src/CollectionSystemManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#include "ThemeData.h"
#include <pugixml.hpp>
#include <fstream>
#include <cstring>

/* Handling the getting, initialization, deinitialization, saving and deletion of
* a CollectionSystemManager Instance */
Expand Down Expand Up @@ -97,29 +98,37 @@ void CollectionSystemManager::deinit()
}
}

void CollectionSystemManager::saveCustomCollection(SystemData* sys)
bool CollectionSystemManager::saveCustomCollection(SystemData* sys)
{
std::string name = sys->getName();
std::unordered_map<std::string, FileData*> games = sys->getRootFolder()->getChildrenByFilename();
bool found = mCustomCollectionSystemsData.find(name) != mCustomCollectionSystemsData.cend();
if (found) {
CollectionSystemData sysData = mCustomCollectionSystemsData.at(name);
if (sysData.needsSave)
{
std::ofstream configFile;
configFile.open(getCustomCollectionConfigPath(name));
for(std::unordered_map<std::string, FileData*>::const_iterator iter = games.cbegin(); iter != games.cend(); ++iter)
{
std::string path = iter->first;
configFile << path << std::endl;
}
configFile.close();
}
}
else
if (!found)
{
LOG(LogError) << "Couldn't find collection to save! " << name;
return false;
}

CollectionSystemData sysData = mCustomCollectionSystemsData.at(name);
if (sysData.needsSave)
{
std::string absCollectionFn = getCustomCollectionConfigPath(name);
std::ofstream configFile;
configFile.open(absCollectionFn);
if (!configFile.good())
{
auto const errNo = errno;
LOG(LogError) << "Failed to create file, collection not created: " << absCollectionFn << ": " << std::strerror(errNo) << " (" << errNo << ")";
return false;
}
for(std::unordered_map<std::string, FileData*>::const_iterator iter = games.cbegin(); iter != games.cend(); ++iter)
{
std::string path = iter->first;
configFile << path << std::endl;
}
configFile.close();
}
return true;
}

/* Methods to load all Collections into memory, and handle enabling the active ones */
Expand All @@ -128,7 +137,7 @@ void CollectionSystemManager::loadCollectionSystems(bool async)
{
initAutoCollectionSystems();
CollectionSystemDecl decl = mCollectionSystemDeclsIndex[CUSTOM_COLL_ID];
mCustomCollectionsBundle = createNewCollectionEntry(decl.name, decl, false);
mCustomCollectionsBundle = createNewCollectionEntry(decl.name, decl, CollectionFlags::NONE);
// we will also load custom systems here
initCustomCollectionSystems();
if(Settings::getInstance()->getString("CollectionSystemsAuto") != "" || Settings::getInstance()->getString("CollectionSystemsCustom") != "")
Expand Down Expand Up @@ -375,6 +384,7 @@ bool CollectionSystemManager::isThemeCustomCollectionCompatible(std::vector<std:
std::string CollectionSystemManager::getValidNewCollectionName(std::string inName, int index)
{
std::string name = inName;
const std::string infix = " (" + std::to_string(index) + ")";

if(index == 0)
{
Expand All @@ -388,7 +398,7 @@ std::string CollectionSystemManager::getValidNewCollectionName(std::string inNam
}
else
{
name += " (" + std::to_string(index) + ")";
name += infix;
}

if(name == "")
Expand All @@ -398,7 +408,7 @@ std::string CollectionSystemManager::getValidNewCollectionName(std::string inNam

if(name != inName)
{
LOG(LogInfo) << "Had to change name, from: " << inName << " to: " << name;
LOG(LogInfo) << "Name collision, had to change name from: " << inName << " to: " << name;
}

// get used systems in es_systems.cfg
Expand All @@ -418,7 +428,7 @@ std::string CollectionSystemManager::getValidNewCollectionName(std::string inNam
if (*sysIt == name)
{
if(index > 0) {
name = name.substr(0, name.size()-4);
name = name.substr(0, name.size() - infix.size());
}
return getValidNewCollectionName(name, index+1);
}
Expand Down Expand Up @@ -448,22 +458,22 @@ void CollectionSystemManager::setEditMode(std::string collectionName, bool quiet
mEditingCollectionSystemData = sysData;

if (!quiet) {
GuiInfoPopup* s = new GuiInfoPopup(mWindow, "Editing the '" + Utils::String::toUpper(collectionName) + "' Collection. Add/remove games with Y.", 10000);
GuiInfoPopup* s = new GuiInfoPopup(mWindow, "Editing the '" + Utils::String::toUpper(collectionName) + "' Collection. Add/remove games with Y.", 8000);
mWindow->setInfoPopup(s);
}
}

void CollectionSystemManager::exitEditMode(bool quiet)
{
if (!quiet) {
GuiInfoPopup* s = new GuiInfoPopup(mWindow, "Finished editing the '" + mEditingCollection + "' Collection.", 4000);
GuiInfoPopup* s = new GuiInfoPopup(mWindow, "Finished editing the '" + Utils::String::toUpper(mEditingCollection) + "' Collection.", 4000);
mWindow->setInfoPopup(s);
}
if (mIsEditingCustom) {
mIsEditingCustom = false;
mEditingCollection = "Favorites";

mEditingCollectionSystemData->system->onMetaDataSavePoint();
saveCustomCollection(mEditingCollectionSystemData->system);
}
}

Expand Down Expand Up @@ -656,7 +666,7 @@ void CollectionSystemManager::initAutoCollectionSystems()
CollectionSystemDecl sysDecl = it->second;
if (!sysDecl.isCustom)
{
SystemData* newCol = createNewCollectionEntry(sysDecl.name, sysDecl);
SystemData* newCol = createNewCollectionEntry(sysDecl.name, sysDecl, CollectionFlags::HOLD_IN_MAP);
if (sysDecl.type == AUTO_RANDOM)
mRandomCollection = newCol;
}
Expand Down Expand Up @@ -756,17 +766,20 @@ SystemData* CollectionSystemManager::getAllGamesCollection()
return allSysData->system;
}

SystemData* CollectionSystemManager::addNewCustomCollection(std::string name)
SystemData* CollectionSystemManager::addNewCustomCollection(std::string name, bool needsSave)
{
CollectionSystemDecl decl = mCollectionSystemDeclsIndex[CUSTOM_COLL_ID];
decl.themeFolder = name;
decl.name = name;
decl.longName = name;
return createNewCollectionEntry(name, decl);
CollectionFlags flags = CollectionFlags::HOLD_IN_MAP;
if (needsSave)
flags = flags | CollectionFlags::NEEDS_SAVE;
return createNewCollectionEntry(name, decl, flags);
}

// creates a new, empty Collection system, based on the name and declaration
SystemData* CollectionSystemManager::createNewCollectionEntry(std::string name, CollectionSystemDecl sysDecl, bool index)
SystemData* CollectionSystemManager::createNewCollectionEntry(std::string name, CollectionSystemDecl sysDecl, const CollectionFlags flags)
{
SystemData* newSys = new SystemData(name, sysDecl.longName, mCollectionEnvData, sysDecl.themeFolder, true);

Expand All @@ -775,9 +788,9 @@ SystemData* CollectionSystemManager::createNewCollectionEntry(std::string name,
newCollectionData.decl = sysDecl;
newCollectionData.isEnabled = false;
newCollectionData.isPopulated = false;
newCollectionData.needsSave = false;
newCollectionData.needsSave = (flags & CollectionFlags::NEEDS_SAVE) == CollectionFlags::NEEDS_SAVE ? true : false;

if (index)
if ((flags & CollectionFlags::HOLD_IN_MAP) == CollectionFlags::HOLD_IN_MAP)
{
if (!sysDecl.isCustom)
{
Expand Down
24 changes: 21 additions & 3 deletions es-app/src/CollectionSystemManager.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,24 @@ enum CollectionSystemType
CUSTOM_COLLECTION
};

// Flags when loading or creating a collection
enum class CollectionFlags : uint8_t
{
NONE, // create only
HOLD_IN_MAP, // create and keep in mAutoCollectionSystemsData or mCustomCollectionSystemsData
NEEDS_SAVE // force save of newly added collection
};

constexpr CollectionFlags operator|(CollectionFlags a,CollectionFlags b)
{
return static_cast<CollectionFlags>(static_cast<uint8_t>(a) | static_cast<uint8_t>(b));
}

constexpr CollectionFlags operator&(CollectionFlags a, CollectionFlags b)
{
return static_cast<CollectionFlags>(static_cast<uint8_t>(a) & static_cast<uint8_t>(b));
}

struct CollectionSystemDecl
{
CollectionSystemType type; // type of system
Expand Down Expand Up @@ -58,7 +76,7 @@ class CollectionSystemManager
static CollectionSystemManager* get();
static void init(Window* window);
static void deinit();
void saveCustomCollection(SystemData* sys);
bool saveCustomCollection(SystemData* sys);

void loadCollectionSystems(bool async=false);
void loadEnabledListFromSettings();
Expand All @@ -74,7 +92,7 @@ class CollectionSystemManager
inline SystemData* getCustomCollectionsBundle() { return mCustomCollectionsBundle; };
inline SystemData* getRandomCollection() { return mRandomCollection; };
std::vector<std::string> getUnusedSystemsFromTheme();
SystemData* addNewCustomCollection(std::string name);
SystemData* addNewCustomCollection(std::string name, bool needsSave = false);

bool isThemeGenericCollectionCompatible(bool genericCustomCollections);
bool isThemeCustomCollectionCompatible(std::vector<std::string> stringVector);
Expand Down Expand Up @@ -107,7 +125,7 @@ class CollectionSystemManager

void initAutoCollectionSystems();
void initCustomCollectionSystems();
SystemData* createNewCollectionEntry(std::string name, CollectionSystemDecl sysDecl, bool index = true);
SystemData* createNewCollectionEntry(std::string name, CollectionSystemDecl sysDecl, const CollectionFlags flags);
void populateAutoCollection(CollectionSystemData* sysData);
void populateCustomCollection(CollectionSystemData* sysData);
void addRandomGames(SystemData* newSys, SystemData* sourceSystem, FileData* rootFolder, FileFilterIndex* index,
Expand Down
108 changes: 59 additions & 49 deletions es-app/src/guis/GuiCollectionSystemsOptions.cpp
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
#include <fstream>

#include "guis/GuiCollectionSystemsOptions.h"

#include "components/OptionListComponent.h"
#include "components/SwitchComponent.h"
#include "guis/GuiInfoPopup.h"
#include "guis/GuiRandomCollectionOptions.h"
#include "guis/GuiSettings.h"
#include "guis/GuiTextEditPopup.h"
Expand All @@ -25,50 +28,59 @@ void GuiCollectionSystemsOptions::initializeMenu()
// manage random collection
addEntry("RANDOM GAME COLLECTION SETTINGS", 0x777777FF, true, [this] { openRandomCollectionSettings(); });

// add "Create New Custom Collection from Theme"
std::vector<std::string> unusedFolders = CollectionSystemManager::get()->getUnusedSystemsFromTheme();
if (unusedFolders.size() > 0)

ComponentListRow row;
if(CollectionSystemManager::get()->isEditing())
{
addEntry("CREATE NEW CUSTOM COLLECTION FROM THEME", 0x777777FF, true,
[this, unusedFolders] {
auto s = new GuiSettings(mWindow, "SELECT THEME FOLDER");
std::shared_ptr< OptionListComponent<std::string> > folderThemes = std::make_shared< OptionListComponent<std::string> >(mWindow, "SELECT THEME FOLDER", true);
row.addElement(std::make_shared<TextComponent>(mWindow, "FINISH EDITING '" + Utils::String::toUpper(CollectionSystemManager::get()->getEditingCollection()) + "' COLLECTION", Font::get(FONT_SIZE_MEDIUM), 0x777777FF), true);
row.makeAcceptInputHandler(std::bind(&GuiCollectionSystemsOptions::exitEditMode, this));
mMenu.addRow(row);
}
else
{
// add "Create New Custom Collection from Theme"
std::vector<std::string> unusedFolders = CollectionSystemManager::get()->getUnusedSystemsFromTheme();
if (unusedFolders.size() > 0)
{
addEntry("CREATE NEW CUSTOM COLLECTION FROM THEME", 0x777777FF, true,
[this, unusedFolders] {
auto s = new GuiSettings(mWindow, "SELECT THEME FOLDER");
std::shared_ptr< OptionListComponent<std::string> > folderThemes = std::make_shared< OptionListComponent<std::string> >(mWindow, "SELECT THEME FOLDER", true);

// add Custom Systems
for(auto it = unusedFolders.cbegin() ; it != unusedFolders.cend() ; it++ )
{
ComponentListRow row;
std::string name = *it;
// add Custom Systems
for(auto it = unusedFolders.cbegin() ; it != unusedFolders.cend() ; it++ )
{
ComponentListRow row;
std::string name = *it;

std::function<void()> createCollectionCall = [name, this, s] {
createCollection(name);
};
row.makeAcceptInputHandler(createCollectionCall);
std::function<void()> createCollectionCall = [name, this, s] {
createCollection(name);
};
row.makeAcceptInputHandler(createCollectionCall);

auto themeFolder = std::make_shared<TextComponent>(mWindow, Utils::String::toUpper(name), Font::get(FONT_SIZE_SMALL), 0x777777FF);
row.addElement(themeFolder, true);
s->addRow(row);
}
mWindow->pushGui(s);
auto themeFolder = std::make_shared<TextComponent>(mWindow, Utils::String::toUpper(name), Font::get(FONT_SIZE_SMALL), 0x777777FF);
row.addElement(themeFolder, true);
s->addRow(row);
}
mWindow->pushGui(s);
});
}

row.addElement(std::make_shared<TextComponent>(mWindow, "CREATE NEW CUSTOM COLLECTION", Font::get(FONT_SIZE_MEDIUM), 0x777777FF), true);
auto createCustomCollection = [this](const std::string& newVal) {
std::string name = newVal;
// we need to store the first Gui and remove it, as it'll be deleted by the actual Gui
Window* window = mWindow;
GuiComponent* topGui = window->peekGui();
window->removeGui(topGui);
createCollection(name);
};
row.makeAcceptInputHandler([this, createCustomCollection] {
mWindow->pushGui(new GuiTextEditPopup(mWindow, "New Collection Name", "", createCustomCollection, false));
});
mMenu.addRow(row);
}

ComponentListRow row;
row.addElement(std::make_shared<TextComponent>(mWindow, "CREATE NEW CUSTOM COLLECTION", Font::get(FONT_SIZE_MEDIUM), 0x777777FF), true);
auto createCustomCollection = [this](const std::string& newVal) {
std::string name = newVal;
// we need to store the first Gui and remove it, as it'll be deleted by the actual Gui
Window* window = mWindow;
GuiComponent* topGui = window->peekGui();
window->removeGui(topGui);
createCollection(name);
};
row.makeAcceptInputHandler([this, createCustomCollection] {
mWindow->pushGui(new GuiTextEditPopup(mWindow, "New Collection Name", "", createCustomCollection, false));
});

mMenu.addRow(row);

bundleCustomCollections = std::make_shared<SwitchComponent>(mWindow);
bundleCustomCollections->setState(Settings::getInstance()->getBool("UseCustomCollectionsSystem"));
mMenu.addWithLabel("GROUP UNTHEMED CUSTOM COLLECTIONS", bundleCustomCollections);
Expand Down Expand Up @@ -103,14 +115,6 @@ void GuiCollectionSystemsOptions::initializeMenu()

mMenu.addWithLabel("ADD/REMOVE GAMES WHILE SCREENSAVER TO", defaultScreenSaverCollection);

if(CollectionSystemManager::get()->isEditing())
{
row.elements.clear();
row.addElement(std::make_shared<TextComponent>(mWindow, "FINISH EDITING '" + Utils::String::toUpper(CollectionSystemManager::get()->getEditingCollection()) + "' COLLECTION", Font::get(FONT_SIZE_MEDIUM), 0x777777FF), true);
row.makeAcceptInputHandler(std::bind(&GuiCollectionSystemsOptions::exitEditMode, this));
mMenu.addRow(row);
}

mMenu.addButton("BACK", "back", std::bind(&GuiCollectionSystemsOptions::applySettings, this));

mMenu.setPosition((Renderer::getScreenWidth() - mMenu.getSize().x()) / 2, Renderer::getScreenHeight() * 0.15f);
Expand All @@ -137,19 +141,25 @@ void GuiCollectionSystemsOptions::addEntry(const char* name, unsigned int color,

void GuiCollectionSystemsOptions::createCollection(std::string inName)
{
std::string name = CollectionSystemManager::get()->getValidNewCollectionName(inName);
SystemData* newSys = CollectionSystemManager::get()->addNewCustomCollection(name);
CollectionSystemManager* collSysMgr = CollectionSystemManager::get();
std::string name = collSysMgr->getValidNewCollectionName(inName);

SystemData* newSys = collSysMgr->addNewCustomCollection(name, true);
if (!collSysMgr->saveCustomCollection(newSys)) {
GuiInfoPopup* s = new GuiInfoPopup(mWindow, "Failed creating '" + Utils::String::toUpper(name) + "' Collection. See log for details.", 8000);
mWindow->setInfoPopup(s);
return;
}
customOptionList->add(name, name, true);
std::string outAuto = Utils::String::vectorToDelimitedString(autoOptionList->getSelectedObjects(), ",");
std::string outCustom = Utils::String::vectorToDelimitedString(customOptionList->getSelectedObjects(), ",");
updateSettings(outAuto, outCustom);
ViewController::get()->goToSystemView(newSys);

Window* window = mWindow;
CollectionSystemManager::get()->setEditMode(name);
collSysMgr->setEditMode(name);
while(window->peekGui() && window->peekGui() != ViewController::get())
delete window->peekGui();
return;
}

void GuiCollectionSystemsOptions::openRandomCollectionSettings()
Expand Down

0 comments on commit 3c41f15

Please sign in to comment.