newprojectwizard.java

A static analysis tool to find bugs in Java programs

/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2006, University of Maryland
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston MA 02111-1307, USA
 */

package edu.umd.cs.findbugs.gui2;

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.GridLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.File;
import java.util.List;

import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.DefaultListModel;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JFileChooser;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JSeparator;
import javax.swing.JTextField;
import javax.swing.SwingUtilities;
import javax.swing.border.EmptyBorder;
import javax.swing.filechooser.FileFilter;

import edu.umd.cs.findbugs.Project;
import edu.umd.cs.findbugs.ba.SourceFinder;

/**
 * The User Interface for creating a Project and editing it after the fact.  
 * @author Reuven
 *
 */
@SuppressWarnings("serial")
public class NewProjectWizard extends FBDialog
{
	private EmptyBorder border = new EmptyBorder(5, 5, 5, 5);

	private Project project;
	private boolean projectChanged = false;
	private FBFileChooser chooser = new FBFileChooser();
	private FileFilter directoryOrArchive = new FileFilter()
	{

		@Override
		public boolean accept(File f)
		{
			String fileName = f.getName().toLowerCase(); 
			return f.isDirectory() || fileName.endsWith(".jar") || fileName.endsWith(".ear") || fileName.endsWith(".war") || fileName.endsWith(".zip") || fileName.endsWith(".sar");
		}

		@Override
		public String getDescription()
		{
			return edu.umd.cs.findbugs.L10N.getLocalString("file.accepted_extensions", "Class archive files (*.[jwes]ar, *.zip)");
		}
	};

	private JList analyzeList = new JList();
	private DefaultListModel analyzeModel = new DefaultListModel();

	private JTextField projectName = new JTextField();
	private JList auxList = new JList();
	private DefaultListModel auxModel = new DefaultListModel();

	private JList sourceList = new JList();
	private DefaultListModel sourceModel = new DefaultListModel();

	private JButton finishButton = new JButton(edu.umd.cs.findbugs.L10N.getLocalString("dlg.finish_btn", "Finish"));
	private JButton cancelButton = new JButton(edu.umd.cs.findbugs.L10N.getLocalString("dlg.cancel_btn", "Cancel"));

	private JComponent[] wizardComponents = new JComponent[3];
	private int currentPanel;

	public NewProjectWizard()
	{
		this(null);
		finishButton.setEnabled(false);
	}

