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