/******************************************************************************
* Copyright (c) 2009, 2011 Red Hat, IBM
* 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:
* Rob Stryker - initial implementation and ongoing maintenance
* Chuck Bridgham - additional support
* Roberto Sanchez - Add Advanced section
******************************************************************************/
package org.eclipse.jst.j2ee.internal.ui.preferences;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.fieldassist.ControlDecoration;
import org.eclipse.jface.fieldassist.FieldDecorationRegistry;
import org.eclipse.jst.j2ee.application.internal.operations.AddReferenceToEnterpriseApplicationDataModelProvider;
import org.eclipse.jst.j2ee.application.internal.operations.RemoveReferenceFromEnterpriseApplicationDataModelProvider;
import org.eclipse.jst.j2ee.internal.J2EEConstants;
import org.eclipse.jst.j2ee.internal.common.classpath.J2EEComponentClasspathUpdater;
import org.eclipse.jst.j2ee.internal.componentcore.JavaEEBinaryComponentHelper;
import org.eclipse.jst.j2ee.internal.componentcore.JavaEEModuleHandler;
import org.eclipse.jst.j2ee.internal.plugin.J2EEUIMessages;
import org.eclipse.jst.j2ee.internal.plugin.J2EEUIPlugin;
import org.eclipse.jst.j2ee.internal.project.J2EEProjectUtilities;
import org.eclipse.jst.j2ee.internal.ui.IJavaEEDeploymentAssemblySectionBuilder;
import org.eclipse.jst.j2ee.internal.ui.J2EEModuleDependenciesPropertyPage.ClasspathEntryProxy;
import org.eclipse.jst.j2ee.internal.ui.JavaEEComponentDependencyContentProvider;
import org.eclipse.jst.j2ee.internal.ui.JavaEEDeploymentAssemblyAdvancedSectionBuilder;
import org.eclipse.jst.j2ee.model.IEARModelProvider;
import org.eclipse.jst.j2ee.model.ModelProviderManager;
import org.eclipse.jst.j2ee.project.EarUtilities;
import org.eclipse.jst.j2ee.project.JavaEEProjectUtilities;
import org.eclipse.jst.javaee.application.Application;
import org.eclipse.jst.jee.project.facet.EarCreateDeploymentFilesDataModelProvider;
import org.eclipse.jst.jee.project.facet.ICreateDeploymentFilesDataModelProperties;
import org.eclipse.jst.jee.util.internal.JavaEEQuickPeek;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.wst.common.componentcore.internal.IModuleHandler;
import org.eclipse.wst.common.componentcore.internal.impl.TaskModel;
import org.eclipse.wst.common.componentcore.internal.resources.VirtualArchiveComponent;
import org.eclipse.wst.common.componentcore.resources.IVirtualComponent;
import org.eclipse.wst.common.componentcore.resources.IVirtualFile;
import org.eclipse.wst.common.componentcore.resources.IVirtualReference;
import org.eclipse.wst.common.componentcore.ui.internal.propertypage.ComponentDependencyContentProvider;
import org.eclipse.wst.common.componentcore.ui.internal.propertypage.DependencyPageExtensionManager;
import org.eclipse.wst.common.componentcore.ui.internal.propertypage.DependencyPageExtensionManager.ReferenceExtension;
import org.eclipse.wst.common.componentcore.ui.internal.taskwizard.TaskWizard;
import org.eclipse.wst.common.componentcore.ui.propertypage.AddModuleDependenciesPropertiesPage;
import org.eclipse.wst.common.componentcore.ui.propertypage.IReferenceWizardConstants;
import org.eclipse.wst.common.componentcore.ui.propertypage.IReferenceWizardConstants.ProjectConverterOperationProvider;
import org.eclipse.wst.common.componentcore.ui.propertypage.ModuleAssemblyRootPage;
import org.eclipse.wst.common.frameworks.datamodel.DataModelFactory;
import org.eclipse.wst.common.frameworks.datamodel.IDataModel;
import org.eclipse.wst.common.frameworks.datamodel.IDataModelOperation;
import org.eclipse.wst.common.frameworks.datamodel.IDataModelProvider;
public class EarModuleDependenciesPropertyPage extends
AddModuleDependenciesPropertiesPage {
private String libDir = null;
private Text libDirText;
private ControlDecoration libDirTextErrorDecoration = null;
private static String earDefaultLirDir = new Path(J2EEConstants.EAR_DEFAULT_LIB_DIR).makeRelative().toString();
boolean previousLibDirIsValid = true;
private IJavaEEDeploymentAssemblySectionBuilder advancedHelper;
public EarModuleDependenciesPropertyPage(IProject project,
ModuleAssemblyRootPage page) {
super(project, page);
advancedHelper = getAdvancedSectionBuilder();
}
@Override
protected void createTableComposite(Composite parent) {
Composite composite = new Composite(parent, SWT.NONE);
GridData gData = new GridData(GridData.FILL_BOTH);
composite.setLayoutData(gData);
fillTableComposite(composite);
if(JavaEEProjectUtilities.isJEEComponent(rootComponent, JavaEEProjectUtilities.DD_VERSION) && JavaEEProjectUtilities.isJEEComponent(rootComponent, JavaEEProjectUtilities.FACET_VERSION))
addLibDirComposite(composite);
addAdvancedComposite(composite);
}
private String loadLibDirString() {
return EarUtilities.getEARLibDir(rootComponent);
}
protected void addLibDirComposite(Composite parent) {
libDir = loadLibDirString();
if(libDir != null) {
Composite c = new Composite(parent, SWT.NONE);
GridData mainData = new GridData(GridData.FILL_HORIZONTAL);
c.setLayoutData(mainData);
GridLayout gl = new GridLayout(2,false);
gl.marginWidth = 0;
gl.marginHeight = 0;
c.setLayout(gl);
Label l = new Label(c, SWT.NONE);
l.setText(Messages.EarModuleDependenciesPropertyPage_LIBDIR);
libDirText = new Text(c, SWT.BORDER);
GridData gd = new GridData(GridData.FILL_HORIZONTAL);
gd.horizontalIndent = FieldDecorationRegistry.getDefault().getMaximumDecorationWidth();
libDirText.setText(libDir);
libDirText.setLayoutData(gd);
libDirTextErrorDecoration = new ControlDecoration(libDirText, SWT.TOP | SWT.LEAD);
libDirTextErrorDecoration.hide();
libDirText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
libDirTextModified();
} });
new Label(parent, SWT.NONE); //Place holder to fill the second column
}
}
protected void libDirTextModified() {
boolean refresh = mustRefreshLibDirValidationMessages(libDir, libDirText.getText());
libDir = libDirText.getText();
if(refresh)
propPage.refreshProblemsView();
}
protected boolean mustRefreshLibDirValidationMessages(String oldLibDir, String newLibDir) {
boolean newIsValid = isValidLibDir(newLibDir);
boolean newIsEmpty = (newLibDir != null && newLibDir.trim().length() == 0);
// Both are valid; no need to refresh
if(previousLibDirIsValid && newIsValid && !newIsEmpty)
return false;
boolean oldIsValid = isValidLibDir(oldLibDir);
boolean oldIsEmpty = (oldLibDir != null && oldLibDir.trim().length() == 0);
// Both are invalid and no change in reason for being invalid; no need to refresh
if(!previousLibDirIsValid && oldIsValid == newIsValid && oldIsEmpty == newIsEmpty)
return false;
return true;
}
protected void validatelibDirText() {
if(libDirTextErrorDecoration != null) {
if(!isValidLibDir(libDir)) {
libDirTextErrorDecoration.setImage(FieldDecorationRegistry.getDefault().getFieldDecoration(FieldDecorationRegistry.DEC_ERROR).getImage());
libDirTextErrorDecoration.setDescriptionText(Messages.EarModuleDependenciesPropertyPage_ERROR_INVALID_LIBDIR);
libDirTextErrorDecoration.show();
previousLibDirIsValid = false;
}else if(libDir != null && libDir.trim().length() == 0){
libDirTextErrorDecoration.setImage(FieldDecorationRegistry.getDefault().getFieldDecoration(FieldDecorationRegistry.DEC_WARNING).getImage());
libDirTextErrorDecoration.setDescriptionText(Messages.EarModuleDependenciesPropertyPage_WARNING_EMPTY_LIB_DIR);
libDirTextErrorDecoration.show();
previousLibDirIsValid = false;
} else if(!previousLibDirIsValid){
previousLibDirIsValid = true;
libDirTextErrorDecoration.setImage(null);
libDirTextErrorDecoration.setDescriptionText(null);
libDirTextErrorDecoration.hide();
}
}
}
private boolean isValidLibDir(String libraryDirectory) {
if(libraryDirectory != null && libraryDirectory.trim().length() > 0 && new Path(libraryDirectory.trim()).isAbsolute()) {
return false;
}
return true;
}
protected IDataModelOperation generateEARDDOperation() {
IDataModel model = DataModelFactory.createDataModel(new EarCreateDeploymentFilesDataModelProvider());
model.setProperty(ICreateDeploymentFilesDataModelProperties.GENERATE_DD, rootComponent);
model.setProperty(ICreateDeploymentFilesDataModelProperties.TARGET_PROJECT, project);
return model.getDefaultOperation();
}
@Override
public boolean postHandleChanges(IProgressMonitor monitor) {
return true;
}
@Override
protected void handleRemoved(ArrayList<IVirtualReference> removed) {
super.handleRemoved(removed);
boolean binariesRemoved = false;
for(IVirtualReference ref : removed){
IVirtualComponent comp = ref.getReferencedComponent();
if(comp.isBinary()){
binariesRemoved = true;
break;
}
}
if(binariesRemoved){
JavaEEBinaryComponentHelper.clearDisconnectedArchivesInEAR(rootComponent);
}
J2EEComponentClasspathUpdater.getInstance().queueUpdateEAR(rootComponent.getProject());
}
@Override
protected IDataModelProvider getAddReferenceDataModelProvider(IVirtualReference component) {
return new AddReferenceToEnterpriseApplicationDataModelProvider();
}
@Override
protected String getModuleAssemblyRootPageDescription() {
return Messages.EarModuleDependenciesPropertyPage_3;
}
@Override
protected IDataModelProvider getRemoveReferenceDataModelProvider(IVirtualReference component) {
return new RemoveReferenceFromEnterpriseApplicationDataModelProvider();
}
@Override
protected void filterReferenceTypes( final List<ReferenceExtension> extensions )
{
// Replace the default one with our own custom one, in class CustomEARProjectReferenceWizardFragment
for( int i = 0, n = extensions.size(); i < n; i++ )
{
final ReferenceExtension ext = extensions.get( i );
if( ext.getId().equals( "org.eclipse.wst.common.componentcore.ui.newProjectReference" ) ) //$NON-NLS-1$
{
extensions.set( i, DependencyPageExtensionManager.getManager().findReferenceExtension( "org.eclipse.jst.j2ee.internal.ui.preferences.CustomEARProjectReferenceWizardFragment" ) ); //$NON-NLS-1$
}
}
}
protected void createDD(IProgressMonitor monitor) {
if( rootComponent != null ){
IDataModelOperation op = generateEARDDOperation();
try {
op.execute(monitor, null);
} catch (ExecutionException e) {
J2EEUIPlugin.logError(e);
}
}
}
@Override
public void handleEvent(Event event) {
super.handleEvent(event);
}
@Override
public boolean performOk() {
boolean result = super.performOk();
if(JavaEEProjectUtilities.isJEEComponent(rootComponent, JavaEEProjectUtilities.DD_VERSION) && JavaEEProjectUtilities.isJEEComponent(rootComponent, JavaEEProjectUtilities.FACET_VERSION) && libDir != null)
updateLibDir();
if (advancedHelper != null)
result = result & advancedHelper.saveContents();
return result;
}
private void updateLibDir() {
if (!libDir.equals(earDefaultLirDir)) {
IVirtualFile vFile = rootComponent.getRootFolder().getFile(new Path(J2EEConstants.APPLICATION_DD_URI));
if (!vFile.exists()) {
if (!MessageDialog.openQuestion(null,
J2EEUIMessages.getResourceString(J2EEUIMessages.NO_DD_MSG_TITLE),
J2EEUIMessages.getResourceString(J2EEUIMessages.GEN_DD_QUESTION)))
return;
createDD(new NullProgressMonitor());
}
}
final IEARModelProvider earModel = (IEARModelProvider)ModelProviderManager.getModelProvider(project);
Application app = (Application)earModel.getModelObject();
String oldLibDir = app.getLibraryDirectory();
if (libDir.equals(earDefaultLirDir)) {
if(oldLibDir != null) {
earModel.modify(new Runnable() {
public void run() {
Application app2 = (Application)earModel.getModelObject();
app2.setLibraryDirectory(null);
}}, null);
}
} else if ((oldLibDir != null && !oldLibDir.equals(libDir)) || oldLibDir == null) {
earModel.modify(new Runnable() {
public void run() {
Application app2 = (Application)earModel.getModelObject();
app2.setLibraryDirectory(libDir);
}}, null);
}
}
@Override
protected void setCustomReferenceWizardProperties(TaskModel model) {
model.putObject(IReferenceWizardConstants.DEFAULT_LIBRARY_LOCATION, libDir);
model.putObject(IReferenceWizardConstants.PROJECT_CONVERTER_OPERATION_PROVIDER, getConverterProvider());
}
public ProjectConverterOperationProvider getConverterProvider() {
return new ProjectConverterOperationProvider() {
public IDataModelOperation getConversionOperation(IProject project) {
return J2EEProjectUtilities.createFlexJavaProjectForProjectOperation(project);
}
};
}
@Override
protected IModuleHandler getModuleHandler() {
if(moduleHandler == null)
moduleHandler = new JavaEEModuleHandler();
return moduleHandler;
}
@Override
protected ComponentDependencyContentProvider createProvider() {
JavaEEComponentDependencyContentProvider provider = new JavaEEComponentDependencyContentProvider(this);
provider.setClasspathEntries(new ArrayList<ClasspathEntryProxy>());
return provider;
}
@Override
protected boolean canRemove(Object selectedObject) {
return super.canRemove(selectedObject) && !(selectedObject instanceof JavaEEComponentDependencyContentProvider.ConsumedClasspathEntryProxy);
}
@Override
protected void remove(Object selectedItem) {
super.remove(selectedItem);
advancedHelper.directiveRemoved(selectedItem);
}
@Override
public IStatus validate() {
IStatus status = super.validate();
validatelibDirText();
if(libDirTextErrorDecoration != null && libDirTextErrorDecoration.getImage() != null) {
int severity = Status.ERROR;
if(libDirTextErrorDecoration.getImage().equals(FieldDecorationRegistry.getDefault().getFieldDecoration(FieldDecorationRegistry.DEC_WARNING).getImage()))
severity = Status.WARNING;
status = appendStatusMessage(status, libDirTextErrorDecoration.getDescriptionText(), severity);
}
status = advancedHelper.validate(status);
return status;
}
@Override
public void performDefaults() {
libDir = loadLibDirString();
if(libDir != null)
libDirText.setText(libDir);
if (advancedHelper != null)
advancedHelper.loadContents();
super.performDefaults();
}
private IStatus appendStatusMessage(IStatus existingStatus, String message, int severity) {
MultiStatus multiStatus;
IStatus newStatus = new Status(severity, J2EEUIPlugin.PLUGIN_ID, message);
int newSeverity = severity;
if(existingStatus.getSeverity() > severity)
newSeverity = existingStatus.getSeverity();
if(existingStatus instanceof MultiStatus){
multiStatus = (MultiStatus)existingStatus;
multiStatus.merge(newStatus);
} else {
if(!existingStatus.isMultiStatus() && existingStatus.isOK()) {
return newStatus;
}
IStatus [] children = new IStatus [] {existingStatus, newStatus};
multiStatus = new MultiStatus(J2EEUIPlugin.PLUGIN_ID, newSeverity, children, null, null);
}
return multiStatus;
}
@Override
protected void handleAddDirective( final TaskWizard wizard )
{
final Object folderMapping = wizard.getTaskModel().getObject(IReferenceWizardConstants.FOLDER_MAPPING);
if( folderMapping != null && folderMapping instanceof ComponentResourceProxy || libDir == null)
{
super.handleAddDirective(wizard);
}
else
{
Object reference = wizard.getTaskModel().getObject(IReferenceWizardConstants.FINAL_REFERENCE);
if( reference != null )
{
IVirtualReference[] referenceArray = reference instanceof IVirtualReference ?
new IVirtualReference[] { (IVirtualReference)reference } :
(IVirtualReference[])reference;
for(int i = 0; i < referenceArray.length; i++) {
IVirtualComponent component = referenceArray[i].getReferencedComponent();
if(component instanceof VirtualArchiveComponent) {
JavaEEQuickPeek qp = JavaEEBinaryComponentHelper.getJavaEEQuickPeek(component);
switch (qp.getType()) {
case JavaEEQuickPeek.EJB_TYPE:
case JavaEEQuickPeek.WEB_TYPE:
case JavaEEQuickPeek.APPLICATION_CLIENT_TYPE:
case JavaEEQuickPeek.CONNECTOR_TYPE:
referenceArray[i].setRuntimePath(new Path("/")); //$NON-NLS-1$
}
}
currentReferences.add(referenceArray[i]);
}
}
}
advancedHelper.directiveAdded(wizard.getTaskModel());
}
protected void addAdvancedComposite(Composite parent) {
if (advancedHelper != null) {
advancedHelper.buildSection(parent);
advancedHelper.loadContents();
}
}
protected IJavaEEDeploymentAssemblySectionBuilder getAdvancedSectionBuilder(){
if (advancedHelper == null){
advancedHelper = new JavaEEDeploymentAssemblyAdvancedSectionBuilder(rootComponent, this);
}
return advancedHelper;
}
@Override
protected RuntimePathCellModifier getRuntimePathCellModifier() {
return new AddModuleDependenciesPropertiesPage.RuntimePathCellModifier(){
@Override
public void modify(Object element, String property, Object value) {
ComponentResourceProxy originalResource = null;
ComponentResourceProxy modifiedResource = null;
if (property.equals(DEPLOY_PATH_PROPERTY)) {
TreeItem item = (TreeItem) element;
if( item.getData() instanceof ComponentResourceProxy) {
modifiedResource = (ComponentResourceProxy)item.getData();
originalResource = new ComponentResourceProxy(modifiedResource.source, modifiedResource.runtimePath);
}
}
super.modify(element, property, value);
if (originalResource != null && advancedHelper != null)
advancedHelper.componentResourceModified(originalResource, modifiedResource);
}
};
}
}