2020-09-21 17:17:34 +00:00
|
|
|
// SPDX-License-Identifier: MIT
|
2020-06-06 11:10:33 +00:00
|
|
|
//
|
2020-09-21 17:17:34 +00:00
|
|
|
// EmulationStation Desktop Edition
|
2020-06-21 12:25:28 +00:00
|
|
|
// GuiScraperMenu.cpp
|
2020-06-06 11:10:33 +00:00
|
|
|
//
|
2020-06-21 12:25:28 +00:00
|
|
|
// Game media scraper, including settings as well as the scraping start button.
|
|
|
|
// Submenu to the GuiMenu main menu.
|
|
|
|
// Will call GuiScraperMulti to perform the actual scraping.
|
2020-06-06 11:10:33 +00:00
|
|
|
//
|
|
|
|
|
|
|
|
#include "guis/GuiScraperMenu.h"
|
|
|
|
|
|
|
|
#include "components/OptionListComponent.h"
|
|
|
|
#include "components/SwitchComponent.h"
|
|
|
|
#include "guis/GuiMsgBox.h"
|
|
|
|
#include "guis/GuiScraperMulti.h"
|
|
|
|
#include "views/ViewController.h"
|
|
|
|
#include "FileData.h"
|
|
|
|
#include "SystemData.h"
|
|
|
|
#include "guis/GuiSettings.h"
|
|
|
|
|
2020-11-06 19:27:41 +00:00
|
|
|
GuiScraperMenu::GuiScraperMenu(Window* window, std::string title)
|
|
|
|
: GuiComponent(window), mMenu(window, title)
|
2020-06-06 11:10:33 +00:00
|
|
|
{
|
2020-11-05 17:18:11 +00:00
|
|
|
// Scraper service.
|
|
|
|
mScraper = std::make_shared<OptionListComponent<std::string>>
|
2020-06-21 12:25:28 +00:00
|
|
|
(mWindow, getHelpStyle(), "SCRAPE FROM", false);
|
|
|
|
std::vector<std::string> scrapers = getScraperList();
|
|
|
|
// Select either the first entry or the one read from the settings,
|
|
|
|
// just in case the scraper from settings has vanished.
|
|
|
|
for (auto it = scrapers.cbegin(); it != scrapers.cend(); it++)
|
2020-11-05 17:18:11 +00:00
|
|
|
mScraper->add(*it, *it, *it == Settings::getInstance()->getString("Scraper"));
|
|
|
|
mMenu.addWithLabel("SCRAPE FROM", mScraper);
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
// Search filters, getSearches() will generate a queue of games to scrape
|
|
|
|
// based on the outcome of the checks below.
|
|
|
|
mFilters = std::make_shared< OptionListComponent<GameFilterFunc>>
|
|
|
|
(mWindow, getHelpStyle(), "SCRAPE THESE GAMES", false);
|
2020-12-16 16:35:23 +00:00
|
|
|
mFilters->add("ALL GAMES", [](SystemData*, FileData*) -> bool { return true; }, false);
|
2020-08-06 09:27:16 +00:00
|
|
|
mFilters->add("FAVORITE GAMES", [](SystemData*, FileData* g) -> bool {
|
|
|
|
return g->getFavorite(); }, false);
|
|
|
|
mFilters->add("NO METADATA", [](SystemData*, FileData* g) -> bool {
|
2020-06-21 12:25:28 +00:00
|
|
|
return g->metadata.get("desc").empty(); }, false);
|
|
|
|
mFilters->add("NO GAME IMAGE",
|
|
|
|
[](SystemData*, FileData* g) -> bool {
|
|
|
|
return g->getImagePath().empty(); }, false);
|
2020-08-06 09:27:16 +00:00
|
|
|
mFilters->add("NO GAME VIDEO",
|
|
|
|
[](SystemData*, FileData* g) -> bool {
|
|
|
|
return g->getVideoPath().empty(); }, false);
|
2020-09-26 12:03:17 +00:00
|
|
|
mFilters->add("FOLDERS ONLY",
|
|
|
|
[](SystemData*, FileData* g) -> bool {
|
|
|
|
return g->getType() == FOLDER; }, false);
|
2020-12-16 16:35:23 +00:00
|
|
|
|
|
|
|
mFilters->selectEntry(Settings::getInstance()->getInt("ScraperFilter"));
|
2020-06-21 12:25:28 +00:00
|
|
|
mMenu.addWithLabel("Filter", mFilters);
|
|
|
|
|
2020-12-16 16:35:23 +00:00
|
|
|
mMenu.addSaveFunc([this] {
|
|
|
|
if (mScraper->getSelected() != Settings::getInstance()->getString("Scraper")) {
|
|
|
|
Settings::getInstance()->setString("Scraper", mScraper->getSelected());
|
|
|
|
mMenu.setNeedsSaving();
|
|
|
|
}
|
|
|
|
// The filter setting is only retained during the program session i.e. it's not saved
|
|
|
|
// to es_settings.cfg.
|
|
|
|
if (mFilters->getSelectedId() != Settings::getInstance()->getInt("ScraperFilter"))
|
|
|
|
Settings::getInstance()->setInt("ScraperFilter", mFilters->getSelectedId());
|
|
|
|
});
|
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
// Add systems (all systems with an existing platform ID are listed).
|
|
|
|
mSystems = std::make_shared< OptionListComponent<SystemData*>>
|
|
|
|
(mWindow, getHelpStyle(), "SCRAPE THESE SYSTEMS", true);
|
|
|
|
for (unsigned int i = 0; i < SystemData::sSystemVector.size(); i++) {
|
|
|
|
if (!SystemData::sSystemVector[i]->hasPlatformId(PlatformIds::PLATFORM_IGNORE)) {
|
|
|
|
mSystems->add(SystemData::sSystemVector[i]->getFullName(),
|
|
|
|
SystemData::sSystemVector[i],
|
|
|
|
!SystemData::sSystemVector[i]->getPlatformIds().empty());
|
|
|
|
SystemData::sSystemVector[i]->getScrapeFlag() ?
|
|
|
|
mSystems->selectEntry(i) : mSystems->unselectEntry(i);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
mMenu.addWithLabel("Systems", mSystems);
|
|
|
|
|
2020-11-07 14:34:15 +00:00
|
|
|
addEntry("ACCOUNT SETTINGS", 0x777777FF, true, [this] {
|
|
|
|
openAccountSettings();
|
|
|
|
});
|
2020-08-05 17:31:59 +00:00
|
|
|
addEntry("CONTENT SETTINGS", 0x777777FF, true, [this] {
|
2020-11-05 17:18:11 +00:00
|
|
|
// If the scraper service has been changed before entering this menu, then save the
|
|
|
|
// settings so that the specific options supported by the respective scrapers
|
|
|
|
// can be enabled or disabled.
|
|
|
|
if (mScraper->getSelected() != Settings::getInstance()->getString("Scraper"))
|
|
|
|
mMenu.save();
|
2020-08-05 17:31:59 +00:00
|
|
|
openContentSettings();
|
|
|
|
});
|
|
|
|
addEntry("OTHER SETTINGS", 0x777777FF, true, [this] {
|
2020-11-05 17:18:11 +00:00
|
|
|
// If the scraper service has been changed before entering this menu, then save the
|
|
|
|
// settings so that the specific options supported by the respective scrapers
|
|
|
|
// can be enabled or disabled.
|
|
|
|
if (mScraper->getSelected() != Settings::getInstance()->getString("Scraper"))
|
|
|
|
mMenu.save();
|
2020-08-05 17:31:59 +00:00
|
|
|
openOtherSettings();
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
addChild(&mMenu);
|
|
|
|
|
|
|
|
mMenu.addButton("START", "start", std::bind(&GuiScraperMenu::pressedStart, this));
|
|
|
|
mMenu.addButton("BACK", "back", [&] { delete this; });
|
|
|
|
|
|
|
|
setSize(mMenu.getSize());
|
|
|
|
|
|
|
|
setPosition((Renderer::getScreenWidth() - mSize.x()) / 2,
|
|
|
|
Renderer::getScreenHeight() * 0.15f);
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
GuiScraperMenu::~GuiScraperMenu()
|
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
// Save the scrape flags to the system settings so that they are
|
|
|
|
// remembered throughout the program session.
|
|
|
|
std::vector<SystemData*> sys = mSystems->getSelectedObjects();
|
|
|
|
for (auto it = SystemData::sSystemVector.cbegin();
|
|
|
|
it != SystemData::sSystemVector.cend(); it++) {
|
|
|
|
(*it)->setScrapeFlag(false);
|
|
|
|
for (auto it_sys = sys.cbegin(); it_sys != sys.cend(); it_sys++) {
|
|
|
|
if ((*it)->getFullName() == (*it_sys)->getFullName())
|
|
|
|
(*it)->setScrapeFlag(true);
|
|
|
|
}
|
|
|
|
}
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
2020-11-07 14:34:15 +00:00
|
|
|
void GuiScraperMenu::openAccountSettings()
|
|
|
|
{
|
|
|
|
auto s = new GuiSettings(mWindow, "ACCOUNT SETTINGS");
|
|
|
|
|
|
|
|
// Whether to use the ScreenScraper account when scraping.
|
|
|
|
auto scraper_use_account_screenscraper = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_use_account_screenscraper->setState(Settings::getInstance()->
|
|
|
|
getBool("ScraperUseAccountScreenScraper"));
|
|
|
|
s->addWithLabel("USE THIS ACCOUNT FOR SCREENSCRAPER", scraper_use_account_screenscraper);
|
|
|
|
s->addSaveFunc([scraper_use_account_screenscraper, s] {
|
|
|
|
if (scraper_use_account_screenscraper->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperUseAccountScreenScraper")) {
|
|
|
|
Settings::getInstance()->setBool("ScraperUseAccountScreenScraper",
|
|
|
|
scraper_use_account_screenscraper->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
// ScreenScraper username.
|
|
|
|
auto scraper_username_screenscraper = std::make_shared<TextComponent>(mWindow, "",
|
|
|
|
Font::get(FONT_SIZE_MEDIUM), 0x777777FF, ALIGN_RIGHT);
|
|
|
|
s->addEditableTextComponent("SCREENSCRAPER USERNAME", scraper_username_screenscraper,
|
|
|
|
Settings::getInstance()->getString("ScraperUsernameScreenScraper"));
|
|
|
|
s->addSaveFunc([scraper_username_screenscraper, s] {
|
|
|
|
if (scraper_username_screenscraper->getValue() !=
|
|
|
|
Settings::getInstance()->getString("ScraperUsernameScreenScraper")) {
|
|
|
|
Settings::getInstance()->setString("ScraperUsernameScreenScraper",
|
|
|
|
scraper_username_screenscraper->getValue());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
// ScreenScraper password.
|
|
|
|
auto scraper_password_screenscraper = std::make_shared<TextComponent>(mWindow, "",
|
|
|
|
Font::get(FONT_SIZE_MEDIUM), 0x777777FF, ALIGN_RIGHT);
|
|
|
|
std::string passwordMasked;
|
|
|
|
if (Settings::getInstance()->getString("ScraperPasswordScreenScraper") != "") {
|
|
|
|
passwordMasked = "********";
|
|
|
|
scraper_password_screenscraper->setHiddenValue(
|
|
|
|
Settings::getInstance()->getString("ScraperPasswordScreenScraper"));
|
|
|
|
}
|
|
|
|
s->addEditableTextComponent("SCREENSCRAPER PASSWORD",
|
|
|
|
scraper_password_screenscraper, passwordMasked, "", true);
|
|
|
|
s->addSaveFunc([scraper_password_screenscraper, s] {
|
|
|
|
if (scraper_password_screenscraper->getHiddenValue() !=
|
|
|
|
Settings::getInstance()->getString("ScraperPasswordScreenScraper")) {
|
|
|
|
Settings::getInstance()->setString("ScraperPasswordScreenScraper",
|
|
|
|
scraper_password_screenscraper->getHiddenValue());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
mWindow->pushGui(s);
|
|
|
|
}
|
|
|
|
|
2020-06-06 11:10:33 +00:00
|
|
|
void GuiScraperMenu::openContentSettings()
|
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
auto s = new GuiSettings(mWindow, "SCRAPER CONTENT SETTINGS");
|
|
|
|
|
|
|
|
// Scrape game names.
|
2020-11-05 17:18:11 +00:00
|
|
|
auto scrape_game_names = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_game_names->setState(Settings::getInstance()->getBool("ScrapeGameNames"));
|
|
|
|
s->addWithLabel("SCRAPE GAME NAMES", scrape_game_names);
|
|
|
|
s->addSaveFunc([scrape_game_names, s] {
|
|
|
|
if (scrape_game_names->getState() != Settings::getInstance()->getBool("ScrapeGameNames")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeGameNames", scrape_game_names->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
// Scrape ratings.
|
|
|
|
auto scrape_ratings = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_ratings->setState(Settings::getInstance()->getBool("ScrapeRatings"));
|
|
|
|
s->addWithLabel("SCRAPE RATINGS", scrape_ratings);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_ratings, s] {
|
|
|
|
if (scrape_ratings->getState() != Settings::getInstance()->getBool("ScrapeRatings")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeRatings", scrape_ratings->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
2020-08-05 17:31:59 +00:00
|
|
|
// Ratings are not supported by TheGamesDB, so disable the option if this scraper is selected.
|
|
|
|
if (Settings::getInstance()->getString("Scraper") == "thegamesdb") {
|
2020-12-15 17:49:43 +00:00
|
|
|
scrape_ratings->setEnabled(false);
|
2020-08-05 17:31:59 +00:00
|
|
|
scrape_ratings->setOpacity(DISABLED_OPACITY);
|
2020-12-15 17:49:43 +00:00
|
|
|
scrape_ratings->getParent()->getChild(scrape_ratings->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
2020-08-05 17:31:59 +00:00
|
|
|
}
|
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
// Scrape other metadata.
|
|
|
|
auto scrape_metadata = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_metadata->setState(Settings::getInstance()->getBool("ScrapeMetadata"));
|
|
|
|
s->addWithLabel("SCRAPE OTHER METADATA", scrape_metadata);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_metadata, s] {
|
|
|
|
if (scrape_metadata->getState() != Settings::getInstance()->getBool("ScrapeMetadata")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeMetadata", scrape_metadata->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
2020-08-05 20:38:44 +00:00
|
|
|
// Scrape videos.
|
|
|
|
auto scrape_videos = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_videos->setState(Settings::getInstance()->getBool("ScrapeVideos"));
|
|
|
|
s->addWithLabel("SCRAPE VIDEOS", scrape_videos);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_videos, s] {
|
|
|
|
if (scrape_videos->getState() != Settings::getInstance()->getBool("ScrapeVideos")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeVideos", scrape_videos->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-08-05 20:38:44 +00:00
|
|
|
|
|
|
|
// Videos are not supported by TheGamesDB, so disable the option if this scraper is selected.
|
|
|
|
if (Settings::getInstance()->getString("Scraper") == "thegamesdb") {
|
2020-12-15 17:49:43 +00:00
|
|
|
scrape_videos->setEnabled(false);
|
2020-08-05 20:38:44 +00:00
|
|
|
scrape_videos->setOpacity(DISABLED_OPACITY);
|
2020-12-15 17:49:43 +00:00
|
|
|
scrape_videos->getParent()->getChild(scrape_videos->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
2020-08-05 20:38:44 +00:00
|
|
|
}
|
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
// Scrape screenshots images.
|
|
|
|
auto scrape_screenshots = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_screenshots->setState(Settings::getInstance()->getBool("ScrapeScreenshots"));
|
|
|
|
s->addWithLabel("SCRAPE SCREENSHOT IMAGES", scrape_screenshots);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_screenshots, s] {
|
|
|
|
if (scrape_screenshots->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScrapeScreenshots")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeScreenshots", scrape_screenshots->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
// Scrape cover images.
|
|
|
|
auto scrape_covers = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_covers->setState(Settings::getInstance()->getBool("ScrapeCovers"));
|
|
|
|
s->addWithLabel("SCRAPE BOX COVER IMAGES", scrape_covers);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_covers, s] {
|
|
|
|
if (scrape_covers->getState() != Settings::getInstance()->getBool("ScrapeCovers")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeCovers", scrape_covers->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
// Scrape marquee images.
|
|
|
|
auto scrape_marquees = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_marquees->setState(Settings::getInstance()->getBool("ScrapeMarquees"));
|
|
|
|
s->addWithLabel("SCRAPE MARQUEE (WHEEL) IMAGES", scrape_marquees);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_marquees, s] {
|
|
|
|
if (scrape_marquees->getState() != Settings::getInstance()->getBool("ScrapeMarquees")) {
|
|
|
|
Settings::getInstance()->setBool("ScrapeMarquees", scrape_marquees->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
// Scrape 3D box images.
|
|
|
|
auto scrape_3dboxes = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scrape_3dboxes->setState(Settings::getInstance()->getBool("Scrape3DBoxes"));
|
|
|
|
s->addWithLabel("SCRAPE 3D BOX IMAGES", scrape_3dboxes);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scrape_3dboxes, s] {
|
|
|
|
if (scrape_3dboxes->getState() != Settings::getInstance()->getBool("Scrape3DBoxes")) {
|
|
|
|
Settings::getInstance()->setBool("Scrape3DBoxes", scrape_3dboxes->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
2020-08-05 17:31:59 +00:00
|
|
|
// 3D box images are not supported by TheGamesDB, so disable the option if this scraper
|
|
|
|
// is selected.
|
|
|
|
if (Settings::getInstance()->getString("Scraper") == "thegamesdb") {
|
2020-12-15 17:49:43 +00:00
|
|
|
scrape_3dboxes->setEnabled(false);
|
2020-08-05 17:31:59 +00:00
|
|
|
scrape_3dboxes->setOpacity(DISABLED_OPACITY);
|
2020-12-15 17:49:43 +00:00
|
|
|
scrape_3dboxes->getParent()->getChild(scrape_3dboxes->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
2020-08-05 17:31:59 +00:00
|
|
|
}
|
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
mWindow->pushGui(s);
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void GuiScraperMenu::openOtherSettings()
|
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
auto s = new GuiSettings(mWindow, "OTHER SCRAPER SETTINGS");
|
|
|
|
|
|
|
|
// Scraper region.
|
|
|
|
auto scraper_region = std::make_shared<OptionListComponent<std::string>>
|
|
|
|
(mWindow, getHelpStyle(), "REGION", false);
|
|
|
|
std::vector<std::string> transitions_rg;
|
|
|
|
transitions_rg.push_back("eu");
|
|
|
|
transitions_rg.push_back("jp");
|
|
|
|
transitions_rg.push_back("us");
|
|
|
|
transitions_rg.push_back("ss");
|
|
|
|
transitions_rg.push_back("wor");
|
|
|
|
if (Settings::getInstance()->getString("ScraperRegion") != "") {
|
|
|
|
if (std::find(transitions_rg.begin(), transitions_rg.end(),
|
|
|
|
Settings::getInstance()->getString("ScraperRegion")) == transitions_rg.end()) {
|
|
|
|
transitions_rg.push_back(Settings::getInstance()->getString("ScraperRegion"));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
for (auto it = transitions_rg.cbegin(); it != transitions_rg.cend(); it++)
|
|
|
|
scraper_region->add(*it, *it, Settings::getInstance()->getString("ScraperRegion") == *it);
|
|
|
|
s->addWithLabel("REGION", scraper_region);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_region, s] {
|
|
|
|
if (scraper_region->getSelected() != Settings::getInstance()->getString("ScraperRegion")) {
|
|
|
|
Settings::getInstance()->setString("ScraperRegion", scraper_region->getSelected());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
2020-06-21 12:25:28 +00:00
|
|
|
});
|
|
|
|
|
2020-08-05 17:31:59 +00:00
|
|
|
// Regions are not supported by TheGamesDB, so disable the option if this scraper is selected.
|
|
|
|
if (Settings::getInstance()->getString("Scraper") == "thegamesdb") {
|
2020-12-15 17:49:43 +00:00
|
|
|
scraper_region->setEnabled(false);
|
2020-08-05 17:31:59 +00:00
|
|
|
scraper_region->setOpacity(DISABLED_OPACITY);
|
2020-12-15 17:49:43 +00:00
|
|
|
scraper_region->getParent()->getChild(scraper_region->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
2020-08-05 17:31:59 +00:00
|
|
|
}
|
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
// Scraper language.
|
|
|
|
auto scraper_language = std::make_shared<OptionListComponent<std::string>>
|
|
|
|
(mWindow, getHelpStyle(), "LANGUAGE", false);
|
|
|
|
std::vector<std::string> transitions_lg;
|
|
|
|
transitions_lg.push_back("en");
|
|
|
|
transitions_lg.push_back("wor");
|
|
|
|
if (Settings::getInstance()->getString("ScraperLanguage") != "") {
|
|
|
|
if (std::find(transitions_lg.begin(), transitions_lg.end(),
|
|
|
|
Settings::getInstance()->getString("ScraperLanguage")) == transitions_lg.end()) {
|
|
|
|
transitions_lg.push_back(Settings::getInstance()->getString("ScraperLanguage"));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
for (auto it = transitions_lg.cbegin(); it != transitions_lg.cend(); it++)
|
|
|
|
scraper_language->add(*it, *it,
|
|
|
|
Settings::getInstance()->getString("ScraperLanguage") == *it);
|
|
|
|
s->addWithLabel("LANGUAGE", scraper_language);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_language, s] {
|
|
|
|
if (scraper_language->getSelected() !=
|
|
|
|
Settings::getInstance()->getString("ScraperLanguage")) {
|
|
|
|
Settings::getInstance()->setString("ScraperLanguage", scraper_language->getSelected());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
2020-06-21 12:25:28 +00:00
|
|
|
});
|
|
|
|
|
2020-08-05 17:31:59 +00:00
|
|
|
// Languages are not supported by TheGamesDB, so disable the option if this scraper is selected.
|
|
|
|
if (Settings::getInstance()->getString("Scraper") == "thegamesdb") {
|
2020-12-15 17:49:43 +00:00
|
|
|
scraper_language->setEnabled(false);
|
2020-08-05 17:31:59 +00:00
|
|
|
scraper_language->setOpacity(DISABLED_OPACITY);
|
2020-12-15 17:49:43 +00:00
|
|
|
scraper_language->getParent()->getChild(scraper_language->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
2020-08-05 17:31:59 +00:00
|
|
|
}
|
|
|
|
|
2020-10-19 19:05:04 +00:00
|
|
|
// Overwrite files and data.
|
2020-11-05 17:18:11 +00:00
|
|
|
auto scraper_overwrite_data = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_overwrite_data->setState(Settings::getInstance()->getBool("ScraperOverwriteData"));
|
|
|
|
s->addWithLabel("OVERWRITE FILES AND DATA", scraper_overwrite_data);
|
|
|
|
s->addSaveFunc([scraper_overwrite_data, s] {
|
|
|
|
if (scraper_overwrite_data->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperOverwriteData")) {
|
|
|
|
Settings::getInstance()->setBool("ScraperOverwriteData",
|
|
|
|
scraper_overwrite_data->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-10-19 19:05:04 +00:00
|
|
|
|
2020-10-10 11:05:12 +00:00
|
|
|
// Search using metadata name.
|
2020-11-05 17:18:11 +00:00
|
|
|
auto scraper_search_metadata_name = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_search_metadata_name->
|
|
|
|
setState(Settings::getInstance()->getBool("ScraperSearchMetadataName"));
|
|
|
|
s->addWithLabel("SEARCH USING METADATA NAME", scraper_search_metadata_name);
|
|
|
|
s->addSaveFunc([scraper_search_metadata_name, s] {
|
|
|
|
if (scraper_search_metadata_name->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperSearchMetadataName")) {
|
|
|
|
Settings::getInstance()->setBool("ScraperSearchMetadataName",
|
|
|
|
scraper_search_metadata_name->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-10-10 11:05:12 +00:00
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
// Interactive scraping.
|
|
|
|
auto scraper_interactive = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_interactive->setState(Settings::getInstance()->getBool("ScraperInteractive"));
|
|
|
|
s->addWithLabel("INTERACTIVE MODE", scraper_interactive);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_interactive, s] {
|
|
|
|
if (scraper_interactive->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperInteractive")) {
|
|
|
|
Settings::getInstance()->setBool("ScraperInteractive", scraper_interactive->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
// Semi-automatic scraping.
|
|
|
|
auto scraper_semiautomatic = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_semiautomatic->setState(Settings::getInstance()->getBool("ScraperSemiautomatic"));
|
|
|
|
s->addWithLabel("AUTO-ACCEPT SINGLE GAME MATCHES", scraper_semiautomatic);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_semiautomatic ,s] {
|
|
|
|
if (scraper_semiautomatic->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperSemiautomatic")) {
|
2020-06-21 12:25:28 +00:00
|
|
|
Settings::getInstance()->setBool("ScraperSemiautomatic",
|
2020-11-05 17:18:11 +00:00
|
|
|
scraper_semiautomatic->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-06-21 12:25:28 +00:00
|
|
|
|
2020-12-15 17:49:43 +00:00
|
|
|
// If interactive mode is set to off, then disable this option.
|
|
|
|
if (!Settings::getInstance()->getBool("ScraperInteractive")) {
|
|
|
|
scraper_semiautomatic->setEnabled(false);
|
|
|
|
scraper_semiautomatic->setOpacity(DISABLED_OPACITY);
|
|
|
|
scraper_semiautomatic->getParent()->getChild(scraper_semiautomatic->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-08-06 09:27:16 +00:00
|
|
|
// Respect the per-file multi-scraper exclusion flag.
|
|
|
|
auto scraper_respect_exclusions = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_respect_exclusions->setState(
|
|
|
|
Settings::getInstance()->getBool("ScraperRespectExclusions"));
|
|
|
|
s->addWithLabel("RESPECT PER-FILE SCRAPER EXCLUSIONS", scraper_respect_exclusions);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_respect_exclusions, s] {
|
|
|
|
if (scraper_respect_exclusions->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperRespectExclusions")) {
|
2020-08-06 09:27:16 +00:00
|
|
|
Settings::getInstance()->setBool("ScraperRespectExclusions",
|
2020-11-05 17:18:11 +00:00
|
|
|
scraper_respect_exclusions->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-08-06 09:27:16 +00:00
|
|
|
|
2020-08-06 13:12:04 +00:00
|
|
|
// Exclude files recursively for excluded folders.
|
|
|
|
auto scraper_exclude_recursively = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_exclude_recursively->setState(
|
|
|
|
Settings::getInstance()->getBool("ScraperExcludeRecursively"));
|
|
|
|
s->addWithLabel("EXCLUDE FOLDERS RECURSIVELY", scraper_exclude_recursively);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_exclude_recursively, s] {
|
|
|
|
if (scraper_exclude_recursively->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperExcludeRecursively")) {
|
2020-08-06 13:12:04 +00:00
|
|
|
Settings::getInstance()->setBool("ScraperExcludeRecursively",
|
2020-11-05 17:18:11 +00:00
|
|
|
scraper_exclude_recursively->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-08-06 13:12:04 +00:00
|
|
|
|
2020-12-15 17:49:43 +00:00
|
|
|
// If respecting excluded files is set to off, then disable this option.
|
|
|
|
if (!Settings::getInstance()->getBool("ScraperRespectExclusions")) {
|
|
|
|
scraper_exclude_recursively->setEnabled(false);
|
|
|
|
scraper_exclude_recursively->setOpacity(DISABLED_OPACITY);
|
|
|
|
scraper_exclude_recursively->getParent()->getChild(scraper_exclude_recursively->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
|
|
|
}
|
|
|
|
|
2020-08-06 13:12:04 +00:00
|
|
|
// Include actual folders when scraping.
|
|
|
|
auto scraper_include_folders = std::make_shared<SwitchComponent>(mWindow);
|
|
|
|
scraper_include_folders->setState(
|
|
|
|
Settings::getInstance()->getBool("ScraperIncludeFolders"));
|
|
|
|
s->addWithLabel("SCRAPE ACTUAL FOLDERS", scraper_include_folders);
|
2020-11-05 17:18:11 +00:00
|
|
|
s->addSaveFunc([scraper_include_folders, s] {
|
|
|
|
if (scraper_include_folders->getState() !=
|
|
|
|
Settings::getInstance()->getBool("ScraperIncludeFolders")) {
|
2020-08-06 13:12:04 +00:00
|
|
|
Settings::getInstance()->setBool("ScraperIncludeFolders",
|
2020-11-05 17:18:11 +00:00
|
|
|
scraper_include_folders->getState());
|
|
|
|
s->setNeedsSaving();
|
|
|
|
}
|
|
|
|
});
|
2020-08-06 13:12:04 +00:00
|
|
|
|
2020-12-15 17:49:43 +00:00
|
|
|
// Switch callbacks.
|
|
|
|
auto interactiveToggleFunc = [scraper_semiautomatic]() {
|
|
|
|
if (scraper_semiautomatic->getEnabled()) {
|
|
|
|
scraper_semiautomatic->setEnabled(false);
|
|
|
|
scraper_semiautomatic->setOpacity(DISABLED_OPACITY);
|
|
|
|
scraper_semiautomatic->getParent()->getChild(scraper_semiautomatic->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
scraper_semiautomatic->setEnabled(true);
|
|
|
|
scraper_semiautomatic->setOpacity(255);
|
|
|
|
scraper_semiautomatic->getParent()->getChild(scraper_semiautomatic->
|
|
|
|
getChildIndex() - 1)->setOpacity(255);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
auto excludeRecursivelyToggleFunc = [scraper_exclude_recursively]() {
|
|
|
|
if (scraper_exclude_recursively->getEnabled()) {
|
|
|
|
scraper_exclude_recursively->setEnabled(false);
|
|
|
|
scraper_exclude_recursively->setOpacity(DISABLED_OPACITY);
|
|
|
|
scraper_exclude_recursively->getParent()->getChild(scraper_exclude_recursively->
|
|
|
|
getChildIndex() - 1)->setOpacity(DISABLED_OPACITY);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
scraper_exclude_recursively->setEnabled(true);
|
|
|
|
scraper_exclude_recursively->setOpacity(255);
|
|
|
|
scraper_exclude_recursively->getParent()->getChild(scraper_exclude_recursively->
|
|
|
|
getChildIndex() - 1)->setOpacity(255);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
scraper_interactive->setCallback(interactiveToggleFunc);
|
|
|
|
scraper_respect_exclusions->setCallback(excludeRecursivelyToggleFunc);
|
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
mWindow->pushGui(s);
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void GuiScraperMenu::pressedStart()
|
|
|
|
{
|
2020-11-05 17:18:11 +00:00
|
|
|
// If the scraper service has been changed, then save the settings as otherwise the
|
|
|
|
// wrong scraper would be used.
|
|
|
|
if (mScraper->getSelected() != Settings::getInstance()->getString("Scraper"))
|
|
|
|
mMenu.save();
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
std::vector<SystemData*> sys = mSystems->getSelectedObjects();
|
|
|
|
for (auto it = sys.cbegin(); it != sys.cend(); it++) {
|
|
|
|
if ((*it)->getPlatformIds().empty()) {
|
|
|
|
mWindow->pushGui(new GuiMsgBox(mWindow, getHelpStyle(),
|
|
|
|
Utils::String::toUpper("Warning: some of your selected systems do not "
|
|
|
|
"have a platform set. Results may be even more inaccurate than "
|
|
|
|
"usual!\nContinue anyway?"),
|
|
|
|
"YES", std::bind(&GuiScraperMenu::start, this),
|
|
|
|
"NO", nullptr));
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
start();
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void GuiScraperMenu::start()
|
|
|
|
{
|
2020-12-16 16:35:23 +00:00
|
|
|
std::queue<ScraperSearchParams> searches =
|
|
|
|
getSearches(mSystems->getSelectedObjects(), mFilters->getSelected());
|
2020-06-21 12:25:28 +00:00
|
|
|
|
|
|
|
if (searches.empty()) {
|
|
|
|
mWindow->pushGui(new GuiMsgBox(mWindow, getHelpStyle(),
|
|
|
|
"NO GAMES TO SCRAPE"));
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
GuiScraperMulti* gsm = new GuiScraperMulti(mWindow, searches,
|
|
|
|
Settings::getInstance()->getBool("ScraperInteractive"));
|
|
|
|
mWindow->pushGui(gsm);
|
|
|
|
delete this;
|
|
|
|
}
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
std::queue<ScraperSearchParams> GuiScraperMenu::getSearches(
|
2020-06-21 12:25:28 +00:00
|
|
|
std::vector<SystemData*> systems, GameFilterFunc selector)
|
2020-06-06 11:10:33 +00:00
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
std::queue<ScraperSearchParams> queue;
|
|
|
|
for (auto sys = systems.cbegin(); sys != systems.cend(); sys++) {
|
2020-08-06 13:12:04 +00:00
|
|
|
std::vector<FileData*> games = (*sys)->getRootFolder()->getScrapeFilesRecursive(
|
|
|
|
Settings::getInstance()->getBool("ScraperIncludeFolders"),
|
|
|
|
Settings::getInstance()->getBool("ScraperExcludeRecursively"),
|
|
|
|
Settings::getInstance()->getBool("ScraperRespectExclusions"));
|
2020-06-21 12:25:28 +00:00
|
|
|
for (auto game = games.cbegin(); game != games.cend(); game++) {
|
2020-08-06 13:12:04 +00:00
|
|
|
if (selector((*sys), (*game))) {
|
2020-06-21 12:25:28 +00:00
|
|
|
ScraperSearchParams search;
|
|
|
|
search.game = *game;
|
|
|
|
search.system = *sys;
|
|
|
|
|
|
|
|
queue.push(search);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return queue;
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void GuiScraperMenu::addEntry(const char* name, unsigned int color,
|
2020-06-21 12:25:28 +00:00
|
|
|
bool add_arrow, const std::function<void()>& func)
|
2020-06-06 11:10:33 +00:00
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
std::shared_ptr<Font> font = Font::get(FONT_SIZE_MEDIUM);
|
2020-06-06 11:10:33 +00:00
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
// Populate the list.
|
|
|
|
ComponentListRow row;
|
|
|
|
row.addElement(std::make_shared<TextComponent>(mWindow, name, font, color), true);
|
2020-06-06 11:10:33 +00:00
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
if (add_arrow) {
|
|
|
|
std::shared_ptr<ImageComponent> bracket = makeArrow(mWindow);
|
|
|
|
row.addElement(bracket, false);
|
|
|
|
}
|
2020-06-06 11:10:33 +00:00
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
row.makeAcceptInputHandler(func);
|
|
|
|
mMenu.addRow(row);
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool GuiScraperMenu::input(InputConfig* config, Input input)
|
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
if (GuiComponent::input(config, input))
|
|
|
|
return true;
|
2020-06-06 11:10:33 +00:00
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
if (config->isMappedTo("b", input) &&
|
|
|
|
input.value != 0) {
|
|
|
|
delete this;
|
|
|
|
return true;
|
|
|
|
}
|
2020-06-06 11:10:33 +00:00
|
|
|
|
2020-06-21 12:25:28 +00:00
|
|
|
return false;
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
std::vector<HelpPrompt> GuiScraperMenu::getHelpPrompts()
|
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
std::vector<HelpPrompt> prompts = mMenu.getHelpPrompts();
|
|
|
|
prompts.push_back(HelpPrompt("b", "back"));
|
|
|
|
return prompts;
|
2020-06-06 11:10:33 +00:00
|
|
|
}
|
2020-06-07 18:09:02 +00:00
|
|
|
|
|
|
|
HelpStyle GuiScraperMenu::getHelpStyle()
|
|
|
|
{
|
2020-06-21 12:25:28 +00:00
|
|
|
HelpStyle style = HelpStyle();
|
|
|
|
style.applyTheme(ViewController::get()->getState().getSystem()->getTheme(), "system");
|
|
|
|
return style;
|
2020-06-07 18:09:02 +00:00
|
|
|
}
|