GH-1053 explode launch task into many small steps, each a Task

1 files changed, 102 insertions, 479 deletions

diff --git a/logic/launch/LaunchTask.cpp b/logic/launch/LaunchTask.cpp
index 83bbba97..248761f0 100644
--- a/logic/launch/LaunchTask.cpp
+++ b/logic/launch/LaunchTask.cpp
@@ -27,105 +27,14 @@
 #include <QRegularExpression>
 #include <QCoreApplication>
 #include <QStandardPaths>
-
-#define IBUS "@im=ibus"
-
-void LaunchTask::initializeEnvironment()
-{
-	// prepare the process environment
-	QProcessEnvironment rawenv = QProcessEnvironment::systemEnvironment();
-
-	QStringList ignored =
-	{
-		"JAVA_ARGS",
-		"CLASSPATH",
-		"CONFIGPATH",
-		"JAVA_HOME",
-		"JRE_HOME",
-		"_JAVA_OPTIONS",
-		"JAVA_OPTIONS",
-		"JAVA_TOOL_OPTIONS"
-	};
-	for(auto key: rawenv.keys())
-	{
-		auto value = rawenv.value(key);
-		// filter out dangerous java crap
-		if(ignored.contains(key))
-		{
-			qDebug() << "Env: ignoring" << key << value;
-			continue;
-		}
-		// filter MultiMC-related things
-		if(key.startsWith("QT_"))
-		{
-			qDebug() << "Env: ignoring" << key << value;
-			continue;
-		}
-#ifdef Q_OS_LINUX
-		// Do not pass LD_* variables to java. They were intended for MultiMC
-		if(key.startsWith("LD_"))
-		{
-			qDebug() << "Env: ignoring" << key << value;
-			continue;
-		}
-		// Strip IBus
-		// IBus is a Linux IME framework. For some reason, it breaks MC?
-		if (key == "XMODIFIERS" && value.contains(IBUS))
-		{
-			QString save = value;
-			value.replace(IBUS, "");
-			qDebug() << "Env: stripped" << IBUS << "from" << save << ":" << value;
-		}
-		if(key == "GAME_PRELOAD")
-		{
-			m_env.insert("LD_PRELOAD", value);
-			continue;
-		}
-		if(key == "GAME_LIBRARY_PATH")
-		{
-			m_env.insert("LD_LIBRARY_PATH", value);
-			continue;
-		}
-#endif
-		qDebug() << "Env: " << key << value;
-		m_env.insert(key, value);
-	}
-#ifdef Q_OS_LINUX
-	// HACK: Workaround for QTBUG42500
-	if(!m_env.contains("LD_LIBRARY_PATH"))
-	{
-		m_env.insert("LD_LIBRARY_PATH", "");
-	}
-#endif
-
-	// export some infos
-	auto variables = getVariables();
-	for (auto it = variables.begin(); it != variables.end(); ++it)
-	{
-		m_env.insert(it.key(), it.value());
-	}
-}
+#include <assert.h>
 
 void LaunchTask::init()
 {
-	initializeEnvironment();
-
-	m_process.setProcessEnvironment(m_env);
-	connect(&m_process, &LoggedProcess::log, this, &LaunchTask::on_log);
-	connect(&m_process, &LoggedProcess::stateChanged, this, &LaunchTask::on_state);
-
-	m_prelaunchprocess.setProcessEnvironment(m_env);
-	connect(&m_prelaunchprocess, &LoggedProcess::log, this, &LaunchTask::on_log);
-	connect(&m_prelaunchprocess, &LoggedProcess::stateChanged, this, &LaunchTask::on_pre_state);
-
-	m_postlaunchprocess.setProcessEnvironment(m_env);
-	connect(&m_postlaunchprocess, &LoggedProcess::log, this, &LaunchTask::on_log);
-	connect(&m_postlaunchprocess, &LoggedProcess::stateChanged, this, &LaunchTask::on_post_state);
-
 	m_instance->setRunning(true);
 }
 
-std::shared_ptr<LaunchTask> LaunchTask::create(MinecraftInstancePtr inst)
+std::shared_ptr<LaunchTask> LaunchTask::create(InstancePtr inst)
 {
 	std::shared_ptr<LaunchTask> proc(new LaunchTask(inst));
 	proc->init();
@@ -136,25 +45,77 @@ LaunchTask::LaunchTask(InstancePtr instance): m_instance(instance)
 {
 }
 
-QString LaunchTask::censorPrivateInfo(QString in)
+void LaunchTask::appendStep(std::shared_ptr<LaunchStep> step)
 {
-	if (!m_session)
-		return in;
+	m_steps.append(step);
+}
 
-	if (m_session->session != "-")
-		in.replace(m_session->session, "<SESSION ID>");
-	in.replace(m_session->access_token, "<ACCESS TOKEN>");
-	in.replace(m_session->client_token, "<CLIENT TOKEN>");
-	in.replace(m_session->uuid, "<PROFILE ID>");
-	in.replace(m_session->player_name, "<PROFILE NAME>");
+void LaunchTask::prependStep(std::shared_ptr<LaunchStep> step)
+{
+	m_steps.prepend(step);
+}
 
-	auto i = m_session->u.properties.begin();
-	while (i != m_session->u.properties.end())
+void LaunchTask::executeTask()
+{
+	if(!m_steps.size())
 	{
-		in.replace(i.value(), "<" + i.key().toUpper() + ">");
-		++i;
+		state = LaunchTask::Finished;
+		emitSucceeded();
 	}
+	state = LaunchTask::Running;
+	onStepFinished();
+}
+
+void LaunchTask::onReadyForLaunch()
+{
+	state = LaunchTask::Waiting;
+	emit readyForLaunch();
+}
+
+void LaunchTask::onStepFinished()
+{
+	// initial -> just start the first step
+	if(currentStep == -1)
+	{
+		currentStep ++;
+		m_steps[currentStep]->start();
+		return;
+	}
+
+	auto step = m_steps[currentStep];
+	if(step->successful())
+	{
+		// end?
+		if(currentStep == m_steps.size() - 1)
+		{
+			emitSucceeded();
+		}
+		else
+		{
+			currentStep ++;
+			step = m_steps[currentStep];
+			step->start();
+		}
+	}
+	else
+	{
+		emitFailed(step->failReason());
+	}
+}
 
+void LaunchTask::setCensorFilter(QMap<QString, QString> filter)
+{
+	m_censorFilter = filter;
+}
+
+QString LaunchTask::censorPrivateInfo(QString in)
+{
+	auto iter = m_censorFilter.begin();
+	while (iter != m_censorFilter.end())
+	{
+		in.replace(iter.key(), iter.value());
+		iter++;
+	}
 	return in;
 }
 
@@ -199,163 +160,58 @@ MessageLevel::Enum LaunchTask::guessLevel(const QString &line, MessageLevel::Enu
 	return level;
 }
 
-QMap<QString, QString> LaunchTask::getVariables() const
+void LaunchTask::proceed()
 {
-	auto mcInstance = std::dynamic_pointer_cast<MinecraftInstance>(m_instance);
-	QMap<QString, QString> out;
-	out.insert("INST_NAME", mcInstance->name());
-	out.insert("INST_ID", mcInstance->id());
-	out.insert("INST_DIR", QDir(mcInstance->instanceRoot()).absolutePath());
-	out.insert("INST_MC_DIR", QDir(mcInstance->minecraftRoot()).absolutePath());
-	out.insert("INST_JAVA", mcInstance->settings()->get("JavaPath").toString());
-	out.insert("INST_JAVA_ARGS", javaArguments().join(' '));
-	return out;
-}
-
-QStringList LaunchTask::javaArguments() const
-{
-	QStringList args;
-
-	// custom args go first. we want to override them if we have our own here.
-	args.append(m_instance->extraArguments());
-
-	// OSX dock icon and name
-#ifdef Q_OS_MAC
-	args << "-Xdock:icon=icon.png";
-	args << QString("-Xdock:name=\"%1\"").arg(m_instance->windowTitle());
-#endif
-
-	// HACK: Stupid hack for Intel drivers. See: https://mojang.atlassian.net/browse/MCL-767
-#ifdef Q_OS_WIN32
-	args << QString("-XX:HeapDumpPath=MojangTricksIntelDriversForPerformance_javaw.exe_"
-					"minecraft.exe.heapdump");
-#endif
-
-	args << QString("-Xms%1m").arg(m_instance->settings()->get("MinMemAlloc").toInt());
-	args << QString("-Xmx%1m").arg(m_instance->settings()->get("MaxMemAlloc").toInt());
-
-	// No PermGen in newer java.
-	auto javaVersion = m_instance->settings()->get("JavaVersion");
-	if(Strings::naturalCompare(javaVersion.toString(), "1.8.0", Qt::CaseInsensitive) < 0)
-	{
-		auto permgen = m_instance->settings()->get("PermGen").toInt();
-		if (permgen != 64)
-		{
-			args << QString("-XX:PermSize=%1m").arg(permgen);
-		}
-	}
-
-	args << "-Duser.language=en";
-	if (!m_nativeFolder.isEmpty())
-		args << QString("-Djava.library.path=%1").arg(m_nativeFolder);
-	args << "-jar" << PathCombine(QCoreApplication::applicationDirPath(), "jars", "NewLaunch.jar");
-
-	return args;
-}
-
-void LaunchTask::checkJava()
-{
-	m_javaPath = m_instance->settings()->get("JavaPath").toString();
-	emit log("Java path is:\n" + m_javaPath + "\n\n");
-
-	auto realJavaPath = QStandardPaths::findExecutable(m_javaPath);
-	if (realJavaPath.isEmpty())
-	{
-		emit log(tr("The java binary \"%1\" couldn't be found. You may have to set up java "
-					"if Minecraft fails to launch.").arg(m_javaPath),
-				 MessageLevel::Warning);
-	}
-
-	QFileInfo javaInfo(realJavaPath);
-	qlonglong javaUnixTime = javaInfo.lastModified().toMSecsSinceEpoch();
-	auto storedUnixTime = m_instance->settings()->get("JavaTimestamp").toLongLong();
-	this->m_javaUnixTime = javaUnixTime;
-	// if they are not the same, check!
-	if(javaUnixTime != storedUnixTime)
+	if(state != LaunchTask::Waiting)
 	{
-		m_JavaChecker = std::make_shared<JavaChecker>();
-		bool successful = false;
-		QString errorLog;
-		QString version;
-		emit log(tr("Checking Java version..."), MessageLevel::MultiMC);
-		connect(m_JavaChecker.get(), &JavaChecker::checkFinished, this, &LaunchTask::checkJavaFinished);
-		m_JavaChecker->m_path = realJavaPath;
-		m_JavaChecker->performCheck();
+		return;
 	}
-	preLaunch();
+	m_steps[currentStep]->proceed();
 }
 
-void LaunchTask::checkJavaFinished(JavaCheckResult result)
+bool LaunchTask::abort()
 {
-	if(!result.valid)
+	switch(state)
 	{
-		// Error message displayed if java can't start
-		emit log(tr("Could not start java:"), MessageLevel::Error);
-		auto lines = result.errorLog.split('\n');
-		for(auto line: lines)
+		case LaunchTask::Aborted:
+		case LaunchTask::Failed:
+		case LaunchTask::Finished:
+			return true;
+		case LaunchTask::NotStarted:
 		{
-			emit log(line, MessageLevel::Error);
+			state = LaunchTask::Aborted;
+			emitFailed("Aborted");
+			return true;
 		}
-		emit log("\nCheck your MultiMC Java settings.", MessageLevel::MultiMC);
-		emitFailed(tr("Could not start java!"));
-	}
-	else
-	{
-		emit log(tr("Java version is %1!\n").arg(result.javaVersion), MessageLevel::MultiMC);
-		m_instance->settings()->set("JavaVersion", result.javaVersion);
-		m_instance->settings()->set("JavaTimestamp", m_javaUnixTime);
-		preLaunch();
+		case LaunchTask::Running:
+		case LaunchTask::Waiting:
+		{
+			auto step = m_steps[currentStep];
+			if(!step->canAbort())
+			{
+				return false;
+			}
+			if(step->abort())
+			{
+				state = LaunchTask::Aborted;
+				return true;
+			}
+		}
+		default:
+			break;
 	}
+	return false;
 }
 
-void LaunchTask::executeTask()
-{
-	printHeader();
-	emit log("Minecraft folder is:\n" + m_process.workingDirectory() + "\n\n");
-
-	checkJava();
-}
-
-void LaunchTask::launch()
-{
-	QString launchString("launch\n");
-	m_process.write(launchString.toUtf8());
-}
-
-void LaunchTask::abort()
-{
-	QString launchString("abort\n");
-	m_process.write(launchString.toUtf8());
-}
-
-
-void LaunchTask::setWorkdir(QString path)
-{
-	QDir mcDir(path);
-	m_process.setWorkingDirectory(mcDir.absolutePath());
-	m_prelaunchprocess.setWorkingDirectory(mcDir.absolutePath());
-	m_postlaunchprocess.setWorkingDirectory(mcDir.absolutePath());
-}
-
-void LaunchTask::printHeader()
-{
-	emit log(m_header);
-}
-
-void LaunchTask::on_log(QStringList lines, MessageLevel::Enum level)
-{
-	logOutput(lines, level);
-}
-
-void LaunchTask::logOutput(const QStringList &lines, MessageLevel::Enum defaultLevel)
+void LaunchTask::onLogLines(const QStringList &lines, MessageLevel::Enum defaultLevel)
 {
 	for (auto & line: lines)
 	{
-		logOutput(line, defaultLevel);
+		onLogLine(line, defaultLevel);
 	}
 }
 
-void LaunchTask::logOutput(QString line, MessageLevel::Enum level)
+void LaunchTask::onLogLine(QString line, MessageLevel::Enum level)
 {
 	// if the launcher part set a log level, use it
 	auto innerLevel = MessageLevel::fromLine(line);
@@ -376,230 +232,6 @@ void LaunchTask::logOutput(QString line, MessageLevel::Enum level)
 	emit log(line, level);
 }
 
-void LaunchTask::preLaunch()
-{
-	QString prelaunch_cmd = m_instance->settings()->get("PreLaunchCommand").toString();
-	if (!prelaunch_cmd.isEmpty())
-	{
-		prelaunch_cmd = substituteVariables(prelaunch_cmd);
-		// Launch
-		emit log(tr("Running Pre-Launch command: %1").arg(prelaunch_cmd));
-		m_prelaunchprocess.start(prelaunch_cmd);
-	}
-	else
-	{
-		on_pre_state(LoggedProcess::Skipped);
-	}
-}
-
-void LaunchTask::on_pre_state(LoggedProcess::State state)
-{
-	switch(state)
-	{
-		case LoggedProcess::Aborted:
-		case LoggedProcess::Crashed:
-		case LoggedProcess::FailedToStart:
-		{
-			QString error = tr("Pre-Launch command failed with code %1.\n\n").arg(m_prelaunchprocess.exitCode());
-			emit log(error, MessageLevel::Fatal);
-			emitFailed(error);
-			return;
-		}
-		case LoggedProcess::Finished:
-		{
-			emit log(tr("Pre-Launch command ran successfully.\n\n"));
-		}
-		case LoggedProcess::Skipped:
-		{
-			m_instance->reload();
-			updateInstance();
-		}
-		default:
-			break;
-	}
-}
-
-void LaunchTask::updateInstance()
-{
-	m_updateTask = m_instance->createUpdateTask();
-	if(m_updateTask)
-	{
-		connect(m_updateTask.get(), SIGNAL(finished()), this, SLOT(updateFinished()));
-		m_updateTask->start();
-		return;
-	}
-	makeReady();
-}
-
-void LaunchTask::updateFinished()
-{
-	if(m_updateTask->successful())
-	{
-		doJarModding();
-	}
-	else
-	{
-		QString reason = tr("Instance update failed because: %1.\n\n").arg(m_updateTask->failReason());
-		emit log(reason, MessageLevel::Fatal);
-		emitFailed(reason);
-	}
-}
-
-void LaunchTask::doJarModding()
-{
-	m_jarModTask = m_instance->createJarModdingTask();
-	if(!m_jarModTask)
-	{
-		jarModdingSucceeded();
-	}
-	connect(m_jarModTask.get(), SIGNAL(succeeded()), this, SLOT(jarModdingSucceeded()));
-	connect(m_jarModTask.get(), SIGNAL(failed(QString)), this, SLOT(jarModdingFailed(QString)));
-	m_jarModTask->start();
-}
-
-void LaunchTask::jarModdingSucceeded()
-{
-	makeReady();
-}
-
-void LaunchTask::jarModdingFailed(QString reason)
-{
-	emitFailed(reason);
-}
-
-void LaunchTask::makeReady()
-{
-	QStringList args = javaArguments();
-	QString allArgs = args.join(", ");
-	emit log("Java Arguments:\n[" + censorPrivateInfo(allArgs) + "]\n\n");
-
-	QString wrapperCommand = m_instance->settings()->get("WrapperCommand").toString();
-	if(!wrapperCommand.isEmpty())
-	{
-		auto realWrapperCommand = QStandardPaths::findExecutable(wrapperCommand);
-		if (realWrapperCommand.isEmpty())
-		{
-			QString reason = tr("The wrapper command \"%1\" couldn't be found.").arg(wrapperCommand);
-			emit log(reason, MessageLevel::Fatal);
-			emitFailed(reason);
-			return;
-		}
-		emit log("Wrapper command is:\n" + wrapperCommand + "\n\n");
-		args.prepend(m_javaPath);
-		m_process.start(wrapperCommand, args);
-	}
-	else
-	{
-		m_process.start(m_javaPath, args);
-	}
-
-	// instantiate the launcher part
-	if (!m_process.waitForStarted())
-	{
-		//: Error message displayed if instace can't start
-		QString reason = tr("Could not launch minecraft!");
-		emit log(reason, MessageLevel::Fatal);
-		emitFailed(reason);
-		return;
-	}
-
-	emit log(tr("Minecraft process ID: %1\n\n").arg(m_process.processId()), MessageLevel::MultiMC);
-
-	// send the launch script to the launcher part
-	m_process.write(launchScript.toUtf8());
-
-	emit readyForLaunch();
-}
-
-void LaunchTask::on_state(LoggedProcess::State state)
-{
-	QProcess::ExitStatus estat = QProcess::NormalExit;
-	switch(state)
-	{
-		case LoggedProcess::Aborted:
-		case LoggedProcess::Crashed:
-		case LoggedProcess::FailedToStart:
-		{
-			estat = QProcess::CrashExit;
-			emitFailed("Game crashed.");
-			return;
-		}
-		case LoggedProcess::Finished:
-		{
-			auto exitCode = m_process.exitCode();
-			m_postlaunchprocess.processEnvironment().insert("INST_EXITCODE", QString(exitCode));
-			// run post-exit
-			postLaunch();
-			break;
-		}
-		case LoggedProcess::Skipped:
-			qWarning() << "Illegal game state: Skipped";
-			break;
-		case LoggedProcess::Running:
-			m_instance->setLastLaunch();
-			break;
-		default:
-			break;
-	}
-}
-
-void LaunchTask::killProcess()
-{
-	killed = true;
-	if (m_prelaunchprocess.state() == LoggedProcess::Running)
-	{
-		m_prelaunchprocess.kill();
-	}
-	else if(m_process.state() == LoggedProcess::Running)
-	{
-		m_process.kill();
-	}
-	else if(m_postlaunchprocess.state() == LoggedProcess::Running)
-	{
-		m_postlaunchprocess.kill();
-	}
-}
-
-void LaunchTask::postLaunch()
-{
-	if(killed)
-		return;
-	QString postlaunch_cmd = m_instance->settings()->get("PostExitCommand").toString();
-	if (!postlaunch_cmd.isEmpty())
-	{
-		postlaunch_cmd = substituteVariables(postlaunch_cmd);
-		emit log(tr("Running Post-Launch command: %1").arg(postlaunch_cmd));
-		m_postlaunchprocess.start(postlaunch_cmd);
-		return;
-	}
-	emitSucceeded();
-}
-
-void LaunchTask::on_post_state(LoggedProcess::State state)
-{
-	switch(state)
-	{
-		case LoggedProcess::Aborted:
-		case LoggedProcess::Crashed:
-		case LoggedProcess::FailedToStart:
-		{
-			QString error = tr("Post-Launch command failed with code %1.\n\n").arg(m_postlaunchprocess.exitCode());
-			emit log(error, MessageLevel::Error);
-			emitFailed(error);
-		}
-		case LoggedProcess::Finished:
-		{
-			emit log(tr("Post-Launch command ran successfully.\n\n"));
-		}
-		case LoggedProcess::Skipped:
-		{
-			emitSucceeded();
-		}
-		default:
-			break;
-	}
-}
-
 void LaunchTask::emitSucceeded()
 {
 	m_instance->cleanupAfterRun();
@@ -617,7 +249,7 @@ void LaunchTask::emitFailed(QString reason)
 QString LaunchTask::substituteVariables(const QString &cmd) const
 {
 	QString out = cmd;
-	auto variables = getVariables();
+	auto variables = m_instance->getVariables();
 	for (auto it = variables.begin(); it != variables.end(); ++it)
 	{
 		out.replace("$" + it.key(), it.value());
@@ -630,12 +262,3 @@ QString LaunchTask::substituteVariables(const QString &cmd) const
 	return out;
 }
 
-qint64 LaunchTask::pid()
-{
-#ifdef Q_OS_WIN
-	struct _PROCESS_INFORMATION *procinfo = m_process.pid();
-	return procinfo->dwProcessId;
-#else
-	return m_process.pid();
-#endif
-}