/* -*- 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/. */ /* * The main entry point for the LibreOfficeKit process serving * a document editing session. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define LOK_USE_UNSTABLE_API #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "ChildSession.hpp" #include "Common.hpp" #include "IoUtil.hpp" #include "LOKitHelper.hpp" #include "LOOLKit.hpp" #include "LOOLProtocol.hpp" #include "LOOLWebSocket.hpp" #include "Log.hpp" #include "Png.hpp" #include "Rectangle.hpp" #include "TileDesc.hpp" #include "Unit.hpp" #include "UserMessages.hpp" #include "Util.hpp" #include "common/SigUtil.hpp" #define LIB_SOFFICEAPP "lib" "sofficeapp" ".so" #define LIB_MERGED "lib" "mergedlo" ".so" typedef int (LokHookPreInit) (const char *install_path, const char *user_profile_path); using Poco::Exception; using Poco::File; using Poco::JSON::Array; using Poco::JSON::Object; using Poco::JSON::Parser; using Poco::Net::Socket; using Poco::Net::WebSocket; using Poco::Runnable; using Poco::StringTokenizer; using Poco::Thread; using Poco::Timestamp; using Poco::URI; using Poco::Util::Application; #ifndef BUILDING_TESTS using Poco::Net::HTTPClientSession; using Poco::Net::HTTPRequest; using Poco::Net::HTTPResponse; using Poco::Path; using Poco::Process; #endif using namespace LOOLProtocol; // We only host a single document in our lifetime. class Document; static std::shared_ptr document; namespace { #ifndef BUILDING_TESTS typedef enum { COPY_ALL, COPY_LO, COPY_NO_USR } LinkOrCopyType; LinkOrCopyType linkOrCopyType; std::string sourceForLinkOrCopy; Path destinationForLinkOrCopy; bool shouldCopyDir(const char *path) { switch (linkOrCopyType) { case COPY_NO_USR: // bind mounted. return strcmp(path,"usr") != 0; case COPY_LO: return strcmp(path, "program/wizards") != 0 && strcmp(path, "sdk") != 0 && strcmp(path, "share/basic") != 0 && strcmp(path, "share/gallery") != 0 && strcmp(path, "share/Scripts") != 0 && strcmp(path, "share/template") != 0 && strcmp(path, "share/config/wizard") != 0 && strcmp(path, "share/config/wizard") != 0; default: // COPY_ALL return true; } } int linkOrCopyFunction(const char *fpath, const struct stat* /*sb*/, int typeflag, struct FTW* /*ftwbuf*/) { if (strcmp(fpath, sourceForLinkOrCopy.c_str()) == 0) return 0; assert(fpath[strlen(sourceForLinkOrCopy.c_str())] == '/'); const char *relativeOldPath = fpath + strlen(sourceForLinkOrCopy.c_str()) + 1; Path newPath(destinationForLinkOrCopy, Path(relativeOldPath)); switch (typeflag) { case FTW_F: case FTW_SLN: File(newPath.parent()).createDirectories(); if (link(fpath, newPath.toString().c_str()) == -1) { LOG_SYS("link(\"" << std::string(fpath) << "\",\"" << newPath.toString() << "\") failed. Exiting."); std::_Exit(Application::EXIT_SOFTWARE); } break; case FTW_D: { struct stat st; if (stat(fpath, &st) == -1) { LOG_SYS("stat(\"" << std::string(fpath) << "\") failed."); return 1; } if (!shouldCopyDir(relativeOldPath)) { LOG_TRC("skip redundant paths " << relativeOldPath); return FTW_SKIP_SUBTREE; } File(newPath).createDirectories(); struct utimbuf ut; ut.actime = st.st_atime; ut.modtime = st.st_mtime; if (utime(newPath.toString().c_str(), &ut) == -1) { LOG_SYS("utime(\"" << newPath.toString() << "\") failed."); return 1; } } break; case FTW_DNR: LOG_ERR("Cannot read directory '" << fpath << "'"); return 1; case FTW_NS: LOG_ERR("nftw: stat failed for '" << fpath << "'"); return 1; default: LOG_FTL("nftw: unexpected type: '" << typeflag); assert(false); break; } return 0; } void linkOrCopy(const std::string& source, const Path& destination, LinkOrCopyType type) { linkOrCopyType = type; sourceForLinkOrCopy = source; if (sourceForLinkOrCopy.back() == '/') sourceForLinkOrCopy.pop_back(); destinationForLinkOrCopy = destination; if (nftw(source.c_str(), linkOrCopyFunction, 10, FTW_ACTIONRETVAL) == -1) LOG_ERR("linkOrCopy: nftw() failed for '" << source << "'"); } void dropCapability(cap_value_t capability) { cap_t caps; cap_value_t cap_list[] = { capability }; caps = cap_get_proc(); if (caps == nullptr) { LOG_SYS("cap_get_proc() failed."); std::_Exit(1); } char *capText = cap_to_text(caps, nullptr); LOG_TRC("Capabilities first: " << capText); cap_free(capText); if (cap_set_flag(caps, CAP_EFFECTIVE, sizeof(cap_list)/sizeof(cap_list[0]), cap_list, CAP_CLEAR) == -1 || cap_set_flag(caps, CAP_PERMITTED, sizeof(cap_list)/sizeof(cap_list[0]), cap_list, CAP_CLEAR) == -1) { LOG_SYS("cap_set_flag() failed."); std::_Exit(1); } if (cap_set_proc(caps) == -1) { LOG_SYS("cap_set_proc() failed."); std::_Exit(1); } capText = cap_to_text(caps, nullptr); LOG_TRC("Capabilities now: " << capText); cap_free(capText); cap_free(caps); } void symlinkPathToJail(const Path& jailPath, const std::string &loTemplate, const std::string &loSubPath) { Path symlinkSource(jailPath, Path(loTemplate.substr(1))); File(symlinkSource.parent()).createDirectories(); std::string symlinkTarget; for (auto i = 0; i < Path(loTemplate).depth(); i++) symlinkTarget += "../"; symlinkTarget += loSubPath; LOG_DBG("symlink(\"" << symlinkTarget << "\",\"" << symlinkSource.toString() << "\")"); if (symlink(symlinkTarget.c_str(), symlinkSource.toString().c_str()) == -1) { LOG_SYS("symlink(\"" << symlinkTarget << "\",\"" << symlinkSource.toString() << "\") failed"); throw Exception("symlink() failed"); } } #endif } /// A document container. /// Owns LOKitDocument instance and connections. /// Manages the lifetime of a document. /// Technically, we can host multiple documents /// per process. But for security reasons don't. /// However, we could have a loolkit instance /// per user or group of users (a trusted circle). class Document : public Runnable, public IDocumentManager { public: /// We have two types of password protected documents /// 1) Documents which require password to view /// 2) Document which require password to modify enum class PasswordType { ToView, ToModify }; public: Document(const std::shared_ptr& loKit, const std::string& jailId, const std::string& docKey, const std::string& url, std::shared_ptr tileQueue, const std::shared_ptr& ws) : _loKit(loKit), _jailId(jailId), _docKey(docKey), _url(url), _tileQueue(std::move(tileQueue)), _ws(ws), _docPassword(""), _haveDocPassword(false), _isDocPasswordProtected(false), _docPasswordType(PasswordType::ToView), _stop(false), _mutex(), _documentMutex(), _isLoading(0) { LOG_INF("Document ctor for url [" << _url << "] on child [" << _jailId << "]."); assert(_loKit); _callbackThread.start(*this); } ~Document() { LOG_INF("~Document dtor for url [" << _url << "] on child [" << _jailId << "]. There are " << _sessions.size() << " views."); // Wait for the callback worker to finish. _stop = true; _tileQueue->put("eof"); _callbackThread.join(); } const std::string& getUrl() const { return _url; } bool createSession(const std::string& sessionId) { std::unique_lock lock(_mutex); try { if (_sessions.find(sessionId) != _sessions.end()) { LOG_WRN("Session [" << sessionId << "] on url [" << _url << "] already exists."); return true; } LOG_INF("Creating " << (_sessions.empty() ? "first" : "new") << " session for url: " << _url << " for sessionId: " << sessionId << " on jailId: " << _jailId); auto session = std::make_shared(sessionId, _jailId, *this); _sessions.emplace(sessionId, session); LOG_DBG("Sessions: " << _sessions.size()); return true; } catch (const std::exception& ex) { LOG_ERR("Exception while creating session [" << sessionId << "] on url [" << _url << "] - '" << ex.what() << "'."); return false; } } /// Purges dead connections and returns /// the remaining number of clients. /// Returns -1 on failure. size_t purgeSessions() { std::vector> deadSessions; size_t numRunning = 0; size_t num_sessions = 0; { std::unique_lock lock(_mutex, std::defer_lock); if (!lock.try_lock()) { // Not a good time, try later. return -1; } // If there are no live sessions, we don't need to do anything at all and can just // bluntly exit, no need to clean up our own data structures. Also, there is a bug that // causes the deadSessions.clear() call below to crash in some situations when the last // session is being removed. for (auto it = _sessions.cbegin(); it != _sessions.cend(); ++it) { if (!it->second->isCloseFrame()) numRunning++; } if (numRunning > 0) { for (auto it = _sessions.cbegin(); it != _sessions.cend(); ) { if (it->second->isCloseFrame()) { deadSessions.push_back(it->second); it = _sessions.erase(it); } else { ++it; } } } num_sessions = _sessions.size(); } if (numRunning == 0) { LOG_INF("No more sessions, exiting bluntly"); std::_Exit(Application::EXIT_OK); } // Don't destroy sessions while holding our lock. // We may deadlock if a session is waiting on us // during callback initiated while handling a command // and the dtor tries to take its lock (which is taken). deadSessions.clear(); return num_sessions; } /// Returns true if at least one *live* connection exists. /// Does not consider user activity, just socket status. bool hasSessions() { // -ve values for failure. return purgeSessions() != 0; } /// Returns true if there is no activity and /// the document is saved. bool canDiscard() { //TODO: Implement proper time-out on inactivity. return !hasSessions(); } /// Set Document password for given URL void setDocumentPassword(int nPasswordType) { LOG_INF("setDocumentPassword: passwordProtected=" << _isDocPasswordProtected << " passwordProvided=" << _haveDocPassword << " password='" << _docPassword << "'"); if (_isDocPasswordProtected && _haveDocPassword) { // it means this is the second attempt with the wrong password; abort the load operation _loKit->setDocumentPassword(_jailedUrl.c_str(), nullptr); return; } // One thing for sure, this is a password protected document _isDocPasswordProtected = true; if (nPasswordType == LOK_CALLBACK_DOCUMENT_PASSWORD) _docPasswordType = PasswordType::ToView; else if (nPasswordType == LOK_CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY) _docPasswordType = PasswordType::ToModify; LOG_INF("Calling _loKit->setDocumentPassword"); if (_haveDocPassword) _loKit->setDocumentPassword(_jailedUrl.c_str(), _docPassword.c_str()); else _loKit->setDocumentPassword(_jailedUrl.c_str(), nullptr); LOG_INF("setDocumentPassword returned"); } void renderTile(StringTokenizer& tokens, const std::shared_ptr& ws) { assert(ws && "Expected a non-null websocket."); auto tile = TileDesc::parse(tokens); // Send back the request with all optional parameters given in the request. const auto tileMsg = tile.serialize("tile:"); #if ENABLE_DEBUG const std::string response = tileMsg + " renderid=" + Util::UniqueId() + "\n"; #else const std::string response = tileMsg + "\n"; #endif std::vector output; output.reserve(response.size() + (4 * tile.getWidth() * tile.getHeight())); output.resize(response.size()); std::memcpy(output.data(), response.data(), response.size()); std::vector pixmap; pixmap.resize(output.capacity()); if (!_loKitDocument) { LOG_ERR("Tile rendering requested before loading document."); return; } std::unique_lock lock(_documentMutex); if (_loKitDocument->getViewsCount() <= 0) { LOG_ERR("Tile rendering requested without views."); return; } const double area = tile.getWidth() * tile.getHeight(); Timestamp timestamp; _loKitDocument->paintPartTile(pixmap.data(), tile.getPart(), tile.getWidth(), tile.getHeight(), tile.getTilePosX(), tile.getTilePosY(), tile.getTileWidth(), tile.getTileHeight()); const auto elapsed = timestamp.elapsed(); LOG_TRC("paintTile at (" << tile.getPart() << ',' << tile.getTilePosX() << ',' << tile.getTilePosY() << ") " << "ver: " << tile.getVersion() << " rendered in " << (elapsed/1000.) << " ms (" << area / elapsed << " MP/s)."); const auto mode = static_cast(_loKitDocument->getTileMode()); if (!png::encodeBufferToPNG(pixmap.data(), tile.getWidth(), tile.getHeight(), output, mode)) { //FIXME: Return error. //sendTextFrame("error: cmd=tile kind=failure"); LOG_ERR("Failed to encode tile into PNG."); return; } LOG_TRC("Sending render-tile response (" + std::to_string(output.size()) + " bytes) for: " + response); ws->sendFrame(output.data(), output.size(), WebSocket::FRAME_BINARY); } void renderCombinedTiles(StringTokenizer& tokens, const std::shared_ptr& ws) { assert(ws && "Expected a non-null websocket."); auto tileCombined = TileCombined::parse(tokens); auto& tiles = tileCombined.getTiles(); Util::Rectangle renderArea; std::vector tileRecs; tileRecs.reserve(tiles.size()); for (auto& tile : tiles) { Util::Rectangle rectangle(tile.getTilePosX(), tile.getTilePosY(), tileCombined.getTileWidth(), tileCombined.getTileHeight()); if (tileRecs.empty()) { renderArea = rectangle; } else { renderArea.extend(rectangle); } tileRecs.push_back(rectangle); } const size_t tilesByX = renderArea.getWidth() / tileCombined.getTileWidth(); const size_t tilesByY = renderArea.getHeight() / tileCombined.getTileHeight(); const size_t pixmapWidth = tilesByX * tileCombined.getWidth(); const size_t pixmapHeight = tilesByY * tileCombined.getHeight(); const size_t pixmapSize = 4 * pixmapWidth * pixmapHeight; std::vector pixmap(pixmapSize, 0); if (!_loKitDocument) { LOG_ERR("Tile rendering requested before loading document."); return; } std::unique_lock lock(_documentMutex); if (_loKitDocument->getViewsCount() <= 0) { LOG_ERR("Tile rendering requested without views."); return; } const double area = pixmapWidth * pixmapHeight; Timestamp timestamp; _loKitDocument->paintPartTile(pixmap.data(), tileCombined.getPart(), pixmapWidth, pixmapHeight, renderArea.getLeft(), renderArea.getTop(), renderArea.getWidth(), renderArea.getHeight()); const auto elapsed = timestamp.elapsed(); LOG_DBG("paintTile (combined) at (" << renderArea.getLeft() << ", " << renderArea.getTop() << "), (" << renderArea.getWidth() << ", " << renderArea.getHeight() << ") ver: " << tileCombined.getVersion() << " rendered in " << (elapsed/1000.) << " ms (" << area / elapsed << " MP/s)."); const auto mode = static_cast(_loKitDocument->getTileMode()); std::vector output; output.reserve(pixmapWidth * pixmapHeight * 4); size_t tileIndex = 0; for (Util::Rectangle& tileRect : tileRecs) { const size_t positionX = (tileRect.getLeft() - renderArea.getLeft()) / tileCombined.getTileWidth(); const size_t positionY = (tileRect.getTop() - renderArea.getTop()) / tileCombined.getTileHeight(); const auto oldSize = output.size(); const auto pixelWidth = tileCombined.getWidth(); const auto pixelHeight = tileCombined.getHeight(); if (!png::encodeSubBufferToPNG(pixmap.data(), positionX * pixelWidth, positionY * pixelHeight, pixelWidth, pixelHeight, pixmapWidth, pixmapHeight, output, mode)) { //FIXME: Return error. //sendTextFrame("error: cmd=tile kind=failure"); LOG_ERR("Failed to encode tile into PNG."); return; } const auto imgSize = output.size() - oldSize; LOG_TRC("Encoded tile #" << tileIndex << " in " << imgSize << " bytes."); tiles[tileIndex++].setImgSize(imgSize); } #if ENABLE_DEBUG const auto tileMsg = tileCombined.serialize("tilecombine:") + " renderid=" + Util::UniqueId() + "\n"; #else const auto tileMsg = tileCombined.serialize("tilecombine:") + "\n"; #endif LOG_TRC("Sending back painted tiles for " << tileMsg); std::vector response; response.resize(tileMsg.size() + output.size()); std::copy(tileMsg.begin(), tileMsg.end(), response.begin()); std::copy(output.begin(), output.end(), response.begin() + tileMsg.size()); ws->sendFrame(response.data(), response.size(), WebSocket::FRAME_BINARY); } bool sendTextFrame(const std::string& message) override { try { if (!_ws || _ws->poll(Poco::Timespan(0), Socket::SelectMode::SELECT_ERROR)) { LOG_ERR("Child Doc: Bad socket while sending [" << getAbbreviatedMessage(message) << "]."); return false; } _ws->sendFrame(message.data(), message.size()); return true; } catch (const Exception& exc) { LOG_ERR("Document::sendTextFrame: Exception: " << exc.displayText() << (exc.nested() ? "( " + exc.nested()->displayText() + ")" : "")); } return false; } static void GlobalCallback(const int nType, const char* pPayload, void* pData) { if (TerminationFlag) { return; } const std::string payload = pPayload ? pPayload : "(nil)"; LOG_TRC("Document::GlobalCallback " << LOKitHelper::kitCallbackTypeToString(nType) << " [" << payload << "]."); Document* self = reinterpret_cast(pData); if (nType == LOK_CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY || nType == LOK_CALLBACK_DOCUMENT_PASSWORD) { // Mark the document password type. self->setDocumentPassword(nType); return; } // Broadcast leftover status indicator callbacks to all clients self->broadcastCallbackToClients(nType, payload); } static void ViewCallback(const int nType, const char* pPayload, void* pData) { if (TerminationFlag) { return; } CallbackDescriptor* pDescr = reinterpret_cast(pData); assert(pDescr && "Null callback data."); assert(pDescr->Doc && "Null Document instance."); const std::string payload = pPayload ? pPayload : "(nil)"; LOG_TRC("Document::ViewCallback [" << pDescr->ViewId << "] [" << LOKitHelper::kitCallbackTypeToString(nType) << "] [" << payload << "]."); std::unique_lock lock(pDescr->Doc->getMutex()); if (nType == LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR || nType == LOK_CALLBACK_CELL_CURSOR) { Poco::StringTokenizer tokens(payload, ",", Poco::StringTokenizer::TOK_IGNORE_EMPTY | Poco::StringTokenizer::TOK_TRIM); // Payload may be 'EMPTY'. if (tokens.count() == 4) { auto cursorX = std::stoi(tokens[0]); auto cursorY = std::stoi(tokens[1]); auto cursorWidth = std::stoi(tokens[2]); auto cursorHeight = std::stoi(tokens[3]); pDescr->Doc->getTileQueue()->updateCursorPosition(0, 0, cursorX, cursorY, cursorWidth, cursorHeight); } } else if (nType == LOK_CALLBACK_INVALIDATE_VIEW_CURSOR || nType == LOK_CALLBACK_CELL_VIEW_CURSOR) { Poco::JSON::Parser parser; const auto result = parser.parse(payload); const auto& command = result.extract(); auto viewId = command->get("viewId").toString(); auto part = command->get("part").toString(); auto text = command->get("rectangle").toString(); Poco::StringTokenizer tokens(text, ",", Poco::StringTokenizer::TOK_IGNORE_EMPTY | Poco::StringTokenizer::TOK_TRIM); // Payload may be 'EMPTY'. if (tokens.count() == 4) { auto cursorX = std::stoi(tokens[0]); auto cursorY = std::stoi(tokens[1]); auto cursorWidth = std::stoi(tokens[2]); auto cursorHeight = std::stoi(tokens[3]); pDescr->Doc->getTileQueue()->updateCursorPosition(std::stoi(viewId), std::stoi(part), cursorX, cursorY, cursorWidth, cursorHeight); } } pDescr->Doc->getTileQueue()->put("callback " + std::to_string(pDescr->ViewId) + " " + std::to_string(nType) + " " + payload); } private: static void DocumentCallback(const int nType, const char* pPayload, void* pData) { if (TerminationFlag) { return; } const std::string payload = pPayload ? pPayload : "(nil)"; LOG_TRC("Document::DocumentCallback " << LOKitHelper::kitCallbackTypeToString(nType) << " [" << payload << "]."); Document* self = reinterpret_cast(pData); self->broadcastCallbackToClients(nType, pPayload); } /// Helper method to broadcast callback and its payload to all clients void broadcastCallbackToClients(const int nType, const std::string& payload) { std::unique_lock lock(_mutex); // "-1" means broadcast _tileQueue->put("callback -1 " + std::to_string(nType) + " " + payload); } /// Load a document (or view) and register callbacks. bool onLoad(const std::string& sessionId, const std::string& uri, const std::string& userName, const std::string& docPassword, const std::string& renderOpts, const bool haveDocPassword) override { std::unique_lock lock(_mutex); LOG_INF("Loading session [" << sessionId << "] on url [" << uri << "] is loading. " << _sessions.size() << " views loaded."); while (_isLoading) { _cvLoading.wait(lock); } // Flag and release lock. ++_isLoading; lock.unlock(); try { load(sessionId, uri, userName, docPassword, renderOpts, haveDocPassword); if (!_loKitDocument || !_loKitDocument->get()) { return false; } } catch (const std::exception& exc) { LOG_ERR("Exception while loading [" << uri << "] : " << exc.what()); return false; } // Done loading, let the next one in (if any). assert(_loKitDocument && _loKitDocument->get() && "Uninitialized lok::Document instance"); lock.lock(); --_isLoading; _cvLoading.notify_one(); return true; } void onUnload(const ChildSession& session) override { const auto& sessionId = session.getId(); LOG_INF("Unloading session [" << sessionId << "] on url [" << _url << "]."); const auto viewId = session.getViewId(); _tileQueue->removeCursorPosition(viewId); if (_loKitDocument == nullptr) { LOG_ERR("Unloading session [" << sessionId << "] without loKitDocument."); return; } std::unique_lock lockLokDoc(_documentMutex); _loKitDocument->setView(viewId); _loKitDocument->registerCallback(nullptr, nullptr); _loKitDocument->destroyView(viewId); _viewIdToCallbackDescr.erase(viewId); LOG_DBG("Destroyed view [" << viewId << "] with session [" << sessionId << "] on url [" << _url << "]."); // Get the list of view ids from the core const int viewCount = _loKitDocument->getViewsCount(); std::vector viewIds(viewCount); _loKitDocument->getViewIds(viewIds.data(), viewCount); LOG_INF("Document [" << _url << "] session [" << sessionId << "] unloaded. Have " << viewCount << " view" << (viewCount != 1 ? "s" : "")); lockLokDoc.unlock(); // Broadcast updated view info notifyViewInfo(viewIds); } std::map getViewInfo() override { std::unique_lock lock(_mutex); std::map viewInfo; for (auto& pair : _sessions) { const auto& session = pair.second; const auto viewId = session->getViewId(); viewInfo[viewId] = UserInfo({session->getViewUserId(), session->getViewUserName()}); } viewInfo.insert(_oldSessionIds.begin(), _oldSessionIds.end()); return viewInfo; } std::mutex& getMutex() override { return _mutex; } std::shared_ptr& getTileQueue() override { return _tileQueue; } /// Notify all views of viewId and their associated usernames void notifyViewInfo(const std::vector& viewIds) override { // Store the list of viewid, username mapping in a map std::map viewInfoMap = getViewInfo(); std::map viewColorsMap = getViewColors(); std::unique_lock lock(_mutex); // Double check if list of viewids from core and our list matches, // and create an array of JSON objects containing id and username Array::Ptr viewInfoArray = new Array(); int arrayIndex = 0; for (auto& viewId: viewIds) { Object::Ptr viewInfoObj = new Object(); viewInfoObj->set("id", viewId); int color = 0; if (viewInfoMap.find(viewId) == viewInfoMap.end()) { LOG_ERR("No username found for viewId [" << viewId << "]."); viewInfoObj->set("username", "Unknown"); } else { viewInfoObj->set("userid", viewInfoMap[viewId].userid); viewInfoObj->set("username", viewInfoMap[viewId].username); if (viewColorsMap.find(viewInfoMap[viewId].username) != viewColorsMap.end()) { color = viewColorsMap[viewInfoMap[viewId].username]; } } viewInfoObj->set("color", color); viewInfoArray->set(arrayIndex++, viewInfoObj); } std::ostringstream ossViewInfo; viewInfoArray->stringify(ossViewInfo); // Broadcast updated viewinfo to all _active_ connections for (auto& pair : _sessions) { const auto session = pair.second; if (!session->isCloseFrame() && session->isActive()) { session->sendTextFrame("viewinfo: " + ossViewInfo.str()); } } } private: // Get the color value for all author names from the core std::map getViewColors() { std::string colorValues; std::map viewColors; { std::unique_lock lock(_documentMutex); char* pValues = _loKitDocument->getCommandValues(".uno:TrackedChangeAuthors"); colorValues = std::string(pValues == nullptr ? "" : pValues); std::free(pValues); } try { if (!colorValues.empty()) { Poco::JSON::Parser parser; auto root = parser.parse(colorValues).extract(); if (root->get("authors").type() == typeid(Poco::JSON::Array::Ptr)) { auto authorsArray = root->get("authors").extract(); for (auto& authorVar: *authorsArray) { auto authorObj = authorVar.extract(); auto authorName = authorObj->get("name").convert(); auto colorValue = authorObj->get("color").convert(); viewColors[authorName] = colorValue; } } } } catch(const Exception& exc) { LOG_ERR("Poco Exception: " << exc.displayText() << (exc.nested() ? " (" + exc.nested()->displayText() + ")" : "")); } return viewColors; } std::shared_ptr load(const std::string& sessionId, const std::string& uri, const std::string& userName, const std::string& docPassword, const std::string& renderOpts, const bool haveDocPassword) { const auto it = _sessions.find(sessionId); if (it == _sessions.end() || !it->second) { LOG_ERR("Cannot find session [" << sessionId << "]."); return nullptr; } auto session = it->second; int viewId = 0; std::unique_lock lockLokDoc; if (!_loKitDocument) { // This is the first time we are loading the document LOG_INF("Loading new document from URI: [" << uri << "] for session [" << sessionId << "]."); _loKit->registerCallback(GlobalCallback, this); const auto flags = LOK_FEATURE_DOCUMENT_PASSWORD | LOK_FEATURE_DOCUMENT_PASSWORD_TO_MODIFY | LOK_FEATURE_PART_IN_INVALIDATION_CALLBACK; _loKit->setOptionalFeatures(flags); // Save the provided password with us and the jailed url _haveDocPassword = haveDocPassword; _docPassword = docPassword; _jailedUrl = uri; _isDocPasswordProtected = false; LOG_DBG("Calling lokit::documentLoad."); _loKitDocument.reset(_loKit->documentLoad(uri.c_str())); LOG_DBG("Returned lokit::documentLoad."); std::unique_lock l(_documentMutex); lockLokDoc.swap(l); if (!_loKitDocument || !_loKitDocument->get()) { LOG_ERR("Failed to load: " << uri << ", error: " << _loKit->getError()); // Checking if wrong password or no password was reason for failure. if (_isDocPasswordProtected) { LOG_INF("Document [" << uri << "] is password protected."); if (!_haveDocPassword) { LOG_INF("No password provided for password-protected document [" << uri << "]."); std::string passwordFrame = "passwordrequired:"; if (_docPasswordType == PasswordType::ToView) passwordFrame += "to-view"; else if (_docPasswordType == PasswordType::ToModify) passwordFrame += "to-modify"; session->sendTextFrame("error: cmd=load kind=" + passwordFrame); } else { LOG_INF("Wrong password for password-protected document [" << uri << "]."); session->sendTextFrame("error: cmd=load kind=wrongpassword"); } } return nullptr; } // Only save the options on opening the document. // No support for changing them after opening a document. _renderOpts = renderOpts; } else { std::unique_lock l(_documentMutex); lockLokDoc.swap(l); // Check if this document requires password if (_isDocPasswordProtected) { if (!haveDocPassword) { std::string passwordFrame = "passwordrequired:"; if (_docPasswordType == PasswordType::ToView) passwordFrame += "to-view"; else if (_docPasswordType == PasswordType::ToModify) passwordFrame += "to-modify"; session->sendTextFrame("error: cmd=load kind=" + passwordFrame); return nullptr; } else if (docPassword != _docPassword) { session->sendTextFrame("error: cmd=load kind=wrongpassword"); return nullptr; } } LOG_INF("Loading view to document from URI: [" << uri << "] for session [" << sessionId << "]."); _loKitDocument->createView(); LOG_TRC("View created."); } Util::assertIsLocked(lockLokDoc); Object::Ptr renderOptsObj = new Object(); // Fill the object with renderoptions, if any if (!_renderOpts.empty()) { Parser parser; Poco::Dynamic::Var var = parser.parse(_renderOpts); renderOptsObj = var.extract(); } // Append name of the user, if any, who opened the document to rendering options if (!userName.empty()) { Object::Ptr authorContainer = new Object(); Object::Ptr authorObj = new Object(); authorObj->set("type", "string"); std::string decodedUserName; URI::decode(userName, decodedUserName); authorObj->set("value", decodedUserName); renderOptsObj->set(".uno:Author", authorObj); } std::ostringstream ossRenderOpts; renderOptsObj->stringify(ossRenderOpts); // initializeForRendering() should be called before // registerCallback(), as the previous creates a new view in Impress. _loKitDocument->initializeForRendering(ossRenderOpts.str().c_str()); session->setViewId((viewId = _loKitDocument->getView())); _viewIdToCallbackDescr.emplace(viewId, std::unique_ptr(new CallbackDescriptor({ this, viewId }))); _loKitDocument->registerCallback(ViewCallback, _viewIdToCallbackDescr[viewId].get()); const int viewCount = _loKitDocument->getViewsCount(); LOG_INF("Document [" << _url << "] view [" << viewId << "] loaded. Have " << viewCount << " view" << (viewCount != 1 ? "s." : ".")); return _loKitDocument; } bool forwardToChild(const std::string& prefix, const std::vector& payload) { assert(payload.size() > prefix.size()); // Remove the prefix and trim. size_t index = prefix.size(); for ( ; index < payload.size(); ++index) { if (payload[index] != ' ') { break; } } auto data = payload.data() + index; auto size = payload.size() - index; const auto abbrMessage = getAbbreviatedMessage(data, size); LOG_TRC("Forwarding payload to " << prefix << ' ' << abbrMessage); std::string name; std::string sessionId; if (LOOLProtocol::parseNameValuePair(prefix, name, sessionId, '-') && name == "child") { const auto it = _sessions.find(sessionId); if (it != _sessions.end()) { static const std::string disconnect("disconnect"); if (size == disconnect.size() && strncmp(data, disconnect.data(), disconnect.size()) == 0) { LOG_DBG("Removing ChildSession " << sessionId); _oldSessionIds[it->second->getViewId()] = UserInfo({it->second->getViewUserId(), it->second->getViewUserName()}); _sessions.erase(it); return true; } auto session = it->second; if (session) { return session->handleInput(data, size); } } LOG_WRN("Child session [" << sessionId << "] not found to forward message: " << abbrMessage); } else { LOG_ERR("Failed to parse prefix of forward-to-child message: " << prefix); } return false; } void run() override { Util::setThreadName("lok_handler"); LOG_DBG("Thread started."); try { while (!_stop && !TerminationFlag) { const TileQueue::Payload input = _tileQueue->get(); if (_stop || TerminationFlag) { break; } const std::string message(input.data(), input.size()); StringTokenizer tokens(message, " "); if (tokens[0] == "eof") { LOG_INF("Received EOF. Finishing."); break; } if (tokens[0] == "tile") { renderTile(tokens, _ws); } else if (tokens[0] == "tilecombine") { renderCombinedTiles(tokens, _ws); } else if (LOOLProtocol::getFirstToken(tokens[0], '-') == "child") { forwardToChild(tokens[0], input); } else if (tokens[0] == "callback") { int viewId = std::stoi(tokens[1]); // -1 means broadcast int type = std::stoi(tokens[2]); // payload is the rest of the message std::string payload(message.substr(tokens[0].length() + tokens[1].length() + tokens[2].length() + 3)); // Forward the callback to the same view, demultiplexing is done by the LibreOffice core. // TODO: replace with a map to be faster. bool isFound = false; for (auto& it : _sessions) { auto session = it.second; if (session && ((session->getViewId() == viewId) || (viewId == -1))) { if (!it.second->isCloseFrame()) { isFound = true; session->loKitCallback(type, payload); } else { LOG_ERR("Session thread for session " << session->getId() << " for view " << viewId << " is not running. Dropping [" << LOKitHelper::kitCallbackTypeToString(type) << "] payload [" << payload << "]."); } break; } } if (!isFound) { LOG_WRN("Document::ViewCallback. The message [" << viewId << "] [" << LOKitHelper::kitCallbackTypeToString(type) << "] [" << payload << "] is not sent to Master Session."); } } else { LOG_ERR("Unexpected tile request: [" << message << "]."); } } } catch (const std::exception& exc) { LOG_ERR("QueueHandler::run: Exception: " << exc.what()); } LOG_DBG("Thread finished."); } /// Return access to the lok::Document instance. std::shared_ptr getLOKitDocument() override { return _loKitDocument; } /// Return access to the lok::Document instance. std::mutex& getDocumentMutex() override { return _documentMutex; } private: std::shared_ptr _loKit; const std::string _jailId; const std::string _docKey; const std::string _url; std::string _jailedUrl; std::string _renderOpts; std::shared_ptr _loKitDocument; std::shared_ptr _tileQueue; std::shared_ptr _ws; // Document password provided std::string _docPassword; // Whether password was provided or not bool _haveDocPassword; // Whether document is password protected bool _isDocPasswordProtected; // Whether password is required to view the document, or modify it PasswordType _docPasswordType; std::atomic _stop; mutable std::mutex _mutex; /// Mutex guarding the lok::Document so that we can lock operations /// like setting a view followed by a tile render, etc. std::mutex _documentMutex; std::condition_variable _cvLoading; std::atomic_size_t _isLoading; std::map> _viewIdToCallbackDescr; std::map> _sessions; std::map _oldSessionIds; Poco::Thread _callbackThread; }; void documentViewCallback(const int nType, const char* pPayload, void* pData) { Document::ViewCallback(nType, pPayload, pData); } #ifndef BUILDING_TESTS void lokit_main(const std::string& childRoot, const std::string& sysTemplate, const std::string& loTemplate, const std::string& loSubPath, bool noCapabilities, bool queryVersion, bool displayVersion) { SigUtil::setFatalSignals(); SigUtil::setTerminationSignals(); Util::setThreadName("loolkit"); // Reinitialize logging when forked. const bool logToFile = std::getenv("LOOL_LOGFILE"); const char* logFilename = std::getenv("LOOL_LOGFILENAME"); const char* logLevel = std::getenv("LOOL_LOGLEVEL"); const char* logColor = std::getenv("LOOL_LOGCOLOR"); std::map logProperties; if (logToFile && logFilename) { logProperties["path"] = std::string(logFilename); } Log::initialize("kit", logLevel ? logLevel : "", logColor != nullptr, logToFile, logProperties); Util::rng::reseed(); assert(!childRoot.empty()); assert(!sysTemplate.empty()); assert(!loTemplate.empty()); assert(!loSubPath.empty()); // Ideally this will be a random ID, but forkit will cleanup // our jail directory when we die, and it's simpler to know // the jailId (i.e. the path) implicitly by knowing our pid. static const std::string pid = std::to_string(Process::id()); static const std::string jailId = pid; LOG_DBG("Process started."); std::string userdir_url; std::string instdir_path; // lokit's destroy typically throws from // framework/source/services/modulemanager.cxx:198 // So we insure it lives until std::_Exit is called. std::shared_ptr loKit; Path jailPath; bool bRunInsideJail = !noCapabilities; try { jailPath = Path::forDirectory(childRoot + "/" + jailId); LOG_INF("Jail path: " << jailPath.toString()); File(jailPath).createDirectories(); if (bRunInsideJail) { userdir_url = "file:///user"; instdir_path = "/" + loSubPath + "/program"; // Create a symlink inside the jailPath so that the absolute pathname loTemplate, when // interpreted inside a chroot at jailPath, points to loSubPath (relative to the chroot). symlinkPathToJail(jailPath, loTemplate, loSubPath); // Font paths can end up as realpaths so match that too. char *resolved = realpath(loTemplate.c_str(), NULL); if (resolved) { if (strcmp(loTemplate.c_str(), resolved) != 0) symlinkPathToJail(jailPath, std::string(resolved), loSubPath); free (resolved); } Path jailLOInstallation(jailPath, loSubPath); jailLOInstallation.makeDirectory(); File(jailLOInstallation).createDirectory(); // Copy (link) LO installation and other necessary files into it from the template. bool bLoopMounted = false; if (std::getenv("LOOL_BIND_MOUNT")) { Path usrSrcPath(sysTemplate, "usr"); Path usrDestPath(jailPath, "usr"); File(usrDestPath).createDirectory(); std::string mountCommand = std::string("loolmount ") + usrSrcPath.toString() + std::string(" ") + usrDestPath.toString(); LOG_DBG("Initializing jail bind mount."); bLoopMounted = !system(mountCommand.c_str()); LOG_DBG("Initialized jail bind mount."); } linkOrCopy(sysTemplate, jailPath, bLoopMounted ? COPY_NO_USR : COPY_ALL); linkOrCopy(loTemplate, jailLOInstallation, COPY_LO); // We need this because sometimes the hostname is not resolved const auto networkFiles = {"/etc/host.conf", "/etc/hosts", "/etc/nsswitch.conf", "/etc/resolv.conf"}; for (const auto& filename : networkFiles) { const auto etcPath = Path(jailPath, filename).toString(); const File networkFile(filename); if (networkFile.exists() && !File(etcPath).exists()) { networkFile.copyTo(etcPath); } } LOG_DBG("Initialized jail files."); // Create the urandom and random devices File(Path(jailPath, "/dev")).createDirectory(); if (mknod((jailPath.toString() + "/dev/random").c_str(), S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH, makedev(1, 8)) != 0) { LOG_SYS("mknod(" << jailPath.toString() << "/dev/random) failed."); } if (mknod((jailPath.toString() + "/dev/urandom").c_str(), S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH, makedev(1, 9)) != 0) { LOG_SYS("mknod(" << jailPath.toString() << "/dev/urandom) failed."); } LOG_INF("chroot(\"" << jailPath.toString() << "\")"); if (chroot(jailPath.toString().c_str()) == -1) { LOG_SYS("chroot(\"" << jailPath.toString() << "\") failed."); std::_Exit(Application::EXIT_SOFTWARE); } if (chdir("/") == -1) { LOG_SYS("chdir(\"/\") in jail failed."); std::_Exit(Application::EXIT_SOFTWARE); } dropCapability(CAP_SYS_CHROOT); dropCapability(CAP_MKNOD); dropCapability(CAP_FOWNER); LOG_DBG("Initialized jail nodes, dropped caps."); } else // noCapabilities set { LOG_INF("Using template " << loTemplate << " as install subpath - skipping jail setup"); userdir_url = "file:///" + jailPath.toString() + "/user"; instdir_path = "/" + loTemplate + "/program"; } { const char *instdir = instdir_path.c_str(); const char *userdir = userdir_url.c_str(); auto kit = UnitKit::get().lok_init(instdir, userdir); if (!kit) { kit = lok_init_2(instdir, userdir); } loKit = std::make_shared(kit); if (!loKit) { LOG_FTL("LibreOfficeKit initialization failed. Exiting."); std::_Exit(Application::EXIT_SOFTWARE); } } assert(loKit); LOG_INF("Process is ready."); // Open websocket connection between the child process and WSD. HTTPClientSession cs("127.0.0.1", MasterPortNumber); cs.setTimeout(0); std::string requestUrl = std::string(NEW_CHILD_URI) + "pid=" + pid; if (queryVersion) { char* versionInfo = loKit->getVersionInfo(); std::string versionString(versionInfo); if (displayVersion) std::cout << "office version details: " << versionString << std::endl; std::string encodedVersionStr; URI::encode(versionString, "", encodedVersionStr); requestUrl += "&version=" + encodedVersionStr; free(versionInfo); } HTTPRequest request(HTTPRequest::HTTP_GET, requestUrl); HTTPResponse response; auto ws = std::make_shared(cs, request, response); ws->setReceiveTimeout(0); auto queue = std::make_shared(); const std::string socketName = "child_ws_" + std::to_string(getpid()); IoUtil::SocketProcessor(ws, socketName, [&socketName, &ws, &loKit, &queue](const std::vector& data) { std::string message(data.data(), data.size()); if (UnitKit::get().filterKitMessage(ws, message)) { return true; } LOG_DBG(socketName << ": recv [" << LOOLProtocol::getAbbreviatedMessage(message) << "]."); StringTokenizer tokens(message, " ", StringTokenizer::TOK_IGNORE_EMPTY | StringTokenizer::TOK_TRIM); // Note: Syntax or parsing errors here are unexpected and fatal. if (TerminationFlag) { LOG_DBG("Too late, we're going down"); } else if (tokens[0] == "session") { const std::string& sessionId = tokens[1]; const std::string& docKey = tokens[2]; std::string url; URI::decode(docKey, url); LOG_INF("New session [" << sessionId << "] request on url [" << url << "]."); if (!document) { document = std::make_shared(loKit, jailId, docKey, url, queue, ws); } // Validate and create session. if (!(url == document->getUrl() && document->createSession(sessionId))) { LOG_DBG("CreateSession failed."); } } else if (tokens[0] == "exit") { LOG_TRC("Setting TerminationFlag due to 'exit' command from parent."); TerminationFlag = true; } else if (tokens[0] == "tile" || tokens[0] == "tilecombine" || tokens[0] == "canceltiles" || LOOLProtocol::getFirstToken(tokens[0], '-') == "child") { if (document) { queue->put(message); } else { LOG_WRN("No document while processing " << tokens[0] << " request."); } } else if (document && document->canDiscard()) { LOG_INF("Last session discarded. Terminating."); TerminationFlag = true; } else { LOG_ERR("Bad or unknown token [" << tokens[0] << "]"); } return true; }, []() {}, []() { if (document && document->canDiscard()) { LOG_INF("Last session discarded. Terminating."); TerminationFlag = true; } return TerminationFlag.load(); }); // Let forkit handle the jail cleanup. } catch (const Exception& exc) { LOG_ERR("Poco Exception: " << exc.displayText() << (exc.nested() ? " (" + exc.nested()->displayText() + ")" : "")); } catch (const std::exception& exc) { LOG_ERR("Exception: " << exc.what()); } // Trap the signal handler, if invoked, // to prevent exiting. LOG_INF("Process finished."); std::unique_lock lock(SigHandlerTrap); std::_Exit(Application::EXIT_OK); } #endif /// Initializes LibreOfficeKit for cross-fork re-use. bool globalPreinit(const std::string &loTemplate) { const std::string libSofficeapp = loTemplate + "/program/" LIB_SOFFICEAPP; const std::string libMerged = loTemplate + "/program/" LIB_MERGED; std::string loadedLibrary; void *handle; if (File(libMerged).exists()) { LOG_TRC("dlopen(" << libMerged << ", RTLD_GLOBAL|RTLD_NOW)"); handle = dlopen(libMerged.c_str(), RTLD_GLOBAL|RTLD_NOW); if (!handle) { LOG_FTL("Failed to load " << libMerged << ": " << dlerror()); return false; } loadedLibrary = libMerged; } else { if (File(libSofficeapp).exists()) { LOG_TRC("dlopen(" << libSofficeapp << ", RTLD_GLOBAL|RTLD_NOW)"); handle = dlopen(libSofficeapp.c_str(), RTLD_GLOBAL|RTLD_NOW); if (!handle) { LOG_FTL("Failed to load " << libSofficeapp << ": " << dlerror()); return false; } loadedLibrary = libSofficeapp; } else { LOG_FTL("Neither " << libSofficeapp << " or " << libMerged << " exist."); return false; } } LokHookPreInit* preInit = (LokHookPreInit *)dlsym(handle, "lok_preinit"); if (!preInit) { LOG_FTL("No lok_preinit symbol in " << loadedLibrary << ": " << dlerror()); return false; } LOG_TRC("lok_preinit(" << loTemplate << "/program\", \"file:///user\")"); if (preInit((loTemplate + "/program").c_str(), "file:///user") != 0) { LOG_FTL("lok_preinit() in " << loadedLibrary << " failed"); return false; } return true; } namespace Util { #ifndef BUILDING_TESTS void alertAllUsers(const std::string& msg) { document->sendTextFrame(msg); } void alertAllUsers(const std::string& cmd, const std::string& kind) { alertAllUsers("errortoall: cmd=" + cmd + " kind=" + kind); } #endif } /* vim:set shiftwidth=4 softtabstop=4 expandtab: */