-
Notifications
You must be signed in to change notification settings - Fork 341
/
DefaultLocationManager.java
422 lines (357 loc) · 12.7 KB
/
DefaultLocationManager.java
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
/*
* Copyright (c) 2004-2022, University of Oslo
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* Neither the name of the HISP project nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hisp.dhis.external.location;
import static java.io.File.separator;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import javax.annotation.PostConstruct;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import lombok.extern.slf4j.Slf4j;
import org.hisp.dhis.external.util.LogOnceLogger;
import org.slf4j.event.Level;
/**
* @author Lars Helge Overland
*/
@Slf4j
public class DefaultLocationManager extends LogOnceLogger
implements LocationManager
{
private static final String DEFAULT_DHIS2_HOME = "/opt/dhis2";
private static final String DEFAULT_ENV_VAR = "DHIS2_HOME";
private static final String DEFAULT_SYS_PROP = "dhis2.home";
private static final String DEFAULT_CTX_VAR = "dhis2-home";
private String externalDir;
private String environmentVariable;
private String systemProperty;
private String contextVariable;
public DefaultLocationManager( String environmentVariable, String systemProperty, String contextVariable )
{
this.environmentVariable = environmentVariable;
this.systemProperty = systemProperty;
this.contextVariable = contextVariable;
}
public static DefaultLocationManager getDefault()
{
return new DefaultLocationManager( DEFAULT_ENV_VAR, DEFAULT_SYS_PROP, DEFAULT_CTX_VAR );
}
// -------------------------------------------------------------------------
// Init
// -------------------------------------------------------------------------
@PostConstruct
public void init()
{
// check the most specific to the least specific
// 1- context variable
externalDir = getPathFromContext();
// 2- system property
if ( externalDir == null )
externalDir = getPathFromSysProperty();
// 3- env variable
if ( externalDir == null )
externalDir = getPathFromEnvVariable();
// 4- default value
if ( externalDir == null )
externalDir = getPathDefault();
}
// -------------------------------------------------------------------------
// LocationManager implementation
// -------------------------------------------------------------------------
private String getPathFromContext()
{
String path = null;
try
{
Context initCtx = new InitialContext();
Context envCtx = (Context) initCtx.lookup( "java:comp/env" );
path = (String) envCtx.lookup( this.contextVariable );
}
catch ( NamingException e )
{
log( log, Level.INFO, "Context variable " + contextVariable + " not set" );
}
if ( path != null )
{
log( log, Level.INFO, "Context variable " + contextVariable + " points to " + path );
if ( directoryIsValid( new File( path ) ) )
{
return path;
}
}
return null;
}
private String getPathFromSysProperty()
{
String path = System.getProperty( systemProperty );
if ( path != null )
{
log( log, Level.INFO, "System property " + systemProperty + " points to " + path );
if ( directoryIsValid( new File( path ) ) )
{
return path;
}
}
else
{
log( log, Level.INFO, "System property " + systemProperty + " not set" );
}
return null;
}
private String getPathFromEnvVariable()
{
String path = System.getenv( environmentVariable );
if ( path != null )
{
log( log, Level.INFO, "Environment variable " + environmentVariable + " points to " + path );
if ( directoryIsValid( new File( path ) ) )
{
return path;
}
}
else
{
log( log, Level.INFO, "Environment variable " + environmentVariable + " not set" );
}
return null;
}
private String getPathDefault()
{
String path = DEFAULT_DHIS2_HOME;
if ( directoryIsValid( new File( path ) ) )
{
log( log, Level.INFO, "Home directory set to " + DEFAULT_DHIS2_HOME );
return path;
}
else
{
log( log, Level.ERROR, "No Home directory set, and " + DEFAULT_DHIS2_HOME + " is not a directory" );
return null;
}
}
// -------------------------------------------------------------------------
// InputStream
// -------------------------------------------------------------------------
@Override
public InputStream getInputStream( String fileName )
throws LocationManagerException
{
return getInputStream( fileName, new String[0] );
}
@Override
public InputStream getInputStream( String fileName, String... directories )
throws LocationManagerException
{
File file = getFileForReading( fileName, directories );
try
{
return new BufferedInputStream( new FileInputStream( file ) );
}
catch ( FileNotFoundException ex )
{
throw new LocationManagerException( "Could not find file", ex );
}
}
// -------------------------------------------------------------------------
// File for reading
// -------------------------------------------------------------------------
@Override
public File getFileForReading( String fileName )
throws LocationManagerException
{
return getFileForReading( fileName, new String[0] );
}
@Override
public File getFileForReading( String fileName, String... directories )
throws LocationManagerException
{
File directory = buildDirectory( directories );
File file = new File( directory, fileName );
if ( !canReadFile( file ) )
{
throw new LocationManagerException( "File " + file.getAbsolutePath() + " cannot be read" );
}
return file;
}
// -------------------------------------------------------------------------
// OutputStream
// -------------------------------------------------------------------------
@Override
public OutputStream getOutputStream( String fileName )
throws LocationManagerException
{
return getOutputStream( fileName, new String[0] );
}
@Override
public OutputStream getOutputStream( String fileName, String... directories )
throws LocationManagerException
{
File file = getFileForWriting( fileName, directories );
try
{
return new BufferedOutputStream( new FileOutputStream( file ) );
}
catch ( FileNotFoundException ex )
{
throw new LocationManagerException( "Could not find file", ex );
}
}
// -------------------------------------------------------------------------
// File for writing
// -------------------------------------------------------------------------
@Override
public File getFileForWriting( String fileName )
throws LocationManagerException
{
return getFileForWriting( fileName, new String[0] );
}
@Override
public File getFileForWriting( String fileName, String... directories )
throws LocationManagerException
{
File directory = buildDirectory( directories );
if ( !directoryIsValid( directory ) )
{
throw new LocationManagerException( "Directory " + directory.getAbsolutePath() + " cannot be created" );
}
return new File( directory, fileName );
}
@Override
public File buildDirectory( String... directories )
throws LocationManagerException
{
if ( externalDir == null )
{
throw new LocationManagerException( "External directory not set" );
}
StringBuilder directoryPath = new StringBuilder( externalDir + separator );
for ( String dir : directories )
{
directoryPath.append( dir ).append( separator );
}
return new File( directoryPath.toString() );
}
// -------------------------------------------------------------------------
// External directory and environment variable
// -------------------------------------------------------------------------
@Override
public File getExternalDirectory()
throws LocationManagerException
{
if ( externalDir == null )
{
throw new LocationManagerException( "External directory not set" );
}
return new File( externalDir );
}
public void setExternalDir( String externalDir )
{
this.externalDir = externalDir;
}
@Override
public String getExternalDirectoryPath()
throws LocationManagerException
{
if ( externalDir == null )
{
throw new LocationManagerException( "External directory not set" );
}
return externalDir;
}
@Override
public boolean externalDirectorySet()
{
return externalDir != null;
}
@Override
public String getEnvironmentVariable()
{
return environmentVariable;
}
// -------------------------------------------------------------------------
// Supportive methods
// -------------------------------------------------------------------------
/**
* Tests whether the file exists and can be read by the application.
*/
private boolean canReadFile( File file )
{
if ( !file.exists() )
{
log( log, Level.INFO, "File " + file.getAbsolutePath() + " does not exist" );
return false;
}
if ( !file.canRead() )
{
log( log, Level.INFO, "File " + file.getAbsolutePath() + " cannot be read" );
return false;
}
return true;
}
/**
* Tests whether the directory is writable by the application if the
* directory exists. Tries to create the directory including necessary
* parent directories if the directory does not exists, and tests whether
* the directory construction was successful and not prevented by a
* SecurityManager in any way.
*/
private boolean directoryIsValid( File directory )
{
if ( directory.exists() )
{
if ( !directory.canWrite() )
{
log( log, Level.INFO, "Directory " + directory.getAbsolutePath() + " is not writeable" );
return false;
}
}
else
{
try
{
if ( !directory.mkdirs() )
{
log( log, Level.INFO, "Directory " + directory.getAbsolutePath() + " cannot be created" );
return false;
}
}
catch ( SecurityException ex )
{
log( log, Level.INFO, "Directory " + directory.getAbsolutePath() + " cannot be accessed" );
return false;
}
}
return true;
}
}