org.eclipse.emf.emfstore.client.ui/src/org/eclipse/emf/emfstore/client/ui/commands/UpdateProjectVersionHandler.java

/*******************************************************************************
 * Copyright (c) 2008-2011 Chair for Applied Software Engineering,
 * Technische Universitaet Muenchen.
 * 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:
 ******************************************************************************/
package org.eclipse.emf.emfstore.client.ui.commands;

import java.util.List;

import org.eclipse.emf.emfstore.client.model.ProjectSpace;
import org.eclipse.emf.emfstore.client.model.Usersession;
import org.eclipse.emf.emfstore.client.model.WorkspaceManager;
import org.eclipse.emf.emfstore.client.model.exceptions.ChangeConflictException;
import org.eclipse.emf.emfstore.client.model.exceptions.NoChangesOnServerException;
import org.eclipse.emf.emfstore.client.model.observers.UpdateObserver;
import org.eclipse.emf.emfstore.client.model.util.WorkspaceUtil;
import org.eclipse.emf.emfstore.client.ui.dialogs.UpdateDialog;
import org.eclipse.emf.emfstore.server.exceptions.EmfStoreException;
import org.eclipse.emf.emfstore.server.model.versioning.ChangePackage;
import org.eclipse.emf.emfstore.server.model.versioning.PrimaryVersionSpec;
import org.eclipse.emf.emfstore.server.model.versioning.VersioningFactory;
import org.eclipse.jface.dialogs.InputDialog;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.PlatformUI;

/**
 * This handlers updates the Project to a user-defined version. It is only intended to be used by admins as no
 * validation checks are made on the version number.
 * 
 * @author Shterev
 */
public class UpdateProjectVersionHandler extends ServerRequestCommandHandler implements UpdateObserver {

	private Usersession usersession;

	/**
	 * Default constructor.
	 */
	public UpdateProjectVersionHandler() {
		setTaskTitle("Update project...");
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected Object run() throws EmfStoreException {
		ProjectSpace projectSpace = getProjectSpace();
		if (projectSpace == null) {
			ProjectSpace activeProjectSpace = WorkspaceManager.getInstance().getCurrentWorkspace()
				.getActiveProjectSpace();
			if (activeProjectSpace == null) {
				MessageDialog.openInformation(getShell(), "Information", "You must select the Project");
				return null;
			}
			projectSpace = activeProjectSpace;
		}

		update(projectSpace);

		return null;
	}

	/**
	 * Updates the project space.
	 * 
	 * @param projectSpace the target project space
	 * @throws EmfStoreException if any.
	 */
	public void update(final ProjectSpace projectSpace) throws EmfStoreException {
		usersession = projectSpace.getUsersession();
		if (usersession == null) {
			MessageDialog.openInformation(getShell(), null,
				"This project is not yet shared with a server, you cannot update.");
			return;
		}

		InputDialog inputDialog = new InputDialog(getShell(), "Update to version...", "Enter the new version:", "",
			null);
		if (inputDialog.open() != Window.OK) {
			return;
		}
		int version = 0;
		try {
			version = Integer.parseInt(inputDialog.getValue());
		} catch (NumberFormatException e) {
			MessageDialog.openError(getShell(), "Invalid input", "A numerical value was expected!");
			update(projectSpace);
		}

		PrimaryVersionSpec targetVersionSpec = VersioningFactory.eINSTANCE.createPrimaryVersionSpec();
		targetVersionSpec.setIdentifier(version);

		update(projectSpace, targetVersionSpec);
	}

	/**
	 * Updates the project space to a certain version.
	 * 
	 * @param projectSpace the target project space
	 * @param targetVersionSpec the target version of the project space
	 * @throws EmfStoreException if any.
	 */
	public void update(final ProjectSpace projectSpace, PrimaryVersionSpec targetVersionSpec) throws EmfStoreException {
		PrimaryVersionSpec baseVersion = projectSpace.getBaseVersion();

		try {
			PrimaryVersionSpec targetVersion = projectSpace.update(targetVersionSpec, UpdateProjectVersionHandler.this);
			WorkspaceUtil.logUpdate(projectSpace, baseVersion, targetVersion);

			// explicitly refresh the decorator since no simple attribute has
			// been changed
			// (as opposed to committing where the dirty property is being set)
			Display.getDefault().asyncExec(new Runnable() {
				public void run() {
					PlatformUI.getWorkbench().getDecoratorManager()
						.update("org.eclipse.emf.emfstore.client.ui.decorators.VersionDecorator");
				}
			});
		} catch (ChangeConflictException e1) {
			handleChangeConflictException(e1);
		} catch (NoChangesOnServerException e) {
			MessageDialog.openInformation(getShell(), "No need to update",
				"Your project is up to date, you do not need to update.");
		}
	}

	private void handleChangeConflictException(ChangeConflictException e1) {
		MessageDialog.openError(Display.getCurrent().getActiveShell(), "Ooops!",
			"This feature is not implemented yet! We are sorry for the inconvenience.");
	}

	/**
	 * {@inheritDoc}
	 */
	public boolean inspectChanges(ProjectSpace projectSpace, List<ChangePackage> changePackages) {
		UpdateDialog updateDialog = new UpdateDialog(getShell(), projectSpace, changePackages);
		int returnCode = updateDialog.open();
		if (returnCode == Window.OK) {
			return true;
		}
		return false;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.emf.emfstore.client.model.observers.UpdateObserver#updateCompleted()
	 */
	public void updateCompleted(ProjectSpace projectSpace) {
	}
}