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
|
/*******************************************************************************
* Copyright (c) 2007 Oracle Corporation.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Cameron Bateman/Oracle - initial API and implementation
*
********************************************************************************/
package org.eclipse.jst.jsf.validation.internal.appconfig;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.ISchedulingRule;
import org.eclipse.jst.jsf.core.IJSFCoreConstants;
import org.eclipse.jst.jsf.core.internal.JSFCorePlugin;
import org.eclipse.jst.jsf.core.jsfappconfig.JSFAppConfigUtils;
import org.eclipse.jst.jsf.facesconfig.emf.FacesConfigType;
import org.eclipse.jst.jsf.facesconfig.util.FacesConfigArtifactEdit;
import org.eclipse.jst.jsp.core.internal.Logger;
import org.eclipse.wst.common.project.facet.core.IFacetedProject;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;
import org.eclipse.wst.common.project.facet.core.ProjectFacetsManager;
import org.eclipse.wst.validation.internal.core.ValidationException;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.eclipse.wst.validation.internal.provisional.core.IReporter;
import org.eclipse.wst.validation.internal.provisional.core.IValidationContext;
import org.eclipse.wst.validation.internal.provisional.core.IValidatorJob;
import org.eclipse.wst.xml.core.internal.provisional.document.IDOMDocument;
import org.eclipse.wst.xml.core.internal.provisional.document.IDOMModel;
import org.w3c.dom.DocumentType;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* General build-time validator for the JSF application configuration file (faces-config.xml)b
*
* @author cbateman
*
*/
public class AppConfigValidator implements IValidatorJob {
public ISchedulingRule getSchedulingRule(IValidationContext helper) {
// no scheduling rule
return null;
}
public IStatus validateInJob(IValidationContext helper, IReporter reporter)
throws ValidationException {
IStatus status = Status.OK_STATUS;
try {
validate(helper, reporter);
}
catch (ValidationException e) {
Logger.logException(e);
status = new Status(IStatus.ERROR, JSFCorePlugin.getDefault().getPluginID(), IStatus.ERROR, e.getLocalizedMessage(), e);
}
return status;
}
public void cleanup(IReporter reporter) {
// no cleanup
}
public void validate(IValidationContext helper, IReporter reporter)
throws ValidationException
{
String[] uris = helper.getURIs();
IWorkspaceRoot wsRoot = ResourcesPlugin.getWorkspace().getRoot();
if (uris.length > 0) {
IFile currentFile = null;
for (int i = 0; i < uris.length && !reporter.isCancelled(); i++) {
currentFile = wsRoot.getFile(new Path(uris[i]));
if (currentFile != null && currentFile.exists()) {
// if (shouldValidate(currentFile) && fragmentCheck(currentFile)) {
// int percent = (i * 100) / uris.length + 1;
//Message message = new LocalizedMessage(IMessage.LOW_SEVERITY, percent + "% " + uris[i]);
// reporter.displaySubtask(this, message);
validateFile(currentFile, reporter);
}
}
}
// copied from JSPValidator TODO: perhaps just use app config locator?
// else {
//
// // if uris[] length 0 -> validate() gets called for each project
// if (helper instanceof IWorkbenchContext) {
//
// IProject project = ((IWorkbenchContext) helper).getProject();
// JSPFileVisitor visitor = new JSPFileVisitor(reporter);
// try {
// // collect all jsp files for the project
// project.accept(visitor, IResource.DEPTH_INFINITE);
// }
// catch (CoreException e) {
// if (DEBUG)
// e.printStackTrace();
// }
// IFile[] files = visitor.getFiles();
// for (int i = 0; i < files.length && !reporter.isCancelled(); i++) {
// if (shouldValidate(files[i]) && fragmentCheck(files[i])) {
// int percent = (i * 100) / files.length + 1;
// Message message = new LocalizedMessage(IMessage.LOW_SEVERITY, percent + "% " + files[i].getFullPath().toString());
// reporter.displaySubtask(this, message);
//
// validateFile(files[i], reporter);
// }
// if (DEBUG)
// System.out.println("validating: [" + files[i] + "]"); //$NON-NLS-1$ //$NON-NLS-2$
// }
// }
// }
}
private void validateFile(IFile file, IReporter reporter)
{
FacesConfigArtifactEdit facesConfigEdit = null;
try
{
IPath path = JSFAppConfigUtils.getWebContentFolderRelativePath(file);
facesConfigEdit = FacesConfigArtifactEdit.
getFacesConfigArtifactEditForRead(file.getProject(), path.toString());
if (facesConfigEdit != null
&& facesConfigEdit.getFacesConfig()!=null)
{
String version = validateVersioning(file, facesConfigEdit, reporter);
validateModel(file, facesConfigEdit,reporter, version);
}
}
finally
{
if (facesConfigEdit != null)
{
facesConfigEdit.dispose();
}
}
}
/**
* Ensure that the expected project version (facet) jives with what is in
* the faces-config. Generally this means:
*
* if (version == 1.1) then no 1.2 artifacts (error)
* if (version == 1.2) then warn if using old artifacts (warning)
*/
private String validateVersioning(IFile file, FacesConfigArtifactEdit facesConfigEdit, IReporter reporter)
{
final String appConfigFileVersion = getAppConfigFileVersion(facesConfigEdit);
if (appConfigFileVersion != null)
{
final String projectVersion = getJSFVersion(file.getProject());
if (IJSFCoreConstants.FACET_VERSION_1_1.equals(projectVersion)
|| IJSFCoreConstants.FACET_VERSION_1_0.equals(projectVersion))
{
if (IJSFCoreConstants.FACET_VERSION_1_2.equals(appConfigFileVersion))
{
reporter.addMessage(this,
DiagnosticFactory
.create_APP_CONFIG_IS_NEWER_THAN_JSF_VERSION(file));
}
}
else if (IJSFCoreConstants.FACET_VERSION_1_2.equals(projectVersion))
{
if (IJSFCoreConstants.FACET_VERSION_1_1.equals(appConfigFileVersion)
|| IJSFCoreConstants.FACET_VERSION_1_0.equals(appConfigFileVersion))
{
reporter.addMessage(this,
DiagnosticFactory
.create_APP_CONFIG_IS_OLDER_THAN_JSF_VERSION(file
, appConfigFileVersion, projectVersion));
}
}
// if no exact match, don't make any assumptions
}
return appConfigFileVersion;
}
/**
* @param facesConfigEdit
* @return the version of the app config file or null if not determinant
*/
private String getAppConfigFileVersion(FacesConfigArtifactEdit facesConfigEdit)
{
String appConfigVersion = null;
final IDOMModel domModel = facesConfigEdit.getIDOMModel();
final IDOMDocument document = domModel.getDocument();
if (document == null) {return null;}
final DocumentType docType = domModel.getDocument().getDoctype();
// if we have DTD doctype then we're looking at 1.1 or before
if (docType != null)
{
appConfigVersion = extractVersionFromPublicId(docType);
// if not found in the public id, try the system id
if (appConfigVersion == null)
{
appConfigVersion = extractVersionFromSystemId(docType);
}
}
else
{
NodeList rootNodes = domModel.getDocument().getChildNodes();
for (int i = 0; i < rootNodes.getLength(); i++)
{
Node node = rootNodes.item(i);
if (node.getNodeType() == Node.ELEMENT_NODE
&& "faces-config".equals(node.getLocalName()))
{
NamedNodeMap map = node.getAttributes();
// the most accurate thing is the version
Node versionAttrib = map.getNamedItem("version");
if (versionAttrib != null)
{
appConfigVersion = versionAttrib.getNodeValue();
break;
}
// TODO: add additional heuristic to parse out
// the schema
}
}
}
return appConfigVersion;
}
private void validateModel(final IFile file,
final FacesConfigArtifactEdit facesConfigEdit,
final IReporter reporter,
final String version)
{
final FacesConfigType facesConfigType = facesConfigEdit.getFacesConfig();
FacesConfigValidator validator = new FacesConfigValidator(version);
List messages = new ArrayList();
validator.validate(facesConfigType, messages, file);
for (final Iterator it = messages.iterator(); it.hasNext();)
{
IMessage message = (IMessage) it.next();
reporter.addMessage(this, message);
}
}
/**
* @param project
* @return the version string for the JSF facet on project
* or null if not found
*/
private String getJSFVersion(final IProject project)
{
try
{
final IFacetedProject facetedProject = ProjectFacetsManager.create(project);
Set facets = facetedProject.getProjectFacets();
for (final Iterator it = facets.iterator(); it.hasNext();)
{
IProjectFacetVersion facetVersion =
(IProjectFacetVersion) it.next();
if (IJSFCoreConstants.JSF_CORE_FACET_ID.equals(facetVersion.getProjectFacet().getId()))
{
return facetVersion.getVersionString();
}
}
}
catch (CoreException ce)
{
JSFCorePlugin.log(ce, "Problem loading faceted project");
// fall-through and return null
}
return null;
}
private String extractVersionFromPublicId(DocumentType docType)
{
final String publicId = docType.getPublicId();
final String publicIdRegex = "-\\/\\/(.*)\\/\\/(.*)\\/\\/.*";
if (publicId != null)
{
final Pattern pattern = Pattern.compile(publicIdRegex);
Matcher matcher = pattern.matcher(publicId);
if (matcher.matches())
{
final String classTypeString = matcher.group(2);
final String[] classTypes = classTypeString.split("\\s+");
// verify that the class type is a DTD
if (classTypes.length > 0
&& "DTD".equals(classTypes[0]))
{
// either 1.0 or 1.1; be most conservative
String appConfigVersion = IJSFCoreConstants.JSF_VERSION_1_0;
// see if the version is in the public id
if (IJSFCoreConstants.JSF_VERSION_1_1.equals(classTypes[classTypes.length-1]))
{
appConfigVersion = IJSFCoreConstants.FACET_VERSION_1_1;
}
return appConfigVersion;
}
}
}
return null;
}
private String extractVersionFromSystemId(DocumentType docType)
{
final String systemId = docType.getSystemId();
final String systemIdRegEx = "http:\\/\\/java.sun.com\\/dtd\\/web-facesconfig_(.*)\\.dtd";
if (systemId != null)
{
final Pattern pattern = Pattern.compile(systemIdRegEx);
Matcher matcher = pattern.matcher(systemId);
if (matcher.matches())
{
final String version = matcher.group(1);
if ("1_1".equals(version)||"1_0".equals(version))
{
return version.replaceAll("_", ".");
}
}
}
return null;
}
}
|
