oox/source/drawingml/graphicshapecontext.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 <string_view>
  23
  24 #include <oox/drawingml/graphicshapecontext.hxx>
  25
  26 #include <osl/diagnose.h>
  27 #include <sal/log.hxx>
  28
  29 #include <drawingml/embeddedwavaudiofile.hxx>
  30 #include <drawingml/misccontexts.hxx>
  31 #include <drawingml/graphicproperties.hxx>
  32 #include <drawingml/customshapeproperties.hxx>
  33 #include <oox/drawingml/diagram/diagram.hxx>
  34 #include <drawingml/table/tablecontext.hxx>
  35 #include <oox/core/xmlfilterbase.hxx>
  36 #include <oox/helper/attributelist.hxx>
  37 #include <oox/vml/vmldrawing.hxx>
  38 #include <drawingml/transform2dcontext.hxx>
  39 #include <oox/ppt/pptshapegroupcontext.hxx>
  40 #include <oox/token/namespaces.hxx>
  41 #include <oox/token/tokens.hxx>
  42
  43 using namespace ::com::sun::star;
  44 using namespace ::com::sun::star::io;
  45 using namespace ::com::sun::star::uno;
  46 using namespace ::com::sun::star::lang;
  47 using namespace ::com::sun::star::beans;
  48 using namespace ::com::sun::star::xml::sax;
  49 using namespace ::oox::core;
  50
  51 static uno::Reference<io::XInputStream>
  52 lcl_GetMediaStream(const OUString& rStream, const oox::core::XmlFilterBase& rFilter)
  53 {
  54     if (rStream.isEmpty())
  55         return nullptr;
  56
  57     Reference< XInputStream > xInStrm( rFilter.openInputStream(rStream), UNO_SET_THROW );
  58     return xInStrm;
  59 }
  60
  61 static OUString lcl_GetMediaReference(std::u16string_view rStream)
  62 {
  63     return rStream.empty() ? OUString() : OUString::Concat("vnd.sun.star.Package:") + rStream;
  64 }
  65
  66 namespace oox::drawingml {
  67
  68 // CT_Picture
  69
  70 GraphicShapeContext::GraphicShapeContext( ContextHandler2Helper const & rParent, const ShapePtr& pMasterShapePtr, const ShapePtr& pShapePtr )
  71 : ShapeContext( rParent, pMasterShapePtr, pShapePtr )
  72 {
  73 }
  74
  75 ContextHandlerRef GraphicShapeContext::onCreateContext( sal_Int32 aElementToken, const AttributeList& rAttribs )
  76 {
  77     switch( getBaseToken( aElementToken ) )
  78     {
  79     // CT_ShapeProperties
  80     case XML_xfrm:
  81         return new Transform2DContext( *this, rAttribs, *mpShapePtr );
  82     case XML_blipFill:
  83         return new BlipFillContext(*this, rAttribs, mpShapePtr->getGraphicProperties().maBlipProps, nullptr);
  84     case XML_wavAudioFile:
  85         {
  86             OUString const path(getEmbeddedWAVAudioFile(getRelations(), rAttribs));
  87             Reference<XInputStream> xMediaStream = lcl_GetMediaStream(path, getFilter());
  88             if (xMediaStream.is())
  89             {
  90                 mpShapePtr->getGraphicProperties().m_xMediaStream = xMediaStream;
  91                 mpShapePtr->getGraphicProperties().m_sMediaPackageURL = lcl_GetMediaReference(path);
  92             }
  93         }
  94         break;
  95     case XML_audioFile:
  96     case XML_videoFile:
  97         {
  98             OUString rPath = getRelations().getFragmentPathFromRelId(
  99                     rAttribs.getStringDefaulted(R_TOKEN(link)) );
 100             if (!rPath.isEmpty())
 101             {
 102                 Reference<XInputStream> xMediaStream = lcl_GetMediaStream(rPath, getFilter());
 103                 if (xMediaStream.is()) // embedded media file
 104                 {
 105                     mpShapePtr->getGraphicProperties().m_xMediaStream = xMediaStream;
 106                     mpShapePtr->getGraphicProperties().m_sMediaPackageURL
 107                         = lcl_GetMediaReference(rPath);
 108                 }
 109             }
 110             else
 111             {
 112                 rPath = getRelations().getExternalTargetFromRelId(
 113                     rAttribs.getStringDefaulted(R_TOKEN(link)));
 114                 if (!rPath.isEmpty()) // linked media file
 115                     mpShapePtr->getGraphicProperties().m_sMediaPackageURL
 116                         = getFilter().getAbsoluteUrl(rPath);
 117             }
 118         }
 119         break;
 120     }
 121
 122     if ((getNamespace( aElementToken ) == NMSP_vml) && mpShapePtr)
 123     {
 124         mpShapePtr->setServiceName("com.sun.star.drawing.CustomShape");
 125         CustomShapePropertiesPtr pCstmShpProps
 126             (mpShapePtr->getCustomShapeProperties());
 127
 128         pCstmShpProps->setShapePresetType( getBaseToken( aElementToken ) );
 129     }
 130
 131     return ShapeContext::onCreateContext( aElementToken, rAttribs );
 132 }
 133
 134 // CT_GraphicalObjectFrameContext
 135
 136 GraphicalObjectFrameContext::GraphicalObjectFrameContext( ContextHandler2Helper& rParent, const ShapePtr& pMasterShapePtr, const ShapePtr& pShapePtr, bool bEmbedShapesInChart ) :
 137     ShapeContext( rParent, pMasterShapePtr, pShapePtr ),
 138     mbEmbedShapesInChart( bEmbedShapesInChart ),
 139     mpParent(&rParent)
 140 {
 141 }
 142
 143 ContextHandlerRef GraphicalObjectFrameContext::onCreateContext( sal_Int32 aElementToken, const AttributeList& rAttribs )
 144 {
 145     switch( getBaseToken( aElementToken ) )
 146     {
 147     // CT_ShapeProperties
 148     case XML_nvGraphicFramePr:      // CT_GraphicalObjectFrameNonVisual
 149         break;
 150     case XML_xfrm:                  // CT_Transform2D
 151         return new Transform2DContext( *this, rAttribs, *mpShapePtr );
 152     case XML_graphic:               // CT_GraphicalObject
 153         return this;
 154
 155         case XML_graphicData :          // CT_GraphicalObjectData
 156         {
 157             OUString sUri( rAttribs.getStringDefaulted( XML_uri ) );
 158             if ( sUri == "http://schemas.openxmlformats.org/presentationml/2006/ole" ||
 159                     sUri == "http://purl.oclc.org/ooxml/presentationml/ole" )
 160                 return new OleObjectGraphicDataContext( *this, mpShapePtr );
 161             else if ( sUri == "http://schemas.openxmlformats.org/drawingml/2006/diagram" ||
 162                     sUri == "http://purl.oclc.org/ooxml/drawingml/diagram" )
 163                 return new DiagramGraphicDataContext( *this, mpShapePtr );
 164             else if ( sUri == "http://schemas.openxmlformats.org/drawingml/2006/chart" ||
 165                     sUri == "http://purl.oclc.org/ooxml/drawingml/chart" )
 166                 return new ChartGraphicDataContext( *this, mpShapePtr, mbEmbedShapesInChart );
 167             else if ( sUri == "http://schemas.openxmlformats.org/drawingml/2006/table" ||
 168                     sUri == "http://purl.oclc.org/ooxml/drawingml/table" )
 169                 return new table::TableContext( *this, mpShapePtr );
 170             else
 171             {
 172                 SAL_WARN("oox.drawingml", "OOX: Ignore graphicsData of :" << sUri );
 173                 return nullptr;
 174             }
 175         }
 176         break;
 177     }
 178
 179     return ShapeContext::onCreateContext( aElementToken, rAttribs );
 180 }
 181
 182 void GraphicalObjectFrameContext::onEndElement()
 183 {
 184     if( getCurrentElement() == PPT_TOKEN( graphicFrame ) && mpParent )
 185     {
 186         oox::ppt::PPTShapeGroupContext* pParent = dynamic_cast<oox::ppt::PPTShapeGroupContext*>(mpParent);
 187         if( pParent )
 188             pParent->importExtDrawings();
 189     }
 190 }
 191
 192 OleObjectGraphicDataContext::OleObjectGraphicDataContext( ContextHandler2Helper const & rParent, const ShapePtr& xShape ) :
 193     ShapeContext( rParent, ShapePtr(), xShape ),
 194     mrOleObjectInfo( xShape->setOleObjectType() )
 195 {
 196 }
 197
 198 OleObjectGraphicDataContext::~OleObjectGraphicDataContext()
 199 {
 200     /*  Register the OLE shape at the VML drawing, this prevents that the
 201         related VML shape converts the OLE object by itself. */
 202     if( !mrOleObjectInfo.maShapeId.isEmpty() )
 203         if( ::oox::vml::Drawing* pVmlDrawing = getFilter().getVmlDrawing() )
 204             pVmlDrawing->registerOleObject( mrOleObjectInfo );
 205 }
 206
 207 ContextHandlerRef OleObjectGraphicDataContext::onCreateContext( sal_Int32 nElement, const AttributeList& rAttribs )
 208 {
 209     switch( nElement )
 210     {
 211         case PPT_TOKEN( oleObj ):
 212         {
 213             mrOleObjectInfo.maShapeId = rAttribs.getXString( XML_spid, OUString() );
 214             const Relation* pRelation = getRelations().getRelationFromRelId( rAttribs.getStringDefaulted( R_TOKEN( id )) );
 215             OSL_ENSURE( pRelation, "OleObjectGraphicDataContext::createFastChildContext - missing relation for OLE object" );
 216             if( pRelation )
 217             {
 218                 mrOleObjectInfo.mbLinked = pRelation->mbExternal;
 219                 if( pRelation->mbExternal )
 220                 {
 221                     mrOleObjectInfo.maTargetLink = getFilter().getAbsoluteUrl( pRelation->maTarget );
 222                 }
 223                 else
 224                 {
 225                     OUString aFragmentPath = getFragmentPathFromRelation( *pRelation );
 226                     if( !aFragmentPath.isEmpty() )
 227                         getFilter().importBinaryData( mrOleObjectInfo.maEmbeddedData, aFragmentPath );
 228                 }
 229             }
 230             mrOleObjectInfo.maName = rAttribs.getXString( XML_name, OUString() );
 231             mrOleObjectInfo.maProgId = rAttribs.getXString( XML_progId, OUString() );
 232             mrOleObjectInfo.mbShowAsIcon = rAttribs.getBool( XML_showAsIcon, false );
 233             mrOleObjectInfo.mbHasPicture = false; // Initialize as false
 234             return this;
 235         }
 236         break;
 237
 238         case PPT_TOKEN( embed ):
 239             OSL_ENSURE( !mrOleObjectInfo.mbLinked, "OleObjectGraphicDataContext::createFastChildContext - unexpected child element" );
 240         break;
 241
 242         case PPT_TOKEN( link ):
 243             OSL_ENSURE( mrOleObjectInfo.mbLinked, "OleObjectGraphicDataContext::createFastChildContext - unexpected child element" );
 244             mrOleObjectInfo.mbAutoUpdate = rAttribs.getBool( XML_updateAutomatic, false );
 245         break;
 246         case PPT_TOKEN( pic ):
 247             mrOleObjectInfo.mbHasPicture = true; // Set true if ole object has picture element.
 248             return new GraphicShapeContext( *this, mpMasterShapePtr, mpShapePtr );
 249     }
 250     SAL_WARN("oox", "OleObjectGraphicDataContext::onCreateContext: unhandled element: "
 251                         << getBaseToken(nElement));
 252     return nullptr;
 253 }
 254
 255 void OleObjectGraphicDataContext::onEndElement()
 256 {
 257     if( getCurrentElement() == PPT_TOKEN( oleObj ) && !isMCEStateEmpty() )
 258     {
 259         if (getMCEState() == MCE_STATE::FoundChoice && !mrOleObjectInfo.mbHasPicture
 260             && mrOleObjectInfo.maShapeId.isEmpty())
 261             setMCEState( MCE_STATE::Started );
 262     }
 263 }
 264
 265 DiagramGraphicDataContext::DiagramGraphicDataContext( ContextHandler2Helper const & rParent, const ShapePtr& pShapePtr )
 266 : ShapeContext( rParent, ShapePtr(), pShapePtr )
 267 {
 268     pShapePtr->setDiagramType();
 269 }
 270
 271 DiagramGraphicDataContext::~DiagramGraphicDataContext()
 272 {
 273 }
 274
 275 ContextHandlerRef DiagramGraphicDataContext::onCreateContext( ::sal_Int32 aElementToken, const AttributeList& rAttribs )
 276 {
 277     switch( aElementToken )
 278     {
 279     case DGM_TOKEN( relIds ):
 280     {
 281         msDm = rAttribs.getStringDefaulted( R_TOKEN( dm ) );
 282         msLo = rAttribs.getStringDefaulted( R_TOKEN( lo ) );
 283         msQs = rAttribs.getStringDefaulted( R_TOKEN( qs ) );
 284         msCs = rAttribs.getStringDefaulted( R_TOKEN( cs ) );
 285         loadDiagram(mpShapePtr,
 286                     getFilter(),
 287                     getFragmentPathFromRelId( msDm ),
 288                     getFragmentPathFromRelId( msLo ),
 289                     getFragmentPathFromRelId( msQs ),
 290                     getFragmentPathFromRelId( msCs ),
 291                     getRelations());
 292         SAL_INFO("oox.drawingml", "DiagramGraphicDataContext::onCreateContext: added shape " << mpShapePtr->getName()
 293                  << " of type " << mpShapePtr->getServiceName()
 294                  << ", position: " << mpShapePtr->getPosition().X
 295                  << "," << mpShapePtr->getPosition().Y
 296                  << ", size: " << mpShapePtr->getSize().Width
 297                  << "x" << mpShapePtr->getSize().Height);
 298
 299         // No DrawingML fallback, need to warn the user at the end.
 300         if (mpShapePtr->getExtDrawings().empty())
 301             getFilter().setMissingExtDrawing();
 302         else
 303         {
 304             for (const auto& rRelId : mpShapePtr->getExtDrawings())
 305             {
 306                 // An invalid fallback reference is as bad as a missing one.
 307                 if (getFragmentPathFromRelId(rRelId).isEmpty())
 308                 {
 309                     getFilter().setMissingExtDrawing();
 310                     break;
 311                 }
 312             }
 313         }
 314
 315         break;
 316     }
 317     default:
 318         break;
 319     }
 320
 321     return ShapeContext::onCreateContext( aElementToken, rAttribs );
 322 }
 323
 324 ChartGraphicDataContext::ChartGraphicDataContext( ContextHandler2Helper const & rParent, const ShapePtr& rxShape, bool bEmbedShapes ) :
 325     ShapeContext( rParent, ShapePtr(), rxShape ),
 326     mrChartShapeInfo( rxShape->setChartType( bEmbedShapes ) )
 327 {
 328 }
 329
 330 ContextHandlerRef ChartGraphicDataContext::onCreateContext( ::sal_Int32 nElement, const AttributeList& rAttribs )
 331 {
 332     if( nElement == C_TOKEN( chart ) )
 333     {
 334         mrChartShapeInfo.maFragmentPath = getFragmentPathFromRelId( rAttribs.getStringDefaulted( R_TOKEN( id )) );
 335     }
 336     return nullptr;
 337 }
 338
 339 } // namespace oox::drawingml
 340
 341 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */