/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <calc/CTable.hxx>
#include <com/sun/star/sdbc/ColumnValue.hpp>
#include <com/sun/star/sdbc/DataType.hpp>
#include <com/sun/star/sdbc/SQLException.hpp>
#include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
#include <com/sun/star/sheet/XSpreadsheet.hpp>
#include <com/sun/star/sheet/XCellRangeAddressable.hpp>
#include <com/sun/star/sheet/XCellRangesQuery.hpp>
#include <com/sun/star/sheet/XDatabaseRanges.hpp>
#include <com/sun/star/sheet/XDatabaseRange.hpp>
#include <com/sun/star/sheet/XCellRangeReferrer.hpp>
#include <com/sun/star/sheet/XUsedAreaCursor.hpp>
#include <com/sun/star/sheet/CellFlags.hpp>
#include <com/sun/star/sheet/FormulaResult.hpp>
#include <com/sun/star/util/NumberFormat.hpp>
#include <com/sun/star/util/XNumberFormatsSupplier.hpp>
#include <com/sun/star/text/XText.hpp>
#include <calc/CConnection.hxx>
#include <connectivity/sdbcx/VColumn.hxx>
#include <rtl/ustrbuf.hxx>
#include <sal/log.hxx>
#include <rtl/math.hxx>
#include <tools/time.hxx>
#include <comphelper/servicehelper.hxx>
using namespace connectivity;
using namespace connectivity::calc;
using namespace connectivity::file;
using namespace ::cppu;
using namespace ::dbtools;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::sdbc;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::sheet;
using namespace ::com::sun::star::table;
using namespace ::com::sun::star::text;
using namespace ::com::sun::star::util;
static void lcl_UpdateArea( const Reference<XCellRange>& xUsedRange, sal_Int32& rEndCol, sal_Int32& rEndRow )
{
// update rEndCol, rEndRow if any non-empty cell in xUsedRange is right/below
const Reference<XCellRangesQuery> xUsedQuery( xUsedRange, UNO_QUERY );
if ( !xUsedQuery.is() )
return;
const sal_Int16 nContentFlags =
CellFlags::STRING | CellFlags::VALUE | CellFlags::DATETIME | CellFlags::FORMULA | CellFlags::ANNOTATION;
const Reference<XSheetCellRanges> xUsedRanges = xUsedQuery->queryContentCells( nContentFlags );
for (auto& address : xUsedRanges->getRangeAddresses())
{
rEndCol = std::max(address.EndColumn, rEndCol);
rEndRow = std::max(address.EndRow, rEndRow);
}
}
static void lcl_GetDataArea( const Reference<XSpreadsheet>& xSheet, sal_Int32& rColumnCount, sal_Int32& rRowCount )
{
Reference<XSheetCellCursor> xCursor = xSheet->createCursor();
Reference<XCellRangeAddressable> xRange( xCursor, UNO_QUERY );
if ( !xRange.is() )
{
rColumnCount = rRowCount = 0;
return;
}
// first find the contiguous cell area starting at A1
xCursor->collapseToSize( 1, 1 ); // single (first) cell
xCursor->collapseToCurrentRegion(); // contiguous data area
CellRangeAddress aRegionAddr = xRange->getRangeAddress();
sal_Int32 nEndCol = aRegionAddr.EndColumn;
sal_Int32 nEndRow = aRegionAddr.EndRow;
Reference<XUsedAreaCursor> xUsed( xCursor, UNO_QUERY );
if ( xUsed.is() )
{
// The used area from XUsedAreaCursor includes visible attributes.
// If the used area is larger than the contiguous cell area, find non-empty
// cells in that area.
xUsed->gotoEndOfUsedArea( false );
CellRangeAddress aUsedAddr = xRange->getRangeAddress();
if ( aUsedAddr.EndColumn > aRegionAddr.EndColumn )
{
Reference<XCellRange> xUsedRange = xSheet->getCellRangeByPosition(
aRegionAddr.EndColumn + 1, 0, aUsedAddr.EndColumn, aUsedAddr.EndRow );
lcl_UpdateArea( xUsedRange, nEndCol, nEndRow );
}
if ( aUsedAddr.EndRow > aRegionAddr.EndRow )
{
// only up to the last column of aRegionAddr, the other columns are handled above
Reference<XCellRange> xUsedRange = xSheet->getCellRangeByPosition(
0, aRegionAddr.EndRow + 1, aRegionAddr.EndColumn, aUsedAddr.EndRow );
lcl_UpdateArea( xUsedRange, nEndCol, nEndRow );
}
}
rColumnCount = nEndCol + 1; // number of columns
rRowCount = nEndRow; // first row (headers) is not counted
}
static CellContentType lcl_GetContentOrResultType( const Reference<XCell>& xCell )
{
CellContentType eCellType = xCell->getType();
if ( eCellType == CellContentType_FORMULA )
{
Reference<XPropertySet> xProp( xCell, UNO_QUERY );
try
{
xProp->getPropertyValue( u"CellContentType"_ustr ) >>= eCellType; // type of cell content
}
catch (UnknownPropertyException&)
{
eCellType = CellContentType_VALUE; // if CellContentType property not available
}
}
return eCellType;
}
static Reference<XCell> lcl_GetUsedCell( const Reference<XSpreadsheet>& xSheet, sal_Int32 nDocColumn, sal_Int32 nDocRow )
{
Reference<XCell> xCell = xSheet->getCellByPosition( nDocColumn, nDocRow );
if ( xCell.is() && xCell->getType() == CellContentType_EMPTY )
{
// get first non-empty cell
Reference<XCellRangeAddressable> xAddr( xSheet, UNO_QUERY );
if (xAddr.is())
{
CellRangeAddress aTotalRange = xAddr->getRangeAddress();
sal_Int32 nLastRow = aTotalRange.EndRow;
Reference<XCellRangesQuery> xQuery( xSheet->getCellRangeByPosition( nDocColumn, nDocRow, nDocColumn, nLastRow ), UNO_QUERY );
if (xQuery.is())
{
// queryIntersection to get a ranges object
Reference<XSheetCellRanges> xRanges = xQuery->queryIntersection( aTotalRange );
if (xRanges.is())
{
Reference<XEnumerationAccess> xCells = xRanges->getCells();
if (xCells.is())
{
Reference<XEnumeration> xEnum = xCells->createEnumeration();
if ( xEnum.is() && xEnum->hasMoreElements() )
{
// get first non-empty cell from enumeration
xCell.set(xEnum->nextElement(),UNO_QUERY);
}
// otherwise, keep empty cell
}
}
}
}
}
return xCell;
}
static bool lcl_HasTextInColumn( const Reference<XSpreadsheet>& xSheet, sal_Int32 nDocColumn, sal_Int32 nDocRow )
{
// look for any text cell or text result in the column
Reference<XCellRangeAddressable> xAddr( xSheet, UNO_QUERY );
if (!xAddr)
return false;
CellRangeAddress aTotalRange = xAddr->getRangeAddress();
sal_Int32 nLastRow = aTotalRange.EndRow;
Reference<XCellRangesQuery> xQuery( xSheet->getCellRangeByPosition( nDocColumn, nDocRow, nDocColumn, nLastRow ), UNO_QUERY );
if (!xQuery)
return false;
// are there text cells in the column?
Reference<XSheetCellRanges> xTextContent = xQuery->queryContentCells( CellFlags::STRING );
if ( xTextContent.is() && xTextContent->hasElements() )
return true;
// are there formulas with text results in the column?
Reference<XSheetCellRanges> xTextFormula = xQuery->queryFormulaCells( FormulaResult::STRING );
if ( xTextFormula.is() && xTextFormula->hasElements() )
return true;
return false;
}
static void lcl_GetColumnInfo( const Reference<XSpreadsheet>& xSheet, const Reference<XNumberFormats>& xFormats,
sal_Int32 nDocColumn, sal_Int32 nStartRow, bool bHasHeaders,
OUString& rName, sal_Int32& rDataType, bool& rCurrency )
{
//! avoid duplicate field names
// get column name from first row, if range contains headers
if ( bHasHeaders )
{
Reference<XText> xHeaderText( xSheet->getCellByPosition( nDocColumn, nStartRow ), UNO_QUERY );
if ( xHeaderText.is() )
rName = xHeaderText->getString();
}
// get column type from first data row
sal_Int32 nDataRow = nStartRow;
if ( bHasHeaders )
++nDataRow;
Reference<XCell> xDataCell = lcl_GetUsedCell( xSheet, nDocColumn, nDataRow );
Reference<XPropertySet> xProp( xDataCell, UNO_QUERY );
if ( !xProp.is() )
return;
rCurrency = false; // set to true for currency below
const CellContentType eCellType = lcl_GetContentOrResultType( xDataCell );
// #i35178# use "text" type if there is any text cell in the column
if ( eCellType == CellContentType_TEXT || lcl_HasTextInColumn( xSheet, nDocColumn, nDataRow ) )
rDataType = DataType::VARCHAR;
else if ( eCellType == CellContentType_VALUE )
{
// get number format to distinguish between different types
sal_Int16 nNumType = NumberFormat::NUMBER;
try
{
sal_Int32 nKey = 0;
if ( xProp->getPropertyValue( u"NumberFormat"_ustr ) >>= nKey )
{
const Reference<XPropertySet> xFormat = xFormats->getByKey( nKey );
if ( xFormat.is() )
{
xFormat->getPropertyValue( OMetaConnection::getPropMap().getNameByIndex(PROPERTY_ID_TYPE) ) >>= nNumType;
}
}
}
catch ( Exception& )
{
}
if ( nNumType & NumberFormat::TEXT )
rDataType = DataType::VARCHAR;
else if ( nNumType & NumberFormat::NUMBER )
rDataType = DataType::DECIMAL;
else if ( nNumType & NumberFormat::CURRENCY )
{
rCurrency = true;
rDataType = DataType::DECIMAL;
}
else if ( ( nNumType & NumberFormat::DATETIME ) == NumberFormat::DATETIME )
{
// NumberFormat::DATETIME is DATE | TIME
rDataType = DataType::TIMESTAMP;
}
else if ( nNumType & NumberFormat::DATE )
rDataType = DataType::DATE;
else if ( nNumType & NumberFormat::TIME )
rDataType = DataType::TIME;
else if ( nNumType & NumberFormat::LOGICAL )
rDataType = DataType::BIT;
else
rDataType = DataType::DECIMAL;
}
else
{
// whole column empty
rDataType = DataType::VARCHAR;
}
}
static void lcl_SetValue( ORowSetValue& rValue, const Reference<XSpreadsheet>& xSheet,
sal_Int32 nStartCol, sal_Int32 nStartRow, bool bHasHeaders,
const ::Date& rNullDate,
sal_Int32 nDBRow, sal_Int32 nDBColumn, sal_Int32 nType )
{
sal_Int32 nDocColumn = nStartCol + nDBColumn - 1; // database counts from 1
sal_Int32 nDocRow = nStartRow + nDBRow - 1;
if (bHasHeaders)
++nDocRow;
const Reference<XCell> xCell = xSheet->getCellByPosition( nDocColumn, nDocRow );
if ( !xCell.is() )
return;
CellContentType eCellType = lcl_GetContentOrResultType( xCell );
switch (nType)
{
case DataType::VARCHAR:
if ( eCellType == CellContentType_EMPTY )
rValue.setNull();
else
{
// #i25840# still let Calc convert numbers to text
const Reference<XText> xText( xCell, UNO_QUERY );
if ( xText.is() )
rValue = xText->getString();
}
break;
case DataType::DECIMAL:
if ( eCellType == CellContentType_VALUE )
rValue = xCell->getValue(); // double
else
rValue.setNull();
break;
case DataType::BIT:
if ( eCellType == CellContentType_VALUE )
rValue = xCell->getValue() != 0.0;
else
rValue.setNull();
break;
case DataType::DATE:
if ( eCellType == CellContentType_VALUE )
{
::Date aDate( rNullDate );
aDate.AddDays(::rtl::math::approxFloor( xCell->getValue() ));
rValue = aDate.GetUNODate();
}
else
rValue.setNull();
break;
case DataType::TIME:
if ( eCellType == CellContentType_VALUE )
{
double fCellVal = xCell->getValue();
double fTime = fCellVal - rtl::math::approxFloor( fCellVal );
sal_Int64 nIntTime = static_cast<sal_Int64>(rtl::math::round( fTime * static_cast<double>(::tools::Time::nanoSecPerDay) ));
if ( nIntTime == ::tools::Time::nanoSecPerDay)
nIntTime = 0; // 23:59:59.9999999995 and above is 00:00:00.00
css::util::Time aTime;
aTime.NanoSeconds = static_cast<sal_uInt32>( nIntTime % ::tools::Time::nanoSecPerSec );
nIntTime /= ::tools::Time::nanoSecPerSec;
aTime.Seconds = static_cast<sal_uInt16>( nIntTime % 60 );
nIntTime /= 60;
aTime.Minutes = static_cast<sal_uInt16>( nIntTime % 60 );
nIntTime /= 60;
OSL_ENSURE( nIntTime < 24, "error in time calculation" );
aTime.Hours = static_cast<sal_uInt16>(nIntTime);
rValue = aTime;
}
else
rValue.setNull();
break;
case DataType::TIMESTAMP:
if ( eCellType == CellContentType_VALUE )
{
double fCellVal = xCell->getValue();
double fDays = ::rtl::math::approxFloor( fCellVal );
double fTime = fCellVal - fDays;
tools::Long nIntDays = static_cast<tools::Long>(fDays);
sal_Int64 nIntTime = ::rtl::math::round( fTime * static_cast<double>(::tools::Time::nanoSecPerDay) );
if ( nIntTime == ::tools::Time::nanoSecPerDay )
{
nIntTime = 0; // 23:59:59.9999999995 and above is 00:00:00.00
++nIntDays; // (next day)
}
css::util::DateTime aDateTime;
aDateTime.NanoSeconds = static_cast<sal_uInt16>( nIntTime % ::tools::Time::nanoSecPerSec );
nIntTime /= ::tools::Time::nanoSecPerSec;
aDateTime.Seconds = static_cast<sal_uInt16>( nIntTime % 60 );
nIntTime /= 60;
aDateTime.Minutes = static_cast<sal_uInt16>( nIntTime % 60 );
nIntTime /= 60;
OSL_ENSURE( nIntTime < 24, "error in time calculation" );
aDateTime.Hours = static_cast<sal_uInt16>(nIntTime);
::Date aDate( rNullDate );
aDate.AddDays( nIntDays );
aDateTime.Day = aDate.GetDay();
aDateTime.Month = aDate.GetMonth();
aDateTime.Year = aDate.GetYear();
rValue = aDateTime;
}
else
rValue.setNull();
break;
} // switch (nType)
// rValue.setTypeKind(nType);
}
static OUString lcl_GetColumnStr( sal_Int32 nColumn )
{
if ( nColumn < 26 )
return OUString( static_cast<sal_Unicode>( 'A' + nColumn ) );
else
{
OUStringBuffer aBuffer(2);
aBuffer.setLength( 2 );
aBuffer[0] = static_cast<sal_Unicode>( 'A' + ( nColumn / 26 ) - 1 );
aBuffer[1] = static_cast<sal_Unicode>( 'A' + ( nColumn % 26 ) );
return aBuffer.makeStringAndClear();
}
}
void OCalcTable::fillColumns()
{
if ( !m_xSheet.is() )
throw SQLException();
OUString aTypeName;
::comphelper::UStringMixEqual aCase(m_pConnection->getMetaData()->supportsMixedCaseQuotedIdentifiers());
const bool bStoresMixedCaseQuotedIdentifiers = getConnection()->getMetaData()->supportsMixedCaseQuotedIdentifiers();
for (sal_Int32 i = 0; i < m_nDataCols; i++)
{
OUString aColumnName;
sal_Int32 eType = DataType::OTHER;
bool bCurrency = false;
lcl_GetColumnInfo( m_xSheet, m_xFormats, m_nStartCol + i, m_nStartRow, m_bHasHeaders,
aColumnName, eType, bCurrency );
if ( aColumnName.isEmpty() )
aColumnName = lcl_GetColumnStr( i );
sal_Int32 nPrecision = 0; //! ...
sal_Int32 nDecimals = 0; //! ...
switch ( eType )
{
case DataType::VARCHAR:
aTypeName = "VARCHAR";
break;
case DataType::DECIMAL:
aTypeName = "DECIMAL";
break;
case DataType::BIT:
aTypeName = "BOOL";
break;
case DataType::DATE:
aTypeName = "DATE";
break;
case DataType::TIME:
aTypeName = "TIME";
break;
case DataType::TIMESTAMP:
aTypeName = "TIMESTAMP";
break;
default:
SAL_WARN( "connectivity.drivers","missing type name");
aTypeName.clear();
}
// check if the column name already exists
OUString aAlias = aColumnName;
OSQLColumns::const_iterator aFind = connectivity::find(m_aColumns->begin(),m_aColumns->end(),aAlias,aCase);
sal_Int32 nExprCnt = 0;
while(aFind != m_aColumns->end())
{
aAlias = aColumnName + OUString::number(++nExprCnt);
aFind = connectivity::find(m_aColumns->begin(),m_aColumns->end(),aAlias,aCase);
}
rtl::Reference<sdbcx::OColumn> pColumn = new sdbcx::OColumn( aAlias, aTypeName, OUString(),OUString(),
ColumnValue::NULLABLE, nPrecision, nDecimals,
eType, false, false, bCurrency,
bStoresMixedCaseQuotedIdentifiers,
m_CatalogName, getSchema(), getName());
m_aColumns->push_back(pColumn);
m_aTypes.push_back(eType);
}
}
OCalcTable::OCalcTable(sdbcx::OCollection* _pTables,OCalcConnection* _pConnection,
const OUString& Name,
const OUString& Type,
const OUString& Description ,
const OUString& SchemaName,
const OUString& CatalogName
) : OCalcTable_BASE(_pTables,_pConnection,Name,
Type,
Description,
SchemaName,
CatalogName)
,m_pCalcConnection(_pConnection)
,m_nStartCol(0)
,m_nStartRow(0)
,m_nDataCols(0)
,m_bHasHeaders(false)
,m_aNullDate(::Date::EMPTY)
{
}
void OCalcTable::construct()
{
// get sheet object
Reference< XSpreadsheetDocument> xDoc = m_pCalcConnection->acquireDoc();
if (xDoc.is())
{
Reference<XSpreadsheets> xSheets = xDoc->getSheets();
if ( xSheets.is() && xSheets->hasByName( m_Name ) )
{
m_xSheet.set(xSheets->getByName( m_Name ),UNO_QUERY);
if ( m_xSheet.is() )
{
lcl_GetDataArea( m_xSheet, m_nDataCols, m_nDataRows );
m_bHasHeaders = true;
// whole sheet is always assumed to include a header row
}
}
else // no sheet -> try database range
{
Reference<XPropertySet> xDocProp( xDoc, UNO_QUERY );
if ( xDocProp.is() )
{
Reference<XDatabaseRanges> xRanges(xDocProp->getPropertyValue(u"DatabaseRanges"_ustr),UNO_QUERY);
if ( xRanges.is() && xRanges->hasByName( m_Name ) )
{
Reference<XDatabaseRange> xDBRange(xRanges->getByName( m_Name ),UNO_QUERY);
Reference<XCellRangeReferrer> xRefer( xDBRange, UNO_QUERY );
if ( xRefer.is() )
{
// Header flag is always stored with database range
// Get flag from FilterDescriptor
bool bRangeHeader = true;
Reference<XPropertySet> xFiltProp( xDBRange->getFilterDescriptor(), UNO_QUERY );
if ( xFiltProp.is() )
xFiltProp->getPropertyValue(u"ContainsHeader"_ustr) >>= bRangeHeader;
Reference<XSheetCellRange> xSheetRange( xRefer->getReferredCells(), UNO_QUERY );
Reference<XCellRangeAddressable> xAddr( xSheetRange, UNO_QUERY );
if ( xSheetRange.is() && xAddr.is() )
{
m_xSheet = xSheetRange->getSpreadsheet();
CellRangeAddress aRangeAddr = xAddr->getRangeAddress();
m_nStartCol = aRangeAddr.StartColumn;
m_nStartRow = aRangeAddr.StartRow;
m_nDataCols = aRangeAddr.EndColumn - m_nStartCol + 1;
// m_nDataRows is excluding header row
m_nDataRows = aRangeAddr.EndRow - m_nStartRow;
if ( !bRangeHeader )
{
// m_nDataRows counts the whole range
m_nDataRows += 1;
}
m_bHasHeaders = bRangeHeader;
}
}
}
}
}
Reference<XNumberFormatsSupplier> xSupp( xDoc, UNO_QUERY );
if (xSupp.is())
m_xFormats = xSupp->getNumberFormats();
Reference<XPropertySet> xProp( xDoc, UNO_QUERY );
if (xProp.is())
{
css::util::Date aDateStruct;
if ( xProp->getPropertyValue(u"NullDate"_ustr) >>= aDateStruct )
m_aNullDate = ::Date( aDateStruct.Day, aDateStruct.Month, aDateStruct.Year );
}
}
//! default if no null date available?
fillColumns();
refreshColumns();
}
void SAL_CALL OCalcTable::disposing()
{
OFileTable::disposing();
::osl::MutexGuard aGuard(m_aMutex);
m_aColumns = nullptr;
if ( m_pCalcConnection )
m_pCalcConnection->releaseDoc();
m_pCalcConnection = nullptr;
}
bool OCalcTable::fetchRow( OValueRefRow& _rRow, const OSQLColumns & _rCols,
bool bRetrieveData )
{
// read the bookmark
_rRow->setDeleted(false);
*(*_rRow)[0] = m_nFilePos;
if (!bRetrieveData)
return true;
// fields
const OValueRefVector::size_type nCount = std::min(_rRow->size(), _rCols.size() + 1);
for (OValueRefVector::size_type i = 1; i < nCount; i++)
{
if ( (*_rRow)[i]->isBound() )
{
sal_Int32 nType = m_aTypes[i-1];
lcl_SetValue( (*_rRow)[i]->get(), m_xSheet, m_nStartCol, m_nStartRow, m_bHasHeaders,
m_aNullDate, m_nFilePos, i, nType );
}
}
return true;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
↑ V547 Expression 'nNumType & NumberFormat::TEXT' is always false.
↑ V547 Expression 'nNumType & NumberFormat::NUMBER' is always true.
↑ V547 Expression '!bRangeHeader' is always false.