X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.project%2Fsrc%2Forg%2Fsimantics%2Fproject%2Fmanagement%2Finstall%2FInstallDescriptionParser.java;fp=bundles%2Forg.simantics.project%2Fsrc%2Forg%2Fsimantics%2Fproject%2Fmanagement%2Finstall%2FInstallDescriptionParser.java;h=567f48a114c04f32489e9cb2f20d383a1b2cd6df;hb=969bd23cab98a79ca9101af33334000879fb60c5;hp=0000000000000000000000000000000000000000;hpb=866dba5cd5a3929bbeae85991796acb212338a08;p=simantics%2Fplatform.git diff --git a/bundles/org.simantics.project/src/org/simantics/project/management/install/InstallDescriptionParser.java b/bundles/org.simantics.project/src/org/simantics/project/management/install/InstallDescriptionParser.java new file mode 100644 index 000000000..567f48a11 --- /dev/null +++ b/bundles/org.simantics.project/src/org/simantics/project/management/install/InstallDescriptionParser.java @@ -0,0 +1,251 @@ +/******************************************************************************* + * Copyright (c) 2007, 2010 IBM Corporation and others. + * 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: + * IBM Corporation - initial API and implementation + * Code 9 - ongoing development + * Sonatype, Inc. - ongoing development + *******************************************************************************/ +package org.simantics.project.management.install; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.StringTokenizer; + +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.SubMonitor; +import org.eclipse.core.runtime.URIUtil; +import org.eclipse.equinox.internal.p2.core.helpers.CollectionUtils; +import org.eclipse.equinox.internal.p2.core.helpers.LogHelper; +import org.eclipse.equinox.internal.p2.core.helpers.ServiceHelper; +import org.eclipse.equinox.internal.p2.repository.Transport; +import org.eclipse.equinox.internal.provisional.p2.installer.InstallDescription; +import org.eclipse.equinox.p2.core.IProvisioningAgent; +import org.eclipse.equinox.p2.metadata.IVersionedId; +import org.eclipse.equinox.p2.metadata.VersionedId; +import org.simantics.project.internal.Activator; + +/** + * This class is responsible for loading install descriptions from a stream. + */ +@SuppressWarnings("restriction") +public class InstallDescriptionParser { + private static final String PROP_AGENT_LOCATION = "eclipse.p2.agentLocation"; //$NON-NLS-1$ + private static final String PROP_ARTIFACT_REPOSITORY = "eclipse.p2.artifacts";//$NON-NLS-1$ + private static final String PROP_BUNDLE_LOCATION = "eclipse.p2.bundleLocation";//$NON-NLS-1$ + private static final String PROP_INSTALL_LOCATION = "eclipse.p2.installLocation";//$NON-NLS-1$ + private static final String PROP_IS_AUTO_START = "eclipse.p2.autoStart";//$NON-NLS-1$ + private static final String PROP_LAUNCHER_NAME = "eclipse.p2.launcherName";//$NON-NLS-1$ + private static final String PROP_METADATA_REPOSITORY = "eclipse.p2.metadata";//$NON-NLS-1$ + private static final String PROP_PROFILE_NAME = "eclipse.p2.profileName";//$NON-NLS-1$ + private static final String PROP_ROOT_ID = "eclipse.p2.rootId";//$NON-NLS-1$ + private static final String PROP_ROOT_VERSION = "eclipse.p2.rootVersion";//$NON-NLS-1$ + private static final String PROP_ROOTS = "eclipse.p2.roots";//$NON-NLS-1$ + + /** + * Loads and returns an install description that is stored in a properties file. + * @param site The URL of the install properties file. + */ + public static InstallDescription createDescription(String site, SubMonitor monitor) throws Exception { + // if no description URL was given from the outside, look for an "install.properties" file + // in relative to where the installer is running. This allows the installer to be self-contained + if (site == null) + site = "installer.properties"; //$NON-NLS-1$ + + URI propsURI = URIUtil.fromString(site); + InputStream in = null; + if (!propsURI.isAbsolute()) { + String installerInstallArea = System.getProperty("osgi.install.area"); + if (installerInstallArea == null) + throw new IllegalStateException("Install area is not specified."); + + propsURI = URIUtil.append(URIUtil.fromString(installerInstallArea), site); + File installerDescription = URIUtil.toFile(propsURI); + if (!installerDescription.exists()) { + throw new IllegalStateException("Can't find install description file: " + installerDescription); + } + } + Map properties; + try { + in = getTransport().stream(propsURI, monitor); + properties = CollectionUtils.loadProperties(in); + } finally { + safeClose(in); + } + + URI base = getBase(propsURI); + InstallDescription result = new InstallDescription(); + result = initialize(result, properties, base); + initializeProfileProperties(result, properties); + + // now override the properties from anything interesting in system properties + result = initialize(result, CollectionUtils.toMap(System.getProperties()), base); + return result; + } + + private static IProvisioningAgent getAgent() { + return (IProvisioningAgent) ServiceHelper.getService(Activator.getDefault().getContext(), IProvisioningAgent.SERVICE_NAME); + } + + private static Transport getTransport() { + return (Transport) getAgent().getService(Transport.SERVICE_NAME); + } + + private static URI getBase(URI uri) { + if (uri == null) + return null; + + String uriString = uri.toString(); + int slashIndex = uriString.lastIndexOf('/'); + if (slashIndex == -1 || slashIndex == (uriString.length() - 1)) + return uri; + + return URI.create(uriString.substring(0, slashIndex + 1)); + } + + private static InstallDescription initialize(InstallDescription description, Map properties, URI base) { + String property = properties.get(PROP_ARTIFACT_REPOSITORY); + if (property != null) + description.setArtifactRepositories(getURIs(property, base)); + + property = properties.get(PROP_METADATA_REPOSITORY); + if (property != null) + description.setMetadataRepositories(getURIs(property, base)); + + property = properties.get(PROP_IS_AUTO_START); + if (property != null) + description.setAutoStart(Boolean.TRUE.toString().equalsIgnoreCase(property)); + + property = properties.get(PROP_LAUNCHER_NAME); + if (property != null) + description.setLauncherName(property); + + property = properties.get(PROP_INSTALL_LOCATION); + if (property != null) + description.setInstallLocation(new Path(property)); + + property = properties.get(PROP_AGENT_LOCATION); + if (property != null) + description.setAgentLocation(new Path(property)); + + property = properties.get(PROP_BUNDLE_LOCATION); + if (property != null) + description.setBundleLocation(new Path(property)); + + property = properties.get(PROP_PROFILE_NAME); + if (property != null) + description.setProductName(property); + + // Process the retro root id and rootVersion properties + String id = properties.get(PROP_ROOT_ID); + if (id != null) { + String version = properties.get(PROP_ROOT_VERSION); + try { + description.setRoots(new IVersionedId[] {new VersionedId(id, version)}); + } catch (IllegalArgumentException e) { + LogHelper.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Invalid version in install description: " + version, e)); //$NON-NLS-1$ + } + } + + String rootSpec = properties.get(PROP_ROOTS); + if (rootSpec != null) { + String[] rootList = getArrayFromString(rootSpec, ","); //$NON-NLS-1$ + ArrayList roots = new ArrayList(rootList.length); + for (int i = 0; i < rootList.length; i++) { + try { + roots.add(VersionedId.parse(rootList[i])); + } catch (IllegalArgumentException e) { + LogHelper.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Invalid version in install description: " + rootList[i], e)); //$NON-NLS-1$ + } + } + if (!roots.isEmpty()) + description.setRoots(roots.toArray(new IVersionedId[roots.size()])); + } + return description; + } + + /** + * Add all of the given properties to profile properties of the given description + * after removing the keys known to be for the installer. This allows install descriptions + * to also set random profile properties. + * @param description + * @param properties + */ + private static void initializeProfileProperties(InstallDescription description, Map properties) { + //any remaining properties are profile properties + Map profileProperties = new HashMap(properties); + profileProperties.remove(PROP_PROFILE_NAME); + profileProperties.remove(PROP_ARTIFACT_REPOSITORY); + profileProperties.remove(PROP_METADATA_REPOSITORY); + profileProperties.remove(PROP_IS_AUTO_START); + profileProperties.remove(PROP_LAUNCHER_NAME); + profileProperties.remove(PROP_AGENT_LOCATION); + profileProperties.remove(PROP_BUNDLE_LOCATION); + profileProperties.remove(PROP_ROOT_ID); + profileProperties.remove(PROP_ROOT_VERSION); + profileProperties.remove(PROP_ROOTS); + description.setProfileProperties(profileProperties); + } + + /** + * Returns an array of URIs from the given comma-separated list + * of URLs. Returns null if the given spec does not contain any URLs. + * @param base + * @return An array of URIs in the given spec, or null + */ + private static URI[] getURIs(String spec, URI base) { + String[] urlSpecs = getArrayFromString(spec, ","); //$NON-NLS-1$ + ArrayList result = new ArrayList(urlSpecs.length); + for (int i = 0; i < urlSpecs.length; i++) { + try { + URI uri = URIUtil.fromString(urlSpecs[i]); + uri = URIUtil.makeAbsolute(uri, base); + result.add(uri); + } catch (URISyntaxException e) { + LogHelper.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Invalid URL in install description: " + urlSpecs[i], e)); //$NON-NLS-1$ + } + } + if (result.isEmpty()) + return null; + return result.toArray(new URI[result.size()]); + } + + private static void safeClose(InputStream in) { + try { + if (in != null) + in.close(); + } catch (IOException e) { + //ignore secondary failure during close + } + } + + /** + * Convert a list of tokens into an array. The list separator has to be + * specified. + */ + public static String[] getArrayFromString(String list, String separator) { + if (list == null || list.trim().equals("")) //$NON-NLS-1$ + return new String[0]; + List result = new ArrayList(); + for (StringTokenizer tokens = new StringTokenizer(list, separator); tokens.hasMoreTokens();) { + String token = tokens.nextToken().trim(); + if (!token.equals("")) //$NON-NLS-1$ + result.add(token); + } + return result.toArray(new String[result.size()]); + } + +}