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
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.google.common.collect.HashMultiset;
import com.google.common.collect.ImmutableMultiset;
import com.google.common.collect.Multiset;
import com.google.common.collect.Multiset.Entry;
import com.google.common.io.Closeables;
import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.FileText;
/**
* Checks the uniqueness of property keys (left from equal sign) in the
* properties file.
*
* @author Pavel Baranchikov
*/
@StatelessCheck
public class UniquePropertiesCheck extends AbstractFileSetCheck {
/**
* Localization key for check violation.
*/
public static final String MSG_KEY = "properties.duplicate.property";
/**
* Localization key for IO exception occurred on file open.
*/
public static final String MSG_IO_EXCEPTION_KEY = "unable.open.cause";
/**
* Pattern matching single space.
*/
private static final Pattern SPACE_PATTERN = Pattern.compile(" ");
/**
* Construct the check with default values.
*/
public UniquePropertiesCheck() {
setFileExtensions("properties");
}
@Override
protected void processFiltered(File file, FileText fileText) {
final UniqueProperties properties = new UniqueProperties();
FileInputStream fileInputStream = null;
try {
fileInputStream = new FileInputStream(file);
properties.load(fileInputStream);
}
catch (IOException ex) {
log(0, MSG_IO_EXCEPTION_KEY, file.getPath(),
ex.getLocalizedMessage());
}
finally {
Closeables.closeQuietly(fileInputStream);
}
for (Entry<String> duplication : properties
.getDuplicatedKeys().entrySet()) {
final String keyName = duplication.getElement();
final int lineNumber = getLineNumber(fileText, keyName);
// Number of occurrences is number of duplications + 1
log(lineNumber, MSG_KEY, keyName, duplication.getCount() + 1);
}
}
/**
* Method returns line number the key is detected in the checked properties
* files first.
*
* @param fileText
* {@link FileText} object contains the lines to process
* @param keyName
* key name to look for
* @return line number of first occurrence. If no key found in properties
* file, 0 is returned
*/
private static int getLineNumber(FileText fileText, String keyName) {
final Pattern keyPattern = getKeyPattern(keyName);
int lineNumber = 1;
final Matcher matcher = keyPattern.matcher("");
for (int index = 0; index < fileText.size(); index++) {
final String line = fileText.get(index);
matcher.reset(line);
if (matcher.matches()) {
break;
}
++lineNumber;
}
// -1 as check seeks for the first duplicate occurance in file,
// so it cannot be the last line.
if (lineNumber > fileText.size() - 1) {
lineNumber = 0;
}
return lineNumber;
}
/**
* Method returns regular expression pattern given key name.
*
* @param keyName
* key name to look for
* @return regular expression pattern given key name
*/
private static Pattern getKeyPattern(String keyName) {
final String keyPatternString = "^" + SPACE_PATTERN.matcher(keyName)
.replaceAll(Matcher.quoteReplacement("\\\\ ")) + "[\\s:=].*$";
return Pattern.compile(keyPatternString);
}
/**
* Properties subclass to store duplicated property keys in a separate map.
*
* @author Pavel Baranchikov
* @noinspection ClassExtendsConcreteCollection, SerializableHasSerializationMethods
*/
private static class UniqueProperties extends Properties {
private static final long serialVersionUID = 1L;
/**
* Multiset, holding duplicated keys. Keys are added here only if they
* already exist in Properties' inner map.
*/
private final Multiset<String> duplicatedKeys = HashMultiset
.create();
/**
* Puts the value into properties by the key specified.
* @noinspection UseOfPropertiesAsHashtable
*/
@Override
public synchronized Object put(Object key, Object value) {
final Object oldValue = super.put(key, value);
if (oldValue != null && key instanceof String) {
final String keyString = (String) key;
duplicatedKeys.add(keyString);
}
return oldValue;
}
/**
* Retrieves a collections of duplicated properties keys.
*
* @return A collection of duplicated keys.
*/
public Multiset<String> getDuplicatedKeys() {
return ImmutableMultiset.copyOf(duplicatedKeys);
}
}
}
|
