summaryrefslogtreecommitdiffstats
path: root/logic/updater/DownloadUpdateTask.cpp
blob: cc06104aae2ed5f045ca67c42913e4f7c93857b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
/* Copyright 2013 MultiMC Contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "DownloadUpdateTask.h"

#include "MultiMC.h"
#include "logic/updater/UpdateChecker.h"
#include "logic/net/NetJob.h"
#include "pathutils.h"

#include <QFile>
#include <QTemporaryDir>
#include <QCryptographicHash>

#include <QDomDocument>

DownloadUpdateTask::DownloadUpdateTask(QString repoUrl, int versionId, QObject *parent)
	: Task(parent)
{
	m_cVersionId = MMC->version().build;

	m_nRepoUrl = repoUrl;
	m_nVersionId = versionId;

	m_updateFilesDir.setAutoRemove(false);
}

void DownloadUpdateTask::executeTask()
{
	// GO!
	// This will call the next step when it's done.
	findCurrentVersionInfo();
}

void DownloadUpdateTask::processChannels()
{
	auto checker = MMC->updateChecker();

	// Now, check the channel list again.
	if (!checker->hasChannels())
	{
		// We still couldn't load the channel list. Give up. Call loadVersionInfo and return.
		QLOG_INFO() << "Reloading the channel list didn't work. Giving up.";
		loadVersionInfo();
		return;
	}

	QList<UpdateChecker::ChannelListEntry> channels = checker->getChannelList();
	QString channelId = MMC->version().channel;

	// Search through the channel list for a channel with the correct ID.
	for (auto channel : channels)
	{
		if (channel.id == channelId)
		{
			QLOG_INFO() << "Found matching channel.";
			m_cRepoUrl = preparePath(channel.url);
			break;
		}
	}

	// Now that we've done that, load version info.
	loadVersionInfo();
}

void DownloadUpdateTask::findCurrentVersionInfo()
{
	setStatus(tr("Finding information about the current version."));

	auto checker = MMC->updateChecker();

	if (!checker->hasChannels())
	{
		// Load the channel list and wait for it to finish loading.
		QLOG_INFO() << "No channel list entries found. Will try reloading it.";

		QObject::connect(checker.get(), &UpdateChecker::channelListLoaded, this,
						 &DownloadUpdateTask::processChannels);
		checker->updateChanList();
	}
	else
	{
		processChannels();
	}
}

void DownloadUpdateTask::loadVersionInfo()
{
	setStatus(tr("Loading version information."));

	// Create the net job for loading version info.
	NetJob *netJob = new NetJob("Version Info");

	// Find the index URL.
	QUrl newIndexUrl = QUrl(m_nRepoUrl).resolved(QString::number(m_nVersionId) + ".json");
	QLOG_DEBUG() << m_nRepoUrl << " turns into " << newIndexUrl;

	// Add a net action to download the version info for the version we're updating to.
	netJob->addNetAction(ByteArrayDownload::make(newIndexUrl));

	// If we have a current version URL, get that one too.
	if (!m_cRepoUrl.isEmpty())
	{
		QUrl cIndexUrl = QUrl(m_cRepoUrl).resolved(QString::number(m_cVersionId) + ".json");
		netJob->addNetAction(ByteArrayDownload::make(cIndexUrl));
		QLOG_DEBUG() << m_cRepoUrl << " turns into " << cIndexUrl;
	}

	// Connect slots so we know when it's done.
	QObject::connect(netJob, &NetJob::succeeded, this,
					 &DownloadUpdateTask::vinfoDownloadFinished);
	QObject::connect(netJob, &NetJob::failed, this, &DownloadUpdateTask::vinfoDownloadFailed);

	// Store the NetJob in a class member. We don't want to lose it!
	m_vinfoNetJob.reset(netJob);

	// Finally, we start the network job and the thread's event loop to wait for it to finish.
	netJob->start();
}

void DownloadUpdateTask::vinfoDownloadFinished()
{
	// Both downloads succeeded. OK. Parse stuff.
	parseDownloadedVersionInfo();
}

void DownloadUpdateTask::vinfoDownloadFailed()
{
	// Something failed. We really need the second download (current version info), so parse
	// downloads anyways as long as the first one succeeded.
	if (m_vinfoNetJob->first()->m_status != Job_Failed)
	{
		parseDownloadedVersionInfo();
		return;
	}

	// TODO: Give a more detailed error message.
	QLOG_ERROR() << "Failed to download version info files.";
	emitFailed(tr("Failed to download version info files."));
}

void DownloadUpdateTask::parseDownloadedVersionInfo()
{
	setStatus(tr("Reading file lists."));

	setStatus(tr("Reading file list for new version."));
	QLOG_DEBUG() << "Reading file list for new version.";
	QString error;
	if (!parseVersionInfo(
			 std::dynamic_pointer_cast<ByteArrayDownload>(m_vinfoNetJob->first())->m_data,
			 &m_nVersionFileList, &error))
	{
		emitFailed(error);
		return;
	}

	// If there is a second entry in the network job's list, load it as the current version's
	// info.
	if (m_vinfoNetJob->size() >= 2 && m_vinfoNetJob->operator[](1)->m_status != Job_Failed)
	{
		setStatus(tr("Reading file list for current version."));
		QLOG_DEBUG() << "Reading file list for current version.";
		QString error;
		parseVersionInfo(
			std::dynamic_pointer_cast<ByteArrayDownload>(m_vinfoNetJob->operator[](1))->m_data,
			&m_cVersionFileList, &error);
	}

	// We don't need this any more.
	m_vinfoNetJob.reset();

	// Now that we're done loading version info, we can move on to the next step. Process file
	// lists and download files.
	processFileLists();
}

bool DownloadUpdateTask::parseVersionInfo(const QByteArray &data, VersionFileList *list,
										  QString *error)
{
	QJsonParseError jsonError;
	QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &jsonError);
	if (jsonError.error != QJsonParseError::NoError)
	{
		*error = QString("Failed to parse version info JSON: %1 at %2")
					 .arg(jsonError.errorString())
					 .arg(jsonError.offset);
		QLOG_ERROR() << error;
		return false;
	}

	QJsonObject json = jsonDoc.object();

	QLOG_DEBUG() << data;
	QLOG_DEBUG() << "Loading version info from JSON.";
	QJsonArray filesArray = json.value("Files").toArray();
	for (QJsonValue fileValue : filesArray)
	{
		QJsonObject fileObj = fileValue.toObject();

		VersionFileEntry file{
			fileObj.value("Path").toString(), fileObj.value("Perms").toVariant().toInt(),
			FileSourceList(),				 fileObj.value("MD5").toString(), };
		QLOG_DEBUG() << "File" << file.path << "with perms" << file.mode;

		QJsonArray sourceArray = fileObj.value("Sources").toArray();
		for (QJsonValue val : sourceArray)
		{
			QJsonObject sourceObj = val.toObject();

			QString type = sourceObj.value("SourceType").toString();
			if (type == "http")
			{
				file.sources.append(
					FileSource("http", preparePath(sourceObj.value("Url").toString())));
			}
			else if (type == "httpc")
			{
				file.sources.append(FileSource("httpc",
											   preparePath(sourceObj.value("Url").toString()),
											   sourceObj.value("CompressionType").toString()));
			}
			else
			{
				QLOG_WARN() << "Unknown source type" << type << "ignored.";
			}
		}

		QLOG_DEBUG() << "Loaded info for" << file.path;

		list->append(file);
	}

	return true;
}

void DownloadUpdateTask::processFileLists()
{
	// Create a network job for downloading files.
	NetJob *netJob = new NetJob("Update Files");

	if (!processFileLists(netJob, m_cVersionFileList, m_nVersionFileList, m_operationList))
	{
		emitFailed(tr("Failed to process update lists..."));
		return;
	}

	// Add listeners to wait for the downloads to finish.
	QObject::connect(netJob, &NetJob::succeeded, this,
					 &DownloadUpdateTask::fileDownloadFinished);
	QObject::connect(netJob, &NetJob::progress, this,
					 &DownloadUpdateTask::fileDownloadProgressChanged);
	QObject::connect(netJob, &NetJob::failed, this, &DownloadUpdateTask::fileDownloadFailed);

	// Now start the download.
	setStatus(tr("Downloading %1 update files.").arg(QString::number(netJob->size())));
	QLOG_DEBUG() << "Begin downloading update files to" << m_updateFilesDir.path();
	m_filesNetJob.reset(netJob);
	netJob->start();

	writeInstallScript(m_operationList, PathCombine(m_updateFilesDir.path(), "file_list.xml"));
}

bool
DownloadUpdateTask::processFileLists(NetJob *job,
									 const DownloadUpdateTask::VersionFileList &currentVersion,
									 const DownloadUpdateTask::VersionFileList &newVersion,
									 DownloadUpdateTask::UpdateOperationList &ops)
{
	setStatus(tr("Processing file lists. Figuring out how to install the update."));

	// First, if we've loaded the current version's file list, we need to iterate through it and
	// delete anything in the current one version's list that isn't in the new version's list.
	for (VersionFileEntry entry : currentVersion)
	{
		QFileInfo toDelete(entry.path);
		if (!toDelete.exists())
		{
			QLOG_ERROR() << "Expected file " << toDelete.absoluteFilePath()
						 << " doesn't exist!";
			QLOG_ERROR() << "CWD: " << QDir::currentPath();
		}
		bool keep = false;

		//
		for (VersionFileEntry newEntry : newVersion)
		{
			if (newEntry.path == entry.path)
			{
				QLOG_DEBUG() << "Not deleting" << entry.path
							 << "because it is still present in the new version.";
				keep = true;
				break;
			}
		}

		// If the loop reaches the end and we didn't find a match, delete the file.
		if (!keep)
		{
			QFileInfo toDelete(entry.path);
			if (toDelete.exists())
				ops.append(UpdateOperation::DeleteOp(entry.path));
		}
	}

	// Next, check each file in MultiMC's folder and see if we need to update them.
	for (VersionFileEntry entry : newVersion)
	{
		// TODO: Let's not MD5sum a ton of files on the GUI thread. We should probably find a
		// way to do this in the background.
		QString fileMD5;
		QFile entryFile(entry.path);
		QFileInfo entryInfo(entry.path);

		bool needs_upgrade = false;
		if (!entryFile.exists())
		{
			needs_upgrade = true;
		}
		else
		{
			bool pass = true;
			if (!entryInfo.isReadable())
			{
				QLOG_ERROR() << "File " << entry.path << " is not readable.";
				pass = false;
			}
			if (!entryInfo.isWritable())
			{
				QLOG_ERROR() << "File " << entry.path << " is not writable.";
				pass = false;
			}
			if (!entryFile.open(QFile::ReadOnly))
			{
				QLOG_ERROR() << "File " << entry.path << " cannot be opened for reading.";
				pass = false;
			}
			if (!pass)
			{
				QLOG_ERROR() << "CWD: " << QDir::currentPath();
				ops.clear();
				return false;
			}
		}

		QCryptographicHash hash(QCryptographicHash::Md5);
		auto foo = entryFile.readAll();

		hash.addData(foo);
		fileMD5 = hash.result().toHex();
		if ((fileMD5 != entry.md5))
		{
			QLOG_DEBUG() << "MD5Sum does not match!";
			QLOG_DEBUG() << "Expected:'" << entry.md5 << "'";
			QLOG_DEBUG() << "Got:     '" << fileMD5 << "'";
			needs_upgrade = true;
		}

		// skip file. it doesn't need an upgrade.
		if (!needs_upgrade)
		{
			QLOG_DEBUG() << "File" << entry.path << " does not need updating.";
			continue;
		}

		// yep. this file actually needs an upgrade. PROCEED.
		QLOG_DEBUG() << "Found file" << entry.path << " that needs updating.";

		// Go through the sources list and find one to use.
		// TODO: Make a NetAction that takes a source list and tries each of them until one
		// works. For now, we'll just use the first http one.
		for (FileSource source : entry.sources)
		{
			if (source.type == "http")
			{
				QLOG_DEBUG() << "Will download" << entry.path << "from" << source.url;

				// Download it to updatedir/<filepath>-<md5> where filepath is the file's
				// path with slashes replaced by underscores.
				QString dlPath =
					PathCombine(m_updateFilesDir.path(), QString(entry.path).replace("/", "_"));

				if (job)
				{
					// We need to download the file to the updatefiles folder and add a task
					// to copy it to its install path.
					auto download = MD5EtagDownload::make(source.url, dlPath);
					download->m_check_md5 = true;
					download->m_expected_md5 = entry.md5;
					job->addNetAction(download);
				}

				// Now add a copy operation to our operations list to install the file.
				ops.append(UpdateOperation::CopyOp(dlPath, entry.path, entry.mode));
			}
		}
	}
	return true;
}

bool DownloadUpdateTask::writeInstallScript(UpdateOperationList &opsList, QString scriptFile)
{
	// Build the base structure of the XML document.
	QDomDocument doc;

	QDomElement root = doc.createElement("update");
	root.setAttribute("version", "3");
	doc.appendChild(root);

	QDomElement installFiles = doc.createElement("install");
	root.appendChild(installFiles);

	QDomElement removeFiles = doc.createElement("uninstall");
	root.appendChild(removeFiles);

	// Write the operation list to the XML document.
	for (UpdateOperation op : opsList)
	{
		QDomElement file = doc.createElement("file");

		QString native_file = QDir::toNativeSeparators(op.file);
		QString native_dest = QDir::toNativeSeparators(op.dest);

		switch (op.type)
		{
		case UpdateOperation::OP_COPY:
		{
			// Install the file.
			QDomElement name = doc.createElement("source");
			QDomElement path = doc.createElement("dest");
			QDomElement mode = doc.createElement("mode");
			name.appendChild(doc.createTextNode(native_file));
			path.appendChild(doc.createTextNode(native_dest));
			// We need to add a 0 at the beginning here, because Qt doesn't convert to octal
			// correctly.
			mode.appendChild(doc.createTextNode("0" + QString::number(op.mode, 8)));
			file.appendChild(name);
			file.appendChild(path);
			file.appendChild(mode);
			installFiles.appendChild(file);
			QLOG_DEBUG() << "Will install file" << native_file;
		}
		break;

		case UpdateOperation::OP_DELETE:
		{
			// Delete the file.
			file.appendChild(doc.createTextNode(native_file));
			removeFiles.appendChild(file);
			QLOG_DEBUG() << "Will remove file" << native_file;
		}
		break;

		default:
			QLOG_WARN() << "Can't write update operation of type" << op.type
						<< "to file. Not implemented.";
			continue;
		}
	}

	// Write the XML document to the file.
	QFile outFile(scriptFile);

	if (outFile.open(QIODevice::WriteOnly))
	{
		outFile.write(doc.toByteArray());
	}
	else
	{
		emitFailed(tr("Failed to write update script file."));
		return false;
	}

	return true;
}

QString DownloadUpdateTask::preparePath(const QString &path)
{
	QString foo = path;
	foo.replace("$PWD", qApp->applicationDirPath());
	return QUrl::fromLocalFile(foo).toString(QUrl::FullyEncoded);
}

void DownloadUpdateTask::fileDownloadFinished()
{
	emitSucceeded();
}

void DownloadUpdateTask::fileDownloadFailed()
{
	// TODO: Give more info about the failure.
	QLOG_ERROR() << "Failed to download update files.";
	emitFailed(tr("Failed to download update files."));
}

void DownloadUpdateTask::fileDownloadProgressChanged(qint64 current, qint64 total)
{
	setProgress((int)(((float)current / (float)total) * 100));
}

QString DownloadUpdateTask::updateFilesDir()
{
	return m_updateFilesDir.path();
}