ArchiveProjectReader.java

/*
 * Copyright (c) 2012 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     HUMBOLDT EU Integrated Project #030962
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.hale.common.core.io.project.impl;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.text.MessageFormat;
import java.util.Collections;

import com.google.common.io.Files;

import de.fhg.igd.slf4jplus.ALogger;
import de.fhg.igd.slf4jplus.ALoggerFactory;
import eu.esdihumboldt.hale.common.core.io.HaleIO;
import eu.esdihumboldt.hale.common.core.io.IOProviderConfigurationException;
import eu.esdihumboldt.hale.common.core.io.ProgressIndicator;
import eu.esdihumboldt.hale.common.core.io.project.ProjectIO;
import eu.esdihumboldt.hale.common.core.io.project.ProjectReader;
import eu.esdihumboldt.hale.common.core.io.project.model.Project;
import eu.esdihumboldt.hale.common.core.io.project.util.LocationUpdater;
import eu.esdihumboldt.hale.common.core.io.report.IOReport;
import eu.esdihumboldt.hale.common.core.io.report.IOReporter;
import eu.esdihumboldt.hale.common.core.io.report.impl.IOMessageImpl;
import eu.esdihumboldt.hale.common.core.io.supplier.FileIOSupplier;
import eu.esdihumboldt.hale.common.core.io.supplier.LocatableInputSupplier;
import eu.esdihumboldt.hale.common.core.service.cleanup.TemporaryFiles;
import eu.esdihumboldt.util.io.IOUtils;

/**
 * Load project from a zip-archive (created by {@link ArchiveProjectWriter})
 * 
 * @author Patrick Lieb
 */
public class ArchiveProjectReader extends AbstractProjectReader implements TemporaryFiles {

	private static final ALogger log = ALoggerFactory.getLogger(ArchiveProjectReader.class);

	private File tempDir;

	@Override
	protected IOReport execute(ProgressIndicator progress, IOReporter reporter)
			throws IOProviderConfigurationException, IOException {
		// copy resources to a temporary directory
		tempDir = Files.createTempDir();
		IOUtils.extract(tempDir, getSource().getInput());

		// create the project file via XMLProjectReader
		File baseFile = new File(tempDir, "project.halex");
		ProjectReader reader;
		if (!baseFile.exists()) {
			// look for project file
			log.debug("Default project file not found, looking for other candidates.");
			String candidate = ProjectIO.findProjectFile(tempDir);
			if (candidate != null) {
				log.info(MessageFormat.format("Loading {0} as project file from archive",
						candidate));
				baseFile = new File(tempDir, candidate);
			}
			reader = HaleIO.findIOProvider(ProjectReader.class, new FileIOSupplier(baseFile),
					candidate);
			if (reader == null) {
				reporter.error(new IOMessageImpl(
						"Could not find reader for project file " + candidate, null));
				reporter.setSuccess(false);
				return reporter;
			}
		}
		else {
			// default project file
			reader = new XMLProjectReader();
		}

		LocatableInputSupplier<InputStream> tempSource = new FileIOSupplier(baseFile);

		// save old save configuration
		LocatableInputSupplier<? extends InputStream> oldSource = getSource();

		setSource(tempSource);
		reader.setSource(tempSource);
		reader.setProjectFiles(getProjectFiles());
		IOReport report = reader.execute(progress);
		Project readProject = reader.getProject();

		if (readProject != null) {
			/*
			 * Because the original source is only available here, update the
			 * project's resource paths here.
			 * 
			 * The only drawback is that the UILocationUpdater cannot be used.
			 */
			LocationUpdater updater = new LocationUpdater(readProject, tempSource.getLocation());
			// update resources
			// resources are made absolute (else they can't be found afterwards)
			updater.updateProject(false);
		}

		// set the real source
		setSource(oldSource);
		// set the read project
		setProjectChecked(readProject, reporter);

		return report;
	}

	@Override
	public Iterable<File> getTemporaryFiles() {
		return (tempDir == null) ? (Collections.<File> emptyList())
				: (Collections.singleton(tempDir));
	}
}