sc/source/filter/oox/tablebuffer.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 <tablebuffer.hxx>
  21
  22 #include <com/sun/star/beans/XPropertySet.hpp>
  23 #include <com/sun/star/sheet/XDatabaseRange.hpp>
  24 #include <com/sun/star/sheet/XDatabaseRanges.hpp>
  25 #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
  26 #include <osl/diagnose.h>
  27 #include <sal/log.hxx>
  28 #include <oox/helper/attributelist.hxx>
  29 #include <oox/helper/binaryinputstream.hxx>
  30 #include <oox/helper/propertyset.hxx>
  31 #include <oox/token/properties.hxx>
  32 #include <oox/token/tokens.hxx>
  33 #include <addressconverter.hxx>
  34 #include <biffhelper.hxx>
  35 #include <docuno.hxx>
  36
  37 namespace oox::xls {
  38
  39 using namespace ::com::sun::star::sheet;
  40 using namespace ::com::sun::star::uno;
  41
  42 TableModel::TableModel() :
  43     mnId( -1 ),
  44     mnType( XML_worksheet ),
  45     mnHeaderRows( 1 ),
  46     mnTotalsRows( 0 )
  47 {
  48 }
  49
  50 Table::Table( const WorkbookHelper& rHelper ) :
  51     WorkbookHelper( rHelper ),
  52     maAutoFilters( rHelper ),
  53     maTableColumns( rHelper ),
  54     mnTokenIndex( -1 )
  55 {
  56 }
  57
  58 void Table::importTable( const AttributeList& rAttribs, sal_Int16 nSheet )
  59 {
  60     AddressConverter::convertToCellRangeUnchecked(maModel.maRange,
  61                                                   rAttribs.getString(XML_ref, OUString()), nSheet,
  62                                                   getScDocument());
  63     maModel.maProgName    = rAttribs.getXString( XML_name, OUString() );
  64     maModel.maDisplayName = rAttribs.getXString( XML_displayName, OUString() );
  65     maModel.mnId          = rAttribs.getInteger( XML_id, -1 );
  66     maModel.mnType        = rAttribs.getToken( XML_tableType, XML_worksheet );
  67     maModel.mnHeaderRows  = rAttribs.getInteger( XML_headerRowCount, 1 );
  68     maModel.mnTotalsRows  = rAttribs.getInteger( XML_totalsRowCount, 0 );
  69 }
  70
  71 void Table::importTable( SequenceInputStream& rStrm, sal_Int16 nSheet )
  72 {
  73     BinRange aBinRange;
  74     sal_Int32 nType;
  75     rStrm >> aBinRange;
  76     nType = rStrm.readInt32();
  77     maModel.mnId = rStrm.readInt32();
  78     maModel.mnHeaderRows = rStrm.readInt32();
  79     maModel.mnTotalsRows = rStrm.readInt32();
  80     rStrm.skip( 32 );
  81     rStrm >> maModel.maProgName >> maModel.maDisplayName;
  82
  83     AddressConverter::convertToCellRangeUnchecked( maModel.maRange, aBinRange, nSheet );
  84     static const sal_Int32 spnTypes[] = { XML_worksheet, XML_TOKEN_INVALID, XML_TOKEN_INVALID, XML_queryTable };
  85     maModel.mnType = STATIC_ARRAY_SELECT( spnTypes, nType, XML_TOKEN_INVALID );
  86 }
  87
  88 void Table::finalizeImport()
  89 {
  90     // Create database range.  Note that Excel 2007 and later names database
  91     // ranges (or tables in their terminology) as Table1, Table2 etc.  We need
  92     // to import them as named db ranges because they may be referenced by
  93     // name in formula expressions.
  94     if( (maModel.mnId <= 0) || maModel.maDisplayName.isEmpty() )
  95         return;
  96
  97     try
  98     {
  99         maDBRangeName = maModel.maDisplayName;
 100
 101         Reference< XDatabaseRange > xDatabaseRange(
 102             createDatabaseRangeObject( maDBRangeName, maModel.maRange ), UNO_SET_THROW);
 103         ::css::table::CellRangeAddress aAddressRange = xDatabaseRange->getDataArea();
 104         maDestRange = ScRange( aAddressRange.StartColumn, aAddressRange.StartRow, aAddressRange.Sheet,
 105                                aAddressRange.EndColumn, aAddressRange.EndRow, aAddressRange.Sheet );
 106
 107         PropertySet aPropSet( xDatabaseRange );
 108
 109         // Default HasHeader is true at ScDBData.
 110         if (maModel.mnHeaderRows != 1)
 111         {
 112             SAL_WARN_IF( maModel.mnHeaderRows > 1, "sc.filter",
 113                     "Table HeaderRows > 1 not supported: " << maModel.mnHeaderRows);
 114             if (maModel.mnHeaderRows == 0)
 115                 aPropSet.setProperty( PROP_ContainsHeader, false);
 116         }
 117
 118         if (maModel.mnTotalsRows > 0)
 119         {
 120             SAL_WARN_IF( maModel.mnTotalsRows > 1, "sc.filter",
 121                     "Table TotalsRows > 1 not supported: " << maModel.mnTotalsRows);
 122             aPropSet.setProperty( PROP_TotalsRow, true);
 123         }
 124
 125         // get formula token index of the database range
 126         if( !aPropSet.getProperty( mnTokenIndex, PROP_TokenIndex ) )
 127             mnTokenIndex = -1;
 128     }
 129     catch( Exception& )
 130     {
 131         OSL_FAIL( "Table::finalizeImport - cannot create database range" );
 132     }
 133 }
 134
 135 void Table::applyAutoFilters()
 136 {
 137     if( maDBRangeName.isEmpty() )
 138         return;
 139
 140     try
 141     {
 142         // get the range ( maybe we should cache the xDatabaseRange from finalizeImport )
 143         PropertySet aDocProps(( Reference< css::beans::XPropertySet >(getDocument()) ));
 144         Reference< XDatabaseRanges > xDatabaseRanges( aDocProps.getAnyProperty( PROP_DatabaseRanges ), UNO_QUERY_THROW );
 145         Reference< XDatabaseRange > xDatabaseRange( xDatabaseRanges->getByName( maDBRangeName ), UNO_QUERY );
 146         maAutoFilters.finalizeImport( xDatabaseRange, maModel.maRange.aStart.Tab() );
 147     }
 148     catch( Exception& )
 149     {
 150         OSL_FAIL( "Table::applyAutofilters - cannot create filter" );
 151     }
 152 }
 153
 154 void Table::applyTableColumns()
 155 {
 156     maTableColumns.finalizeImport( findDatabaseRangeByIndex( mnTokenIndex ));
 157 }
 158
 159 TableBuffer::TableBuffer( const WorkbookHelper& rHelper ) :
 160     WorkbookHelper( rHelper )
 161 {
 162 }
 163
 164 Table& TableBuffer::createTable()
 165 {
 166     TableVector::value_type xTable = std::make_shared<Table>( *this );
 167     maTables.push_back( xTable );
 168     return *xTable;
 169 }
 170
 171 void TableBuffer::finalizeImport()
 172 {
 173     // map all tables by identifier and display name
 174     for( const auto& rxTable : maTables )
 175         insertTableToMaps( rxTable );
 176     // finalize all valid tables
 177     maIdTables.forEachMem( &Table::finalizeImport );
 178 }
 179
 180 void TableBuffer::applyAutoFilters()
 181 {
 182     maIdTables.forEachMem( &Table::applyAutoFilters );
 183 }
 184
 185 void TableBuffer::applyTableColumns()
 186 {
 187     maIdTables.forEachMem( &Table::applyTableColumns );
 188 }
 189
 190 TableRef TableBuffer::getTable( sal_Int32 nTableId ) const
 191 {
 192     return maIdTables.get( nTableId );
 193 }
 194
 195 TableRef TableBuffer::getTable( const OUString& rDispName ) const
 196 {
 197     return maNameTables.get( rDispName );
 198 }
 199
 200 // private --------------------------------------------------------------------
 201
 202 void TableBuffer::insertTableToMaps( const TableRef& rxTable )
 203 {
 204     sal_Int32 nTableId = rxTable->getTableId();
 205     const OUString& rDispName = rxTable->getDisplayName();
 206     if( (nTableId > 0) && !rDispName.isEmpty() )
 207     {
 208         OSL_ENSURE( !maIdTables.has( nTableId ), "TableBuffer::insertTableToMaps - multiple table identifier" );
 209         maIdTables[ nTableId ] = rxTable;
 210         OSL_ENSURE( !maNameTables.has( rDispName ), "TableBuffer::insertTableToMaps - multiple table name" );
 211         maNameTables[ rDispName ] = rxTable;
 212     }
 213 }
 214
 215 } // namespace oox::xls
 216
 217 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */