sd/qa/unit/SdrPdfImportTest.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <test/unoapi_test.hxx>
  11
  12 #include <comphelper/scopeguard.hxx>
  13 #include <comphelper/propertysequence.hxx>
  14
  15 #include <unotools/tempfile.hxx>
  16 #include <unotools/mediadescriptor.hxx>
  17 #include <svx/svdograf.hxx>
  18 #include <editeng/outlobj.hxx>
  19 #include <editeng/editobj.hxx>
  20 #include <vcl/filter/PDFiumLibrary.hxx>
  21 #include <vcl/pdf/PDFAnnotationSubType.hxx>
  22
  23 #include <DrawDocShell.hxx>
  24 #include <ViewShell.hxx>
  25 #include <sdpage.hxx>
  26 #include <unomodel.hxx>
  27
  28 using namespace css;
  29
  30 namespace
  31 {
  32 class EnvVarGuard
  33 {
  34 public:
  35     EnvVarGuard(const char* var, const char* val)
  36     {
  37         if (getenv(var) == nullptr)
  38         {
  39             sVar = var;
  40             SetEnv(sVar, val);
  41         }
  42     }
  43     ~EnvVarGuard()
  44     {
  45         if (sVar)
  46             SetEnv(sVar, nullptr);
  47     }
  48
  49 private:
  50     static void SetEnv(const char* var, const char* val)
  51     {
  52 #ifdef _WIN32
  53         if (!val)
  54             val = ""; // remove
  55         _putenv_s(var, val);
  56 #else
  57         if (val)
  58             setenv(var, val, false);
  59         else
  60             unsetenv(var);
  61 #endif
  62     }
  63
  64     const char* sVar = nullptr;
  65 };
  66 }
  67
  68 class SdrPdfImportTest : public UnoApiTest
  69 {
  70 public:
  71     SdrPdfImportTest()
  72         : UnoApiTest("/sd/qa/unit/data/")
  73     {
  74     }
  75 };
  76
  77 // Load the PDF in Draw, which will load the PDF as an Graphic, then
  78 // mark the graphic object and trigger "break" function. This should
  79 // convert the PDF content into objects/shapes.
  80 CPPUNIT_TEST_FIXTURE(SdrPdfImportTest, testImportSimpleText)
  81 {
  82     auto pPdfium = vcl::pdf::PDFiumLibrary::get();
  83     if (!pPdfium)
  84     {
  85         return;
  86     }
  87
  88     // We need to enable PDFium import (and make sure to disable after the test)
  89     EnvVarGuard UsePDFiumGuard("LO_IMPORT_USE_PDFIUM", "1");
  90
  91     loadFromURL(u"SimplePDF.pdf");
  92     auto pImpressDocument = dynamic_cast<SdXImpressDocument*>(mxComponent.get());
  93     sd::ViewShell* pViewShell = pImpressDocument->GetDocShell()->GetViewShell();
  94     CPPUNIT_ASSERT(pViewShell);
  95
  96     // Get the first page - there should be only one.
  97     SdPage* pPage = pViewShell->GetActualPage();
  98     CPPUNIT_ASSERT(pPage);
  99
 100     // Check there is one object on the page only
 101     CPPUNIT_ASSERT_EQUAL(size_t(1), pPage->GetObjCount());
 102
 103     // Get the first object - there should be only one.
 104     SdrObject* pObject = pPage->GetObj(0);
 105     CPPUNIT_ASSERT(pObject);
 106
 107     // Check the object is a graphic object
 108     SdrGrafObj* pGraphicObject = dynamic_cast<SdrGrafObj*>(pObject);
 109     CPPUNIT_ASSERT(pGraphicObject);
 110     // Check the graphic is a vector graphic and that it is PDF
 111     Graphic aGraphic = pGraphicObject->GetGraphic();
 112     auto const& pVectorGraphicData = aGraphic.getVectorGraphicData();
 113     CPPUNIT_ASSERT(pVectorGraphicData);
 114     CPPUNIT_ASSERT_EQUAL(VectorGraphicDataType::Pdf, pVectorGraphicData->getType());
 115
 116     // Mark the object
 117     SdrView* pView = pViewShell->GetView();
 118     pView->MarkObj(pObject, pView->GetSdrPageView());
 119
 120     // Execute the break operation - to turn the PDF into shapes/objects
 121     pViewShell->GetDrawView()->DoImportMarkedMtf();
 122
 123     // Check there is one object on the page only
 124     CPPUNIT_ASSERT_EQUAL(size_t(1), pPage->GetObjCount());
 125
 126     // Get the object
 127     SdrObject* pImportedObject = pPage->GetObj(0);
 128     CPPUNIT_ASSERT(pImportedObject);
 129
 130     // Check the object position
 131     CPPUNIT_ASSERT_EQUAL(tools::Rectangle(Point(2011, 2102), Size(2106 + 1, 298 + 1)),
 132                          pImportedObject->GetLogicRect());
 133
 134     // Object should be a text object containing one paragraph with
 135     // content "This is PDF!"
 136
 137     SdrTextObj* pTextObject = DynCastSdrTextObj(pImportedObject);
 138     CPPUNIT_ASSERT(pTextObject);
 139     OutlinerParaObject* pOutlinerParagraphObject = pTextObject->GetOutlinerParaObject();
 140     const EditTextObject& aEdit = pOutlinerParagraphObject->GetTextObject();
 141     OUString sText = aEdit.GetText(0);
 142     CPPUNIT_ASSERT_EQUAL(OUString("This is PDF!"), sText);
 143 }
 144
 145 CPPUNIT_TEST_FIXTURE(SdrPdfImportTest, testAnnotationsImportExport)
 146 {
 147     auto pPdfium = vcl::pdf::PDFiumLibrary::get();
 148     if (!pPdfium)
 149     {
 150         return;
 151     }
 152
 153     // We need to enable PDFium import (and make sure to disable after the test)
 154     EnvVarGuard UsePDFiumGuard("LO_IMPORT_USE_PDFIUM", "1");
 155
 156     EnvVarGuard DisablePDFCompressionGuard("VCL_DEBUG_DISABLE_PDFCOMPRESSION", "1");
 157
 158     auto pPdfiumLibrary = vcl::pdf::PDFiumLibrary::get();
 159
 160     loadFromURL(u"PdfWithAnnotation.pdf");
 161     auto pImpressDocument = dynamic_cast<SdXImpressDocument*>(mxComponent.get());
 162     sd::ViewShell* pViewShell = pImpressDocument->GetDocShell()->GetViewShell();
 163     CPPUNIT_ASSERT(pViewShell);
 164
 165     BinaryDataContainer aContainer;
 166
 167     {
 168         // Get the first page - there should be only one.
 169         SdPage* pPage = pViewShell->GetActualPage();
 170         CPPUNIT_ASSERT(pPage);
 171
 172         // Check the number of annotations
 173         CPPUNIT_ASSERT_EQUAL(size_t(1), pPage->getAnnotations().size());
 174
 175         // Get the first object - there should be only one.
 176         SdrObject* pObject = pPage->GetObj(0);
 177         CPPUNIT_ASSERT(pObject);
 178
 179         // Check the object is a graphic object
 180         SdrGrafObj* pGraphicObject = dynamic_cast<SdrGrafObj*>(pObject);
 181         CPPUNIT_ASSERT(pGraphicObject);
 182
 183         // Check the graphic is a vector graphic and that it is PDF
 184         Graphic aGraphic = pGraphicObject->GetGraphic();
 185         auto const& pVectorGraphicData = aGraphic.getVectorGraphicData();
 186         CPPUNIT_ASSERT(pVectorGraphicData);
 187         CPPUNIT_ASSERT_EQUAL(VectorGraphicDataType::Pdf, pVectorGraphicData->getType());
 188
 189         // Write the PDF
 190         aContainer = pVectorGraphicData->getBinaryDataContainer();
 191     }
 192
 193     { // check graphic PDF has annotations
 194
 195         CPPUNIT_ASSERT_EQUAL(false, aContainer.isEmpty());
 196
 197         auto pPDFDocument
 198             = pPdfiumLibrary->openDocument(aContainer.getData(), aContainer.getSize(), OString());
 199         auto pPDFPage = pPDFDocument->openPage(0);
 200
 201         CPPUNIT_ASSERT_EQUAL(2, pPDFPage->getAnnotationCount());
 202
 203         auto pPDFAnnotation1 = pPDFPage->getAnnotation(0);
 204         CPPUNIT_ASSERT_EQUAL(vcl::pdf::PDFAnnotationSubType::Text,
 205                              pPDFAnnotation1->getSubType()); // Text annotation
 206
 207         auto pPDFAnnotation2 = pPDFPage->getAnnotation(1);
 208         CPPUNIT_ASSERT_EQUAL(vcl::pdf::PDFAnnotationSubType::Popup,
 209                              pPDFAnnotation2->getSubType()); // Pop-up annotation
 210     }
 211
 212     { // save as PDF and check annotations
 213         uno::Reference<frame::XStorable> xStorable(mxComponent, uno::UNO_QUERY);
 214         utl::MediaDescriptor aMediaDescriptor;
 215         aMediaDescriptor["FilterName"] <<= OUString("writer_pdf_Export");
 216         uno::Sequence<beans::PropertyValue> aFilterData(
 217             comphelper::InitPropertySequence({ { "ExportBookmarks", uno::Any(true) } }));
 218         aMediaDescriptor["FilterData"] <<= aFilterData;
 219         xStorable->storeToURL(maTempFile.GetURL(), aMediaDescriptor.getAsConstPropertyValueList());
 220
 221         // Check PDF for annotations
 222         auto pPDFDocument = parsePDFExport();
 223         CPPUNIT_ASSERT(pPDFDocument);
 224         CPPUNIT_ASSERT_EQUAL(1, pPDFDocument->getPageCount());
 225
 226         auto pPDFPage = pPDFDocument->openPage(0);
 227         CPPUNIT_ASSERT(pPDFPage);
 228
 229         CPPUNIT_ASSERT_EQUAL(2, pPDFPage->getAnnotationCount());
 230
 231         auto pPDFAnnotation1 = pPDFPage->getAnnotation(0);
 232         CPPUNIT_ASSERT_EQUAL(vcl::pdf::PDFAnnotationSubType::Text,
 233                              pPDFAnnotation1->getSubType()); // Text annotation
 234
 235         auto pPDFAnnotation2 = pPDFPage->getAnnotation(1);
 236         CPPUNIT_ASSERT_EQUAL(vcl::pdf::PDFAnnotationSubType::Popup,
 237                              pPDFAnnotation2->getSubType()); // Pop-up annotation
 238
 239         // Load document again
 240         mxComponent = loadFromDesktop(maTempFile.GetURL());
 241         auto pNewImpressDocument = dynamic_cast<SdXImpressDocument*>(mxComponent.get());
 242         sd::ViewShell* pNewViewShell = pNewImpressDocument->GetDocShell()->GetViewShell();
 243         CPPUNIT_ASSERT(pNewViewShell);
 244
 245         SdPage* pPage = pNewViewShell->GetActualPage();
 246         CPPUNIT_ASSERT(pPage);
 247
 248         // We expect only 1 annotation in the document because the PDF
 249         // annotations are dependent on each-other:
 250         // parent annotation "Text" and the child annotation "Pop-up"
 251
 252         CPPUNIT_ASSERT_EQUAL(size_t(1), pPage->getAnnotations().size());
 253
 254         // check annotation
 255         auto xAnnotation = pPage->getAnnotations().at(0);
 256
 257         CPPUNIT_ASSERT_DOUBLES_EQUAL(90.33, xAnnotation->getPosition().X, 1E-3);
 258         CPPUNIT_ASSERT_DOUBLES_EQUAL(12.07, xAnnotation->getPosition().Y, 1E-3);
 259
 260         CPPUNIT_ASSERT_EQUAL(OUString("TheAuthor"), xAnnotation->getAuthor());
 261         CPPUNIT_ASSERT_EQUAL(OUString(), xAnnotation->getInitials());
 262
 263         auto xText = xAnnotation->getTextRange();
 264
 265         CPPUNIT_ASSERT_EQUAL(OUString("This is the annotation text!"), xText->getString());
 266
 267         auto aDateTime = xAnnotation->getDateTime();
 268         CPPUNIT_ASSERT_EQUAL(sal_Int16(2020), aDateTime.Year);
 269         CPPUNIT_ASSERT_EQUAL(sal_uInt16(6), aDateTime.Month);
 270         CPPUNIT_ASSERT_EQUAL(sal_uInt16(18), aDateTime.Day);
 271         CPPUNIT_ASSERT_EQUAL(sal_uInt16(12), aDateTime.Hours);
 272         CPPUNIT_ASSERT_EQUAL(sal_uInt16(11), aDateTime.Minutes);
 273         CPPUNIT_ASSERT_EQUAL(sal_uInt16(53), aDateTime.Seconds);
 274         CPPUNIT_ASSERT_EQUAL(sal_uInt32(0), aDateTime.NanoSeconds);
 275         CPPUNIT_ASSERT_EQUAL(false, bool(aDateTime.IsUTC));
 276     }
 277 }
 278
 279 CPPUNIT_PLUGIN_IMPLEMENT();
 280
 281 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */