SyncEventHandlerAdapterWithProgressMonitor.java

/**
 * This file Copyright (c) 2005-2010 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain Eclipse Public Licensed code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.syncing.ui.handlers;

import java.util.HashMap;
import java.util.Map;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;

import com.aptana.ide.core.FileUtils;
import com.aptana.ide.core.io.IConnectionPoint;
import com.aptana.ide.core.io.syncing.VirtualFileSyncPair;

/**
 * @author Max Stepanov (mstepanov@aptana.com)
 *
 */
public class SyncEventHandlerAdapterWithProgressMonitor extends SyncEventHandlerAdapter {

	private static final int TRANSFER_SCALE = 1024;
	private static final int PATH_DISPLAY_CHARACTERS = 40;
	
	private IProgressMonitor monitor;
	private Map<VirtualFileSyncPair, SubProgressMonitor> itemsProgress = new HashMap<VirtualFileSyncPair, SubProgressMonitor>();
	private Map<VirtualFileSyncPair, Long> itemsTransfer = new HashMap<VirtualFileSyncPair, Long>();
	
	/**
	 * 
	 */
	public SyncEventHandlerAdapterWithProgressMonitor(IProgressMonitor monitor) {
		this.monitor = monitor != null ? monitor : new NullProgressMonitor();
	}

	/* (non-Javadoc)
	 * @see com.aptana.ide.core.io.sync.SyncEventHandlerAdapter#getFilesEvent(com.aptana.ide.core.io.IVirtualFileManager, java.lang.String)
	 */
	@Override
	public boolean getFilesEvent(IConnectionPoint manager, String path) {
		monitor.subTask(FileUtils.compressPath(path, PATH_DISPLAY_CHARACTERS));
		return !monitor.isCanceled() && super.getFilesEvent(manager, path);
	}

	/* (non-Javadoc)
	 * @see com.aptana.ide.core.io.sync.SyncEventHandlerAdapter#syncContinue()
	 */
	@Override
	public boolean syncContinue() {
		return !monitor.isCanceled() && super.syncContinue();
	}

	/* (non-Javadoc)
	 * @see com.aptana.ide.core.io.sync.SyncEventHandlerAdapter#syncDone(com.aptana.ide.core.io.sync.VirtualFileSyncPair)
	 */
	@Override
	public void syncDone(VirtualFileSyncPair item) {
		SubProgressMonitor itemProgressMonitor = itemsProgress.get(item);
		if (itemProgressMonitor != null) {
			itemProgressMonitor.done();
			itemsProgress.remove(item);
			itemsTransfer.remove(item);
		}
		super.syncDone(item);
	}

	/* (non-Javadoc)
	 * @see com.aptana.ide.core.io.sync.SyncEventHandlerAdapter#syncErrorEvent(com.aptana.ide.core.io.sync.VirtualFileSyncPair, java.lang.Exception)
	 */
	@Override
	public boolean syncErrorEvent(VirtualFileSyncPair item, Exception e) {
		SubProgressMonitor itemProgressMonitor = itemsProgress.get(item);
		if (itemProgressMonitor != null) {
			itemProgressMonitor.done();
			itemsProgress.remove(item);
			itemsTransfer.remove(item);
		}
		return !monitor.isCanceled() && super.syncErrorEvent(item, e);
	}

	/* (non-Javadoc)
	 * @see com.aptana.ide.core.io.sync.SyncEventHandlerAdapter#syncEvent(com.aptana.ide.core.io.sync.VirtualFileSyncPair, int, int)
	 */
	@Override
	public boolean syncEvent(VirtualFileSyncPair item, int index, int totalItems) {
		SubProgressMonitor itemProgressMonitor = itemsProgress.get(item);
		if (itemProgressMonitor == null && item != null) {
			itemProgressMonitor = new SubProgressMonitor(monitor, 1);
			itemsProgress.put(item, itemProgressMonitor);
			itemsTransfer.put(item, Long.valueOf(0));
			monitor.subTask(FileUtils.compressPath(item.getRelativePath(), PATH_DISPLAY_CHARACTERS));
			itemProgressMonitor.beginTask(item.getRelativePath(), getItemProgressAmount(item));
		}
		return !monitor.isCanceled() && super.syncEvent(item, index, totalItems);
	}

	/* (non-Javadoc)
	 * @see com.aptana.ide.core.io.sync.SyncEventHandlerAdapter#syncTransferring(com.aptana.ide.core.io.sync.VirtualFileSyncPair, long)
	 */
	@Override
	public void syncTransferring(VirtualFileSyncPair item, long bytes) {
		SubProgressMonitor itemProgressMonitor = itemsProgress.get(item);
		if (itemProgressMonitor != null) {
			long delta = bytes - ((Long) itemsTransfer.get(item));
			itemsTransfer.put(item, Long.valueOf(bytes));
			itemProgressMonitor.worked((int) (delta/TRANSFER_SCALE));
		}
		super.syncTransferring(item, bytes);
	}
	
	private static int getItemProgressAmount(VirtualFileSyncPair item) {
		switch (item.getSyncDirection()) {
		case VirtualFileSyncPair.Direction_ClientToServer:
			return (int) (item.getSourceFile().fetchInfo().getLength()/TRANSFER_SCALE);
		case VirtualFileSyncPair.Direction_ServerToClient:
			return (int) (item.getDestinationFile().fetchInfo().getLength()/TRANSFER_SCALE);
		}
		return 1;
	}

}