sc/source/filter/oox/excelfilter.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 <excelfilter.hxx>
  21
  22 #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
  23 #include <osl/diagnose.h>
  24 #include <sal/log.hxx>
  25
  26 #include <excelvbaproject.hxx>
  27 #include <stylesbuffer.hxx>
  28 #include <themebuffer.hxx>
  29 #include <workbookfragment.hxx>
  30 #include <xestream.hxx>
  31
  32 #include <addressconverter.hxx>
  33 #include <document.hxx>
  34 #include <docsh.hxx>
  35 #include <scerrors.hxx>
  36 #include <vcl/svapp.hxx>
  37 #include <vcl/weld.hxx>
  38 #include <svtools/sfxecode.hxx>
  39 #include <svtools/ehdl.hxx>
  40 #include <tools/urlobj.hxx>
  41 #include <tools/diagnose_ex.h>
  42
  43 namespace oox::xls {
  44
  45 using namespace ::com::sun::star::lang;
  46 using namespace ::com::sun::star::sheet;
  47 using namespace ::com::sun::star::uno;
  48 using namespace ::oox::core;
  49
  50 using ::oox::drawingml::table::TableStyleListPtr;
  51
  52 ExcelFilter::ExcelFilter( const Reference< XComponentContext >& rxContext ) :
  53     XmlFilterBase( rxContext ),
  54     mpBookGlob( nullptr )
  55 {
  56 }
  57
  58 ExcelFilter::~ExcelFilter()
  59 {
  60     OSL_ENSURE( !mpBookGlob, "ExcelFilter::~ExcelFilter - workbook data not cleared" );
  61 }
  62
  63 void ExcelFilter::registerWorkbookGlobals( WorkbookGlobals& rBookGlob )
  64 {
  65     mpBookGlob = &rBookGlob;
  66 }
  67
  68 WorkbookGlobals& ExcelFilter::getWorkbookGlobals() const
  69 {
  70     OSL_ENSURE( mpBookGlob, "ExcelFilter::getWorkbookGlobals - missing workbook data" );
  71     return *mpBookGlob;
  72 }
  73
  74 void ExcelFilter::unregisterWorkbookGlobals()
  75 {
  76     mpBookGlob = nullptr;
  77 }
  78
  79 bool ExcelFilter::importDocument()
  80 {
  81     /*  To activate the XLSX/XLSB dumper, insert the full path to the file
  82         file:///<path-to-oox-module>/source/dump/xlsbdumper.ini
  83         into the environment variable OOO_XLSBDUMPER and start the office with
  84         this variable (nonpro only). */
  85     //OOX_DUMP_FILE( ::oox::dump::xlsb::Dumper );
  86
  87     OUString aWorkbookPath = getFragmentPathFromFirstTypeFromOfficeDoc( "officeDocument" );
  88     if( aWorkbookPath.isEmpty() )
  89         return false;
  90
  91     try
  92     {
  93         try
  94         {
  95             importDocumentProperties();
  96         }
  97         catch( const Exception& )
  98         {
  99             TOOLS_WARN_EXCEPTION("sc", "exception when importing document properties");
 100         }
 101         catch( ... )
 102         {
 103             SAL_WARN("sc", "exception when importing document properties");
 104         }
 105         /*  Construct the WorkbookGlobals object referred to by every instance of
 106             the class WorkbookHelper, and execute the import filter by constructing
 107             an instance of WorkbookFragment and loading the file. */
 108         WorkbookGlobalsRef xBookGlob(WorkbookHelper::constructGlobals(*this));
 109         if (xBookGlob)
 110         {
 111             rtl::Reference<FragmentHandler> xWorkbookFragment( new WorkbookFragment(*xBookGlob, aWorkbookPath));
 112
 113             const WorkbookFragment* pWF = static_cast<const WorkbookFragment*>(xWorkbookFragment.get());
 114             const ScDocument& rDoc = pWF->getScDocument();
 115             if (ScDocShell* pDocSh = static_cast<ScDocShell*>(rDoc.GetDocumentShell()))
 116                 pDocSh->SetInitialLinkUpdate( pDocSh->GetMedium());
 117
 118             bool bRet = importFragment( xWorkbookFragment);
 119             if (bRet)
 120             {
 121                 const AddressConverter& rAC = pWF->getAddressConverter();
 122                 if (rAC.isTabOverflow() || rAC.isColOverflow() || rAC.isRowOverflow())
 123                 {
 124                     if (rDoc.IsUserInteractionEnabled())
 125                     {
 126                         // Show data loss warning.
 127
 128                         INetURLObject aURL( getFileUrl());
 129                         SfxErrorContext aContext( ERRCTX_SFX_OPENDOC,
 130                                 aURL.getName( INetURLObject::LAST_SEGMENT, true,
 131                                     INetURLObject::DecodeMechanism::WithCharset),
 132                                 nullptr, RID_ERRCTX);
 133
 134                         OUString aWarning;
 135                         aContext.GetString( ERRCODE_NONE.MakeWarning(), aWarning);
 136                         aWarning += ":\n";
 137
 138                         OUString aMsg;
 139                         if (rAC.isTabOverflow())
 140                         {
 141                             if (ErrorHandler::GetErrorString( SCWARN_IMPORT_SHEET_OVERFLOW, aMsg))
 142                                 aWarning += aMsg;
 143                         }
 144                         if (rAC.isColOverflow())
 145                         {
 146                             if (!aMsg.isEmpty())
 147                                 aWarning += "\n";
 148                             if (ErrorHandler::GetErrorString( SCWARN_IMPORT_COLUMN_OVERFLOW, aMsg))
 149                                 aWarning += aMsg;
 150                         }
 151                         if (rAC.isRowOverflow())
 152                         {
 153                             if (!aMsg.isEmpty())
 154                                 aWarning += "\n";
 155                             if (ErrorHandler::GetErrorString( SCWARN_IMPORT_ROW_OVERFLOW, aMsg))
 156                                 aWarning += aMsg;
 157                         }
 158
 159                         /* XXX displaying a dialog here is ugly and should
 160                          * rather happen at UI level instead of at the filter
 161                          * level, but it seems there's no way to transport
 162                          * detailed information other than returning true or
 163                          * false at this point? */
 164
 165                         std::unique_ptr<weld::MessageDialog> xWarn(Application::CreateMessageDialog(ScDocShell::GetActiveDialogParent(),
 166                                                                    VclMessageType::Warning, VclButtonsType::Ok,
 167                                                                    aWarning));
 168                         xWarn->run();
 169                     }
 170                 }
 171             }
 172             return bRet;
 173         }
 174     }
 175     catch (...)
 176     {
 177     }
 178
 179     return false;
 180 }
 181
 182 bool ExcelFilter::exportDocument() throw()
 183 {
 184     return false;
 185 }
 186
 187 const ::oox::drawingml::Theme* ExcelFilter::getCurrentTheme() const
 188 {
 189     return &WorkbookHelper( getWorkbookGlobals() ).getTheme();
 190 }
 191
 192 ::oox::vml::Drawing* ExcelFilter::getVmlDrawing()
 193 {
 194     return nullptr;
 195 }
 196
 197 TableStyleListPtr ExcelFilter::getTableStyles()
 198 {
 199     return TableStyleListPtr();
 200 }
 201
 202 ::oox::drawingml::chart::ChartConverter* ExcelFilter::getChartConverter()
 203 {
 204     return WorkbookHelper( getWorkbookGlobals() ).getChartConverter();
 205 }
 206
 207 void ExcelFilter::useInternalChartDataTable( bool bInternal )
 208 {
 209     return WorkbookHelper( getWorkbookGlobals() ).useInternalChartDataTable( bInternal );
 210 }
 211
 212 GraphicHelper* ExcelFilter::implCreateGraphicHelper() const
 213 {
 214     return new ExcelGraphicHelper( getWorkbookGlobals() );
 215 }
 216
 217 ::oox::ole::VbaProject* ExcelFilter::implCreateVbaProject() const
 218 {
 219     return new ExcelVbaProject( getComponentContext(), Reference< XSpreadsheetDocument >( getModel(), UNO_QUERY ) );
 220 }
 221
 222 sal_Bool SAL_CALL ExcelFilter::filter( const css::uno::Sequence< css::beans::PropertyValue >& rDescriptor )
 223 {
 224     if ( XmlFilterBase::filter( rDescriptor ) )
 225         return true;
 226
 227     if ( isExportFilter() )
 228     {
 229         bool bExportVBA = exportVBA();
 230         Reference< XExporter > xExporter(
 231             new XclExpXmlStream( getComponentContext(), bExportVBA, isExportTemplate() ) );
 232
 233         Reference< XComponent > xDocument = getModel();
 234         Reference< XFilter > xFilter( xExporter, UNO_QUERY );
 235
 236         if ( xFilter.is() )
 237         {
 238             xExporter->setSourceDocument( xDocument );
 239             if ( xFilter->filter( rDescriptor ) )
 240                 return true;
 241         }
 242     }
 243
 244     return false;
 245 }
 246
 247 OUString ExcelFilter::getImplementationName()
 248 {
 249     return "com.sun.star.comp.oox.xls.ExcelFilter";
 250 }
 251
 252 } // namespace oox::xls
 253
 254
 255 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 256 com_sun_star_comp_oox_xls_ExcelFilter_get_implementation(css::uno::XComponentContext* context,
 257                                                          css::uno::Sequence<css::uno::Any> const &)
 258 {
 259     return cppu::acquire(new oox::xls::ExcelFilter(context));
 260 }
 261
 262
 263 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */