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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#include "System/EventHandler.h"
#include "LuaVFSDownload.h"
#include "System/Util.h"
#include "System/EventHandler.h"
#include "System/Platform/Threading.h"
#include "System/Threading/SpringMutex.h"
#include "System/FileSystem/ArchiveScanner.h"
#include <queue>
#include "LuaInclude.h"
#include "../tools/pr-downloader/src/pr-downloader.h"
/******************************************************************************/
/******************************************************************************/
#define REGISTER_LUA_CFUNC(x) \
lua_pushstring(L, #x); \
lua_pushcfunction(L, x); \
lua_rawset(L, -3)
LuaVFSDownload* luavfsdownload = nullptr;
struct dlEvent {
int ID;
virtual void processEvent() = 0;
virtual ~dlEvent(){}
};
struct dlStarted : public dlEvent {
void processEvent() {
eventHandler.DownloadStarted(ID);
}
};
struct dlFinished : public dlEvent {
void processEvent() {
eventHandler.DownloadFinished(ID);
}
};
struct dlFailed : public dlEvent {
int errorID;
void processEvent() {
eventHandler.DownloadFailed(ID, errorID);
}
};
struct dlProgress : public dlEvent {
long downloaded;
long total;
void processEvent() {
eventHandler.DownloadProgress(ID, downloaded, total);
}
};
std::queue<dlEvent*> dlEventQueue;
spring::mutex dlEventQueueMutex;
void AddQueueEvent(dlEvent* ev) {
dlEventQueueMutex.lock();
dlEventQueue.push(ev);
dlEventQueueMutex.unlock();
}
void QueueDownloadStarted(int ID) //queue from other thread download started event
{
dlStarted* ev = new dlStarted();
ev->ID = ID;
AddQueueEvent(ev);
}
void QueueDownloadFinished(int ID) //queue from other thread download started event
{
dlFinished* ev = new dlFinished();
ev->ID = ID;
AddQueueEvent(ev);
}
void QueueDownloadFailed(int ID, int errorID) //queue from other thread download started event
{
dlFailed* ev = new dlFailed();
ev->ID = ID;
ev->errorID = errorID;
AddQueueEvent(ev);
}
void QueueDownloadProgress(int ID, long downloaded, long total) //queue from other thread download started event
{
dlProgress* ev = new dlProgress();
ev->ID = ID;
ev->downloaded = downloaded;
ev->total = total;
AddQueueEvent(ev);
}
LuaVFSDownload::LuaVFSDownload():
CEventClient("[LuaVFSDownload]", 314161, false)
{
eventHandler.AddClient(this);
}
LuaVFSDownload::~LuaVFSDownload()
{
eventHandler.RemoveClient(this);
}
bool LuaVFSDownload::PushEntries(lua_State* L)
{
REGISTER_LUA_CFUNC(DownloadArchive);
return true;
}
struct DownloadItem {
int ID;
std::string filename;
DownloadEnum::Category cat;
DownloadItem(int ID, const std::string& filename, DownloadEnum::Category& cat) : ID(ID), filename(filename), cat(cat) {
}
};
static int queueIDCount = -1;
static int currentDownloadID = -1;
static std::list<DownloadItem> queue;
static bool isDownloading = false;
spring::mutex queueMutex;
void StartDownload();
void UpdateProgress(int done, int size) {
QueueDownloadProgress(currentDownloadID, done, size);
}
__FORCE_ALIGN_STACK__
int Download(int ID, const std::string& filename, DownloadEnum::Category cat)
{
currentDownloadID = ID;
// FIXME: Progress is incorrectly updated when rapid is queried to check for existing packages.
SetDownloadListener(UpdateProgress);
LOG_L(L_DEBUG, "Going to download %s", filename.c_str());
DownloadInit();
const int count = DownloadSearch(cat, filename.c_str());
for (int i = 0; i < count; i++) {
DownloadAdd(i);
struct downloadInfo dl;
if (DownloadGetInfo(i, dl)) {
LOG_L(L_DEBUG, "Download info: %s %d", dl.filename, dl.cat);
}
}
int result;
LOG_L(L_DEBUG, "Download count: %d", count);
// TODO: count will be 1 when archives already exist. We should instead return a different result with DownloadFailed/DownloadFinished?
if (count == 0) { // there's nothing to download
result = 2;
QueueDownloadFailed(ID, result);
} else {
LOG_L(L_DEBUG, "Download finished %s", filename.c_str());
QueueDownloadStarted(ID);
result = DownloadStart();
// TODO: This works but there are errors spammed as it's trying to clear timers in the main thread, which this is not:
// Error: [Watchdog::ClearTimer(id)] Invalid thread 4 (_threadId=(nil))
archiveScanner->ScanAllDirs();
}
DownloadShutdown();
return result;
}
void StartDownload() {
isDownloading = true;
const DownloadItem downloadItem = queue.front();
queue.pop_front();
const std::string& filename = downloadItem.filename;
DownloadEnum::Category cat = downloadItem.cat;
int ID = downloadItem.ID;
if (!filename.empty()) {
LOG_L(L_DEBUG, "DOWNLOADING: %s", filename.c_str());
}
boost::thread {[ID, filename, cat]() {
const int result = Download(ID, filename, cat);
if (result == 0) {
QueueDownloadFinished(ID);
} else {
QueueDownloadFailed(ID, result);
}
queueMutex.lock();
if (!queue.empty()) {
queueMutex.unlock();
StartDownload();
} else {
isDownloading = false;
queueMutex.unlock();
}
}
}.detach();
}
/******************************************************************************/
int LuaVFSDownload::DownloadArchive(lua_State* L)
{
const std::string filename = luaL_checkstring(L, 1);
const std::string categoryStr = luaL_checkstring(L, 2);
if (filename.empty()) {
return luaL_error(L, "Missing download archive name.");
}
DownloadEnum::Category cat;
if (categoryStr == "map") {
cat = DownloadEnum::CAT_MAP;
} else if (categoryStr == "game") {
cat = DownloadEnum::CAT_GAME;
} else if (categoryStr == "engine") {
cat = DownloadEnum::CAT_ENGINE;
} else {
return luaL_error(L, "Category must be one of: map, game, engine.");
}
queueIDCount++;
queueMutex.lock();
queue.push_back(DownloadItem(queueIDCount, filename, cat));
queueMutex.unlock();
eventHandler.DownloadQueued(queueIDCount, filename, categoryStr);
if (!isDownloading) {
if (queue.size() == 1) {
StartDownload();
}
}
return 0;
}
void LuaVFSDownload::Update()
{
assert(Threading::IsMainThread() || Threading::IsGameLoadThread());
// only locks the mutex if the queue is not empty
if (!dlEventQueue.empty()) {
dlEventQueueMutex.lock();
dlEvent* ev;
while (!dlEventQueue.empty()) {
ev = dlEventQueue.front();
dlEventQueue.pop();
ev->processEvent();
SafeDelete(ev);
}
dlEventQueueMutex.unlock();
}
}
|