	/**
	 * @param curProject the project to populate from, or null to start a new one
	 */
	public NewProjectWizard(Project curProject)
	{
		project = curProject;
		boolean temp = false;

		if(curProject == null)
			setTitle(edu.umd.cs.findbugs.L10N.getLocalString("dlg.new_item", "New Project"));
		else{
			setTitle(edu.umd.cs.findbugs.L10N.getLocalString("dlg.reconfig", "Reconfigure"));
			temp = true;
		}

		final boolean reconfig = temp;

		JPanel mainPanel = new JPanel();
		mainPanel.setLayout(new GridLayout(3,1));


		wizardComponents[0] = createFilePanel(edu.umd.cs.findbugs.L10N.getLocalString("dlg.class_jars_dirs_lbl", "Class archives and directories to analyze:"), 
				analyzeList, analyzeModel, JFileChooser.FILES_AND_DIRECTORIES, directoryOrArchive);

		wizardComponents[1] = createFilePanel(edu.umd.cs.findbugs.L10N.getLocalString("dlg.aux_class_lbl", "Auxiliary class locations:"), 
				auxList, auxModel, JFileChooser.FILES_AND_DIRECTORIES, directoryOrArchive);

		wizardComponents[2] = createFilePanel(edu.umd.cs.findbugs.L10N.getLocalString("dlg.source_dirs_lbl", "Source directories:"), sourceList, sourceModel, JFileChooser.FILES_AND_DIRECTORIES, null);

		JPanel buttons = new JPanel();
		buttons.setLayout(new BoxLayout(buttons, BoxLayout.X_AXIS));
		if (MainFrame.isMacLookAndFeel()) {
			buttons.add(Box.createHorizontalStrut(5));
			buttons.add(cancelButton);
			buttons.add(Box.createHorizontalStrut(5));
			buttons.add(finishButton);
		} else {
			buttons.add(Box.createHorizontalStrut(5));
			buttons.add(finishButton);
			buttons.add(Box.createHorizontalStrut(5));
			buttons.add(cancelButton);
		}
		finishButton.addActionListener(new ActionListener()
		{
			boolean keepGoing = false;
			private boolean displayWarningAndAskIfWeShouldContinue(String msg, String title) {
				if (keepGoing) return true;
				boolean result =  JOptionPane.showConfirmDialog(NewProjectWizard.this, msg, title, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) == JOptionPane.OK_OPTION;
				if (result) keepGoing = true;
				return result;

			}
			public void actionPerformed(ActionEvent evt)
			{

				 for (int i = 0; i < analyzeModel.getSize(); i++){
					File temp = new File((String)analyzeModel.get(i));
					if(!temp.exists() && directoryOrArchive.accept(temp)) { 
						if (!displayWarningAndAskIfWeShouldContinue(temp.getName()+" " + edu.umd.cs.findbugs.L10N.getLocalString("dlg.invalid_txt", " is invalid."), 
								edu.umd.cs.findbugs.L10N.getLocalString("dlg.error_ttl", "Can't locate file"))) return;

					}
				}

				 for (int i = 0; i < sourceModel.getSize(); i++){
					File temp = new File((String)sourceModel.get(i));
					if(!temp.exists() && directoryOrArchive.accept(temp)) { 
						if (!displayWarningAndAskIfWeShouldContinue(temp.getName()+" " + edu.umd.cs.findbugs.L10N.getLocalString("dlg.invalid_txt", " is invalid."), 
								edu.umd.cs.findbugs.L10N.getLocalString("dlg.error_ttl", "Can't locate file"))) return;
					}
				}
				for (int i = 0; i < auxModel.getSize(); i++){
					File temp = new File((String)auxModel.get(i));
					if(!temp.exists() && directoryOrArchive.accept(temp)) { 
						if (!displayWarningAndAskIfWeShouldContinue(temp.getName()+" " + edu.umd.cs.findbugs.L10N.getLocalString("dlg.invalid_txt", " is invalid."), 
								edu.umd.cs.findbugs.L10N.getLocalString("dlg.error_ttl", "Can't locate file"))) return;
					}
				}
				Project p;
				boolean resetSettings;
				if (project==null)
				{
					p=new Project();
					resetSettings=true;
				}
				else
				{
					p=project;
					resetSettings=false;
				}
					//First clear p's old files, otherwise we can't remove a file once an analysis has been performed on it	
				int numOldFiles= p.getFileCount();
				for (int x=0; x< numOldFiles;x++)
					p.removeFile(0);	

				int numOldAuxFiles=p.getNumAuxClasspathEntries();
				for (int x=0; x< numOldAuxFiles;x++)
					p.removeAuxClasspathEntry(0);

				int numOldSrc=p.getNumSourceDirs();
				for (int x=0; x< numOldSrc;x++)
					p.removeSourceDir(0);

				//Now that p is cleared, we can add in all the correct files.
				for (int i = 0; i < analyzeModel.getSize(); i++)
					p.addFile((String) analyzeModel.get(i));
				for (int i = 0; i < auxModel.getSize(); i++)
					p.addAuxClasspathEntry((String) auxModel.get(i));
				for (int i = 0; i < sourceModel.getSize(); i++)
					p.addSourceDir((String) sourceModel.get(i));
				p.setProjectName(projectName.getText());
				if (keepGoing) {
					MainFrame.getInstance().setProject(p);
					List<String> possibleDirectories=p.getSourceDirList();
					MainFrame.getInstance().setSourceFinder(new SourceFinder());
					MainFrame.getInstance().getSourceFinder().setSourceBaseList(possibleDirectories);
				}
				else if (project == null || (projectChanged && JOptionPane.showConfirmDialog(NewProjectWizard.this, edu.umd.cs.findbugs.L10N.getLocalString("dlg.project_settings_changed_lbl", "Project settings have been changed.  Perform a new analysis with the changed files?"), edu.umd.cs.findbugs.L10N.getLocalString("dlg.redo_analysis_question_lbl", "Redo analysis?"), JOptionPane.YES_NO_OPTION) == JOptionPane.YES_OPTION))
					new AnalyzingDialog(p,resetSettings);

				if(reconfig == true)
					MainFrame.getInstance().setProjectChanged(true);

				String name = p.getProjectName();
				if(name == null){
					name = Project.UNNAMED_PROJECT;
					Debug.println("PROJECT NAME IS NULL!!");
				}
				MainFrame.getInstance().setTitle(MainFrame.TITLE_START_TXT + name);

				dispose();
			}
		});
		cancelButton.addActionListener(new ActionListener()
		{
			public void actionPerformed(ActionEvent evt)
			{
				dispose();
			}
		});

		JPanel south = new JPanel(new BorderLayout());
		south.add(new JSeparator(), BorderLayout.NORTH);
		south.add(buttons, BorderLayout.EAST);


		if (curProject != null)
		{
			for (String i : curProject.getFileList()) 
				analyzeModel.addElement(i);
			//If the project had no classes in it, disable the finish button until classes are added.
			if (curProject.getFileList().size()==0)
				this.finishButton.setEnabled(false);
			for (String i : curProject.getAuxClasspathEntryList())
				auxModel.addElement(i);
			for (String i : curProject.getSourceDirList())
				sourceModel.addElement(i);
			projectName.setText(curProject.getProjectName());
		}
		else
		{
			//If project is null, disable finish button until classes are added
			finishButton.setEnabled(false);
		}

		//loadPanel(0);
		loadAllPanels(mainPanel);
		add(mainPanel, BorderLayout.CENTER);
		add(south, BorderLayout.SOUTH);
		add(createTextFieldPanel("Project name (i.e., description)", projectName), 
				BorderLayout.NORTH);

		setDefaultCloseOperation(DISPOSE_ON_CLOSE);

//		pack();
		setModal(true);
		setVisible(true);
	}

