oox/source/xls/excelfilter.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: excelfilter.cxx,v $
  10  * $Revision: 1.6.6.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #include "oox/xls/excelfilter.hxx"
  32 #include "oox/helper/binaryinputstream.hxx"
  33 #include "oox/xls/biffdetector.hxx"
  34 #include "oox/xls/biffinputstream.hxx"
  35 #include "oox/xls/excelchartconverter.hxx"
  36 #include "oox/xls/themebuffer.hxx"
  37 #include "oox/xls/workbookfragment.hxx"
  38 #include "oox/dump/biffdumper.hxx"
  39 #include "oox/dump/xlsbdumper.hxx"
  40
  41 using ::rtl::OUString;
  42 using ::com::sun::star::uno::Any;
  43 using ::com::sun::star::uno::Reference;
  44 using ::com::sun::star::uno::Sequence;
  45 using ::com::sun::star::uno::Exception;
  46 using ::com::sun::star::uno::XInterface;
  47 using ::com::sun::star::lang::XMultiServiceFactory;
  48 using ::com::sun::star::xml::sax::XFastDocumentHandler;
  49 using ::oox::core::BinaryFilterBase;
  50 using ::oox::core::FragmentHandlerRef;
  51 using ::oox::core::Relation;
  52 using ::oox::core::Relations;
  53 using ::oox::core::XmlFilterBase;
  54 using ::oox::drawingml::table::TableStyleListPtr;
  55
  56 namespace oox {
  57 namespace xls {
  58
  59 // ============================================================================
  60
  61 ExcelFilterBase::ExcelFilterBase() :
  62     mpHelper( 0 )
  63 {
  64 }
  65
  66 ExcelFilterBase::~ExcelFilterBase()
  67 {
  68     OSL_ENSURE( !mpHelper, "ExcelFilterBase::~ExcelFilterBase - workbook helper not cleared" );
  69 }
  70
  71 void ExcelFilterBase::setWorkbookHelper( WorkbookHelper& rHelper )
  72 {
  73     mpHelper = &rHelper;
  74 }
  75
  76 WorkbookHelper& ExcelFilterBase::getWorkbookHelper() const
  77 {
  78     OSL_ENSURE( mpHelper, "ExcelFilterBase::getWorkbookHelper - missing workbook helper" );
  79     return *mpHelper;
  80 }
  81
  82 void ExcelFilterBase::clearWorkbookHelper()
  83 {
  84     mpHelper = 0;
  85 }
  86
  87 // ============================================================================
  88
  89 OUString SAL_CALL ExcelFilter_getImplementationName() throw()
  90 {
  91     return CREATE_OUSTRING( "com.sun.star.comp.oox.ExcelFilter" );
  92 }
  93
  94 Sequence< OUString > SAL_CALL ExcelFilter_getSupportedServiceNames() throw()
  95 {
  96     OUString aServiceName = CREATE_OUSTRING( "com.sun.star.comp.oox.ExcelFilter" );
  97     Sequence< OUString > aSeq( &aServiceName, 1 );
  98     return aSeq;
  99 }
 100
 101 Reference< XInterface > SAL_CALL ExcelFilter_createInstance(
 102         const Reference< XMultiServiceFactory >& rxGlobalFactory ) throw( Exception )
 103 {
 104     return static_cast< ::cppu::OWeakObject* >( new ExcelFilter( rxGlobalFactory ) );
 105 }
 106
 107 // ----------------------------------------------------------------------------
 108
 109 ExcelFilter::ExcelFilter( const Reference< XMultiServiceFactory >& rxGlobalFactory ) :
 110     XmlFilterBase( rxGlobalFactory )
 111 {
 112 }
 113
 114 ExcelFilter::~ExcelFilter()
 115 {
 116 }
 117
 118 bool ExcelFilter::importDocument() throw()
 119 {
 120     /*  to activate the XLSX/XLSB dumper, define the environment variable
 121         OOO_XLSBDUMPER and insert the full path to the file
 122         file:///<path-to-oox-module>/source/dump/xlsbdumper.ini. */
 123     OOX_DUMP_FILE( ::oox::dump::xlsb::Dumper );
 124
 125     bool bRet = false;
 126     OUString aWorkbookPath = getFragmentPathFromFirstType( CREATE_OFFICEDOC_RELATIONSTYPE( "officeDocument" ) );
 127     if( aWorkbookPath.getLength() > 0 )
 128     {
 129         WorkbookHelperRoot aHelper( *this );
 130         if( aHelper.isValid() )
 131         {
 132             setWorkbookHelper( aHelper );   // needed for callbacks
 133             bRet = importFragment( new OoxWorkbookFragment( aHelper, aWorkbookPath ) );
 134             clearWorkbookHelper();
 135         }
 136     }
 137     return bRet;
 138 }
 139
 140 bool ExcelFilter::exportDocument() throw()
 141 {
 142     return false;
 143 }
 144
 145 sal_Int32 ExcelFilter::getSchemeColor( sal_Int32 nToken ) const
 146 {
 147     return getWorkbookHelper().getTheme().getColorByToken( nToken );
 148 }
 149
 150 sal_Int32 ExcelFilter::getPaletteColor( sal_Int32 nPaletteIdx ) const
 151 {
 152     return getWorkbookHelper().getStyles().getPaletteColor( nPaletteIdx );
 153 }
 154
 155 const ::oox::drawingml::Theme* ExcelFilter::getCurrentTheme() const
 156 {
 157     return &getWorkbookHelper().getTheme();
 158 }
 159
 160 ::oox::vml::Drawing* ExcelFilter::getVmlDrawing()
 161 {
 162     return 0;
 163 }
 164
 165 const TableStyleListPtr ExcelFilter::getTableStyles()
 166 {
 167     return TableStyleListPtr();
 168 }
 169
 170 ::oox::drawingml::chart::ChartConverter& ExcelFilter::getChartConverter()
 171 {
 172     return getWorkbookHelper().getChartConverter();
 173 }
 174
 175 OUString ExcelFilter::implGetImplementationName() const
 176 {
 177     return ExcelFilter_getImplementationName();
 178 }
 179
 180 // ============================================================================
 181
 182 OUString SAL_CALL ExcelBiffFilter_getImplementationName() throw()
 183 {
 184     return CREATE_OUSTRING( "com.sun.star.comp.oox.ExcelBiffFilter" );
 185 }
 186
 187 Sequence< OUString > SAL_CALL ExcelBiffFilter_getSupportedServiceNames() throw()
 188 {
 189     OUString aServiceName = CREATE_OUSTRING( "com.sun.star.comp.oox.ExcelBiffFilter" );
 190     Sequence< OUString > aSeq( &aServiceName, 1 );
 191     return aSeq;
 192 }
 193
 194 Reference< XInterface > SAL_CALL ExcelBiffFilter_createInstance(
 195         const Reference< XMultiServiceFactory >& rxGlobalFactory ) throw( Exception )
 196 {
 197     return static_cast< ::cppu::OWeakObject* >( new ExcelBiffFilter( rxGlobalFactory ) );
 198 }
 199
 200 // ----------------------------------------------------------------------------
 201
 202 ExcelBiffFilter::ExcelBiffFilter( const Reference< XMultiServiceFactory >& rxGlobalFactory ) :
 203     BinaryFilterBase( rxGlobalFactory )
 204 {
 205 }
 206
 207 ExcelBiffFilter::~ExcelBiffFilter()
 208 {
 209 }
 210
 211 bool ExcelBiffFilter::importDocument() throw()
 212 {
 213     /*  to activate the BIFF dumper, define the environment variable
 214         OOO_BIFFDUMPER and insert the full path to the file
 215         file:///<path-to-oox-module>/source/dump/biffdumper.ini. */
 216     OOX_DUMP_FILE( ::oox::dump::biff::Dumper );
 217
 218     /*  The boolean argument "UseBiffFilter" passed through XInitialisation
 219         decides whether to use the BIFF file dumper implemented in this filter
 220         only (false or missing), or to import/export the document (true). */
 221     Any aUseBiffFilter = getArgument( CREATE_OUSTRING( "UseBiffFilter" ) );
 222     bool bUseBiffFilter = false;
 223     if( !(aUseBiffFilter >>= bUseBiffFilter) || !bUseBiffFilter )
 224         return true;
 225
 226     bool bRet = false;
 227
 228     // detect BIFF version and workbook stream name
 229     OUString aWorkbookName;
 230     BiffType eBiff = BiffDetector::detectStorageBiffVersion( aWorkbookName, getStorage() );
 231     OSL_ENSURE( eBiff != BIFF_UNKNOWN, "ExcelBiffFilter::ExcelBiffFilter - invalid file format" );
 232     if( eBiff != BIFF_UNKNOWN )
 233     {
 234         WorkbookHelperRoot aHelper( *this, eBiff );
 235         if( aHelper.isValid() )
 236         {
 237             setWorkbookHelper( aHelper );   // needed for callbacks
 238             bRet = BiffWorkbookFragment( aHelper, aWorkbookName ).importFragment();
 239             clearWorkbookHelper();
 240         }
 241     }
 242     return bRet;
 243 }
 244
 245 bool ExcelBiffFilter::exportDocument() throw()
 246 {
 247     return false;
 248 }
 249
 250 sal_Int32 ExcelBiffFilter::getPaletteColor( sal_Int32 nPaletteIdx ) const
 251 {
 252     return getWorkbookHelper().getStyles().getPaletteColor( nPaletteIdx );
 253 }
 254
 255 OUString ExcelBiffFilter::implGetImplementationName() const
 256 {
 257     return ExcelBiffFilter_getImplementationName();
 258 }
 259
 260 // ============================================================================
 261
 262 } // namespace xls
 263 } // namespace oox
 264