ES-DE/es-app/src/FileData.cpp

#include "FileData.h"

#include "utils/FileSystemUtil.h"
#include "utils/StringUtil.h"
#include "utils/TimeUtil.h"
#include "AudioManager.h"
#include "CollectionSystemManager.h"
#include "FileFilterIndex.h"
#include "FileSorts.h"
#include "Log.h"
#include "MameNames.h"
#include "platform.h"
#include "Scripting.h"
#include "SystemData.h"
#include "VolumeControl.h"
#include "Window.h"
#include <assert.h>

FileData::FileData(FileType type, const std::string& path, SystemEnvironmentData* envData, SystemData* system)
	: mType(type), mPath(path), mSystem(system), mEnvData(envData), mSourceFileData(NULL), mParent(NULL), metadata(type == GAME ? GAME_METADATA : FOLDER_METADATA) // metadata is REALLY set in the constructor!
{
	// metadata needs at least a name field (since that's what getName() will return)
	if(metadata.get("name").empty())
		metadata.set("name", getDisplayName());
	mSystemName = system->getName();
	metadata.resetChangedFlag();
}

FileData::~FileData()
{
	if(mParent)
		mParent->removeChild(this);

	if(mType == GAME)
		mSystem->getIndex()->removeFromIndex(this);

	mChildren.clear();
}

std::string FileData::getDisplayName() const
{
	std::string stem = Utils::FileSystem::getStem(mPath);
//	if(mSystem && mSystem->hasPlatformId(PlatformIds::ARCADE) || mSystem->hasPlatformId(PlatformIds::NEOGEO))
//		stem = MameNames::getInstance()->getRealName(stem);

	return stem;
}

std::string FileData::getCleanName() const
{
	return Utils::String::removeParenthesis(this->getDisplayName());
}

const std::string& FileData::getName()
{
	return metadata.get("name");
}

const std::string& FileData::getSortName()
{
	if (metadata.get("sortname").empty())
		return metadata.get("name");
	else
		return metadata.get("sortname");
}

const bool FileData::getFavorite()
{
	if (metadata.get("favorite") == "true")
		return true;
	else
		return false;
}

const std::string FileData::getMediaDirectory() const
{
	std::string mediaDirSetting = Settings::getInstance()->getString("MediaDirectory");
	std::string mediaDirPath = "";

	if(mediaDirSetting == "")
	{
		mediaDirPath = Utils::FileSystem::getHomePath() + "/.emulationstation/downloaded_media/";
	}
	else
	{
		mediaDirPath = mediaDirSetting;

		// Expand home symbol if the path starts with ~
		if(mediaDirPath[0] == '~')
		{
			mediaDirPath.erase(0, 1);
			mediaDirPath.insert(0, Utils::FileSystem::getHomePath());
		}

		if(mediaDirPath.back() !=  '/')
		{
			mediaDirPath = mediaDirPath + "/";
		}
	}

	return mediaDirPath;
}

const std::string FileData::getThumbnailPath() const
{
	const char* extList[2] = { ".png", ".jpg" };
	std::string tempPath = getMediaDirectory() + mSystemName + "/thumbnails/" + getDisplayName();

	// Look for media in the media directory
	for(int i = 0; i < 2; i++)
	{
		std::string mediaPath = tempPath + extList[i];
		if(Utils::FileSystem::exists(mediaPath))
			return mediaPath;
	}

	// No media found in the media directory, so look for local art as well (if configured to do so)
	if(Settings::getInstance()->getBool("LocalArt"))
	{
		for(int i = 0; i < 2; i++)
		{
			std::string localMediaPath = mEnvData->mStartPath + "/images/" + getDisplayName() + "-thumbnail" + extList[i];
			if(Utils::FileSystem::exists(localMediaPath))
				return localMediaPath;
		}
	}

	return "";
}

const std::string FileData::getVideoPath() const
{
	const char* extList[5] = { ".avi", ".mkv", ".mov", ".mp4", ".wmv" };
	std::string tempPath = getMediaDirectory() + mSystemName + "/videos/" + getDisplayName();

	// Look for media in the media directory
	for(int i = 0; i < 5; i++)
	{
		std::string mediaPath = tempPath + extList[i];
		if(Utils::FileSystem::exists(mediaPath))
			return mediaPath;
	}

	// No media found in the media directory, so look for local art as well (if configured to do so)
	if(Settings::getInstance()->getBool("LocalArt"))
	{
		for(int i = 0; i < 5; i++)
		{
			std::string localMediaPath = mEnvData->mStartPath + "/images/" + getDisplayName() + "-video" + extList[i];
			if(Utils::FileSystem::exists(localMediaPath))
				return localMediaPath;
		}
	}

	return "";
}

const std::string FileData::getMarqueePath() const
{
	const char* extList[2] = { ".png", ".jpg" };
	std::string tempPath = getMediaDirectory() + mSystemName + "/marquees/" + getDisplayName();

	// Look for media in the media directory
	for(int i = 0; i < 2; i++)
	{
		std::string mediaPath = tempPath + extList[i];
		if(Utils::FileSystem::exists(mediaPath))
			return mediaPath;
	}

	// No media found in the media directory, so look for local art as well (if configured to do so)
	if(Settings::getInstance()->getBool("LocalArt"))
	{
		for(int i = 0; i < 2; i++)
		{
			std::string localMediaPath = mEnvData->mStartPath + "/images/" + getDisplayName() + "-marquee" + extList[i];
			if(Utils::FileSystem::exists(localMediaPath))
				return localMediaPath;
		}
	}

	return "";
}

const std::string FileData::getImagePath() const
{
	const char* extList[2] = { ".png", ".jpg" };

	// Look for mix image (a combination of screenshot, 3D box and marquee) in the media directory
	std::string tempPath = getMediaDirectory() + mSystemName + "/miximages/" + getDisplayName();
	for(int i = 0; i < 2; i++)
	{
		std::string mediaPath = tempPath + extList[i];
		if(Utils::FileSystem::exists(mediaPath))
			return mediaPath;
	}

	// If no mix image exists, try normal screenshot
	tempPath = getMediaDirectory() + mSystemName + "/screenshots/" + getDisplayName();

	for(int i = 0; i < 2; i++)
	{
		std::string mediaPath = tempPath + extList[i];
		if(Utils::FileSystem::exists(mediaPath))
			return mediaPath;
	}

	// No media found in the media directory, so look for local art as well (if configured to do so)
	if(Settings::getInstance()->getBool("LocalArt"))
	{
		for(int i = 0; i < 2; i++)
		{
			std::string localMediaPath = mEnvData->mStartPath + "/images/" + getDisplayName() + "-image" + extList[i];
			if(Utils::FileSystem::exists(localMediaPath))
				return localMediaPath;
		}
	}

	return "";
}

const std::vector<FileData*>& FileData::getChildrenListToDisplay()
{

	FileFilterIndex* idx = CollectionSystemManager::get()->getSystemToView(mSystem)->getIndex();
	if (idx->isFiltered()) {
		mFilteredChildren.clear();
		for(auto it = mChildren.cbegin(); it != mChildren.cend(); it++)
		{
			if (idx->showFile((*it))) {
				mFilteredChildren.push_back(*it);
			}
		}

		return mFilteredChildren;
	}
	else
	{
		return mChildren;
	}
}

std::vector<FileData*> FileData::getFilesRecursive(unsigned int typeMask, bool displayedOnly) const
{
	std::vector<FileData*> out;
	FileFilterIndex* idx = mSystem->getIndex();

	for(auto it = mChildren.cbegin(); it != mChildren.cend(); it++)
	{
		if((*it)->getType() & typeMask)
		{
			if (!displayedOnly || !idx->isFiltered() || idx->showFile(*it))
				out.push_back(*it);
		}

		if((*it)->getChildren().size() > 0)
		{
			std::vector<FileData*> subchildren = (*it)->getFilesRecursive(typeMask, displayedOnly);
			out.insert(out.cend(), subchildren.cbegin(), subchildren.cend());
		}
	}

	return out;
}

std::string FileData::getKey() {
	return getFileName();
}

const bool FileData::isArcadeAsset()
{
	const std::string stem = Utils::FileSystem::getStem(mPath);
	return (
		(mSystem && (mSystem->hasPlatformId(PlatformIds::ARCADE) || mSystem->hasPlatformId(PlatformIds::NEOGEO)))
		&&
		(MameNames::getInstance()->isBios(stem) || MameNames::getInstance()->isDevice(stem))
	);
}

FileData* FileData::getSourceFileData()
{
	return this;
}

void FileData::addChild(FileData* file)
{
	assert(mType == FOLDER);
	assert(file->getParent() == NULL);

	const std::string key = file->getKey();
	if (mChildrenByFilename.find(key) == mChildrenByFilename.cend())
	{
		mChildrenByFilename[key] = file;
		mChildren.push_back(file);
		file->mParent = this;
	}
}

void FileData::removeChild(FileData* file)
{
	assert(mType == FOLDER);
	assert(file->getParent() == this);
	mChildrenByFilename.erase(file->getKey());
	for(auto it = mChildren.cbegin(); it != mChildren.cend(); it++)
	{
		if(*it == file)
		{
			file->mParent = NULL;
			mChildren.erase(it);
			return;
		}
	}

	// File somehow wasn't in our children.
	assert(false);

}

void FileData::sort(ComparisonFunction& comparator, bool ascending)
{
	std::stable_sort(mChildren.begin(), mChildren.end(), comparator);

	for(auto it = mChildren.cbegin(); it != mChildren.cend(); it++)
	{
		if((*it)->getChildren().size() > 0)
			(*it)->sort(comparator, ascending);
	}

	if(!ascending)
		std::reverse(mChildren.begin(), mChildren.end());
}

void FileData::sort(const SortType& type)
{
	sort(*type.comparisonFunction, type.ascending);
}

void FileData::launchGame(Window* window)
{
	LOG(LogInfo) << "Attempting to launch game...";

	AudioManager::getInstance()->deinit();
	VolumeControl::getInstance()->deinit();

//	window->deinit();

	std::string command = "";

	// Check if there is a launch string override for the game and the corresponding option has been set
	if(Settings::getInstance()->getBool("LaunchstringOverride") && !metadata.get("launchstring").empty())
	{
		command = metadata.get("launchstring");
	}
	else
	{
		command = mEnvData->mLaunchCommand;
	}

	const std::string rom      = Utils::FileSystem::getEscapedPath(getPath());
	const std::string basename = Utils::FileSystem::getStem(getPath());
	const std::string rom_raw  = Utils::FileSystem::getPreferredPath(getPath());

	command = Utils::String::replace(command, "%ROM%", rom);
	command = Utils::String::replace(command, "%BASENAME%", basename);
	command = Utils::String::replace(command, "%ROM_RAW%", rom_raw);

	Scripting::fireEvent("game-start", rom, basename);

	LOG(LogInfo) << "	" << command;
	int exitCode = runSystemCommand(command);

	if(exitCode != 0)
	{
		LOG(LogWarning) << "...launch terminated with nonzero exit code " << exitCode << "!";
	}

	Scripting::fireEvent("game-end");

//	window->init();
	VolumeControl::getInstance()->init();
	window->normalizeNextUpdate();

	//update number of times the game has been launched

	FileData* gameToUpdate = getSourceFileData();

	int timesPlayed = gameToUpdate->metadata.getInt("playcount") + 1;
	gameToUpdate->metadata.set("playcount", std::to_string(static_cast<long long>(timesPlayed)));

	//update last played time
	gameToUpdate->metadata.set("lastplayed", Utils::Time::DateTime(Utils::Time::now()));
	CollectionSystemManager::get()->refreshCollectionSystems(gameToUpdate);

	gameToUpdate->mSystem->onMetaDataSavePoint();
}

CollectionFileData::CollectionFileData(FileData* file, SystemData* system)
	: FileData(file->getSourceFileData()->getType(), file->getSourceFileData()->getPath(), file->getSourceFileData()->getSystemEnvData(), system)
{
	// we use this constructor to create a clone of the filedata, and change its system
	mSourceFileData = file->getSourceFileData();
	refreshMetadata();
	mParent = NULL;
	metadata = mSourceFileData->metadata;
	mSystemName = mSourceFileData->getSystem()->getName();
}

CollectionFileData::~CollectionFileData()
{
	// need to remove collection file data at the collection object destructor
	if(mParent)
		mParent->removeChild(this);
	mParent = NULL;
}

std::string CollectionFileData::getKey() {
	return getFullPath();
}

FileData* CollectionFileData::getSourceFileData()
{
	return mSourceFileData;
}

void CollectionFileData::refreshMetadata()
{
	metadata = mSourceFileData->metadata;
	mDirty = true;
}

const std::string& CollectionFileData::getName()
{
	if (mDirty) {
		mCollectionFileName = Utils::String::removeParenthesis(mSourceFileData->metadata.get("name"));
		mCollectionFileName += " [" + Utils::String::toUpper(mSourceFileData->getSystem()->getName()) + "]";
		mDirty = false;
	}

	if (Settings::getInstance()->getBool("CollectionShowSystemInfo"))
		return mCollectionFileName;
	return mSourceFileData->metadata.get("name");
}

// returns Sort Type based on a string description
FileData::SortType getSortTypeFromString(std::string desc) {
	std::vector<FileData::SortType> SortTypes = FileSorts::SortTypes;
	// find it
	for(unsigned int i = 0; i < FileSorts::SortTypes.size(); i++)
	{
		const FileData::SortType& sort = FileSorts::SortTypes.at(i);
		if(sort.description == desc)
		{
			return sort;
		}
	}
	// if not found default to name, ascending
	return FileSorts::SortTypes.at(0);
}