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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544 | /* -*- 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/.
*/
#include <sal/config.h>
#include <test/unoapi_test.hxx>
#include <osl/file.hxx>
#include <sal/log.hxx>
#include <unotools/tempfile.hxx>
#include <vcl/svapp.hxx>
#include <docsh.hxx>
#include <document.hxx>
#include <com/sun/star/script/XLibraryContainerPassword.hpp>
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
/* Implementation of Macros test */
class ScMacrosTest : public UnoApiTest
{
public:
ScMacrosTest();
void saveAndReload(css::uno::Reference<css::lang::XComponent>& xComponent,
const OUString& rFilter);
void testStarBasic();
void testVba();
void testMSP();
void testPasswordProtectedStarBasic();
void testRowColumn();
void testPasswordProtectedUnicodeString();
void testTdf131296_legacy();
void testTdf131296_new();
CPPUNIT_TEST_SUITE(ScMacrosTest);
CPPUNIT_TEST(testStarBasic);
CPPUNIT_TEST(testMSP);
CPPUNIT_TEST(testVba);
CPPUNIT_TEST(testPasswordProtectedStarBasic);
CPPUNIT_TEST(testRowColumn);
CPPUNIT_TEST(testPasswordProtectedUnicodeString);
CPPUNIT_TEST(testTdf131296_legacy);
CPPUNIT_TEST(testTdf131296_new);
CPPUNIT_TEST_SUITE_END();
};
void ScMacrosTest::saveAndReload(css::uno::Reference<css::lang::XComponent>& xComponent,
const OUString& rFilter)
{
utl::TempFile aTempFile;
aTempFile.EnableKillingFile();
css::uno::Sequence<css::beans::PropertyValue> aArgs(1);
aArgs[0].Name = "FilterName";
aArgs[0].Value <<= rFilter;
css::uno::Reference<css::frame::XStorable> xStorable(xComponent, css::uno::UNO_QUERY_THROW);
xStorable->storeAsURL(aTempFile.GetURL(), aArgs);
css::uno::Reference<css::util::XCloseable> xCloseable(xComponent, css::uno::UNO_QUERY_THROW);
xCloseable->close(true);
xComponent = loadFromDesktop(aTempFile.GetURL(), "com.sun.star.sheet.SpreadsheetDocument");
}
// I suppose you could say this test doesn't really belong here, OTOH
// we need a full document to run the test ( it related originally to an
// imported Excel VBA macro ) It's convenient and fast to unit test
// this the problem this way. Perhaps in the future there will be some sort
// of slowcheck tests ( requiring a full document environment in the scripting
// module, we could move the test there then ) - relates to fdo#67547
void ScMacrosTest::testMSP()
{
OUString aFileName;
createFileURL("MasterScriptProviderProblem.ods", aFileName);
uno::Reference< css::lang::XComponent > xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT_MESSAGE("Failed to load MasterScriptProviderProblem.ods", xComponent.is());
Any aRet;
Sequence< sal_Int16 > aOutParamIndex;
Sequence< Any > aOutParam;
Sequence< uno::Any > aParams;
SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(xComponent);
CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell);
ScDocShell* pDocSh = dynamic_cast<ScDocShell*>(pFoundShell);<--- Assignment 'pDocSh=dynamic_cast(pFoundShell)', assigned value is 0
CPPUNIT_ASSERT(pDocSh != nullptr);<--- Assuming that condition 'pDocSh!=nullptr' is not redundant
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:Standard.Module1.TestMSP?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
OUString sResult;
aRet >>= sResult;
SAL_INFO("sc.qa", "Result is " << sResult );
CPPUNIT_ASSERT_EQUAL_MESSAGE("TestMSP ( for fdo#67547) failed", OUString("OK"), sResult);
pDocSh->DoClose();<--- Null pointer dereference
}
void ScMacrosTest::testPasswordProtectedStarBasic()
{
OUString aFileName;
createFileURL("testTypePassword.ods", aFileName);
uno::Reference< css::lang::XComponent > xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT_MESSAGE("Failed to load testTypePassword.ods", xComponent.is());
Any aRet;
Sequence< sal_Int16 > aOutParamIndex;
Sequence< Any > aOutParam;
Sequence< uno::Any > aParams;
SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(xComponent);
CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell);
ScDocShell* pDocSh = static_cast<ScDocShell*>(pFoundShell);
ScDocument& rDoc = pDocSh->GetDocument();
// User defined types
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:MyLibrary.Module1.Main?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
OUString aValue = rDoc.GetString(0,0,0);
CPPUNIT_ASSERT_EQUAL_MESSAGE("User defined types script did not change the value of Sheet1.A1", OUString("success"), aValue);
// Big Module
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:MyLibrary.BigModule.bigMethod?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
aValue = rDoc.GetString(1,0,0);
CPPUNIT_ASSERT_EQUAL_MESSAGE("Big module script did not change the value of Sheet1.B1", OUString("success"), aValue);
// far big method tdf#94617
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:MyLibrary.BigModule.farBigMethod?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
aValue = rDoc.GetString(2,0,0);
CPPUNIT_ASSERT_EQUAL_MESSAGE("Far Method script did not change the value of Sheet1.C1", OUString("success"), aValue);
pDocSh->DoClose();
}
void ScMacrosTest::testStarBasic()
{
OUString aFileName;
createFileURL("StarBasic.ods", aFileName);
uno::Reference< css::lang::XComponent > xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT_MESSAGE("Failed to load StarBasic.ods", xComponent.is());
Any aRet;
Sequence< sal_Int16 > aOutParamIndex;
Sequence< Any > aOutParam;
Sequence< uno::Any > aParams;
SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(xComponent);
CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell);
ScDocShell* pDocSh = static_cast<ScDocShell*>(pFoundShell);
ScDocument& rDoc = pDocSh->GetDocument();
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:Standard.Module1.Macro1?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
double aValue;
rDoc.GetValue(0,0,0,aValue);
CPPUNIT_ASSERT_DOUBLES_EQUAL_MESSAGE("script did not change the value of Sheet1.A1",2.0, aValue, 0.00001);
pDocSh->DoClose();
}
void ScMacrosTest::testVba()
{
TestMacroInfo testInfo[] = {
{
OUString("TestAddress."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("vba."),
OUString("vnd.sun.Star.script:VBAProject.Modul1.Modul1?language=Basic&location=document"),
},
{
OUString("MiscRangeTests."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("bytearraystring."),
OUString("vnd.sun.Star.script:VBAProject.testMacro.test?language=Basic&location=document")
},
{
OUString("AutoFilter."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("CalcFont."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("TestIntersection."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("TestUnion."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("range-4."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Ranges-3."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("TestCalc_Rangetest."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("TestCalc_Rangetest2."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Ranges-2."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("pagesetup."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Window."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("window2."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("PageBreaks."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Shapes."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Ranges."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("CheckOptionToggleValue."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("GeneratedEventTest."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("MiscControlTests."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Workbooks."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("Names."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("vba_endFunction."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
{
OUString("vba_findFunction."),
OUString("vnd.sun.Star.script:VBAProject.testMacros.test?language=Basic&location=document")
},
};
OUString sTempDir;
OUString sTempDirURL;
osl::FileBase:: getTempDirURL( sTempDirURL );
osl::FileBase::getSystemPathFromFileURL( sTempDirURL, sTempDir );
sTempDir += OUStringChar(SAL_PATHDELIMITER);
OUString sTestFileName("My Test WorkBook.xls");
Sequence< uno::Any > aParams;
for (const auto& rTestInfo : testInfo)
{
OUString aFileName;
createFileURL(rTestInfo.sFileBaseName + "xls", aFileName);
uno::Reference< css::lang::XComponent > xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
OUString sMsg( "Failed to load " + aFileName );
CPPUNIT_ASSERT_MESSAGE( OUStringToOString( sMsg, RTL_TEXTENCODING_UTF8 ).getStr(), xComponent.is() );
// process all events such as OnLoad events etc.
// otherwise the tend to arrive later at a random
// time - while processing other StarBasic methods.
Application::Reschedule(true);
Any aRet;
Sequence< sal_Int16 > aOutParamIndex;
Sequence< Any > aOutParam;
bool bWorkbooksHandling = rTestInfo.sFileBaseName == "Workbooks." && !sTempDir.isEmpty() ;
if ( bWorkbooksHandling )
{
aParams.realloc(2);
aParams[ 0 ] <<= sTempDir;
aParams[ 1 ] <<= sTestFileName;
}
SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(xComponent);
CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell);
SAL_INFO("sc.qa", "about to invoke vba test in " << aFileName << " with url " << rTestInfo.sMacroUrl);
SfxObjectShell::CallXScript(
xComponent, rTestInfo.sMacroUrl, aParams, aRet, aOutParamIndex,
aOutParam);
OUString aStringRes;
aRet >>= aStringRes;
CPPUNIT_ASSERT_EQUAL_MESSAGE(
OUString("script reported failure in file " + rTestInfo.sFileBaseName + "xls")
.toUtf8()
.getStr(),
OUString("OK"), aStringRes);
pFoundShell->DoClose();
if ( bWorkbooksHandling )
{
OUString sFileUrl;
OUString sFilePath = sTempDir + sTestFileName;
osl::FileBase::getFileURLFromSystemPath( sFilePath, sFileUrl );
if ( !sFileUrl.isEmpty() )
osl::File::remove( sFileUrl );
}
}
}
void ScMacrosTest::testRowColumn()
{
OUString aFileName;
createFileURL("StarBasic.ods", aFileName);
uno::Reference< css::lang::XComponent > xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT_MESSAGE("Failed to load StarBasic.ods", xComponent.is());
Any aRet;
Sequence< sal_Int16 > aOutParamIndex;
Sequence< Any > aOutParam;
Sequence< uno::Any > aParams;
SfxObjectShell* pFoundShell = SfxObjectShell::GetShellFromComponent(xComponent);
CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", pFoundShell);
ScDocShell* pDocSh = static_cast<ScDocShell*>(pFoundShell);
ScDocument& rDoc = pDocSh->GetDocument();
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:Standard.Module1.Macro_RowHeight?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
sal_uInt16 nHeight = rDoc.GetRowHeight(0, 0) * HMM_PER_TWIPS;
CPPUNIT_ASSERT_EQUAL(static_cast<sal_uInt16>(2000), nHeight);
SfxObjectShell::CallXScript(
xComponent,
"vnd.sun.Star.script:Standard.Module1.Macro_ColumnWidth?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
sal_uInt16 nWidth = rDoc.GetColWidth(0, 0) * HMM_PER_TWIPS;
CPPUNIT_ASSERT_EQUAL(static_cast<sal_uInt16>(4000), nWidth);
pDocSh->DoClose();
}
void ScMacrosTest::testPasswordProtectedUnicodeString()
{
const OUString sCorrectString(u"English Русский 中文");
const OUString sMacroURL(
"vnd.sun.Star.script:Protected.Module1.TestUnicodeString?language=Basic&location=document");
const OUString sLibName("Protected");
OUString aFileName;
createFileURL("tdf57113.ods", aFileName);
auto xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT(xComponent);
// Check that loading password-protected macro image correctly loads Unicode strings
{
Any aRet;
Sequence<sal_Int16> aOutParamIndex;
Sequence<Any> aOutParam;
Sequence<uno::Any> aParams;
SfxObjectShell::CallXScript(xComponent, sMacroURL, aParams, aRet, aOutParamIndex,
aOutParam);
OUString aReturnValue;
aRet >>= aReturnValue;
CPPUNIT_ASSERT_EQUAL(sCorrectString, aReturnValue);
}
// Unlock and load the library, to regenerate the image on save
css::uno::Reference<css::document::XEmbeddedScripts> xES(xComponent, UNO_QUERY_THROW);
css::uno::Reference<css::script::XLibraryContainer> xLC(xES->getBasicLibraries(),
UNO_QUERY_THROW);
css::uno::Reference<css::script::XLibraryContainerPassword> xPasswd(xLC, UNO_QUERY_THROW);
CPPUNIT_ASSERT(xPasswd->isLibraryPasswordProtected(sLibName));
CPPUNIT_ASSERT(!xPasswd->isLibraryPasswordVerified(sLibName));
CPPUNIT_ASSERT(xPasswd->verifyLibraryPassword(sLibName, "password"));
xLC->loadLibrary(sLibName);
CPPUNIT_ASSERT(xLC->isLibraryLoaded(sLibName));
// Now check that saving stores Unicode data correctly in image's string pool
saveAndReload(xComponent, "calc8");
CPPUNIT_ASSERT(xComponent);
{
Any aRet;
Sequence<sal_Int16> aOutParamIndex;
Sequence<Any> aOutParam;
Sequence<uno::Any> aParams;
SfxObjectShell::CallXScript(xComponent, sMacroURL, aParams, aRet, aOutParamIndex,
aOutParam);
OUString aReturnValue;
aRet >>= aReturnValue;
CPPUNIT_ASSERT_EQUAL(sCorrectString, aReturnValue);
}
css::uno::Reference<css::util::XCloseable> xCloseable(xComponent, css::uno::UNO_QUERY_THROW);
xCloseable->close(true);
}
void ScMacrosTest::testTdf131296_legacy()
{
// For legacy password-protected library images, we must correctly get the constants' values,
// and also - for Integer - the type.
const std::vector<std::pair<OUString, OUString>> aTests({
{ "TestIntConst", "Integer: 123" },
{ "TestLongConst", "Double: 123" },
{ "TestSingleConst", "Double: 123" },
{ "TestDoubleConst", "Double: 123" },
});
OUString aFileName;
createFileURL("tdf131296_legacy.ods", aFileName);
auto xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT(xComponent);
{
Any aRet;
Sequence<sal_Int16> aOutParamIndex;
Sequence<Any> aOutParam;
Sequence<uno::Any> aParams;
for (auto& [sTestName, sExpected] : aTests)
{
SfxObjectShell::CallXScript(xComponent,
"vnd.sun.Star.script:Protected.Module1." + sTestName
+ "?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
OUString aReturnValue;
aRet >>= aReturnValue;
CPPUNIT_ASSERT_EQUAL_MESSAGE(sTestName.toUtf8().getStr(), sExpected, aReturnValue);
}
}
css::uno::Reference<css::util::XCloseable> xCloseable(xComponent, css::uno::UNO_QUERY_THROW);
xCloseable->close(true);
}
void ScMacrosTest::testTdf131296_new()
{
// For new password-protected library images, we must correctly get both the constants' values
// and their types.
const std::vector<std::pair<OUString, OUString>> aTests({
{ "TestIntConst", "Integer: 123" },
{ "TestLongConst", "Long: 123" },
{ "TestSingleConst", "Single: 123" },
{ "TestDoubleConst", "Double: 123" },
{ "TestCurrencyConst", "Currency: 123.0000" },
});
OUString aFileName;
createFileURL("tdf131296_new.ods", aFileName);
auto xComponent = loadFromDesktop(aFileName, "com.sun.star.sheet.SpreadsheetDocument");
CPPUNIT_ASSERT(xComponent);
{
Any aRet;
Sequence<sal_Int16> aOutParamIndex;
Sequence<Any> aOutParam;
Sequence<uno::Any> aParams;
for (auto& [sTestName, sExpected] : aTests)
{
SfxObjectShell::CallXScript(xComponent,
"vnd.sun.Star.script:Protected.Module1." + sTestName
+ "?language=Basic&location=document",
aParams, aRet, aOutParamIndex, aOutParam);
OUString aReturnValue;
aRet >>= aReturnValue;
CPPUNIT_ASSERT_EQUAL_MESSAGE(sTestName.toUtf8().getStr(), sExpected, aReturnValue);
}
}
css::uno::Reference<css::util::XCloseable> xCloseable(xComponent, css::uno::UNO_QUERY_THROW);
xCloseable->close(true);
}
ScMacrosTest::ScMacrosTest()
: UnoApiTest("/sc/qa/extras/testdocuments")
{
}
CPPUNIT_TEST_SUITE_REGISTRATION(ScMacrosTest);
CPPUNIT_PLUGIN_IMPLEMENT();
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|