/* -*- 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/. */ #include #include #include #include #include #include #include #include #include #include #include #ifdef IOS #include #include #include #include #include #import #import #include #endif #undef HAVE_MALLOC_TRIM #ifdef LINUX #include #if defined __GLIBC__ # include # define HAVE_MALLOC_TRIM #endif #endif #ifdef ANDROID #include #endif #ifdef EMSCRIPTEN #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef IOS #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef IOS #include #endif #include #include #include #include #ifdef _WIN32 #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // Needed for getUndoManager() #include #include #include #include #include #include #include #include "../app/cmdlineargs.hxx" // We also need to hackily be able to start the main libreoffice thread: #include "../app/sofficemain.h" #include "../app/officeipcthread.hxx" #include #include "lokinteractionhandler.hxx" #include "lokclipboard.hxx" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace css; using namespace vcl; using namespace desktop; using namespace utl; using namespace bridge; using namespace uno; using namespace lang; using LanguageToolCfg = officecfg::Office::Linguistic::GrammarChecking::LanguageTool; static LibLibreOffice_Impl *gImpl = nullptr; static bool lok_preinit_2_called = false; static std::weak_ptr< LibreOfficeKitClass > gOfficeClass; static std::weak_ptr< LibreOfficeKitDocumentClass > gDocumentClass; static void SetLastExceptionMsg(const OUString& s = OUString()) { SAL_WARN_IF(!s.isEmpty(), "lok", "lok exception '" + s + "'"); if (gImpl) gImpl->maLastExceptionMsg = s; } namespace { struct ExtensionMap { std::string_view extn; OUString filterName; }; class TraceEventDumper : public AutoTimer { static const int dumpTimeoutMS = 5000; public: TraceEventDumper() : AutoTimer( "Trace Event dumper" ) { SetTimeout(dumpTimeoutMS); Start(); } virtual void Invoke() override { flushRecordings(); } static void flushRecordings() { const css::uno::Sequence aEvents = comphelper::TraceEvent::getRecordingAndClear(); OStringBuffer aOutput; for (const auto &s : aEvents) { aOutput.append(OUStringToOString(s, RTL_TEXTENCODING_UTF8) + "\n"); } if (aOutput.getLength() > 0) { OString aChunk = aOutput.makeStringAndClear(); if (gImpl && gImpl->mpCallback) gImpl->mpCallback(LOK_CALLBACK_PROFILE_FRAME, aChunk.getStr(), gImpl->mpCallbackData); } } }; TraceEventDumper *traceEventDumper = nullptr; constexpr ExtensionMap aWriterExtensionMap[] = { { "doc", u"MS Word 97"_ustr }, { "docm", u"MS Word 2007 XML VBA"_ustr }, { "docx", u"MS Word 2007 XML"_ustr }, { "fodt", u"OpenDocument Text Flat XML"_ustr }, { "html", u"HTML (StarWriter)"_ustr }, { "odt", u"writer8"_ustr }, { "ott", u"writer8_template"_ustr }, { "pdf", u"writer_pdf_Export"_ustr }, { "epub", u"EPUB"_ustr }, { "rtf", u"Rich Text Format"_ustr }, { "txt", u"Text"_ustr }, { "xhtml", u"XHTML Writer File"_ustr }, { "png", u"writer_png_Export"_ustr }, { "xml", u"writer_indexing_export"_ustr }, }; constexpr ExtensionMap aCalcExtensionMap[] = { { "csv", u"Text - txt - csv (StarCalc)"_ustr }, { "fods", u"OpenDocument Spreadsheet Flat XML"_ustr }, { "html", u"HTML (StarCalc)"_ustr }, { "ods", u"calc8"_ustr }, { "ots", u"calc8_template"_ustr }, { "pdf", u"calc_pdf_Export"_ustr }, { "xhtml", u"XHTML Calc File"_ustr }, { "xls", u"MS Excel 97"_ustr }, { "xlsm", u"Calc MS Excel 2007 VBA XML"_ustr }, { "xlsx", u"Calc MS Excel 2007 XML"_ustr }, { "png", u"calc_png_Export"_ustr }, }; constexpr ExtensionMap aImpressExtensionMap[] = { { "fodp", u"OpenDocument Presentation Flat XML"_ustr }, { "html", u"impress_html_Export"_ustr }, { "odg", u"impress8_draw"_ustr }, { "odp", u"impress8"_ustr }, { "otp", u"impress8_template"_ustr }, { "pdf", u"impress_pdf_Export"_ustr }, { "potm", u"Impress MS PowerPoint 2007 XML Template"_ustr }, { "pot", u"MS PowerPoint 97 Vorlage"_ustr }, { "pptm", u"Impress MS PowerPoint 2007 XML VBA"_ustr }, { "pptx", u"Impress MS PowerPoint 2007 XML"_ustr }, { "pps", u"MS PowerPoint 97 Autoplay"_ustr }, { "ppt", u"MS PowerPoint 97"_ustr }, { "svg", u"impress_svg_Export"_ustr }, { "xhtml", u"XHTML Impress File"_ustr }, { "png", u"impress_png_Export"_ustr }, }; constexpr ExtensionMap aDrawExtensionMap[] = { { "fodg", u"draw_ODG_FlatXML"_ustr }, { "html", u"draw_html_Export"_ustr }, { "odg", u"draw8"_ustr }, { "pdf", u"draw_pdf_Export"_ustr }, { "svg", u"draw_svg_Export"_ustr }, { "xhtml", u"XHTML Draw File"_ustr }, { "png", u"draw_png_Export"_ustr }, }; OUString getUString(const char* pString) { if (pString == nullptr) return OUString(); return OStringToOUString(pString, RTL_TEXTENCODING_UTF8); } // Tolerate embedded \0s etc. char *convertOString(const OString &rStr) { char* pMemory = static_cast(malloc(rStr.getLength() + 1)); assert(pMemory); // don't tolerate failed allocations. memcpy(pMemory, rStr.getStr(), rStr.getLength() + 1); return pMemory; } char *convertOUString(std::u16string_view aStr) { return convertOString(OUStringToOString(aStr, RTL_TEXTENCODING_UTF8)); } /// Try to convert a relative URL to an absolute one, unless it already looks like a URL. OUString getAbsoluteURL(const char* pURL) { OUString aURL(getUString(pURL)); if (aURL.isEmpty()) return aURL; // convert relative paths to absolute ones OUString aWorkingDir; osl_getProcessWorkingDir(&aWorkingDir.pData); if (!aWorkingDir.endsWith("/")) aWorkingDir += "/"; try { return rtl::Uri::convertRelToAbs(aWorkingDir, aURL); } catch (const rtl::MalformedUriException &) { } return OUString(); } } // unnamed namespace std::vector desktop::jsonToPropertyValuesVector(const char* pJSON) { std::vector aArguments; if (pJSON && pJSON[0] != '\0') { aArguments = comphelper::JsonToPropertyValues(pJSON); } return aArguments; } static void extractLinks(const uno::Reference< container::XNameAccess >& xLinks, bool subcontent, tools::JsonWriter& aJson) { for (const OUString& aLink : xLinks->getElementNames()) { uno::Any aAny; try { aAny = xLinks->getByName( aLink ); } catch(const uno::Exception&) { // if the name of the target was invalid (like empty headings) // no object can be provided continue; } uno::Reference< beans::XPropertySet > xTarget; if( aAny >>= xTarget ) { try { // get name to display aAny = xTarget->getPropertyValue(u"LinkDisplayName"_ustr); OUString aStrDisplayname; aAny >>= aStrDisplayname; if (subcontent) { aJson.put(aStrDisplayname, aLink); } else { uno::Reference xSI(xTarget, uno::UNO_QUERY_THROW); if (xSI->supportsService(u"com.sun.star.document.LinkTarget"_ustr)) { aJson.put(aStrDisplayname, aLink); continue; } else { auto aNode = aJson.startNode( OUStringToOString(aStrDisplayname, RTL_TEXTENCODING_UTF8)); uno::Reference< document::XLinkTargetSupplier > xLTS( xTarget, uno::UNO_QUERY ); if( xLTS.is() ) extractLinks(xLTS->getLinks(), true, aJson); } } } catch(...) { SAL_WARN("lok", "extractLinks: Exception"); } } } } static void unoAnyToJson(tools::JsonWriter& rJson, std::string_view pNodeName, const uno::Any& anyItem) { auto aNode = rJson.startNode(pNodeName); OUString aType = anyItem.getValueTypeName(); rJson.put("type", aType); if (aType == "string") rJson.put("value", anyItem.get()); else if (aType == "unsigned long") rJson.put("value", OString::number(anyItem.get())); else if (aType == "long") rJson.put("value", OString::number(anyItem.get())); else if (aType == "[]any") { uno::Sequence aSeq; if (anyItem >>= aSeq) { auto valueNode = rJson.startNode("value"); for (auto i = 0; i < aSeq.getLength(); ++i) { unoAnyToJson(rJson, OString::number(i), aSeq[i]); } } } } static int lcl_getViewId(std::string_view payload); namespace desktop { RectangleAndPart RectangleAndPart::Create(const OString& rPayload) { RectangleAndPart aRet; if (rPayload.startsWith("EMPTY")) // payload starts with "EMPTY" { aRet.m_aRectangle = tools::Rectangle(0, 0, SfxLokHelper::MaxTwips, SfxLokHelper::MaxTwips); if (comphelper::LibreOfficeKit::isPartInInvalidation()) { int nSeparatorPos = rPayload.indexOf(',', 6); bool bHasMode = nSeparatorPos > 0; if (bHasMode) { aRet.m_nPart = o3tl::toInt32(rPayload.subView(6, nSeparatorPos - 6)); assert(rPayload.getLength() > nSeparatorPos); aRet.m_nMode = o3tl::toInt32(rPayload.subView(nSeparatorPos + 1)); } else { aRet.m_nPart = o3tl::toInt32(rPayload.subView(6)); aRet.m_nMode = 0; } } return aRet; } // Read ', , , [, , ]'. C++ streams are simpler but slower. const char* pos = rPayload.getStr(); const char* end = rPayload.getStr() + rPayload.getLength(); tools::Long nLeft = rtl_str_toInt64_WithLength(pos, 10, end - pos); while (pos < end && *pos != ',') ++pos; if (pos < end) ++pos; assert(pos < end); tools::Long nTop = rtl_str_toInt64_WithLength(pos, 10, end - pos); while (pos < end && *pos != ',') ++pos; if (pos < end) ++pos; assert(pos < end); tools::Long nWidth = rtl_str_toInt64_WithLength(pos, 10, end - pos); while (pos < end && *pos != ',') ++pos; if (pos < end) ++pos; assert(pos < end); tools::Long nHeight = rtl_str_toInt64_WithLength(pos, 10, end - pos); tools::Long nPart = INT_MIN; tools::Long nMode = 0; if (comphelper::LibreOfficeKit::isPartInInvalidation()) { while (pos < end && *pos != ',') ++pos; if (pos < end) ++pos; assert(pos < end); nPart = rtl_str_toInt64_WithLength(pos, 10, end - pos); while (pos < end && *pos != ',') ++pos; if (pos < end) { ++pos; assert(pos < end); nMode = rtl_str_toInt64_WithLength(pos, 10, end - pos); } } aRet.m_aRectangle = SanitizedRectangle(nLeft, nTop, nWidth, nHeight); aRet.m_nPart = nPart; aRet.m_nMode = nMode; return aRet; } tools::Rectangle RectangleAndPart::SanitizedRectangle(tools::Long nLeft, tools::Long nTop, tools::Long nWidth, tools::Long nHeight) { if (nWidth <= 0 || nHeight <= 0) return tools::Rectangle(); // The top-left corner starts at (0, 0). // Anything negative is invalid. if (nLeft < 0) { nWidth += nLeft; nLeft = 0; } if (nTop < 0) { nHeight += nTop; nTop = 0; } if (nWidth > 0 && nHeight > 0) return tools::Rectangle(nLeft, nTop, nLeft + nWidth, nTop + nHeight); // Else set empty rect. return tools::Rectangle(); } tools::Rectangle RectangleAndPart::SanitizedRectangle(const tools::Rectangle& rect) { return SanitizedRectangle(rect.Left(), rect.Top(), rect.getOpenWidth(), rect.getOpenHeight()); } const OString& CallbackFlushHandler::CallbackData::getPayload() const { if(PayloadString.isEmpty()) { // Do to-string conversion on demand, as many calls will get dropped without // needing the string. if(PayloadObject.which() == 1) PayloadString = getRectangleAndPart().toString(); } return PayloadString; } void CallbackFlushHandler::CallbackData::updateRectangleAndPart(const RectangleAndPart& rRectAndPart) { PayloadObject = rRectAndPart; PayloadString.clear(); // will be set on demand if needed } const RectangleAndPart& CallbackFlushHandler::CallbackData::getRectangleAndPart() const { // TODO: In case of unittests, they do not pass invalidations in binary but as text messages. // LO core should preferably always pass binary for performance. if(PayloadObject.which() != 1) PayloadObject = RectangleAndPart::Create(PayloadString); return boost::get(PayloadObject); } boost::property_tree::ptree& CallbackFlushHandler::CallbackData::setJson(const std::string& payload) { boost::property_tree::ptree aTree; std::stringstream aStream(payload); boost::property_tree::read_json(aStream, aTree); // Let boost normalize the payload so it always matches the cache. setJson(aTree); // Return reference to the cached object. return boost::get(PayloadObject); } void CallbackFlushHandler::CallbackData::setJson(const boost::property_tree::ptree& rTree) { std::stringstream aJSONStream; constexpr bool bPretty = false; // Don't waste time and bloat logs. boost::property_tree::write_json(aJSONStream, rTree, bPretty); PayloadString = OString(o3tl::trim(aJSONStream.str())); PayloadObject = rTree; } const boost::property_tree::ptree& CallbackFlushHandler::CallbackData::getJson() const { assert(PayloadObject.which() == 2); return boost::get(PayloadObject); } int CallbackFlushHandler::CallbackData::getViewId() const { if (isCached()) { assert(PayloadObject.which() == 3); return boost::get(PayloadObject); } return lcl_getViewId(getPayload()); } bool CallbackFlushHandler::CallbackData::validate() const { switch (PayloadObject.which()) { // Not cached. case 0: return true; // RectangleAndPart. case 1: return getRectangleAndPart().toString().getStr() == getPayload(); // Json. case 2: { std::stringstream aJSONStream; boost::property_tree::write_json(aJSONStream, getJson(), false); const std::string aExpected = boost::trim_copy(aJSONStream.str()); return getPayload() == std::string_view(aExpected); } // View id. case 3: return getViewId() == lcl_getViewId( getPayload()); default: assert(!"Unknown variant type; please add an entry to validate."); } return false; } } // namespace desktop static bool lcl_isViewCallbackType(const int type) { switch (type) { case LOK_CALLBACK_CELL_VIEW_CURSOR: case LOK_CALLBACK_GRAPHIC_VIEW_SELECTION: case LOK_CALLBACK_INVALIDATE_VIEW_CURSOR: case LOK_CALLBACK_TEXT_VIEW_SELECTION: case LOK_CALLBACK_VIEW_CURSOR_VISIBLE: return true; default: return false; } } static bool isUpdatedType(int type) { switch (type) { case LOK_CALLBACK_TEXT_SELECTION: case LOK_CALLBACK_TEXT_SELECTION_START: case LOK_CALLBACK_TEXT_SELECTION_END: return true; default: return false; } } static bool isUpdatedTypePerViewId(int type) { switch (type) { case LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR: case LOK_CALLBACK_INVALIDATE_VIEW_CURSOR: case LOK_CALLBACK_TEXT_VIEW_SELECTION: return true; default: return false; } } static int lcl_getViewId(std::string_view payload) { // this is a cheap way how to get the viewId from a JSON message; proper // parsing is terribly expensive, and we just need the viewId here size_t viewIdPos = payload.find("viewId"); if (viewIdPos == std::string::npos) return 0; size_t numberPos = payload.find(":", viewIdPos + 6); if (numberPos == std::string::npos) return 0; for (++numberPos; numberPos < payload.length(); ++numberPos) { if (payload[numberPos] == ',' || payload[numberPos] == '}' || (payload[numberPos] >= '0' && payload[numberPos] <= '9')) break; } if (numberPos < payload.length() && payload[numberPos] >= '0' && payload[numberPos] <= '9') return o3tl::toInt32(payload.substr(numberPos)); return 0; } namespace { std::string extractCertificate(const std::string & certificate) { static constexpr std::string_view header("-----BEGIN CERTIFICATE-----"); static constexpr std::string_view footer("-----END CERTIFICATE-----"); std::string result; size_t pos1 = certificate.find(header); if (pos1 == std::string::npos) return result; size_t pos2 = certificate.find(footer, pos1 + 1); if (pos2 == std::string::npos) return result; pos1 = pos1 + header.length(); pos2 = pos2 - pos1; return certificate.substr(pos1, pos2); } std::string extractPrivateKey(const std::string & privateKey) { static constexpr std::string_view header("-----BEGIN PRIVATE KEY-----"); static constexpr std::string_view footer("-----END PRIVATE KEY-----"); std::string result; size_t pos1 = privateKey.find(header); if (pos1 == std::string::npos) return result; size_t pos2 = privateKey.find(footer, pos1 + 1); if (pos2 == std::string::npos) return result; pos1 = pos1 + header.length(); pos2 = pos2 - pos1; return privateKey.substr(pos1, pos2); } OUString lcl_getCurrentDocumentMimeType(const LibLODocument_Impl* pDocument) { SfxBaseModel* pBaseModel = dynamic_cast(pDocument->mxComponent.get()); if (!pBaseModel) return ""; SfxObjectShell* pObjectShell = pBaseModel->GetObjectShell(); if (!pObjectShell) return ""; SfxMedium* pMedium = pObjectShell->GetMedium(); if (!pMedium) return ""; auto pFilter = pMedium->GetFilter(); if (!pFilter) return ""; return pFilter->GetMimeType(); } // Gets an undo manager to enter and exit undo context. Needed by ToggleOrientation css::uno::Reference< css::document::XUndoManager > getUndoManager( const css::uno::Reference< css::frame::XFrame >& rxFrame ) { const css::uno::Reference< css::frame::XController >& xController = rxFrame->getController(); if ( xController.is() ) { const css::uno::Reference< css::frame::XModel >& xModel = xController->getModel(); if ( xModel.is() ) { const css::uno::Reference< css::document::XUndoManagerSupplier > xSuppUndo( xModel, css::uno::UNO_QUERY_THROW ); return css::uno::Reference< css::document::XUndoManager >( xSuppUndo->getUndoManager(), css::uno::UNO_SET_THROW ); } } return css::uno::Reference< css::document::XUndoManager > (); } // Adjusts page margins for Writer doc. Needed by ToggleOrientation void ExecuteMarginLRChange( const tools::Long nPageLeftMargin, const tools::Long nPageRightMargin, SvxLongLRSpaceItem* pPageLRMarginItem) { pPageLRMarginItem->SetLeft( nPageLeftMargin ); pPageLRMarginItem->SetRight( nPageRightMargin ); SfxViewShell::Current()->GetDispatcher()->ExecuteList(SID_ATTR_PAGE_LRSPACE, SfxCallMode::RECORD, { pPageLRMarginItem }); } // Adjusts page margins for Writer doc. Needed by ToggleOrientation void ExecuteMarginULChange( const tools::Long nPageTopMargin, const tools::Long nPageBottomMargin, SvxLongULSpaceItem* pPageULMarginItem) { pPageULMarginItem->SetUpper( nPageTopMargin ); pPageULMarginItem->SetLower( nPageBottomMargin ); SfxViewShell::Current()->GetDispatcher()->ExecuteList(SID_ATTR_PAGE_ULSPACE, SfxCallMode::RECORD, { pPageULMarginItem }); } // Main function which toggles page orientation of the Writer doc. Needed by ToggleOrientation void ExecuteOrientationChange() { SfxViewFrame* pViewFrm = SfxViewFrame::Current(); if (!pViewFrm) return; std::unique_ptr pPageItem(new SvxPageItem(SID_ATTR_PAGE)); // 1mm in twips rounded // This should be in sync with MINBODY in sw/source/uibase/sidebar/PageMarginControl.hxx constexpr tools::Long MINBODY = o3tl::toTwips(1, o3tl::Length::mm); css::uno::Reference< css::document::XUndoManager > mxUndoManager( getUndoManager( pViewFrm->GetFrame().GetFrameInterface() ) ); if ( mxUndoManager.is() ) mxUndoManager->enterUndoContext( "" ); SfxPoolItemHolder aResult; pViewFrm->GetBindings().GetDispatcher()->QueryState(SID_ATTR_PAGE_SIZE, aResult); std::unique_ptr pPageSizeItem(static_cast(aResult.getItem())->Clone()); pViewFrm->GetBindings().GetDispatcher()->QueryState(SID_ATTR_PAGE_LRSPACE, aResult); std::unique_ptr pPageLRMarginItem(static_cast(aResult.getItem())->Clone()); pViewFrm->GetBindings().GetDispatcher()->QueryState(SID_ATTR_PAGE_ULSPACE, aResult); std::unique_ptr pPageULMarginItem(static_cast(aResult.getItem())->Clone()); { bool bIsLandscape = false; if ( pPageSizeItem->GetSize().Width() > pPageSizeItem->GetSize().Height()) bIsLandscape = true; // toggle page orientation pPageItem->SetLandscape(!bIsLandscape); // swap the width and height of the page size const tools::Long nRotatedWidth = pPageSizeItem->GetSize().Height(); const tools::Long nRotatedHeight = pPageSizeItem->GetSize().Width(); pPageSizeItem->SetSize(Size(nRotatedWidth, nRotatedHeight)); // apply changed attributes if (SfxViewShell::Current()) { SfxViewShell::Current()->GetDispatcher()->ExecuteList(SID_ATTR_PAGE_SIZE, SfxCallMode::RECORD, { pPageSizeItem.get(), pPageItem.get() }); } } // check, if margin values still fit to the changed page size. // if not, adjust margin values { const tools::Long nML = pPageLRMarginItem->GetLeft(); const tools::Long nMR = pPageLRMarginItem->GetRight(); const tools::Long nTmpPW = nML + nMR + MINBODY; const tools::Long nPW = pPageSizeItem->GetSize().Width(); if ( nTmpPW > nPW ) { if ( nML <= nMR ) { ExecuteMarginLRChange( pPageLRMarginItem->GetLeft(), nMR - (nTmpPW - nPW ), pPageLRMarginItem.get() ); } else { ExecuteMarginLRChange( nML - (nTmpPW - nPW ), pPageLRMarginItem->GetRight(), pPageLRMarginItem.get() ); } } const tools::Long nMT = pPageULMarginItem->GetUpper(); const tools::Long nMB = pPageULMarginItem->GetLower(); const tools::Long nTmpPH = nMT + nMB + MINBODY; const tools::Long nPH = pPageSizeItem->GetSize().Height(); if ( nTmpPH > nPH ) { if ( nMT <= nMB ) { ExecuteMarginULChange( pPageULMarginItem->GetUpper(), nMB - ( nTmpPH - nPH ), pPageULMarginItem.get() ); } else { ExecuteMarginULChange( nMT - ( nTmpPH - nPH ), pPageULMarginItem->GetLower(), pPageULMarginItem.get() ); } } } if ( mxUndoManager.is() ) mxUndoManager->leaveUndoContext(); } void setupSidebar(std::u16string_view sidebarDeckId = u"") { SfxViewShell* pViewShell = SfxViewShell::Current(); SfxViewFrame* pViewFrame = pViewShell ? &pViewShell->GetViewFrame() : nullptr; if (pViewFrame) { if (!pViewFrame->GetChildWindow(SID_SIDEBAR)) pViewFrame->SetChildWindow(SID_SIDEBAR, false /* create it */, true /* focus */); pViewFrame->ShowChildWindow(SID_SIDEBAR, true); // Force synchronous population of panels SfxChildWindow *pChild = pViewFrame->GetChildWindow(SID_SIDEBAR); if (!pChild) return; auto pDockingWin = dynamic_cast(pChild->GetWindow()); if (!pDockingWin) return; pViewFrame->ShowChildWindow( SID_SIDEBAR ); const rtl::Reference& xController = pDockingWin->GetOrCreateSidebarController(); xController->FadeIn(); xController->RequestOpenDeck(); if (!sidebarDeckId.empty()) { xController->SwitchToDeck(sidebarDeckId); } else { xController->SwitchToDefaultDeck(); } pDockingWin->SyncUpdate(); } else SetLastExceptionMsg(u"No view shell or sidebar"_ustr); } void hideSidebar() { SfxViewShell* pViewShell = SfxViewShell::Current(); SfxViewFrame* pViewFrame = pViewShell ? &pViewShell->GetViewFrame() : nullptr; if (pViewFrame) pViewFrame->SetChildWindow(SID_SIDEBAR, false , false ); else SetLastExceptionMsg(u"No view shell or sidebar"_ustr); } } // end anonymous namespace // Could be anonymous in principle, but for the unit testing purposes, we // declare it in init.hxx. OUString desktop::extractParameter(OUString& rOptions, std::u16string_view rName) { OUString aValue; OUString aNameEquals(OUString::Concat(rName) + "="); OUString aCommaNameEquals(OUString::Concat(",") + rName + "="); int nIndex = -1; if (rOptions.startsWith(aNameEquals)) { size_t nLen = aNameEquals.getLength(); int nComma = rOptions.indexOf(",", nLen); if (nComma >= 0) { aValue = rOptions.copy(nLen, nComma - nLen); rOptions = rOptions.copy(nComma + 1); } else { aValue = rOptions.copy(nLen); rOptions.clear(); } } else if ((nIndex = rOptions.indexOf(aCommaNameEquals)) >= 0) { size_t nLen = aCommaNameEquals.getLength(); int nComma = rOptions.indexOf(",", nIndex + nLen); if (nComma >= 0) { aValue = rOptions.copy(nIndex + nLen, nComma - nIndex - nLen); rOptions = OUString::Concat(rOptions.subView(0, nIndex)) + rOptions.subView(nComma); } else { aValue = rOptions.copy(nIndex + nLen); rOptions = rOptions.copy(0, nIndex); } } return aValue; } extern "C" { static void doc_destroy(LibreOfficeKitDocument* pThis); static int doc_saveAs(LibreOfficeKitDocument* pThis, const char* pUrl, const char* pFormat, const char* pFilterOptions); static int doc_getDocumentType(LibreOfficeKitDocument* pThis); static int doc_getParts(LibreOfficeKitDocument* pThis); static char* doc_getPartPageRectangles(LibreOfficeKitDocument* pThis); static int doc_getPart(LibreOfficeKitDocument* pThis); static void doc_setPart(LibreOfficeKitDocument* pThis, int nPart); static void doc_selectPart(LibreOfficeKitDocument* pThis, int nPart, int nSelect); static void doc_moveSelectedParts(LibreOfficeKitDocument* pThis, int nPosition, bool bDuplicate); static char* doc_getPartName(LibreOfficeKitDocument* pThis, int nPart); static void doc_setPartMode(LibreOfficeKitDocument* pThis, int nPartMode); static int doc_getEditMode(LibreOfficeKitDocument* pThis); static void doc_paintTile(LibreOfficeKitDocument* pThis, unsigned char* pBuffer, const int nCanvasWidth, const int nCanvasHeight, const int nTilePosX, const int nTilePosY, const int nTileWidth, const int nTileHeight); static void doc_paintPartTile(LibreOfficeKitDocument* pThis, unsigned char* pBuffer, const int nPart, const int nMode, const int nCanvasWidth, const int nCanvasHeight, const int nTilePosX, const int nTilePosY, const int nTileWidth, const int nTileHeight); static int doc_getTileMode(LibreOfficeKitDocument* pThis); static void doc_getDocumentSize(LibreOfficeKitDocument* pThis, long* pWidth, long* pHeight); static void doc_getDataArea(LibreOfficeKitDocument* pThis, long nTab, long* pCol, long* pRow); static void doc_initializeForRendering(LibreOfficeKitDocument* pThis, const char* pArguments); static void doc_registerCallback(LibreOfficeKitDocument* pThis, LibreOfficeKitCallback pCallback, void* pData); static void doc_postKeyEvent(LibreOfficeKitDocument* pThis, int nType, int nCharCode, int nKeyCode); static void doc_setBlockedCommandList(LibreOfficeKitDocument* pThis, int nViewId, const char* blockedCommandList); static void doc_postWindowExtTextInputEvent(LibreOfficeKitDocument* pThis, unsigned nWindowId, int nType, const char* pText); static char* doc_hyperlinkInfoAtPosition(LibreOfficeKitDocument *pThis, int x, int y); static void doc_removeTextContext(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, int nCharBefore, int nCharAfter); static void doc_sendDialogEvent(LibreOfficeKitDocument* pThis, unsigned long long int nLOKWindowId, const char* pArguments); static void doc_postWindowKeyEvent(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, int nType, int nCharCode, int nKeyCode); static void doc_postMouseEvent (LibreOfficeKitDocument* pThis, int nType, int nX, int nY, int nCount, int nButtons, int nModifier); static void doc_postWindowMouseEvent (LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, int nType, int nX, int nY, int nCount, int nButtons, int nModifier); static void doc_postWindowGestureEvent(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, const char* pType, int nX, int nY, int nOffset); static void doc_postUnoCommand(LibreOfficeKitDocument* pThis, const char* pCommand, const char* pArguments, bool bNotifyWhenFinished); static void doc_setWindowTextSelection(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, bool swap, int nX, int nY); static void doc_setTextSelection (LibreOfficeKitDocument* pThis, int nType, int nX, int nY); static char* doc_getTextSelection(LibreOfficeKitDocument* pThis, const char* pMimeType, char** pUsedMimeType); static int doc_getSelectionType(LibreOfficeKitDocument* pThis); static int doc_getSelectionTypeAndText(LibreOfficeKitDocument* pThis, const char* pMimeType, char** pText, char** pUsedMimeType); static int doc_getClipboard (LibreOfficeKitDocument* pThis, const char **pMimeTypes, size_t *pOutCount, char ***pOutMimeTypes, size_t **pOutSizes, char ***pOutStreams); static int doc_setClipboard (LibreOfficeKitDocument* pThis, const size_t nInCount, const char **pInMimeTypes, const size_t *pInSizes, const char **pInStreams); static bool doc_paste(LibreOfficeKitDocument* pThis, const char* pMimeType, const char* pData, size_t nSize); static void doc_setGraphicSelection (LibreOfficeKitDocument* pThis, int nType, int nX, int nY); static void doc_resetSelection (LibreOfficeKitDocument* pThis); static char* doc_getCommandValues(LibreOfficeKitDocument* pThis, const char* pCommand); static void doc_setClientZoom(LibreOfficeKitDocument* pThis, int nTilePixelWidth, int nTilePixelHeight, int nTileTwipWidth, int nTileTwipHeight); static void doc_setClientVisibleArea(LibreOfficeKitDocument* pThis, int nX, int nY, int nWidth, int nHeight); static void doc_setOutlineState(LibreOfficeKitDocument* pThis, bool bColumn, int nLevel, int nIndex, bool bHidden); static int doc_createView(LibreOfficeKitDocument* pThis); static int doc_createViewWithOptions(LibreOfficeKitDocument* pThis, const char* pOptions); static void doc_destroyView(LibreOfficeKitDocument* pThis, int nId); static void doc_setView(LibreOfficeKitDocument* pThis, int nId); static int doc_getView(LibreOfficeKitDocument* pThis); static int doc_getViewsCount(LibreOfficeKitDocument* pThis); static bool doc_getViewIds(LibreOfficeKitDocument* pThis, int* pArray, size_t nSize); static void doc_setViewLanguage(LibreOfficeKitDocument* pThis, int nId, const char* language); static unsigned char* doc_renderFontOrientation(LibreOfficeKitDocument* pThis, const char *pFontName, const char *pChar, int* pFontWidth, int* pFontHeight, int pOrientation); static unsigned char* doc_renderFont(LibreOfficeKitDocument* pThis, const char *pFontName, const char *pChar, int* pFontWidth, int* pFontHeight); static char* doc_getPartHash(LibreOfficeKitDocument* pThis, int nPart); static void doc_paintWindow(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, unsigned char* pBuffer, const int nX, const int nY, const int nWidth, const int nHeight); static void doc_paintWindowDPI(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, unsigned char* pBuffer, const int nX, const int nY, const int nWidth, const int nHeight, const double fDPIScale); static void doc_paintWindowForView(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, unsigned char* pBuffer, const int nX, const int nY, const int nWidth, const int nHeight, const double fDPIScale, int viewId); static void doc_postWindow(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, int nAction, const char* pData); static char* doc_getPartInfo(LibreOfficeKitDocument* pThis, int nPart); static bool doc_insertCertificate(LibreOfficeKitDocument* pThis, const unsigned char* pCertificateBinary, const int nCertificateBinarySize, const unsigned char* pPrivateKeyBinary, const int nPrivateKeyBinarySize); static bool doc_addCertificate(LibreOfficeKitDocument* pThis, const unsigned char* pCertificateBinary, const int nCertificateBinarySize); static int doc_getSignatureState(LibreOfficeKitDocument* pThis); static size_t doc_renderShapeSelection(LibreOfficeKitDocument* pThis, char** pOutput); static void doc_resizeWindow(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, const int nWidth, const int nHeight); static void doc_completeFunction(LibreOfficeKitDocument* pThis, const char*); static void doc_sendFormFieldEvent(LibreOfficeKitDocument* pThis, const char* pArguments); static bool doc_renderSearchResult(LibreOfficeKitDocument* pThis, const char* pSearchResult, unsigned char** pBitmapBuffer, int* pWidth, int* pHeight, size_t* pByteSize); static void doc_sendContentControlEvent(LibreOfficeKitDocument* pThis, const char* pArguments); static void doc_setViewTimezone(LibreOfficeKitDocument* pThis, int nId, const char* timezone); static void doc_setAccessibilityState(LibreOfficeKitDocument* pThis, int nId, bool bEnabled); static char* doc_getA11yFocusedParagraph(LibreOfficeKitDocument* pThis); static int doc_getA11yCaretPosition(LibreOfficeKitDocument* pThis); } // extern "C" namespace { ITiledRenderable* getTiledRenderable(LibreOfficeKitDocument* pThis) { LibLODocument_Impl* pDocument = static_cast(pThis); return dynamic_cast(pDocument->mxComponent.get()); } #ifndef IOS /* * Unfortunately clipboard creation using UNO is insanely baroque. * we also need to ensure that this works for the first view which * has no clear 'createView' called for it (unfortunately). */ rtl::Reference forceSetClipboardForCurrentView(LibreOfficeKitDocument *pThis) { ITiledRenderable* pDoc = getTiledRenderable(pThis); rtl::Reference xClip(LOKClipboardFactory::getClipboardForCurView()); SAL_INFO("lok", "Set to clipboard for view " << xClip.get()); // FIXME: using a hammer here - should not be necessary if all tests used createView. pDoc->setClipboard(uno::Reference(xClip->getXI(), UNO_QUERY)); return xClip; } #endif const vcl::Font* FindFont(std::u16string_view rFontName) { SfxObjectShell* pDocSh = SfxObjectShell::Current(); if (!pDocSh) return nullptr; const SvxFontListItem* pFonts = static_cast(pDocSh->GetItem(SID_ATTR_CHAR_FONTLIST)); const FontList* pList = pFonts ? pFonts->GetFontList() : nullptr; if (pList && !rFontName.empty()) if (sal_Handle hMetric = pList->GetFirstFontMetric(rFontName)) return &FontList::GetFontMetric(hMetric); return nullptr; } vcl::Font FindFont_FallbackToDefault(std::u16string_view rFontName) { if (auto pFound = FindFont(rFontName)) return *pFound; return OutputDevice::GetDefaultFont(DefaultFontType::SANS_UNICODE, LANGUAGE_NONE, GetDefaultFontFlags::NONE); } int getDocumentType (LibreOfficeKitDocument* pThis) { SetLastExceptionMsg(); LibLODocument_Impl* pDocument = static_cast(pThis); try { uno::Reference xDocument(pDocument->mxComponent, uno::UNO_QUERY_THROW); if (xDocument->supportsService(u"com.sun.star.sheet.SpreadsheetDocument"_ustr)) { return LOK_DOCTYPE_SPREADSHEET; } else if (xDocument->supportsService(u"com.sun.star.presentation.PresentationDocument"_ustr)) { return LOK_DOCTYPE_PRESENTATION; } else if (xDocument->supportsService(u"com.sun.star.drawing.DrawingDocument"_ustr)) { return LOK_DOCTYPE_DRAWING; } else if (xDocument->supportsService(u"com.sun.star.text.TextDocument"_ustr) || xDocument->supportsService(u"com.sun.star.text.WebDocument"_ustr)) { return LOK_DOCTYPE_TEXT; } else { SetLastExceptionMsg(u"unknown document type"_ustr); } } catch (const uno::Exception& exception) { SetLastExceptionMsg("exception: " + exception.Message); } return LOK_DOCTYPE_OTHER; } } // anonymous namespace LibLODocument_Impl::LibLODocument_Impl(uno::Reference xComponent, int nDocumentId) : mxComponent(std::move(xComponent)) , mnDocumentId(nDocumentId) { assert(nDocumentId != -1 && "Cannot set mnDocumentId to -1"); m_pDocumentClass = gDocumentClass.lock(); if (!m_pDocumentClass) { m_pDocumentClass = std::make_shared(); m_pDocumentClass->nSize = sizeof(LibreOfficeKitDocumentClass); m_pDocumentClass->destroy = doc_destroy; m_pDocumentClass->saveAs = doc_saveAs; m_pDocumentClass->getDocumentType = doc_getDocumentType; m_pDocumentClass->getParts = doc_getParts; m_pDocumentClass->getPartPageRectangles = doc_getPartPageRectangles; m_pDocumentClass->getPart = doc_getPart; m_pDocumentClass->setPart = doc_setPart; m_pDocumentClass->selectPart = doc_selectPart; m_pDocumentClass->moveSelectedParts = doc_moveSelectedParts; m_pDocumentClass->getPartName = doc_getPartName; m_pDocumentClass->setPartMode = doc_setPartMode; m_pDocumentClass->getEditMode = doc_getEditMode; m_pDocumentClass->paintTile = doc_paintTile; m_pDocumentClass->paintPartTile = doc_paintPartTile; m_pDocumentClass->getTileMode = doc_getTileMode; m_pDocumentClass->getDocumentSize = doc_getDocumentSize; m_pDocumentClass->getDataArea = doc_getDataArea; m_pDocumentClass->initializeForRendering = doc_initializeForRendering; m_pDocumentClass->registerCallback = doc_registerCallback; m_pDocumentClass->postKeyEvent = doc_postKeyEvent; m_pDocumentClass->postWindowExtTextInputEvent = doc_postWindowExtTextInputEvent; m_pDocumentClass->hyperlinkInfoAtPosition = doc_hyperlinkInfoAtPosition; m_pDocumentClass->removeTextContext = doc_removeTextContext; m_pDocumentClass->postWindowKeyEvent = doc_postWindowKeyEvent; m_pDocumentClass->postMouseEvent = doc_postMouseEvent; m_pDocumentClass->postWindowMouseEvent = doc_postWindowMouseEvent; m_pDocumentClass->sendDialogEvent = doc_sendDialogEvent; m_pDocumentClass->postUnoCommand = doc_postUnoCommand; m_pDocumentClass->setTextSelection = doc_setTextSelection; m_pDocumentClass->setWindowTextSelection = doc_setWindowTextSelection; m_pDocumentClass->getTextSelection = doc_getTextSelection; m_pDocumentClass->getSelectionType = doc_getSelectionType; m_pDocumentClass->getSelectionTypeAndText = doc_getSelectionTypeAndText; m_pDocumentClass->getClipboard = doc_getClipboard; m_pDocumentClass->setClipboard = doc_setClipboard; m_pDocumentClass->paste = doc_paste; m_pDocumentClass->setGraphicSelection = doc_setGraphicSelection; m_pDocumentClass->resetSelection = doc_resetSelection; m_pDocumentClass->getCommandValues = doc_getCommandValues; m_pDocumentClass->setClientZoom = doc_setClientZoom; m_pDocumentClass->setClientVisibleArea = doc_setClientVisibleArea; m_pDocumentClass->setOutlineState = doc_setOutlineState; m_pDocumentClass->createView = doc_createView; m_pDocumentClass->destroyView = doc_destroyView; m_pDocumentClass->setView = doc_setView; m_pDocumentClass->getView = doc_getView; m_pDocumentClass->getViewsCount = doc_getViewsCount; m_pDocumentClass->getViewIds = doc_getViewIds; m_pDocumentClass->renderFont = doc_renderFont; m_pDocumentClass->renderFontOrientation = doc_renderFontOrientation; m_pDocumentClass->getPartHash = doc_getPartHash; m_pDocumentClass->paintWindow = doc_paintWindow; m_pDocumentClass->paintWindowDPI = doc_paintWindowDPI; m_pDocumentClass->paintWindowForView = doc_paintWindowForView; m_pDocumentClass->postWindow = doc_postWindow; m_pDocumentClass->resizeWindow = doc_resizeWindow; m_pDocumentClass->setViewLanguage = doc_setViewLanguage; m_pDocumentClass->getPartInfo = doc_getPartInfo; m_pDocumentClass->insertCertificate = doc_insertCertificate; m_pDocumentClass->addCertificate = doc_addCertificate; m_pDocumentClass->getSignatureState = doc_getSignatureState; m_pDocumentClass->renderShapeSelection = doc_renderShapeSelection; m_pDocumentClass->postWindowGestureEvent = doc_postWindowGestureEvent; m_pDocumentClass->createViewWithOptions = doc_createViewWithOptions; m_pDocumentClass->completeFunction = doc_completeFunction; m_pDocumentClass->sendFormFieldEvent = doc_sendFormFieldEvent; m_pDocumentClass->renderSearchResult = doc_renderSearchResult; m_pDocumentClass->setBlockedCommandList = doc_setBlockedCommandList; m_pDocumentClass->sendContentControlEvent = doc_sendContentControlEvent; m_pDocumentClass->setViewTimezone = doc_setViewTimezone; m_pDocumentClass->setAccessibilityState = doc_setAccessibilityState; m_pDocumentClass->getA11yFocusedParagraph = doc_getA11yFocusedParagraph; m_pDocumentClass->getA11yCaretPosition = doc_getA11yCaretPosition; gDocumentClass = m_pDocumentClass; } pClass = m_pDocumentClass.get(); #ifndef IOS forceSetClipboardForCurrentView(this); #endif } LibLODocument_Impl::~LibLODocument_Impl() { try { mxComponent->dispose(); } catch (const css::lang::DisposedException&) { TOOLS_WARN_EXCEPTION("lok", "failed to dispose document"); } } static OUString getGenerator() { OUString sGenerator( Translate::ExpandVariables(u"%PRODUCTNAME %PRODUCTVERSION%PRODUCTEXTENSION (%1)"_ustr)); OUString os(u"$_OS"_ustr); ::rtl::Bootstrap::expandMacros(os); return sGenerator.replaceFirst("%1", os); } extern "C" { CallbackFlushHandler::TimeoutIdle::TimeoutIdle( CallbackFlushHandler* handler ) : Timer( "lokit timer callback" ) , mHandler( handler ) { // A second timer with higher priority, it'll ensure we flush in reasonable time if we get too busy // to get POST_PAINT priority processing. Otherwise it could take a long time to flush. SetPriority(TaskPriority::DEFAULT); SetTimeout( 100 ); // 100 ms } void CallbackFlushHandler::TimeoutIdle::Invoke() { mHandler->Invoke(); } // One of these is created per view to handle events cf. doc_registerCallback CallbackFlushHandler::CallbackFlushHandler(LibreOfficeKitDocument* pDocument, LibreOfficeKitCallback pCallback, void* pData) : Idle( "lokit idle callback" ), m_pDocument(pDocument), m_pCallback(pCallback), m_pData(pData), m_nDisableCallbacks(0), m_TimeoutIdle( this ) { SetPriority(TaskPriority::POST_PAINT); // Add the states that are safe to skip duplicates on, even when // not consequent (i.e. do no emit them if unchanged from last). m_states.emplace(LOK_CALLBACK_TEXT_SELECTION, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_GRAPHIC_SELECTION, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_STATE_CHANGED, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_MOUSE_POINTER, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_CELL_CURSOR, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_CELL_FORMULA, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_CELL_ADDRESS, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_CURSOR_VISIBLE, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_SET_PART, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_TABLE_SELECTED, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_TAB_STOP_LIST, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_RULER_UPDATE, "NIL"_ostr); m_states.emplace(LOK_CALLBACK_STATUS_INDICATOR_SET_VALUE, "NIL"_ostr); } CallbackFlushHandler::~CallbackFlushHandler() { Stop(); } CallbackFlushHandler::queue_type2::iterator CallbackFlushHandler::toQueue2(CallbackFlushHandler::queue_type1::iterator pos) { int delta = std::distance(m_queue1.begin(), pos); return m_queue2.begin() + delta; } CallbackFlushHandler::queue_type2::reverse_iterator CallbackFlushHandler::toQueue2(CallbackFlushHandler::queue_type1::reverse_iterator pos) { int delta = std::distance(m_queue1.rbegin(), pos); return m_queue2.rbegin() + delta; } void CallbackFlushHandler::setUpdatedType( int nType, bool value ) { assert(isUpdatedType(nType)); if( m_updatedTypes.size() <= o3tl::make_unsigned( nType )) m_updatedTypes.resize( nType + 1 ); // new are default-constructed, i.e. false m_updatedTypes[ nType ] = value; if(value) startTimer(); } void CallbackFlushHandler::resetUpdatedType( int nType ) { setUpdatedType( nType, false ); } void CallbackFlushHandler::setUpdatedTypePerViewId( int nType, int nViewId, int nSourceViewId, bool value ) { assert(isUpdatedTypePerViewId(nType)); std::vector& types = m_updatedTypesPerViewId[ nViewId ]; if( types.size() <= o3tl::make_unsigned( nType )) types.resize( nType + 1 ); // new are default-constructed, i.e. 'set' is false types[ nType ] = PerViewIdData{ value, nSourceViewId }; if(value) startTimer(); } void CallbackFlushHandler::resetUpdatedTypePerViewId( int nType, int nViewId ) { assert(isUpdatedTypePerViewId(nType)); bool allViewIds = false; // Handle specially messages that do not have viewId for backwards compatibility. if( nType == LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR && !comphelper::LibreOfficeKit::isViewIdForVisCursorInvalidation()) allViewIds = true; if( !allViewIds ) { setUpdatedTypePerViewId( nType, nViewId, -1, false ); return; } for( auto& it : m_updatedTypesPerViewId ) { std::vector& types = it.second; if( types.size() >= o3tl::make_unsigned( nType )) types[ nType ].set = false; } } void CallbackFlushHandler::libreOfficeKitViewCallback(int nType, const OString& pPayload) { CallbackData callbackData(pPayload); queue(nType, callbackData); } void CallbackFlushHandler::libreOfficeKitViewCallbackWithViewId(int nType, const OString& pPayload, int nViewId) { CallbackData callbackData(pPayload, nViewId); queue(nType, callbackData); } void CallbackFlushHandler::libreOfficeKitViewInvalidateTilesCallback(const tools::Rectangle* pRect, int nPart, int nMode) { CallbackData callbackData(pRect, nPart, nMode); queue(LOK_CALLBACK_INVALIDATE_TILES, callbackData); } void CallbackFlushHandler::libreOfficeKitViewUpdatedCallback(int nType) { assert(isUpdatedType( nType )); std::unique_lock lock(m_mutex); SAL_INFO("lok", "Updated: [" << nType << "]"); setUpdatedType(nType, true); } void CallbackFlushHandler::libreOfficeKitViewUpdatedCallbackPerViewId(int nType, int nViewId, int nSourceViewId) { assert(isUpdatedTypePerViewId( nType )); std::unique_lock lock(m_mutex); SAL_INFO("lok", "Updated: [" << nType << "]"); setUpdatedTypePerViewId(nType, nViewId, nSourceViewId, true); } void CallbackFlushHandler::dumpState(rtl::OStringBuffer &rState) { // NB. no locking rState.append("\nView:\t"); rState.append(static_cast(m_viewId)); rState.append("\n\tDisableCallbacks:\t"); rState.append(static_cast(m_nDisableCallbacks)); rState.append("\n\tStates:\n"); for (const auto &i : m_states) { rState.append("\n\t\t"); rState.append(static_cast(i.first)); rState.append("\t"); rState.append(i.second); } } void CallbackFlushHandler::libreOfficeKitViewAddPendingInvalidateTiles() { // Invoke() will call flushPendingLOKInvalidateTiles(), so just make sure the timer is active. startTimer(); } void CallbackFlushHandler::queue(const int type, const OString& data) { CallbackData callbackData(data); queue(type, callbackData); } void CallbackFlushHandler::queue(const int type, CallbackData& aCallbackData) { comphelper::ProfileZone aZone("CallbackFlushHandler::queue"); SAL_INFO("lok", "Queue: [" << type << "]: [" << aCallbackData.getPayload() << "] on " << m_queue1.size() << " entries."); bool bIsChartActive = false; bool bIsComment = false; if (type == LOK_CALLBACK_GRAPHIC_SELECTION) { LokChartHelper aChartHelper(SfxViewShell::Current()); bIsChartActive = aChartHelper.GetWindow() != nullptr; } else if (type == LOK_CALLBACK_COMMENT) { bIsComment = true; } if (callbacksDisabled() && !bIsChartActive && !bIsComment) { // We drop notifications when this is set, except for important ones. // When we issue a complex command (such as .uno:InsertAnnotation) // there will be multiple notifications. On the first invalidation // we will start painting, but other events will get fired // while the complex command in question executes. // We don't want to suppress everything here on the wrong assumption // that no new events are fired during painting. if (type != LOK_CALLBACK_STATE_CHANGED && type != LOK_CALLBACK_INVALIDATE_TILES && type != LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR && type != LOK_CALLBACK_CURSOR_VISIBLE && type != LOK_CALLBACK_VIEW_CURSOR_VISIBLE && type != LOK_CALLBACK_TEXT_SELECTION && type != LOK_CALLBACK_TEXT_SELECTION_START && type != LOK_CALLBACK_TEXT_SELECTION_END && type != LOK_CALLBACK_MEDIA_SHAPE && type != LOK_CALLBACK_REFERENCE_MARKS) { SAL_INFO("lok", "Skipping while painting [" << type << "]: [" << aCallbackData.getPayload() << "]."); return; } // In Writer we drop all notifications during painting. if (doc_getDocumentType(m_pDocument) == LOK_DOCTYPE_TEXT) return; } // Suppress invalid payloads. if (type == LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR && aCallbackData.getPayload().indexOf(", 0, 0, ") != -1 && aCallbackData.getPayload().indexOf("\"hyperlink\":\"\"") == -1 && aCallbackData.getPayload().indexOf("\"hyperlink\": {}") == -1) { // The cursor position is often the relative coordinates of the widget // issuing it, instead of the absolute one that we expect. // This is temporary however, and, once the control is created and initialized // correctly, it eventually emits the correct absolute coordinates. SAL_INFO("lok", "Skipping invalid event [" << type << "]: [" << aCallbackData.getPayload() << "]."); return; } std::unique_lock lock(m_mutex); // Update types should be received via the updated callbacks for performance, // getting them as normal callbacks is technically not wrong, but probably should be avoided. // Reset the updated flag if we get a normal message. if(isUpdatedType(type)) { SAL_INFO("lok", "Received event with updated type [" << type << "] as normal callback"); resetUpdatedType(type); } if(isUpdatedTypePerViewId(type)) { SAL_INFO("lok", "Received event with updated type [" << type << "] as normal callback"); resetUpdatedTypePerViewId(type, aCallbackData.getViewId()); } // drop duplicate callbacks for the listed types switch (type) { case LOK_CALLBACK_TEXT_SELECTION_START: case LOK_CALLBACK_TEXT_SELECTION_END: case LOK_CALLBACK_TEXT_SELECTION: case LOK_CALLBACK_GRAPHIC_SELECTION: case LOK_CALLBACK_GRAPHIC_VIEW_SELECTION: case LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR: case LOK_CALLBACK_INVALIDATE_VIEW_CURSOR: case LOK_CALLBACK_STATE_CHANGED: case LOK_CALLBACK_MOUSE_POINTER: case LOK_CALLBACK_CELL_CURSOR: case LOK_CALLBACK_CELL_VIEW_CURSOR: case LOK_CALLBACK_CELL_FORMULA: case LOK_CALLBACK_CELL_ADDRESS: case LOK_CALLBACK_CELL_SELECTION_AREA: case LOK_CALLBACK_CURSOR_VISIBLE: case LOK_CALLBACK_VIEW_CURSOR_VISIBLE: case LOK_CALLBACK_SET_PART: case LOK_CALLBACK_TEXT_VIEW_SELECTION: case LOK_CALLBACK_INVALIDATE_HEADER: case LOK_CALLBACK_WINDOW: case LOK_CALLBACK_CALC_FUNCTION_LIST: case LOK_CALLBACK_INVALIDATE_SHEET_GEOMETRY: case LOK_CALLBACK_REFERENCE_MARKS: case LOK_CALLBACK_CELL_AUTO_FILL_AREA: case LOK_CALLBACK_A11Y_FOCUS_CHANGED: case LOK_CALLBACK_A11Y_CARET_CHANGED: case LOK_CALLBACK_A11Y_TEXT_SELECTION_CHANGED: case LOK_CALLBACK_A11Y_FOCUSED_CELL_CHANGED: case LOK_CALLBACK_COLOR_PALETTES: case LOK_CALLBACK_A11Y_EDITING_IN_SELECTION_STATE: case LOK_CALLBACK_A11Y_SELECTION_CHANGED: { const auto& pos = std::find(m_queue1.rbegin(), m_queue1.rend(), type); auto pos2 = toQueue2(pos); if (pos != m_queue1.rend() && pos2->getPayload() == aCallbackData.getPayload()) { SAL_INFO("lok", "Skipping queue duplicate [" << type << + "]: [" << aCallbackData.getPayload() << "]."); return; } } break; } if (type == LOK_CALLBACK_TEXT_SELECTION && aCallbackData.isEmpty()) { const auto& posStart = std::find(m_queue1.rbegin(), m_queue1.rend(), LOK_CALLBACK_TEXT_SELECTION_START); auto posStart2 = toQueue2(posStart); if (posStart != m_queue1.rend()) posStart2->clear(); const auto& posEnd = std::find(m_queue1.rbegin(), m_queue1.rend(), LOK_CALLBACK_TEXT_SELECTION_END); auto posEnd2 = toQueue2(posEnd); if (posEnd != m_queue1.rend()) posEnd2->clear(); } // When payload is empty discards any previous state. if (aCallbackData.isEmpty()) { switch (type) { case LOK_CALLBACK_TEXT_SELECTION_START: case LOK_CALLBACK_TEXT_SELECTION_END: case LOK_CALLBACK_TEXT_SELECTION: case LOK_CALLBACK_GRAPHIC_SELECTION: case LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR: case LOK_CALLBACK_INVALIDATE_TILES: case LOK_CALLBACK_TOOLTIP: if (removeAll(type)) SAL_INFO("lok", "Removed dups of [" << type << "]: [" << aCallbackData.getPayload() << "]."); break; } } else { switch (type) { // These are safe to use the latest state and ignore previous // ones (if any) since the last overrides previous ones. case LOK_CALLBACK_TEXT_SELECTION_START: case LOK_CALLBACK_TEXT_SELECTION_END: case LOK_CALLBACK_TEXT_SELECTION: case LOK_CALLBACK_MOUSE_POINTER: case LOK_CALLBACK_CELL_CURSOR: case LOK_CALLBACK_CELL_FORMULA: case LOK_CALLBACK_CELL_ADDRESS: case LOK_CALLBACK_CURSOR_VISIBLE: case LOK_CALLBACK_SET_PART: case LOK_CALLBACK_STATUS_INDICATOR_SET_VALUE: case LOK_CALLBACK_RULER_UPDATE: case LOK_CALLBACK_A11Y_FOCUS_CHANGED: case LOK_CALLBACK_A11Y_CARET_CHANGED: case LOK_CALLBACK_A11Y_TEXT_SELECTION_CHANGED: case LOK_CALLBACK_A11Y_FOCUSED_CELL_CHANGED: case LOK_CALLBACK_COLOR_PALETTES: case LOK_CALLBACK_TOOLTIP: { if (removeAll(type)) SAL_INFO("lok", "Removed dups of [" << type << "]: [" << aCallbackData.getPayload() << "]."); } break; // These are safe to use the latest state and ignore previous // ones (if any) since the last overrides previous ones, // but only if the view is the same. case LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR: // deleting the duplicate of visible cursor message can cause hyperlink popup not to show up on second/or more click on the same place. // If the hyperlink is not empty we can bypass that to show the popup if (aCallbackData.getPayload().indexOf("\"hyperlink\":\"\"") == -1 && aCallbackData.getPayload().indexOf("\"hyperlink\": {}") == -1) break; [[fallthrough]]; case LOK_CALLBACK_CELL_VIEW_CURSOR: case LOK_CALLBACK_GRAPHIC_VIEW_SELECTION: case LOK_CALLBACK_INVALIDATE_VIEW_CURSOR: case LOK_CALLBACK_TEXT_VIEW_SELECTION: case LOK_CALLBACK_VIEW_CURSOR_VISIBLE: case LOK_CALLBACK_CALC_FUNCTION_LIST: case LOK_CALLBACK_FORM_FIELD_BUTTON: { const int nViewId = aCallbackData.getViewId(); removeAll(type, [nViewId] (const CallbackData& elemData) { return (nViewId == elemData.getViewId()); } ); } break; case LOK_CALLBACK_INVALIDATE_TILES: if (processInvalidateTilesEvent(type, aCallbackData)) return; break; // State changes with same name override previous ones with a different value. // Ex. ".uno:PageStatus=Slide 20 of 83" overwrites any previous PageStatus. case LOK_CALLBACK_STATE_CHANGED: { // Compare the state name=value and overwrite earlier entries with same name. const auto pos = aCallbackData.getPayload().indexOf('='); if (pos != -1) { const std::string_view name = aCallbackData.getPayload().subView(0, pos + 1); // This is needed because otherwise it creates some problems when // a save occurs while a cell is still edited in Calc. if (name != ".uno:ModifiedStatus=") { removeAll(type, [&name] (const CallbackData& elemData) { return elemData.getPayload().startsWith(name); } ); } } } break; case LOK_CALLBACK_WINDOW: if (processWindowEvent(type, aCallbackData)) return; break; case LOK_CALLBACK_GRAPHIC_SELECTION: { // remove only selection ranges and 'EMPTY' messages // always send 'INPLACE' and 'INPLACE EXIT' messages removeAll(type, [] (const CallbackData& elemData) { return (elemData.getPayload().indexOf("INPLACE") == -1); }); } break; } } // Validate that the cached data and the payload string are identical. assert(aCallbackData.validate() && "Cached callback payload object and string mismatch!"); m_queue1.emplace_back(type); m_queue2.emplace_back(aCallbackData); SAL_INFO("lok", "Queued #" << (m_queue1.size() - 1) << " [" << type << "]: [" << aCallbackData.getPayload() << "] to have " << m_queue1.size() << " entries."); #ifdef DBG_UTIL { // Dump the queue state and validate cached data. int i = 1; std::ostringstream oss; if (m_queue1.empty()) oss << "Empty"; else oss << m_queue1.size() << " items\n"; auto it1 = m_queue1.begin(); auto it2 = m_queue2.begin(); for (; it1 != m_queue1.end(); ++it1, ++it2) oss << i++ << ": [" << *it1 << "] [" << it2->getPayload() << "].\n"; SAL_INFO("lok", "Current Queue: " << oss.str()); assert( std::all_of( m_queue2.begin(), m_queue2.end(), [](const CallbackData& c) { return c.validate(); })); } #endif lock.unlock(); startTimer(); } bool CallbackFlushHandler::processInvalidateTilesEvent(int type, CallbackData& aCallbackData) { RectangleAndPart rcNew = aCallbackData.getRectangleAndPart(); if (rcNew.isEmpty()) { SAL_INFO("lok", "Skipping invalid event [" << type << "]: [" << aCallbackData.getPayload() << "]."); return true; } // If we have to invalidate all tiles, we can skip any new tile invalidation. // Find the last INVALIDATE_TILES entry, if any to see if it's invalidate-all. const auto& pos = std::find(m_queue1.rbegin(), m_queue1.rend(), LOK_CALLBACK_INVALIDATE_TILES); if (pos != m_queue1.rend()) { auto pos2 = toQueue2(pos); const RectangleAndPart& rcOld = pos2->getRectangleAndPart(); if (rcOld.isInfinite() && (rcOld.m_nPart == -1 || rcOld.m_nPart == rcNew.m_nPart) && (rcOld.m_nMode == rcNew.m_nMode)) { SAL_INFO("lok", "Skipping queue [" << type << "]: [" << aCallbackData.getPayload() << "] since all tiles need to be invalidated."); return true; } if ((rcOld.m_nPart == -1 || rcOld.m_nPart == rcNew.m_nPart) && (rcOld.m_nMode == rcNew.m_nMode)) { // If fully overlapping. if (rcOld.m_aRectangle.Contains(rcNew.m_aRectangle)) { SAL_INFO("lok", "Skipping queue [" << type << "]: [" << aCallbackData.getPayload() << "] since overlaps existing all-parts."); return true; } } } if (rcNew.isInfinite()) { SAL_INFO("lok", "Have Empty [" << type << "]: [" << aCallbackData.getPayload() << "] so removing all with part " << rcNew.m_nPart << "."); removeAll(LOK_CALLBACK_INVALIDATE_TILES, [&rcNew](const CallbackData& elemData) { // Remove exiting if new is all-encompassing, or if of the same part. return ((rcNew.m_nPart == -1 || rcNew.m_nPart == elemData.getRectangleAndPart().m_nPart) && (rcNew.m_nMode == elemData.getRectangleAndPart().m_nMode)); }); } else { const auto rcOrig = rcNew; SAL_INFO("lok", "Have [" << type << "]: [" << aCallbackData.getPayload() << "] so merging overlapping."); removeAll(LOK_CALLBACK_INVALIDATE_TILES,[&rcNew](const CallbackData& elemData) { const RectangleAndPart& rcOld = elemData.getRectangleAndPart(); if (rcNew.m_nPart != -1 && rcOld.m_nPart != -1 && (rcOld.m_nPart != rcNew.m_nPart || rcOld.m_nMode != rcNew.m_nMode)) { SAL_INFO("lok", "Nothing to merge between new: " << rcNew.toString() << ", and old: " << rcOld.toString()); return false; } if (rcNew.m_nPart == -1) { // Don't merge unless fully overlapped. SAL_INFO("lok", "New " << rcNew.toString() << " has " << rcOld.toString() << "?"); if (rcNew.m_aRectangle.Contains(rcOld.m_aRectangle) && rcOld.m_nMode == rcNew.m_nMode) { SAL_INFO("lok", "New " << rcNew.toString() << " engulfs old " << rcOld.toString() << "."); return true; } } else if (rcOld.m_nPart == -1) { // Don't merge unless fully overlapped. SAL_INFO("lok", "Old " << rcOld.toString() << " has " << rcNew.toString() << "?"); if (rcOld.m_aRectangle.Contains(rcNew.m_aRectangle) && rcOld.m_nMode == rcNew.m_nMode) { SAL_INFO("lok", "New " << rcNew.toString() << " engulfs old " << rcOld.toString() << "."); return true; } } else { const tools::Rectangle rcOverlap = rcNew.m_aRectangle.GetIntersection(rcOld.m_aRectangle); const bool bOverlap = !rcOverlap.IsEmpty() && rcOld.m_nMode == rcNew.m_nMode; SAL_INFO("lok", "Merging " << rcNew.toString() << " & " << rcOld.toString() << " => " << rcOverlap.toString() << " Overlap: " << bOverlap); if (bOverlap) { rcNew.m_aRectangle.Union(rcOld.m_aRectangle); SAL_INFO("lok", "Merged: " << rcNew.toString()); return true; } } // Keep others. return false; }); if (rcNew.m_aRectangle != rcOrig.m_aRectangle) { SAL_INFO("lok", "Replacing: " << rcOrig.toString() << " by " << rcNew.toString()); if (rcNew.m_aRectangle.GetWidth() < rcOrig.m_aRectangle.GetWidth() || rcNew.m_aRectangle.GetHeight() < rcOrig.m_aRectangle.GetHeight()) { SAL_WARN("lok", "Error: merged rect smaller."); } } } aCallbackData.updateRectangleAndPart(rcNew); // Queue this one. return false; } bool CallbackFlushHandler::processWindowEvent(int type, CallbackData& aCallbackData) { const OString& payload = aCallbackData.getPayload(); boost::property_tree::ptree& aTree = aCallbackData.setJson(std::string(payload)); const unsigned nLOKWindowId = aTree.get("id", 0); const std::string aAction = aTree.get("action", ""); if (aAction == "invalidate") { std::string aRectStr = aTree.get("rectangle", ""); // no 'rectangle' field => invalidate all of the window => // remove all previous window part invalidations if (aRectStr.empty()) { removeAll(LOK_CALLBACK_WINDOW,[&nLOKWindowId](const CallbackData& elemData) { const boost::property_tree::ptree& aOldTree = elemData.getJson(); if (nLOKWindowId == aOldTree.get("id", 0) && aOldTree.get("action", "") == "invalidate") { return true; } return false; }); } else { // if we have to invalidate all of the window, ignore // any part invalidation message bool invAllExist = false; auto it1 = m_queue1.rbegin(); auto it2 = m_queue2.rbegin(); for (;it1 != m_queue1.rend(); ++it1, ++it2) { if (*it1 != LOK_CALLBACK_WINDOW) continue; const boost::property_tree::ptree& aOldTree = it2->getJson(); if (nLOKWindowId == aOldTree.get("id", 0) && aOldTree.get("action", "") == "invalidate" && aOldTree.get("rectangle", "").empty()) { invAllExist = true; break; } } // we found a invalidate-all window callback if (invAllExist) { SAL_INFO("lok.dialog", "Skipping queue [" << type << "]: [" << payload << "] since whole window needs to be invalidated."); return true; } std::istringstream aRectStream(aRectStr); tools::Long nLeft, nTop, nWidth, nHeight; char nComma; aRectStream >> nLeft >> nComma >> nTop >> nComma >> nWidth >> nComma >> nHeight; tools::Rectangle aNewRect(nLeft, nTop, nLeft + nWidth, nTop + nHeight); bool currentIsRedundant = false; removeAll(LOK_CALLBACK_WINDOW, [&aNewRect, &nLOKWindowId, ¤tIsRedundant](const CallbackData& elemData) { const boost::property_tree::ptree& aOldTree = elemData.getJson(); if (aOldTree.get("action", "") == "invalidate") { // Not possible that we encounter an empty rectangle here; we already handled this case above. std::istringstream aOldRectStream(aOldTree.get("rectangle", "")); tools::Long nOldLeft, nOldTop, nOldWidth, nOldHeight; char nOldComma; aOldRectStream >> nOldLeft >> nOldComma >> nOldTop >> nOldComma >> nOldWidth >> nOldComma >> nOldHeight; const tools::Rectangle aOldRect = tools::Rectangle( nOldLeft, nOldTop, nOldLeft + nOldWidth, nOldTop + nOldHeight); if (nLOKWindowId == aOldTree.get("id", 0)) { if (aNewRect == aOldRect) { SAL_INFO("lok.dialog", "Duplicate rect [" << aNewRect.toString() << "]. Skipping new."); // We have a rectangle in the queue already that makes the current Callback useless. currentIsRedundant = true; return false; } // new one engulfs the old one? else if (aNewRect.Contains(aOldRect)) { SAL_INFO("lok.dialog", "New rect [" << aNewRect.toString() << "] engulfs old [" << aOldRect.toString() << "]. Replacing old."); return true; } // old one engulfs the new one? else if (aOldRect.Contains(aNewRect)) { SAL_INFO("lok.dialog", "Old rect [" << aOldRect.toString() << "] engulfs new [" << aNewRect.toString() << "]. Skipping new."); // We have a rectangle in the queue already that makes the current Callback useless. currentIsRedundant = true; return false; } else { // Overlapping rects. const tools::Rectangle aPreMergeRect = aNewRect; aNewRect.Union(aOldRect); SAL_INFO("lok.dialog", "Merging rects [" << aPreMergeRect.toString() << "] & [" << aOldRect.toString() << "] = [" << aNewRect.toString() << "]. Replacing old."); return true; } } } // keep rest return false; }); // Do not enqueue if redundant. if (currentIsRedundant) return true; aTree.put("rectangle", aNewRect.toString().getStr()); aCallbackData.setJson(aTree); assert(aCallbackData.validate() && "Validation after setJson failed!"); } } else if (aAction == "created") { // Remove all previous actions on same dialog, if we are creating it anew. removeAll(LOK_CALLBACK_WINDOW,[&nLOKWindowId](const CallbackData& elemData) { const boost::property_tree::ptree& aOldTree = elemData.getJson(); if (nLOKWindowId == aOldTree.get("id", 0)) return true; return false; }); VclPtr pWindow = vcl::Window::FindLOKWindow(nLOKWindowId); if (!pWindow) { SetLastExceptionMsg(u"Document doesn't support dialog rendering, or window not found."_ustr); return false; } #ifndef IOS auto xClip = forceSetClipboardForCurrentView(m_pDocument); uno::Reference xClipboard(xClip); pWindow->SetClipboard(xClipboard); #endif } else if (aAction == "size_changed") { // A size change is practically re-creation of the window. // But at a minimum it's a full invalidation. removeAll(LOK_CALLBACK_WINDOW, [&nLOKWindowId](const CallbackData& elemData) { const boost::property_tree::ptree& aOldTree = elemData.getJson(); if (nLOKWindowId == aOldTree.get("id", 0)) { const std::string aOldAction = aOldTree.get("action", ""); if (aOldAction == "invalidate") return true; } return false; }); } // Queue this one. return false; } void CallbackFlushHandler::enqueueUpdatedTypes() { if( m_updatedTypes.empty() && m_updatedTypesPerViewId.empty()) return; assert(m_viewId >= 0); SfxViewShell* viewShell = SfxViewShell::GetFirst( false, [this](const SfxViewShell* shell) { return shell->GetViewShellId().get() == m_viewId; } ); assert(viewShell != nullptr); // First move data to local structures, so that callbacks don't possibly modify it. std::vector updatedTypes; std::swap(updatedTypes, m_updatedTypes); boost::container::flat_map> updatedTypesPerViewId; std::swap(updatedTypesPerViewId, m_updatedTypesPerViewId); // Some types must always precede other types, for example // LOK_CALLBACK_TEXT_SELECTION_START and LOK_CALLBACK_TEXT_SELECTION_END // must always precede LOK_CALLBACK_TEXT_SELECTION if present. // Only these types should be present (see isUpdatedType()) and should be processed in this order. static const int orderedUpdatedTypes[] = { LOK_CALLBACK_TEXT_SELECTION_START, LOK_CALLBACK_TEXT_SELECTION_END, LOK_CALLBACK_TEXT_SELECTION }; // Only these types should be present (see isUpdatedTypePerViewId()) and (as of now) // the order doesn't matter. static const int orderedUpdatedTypesPerViewId[] = { LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR, LOK_CALLBACK_INVALIDATE_VIEW_CURSOR, LOK_CALLBACK_TEXT_VIEW_SELECTION }; for( int type : orderedUpdatedTypes ) { if(o3tl::make_unsigned( type ) < updatedTypes.size() && updatedTypes[ type ]) { enqueueUpdatedType( type, viewShell, m_viewId ); } } for( const auto& it : updatedTypesPerViewId ) { int viewId = it.first; const std::vector& types = it.second; for( int type : orderedUpdatedTypesPerViewId ) { if(o3tl::make_unsigned( type ) < types.size() && types[ type ].set) { SfxViewShell* sourceViewShell = viewShell; const int sourceViewId = types[ type ].sourceViewId; if( sourceViewId != m_viewId ) { assert(sourceViewId >= 0); sourceViewShell = SfxViewShell::GetFirst( false, [sourceViewId](const SfxViewShell* shell) { return shell->GetViewShellId().get() == sourceViewId; } ); } if(sourceViewShell == nullptr) { SAL_INFO("lok", "View #" << sourceViewId << " no longer found for updated event [" << type << "]"); continue; // View removed, probably cleaning up. } enqueueUpdatedType( type, sourceViewShell, viewId ); } } } } void CallbackFlushHandler::enqueueUpdatedType( int type, const SfxViewShell* viewShell, int viewId ) { if (type == LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR) { if (const SfxViewShell* viewShell2 = LokStarMathHelper(viewShell).GetSmViewShell()) viewShell = viewShell2; } std::optional payload = viewShell->getLOKPayload( type, viewId ); if(!payload) return; // No actual payload to send. CallbackData callbackData(*payload, viewId); m_queue1.emplace_back(type); m_queue2.emplace_back(callbackData); SAL_INFO("lok", "Queued updated [" << type << "]: [" << callbackData.getPayload() << "] to have " << m_queue1.size() << " entries."); } void CallbackFlushHandler::Invoke() { comphelper::ProfileZone aZone("CallbackFlushHandler::Invoke"); if (!m_pCallback) return; // Get any pending invalidate tile events. This will call our callbacks, // so it must be done before taking the mutex. assert(m_viewId >= 0); if(SfxViewShell* viewShell = SfxViewShell::GetFirst( false, [this](const SfxViewShell* shell) { return shell->GetViewShellId().get() == m_viewId; } )) { viewShell->flushPendingLOKInvalidateTiles(); } std::unique_lock lock(m_mutex); // Append messages for updated types, fetch them only now. enqueueUpdatedTypes(); SAL_INFO("lok", "Flushing " << m_queue1.size() << " elements."); auto it1 = m_queue1.begin(); auto it2 = m_queue2.begin(); for (; it1 != m_queue1.end(); ++it1, ++it2) { const int type = *it1; const auto& payload = it2->getPayload(); const int viewId = lcl_isViewCallbackType(type) ? it2->getViewId() : -1; SAL_INFO("lok", "processing event: [" << type << ',' << viewId << "]: [" << payload << "]."); // common code-path for events on this view: if (viewId == -1) { sal_Int32 idx; // key-value pairs if (type == LOK_CALLBACK_STATE_CHANGED && (idx = payload.indexOf('=')) != -1) { OString key = payload.copy(0, idx); OString value = payload.copy(idx+1); const auto stateIt = m_lastStateChange.find(key); if (stateIt != m_lastStateChange.end()) { // If the value didn't change, it's safe to ignore. if (stateIt->second == value) { SAL_INFO("lok", "Skipping new state duplicate: [" << type << "]: [" << payload << "]."); continue; } SAL_INFO("lok", "Replacing a state element [" << type << "]: [" << payload << "]."); stateIt->second = value; } else { SAL_INFO("lok", "Inserted a new state element: [" << type << "]: [" << payload << "]"); m_lastStateChange.emplace(key, value); } } else { const auto stateIt = m_states.find(type); if (stateIt != m_states.end()) { // If the state didn't change, it's safe to ignore. if (stateIt->second == payload) { SAL_INFO("lok", "Skipping duplicate [" << type << "]: [" << payload << "]."); continue; } stateIt->second = payload; } } } else // less common path for events relating to other views { const auto statesIt = m_viewStates.find(viewId); if (statesIt != m_viewStates.end()) { auto& states = statesIt->second; const auto stateIt = states.find(type); if (stateIt != states.end()) { // If the state didn't change, it's safe to ignore. if (stateIt->second == payload) { SAL_INFO("lok", "Skipping view duplicate [" << type << ',' << viewId << "]: [" << payload << "]."); continue; } SAL_INFO("lok", "Replacing an element in view states [" << type << ',' << viewId << "]: [" << payload << "]."); stateIt->second = payload; } else { SAL_INFO("lok", "Inserted a new element in view states: [" << type << ',' << viewId << "]: [" << payload << "]"); states.emplace(type, payload); } } } m_pCallback(type, payload.getStr(), m_pData); } m_queue1.clear(); m_queue2.clear(); Stop(); m_TimeoutIdle.Stop(); } void CallbackFlushHandler::startTimer() { if (!IsActive()) Start(); if (!m_TimeoutIdle.IsActive()) m_TimeoutIdle.Start(); } bool CallbackFlushHandler::removeAll(int type) { bool bErased = false; auto it1 = m_queue1.begin(); for(;;) { it1 = std::find(it1, m_queue1.end(), type); if(it1 == m_queue1.end()) break; m_queue2.erase(toQueue2(it1)); it1 = m_queue1.erase(it1); bErased = true; } return bErased; } bool CallbackFlushHandler::removeAll(int type, const std::function& rTestFunc) { bool bErased = false; auto it1 = m_queue1.begin(); for(;;) { it1 = std::find(it1, m_queue1.end(), type); if(it1 == m_queue1.end()) break; auto it2 = toQueue2(it1); if (rTestFunc(*it2)) { m_queue2.erase(it2); it1 = m_queue1.erase(it1); bErased = true; } else ++it1; } return bErased; } void CallbackFlushHandler::addViewStates(int viewId) { const auto& result = m_viewStates.emplace(viewId, decltype(m_viewStates)::mapped_type()); if (!result.second && result.first != m_viewStates.end()) { result.first->second.clear(); } } void CallbackFlushHandler::removeViewStates(int viewId) { m_viewStates.erase(viewId); } static void doc_destroy(LibreOfficeKitDocument *pThis) { comphelper::ProfileZone aZone("doc_destroy"); SolarMutexGuard aGuard; #ifndef IOS LOKClipboardFactory::releaseClipboardForView(-1); #endif LibLODocument_Impl *pDocument = static_cast(pThis); delete pDocument; } static void lo_destroy (LibreOfficeKit* pThis); static int lo_initialize (LibreOfficeKit* pThis, const char* pInstallPath, const char* pUserProfilePath); static LibreOfficeKitDocument* lo_documentLoad (LibreOfficeKit* pThis, const char* pURL); static char * lo_getError (LibreOfficeKit* pThis); static void lo_freeError (char* pFree); static LibreOfficeKitDocument* lo_documentLoadWithOptions (LibreOfficeKit* pThis, const char* pURL, const char* pOptions); static void lo_registerCallback (LibreOfficeKit* pThis, LibreOfficeKitCallback pCallback, void* pData); static char* lo_getFilterTypes(LibreOfficeKit* pThis); static void lo_setOptionalFeatures(LibreOfficeKit* pThis, unsigned long long features); static void lo_setDocumentPassword(LibreOfficeKit* pThis, const char* pURL, const char* pPassword); static char* lo_getVersionInfo(LibreOfficeKit* pThis); static int lo_runMacro (LibreOfficeKit* pThis, const char* pURL); static bool lo_signDocument(LibreOfficeKit* pThis, const char* pUrl, const unsigned char* pCertificateBinary, const int nCertificateBinarySize, const unsigned char* pPrivateKeyBinary, const int nPrivateKeyBinarySize); static char* lo_extractRequest(LibreOfficeKit* pThis, const char* pFilePath); static void lo_trimMemory(LibreOfficeKit* pThis, int nTarget); static void* lo_startURP(LibreOfficeKit* pThis, void* pReceiveURPFromLOContext, void* pSendURPToLOContext, int (*fnReceiveURPFromLO)(void* pContext, const signed char* pBuffer, int nLen), int (*fnSendURPToLO)(void* pContext, signed char* pBuffer, int nLen)); static void lo_stopURP(LibreOfficeKit* pThis, void* pSendURPToLOContext); static void lo_runLoop(LibreOfficeKit* pThis, LibreOfficeKitPollCallback pPollCallback, LibreOfficeKitWakeCallback pWakeCallback, void* pData); static void lo_sendDialogEvent(LibreOfficeKit* pThis, unsigned long long int nLOKWindowId, const char* pArguments); static void lo_setOption(LibreOfficeKit* pThis, const char* pOption, const char* pValue); static void lo_dumpState(LibreOfficeKit* pThis, const char* pOptions, char** pState); LibLibreOffice_Impl::LibLibreOffice_Impl() : m_pOfficeClass( gOfficeClass.lock() ) , maThread(nullptr) , mpCallback(nullptr) , mpCallbackData(nullptr) , mOptionalFeatures(0) { if(!m_pOfficeClass) { m_pOfficeClass = std::make_shared(); m_pOfficeClass->nSize = sizeof(LibreOfficeKitClass); m_pOfficeClass->destroy = lo_destroy; m_pOfficeClass->documentLoad = lo_documentLoad; m_pOfficeClass->getError = lo_getError; m_pOfficeClass->freeError = lo_freeError; m_pOfficeClass->documentLoadWithOptions = lo_documentLoadWithOptions; m_pOfficeClass->registerCallback = lo_registerCallback; m_pOfficeClass->getFilterTypes = lo_getFilterTypes; m_pOfficeClass->setOptionalFeatures = lo_setOptionalFeatures; m_pOfficeClass->setDocumentPassword = lo_setDocumentPassword; m_pOfficeClass->getVersionInfo = lo_getVersionInfo; m_pOfficeClass->runMacro = lo_runMacro; m_pOfficeClass->signDocument = lo_signDocument; m_pOfficeClass->runLoop = lo_runLoop; m_pOfficeClass->sendDialogEvent = lo_sendDialogEvent; m_pOfficeClass->setOption = lo_setOption; m_pOfficeClass->dumpState = lo_dumpState; m_pOfficeClass->extractRequest = lo_extractRequest; m_pOfficeClass->trimMemory = lo_trimMemory; m_pOfficeClass->startURP = lo_startURP; m_pOfficeClass->stopURP = lo_stopURP; gOfficeClass = m_pOfficeClass; } pClass = m_pOfficeClass.get(); } LibLibreOffice_Impl::~LibLibreOffice_Impl() { } namespace { void setLanguageAndLocale(OUString const & aLangISO) { SvtSysLocaleOptions aLocalOptions; aLocalOptions.SetLocaleConfigString(aLangISO); aLocalOptions.SetUILocaleConfigString(aLangISO); aLocalOptions.Commit(); } void setFormatSpecificFilterData(std::u16string_view sFormat, comphelper::SequenceAsHashMap & rFilterDataMap) { if (sFormat == u"pdf") { // always export bookmarks, which is needed for annotations rFilterDataMap[u"ExportBookmarks"_ustr] <<= true; } } } // anonymous namespace // Wonder global state ... static uno::Reference xContext; static uno::Reference xSFactory; static uno::Reference xFactory; static LibreOfficeKitDocument* lo_documentLoad(LibreOfficeKit* pThis, const char* pURL) { return lo_documentLoadWithOptions(pThis, pURL, nullptr); } static LibreOfficeKitDocument* lo_documentLoadWithOptions(LibreOfficeKit* pThis, const char* pURL, const char* pOptions) { comphelper::ProfileZone aZone("lo_documentLoadWithOptions"); SolarMutexGuard aGuard; static int nDocumentIdCounter = 0; LibLibreOffice_Impl* pLib = static_cast(pThis); pLib->maLastExceptionMsg.clear(); const OUString aURL(getAbsoluteURL(pURL)); if (aURL.isEmpty()) { pLib->maLastExceptionMsg = u"Filename to load was not provided."_ustr; SAL_INFO("lok", "URL for load is empty"); return nullptr; } pLib->maLastExceptionMsg.clear(); if (!xContext.is()) { pLib->maLastExceptionMsg = u"ComponentContext is not available"_ustr; SAL_INFO("lok", "ComponentContext is not available"); return nullptr; } uno::Reference xComponentLoader = frame::Desktop::create(xContext); if (!xComponentLoader.is()) { pLib->maLastExceptionMsg = u"ComponentLoader is not available"_ustr; SAL_INFO("lok", "ComponentLoader is not available"); return nullptr; } try { // 'Language=...' is an option that LOK consumes by itself, and does // not pass it as a parameter to the filter OUString aOptions = getUString(pOptions); const OUString aLanguage = extractParameter(aOptions, u"Language"); if (!aLanguage.isEmpty() && LanguageTag::isValidBcp47(aLanguage, nullptr)) { static bool isLoading = true; if (isLoading) { // Capture the language used to load the document. SfxLokHelper::setLoadLanguage(aLanguage); isLoading = false; } SfxLokHelper::setDefaultLanguage(aLanguage); // Set the LOK language tag, used for dialog tunneling. comphelper::LibreOfficeKit::setLanguageTag(LanguageTag(aLanguage)); comphelper::LibreOfficeKit::setLocale(LanguageTag(aLanguage)); SAL_INFO("lok", "Set document language to " << aLanguage); // use with care - it sets it for the entire core, not just the // document setLanguageAndLocale(aLanguage); // Need to reset the static initialized values SvNumberFormatter::resetTheCurrencyTable(); } // Set the timezone, if not empty. const OUString aTimezone = extractParameter(aOptions, u"Timezone"); if (!aTimezone.isEmpty()) { SfxLokHelper::setDefaultTimezone(true, aTimezone); } else { // Default to the TZ envar, if set. const char* tz = ::getenv("TZ"); if (tz) { SfxLokHelper::setDefaultTimezone(true, OStringToOUString(tz, RTL_TEXTENCODING_UTF8)); } else { SfxLokHelper::setDefaultTimezone(false, OUString()); } } const OUString aDeviceFormFactor = extractParameter(aOptions, u"DeviceFormFactor"); SfxLokHelper::setDeviceFormFactor(aDeviceFormFactor); const OUString aBatch = extractParameter(aOptions, u"Batch"); if (!aBatch.isEmpty()) { Application::SetDialogCancelMode(DialogCancelMode::LOKSilent); } rtl::Reference const pInteraction( new LOKInteractionHandler("load"_ostr, pLib)); auto const pair(pLib->mInteractionMap.insert(std::make_pair(aURL.toUtf8(), pInteraction))); comphelper::ScopeGuard const g([&] () { if (pair.second) { pLib->mInteractionMap.erase(aURL.toUtf8()); } }); uno::Reference const xInteraction(pInteraction); int nMacroSecurityLevel = 1; const OUString aMacroSecurityLevel = extractParameter(aOptions, u"MacroSecurityLevel"); if (!aMacroSecurityLevel.isEmpty()) { double nNumber; sal_uInt32 nFormat = 1; SvNumberFormatter aFormatter(::comphelper::getProcessComponentContext(), LANGUAGE_ENGLISH_US); if (aFormatter.IsNumberFormat(aMacroSecurityLevel, nFormat, nNumber)) nMacroSecurityLevel = static_cast(nNumber); } SvtSecurityOptions::SetMacroSecurityLevel(nMacroSecurityLevel); #if defined(ANDROID) && HAVE_FEATURE_ANDROID_LOK sal_Int16 nMacroExecMode = document::MacroExecMode::USE_CONFIG; #else const OUString aEnableMacrosExecution = extractParameter(aOptions, u"EnableMacrosExecution"); sal_Int16 nMacroExecMode = aEnableMacrosExecution == "true" ? document::MacroExecMode::USE_CONFIG : document::MacroExecMode::NEVER_EXECUTE; #endif // set AsTemplate explicitly false to be able to load template files // as regular files, otherwise we cannot save them; it will try // to bring saveas dialog which cannot work with LOK case uno::Sequence aFilterOptions{ comphelper::makePropertyValue(u"FilterOptions"_ustr, aOptions), comphelper::makePropertyValue(u"InteractionHandler"_ustr, xInteraction), comphelper::makePropertyValue(u"MacroExecutionMode"_ustr, nMacroExecMode), comphelper::makePropertyValue(u"AsTemplate"_ustr, false), comphelper::makePropertyValue(u"Silent"_ustr, !aBatch.isEmpty()) }; /* TODO sal_Int16 nUpdateDoc = document::UpdateDocMode::ACCORDING_TO_CONFIG; aFilterOptions[3].Name = "UpdateDocMode"; aFilterOptions[3].Value <<= nUpdateDoc; */ OutputDevice::StartTrackingFontMappingUse(); const int nThisDocumentId = nDocumentIdCounter++; SfxViewShell::SetCurrentDocId(ViewShellDocId(nThisDocumentId)); uno::Reference xComponent = xComponentLoader->loadComponentFromURL( aURL, u"_blank"_ustr, 0, aFilterOptions); assert(!xComponent.is() || pair.second); // concurrent loading of same URL ought to fail if (!xComponent.is()) { pLib->maLastExceptionMsg = u"loadComponentFromURL returned an empty reference"_ustr; SAL_INFO("lok", "Document can't be loaded - " << pLib->maLastExceptionMsg); return nullptr; } LibLODocument_Impl* pDocument = new LibLODocument_Impl(xComponent, nThisDocumentId); // After loading the document, its initial view is the "current" view. if (pLib->mpCallback) { int nState = doc_getSignatureState(pDocument); pLib->mpCallback(LOK_CALLBACK_SIGNATURE_STATUS, OString::number(nState).getStr(), pLib->mpCallbackData); } auto aFontMappingUseData = OutputDevice::FinishTrackingFontMappingUse(); if (aFontMappingUseData.size() > 0) { SAL_INFO("lok.fontsubst", "================ Original substitutions:"); for (const auto &i : aFontMappingUseData) { SAL_INFO("lok.fontsubst", i.mOriginalFont); for (const auto &j : i.mUsedFonts) SAL_INFO("lok.fontsubst", " " << j); } } // Filter out font substitutions that actually aren't any substitutions, like "Liberation // Serif" -> "Liberation Serif/Regular". If even one of the "substitutions" of a font is to // the same font, don't count that as a missing font. std::erase_if (aFontMappingUseData, [](OutputDevice::FontMappingUseItem x) { // If the original font had an empty style and one of its // replacement fonts has the same family name, we assume the font is // present. The root problem here is that the code that collects // font substitutions tends to get just empty styles for the font // that is being substituted, as vcl::Font::GetStyleName() tends to // return an empty string. (Italicness is instead indicated by what // vcl::Font::GetItalic() returns and boldness by what // vcl::Font::GetWeight() returns.) if (x.mOriginalFont.indexOf('/') == -1) for (const auto &j : x.mUsedFonts) if (j == x.mOriginalFont || j.startsWith(Concat2View(x.mOriginalFont + "/"))) return true; return false; }); // Filter out substitutions where a proprietary font has been substituted by a // metric-compatible one. Obviously this is just a heuristic and implemented only for some // well-known cases. std::erase_if (aFontMappingUseData, [](OutputDevice::FontMappingUseItem x) { // Again, handle only cases where the original font does not include // a style. Unclear whether there ever will be a style part included // in the mOriginalFont. if (x.mOriginalFont.indexOf('/') == -1) for (const auto &j : x.mUsedFonts) if ((x.mOriginalFont == "Arial" && j.startsWith("Liberation Sans/")) || (x.mOriginalFont == "Times New Roman" && j.startsWith("Liberation Serif/")) || (x.mOriginalFont == "Courier New" && j.startsWith("Liberation Mono/")) || (x.mOriginalFont == "Arial Narrow" && j.startsWith("Liberation Sans Narrow/")) || (x.mOriginalFont == "Cambria" && j.startsWith("Caladea/")) || (x.mOriginalFont == "Calibri" && j.startsWith("Carlito/")) || (x.mOriginalFont == "Palatino Linotype" && j.startsWith("P052/")) || // Perhaps a risky heuristic? If some glyphs from Symbol // have been mapped to ones in OpenSymbol, don't warn // that Symbol is missing. (x.mOriginalFont == "Symbol" && j.startsWith("OpenSymbol/"))) { return true; } return false; }); if (aFontMappingUseData.size() > 0) { SAL_INFO("lok.fontsubst", "================ Pruned substitutions:"); for (const auto &i : aFontMappingUseData) { SAL_INFO("lok.fontsubst", i.mOriginalFont); for (const auto &j : i.mUsedFonts) SAL_INFO("lok.fontsubst", " " << j); } } for (std::size_t i = 0; i < aFontMappingUseData.size(); ++i) { pDocument->maFontsMissing.insert(aFontMappingUseData[i].mOriginalFont); } return pDocument; } catch (const uno::Exception& exception) { pLib->maLastExceptionMsg = exception.Message; TOOLS_INFO_EXCEPTION("lok", "Document can't be loaded"); } return nullptr; } static int lo_runMacro(LibreOfficeKit* pThis, const char *pURL) { comphelper::ProfileZone aZone("lo_runMacro"); SolarMutexGuard aGuard; LibLibreOffice_Impl* pLib = static_cast(pThis); pLib->maLastExceptionMsg.clear(); OUString sURL( pURL, strlen(pURL), RTL_TEXTENCODING_UTF8 ); if (sURL.isEmpty()) { pLib->maLastExceptionMsg = u"Macro to run was not provided."_ustr; SAL_INFO("lok", "Macro URL is empty"); return false; } if (!sURL.startsWith("macro://")) { pLib->maLastExceptionMsg = u"This doesn't look like macro URL"_ustr; SAL_INFO("lok", "Macro URL is invalid"); return false; } pLib->maLastExceptionMsg.clear(); if (!xContext.is()) { pLib->maLastExceptionMsg = u"ComponentContext is not available"_ustr; SAL_INFO("lok", "ComponentContext is not available"); return false; } util::URL aURL; aURL.Complete = sURL; uno::Reference < util::XURLTransformer > xParser( util::URLTransformer::create( xContext ) ); if( xParser.is() ) xParser->parseStrict( aURL ); uno::Reference xComponentLoader = frame::Desktop::create(xContext); if (!xComponentLoader.is()) { pLib->maLastExceptionMsg = u"ComponentLoader is not available"_ustr; SAL_INFO("lok", "ComponentLoader is not available"); return false; } xFactory = xContext->getServiceManager(); if (!xFactory) return false; uno::Reference xDP; xSFactory.set(xFactory, uno::UNO_QUERY_THROW); xDP.set( xSFactory->createInstance(u"com.sun.star.comp.sfx2.SfxMacroLoader"_ustr), uno::UNO_QUERY ); uno::Reference xD = xDP->queryDispatch( aURL, OUString(), 0); if (!xD.is()) { pLib->maLastExceptionMsg = u"Macro loader is not available"_ustr; SAL_INFO("lok", "Macro loader is not available"); return false; } uno::Reference < frame::XSynchronousDispatch > xSyncDisp( xD, uno::UNO_QUERY_THROW ); uno::Sequence aEmpty; css::beans::PropertyValue aErr; uno::Any aRet = xSyncDisp->dispatchWithReturnValue( aURL, aEmpty ); aRet >>= aErr; if (aErr.Name == "ErrorCode") { sal_uInt32 nErrCode = 0; // ERRCODE_NONE aErr.Value >>= nErrCode; pLib->maLastExceptionMsg = "An error occurred running macro (error code: " + OUString::number( nErrCode ) + ")"; SAL_INFO("lok", "Macro execution terminated with error code " << nErrCode); return false; } return true; } static bool lo_signDocument(LibreOfficeKit* /*pThis*/, const char* pURL, const unsigned char* pCertificateBinary, const int nCertificateBinarySize, const unsigned char* pPrivateKeyBinary, const int nPrivateKeyBinarySize) { comphelper::ProfileZone aZone("lo_signDocument"); OUString aURL(getAbsoluteURL(pURL)); if (aURL.isEmpty()) return false; if (!xContext.is()) return false; uno::Sequence aCertificateSequence; std::string aCertificateString(reinterpret_cast(pCertificateBinary), nCertificateBinarySize); std::string aCertificateBase64String = extractCertificate(aCertificateString); if (!aCertificateBase64String.empty()) { OUString aBase64OUString = OUString::createFromAscii(aCertificateBase64String); comphelper::Base64::decode(aCertificateSequence, aBase64OUString); } else { aCertificateSequence.realloc(nCertificateBinarySize); std::copy(pCertificateBinary, pCertificateBinary + nCertificateBinarySize, aCertificateSequence.getArray()); } uno::Sequence aPrivateKeySequence; std::string aPrivateKeyString(reinterpret_cast(pPrivateKeyBinary), nPrivateKeyBinarySize); std::string aPrivateKeyBase64String = extractPrivateKey(aPrivateKeyString); if (!aPrivateKeyBase64String.empty()) { OUString aBase64OUString = OUString::createFromAscii(aPrivateKeyBase64String); comphelper::Base64::decode(aPrivateKeySequence, aBase64OUString); } else { aPrivateKeySequence.realloc(nPrivateKeyBinarySize); std::copy(pPrivateKeyBinary, pPrivateKeyBinary + nPrivateKeyBinarySize, aPrivateKeySequence.getArray()); } uno::Reference xSEInitializer = xml::crypto::SEInitializer::create(xContext); uno::Reference xSecurityContext = xSEInitializer->createSecurityContext(OUString()); if (!xSecurityContext.is()) return false; uno::Reference xSecurityEnvironment = xSecurityContext->getSecurityEnvironment(); uno::Reference xCertificateCreator(xSecurityEnvironment, uno::UNO_QUERY); if (!xCertificateCreator.is()) return false; uno::Reference xCertificate = xCertificateCreator->createDERCertificateWithPrivateKey(aCertificateSequence, aPrivateKeySequence); if (!xCertificate.is()) return false; sfx2::DocumentSigner aDocumentSigner(aURL); if (!aDocumentSigner.signDocument(xCertificate)) return false; return true; } static char* lo_extractRequest(LibreOfficeKit* /*pThis*/, const char* pFilePath) { uno::Reference xComponentLoader = frame::Desktop::create(xContext); uno::Reference< css::lang::XComponent > xComp; OUString aURL(getAbsoluteURL(pFilePath)); if (!aURL.isEmpty()) { if (xComponentLoader.is()) { try { uno::Sequence aFilterOptions(comphelper::InitPropertySequence( { {u"Hidden"_ustr, css::uno::Any(true)}, {u"ReadOnly"_ustr, css::uno::Any(true)} })); xComp = xComponentLoader->loadComponentFromURL( aURL, u"_blank"_ustr, 0, aFilterOptions ); } catch ( const lang::IllegalArgumentException& ex ) { SAL_WARN("lok", "lo_extractRequest: IllegalArgumentException: " << ex.Message); } catch (...) { SAL_WARN("lok", "lo_extractRequest: Exception on loadComponentFromURL, url= " << aURL); } if (xComp.is()) { uno::Reference< document::XLinkTargetSupplier > xLTS( xComp, uno::UNO_QUERY ); if( xLTS.is() ) { tools::JsonWriter aJson; { auto aNode = aJson.startNode("Targets"); extractLinks(xLTS->getLinks(), false, aJson); } return convertOString(aJson.finishAndGetAsOString()); } xComp->dispose(); } } } return strdup("{ }"); } static void lo_trimMemory(LibreOfficeKit* /* pThis */, int nTarget) { vcl::lok::trimMemory(nTarget); if (nTarget > 2000) { SolarMutexGuard aGuard; // Flush all buffered VOC primitives from the pages. SfxViewShell* pViewShell = SfxViewShell::Current(); if (pViewShell) { const SdrView* pView = pViewShell->GetDrawView(); if (pView) { SdrPageView* pPageView = pView->GetSdrPageView(); if (pPageView) { SdrPage* pCurPage = pPageView->GetPage(); if (pCurPage) { SdrModel& sdrModel = pCurPage->getSdrModelFromSdrPage(); for (sal_uInt16 i = 0; i < sdrModel.GetPageCount(); ++i) { SdrPage* pPage = sdrModel.GetPage(i); if (pPage) pPage->GetViewContact().flushViewObjectContacts(); } } } } } } if (nTarget > 1000) { #ifdef HAVE_MALLOC_TRIM malloc_trim(0); #endif } } namespace { class FunctionBasedURPInstanceProvider : public ::cppu::WeakImplHelper { private: css::uno::Reference m_rContext; public: FunctionBasedURPInstanceProvider( const css::uno::Reference& rxContext); // XInstanceProvider virtual css::uno::Reference SAL_CALL getInstance(const OUString& aName) override; }; // InstanceProvider FunctionBasedURPInstanceProvider::FunctionBasedURPInstanceProvider( const Reference& rxContext) : m_rContext(rxContext) { } Reference FunctionBasedURPInstanceProvider::getInstance(const OUString& aName) { Reference rInstance; if (aName == "StarOffice.ServiceManager") { rInstance.set(m_rContext->getServiceManager()); } else if (aName == "StarOffice.ComponentContext") { rInstance = m_rContext; } else if (aName == "StarOffice.NamingService") { Reference rNamingService( m_rContext->getServiceManager()->createInstanceWithContext( u"com.sun.star.uno.NamingService"_ustr, m_rContext), UNO_QUERY); if (rNamingService.is()) { rNamingService->registerObject(u"StarOffice.ServiceManager"_ustr, m_rContext->getServiceManager()); rNamingService->registerObject(u"StarOffice.ComponentContext"_ustr, m_rContext); rInstance = rNamingService; } } return rInstance; } class FunctionBasedURPConnection : public cppu::WeakImplHelper { public: explicit FunctionBasedURPConnection(void*, int (*)(void* pContext, const signed char* pBuffer, int nLen), void*, int (*)(void* pContext, signed char* pBuffer, int nLen)); ~FunctionBasedURPConnection(); // These overridden member functions use "read" and "write" from the point of view of LO, // i.e. the opposite to how startURP() uses them. virtual sal_Int32 SAL_CALL read(Sequence& rReadBytes, sal_Int32 nBytesToRead) override; virtual void SAL_CALL write(const Sequence& aData) override; virtual void SAL_CALL flush() override; virtual void SAL_CALL close() override; virtual OUString SAL_CALL getDescription() override; void setBridge(Reference); void* getContext(); inline static int g_connectionCount = 0; private: void* m_pRecieveFromLOContext; void* m_pSendURPToLOContext; int (*m_fnReceiveURPFromLO)(void* pContext, const signed char* pBuffer, int nLen); int (*m_fnSendURPToLO)(void* pContext, signed char* pBuffer, int nLen); Reference m_URPBridge; }; FunctionBasedURPConnection::FunctionBasedURPConnection( void* pRecieveFromLOContext, int (*fnReceiveURPFromLO)(void* pContext, const signed char* pBuffer, int nLen), void* pSendURPToLOContext, int (*fnSendURPToLO)(void* pContext, signed char* pBuffer, int nLen)) : m_pRecieveFromLOContext(pRecieveFromLOContext) , m_pSendURPToLOContext(pSendURPToLOContext) , m_fnReceiveURPFromLO(fnReceiveURPFromLO) , m_fnSendURPToLO(fnSendURPToLO) { g_connectionCount++; } FunctionBasedURPConnection::~FunctionBasedURPConnection() { Reference xComp(m_URPBridge, UNO_QUERY_THROW); xComp->dispose(); // TODO: check this doesn't deadlock } void* FunctionBasedURPConnection::getContext() { return this; } sal_Int32 FunctionBasedURPConnection::read(Sequence& rReadBytes, sal_Int32 nBytesToRead) { if (nBytesToRead < 0) return 0; if (rReadBytes.getLength() != nBytesToRead) rReadBytes.realloc(nBytesToRead); // As with osl::StreamPipe, we must always read nBytesToRead... return m_fnSendURPToLO(m_pSendURPToLOContext, rReadBytes.getArray(), nBytesToRead); } void FunctionBasedURPConnection::write(const Sequence& rData) { m_fnReceiveURPFromLO(m_pRecieveFromLOContext, rData.getConstArray(), rData.getLength()); } void FunctionBasedURPConnection::flush() {} void FunctionBasedURPConnection::close() { SAL_INFO("lok.urp", "Requested to close FunctionBasedURPConnection"); } OUString FunctionBasedURPConnection::getDescription() { return ""; } void FunctionBasedURPConnection::setBridge(Reference xBridge) { m_URPBridge = xBridge; } } static void* lo_startURP(LibreOfficeKit* /* pThis */, void* pRecieveFromLOContext, void* pSendToLOContext, int (*fnReceiveURPFromLO)(void* pContext, const signed char* pBuffer, int nLen), int (*fnSendURPToLO)(void* pContext, signed char* pBuffer, int nLen)) { // Here we will roughly do what desktop LO does when one passes a command-line switch like // --accept=socket,port=nnnn;urp;StarOffice.ServiceManager. Except that no listening socket will // be created. The communication to the URP will be through the nReceiveURPFromLO and nSendURPToLO // functions. rtl::Reference connection( new FunctionBasedURPConnection(pRecieveFromLOContext, fnReceiveURPFromLO, pSendToLOContext, fnSendURPToLO)); Reference xBridgeFactory = css::bridge::BridgeFactory::create(xContext); Reference xInstanceProvider(new FunctionBasedURPInstanceProvider(xContext)); Reference xBridge(xBridgeFactory->createBridge( "functionurp" + OUString::number(FunctionBasedURPConnection::g_connectionCount), u"urp"_ustr, connection, xInstanceProvider)); connection->setBridge(std::move(xBridge)); return connection->getContext(); } /** * Stop a function based URP connection that you started with lo_startURP above * * @param pSendToLOContext a pointer to the context returned by lo_startURP */ static void lo_stopURP(LibreOfficeKit* /* pThis */, void* pFunctionBasedURPConnection/* FunctionBasedURPConnection* */) { static_cast(pFunctionBasedURPConnection)->close(); } static void lo_registerCallback (LibreOfficeKit* pThis, LibreOfficeKitCallback pCallback, void* pData) { SolarMutexGuard aGuard; Application* pApp = GetpApp(); assert(pApp); LibLibreOffice_Impl* pLib = static_cast(pThis); pLib->maLastExceptionMsg.clear(); pApp->m_pCallback = pLib->mpCallback = pCallback; pApp->m_pCallbackData = pLib->mpCallbackData = pData; } static int doc_saveAs(LibreOfficeKitDocument* pThis, const char* sUrl, const char* pFormat, const char* pFilterOptions) { comphelper::ProfileZone aZone("doc_saveAs"); SolarMutexGuard aGuard; SetLastExceptionMsg(); LibLODocument_Impl* pDocument = static_cast(pThis); OUString sFormat = getUString(pFormat); OUString aURL(getAbsoluteURL(sUrl)); uno::Reference xStorable(pDocument->mxComponent, uno::UNO_QUERY_THROW); if (aURL.isEmpty()) { SetLastExceptionMsg(u"Filename to save to was not provided."_ustr); SAL_INFO("lok", "URL for save is empty"); return false; } try { std::span pMap; switch (doc_getDocumentType(pThis)) { case LOK_DOCTYPE_SPREADSHEET: pMap = aCalcExtensionMap; break; case LOK_DOCTYPE_PRESENTATION: pMap = aImpressExtensionMap; break; case LOK_DOCTYPE_DRAWING: pMap = aDrawExtensionMap; break; case LOK_DOCTYPE_TEXT: pMap = aWriterExtensionMap; break; case LOK_DOCTYPE_OTHER: default: SAL_INFO("lok", "Can't save document - unsupported document type."); return false; } if (pFormat == nullptr) { // sniff from the extension sal_Int32 idx = aURL.lastIndexOf("."); if( idx > 0 ) { sFormat = aURL.copy( idx + 1 ); } else { SetLastExceptionMsg("input URL '" + aURL + "' lacks a suffix"); return false; } } OUString aFilterName; for (const auto& item : pMap) { if (sFormat.equalsIgnoreAsciiCaseAscii(item.extn)) { aFilterName = item.filterName; break; } } if (aFilterName.isEmpty()) { SetLastExceptionMsg(u"no output filter found for provided suffix"_ustr); return false; } OUString aFilterOptions = getUString(pFilterOptions); // Check if watermark for pdf is passed by filteroptions... // It is not a real filter option so it must be filtered out. OUString watermarkText; std::u16string_view sFullSheetPreview; int aIndex = -1; if ((aIndex = aFilterOptions.indexOf(",Watermark=")) >= 0) { int bIndex = aFilterOptions.indexOf("WATERMARKEND"); watermarkText = aFilterOptions.subView(aIndex+11, bIndex-(aIndex+11)); aFilterOptions = OUString::Concat(aFilterOptions.subView(0, aIndex)) + aFilterOptions.subView(bIndex+12); } if ((aIndex = aFilterOptions.indexOf(",FullSheetPreview=")) >= 0) { int bIndex = aFilterOptions.indexOf("FULLSHEETPREVEND"); sFullSheetPreview = aFilterOptions.subView(aIndex+18, bIndex-(aIndex+18)); aFilterOptions = OUString::Concat(aFilterOptions.subView(0, aIndex)) + aFilterOptions.subView(bIndex+16); } bool bFullSheetPreview = sFullSheetPreview == u"true"; OUString filePassword; if ((aIndex = aFilterOptions.indexOf(",Password=")) >= 0) { int bIndex = aFilterOptions.indexOf("PASSWORDEND"); filePassword = aFilterOptions.subView(aIndex + 10, bIndex - (aIndex + 10)); aFilterOptions = OUString::Concat(aFilterOptions.subView(0, aIndex)) + aFilterOptions.subView(bIndex + 11); } OUString filePasswordToModify; if ((aIndex = aFilterOptions.indexOf(",PasswordToModify=")) >= 0) { int bIndex = aFilterOptions.indexOf("PASSWORDTOMODIFYEND"); filePassword = aFilterOptions.subView(aIndex + 18, bIndex - (aIndex + 18)); aFilterOptions = OUString::Concat(aFilterOptions.subView(0, aIndex)) + aFilterOptions.subView(bIndex + 19); } // Select a pdf version if specified a valid one. If not specified then ignore. // If invalid then fail. sal_Int32 pdfVer = 0; if ((aIndex = aFilterOptions.indexOf(",PDFVer=")) >= 0) { int bIndex = aFilterOptions.indexOf("PDFVEREND"); std::u16string_view sPdfVer = aFilterOptions.subView(aIndex+8, bIndex-(aIndex+8)); aFilterOptions = OUString::Concat(aFilterOptions.subView(0, aIndex)) + aFilterOptions.subView(bIndex+9); if (o3tl::equalsIgnoreAsciiCase(sPdfVer, u"PDF/A-1b")) pdfVer = 1; else if (o3tl::equalsIgnoreAsciiCase(sPdfVer, u"PDF/A-2b")) pdfVer = 2; else if (o3tl::equalsIgnoreAsciiCase(sPdfVer, u"PDF/A-3b")) pdfVer = 3; else if (o3tl::equalsIgnoreAsciiCase(sPdfVer, u"PDF-1.5")) pdfVer = 15; else if (o3tl::equalsIgnoreAsciiCase(sPdfVer, u"PDF-1.6")) pdfVer = 16; else { SetLastExceptionMsg(u"wrong PDF version"_ustr); return false; } } // 'TakeOwnership' == this is a 'real' SaveAs (that is, the document // gets a new name). When this is not provided, the meaning of // saveAs() is more like save-a-copy, which allows saving to any // random format like PDF or PNG. // It is not a real filter option, so we have to filter it out. const uno::Sequence aOptionSeq = comphelper::string::convertCommaSeparated(aFilterOptions); std::vector aFilteredOptionVec; bool bTakeOwnership = false; MediaDescriptor aSaveMediaDescriptor; for (const auto& rOption : aOptionSeq) { if (rOption == "TakeOwnership") bTakeOwnership = true; else if (rOption == "NoFileSync") aSaveMediaDescriptor[u"NoFileSync"_ustr] <<= true; else aFilteredOptionVec.push_back(rOption); } aSaveMediaDescriptor[u"Overwrite"_ustr] <<= true; aSaveMediaDescriptor[u"FilterName"_ustr] <<= aFilterName; auto aFilteredOptionSeq = comphelper::containerToSequence(aFilteredOptionVec); aFilterOptions = comphelper::string::convertCommaSeparated(aFilteredOptionSeq); aSaveMediaDescriptor[MediaDescriptor::PROP_FILTEROPTIONS] <<= aFilterOptions; comphelper::SequenceAsHashMap aFilterDataMap; // If filter options is JSON string, then make sure aFilterDataMap stays empty, otherwise we // would ignore the filter options. if (!aFilterOptions.startsWith("{")) { setFormatSpecificFilterData(sFormat, aFilterDataMap); } if (!watermarkText.isEmpty()) aFilterDataMap[u"TiledWatermark"_ustr] <<= watermarkText; if (bFullSheetPreview) aFilterDataMap[u"SinglePageSheets"_ustr] <<= true; if (pdfVer) aFilterDataMap[u"SelectPdfVersion"_ustr] <<= pdfVer; if (!aFilterDataMap.empty()) { aSaveMediaDescriptor[u"FilterData"_ustr] <<= aFilterDataMap.getAsConstPropertyValueList(); } if (!filePassword.isEmpty()) aSaveMediaDescriptor[u"Password"_ustr] <<= filePassword; if (!filePasswordToModify.isEmpty()) aSaveMediaDescriptor[u"PasswordToModify"_ustr] <<= filePasswordToModify; // add interaction handler too if (gImpl) { // gImpl does not have to exist when running from a unit test rtl::Reference const pInteraction( new LOKInteractionHandler("saveas"_ostr, gImpl, pDocument)); uno::Reference const xInteraction(pInteraction); aSaveMediaDescriptor[MediaDescriptor::PROP_INTERACTIONHANDLER] <<= xInteraction; } if (bTakeOwnership) xStorable->storeAsURL(aURL, aSaveMediaDescriptor.getAsConstPropertyValueList()); else xStorable->storeToURL(aURL, aSaveMediaDescriptor.getAsConstPropertyValueList()); return true; } catch (const uno::Exception& exception) { SetLastExceptionMsg("exception: " + exception.Message); } return false; } /** * Initialize UNO commands, in the sense that from now on, the LOK client gets updates for status * changes of these commands. This is necessary, because (unlike in the desktop case) there are no * toolbars hosting widgets these UNO commands, so no such status updates would be sent to the * headless LOK clients out of the box. */ static void doc_iniUnoCommands () { SolarMutexGuard aGuard; SetLastExceptionMsg(); static constexpr OUString sUnoCommands[] = { u".uno:AlignLeft"_ustr, u".uno:AlignHorizontalCenter"_ustr, u".uno:AlignRight"_ustr, u".uno:BackColor"_ustr, u".uno:BackgroundColor"_ustr, u".uno:TableCellBackgroundColor"_ustr, u".uno:Bold"_ustr, u".uno:CenterPara"_ustr, u".uno:CharBackColor"_ustr, u".uno:CharBackgroundExt"_ustr, u".uno:CharFontName"_ustr, u".uno:Color"_ustr, u".uno:ControlCodes"_ustr, u".uno:DecrementIndent"_ustr, u".uno:DefaultBullet"_ustr, u".uno:DefaultNumbering"_ustr, u".uno:FontColor"_ustr, u".uno:FontHeight"_ustr, u".uno:IncrementIndent"_ustr, u".uno:Italic"_ustr, u".uno:JustifyPara"_ustr, u".uno:JumpToMark"_ustr, u".uno:OutlineFont"_ustr, u".uno:LeftPara"_ustr, u".uno:LanguageStatus"_ustr, u".uno:RightPara"_ustr, u".uno:Shadowed"_ustr, u".uno:SubScript"_ustr, u".uno:SuperScript"_ustr, u".uno:Strikeout"_ustr, u".uno:StyleApply"_ustr, u".uno:Underline"_ustr, u".uno:ModifiedStatus"_ustr, u".uno:Undo"_ustr, u".uno:Redo"_ustr, u".uno:InsertPage"_ustr, u".uno:DeletePage"_ustr, u".uno:DuplicatePage"_ustr, u".uno:InsertSlide"_ustr, u".uno:DeleteSlide"_ustr, u".uno:DuplicateSlide"_ustr, u".uno:ChangeTheme"_ustr, u".uno:Cut"_ustr, u".uno:Copy"_ustr, u".uno:Paste"_ustr, u".uno:SelectAll"_ustr, u".uno:ReplyComment"_ustr, u".uno:ResolveComment"_ustr, u".uno:ResolveCommentThread"_ustr, u".uno:InsertRowsBefore"_ustr, u".uno:InsertRowsAfter"_ustr, u".uno:InsertColumnsBefore"_ustr, u".uno:InsertColumnsAfter"_ustr, u".uno:DeleteRows"_ustr, u".uno:DeleteColumns"_ustr, u".uno:DeleteTable"_ustr, u".uno:SelectTable"_ustr, u".uno:EntireRow"_ustr, u".uno:EntireColumn"_ustr, u".uno:EntireCell"_ustr, u".uno:AssignLayout"_ustr, u".uno:StatusDocPos"_ustr, u".uno:RowColSelCount"_ustr, u".uno:StatusPageStyle"_ustr, u".uno:InsertMode"_ustr, u".uno:SpellOnline"_ustr, u".uno:StatusSelectionMode"_ustr, u".uno:StateTableCell"_ustr, u".uno:StatusBarFunc"_ustr, u".uno:StatePageNumber"_ustr, u".uno:StateWordCount"_ustr, u".uno:SelectionMode"_ustr, u".uno:PageStatus"_ustr, u".uno:LayoutStatus"_ustr, u".uno:Scale"_ustr, u".uno:Context"_ustr, u".uno:WrapText"_ustr, u".uno:ToggleMergeCells"_ustr, u".uno:NumberFormatCurrency"_ustr, u".uno:NumberFormatPercent"_ustr, u".uno:NumberFormatDecimal"_ustr, u".uno:NumberFormatIncDecimals"_ustr, u".uno:NumberFormatDecDecimals"_ustr, u".uno:NumberFormatDate"_ustr, u".uno:EditHeaderAndFooter"_ustr, u".uno:FrameLineColor"_ustr, u".uno:SortAscending"_ustr, u".uno:SortDescending"_ustr, u".uno:TrackChanges"_ustr, u".uno:ShowTrackedChanges"_ustr, u".uno:NextTrackedChange"_ustr, u".uno:PreviousTrackedChange"_ustr, u".uno:AcceptAllTrackedChanges"_ustr, u".uno:RejectAllTrackedChanges"_ustr, u".uno:TableDialog"_ustr, u".uno:FormatCellDialog"_ustr, u".uno:FontDialog"_ustr, u".uno:ParagraphDialog"_ustr, u".uno:OutlineBullet"_ustr, u".uno:InsertIndexesEntry"_ustr, u".uno:DocumentRepair"_ustr, u".uno:TransformDialog"_ustr, u".uno:InsertPageHeader"_ustr, u".uno:InsertPageFooter"_ustr, u".uno:OnlineAutoFormat"_ustr, u".uno:InsertObjectChart"_ustr, u".uno:InsertSection"_ustr, u".uno:InsertAnnotation"_ustr, u".uno:DeleteAnnotation"_ustr, u".uno:InsertPagebreak"_ustr, u".uno:InsertColumnBreak"_ustr, u".uno:HyperlinkDialog"_ustr, u".uno:InsertSymbol"_ustr, u".uno:EditRegion"_ustr, u".uno:ThesaurusDialog"_ustr, u".uno:FormatArea"_ustr, u".uno:FormatLine"_ustr, u".uno:FormatColumns"_ustr, u".uno:Watermark"_ustr, u".uno:ResetAttributes"_ustr, u".uno:Orientation"_ustr, u".uno:ObjectAlignLeft"_ustr, u".uno:ObjectAlignRight"_ustr, u".uno:AlignCenter"_ustr, u".uno:TransformPosX"_ustr, u".uno:TransformPosY"_ustr, u".uno:TransformWidth"_ustr, u".uno:TransformHeight"_ustr, u".uno:ObjectBackOne"_ustr, u".uno:SendToBack"_ustr, u".uno:ObjectForwardOne"_ustr, u".uno:BringToFront"_ustr, u".uno:WrapRight"_ustr, u".uno:WrapThrough"_ustr, u".uno:WrapLeft"_ustr, u".uno:WrapIdeal"_ustr, u".uno:WrapOn"_ustr, u".uno:WrapOff"_ustr, u".uno:UpdateCurIndex"_ustr, u".uno:InsertCaptionDialog"_ustr, u".uno:FormatGroup"_ustr, u".uno:SplitTable"_ustr, u".uno:SplitCell"_ustr, u".uno:MergeCells"_ustr, u".uno:DeleteNote"_ustr, u".uno:AcceptChanges"_ustr, u".uno:FormatPaintbrush"_ustr, u".uno:SetDefault"_ustr, u".uno:ParaLeftToRight"_ustr, u".uno:ParaRightToLeft"_ustr, u".uno:ParaspaceIncrease"_ustr, u".uno:ParaspaceDecrease"_ustr, u".uno:AcceptTrackedChange"_ustr, u".uno:RejectTrackedChange"_ustr, u".uno:ShowResolvedAnnotations"_ustr, u".uno:InsertBreak"_ustr, u".uno:InsertEndnote"_ustr, u".uno:InsertFootnote"_ustr, u".uno:InsertReferenceField"_ustr, u".uno:InsertBookmark"_ustr, u".uno:InsertAuthoritiesEntry"_ustr, u".uno:InsertMultiIndex"_ustr, u".uno:InsertField"_ustr, u".uno:PageNumberWizard"_ustr, u".uno:InsertPageNumberField"_ustr, u".uno:InsertPageCountField"_ustr, u".uno:InsertDateField"_ustr, u".uno:InsertTitleField"_ustr, u".uno:InsertFieldCtrl"_ustr, u".uno:CharmapControl"_ustr, u".uno:EnterGroup"_ustr, u".uno:LeaveGroup"_ustr, u".uno:AlignUp"_ustr, u".uno:AlignMiddle"_ustr, u".uno:AlignDown"_ustr, u".uno:TraceChangeMode"_ustr, u".uno:Combine"_ustr, u".uno:Merge"_ustr, u".uno:Dismantle"_ustr, u".uno:Substract"_ustr, u".uno:DistributeSelection"_ustr, u".uno:Intersect"_ustr, u".uno:BorderInner"_ustr, u".uno:BorderOuter"_ustr, u".uno:FreezePanes"_ustr, u".uno:FreezePanesColumn"_ustr, u".uno:FreezePanesRow"_ustr, u".uno:Sidebar"_ustr, u".uno:SheetRightToLeft"_ustr, u".uno:RunMacro"_ustr, u".uno:SpacePara1"_ustr, u".uno:SpacePara15"_ustr, u".uno:SpacePara2"_ustr, u".uno:InsertSparkline"_ustr, u".uno:DeleteSparkline"_ustr, u".uno:DeleteSparklineGroup"_ustr, u".uno:EditSparklineGroup"_ustr, u".uno:EditSparkline"_ustr, u".uno:GroupSparklines"_ustr, u".uno:UngroupSparklines"_ustr, u".uno:FormatSparklineMenu"_ustr, u".uno:DataDataPilotRun"_ustr, u".uno:RecalcPivotTable"_ustr, u".uno:DeletePivotTable"_ustr, u".uno:Protect"_ustr, u".uno:UnsetCellsReadOnly"_ustr, u".uno:ContentControlProperties"_ustr, u".uno:InsertCheckboxContentControl"_ustr, u".uno:InsertContentControl"_ustr, u".uno:InsertDateContentControl"_ustr, u".uno:InsertDropdownContentControl"_ustr, u".uno:InsertPlainTextContentControl"_ustr, u".uno:InsertPictureContentControl"_ustr, u".uno:DataFilterAutoFilter"_ustr, u".uno:CellProtection"_ustr, u".uno:MoveKeepInsertMode"_ustr }; util::URL aCommandURL; SfxViewShell* pViewShell = SfxViewShell::Current(); SfxViewFrame* pViewFrame = pViewShell ? &pViewShell->GetViewFrame() : nullptr; // check if Frame-Controller were created. if (!pViewFrame) { SAL_WARN("lok", "iniUnoCommands: No Frame-Controller created."); return; } if (!xContext.is()) xContext = comphelper::getProcessComponentContext(); if (!xContext.is()) { SAL_WARN("lok", "iniUnoCommands: Component context is not available"); return; } #if !defined IOS && !defined ANDROID && !defined __EMSCRIPTEN__ uno::Reference xSEInitializer = xml::crypto::SEInitializer::create(xContext); if (!xSEInitializer.is()) { SAL_WARN("lok", "iniUnoCommands: XSEInitializer is not available"); return; } uno::Reference xSecurityContext = xSEInitializer->createSecurityContext(OUString()); if (!xSecurityContext.is()) { SAL_WARN("lok", "iniUnoCommands: failed to create security context"); } #endif SfxSlotPool& rSlotPool = SfxSlotPool::GetSlotPool(pViewFrame); uno::Reference xParser(util::URLTransformer::create(xContext)); for (const auto & sUnoCommand : sUnoCommands) { aCommandURL.Complete = sUnoCommand; xParser->parseStrict(aCommandURL); // when null, this command is not supported by the given component // (like eg. Calc does not have ".uno:DefaultBullet" etc.) if (const SfxSlot* pSlot = rSlotPool.GetUnoSlot(aCommandURL.Path)) { // Initialize slot to dispatch .uno: Command. pViewFrame->GetBindings().GetDispatch(pSlot, aCommandURL, false); } } } static int doc_getDocumentType (LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_getDocumentType"); SolarMutexGuard aGuard; return getDocumentType(pThis); } static int doc_getParts (LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_getParts"); SolarMutexGuard aGuard; ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return 0; } return pDoc->getParts(); } static int doc_getPart (LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_getPart"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return 0; } return pDoc->getPart(); } static void doc_setPartImpl(LibreOfficeKitDocument* pThis, int nPart, bool bAllowChangeFocus = true) { comphelper::ProfileZone aZone("doc_setPart"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pDoc->setPart( nPart, bAllowChangeFocus ); } static void doc_setPart(LibreOfficeKitDocument* pThis, int nPart) { doc_setPartImpl(pThis, nPart, true); } static char* doc_getPartInfo(LibreOfficeKitDocument* pThis, int nPart) { comphelper::ProfileZone aZone("doc_getPartInfo"); SolarMutexGuard aGuard; ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } return convertOUString(pDoc->getPartInfo(nPart)); } static void doc_selectPart(LibreOfficeKitDocument* pThis, int nPart, int nSelect) { SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pDoc->selectPart( nPart, nSelect ); } static void doc_moveSelectedParts(LibreOfficeKitDocument* pThis, int nPosition, bool bDuplicate) { SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pDoc->moveSelectedParts(nPosition, bDuplicate); } static char* doc_getPartPageRectangles(LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_getPartPageRectangles"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } return convertOUString(pDoc->getPartPageRectangles()); } static char* doc_getA11yFocusedParagraph(LibreOfficeKitDocument* pThis) { SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } if (SfxViewShell* pViewShell = SfxViewShell::Current()) { return convertOUString(pViewShell->getA11yFocusedParagraph()); } return nullptr; } static int doc_getA11yCaretPosition(LibreOfficeKitDocument* pThis) { SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return -1; } if (SfxViewShell* pViewShell = SfxViewShell::Current()) { return pViewShell->getA11yCaretPosition(); } return -1; } static char* doc_getPartName(LibreOfficeKitDocument* pThis, int nPart) { comphelper::ProfileZone aZone("doc_getPartName"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } return convertOUString(pDoc->getPartName(nPart)); } static char* doc_getPartHash(LibreOfficeKitDocument* pThis, int nPart) { comphelper::ProfileZone aZone("doc_getPartHash"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } return convertOUString(pDoc->getPartHash(nPart)); } static void doc_setPartMode(LibreOfficeKitDocument* pThis, int nPartMode) { comphelper::ProfileZone aZone("doc_setPartMode"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } int nCurrentPart = pDoc->getPart(); pDoc->setPartMode(nPartMode); // We need to make sure the internal state is updated, just changing the mode // might not update the relevant shells (i.e. impress will keep rendering the // previous mode unless we do this). // TODO: we might want to do this within the relevant components rather than // here, but that's also dependent on how we implement embedded object // rendering I guess? // TODO: we could be clever and e.g. set to 0 when we change to/from // embedded object mode, and not when changing between slide/notes/combined // modes? if ( nCurrentPart < pDoc->getParts() ) { pDoc->setPart( nCurrentPart ); } else { pDoc->setPart( 0 ); } } static int doc_getEditMode(LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_getEditMode"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return 0; } return pDoc->getEditMode(); } static void doc_paintTile(LibreOfficeKitDocument* pThis, unsigned char* pBuffer, const int nCanvasWidth, const int nCanvasHeight, const int nTilePosX, const int nTilePosY, const int nTileWidth, const int nTileHeight) { comphelper::ProfileZone aZone("doc_paintTile"); SolarMutexGuard aGuard; SetLastExceptionMsg(); SAL_INFO( "lok.tiledrendering", "paintTile: painting [" << nTileWidth << "x" << nTileHeight << "]@(" << nTilePosX << ", " << nTilePosY << ") to [" << nCanvasWidth << "x" << nCanvasHeight << "]px" ); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } #if defined(UNX) && !defined(MACOSX) || defined(_WIN32) // Painting of zoomed or HiDPI spreadsheets is special, we actually draw everything at 100%, // and only set cairo's (or CoreGraphic's, in the iOS case) scale factor accordingly, so that // everything is painted bigger or smaller. This is different to what Calc's internal scaling // would do - because that one is trying to fit the lines between cells to integer multiples of // pixels. comphelper::ScopeGuard dpiScaleGuard([]() { comphelper::LibreOfficeKit::setDPIScale(1.0); }); #if defined(IOS) double fDPIScale = 1.0; // Onine uses the LOK_TILEMODE_RGBA by default so flip the normal flags // to kCGImageAlphaPremultipliedLast | kCGImageByteOrder32Big CGContextRef pCGContext = CGBitmapContextCreate(pBuffer, nCanvasWidth, nCanvasHeight, 8, nCanvasWidth * 4, CGColorSpaceCreateDeviceRGB(), kCGImageAlphaPremultipliedLast | kCGImageByteOrder32Big); CGContextTranslateCTM(pCGContext, 0, nCanvasHeight); CGContextScaleCTM(pCGContext, fDPIScale, -fDPIScale); SAL_INFO( "lok.tiledrendering", "doc_paintTile: painting [" << nTileWidth << "x" << nTileHeight << "]@(" << nTilePosX << ", " << nTilePosY << ") to [" << nCanvasWidth << "x" << nCanvasHeight << "]px" ); Size aCanvasSize(nCanvasWidth, nCanvasHeight); SystemGraphicsData aData; aData.rCGContext = reinterpret_cast(pCGContext); ScopedVclPtrInstance pDevice(aData, Size(1, 1), DeviceFormat::WITHOUT_ALPHA); pDevice->SetBackground(Wallpaper(COL_TRANSPARENT)); pDevice->SetOutputSizePixel(aCanvasSize); pDoc->paintTile(*pDevice, aCanvasSize.Width(), aCanvasSize.Height(), nTilePosX, nTilePosY, nTileWidth, nTileHeight); CGContextRelease(pCGContext); #else ScopedVclPtrInstance< VirtualDevice > pDevice(DeviceFormat::WITHOUT_ALPHA); // Set background to transparent by default. pDevice->SetBackground(Wallpaper(COL_TRANSPARENT)); pDevice->SetOutputSizePixelScaleOffsetAndLOKBuffer( Size(nCanvasWidth, nCanvasHeight), Fraction(1.0), Point(), pBuffer); pDoc->paintTile(*pDevice, nCanvasWidth, nCanvasHeight, nTilePosX, nTilePosY, nTileWidth, nTileHeight); static bool bDebug = getenv("LOK_DEBUG_TILES") != nullptr; if (bDebug) { // Draw a small red rectangle in the top left corner so that it's easy to see where a new tile begins. tools::Rectangle aRect(0, 0, 5, 5); aRect = pDevice->PixelToLogic(aRect); pDevice->Push(PushFlags::FILLCOLOR | PushFlags::LINECOLOR); pDevice->SetFillColor(COL_LIGHTRED); pDevice->SetLineColor(); pDevice->DrawRect(aRect); pDevice->Pop(); } #ifdef _WIN32 // pBuffer was not used there pDevice->EnableMapMode(false); BitmapEx aBmpEx = pDevice->GetBitmapEx({ 0, 0 }, { nCanvasWidth, nCanvasHeight }); Bitmap aBmp = aBmpEx.GetBitmap(); AlphaMask aAlpha = aBmpEx.GetAlphaMask(); BitmapScopedReadAccess sraBmp(aBmp); BitmapScopedReadAccess sraAlpha(aAlpha); assert(sraBmp->Height() == nCanvasHeight); assert(sraBmp->Width() == nCanvasWidth); assert(!sraAlpha || sraBmp->Height() == sraAlpha->Height()); assert(!sraAlpha || sraBmp->Width() == sraAlpha->Width()); auto p = pBuffer; for (tools::Long y = 0; y < sraBmp->Height(); ++y) { Scanline dataBmp = sraBmp->GetScanline(y); Scanline dataAlpha = sraAlpha ? sraAlpha->GetScanline(y) : nullptr; for (tools::Long x = 0; x < sraBmp->Width(); ++x) { BitmapColor color = sraBmp->GetPixelFromData(dataBmp, x); sal_uInt8 alpha = dataAlpha ? sraAlpha->GetPixelFromData(dataAlpha, x).GetBlue() : 255; *p++ = color.GetBlue(); *p++ = color.GetGreen(); *p++ = color.GetRed(); *p++ = alpha; } } #endif #endif #else (void) pBuffer; #endif } static void doc_paintPartTile(LibreOfficeKitDocument* pThis, unsigned char* pBuffer, const int nPart, const int nMode, const int nCanvasWidth, const int nCanvasHeight, const int nTilePosX, const int nTilePosY, const int nTileWidth, const int nTileHeight) { comphelper::ProfileZone aZone("doc_paintPartTile"); SolarMutexGuard aGuard; SetLastExceptionMsg(); SAL_INFO( "lok.tiledrendering", "paintPartTile: painting @ " << nPart << " : " << nMode << " [" << nTileWidth << "x" << nTileHeight << "]@(" << nTilePosX << ", " << nTilePosY << ") to [" << nCanvasWidth << "x" << nCanvasHeight << "]px" ); LibLODocument_Impl* pDocument = static_cast(pThis); int nOrigViewId = doc_getView(pThis); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } if (nOrigViewId < 0) { // tile painting always needs a SfxViewShell::Current(), but actually // it does not really matter which one - all of them should paint the // same thing. It's important to get a view for the correct document, // though. // doc_getViewsCount() returns the count of views for the document in the current view. int viewCount = doc_getViewsCount(pThis); if (viewCount == 0) return; std::vector viewIds(viewCount); doc_getViewIds(pThis, viewIds.data(), viewCount); nOrigViewId = viewIds[0]; doc_setView(pThis, nOrigViewId); } // Disable callbacks while we are painting. if (nOrigViewId >= 0) { const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nOrigViewId); if (handlerIt != pDocument->mpCallbackFlushHandlers.end()) handlerIt->second->disableCallbacks(); } try { // Text documents have a single coordinate system; don't change part. int nOrigPart = 0; const int aType = doc_getDocumentType(pThis); const bool isText = (aType == LOK_DOCTYPE_TEXT); const bool isCalc = (aType == LOK_DOCTYPE_SPREADSHEET); int nOrigEditMode = 0; bool bPaintTextEdit = true; int nViewId = nOrigViewId; int nLastNonEditorView = -1; int nViewMatchingMode = -1; SfxViewShell* pCurrentViewShell = SfxViewShell::Current(); if (!isText) { // Check if just switching to another view is enough, that has // less side-effects. if (nPart != doc_getPart(pThis) || nMode != pDoc->getEditMode()) { SfxViewShell* pViewShell = SfxViewShell::GetFirst(); while (pViewShell) { bool bIsInEdit = pViewShell->GetDrawView() && pViewShell->GetDrawView()->GetTextEditOutliner(); OString sCurrentViewRenderState = pDoc->getViewRenderState(pCurrentViewShell); OString sNewRenderState = pDoc->getViewRenderState(pViewShell); if (sCurrentViewRenderState == sNewRenderState && !bIsInEdit) nLastNonEditorView = pViewShell->GetViewShellId().get(); if (pViewShell->getPart() == nPart && pViewShell->getEditMode() == nMode && sCurrentViewRenderState == sNewRenderState && !bIsInEdit) { nViewId = pViewShell->GetViewShellId().get(); nViewMatchingMode = nViewId; nLastNonEditorView = nViewId; doc_setView(pThis, nViewId); break; } else if (pViewShell->getEditMode() == nMode && sCurrentViewRenderState == sNewRenderState && !bIsInEdit) { nViewMatchingMode = pViewShell->GetViewShellId().get(); } pViewShell = SfxViewShell::GetNext(*pViewShell); } } // if not found view with correct part // - at least avoid rendering active textbox, This is for Impress. // - prefer view with the same mode if (nViewMatchingMode >= 0 && nViewMatchingMode != nViewId) { nViewId = nViewMatchingMode; doc_setView(pThis, nViewId); } else if (!isCalc && nLastNonEditorView >= 0 && nLastNonEditorView != nViewId && pCurrentViewShell && pCurrentViewShell->GetDrawView() && pCurrentViewShell->GetDrawView()->GetTextEditOutliner()) { nViewId = nLastNonEditorView; doc_setView(pThis, nViewId); } // Disable callbacks while we are painting - after setting the view if (nViewId != nOrigViewId && nViewId >= 0) { const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nViewId); if (handlerIt != pDocument->mpCallbackFlushHandlers.end()) handlerIt->second->disableCallbacks(); } nOrigPart = doc_getPart(pThis); if (nPart != nOrigPart) { doc_setPartImpl(pThis, nPart, false); } nOrigEditMode = pDoc->getEditMode(); if (nOrigEditMode != nMode) { SfxLokHelper::setEditMode(nMode, pDoc); } bPaintTextEdit = (nPart == nOrigPart && nMode == nOrigEditMode); pDoc->setPaintTextEdit(bPaintTextEdit); } doc_paintTile(pThis, pBuffer, nCanvasWidth, nCanvasHeight, nTilePosX, nTilePosY, nTileWidth, nTileHeight); if (!isText) { pDoc->setPaintTextEdit(true); if (nMode != nOrigEditMode) { SfxLokHelper::setEditMode(nOrigEditMode, pDoc); } if (nPart != nOrigPart) { doc_setPartImpl(pThis, nOrigPart, false); } if (nViewId != nOrigViewId) { if (nViewId >= 0) { const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nViewId); if (handlerIt != pDocument->mpCallbackFlushHandlers.end()) handlerIt->second->enableCallbacks(); } doc_setView(pThis, nOrigViewId); } } } catch (const std::exception&) { // Nothing to do but restore the PartTilePainting flag. } if (nOrigViewId >= 0) { const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nOrigViewId); if (handlerIt != pDocument->mpCallbackFlushHandlers.end()) handlerIt->second->enableCallbacks(); } } static int doc_getTileMode(SAL_UNUSED_PARAMETER LibreOfficeKitDocument* /*pThis*/) { SetLastExceptionMsg(); #if ENABLE_CAIRO_RGBA || defined IOS return LOK_TILEMODE_RGBA; #else return LOK_TILEMODE_BGRA; #endif } static void doc_getDocumentSize(LibreOfficeKitDocument* pThis, long* pWidth, long* pHeight) { comphelper::ProfileZone aZone("doc_getDocumentSize"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (pDoc) { Size aDocumentSize = pDoc->getDocumentSize(); *pWidth = aDocumentSize.Width(); *pHeight = aDocumentSize.Height(); } else { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); } } static void doc_getDataArea(LibreOfficeKitDocument* pThis, long nTab, long* pCol, long* pRow) { comphelper::ProfileZone aZone("doc_getDataArea"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (pDoc) { Size aDocumentSize = pDoc->getDataArea(nTab); *pCol = aDocumentSize.Width(); *pRow = aDocumentSize.Height(); } else { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); } } static void doc_initializeForRendering(LibreOfficeKitDocument* pThis, const char* pArguments) { comphelper::ProfileZone aZone("doc_initializeForRendering"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (pDoc) { doc_iniUnoCommands(); pDoc->initializeForTiledRendering( comphelper::containerToSequence(jsonToPropertyValuesVector(pArguments))); } } static void doc_registerCallback(LibreOfficeKitDocument* pThis, LibreOfficeKitCallback pCallback, void* pData) { SolarMutexGuard aGuard; SetLastExceptionMsg(); LibLODocument_Impl* pDocument = static_cast(pThis); const int nView = SfxLokHelper::getView(); if (nView < 0) return; const size_t nId = nView; if (pCallback != nullptr) { for (auto& pair : pDocument->mpCallbackFlushHandlers) { if (pair.first == nId) continue; pair.second->addViewStates(nView); } } else { for (auto& pair : pDocument->mpCallbackFlushHandlers) { if (pair.first == nId) continue; pair.second->removeViewStates(nView); } } pDocument->mpCallbackFlushHandlers[nView] = std::make_shared(pThis, pCallback, pData); if (pCallback != nullptr) { for (const auto& pair : pDocument->mpCallbackFlushHandlers) { if (pair.first == nId) continue; pDocument->mpCallbackFlushHandlers[nView]->addViewStates(pair.first); } if (SfxViewShell* pViewShell = SfxViewShell::Current()) { pDocument->mpCallbackFlushHandlers[nView]->setViewId(pViewShell->GetViewShellId().get()); pViewShell->setLibreOfficeKitViewCallback(pDocument->mpCallbackFlushHandlers[nView].get()); } if (pDocument->maFontsMissing.size() != 0) { OString sPayload = "{ \"fontsmissing\": [ "_ostr; bool bFirst = true; for (const auto &f : pDocument->maFontsMissing) { if (bFirst) bFirst = false; else sPayload += ", "; sPayload += "\"" + f.toUtf8() + "\""; } sPayload += " ] }"; pCallback(LOK_CALLBACK_FONTS_MISSING, sPayload.getStr(), pData); pDocument->maFontsMissing.clear(); } } else { if (SfxViewShell* pViewShell = SfxViewShell::Current()) { pViewShell->setLibreOfficeKitViewCallback(nullptr); pDocument->mpCallbackFlushHandlers[nView]->setViewId(-1); } } } /// Returns the JSON representation of all the comments in the document static char* getPostIts(LibreOfficeKitDocument* pThis) { SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } tools::JsonWriter aJsonWriter; pDoc->getPostIts(aJsonWriter); return convertOString(aJsonWriter.finishAndGetAsOString()); } /// Returns the JSON representation of the positions of all the comments in the document static char* getPostItsPos(LibreOfficeKitDocument* pThis) { SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } tools::JsonWriter aJsonWriter; pDoc->getPostItsPos(aJsonWriter); return convertOString(aJsonWriter.finishAndGetAsOString()); } static char* getRulerState(LibreOfficeKitDocument* pThis) { SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } tools::JsonWriter aJsonWriter; pDoc->getRulerState(aJsonWriter); return convertOString(aJsonWriter.finishAndGetAsOString()); } static void doc_postKeyEvent(LibreOfficeKitDocument* pThis, int nType, int nCharCode, int nKeyCode) { comphelper::ProfileZone aZone("doc_postKeyEvent"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } try { pDoc->postKeyEvent(nType, nCharCode, nKeyCode); } catch (const uno::Exception& exception) { SetLastExceptionMsg(exception.Message); SAL_INFO("lok", "Failed to postKeyEvent " << exception.Message); } } static void doc_setBlockedCommandList(LibreOfficeKitDocument* /*pThis*/, int nViewId, const char* blockedCommandList) { SolarMutexGuard aGuard; SfxLokHelper::setBlockedCommandList(nViewId, blockedCommandList); } static void doc_postWindowExtTextInputEvent(LibreOfficeKitDocument* pThis, unsigned nWindowId, int nType, const char* pText) { comphelper::ProfileZone aZone("doc_postWindowExtTextInputEvent"); SolarMutexGuard aGuard; VclPtr pWindow; if (nWindowId == 0) { ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pWindow = pDoc->getDocWindow(); } else { pWindow = vcl::Window::FindLOKWindow(nWindowId); } if (!pWindow) { SetLastExceptionMsg("No window found for window id: " + OUString::number(nWindowId)); return; } SfxLokHelper::postExtTextEventAsync(pWindow, nType, OUString::fromUtf8(std::string_view(pText, strlen(pText)))); } static char* doc_hyperlinkInfoAtPosition(LibreOfficeKitDocument* pThis, int x, int y) { SolarMutexGuard aGuard; ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg("Document doesn't support tiled rendering"); return nullptr; } return convertOUString(pDoc->hyperlinkInfoAtPosition(x, y)); } static void doc_removeTextContext(LibreOfficeKitDocument* pThis, unsigned nLOKWindowId, int nCharBefore, int nCharAfter) { SolarMutexGuard aGuard; VclPtr pWindow; if (nLOKWindowId == 0) { ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pWindow = pDoc->getDocWindow(); } else { pWindow = vcl::Window::FindLOKWindow(nLOKWindowId); } if (!pWindow) { SetLastExceptionMsg("No window found for window id: " + OUString::number(nLOKWindowId)); return; } // Annoyingly - backspace and delete are handled in the apps via an accelerator // which are PostMessage'd by SfxViewShell::ExecKey_Impl so to stay in the same // order we do this synchronously here, unless we're in a dialog. if (nCharBefore > 0) { // backspace if (nLOKWindowId == 0) { KeyEvent aEvt(8, KEY_BACKSPACE); for (int i = 0; i < nCharBefore; ++i) pWindow->KeyInput(aEvt); } else SfxLokHelper::postKeyEventAsync(pWindow, LOK_KEYEVENT_KEYINPUT, 8, KEY_BACKSPACE, nCharBefore - 1); } if (nCharAfter > 0) { // delete (forward) if (nLOKWindowId == 0) { KeyEvent aEvt(46, KEY_DELETE); for (int i = 0; i < nCharAfter; ++i) pWindow->KeyInput(aEvt); } else SfxLokHelper::postKeyEventAsync(pWindow, LOK_KEYEVENT_KEYINPUT, 46, KEY_DELETE, nCharAfter - 1); } } static void doc_postWindowKeyEvent(LibreOfficeKitDocument* /*pThis*/, unsigned nLOKWindowId, int nType, int nCharCode, int nKeyCode) { comphelper::ProfileZone aZone("doc_postWindowKeyEvent"); SolarMutexGuard aGuard; SetLastExceptionMsg(); VclPtr pWindow = vcl::Window::FindLOKWindow(nLOKWindowId); if (!pWindow) { SetLastExceptionMsg(u"Document doesn't support dialog rendering, or window not found."_ustr); return; } KeyEvent aEvent(nCharCode, nKeyCode, 0); switch (nType) { case LOK_KEYEVENT_KEYINPUT: Application::PostKeyEvent(VclEventId::WindowKeyInput, pWindow, &aEvent); break; case LOK_KEYEVENT_KEYUP: Application::PostKeyEvent(VclEventId::WindowKeyUp, pWindow, &aEvent); break; default: assert(false); break; } } static size_t doc_renderShapeSelection(LibreOfficeKitDocument* pThis, char** pOutput) { comphelper::ProfileZone aZone("doc_renderShapeSelection"); SolarMutexGuard aGuard; SetLastExceptionMsg(); LokChartHelper aChartHelper(SfxViewShell::Current()); if (aChartHelper.GetWindow()) return 0; try { LibLODocument_Impl* pDocument = static_cast(pThis); uno::Reference xStorable(pDocument->mxComponent, uno::UNO_QUERY_THROW); SvMemoryStream aOutStream; uno::Reference xOut = new utl::OOutputStreamWrapper(aOutStream); utl::MediaDescriptor aMediaDescriptor; switch (doc_getDocumentType(pThis)) { case LOK_DOCTYPE_PRESENTATION: aMediaDescriptor[u"FilterName"_ustr] <<= u"impress_svg_Export"_ustr; break; case LOK_DOCTYPE_DRAWING: aMediaDescriptor[u"FilterName"_ustr] <<= u"draw_svg_Export"_ustr; break; case LOK_DOCTYPE_TEXT: aMediaDescriptor[u"FilterName"_ustr] <<= u"writer_svg_Export"_ustr; break; case LOK_DOCTYPE_SPREADSHEET: aMediaDescriptor[u"FilterName"_ustr] <<= u"calc_svg_Export"_ustr; break; default: SAL_WARN("lok", "Failed to render shape selection: Document type is not supported"); } aMediaDescriptor[u"SelectionOnly"_ustr] <<= true; aMediaDescriptor[u"OutputStream"_ustr] <<= xOut; aMediaDescriptor[u"IsPreview"_ustr] <<= true; // will down-scale graphics xStorable->storeToURL(u"private:stream"_ustr, aMediaDescriptor.getAsConstPropertyValueList()); if (pOutput) { const size_t nOutputSize = aOutStream.GetEndOfData(); *pOutput = static_cast(malloc(nOutputSize)); if (*pOutput) { std::memcpy(*pOutput, aOutStream.GetData(), nOutputSize); return nOutputSize; } } } catch (const uno::Exception& exception) { css::uno::Any exAny( cppu::getCaughtException() ); SetLastExceptionMsg(exception.Message); SAL_WARN("lok", "Failed to render shape selection: " << exceptionToString(exAny)); } return 0; } namespace { /** Class to react on finishing of a dispatched command. This will call a LOK_COMMAND_FINISHED callback when postUnoCommand was called with the parameter requesting the notification. @see LibreOfficeKitCallbackType::LOK_CALLBACK_UNO_COMMAND_RESULT. */ class DispatchResultListener : public cppu::WeakImplHelper { const OString maCommand; ///< Command for which this is the result. const std::shared_ptr mpCallback; ///< Callback to call. const std::chrono::steady_clock::time_point mSaveTime; //< The time we started saving. const bool mbWasModified; //< Whether or not the document was modified before saving. public: DispatchResultListener(const char* pCommand, std::shared_ptr pCallback) : maCommand(pCommand) , mpCallback(std::move(pCallback)) , mSaveTime(std::chrono::steady_clock::now()) , mbWasModified(SfxObjectShell::Current()->IsModified()) { assert(mpCallback); } virtual void SAL_CALL dispatchFinished(const css::frame::DispatchResultEvent& rEvent) override { tools::JsonWriter aJson; aJson.put("commandName", maCommand); if (rEvent.State != frame::DispatchResultState::DONTKNOW) { bool bSuccess = (rEvent.State == frame::DispatchResultState::SUCCESS); aJson.put("success", bSuccess); } unoAnyToJson(aJson, "result", rEvent.Result); aJson.put("wasModified", mbWasModified); aJson.put("startUnixTimeMics", std::chrono::time_point_cast(mSaveTime) .time_since_epoch() .count()); aJson.put("saveDurationMics", std::chrono::duration_cast( std::chrono::steady_clock::now() - mSaveTime) .count()); mpCallback->queue(LOK_CALLBACK_UNO_COMMAND_RESULT, aJson.finishAndGetAsOString()); } virtual void SAL_CALL disposing(const css::lang::EventObject&) override {} }; } // anonymous namespace static void lcl_sendDialogEvent(unsigned long long int nWindowId, const char* pArguments) { SolarMutexGuard aGuard; StringMap aMap(jsdialog::jsonToStringMap(pArguments)); if (aMap.find(u"id"_ustr) == aMap.end()) return; sal_uInt64 nCurrentShellId = reinterpret_cast(SfxViewShell::Current()); try { OUString sControlId = aMap[u"id"_ustr]; OUString sWindowId = OUString::number(nWindowId); OUString sCurrentShellId = OUString::number(nCurrentShellId); // special values for window id if (nWindowId == static_cast(-1)) sWindowId = sCurrentShellId + "sidebar"; if (nWindowId == static_cast(-2)) sWindowId = sCurrentShellId + "notebookbar"; if (nWindowId == static_cast(-3)) sWindowId = sCurrentShellId + "formulabar"; // dialogs send own id but notebookbar and sidebar controls are remembered by SfxViewShell id if (jsdialog::ExecuteAction(sWindowId, sControlId, aMap)) return; if (jsdialog::ExecuteAction(sCurrentShellId + "sidebar", sControlId, aMap)) return; if (jsdialog::ExecuteAction(sCurrentShellId + "notebookbar", sControlId, aMap)) return; if (jsdialog::ExecuteAction(sCurrentShellId + "formulabar", sControlId, aMap)) return; // this is needed for dialogs shown before document is loaded: MacroWarning dialog, etc... // these dialogs are created with WindowId "0" if (!SfxViewShell::Current() && jsdialog::ExecuteAction(u"0"_ustr, sControlId, aMap)) return; // force resend - used in mobile-wizard jsdialog::SendFullUpdate(sCurrentShellId + "sidebar", u"Panel"_ustr); } catch(...) {} } static void doc_sendDialogEvent(LibreOfficeKitDocument* /*pThis*/, unsigned long long int nWindowId, const char* pArguments) { lcl_sendDialogEvent(nWindowId, pArguments); } static void lo_sendDialogEvent(LibreOfficeKit* /*pThis*/, unsigned long long int nWindowId, const char* pArguments) { lcl_sendDialogEvent(nWindowId, pArguments); } static void lo_setOption(LibreOfficeKit* /*pThis*/, const char *pOption, const char* pValue) { static char* pCurrentSalLogOverride = nullptr; if (strcmp(pOption, "traceeventrecording") == 0) { if (strcmp(pValue, "start") == 0) { comphelper::TraceEvent::setBufferSizeAndCallback(100, TraceEventDumper::flushRecordings); comphelper::TraceEvent::startRecording(); if (traceEventDumper == nullptr) traceEventDumper = new TraceEventDumper(); } else if (strcmp(pValue, "stop") == 0) comphelper::TraceEvent::stopRecording(); } else if (strcmp(pOption, "sallogoverride") == 0) { if (pCurrentSalLogOverride != nullptr) free(pCurrentSalLogOverride); if (pValue == nullptr) pCurrentSalLogOverride = nullptr; else pCurrentSalLogOverride = strdup(pValue); if (pCurrentSalLogOverride == nullptr || pCurrentSalLogOverride[0] == '\0') sal_detail_set_log_selector(nullptr); else sal_detail_set_log_selector(pCurrentSalLogOverride); } #ifdef LINUX else if (strcmp(pOption, "addfont") == 0) { if (memcmp(pValue, "file://", 7) == 0) pValue += 7; int fd = open(pValue, O_RDONLY); if (fd == -1) { std::cerr << "Could not open font file '" << pValue << "': " << strerror(errno) << std::endl; return; } OUString sMagicFileName = "file:///:FD:/" + OUString::number(fd); OutputDevice *pDevice = Application::GetDefaultDevice(); OutputDevice::ImplClearAllFontData(false); pDevice->AddTempDevFont(sMagicFileName, ""); OutputDevice::ImplRefreshAllFontData(false); } #endif } static void lo_dumpState (LibreOfficeKit* pThis, const char* /* pOptions */, char** pState) { if (!pState) return; // NB. no SolarMutexGuard since this may be caused in some extremis / deadlock SetLastExceptionMsg(); *pState = nullptr; OStringBuffer aState(4096*256); LibLibreOffice_Impl* pLib = static_cast(pThis); pLib->dumpState(aState); *pState = convertOString(aState.makeStringAndClear()); } void LibLibreOffice_Impl::dumpState(rtl::OStringBuffer &rState) { rState.append("LibreOfficeKit state:" "\n\tLastExceptionMsg:\t"); rState.append(rtl::OUStringToOString(maLastExceptionMsg, RTL_TEXTENCODING_UTF8)); rState.append("\n\tUnipoll:\t"); rState.append(vcl::lok::isUnipoll() ? "yes" : "no: events on thread"); rState.append("\n\tOptionalFeatures:\t0x"); rState.append(static_cast(mOptionalFeatures), 16); rState.append("\n\tCallbackData:\t0x"); rState.append(reinterpret_cast(mpCallback), 16); // TODO: dump mInteractionMap SfxLokHelper::dumpState(rState); vcl::lok::dumpState(rState); } static void doc_postUnoCommand(LibreOfficeKitDocument* pThis, const char* pCommand, const char* pArguments, bool bNotifyWhenFinished) { comphelper::ProfileZone aZone("doc_postUnoCommand"); SolarMutexGuard aGuard; SetLastExceptionMsg(); SfxObjectShell* pDocSh = SfxObjectShell::Current(); OUString aCommand(pCommand, strlen(pCommand), RTL_TEXTENCODING_UTF8); LibLODocument_Impl* pDocument = static_cast(pThis); std::vector aPropertyValuesVector(jsonToPropertyValuesVector(pArguments)); if (!vcl::lok::isUnipoll()) { beans::PropertyValue aSynchronMode; aSynchronMode.Name = u"SynchronMode"_ustr; aSynchronMode.Value <<= false; aPropertyValuesVector.push_back(aSynchronMode); } int nView = SfxLokHelper::getView(); if (nView < 0) return; if (gImpl && aCommand == ".uno:ToggleOrientation") { ExecuteOrientationChange(); return; } // handle potential interaction if (gImpl && aCommand == ".uno:Save") { // Check if saving a PDF file OUString aMimeType = lcl_getCurrentDocumentMimeType(pDocument); if (pDocSh && pDocSh->IsModified() && aMimeType == "application/pdf") { // If we have a PDF file (for saving annotations for example), we need // to run save-as to the same file as the opened document. Plain save // doesn't work as the PDF is not a "native" format. uno::Reference xStorable(pDocument->mxComponent, uno::UNO_QUERY_THROW); OUString aURL = xStorable->getLocation(); OString aURLUtf8 = OUStringToOString(aURL, RTL_TEXTENCODING_UTF8); bool bResult = doc_saveAs(pThis, aURLUtf8.getStr(), "pdf", nullptr); // Send the result of save tools::JsonWriter aJson; aJson.put("commandName", pCommand); aJson.put("success", bResult); pDocument->mpCallbackFlushHandlers[nView]->queue(LOK_CALLBACK_UNO_COMMAND_RESULT, aJson.finishAndGetAsOString()); return; } rtl::Reference const pInteraction( new LOKInteractionHandler("save"_ostr, gImpl, pDocument)); uno::Reference const xInteraction(pInteraction); beans::PropertyValue aValue; aValue.Name = u"InteractionHandler"_ustr; aValue.Value <<= xInteraction; aPropertyValuesVector.push_back(aValue); bool bDontSaveIfUnmodified = false; std::erase_if(aPropertyValuesVector, [&bDontSaveIfUnmodified](const beans::PropertyValue& aItem){ if (aItem.Name == "DontSaveIfUnmodified") { bDontSaveIfUnmodified = aItem.Value.get(); return true; } return false; }); // skip saving and tell the result via UNO_COMMAND_RESULT if (bDontSaveIfUnmodified && (!pDocSh || !pDocSh->IsModified())) { tools::JsonWriter aJson; aJson.put("commandName", pCommand); aJson.put("success", false); // Add the reason for not saving { auto resultNode = aJson.startNode("result"); aJson.put("type", "string"); aJson.put("value", "unmodified"); } pDocument->mpCallbackFlushHandlers[nView]->queue(LOK_CALLBACK_UNO_COMMAND_RESULT, aJson.finishAndGetAsOString()); return; } } else if (gImpl && aCommand == ".uno:TransformDialog") { bool bNeedConversion = false; SfxViewShell* pViewShell = SfxViewShell::Current(); LokChartHelper aChartHelper(pViewShell); if (aChartHelper.GetWindow() ) { bNeedConversion = true; } else if (const SdrView* pView = pViewShell->GetDrawView()) { if (OutputDevice* pOutputDevice = pView->GetFirstOutputDevice()) { bNeedConversion = (pOutputDevice->GetMapMode().GetMapUnit() == MapUnit::Map100thMM); } } if (bNeedConversion) { sal_Int32 value; for (beans::PropertyValue& rPropValue: aPropertyValuesVector) { if (rPropValue.Name == "TransformPosX" || rPropValue.Name == "TransformPosY" || rPropValue.Name == "TransformWidth" || rPropValue.Name == "TransformHeight" || rPropValue.Name == "TransformRotationX" || rPropValue.Name == "TransformRotationY") { rPropValue.Value >>= value; value = o3tl::convert(value, o3tl::Length::twip, o3tl::Length::mm100); rPropValue.Value <<= value; } } } if (aChartHelper.GetWindow() && aPropertyValuesVector.size() > 0) { if (aPropertyValuesVector[0].Name != "Action") { tools::Rectangle aChartBB = aChartHelper.GetChartBoundingBox(); int nLeft = o3tl::convert(aChartBB.Left(), o3tl::Length::twip, o3tl::Length::mm100); int nTop = o3tl::convert(aChartBB.Top(), o3tl::Length::twip, o3tl::Length::mm100); for (beans::PropertyValue& rPropValue: aPropertyValuesVector) { if (rPropValue.Name == "TransformPosX" || rPropValue.Name == "TransformRotationX") { auto const value = *o3tl::doAccess(rPropValue.Value); rPropValue.Value <<= value - nLeft; } else if (rPropValue.Name == "TransformPosY" || rPropValue.Name == "TransformRotationY") { auto const value = *o3tl::doAccess(rPropValue.Value); rPropValue.Value <<= value - nTop; } } } util::URL aCommandURL; aCommandURL.Path = u"LOKTransform"_ustr; css::uno::Reference& aChartDispatcher = aChartHelper.GetXDispatcher(); aChartDispatcher->dispatch(aCommandURL, comphelper::containerToSequence(aPropertyValuesVector)); return; } } else if (gImpl && aCommand == ".uno:LOKSidebarWriterPage") { setupSidebar(u"WriterPageDeck"); return; } else if (gImpl && aCommand == ".uno:SidebarShow") { setupSidebar(); return; } else if (gImpl && aCommand == ".uno:SidebarHide") { hideSidebar(); return; } bool bResult = false; LokChartHelper aChartHelper(SfxViewShell::Current()); if (aChartHelper.GetWindow() && aCommand != ".uno:Save" ) { util::URL aCommandURL; aCommandURL.Path = aCommand.copy(5); css::uno::Reference& aChartDispatcher = aChartHelper.GetXDispatcher(); aChartDispatcher->dispatch(aCommandURL, comphelper::containerToSequence(aPropertyValuesVector)); return; } if (LokStarMathHelper aMathHelper(SfxViewShell::Current()); aMathHelper.GetGraphicWindow() && aCommand != ".uno:Save") { aMathHelper.Dispatch(aCommand, comphelper::containerToSequence(aPropertyValuesVector)); return; } if (bNotifyWhenFinished && pDocument->mpCallbackFlushHandlers.count(nView)) { bResult = comphelper::dispatchCommand(aCommand, comphelper::containerToSequence(aPropertyValuesVector), new DispatchResultListener(pCommand, pDocument->mpCallbackFlushHandlers[nView])); } else bResult = comphelper::dispatchCommand(aCommand, comphelper::containerToSequence(aPropertyValuesVector)); if (!bResult) { SetLastExceptionMsg("Failed to dispatch " + aCommand); } } static void doc_postMouseEvent(LibreOfficeKitDocument* pThis, int nType, int nX, int nY, int nCount, int nButtons, int nModifier) { comphelper::ProfileZone aZone("doc_postMouseEvent"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } try { pDoc->postMouseEvent(nType, nX, nY, nCount, nButtons, nModifier); } catch (const uno::Exception& exception) { SetLastExceptionMsg(exception.Message); SAL_INFO("lok", "Failed to postMouseEvent " << exception.Message); } } static void doc_postWindowMouseEvent(LibreOfficeKitDocument* /*pThis*/, unsigned nLOKWindowId, int nType, int nX, int nY, int nCount, int nButtons, int nModifier) { comphelper::ProfileZone aZone("doc_postWindowMouseEvent"); SolarMutexGuard aGuard; SetLastExceptionMsg(); VclPtr pWindow = vcl::Window::FindLOKWindow(nLOKWindowId); if (!pWindow) { SetLastExceptionMsg(u"Document doesn't support dialog rendering, or window not found."_ustr); return; } const Point aPos(nX, nY); MouseEvent aEvent(aPos, nCount, MouseEventModifiers::SIMPLECLICK, nButtons, nModifier); vcl::EnableDialogInput(pWindow); switch (nType) { case LOK_MOUSEEVENT_MOUSEBUTTONDOWN: Application::PostMouseEvent(VclEventId::WindowMouseButtonDown, pWindow, &aEvent); break; case LOK_MOUSEEVENT_MOUSEBUTTONUP: Application::PostMouseEvent(VclEventId::WindowMouseButtonUp, pWindow, &aEvent); break; case LOK_MOUSEEVENT_MOUSEMOVE: Application::PostMouseEvent(VclEventId::WindowMouseMove, pWindow, &aEvent); break; default: assert(false); break; } } static void doc_postWindowGestureEvent(LibreOfficeKitDocument* /*pThis*/, unsigned nLOKWindowId, const char* pType, int nX, int nY, int nOffset) { comphelper::ProfileZone aZone("doc_postWindowGestureEvent"); SolarMutexGuard aGuard; SetLastExceptionMsg(); VclPtr pWindow = vcl::Window::FindLOKWindow(nLOKWindowId); if (!pWindow) { SetLastExceptionMsg(u"Document doesn't support dialog rendering, or window not found."_ustr); return; } OString aType(pType); GestureEventPanType eEventType = GestureEventPanType::Update; if (aType == "panBegin") eEventType = GestureEventPanType::Begin; else if (aType == "panEnd") eEventType = GestureEventPanType::End; GestureEventPan aEvent { sal_Int32(nX), sal_Int32(nY), eEventType, sal_Int32(nOffset), PanningOrientation::Vertical, }; vcl::EnableDialogInput(pWindow); Application::PostGestureEvent(VclEventId::WindowGestureEvent, pWindow, &aEvent); } static void doc_setTextSelection(LibreOfficeKitDocument* pThis, int nType, int nX, int nY) { comphelper::ProfileZone aZone("doc_setTextSelection"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pDoc->setTextSelection(nType, nX, nY); } static void doc_setWindowTextSelection(LibreOfficeKitDocument* /*pThis*/, unsigned nLOKWindowId, bool swap, int nX, int nY) { comphelper::ProfileZone aZone("doc_setWindowTextSelection"); SolarMutexGuard aGuard; SetLastExceptionMsg(); VclPtr pWindow = vcl::Window::FindLOKWindow(nLOKWindowId); if (!pWindow) { SetLastExceptionMsg(u"Document doesn't support dialog rendering, or window not found."_ustr); return; } Size aOffset(pWindow->GetOutOffXPixel(), pWindow->GetOutOffYPixel()); Point aCursorPos(nX, nY); aCursorPos.Move(aOffset); sal_uInt16 nModifier = swap ? KEY_MOD1 + KEY_MOD2 : KEY_SHIFT; MouseEvent aCursorEvent(aCursorPos, 1, MouseEventModifiers::SIMPLECLICK, 0, nModifier); Application::PostMouseEvent(VclEventId::WindowMouseButtonDown, pWindow, &aCursorEvent); Application::PostMouseEvent(VclEventId::WindowMouseButtonUp, pWindow, &aCursorEvent); } static bool getFromTransferable( const css::uno::Reference &xTransferable, const OString &aInMimeType, OString &aRet); static bool encodeImageAsHTML( const css::uno::Reference &xTransferable, const OString &aMimeType, OString &aRet) { if (!getFromTransferable(xTransferable, aMimeType, aRet)) return false; // Encode in base64. auto aSeq = Sequence(reinterpret_cast(aRet.getStr()), aRet.getLength()); OStringBuffer aBase64Data; comphelper::Base64::encode(aBase64Data, aSeq); // Embed in HTML. aRet = "\n" "" "" "

"; return true; } static bool encodeTextAsHTML( const css::uno::Reference &xTransferable, const OString &aMimeType, OString &aRet) { if (!getFromTransferable(xTransferable, aMimeType, aRet)) return false; // Embed in HTML - FIXME: needs some escaping. aRet = "\n" "" "

" + aRet + "

"; return true; } static bool getFromTransferable( const css::uno::Reference &xTransferable, const OString &aInMimeType, OString &aRet) { OString aMimeType(aInMimeType); // Take care of UTF-8 text here. bool bConvert = false; sal_Int32 nIndex = 0; if (o3tl::getToken(aMimeType, 0, ';', nIndex) == "text/plain") { if (o3tl::getToken(aMimeType, 0, ';', nIndex) == "charset=utf-8") { aMimeType = "text/plain;charset=utf-16"_ostr; bConvert = true; } } datatransfer::DataFlavor aFlavor; aFlavor.MimeType = OUString::fromUtf8(aMimeType); if (aMimeType == "text/plain;charset=utf-16") aFlavor.DataType = cppu::UnoType::get(); else aFlavor.DataType = cppu::UnoType< uno::Sequence >::get(); if (!xTransferable->isDataFlavorSupported(aFlavor)) { // Try harder for HTML it is our copy/paste meta-file format if (aInMimeType == "text/html") { // Desperate measures - convert text to HTML instead. if (encodeTextAsHTML(xTransferable, "text/plain;charset=utf-8"_ostr, aRet)) return true; // If html is not supported, might be a graphic-selection, if (encodeImageAsHTML(xTransferable, "image/png"_ostr, aRet)) return true; } SetLastExceptionMsg("Flavor " + aFlavor.MimeType + " is not supported"); return false; } uno::Any aAny; try { aAny = xTransferable->getTransferData(aFlavor); } catch (const css::datatransfer::UnsupportedFlavorException& e) { SetLastExceptionMsg("Unsupported flavor " + aFlavor.MimeType + " exception " + e.Message); return false; } catch (const css::uno::Exception& e) { SetLastExceptionMsg("Exception getting " + aFlavor.MimeType + " exception " + e.Message); return false; } if (aFlavor.DataType == cppu::UnoType::get()) { OUString aString; aAny >>= aString; if (bConvert) aRet = OUStringToOString(aString, RTL_TEXTENCODING_UTF8); else aRet = OString(reinterpret_cast(aString.getStr()), aString.getLength() * sizeof(sal_Unicode)); } else { uno::Sequence aSequence; aAny >>= aSequence; aRet = OString(reinterpret_cast(aSequence.getConstArray()), aSequence.getLength()); } return true; } static char* doc_getTextSelection(LibreOfficeKitDocument* pThis, const char* pMimeType, char** pUsedMimeType) { comphelper::ProfileZone aZone("doc_getTextSelection"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return nullptr; } css::uno::Reference xTransferable = pDoc->getSelection(); if (!xTransferable) { SetLastExceptionMsg(u"No selection available"_ustr); return nullptr; } OString aType = pMimeType && pMimeType[0] != '\0' ? OString(pMimeType) : "text/plain;charset=utf-8"_ostr; OString aRet; bool bSuccess = getFromTransferable(xTransferable, aType, aRet); if (!bSuccess) return nullptr; if (pUsedMimeType) // legacy { if (pMimeType) *pUsedMimeType = strdup(pMimeType); else *pUsedMimeType = nullptr; } return convertOString(aRet); } static int doc_getSelectionType(LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_getSelectionType"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return LOK_SELTYPE_NONE; } css::uno::Reference xTransferable = pDoc->getSelection(); if (!xTransferable) { SetLastExceptionMsg(u"No selection available"_ustr); return LOK_SELTYPE_NONE; } css::uno::Reference xTransferable2(xTransferable, css::uno::UNO_QUERY); if (xTransferable2.is() && xTransferable2->isComplex()) return LOK_SELTYPE_COMPLEX; OString aRet; bool bSuccess = getFromTransferable(xTransferable, "text/plain;charset=utf-8"_ostr, aRet); if (!bSuccess) return LOK_SELTYPE_NONE; if (aRet.getLength() > 10000) return LOK_SELTYPE_COMPLEX; return !aRet.isEmpty() ? LOK_SELTYPE_TEXT : LOK_SELTYPE_NONE; } static int doc_getSelectionTypeAndText(LibreOfficeKitDocument* pThis, const char* pMimeType, char** pText, char** pUsedMimeType) { // The purpose of this function is to avoid double call to pDoc->getSelection(), // which may be expensive. comphelper::ProfileZone aZone("doc_getSelectionTypeAndText"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return LOK_SELTYPE_NONE; } css::uno::Reference xTransferable = pDoc->getSelection(); if (!xTransferable) { SetLastExceptionMsg(u"No selection available"_ustr); return LOK_SELTYPE_NONE; } css::uno::Reference xTransferable2(xTransferable, css::uno::UNO_QUERY); if (xTransferable2.is() && xTransferable2->isComplex()) return LOK_SELTYPE_COMPLEX; OString aType = pMimeType && pMimeType[0] != '\0' ? OString(pMimeType) : "text/plain;charset=utf-8"_ostr; OString aRet; bool bSuccess = getFromTransferable(xTransferable, aType, aRet); if (!bSuccess) return LOK_SELTYPE_NONE; if (aRet.getLength() > 10000) return LOK_SELTYPE_COMPLEX; if (aRet.isEmpty()) return LOK_SELTYPE_NONE; if (pText) *pText = convertOString(aRet); if (pUsedMimeType) // legacy { if (pMimeType) *pUsedMimeType = strdup(pMimeType); else *pUsedMimeType = nullptr; } return LOK_SELTYPE_TEXT; } static int doc_getClipboard(LibreOfficeKitDocument* pThis, const char **pMimeTypes, size_t *pOutCount, char ***pOutMimeTypes, size_t **pOutSizes, char ***pOutStreams) { #ifdef IOS (void) pThis; (void) pMimeTypes; (void) pOutCount; (void) pOutMimeTypes; (void) pOutSizes; (void) pOutStreams; assert(!"doc_getClipboard should not be called on iOS"); return 0; #else comphelper::ProfileZone aZone("doc_getClipboard"); SolarMutexGuard aGuard; SetLastExceptionMsg(); assert (pOutCount); assert (pOutMimeTypes); assert (pOutSizes); assert (pOutStreams); *pOutCount = 0; *pOutMimeTypes = nullptr; *pOutSizes = nullptr; *pOutStreams = nullptr; ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return 0; } rtl::Reference xClip(LOKClipboardFactory::getClipboardForCurView()); css::uno::Reference xTransferable = xClip->getContents(); SAL_INFO("lok", "Got from clip: " << xClip.get() << " transferable: " << xTransferable); if (!xTransferable) { SetLastExceptionMsg(u"No clipboard content available"_ustr); return 0; } std::vector aMimeTypes; if (!pMimeTypes) // everything { const uno::Sequence< css::datatransfer::DataFlavor > flavors = xTransferable->getTransferDataFlavors(); if (!flavors.getLength()) { SetLastExceptionMsg(u"Flavourless selection"_ustr); return 0; } for (const auto &it : flavors) aMimeTypes.push_back(OUStringToOString(it.MimeType, RTL_TEXTENCODING_UTF8)); } else { for (size_t i = 0; pMimeTypes[i]; ++i) aMimeTypes.push_back(OString(pMimeTypes[i])); } *pOutCount = aMimeTypes.size(); *pOutSizes = static_cast(malloc(*pOutCount * sizeof(size_t))); *pOutMimeTypes = static_cast(malloc(*pOutCount * sizeof(char *))); *pOutStreams = static_cast(malloc(*pOutCount * sizeof(char *))); for (size_t i = 0; i < aMimeTypes.size(); ++i) { if (aMimeTypes[i] == "text/plain;charset=utf-16") (*pOutMimeTypes)[i] = strdup("text/plain;charset=utf-8"); else (*pOutMimeTypes)[i] = convertOString(aMimeTypes[i]); OString aRet; bool bSuccess = getFromTransferable(xTransferable, (*pOutMimeTypes)[i], aRet); if (!bSuccess || aRet.getLength() < 1) { (*pOutSizes)[i] = 0; (*pOutStreams)[i] = nullptr; } else { (*pOutSizes)[i] = aRet.getLength(); (*pOutStreams)[i] = convertOString(aRet); } } return 1; #endif } static int doc_setClipboard(LibreOfficeKitDocument* pThis, const size_t nInCount, const char **pInMimeTypes, const size_t *pInSizes, const char **pInStreams) { #ifdef IOS (void) pThis; (void) nInCount; (void) pInMimeTypes; (void) pInSizes; (void) pInStreams; #else comphelper::ProfileZone aZone("doc_setClipboard"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return false; } uno::Reference xTransferable(new LOKTransferable(nInCount, pInMimeTypes, pInSizes, pInStreams)); auto xClip = forceSetClipboardForCurrentView(pThis); xClip->setContents(xTransferable, uno::Reference()); SAL_INFO("lok", "Set clip: " << xClip.get() << " to: " << xTransferable); if (!pDoc->isMimeTypeSupported()) { SetLastExceptionMsg(u"Document doesn't support this mime type"_ustr); return false; } #endif return true; } static bool doc_paste(LibreOfficeKitDocument* pThis, const char* pMimeType, const char* pData, size_t nSize) { comphelper::ProfileZone aZone("doc_paste"); SolarMutexGuard aGuard; const char *pInMimeTypes[1]; const char *pInStreams[1]; size_t pInSizes[1]; pInMimeTypes[0] = pMimeType; pInSizes[0] = nSize; pInStreams[0] = pData; if (!doc_setClipboard(pThis, 1, pInMimeTypes, pInSizes, pInStreams)) return false; uno::Sequence aPropertyValues(comphelper::InitPropertySequence( { {"AnchorType", uno::Any(static_cast(css::text::TextContentAnchorType_AS_CHARACTER))}, {"IgnoreComments", uno::Any(true)}, })); if (!comphelper::dispatchCommand(u".uno:Paste"_ustr, aPropertyValues)) { SetLastExceptionMsg(u"Failed to dispatch the .uno: command"_ustr); return false; } return true; } static void doc_setGraphicSelection(LibreOfficeKitDocument* pThis, int nType, int nX, int nY) { comphelper::ProfileZone aZone("doc_setGraphicSelection"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pDoc->setGraphicSelection(nType, nX, nY); } static void doc_resetSelection(LibreOfficeKitDocument* pThis) { comphelper::ProfileZone aZone("doc_resetSelection"); SolarMutexGuard aGuard; SetLastExceptionMsg(); ITiledRenderable* pDoc = getTiledRenderable(pThis); if (!pDoc) { SetLastExceptionMsg(u"Document doesn't support tiled rendering"_ustr); return; } pDoc->resetSelection(); } static char* getDocReadOnly(LibreOfficeKitDocument* pThis) { LibLODocument_Impl* pDocument = static_cast(pThis); if (!pDocument) return nullptr; SfxBaseModel* pBaseModel = dynamic_cast(pDocument->mxComponent.get()); if (!pBaseModel) return nullptr; SfxObjectShell* pObjectShell = pBaseModel->GetObjectShell(); if (!pObjectShell) return nullptr; boost::property_tree::ptree aTree; aTree.put("commandName", ".uno:ReadOnly"); aTree.put("success", pObjectShell->IsLoadReadonly()); std::stringstream aStream; boost::property_tree::write_json(aStream, aTree); char* pJson = static_cast(malloc(aStream.str().size() + 1)); if (!pJson) return nullptr; strcpy(pJson, aStream.str().c_str()); pJson[aStream.str().size()] = '\0'; return pJson; } static void addLocale(boost::property_tree::ptree& rValues, css::lang::Locale const & rLocale) { boost::property_tree::ptree aChild; const LanguageTag aLanguageTag( rLocale ); OUString sLanguage = SvtLanguageTable::GetLanguageString(aLanguageTag.getLanguageType()); if (sLanguage.endsWith("}")) return; sLanguage += ";" + aLanguageTag.getBcp47(false); aChild.put("", sLanguage.toUtf8()); rValues.push_back(std::make_pair("", aChild)); } static char* getLanguages(const char* pCommand) { css::uno::Sequence< css::lang::Locale > aLocales; css::uno::Sequence< css::lang::Locale > aGrammarLocales; if (xContext.is()) { // SpellChecker css::uno::Reference xLangSrv = css::linguistic2::LinguServiceManager::create(xContext); if (xLangSrv.is()) { css::uno::Reference xSpell = xLangSrv->getSpellChecker(); if (xSpell.is()) aLocales = xSpell->getLocales(); } // LanguageTool if (LanguageToolCfg::IsEnabled::get()) { uno::Reference< linguistic2::XProofreader > xGC( xContext->getServiceManager()->createInstanceWithContext(u"org.openoffice.lingu.LanguageToolGrammarChecker"_ustr, xContext), uno::UNO_QUERY_THROW ); uno::Reference< linguistic2::XSupportedLocales > xSuppLoc( xGC, uno::UNO_QUERY_THROW ); aGrammarLocales = xSuppLoc->getLocales(); } } boost::property_tree::ptree aTree; aTree.put("commandName", pCommand); boost::property_tree::ptree aValues; for ( css::lang::Locale const & rLocale : std::as_const(aLocales) ) addLocale(aValues, rLocale); for ( css::lang::Locale const & rLocale : std::as_const(aGrammarLocales) ) addLocale(aValues, rLocale); aTree.add_child("commandValues", aValues); std::stringstream aStream; boost::property_tree::write_json(aStream, aTree); char* pJson = static_cast(malloc(aStream.str().size() + 1)); assert(pJson); // Don't handle OOM conditions strcpy(pJson, aStream.str().c_str()); pJson[aStream.str().size()] = '\0'; return pJson; } static char* getFonts (const char* pCommand) { SfxObjectShell* pDocSh = SfxObjectShell::Current(); if (!pDocSh) return nullptr; const SvxFontListItem* pFonts = static_cast( pDocSh->GetItem(SID_ATTR_CHAR_FONTLIST)); const FontList* pList = pFonts ? pFonts->GetFontList() : nullptr; boost::property_tree::ptree aTree; aTree.put("commandName", pCommand); boost::property_tree::ptree aValues; if ( pList ) { sal_uInt16 nFontCount = pList->GetFontNameCount(); for (sal_uInt16 i = 0; i < nFontCount; ++i) { boost::property_tree::ptree aChildren; const FontMetric& rFontMetric = pList->GetFontName(i); const int* pAry = FontList::GetStdSizeAry(); sal_uInt16 nSizeCount = 0; while (pAry[nSizeCount]) { boost::property_tree::ptree aChild; aChild.put("", static_cast(pAry[nSizeCount]) / 10); aChildren.push_back(std::make_pair("", aChild)); nSizeCount++; } aValues.add_child(rFontMetric.GetFamilyName().toUtf8().getStr(), aChildren); } } aTree.add_child("commandValues", aValues); std::stringstream aStream; boost::property_tree::write_json(aStream, aTree); char* pJson = static_cast(malloc(aStream.str().size() + 1)); assert(pJson); // Don't handle OOM conditions strcpy(pJson, aStream.str().c_str()); pJson[aStream.str().size()] = '\0'; return pJson; } static char* getFontSubset (std::string_view aFontName) { OUString aFoundFont(::rtl::Uri::decode(OStringToOUString(aFontName, RTL_TEXTENCODING_UTF8), rtl_UriDecodeStrict, RTL_TEXTENCODING_UTF8)); boost::property_tree::ptree aTree; aTree.put("commandName", ".uno:FontSubset"); boost::property_tree::ptree aValues; if (const vcl::Font* pFont = FindFont(aFoundFont)) { FontCharMapRef xFontCharMap (new FontCharMap()); auto aDevice(VclPtr::Create(DeviceFormat::WITHOUT_ALPHA)); aDevice->SetFont(*pFont); aDevice->GetFontCharMap(xFontCharMap); SubsetMap aSubMap(xFontCharMap); for (auto const& subset : aSubMap.GetSubsetMap()) { boost::property_tree::ptree aChild; aChild.put("", static_cast(ublock_getCode(subset.GetRangeMin()))); aValues.push_back(std::make_pair("", aChild)); } } aTree.add_child("commandValues", aValues); std::stringstream aStream; boost::property_tree::write_json(aStream, aTree); char* pJson = static_cast(malloc(aStream.str().size() + 1)); assert(pJson); // Don't handle OOM conditions strcpy(pJson, aStream.str().c_str()); pJson[aStream.str().size()] = '\0'; return pJson; } static char* getStyles(LibreOfficeKitDocument* pThis, const char* pCommand) { LibLODocument_Impl* pDocument = static_cast(pThis); boost::property_tree::ptree aTree; aTree.put("commandName", pCommand); uno::Reference xStyleFamiliesSupplier(pDocument->mxComponent, uno::UNO_QUERY); const uno::Reference xStyleFamilies = xStyleFamiliesSupplier->getStyleFamilies(); const uno::Sequence aStyleFamilies = xStyleFamilies->getElementNames(); static constexpr OUString aWriterStyles[] = { u"Text body"_ustr, u"Quotations"_ustr, u"Title"_ustr, u"Subtitle"_ustr, u"Heading 1"_ustr, u"Heading 2"_ustr, u"Heading 3"_ustr, }; // We need to keep a list of the default style names // in order to filter these out later when processing // the full list of styles. std::set aDefaultStyleNames; boost::property_tree::ptree aValues; for (OUString const & sStyleFam : aStyleFamilies) { boost::property_tree::ptree aChildren; uno::Reference xStyleFamily(xStyleFamilies->getByName(sStyleFam), uno::UNO_QUERY); // Writer provides a huge number of styles, we have a list of 7 "default" styles which // should be shown in the normal dropdown, which we should add to the start of the list // to simplify their selection. if (sStyleFam == "ParagraphStyles" && doc_getDocumentType(pThis) == LOK_DOCTYPE_TEXT) { for (const OUString& rStyle: aWriterStyles) { aDefaultStyleNames.insert( rStyle ); boost::property_tree::ptree aChild; aChild.put("", rStyle.toUtf8()); aChildren.push_back(std::make_pair("", aChild)); } } const uno::Sequence aStyles = xStyleFamily->getElementNames(); for (const OUString& rStyle: aStyles ) { // Filter out the default styles - they are already at the top // of the list if (aDefaultStyleNames.find(rStyle) == aDefaultStyleNames.end() || (sStyleFam != "ParagraphStyles" || doc_getDocumentType(pThis) != LOK_DOCTYPE_TEXT) ) { boost::property_tree::ptree aChild; aChild.put("", rStyle.toUtf8()); aChildren.push_back(std::make_pair("", aChild)); } } aValues.add_child(sStyleFam.toUtf8().getStr(), aChildren); } // Header & Footer Styles { boost::property_tree::ptree aChild; boost::property_tree::ptree aChildren; static constexpr OUString sPageStyles(u"PageStyles"_ustr); uno::Reference