1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*******************************************************************************
* Copyright (c) 2007, 2017 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.eclipse.equinox.internal.p2.installer;
import java.io.*;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.*;
import org.eclipse.core.runtime.*;
import org.eclipse.equinox.internal.p2.core.helpers.CollectionUtils;
import org.eclipse.equinox.internal.p2.core.helpers.LogHelper;
import org.eclipse.equinox.internal.p2.transport.ecf.RepositoryTransport;
import org.eclipse.equinox.internal.provisional.p2.installer.InstallDescription;
import org.eclipse.equinox.p2.metadata.IVersionedId;
import org.eclipse.equinox.p2.metadata.VersionedId;
/**
* This class is responsible for loading install descriptions from a stream.
*/
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"); //$NON-NLS-1$
if (installerInstallArea == null)
throw new IllegalStateException("Install area is not specified."); //$NON-NLS-1$
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); //$NON-NLS-1$
}
}
Map<String, String> properties;
try {
in = new RepositoryTransport().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 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<String, String> 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, InstallerActivator.PI_INSTALLER, "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<IVersionedId> 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, InstallerActivator.PI_INSTALLER, "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<String, String> properties) {
//any remaining properties are profile properties
Map<String, String> 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 <code>null</code>
*/
private static URI[] getURIs(String spec, URI base) {
String[] urlSpecs = getArrayFromString(spec, ","); //$NON-NLS-1$
ArrayList<URI> 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, InstallerActivator.PI_INSTALLER, "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<String> 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()]);
}
}
|
