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
|
/*
* 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 .
*/
package complex.loadAllDocuments;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;
import helper.URLHelper;
import java.io.File;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.openoffice.test.OfficeConnection;
import org.openoffice.test.OfficeFileUrl;
import com.sun.star.beans.PropertyValue;
import com.sun.star.frame.FrameSearchFlag;
import com.sun.star.frame.XComponentLoader;
import com.sun.star.frame.XFrame;
import com.sun.star.frame.XStorable;
import com.sun.star.io.XInputStream;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.ucb.XSimpleFileAccess;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.util.XCloseable;
/** @short Check the interface method XComponentLoader.loadComponentFromURL()
@descr A prerequisite for this test is a server which allows access to files
that will be loaded via three different access methods:
<ul>
<li>1. nfs (mounted directory / mapped network drive)</li>
<li>2. ftp</li>
<li>3. http</li>
</ul>
<p>
The test will look for a list of files from the <i>TestDocumentPath</i>
on and load these files from the mounted directory, via ftp and http.
The parameters for this have to be "ftp_access" and "http_access".
If they are not given, tests for ftp and http will fail.
@todo We need a further test for accessing UNC paths on windows!
*/
public class CheckXComponentLoader
{
// some const
/** used to classify the result of a loadComponentFromURL() request. */
private static final int RESULT_VALID_DOC = 1;
private static final int RESULT_EMPTY_DOC = 2;
private static final int RESULT_ILLEGALARGUMENTEXCEPTION = 3;
private static final int RESULT_IOEXCEPTION = 4;
private static final int RESULT_RUNTIMEEXCEPTION = 5;
private static final int RESULT_EXCEPTION = 6;
/** used for testing password protected files. */
private static final String SUFFIX_PASSWORD_TEMPFILE = "password_";
private static final String PREFIX_PASSWORD_TEMPFILE = ".sxw";
private static final String DEFAULT_PASSWORD = "DefaultPasswordForComponentLoaderTest";
// member
/** provides XComponentLoader interface too. */
private XFrame m_xFrame = null;
/** will be set to xDesktop OR xFrame. */
private XComponentLoader m_xLoader = null;
/** can be used to open local files as stream. */
private XSimpleFileAccess m_xStreamProvider = null;
/** directory for creating temp. files. */
private String m_sTempPath = null;
/** directory for searching files to load */
private String m_sTestDocPath = null;
/** files of m_sTestDocPath to test. */
private static ArrayList<String> m_lTestFiles = null;
// test environment
/** @short Create the environment for following tests.
@descr Use either a component loader from desktop or
from frame
*/
@Before public void before() throws Exception
{
// get uno service manager from global test environment
/* points to the global uno service manager. */
XMultiServiceFactory xMSF = getMSF();
// create stream provider
m_xStreamProvider = UnoRuntime.queryInterface(XSimpleFileAccess.class, xMSF.createInstance("com.sun.star.ucb.SimpleFileAccess"));
// create desktop instance
/* provides XComponentLoader interface. */
XFrame xDesktop = UnoRuntime.queryInterface(XFrame.class, xMSF.createInstance("com.sun.star.frame.Desktop"));
// create frame instance
m_xFrame = xDesktop.findFrame("testFrame_componentLoader",
FrameSearchFlag.TASKS | FrameSearchFlag.CREATE);
assertNotNull("Couldn't create test frame.", m_xFrame);
// define default loader for testing
// TODO think about using of bot loader instances!
m_xLoader = UnoRuntime.queryInterface(XComponentLoader.class, xDesktop);
assertNotNull("Desktop service doesn't support needed component loader interface.", m_xLoader);
// get temp path for this environment
final String tempDirURL = util.utils.getOfficeTemp/*Dir*/(getMSF());
m_sTempPath = graphical.FileHelper.getSystemPathFromFileURL(tempDirURL);
// m_sTempPath = "."+fs_sys;
// get all files from the given directory
// TODO URLHelper should ignore directories!
m_lTestFiles = new ArrayList<String>();
final String sTestDocURL = OfficeFileUrl.getAbsolute(new File("testdocuments"));
m_sTestDocPath = graphical.FileHelper.getSystemPathFromFileURL(sTestDocURL);
File aBaseDir = new File(m_sTestDocPath);
List<File> lDirContent = URLHelper.getSystemFilesFromDir(aBaseDir.getPath());
Iterator<File> lList = lDirContent.iterator();
int nBasePathLength = m_sTestDocPath.length();
while(lList.hasNext())
{
File aFile = lList.next();
// ignore broken links and directories at all
if (
(!aFile.exists()) ||
(!aFile.isFile())
)
{
continue;
}
String sCompletePath = aFile.getAbsolutePath();
String sSubPath = sCompletePath.substring(nBasePathLength);
m_lTestFiles.add(sSubPath);
}
}
/** @short close the environment.
*/
@After public void after() throws Exception
{
XCloseable xClose = UnoRuntime.queryInterface(XCloseable.class, m_xFrame);
xClose.close(false);
m_xFrame = null;
m_xLoader = null;
}
/** @short Look for files in the given directory for loading.
*/
@Test public void checkUsingOfMediaDescriptor()
{
InteractionHandler xHandler = new InteractionHandler();
StatusIndicator xIndicator = new StatusIndicator();
PropertyValue[] lProps = new PropertyValue[3];
lProps[0] = new PropertyValue();
lProps[0].Name = "Hidden";
lProps[0].Value = Boolean.TRUE;
lProps[1] = new PropertyValue();
lProps[1].Name = "InteractionHandler";
lProps[1].Value = xHandler;
lProps[2] = new PropertyValue();
lProps[2].Name = "StatusIndicator";
lProps[2].Value = xIndicator;
Iterator<String> aSnapshot = m_lTestFiles.iterator();
while (aSnapshot.hasNext())
{
File aSysFile = new File(m_sTestDocPath, aSnapshot.next());
String sURL = URLHelper.getFileURLFromSystemPath(aSysFile);
loadURL(m_xLoader, RESULT_VALID_DOC, sURL, "_blank", 0, lProps);
// It's not needed to reset this using states!
// Its done internally ...
if (!xIndicator.wasUsed())
{
System.out.println("External progress was not used for loading.");
}
if (xHandler.wasUsed())
{
System.out.println("External interaction handler was not used for loading.");
}
}
}
/** TODO document me and move this method to a more global helper! */
private String impl_getTempFileName(String sTempPath,
String sSuffix ,
String sPrefix )
{
File aDir = new File(sTempPath);
aDir.mkdirs();
// TODO: create a temp file which not exist!
for (int i=0; i<999999; ++i)
{
File aTempFile = new File(aDir, sSuffix+i+sPrefix);
if (!aTempFile.exists())
{
return aTempFile.getAbsolutePath();
}
}
fail("Seems that all temp file names are currently in use!");
return null;
}
/** TODO document me and move this method to a more global helper! */
private void impl_createTempOfficeDocument(XComponentLoader xLoader ,
String sSourceURL,
String sTargetURL,
String sFilter ,
String sPassword ) throws Exception
{
PropertyValue[] lLoadProps = new PropertyValue[1];
lLoadProps[0] = new PropertyValue();
lLoadProps[0].Name = "Hidden";
lLoadProps[0].Value = Boolean.TRUE;
PropertyValue[] lSaveProps = new PropertyValue[3];
lSaveProps[0] = new PropertyValue();
lSaveProps[0].Name = "FilterName";
lSaveProps[0].Value = sFilter;
lSaveProps[1] = new PropertyValue();
lSaveProps[1].Name = "PassWord";
lSaveProps[1].Value = sPassword;
lSaveProps[2] = new PropertyValue();
lSaveProps[2].Name = "Overwrite";
lSaveProps[2].Value = Boolean.TRUE;
XComponent xDoc = null;
// load it
xDoc = xLoader.loadComponentFromURL(sSourceURL, "_blank", 0, lLoadProps);
assertNotNull("Could create office document, which should be saved as temp one.", xDoc);
// save it as temp file
XStorable xStore = UnoRuntime.queryInterface(XStorable.class, xDoc);
xStore.storeAsURL(sTargetURL, lSaveProps);
// Don't forget to close this file. Otherwise the temp file is locked!
XCloseable xClose = UnoRuntime.queryInterface(XCloseable.class, xDoc);
xClose.close(false);
}
/** @short Check the password handling.
@descr The used password is the one given
as password for the ftp connection,
or - if none given a default one.
*/
@Test public void checkLoadingWithPassword() throws Exception
{
String sTempFile = impl_getTempFileName(m_sTempPath, SUFFIX_PASSWORD_TEMPFILE, PREFIX_PASSWORD_TEMPFILE);
File aTestFile = new File(sTempFile);
String sTestURL = URLHelper.getFileURLFromSystemPath(aTestFile);
impl_createTempOfficeDocument(m_xLoader, "private:factory/swriter", sTestURL, "StarOffice XML (Writer)", DEFAULT_PASSWORD);
PropertyValue[] lArgs1 = new PropertyValue[2];
lArgs1[0] = new PropertyValue();
lArgs1[0].Name = "Hidden";
lArgs1[0].Value = Boolean.TRUE;
lArgs1[1] = new PropertyValue();
lArgs1[1].Name = "Password";
lArgs1[1].Value = DEFAULT_PASSWORD;
PropertyValue[] lArgs2 = new PropertyValue[1];
lArgs2[0] = new PropertyValue();
lArgs2[0].Name = "Hidden";
lArgs2[0].Value = Boolean.TRUE;
loadURL(m_xLoader, RESULT_VALID_DOC, sTestURL, "_blank", 0, lArgs1);
// TODO: wrong? loadURL(m_xLoader, RESULT_EMPTY_DOC, sTestURL, "_blank", 0, lArgs2);
}
/**
* Check URL encoding. The first filename that matches "*.sxw"
* is used as source for several encodings.
*/
@Test public void checkURLEncoding() throws Exception {
PropertyValue[] lProps = new PropertyValue[1];
lProps[0] = new PropertyValue();
lProps[0].Name = "Hidden";
lProps[0].Value = Boolean.TRUE;
// first get encoding of this system
InputStreamReader in = new InputStreamReader(System.in);
String sSystemEncoding = in.getEncoding();
System.out.println("This system's encoding: " + sSystemEncoding);
assertNotNull("Found an empty directory. There are no files for testing.", m_lTestFiles);
// get a file name as byte array
Iterator<String> aSnapshot = m_lTestFiles.iterator();
byte[] baURL = null;
while (aSnapshot.hasNext()) {
File aFile = new File(m_sTestDocPath, aSnapshot.next());
String sFile = URLHelper.getFileURLFromSystemPath(aFile);
// take the first sxw file as stream
if (sFile.endsWith(".sxw")) {
baURL = sFile.getBytes();
break;
}
}
assertNotNull("Found no file to load. Cannot test.", baURL);
//construct several different encoded strings
String[] sEncoding = new String[] {
"US-ASCII", "TRUE", // us ascii encoding
"ISO-8859-1", "TRUE", // iso encoding
"UTF-8", "TRUE", // 8 bit utf encoding
"UTF-16BE", "FALSE", // 16 bit big endian utf
"UTF-16LE", "FALSE", // 16 bit little endian utf
"UTF-16", "FALSE" // 16 bit, order specified by byte order mark
};
for (int i = 0; i < sEncoding.length; i = i + 2) {
String encURL = new String(baURL, sEncoding[i]);
System.out.println("ENC[" + sEncoding[i] + "]");
if (sEncoding[i + 1].equals("TRUE")) {
loadURL(m_xLoader, RESULT_VALID_DOC, encURL, "_blank", 0,
lProps);
} else {
//with cws_loadenv01 changed to IllegalArgumentException
loadURL(m_xLoader, RESULT_ILLEGALARGUMENTEXCEPTION, encURL, "_blank", 0,
lProps);
}
}
}
/** TODo document me
*/
@Test public void checkStreamLoading() throws Exception
{
PropertyValue[] lProps = new PropertyValue[2];
lProps[0] = new PropertyValue();
lProps[0].Name = "Hidden";
lProps[0].Value = Boolean.TRUE;
lProps[1] = new PropertyValue();
lProps[1].Name = "InputStream";
Iterator<String> aSnapshot = m_lTestFiles.iterator();
while (aSnapshot.hasNext())
{
File aFile = new File(m_sTestDocPath, aSnapshot.next());
String sURL = URLHelper.getFileURLFromSystemPath(aFile);
XInputStream xStream = m_xStreamProvider.openFileRead(sURL);
lProps[1].Value = xStream;
// check different version of "private:stream" URL!
loadURL(m_xLoader, RESULT_VALID_DOC, "private:stream" , "_blank", 0, lProps);
}
}
/**
* Loads one URL with the given parameters using the method
* loadComponentFromURL(). Further it's possible to specify, which result is
* required and we check internally if it was reached. Logging of errors
* and success stories is done inside this method too. Of course we catch
* all possible exceptions and try to leave the office without any forgotten
* but opened documents.
*/
private void loadURL(XComponentLoader xLoader, int nRequiredResult,
String sURL, String sTarget, int nFlags,
PropertyValue[] lProps) {
int nResult = RESULT_EMPTY_DOC;
XComponent xDoc = null;
try {
xDoc = xLoader.loadComponentFromURL(sURL, sTarget, nFlags,
lProps);
if (xDoc != null) {
nResult = RESULT_VALID_DOC;
} else {
nResult = RESULT_EMPTY_DOC;
}
} catch (com.sun.star.lang.IllegalArgumentException exArgument) {
nResult = RESULT_ILLEGALARGUMENTEXCEPTION;
} catch (com.sun.star.io.IOException exIO) {
nResult = RESULT_IOEXCEPTION;
} catch (com.sun.star.uno.RuntimeException exRuntime) {
nResult = RESULT_RUNTIMEEXCEPTION;
} catch (Exception e) {
nResult = RESULT_EXCEPTION;
}
try {
if (xDoc != null) {
xDoc.dispose();
xDoc = null;
}
} catch (com.sun.star.uno.RuntimeException exClosing) {
System.out.println("exception during disposing of a document found!" +
" Doesn't influence test - but should be checked.");
}
String sMessage = "URL[\"" + sURL + "\"]";
if (nResult == nRequiredResult) {
System.out.println(sMessage + " expected result [" +
convertResult2String(nResult) + "] ");
} else {
fail(sMessage + " unexpected result [" +
convertResult2String(nResult) + "] " +
"\nrequired was [" +
convertResult2String(nRequiredResult) + "]" +
"\nwe got [" + convertResult2String(nResult) + "]"
);
}
}
/**
* it match the int result value to a string, which can be used for logging
*/
private static String convertResult2String(int nResult) {
switch (nResult) {
case RESULT_VALID_DOC:
return "VALID_DOC";
case RESULT_EMPTY_DOC:
return "EMPTY_DOC";
case RESULT_ILLEGALARGUMENTEXCEPTION:
return "ILLEGALARGUMENTEXCEPTION";
case RESULT_IOEXCEPTION:
return "IOEXCEPTION";
case RESULT_RUNTIMEEXCEPTION:
return "RUNTIMEEXCEPTION";
case RESULT_EXCEPTION:
return "ALLOTHEREXCEPTION";
}
return "unknown!";
}
private XMultiServiceFactory getMSF()
{
return UnoRuntime.queryInterface(XMultiServiceFactory.class, connection.getComponentContext().getServiceManager());
}
// setup and close connections
@BeforeClass
public static void setUpConnection() throws Exception
{
System.out.println("setUpConnection()");
connection.setUp();
}
@AfterClass
public static void tearDownConnection()
throws InterruptedException, com.sun.star.uno.Exception
{
System.out.println("tearDownConnection()");
connection.tearDown();
}
private static final OfficeConnection connection = new OfficeConnection();
}
|