1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#include "oox/ole/vbamodule.hxx"
#include <boost/unordered_map.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/container/XIndexContainer.hpp>
#include <com/sun/star/script/ModuleInfo.hpp>
#include <com/sun/star/script/ModuleType.hpp>
#include <com/sun/star/script/vba/XVBAModuleInfo.hpp>
#include <cppuhelper/implbase1.hxx>
#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;
// ============================================================================
typedef ::cppu::WeakImplHelper1< XIndexContainer > OleIdToNameContainer_BASE;
typedef boost::unordered_map< sal_Int32, rtl::OUString > ObjIdToName;
class OleIdToNameContainer : public OleIdToNameContainer_BASE
{
ObjIdToName ObjIdToNameHash;
::osl::Mutex m_aMutex;
bool hasByIndex( ::sal_Int32 Index )
{
::osl::MutexGuard aGuard( m_aMutex );
return ( ObjIdToNameHash.find( Index ) != ObjIdToNameHash.end() );
}
public:
OleIdToNameContainer() {}
// XIndexContainer Methods
virtual void SAL_CALL insertByIndex( ::sal_Int32 Index, const Any& Element ) throw (IllegalArgumentException, IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
rtl::OUString sOleName;
if ( !( Element >>= sOleName ) )
throw IllegalArgumentException();
ObjIdToNameHash[ Index ] = sOleName;
}
virtual void SAL_CALL removeByIndex( ::sal_Int32 Index ) throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !hasByIndex( Index ) )
throw IndexOutOfBoundsException();
ObjIdToNameHash.erase( ObjIdToNameHash.find( Index ) );
}
// XIndexReplace Methods
virtual void SAL_CALL replaceByIndex( ::sal_Int32 Index, const Any& Element ) throw (IllegalArgumentException, IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !hasByIndex( Index ) )
throw IndexOutOfBoundsException();
rtl::OUString sOleName;
if ( !( Element >>= sOleName ) )
throw IllegalArgumentException();
ObjIdToNameHash[ Index ] = sOleName;
}
// XIndexAccess Methods
virtual ::sal_Int32 SAL_CALL getCount( ) throw (RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
return ObjIdToNameHash.size();
}
virtual Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !hasByIndex( Index ) )
throw IndexOutOfBoundsException();
return makeAny( ObjIdToNameHash[ Index ] );
}
// XElementAccess Methods
virtual Type SAL_CALL getElementType( ) throw (RuntimeException)
{
return ::getCppuType( static_cast< const ::rtl::OUString* >( 0 ) );
}
virtual ::sal_Bool SAL_CALL hasElements( ) throw (RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
return ( getCount() > 0 );
}
};
// ============================================================================
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_FAIL( "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 );
// Actually the stream name seems the best name to use
// the VBA_ID_MODULENAME name can sometimes be the wrong case
maName = maStreamName;
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_FAIL( "VbaModule::importDirRecords - unknown module record" );
#undef OOX_ENSURE_RECORDSIZE
}
}
OSL_ENSURE( !maName.isEmpty(), "VbaModule::importDirRecords - missing module name" );
OSL_ENSURE( !maStreamName.isEmpty(), "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 Reference< XNameContainer >& rxOleNameOverrides ) const
{
OUString aVBASourceCode = readSourceCode( rVbaStrg, rxOleNameOverrides );
createModule( aVBASourceCode, rxBasicLib, rxDocObjectNA );
}
void VbaModule::createEmptyModule( const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const
{
createModule( OUString(), rxBasicLib, rxDocObjectNA );
}
OUString VbaModule::readSourceCode( StorageBase& rVbaStrg, const Reference< XNameContainer >& rxOleNameOverrides ) const
{
OUStringBuffer aSourceCode;
if( !maStreamName.isEmpty() && (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 " ) ) )
{
// attribute
extractOleOverrideFromAttr( aCodeLine, rxOleNameOverrides );
}
else
{
// normal source code line
if( !mbExecutable )
aSourceCode.appendAscii( RTL_CONSTASCII_STRINGPARAM( "Rem " ) );
aSourceCode.append( aCodeLine ).append( sal_Unicode( '\n' ) );
}
}
}
}
return aSourceCode.makeStringAndClear();
}
void VbaModule::extractOleOverrideFromAttr( const OUString& rAttribute, const Reference< XNameContainer >& rxOleNameOverrides ) const
{
// format of the attribute we are interested in is
// Attribute VB_Control = "ControlName", intString, MSForms, ControlTypeAsString
// e.g.
// Attribute VB_Control = "CommandButton1, 201, 19, MSForms, CommandButton"
OUString sControlAttribute = CREATE_OUSTRING( "Attribute VB_Control = \"" );
if ( rxOleNameOverrides.is() && rAttribute.indexOf( sControlAttribute ) != -1 )
{
OUString sRest = rAttribute.copy( sControlAttribute.getLength() );
sal_Int32 nPos = sRest.indexOf( ',' );
OUString sCntrlName = sRest.copy( 0, nPos );
sal_Int32 nCntrlId = sRest.copy( nPos + 1 ).copy( 0, sRest.indexOf( ',', nPos + 1) ).toInt32();
OSL_TRACE("In module %s, assiging %d controlname %s",
rtl::OUStringToOString( maName, RTL_TEXTENCODING_UTF8 ).getStr(), nCntrlId,
rtl::OUStringToOString( sCntrlName, RTL_TEXTENCODING_UTF8 ).getStr() );
if ( !rxOleNameOverrides->hasByName( maName ) )
rxOleNameOverrides->insertByName( maName, Any( Reference< XIndexContainer> ( new OleIdToNameContainer ) ) );
Reference< XIndexContainer > xIdToOleName;
if ( rxOleNameOverrides->getByName( maName ) >>= xIdToOleName )
xIdToOleName->insertByIndex( nCntrlId, makeAny( sCntrlName ) );
}
}
void VbaModule::createModule( const OUString& rVBASourceCode,
const Reference< XNameContainer >& rxBasicLib, const Reference< XNameAccess >& rxDocObjectNA ) const
{
if( maName.isEmpty() )
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(const 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(const Exception& )
{
}
// insert the module into the passed Basic library
try
{
rxBasicLib->insertByName( maName, Any( aSourceCode.makeStringAndClear() ) );
}
catch(const Exception& )
{
OSL_FAIL( "VbaModule::createModule - cannot insert module into library" );
}
}
// ============================================================================
} // namespace ole
} // namespace oox
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
