thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

CLOUD: Add "/download" handler

Browse source 
Now one can download files from the device through browser!
This commit is contained in:
Alexander Tkachev 2016-07-06 19:09:29 +06:00
parent 8a9d126152
commit b40bfaa046
7 changed files with 169 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
backends/module.mk
View file

@ -60,6 +60,7 @@ MODULE_OBJS += \
networking/sdl_net/getclienthandler.o \ networking/sdl_net/getclienthandler.o \
networking/sdl_net/handlers/basehandler.o \ networking/sdl_net/handlers/basehandler.o \
networking/sdl_net/handlers/createdirectoryhandler.o \ networking/sdl_net/handlers/createdirectoryhandler.o \
networking/sdl_net/handlers/downloadfilehandler.o \
networking/sdl_net/handlers/filesbasehandler.o \ networking/sdl_net/handlers/filesbasehandler.o \
networking/sdl_net/handlers/filespagehandler.o \ networking/sdl_net/handlers/filespagehandler.o \
networking/sdl_net/handlers/indexpagehandler.o \ networking/sdl_net/handlers/indexpagehandler.o \

111
backends/networking/sdl_net/handlers/downloadfilehandler.cpp Normal file
View file

@ -0,0 +1,111 @@
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "backends/networking/sdl_net/handlers/downloadfilehandler.h"
#include "backends/networking/sdl_net/localwebserver.h"
#include "backends/fs/fs-factory.h"
#include "common/file.h"
#include "common/translation.h"
#include "../getclienthandler.h"
namespace Networking {
#define INDEX_PAGE_NAME ".index.html"
DownloadFileHandler::DownloadFileHandler() {}
DownloadFileHandler::~DownloadFileHandler() {}
void DownloadFileHandler::handle(Client &client) {
Common::String path = client.queryParameter("path");
Common::String errorMessage = "";
// show an error message if failed to download the file
if (!downloadFile(client, path, errorMessage)) {
handleErrorMessage(
client,
Common::String::format(
"%s<br/><a href=\"files?path=/\">%s</a>",
errorMessage.c_str(),
_("Back to the files manager")
)
);
}
}
void DownloadFileHandler::handleErrorMessage(Client &client, Common::String message) {
Common::String response = "<html><head><title>ScummVM</title></head><body>{message}</body></html>";
// load stylish response page from the archive
Common::SeekableReadStream *const stream = getArchiveFile(INDEX_PAGE_NAME);
if (stream) response = readEverythingFromStream(stream);
replace(response, "{message}", message);
LocalWebserver::setClientGetHandler(client, response);
}
bool DownloadFileHandler::downloadFile(Client &client, Common::String path, Common::String &errorMessage) {
// check that <path> is not an absolute root
if (path == "" || path == "/") {
errorMessage = _("Invalid path!");
return false;
}
// transform virtual path to actual file system one
Common::String prefixToRemove = "", prefixToAdd = "";
if (!transformPath(path, prefixToRemove, prefixToAdd, false) || path.empty()) {
errorMessage = _("Invalid path!");
return false;
}
// check that <path> exists and is directory
AbstractFSNode *node = g_system->getFilesystemFactory()->makeFileNodePath(path);
if (!node->exists()) {
errorMessage = _("The file doesn't exist!");
return false;
}
if (node->isDirectory()) {
errorMessage = _("Can't download a directory!");
return false;
}
Common::SeekableReadStream *stream = node->createReadStream();
if (stream == nullptr) {
errorMessage = _("Failed to read the file!");
return false;
}
GetClientHandler *handler = new GetClientHandler(stream);
handler->setResponseCode(200);
handler->setHeader("Content-Type", "application/force-download");
handler->setHeader("Content-Disposition", "attachment; filename=\"" + node->getDisplayName() + "\"");
handler->setHeader("Content-Transfer-Encoding", "binary");
client.setHandler(handler);
return true;
}
/// public
ClientHandlerCallback DownloadFileHandler::getHandler() {
return new Common::Callback<DownloadFileHandler, Client &>(this, &DownloadFileHandler::handle);
}
} // End of namespace Networking

51
backends/networking/sdl_net/handlers/downloadfilehandler.h Normal file
View file

@ -0,0 +1,51 @@
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef BACKENDS_NETWORKING_SDL_NET_DOWNLOADFILEHANDLER_H
#define BACKENDS_NETWORKING_SDL_NET_DOWNLOADFILEHANDLER_H
#include "backends/networking/sdl_net/handlers/filesbasehandler.h"
namespace Networking {
class DownloadFileHandler: public FilesBaseHandler {
void handle(Client &client);
void handleErrorMessage(Client &client, Common::String message);
/**
* Creates a client handler for downloading file <path>.
*
* Fills <errorMessage> on failure.
*
* Returns true on success.
*/
bool downloadFile(Client &client, Common::String path, Common::String &errorMessage);
public:
DownloadFileHandler();
virtual ~DownloadFileHandler();
virtual ClientHandlerCallback getHandler();
};
} // End of namespace Networking
#endif

4
backends/networking/sdl_net/handlers/filesbasehandler.cpp
View file

@ -44,9 +44,9 @@ Common::String FilesBaseHandler::parentPath(Common::String path) {
return path; return path;
} }
bool FilesBaseHandler::transformPath(Common::String &path, Common::String &prefixToRemove, Common::String &prefixToAdd) { bool FilesBaseHandler::transformPath(Common::String &path, Common::String &prefixToRemove, Common::String &prefixToAdd, bool isDirectory) {
// <path> is not empty, but could lack the trailing slash // <path> is not empty, but could lack the trailing slash
if (path.lastChar() != '/' && path.lastChar() != '\\') path += '/'; if (isDirectory && path.lastChar() != '/' && path.lastChar() != '\\') path += '/';
if (path.hasPrefix("/root")) { if (path.hasPrefix("/root")) {
prefixToAdd = "/root/"; prefixToAdd = "/root/";

2
backends/networking/sdl_net/handlers/filesbasehandler.h
View file

@ -39,7 +39,7 @@ protected:
* *
* Returns true on success. * Returns true on success.
*/ */
bool transformPath(Common::String &path, Common::String &prefixToRemove, Common::String &prefixToAdd); bool transformPath(Common::String &path, Common::String &prefixToRemove, Common::String &prefixToAdd, bool isDirectory = true);
public: public:
FilesBaseHandler(); FilesBaseHandler();
virtual ~FilesBaseHandler(); virtual ~FilesBaseHandler();

1
backends/networking/sdl_net/localwebserver.cpp
View file

@ -45,6 +45,7 @@ LocalWebserver::LocalWebserver(): _set(nullptr), _serverSocket(nullptr), _timerS
addPathHandler("/", _indexPageHandler.getHandler()); addPathHandler("/", _indexPageHandler.getHandler());
addPathHandler("/files", _filesPageHandler.getHandler()); addPathHandler("/files", _filesPageHandler.getHandler());
addPathHandler("/create", _createDirectoryHandler.getHandler()); addPathHandler("/create", _createDirectoryHandler.getHandler());
addPathHandler("/download", _downloadFileHandler.getHandler());
_defaultHandler = _resourceHandler.getHandler(); _defaultHandler = _resourceHandler.getHandler();
} }

2
backends/networking/sdl_net/localwebserver.h
View file

@ -26,6 +26,7 @@
#include "backends/networking/sdl_net/client.h" #include "backends/networking/sdl_net/client.h"
#include "backends/networking/sdl_net/handlers/basehandler.h" #include "backends/networking/sdl_net/handlers/basehandler.h"
#include "backends/networking/sdl_net/handlers/createdirectoryhandler.h" #include "backends/networking/sdl_net/handlers/createdirectoryhandler.h"
#include "backends/networking/sdl_net/handlers/downloadfilehandler.h"
#include "backends/networking/sdl_net/handlers/filespagehandler.h" #include "backends/networking/sdl_net/handlers/filespagehandler.h"
#include "backends/networking/sdl_net/handlers/indexpagehandler.h" #include "backends/networking/sdl_net/handlers/indexpagehandler.h"
#include "backends/networking/sdl_net/handlers/resourcehandler.h" #include "backends/networking/sdl_net/handlers/resourcehandler.h"
@ -61,6 +62,7 @@ class LocalWebserver : public Common::Singleton<LocalWebserver> {
IndexPageHandler _indexPageHandler; IndexPageHandler _indexPageHandler;
FilesPageHandler _filesPageHandler; FilesPageHandler _filesPageHandler;
CreateDirectoryHandler _createDirectoryHandler; CreateDirectoryHandler _createDirectoryHandler;
DownloadFileHandler _downloadFileHandler;
ResourceHandler _resourceHandler; ResourceHandler _resourceHandler;
uint32 _idlingFrames; uint32 _idlingFrames;
Common::Mutex _handleMutex; Common::Mutex _handleMutex;