/************************************************************** * * 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 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #include "oox/ole/vbamodule.hxx" #include #include #include #include #include "oox/helper/binaryinputstream.hxx" #include "oox/helper/storagebase.hxx" #include "oox/helper/textinputstream.hxx" #include "oox/ole/vbahelper.hxx" #include "oox/ole/vbainputstream.hxx" namespace oox { namespace ole { // ============================================================================ using namespace ::com::sun::star::container; using namespace ::com::sun::star::frame; using namespace ::com::sun::star::lang; using namespace ::com::sun::star::script; using namespace ::com::sun::star::script::vba; using namespace ::com::sun::star::uno; using ::rtl::OUString; using ::rtl::OUStringBuffer; // ============================================================================ VbaModule::VbaModule( const Reference< XComponentContext >& rxContext, const Reference< XModel >& rxDocModel, const OUString& rName, rtl_TextEncoding eTextEnc, bool bExecutable ) : mxContext( rxContext ), mxDocModel( rxDocModel ), maName( rName ), meTextEnc( eTextEnc ), mnType( ModuleType::UNKNOWN ), mnOffset( SAL_MAX_UINT32 ), mbReadOnly( false ), mbPrivate( false ), mbExecutable( bExecutable ) { } void VbaModule::importDirRecords( BinaryInputStream& rDirStrm ) { sal_uInt16 nRecId = 0; StreamDataSequence aRecData; while( VbaHelper::readDirRecord( nRecId, aRecData, rDirStrm ) && (nRecId != VBA_ID_MODULEEND) ) { SequenceInputStream aRecStrm( aRecData ); sal_Int32 nRecSize = aRecData.getLength(); switch( nRecId ) { #define OOX_ENSURE_RECORDSIZE( cond ) OSL_ENSURE( cond, "VbaModule::importDirRecords - invalid record size" ) case VBA_ID_MODULENAME: OSL_ENSURE( false, "VbaModule::importDirRecords - unexpected MODULENAME record" ); maName = aRecStrm.readCharArrayUC( nRecSize, meTextEnc ); break; case VBA_ID_MODULENAMEUNICODE: break; case VBA_ID_MODULESTREAMNAME: maStreamName = aRecStrm.readCharArrayUC( nRecSize, meTextEnc ); break; case VBA_ID_MODULESTREAMNAMEUNICODE: break; case VBA_ID_MODULEDOCSTRING: maDocString = aRecStrm.readCharArrayUC( nRecSize, meTextEnc ); break; case VBA_ID_MODULEDOCSTRINGUNICODE: break; case VBA_ID_MODULEOFFSET: OOX_ENSURE_RECORDSIZE( nRecSize == 4 ); aRecStrm >> mnOffset; break; case VBA_ID_MODULEHELPCONTEXT: OOX_ENSURE_RECORDSIZE( nRecSize == 4 ); break; case VBA_ID_MODULECOOKIE: OOX_ENSURE_RECORDSIZE( nRecSize == 2 ); break; case VBA_ID_MODULETYPEPROCEDURAL: OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); OSL_ENSURE( mnType == ModuleType::UNKNOWN, "VbaModule::importDirRecords - multiple module type records" ); mnType = ModuleType::NORMAL; break; case VBA_ID_MODULETYPEDOCUMENT: OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); OSL_ENSURE( mnType == ModuleType::UNKNOWN, "VbaModule::importDirRecords - multiple module type records" ); mnType = ModuleType::DOCUMENT; break; case VBA_ID_MODULEREADONLY: OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); mbReadOnly = true; break; case VBA_ID_MODULEPRIVATE: OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); mbPrivate = true; break; default: OSL_ENSURE( false, "VbaModule::importDirRecords - unknown module record" ); #undef OOX_ENSURE_RECORDSIZE } } OSL_ENSURE( maName.getLength() > 0, "VbaModule::importDirRecords - missing module name" ); OSL_ENSURE( maStreamName.getLength() > 0, "VbaModule::importDirRecords - missing module stream name" ); OSL_ENSURE( mnType != ModuleType::UNKNOWN, "VbaModule::importDirRecords - missing module type" ); OSL_ENSURE( mnOffset < SAL_MAX_UINT32, "VbaModule::importDirRecords - missing module stream offset" ); } void VbaModule::createAndImportModule( StorageBase& rVbaStrg, const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const { OUString aVBASourceCode = readSourceCode( rVbaStrg ); createModule( aVBASourceCode, rxBasicLib, rxDocObjectNA ); } void VbaModule::createEmptyModule( const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const { createModule( OUString(), rxBasicLib, rxDocObjectNA ); } // private -------------------------------------------------------------------- OUString VbaModule::readSourceCode( StorageBase& rVbaStrg ) const { OUStringBuffer aSourceCode; if( (maStreamName.getLength() > 0) && (mnOffset != SAL_MAX_UINT32) ) { BinaryXInputStream aInStrm( rVbaStrg.openInputStream( maStreamName ), true ); OSL_ENSURE( !aInStrm.isEof(), "VbaModule::readSourceCode - cannot open module stream" ); // skip the 'performance cache' stored before the actual source code aInStrm.seek( mnOffset ); // if stream is still valid, load the source code if( !aInStrm.isEof() ) { // decompression starts at current stream position of aInStrm VbaInputStream aVbaStrm( aInStrm ); // load the source code line-by-line, with some more processing TextInputStream aVbaTextStrm( mxContext, aVbaStrm, meTextEnc ); while( !aVbaTextStrm.isEof() ) { OUString aCodeLine = aVbaTextStrm.readLine(); if( !aCodeLine.matchAsciiL( RTL_CONSTASCII_STRINGPARAM( "Attribute " ) ) ) { // normal source code line if( !mbExecutable ) aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Rem " ) ); aSourceCode.append( aCodeLine ).append( sal_Unicode( '\n' ) ); } } } } return aSourceCode.makeStringAndClear(); } void VbaModule::createModule( const OUString& rVBASourceCode, const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const { if( maName.getLength() == 0 ) return; // prepare the Basic module ModuleInfo aModuleInfo; aModuleInfo.ModuleType = mnType; OUStringBuffer aSourceCode; aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Rem Attribute VBA_ModuleType=" ) ); switch( mnType ) { case ModuleType::NORMAL: aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAModule" ) ); break; case ModuleType::CLASS: aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAClassModule" ) ); break; case ModuleType::FORM: aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAFormModule" ) ); // hack from old filter, document Basic should know the XModel, but it doesn't aModuleInfo.ModuleObject.set( mxDocModel, UNO_QUERY ); break; case ModuleType::DOCUMENT: aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBADocumentModule" ) ); // get the VBA implementation object associated to the document module if( rxDocObjectNA.is() ) try { aModuleInfo.ModuleObject.set( rxDocObjectNA->getByName( maName ), UNO_QUERY ); } catch( Exception& ) { } break; default: aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAUnknown" ) ); } aSourceCode.append( sal_Unicode( '\n' ) ); if( mbExecutable ) { aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Option VBASupport 1\n" ) ); if( mnType == ModuleType::CLASS ) aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Option ClassModule\n" ) ); } else { // add a subroutine named after the module itself aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Sub " ) ). append( maName.replace( ' ', '_' ) ).append( sal_Unicode( '\n' ) ); } // append passed VBA source code aSourceCode.append( rVBASourceCode ); // close the subroutine named after the module if( !mbExecutable ) aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "End Sub\n" ) ); // insert extended module info try { Reference< XVBAModuleInfo > xVBAModuleInfo( rxBasicLib, UNO_QUERY_THROW ); xVBAModuleInfo->insertModuleInfo( maName, aModuleInfo ); } catch( Exception& ) { } // insert the module into the passed Basic library try { rxBasicLib->insertByName( maName, Any( aSourceCode.makeStringAndClear() ) ); } catch( Exception& ) { OSL_ENSURE( false, "VbaModule::createModule - cannot insert module into library" ); } } // ============================================================================ } // namespace ole } // namespace oox