// SPDX-License-Identifier: MIT // // ES-DE Frontend // FileFilterIndex.cpp // // Gamelist filters. // #include "FileFilterIndex.h" #include "FileData.h" #include "Log.h" #include "Settings.h" #include "UIModeController.h" #include "utils/LocalizationUtil.h" #include "utils/StringUtil.h" #include "views/ViewController.h" #include #define UNKNOWN_LABEL "UNKNOWN" #define INCLUDE_UNKNOWN false; FileFilterIndex::FileFilterIndex() : mFilterByText {false} , mFilterByRatings {false} , mFilterByDeveloper {false} , mFilterByPublisher {false} , mFilterByGenre {false} , mFilterByPlayers {false} , mFilterByFavorites {false} , mFilterByCompleted {false} , mFilterByKidGame {false} , mFilterByHidden {false} , mFilterByBroken {false} , mFilterByController {false} , mFilterByAltemulator {false} { clearAllFilters(); // clang-format off FilterDataDecl filterDecls[] = { //type //allKeys //filteredBy //filteredKeys //primaryKey //hasSecondaryKey //secondaryKey //menuLabel {RATINGS_FILTER, &mRatingsIndexAllKeys, &mFilterByRatings, &mRatingsIndexFilteredKeys, "rating", false, "", _("RATING")}, {DEVELOPER_FILTER, &mDeveloperIndexAllKeys, &mFilterByDeveloper, &mDeveloperIndexFilteredKeys, "developer", false, "", _("DEVELOPER")}, {PUBLISHER_FILTER, &mPublisherIndexAllKeys, &mFilterByPublisher, &mPublisherIndexFilteredKeys, "publisher", false, "", _("PUBLISHER")}, {GENRE_FILTER, &mGenreIndexAllKeys, &mFilterByGenre, &mGenreIndexFilteredKeys, "genre", true, "genre", _("GENRE")}, {PLAYER_FILTER, &mPlayersIndexAllKeys, &mFilterByPlayers, &mPlayersIndexFilteredKeys, "players", false, "", _("PLAYERS")}, {FAVORITES_FILTER, &mFavoritesIndexAllKeys, &mFilterByFavorites, &mFavoritesIndexFilteredKeys, "favorite", false, "", _("FAVORITE")}, {COMPLETED_FILTER, &mCompletedIndexAllKeys, &mFilterByCompleted, &mCompletedIndexFilteredKeys, "completed", false, "", _("COMPLETED")}, {KIDGAME_FILTER, &mKidGameIndexAllKeys, &mFilterByKidGame, &mKidGameIndexFilteredKeys, "kidgame", false, "", _("KIDGAME")}, {HIDDEN_FILTER, &mHiddenIndexAllKeys, &mFilterByHidden, &mHiddenIndexFilteredKeys, "hidden", false, "", _("HIDDEN")}, {BROKEN_FILTER, &mBrokenIndexAllKeys, &mFilterByBroken, &mBrokenIndexFilteredKeys, "broken", false, "", _("BROKEN")}, {CONTROLLER_FILTER, &mControllerIndexAllKeys, &mFilterByController, &mControllerIndexFilteredKeys, "controller", false, "", _("CONTROLLER")}, {ALTEMULATOR_FILTER, &mAltemulatorIndexAllKeys, &mFilterByAltemulator, &mAltemulatorIndexFilteredKeys, "altemulator", false, "", _("ALTERNATIVE EMULATOR")} }; // clang-format on filterDataDecl = std::vector( filterDecls, filterDecls + sizeof(filterDecls) / sizeof(filterDecls[0])); #if defined(GETTEXT_DUMMY_ENTRIES) // This is just to get gettext msgid entries added to the PO message catalog files. _("FALSE"); _("TRUE"); #endif } FileFilterIndex::~FileFilterIndex() { // Reset the index when destroyed. resetIndex(); } void FileFilterIndex::importIndex(FileFilterIndex* indexToImport) { struct IndexImportStructure { std::map* destinationIndex; std::map* sourceIndex; }; IndexImportStructure indexStructDecls[] = { {&mRatingsIndexAllKeys, &(indexToImport->mRatingsIndexAllKeys)}, {&mDeveloperIndexAllKeys, &(indexToImport->mDeveloperIndexAllKeys)}, {&mPublisherIndexAllKeys, &(indexToImport->mPublisherIndexAllKeys)}, {&mGenreIndexAllKeys, &(indexToImport->mGenreIndexAllKeys)}, {&mPlayersIndexAllKeys, &(indexToImport->mPlayersIndexAllKeys)}, {&mFavoritesIndexAllKeys, &(indexToImport->mFavoritesIndexAllKeys)}, {&mCompletedIndexAllKeys, &(indexToImport->mCompletedIndexAllKeys)}, {&mKidGameIndexAllKeys, &(indexToImport->mKidGameIndexAllKeys)}, {&mHiddenIndexAllKeys, &(indexToImport->mHiddenIndexAllKeys)}, {&mBrokenIndexAllKeys, &(indexToImport->mBrokenIndexAllKeys)}, {&mControllerIndexAllKeys, &(indexToImport->mControllerIndexAllKeys)}, {&mAltemulatorIndexAllKeys, &(indexToImport->mAltemulatorIndexAllKeys)}, }; std::vector indexImportDecl {std::vector( indexStructDecls, indexStructDecls + sizeof(indexStructDecls) / sizeof(indexStructDecls[0]))}; for (std::vector::const_iterator indexesIt = indexImportDecl.cbegin(); indexesIt != indexImportDecl.cend(); ++indexesIt) { for (std::map::const_iterator sourceIt = (*indexesIt).sourceIndex->cbegin(); sourceIt != (*indexesIt).sourceIndex->cend(); ++sourceIt) { if ((*indexesIt).destinationIndex->find((*sourceIt).first) == (*indexesIt).destinationIndex->cend()) { // Entry doesn't exist. (*((*indexesIt).destinationIndex))[(*sourceIt).first] = (*sourceIt).second; } else { (*((*indexesIt).destinationIndex))[(*sourceIt).first] += (*sourceIt).second; } } } } void FileFilterIndex::resetIndex() { clearAllFilters(); clearIndex(mRatingsIndexAllKeys); clearIndex(mDeveloperIndexAllKeys); clearIndex(mPublisherIndexAllKeys); clearIndex(mGenreIndexAllKeys); clearIndex(mPlayersIndexAllKeys); clearIndex(mFavoritesIndexAllKeys); clearIndex(mCompletedIndexAllKeys); clearIndex(mKidGameIndexAllKeys); clearIndex(mHiddenIndexAllKeys); clearIndex(mBrokenIndexAllKeys); clearIndex(mControllerIndexAllKeys); clearIndex(mAltemulatorIndexAllKeys); } std::string FileFilterIndex::getIndexableKey(FileData* game, FilterIndexType type, bool getSecondary) { std::string key = ""; switch (type) { case RATINGS_FILTER: { int ratingNumber = 0; if (!getSecondary) { std::string ratingString = game->metadata.get("rating"); if (!ratingString.empty()) { try { // Round up fractional values such as 0.75 to 0.8. // These values should only exist if a third party application has // been used for scraping the ratings, or if the gamelist.xml file // has been manually edited. ratingNumber = static_cast((ceilf(stof(ratingString) / 0.1f) / 10.0f) * 5.0f); if (ratingNumber < 0) ratingNumber = 0; if (ratingNumber == 5) key = "5"; else key = std::to_string(ratingNumber) + " - " + std::to_string(ratingNumber) + ".5"; } catch (int e) { LOG(LogError) << "Error parsing Rating (invalid value, exception nr.): " << ratingString << ", " << e; } } } break; } case DEVELOPER_FILTER: { key = Utils::String::toUpper(game->metadata.get("developer")); break; } case PUBLISHER_FILTER: { key = Utils::String::toUpper(game->metadata.get("publisher")); break; } case GENRE_FILTER: { key = Utils::String::toUpper(game->metadata.get("genre")); if (getSecondary && !key.empty()) { std::istringstream f(key); std::string newKey; getline(f, newKey, '/'); if (!newKey.empty() && newKey != key) key = newKey; else key = std::string(); } break; } case PLAYER_FILTER: { if (getSecondary) break; key = Utils::String::toUpper(game->metadata.get("players")); break; } case FAVORITES_FILTER: { if (game->getType() != GAME) return "FALSE"; key = Utils::String::toUpper(game->metadata.get("favorite")); break; } case COMPLETED_FILTER: { if (game->getType() != GAME) return "FALSE"; key = Utils::String::toUpper(game->metadata.get("completed")); break; } case KIDGAME_FILTER: { if (game->getType() != GAME) return "FALSE"; key = Utils::String::toUpper(game->metadata.get("kidgame")); break; } case HIDDEN_FILTER: { if (game->getType() != GAME) return "FALSE"; key = Utils::String::toUpper(game->metadata.get("hidden")); break; } case BROKEN_FILTER: { if (game->getType() != GAME) return "FALSE"; key = Utils::String::toUpper(game->metadata.get("broken")); break; } case CONTROLLER_FILTER: { if (getSecondary) break; key = Utils::String::toUpper(game->metadata.get("controller")); break; } case ALTEMULATOR_FILTER: { if (getSecondary) break; key = Utils::String::toUpper(game->metadata.get("altemulator")); break; } default: break; } key = Utils::String::trim(key); // Add a dummy value in case there is no metadata defined so we can filter based on this. if ((type == GENRE_FILTER || type == PLAYER_FILTER || type == DEVELOPER_FILTER || type == PUBLISHER_FILTER) && Utils::String::toUpper(key) == UNKNOWN_LABEL) key = ViewController::CROSSEDCIRCLE_CHAR + " " + _("UNKNOWN"); else if ((type == CONTROLLER_FILTER || type == ALTEMULATOR_FILTER) && key.empty()) key = ViewController::CROSSEDCIRCLE_CHAR + " " + _("NONE SELECTED"); else if (key.empty() || (type == RATINGS_FILTER && key == "0")) key = UNKNOWN_LABEL; return key; } void FileFilterIndex::addToIndex(FileData* game) { manageRatingsEntryInIndex(game); manageDeveloperEntryInIndex(game); managePublisherEntryInIndex(game); manageGenreEntryInIndex(game); managePlayerEntryInIndex(game); manageFavoritesEntryInIndex(game); manageCompletedEntryInIndex(game); manageKidGameEntryInIndex(game); manageHiddenEntryInIndex(game); manageBrokenEntryInIndex(game); manageControllerEntryInIndex(game); manageAltemulatorEntryInIndex(game); } void FileFilterIndex::removeFromIndex(FileData* game) { manageRatingsEntryInIndex(game, true); manageDeveloperEntryInIndex(game, true); managePublisherEntryInIndex(game, true); manageGenreEntryInIndex(game, true); managePlayerEntryInIndex(game, true); manageFavoritesEntryInIndex(game, true); manageCompletedEntryInIndex(game, true); manageKidGameEntryInIndex(game, true); manageHiddenEntryInIndex(game, true); manageBrokenEntryInIndex(game, true); manageControllerEntryInIndex(game, true); manageAltemulatorEntryInIndex(game, true); } void FileFilterIndex::setFilter(FilterIndexType type, std::vector* values) { // Test if it exists before setting. if (type == NONE) { clearAllFilters(); } else { for (std::vector::const_iterator it = filterDataDecl.cbegin(); it != filterDataDecl.cend(); ++it) { if ((*it).type == type) { FilterDataDecl filterData = (*it); *(filterData.filteredByRef) = values->size() > 0; filterData.currentFilteredKeys->clear(); for (std::vector::const_iterator vit = values->cbegin(); vit != values->cend(); ++vit) { // Check if it exists. if (filterData.allIndexKeys->find(*vit) != filterData.allIndexKeys->cend()) { filterData.currentFilteredKeys->push_back(std::string(*vit)); } } } } } return; } void FileFilterIndex::setTextFilter(std::string textFilter) { mTextFilter = textFilter; if (textFilter == "") mFilterByText = false; else mFilterByText = true; } void FileFilterIndex::clearAllFilters() { for (std::vector::const_iterator it = filterDataDecl.cbegin(); it != filterDataDecl.cend(); ++it) { FilterDataDecl filterData = (*it); *(filterData.filteredByRef) = false; filterData.currentFilteredKeys->clear(); } setTextFilter(""); return; } void FileFilterIndex::resetFilters() { clearAllFilters(); setKidModeFilters(); } void FileFilterIndex::setKidModeFilters() { if (UIModeController::getInstance()->isUIModeKid()) { mFilterByKidGame = true; std::vector val = {"TRUE"}; setFilter(KIDGAME_FILTER, &val); } } void FileFilterIndex::debugPrintIndexes() { LOG(LogInfo) << "Printing Indexes..."; for (auto x : mRatingsIndexAllKeys) { LOG(LogInfo) << "Ratings Index: " << x.first << ": " << x.second; } for (auto x : mDeveloperIndexAllKeys) { LOG(LogInfo) << "Developer Index: " << x.first << ": " << x.second; } for (auto x : mPublisherIndexAllKeys) { LOG(LogInfo) << "Publisher Index: " << x.first << ": " << x.second; } for (auto x : mGenreIndexAllKeys) { LOG(LogInfo) << "Genre Index: " << x.first << ": " << x.second; } for (auto x : mPlayersIndexAllKeys) { LOG(LogInfo) << "Players Index: " << x.first << ": " << x.second; } for (auto x : mFavoritesIndexAllKeys) { LOG(LogInfo) << "Favorites Index: " << x.first << ": " << x.second; } for (auto x : mCompletedIndexAllKeys) { LOG(LogInfo) << "Completed Index: " << x.first << ": " << x.second; } for (auto x : mKidGameIndexAllKeys) { LOG(LogInfo) << "KidGames Index: " << x.first << ": " << x.second; } for (auto x : mHiddenIndexAllKeys) { LOG(LogInfo) << "Hidden Index: " << x.first << ": " << x.second; } for (auto x : mBrokenIndexAllKeys) { LOG(LogInfo) << "Broken Index: " << x.first << ": " << x.second; } for (auto x : mControllerIndexAllKeys) { LOG(LogInfo) << "Controller Index: " << x.first << ": " << x.second; } for (auto x : mAltemulatorIndexAllKeys) { LOG(LogInfo) << "Altemulator Index: " << x.first << ": " << x.second; } } bool FileFilterIndex::showFile(FileData* game) { // If folder, needs further inspection - i.e. see if folder contains at least one element // that should be shown. if (game->getType() == FOLDER) { std::vector children = game->getChildren(); // Iterate through all of the children, until there's a match. for (std::vector::const_iterator it = children.cbegin(); it != children.cend(); ++it) { if (showFile(*it)) return true; } return false; } bool nameMatch = false; bool keepGoing = false; // Name filters take precedence over all other filters, so if there is no match for // the game name, then always return false. if (mTextFilter != "" && !(Utils::String::toUpper(game->getName()).find(Utils::String::toUpper(mTextFilter)) != std::string::npos)) { return false; } if (mTextFilter != "") nameMatch = true; for (std::vector::const_iterator it = filterDataDecl.cbegin(); it != filterDataDecl.cend(); ++it) { FilterDataDecl filterData = (*it); if (filterData.primaryKey == "kidgame" && UIModeController::getInstance()->isUIModeKid()) { return (getIndexableKey(game, filterData.type, false) != "FALSE"); } else if (*(filterData.filteredByRef)) { // Try to find a match. std::string key = getIndexableKey(game, filterData.type, false); keepGoing = isKeyBeingFilteredBy(key, filterData.type); // If we didn't find a match, try for secondary keys - i.e. // publisher and dev, or first genre. if (!keepGoing) { if (!filterData.hasSecondaryKey) return false; std::string secKey = getIndexableKey(game, filterData.type, true); if (secKey != UNKNOWN_LABEL) keepGoing = isKeyBeingFilteredBy(secKey, filterData.type); } // If still nothing, then it's not a match. if (!keepGoing) return false; } } // If there is a match for the game name, but not for any other filters, then return // true as it means that the name filter is the only applied filter. if (!keepGoing && nameMatch) return true; else return keepGoing; } bool FileFilterIndex::isFiltered() { if (UIModeController::getInstance()->isUIModeKid()) { return (mFilterByText || mFilterByRatings || mFilterByDeveloper || mFilterByPublisher || mFilterByGenre || mFilterByPlayers || mFilterByFavorites || mFilterByCompleted || mFilterByHidden || mFilterByBroken || mFilterByController || mFilterByAltemulator); } else { return (mFilterByText || mFilterByRatings || mFilterByDeveloper || mFilterByPublisher || mFilterByGenre || mFilterByPlayers || mFilterByFavorites || mFilterByCompleted || mFilterByKidGame || mFilterByHidden || mFilterByBroken || mFilterByController || mFilterByAltemulator); } } bool FileFilterIndex::isKeyBeingFilteredBy(std::string key, FilterIndexType type) { const FilterIndexType filterTypes[12] = { RATINGS_FILTER, DEVELOPER_FILTER, PUBLISHER_FILTER, GENRE_FILTER, PLAYER_FILTER, FAVORITES_FILTER, COMPLETED_FILTER, KIDGAME_FILTER, HIDDEN_FILTER, BROKEN_FILTER, CONTROLLER_FILTER, ALTEMULATOR_FILTER}; std::vector filterKeysList[12] = { mRatingsIndexFilteredKeys, mDeveloperIndexFilteredKeys, mPublisherIndexFilteredKeys, mGenreIndexFilteredKeys, mPlayersIndexFilteredKeys, mFavoritesIndexFilteredKeys, mCompletedIndexFilteredKeys, mKidGameIndexFilteredKeys, mHiddenIndexFilteredKeys, mBrokenIndexFilteredKeys, mControllerIndexFilteredKeys, mAltemulatorIndexFilteredKeys}; for (int i = 0; i < 12; ++i) { if (filterTypes[i] == type) { for (std::vector::const_iterator it = filterKeysList[i].cbegin(); it != filterKeysList[i].cend(); ++it) { if (key == (*it)) return true; } return false; } } return false; } void FileFilterIndex::manageRatingsEntryInIndex(FileData* game, bool remove) { std::string key = getIndexableKey(game, RATINGS_FILTER, false); // Flag for including unknowns. bool includeUnknown = INCLUDE_UNKNOWN; if (!includeUnknown && key == UNKNOWN_LABEL) // No valid rating info found. return; manageIndexEntry(&mRatingsIndexAllKeys, key, remove); } void FileFilterIndex::manageDeveloperEntryInIndex(FileData* game, bool remove) { bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, DEVELOPER_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) return; manageIndexEntry(&mDeveloperIndexAllKeys, key, remove); key = getIndexableKey(game, DEVELOPER_FILTER, true); if (!includeUnknown && key == UNKNOWN_LABEL) manageIndexEntry(&mDeveloperIndexAllKeys, key, remove); } void FileFilterIndex::managePublisherEntryInIndex(FileData* game, bool remove) { bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, PUBLISHER_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) return; manageIndexEntry(&mPublisherIndexAllKeys, key, remove); key = getIndexableKey(game, PUBLISHER_FILTER, true); if (!includeUnknown && key == UNKNOWN_LABEL) manageIndexEntry(&mPublisherIndexAllKeys, key, remove); } void FileFilterIndex::manageGenreEntryInIndex(FileData* game, bool remove) { bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, GENRE_FILTER, false); if (!includeUnknown && (key == UNKNOWN_LABEL || key == "BIOS")) return; manageIndexEntry(&mGenreIndexAllKeys, key, remove); key = getIndexableKey(game, GENRE_FILTER, true); if (!includeUnknown && key == UNKNOWN_LABEL) manageIndexEntry(&mGenreIndexAllKeys, key, remove); } void FileFilterIndex::managePlayerEntryInIndex(FileData* game, bool remove) { bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, PLAYER_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) return; manageIndexEntry(&mPlayersIndexAllKeys, key, remove); } void FileFilterIndex::manageFavoritesEntryInIndex(FileData* game, bool remove) { bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, FAVORITES_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) return; manageIndexEntry(&mFavoritesIndexAllKeys, key, remove); } void FileFilterIndex::manageCompletedEntryInIndex(FileData* game, bool remove) { // Flag for including unknowns. bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, COMPLETED_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) // No valid completed info found. return; manageIndexEntry(&mCompletedIndexAllKeys, key, remove); } void FileFilterIndex::manageKidGameEntryInIndex(FileData* game, bool remove) { // Flag for including unknowns. bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, KIDGAME_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) // No valid kidgame info found. return; manageIndexEntry(&mKidGameIndexAllKeys, key, remove); } void FileFilterIndex::manageHiddenEntryInIndex(FileData* game, bool remove) { // Flag for including unknowns. bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, HIDDEN_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) // No valid hidden info found. return; manageIndexEntry(&mHiddenIndexAllKeys, key, remove); } void FileFilterIndex::manageBrokenEntryInIndex(FileData* game, bool remove) { // Flag for including unknowns. bool includeUnknown = INCLUDE_UNKNOWN; std::string key = getIndexableKey(game, BROKEN_FILTER, false); if (!includeUnknown && key == UNKNOWN_LABEL) // No valid broken info found. return; manageIndexEntry(&mBrokenIndexAllKeys, key, remove); } void FileFilterIndex::manageControllerEntryInIndex(FileData* game, bool remove) { std::string key = getIndexableKey(game, CONTROLLER_FILTER, false); manageIndexEntry(&mControllerIndexAllKeys, key, remove); } void FileFilterIndex::manageAltemulatorEntryInIndex(FileData* game, bool remove) { std::string key = getIndexableKey(game, ALTEMULATOR_FILTER, false); manageIndexEntry(&mAltemulatorIndexAllKeys, key, remove); } void FileFilterIndex::manageIndexEntry(std::map* index, std::string key, bool remove) { bool includeUnknown = INCLUDE_UNKNOWN; if (!includeUnknown && key == UNKNOWN_LABEL) return; if (remove) { // Removing entry. if (index->find(key) == index->cend()) { // Disabled for now as this could happen because default values are assigned as // filters, for example 'FALSE' for favorites and kidgames for non-game entries. // LOG(LogDebug) << "Couldn't find entry in index! " << key; } else { --(index->at(key)); if (index->at(key) <= 0) { index->erase(key); } } } else { // Adding entry. if (index->find(key) == index->cend()) (*index)[key] = 1; else ++(index->at(key)); } }