|
2
|
1 |
/*
|
|
|
2 |
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
|
3 |
* All rights reserved.
|
|
|
4 |
* This component and the accompanying materials are made available
|
|
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
|
6 |
* which accompanies this distribution, and is available
|
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
|
8 |
*
|
|
|
9 |
* Initial Contributors:
|
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
|
11 |
*
|
|
|
12 |
* Contributors:
|
|
|
13 |
*
|
|
|
14 |
* Description:
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
package com.nokia.carbide.cpp.internal.codescanner.config;
|
|
|
19 |
|
|
|
20 |
import java.io.File;
|
|
|
21 |
import java.util.ArrayList;
|
|
|
22 |
import java.util.HashMap;
|
|
|
23 |
import java.util.Iterator;
|
|
|
24 |
import java.util.List;
|
|
|
25 |
import java.util.Map;
|
|
|
26 |
import java.util.StringTokenizer;
|
|
|
27 |
|
|
|
28 |
import org.eclipse.core.resources.IProject;
|
|
|
29 |
import org.eclipse.core.resources.IResourceChangeEvent;
|
|
|
30 |
import org.eclipse.core.resources.IResourceChangeListener;
|
|
|
31 |
import org.eclipse.core.runtime.IPath;
|
|
|
32 |
import org.eclipse.core.runtime.Path;
|
|
|
33 |
import org.eclipse.emf.common.util.EList;
|
|
|
34 |
import org.eclipse.jface.dialogs.IDialogSettings;
|
|
|
35 |
import org.eclipse.jface.preference.IPreferenceStore;
|
|
|
36 |
|
|
|
37 |
import com.nokia.carbide.cpp.internal.codescanner.CSPlugin;
|
|
|
38 |
import com.nokia.carbide.cpp.internal.codescanner.ui.CSPreferenceConstants;
|
|
|
39 |
|
|
|
40 |
/**
|
|
|
41 |
* A class for handling global and project specific Codescanner configuration settings.
|
|
|
42 |
*/
|
|
|
43 |
public class CSConfigManager implements IResourceChangeListener {
|
|
|
44 |
|
|
|
45 |
// name of CodeScanner configuration file generated by this plugin
|
|
|
46 |
public static final String CS_CONFIG_SETTINGS_FILE = "carbide_cs_config.xml";
|
|
|
47 |
|
|
|
48 |
// name of CodeScanner commandline tool
|
|
|
49 |
public static final String CS_CMDLINE_TOOL = "codescanner.exe";
|
|
|
50 |
|
|
|
51 |
// private members
|
|
|
52 |
private static CSConfigSettings defaultConfig;
|
|
|
53 |
private String codescannerDir = null;
|
|
|
54 |
private String resultsDir = null;
|
|
|
55 |
private String outputFormatArgument = null;
|
|
|
56 |
private List<String> inputArguments = null;
|
|
|
57 |
private boolean htmlResults = false;
|
|
|
58 |
private boolean xmlResults = false;
|
|
|
59 |
private Map<IProject, CSProjectSettings> settingsMap;
|
|
|
60 |
|
|
|
61 |
/**
|
|
|
62 |
* Create an instance of CSConfigManager.
|
|
|
63 |
*/
|
|
|
64 |
public CSConfigManager() {
|
|
|
65 |
super();
|
|
|
66 |
defaultConfig = new CSConfigSettings();
|
|
|
67 |
defaultConfig.loadDefaultConfig();
|
|
|
68 |
settingsMap = new HashMap<IProject, CSProjectSettings>();
|
|
|
69 |
}
|
|
|
70 |
|
|
|
71 |
/**
|
|
|
72 |
* Get the default CodeScanner configuration settings.
|
|
|
73 |
* @return default CodeScanner configuration settings
|
|
|
74 |
*/
|
|
|
75 |
public CSConfigSettings getDefaultConfig() {
|
|
|
76 |
if (defaultConfig == null) {
|
|
|
77 |
defaultConfig = new CSConfigSettings();
|
|
|
78 |
defaultConfig.loadDefaultConfig();
|
|
|
79 |
}
|
|
|
80 |
return defaultConfig;
|
|
|
81 |
}
|
|
|
82 |
|
|
|
83 |
/**
|
|
|
84 |
* Find out whether the CodeScanner commandline tool exists in the specified
|
|
|
85 |
* CodeScanner directory. If it does, return its full path, otherwise return null.
|
|
|
86 |
* @return full path of the CodeScanner commandline tool if it exists
|
|
|
87 |
*/
|
|
|
88 |
public String getCSCommandLineTool() {
|
|
|
89 |
String csCmdLineTool = CS_CMDLINE_TOOL;
|
|
|
90 |
if (codescannerDir != null && codescannerDir.length() > 0) {
|
|
|
91 |
csCmdLineTool = codescannerDir + csCmdLineTool;
|
|
|
92 |
}
|
|
|
93 |
IPath fullPath = new Path(csCmdLineTool);
|
|
|
94 |
if (fullPath.toFile().exists()) {
|
|
|
95 |
return csCmdLineTool;
|
|
|
96 |
}
|
|
|
97 |
else {
|
|
|
98 |
return null;
|
|
|
99 |
}
|
|
|
100 |
}
|
|
|
101 |
|
|
|
102 |
/**
|
|
|
103 |
* Return the directory for scanning results.
|
|
|
104 |
* @return the directory for scanning results
|
|
|
105 |
*/
|
|
|
106 |
public String getCSResultsDirectory() {
|
|
|
107 |
return resultsDir;
|
|
|
108 |
}
|
|
|
109 |
|
|
|
110 |
/**
|
|
|
111 |
* Are we generating html reports for scanning results?
|
|
|
112 |
* @return true if generating html reports
|
|
|
113 |
*/
|
|
|
114 |
public boolean generateHtmlResults() {
|
|
|
115 |
return htmlResults;
|
|
|
116 |
}
|
|
|
117 |
|
|
|
118 |
/**
|
|
|
119 |
* Are we generating xml reports for scanning results?
|
|
|
120 |
* @return true if generating xml reports
|
|
|
121 |
*/
|
|
|
122 |
public boolean generateXmlResults() {
|
|
|
123 |
return xmlResults;
|
|
|
124 |
}
|
|
|
125 |
|
|
|
126 |
/**
|
|
|
127 |
* Create CodeScanner settings for a given project and store it.
|
|
|
128 |
* @param project - the project in question
|
|
|
129 |
* @return the project specific CodeScanner settings
|
|
|
130 |
*/
|
|
|
131 |
public CSProjectSettings createProjectSettings(IProject project) {
|
|
|
132 |
synchronized (settingsMap) {
|
|
|
133 |
assert(settingsMap.get(project) == null);
|
|
|
134 |
CSProjectSettings settings = new CSProjectSettings(project);
|
|
|
135 |
settingsMap.put(project, settings);
|
|
|
136 |
return settings;
|
|
|
137 |
}
|
|
|
138 |
}
|
|
|
139 |
|
|
|
140 |
/**
|
|
|
141 |
* Get the CodeScanner settings for a given project.
|
|
|
142 |
* @param project - the project in question
|
|
|
143 |
* @return the project specific CodeScanner settings
|
|
|
144 |
*/
|
|
|
145 |
public CSProjectSettings getProjectSettings(IProject project) {
|
|
|
146 |
synchronized (settingsMap) {
|
|
|
147 |
CSProjectSettings settings = settingsMap.get(project);
|
|
|
148 |
if (settings == null) {
|
|
|
149 |
settings = createProjectSettings(project);
|
|
|
150 |
}
|
|
|
151 |
return settings;
|
|
|
152 |
}
|
|
|
153 |
}
|
|
|
154 |
|
|
|
155 |
/**
|
|
|
156 |
* Handle any resource change event
|
|
|
157 |
* @param event - the resource change event in question
|
|
|
158 |
*/
|
|
|
159 |
public void resourceChanged(IResourceChangeEvent event) {
|
|
|
160 |
// remove projects from map when they are closed or deleted
|
|
|
161 |
if (event.getType() == IResourceChangeEvent.PRE_CLOSE || event.getType() == IResourceChangeEvent.PRE_DELETE) {
|
|
|
162 |
settingsMap.remove(event.getResource());
|
|
|
163 |
}
|
|
|
164 |
}
|
|
|
165 |
|
|
|
166 |
/**
|
|
|
167 |
* Load either project specific or global CodeScanner configuration settings.
|
|
|
168 |
* @param project - project associated with currently selected resource
|
|
|
169 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
170 |
* @return true if settings has been successfully loaded
|
|
|
171 |
*/
|
|
|
172 |
public boolean loadConfigSettings(IProject project) {
|
|
|
173 |
boolean success = false;
|
|
|
174 |
if (project != null) {
|
|
|
175 |
success = loadProjectConfigSettings(project);
|
|
|
176 |
}
|
|
|
177 |
if (!success) {
|
|
|
178 |
success = loadGlobalConfigSettings();
|
|
|
179 |
}
|
|
|
180 |
clearArguments();
|
|
|
181 |
return success;
|
|
|
182 |
}
|
|
|
183 |
|
|
|
184 |
/**
|
|
|
185 |
* Load project specific CodeScanner settings.
|
|
|
186 |
* @param project - project associated with currently selected resource
|
|
|
187 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
188 |
* @return true if settings has been successfully loaded
|
|
|
189 |
*/
|
|
|
190 |
public boolean loadProjectConfigSettings(IProject project) {
|
|
|
191 |
if (project == null) {
|
|
|
192 |
return false;
|
|
|
193 |
}
|
|
|
194 |
boolean success = false;
|
|
|
195 |
CSProjectSettings projectSettings = getProjectSettings(project);
|
|
|
196 |
IDialogSettings cSettings = projectSettings.getDialogSettings();
|
|
|
197 |
IDialogSettings pageSettings = cSettings.getSection(CSPreferenceConstants.PROPERTY_SETTINGS_ID);
|
|
|
198 |
if (pageSettings == null) {
|
|
|
199 |
success = false;
|
|
|
200 |
}
|
|
|
201 |
else {
|
|
|
202 |
success = pageSettings.getBoolean(CSPreferenceConstants.PROJ_SETTINGS);
|
|
|
203 |
if (success) {
|
|
|
204 |
codescannerDir = pageSettings.get(CSPreferenceConstants.CODESCANNER_FOLDER);
|
|
|
205 |
htmlResults = pageSettings.getBoolean(CSPreferenceConstants.HTML_RESULTS);
|
|
|
206 |
xmlResults = pageSettings.getBoolean(CSPreferenceConstants.XML_RESULTS);
|
|
|
207 |
resultsDir = pageSettings.get(CSPreferenceConstants.RESULTS_FOLDER);
|
|
|
208 |
}
|
|
|
209 |
else {
|
|
|
210 |
codescannerDir = "";
|
|
|
211 |
htmlResults = false;
|
|
|
212 |
xmlResults = false;
|
|
|
213 |
resultsDir = "";
|
|
|
214 |
}
|
|
|
215 |
}
|
|
|
216 |
return success;
|
|
|
217 |
}
|
|
|
218 |
|
|
|
219 |
/**
|
|
|
220 |
* Load global CodeScanner settings.
|
|
|
221 |
* @param project - project associated with currently selected resource
|
|
|
222 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
223 |
* @return true if settings has been successfully loaded
|
|
|
224 |
*/
|
|
|
225 |
public boolean loadGlobalConfigSettings() {
|
|
|
226 |
IPreferenceStore store = CSPlugin.getCSPrefsStore();
|
|
|
227 |
codescannerDir = store.getString(CSPreferenceConstants.CODESCANNER_FOLDER);
|
|
|
228 |
htmlResults = store.getBoolean(CSPreferenceConstants.HTML_RESULTS);
|
|
|
229 |
xmlResults = store.getBoolean(CSPreferenceConstants.XML_RESULTS);
|
|
|
230 |
resultsDir = store.getString(CSPreferenceConstants.RESULTS_FOLDER);
|
|
|
231 |
return true;
|
|
|
232 |
}
|
|
|
233 |
|
|
|
234 |
/**
|
|
|
235 |
* Create a CodeScanner configuration file from either project specific or
|
|
|
236 |
* global CodeScanner configuration settings.
|
|
|
237 |
* @param project - project associated with currently selected resource
|
|
|
238 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
239 |
* @return true if configuration file has been successfully created
|
|
|
240 |
*/
|
|
|
241 |
public File createConfigFile(IProject project, String configFilePath) {
|
|
|
242 |
File configFile = null;
|
|
|
243 |
if (project != null) {
|
|
|
244 |
configFile = createProjectConfigFile(project, configFilePath);
|
|
|
245 |
}
|
|
|
246 |
if (configFile == null) {
|
|
|
247 |
configFile = createGlobalConfigFile(project, configFilePath);
|
|
|
248 |
}
|
|
|
249 |
return configFile;
|
|
|
250 |
}
|
|
|
251 |
|
|
|
252 |
/**
|
|
|
253 |
* Create a CodeScanner configuration file from project specific CodeScanner settings.
|
|
|
254 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
255 |
* @param settings - project specific CodeScanner settings
|
|
|
256 |
* @return CodeScanner configuration file
|
|
|
257 |
*/
|
|
|
258 |
public File createProjectConfigFile(IProject project, String configFilePath) {
|
|
|
259 |
if (configFilePath.length() == 0) {
|
|
|
260 |
return null;
|
|
|
261 |
}
|
|
|
262 |
|
|
|
263 |
// load project specific settings
|
|
|
264 |
CSProjectSettings projectSettings = getProjectSettings(project);
|
|
|
265 |
IDialogSettings cSettings = projectSettings.getDialogSettings();
|
|
|
266 |
IDialogSettings pageSettings = cSettings.getSection(CSPreferenceConstants.PROPERTY_SETTINGS_ID);
|
|
|
267 |
if (pageSettings == null) {
|
|
|
268 |
return null;
|
|
|
269 |
}
|
|
|
270 |
if (!pageSettings.getBoolean(CSPreferenceConstants.PROJ_SETTINGS)) {
|
|
|
271 |
return null;
|
|
|
272 |
}
|
|
|
273 |
|
|
|
274 |
// create and initialize a configuration file
|
|
|
275 |
File configFile = new File(configFilePath);
|
|
|
276 |
if (configFile.exists()) {
|
|
|
277 |
configFile.delete();
|
|
|
278 |
}
|
|
|
279 |
CSConfigSettings configSettings = new CSConfigSettings();
|
|
|
280 |
configSettings.loadDefaultConfig();
|
|
|
281 |
|
|
|
282 |
// retrieve various stored values
|
|
|
283 |
String fileFilterString = pageSettings.get(CSPreferenceConstants.FILE_FILTERS);
|
|
|
284 |
if (fileFilterString != null) {
|
|
|
285 |
StringTokenizer fileFilters = new StringTokenizer(fileFilterString, CSPreferenceConstants.DELIMETER);
|
|
|
286 |
EList<String> fileFilterList = configSettings.getSourceFilters().getExclude();
|
|
|
287 |
fileFilterList.clear();
|
|
|
288 |
while (fileFilters.hasMoreTokens()) {
|
|
|
289 |
String fileFilter = fileFilters.nextToken();
|
|
|
290 |
fileFilterList.add(fileFilter);
|
|
|
291 |
}
|
|
|
292 |
}
|
|
|
293 |
|
|
|
294 |
String scriptsString = pageSettings.get(CSPreferenceConstants.RULE_SCRIPTS);
|
|
|
295 |
String categoriesString = pageSettings.get(CSPreferenceConstants.RULE_CATEGORIES);
|
|
|
296 |
String severitiesString = pageSettings.get(CSPreferenceConstants.RULE_SEVERITIES);
|
|
|
297 |
String enabledString = pageSettings.get(CSPreferenceConstants.RULES_ENABLED);
|
|
|
298 |
if ((scriptsString != null) &&
|
|
|
299 |
(categoriesString != null) &&
|
|
|
300 |
(severitiesString != null) &&
|
|
|
301 |
(enabledString != null)) {
|
|
|
302 |
StringTokenizer scriptTokens = new StringTokenizer(scriptsString, CSPreferenceConstants.DELIMETER);
|
|
|
303 |
StringTokenizer categoryTokens = new StringTokenizer(categoriesString, CSPreferenceConstants.DELIMETER);
|
|
|
304 |
StringTokenizer severityTokens = new StringTokenizer(severitiesString, CSPreferenceConstants.DELIMETER);
|
|
|
305 |
StringTokenizer enabledTokens = new StringTokenizer(enabledString, CSPreferenceConstants.DELIMETER);
|
|
|
306 |
while (scriptTokens.hasMoreTokens() &&
|
|
|
307 |
categoryTokens.hasMoreTokens() &&
|
|
|
308 |
severityTokens.hasMoreTokens() &&
|
|
|
309 |
enabledTokens.hasMoreTokens()) {
|
|
|
310 |
String scriptString = "script_" + scriptTokens.nextToken();
|
|
|
311 |
String categoryString = categoryTokens.nextToken();
|
|
|
312 |
String severityString = severityTokens.nextToken();
|
|
|
313 |
int value = Integer.valueOf(enabledTokens.nextToken());
|
|
|
314 |
boolean enabled = (value != 0);
|
|
|
315 |
CSScript script = CSScript.toScript(scriptString);
|
|
|
316 |
if (!script.equals(CSScript.script_unknown)) {
|
|
|
317 |
configSettings.setScriptCategory(script, categoryString);
|
|
|
318 |
configSettings.setScriptSeverity(script, severityString);
|
|
|
319 |
configSettings.setScriptEnabled(script, enabled);
|
|
|
320 |
}
|
|
|
321 |
}
|
|
|
322 |
}
|
|
|
323 |
|
|
|
324 |
configSettings.setScriptCClassIgnore(pageSettings.get(CSPreferenceConstants.CCLASSIGNORE));
|
|
|
325 |
configSettings.setScriptForbiddenWords(pageSettings.get(CSPreferenceConstants.FORBIDEENWORDS));
|
|
|
326 |
configSettings.setScriptLFunctionIgnore(pageSettings.get(CSPreferenceConstants.LFUNCTIONIGNORE));
|
|
|
327 |
configSettings.setScriptLongLinesLength(pageSettings.getInt(CSPreferenceConstants.LONGLINES_LENGTH));
|
|
|
328 |
configSettings.setScriptOpenIgnore(pageSettings.get(CSPreferenceConstants.OPENIGNORE));
|
|
|
329 |
configSettings.setScriptWorryingComments(pageSettings.get(CSPreferenceConstants.WORRYINGCOMMENTS));
|
|
|
330 |
|
|
|
331 |
configSettings.setInputArguments(inputArguments);
|
|
|
332 |
configSettings.setOutputFormatArgument(outputFormatArgument);
|
|
|
333 |
|
|
|
334 |
if (isProjectKbScanningEnabled(pageSettings)) {
|
|
|
335 |
CSPlugin.getKbManager().clearRules();
|
|
|
336 |
CSPlugin.getKbManager().addKBaseRulesToConfigSettings(project, configSettings);
|
|
|
337 |
}
|
|
|
338 |
|
|
|
339 |
// copy settings to the configuration file and return it
|
|
|
340 |
configSettings.saveConfig(configFile);
|
|
|
341 |
return configFile;
|
|
|
342 |
}
|
|
|
343 |
|
|
|
344 |
/**
|
|
|
345 |
* Create a CodeScanner configuration file from global CodeScanner settings.
|
|
|
346 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
347 |
* @return CodeScanner configuration file
|
|
|
348 |
*/
|
|
|
349 |
public File createGlobalConfigFile(IProject project, String configFilePath) {
|
|
|
350 |
if (configFilePath.length() == 0) {
|
|
|
351 |
return null;
|
|
|
352 |
}
|
|
|
353 |
|
|
|
354 |
// create and initialize a configuration file
|
|
|
355 |
File configFile = new File(configFilePath);
|
|
|
356 |
if (configFile.exists()) {
|
|
|
357 |
configFile.delete();
|
|
|
358 |
}
|
|
|
359 |
CSConfigSettings configSettings = new CSConfigSettings();
|
|
|
360 |
configSettings.loadDefaultConfig();
|
|
|
361 |
|
|
|
362 |
// retrieve various stored values
|
|
|
363 |
IPreferenceStore store = CSPlugin.getCSPrefsStore();
|
|
|
364 |
|
|
|
365 |
String fileFilterString = store.getString(CSPreferenceConstants.FILE_FILTERS);
|
|
|
366 |
if (fileFilterString != null) {
|
|
|
367 |
StringTokenizer fileFilters = new StringTokenizer(fileFilterString, CSPreferenceConstants.DELIMETER);
|
|
|
368 |
EList<String> fileFilterList = configSettings.getSourceFilters().getExclude();
|
|
|
369 |
fileFilterList.clear();
|
|
|
370 |
while (fileFilters.hasMoreTokens()) {
|
|
|
371 |
String fileFilter = fileFilters.nextToken();
|
|
|
372 |
fileFilterList.add(fileFilter);
|
|
|
373 |
}
|
|
|
374 |
}
|
|
|
375 |
|
|
|
376 |
String scriptsString = store.getString(CSPreferenceConstants.RULE_SCRIPTS);
|
|
|
377 |
String categoriesString = store.getString(CSPreferenceConstants.RULE_CATEGORIES);
|
|
|
378 |
String severitiesString = store.getString(CSPreferenceConstants.RULE_SEVERITIES);
|
|
|
379 |
String enabledString = store.getString(CSPreferenceConstants.RULES_ENABLED);
|
|
|
380 |
if ((scriptsString != null) &&
|
|
|
381 |
(categoriesString != null) &&
|
|
|
382 |
(severitiesString != null) &&
|
|
|
383 |
(enabledString != null)) {
|
|
|
384 |
StringTokenizer scriptTokens = new StringTokenizer(scriptsString, CSPreferenceConstants.DELIMETER);
|
|
|
385 |
StringTokenizer categoryTokens = new StringTokenizer(categoriesString, CSPreferenceConstants.DELIMETER);
|
|
|
386 |
StringTokenizer severityTokens = new StringTokenizer(severitiesString, CSPreferenceConstants.DELIMETER);
|
|
|
387 |
StringTokenizer enabledTokens = new StringTokenizer(enabledString, CSPreferenceConstants.DELIMETER);
|
|
|
388 |
while (scriptTokens.hasMoreTokens() &&
|
|
|
389 |
categoryTokens.hasMoreTokens() &&
|
|
|
390 |
severityTokens.hasMoreTokens() &&
|
|
|
391 |
enabledTokens.hasMoreTokens()) {
|
|
|
392 |
String scriptString = "script_" + scriptTokens.nextToken();
|
|
|
393 |
String categoryString = categoryTokens.nextToken();
|
|
|
394 |
String severityString = severityTokens.nextToken();
|
|
|
395 |
int value = Integer.valueOf(enabledTokens.nextToken());
|
|
|
396 |
boolean enabled = (value != 0);
|
|
|
397 |
CSScript script = CSScript.toScript(scriptString);
|
|
|
398 |
if (!script.equals(CSScript.script_unknown)) {
|
|
|
399 |
configSettings.setScriptCategory(script, categoryString);
|
|
|
400 |
configSettings.setScriptSeverity(script, severityString);
|
|
|
401 |
configSettings.setScriptEnabled(script, enabled);
|
|
|
402 |
}
|
|
|
403 |
}
|
|
|
404 |
}
|
|
|
405 |
|
|
|
406 |
configSettings.setScriptCClassIgnore(store.getString(CSPreferenceConstants.CCLASSIGNORE));
|
|
|
407 |
configSettings.setScriptForbiddenWords(store.getString(CSPreferenceConstants.FORBIDEENWORDS));
|
|
|
408 |
configSettings.setScriptLFunctionIgnore(store.getString(CSPreferenceConstants.LFUNCTIONIGNORE));
|
|
|
409 |
configSettings.setScriptLongLinesLength(store.getInt(CSPreferenceConstants.LONGLINES_LENGTH));
|
|
|
410 |
configSettings.setScriptOpenIgnore(store.getString(CSPreferenceConstants.OPENIGNORE));
|
|
|
411 |
configSettings.setScriptWorryingComments(store.getString(CSPreferenceConstants.WORRYINGCOMMENTS));
|
|
|
412 |
configSettings.setInputArguments(inputArguments);
|
|
|
413 |
configSettings.setOutputFormatArgument(outputFormatArgument);
|
|
|
414 |
|
|
|
415 |
if (isGlobalKbScanningEnabled()) {
|
|
|
416 |
CSPlugin.getKbManager().clearRules();
|
|
|
417 |
CSPlugin.getKbManager().addKBaseRulesToConfigSettings(project, configSettings);
|
|
|
418 |
}
|
|
|
419 |
|
|
|
420 |
// copy settings to the configuration file and return it
|
|
|
421 |
configSettings.saveConfig(configFile);
|
|
|
422 |
return configFile;
|
|
|
423 |
}
|
|
|
424 |
|
|
|
425 |
/**
|
|
|
426 |
* Load project specific CodeScanner settings from a CodeScanner configuration file.
|
|
|
427 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
428 |
* @param settings - project specific CodeScanner settings
|
|
|
429 |
*/
|
|
|
430 |
public void loadProjectConfigFile(String configFilePath, IDialogSettings settings) {
|
|
|
431 |
if ((configFilePath.length() == 0) || (settings == null)) {
|
|
|
432 |
return;
|
|
|
433 |
}
|
|
|
434 |
|
|
|
435 |
// load settings from a configuration file
|
|
|
436 |
File configFile = new File(configFilePath);
|
|
|
437 |
CSConfigSettings configSettings = new CSConfigSettings();
|
|
|
438 |
configSettings.loadDefaultConfig();
|
|
|
439 |
if (configSettings.loadConfig(configFile)) {
|
|
|
440 |
// store various values
|
|
|
441 |
String fileFilters = "";
|
|
|
442 |
EList<String> fileFilterList = configSettings.getSourceFilters().getExclude();
|
|
|
443 |
for (Iterator<String> iterator = fileFilterList.iterator(); iterator.hasNext();) {
|
|
|
444 |
fileFilters += iterator.next() + CSPreferenceConstants.DELIMETER;
|
|
|
445 |
}
|
|
|
446 |
settings.put(CSPreferenceConstants.FILE_FILTERS, fileFilters);
|
|
|
447 |
|
|
|
448 |
String scriptString = "";
|
|
|
449 |
String categoryString = "";
|
|
|
450 |
String severityString = "";
|
|
|
451 |
String enabledString = "";
|
|
|
452 |
for (CSScript script : CSScript.values()) {
|
|
|
453 |
if (!script.equals(CSScript.script_unknown)) {
|
|
|
454 |
scriptString += script.toString() + CSPreferenceConstants.DELIMETER;
|
|
|
455 |
if (configSettings.getScript(script) != null) {
|
|
|
456 |
categoryString += configSettings.getScriptCategory(script) + CSPreferenceConstants.DELIMETER;
|
|
|
457 |
severityString += configSettings.getScriptSeverity(script) + CSPreferenceConstants.DELIMETER;
|
|
|
458 |
int flag = 1;
|
|
|
459 |
if (!configSettings.getScriptEnabled(script))
|
|
|
460 |
flag = 0;
|
|
|
461 |
enabledString += flag + CSPreferenceConstants.DELIMETER;
|
|
|
462 |
}
|
|
|
463 |
else {
|
|
|
464 |
categoryString += defaultConfig.getScriptCategory(script) + CSPreferenceConstants.DELIMETER;
|
|
|
465 |
severityString += defaultConfig.getScriptSeverity(script) + CSPreferenceConstants.DELIMETER;
|
|
|
466 |
int flag = 1;
|
|
|
467 |
if (!defaultConfig.getScriptEnabled(script))
|
|
|
468 |
flag = 0;
|
|
|
469 |
enabledString += flag + CSPreferenceConstants.DELIMETER;
|
|
|
470 |
}
|
|
|
471 |
}
|
|
|
472 |
}
|
|
|
473 |
settings.put(CSPreferenceConstants.RULE_SCRIPTS, scriptString);
|
|
|
474 |
settings.put(CSPreferenceConstants.RULE_CATEGORIES, categoryString);
|
|
|
475 |
settings.put(CSPreferenceConstants.RULE_SEVERITIES, severityString);
|
|
|
476 |
settings.put(CSPreferenceConstants.RULES_ENABLED, enabledString);
|
|
|
477 |
|
|
|
478 |
settings.put(CSPreferenceConstants.CCLASSIGNORE, getCClassIgnoreFromConfig(configSettings));
|
|
|
479 |
settings.put(CSPreferenceConstants.FORBIDEENWORDS, getForbiddenWordsFromConfig(configSettings));
|
|
|
480 |
settings.put(CSPreferenceConstants.LFUNCTIONIGNORE, getLFunctionIgnoreFromConfig(configSettings));
|
|
|
481 |
settings.put(CSPreferenceConstants.LONGLINES_LENGTH, getLongLinesLengthFromConfig(configSettings));
|
|
|
482 |
settings.put(CSPreferenceConstants.OPENIGNORE, getOpenIgnoreFromConfig(configSettings));
|
|
|
483 |
settings.put(CSPreferenceConstants.WORRYINGCOMMENTS, getWorryingCommentsFromConfig(configSettings));
|
|
|
484 |
}
|
|
|
485 |
}
|
|
|
486 |
|
|
|
487 |
/**
|
|
|
488 |
* Load global CodeScanner settings from a CodeScanner configuration file.
|
|
|
489 |
* @param configFilePath - path of CodeScanner configuration file
|
|
|
490 |
*/
|
|
|
491 |
public void loadGlobalConfigFile(String configFilePath) {
|
|
|
492 |
if (configFilePath.length() == 0) {
|
|
|
493 |
return;
|
|
|
494 |
}
|
|
|
495 |
|
|
|
496 |
// load settings from a configuration file
|
|
|
497 |
File configFile = new File(configFilePath);
|
|
|
498 |
CSConfigSettings configSettings = new CSConfigSettings();
|
|
|
499 |
configSettings.loadDefaultConfig();
|
|
|
500 |
if (configSettings.loadConfig(configFile)) {
|
|
|
501 |
IPreferenceStore store = CSPlugin.getCSPrefsStore();
|
|
|
502 |
|
|
|
503 |
// store various values
|
|
|
504 |
String fileFilters = "";
|
|
|
505 |
EList<String> fileFilterList = configSettings.getSourceFilters().getExclude();
|
|
|
506 |
for (Iterator<String> iterator = fileFilterList.iterator(); iterator.hasNext();) {
|
|
|
507 |
fileFilters += iterator.next() + CSPreferenceConstants.DELIMETER;
|
|
|
508 |
}
|
|
|
509 |
store.setValue(CSPreferenceConstants.FILE_FILTERS, fileFilters);
|
|
|
510 |
|
|
|
511 |
String scriptString = "";
|
|
|
512 |
String categoryString = "";
|
|
|
513 |
String severityString = "";
|
|
|
514 |
String enabledString = "";
|
|
|
515 |
for (CSScript script : CSScript.values()) {
|
|
|
516 |
if (!script.equals(CSScript.script_unknown)) {
|
|
|
517 |
scriptString += script.toString() + CSPreferenceConstants.DELIMETER;
|
|
|
518 |
if (configSettings.getScript(script) != null) {
|
|
|
519 |
categoryString += configSettings.getScriptCategory(script) + CSPreferenceConstants.DELIMETER;
|
|
|
520 |
severityString += configSettings.getScriptSeverity(script) + CSPreferenceConstants.DELIMETER;
|
|
|
521 |
int flag = 1;
|
|
|
522 |
if (!configSettings.getScriptEnabled(script))
|
|
|
523 |
flag = 0;
|
|
|
524 |
enabledString += flag + CSPreferenceConstants.DELIMETER;
|
|
|
525 |
}
|
|
|
526 |
else {
|
|
|
527 |
categoryString += defaultConfig.getScriptCategory(script) + CSPreferenceConstants.DELIMETER;
|
|
|
528 |
severityString += defaultConfig.getScriptSeverity(script) + CSPreferenceConstants.DELIMETER;
|
|
|
529 |
int flag = 1;
|
|
|
530 |
if (!defaultConfig.getScriptEnabled(script))
|
|
|
531 |
flag = 0;
|
|
|
532 |
enabledString += flag + CSPreferenceConstants.DELIMETER;
|
|
|
533 |
}
|
|
|
534 |
}
|
|
|
535 |
}
|
|
|
536 |
store.setValue(CSPreferenceConstants.RULE_SCRIPTS, scriptString);
|
|
|
537 |
store.setValue(CSPreferenceConstants.RULE_CATEGORIES, categoryString);
|
|
|
538 |
store.setValue(CSPreferenceConstants.RULE_SEVERITIES, severityString);
|
|
|
539 |
store.setValue(CSPreferenceConstants.RULES_ENABLED, enabledString);
|
|
|
540 |
|
|
|
541 |
store.setValue(CSPreferenceConstants.CCLASSIGNORE, getCClassIgnoreFromConfig(configSettings));
|
|
|
542 |
store.setValue(CSPreferenceConstants.FORBIDEENWORDS, getForbiddenWordsFromConfig(configSettings));
|
|
|
543 |
store.setValue(CSPreferenceConstants.LFUNCTIONIGNORE, getLFunctionIgnoreFromConfig(configSettings));
|
|
|
544 |
store.setValue(CSPreferenceConstants.LONGLINES_LENGTH, getLongLinesLengthFromConfig(configSettings));
|
|
|
545 |
store.setValue(CSPreferenceConstants.OPENIGNORE, getOpenIgnoreFromConfig(configSettings));
|
|
|
546 |
store.setValue(CSPreferenceConstants.WORRYINGCOMMENTS, getWorryingCommentsFromConfig(configSettings));
|
|
|
547 |
}
|
|
|
548 |
}
|
|
|
549 |
|
|
|
550 |
/**
|
|
|
551 |
* Set the input arguments.
|
|
|
552 |
* @param configSettings - CodeScanner configuration settings to be set
|
|
|
553 |
* @param inputPaths - input paths to be converted into input arguments
|
|
|
554 |
*/
|
|
|
555 |
public void setInputArguments(List<IPath> inputPaths) {
|
|
|
556 |
inputArguments = new ArrayList<String>();
|
|
|
557 |
for (IPath inputPath : inputPaths){
|
|
|
558 |
inputArguments.add(inputPath.toOSString());
|
|
|
559 |
}
|
|
|
560 |
}
|
|
|
561 |
|
|
|
562 |
/**
|
|
|
563 |
* Set the output format argument.
|
|
|
564 |
* @param configSettings - CodeScanner configuration settings to be set
|
|
|
565 |
*/
|
|
|
566 |
public void setOutputFormatArgument() {
|
|
|
567 |
outputFormatArgument = "std";
|
|
|
568 |
if (generateHtmlResults()) {
|
|
|
569 |
outputFormatArgument += "|html";
|
|
|
570 |
}
|
|
|
571 |
if (generateXmlResults()) {
|
|
|
572 |
outputFormatArgument += "|xml";
|
|
|
573 |
}
|
|
|
574 |
}
|
|
|
575 |
|
|
|
576 |
/**
|
|
|
577 |
* Clear various argument settings.
|
|
|
578 |
*/
|
|
|
579 |
private void clearArguments() {
|
|
|
580 |
inputArguments = null;
|
|
|
581 |
outputFormatArgument = null;
|
|
|
582 |
}
|
|
|
583 |
|
|
|
584 |
/**
|
|
|
585 |
* Get the C class ignore list from from a CodeScanner configuration settings.
|
|
|
586 |
* If the list does not exist in, get it from the default configuration settings.
|
|
|
587 |
* @param configSettings - CodeScanner configuration settings to be read
|
|
|
588 |
* @return C class ignore list as a string
|
|
|
589 |
*/
|
|
|
590 |
private String getCClassIgnoreFromConfig(CSConfigSettings configSettings) {
|
|
|
591 |
String value = configSettings.getScriptCClassIgnore();
|
|
|
592 |
if (value == null) {
|
|
|
593 |
value = getDefaultConfig().getScriptCClassIgnore();
|
|
|
594 |
}
|
|
|
595 |
return value;
|
|
|
596 |
}
|
|
|
597 |
|
|
|
598 |
/**
|
|
|
599 |
* Get the forbidden words list from from a CodeScanner configuration settings.
|
|
|
600 |
* If the list does not exist in, get it from the default configuration settings.
|
|
|
601 |
* @param configSettings - CodeScanner configuration settings to be read
|
|
|
602 |
* @return forbidden words list as a string
|
|
|
603 |
*/
|
|
|
604 |
private String getForbiddenWordsFromConfig(CSConfigSettings configSettings) {
|
|
|
605 |
String value = configSettings.getScriptForbiddenWords();
|
|
|
606 |
if (value == null) {
|
|
|
607 |
value = getDefaultConfig().getScriptForbiddenWords();
|
|
|
608 |
}
|
|
|
609 |
return value;
|
|
|
610 |
}
|
|
|
611 |
|
|
|
612 |
/**
|
|
|
613 |
* Get the L-function ignore list from from a CodeScanner configuration settings.
|
|
|
614 |
* If the list does not exist in, get it from the default configuration settings.
|
|
|
615 |
* @param configSettings - CodeScanner configuration settings to be read
|
|
|
616 |
* @return L-function ignore list as a string
|
|
|
617 |
*/
|
|
|
618 |
private String getLFunctionIgnoreFromConfig(CSConfigSettings configSettings) {
|
|
|
619 |
String value = configSettings.getScriptLFunctionIgnore();
|
|
|
620 |
if (value == null) {
|
|
|
621 |
value = getDefaultConfig().getScriptLFunctionIgnore();
|
|
|
622 |
}
|
|
|
623 |
return value;
|
|
|
624 |
}
|
|
|
625 |
|
|
|
626 |
/**
|
|
|
627 |
* Get the long lines length attribute value from a CodeScanner configuration settings.
|
|
|
628 |
* @param configSettings - CodeScanner configuration settings to be read
|
|
|
629 |
* @return the long lines length attribute value
|
|
|
630 |
*/
|
|
|
631 |
private int getLongLinesLengthFromConfig(CSConfigSettings configSettings) {
|
|
|
632 |
return configSettings.getScriptLongLinesLength();
|
|
|
633 |
}
|
|
|
634 |
|
|
|
635 |
/**
|
|
|
636 |
* Get the Open() function ignore list from from a CodeScanner configuration settings.
|
|
|
637 |
* If the list does not exist in, get it from the default configuration settings.
|
|
|
638 |
* @param configSettings - CodeScanner configuration settings to be read
|
|
|
639 |
* @return Open() function ignore list as a string
|
|
|
640 |
*/
|
|
|
641 |
private String getOpenIgnoreFromConfig(CSConfigSettings configSettings) {
|
|
|
642 |
String value = configSettings.getScriptOpenIgnore();
|
|
|
643 |
if (value == null) {
|
|
|
644 |
value = getDefaultConfig().getScriptOpenIgnore();
|
|
|
645 |
}
|
|
|
646 |
return value;
|
|
|
647 |
}
|
|
|
648 |
|
|
|
649 |
/**
|
|
|
650 |
* Get the worrying comments list from from a CodeScanner configuration settings.
|
|
|
651 |
* If the list does not exist in, get it from the default configuration settings.
|
|
|
652 |
* @param configSettings - CodeScanner configuration settings to be read
|
|
|
653 |
* @return worrying comments list as a string
|
|
|
654 |
*/
|
|
|
655 |
private String getWorryingCommentsFromConfig(CSConfigSettings configSettings) {
|
|
|
656 |
String value = configSettings.getScriptWorryingComments();
|
|
|
657 |
if (value == null) {
|
|
|
658 |
value = getDefaultConfig().getScriptWorryingComments();
|
|
|
659 |
}
|
|
|
660 |
return value;
|
|
|
661 |
}
|
|
|
662 |
|
|
|
663 |
/**
|
|
|
664 |
* Check whether to perform project specific knowledge base scanning.
|
|
|
665 |
* @param pageSettings - project specific settings
|
|
|
666 |
* @return true if performing project specific knowledge base scanning.
|
|
|
667 |
*/
|
|
|
668 |
private boolean isProjectKbScanningEnabled (IDialogSettings pageSettings) {
|
|
|
669 |
return pageSettings.getBoolean(CSPreferenceConstants.KBSCANNING);
|
|
|
670 |
}
|
|
|
671 |
|
|
|
672 |
/**
|
|
|
673 |
* Check whether to perform global knowledge base scanning.
|
|
|
674 |
* @return true if performing global knowledge base scanning.
|
|
|
675 |
*/
|
|
|
676 |
private boolean isGlobalKbScanningEnabled() {
|
|
|
677 |
return CSPlugin.getCSPrefsStore().getBoolean(CSPreferenceConstants.KBSCANNING);
|
|
|
678 |
}
|
|
|
679 |
|
|
|
680 |
}
|