	private JComponent createTextFieldPanel(String label, JTextField textField) {
		JPanel myPanel = new JPanel(new BorderLayout());

		myPanel.add(new JLabel(label), BorderLayout.NORTH);
		myPanel.add(textField, BorderLayout.CENTER);

		return myPanel;
	}
	/**
	 * @param label TODO
	 * 
	 */
	private JPanel createFilePanel(final String label, final JList list, 
			final DefaultListModel listModel, final int fileSelectionMode, final FileFilter filter) {
		JPanel myPanel = new JPanel(new GridBagLayout());
		GridBagConstraints gbc = new GridBagConstraints();
		gbc.gridx = 0;
		gbc.gridy = 0;
		gbc.gridheight = 1;
		gbc.gridwidth = 2;
		gbc.weightx = 1;
		gbc.weighty = 0;
		gbc.anchor = GridBagConstraints.WEST;
		myPanel.add(new JLabel(label), gbc);
		gbc.gridx = 0;
		gbc.gridy = 1;
		gbc.gridheight = 3;
		gbc.gridwidth = 1;
		gbc.weightx = 1;
		gbc.weighty = 1;
		gbc.fill = GridBagConstraints.BOTH;
		myPanel.add(new JScrollPane(list), gbc);
		list.setModel(listModel);
		gbc.gridx = 1;
		gbc.gridy = 1;
		gbc.gridheight = 1;
		gbc.gridwidth = 1;
		gbc.weightx = 0;
		gbc.weighty = 0;
		gbc.fill = GridBagConstraints.HORIZONTAL;
		final JButton addButton = new JButton(edu.umd.cs.findbugs.L10N.getLocalString("dlg.add_btn", "Add"));
		myPanel.add(addButton, gbc);
		gbc.gridx = 1;
		gbc.gridy = 2;
		gbc.insets = new Insets(5, 0, 0, 0);
		final JButton removeButton = new JButton(edu.umd.cs.findbugs.L10N.getLocalString("dlg.remove_btn", "Remove"));
		myPanel.add(removeButton, gbc);
		gbc.gridx = 1;
		gbc.gridy = 3;
		gbc.insets = new Insets(0, 0, 0, 0);
		myPanel.add(Box.createGlue(), gbc);
		myPanel.setBorder(border);
		addButton.addActionListener(new ActionListener()
		{
			public void actionPerformed(ActionEvent evt)
			{
				chooser.setFileSelectionMode(fileSelectionMode);
				chooser.setMultiSelectionEnabled(true);
				
				//Removes all the file filters currently in the chooser.
				for(FileFilter ff : chooser.getChoosableFileFilters()){
					chooser.removeChoosableFileFilter(ff);
				}
				
				chooser.setFileFilter(filter);
				
				if (chooser.showOpenDialog(NewProjectWizard.this) == JFileChooser.APPROVE_OPTION)
				{
					File[] selectedFiles = chooser.getSelectedFiles();
					for(File selectedFile : selectedFiles)
					{
						listModel.addElement(selectedFile.getAbsolutePath());	
					}
					projectChanged = true;
					// If this is the primary class directories add button, set it to enable the finish button of the main dialog
					if (label.equals(edu.umd.cs.findbugs.L10N.getLocalString("dlg.class_jars_dirs_lbl", "Class archives and directories to analyze:")))
						finishButton.setEnabled(true);
				}
			}
		});
		removeButton.addActionListener(new ActionListener()
		{
			public void actionPerformed(ActionEvent evt)
			{
				if (list.getSelectedValues().length > 0)
					projectChanged = true;
				for (Object i : list.getSelectedValues())
					listModel.removeElement(i);
				//If this is the primary class directories remove button, set it to disable finish when there are no class files being analyzed
				if (listModel.size()==0 && label.equals(edu.umd.cs.findbugs.L10N.getLocalString("dlg.class_jars_dirs_lbl", "Class archives and directories to analyze:")))
					finishButton.setEnabled(false);
			}
		});
		return myPanel;
	}
	/*
	private void loadPanel(final int index)
	{
		SwingUtilities.invokeLater(new Runnable()
		{
			public void run()
			{
				remove(wizardPanels[currentPanel]);
				currentPanel = index;
				add(wizardPanels[index], BorderLayout.CENTER);
				backButton.setEnabled(index > 0);
				nextButton.setEnabled(index < wizardPanels.length - 1);
				validate();
				repaint();
			}
		});
	}
	*/
	private void loadAllPanels(final JPanel mainPanel)
	{
		SwingUtilities.invokeLater(new Runnable()
		{
			public void run()
			{
				int numPanels = wizardComponents.length;
				for(int i=0; i<numPanels; i++)
					mainPanel.remove(wizardComponents[i]);
				for(int i=0; i<numPanels; i++)
					mainPanel.add(wizardComponents[i]);
				validate();
				repaint();
			}
		});
	}

	@Override
	public void addNotify(){
		super.addNotify();

		for(JComponent component : wizardComponents){
			setFontSizeHelper(component.getComponents(), Driver.getFontSize());
		}

		pack();

		int width = super.getWidth();

		if(width < 600)
			width = 600;
		setSize(new Dimension(width, 500));
		setLocationRelativeTo(MainFrame.getInstance());
	}
}