From 3ab2b0625bb8ab8447a508d654d6e8c95d50dbd5 Mon Sep 17 00:00:00 2001 From: Miklos Vajna Date: Tue, 30 Aug 2016 15:34:11 +0200 Subject: sc lok: implement getCommandValues(.uno:AcceptTrackedChanges) API Unlike in Writer, there doesn't seem to be an existing UNO API that can be reused here. Change-Id: I011a2f34d4d09ad604991637322ceadf6b2eb181 Reviewed-on: https://gerrit.libreoffice.org/28498 Reviewed-by: Miklos Vajna Tested-by: Jenkins --- desktop/qa/desktop_lib/test_desktop_lib.cxx | 31 +++++++++++++ desktop/source/lib/init.cxx | 72 +++++++++++++++++------------ include/vcl/ITiledRenderable.hxx | 8 ++++ sc/inc/chgtrack.hxx | 2 + sc/inc/docuno.hxx | 3 ++ sc/source/core/tool/chgtrack.cxx | 52 +++++++++++++++++++++ sc/source/ui/unoobj/docuno.cxx | 14 ++++++ 7 files changed, 152 insertions(+), 30 deletions(-) diff --git a/desktop/qa/desktop_lib/test_desktop_lib.cxx b/desktop/qa/desktop_lib/test_desktop_lib.cxx index d3888ff94021..aa8286e7e437 100644 --- a/desktop/qa/desktop_lib/test_desktop_lib.cxx +++ b/desktop/qa/desktop_lib/test_desktop_lib.cxx @@ -98,6 +98,7 @@ public: void testNotificationCompression(); void testRedlineWriter(); void testTrackChanges(); + void testRedlineCalc(); CPPUNIT_TEST_SUITE(DesktopLOKTest); CPPUNIT_TEST(testGetStyles); @@ -127,6 +128,7 @@ public: CPPUNIT_TEST(testNotificationCompression); CPPUNIT_TEST(testRedlineWriter); CPPUNIT_TEST(testTrackChanges); + CPPUNIT_TEST(testRedlineCalc); CPPUNIT_TEST_SUITE_END(); uno::Reference mxComponent; @@ -1441,6 +1443,35 @@ void DesktopLOKTest::testRedlineWriter() comphelper::LibreOfficeKit::setActive(false); } +void DesktopLOKTest::testRedlineCalc() +{ + // Load a Writer document, enable change recording and press a key. + comphelper::LibreOfficeKit::setActive(); + LibLODocument_Impl* pDocument = loadDoc("sheets.ods"); + uno::Reference xPropertySet(mxComponent, uno::UNO_QUERY); + xPropertySet->setPropertyValue("RecordChanges", uno::makeAny(true)); + pDocument->pClass->postKeyEvent(pDocument, LOK_KEYEVENT_KEYINPUT, 't', 0); + pDocument->pClass->postKeyEvent(pDocument, LOK_KEYEVENT_KEYUP, 't', 0); + pDocument->pClass->postKeyEvent(pDocument, LOK_KEYEVENT_KEYINPUT, 0, KEY_RETURN); + pDocument->pClass->postKeyEvent(pDocument, LOK_KEYEVENT_KEYUP, 0, KEY_RETURN); + + // Get redline info. + boost::property_tree::ptree aTree; + char* pJSON = pDocument->m_pDocumentClass->getCommandValues(pDocument, ".uno:AcceptTrackedChanges"); + std::stringstream aStream(pJSON); + free(pJSON); + CPPUNIT_ASSERT(!aStream.str().empty()); + boost::property_tree::read_json(aStream, aTree); + // Make sure that pressing a key creates exactly one redline. + CPPUNIT_ASSERT_EQUAL(static_cast(1), aTree.get_child("redlines").size()); + + for (boost::property_tree::ptree::value_type& rRedline : aTree.get_child("redlines")) + // This failed with boost::property_tree::ptree_bad_path, as there were no description field. + CPPUNIT_ASSERT_EQUAL(std::string("Cell B4 changed from '5' to 't'"), rRedline.second.get("description")); + + comphelper::LibreOfficeKit::setActive(false); +} + CPPUNIT_TEST_SUITE_REGISTRATION(DesktopLOKTest); CPPUNIT_PLUGIN_IMPLEMENT(); diff --git a/desktop/source/lib/init.cxx b/desktop/source/lib/init.cxx index 1de564f88ad5..6ab1cf3bb6b4 100644 --- a/desktop/source/lib/init.cxx +++ b/desktop/source/lib/init.cxx @@ -1820,45 +1820,57 @@ static char* getTrackedChanges(LibreOfficeKitDocument* pThis) LibLODocument_Impl* pDocument = static_cast(pThis); uno::Reference xRedlinesSupplier(pDocument->mxComponent, uno::UNO_QUERY); - if (!xRedlinesSupplier.is()) - return nullptr; - - uno::Reference xRedlines = xRedlinesSupplier->getRedlines()->createEnumeration(); - boost::property_tree::ptree aRedlines; - for (size_t nIndex = 0; xRedlines->hasMoreElements(); ++nIndex) + std::stringstream aStream; + if (xRedlinesSupplier.is()) { - uno::Reference xRedline(xRedlines->nextElement(), uno::UNO_QUERY); - boost::property_tree::ptree aRedline; - aRedline.put("index", nIndex); + uno::Reference xRedlines = xRedlinesSupplier->getRedlines()->createEnumeration(); + boost::property_tree::ptree aRedlines; + for (size_t nIndex = 0; xRedlines->hasMoreElements(); ++nIndex) + { + uno::Reference xRedline(xRedlines->nextElement(), uno::UNO_QUERY); + boost::property_tree::ptree aRedline; + aRedline.put("index", nIndex); + + OUString sAuthor; + xRedline->getPropertyValue("RedlineAuthor") >>= sAuthor; + aRedline.put("author", sAuthor.toUtf8().getStr()); - OUString sAuthor; - xRedline->getPropertyValue("RedlineAuthor") >>= sAuthor; - aRedline.put("author", sAuthor.toUtf8().getStr()); + OUString sType; + xRedline->getPropertyValue("RedlineType") >>= sType; + aRedline.put("type", sType.toUtf8().getStr()); - OUString sType; - xRedline->getPropertyValue("RedlineType") >>= sType; - aRedline.put("type", sType.toUtf8().getStr()); + OUString sComment; + xRedline->getPropertyValue("RedlineComment") >>= sComment; + aRedline.put("comment", sComment.toUtf8().getStr()); - OUString sComment; - xRedline->getPropertyValue("RedlineComment") >>= sComment; - aRedline.put("comment", sComment.toUtf8().getStr()); + OUString sDescription; + xRedline->getPropertyValue("RedlineDescription") >>= sDescription; + aRedline.put("description", sDescription.toUtf8().getStr()); - OUString sDescription; - xRedline->getPropertyValue("RedlineDescription") >>= sDescription; - aRedline.put("description", sDescription.toUtf8().getStr()); + util::DateTime aDateTime; + xRedline->getPropertyValue("RedlineDateTime") >>= aDateTime; + OUString sDateTime = utl::toISO8601(aDateTime); + aRedline.put("dateTime", sDateTime.toUtf8().getStr()); - util::DateTime aDateTime; - xRedline->getPropertyValue("RedlineDateTime") >>= aDateTime; - OUString sDateTime = utl::toISO8601(aDateTime); - aRedline.put("dateTime", sDateTime.toUtf8().getStr()); + aRedlines.push_back(std::make_pair("", aRedline)); + } - aRedlines.push_back(std::make_pair("", aRedline)); + boost::property_tree::ptree aTree; + aTree.add_child("redlines", aRedlines); + boost::property_tree::write_json(aStream, aTree); + } + else + { + ITiledRenderable* pDoc = getTiledRenderable(pThis); + if (!pDoc) + { + gImpl->maLastExceptionMsg = "Document doesn't support tiled rendering"; + return nullptr; + } + OUString aTrackedChanges = pDoc->getTrackedChanges(); + aStream << aTrackedChanges.toUtf8(); } - boost::property_tree::ptree aTree; - aTree.add_child("redlines", aRedlines); - std::stringstream aStream; - boost::property_tree::write_json(aStream, aTree); char* pJson = strdup(aStream.str().c_str()); return pJson; } diff --git a/include/vcl/ITiledRenderable.hxx b/include/vcl/ITiledRenderable.hxx index 65043a0bf86e..7e5ab0066040 100644 --- a/include/vcl/ITiledRenderable.hxx +++ b/include/vcl/ITiledRenderable.hxx @@ -204,6 +204,14 @@ public: virtual void setClientVisibleArea(const Rectangle& /*rRectangle*/) { } + + /// Implementation for + /// lok::Document::getCommandValues(".uno:AcceptTrackedChanges") when there + /// is no matching UNO API. + virtual OUString getTrackedChanges() + { + return OUString(); + } }; } // namespace vcl diff --git a/sc/inc/chgtrack.hxx b/sc/inc/chgtrack.hxx index c8977ab173af..28e3e73f1f93 100644 --- a/sc/inc/chgtrack.hxx +++ b/sc/inc/chgtrack.hxx @@ -1187,6 +1187,8 @@ public: void AppendCloned( ScChangeAction* pAppend ); SC_DLLPUBLIC ScChangeTrack* Clone( ScDocument* pDocument ) const; static void MergeActionState( ScChangeAction* pAct, const ScChangeAction* pOtherAct ); + /// Get info about all ScChangeAction elements. + OUString GetChangeTrackInfo(); }; #endif diff --git a/sc/inc/docuno.hxx b/sc/inc/docuno.hxx index c276198af067..b2b029388e10 100644 --- a/sc/inc/docuno.hxx +++ b/sc/inc/docuno.hxx @@ -418,6 +418,9 @@ public: /// @see vcl::ITiledRenderable::getPointer(). virtual Pointer getPointer() override; + + /// @see vcl::ITiledRenderable::getTrackedChanges(). + OUString getTrackedChanges() override; }; class ScDrawPagesObj : public cppu::WeakImplHelper< diff --git a/sc/source/core/tool/chgtrack.cxx b/sc/source/core/tool/chgtrack.cxx index 83253682339c..30a8f077d8df 100644 --- a/sc/source/core/tool/chgtrack.cxx +++ b/sc/source/core/tool/chgtrack.cxx @@ -41,8 +41,10 @@ #include #include #include +#include #include #include +#include IMPL_FIXEDMEMPOOL_NEWDEL( ScChangeActionCellListEntry ) IMPL_FIXEDMEMPOOL_NEWDEL( ScChangeActionLinkEntry ) @@ -4706,4 +4708,54 @@ void ScChangeTrack::MergeActionState( ScChangeAction* pAct, const ScChangeAction } } +/// Get info about a single ScChangeAction element. +static void lcl_getTrackedChange(ScDocument* pDoc, int nIndex, ScChangeAction* pAction, boost::property_tree::ptree& rRedlines) +{ + if (pAction->GetType() == SC_CAT_CONTENT) + { + boost::property_tree::ptree aRedline; + aRedline.put("index", nIndex); + + const OUString& sAuthor = pAction->GetUser(); + aRedline.put("author", sAuthor.toUtf8().getStr()); + + aRedline.put("type", "Modify"); + + aRedline.put("comment", pAction->GetComment().toUtf8().getStr()); + + OUString aDescription; + pAction->GetDescription(aDescription, pDoc, true); + aRedline.put("description", aDescription); + + OUString sDateTime = utl::toISO8601(pAction->GetDateTimeUTC().GetUNODateTime()); + aRedline.put("dateTime", sDateTime.toUtf8().getStr()); + + rRedlines.push_back(std::make_pair("", aRedline)); + } +} + +OUString ScChangeTrack::GetChangeTrackInfo() +{ + boost::property_tree::ptree aRedlines; + + ScChangeAction* pAction = GetFirst(); + if (pAction) + { + int i = 0; + lcl_getTrackedChange(pDoc, i++, pAction, aRedlines); + ScChangeAction* pLastAction = GetLast(); + while (pAction != pLastAction) + { + pAction = pAction->GetNext(); + lcl_getTrackedChange(pDoc, i++, pAction, aRedlines); + } + } + + boost::property_tree::ptree aTree; + aTree.add_child("redlines", aRedlines); + std::stringstream aStream; + boost::property_tree::write_json(aStream, aTree); + return OUString::fromUtf8(aStream.str().c_str()); +} + /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/sc/source/ui/unoobj/docuno.cxx b/sc/source/ui/unoobj/docuno.cxx index 57c83e9999be..6d300b88e927 100644 --- a/sc/source/ui/unoobj/docuno.cxx +++ b/sc/source/ui/unoobj/docuno.cxx @@ -116,6 +116,7 @@ #include "drawsh.hxx" #include "drtxtob.hxx" #include "transobj.hxx" +#include "chgtrack.hxx" #include "sc.hrc" @@ -943,6 +944,19 @@ Pointer ScModelObj::getPointer() return pGridWindow->GetPointer(); } +OUString ScModelObj::getTrackedChanges() +{ + OUString aRet; + + if (pDocShell) + { + if (ScChangeTrack* pChangeTrack = pDocShell->GetDocument().GetChangeTrack()) + aRet = pChangeTrack->GetChangeTrackInfo(); + } + + return aRet; +} + void ScModelObj::initializeForTiledRendering(const css::uno::Sequence& /*rArguments*/) { SolarMutexGuard aGuard; -- cgit