office-gobmx/sc/source/ui/vba/vbaworkbooks.cxx
Noel Grandin 5a602ed852 loplugin:ostr in sc/.../vba
Change-Id: Ifdf0ebba617432f49e2c14c8a52c495dc1c6a36a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/167853
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Jenkins
2024-05-20 14:40:36 +02:00

291 lines
10 KiB
C++

/* -*- 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 <com/sun/star/sheet/XSpreadsheetDocument.hpp>
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/document/XTypeDetection.hpp>
#include <tools/urlobj.hxx>
#include "excelvbahelper.hxx"
#include "vbaworkbook.hxx"
#include "vbaworkbooks.hxx"
#include <vbahelper/vbahelper.hxx>
#include <comphelper/propertyvalue.hxx>
#include <o3tl/string_view.hxx>
#include <osl/file.hxx>
#include <rtl/ref.hxx>
using namespace ::ooo::vba;
using namespace ::com::sun::star;
const sal_Int16 CUSTOM_CHAR = 5;
static uno::Any
getWorkbook( const uno::Reference< uno::XComponentContext >& xContext,
const uno::Reference< sheet::XSpreadsheetDocument > &xDoc,
const uno::Reference< XHelperInterface >& xParent )
{
// FIXME: fine as long as ScVbaWorkbook is stateless ...
uno::Reference< frame::XModel > xModel( xDoc, uno::UNO_QUERY );
if( !xModel.is() )
return uno::Any();
uno::Reference< excel::XWorkbook > xWb( getVBADocument( xModel ), uno::UNO_QUERY );
if ( xWb.is() )
{
return uno::Any( xWb );
}
rtl::Reference<ScVbaWorkbook> pWb = new ScVbaWorkbook( xParent, xContext, xModel );
return uno::Any( uno::Reference< excel::XWorkbook > (pWb) );
}
namespace {
class WorkBookEnumImpl : public EnumerationHelperImpl
{
public:
/// @throws uno::RuntimeException
WorkBookEnumImpl( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< uno::XComponentContext >& xContext, const uno::Reference< container::XEnumeration >& xEnumeration ) : EnumerationHelperImpl( xParent, xContext, xEnumeration ) {}
virtual uno::Any SAL_CALL nextElement( ) override
{
uno::Reference< sheet::XSpreadsheetDocument > xDoc( m_xEnumeration->nextElement(), uno::UNO_QUERY_THROW );
return getWorkbook( m_xContext, xDoc, m_xParent );
}
};
}
ScVbaWorkbooks::ScVbaWorkbooks( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< css::uno::XComponentContext >& xContext ) : ScVbaWorkbooks_BASE( xParent, xContext, VbaDocumentsBase::EXCEL_DOCUMENT )
{
}
// XEnumerationAccess
uno::Type
ScVbaWorkbooks::getElementType()
{
return cppu::UnoType<excel::XWorkbook>::get();
}
uno::Reference< container::XEnumeration >
ScVbaWorkbooks::createEnumeration()
{
// #FIXME it's possible the WorkBookEnumImpl here doesn't reflect
// the state of this object ( although it should ) would be
// safer to create an enumeration based on this objects state
// rather than one effectively based of the desktop component
uno::Reference< container::XEnumerationAccess > xEnumerationAccess( m_xIndexAccess, uno::UNO_QUERY_THROW );
return new WorkBookEnumImpl( mxParent, mxContext, xEnumerationAccess->createEnumeration() );
}
uno::Any
ScVbaWorkbooks::createCollectionObject( const css::uno::Any& aSource )
{
uno::Reference< sheet::XSpreadsheetDocument > xDoc( aSource, uno::UNO_QUERY_THROW );
return getWorkbook( mxContext, xDoc, mxParent );
}
uno::Any SAL_CALL
ScVbaWorkbooks::Add( const uno::Any& Template )
{
uno::Reference< sheet::XSpreadsheetDocument > xSpreadDoc;
sal_Int32 nWorkbookType = 0;
OUString aTemplateFileName;
if( Template >>= nWorkbookType )
{
// nWorkbookType is a constant from XlWBATemplate (added in Excel 2007)
// TODO: create chart-sheet if supported by Calc
xSpreadDoc.set( createDocument(), uno::UNO_QUERY_THROW );
// create a document with one sheet only
uno::Reference< sheet::XSpreadsheets > xSheets( xSpreadDoc->getSheets(), uno::UNO_SET_THROW );
uno::Reference< container::XIndexAccess > xSheetsIA( xSheets, uno::UNO_QUERY_THROW );
while( xSheetsIA->getCount() > 1 )
{
uno::Reference< container::XNamed > xSheetName( xSheetsIA->getByIndex( xSheetsIA->getCount() - 1 ), uno::UNO_QUERY_THROW );
xSheets->removeByName( xSheetName->getName() );
}
}
else if( Template >>= aTemplateFileName )
{
// TODO: create document from template
xSpreadDoc.set( createDocument(), uno::UNO_QUERY_THROW );
}
else if( !Template.hasValue() )
{
// regular spreadsheet document with configured number of sheets
xSpreadDoc.set( createDocument(), uno::UNO_QUERY_THROW );
}
else
{
// illegal argument
throw uno::RuntimeException();
}
// need to set up the document modules ( and vba mode ) here
excel::setUpDocumentModules( xSpreadDoc );
if (!xSpreadDoc.is())
return uno::Any();
uno::Any aRet = getWorkbook( mxContext, xSpreadDoc, mxParent );
uno::Reference< excel::XWorkbook > xWBook( aRet, uno::UNO_QUERY );
if (xWBook.is())
xWBook->Activate();
return aRet;
}
void SAL_CALL
ScVbaWorkbooks::Close()
{
}
bool
ScVbaWorkbooks::isTextFile( std::u16string_view sType )
{
// will return true if the file is
// a) a variant of a text file
// b) a csv file
// c) unknown
// returning true basically means treat this like a csv file
return sType == u"generic_Text" || sType.empty();
}
bool
ScVbaWorkbooks::isSpreadSheetFile( std::u16string_view sType )
{
// include calc_QPro etc. ? ( not for the moment anyway )
return o3tl::starts_with( sType, u"calc_MS" )
|| o3tl::starts_with( sType, u"MS Excel" )
|| o3tl::starts_with( sType, u"calc8" )
|| o3tl::starts_with( sType, u"calc_StarOffice" );
}
OUString
ScVbaWorkbooks::getFileFilterType( const OUString& rFileName )
{
uno::Reference< document::XTypeDetection > xTypeDetect( mxContext->getServiceManager()->createInstanceWithContext(u"com.sun.star.document.TypeDetection"_ustr, mxContext), uno::UNO_QUERY_THROW );
uno::Sequence aMediaDesc{ comphelper::makePropertyValue(u"URL"_ustr, rFileName) };
OUString sType = xTypeDetect->queryTypeByDescriptor( aMediaDesc, true );
return sType;
}
// #TODO# #FIXME# can any of the unused params below be used?
uno::Any SAL_CALL
ScVbaWorkbooks::Open( const OUString& rFileName, const uno::Any& /*UpdateLinks*/, const uno::Any& ReadOnly, const uno::Any& Format, const uno::Any& /*Password*/, const uno::Any& /*WriteResPassword*/, const uno::Any& /*IgnoreReadOnlyRecommended*/, const uno::Any& /*Origin*/, const uno::Any& Delimiter, const uno::Any& /*Editable*/, const uno::Any& /*Notify*/, const uno::Any& /*Converter*/, const uno::Any& /*AddToMru*/ )
{
// we need to detect if this is a URL, if not then assume it's a file path
OUString aURL;
INetURLObject aObj;
aObj.SetURL( rFileName );
bool bIsURL = aObj.GetProtocol() != INetProtocol::NotValid;
if ( bIsURL )
aURL = rFileName;
else
osl::FileBase::getFileURLFromSystemPath( rFileName, aURL );
uno::Sequence< beans::PropertyValue > sProps;
OUString sType = getFileFilterType( aURL );
// A text file means it needs to be processed as a csv file
if ( isTextFile( sType ) )
{
// Values for format
// 1 Tabs
// 2 Commas
// 3 Spaces
// 4 Semicolons
// 5 Nothing
// 6 Custom character (see the Delimiter argument
// no format means use the current delimiter
sal_Int16 const delims[] { 0 /*default not used*/, 9/*tab*/, 44/*comma*/, 32/*space*/, 59/*semicolon*/ };
OUString sFormat;
sal_Int16 nFormat = 0; // default indicator
if ( Format.hasValue() )
{
Format >>= nFormat; // val of nFormat overwritten if extracted
// validate param
if ( nFormat < 1 || nFormat > 6 )
throw uno::RuntimeException(u"Illegal value for Format"_ustr );
}
sal_Int16 nDelim = getCurrentDelim();
if ( nFormat > 0 && nFormat < CUSTOM_CHAR )
{
nDelim = delims[ nFormat ];
}
else if ( nFormat > CUSTOM_CHAR )
{
// Need to check Delimiter param
if ( !Delimiter.hasValue() )
throw uno::RuntimeException(u"Expected value for Delimiter"_ustr );
OUString sStr;
Delimiter >>= sStr;
if ( sStr.isEmpty() )
throw uno::RuntimeException(u"Incorrect value for Delimiter"_ustr );
nDelim = sStr[0];
}
getCurrentDelim() = nDelim; //set new current
sFormat = OUString::number( nDelim ) + ",34,0,1";
sProps = { comphelper::makePropertyValue(u"FilterOptions"_ustr, sFormat),
comphelper::makePropertyValue(u"FilterName"_ustr, SC_TEXT_CSV_FILTER_NAME),
// Ensure WORKAROUND_CSV_TXT_BUG_i60158 gets called in typedetection.cxx so
// csv is forced for deep detected 'writerxxx' types
comphelper::makePropertyValue(
u"DocumentService"_ustr, u"com.sun.star.sheet.SpreadsheetDocument"_ustr) };
}
else if ( !isSpreadSheetFile( sType ) )
throw uno::RuntimeException(u"Bad Format"_ustr );
uno::Reference <sheet::XSpreadsheetDocument> xSpreadDoc( openDocument( rFileName, ReadOnly, sProps ), uno::UNO_QUERY_THROW );
uno::Any aRet = getWorkbook( mxContext, xSpreadDoc, mxParent );
uno::Reference< excel::XWorkbook > xWBook( aRet, uno::UNO_QUERY );
if ( xWBook.is() )
xWBook->Activate();
return aRet;
}
OUString
ScVbaWorkbooks::getServiceImplName()
{
return u"ScVbaWorkbooks"_ustr;
}
css::uno::Sequence<OUString>
ScVbaWorkbooks::getServiceNames()
{
static uno::Sequence< OUString > const sNames
{
u"ooo.vba.excel.Workbooks"_ustr
};
return sNames;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */