1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.owasp.dependencycheck.utils;
19
20 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
21 import org.slf4j.Logger;
22 import org.slf4j.LoggerFactory;
23
24 import com.fasterxml.jackson.core.JsonProcessingException;
25 import com.fasterxml.jackson.databind.ObjectMapper;
26
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29
30 import java.io.File;
31 import java.io.FileInputStream;
32 import java.io.FileNotFoundException;
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.io.PrintWriter;
36 import java.io.StringWriter;
37 import java.io.UnsupportedEncodingException;
38 import java.net.URLDecoder;
39 import java.nio.charset.StandardCharsets;
40 import java.security.ProtectionDomain;
41 import java.util.ArrayList;
42 import java.util.Arrays;
43 import java.util.Enumeration;
44 import java.util.List;
45 import java.util.Properties;
46 import java.util.UUID;
47 import java.util.function.Predicate;
48 import java.util.regex.Pattern;
49 import java.util.stream.Collectors;
50
51
52
53
54
55
56
57 public final class Settings {
58
59
60
61
62 private static final Logger LOGGER = LoggerFactory.getLogger(Settings.class);
63
64
65
66 private static final String PROPERTIES_FILE = "dependencycheck.properties";
67
68
69
70 private static final String ARRAY_SEP = ",";
71
72
73
74 private Properties props = null;
75
76
77
78 private List<Predicate<String>> maskedKeys;
79
80
81
82
83 private File tempDirectory = null;
84
85
86
87
88 private final ObjectMapper objectMapper = new ObjectMapper();
89
90
91
92
93
94
95 @SuppressWarnings("squid:S2068")
96 public static final class KEYS {
97
98
99
100
101 public static final String APPLICATION_NAME = "odc.application.name";
102
103
104
105 public static final String APPLICATION_VERSION = "odc.application.version";
106
107
108
109
110 public static final String ENGINE_VERSION_CHECK_URL = "engine.version.url";
111
112
113
114
115 public static final String AUTO_UPDATE = "odc.autoupdate";
116
117
118
119
120 public static final String DB_DRIVER_NAME = "data.driver_name";
121
122
123
124
125 public static final String DB_DRIVER_PATH = "data.driver_path";
126
127
128
129
130 public static final String DB_CONNECTION_STRING = "data.connection_string";
131
132
133
134 public static final String DB_USER = "data.user";
135
136
137
138 public static final String DB_PASSWORD = "data.password";
139
140
141
142
143 public static final String DATA_DIRECTORY = "data.directory";
144
145
146
147 public static final String H2_DATA_DIRECTORY = "data.h2.directory";
148
149
150
151 public static final String DB_FILE_NAME = "data.file_name";
152
153
154
155 public static final String DB_VERSION = "data.version";
156
157
158
159
160
161
162
163 public static final String CVE_CPE_STARTS_WITH_FILTER = "cve.cpe.startswith.filter";
164
165
166
167 public static final String NVD_API_ENDPOINT = "nvd.api.endpoint";
168
169
170
171 public static final String NVD_API_KEY = "nvd.api.key";
172
173
174
175 public static final String NVD_API_DELAY = "nvd.api.delay";
176
177
178
179
180 public static final String NVD_API_MAX_RETRY_COUNT = "nvd.api.max.retry.count";
181
182
183
184
185 public static final String NVD_API_VALID_FOR_HOURS = "nvd.api.check.validforhours";
186
187
188
189
190 public static final String NVD_API_RESULTS_PER_PAGE = "nvd.api.results.per.page";
191
192
193
194
195 public static final String NVD_API_DATAFEED_VALID_FOR_DAYS = "nvd.api.datafeed.validfordays";
196
197
198
199 public static final String NVD_API_DATAFEED_URL = "nvd.api.datafeed.url";
200
201
202
203
204 public static final String NVD_API_DATAFEED_USER = "nvd.api.datafeed.user";
205
206
207
208
209 public static final String NVD_API_DATAFEED_PASSWORD = "nvd.api.datafeed.password";
210
211
212
213
214 public static final String NVD_API_DATAFEED_BEARER_TOKEN = "nvd.api.datafeed.bearertoken";
215
216
217
218 public static final String NVD_API_DATAFEED_START_YEAR = "nvd.api.datafeed.startyear";
219
220
221
222
223 public static final String ANALYZER_NVD_CVE_ENABLED = "analyzer.nvdcve.enabled";
224
225
226
227
228 public static final String CPE_MODIFIED_VALID_FOR_DAYS = "cpe.validfordays";
229
230
231
232 public static final String CPE_URL = "cpe.url";
233
234
235
236
237 public static final String KEV_URL = "kev.url";
238
239
240
241
242
243 public static final String KEV_USER = "kev.user";
244
245
246
247
248
249 public static final String KEV_PASSWORD = "kev.password";
250
251
252
253
254
255 public static final String KEV_BEARER_TOKEN = "kev.bearertoken";
256
257
258
259
260
261 public static final String KEV_CHECK_VALID_FOR_HOURS = "kev.check.validforhours";
262
263
264
265
266
267 public static final String PROXY_DISABLE_SCHEMAS = "proxy.disableSchemas";
268
269
270
271 public static final String PROXY_SERVER = "proxy.server";
272
273
274
275
276 public static final String PROXY_PORT = "proxy.port";
277
278
279
280 public static final String PROXY_USERNAME = "proxy.username";
281
282
283
284 public static final String PROXY_PASSWORD = "proxy.password";
285
286
287
288 public static final String PROXY_NON_PROXY_HOSTS = "proxy.nonproxyhosts";
289
290
291
292 public static final String CONNECTION_TIMEOUT = "connection.timeout";
293
294
295
296 public static final String CONNECTION_READ_TIMEOUT = "connection.read.timeout";
297
298
299
300 public static final String TEMP_DIRECTORY = "temp.directory";
301
302
303
304 public static final String MAX_DOWNLOAD_THREAD_POOL_SIZE = "max.download.threads";
305
306
307
308 public static final String ANALYSIS_TIMEOUT = "odc.analysis.timeout";
309
310
311
312 public static final String SUPPRESSION_FILE = "suppression.file";
313
314
315
316
317 public static final String SUPPRESSION_FILE_USER = "suppression.file.user";
318
319
320
321
322 public static final String SUPPRESSION_FILE_PASSWORD = "suppression.file.password";
323
324
325
326
327 public static final String SUPPRESSION_FILE_BEARER_TOKEN = "suppression.file.bearertoken";
328
329
330
331
332 public static final String HOSTED_SUPPRESSIONS_ENABLED = "hosted.suppressions.enabled";
333
334
335
336 public static final String HOSTED_SUPPRESSIONS_URL = "hosted.suppressions.url";
337
338
339
340
341
342 public static final String HOSTED_SUPPRESSIONS_USER = "hosted.suppressions.user";
343
344
345
346
347
348 public static final String HOSTED_SUPPRESSIONS_PASSWORD = "hosted.suppressions.password";
349
350
351
352
353
354 public static final String HOSTED_SUPPRESSIONS_BEARER_TOKEN = "hosted.suppressions.bearertoken";
355
356
357
358
359
360 public static final String HOSTED_SUPPRESSIONS_FORCEUPDATE = "hosted.suppressions.forceupdate";
361
362
363
364
365
366 public static final String HOSTED_SUPPRESSIONS_VALID_FOR_HOURS = "hosted.suppressions.validforhours";
367
368
369
370
371 public static final String HINTS_FILE = "hints.file";
372
373
374
375
376 public static final String JUNIT_FAIL_ON_CVSS = "junit.fail.on.cvss";
377
378
379
380
381 public static final String ANALYZER_JAR_ENABLED = "analyzer.jar.enabled";
382
383
384
385
386
387 public static final String ANALYZER_KNOWN_EXPLOITED_ENABLED = "analyzer.knownexploited.enabled";
388
389
390
391
392 public static final String ANALYZER_EXPERIMENTAL_ENABLED = "analyzer.experimental.enabled";
393
394
395
396 public static final String ANALYZER_RETIRED_ENABLED = "analyzer.retired.enabled";
397
398
399
400 public static final String ANALYZER_ARCHIVE_ENABLED = "analyzer.archive.enabled";
401
402
403
404
405 public static final String ANALYZER_NODE_PACKAGE_ENABLED = "analyzer.node.package.enabled";
406
407
408
409
410 public static final String ANALYZER_NODE_PACKAGE_SKIPDEV = "analyzer.node.package.skipdev";
411
412
413
414 public static final String ANALYZER_NODE_AUDIT_ENABLED = "analyzer.node.audit.enabled";
415
416
417
418 public static final String ANALYZER_YARN_AUDIT_ENABLED = "analyzer.yarn.audit.enabled";
419
420
421
422 public static final String ANALYZER_PNPM_AUDIT_ENABLED = "analyzer.pnpm.audit.enabled";
423
424
425
426 public static final String ANALYZER_NODE_AUDIT_URL = "analyzer.node.audit.url";
427
428
429
430
431 public static final String ANALYZER_NODE_AUDIT_SKIPDEV = "analyzer.node.audit.skipdev";
432
433
434
435
436 public static final String ANALYZER_NODE_AUDIT_USE_CACHE = "analyzer.node.audit.use.cache";
437
438
439
440 public static final String ANALYZER_RETIREJS_ENABLED = "analyzer.retirejs.enabled";
441
442
443
444
445 public static final String ANALYZER_RETIREJS_FILTERS = "analyzer.retirejs.filters";
446
447
448
449
450 public static final String ANALYZER_RETIREJS_FILTER_NON_VULNERABLE = "analyzer.retirejs.filternonvulnerable";
451
452
453
454 public static final String ANALYZER_RETIREJS_REPO_JS_URL = "analyzer.retirejs.repo.js.url";
455
456
457
458
459 public static final String ANALYZER_RETIREJS_REPO_JS_USER = "analyzer.retirejs.repo.js.username";
460
461
462
463
464 public static final String ANALYZER_RETIREJS_REPO_JS_PASSWORD = "analyzer.retirejs.repo.js.password";
465
466
467
468
469 public static final String ANALYZER_RETIREJS_REPO_JS_BEARER_TOKEN = "analyzer.retirejs.repo.js.bearertoken";
470
471
472
473
474 public static final String ANALYZER_RETIREJS_FORCEUPDATE = "analyzer.retirejs.forceupdate";
475
476
477
478
479 public static final String ANALYZER_RETIREJS_REPO_VALID_FOR_HOURS = "analyzer.retirejs.repo.validforhours";
480
481
482
483
484 public static final String ANALYZER_COMPOSER_LOCK_ENABLED = "analyzer.composer.lock.enabled";
485
486
487
488
489 public static final String ANALYZER_COMPOSER_LOCK_SKIP_DEV = "analyzer.composer.lock.skipdev";
490
491
492
493
494 public static final String ANALYZER_CPANFILE_ENABLED = "analyzer.cpanfile.enabled";
495
496
497
498
499 public static final String ANALYZER_PYTHON_DISTRIBUTION_ENABLED = "analyzer.python.distribution.enabled";
500
501
502
503
504 public static final String ANALYZER_PYTHON_PACKAGE_ENABLED = "analyzer.python.package.enabled";
505
506
507
508
509 public static final String ANALYZER_MIX_AUDIT_ENABLED = "analyzer.mix.audit.enabled";
510
511
512
513 public static final String ANALYZER_MIX_AUDIT_PATH = "analyzer.mix.audit.path";
514
515
516
517 public static final String ANALYZER_GOLANG_MOD_ENABLED = "analyzer.golang.mod.enabled";
518
519
520
521 public static final String ANALYZER_GOLANG_PATH = "analyzer.golang.path";
522
523
524
525 public static final String ANALYZER_YARN_PATH = "analyzer.yarn.path";
526
527
528
529 public static final String ANALYZER_PNPM_PATH = "analyzer.pnpm.path";
530
531
532
533 public static final String ANALYZER_GOLANG_DEP_ENABLED = "analyzer.golang.dep.enabled";
534
535
536
537 public static final String ANALYZER_RUBY_GEMSPEC_ENABLED = "analyzer.ruby.gemspec.enabled";
538
539
540
541 public static final String ANALYZER_AUTOCONF_ENABLED = "analyzer.autoconf.enabled";
542
543
544
545
546 public static final String ANALYZER_MAVEN_INSTALL_ENABLED = "analyzer.maveninstall.enabled";
547
548
549
550 public static final String ANALYZER_PIP_ENABLED = "analyzer.pip.enabled";
551
552
553
554 public static final String ANALYZER_PIPFILE_ENABLED = "analyzer.pipfile.enabled";
555
556
557
558 public static final String ANALYZER_POETRY_ENABLED = "analyzer.poetry.enabled";
559
560
561
562 public static final String ANALYZER_CMAKE_ENABLED = "analyzer.cmake.enabled";
563
564
565
566
567 public static final String ANALYZER_BUNDLE_AUDIT_ENABLED = "analyzer.bundle.audit.enabled";
568
569
570
571 public static final String ANALYZER_ASSEMBLY_ENABLED = "analyzer.assembly.enabled";
572
573
574
575 public static final String ANALYZER_NUSPEC_ENABLED = "analyzer.nuspec.enabled";
576
577
578
579
580 public static final String ANALYZER_NUGETCONF_ENABLED = "analyzer.nugetconf.enabled";
581
582
583
584 public static final String ANALYZER_LIBMAN_ENABLED = "analyzer.libman.enabled";
585
586
587
588
589 public static final String ANALYZER_MSBUILD_PROJECT_ENABLED = "analyzer.msbuildproject.enabled";
590
591
592
593 public static final String ANALYZER_NEXUS_ENABLED = "analyzer.nexus.enabled";
594
595
596
597 public static final String ANALYZER_NEXUS_URL = "analyzer.nexus.url";
598
599
600
601 public static final String ANALYZER_NEXUS_USER = "analyzer.nexus.username";
602
603
604
605 public static final String ANALYZER_NEXUS_PASSWORD = "analyzer.nexus.password";
606
607
608
609 public static final String ANALYZER_NEXUS_USES_PROXY = "analyzer.nexus.proxy";
610
611
612
613 public static final String ANALYZER_ARTIFACTORY_ENABLED = "analyzer.artifactory.enabled";
614
615
616
617 public static final String ANALYZER_ARTIFACTORY_URL = "analyzer.artifactory.url";
618
619
620
621 public static final String ANALYZER_ARTIFACTORY_API_USERNAME = "analyzer.artifactory.api.username";
622
623
624
625 public static final String ANALYZER_ARTIFACTORY_API_TOKEN = "analyzer.artifactory.api.token";
626
627
628
629
630
631
632
633
634 public static final String ANALYZER_ARTIFACTORY_BEARER_TOKEN = "analyzer.artifactory.bearer.token";
635
636
637
638 public static final String ANALYZER_ARTIFACTORY_USES_PROXY = "analyzer.artifactory.proxy";
639
640
641
642
643 public static final String ANALYZER_ARTIFACTORY_PARALLEL_ANALYSIS = "analyzer.artifactory.parallel.analysis";
644
645
646
647 public static final String ANALYZER_CENTRAL_ENABLED = "analyzer.central.enabled";
648
649
650
651 public static final String MAVEN_LOCAL_REPO = "odc.maven.local.repo";
652
653
654
655 public static final String CENTRAL_CONTENT_URL = "central.content.url";
656
657
658
659
660 public static final String CENTRAL_CONTENT_USER = "central.content.username";
661
662
663
664
665 public static final String CENTRAL_CONTENT_PASSWORD = "central.content.password";
666
667
668
669
670 public static final String CENTRAL_CONTENT_BEARER_TOKEN = "central.content.bearertoken";
671
672
673
674
675 public static final String ANALYZER_CENTRAL_PARALLEL_ANALYSIS = "analyzer.central.parallel.analysis";
676
677
678
679
680 public static final String ANALYZER_CENTRAL_RETRY_COUNT = "analyzer.central.retry.count";
681
682
683
684 public static final String ANALYZER_OPENSSL_ENABLED = "analyzer.openssl.enabled";
685
686
687
688 public static final String ANALYZER_COCOAPODS_ENABLED = "analyzer.cocoapods.enabled";
689
690
691
692 public static final String ANALYZER_CARTHAGE_ENABLED = "analyzer.carthage.enabled";
693
694
695
696
697 public static final String ANALYZER_SWIFT_PACKAGE_MANAGER_ENABLED = "analyzer.swift.package.manager.enabled";
698
699
700
701
702 public static final String ANALYZER_SWIFT_PACKAGE_RESOLVED_ENABLED = "analyzer.swift.package.resolved.enabled";
703
704
705
706 public static final String ANALYZER_CENTRAL_URL = "analyzer.central.url";
707
708
709
710
711 public static final String ANALYZER_CENTRAL_USER = "analyzer.central.username";
712
713
714
715
716 public static final String ANALYZER_CENTRAL_PASSWORD = "analyzer.central.password";
717
718
719
720
721 public static final String ANALYZER_CENTRAL_BEARER_TOKEN = "analyzer.central.bearertoken";
722
723
724
725 public static final String ANALYZER_CENTRAL_QUERY = "analyzer.central.query";
726
727
728
729 public static final String ANALYZER_CENTRAL_USE_CACHE = "analyzer.central.use.cache";
730
731
732
733 public static final String ANALYZER_ASSEMBLY_DOTNET_PATH = "analyzer.assembly.dotnet.path";
734
735
736
737 public static final String ANALYZER_BUNDLE_AUDIT_PATH = "analyzer.bundle.audit.path";
738
739
740
741 public static final String ANALYZER_BUNDLE_AUDIT_WORKING_DIRECTORY = "analyzer.bundle.audit.working.directory";
742
743
744
745 public static final String ADDITIONAL_ZIP_EXTENSIONS = "extensions.zip";
746
747
748
749 public static final String VFEED_DATA_FILE = "vfeed.data_file";
750
751
752
753 public static final String VFEED_CONNECTION_STRING = "vfeed.connection_string";
754
755
756
757 public static final String VFEED_DOWNLOAD_URL = "vfeed.download_url";
758
759
760
761 public static final String VFEED_DOWNLOAD_FILE = "vfeed.download_file";
762
763
764
765 public static final String VFEED_UPDATE_STATUS = "vfeed.update_status";
766
767
768
769 public static final String DOWNLOADER_QUICK_QUERY_TIMESTAMP = "downloader.quick.query.timestamp";
770
771
772
773 public static final String DOWNLOADER_TLS_PROTOCOL_LIST = "downloader.tls.protocols";
774
775
776
777 public static final String ANALYZER_CPE_ENABLED = "analyzer.cpe.enabled";
778
779
780
781 public static final String ANALYZER_NPM_CPE_ENABLED = "analyzer.npm.cpe.enabled";
782
783
784
785 public static final String ANALYZER_CPE_SUPPRESSION_ENABLED = "analyzer.cpesuppression.enabled";
786
787
788
789 public static final String ANALYZER_DEPENDENCY_BUNDLING_ENABLED = "analyzer.dependencybundling.enabled";
790
791
792
793 public static final String ANALYZER_DEPENDENCY_MERGING_ENABLED = "analyzer.dependencymerging.enabled";
794
795
796
797 public static final String ANALYZER_FALSE_POSITIVE_ENABLED = "analyzer.falsepositive.enabled";
798
799
800
801 public static final String ANALYZER_FILE_NAME_ENABLED = "analyzer.filename.enabled";
802
803
804
805 public static final String ANALYZER_PE_ENABLED = "analyzer.pe.enabled";
806
807
808
809 public static final String ANALYZER_HINT_ENABLED = "analyzer.hint.enabled";
810
811
812
813 public static final String ANALYZER_VERSION_FILTER_ENABLED = "analyzer.versionfilter.enabled";
814
815
816
817
818 public static final String ANALYZER_VULNERABILITY_SUPPRESSION_ENABLED = "analyzer.vulnerabilitysuppression.enabled";
819
820
821
822 public static final String UPDATE_NVDCVE_ENABLED = "updater.nvdcve.enabled";
823
824
825
826
827 public static final String UPDATE_VERSION_CHECK_ENABLED = "updater.versioncheck.enabled";
828
829
830
831 public static final String ECOSYSTEM_SKIP_CPEANALYZER = "ecosystem.skip.cpeanalyzer";
832
833
834
835 public static final String ENABLE_BATCH_UPDATES = "database.batchinsert.enabled";
836
837
838
839 public static final String MAX_BATCH_SIZE = "database.batchinsert.maxsize";
840
841
842
843
844 public static final String WRITELOCK_SHUTDOWN_HOOK = "data.writelock.shutdownhook";
845
846
847
848
849 public static final String ANALYZER_OSSINDEX_ENABLED = "analyzer.ossindex.enabled";
850
851
852
853
854 public static final String ANALYZER_OSSINDEX_USE_CACHE = "analyzer.ossindex.use.cache";
855
856
857
858 public static final String ANALYZER_OSSINDEX_URL = "analyzer.ossindex.url";
859
860
861
862 public static final String ANALYZER_OSSINDEX_USER = "analyzer.ossindex.user";
863
864
865
866 public static final String ANALYZER_OSSINDEX_PASSWORD = "analyzer.ossindex.password";
867
868
869
870 public static final String ANALYZER_OSSINDEX_BATCH_SIZE = "analyzer.ossindex.batch.size";
871
872
873
874
875
876 public static final String ANALYZER_OSSINDEX_REQUEST_DELAY = "analyzer.ossindex.request.delay";
877
878
879
880
881 public static final String ANALYZER_OSSINDEX_WARN_ONLY_ON_REMOTE_ERRORS = "analyzer.ossindex.remote-error.warn-only";
882
883
884
885
886
887
888
889
890 public static final String ANALYZER_DART_ENABLED = "analyzer.dart.enabled";
891
892
893
894
895 public static final String PRETTY_PRINT = "odc.reports.pretty.print";
896
897
898
899
900 public static final String MASKED_PROPERTIES = "odc.settings.mask";
901
902
903
904
905 public static final String MAX_QUERY_SIZE_DEFAULT = "odc.ecosystem.maxquerylimit.default";
906
907
908
909
910 public static final String MAX_QUERY_SIZE_PREFIX = "odc.ecosystem.maxquerylimit.";
911
912
913
914 public static final String FAIL_ON_UNUSED_SUPPRESSION_RULE = "analyzer.suppression.unused.fail";
915
916
917
918
919
920 private KEYS() {
921
922 }
923 }
924
925
926
927
928
929 public Settings() {
930 initialize(PROPERTIES_FILE);
931 }
932
933
934
935
936
937
938
939 public Settings(final Properties properties) {
940 props = properties;
941 logProperties("Properties loaded", props);
942 }
943
944
945
946
947
948
949 public Settings(@NotNull final String propertiesFilePath) {
950 initialize(propertiesFilePath);
951 }
952
953
954
955
956
957
958 private void initialize(@NotNull final String propertiesFilePath) {
959 props = new Properties();
960 try (InputStream in = FileUtils.getResourceAsStream(propertiesFilePath)) {
961 props.load(in);
962 } catch (NullPointerException ex) {
963 LOGGER.error("Did not find settings file '{}'.", propertiesFilePath);
964 LOGGER.debug("", ex);
965 } catch (IOException ex) {
966 LOGGER.error("Unable to load settings from '{}'.", propertiesFilePath);
967 LOGGER.debug("", ex);
968 }
969 logProperties("Properties loaded", props);
970 }
971
972
973
974
975 public void cleanup() {
976 cleanup(true);
977 }
978
979
980
981
982
983
984
985 public synchronized void cleanup(boolean deleteTemporary) {
986 if (deleteTemporary && tempDirectory != null && tempDirectory.exists()) {
987 LOGGER.debug("Deleting ALL temporary files from `{}`", tempDirectory.toString());
988 FileUtils.delete(tempDirectory);
989 tempDirectory = null;
990 }
991 }
992
993
994
995
996
997
998
999
1000 private boolean isKeyMasked(@NotNull String key) {
1001 if (maskedKeys == null || maskedKeys.isEmpty()) {
1002 initMaskedKeys();
1003 }
1004 return maskedKeys.stream().anyMatch(maskExp -> maskExp.test(key));
1005 }
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015 String getPrintableValue(@NotNull String key, String value) {
1016 String printableValue = null;
1017 if (value != null) {
1018 printableValue = isKeyMasked(key) ? "********" : value;
1019 }
1020 return printableValue;
1021 }
1022
1023
1024
1025
1026
1027
1028
1029 void initMaskedKeys() {
1030 final String[] masked = getArray(Settings.KEYS.MASKED_PROPERTIES);
1031 if (masked == null) {
1032 maskedKeys = new ArrayList<>();
1033 } else {
1034 maskedKeys = Arrays.stream(masked)
1035 .map(v -> Pattern.compile(v).asPredicate())
1036 .collect(Collectors.toList());
1037 }
1038 }
1039
1040
1041
1042
1043
1044
1045
1046
1047 private void logProperties(@NotNull final String header, @NotNull final Properties properties) {
1048 if (LOGGER.isDebugEnabled()) {
1049 initMaskedKeys();
1050 final StringWriter sw = new StringWriter();
1051 try (PrintWriter pw = new PrintWriter(sw)) {
1052 pw.format("%s:%n%n", header);
1053 final Enumeration<?> e = properties.propertyNames();
1054 while (e.hasMoreElements()) {
1055 final String key = (String) e.nextElement();
1056 final String value = getPrintableValue(key, properties.getProperty(key));
1057 if (value != null) {
1058 pw.format("%s='%s'%n", key, value);
1059 }
1060 }
1061 pw.flush();
1062 LOGGER.debug(sw.toString());
1063 }
1064 }
1065 }
1066
1067
1068
1069
1070
1071
1072
1073 public void setString(@NotNull final String key, @NotNull final String value) {
1074 props.setProperty(key, value);
1075 LOGGER.debug("Setting: {}='{}'", key, getPrintableValue(key, value));
1076 }
1077
1078
1079
1080
1081
1082
1083
1084 public void setStringIfNotNull(@NotNull final String key, @Nullable final String value) {
1085 if (null != value) {
1086 setString(key, value);
1087 }
1088 }
1089
1090
1091
1092
1093
1094
1095
1096 public void setStringIfNotEmpty(@NotNull final String key, @Nullable final String value) {
1097 if (null != value && !value.isEmpty()) {
1098 setString(key, value);
1099 }
1100 }
1101
1102
1103
1104
1105
1106
1107
1108 public void setArrayIfNotEmpty(@NotNull final String key, @Nullable final String[] value) {
1109 if (null != value && value.length > 0) {
1110 try {
1111 setString(key, objectMapper.writeValueAsString(value));
1112 } catch (JsonProcessingException e) {
1113 throw new IllegalArgumentException();
1114 }
1115 }
1116 }
1117
1118
1119
1120
1121
1122
1123
1124 public void setArrayIfNotEmpty(@NotNull final String key, @Nullable final List<String> value) {
1125 if (null != value && !value.isEmpty()) {
1126 try {
1127 setString(key, objectMapper.writeValueAsString(value));
1128 } catch (JsonProcessingException e) {
1129 throw new IllegalArgumentException();
1130 }
1131 }
1132 }
1133
1134
1135
1136
1137
1138
1139
1140 public void setBoolean(@NotNull final String key, boolean value) {
1141 setString(key, Boolean.toString(value));
1142 }
1143
1144
1145
1146
1147
1148
1149
1150 public void setBooleanIfNotNull(@NotNull final String key, @Nullable final Boolean value) {
1151 if (null != value) {
1152 setBoolean(key, value);
1153 }
1154 }
1155
1156
1157
1158
1159
1160
1161
1162 public void setFloat(@NotNull final String key, final float value) {
1163 setString(key, Float.toString(value));
1164 }
1165
1166
1167
1168
1169
1170
1171
1172 public void setInt(@NotNull final String key, final int value) {
1173 props.setProperty(key, String.valueOf(value));
1174 LOGGER.debug("Setting: {}='{}'", key, value);
1175 }
1176
1177
1178
1179
1180
1181
1182
1183 public void setIntIfNotNull(@NotNull final String key, @Nullable final Integer value) {
1184 if (null != value) {
1185 setInt(key, value);
1186 }
1187 }
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201 @SuppressFBWarnings(justification = "try with resource will clenaup the resources", value = {"OBL_UNSATISFIED_OBLIGATION"})
1202 public void mergeProperties(@NotNull final File filePath) throws FileNotFoundException, IOException {
1203 try (FileInputStream fis = new FileInputStream(filePath)) {
1204 mergeProperties(fis);
1205 }
1206 }
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220 @SuppressFBWarnings(justification = "try with resource will clenaup the resources", value = {"OBL_UNSATISFIED_OBLIGATION"})
1221 public void mergeProperties(@NotNull final String filePath) throws FileNotFoundException, IOException {
1222 try (FileInputStream fis = new FileInputStream(filePath)) {
1223 mergeProperties(fis);
1224 }
1225 }
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237 public void mergeProperties(@NotNull final InputStream stream) throws IOException {
1238 props.load(stream);
1239 logProperties("Properties updated via merge", props);
1240 }
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251 @Nullable
1252 public File getFile(@NotNull final String key) {
1253 final String file = getString(key);
1254 if (file == null) {
1255 return null;
1256 }
1257 return new File(file);
1258 }
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 File getDataFile(@NotNull final String key) {
1275 final String file = getString(key);
1276 LOGGER.debug("Settings.getDataFile() - file: '{}'", file);
1277 if (file == null) {
1278 return null;
1279 }
1280 if (file.startsWith("[JAR]")) {
1281 LOGGER.debug("Settings.getDataFile() - transforming filename");
1282 final File jarPath = getJarPath();
1283 LOGGER.debug("Settings.getDataFile() - jar file: '{}'", jarPath.toString());
1284 final File retVal = new File(jarPath, file.substring(6));
1285 LOGGER.debug("Settings.getDataFile() - returning: '{}'", retVal);
1286 return retVal;
1287 }
1288 return new File(file);
1289 }
1290
1291
1292
1293
1294
1295
1296
1297 private File getJarPath() {
1298 String decodedPath = ".";
1299 String jarPath = "";
1300 final ProtectionDomain domain = Settings.class.getProtectionDomain();
1301 if (domain != null && domain.getCodeSource() != null && domain.getCodeSource().getLocation() != null) {
1302 jarPath = Settings.class.getProtectionDomain().getCodeSource().getLocation().getPath();
1303 }
1304 try {
1305 decodedPath = URLDecoder.decode(jarPath, StandardCharsets.UTF_8.name());
1306 } catch (UnsupportedEncodingException ex) {
1307 LOGGER.trace("", ex);
1308 }
1309
1310 final File path = new File(decodedPath);
1311 if (path.getName().toLowerCase().endsWith(".jar")) {
1312 return path.getParentFile();
1313 } else {
1314 return new File(".");
1315 }
1316 }
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328 public String getString(@NotNull final String key, @Nullable final String defaultValue) {
1329 return System.getProperty(key, props.getProperty(key, defaultValue));
1330 }
1331
1332
1333
1334
1335
1336
1337
1338 public synchronized File getTempDirectory() throws IOException {
1339 if (tempDirectory == null) {
1340 final File baseTemp = new File(getString(Settings.KEYS.TEMP_DIRECTORY, System.getProperty("java.io.tmpdir")));
1341 tempDirectory = FileUtils.createTempDirectory(baseTemp);
1342 }
1343 return tempDirectory;
1344 }
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355 public String getString(@NotNull final String key) {
1356 return System.getProperty(key, props.getProperty(key));
1357 }
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368 public String[] getArray(@NotNull final String key) {
1369 final String string = getString(key);
1370 if (string != null) {
1371 if (string.charAt(0) == '{' || string.charAt(0) == '[') {
1372 try {
1373 return objectMapper.readValue(string, String[].class);
1374 } catch (JsonProcessingException e) {
1375 throw new IllegalStateException("Unable to read value '" + string + "' as an array");
1376 }
1377 } else {
1378 return string.split(ARRAY_SEP);
1379 }
1380 }
1381 return null;
1382 }
1383
1384
1385
1386
1387
1388
1389
1390 public void removeProperty(@NotNull final String key) {
1391 props.remove(key);
1392 }
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405 public int getInt(@NotNull final String key) throws InvalidSettingException {
1406 try {
1407 return Integer.parseInt(getString(key));
1408 } catch (NumberFormatException ex) {
1409 throw new InvalidSettingException("Could not convert property '" + key + "' to an int.", ex);
1410 }
1411 }
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424 public int getInt(@NotNull final String key, int defaultValue) {
1425 int value;
1426 try {
1427 value = Integer.parseInt(getString(key));
1428 } catch (NumberFormatException ex) {
1429 if (!getString(key, "").isEmpty()) {
1430 LOGGER.debug("Could not convert property '{}={}' to an int; using {} instead.",
1431 key, getPrintableValue(key, getString(key)), defaultValue);
1432 }
1433 value = defaultValue;
1434 }
1435 return value;
1436 }
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449 public long getLong(@NotNull final String key) throws InvalidSettingException {
1450 try {
1451 return Long.parseLong(getString(key));
1452 } catch (NumberFormatException ex) {
1453 throw new InvalidSettingException("Could not convert property '" + key + "' to a long.", ex);
1454 }
1455 }
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469 public boolean getBoolean(@NotNull final String key) throws InvalidSettingException {
1470 return Boolean.parseBoolean(getString(key));
1471 }
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485 public boolean getBoolean(@NotNull final String key, boolean defaultValue) {
1486 return Boolean.parseBoolean(getString(key, Boolean.toString(defaultValue)));
1487 }
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501 public float getFloat(@NotNull final String key, float defaultValue) {
1502 float retValue = defaultValue;
1503 try {
1504 retValue = Float.parseFloat(getString(key));
1505 } catch (Throwable ex) {
1506 LOGGER.trace("ignore", ex);
1507 }
1508 return retValue;
1509 }
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524 public String getConnectionString(String connectionStringKey, String dbFileNameKey)
1525 throws IOException, InvalidSettingException {
1526 final String connStr = getString(connectionStringKey);
1527 if (connStr == null) {
1528 final String msg = String.format("Invalid properties file; %s is missing.", connectionStringKey);
1529 throw new InvalidSettingException(msg);
1530 }
1531 if (connStr.contains("%s")) {
1532 final File directory = getH2DataDirectory();
1533 LOGGER.debug("Data directory: {}", directory);
1534 String fileName = null;
1535 if (dbFileNameKey != null) {
1536 fileName = getString(dbFileNameKey);
1537 }
1538 if (fileName == null) {
1539 final String msg = String.format("Invalid properties file to get a file based connection string; '%s' must be defined.",
1540 dbFileNameKey);
1541 throw new InvalidSettingException(msg);
1542 }
1543 if (connStr.startsWith("jdbc:h2:file:") && fileName.endsWith(".mv.db")) {
1544 fileName = fileName.substring(0, fileName.length() - 6);
1545 }
1546
1547 final File dbFile = new File(directory, fileName);
1548 final String cString = String.format(connStr, dbFile.getCanonicalPath());
1549 LOGGER.debug("Connection String: '{}'", cString);
1550 return cString;
1551 }
1552 return connStr;
1553 }
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563 public File getDataDirectory() throws IOException {
1564 final File path = getDataFile(Settings.KEYS.DATA_DIRECTORY);
1565 if (path != null && (path.exists() || path.mkdirs())) {
1566 return path;
1567 }
1568 throw new IOException(String.format("Unable to create the data directory '%s'",
1569 (path == null) ? "unknown" : path.getAbsolutePath()));
1570 }
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580 public File getH2DataDirectory() throws IOException {
1581 final String h2Test = getString(Settings.KEYS.H2_DATA_DIRECTORY);
1582 final File path;
1583 if (h2Test != null && !h2Test.isEmpty()) {
1584 path = getDataFile(Settings.KEYS.H2_DATA_DIRECTORY);
1585 } else {
1586 path = getDataFile(Settings.KEYS.DATA_DIRECTORY);
1587 }
1588 if (path != null && (path.exists() || path.mkdirs())) {
1589 return path;
1590 }
1591 throw new IOException(String.format("Unable to create the h2 data directory '%s'",
1592 (path == null) ? "unknown" : path.getAbsolutePath()));
1593 }
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603 public File getTempFile(@NotNull final String prefix, @NotNull final String extension) throws IOException {
1604 final File dir = getTempDirectory();
1605 final String tempFileName = String.format("%s%s.%s", prefix, UUID.randomUUID(), extension);
1606 final File tempFile = new File(dir, tempFileName);
1607 if (tempFile.exists()) {
1608 return getTempFile(prefix, extension);
1609 }
1610 return tempFile;
1611 }
1612 }