From b40bfaa046370a2eeadcce1236f518315e8ada01 Mon Sep 17 00:00:00 2001
From: Alexander Tkachev
Date: Wed, 6 Jul 2016 19:09:29 +0600
Subject: CLOUD: Add "/download" handler
Now one can download files from the device through browser!
---
.../sdl_net/handlers/downloadfilehandler.cpp | 111 +++++++++++++++++++++
.../sdl_net/handlers/downloadfilehandler.h | 51 ++++++++++
.../sdl_net/handlers/filesbasehandler.cpp | 4 +-
.../networking/sdl_net/handlers/filesbasehandler.h | 2 +-
backends/networking/sdl_net/localwebserver.cpp | 1 +
backends/networking/sdl_net/localwebserver.h | 2 +
6 files changed, 168 insertions(+), 3 deletions(-)
create mode 100644 backends/networking/sdl_net/handlers/downloadfilehandler.cpp
create mode 100644 backends/networking/sdl_net/handlers/downloadfilehandler.h
(limited to 'backends/networking/sdl_net')
diff --git a/backends/networking/sdl_net/handlers/downloadfilehandler.cpp b/backends/networking/sdl_net/handlers/downloadfilehandler.cpp
new file mode 100644
index 0000000000..59eb7dfcb3
--- /dev/null
+++ b/backends/networking/sdl_net/handlers/downloadfilehandler.cpp
@@ -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
%s",
+ errorMessage.c_str(),
+ _("Back to the files manager")
+ )
+ );
+ }
+}
+
+void DownloadFileHandler::handleErrorMessage(Client &client, Common::String message) {
+ Common::String response = "ScummVM{message}";
+
+ // 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 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 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(this, &DownloadFileHandler::handle);
+}
+
+} // End of namespace Networking
diff --git a/backends/networking/sdl_net/handlers/downloadfilehandler.h b/backends/networking/sdl_net/handlers/downloadfilehandler.h
new file mode 100644
index 0000000000..6b6966435c
--- /dev/null
+++ b/backends/networking/sdl_net/handlers/downloadfilehandler.h
@@ -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 .
+ *
+ * Fills 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
diff --git a/backends/networking/sdl_net/handlers/filesbasehandler.cpp b/backends/networking/sdl_net/handlers/filesbasehandler.cpp
index 4575e4d7e4..d4b5c3b9e8 100644
--- a/backends/networking/sdl_net/handlers/filesbasehandler.cpp
+++ b/backends/networking/sdl_net/handlers/filesbasehandler.cpp
@@ -44,9 +44,9 @@ Common::String FilesBaseHandler::parentPath(Common::String 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) {
// 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")) {
prefixToAdd = "/root/";
diff --git a/backends/networking/sdl_net/handlers/filesbasehandler.h b/backends/networking/sdl_net/handlers/filesbasehandler.h
index 3b631a998b..a960181ad1 100644
--- a/backends/networking/sdl_net/handlers/filesbasehandler.h
+++ b/backends/networking/sdl_net/handlers/filesbasehandler.h
@@ -39,7 +39,7 @@ protected:
*
* 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:
FilesBaseHandler();
virtual ~FilesBaseHandler();
diff --git a/backends/networking/sdl_net/localwebserver.cpp b/backends/networking/sdl_net/localwebserver.cpp
index b2eff1667f..cc3f67e208 100644
--- a/backends/networking/sdl_net/localwebserver.cpp
+++ b/backends/networking/sdl_net/localwebserver.cpp
@@ -45,6 +45,7 @@ LocalWebserver::LocalWebserver(): _set(nullptr), _serverSocket(nullptr), _timerS
addPathHandler("/", _indexPageHandler.getHandler());
addPathHandler("/files", _filesPageHandler.getHandler());
addPathHandler("/create", _createDirectoryHandler.getHandler());
+ addPathHandler("/download", _downloadFileHandler.getHandler());
_defaultHandler = _resourceHandler.getHandler();
}
diff --git a/backends/networking/sdl_net/localwebserver.h b/backends/networking/sdl_net/localwebserver.h
index ed1860a937..97fe2aa37b 100644
--- a/backends/networking/sdl_net/localwebserver.h
+++ b/backends/networking/sdl_net/localwebserver.h
@@ -26,6 +26,7 @@
#include "backends/networking/sdl_net/client.h"
#include "backends/networking/sdl_net/handlers/basehandler.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/indexpagehandler.h"
#include "backends/networking/sdl_net/handlers/resourcehandler.h"
@@ -61,6 +62,7 @@ class LocalWebserver : public Common::Singleton {
IndexPageHandler _indexPageHandler;
FilesPageHandler _filesPageHandler;
CreateDirectoryHandler _createDirectoryHandler;
+ DownloadFileHandler _downloadFileHandler;
ResourceHandler _resourceHandler;
uint32 _idlingFrames;
Common::Mutex _handleMutex;
--
cgit v1.2.3