/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ // Storage abstraction. #ifndef INCLUDED_STORAGE_HPP #define INCLUDED_STORAGE_HPP #include #include #include #include #include #include #include #include "Common.hpp" #include "Auth.hpp" #include "Util.hpp" /// Base class of all Storage abstractions. class StorageBase { public: class FileInfo { public: std::string Filename; Poco::Timestamp ModifiedTime; size_t Size; }; /// localStorePath the absolute root path of the chroot. /// jailPath the path within the jail that the child uses. StorageBase(const std::string& localStorePath, const std::string& jailPath, const std::string& uri) : _localStorePath(localStorePath), _jailPath(jailPath), _uri(uri) { Log::debug("Storage ctor: " + uri); } std::string getLocalRootPath() const { auto localPath = _jailPath; if (localPath[0] == '/') { // Remove the leading / localPath.erase(0, 1); } // /chroot/jailId/user/doc/childId const auto rootPath = Poco::Path(_localStorePath, localPath); Poco::File(rootPath).createDirectories(); return rootPath.toString(); } const std::string& getUri() const { return _uri; } /// Returns information about the file. virtual FileInfo getFileInfo(const Poco::URI& uri) = 0; /// Returns a local file path for the given URI. /// If necessary copies the file locally first. virtual std::string loadStorageFileToLocal() = 0; /// Writes the contents of the file back to the source. /// TODO: Should we save to the specific client's URI? /// The advantage is that subseqent views (to the first) /// will not depend on the token of the first. virtual bool saveLocalFileToStorage() = 0; static size_t getFileSize(const std::string& filename) { return std::ifstream(filename, std::ifstream::ate | std::ifstream::binary).tellg(); } protected: const std::string _localStorePath; const std::string _jailPath; const std::string _uri; std::string _jailedFilePath; FileInfo _fileInfo; }; /// Trivial implementation of local storage that does not need do anything. class LocalStorage : public StorageBase { public: LocalStorage(const std::string& localStorePath, const std::string& jailPath, const std::string& uri) : StorageBase(localStorePath, jailPath, uri), _isCopy(false) { } FileInfo getFileInfo(const Poco::URI& uri) override { const auto path = uri.getPath(); Log::debug("Getting info for local uri [" + uri.toString() + "], path [" + path + "]."); const auto filename = Poco::Path(path).getFileName(); const auto lastModified = Poco::File(path).getLastModified(); const auto size = Poco::File(path).getSize(); return FileInfo({filename, lastModified, size}); } std::string loadStorageFileToLocal() override { const auto rootPath = getLocalRootPath(); // /chroot/jailId/user/doc/childId/file.ext const auto filename = Poco::Path(_uri).getFileName(); _jailedFilePath = Poco::Path(rootPath, filename).toString(); Log::info("Public URI [" + _uri + "] jailed to [" + _jailedFilePath + "]."); const auto publicFilePath = _uri; Log::info("Linking " + publicFilePath + " to " + _jailedFilePath); if (!Poco::File(_jailedFilePath).exists() && link(publicFilePath.c_str(), _jailedFilePath.c_str()) == -1) { // Failed Log::warn("link(\"" + publicFilePath + "\", \"" + _jailedFilePath + "\") failed. Will copy."); } try { // Fallback to copying. if (!Poco::File(_jailedFilePath).exists()) { Log::info("Copying " + publicFilePath + " to " + _jailedFilePath); Poco::File(publicFilePath).copyTo(_jailedFilePath); _isCopy = true; } } catch (const Poco::Exception& exc) { Log::error("copyTo(\"" + publicFilePath + "\", \"" + _jailedFilePath + "\") failed: " + exc.displayText()); throw; } // Now return the jailed path. return Poco::Path(_jailPath, filename).toString(); } bool saveLocalFileToStorage() override { try { // Copy the file back. if (_isCopy && Poco::File(_jailedFilePath).exists()) { Log::info("Copying " + _jailedFilePath + " to " + _uri); Poco::File(_jailedFilePath).copyTo(_uri); } } catch (const Poco::Exception& exc) { Log::error("copyTo(\"" + _jailedFilePath + "\", \"" + _uri + "\") failed: " + exc.displayText()); throw; } return true; } private: /// True if the jailed file is not linked but copied. bool _isCopy; }; class WopiStorage : public StorageBase { public: WopiStorage(const std::string& localStorePath, const std::string& jailPath, const std::string& uri) : StorageBase(localStorePath, jailPath, uri) { } FileInfo getFileInfo(const Poco::URI& uri) override { Log::debug("Getting info for wopi uri [" + uri.toString() + "]."); Poco::URI uriObject(uri); Poco::Net::HTTPClientSession session(uriObject.getHost(), uriObject.getPort()); Poco::Net::HTTPRequest request(Poco::Net::HTTPRequest::HTTP_GET, uriObject.getPathAndQuery(), Poco::Net::HTTPMessage::HTTP_1_1); request.set("User-Agent", "LOOLWSD WOPI Agent"); session.sendRequest(request); Poco::Net::HTTPResponse response; std::istream& rs = session.receiveResponse(response); auto logger = Log::trace(); logger << "WOPI::CheckFileInfo header for URI [" << uri.toString() << "]:\n"; for (auto& pair : response) { logger << '\t' + pair.first + ": " + pair.second << " / "; } logger << Log::end; // Parse the response. std::string filename; size_t size = 0; std::string resMsg; Poco::StreamCopier::copyToString(rs, resMsg); Log::debug("WOPI::CheckFileInfo returned: " + resMsg); const auto index = resMsg.find_first_of("{"); if (index != std::string::npos) { const std::string stringJSON = resMsg.substr(index); Poco::JSON::Parser parser; const auto result = parser.parse(stringJSON); const auto object = result.extract(); filename = object->get("BaseFileName").toString(); size = std::stoul (object->get("Size").toString(), nullptr, 0); } // WOPI doesn't support file last modified time. return FileInfo({filename, Poco::Timestamp(), size}); } /// uri format: http://server/<...>/wopi*/files//content std::string loadStorageFileToLocal() override { Log::info("Downloading URI [" + _uri + "]."); _fileInfo = getFileInfo(Poco::URI(_uri)); if (_fileInfo.Size == 0 && _fileInfo.Filename.empty()) { //TODO: Should throw a more appropriate exception. throw std::runtime_error("Failed to load file from storage."); } // WOPI URI to download files ends in '/contents'. // Add it here to get the payload instead of file info. Poco::URI uriObject(_uri); const auto url = uriObject.getPath() + "/contents?" + uriObject.getQuery(); Log::debug("Wopi requesting: " + url); Poco::Net::HTTPClientSession session(uriObject.getHost(), uriObject.getPort()); Poco::Net::HTTPRequest request(Poco::Net::HTTPRequest::HTTP_GET, url, Poco::Net::HTTPMessage::HTTP_1_1); request.set("User-Agent", "LOOLWSD WOPI Agent"); session.sendRequest(request); Poco::Net::HTTPResponse response; std::istream& rs = session.receiveResponse(response); auto logger = Log::trace(); logger << "WOPI::GetFile header for URI [" << _uri << "]:\n"; for (auto& pair : response) { logger << '\t' + pair.first + ": " + pair.second << " / "; } logger << Log::end; _jailedFilePath = Poco::Path(getLocalRootPath(), _fileInfo.Filename).toString(); std::ofstream ofs(_jailedFilePath); std::copy(std::istreambuf_iterator(rs), std::istreambuf_iterator(), std::ostreambuf_iterator(ofs)); const auto size = getFileSize(_jailedFilePath); Log::info() << "WOPI::GetFile downloaded " << size << " bytes from [" << _uri << "] -> " << _jailedFilePath << ": " << response.getStatus() << " " << response.getReason() << Log::end; // Now return the jailed path. return Poco::Path(_jailPath, _fileInfo.Filename).toString(); } bool saveLocalFileToStorage() override { Log::info("Uploading URI [" + _uri + "] from [" + _jailedFilePath + "]."); const auto size = getFileSize(_jailedFilePath); Poco::URI uriObject(_uri); const auto url = uriObject.getPath() + "/contents?" + uriObject.getQuery(); Log::debug("Wopi posting: " + url); Poco::Net::HTTPClientSession session(uriObject.getHost(), uriObject.getPort()); Poco::Net::HTTPRequest request(Poco::Net::HTTPRequest::HTTP_POST, url, Poco::Net::HTTPMessage::HTTP_1_1); request.set("X-WOPIOverride", "PUT"); request.setContentType("application/octet-stream"); request.setContentLength(size); std::ostream& os = session.sendRequest(request); std::ifstream ifs(_jailedFilePath); Poco::StreamCopier::copyStream(ifs, os); Poco::Net::HTTPResponse response; std::istream& rs = session.receiveResponse(response); std::ostringstream oss; Poco::StreamCopier::copyStream(rs, oss); Log::info("WOPI::PutFile response: " + oss.str()); const auto success = (response.getStatus() == Poco::Net::HTTPResponse::HTTP_OK); Log::info() << "WOPI::PutFile uploaded " << size << " bytes from [" << _jailedFilePath << "]:" << "] -> [" << _uri << "]: " << response.getStatus() << " " << response.getReason() << Log::end; return success; } }; class WebDAVStorage : public StorageBase { public: WebDAVStorage(const std::string& localStorePath, const std::string& jailPath, const std::string& uri, std::unique_ptr authAgent) : StorageBase(localStorePath, jailPath, uri), _authAgent(std::move(authAgent)) { } FileInfo getFileInfo(const Poco::URI& uri) override { Log::debug("Getting info for webdav uri [" + uri.toString() + "]."); (void)uri; assert(!"Not Implemented!"); return FileInfo({"bazinga", Poco::Timestamp(), 0}); } std::string loadStorageFileToLocal() override { // TODO: implement webdav GET. return _uri; } bool saveLocalFileToStorage() override { // TODO: implement webdav PUT. return false; } private: std::unique_ptr _authAgent; }; inline std::unique_ptr createStorage(const std::string& jailRoot, const std::string& jailPath, const Poco::URI& uri) { if (uri.isRelative() || uri.getScheme() == "file") { Log::info("Public URI [" + uri.toString() + "] is a file."); return std::unique_ptr(new LocalStorage(jailRoot, jailPath, uri.getPath())); } else { Log::info("Public URI [" + uri.toString() + "] assuming cloud storage."); //TODO: Configure the storage to use. For now, assume it's WOPI. return std::unique_ptr(new WopiStorage(jailRoot, jailPath, uri.toString())); } } #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */