Merge c930587250 into e8fb5a0869

Fix persistence of new collections, either from theme or custom name

es-app/src/CollectionSystemManager.cpp

@@ -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 */
@@ -97,17 +98,29 @@ 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) {
+	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(getCustomCollectionConfigPath(name));
+		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;
@@ -115,11 +128,7 @@ void CollectionSystemManager::saveCustomCollection(SystemData* sys)
 		}
 		configFile.close();
 	}
-	}
+	return true;
-	else
-	{
-		LOG(LogError) << "Couldn't find collection to save! " << name;
-	}
 }
 
 /* Methods to load all Collections into memory, and handle enabling the active ones */
@@ -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") != "")
@@ -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)
 	{
@@ -388,7 +398,7 @@ std::string CollectionSystemManager::getValidNewCollectionName(std::string inNam
 	}
 	else
 	{
-		name += " (" + std::to_string(index) + ")";
+		name += infix;
 	}
 
 	if(name == "")
@@ -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
@@ -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);
 		}
@@ -448,7 +458,7 @@ 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);
 	}
 }
@@ -456,14 +466,14 @@ void CollectionSystemManager::setEditMode(std::string collectionName, bool quiet
 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);
 	}
 }
 
@@ -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;
 		}
@@ -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);
 
@@ -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)
 		{

es-app/src/CollectionSystemManager.h

@@ -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
@@ -58,7 +76,7 @@ public:
 	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();
@@ -74,7 +92,7 @@ public:
 	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);
@@ -107,7 +125,7 @@ private:
 
 	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,

es-app/src/guis/GuiCollectionSystemsOptions.cpp

@@ -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"
@@ -25,6 +28,16 @@ void GuiCollectionSystemsOptions::initializeMenu()
 	// manage random collection
 	addEntry("RANDOM GAME COLLECTION SETTINGS", 0x777777FF, true, [this] { openRandomCollectionSettings(); });
 
+
+	ComponentListRow row;
+	if(CollectionSystemManager::get()->isEditing())
+	{
+		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)
@@ -53,7 +66,6 @@ void GuiCollectionSystemsOptions::initializeMenu()
 			});
 		}
 
-	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;
@@ -66,8 +78,8 @@ void GuiCollectionSystemsOptions::initializeMenu()
 		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"));
@@ -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);
@@ -137,8 +141,15 @@ void GuiCollectionSystemsOptions::addEntry(const char* name, unsigned int color,
 
 void GuiCollectionSystemsOptions::createCollection(std::string inName)
 {
-	std::string name = CollectionSystemManager::get()->getValidNewCollectionName(inName);
+	CollectionSystemManager* collSysMgr = CollectionSystemManager::get();
-	SystemData* newSys = CollectionSystemManager::get()->addNewCustomCollection(name);
+	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(), ",");
@@ -146,10 +157,9 @@ void GuiCollectionSystemsOptions::createCollection(std::string inName)
 	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()

es-app/src/views/gamelist/BasicGameListView.cpp

@@ -66,9 +66,13 @@ void BasicGameListView::setCursor(FileData* cursor, bool refreshListCursorPos)
 	if (refreshListCursorPos)
 		setViewportTop(mList.REFRESH_LIST_CURSOR_POS);
 
-	if(!mList.setCursor(cursor) && (!cursor->isPlaceHolder()))
+	bool notInList = !mList.setCursor(cursor);
+	if(!refreshListCursorPos && notInList && !cursor->isPlaceHolder())
 	{
 		populateList(cursor->getParent()->getChildrenListToDisplay());
+		// this extra call is needed iff a system has games organized in folders
+		// and the cursor is focusing a game in a folder
+		if (cursor->getParent()->getType() == FOLDER)
 			mList.setCursor(cursor);
 
 		// update our cursor stack in case our cursor just got set to some folder we weren't in before