/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * 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 #include #include #include #include #include #include #include #include #include #if USE_TLS_NSS #include #endif using namespace css::lang; using namespace ::com::sun::star; using namespace ::com::sun::star::uno; class ScPDFExportTest : public test::BootstrapFixture, public unotest::MacrosTest { Reference mxComponent; Reference xTargetFrame; public: ScPDFExportTest() {} ~ScPDFExportTest(); virtual void setUp() override final; virtual void tearDown() override final; // helpers private: std::shared_ptr exportToPDF(const uno::Reference& xModel, const ScRange& range); std::shared_ptr exportToPDFWithUnoCommands(const OUString& rRange); static bool hasTextInPdf(const std::shared_ptr& pPDFFile, const char* sText, bool& bFound); void setFont(ScFieldEditEngine& rEE, sal_Int32 nStart, sal_Int32 nEnd, const OUString& rFontName); // unit tests public: void testExportRange_Tdf120161(); void testExportFitToPage_Tdf103516(); void testUnoCommands_Tdf120161(); void testTdf64703_hiddenPageBreak(); void testTdf143978(); void testTdf84012(); void testTdf78897(); CPPUNIT_TEST_SUITE(ScPDFExportTest); CPPUNIT_TEST(testExportRange_Tdf120161); CPPUNIT_TEST(testExportFitToPage_Tdf103516); CPPUNIT_TEST(testUnoCommands_Tdf120161); CPPUNIT_TEST(testTdf64703_hiddenPageBreak); CPPUNIT_TEST(testTdf143978); CPPUNIT_TEST(testTdf84012); CPPUNIT_TEST(testTdf78897); CPPUNIT_TEST_SUITE_END(); }; constexpr OUStringLiteral DATA_DIRECTORY = u"/sc/qa/extras/testdocuments/"; ScPDFExportTest::~ScPDFExportTest() { #if USE_TLS_NSS NSS_Shutdown(); #endif } void ScPDFExportTest::setUp() { test::BootstrapFixture::setUp(); mxDesktop.set( css::frame::Desktop::create(comphelper::getComponentContext(getMultiServiceFactory()))); { uno::Reference xDesktop = mxDesktop; CPPUNIT_ASSERT(xDesktop.is()); // Create spreadsheet uno::Sequence args{ comphelper::makePropertyValue("Hidden", true) }; mxComponent = xDesktop->loadComponentFromURL("private:factory/scalc", "_blank", 0, args); CPPUNIT_ASSERT(mxComponent.is()); // create a frame xTargetFrame = xDesktop->findFrame("_blank", 0); CPPUNIT_ASSERT(xTargetFrame.is()); uno::Reference xModel(mxComponent, uno::UNO_QUERY); uno::Reference xModel2(xModel, UNO_QUERY); CPPUNIT_ASSERT(xModel2.is()); Reference xController = xModel2->createDefaultViewController(xTargetFrame); CPPUNIT_ASSERT(xController.is()); // introduce model/view/controller to each other xController->attachModel(xModel2); xModel2->connectController(xController); xTargetFrame->setComponent(xController->getComponentWindow(), xController); xController->attachFrame(xTargetFrame); xModel2->setCurrentController(xController); } } void ScPDFExportTest::tearDown() { if (mxComponent.is()) mxComponent->dispose(); test::BootstrapFixture::tearDown(); } bool ScPDFExportTest::hasTextInPdf(const std::shared_ptr& pPDFFile, const char* sText, bool& bFound) { SvStream* pStream = pPDFFile->GetStream(StreamMode::STD_READ); CPPUNIT_ASSERT(pStream); // get file size const std::size_t nFileSize = pStream->TellEnd(); if (nFileSize == 0) return false; // read file content char* pBuffer = new char[nFileSize]; pStream->Seek(STREAM_SEEK_TO_BEGIN); const std::size_t nRead = pStream->ReadBytes(pBuffer, nFileSize); if (nRead == nFileSize) { const std::string haystack(pBuffer, pBuffer + nFileSize); const std::string needle(sText); const std::size_t n = haystack.find(needle); bFound = (n != std::string::npos); } delete[] pBuffer; // close and return the status pStream = nullptr; pPDFFile->CloseStream(); return (nRead == nFileSize); } std::shared_ptr ScPDFExportTest::exportToPDF(const uno::Reference& xModel, const ScRange& range) { // create temp file name auto pTempFile = std::make_shared(); pTempFile->EnableKillingFile(); OUString sFileURL = pTempFile->GetURL(); // Note: under Windows path path should be with "/" delimiters instead of "\\" // due to usage of INetURLObject() that converts "\\" to hexadecimal notation. ::osl::FileBase::getFileURLFromSystemPath(sFileURL, sFileURL); // get XSpreadsheet uno::Reference xDoc(xModel, uno::UNO_QUERY_THROW); uno::Reference xSheets(xDoc->getSheets(), UNO_SET_THROW); uno::Reference xIndex(xSheets, uno::UNO_QUERY_THROW); uno::Reference rSheet(xIndex->getByIndex(0), UNO_QUERY_THROW); // select requested cells to print // query for the XCellRange interface uno::Reference xCellRange = rSheet->getCellRangeByPosition( range.aStart.Col(), range.aStart.Row(), range.aEnd.Col(), range.aEnd.Row()); { uno::Reference xController = xModel->getCurrentController(); CPPUNIT_ASSERT(xController.is()); uno::Reference xSelection(xController, uno::UNO_QUERY_THROW); CPPUNIT_ASSERT(xSelection.is()); uno::Any rCellRangeAny(xCellRange); xSelection->select(rCellRangeAny); } // init special pdf export params css::uno::Sequence aFilterData{ comphelper::makePropertyValue("Selection", xCellRange), comphelper::makePropertyValue("Printing", sal_Int32(2)), comphelper::makePropertyValue("ViewPDFAfterExport", true) }; // init set of params for storeToURL() call css::uno::Sequence seqArguments{ comphelper::makePropertyValue("FilterData", aFilterData), comphelper::makePropertyValue("FilterName", OUString("calc_pdf_Export")), comphelper::makePropertyValue("URL", sFileURL) }; // call storeToURL() uno::Reference xComponent(mxComponent, UNO_SET_THROW); uno::Reference xStorable(xComponent, UNO_QUERY); xStorable->storeToURL(sFileURL, seqArguments); // return file object with generated PDF return pTempFile; } std::shared_ptr ScPDFExportTest::exportToPDFWithUnoCommands(const OUString& rRange) { // create temp file name auto pTempFile = std::make_shared(); pTempFile->EnableKillingFile(); OUString sFileURL = pTempFile->GetURL(); // Note: under Windows path path should be with "/" delimiters instead of "\\" // due to usage of INetURLObject() that converts "\\" to hexadecimal notation. ::osl::FileBase::getFileURLFromSystemPath(sFileURL, sFileURL); uno::Sequence aArgs = comphelper::InitPropertySequence({ { "ToPoint", uno::makeAny(rRange) } }); dispatchCommand(mxComponent, ".uno:GoToCell", aArgs); dispatchCommand(mxComponent, ".uno:DefinePrintArea", {}); uno::Sequence aFilterData(comphelper::InitPropertySequence( { { "ViewPDFAfterExport", uno::Any(true) }, { "Printing", uno::Any(sal_Int32(2)) } })); uno::Sequence aDescriptor( comphelper::InitPropertySequence({ { "FilterName", uno::Any(OUString("calc_pdf_Export")) }, { "FilterData", uno::Any(aFilterData) }, { "URL", uno::Any(sFileURL) } })); dispatchCommand(mxComponent, ".uno:ExportToPDF", aDescriptor); // return file object with generated PDF return pTempFile; } void ScPDFExportTest::setFont(ScFieldEditEngine& rEE, sal_Int32 nStart, sal_Int32 nEnd, const OUString& rFontName) { ESelection aSel; aSel.nStartPara = aSel.nEndPara = 0; aSel.nStartPos = nStart; aSel.nEndPos = nEnd; SfxItemSet aItemSet = rEE.GetEmptyItemSet(); SvxFontItem aItem(FAMILY_MODERN, rFontName, "", PITCH_VARIABLE, RTL_TEXTENCODING_UTF8, EE_CHAR_FONTINFO); aItemSet.Put(aItem); rEE.QuickSetAttribs(aItemSet, aSel); } // Selection was not taken into account during export into PDF void ScPDFExportTest::testExportRange_Tdf120161() { // create test document uno::Reference xModel(mxComponent, uno::UNO_QUERY); uno::Reference xDoc(xModel, uno::UNO_QUERY_THROW); uno::Reference xSheets(xDoc->getSheets(), UNO_SET_THROW); uno::Reference xIndex(xSheets, uno::UNO_QUERY_THROW); xSheets->insertNewByName("First Sheet", 0); uno::Reference rSheet(xIndex->getByIndex(0), UNO_QUERY_THROW); // 2. Setup data { SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(mxComponent); CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell); ScDocShellRef xDocSh = dynamic_cast(pFoundShell); CPPUNIT_ASSERT(xDocSh); // put some content into the first row with default font ScDocument& rDoc = xDocSh->GetDocument(); for (unsigned int r = 0; r < 1; ++r) for (unsigned int c = 0; c < 14; ++c) rDoc.SetValue(ScAddress(c, r, 0), (r + 1) * (c + 1)); // set "Text" to H1 cell with "DejaVuSans" font ScFieldEditEngine& rEE = rDoc.GetEditEngine(); rEE.Clear(); rEE.SetTextCurrentDefaults("Text"); setFont(rEE, 0, 4, "DejaVuSans"); // set font for first 4 chars rDoc.SetEditText(ScAddress(7, 0, 0), rEE.CreateTextObject()); } // A1:G1 { ScRange range1(0, 0, 0, 6, 0, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "DejaVuSans", bFound)); CPPUNIT_ASSERT_EQUAL(false, bFound); } // G1:H1 { ScRange range1(6, 0, 0, 7, 0, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "DejaVuSans", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } // H1:I1 { ScRange range1(7, 0, 0, 8, 0, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "DejaVuSans", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } } void ScPDFExportTest::testExportFitToPage_Tdf103516() { // create test document uno::Reference xModel(mxComponent, uno::UNO_QUERY); uno::Reference xDoc(xModel, uno::UNO_QUERY_THROW); uno::Reference xSheets(xDoc->getSheets(), UNO_SET_THROW); uno::Reference xIndex(xSheets, uno::UNO_QUERY_THROW); xSheets->insertNewByName("First Sheet", 0); uno::Reference rSheet(xIndex->getByIndex(0), UNO_QUERY_THROW); // 2. Setup data { SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(mxComponent); CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell); ScDocShellRef xDocSh = dynamic_cast(pFoundShell); CPPUNIT_ASSERT(xDocSh); // put some content into the table ScDocument& rDoc = xDocSh->GetDocument(); for (unsigned int r = 0; r < 80; ++r) for (unsigned int c = 0; c < 12; ++c) rDoc.SetValue(ScAddress(c, r, 0), (r + 1) * (c + 1)); } // A1:G50: 2-page export { ScRange range1(0, 0, 0, 6, 49, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "/Count 2>>", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } // A1:L80: 4-page export { ScRange range1(0, 0, 0, 11, 79, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "/Count 4>>", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } // set fit to page: width=1 page, height=0 (automatic) uno::Reference xStyleFamSupp(xDoc, UNO_QUERY_THROW); uno::Reference xStyleFamiliesNames(xStyleFamSupp->getStyleFamilies(), UNO_SET_THROW); uno::Reference xPageStyles(xStyleFamiliesNames->getByName("PageStyles"), UNO_QUERY_THROW); uno::Any aDefaultStyle = xPageStyles->getByName("Default"); uno::Reference xProp(aDefaultStyle, UNO_QUERY_THROW); uno::Any aScaleX, aScaleY; sal_Int16 nScale; aScaleX <<= static_cast(1); xProp->setPropertyValue("ScaleToPagesX", aScaleX); aScaleX = xProp->getPropertyValue("ScaleToPagesX"); aScaleX >>= nScale; CPPUNIT_ASSERT_EQUAL(sal_Int16(1), nScale); aScaleY = xProp->getPropertyValue("ScaleToPagesY"); aScaleY >>= nScale; CPPUNIT_ASSERT_EQUAL(sal_Int16(0), nScale); // A1:G50 with fit to page width=1: slightly smaller zoom results only 1-page export { ScRange range1(0, 0, 0, 6, 49, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "/Count 1>>", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } // A1:L80 with fit to page width=1: slightly smaller zoom results only 1-page export { ScRange range1(0, 0, 0, 11, 79, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "/Count 1>>", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } } void ScPDFExportTest::testUnoCommands_Tdf120161() { mxComponent = loadFromDesktop(m_directories.getURLFromSrc(DATA_DIRECTORY) + "tdf120161.ods", "com.sun.star.sheet.SpreadsheetDocument"); // A1:G1 { std::shared_ptr pPDFFile = exportToPDFWithUnoCommands("A1:G1"); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "DejaVuSans", bFound)); CPPUNIT_ASSERT_EQUAL(false, bFound); } // G1:H1 { std::shared_ptr pPDFFile = exportToPDFWithUnoCommands("G1:H1"); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "DejaVuSans", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } // H1:I1 { std::shared_ptr pPDFFile = exportToPDFWithUnoCommands("H1:I1"); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "DejaVuSans", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } } void ScPDFExportTest::testTdf64703_hiddenPageBreak() { mxComponent = loadFromDesktop(m_directories.getURLFromSrc(DATA_DIRECTORY) + "tdf64703_hiddenPageBreak.ods", "com.sun.star.sheet.SpreadsheetDocument"); uno::Reference xModel(mxComponent, uno::UNO_QUERY); // A1:A11: 4-page export { ScRange range1(0, 0, 0, 0, 10, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); bool bFound = false; CPPUNIT_ASSERT(hasTextInPdf(pPDFFile, "/Count 4>>", bFound)); CPPUNIT_ASSERT_EQUAL(true, bFound); } } void ScPDFExportTest::testTdf143978() { std::shared_ptr pPDFium = vcl::pdf::PDFiumLibrary::get(); if (!pPDFium) { return; } mxComponent = loadFromDesktop(m_directories.getURLFromSrc(DATA_DIRECTORY) + "tdf143978.ods", "com.sun.star.sheet.SpreadsheetDocument"); uno::Reference xModel(mxComponent, uno::UNO_QUERY); // A1:A2 ScRange range1(0, 0, 0, 0, 1, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); // Parse the export result with pdfium. SvFileStream aFile(pPDFFile->GetURL(), StreamMode::READ); SvMemoryStream aMemory; aMemory.WriteStream(aFile); std::unique_ptr pPdfDocument = pPDFium->openDocument(aMemory.GetData(), aMemory.GetSize()); CPPUNIT_ASSERT(pPdfDocument); CPPUNIT_ASSERT_EQUAL(1, pPdfDocument->getPageCount()); // Get the first page std::unique_ptr pPdfPage = pPdfDocument->openPage(/*nIndex=*/0); CPPUNIT_ASSERT(pPdfPage); std::unique_ptr pTextPage = pPdfPage->getTextPage(); int nPageObjectCount = pPdfPage->getObjectCount(); CPPUNIT_ASSERT_EQUAL(2, nPageObjectCount); // Without the fix in place, this test would have failed with // - Expected: Dies ist viel zu viel Text // - Actual : Dies ist vie std::unique_ptr pPageObject1 = pPdfPage->getObject(0); OUString sText1 = pPageObject1->getText(pTextPage); CPPUNIT_ASSERT_EQUAL(OUString("Dies ist viel zu viel Text"), sText1); // and it would also have failed with // - Expected: 2021-11-17 // - Actual : ### std::unique_ptr pPageObject2 = pPdfPage->getObject(1); OUString sText2 = pPageObject2->getText(pTextPage); CPPUNIT_ASSERT_EQUAL(OUString("2021-11-17"), sText2); } void ScPDFExportTest::testTdf84012() { std::shared_ptr pPDFium = vcl::pdf::PDFiumLibrary::get(); if (!pPDFium) { return; } mxComponent = loadFromDesktop(m_directories.getURLFromSrc(DATA_DIRECTORY) + "tdf84012.ods", "com.sun.star.sheet.SpreadsheetDocument"); uno::Reference xModel(mxComponent, uno::UNO_QUERY); // A1 ScRange range1(0, 0, 0, 0, 0, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); // Parse the export result with pdfium. SvFileStream aFile(pPDFFile->GetURL(), StreamMode::READ); SvMemoryStream aMemory; aMemory.WriteStream(aFile); std::unique_ptr pPdfDocument = pPDFium->openDocument(aMemory.GetData(), aMemory.GetSize()); CPPUNIT_ASSERT(pPdfDocument); CPPUNIT_ASSERT_EQUAL(1, pPdfDocument->getPageCount()); // Get the first page std::unique_ptr pPdfPage = pPdfDocument->openPage(/*nIndex=*/0); CPPUNIT_ASSERT(pPdfPage); std::unique_ptr pTextPage = pPdfPage->getTextPage(); int nChars = pTextPage->countChars(); std::vector aChars(nChars); for (int i = 0; i < nChars; i++) aChars[i] = pTextPage->getUnicode(i); OUString aActualText(aChars.data(), aChars.size()); // Without the fix in place, this test would have failed with // - Expected: Blah blah (blah, blah) // - Actual : Blah blah CPPUNIT_ASSERT_EQUAL(OUString("Blah blah (blah, blah)"), aActualText); } void ScPDFExportTest::testTdf78897() { std::shared_ptr pPDFium = vcl::pdf::PDFiumLibrary::get(); if (!pPDFium) { return; } mxComponent = loadFromDesktop(m_directories.getURLFromSrc(DATA_DIRECTORY) + "tdf78897.xls", "com.sun.star.sheet.SpreadsheetDocument"); uno::Reference xModel(mxComponent, uno::UNO_QUERY); // C3:D3 ScRange range1(2, 2, 0, 3, 2, 0); std::shared_ptr pPDFFile = exportToPDF(xModel, range1); // Parse the export result with pdfium. SvFileStream aFile(pPDFFile->GetURL(), StreamMode::READ); SvMemoryStream aMemory; aMemory.WriteStream(aFile); std::unique_ptr pPdfDocument = pPDFium->openDocument(aMemory.GetData(), aMemory.GetSize()); CPPUNIT_ASSERT(pPdfDocument); CPPUNIT_ASSERT_EQUAL(1, pPdfDocument->getPageCount()); // Get the first page std::unique_ptr pPdfPage = pPdfDocument->openPage(/*nIndex=*/0); CPPUNIT_ASSERT(pPdfPage); std::unique_ptr pTextPage = pPdfPage->getTextPage(); int nChars = pTextPage->countChars(); std::vector aChars(nChars); for (int i = 0; i < nChars; i++) aChars[i] = pTextPage->getUnicode(i); OUString aActualText(aChars.data(), aChars.size()); // Without the fix in place, this test would have failed with // - Expected: 11.00 11.00 // - Actual : 11.00 ### CPPUNIT_ASSERT_EQUAL(OUString(" 11.00 11.00 "), aActualText); } CPPUNIT_TEST_SUITE_REGISTRATION(ScPDFExportTest); CPPUNIT_PLUGIN_IMPLEMENT(); /* vim:set shiftwidth=4 softtabstop=4 expandtab: */