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
|
/*******************************************************************************
* Copyright (c) 2006 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:
* Gerry Kessler/Oracle - initial API and implementation
* Xiaonan Jiang/IBM - https://bugs.eclipse.org/bugs/show_bug.cgi?id=308337
*
********************************************************************************/
package org.eclipse.jst.jsf.taglibprocessing.attributevalues;
import java.net.URL;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jst.jsf.context.resolver.structureddocument.IStructuredDocumentContextResolverFactory;
import org.eclipse.jst.jsf.context.resolver.structureddocument.IWorkspaceContextResolver;
import org.eclipse.jst.jsf.core.JSFVersion;
import org.eclipse.jst.jsf.core.jsfappconfig.JSFAppConfigUtils;
import org.eclipse.jst.jsf.core.jsfappconfig.internal.JSFAppConfigManagerFactory;
import org.eclipse.jst.jsf.facesconfig.FacesConfigPlugin;
import org.eclipse.jst.jsf.facesconfig.emf.DisplayNameType;
import org.eclipse.jst.jsf.facesconfig.emf.NavigationCaseType;
import org.eclipse.jst.jsf.facesconfig.emf.NavigationRuleType;
import org.eclipse.jst.jsf.metadataprocessors.features.IPossibleValue;
import org.eclipse.jst.jsf.metadataprocessors.features.IPossibleValues;
import org.eclipse.jst.jsf.metadataprocessors.features.IValidationMessage;
import org.eclipse.jst.jsf.metadataprocessors.features.PossibleValue;
import org.eclipse.jst.jsf.metadataprocessors.features.ValidationMessage;
import org.eclipse.osgi.util.NLS;
import org.eclipse.wst.common.componentcore.ComponentCore;
import org.eclipse.wst.common.componentcore.resources.IVirtualComponent;
import org.eclipse.wst.common.componentcore.resources.IVirtualFile;
import org.eclipse.wst.common.componentcore.resources.IVirtualFolder;
import org.osgi.framework.Bundle;
/**
* Meta-data processing type representing an "action" attribute
*
* <p><b>Provisional API - subject to change</b></p>
* @author Gerry Kessler - Oracle
*/
public class ActionType extends MethodBindingType implements IPossibleValues{
/**
* Image to use if metadata defined image cannot be created
*/
protected static final ImageDescriptor MISSING_IMAGE = ImageDescriptor.getMissingImageDescriptor();
private static final String IMAGE_NAME = "/icons/full/obj16/NavigationCaseType.gif"; //$NON-NLS-1$
private ImageDescriptor imageDescriptor;
/* (non-Javadoc)
* @see org.eclipse.jst.jsf.taglibprocessing.attributevalues.MethodBindingType#isValidValue(java.lang.String)
*/
public boolean isValidValue(String value){
if (value == null || (value != null && value.length() == 0)) {
IValidationMessage msg = new ValidationMessage(Messages.ActionType_invalid_empty_value);
getValidationMessages().add(msg);
return false;
}
//any other value should be one of the possible values
//optimize
IWorkspaceContextResolver wr = IStructuredDocumentContextResolverFactory.INSTANCE.getWorkspaceContextResolver(getStructuredDocumentContext());
if (wr == null)
return true;//shouldn't get here
//in case that this is not JSF faceted or missing configs, need to pass
if (JSFAppConfigManagerFactory.getJSFAppConfigManagerInstance(wr.getProject()) == null)
return true;
IFile jsp = (IFile)wr.getResource();
List<NavigationRuleType> rules = JSFAppConfigManagerFactory.getJSFAppConfigManagerInstance(wr.getProject()).getNavigationRulesForPage(jsp);
for (final NavigationRuleType rule : rules) {
for (Iterator cases=rule.getNavigationCase().iterator();cases.hasNext();) {
NavigationCaseType navCase = (NavigationCaseType)cases.next();
if (navCase.getFromOutcome() != null && navCase.getFromOutcome().getTextContent() != null &&
value.equals(navCase.getFromOutcome().getTextContent().trim()))
return true;
}
}
if (JSFVersion.valueOfProject(jsp.getProject()).compareTo(JSFVersion.V2_0) >= 0) {
int index = value.indexOf('?');
if (index != -1) {
value = value.substring(0, index);
}
if (value != null && value.length() > 1) {
IVirtualFolder webRoot = ComponentCore.createComponent(jsp.getProject()).getRootFolder();
if (value.charAt(0) == '/') {
IVirtualFile file = webRoot.getFile(new Path(value));
if (file.exists()) {
return true;
}
} else {
IPath webContentPath = webRoot.getUnderlyingFolder().getFullPath();
IPath filePath = jsp.getFullPath();
if (filePath.matchingFirstSegments(webContentPath) == webContentPath.segmentCount()) {
String extension = filePath.getFileExtension();
filePath = filePath.removeFirstSegments(webContentPath.segmentCount());
filePath = filePath.removeLastSegments(1);
filePath = filePath.append(value);
if (filePath.getFileExtension() == null && extension != null) {
filePath = filePath.addFileExtension(extension);
}
IVirtualFile file = webRoot.getFile(filePath);
if (file.exists()) {
return true;
}
}
}
}
}
IValidationMessage msg = new ValidationMessage(Messages.ActionType_invalid_value);
getValidationMessages().add(msg);
return false;
}
/* (non-Javadoc)
* @see org.eclipse.jst.jsf.metadataprocessors.features.IPossibleValues#getPossibleValues()
*/
public List getPossibleValues() {
final List<IPossibleValue> ret = new ArrayList<IPossibleValue>();
if (getStructuredDocumentContext() == null)
return ret;
final IWorkspaceContextResolver wr = IStructuredDocumentContextResolverFactory.INSTANCE.getWorkspaceContextResolver(getStructuredDocumentContext());
if (wr != null && JSFAppConfigManagerFactory.getJSFAppConfigManagerInstance(wr.getProject()) != null) {//may not be JSF faceted project or know faces-config){
IFile jsp = (IFile)wr.getResource();
List<NavigationRuleType> rules = JSFAppConfigManagerFactory.getJSFAppConfigManagerInstance(wr.getProject()).getNavigationRulesForPage(jsp);
for (final NavigationRuleType rule : rules) {
if (rule != null)
ret.addAll(createProposals(rule));
}
//Bug 306451 - [JSF2.0] Support for Implicit navigation
ret.addAll(createImplicitProposals(jsp));
}
return ret;
}
private List createProposals(NavigationRuleType rule) {
List ret = new ArrayList();
List cases = rule.getNavigationCase();
for (Iterator it=cases.iterator();it.hasNext();) {
NavigationCaseType navCase = (NavigationCaseType)it.next();
PossibleValue pv = createProposal(rule, navCase);
if (pv != null)
ret.add(pv);
}
return ret;
}
private PossibleValue createProposal(NavigationRuleType rule, NavigationCaseType navCase) {
PossibleValue pv = null;
String value = null;
String ruleDisp = null;
String navDisplay = null;
String navAction = null;
String toViewId = null;
if (navCase.getFromOutcome() != null)
value = navCase.getFromOutcome().getTextContent();
if (navCase.getToViewId()!= null)
toViewId = navCase.getToViewId().getTextContent();
if (rule.getFromViewId() != null)
ruleDisp = rule.getFromViewId().getTextContent();
if (navCase.getDisplayName() != null
&& navCase.getDisplayName().size() > 0) {
navDisplay = ((DisplayNameType) navCase
.getDisplayName().get(0)).getTextContent();
}
if (navCase.getFromAction() != null) {
navAction= navCase.getFromAction().getTextContent();
}
if (navDisplay == null || navDisplay.trim().equals("")) //$NON-NLS-1$
navDisplay = NLS.bind(Messages.ActionType_navcase_display, new String[]{value, toViewId});
if (value != null){
pv = new PossibleValue(value, navDisplay);
pv.setIcon(getNavCaseImageDescriptor());
pv.setAdditionalInformation("from-outcome: "+value //$NON-NLS-1$
+ "<br>to-view-id: " + toViewId //$NON-NLS-1$
+ "<br>from-view-id: " + ruleDisp //$NON-NLS-1$
+ "<br>from-action: " + (navAction == null ? "null" : navAction)); //$NON-NLS-1$ //$NON-NLS-2$
}
return pv;
}
//Bug 306451 - [JSF2.0] Support for Implicit navigation
private List createImplicitProposals(final IFile fromFile) {
List ret = new ArrayList();
if (fromFile != null) {
final IProject project = fromFile.getProject();
if (project != null) {
final IVirtualComponent component = ComponentCore.createComponent(project);
if (component != null) {
final IVirtualFolder folder = component.getRootFolder();
if (folder != null) {
final IPath webContentPath = folder.getUnderlyingFolder().getFullPath();
IPath fromPath = fromFile.getFullPath();
if (webContentPath.isPrefixOf(fromPath)) {
fromPath = fromPath.makeRelativeTo(webContentPath);
final IPath fromPathParent = fromPath.removeLastSegments(1);
final List<IFile> files =
JSFAppConfigUtils.getImplicitNavigationFiles(fromFile);
for (final IFile currentFile: files) {
IPath currentPath = currentFile.getFullPath();
if (webContentPath.isPrefixOf(currentPath)) {
currentPath = currentPath.makeRelativeTo(webContentPath);
final String toViewId = '/' + currentPath.toString();
boolean isRelative = false;
if (fromPathParent.isPrefixOf(currentPath)) {
currentPath = currentPath.makeRelativeTo(fromPathParent);
isRelative = true;
}
String value = currentPath.toString();
final String fromPathExt = fromPath.getFileExtension();
if (fromPathExt != null &&
fromPathExt.equals(currentPath.getFileExtension())) {
value = currentPath.removeFileExtension().toString();
}
if (!isRelative) {
value = '/' + value;
}
final String navDisplay =
NLS.bind(
Messages.ActionType_navcase_display,
new String[]{value, toViewId});
final PossibleValue possibleValue =
new PossibleValue(value, navDisplay);
possibleValue.setIcon(getNavCaseImageDescriptor());
possibleValue.setAdditionalInformation(
NLS.bind(
Messages.ActionType_implicit_navigation_additional_info,
toViewId));
ret.add(possibleValue);
}
}
}
}
}
}
}
return ret;
}
private ImageDescriptor getNavCaseImageDescriptor() {
ImageDescriptor ret = super.getImage();
if (ret != null && ret != MISSING_IMAGE)
return ret;
if (imageDescriptor == null){
imageDescriptor = getImageDesc(IMAGE_NAME);
}
return imageDescriptor;
}
private ImageDescriptor getImageDesc(String img)
{
Bundle bundle = FacesConfigPlugin.getPlugin().getBundle();
URL url = FileLocator.find(bundle, new Path(img), null);
ImageDescriptor desc = ImageDescriptor.createFromURL(url);
if (desc == MISSING_IMAGE) {
return null;
}
return desc;
}
}
|
