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
|
/*
* Copyright 2011 gitblit.com.
*
* Licensed 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
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gitblit;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.util.Map;
import java.util.Properties;
import com.gitblit.utils.FileUtils;
/**
* Dynamically loads and reloads a properties file by keeping track of the last
* modification date.
*
* @author James Moger
*
*/
public class FileSettings extends IStoredSettings {
protected File propertiesFile;
private final Properties properties = new Properties();
private volatile long lastModified;
private volatile boolean forceReload;
public FileSettings() {
super(FileSettings.class);
}
public FileSettings(String file) {
this();
load(file);
}
public void load(String file) {
this.propertiesFile = new File(file);
}
/**
* Merges the provided settings into this instance. This will also
* set the target file for this instance IFF it is unset AND the merge
* source is also a FileSettings. This is a little sneaky.
*/
@Override
public void merge(IStoredSettings settings) {
super.merge(settings);
// sneaky: set the target file from the merge source
if (propertiesFile == null && settings instanceof FileSettings) {
this.propertiesFile = ((FileSettings) settings).propertiesFile;
}
}
/**
* Returns a properties object which contains the most recent contents of
* the properties file.
*/
@Override
protected synchronized Properties read() {
if (propertiesFile != null && propertiesFile.exists() && (forceReload || (propertiesFile.lastModified() > lastModified))) {
FileInputStream is = null;
try {
Properties props = new Properties();
is = new FileInputStream(propertiesFile);
props.load(is);
// load properties after we have successfully read file
properties.clear();
properties.putAll(props);
lastModified = propertiesFile.lastModified();
forceReload = false;
} catch (FileNotFoundException f) {
// IGNORE - won't happen because file.exists() check above
} catch (Throwable t) {
logger.error("Failed to read " + propertiesFile.getName(), t);
} finally {
if (is != null) {
try {
is.close();
} catch (Throwable t) {
// IGNORE
}
}
}
}
return properties;
}
@Override
public boolean saveSettings() {
String content = FileUtils.readContent(propertiesFile, "\n");
for (String key : removals) {
String regex = "(?m)^(" + regExEscape(key) + "\\s*+=\\s*+)"
+ "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";
content = content.replaceAll(regex, "");
}
removals.clear();
FileUtils.writeContent(propertiesFile, content);
// manually set the forceReload flag because not all JVMs support real
// millisecond resolution of lastModified. (issue-55)
forceReload = true;
return true;
}
/**
* Updates the specified settings in the settings file.
*/
@Override
public synchronized boolean saveSettings(Map<String, String> settings) {
String content = FileUtils.readContent(propertiesFile, "\n");
for (Map.Entry<String, String> setting:settings.entrySet()) {
String regex = "(?m)^(" + regExEscape(setting.getKey()) + "\\s*+=\\s*+)"
+ "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";
String oldContent = content;
content = content.replaceAll(regex, setting.getKey() + " = " + setting.getValue());
if (content.equals(oldContent)) {
// did not replace value because it does not exist in the file
// append new setting to content (issue-85)
content += "\n" + setting.getKey() + " = " + setting.getValue();
}
}
FileUtils.writeContent(propertiesFile, content);
// manually set the forceReload flag because not all JVMs support real
// millisecond resolution of lastModified. (issue-55)
forceReload = true;
return true;
}
private String regExEscape(String input) {
return input.replace(".", "\\.").replace("$", "\\$").replace("{", "\\{");
}
/**
* @return the last modification date of the properties file
*/
protected long lastModified() {
return lastModified;
}
/**
* @return the state of the force reload flag
*/
protected boolean forceReload() {
return forceReload;
}
@Override
public String toString() {
return propertiesFile.getAbsolutePath();
}
}
|
