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
|
/*
* 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 helper;
// __________ Imports __________
// exceptions
import java.io.File;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.Iterator;
import com.sun.star.util.XURLTransformer;
/**
* It collects some static helper functons to handle URLs.
* Sometimes it's necessary to convert URL from/to system paths.
* Or from string to strutural notations (e.g. com.sun.star.util.URL).
* And sometimes java had another notation then the office it has.
*
*/
public class URLHelper
{
/**
* Because the office need URLs for loading/saving documents
* we must convert used system paths.
* And java use another notation for file URLs ... correct it.
*
* @param aSystemPath
* represent the file in system notation
*
* @return [String]
* a file url which represent the given system path
*/
public static String getFileURLFromSystemPath( File aSystemPath )
{
String sFileURL = null;
try
{
sFileURL = aSystemPath.toURI().toURL().toString();
}
catch( MalformedURLException exWrong )
{
}
// problem of java: file URL's are coded with 1 slash instead of 2 or 3 ones!
// => correct this problem first, otherwise office can't use these URL's
if(
(sFileURL != null ) &&
(sFileURL.startsWith("file:/") == true ) &&
(sFileURL.startsWith("file://") == false)
)
{
StringBuffer sWorkBuffer = new StringBuffer(sFileURL);
sWorkBuffer.insert(6,"//");
sFileURL = sWorkBuffer.toString();
}
return sFileURL;
}
/**
* The same as getFileURLFromSystemPath() before but uses string parameter instead
* of a File type. It exist to supress converting of necessary parameters in the
* outside code. But of course getFileURLFromSystemPath(File) will be a little bit faster
* then this method ...
*
* @param sSystemPath
* represent the file in system notation
*
* @return [String]
* a file url which represent the given system path
*/
public static String getFileURLFromSystemPath( String sSystemPath )
{
return getFileURLFromSystemPath(new File(sSystemPath));
}
/**
* Does the same as getFileURLFromSystemPath() before ... but uses
* the given protocol string (e.g."http://") instead of "file:///".
*
* @param aSystemPath
* represent the file in system notation
*
* @param aBasePath
* define the base path of the aSystemPath value,
* which must be replaced with the value of "sServerPath".
*
* @param sServerURL
* Will be used to replace sBasePath.
*
* @example
* System Path = "d:\test\file.txt"
* Base Path = "d:\test"
* Server Path = "http://alaska:8000"
* => "http://alaska:8000/file.txt"
*
* @return [String]
* an url which represent the given system path
* and uses the given protocol
*/
public static String getURLWithProtocolFromSystemPath( File aSystemPath, File aBasePath, String sServerURL )
{
String sFileURL = URLHelper.getFileURLFromSystemPath(aSystemPath);
String sBaseURL = URLHelper.getFileURLFromSystemPath(aBasePath );
// cut last '/'!
if (sBaseURL.lastIndexOf('/')==(sBaseURL.length()-1))
sBaseURL = sBaseURL.substring(0,sBaseURL.length()-1);
// cut last '/'!
if (sServerURL.lastIndexOf('/')==(sServerURL.length()-1))
sServerURL = sServerURL.substring(0,sServerURL.length()-1);
int index = sFileURL.indexOf(sBaseURL);
String sURL = sFileURL.substring(0,index) + sServerURL +
sFileURL.substring(index+sBaseURL.length());
return sURL;
}
/**
* The same as getURLWithProtocolFromSystemPath() before but uses string parameter instead
* of a File types. It exist to supress converting of necessary parameters in the
* outside code. But of course getURLWithProtocolFromSystemPath(File,File,String) will be
* a little bit faster then this method ...
*
* @param sSystemPath
* represent the file in system notation
*
* @param sBasePath
* define the base path of the aSystemPath value,
* which must be replaced with the value of "sServerPath".
*
* @param sServerPath
* Will be used to replace sBasePath.
*
* @example
* System Path = "d:\test\file.txt"
* Base Path = "d:\test"
* Server Path = "http://alaska:8000"
* => "http://alaska:8000/file.txt"
*
* @return [String]
* an url which represent the given system path
* and uses the given protocol
*/
public static String getURLWithProtocolFromSystemPath( String sSystemPath, String sBasePath, String sServerPath )
{
return getURLWithProtocolFromSystemPath(new File(sSystemPath), new File(sBasePath), sServerPath);
}
/**
* This convert an URL (formated as a string) to a struct com.sun.star.util.URL.
* It use a special service to do that: the URLTransformer.
* Because some API calls need it and it's not allowed to set "Complete"
* part of the util struct only. The URL must be parsed.
*
* @param sURL
* URL for parsing in string notation
*
* @return [com.sun.star.util.URL]
* URL in UNO struct notation
*/
public static com.sun.star.util.URL parseURL(XURLTransformer xParser, String sURL)
{
com.sun.star.util.URL aURL = null;
if (sURL==null || sURL.equals(""))
return null;
try
{
// Create special service for parsing of given URL.
/* com.sun.star.util.XURLTransformer xParser = (com.sun.star.util.XURLTransformer)OfficeConnect.createRemoteInstance(
com.sun.star.util.XURLTransformer.class,
"com.sun.star.util.URLTransformer");
*/
// Because it's an in/out parameter we must use an array of URL objects.
com.sun.star.util.URL[] aParseURL = new com.sun.star.util.URL[1];
aParseURL[0] = new com.sun.star.util.URL();
aParseURL[0].Complete = sURL;
// Parse the URL
xParser.parseStrict(aParseURL);
aURL = aParseURL[0];
}
catch(com.sun.star.uno.RuntimeException exRuntime)
{
// Any UNO method of this scope can throw this exception.
// Reset the return value only.
aURL = null;
}
return aURL;
}
/**
* Return a name list of all available files of a directory.
* We filter pure sub directories names. All other files
* are returned as full qualified URL strings. So they can be
* used for further purposes. One parameter define the start directory,
* another one describe the url protocol, which the return URL names should have.
*
* @param sStartDir
* the start directory, which should include all test files
*
* @return [Vector]
* a filtered list of java File objects of all available files of the start dir
* and all accessible sub directories.
*/
public static ArrayList<File> getSystemFilesFromDir(String sStartDir)
{
File aRoot = new File(sStartDir);
if (! aRoot.exists())
return null;
if (! aRoot.isDirectory())
return null;
File[] lAllFiles = aRoot.listFiles();
if (lAllFiles == null )
return null;
ArrayList<File> lFilteredFiles = new ArrayList<File>(lAllFiles.length);
for (int i=0; i<lAllFiles.length; ++i)
{
if (lAllFiles[i].isFile())
lFilteredFiles.add(lAllFiles[i]);
else
if (lAllFiles[i].isDirectory())
{
// recursion!
ArrayList<File> lSubFiles = URLHelper.getSystemFilesFromDir(lAllFiles[i].getPath());
if (lSubFiles != null)
{
Iterator<File> aSnapshot = lSubFiles.iterator();
while (aSnapshot.hasNext())
lFilteredFiles.add(aSnapshot.next());
}
}
}
return lFilteredFiles;
}
}
|