core/plugins/org.eclipse.hawk.localfolder/src/org/eclipse/hawk/localfolder/FileBasedLocation.java

/*******************************************************************************
 * Copyright (c) 2018-2020 Aston University.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License, v. 2.0 are satisfied: GNU General Public License, version 3.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-3.0
 *
 * Contributors:
 *     Antonio Garcia-Dominguez - initial API and implementation
 ******************************************************************************/
package org.eclipse.hawk.localfolder;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.security.DigestInputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.eclipse.hawk.core.IConsole;
import org.eclipse.hawk.core.ICredentialsStore;
import org.eclipse.hawk.core.IVcsManager;
import org.eclipse.hawk.core.VcsCommitItem;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public abstract class FileBasedLocation implements IVcsManager {

	private static final Logger LOGGER = LoggerFactory.getLogger(LocalFolder.class);

	protected static final String FIRST_REV = "0";

	protected IConsole console;
	protected String repositoryURL;
	private boolean isFrozen = false;

	@Override
	public String getLocation() {
		return repositoryURL;
	}

	@Override
	public void setCredentials(String username, String password, ICredentialsStore credStore) {
		// ignore
	}

	protected String makeRelative(String base, String extension) {
		if (!extension.startsWith(base)) {
			return extension;
		}
		return extension.substring(base.length());
	}

	@Override
	public boolean isAuthSupported() {
		return false;
	}

	@Override
	public boolean isPathLocationAccepted() {
		return true;
	}

	@Override
	public boolean isURLLocationAccepted() {
		return true;
	}

	@Override
	public String getRepositoryPath(String rawPath) {
		final String emfUriPrefix = getLocation().replaceFirst("file:///", "file:/");
		if (rawPath.startsWith(emfUriPrefix)) {
			return rawPath.substring(emfUriPrefix.length());
		}
		return rawPath;
	}

	@Override
	public String getUsername() {
		return null;
	}

	@Override
	public String getPassword() {
		return null;
	}

	@Override
	public boolean isFrozen() {
		return isFrozen;
	}

	@Override
	public void setFrozen(boolean f) {
		isFrozen = f;
	}

	@Override
	public String getFirstRevision() throws Exception {
		return FIRST_REV;
	}

	@Override
	public String getCurrentRevision() {
		return getCurrentRevision(false);
	}

	protected abstract String getCurrentRevision(boolean alter);

	@Override
	public void run() {
		/* nothing */
	}

	@Override
	public List<VcsCommitItem> getDelta(String startRevision) throws Exception {
		return getDelta(startRevision, "HEAD").getCompactedCommitItems();
	}

	protected byte[] digestFile(File f) throws IOException {
		try {
			final MessageDigest md = MessageDigest.getInstance("SHA");
			final ByteArrayOutputStream bos = new ByteArrayOutputStream();
			try (FileInputStream is = new FileInputStream(f);
					DigestInputStream dis = new DigestInputStream(is, md)) {
				IOUtils.copy(dis, bos);
			}
			return md.digest();
		} catch (NoSuchAlgorithmException ex) {
			LOGGER.error(ex.getMessage(), ex);
			return new byte[0];
		}
	}

}