/*
    * This file is a part of CAST project.
    * (c) Copyright 2007, AGH University of Science & Technology
    * https://caribou.iisg.agh.edu.pl/trac/cast
    *
    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
    * You may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * http://www.eclipse.org/legal/epl-v10.html
   */
  /*
   * File: ProjectUtil.java
   * Created: 2007-00-00
   * Author: awos, tmilos
   * $Id: ProjectUtil.java 3406 2009-09-30 15:05:28Z tmilos $
   */
  
  package pl.edu.agh.cast.project;
  
  import java.beans.PropertyChangeEvent;
  import java.beans.PropertyChangeListener;
  import java.io.ByteArrayInputStream;
  import java.io.File;
  import java.io.FileInputStream;
  import java.io.FileNotFoundException;
  
  import org.apache.log4j.Logger;
  import org.eclipse.core.resources.IFile;
  import org.eclipse.core.resources.IProject;
  import org.eclipse.core.resources.IProjectDescription;
  import org.eclipse.core.resources.IWorkspace;
  import org.eclipse.core.resources.ProjectScope;
  import org.eclipse.core.resources.ResourcesPlugin;
  import org.eclipse.core.runtime.CoreException;
  import org.eclipse.core.runtime.IPath;
  import org.eclipse.core.runtime.Path;
  import org.eclipse.core.runtime.Platform;
  import org.eclipse.core.runtime.preferences.IEclipsePreferences;
  import org.eclipse.osgi.util.NLS;
  import org.eclipse.swt.SWT;
  import org.eclipse.swt.widgets.Display;
  import org.eclipse.ui.PlatformUI;
  import org.osgi.service.prefs.BackingStoreException;
  
  import pl.edu.agh.cast.Activator;
  import pl.edu.agh.cast.CastApplication;
  import pl.edu.agh.cast.CoreServiceLocator;
  import pl.edu.agh.cast.data.persistence.IPersistenceProvider;
  import pl.edu.agh.cast.data.persistence.PersistenceException;
  import pl.edu.agh.cast.data.persistence.PersistenceProviderLocator;
  import pl.edu.agh.cast.ui.dialogs.ProjectStartupDialog;
  import pl.edu.agh.cast.ui.util.MsgBoxHelper;
  import pl.edu.agh.cast.util.Configuration;
  import pl.edu.agh.cast.util.Messages;
  
  /**
   * Utility methods for operating on projects.
   *
   * @author AGH CAST Team
   */
  public final class ProjectUtil implements PropertyChangeListener {
  
  	private static final Logger LOG = Activator.getLogger();
  
  	// BEGIN Constants
  
  	public static final String PROJECT_VERSION = "0.5.x"; //$NON-NLS-1$
  
  	/**
  	 * List of characters that cannot be used in a project name.
  	 */
  	@SuppressWarnings("nls")
  	public static final String[] PROJECT_BAD_CHARS = new String[] { "\\", "/", ":", "*", "?", "<", ">", "|", ",", "." };
  
  	/**
  	 * Project display name property used.
  	 */
  	public static final String PROJECT_DISPLAY_NAME_PROPERTY = "project.displayName"; //$NON-NLS-1$
  
  	/**
  	 * Project version property.
  	 */
  	public static final String PROJECT_VERSION_PROPERTY = "project.version"; //$NON-NLS-1$
  
  	/**
  	 * Project id property.
  	 */
  	public static final String PROJECT_ID_PROPERTY = "project.id"; //$NON-NLS-1$
  
  	/**
  	 * Project persistence provider id property.
  	 */
  	public static final String PERSISTENCE_PROVIDER_ID_PROPERTY = "persistence.id"; //$NON-NLS-1$
  
  	/**
  	 * Project persistence provider config/store file property.
  	 */
  	public static final String PERSISTENCE_PROVIDER_CONFIG_PROPERTY = "persistence.file"; //$NON-NLS-1$
  
 	// END Constants
 
 	/**
 	 * Enumeration of open project result statuses.
 	 *
 	 * @author AGH CAST Team
 	 */
 	public static enum ProjectOpenStatus {
 		OPENED, LOCKED, INVALID_VERSION;
 	}
 
 	// BEGIN Property Access
 
 	/**
 	 * Reads projects properties using Eclipse Preferences mechanism.
 	 *
 	 * @param project
 	 *            project which properties are read
 	 * @param propertyId
 	 *            id of property to read
 	 * @return property with given id found for specified project
 	 */
 	public static String getProperty(IProject project, String propertyId) {
 		ProjectScope ps = new ProjectScope(project);
 		return ps.getNode(Activator.PLUGIN_ID).get(propertyId, null);
 	}
 
 	/**
 	 * Sets property for given project.
 	 *
 	 * @param project
 	 *            project which property is to be set
 	 * @param propertyId
 	 *            property id
 	 * @param value
 	 *            new value of property
 	 */
 	public static void setProperty(IProject project, String propertyId, String value) {
 		ProjectScope ps = new ProjectScope(project);
 		IEclipsePreferences node = ps.getNode(Activator.PLUGIN_ID);
 		node.put(propertyId, value);
 		try {
 			node.flush();
 		} catch (BackingStoreException e) {
 			Logger.getLogger(ProjectUtil.class).error("Failed to save property " + propertyId, e); //$NON-NLS-1$
 		}
 	}
 
 	// END Property Access
 
 	// BEGIN Singleton
 
 	/**
 	 * Single instance holder.
 	 *
 	 * @author AGH CAST Team
 	 */
 	private static class ProjectUtilHolder {
 		private static final ProjectUtil INSTANCE = new ProjectUtil();
 	}
 
 	/**
 	 * Private constructor.
 	 */
 	private ProjectUtil() {
 		if (CastApplication.getPropertyChangeProvider() != null) {
 			CastApplication.getPropertyChangeProvider().addPropertyChangeListener(this);
 		}
 	}
 
 	/**
 	 * Returns single, shared instance of {@link ProjectUtil}.
 	 *
 	 * @return single, shared instance of {@link ProjectUtil}
 	 */
 	public static ProjectUtil getInstance() {
 		return ProjectUtilHolder.INSTANCE;
 	}
 
 	// END Singleton
 
 	// BEGIN Project Name Methods
 
 	/**
 	 * Returns project's display name.
 	 *
 	 * @param project
 	 *            the project
 	 * @return project's display name
 	 */
 	public String getDisplayName(IProject project) {
 		String displayName = getProperty(project, PROJECT_DISPLAY_NAME_PROPERTY);
 		return displayName != null && displayName.length() > 0 ? displayName : project.getName();
 	}
 
 	/**
 	 * Sets project's display name.
 	 *
 	 * @param project
 	 *            the project
 	 * @param name
 	 *            project's display name
 	 */
 	public void setDisplayName(final IProject project, final String name) {
 		UserPreferences.getInstance().changeMostRecentlyProjectName(project, name);
 		setProperty(project, PROJECT_DISPLAY_NAME_PROPERTY, name);
 	}
 
 	/**
 	 * Escapes non-standard characters in project's name.
 	 *
 	 * @param name
 	 *            name to escape
 	 * @return escaped name
 	 */
 	public String escapeName(String name) {
 		String r = name.replaceAll("[\\\\//?:]", "_"); //$NON-NLS-1$ //$NON-NLS-2$
 		String s = new File(r).toURI().getPath();
 		if (s.lastIndexOf('/') == s.length() - 1) {
 			s = s.substring(0, s.length() - 1);
 		}
 		s = s.substring(s.lastIndexOf('/') + 1);
 		return s;
 	}
 
 	// END Project Name Methods
 
 	// BEGIN Project Management
 
 	/**
 	 * Create project of specified name if it does not exists.
 	 *
 	 * @param projectName
 	 *            name of the project
 	 * @param location
 	 *            location of the project
 	 * @return new instance of a project
 	 * @throws CoreException
 	 */
 	public IProject createProject(String projectName, IPath location) throws CoreException {
 
 		IWorkspace workspace = ResourcesPlugin.getWorkspace();
 		IProjectDescription pd = workspace.newProjectDescription(projectName);
 		if (Platform.getLocation() != null && location != null && !Platform.getLocation().isPrefixOf(location)) {
 			pd.setLocation(location);
 		} else {
 			pd.setLocation(null);
 		}
 
 		IProject project = workspace.getRoot().getProject(projectName);
 
 		if (!project.exists()) {
 			project.create(pd, null); // <-
 			project.open(null); // <-
 			// set cast project name
 			if (getProperty(project, PROJECT_DISPLAY_NAME_PROPERTY) == null) {
 				setDisplayName(project, projectName);
 			}
 			if (getProperty(project, PROJECT_ID_PROPERTY) == null) {
 				setProperty(project, PROJECT_ID_PROPERTY, generateProjectId());
 			}
 			// create dummy file
 			String dummyFileName = projectName + "." + Configuration.DUMMY_PROJECT_FILE_EXTENSION; //$NON-NLS-1$
 			IFile dummyFile = project.getFile(dummyFileName);
 			dummyFile.create(new ByteArrayInputStream(new byte[0]), true, null); // <-
 
 			init(project); // <-
 		}
 		if (!project.isOpen()) {
 			project.open(null);
 		}
 
 		return project;
 	}
 
 	/**
 	 * Initializes the new project.
 	 *
 	 * @param project
 	 *            the new project
 	 * @throws CoreException
 	 */
 	public void init(IProject project) throws CoreException {
 		String id = getProperty(project, ProjectUtil.PROJECT_ID_PROPERTY);
 		if (id == null) {
 			id = generateProjectId();
 			setProperty(project, ProjectUtil.PROJECT_ID_PROPERTY, id);
 		}
 
 		setProperty(project, PROJECT_VERSION_PROPERTY, PROJECT_VERSION);
 
 		String providerId = getProperty(project, PERSISTENCE_PROVIDER_ID_PROPERTY);
 		if (providerId == null) {
 			providerId = PersistenceProviderLocator.selectPersistenceProvider();
 			setProperty(project, PERSISTENCE_PROVIDER_ID_PROPERTY, providerId);
 		}
 
 		String providerFile = getProperty(project, PERSISTENCE_PROVIDER_CONFIG_PROPERTY);
 		if (providerFile == null) {
 			providerFile = PersistenceProviderLocator.getPersistenceFilePath(providerId);
 			setProperty(project, PERSISTENCE_PROVIDER_CONFIG_PROPERTY, providerFile);
 		}
 		IFile file = project.getFile(providerFile);
 		if (!file.exists()) {
 			file.create(new ByteArrayInputStream(new byte[0]), true, null);
 		}
 	}
 
 	/**
 	 * Create project of specified name if it does not exists and activates created project.
 	 *
 	 * @param projectName
 	 *            name of the project
 	 * @param location
 	 *            location of the project
 	 * @return new instance of an activated project
 	 * @throws CoreException
 	 */
 	public IProject createAndActivateProject(String projectName, IPath location) throws CoreException {
 		IProject project = createProject(projectName, location);
 
 		CastApplication.setActiveProject(project);
 		initializePersistenceProvider(project);
 		return project;
 	}
 
 	/**
 	 * Opens existing project from specified directory.
 	 *
 	 * @param location
 	 *            project location which contains <code>.project</code> description file
 	 * @param force
 	 *            if true opens project with the same name which exists in the workspace
 	 * @return <b>true</b> if specified project has been opened; <b>false</b> otherwise: if the specified project exists
 	 *         already in the workspace and force flag has been set to false
 	 * @throws FileNotFoundException
 	 *             if project description file (<code>.project</code>) is not found in specified location
 	 * @throws CoreException
 	 *             if loading description failed. Reasons include:
 	 *             <ul>
 	 *             <li>The stream could not be read.</li>
 	 *             <li>The stream does not contain a legal project description.</li>
 	 *             </ul>
 	 *
 	 */
 	public ProjectOpenStatus openProject(String location, boolean force) throws FileNotFoundException, CoreException {
 		ProjectOpenStatus res = ProjectOpenStatus.OPENED;
 		IWorkspace workspace = ResourcesPlugin.getWorkspace();
 		// check if description file exists
 		IProjectDescription projectDescription = workspace.loadProjectDescription(new FileInputStream(location
 		        + File.separator + IProjectDescription.DESCRIPTION_FILE_NAME));
 
 		if (!Platform.getLocation().isPrefixOf(Path.fromOSString(location))) {
 			projectDescription.setLocation(Path.fromOSString(location));
 		}
 
 		// check if project exists already in workspace
 		IProject project = workspace.getRoot().getProject(projectDescription.getName());
 
 		if (project.exists()) {
 			if (!force) {
 				// fail if project exists in the workplace (i.e. it is locked)
 				res = ProjectOpenStatus.LOCKED;
 			} else {
 				// remove locked project, reopen new project
 				project.delete(false, false, null);
 				project.create(projectDescription, null);
 				res = ProjectOpenStatus.OPENED;
 			}
 		} else {
 			project.create(projectDescription, null);
 			res = ProjectOpenStatus.OPENED;
 		}
 
 		if (res == ProjectOpenStatus.OPENED) {
 			project.open(null);
 			if (!PROJECT_VERSION.equals(getProperty(project, PROJECT_VERSION_PROPERTY))) {
 				project.close(null);
 				project.delete(false, false, null);
 				return ProjectOpenStatus.INVALID_VERSION;
 			}
 			CastApplication.setActiveProject(project);
 			initializePersistenceProvider(project);
 		}
 
 		return res;
 
 	}
 
 	/**
 	 * Removes project from workspace and adds project pointed to by newLocation. Project name is taken from project
 	 * description stored in newLocation.
 	 *
 	 * @param newLocation
 	 *            new project location
 	 * @return moved project
 	 */
 	public IProject changeProjectLocation(String newLocation) {
 		IWorkspace workspace = ResourcesPlugin.getWorkspace();
 		try {
 			// check if description file exists
 			IProjectDescription projectDescription = workspace.loadProjectDescription(new FileInputStream(newLocation
 			        + File.separator + IProjectDescription.DESCRIPTION_FILE_NAME));
 
 			IProject project = workspace.getRoot().getProject(projectDescription.getName());
 
 			if (!Platform.getLocation().isPrefixOf(Path.fromOSString(newLocation))) {
 				projectDescription.setLocation(Path.fromOSString(newLocation));
 			}
 			project.delete(false, false, null);
 			project.create(projectDescription, null);
 			LOG.info("Project " + projectDescription.getName() + " moved to " //$NON-NLS-1$ //$NON-NLS-2$
 			        + newLocation);
 			return project;
 		} catch (FileNotFoundException e) {
 			e.printStackTrace();
 		} catch (CoreException e) {
 			e.printStackTrace();
 		}
 		return null;
 	}
 
 	/**
 	 * Create unique identifier for the project.
 	 *
 	 * @return unique project identifier
 	 */
 	public String generateProjectId() {
 		return "CAST_project_" + //$NON-NLS-1$
 		        System.currentTimeMillis();
 	}
 
 	/**
 	 * Tries to open a project described by {@link MostRecentlyUsedProject}.
 	 *
 	 * @param mrup
 	 *            project to open
 	 * @return true if project was correctly opened, or if the operation was cancelled by the user when closing
 	 *         currently opened editors
 	 */
 	public boolean tryOpenRecentProject(MostRecentlyUsedProject mrup) {
 		ProjectOpenStatus res = ProjectOpenStatus.OPENED;
 		boolean foundSomewhere = false;
 
 		if (!ProjectUtil.getInstance().closeProject(CastApplication.getActiveProject())) {
 			return true;
 		}
 
 		for (IPath path : mrup.getLocations()) {
 			try {
 				res = ProjectUtil.getInstance().openProject(path.toOSString(), false);
 				switch (res) {
 					case LOCKED: {
 						/*
 						 * openProject returns false but doesn't throw - project can be opened, but exists in current
 						 * workspace
 						 */
 						foundSomewhere = true;
 						if (ProjectUtil.getInstance().handleExistingProjectAction(path.toOSString())) {
 							res = ProjectOpenStatus.OPENED;
 							break;
 						}
 						break;
 					}
 				}
 			} catch (FileNotFoundException e) {
 				LOG.warn("Failed to open project in location " //$NON-NLS-1$
 				        + path.toOSString(), e);
 			} catch (CoreException e) {
 				LOG.warn("Failed to open project " + path.toOSString(), e); //$NON-NLS-1$
 			}
 		}
 		if (res != ProjectOpenStatus.OPENED) {
 			int rett = SWT.NO;
 			if (res == ProjectOpenStatus.LOCKED && !foundSomewhere) {
 				rett = MsgBoxHelper.showWarningQuestionBox(Display.getCurrent().getActiveShell(),
 				        Messages.ProjectStartupDialog_9, NLS.bind(Messages.ProjectStartupDialog_10, mrup.getName()));
 			} else if (res == ProjectOpenStatus.INVALID_VERSION) {
 				rett = MsgBoxHelper.showWarningQuestionBox(Display.getCurrent().getActiveShell(),
 				        Messages.ProjectUtil_WrongVersionTitle, NLS.bind(Messages.ProjectUtil_WrongVersionMRUMessage,
 				                mrup.getName(), PROJECT_VERSION));
 			}
 			if (rett == SWT.YES) {
 				UserPreferences.getInstance().removeMRUProject(mrup.getName());
 			}
 		}
 
 		return res == ProjectOpenStatus.OPENED;
 	}
 
 	/**
 	 * Closes a project, closing all editors as well. Asks the user for confirmation to save dirty editors.
 	 *
 	 * @param project
 	 *            project to close
 	 * @return true if all editors were closed
 	 */
 	public boolean closeProject(IProject project) {
 		if (project != null) {
 			// give the user a chance to save dirty editors
 			if (PlatformUI.getWorkbench().getActiveWorkbenchWindow() != null) {
 				if (!PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().closeAllEditors(true)) {
 					return false;
 				}
 			}
 			try {
 				project.close(null);
 				project.delete(false, false, null);
 				destroyPersistenceProvider();
 			} catch (CoreException e) {
 				LOG.error("Failed to close project", e); //$NON-NLS-1$
 			}
 		}
 		return true;
 	}
 
 	public void removeProject(String projectName, IPath location) throws CoreException {
 		IWorkspace workspace = ResourcesPlugin.getWorkspace();
 		IProjectDescription pd = workspace.newProjectDescription(projectName);
 		if (Platform.getLocation() != null && location != null && !Platform.getLocation().isPrefixOf(location)) {
 			pd.setLocation(location);
 		} else {
 			pd.setLocation(null);
 		}
 
 		IProject project = workspace.getRoot().getProject(projectName);
 
 		project.delete(true, null);
 	}
 
 	// END Project Management
 
 	// BEGIN Project Handlers
 
 	/**
 	 * Handles a situation when a project is already opened by another application.
 	 *
 	 * @param location
 	 *            location of the project
 	 * @return <code>true</code> if the project was successfully opened
 	 */
 	public boolean handleExistingProjectAction(String location) {
 		int res = MsgBoxHelper.showQuestionBox(CastApplication.getActiveShell(),
 		        Messages.ApplicationWorkbenchAdvisor_7, NLS.bind(Messages.ApplicationWorkbenchAdvisor_8, location));
 		if (res == SWT.YES) {
 			IProject project = changeProjectLocation(location);
 			if (project != null) {
 				try {
 					project.open(null);
 					CastApplication.setActiveProject(project);
 					initializePersistenceProvider(project);
 					return true;
 				} catch (CoreException e) {
 					LOG.error("Failed to open locked project", e); //$NON-NLS-1$
 				}
 
 			}
 		}
 		return false;
 	}
 
 	/**
 	 * Handles a situation when no project was selected to be opened. In such case the MRU project is opened, and if
 	 * that fails, the {@link ProjectStartupDialog} is shown.
 	 */
 	public void handleNoProjectAction() {
 		CastApplication.setActiveProject(null);
 		if (Boolean.toString(false).equals(
 		        UserPreferences.getInstance().getPreference(UserPreferences.Pref.SHOW_PROJECT_STARTUP_DIALOG))) {
 			// open most recent project
 			MostRecentlyUsedProject mruProject = UserPreferences.getInstance().getMostRecentlyUsedProjects().get(0);
 			tryOpenRecentProject(mruProject);
 		} else {
 			// show startup dialog
 			ProjectStartupDialog projectStartupDialog = new ProjectStartupDialog(CastApplication.getActiveShell(),
 			        SWT.APPLICATION_MODAL);
 			projectStartupDialog.open();
 		}
 	}
 
 	/**
 	 * Handles a situation when invalid project location is given.
 	 *
 	 * @param location
 	 *            given project location
 	 */
 	public void handleWrongProjectLocationAction(String location) {
 		MsgBoxHelper.showWarningBox(CastApplication.getActiveShell(), Messages.ApplicationWorkbenchAdvisor_3, NLS.bind(
 		        Messages.ApplicationWorkbenchAdvisor_4, location));
 		CastApplication.setActiveProject(null);
 
 	}
 
 	/**
 	 * Handles a situation when invalid project is given.
 	 */
 	public void handleInvalidProjectAction() {
 		MsgBoxHelper.showWarningBox(CastApplication.getActiveShell(), Messages.ProjectUtil_WrongVersionTitle, NLS.bind(
 		        Messages.ProjectUtil_WrongVersionMessage, PROJECT_VERSION));
 		CastApplication.setActiveProject(null);
 	}
 
 	/**
 	 * Handles a situation when project location does not contain <code>.project</code>file.
 	 *
 	 * @param location
 	 *            project location
 	 */
 	public void handleMissingProjectFile(String location) {
 		MsgBoxHelper.showWarningBox(CastApplication.getActiveShell(), Messages.ApplicationWorkbenchAdvisor_3, NLS.bind(
 		        Messages.ApplicationWorkbenchAdvisor_9, location));
 		CastApplication.setActiveProject(null);
 
 	}
 
 	/**
 	 * Handles a situation when invalid project is given.
 	 */
 	public void handlePersistenceProviderInitializationError(IProject project) {
 		MsgBoxHelper.showWarningBox(CastApplication.getActiveShell(), Messages.ProjectUtil_InitializationErrorTitle,
 		        NLS.bind(Messages.ProjectUtil_InitializationErrorMessage_Persistence, project.getName()));
 		CastApplication.setActiveProject(null);
 	}
 
 	// END Project Handlers
 
 	/**
 	 * Property change notification.
 	 *
 	 * {@inheritDoc}
 	 *
 	 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
 	 */
 	public void propertyChange(PropertyChangeEvent evt) {
 		if (CastApplication.PROPERTY_ACTIVE_PROJECT.equals(evt.getPropertyName())) {
 			if (evt.getNewValue() != null) {
 				UserPreferences.getInstance().registerMostRecentlyUsedProject((IProject)evt.getNewValue());
 			}
 		}
 	}
 
 	// BEGIN Persistence Provider
 
 	/**
 	 * Initializes persistence provider for given project.
 	 *
 	 * @param project
 	 *            the project
 	 */
 	@SuppressWarnings("nls")
 	public void initializePersistenceProvider(IProject project) {
 		String providerId = getProperty(project, PERSISTENCE_PROVIDER_ID_PROPERTY);
 		String providerConfig = getProperty(project, PERSISTENCE_PROVIDER_CONFIG_PROPERTY);
 		IFile configFile = project.getFile(providerConfig);
 		try {
 			IPersistenceProvider provider = PersistenceProviderLocator.createPersistenceProvider(providerId, configFile
 			        .getLocation().toOSString());
 			CoreServiceLocator.getPersistenceProvider().setActualProvider(provider);
 		} catch (PersistenceException e) {
 			LOG.error(String.format("Failed to initialize persistence provider for project '{0}' ({1}). "
 			        + "\r\nProviderId={2}\r\n persistence file:{3}", project.getName(), project.getLocation()
 			        .toOSString(), providerId, providerConfig), e);
 			handlePersistenceProviderInitializationError(project);
 		}
 	}
 
 	/**
 	 * Destroys persistence provider for active project.
 	 */
 	public void destroyPersistenceProvider() {
 		CoreServiceLocator.getPersistenceProvider().setActualProvider(null);
 	}
 
 	// END Persistence Provider
 
 }