Java tutorial
/******************************************************************************* * Copyright (c) 2005, 2011 IBM Corporation and others. * 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: * IBM Corporation - initial API and implementation *******************************************************************************/ package ext.org.eclipse.jdt.internal.ui.jarimport; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.net.URI; import java.util.HashSet; import java.util.Set; import java.util.zip.ZipEntry; import java.util.zip.ZipFile; import org.eclipse.swt.SWT; import org.eclipse.swt.events.ModifyEvent; import org.eclipse.swt.events.ModifyListener; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.FileDialog; import org.eclipse.swt.widgets.Label; import org.eclipse.core.filesystem.URIUtil; import org.eclipse.core.runtime.Assert; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.jface.dialogs.Dialog; import org.eclipse.jface.dialogs.IDialogConstants; import org.eclipse.jface.viewers.DecoratingLabelProvider; import org.eclipse.jface.viewers.ISelectionChangedListener; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.viewers.SelectionChangedEvent; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.TreeViewer; import org.eclipse.jface.wizard.WizardPage; import org.eclipse.ui.PlatformUI; import org.eclipse.ltk.core.refactoring.RefactoringCore; import org.eclipse.jdt.core.IClasspathEntry; import org.eclipse.jdt.core.IJavaElement; import org.eclipse.jdt.core.IJavaModel; import org.eclipse.jdt.core.IJavaProject; import org.eclipse.jdt.core.IPackageFragment; import org.eclipse.jdt.core.IPackageFragmentRoot; import org.eclipse.jdt.core.JavaCore; import org.eclipse.jdt.core.JavaModelException; import org.eclipse.jdt.core.refactoring.descriptors.JavaRefactoringDescriptor; import org.eclipse.jdt.ui.JavaElementComparator; import org.eclipse.jdt.ui.JavaElementLabelProvider; import org.eclipse.jdt.ui.ProblemsLabelDecorator; import org.eclipse.jdt.ui.StandardJavaElementContentProvider; import patch.org.eclipse.jdt.internal.ui.JavaPlugin; import ext.org.eclipse.jdt.internal.ui.IJavaHelpContextIds; import ext.org.eclipse.jdt.internal.ui.filters.EmptyPackageFilter; import ext.org.eclipse.jdt.internal.ui.jarpackager.JarPackagerUtil; import ext.org.eclipse.jdt.internal.ui.refactoring.binary.BinaryRefactoringHistoryWizard; import ext.org.eclipse.jdt.internal.ui.util.SWTUtil; import ext.org.eclipse.jdt.internal.ui.wizards.buildpaths.ArchiveFileFilter; /** * Jar import wizard page. * * @since 3.2 */ public final class JarImportWizardPage extends WizardPage { /** The jar import wizard page name */ private static final String PAGE_NAME = "JarImportWizardPage"; //$NON-NLS-1$ /** The history dialog setting */ protected static final String SETTING_HISTORY = "org.eclipse.jdt.ui.refactoring.jarHistory"; //$NON-NLS-1$ /** Is the wizard page displayed for the first time? */ private boolean fFirstTime = true; /** Is the wizard part of an import wizard? */ private final boolean fImportWizard; /** The location control */ private RefactoringLocationControl fLocationControl = null; /** The java model viewer */ private TreeViewer fTreeViewer = null; /** The import wizard */ private final JarImportWizard fWizard; /** * Creates a new jar import wizard page. * * @param wizard * the jar import wizard * @param importWizard * <code>true</code> if the wizard is part of an import wizard, * <code>false</code> otherwise */ public JarImportWizardPage(final JarImportWizard wizard, final boolean importWizard) { super(PAGE_NAME); Assert.isNotNull(wizard); fWizard = wizard; fImportWizard = importWizard; if (fImportWizard) { setTitle(JarImportMessages.JarImportWizardPage_page_title); setDescription(JarImportMessages.JarImportWizardPage_page_description); } else { setTitle(JarImportMessages.JarImportWizardPage_page_replace_title); setDescription(JarImportMessages.JarImportWizardPage_page_replace_description); } } /** * {@inheritDoc} */ public void createControl(final Composite parent) { initializeDialogUnits(parent); final Composite composite = new Composite(parent, SWT.NONE); composite.setLayout(new GridLayout()); composite.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_FILL | GridData.HORIZONTAL_ALIGN_FILL)); createLocationGroup(composite); if (fImportWizard) createInputGroup(composite); createRenameGroup(composite); setPageComplete(false); if (fImportWizard && !fTreeViewer.getControl().isEnabled()) setMessage(JarImportMessages.JarImportWizardPage_no_jar_files, INFORMATION); setControl(composite); Dialog.applyDialogFont(composite); PlatformUI.getWorkbench().getHelpSystem().setHelp(composite, IJavaHelpContextIds.JARIMPORT_WIZARD_PAGE); } /** * Creates a new grid data. * * @param flag * the flags to use * @param hspan * the horizontal span * @param indent * the indent * @return the grid data */ protected GridData createGridData(final int flag, final int hspan, final int indent) { final GridData data = new GridData(flag); data.horizontalIndent = indent; data.horizontalSpan = hspan; return data; } /** * Creates the input group. * * @param parent * the parent control */ protected void createInputGroup(final Composite parent) { Assert.isNotNull(parent); new Label(parent, SWT.NONE); final Label label = new Label(parent, SWT.NONE); label.setText(JarImportMessages.JarImportWizardPage_import_message); final StandardJavaElementContentProvider contentProvider = new StandardJavaElementContentProvider() { @Override public Object[] getChildren(Object element) { if ((element instanceof IJavaProject) || (element instanceof IJavaModel)) return super.getChildren(element); return new Object[0]; } @Override protected Object[] getJavaProjects(final IJavaModel model) throws JavaModelException { final Set<IJavaProject> set = new HashSet<IJavaProject>(); final IJavaProject[] projects = model.getJavaProjects(); for (int index = 0; index < projects.length; index++) { if (JarImportWizard.isValidJavaProject(projects[index])) { final Object[] roots = getPackageFragmentRoots(projects[index]); if (roots.length > 0) set.add(projects[index]); } } return set.toArray(); } @Override protected Object[] getPackageFragmentRoots(final IJavaProject project) throws JavaModelException { final Set<IPackageFragmentRoot> set = new HashSet<IPackageFragmentRoot>(); final IPackageFragmentRoot[] roots = project.getPackageFragmentRoots(); for (int offset = 0; offset < roots.length; offset++) { IPackageFragmentRoot root = roots[offset]; IClasspathEntry entry = root.getRawClasspathEntry(); if (JarImportWizard.isValidClassPathEntry(entry) && root.getResolvedClasspathEntry().getReferencingEntry() == null) set.add(root); } return set.toArray(); } @Override public boolean hasChildren(final Object element) { return (element instanceof IJavaProject) || (element instanceof IJavaModel); } }; final DecoratingLabelProvider labelProvider = new DecoratingLabelProvider( new JavaElementLabelProvider(JavaElementLabelProvider.SHOW_BASICS | JavaElementLabelProvider.SHOW_OVERLAY_ICONS | JavaElementLabelProvider.SHOW_SMALL_ICONS), new ProblemsLabelDecorator(null)); fTreeViewer = new TreeViewer(parent, SWT.SINGLE | SWT.BORDER); fTreeViewer.getTree().setLayoutData(createGridData(GridData.FILL_BOTH, 6, 0)); fTreeViewer.setLabelProvider(labelProvider); fTreeViewer.setContentProvider(contentProvider); fTreeViewer.addFilter(new EmptyPackageFilter()); fTreeViewer.setComparator(new JavaElementComparator()); fTreeViewer.setAutoExpandLevel(2); fTreeViewer.setInput(JavaCore.create(ResourcesPlugin.getWorkspace().getRoot())); final IPackageFragmentRoot root = fWizard.getPackageFragmentRoot(); if (root != null) { fTreeViewer.setSelection(new StructuredSelection(new Object[] { root }), true); fTreeViewer.expandToLevel(root, 1); } fTreeViewer.addSelectionChangedListener(new ISelectionChangedListener() { public void selectionChanged(final SelectionChangedEvent event) { handleInputChanged(); } }); if (contentProvider.getChildren(JavaCore.create(ResourcesPlugin.getWorkspace().getRoot())).length == 0) { fTreeViewer.getControl().setEnabled(false); label.setEnabled(false); } } /** * Creates the location group. * * @param parent * the parent control */ protected void createLocationGroup(final Composite parent) { Assert.isNotNull(parent); new Label(parent, SWT.NONE).setText(JarImportMessages.JarImportWizardPage_import_label); final Composite composite = new Composite(parent, SWT.NONE); composite.setLayoutData(createGridData(GridData.FILL_HORIZONTAL, 6, 0)); composite.setLayout(new GridLayout(3, false)); final Label label = new Label(composite, SWT.NONE); label.setText(JarImportMessages.JarImportWizardPage_location_label); label.setLayoutData(createGridData(GridData.HORIZONTAL_ALIGN_BEGINNING, 1, 0)); fLocationControl = new RefactoringLocationControl(fWizard, composite, SETTING_HISTORY); fLocationControl.setLayoutData(createGridData(GridData.FILL_HORIZONTAL, 1, 0)); fLocationControl.loadHistory(); fLocationControl.getControl().addModifyListener(new ModifyListener() { public final void modifyText(final ModifyEvent event) { handleInputChanged(); } }); fLocationControl.getControl().addSelectionListener(new SelectionAdapter() { @Override public final void widgetSelected(final SelectionEvent event) { handleInputChanged(); } }); fLocationControl.setFocus(); final Button button = new Button(composite, SWT.PUSH); button.setText(JarImportMessages.JarImportWizardPage_browse_button_label); button.setLayoutData(createGridData(GridData.HORIZONTAL_ALIGN_FILL, 1, 0)); SWTUtil.setButtonDimensionHint(button); button.addSelectionListener(new SelectionAdapter() { @Override public final void widgetSelected(final SelectionEvent event) { handleBrowseButtonSelected(); } }); } /** * Creates the rename group. * * @param parent * the parent control */ protected void createRenameGroup(final Composite parent) { Assert.isNotNull(parent); final JarImportData data = fWizard.getImportData(); final Button button = new Button(parent, SWT.CHECK); button.setText(JarImportMessages.JarImportWizardPage_replace_jar_file); button.setSelection(!data.isRenameJarFile()); button.addSelectionListener(new SelectionAdapter() { @Override public void widgetSelected(final SelectionEvent event) { data.setRenameJarFile(!button.getSelection()); } }); if (fImportWizard && !fTreeViewer.getControl().isEnabled()) button.setEnabled(false); if (!fImportWizard) { final GridData gd = new GridData(); gd.horizontalIndent = IDialogConstants.HORIZONTAL_MARGIN; button.setLayoutData(gd); } } /** * Handles the browse button selected event. */ protected void handleBrowseButtonSelected() { final FileDialog file = new FileDialog(getShell(), SWT.OPEN); file.setText(JarImportMessages.JarImportWizardPage_browse_caption); file.setFilterNames(ArchiveFileFilter.ALL_ARCHIVES_FILTER_EXTENSIONS); file.setFilterExtensions(ArchiveFileFilter.ALL_ARCHIVES_FILTER_EXTENSIONS); final String path = file.open(); if (path != null) { fLocationControl.setText(path); handleInputChanged(); } } /** * Handles the input changed event. */ protected void handleInputChanged() { final JarImportData data = fWizard.getImportData(); data.setRefactoringHistory(null); data.setRefactoringFileLocation(null); setErrorMessage(null); setMessage(null, NONE); setPageComplete(true); handleJarFileChanged(); if (isPageComplete()) handlePackageFragmentRootChanged(); if (fImportWizard && !fTreeViewer.getControl().isEnabled()) setErrorMessage(JarImportMessages.JarImportWizardPage_no_jar_files); fFirstTime = false; getContainer().updateButtons(); } /** * Handles the jar file changed event. */ protected void handleJarFileChanged() { if (fLocationControl != null) { final String path = fLocationControl.getText(); if ("".equals(path)) { //$NON-NLS-1$ setErrorMessage(JarImportMessages.JarImportWizardPage_empty_location); setPageComplete(false); return; } else { final File file = new File(path); if (!file.exists()) { setErrorMessage(JarImportMessages.JarImportWizardPage_invalid_location); setPageComplete(false); return; } ZipFile zip = null; try { try { zip = new ZipFile(file, ZipFile.OPEN_READ); } catch (IOException exception) { setErrorMessage(JarImportMessages.JarImportWizardPage_invalid_location); setPageComplete(false); return; } final JarImportData data = fWizard.getImportData(); data.setRefactoringFileLocation(URIUtil.toURI(path)); ZipEntry entry = zip.getEntry(JarPackagerUtil.getRefactoringsEntry()); if (entry == null) { setMessage(JarImportMessages.JarImportWizardPage_no_refactorings, INFORMATION); setPageComplete(true); return; } handleTimeStampChanged(); if (data.getExistingTimeStamp() > entry.getTime()) { setMessage(JarImportMessages.JarImportWizardPage_version_warning, WARNING); setPageComplete(true); return; } InputStream stream = null; try { stream = zip.getInputStream(entry); data.setRefactoringHistory(RefactoringCore.getHistoryService() .readRefactoringHistory(stream, JavaRefactoringDescriptor.JAR_MIGRATION | JavaRefactoringDescriptor.JAR_REFACTORING)); } catch (IOException exception) { setErrorMessage(JarImportMessages.JarImportWizardPage_no_refactorings); setPageComplete(false); return; } catch (CoreException exception) { JavaPlugin.log(exception); setErrorMessage(JarImportMessages.JarImportWizardPage_no_refactorings); setPageComplete(false); return; } finally { if (stream != null) { try { stream.close(); } catch (IOException exception) { // Do nothing } } } } finally { if (zip != null) { try { zip.close(); } catch (IOException e) { } } } } } } /** * Handles the package fragment root changed event. */ protected void handlePackageFragmentRootChanged() { if (fTreeViewer != null) { final IStructuredSelection selection = (IStructuredSelection) fTreeViewer.getSelection(); final Object[] elements = selection.toArray(); if (elements.length != 1) { setErrorMessage(JarImportMessages.JarImportWizardPage_select_single_jar); setPageComplete(false); return; } else { final JarImportData data = fWizard.getImportData(); final Object element = elements[0]; if (element instanceof IPackageFragmentRoot) data.setPackageFragmentRoot((IPackageFragmentRoot) element); else if (element instanceof IPackageFragment) { data.setPackageFragmentRoot((IPackageFragmentRoot) ((IJavaElement) element).getParent()); } else { setErrorMessage(JarImportMessages.JarImportWizardPage_select_single_jar); setPageComplete(false); } } } } /** * Handles the time stamp changed event. */ protected void handleTimeStampChanged() { final IPackageFragmentRoot root = fWizard.getPackageFragmentRoot(); if (root != null) { try { final URI uri = BinaryRefactoringHistoryWizard.getLocationURI(root.getRawClasspathEntry()); if (uri != null) { final File file = new File(uri); if (file.exists()) { ZipFile zip = null; try { zip = new ZipFile(file, ZipFile.OPEN_READ); ZipEntry entry = zip.getEntry(JarPackagerUtil.getRefactoringsEntry()); if (entry != null) { fWizard.getImportData().setExistingTimeStamp(entry.getTime()); } } catch (IOException exception) { // Just leave it } finally { if (zip != null) { try { zip.close(); } catch (IOException e) { } } } } } } catch (CoreException exception) { JavaPlugin.log(exception); } } } /** * Gets called if the wizard is finished. */ public void performFinish() { fLocationControl.saveHistory(); } /** * {@inheritDoc} */ @Override public void setErrorMessage(final String message) { if (!fFirstTime) super.setErrorMessage(message); else setMessage(message, NONE); } /** * {@inheritDoc} */ @Override public void setVisible(final boolean visible) { super.setVisible(visible); if (visible) handleInputChanged(); } }