1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #include "oox/ole/vbamodule.hxx" 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir #include <com/sun/star/container/XNameContainer.hpp> 31*cdf0e10cSrcweir #include <com/sun/star/script/ModuleInfo.hpp> 32*cdf0e10cSrcweir #include <com/sun/star/script/ModuleType.hpp> 33*cdf0e10cSrcweir #include <com/sun/star/script/vba/XVBAModuleInfo.hpp> 34*cdf0e10cSrcweir #include "oox/helper/binaryinputstream.hxx" 35*cdf0e10cSrcweir #include "oox/helper/storagebase.hxx" 36*cdf0e10cSrcweir #include "oox/helper/textinputstream.hxx" 37*cdf0e10cSrcweir #include "oox/ole/vbahelper.hxx" 38*cdf0e10cSrcweir #include "oox/ole/vbainputstream.hxx" 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir namespace oox { 41*cdf0e10cSrcweir namespace ole { 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir // ============================================================================ 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir using namespace ::com::sun::star::container; 46*cdf0e10cSrcweir using namespace ::com::sun::star::frame; 47*cdf0e10cSrcweir using namespace ::com::sun::star::lang; 48*cdf0e10cSrcweir using namespace ::com::sun::star::script; 49*cdf0e10cSrcweir using namespace ::com::sun::star::script::vba; 50*cdf0e10cSrcweir using namespace ::com::sun::star::uno; 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir using ::rtl::OUString; 53*cdf0e10cSrcweir using ::rtl::OUStringBuffer; 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir // ============================================================================ 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir VbaModule::VbaModule( const Reference< XComponentContext >& rxContext, const Reference< XModel >& rxDocModel, 58*cdf0e10cSrcweir const OUString& rName, rtl_TextEncoding eTextEnc, bool bExecutable ) : 59*cdf0e10cSrcweir mxContext( rxContext ), 60*cdf0e10cSrcweir mxDocModel( rxDocModel ), 61*cdf0e10cSrcweir maName( rName ), 62*cdf0e10cSrcweir meTextEnc( eTextEnc ), 63*cdf0e10cSrcweir mnType( ModuleType::UNKNOWN ), 64*cdf0e10cSrcweir mnOffset( SAL_MAX_UINT32 ), 65*cdf0e10cSrcweir mbReadOnly( false ), 66*cdf0e10cSrcweir mbPrivate( false ), 67*cdf0e10cSrcweir mbExecutable( bExecutable ) 68*cdf0e10cSrcweir { 69*cdf0e10cSrcweir } 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir void VbaModule::importDirRecords( BinaryInputStream& rDirStrm ) 72*cdf0e10cSrcweir { 73*cdf0e10cSrcweir sal_uInt16 nRecId = 0; 74*cdf0e10cSrcweir StreamDataSequence aRecData; 75*cdf0e10cSrcweir while( VbaHelper::readDirRecord( nRecId, aRecData, rDirStrm ) && (nRecId != VBA_ID_MODULEEND) ) 76*cdf0e10cSrcweir { 77*cdf0e10cSrcweir SequenceInputStream aRecStrm( aRecData ); 78*cdf0e10cSrcweir sal_Int32 nRecSize = aRecData.getLength(); 79*cdf0e10cSrcweir switch( nRecId ) 80*cdf0e10cSrcweir { 81*cdf0e10cSrcweir #define OOX_ENSURE_RECORDSIZE( cond ) OSL_ENSURE( cond, "VbaModule::importDirRecords - invalid record size" ) 82*cdf0e10cSrcweir case VBA_ID_MODULENAME: 83*cdf0e10cSrcweir OSL_ENSURE( false, "VbaModule::importDirRecords - unexpected MODULENAME record" ); 84*cdf0e10cSrcweir maName = aRecStrm.readCharArrayUC( nRecSize, meTextEnc ); 85*cdf0e10cSrcweir break; 86*cdf0e10cSrcweir case VBA_ID_MODULENAMEUNICODE: 87*cdf0e10cSrcweir break; 88*cdf0e10cSrcweir case VBA_ID_MODULESTREAMNAME: 89*cdf0e10cSrcweir maStreamName = aRecStrm.readCharArrayUC( nRecSize, meTextEnc ); 90*cdf0e10cSrcweir break; 91*cdf0e10cSrcweir case VBA_ID_MODULESTREAMNAMEUNICODE: 92*cdf0e10cSrcweir break; 93*cdf0e10cSrcweir case VBA_ID_MODULEDOCSTRING: 94*cdf0e10cSrcweir maDocString = aRecStrm.readCharArrayUC( nRecSize, meTextEnc ); 95*cdf0e10cSrcweir break; 96*cdf0e10cSrcweir case VBA_ID_MODULEDOCSTRINGUNICODE: 97*cdf0e10cSrcweir break; 98*cdf0e10cSrcweir case VBA_ID_MODULEOFFSET: 99*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 4 ); 100*cdf0e10cSrcweir aRecStrm >> mnOffset; 101*cdf0e10cSrcweir break; 102*cdf0e10cSrcweir case VBA_ID_MODULEHELPCONTEXT: 103*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 4 ); 104*cdf0e10cSrcweir break; 105*cdf0e10cSrcweir case VBA_ID_MODULECOOKIE: 106*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 2 ); 107*cdf0e10cSrcweir break; 108*cdf0e10cSrcweir case VBA_ID_MODULETYPEPROCEDURAL: 109*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); 110*cdf0e10cSrcweir OSL_ENSURE( mnType == ModuleType::UNKNOWN, "VbaModule::importDirRecords - multiple module type records" ); 111*cdf0e10cSrcweir mnType = ModuleType::NORMAL; 112*cdf0e10cSrcweir break; 113*cdf0e10cSrcweir case VBA_ID_MODULETYPEDOCUMENT: 114*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); 115*cdf0e10cSrcweir OSL_ENSURE( mnType == ModuleType::UNKNOWN, "VbaModule::importDirRecords - multiple module type records" ); 116*cdf0e10cSrcweir mnType = ModuleType::DOCUMENT; 117*cdf0e10cSrcweir break; 118*cdf0e10cSrcweir case VBA_ID_MODULEREADONLY: 119*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); 120*cdf0e10cSrcweir mbReadOnly = true; 121*cdf0e10cSrcweir break; 122*cdf0e10cSrcweir case VBA_ID_MODULEPRIVATE: 123*cdf0e10cSrcweir OOX_ENSURE_RECORDSIZE( nRecSize == 0 ); 124*cdf0e10cSrcweir mbPrivate = true; 125*cdf0e10cSrcweir break; 126*cdf0e10cSrcweir default: 127*cdf0e10cSrcweir OSL_ENSURE( false, "VbaModule::importDirRecords - unknown module record" ); 128*cdf0e10cSrcweir #undef OOX_ENSURE_RECORDSIZE 129*cdf0e10cSrcweir } 130*cdf0e10cSrcweir } 131*cdf0e10cSrcweir OSL_ENSURE( maName.getLength() > 0, "VbaModule::importDirRecords - missing module name" ); 132*cdf0e10cSrcweir OSL_ENSURE( maStreamName.getLength() > 0, "VbaModule::importDirRecords - missing module stream name" ); 133*cdf0e10cSrcweir OSL_ENSURE( mnType != ModuleType::UNKNOWN, "VbaModule::importDirRecords - missing module type" ); 134*cdf0e10cSrcweir OSL_ENSURE( mnOffset < SAL_MAX_UINT32, "VbaModule::importDirRecords - missing module stream offset" ); 135*cdf0e10cSrcweir } 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir void VbaModule::createAndImportModule( StorageBase& rVbaStrg, const Reference< XNameContainer >& rxBasicLib, 138*cdf0e10cSrcweir const Reference< XNameAccess >& rxDocObjectNA ) const 139*cdf0e10cSrcweir { 140*cdf0e10cSrcweir OUString aVBASourceCode = readSourceCode( rVbaStrg ); 141*cdf0e10cSrcweir createModule( aVBASourceCode, rxBasicLib, rxDocObjectNA ); 142*cdf0e10cSrcweir } 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir void VbaModule::createEmptyModule( const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const 145*cdf0e10cSrcweir { 146*cdf0e10cSrcweir createModule( OUString(), rxBasicLib, rxDocObjectNA ); 147*cdf0e10cSrcweir } 148*cdf0e10cSrcweir 149*cdf0e10cSrcweir // private -------------------------------------------------------------------- 150*cdf0e10cSrcweir 151*cdf0e10cSrcweir OUString VbaModule::readSourceCode( StorageBase& rVbaStrg ) const 152*cdf0e10cSrcweir { 153*cdf0e10cSrcweir OUStringBuffer aSourceCode; 154*cdf0e10cSrcweir if( (maStreamName.getLength() > 0) && (mnOffset != SAL_MAX_UINT32) ) 155*cdf0e10cSrcweir { 156*cdf0e10cSrcweir BinaryXInputStream aInStrm( rVbaStrg.openInputStream( maStreamName ), true ); 157*cdf0e10cSrcweir OSL_ENSURE( !aInStrm.isEof(), "VbaModule::readSourceCode - cannot open module stream" ); 158*cdf0e10cSrcweir // skip the 'performance cache' stored before the actual source code 159*cdf0e10cSrcweir aInStrm.seek( mnOffset ); 160*cdf0e10cSrcweir // if stream is still valid, load the source code 161*cdf0e10cSrcweir if( !aInStrm.isEof() ) 162*cdf0e10cSrcweir { 163*cdf0e10cSrcweir // decompression starts at current stream position of aInStrm 164*cdf0e10cSrcweir VbaInputStream aVbaStrm( aInStrm ); 165*cdf0e10cSrcweir // load the source code line-by-line, with some more processing 166*cdf0e10cSrcweir TextInputStream aVbaTextStrm( mxContext, aVbaStrm, meTextEnc ); 167*cdf0e10cSrcweir while( !aVbaTextStrm.isEof() ) 168*cdf0e10cSrcweir { 169*cdf0e10cSrcweir OUString aCodeLine = aVbaTextStrm.readLine(); 170*cdf0e10cSrcweir if( !aCodeLine.matchAsciiL( RTL_CONSTASCII_STRINGPARAM( "Attribute " ) ) ) 171*cdf0e10cSrcweir { 172*cdf0e10cSrcweir // normal source code line 173*cdf0e10cSrcweir if( !mbExecutable ) 174*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Rem " ) ); 175*cdf0e10cSrcweir aSourceCode.append( aCodeLine ).append( sal_Unicode( '\n' ) ); 176*cdf0e10cSrcweir } 177*cdf0e10cSrcweir } 178*cdf0e10cSrcweir } 179*cdf0e10cSrcweir } 180*cdf0e10cSrcweir return aSourceCode.makeStringAndClear(); 181*cdf0e10cSrcweir } 182*cdf0e10cSrcweir 183*cdf0e10cSrcweir void VbaModule::createModule( const OUString& rVBASourceCode, 184*cdf0e10cSrcweir const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const 185*cdf0e10cSrcweir { 186*cdf0e10cSrcweir if( maName.getLength() == 0 ) 187*cdf0e10cSrcweir return; 188*cdf0e10cSrcweir 189*cdf0e10cSrcweir // prepare the Basic module 190*cdf0e10cSrcweir ModuleInfo aModuleInfo; 191*cdf0e10cSrcweir aModuleInfo.ModuleType = mnType; 192*cdf0e10cSrcweir OUStringBuffer aSourceCode; 193*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Rem Attribute VBA_ModuleType=" ) ); 194*cdf0e10cSrcweir switch( mnType ) 195*cdf0e10cSrcweir { 196*cdf0e10cSrcweir case ModuleType::NORMAL: 197*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAModule" ) ); 198*cdf0e10cSrcweir break; 199*cdf0e10cSrcweir case ModuleType::CLASS: 200*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAClassModule" ) ); 201*cdf0e10cSrcweir break; 202*cdf0e10cSrcweir case ModuleType::FORM: 203*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAFormModule" ) ); 204*cdf0e10cSrcweir // hack from old filter, document Basic should know the XModel, but it doesn't 205*cdf0e10cSrcweir aModuleInfo.ModuleObject.set( mxDocModel, UNO_QUERY ); 206*cdf0e10cSrcweir break; 207*cdf0e10cSrcweir case ModuleType::DOCUMENT: 208*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBADocumentModule" ) ); 209*cdf0e10cSrcweir // get the VBA implementation object associated to the document module 210*cdf0e10cSrcweir if( rxDocObjectNA.is() ) try 211*cdf0e10cSrcweir { 212*cdf0e10cSrcweir aModuleInfo.ModuleObject.set( rxDocObjectNA->getByName( maName ), UNO_QUERY ); 213*cdf0e10cSrcweir } 214*cdf0e10cSrcweir catch( Exception& ) 215*cdf0e10cSrcweir { 216*cdf0e10cSrcweir } 217*cdf0e10cSrcweir break; 218*cdf0e10cSrcweir default: 219*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "VBAUnknown" ) ); 220*cdf0e10cSrcweir } 221*cdf0e10cSrcweir aSourceCode.append( sal_Unicode( '\n' ) ); 222*cdf0e10cSrcweir if( mbExecutable ) 223*cdf0e10cSrcweir { 224*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Option VBASupport 1\n" ) ); 225*cdf0e10cSrcweir if( mnType == ModuleType::CLASS ) 226*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Option ClassModule\n" ) ); 227*cdf0e10cSrcweir } 228*cdf0e10cSrcweir else 229*cdf0e10cSrcweir { 230*cdf0e10cSrcweir // add a subroutine named after the module itself 231*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Sub " ) ). 232*cdf0e10cSrcweir append( maName.replace( ' ', '_' ) ).append( sal_Unicode( '\n' ) ); 233*cdf0e10cSrcweir } 234*cdf0e10cSrcweir 235*cdf0e10cSrcweir // append passed VBA source code 236*cdf0e10cSrcweir aSourceCode.append( rVBASourceCode ); 237*cdf0e10cSrcweir 238*cdf0e10cSrcweir // close the subroutine named after the module 239*cdf0e10cSrcweir if( !mbExecutable ) 240*cdf0e10cSrcweir aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "End Sub\n" ) ); 241*cdf0e10cSrcweir 242*cdf0e10cSrcweir // insert extended module info 243*cdf0e10cSrcweir try 244*cdf0e10cSrcweir { 245*cdf0e10cSrcweir Reference< XVBAModuleInfo > xVBAModuleInfo( rxBasicLib, UNO_QUERY_THROW ); 246*cdf0e10cSrcweir xVBAModuleInfo->insertModuleInfo( maName, aModuleInfo ); 247*cdf0e10cSrcweir } 248*cdf0e10cSrcweir catch( Exception& ) 249*cdf0e10cSrcweir { 250*cdf0e10cSrcweir } 251*cdf0e10cSrcweir 252*cdf0e10cSrcweir // insert the module into the passed Basic library 253*cdf0e10cSrcweir try 254*cdf0e10cSrcweir { 255*cdf0e10cSrcweir rxBasicLib->insertByName( maName, Any( aSourceCode.makeStringAndClear() ) ); 256*cdf0e10cSrcweir } 257*cdf0e10cSrcweir catch( Exception& ) 258*cdf0e10cSrcweir { 259*cdf0e10cSrcweir OSL_ENSURE( false, "VbaModule::createModule - cannot insert module into library" ); 260*cdf0e10cSrcweir } 261*cdf0e10cSrcweir } 262*cdf0e10cSrcweir 263*cdf0e10cSrcweir // ============================================================================ 264*cdf0e10cSrcweir 265*cdf0e10cSrcweir } // namespace ole 266*cdf0e10cSrcweir } // namespace oox 267