svx/source/xml/xmlxtexp.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <comphelper/diagnose_ex.hxx>
  23 #include <tools/urlobj.hxx>
  24 #include <com/sun/star/beans/XPropertySet.hpp>
  25 #include <com/sun/star/container/XNameContainer.hpp>
  26 #include <com/sun/star/xml/sax/Writer.hpp>
  27 #include <com/sun/star/uno/Sequence.hxx>
  28 #include <com/sun/star/drawing/PolyPolygonBezierCoords.hpp>
  29 #include <com/sun/star/drawing/LineDash.hpp>
  30 #include <com/sun/star/awt/Gradient.hpp>
  31 #include <com/sun/star/awt/XBitmap.hpp>
  32 #include <com/sun/star/drawing/Hatch.hpp>
  33 #include <com/sun/star/embed/ElementModes.hpp>
  34
  35 #include <sax/tools/converter.hxx>
  36 #include <sfx2/docfile.hxx>
  37 #include <rtl/ustrbuf.hxx>
  38 #include <xmloff/xmlnamespace.hxx>
  39 #include <xmloff/namespacemap.hxx>
  40
  41 #include <xmloff/xmltoken.hxx>
  42 #include <xmloff/xmlmetae.hxx>
  43 #include <xmloff/DashStyle.hxx>
  44 #include <xmloff/GradientStyle.hxx>
  45 #include <xmloff/HatchStyle.hxx>
  46 #include <xmloff/ImageStyle.hxx>
  47 #include <xmloff/MarkerStyle.hxx>
  48 #include <com/sun/star/embed/XTransactedObject.hpp>
  49 #include <comphelper/processfactory.hxx>
  50 #include <unotools/streamwrap.hxx>
  51 #include <svx/xmlgrhlp.hxx>
  52
  53 #include <xmlxtexp.hxx>
  54
  55 #include <comphelper/storagehelper.hxx>
  56 #include <memory>
  57
  58 using namespace com::sun::star;
  59 using namespace com::sun::star::container;
  60 using namespace com::sun::star::document;
  61 using namespace com::sun::star::uno;
  62 using namespace com::sun::star::awt;
  63 using namespace com::sun::star::lang;
  64 using namespace com::sun::star::xml::sax;
  65 using namespace ::xmloff::token;
  66 using namespace cppu;
  67
  68 using com::sun::star::embed::XTransactedObject;
  69
  70 namespace {
  71
  72 class SvxXMLTableEntryExporter
  73 {
  74 public:
  75     explicit SvxXMLTableEntryExporter( SvXMLExport& rExport ) : mrExport( rExport ) {}
  76     virtual ~SvxXMLTableEntryExporter();
  77
  78     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) = 0;
  79
  80 protected:
  81     SvXMLExport& mrExport;
  82 };
  83
  84 class SvxXMLColorEntryExporter : public SvxXMLTableEntryExporter
  85 {
  86 public:
  87     explicit SvxXMLColorEntryExporter( SvXMLExport& rExport );
  88
  89     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) override;
  90 };
  91
  92 class SvxXMLLineEndEntryExporter : public SvxXMLTableEntryExporter
  93 {
  94 public:
  95     explicit SvxXMLLineEndEntryExporter( SvXMLExport& rExport );
  96
  97     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) override;
  98 private:
  99     XMLMarkerStyleExport maMarkerStyle;
 100 };
 101
 102 class SvxXMLDashEntryExporter : public SvxXMLTableEntryExporter
 103 {
 104 public:
 105     explicit SvxXMLDashEntryExporter( SvXMLExport& rExport );
 106
 107     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) override;
 108
 109 private:
 110     XMLDashStyleExport maDashStyle;
 111 };
 112
 113 class SvxXMLHatchEntryExporter : public SvxXMLTableEntryExporter
 114 {
 115 public:
 116     explicit SvxXMLHatchEntryExporter( SvXMLExport& rExport );
 117
 118     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) override;
 119 private:
 120     XMLHatchStyleExport maHatchStyle;
 121 };
 122
 123 class SvxXMLGradientEntryExporter : public SvxXMLTableEntryExporter
 124 {
 125 public:
 126     explicit SvxXMLGradientEntryExporter( SvXMLExport& rExport );
 127
 128     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) override;
 129 private:
 130     XMLGradientStyleExport maGradientStyle;
 131 };
 132
 133 class SvxXMLBitmapEntryExporter : public SvxXMLTableEntryExporter
 134 {
 135 public:
 136     explicit SvxXMLBitmapEntryExporter( SvXMLExport& rExport );
 137
 138     virtual void exportEntry( const OUString& rStrName, const Any& rValue ) override;
 139 };
 140
 141 }
 142
 143 SvxXMLXTableExportComponent::SvxXMLXTableExportComponent(
 144     const css::uno::Reference< css::uno::XComponentContext >& rContext,
 145     const uno::Reference<xml::sax::XDocumentHandler> & rHandler,
 146     const uno::Reference<container::XNameContainer >& xTable,
 147     uno::Reference<document::XGraphicStorageHandler> const & xGraphicStorageHandler)
 148 :   SvXMLExport(rContext, "", /*rFileName*/"", rHandler, nullptr, FieldUnit::MM_100TH, SvXMLExportFlags::NONE),
 149     mxTable( xTable )
 150 {
 151
 152     GetNamespaceMap_().Add( GetXMLToken(XML_NP_OOO), GetXMLToken(XML_N_OOO), XML_NAMESPACE_OOO );
 153     GetNamespaceMap_().Add( GetXMLToken(XML_NP_OFFICE), GetXMLToken(XML_N_OFFICE), XML_NAMESPACE_OFFICE );
 154     GetNamespaceMap_().Add( GetXMLToken(XML_NP_DRAW), GetXMLToken(XML_N_DRAW), XML_NAMESPACE_DRAW );
 155     GetNamespaceMap_().Add( GetXMLToken(XML_NP_XLINK), GetXMLToken(XML_N_XLINK), XML_NAMESPACE_XLINK );
 156     GetNamespaceMap_().Add( GetXMLToken(XML_NP_SVG), GetXMLToken(XML_N_SVG),  XML_NAMESPACE_SVG );
 157     GetNamespaceMap_().Add( GetXMLToken(XML_NP_LO_EXT), GetXMLToken(XML_N_LO_EXT), XML_NAMESPACE_LO_EXT);
 158     SetGraphicStorageHandler(xGraphicStorageHandler);
 159 }
 160
 161 SvxXMLXTableExportComponent::~SvxXMLXTableExportComponent()
 162 {
 163 }
 164
 165 static void initializeStreamMetadata( const uno::Reference< uno::XInterface > &xOut )
 166 {
 167     uno::Reference< beans::XPropertySet > xProps( xOut, uno::UNO_QUERY );
 168     if( !xProps.is() )
 169     {
 170         OSL_FAIL( "Missing stream metadata interface" );
 171         return;
 172     }
 173
 174     try
 175     {
 176         xProps->setPropertyValue("MediaType",  uno::Any( OUString( "text/xml" ) ) );
 177
 178         // use stock encryption
 179         xProps->setPropertyValue("UseCommonStoragePasswordEncryption", uno::Any( true ) );
 180     } catch ( const uno::Exception & )
 181     {
 182         TOOLS_WARN_EXCEPTION("svx", "exception setting stream metadata");
 183     }
 184 }
 185
 186 static void createStorageStream( uno::Reference < io::XOutputStream > *xOut,
 187                                  rtl::Reference<SvXMLGraphicHelper>&   rxGraphicHelper,
 188                                  const uno::Reference < embed::XStorage >& xSubStorage )
 189 {
 190     uno::Reference < io::XStream > xStream = xSubStorage->openStreamElement(
 191                         "Content.xml",
 192                         embed::ElementModes::WRITE );
 193     rxGraphicHelper = SvXMLGraphicHelper::Create( xSubStorage, SvXMLGraphicHelperMode::Write );
 194     initializeStreamMetadata( xStream );
 195     *xOut = xStream->getOutputStream();
 196 }
 197
 198 bool SvxXMLXTableExportComponent::save(
 199         const OUString& rURL,
 200         const uno::Reference<container::XNameContainer >& xTable,
 201         const uno::Reference<embed::XStorage >& xStorage,
 202         OUString *pOptName )
 203 {
 204     bool bRet = false;
 205     std::unique_ptr<SfxMedium> pMedium;
 206     rtl::Reference<SvXMLGraphicHelper> xGraphicHelper;
 207
 208     INetURLObject aURLObj( rURL );
 209     bool bToStorage = aURLObj.GetProtocol() == INetProtocol::NotValid; // a relative path
 210     bool bSaveAsStorage = xTable->getElementType() == cppu::UnoType<awt::XBitmap>::get();
 211
 212     if( pOptName )
 213         *pOptName = rURL;
 214
 215     try
 216     {
 217         uno::Reference< uno::XComponentContext> xContext( ::comphelper::getProcessComponentContext() );
 218
 219         uno::Reference< xml::sax::XWriter > xWriter = xml::sax::Writer::create( xContext );
 220
 221         uno::Reference < io::XStream > xStream;
 222         uno::Reference < io::XOutputStream > xOut;
 223         uno::Reference<embed::XStorage > xSubStorage;
 224         uno::Reference<XGraphicStorageHandler> xGraphicStorageHandler;
 225         const sal_Int32 eCreate = embed::ElementModes::WRITE | embed::ElementModes::TRUNCATE;
 226
 227         if( !bToStorage || !xStorage.is() )
 228         { // local URL -> SfxMedium route
 229             if( bSaveAsStorage )
 230             {
 231                 // ideally this should use a ZIP_STORAGE_FORMAT_STRING storage
 232                 // but changing it to that could cause problems loading the
 233                 // file with an old version of LO that expects to find in the
 234                 // user profile a PACKAGE_STORAGE_FORMAT_STRING storage
 235                 xSubStorage = ::comphelper::OStorageHelper::GetStorageFromURL( rURL, eCreate );
 236             }
 237             else
 238             {
 239                 pMedium.reset(new SfxMedium( rURL, StreamMode::WRITE | StreamMode::TRUNC ));
 240
 241                 SvStream* pStream = pMedium->GetOutStream();
 242                 if( !pStream )
 243                 {
 244                     OSL_FAIL( "no output stream!" );
 245                     return false;
 246                 }
 247
 248                 xOut = new utl::OOutputStreamWrapper( *pStream );
 249             }
 250         }
 251         else // save into the xSubStorage
 252         {
 253             OUString aPath = rURL;
 254
 255             if( bSaveAsStorage )
 256             {
 257                 try {
 258                     xSubStorage = xStorage->openStorageElement( aPath, eCreate );
 259                 } catch (uno::Exception &) {
 260                     OSL_FAIL( "no output storage!" );
 261                     return false;
 262                 }
 263             }
 264             else
 265             {
 266                 aPath += ".xml";
 267                 try {
 268                     xStream = xStorage->openStreamElement( aPath, eCreate );
 269                     if( !xStream.is() )
 270                         return false;
 271                     initializeStreamMetadata( xStream );
 272                     xOut = xStream->getOutputStream();
 273                 } catch (uno::Exception &) {
 274                     OSL_FAIL( "no output stream!" );
 275                     return false;
 276                 }
 277                 if( pOptName )
 278                     *pOptName = aPath;
 279             }
 280         }
 281
 282         if( !xOut.is() && xSubStorage.is() )
 283             createStorageStream( &xOut, xGraphicHelper, xSubStorage );
 284         if( !xOut.is() )
 285             return false;
 286
 287         xWriter->setOutputStream( xOut );
 288         if( xGraphicHelper.is() )
 289             xGraphicStorageHandler = xGraphicHelper.get();
 290
 291         // Finally do the export
 292         rtl::Reference< SvxXMLXTableExportComponent > xExporter( new SvxXMLXTableExportComponent( xContext, xWriter, xTable, xGraphicStorageHandler ) );
 293         bRet = xExporter->exportTable();
 294
 295         if( xGraphicHelper )
 296             xGraphicHelper->dispose();
 297         xGraphicHelper.clear();
 298
 299         if( xSubStorage.is() )
 300         {
 301             uno::Reference< XTransactedObject > xTrans( xSubStorage, UNO_QUERY );
 302             if( xTrans.is() )
 303                 xTrans->commit();
 304
 305             xSubStorage->dispose();
 306         }
 307     }
 308     catch( uno::Exception& )
 309     {
 310         bRet = false;
 311     }
 312
 313     if( pMedium )
 314         pMedium->Commit();
 315
 316     return bRet;
 317 }
 318
 319 bool SvxXMLXTableExportComponent::exportTable() noexcept
 320 {
 321     bool bRet = false;
 322
 323     try
 324     {
 325         GetDocHandler()->startDocument();
 326
 327         addChaffWhenEncryptedStorage();
 328
 329         // export namespaces
 330         sal_uInt16 nPos = GetNamespaceMap().GetFirstKey();
 331         while( USHRT_MAX != nPos )
 332         {
 333             GetAttrList().AddAttribute( GetNamespaceMap().GetAttrNameByKey( nPos ), GetNamespaceMap().GetNameByKey( nPos ) );
 334             nPos = GetNamespaceMap().GetNextKey( nPos );
 335         }
 336
 337         do
 338         {
 339             if( !mxTable.is() )
 340                 break;
 341
 342             char const* pEleName;
 343             Type aExportType = mxTable->getElementType();
 344             std::unique_ptr<SvxXMLTableEntryExporter> pExporter;
 345
 346             if( aExportType == cppu::UnoType<sal_Int32>::get() )
 347             {
 348                 pExporter.reset(new SvxXMLColorEntryExporter(*this));
 349                 pEleName = "color-table";
 350             }
 351             else if( aExportType == cppu::UnoType< drawing::PolyPolygonBezierCoords >::get() )
 352             {
 353                 pExporter.reset(new SvxXMLLineEndEntryExporter(*this));
 354                 pEleName = "marker-table";
 355             }
 356             else if( aExportType == cppu::UnoType< drawing::LineDash >::get() )
 357             {
 358                 pExporter.reset(new SvxXMLDashEntryExporter(*this));
 359                 pEleName = "dash-table";
 360             }
 361             else if( aExportType == cppu::UnoType< drawing::Hatch >::get() )
 362             {
 363                 pExporter.reset(new SvxXMLHatchEntryExporter(*this));
 364                 pEleName = "hatch-table";
 365             }
 366             else if( aExportType == cppu::UnoType< awt::Gradient >::get() )
 367             {
 368                 pExporter.reset(new SvxXMLGradientEntryExporter(*this));
 369                 pEleName = "gradient-table";
 370             }
 371             else if( aExportType == cppu::UnoType<awt::XBitmap>::get())
 372             {
 373                 pExporter.reset(new SvxXMLBitmapEntryExporter(*this));
 374                 pEleName = "bitmap-table";
 375             }
 376             else
 377             {
 378                 OSL_FAIL( "unknown type for export");
 379                 break;
 380             }
 381
 382             SvXMLElementExport aElem( *this, XML_NAMESPACE_OOO, pEleName, true, true );
 383
 384             const Sequence< OUString > aNames = mxTable->getElementNames();
 385             Any aAny;
 386
 387             for( const OUString& rName : aNames )
 388             {
 389                 aAny = mxTable->getByName( rName );
 390                 pExporter->exportEntry( rName, aAny );
 391             }
 392
 393             bRet = true;
 394         }
 395         while(false);
 396
 397         GetDocHandler()->endDocument();
 398     }
 399     catch( Exception const& )
 400     {
 401         bRet = false;
 402     }
 403
 404     return bRet;
 405 }
 406
 407 // methods without content:
 408 void SvxXMLXTableExportComponent::ExportAutoStyles_() {}
 409 void SvxXMLXTableExportComponent::ExportMasterStyles_() {}
 410 void SvxXMLXTableExportComponent::ExportContent_() {}
 411
 412
 413 SvxXMLTableEntryExporter::~SvxXMLTableEntryExporter()
 414 {
 415 }
 416
 417
 418 SvxXMLColorEntryExporter::SvxXMLColorEntryExporter( SvXMLExport& rExport )
 419 : SvxXMLTableEntryExporter( rExport )
 420 {
 421 }
 422
 423 void SvxXMLColorEntryExporter::exportEntry( const OUString& rStrName, const Any& rValue )
 424 {
 425     mrExport.AddAttribute( XML_NAMESPACE_DRAW, XML_NAME, rStrName );
 426
 427     sal_Int32 nColor = 0;
 428     rValue >>= nColor;
 429
 430     OUStringBuffer aOut;
 431     ::sax::Converter::convertColor( aOut, nColor );
 432     mrExport.AddAttribute( XML_NAMESPACE_DRAW, XML_COLOR, aOut.makeStringAndClear() );
 433
 434     SvXMLElementExport aElem( mrExport, XML_NAMESPACE_DRAW, XML_COLOR, true, true );
 435 }
 436
 437
 438 SvxXMLLineEndEntryExporter::SvxXMLLineEndEntryExporter( SvXMLExport& rExport )
 439 : SvxXMLTableEntryExporter( rExport ), maMarkerStyle( rExport )
 440 {
 441 }
 442
 443 void SvxXMLLineEndEntryExporter::exportEntry( const OUString& rStrName, const Any& rValue )
 444 {
 445     maMarkerStyle.exportXML( rStrName, rValue );
 446 }
 447
 448
 449 SvxXMLDashEntryExporter::SvxXMLDashEntryExporter( SvXMLExport& rExport )
 450 : SvxXMLTableEntryExporter( rExport ), maDashStyle( rExport )
 451 {
 452 }
 453
 454 void SvxXMLDashEntryExporter::exportEntry( const OUString& rStrName, const Any& rValue )
 455 {
 456     maDashStyle.exportXML( rStrName, rValue );
 457 }
 458
 459
 460 SvxXMLHatchEntryExporter::SvxXMLHatchEntryExporter( SvXMLExport& rExport )
 461 : SvxXMLTableEntryExporter( rExport ), maHatchStyle( rExport )
 462 {
 463 }
 464
 465 void SvxXMLHatchEntryExporter::exportEntry( const OUString& rStrName, const Any& rValue )
 466 {
 467     maHatchStyle.exportXML( rStrName, rValue );
 468 }
 469
 470
 471 SvxXMLGradientEntryExporter::SvxXMLGradientEntryExporter( SvXMLExport& rExport )
 472 : SvxXMLTableEntryExporter( rExport ), maGradientStyle( rExport )
 473 {
 474 }
 475
 476 void SvxXMLGradientEntryExporter::exportEntry( const OUString& rStrName, const Any& rValue )
 477 {
 478     maGradientStyle.exportXML( rStrName, rValue );
 479 }
 480
 481
 482 SvxXMLBitmapEntryExporter::SvxXMLBitmapEntryExporter( SvXMLExport& rExport )
 483 : SvxXMLTableEntryExporter( rExport )
 484 {
 485 }
 486
 487 void SvxXMLBitmapEntryExporter::exportEntry( const OUString& rStrName, const Any& rValue )
 488 {
 489     XMLImageStyle::exportXML(rStrName, rValue, mrExport);
 490 }
 491
 492 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */