Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.common.app; |
| 17 | |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableList; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 19 | import com.google.common.collect.ImmutableSet; |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 20 | import com.google.common.collect.Lists; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 21 | import com.google.common.io.ByteStreams; |
| 22 | import com.google.common.io.Files; |
| 23 | import org.apache.commons.configuration.ConfigurationException; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 24 | import org.apache.commons.configuration.HierarchicalConfiguration; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 25 | import org.apache.commons.configuration.XMLConfiguration; |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 26 | import org.apache.commons.lang.StringUtils; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 27 | import org.onlab.util.Tools; |
Ray Milkey | 351d456 | 2018-07-25 12:31:48 -0700 | [diff] [blame^] | 28 | import org.onlab.util.ZipValidator; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 29 | import org.onosproject.app.ApplicationDescription; |
| 30 | import org.onosproject.app.ApplicationEvent; |
| 31 | import org.onosproject.app.ApplicationException; |
| 32 | import org.onosproject.app.ApplicationStoreDelegate; |
| 33 | import org.onosproject.app.DefaultApplicationDescription; |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 34 | import org.onosproject.core.ApplicationRole; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 35 | import org.onosproject.core.Version; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 36 | import org.onosproject.security.AppPermission; |
| 37 | import org.onosproject.security.Permission; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 38 | import org.onosproject.store.AbstractStore; |
| 39 | import org.slf4j.Logger; |
| 40 | import org.slf4j.LoggerFactory; |
| 41 | |
| 42 | import java.io.ByteArrayInputStream; |
| 43 | import java.io.File; |
| 44 | import java.io.FileInputStream; |
| 45 | import java.io.FileNotFoundException; |
| 46 | import java.io.IOException; |
| 47 | import java.io.InputStream; |
| 48 | import java.net.URI; |
HIGUCHI Yuta | 436f8d5 | 2015-12-07 21:17:48 -0800 | [diff] [blame] | 49 | import java.nio.charset.StandardCharsets; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 50 | import java.nio.file.NoSuchFileException; |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 51 | import java.util.List; |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 52 | import java.util.Locale; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 53 | import java.util.Set; |
| 54 | import java.util.zip.ZipEntry; |
| 55 | import java.util.zip.ZipInputStream; |
| 56 | |
Thomas Vachuska | e18a330 | 2015-06-23 12:48:28 -0700 | [diff] [blame] | 57 | import static com.google.common.base.Preconditions.checkState; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 58 | import static com.google.common.io.ByteStreams.toByteArray; |
| 59 | import static com.google.common.io.Files.createParentDirs; |
| 60 | import static com.google.common.io.Files.write; |
| 61 | |
| 62 | /** |
| 63 | * Facility for reading application archive stream and managing application |
| 64 | * directory structure. |
| 65 | */ |
| 66 | public class ApplicationArchive |
| 67 | extends AbstractStore<ApplicationEvent, ApplicationStoreDelegate> { |
| 68 | |
Thomas Vachuska | a7a0f56 | 2015-04-14 23:27:44 -0700 | [diff] [blame] | 69 | private static Logger log = LoggerFactory.getLogger(ApplicationArchive.class); |
| 70 | |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 71 | // Magic strings to search for at the beginning of the archive stream |
| 72 | private static final String XML_MAGIC = "<?xml "; |
Brian O'Connor | e4a4f99 | 2016-04-06 22:50:31 -0700 | [diff] [blame] | 73 | private static final String ZIP_MAGIC = "PK"; |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 74 | |
| 75 | // Magic strings to search for and how deep to search it into the archive stream |
| 76 | private static final String APP_MAGIC = "<app "; |
| 77 | private static final int APP_MAGIC_DEPTH = 1024; |
| 78 | |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 79 | private static final String NAME = "[@name]"; |
| 80 | private static final String ORIGIN = "[@origin]"; |
| 81 | private static final String VERSION = "[@version]"; |
| 82 | private static final String FEATURES_REPO = "[@featuresRepo]"; |
| 83 | private static final String FEATURES = "[@features]"; |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 84 | private static final String APPS = "[@apps]"; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 85 | private static final String DESCRIPTION = "description"; |
| 86 | |
Jian Li | 01b0f595 | 2016-01-20 11:02:07 -0800 | [diff] [blame] | 87 | private static final String UTILITY = "utility"; |
| 88 | |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 89 | private static final String CATEGORY = "[@category]"; |
| 90 | private static final String URL = "[@url]"; |
Simon Hunt | afae2f7 | 2016-03-04 21:18:23 -0800 | [diff] [blame] | 91 | private static final String TITLE = "[@title]"; |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 92 | |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 93 | private static final String ROLE = "security.role"; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 94 | private static final String APP_PERMISSIONS = "security.permissions.app-perm"; |
| 95 | private static final String NET_PERMISSIONS = "security.permissions.net-perm"; |
| 96 | private static final String JAVA_PERMISSIONS = "security.permissions.java-perm"; |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 97 | |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 98 | private static final String JAR = ".jar"; |
Thomas Vachuska | a7a0f56 | 2015-04-14 23:27:44 -0700 | [diff] [blame] | 99 | private static final String OAR = ".oar"; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 100 | private static final String APP_XML = "app.xml"; |
Jian Li | 97d6b2d | 2016-01-20 10:13:43 -0800 | [diff] [blame] | 101 | private static final String APP_PNG = "app.png"; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 102 | private static final String M2_PREFIX = "m2"; |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 103 | private static final String FEATURES_XML = "features.xml"; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 104 | |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 105 | private static final String ROOT = "../"; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 106 | private static final String M2_ROOT = "system/"; |
Thomas Vachuska | d5d9bcb | 2015-03-18 17:46:20 -0700 | [diff] [blame] | 107 | private static final String APPS_ROOT = "apps/"; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 108 | |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 109 | private File root = new File(ROOT); |
| 110 | private File appsDir = new File(root, APPS_ROOT); |
| 111 | private File m2Dir = new File(M2_ROOT); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 112 | |
| 113 | /** |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 114 | * Sets the root directory where apps directory is contained. |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 115 | * |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 116 | * @param root top-level directory path |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 117 | */ |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 118 | protected void setRootPath(String root) { |
| 119 | this.root = new File(root); |
| 120 | this.appsDir = new File(this.root, APPS_ROOT); |
| 121 | this.m2Dir = new File(M2_ROOT); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | /** |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 125 | * Returns the root directory where apps directory is contained. |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 126 | * |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 127 | * @return top-level directory path |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 128 | */ |
Thomas Vachuska | e18a330 | 2015-06-23 12:48:28 -0700 | [diff] [blame] | 129 | public String getRootPath() { |
Thomas Vachuska | 40a398b | 2015-04-03 22:26:30 -0700 | [diff] [blame] | 130 | return root.getPath(); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Returns the set of installed application names. |
| 135 | * |
| 136 | * @return installed application names |
| 137 | */ |
| 138 | public Set<String> getApplicationNames() { |
| 139 | ImmutableSet.Builder<String> names = ImmutableSet.builder(); |
| 140 | File[] files = appsDir.listFiles(File::isDirectory); |
| 141 | if (files != null) { |
| 142 | for (File file : files) { |
| 143 | names.add(file.getName()); |
| 144 | } |
| 145 | } |
| 146 | return names.build(); |
| 147 | } |
| 148 | |
| 149 | /** |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 150 | * Returns the timestamp in millis since start of epoch, of when the |
| 151 | * specified application was last modified or changed state. |
| 152 | * |
| 153 | * @param appName application name |
| 154 | * @return number of millis since start of epoch |
| 155 | */ |
| 156 | public long getUpdateTime(String appName) { |
| 157 | return appFile(appName, APP_XML).lastModified(); |
| 158 | } |
| 159 | |
| 160 | /** |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 161 | * Loads the application descriptor from the specified application archive |
| 162 | * stream and saves the stream in the appropriate application archive |
| 163 | * directory. |
| 164 | * |
| 165 | * @param appName application name |
| 166 | * @return application descriptor |
| 167 | * @throws org.onosproject.app.ApplicationException if unable to read application description |
| 168 | */ |
| 169 | public ApplicationDescription getApplicationDescription(String appName) { |
| 170 | try { |
Thomas Vachuska | ad35c34 | 2015-06-11 17:25:36 -0700 | [diff] [blame] | 171 | XMLConfiguration cfg = new XMLConfiguration(); |
| 172 | cfg.setAttributeSplittingDisabled(true); |
| 173 | cfg.setDelimiterParsingDisabled(true); |
| 174 | cfg.load(appFile(appName, APP_XML)); |
| 175 | return loadAppDescription(cfg); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 176 | } catch (Exception e) { |
| 177 | throw new ApplicationException("Unable to get app description", e); |
| 178 | } |
| 179 | } |
| 180 | |
| 181 | /** |
| 182 | * Loads the application descriptor from the specified application archive |
| 183 | * stream and saves the stream in the appropriate application archive |
| 184 | * directory. |
| 185 | * |
| 186 | * @param stream application archive stream |
| 187 | * @return application descriptor |
| 188 | * @throws org.onosproject.app.ApplicationException if unable to read the |
| 189 | * archive stream or store |
| 190 | * the application archive |
| 191 | */ |
Thomas Vachuska | 0249b53 | 2015-02-20 16:46:18 -0800 | [diff] [blame] | 192 | public synchronized ApplicationDescription saveApplication(InputStream stream) { |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 193 | try (InputStream ais = stream) { |
| 194 | byte[] cache = toByteArray(ais); |
| 195 | InputStream bis = new ByteArrayInputStream(cache); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 196 | |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 197 | boolean plainXml = isPlainXml(cache); |
| 198 | ApplicationDescription desc = plainXml ? |
| 199 | parsePlainAppDescription(bis) : parseZippedAppDescription(bis); |
Thomas Vachuska | e18a330 | 2015-06-23 12:48:28 -0700 | [diff] [blame] | 200 | checkState(!appFile(desc.name(), APP_XML).exists(), |
Jian Li | 97d6b2d | 2016-01-20 10:13:43 -0800 | [diff] [blame] | 201 | "Application %s already installed", desc.name()); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 202 | |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 203 | if (plainXml) { |
| 204 | expandPlainApplication(cache, desc); |
| 205 | } else { |
| 206 | bis.reset(); |
Thomas Vachuska | 08b4dec | 2017-08-31 15:20:17 -0700 | [diff] [blame] | 207 | boolean isSelfContainedJar = expandZippedApplication(bis, desc); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 208 | |
| 209 | if (isSelfContainedJar) { |
| 210 | bis.reset(); |
| 211 | stageSelfContainedJar(bis, desc); |
| 212 | } |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 213 | |
| 214 | bis.reset(); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 215 | saveApplication(bis, desc, isSelfContainedJar); |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 216 | } |
| 217 | |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 218 | installArtifacts(desc); |
| 219 | return desc; |
| 220 | } catch (IOException e) { |
| 221 | throw new ApplicationException("Unable to save application", e); |
| 222 | } |
| 223 | } |
| 224 | |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 225 | // Indicates whether the stream encoded in the given bytes is plain XML. |
| 226 | private boolean isPlainXml(byte[] bytes) { |
Brian O'Connor | e4a4f99 | 2016-04-06 22:50:31 -0700 | [diff] [blame] | 227 | return !substring(bytes, ZIP_MAGIC.length()).equals(ZIP_MAGIC) && |
| 228 | (substring(bytes, XML_MAGIC.length()).equals(XML_MAGIC) || |
| 229 | substring(bytes, APP_MAGIC_DEPTH).contains(APP_MAGIC)); |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | // Returns the substring of maximum possible length from the specified bytes. |
| 233 | private String substring(byte[] bytes, int length) { |
HIGUCHI Yuta | 436f8d5 | 2015-12-07 21:17:48 -0800 | [diff] [blame] | 234 | return new String(bytes, 0, Math.min(bytes.length, length), StandardCharsets.UTF_8); |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 235 | } |
| 236 | |
Ray Milkey | 4b19da6 | 2018-07-08 10:06:19 -0700 | [diff] [blame] | 237 | private String filterAppNameForFilesystem(String name) { |
| 238 | return name.replace("/", "^"); |
| 239 | } |
| 240 | |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 241 | /** |
| 242 | * Purges the application archive directory. |
| 243 | * |
| 244 | * @param appName application name |
| 245 | */ |
Thomas Vachuska | 0249b53 | 2015-02-20 16:46:18 -0800 | [diff] [blame] | 246 | public synchronized void purgeApplication(String appName) { |
Ray Milkey | 4b19da6 | 2018-07-08 10:06:19 -0700 | [diff] [blame] | 247 | File appDir = new File(appsDir, filterAppNameForFilesystem(appName)); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 248 | try { |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 249 | Tools.removeDirectory(appDir); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 250 | } catch (IOException e) { |
| 251 | throw new ApplicationException("Unable to purge application " + appName, e); |
| 252 | } |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 253 | if (appDir.exists()) { |
| 254 | throw new ApplicationException("Unable to purge application " + appName); |
| 255 | } |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | /** |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 259 | * Returns application archive stream for the specified application. This |
Thomas Vachuska | 08b4dec | 2017-08-31 15:20:17 -0700 | [diff] [blame] | 260 | * will be either the application OAR file, JAR file or the plain XML file. |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 261 | * |
| 262 | * @param appName application name |
| 263 | * @return application archive stream |
| 264 | */ |
Thomas Vachuska | 0249b53 | 2015-02-20 16:46:18 -0800 | [diff] [blame] | 265 | public synchronized InputStream getApplicationInputStream(String appName) { |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 266 | try { |
Thomas Vachuska | a7a0f56 | 2015-04-14 23:27:44 -0700 | [diff] [blame] | 267 | File appFile = appFile(appName, appName + OAR); |
Thomas Vachuska | ad37e37 | 2017-08-03 12:07:01 -0700 | [diff] [blame] | 268 | if (!appFile.exists()) { |
| 269 | appFile = appFile(appName, appName + JAR); |
| 270 | } |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 271 | return new FileInputStream(appFile.exists() ? appFile : appFile(appName, APP_XML)); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 272 | } catch (FileNotFoundException e) { |
| 273 | throw new ApplicationException("Application " + appName + " not found"); |
| 274 | } |
| 275 | } |
| 276 | |
| 277 | // Scans the specified ZIP stream for app.xml entry and parses it producing |
| 278 | // an application descriptor. |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 279 | private ApplicationDescription parseZippedAppDescription(InputStream stream) |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 280 | throws IOException { |
| 281 | try (ZipInputStream zis = new ZipInputStream(stream)) { |
| 282 | ZipEntry entry; |
| 283 | while ((entry = zis.getNextEntry()) != null) { |
| 284 | if (entry.getName().equals(APP_XML)) { |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 285 | byte[] data = ByteStreams.toByteArray(zis); |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 286 | return parsePlainAppDescription(new ByteArrayInputStream(data)); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 287 | } |
| 288 | zis.closeEntry(); |
| 289 | } |
| 290 | } |
| 291 | throw new IOException("Unable to locate " + APP_XML); |
| 292 | } |
| 293 | |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 294 | // Scans the specified XML stream and parses it producing an application descriptor. |
| 295 | private ApplicationDescription parsePlainAppDescription(InputStream stream) |
| 296 | throws IOException { |
| 297 | XMLConfiguration cfg = new XMLConfiguration(); |
Thomas Vachuska | ad35c34 | 2015-06-11 17:25:36 -0700 | [diff] [blame] | 298 | cfg.setAttributeSplittingDisabled(true); |
| 299 | cfg.setDelimiterParsingDisabled(true); |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 300 | try { |
| 301 | cfg.load(stream); |
| 302 | return loadAppDescription(cfg); |
| 303 | } catch (ConfigurationException e) { |
| 304 | throw new IOException("Unable to parse " + APP_XML, e); |
| 305 | } |
| 306 | } |
| 307 | |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 308 | private ApplicationDescription loadAppDescription(XMLConfiguration cfg) { |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 309 | String name = cfg.getString(NAME); |
| 310 | Version version = Version.version(cfg.getString(VERSION)); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 311 | String origin = cfg.getString(ORIGIN); |
Simon Hunt | afae2f7 | 2016-03-04 21:18:23 -0800 | [diff] [blame] | 312 | |
| 313 | String title = cfg.getString(TITLE); |
| 314 | // FIXME: title should be set as attribute to APP, but fallback for now... |
| 315 | title = title == null ? name : title; |
| 316 | |
Jian Li | 01b0f595 | 2016-01-20 11:02:07 -0800 | [diff] [blame] | 317 | String category = cfg.getString(CATEGORY, UTILITY); |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 318 | String url = cfg.getString(URL); |
| 319 | byte[] icon = getApplicationIcon(name); |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 320 | ApplicationRole role = getRole(cfg.getString(ROLE)); |
| 321 | Set<Permission> perms = getPermissions(cfg); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 322 | String featRepo = cfg.getString(FEATURES_REPO); |
| 323 | URI featuresRepo = featRepo != null ? URI.create(featRepo) : null; |
Thomas Vachuska | ad35c34 | 2015-06-11 17:25:36 -0700 | [diff] [blame] | 324 | List<String> features = ImmutableList.copyOf(cfg.getString(FEATURES).split(",")); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 325 | |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 326 | String apps = cfg.getString(APPS, ""); |
| 327 | List<String> requiredApps = apps.isEmpty() ? |
| 328 | ImmutableList.of() : ImmutableList.copyOf(apps.split(",")); |
| 329 | |
Jian Li | 8bcb4f2 | 2016-01-20 10:36:18 -0800 | [diff] [blame] | 330 | // put full description to readme field |
| 331 | String readme = cfg.getString(DESCRIPTION); |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 332 | |
Jian Li | 8bcb4f2 | 2016-01-20 10:36:18 -0800 | [diff] [blame] | 333 | // put short description to description field |
| 334 | String desc = compactDescription(readme); |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 335 | |
Ray Milkey | 47c9541 | 2017-09-15 10:40:48 -0700 | [diff] [blame] | 336 | return DefaultApplicationDescription.builder() |
| 337 | .withName(name) |
| 338 | .withVersion(version) |
| 339 | .withTitle(title) |
| 340 | .withDescription(desc) |
| 341 | .withOrigin(origin) |
| 342 | .withCategory(category) |
| 343 | .withUrl(url) |
| 344 | .withReadme(readme) |
| 345 | .withIcon(icon) |
| 346 | .withRole(role) |
| 347 | .withPermissions(perms) |
| 348 | .withFeaturesRepo(featuresRepo) |
| 349 | .withFeatures(features) |
| 350 | .withRequiredApps(requiredApps) |
| 351 | .build(); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 352 | } |
| 353 | |
| 354 | // Expands the specified ZIP stream into app-specific directory. |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 355 | // Returns true of the application is a self-contained jar rather than an oar file. |
| 356 | private boolean expandZippedApplication(InputStream stream, ApplicationDescription desc) |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 357 | throws IOException { |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 358 | boolean isSelfContained = false; |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 359 | ZipInputStream zis = new ZipInputStream(stream); |
| 360 | ZipEntry entry; |
Ray Milkey | 4b19da6 | 2018-07-08 10:06:19 -0700 | [diff] [blame] | 361 | File appDir = new File(appsDir, filterAppNameForFilesystem(desc.name())); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 362 | while ((entry = zis.getNextEntry()) != null) { |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 363 | if (!entry.isDirectory()) { |
| 364 | byte[] data = ByteStreams.toByteArray(zis); |
| 365 | zis.closeEntry(); |
Ray Milkey | 351d456 | 2018-07-25 12:31:48 -0700 | [diff] [blame^] | 366 | if (ZipValidator.validateZipEntry(entry, appDir)) { |
| 367 | File file = new File(appDir, entry.getName()); |
| 368 | if (isTopLevel(file)) { |
| 369 | createParentDirs(file); |
| 370 | write(data, file); |
| 371 | } else { |
| 372 | isSelfContained = true; |
| 373 | } |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 374 | } else { |
Ray Milkey | 351d456 | 2018-07-25 12:31:48 -0700 | [diff] [blame^] | 375 | throw new ApplicationException("Application Zip archive is attempting to leave application root"); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 376 | } |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 377 | } |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 378 | } |
| 379 | zis.close(); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 380 | return isSelfContained; |
| 381 | } |
| 382 | |
| 383 | // Returns true if the specified file is a top-level app file, i.e. app.xml, |
| 384 | // features.xml, .jar or a directory; false if anything else. |
| 385 | private boolean isTopLevel(File file) { |
| 386 | String name = file.getName(); |
| 387 | return name.equals(APP_XML) || name.endsWith(FEATURES_XML) || name.endsWith(JAR) || file.isDirectory(); |
| 388 | } |
| 389 | |
| 390 | // Expands the self-contained JAR stream into the app-specific directory, |
| 391 | // using the bundle coordinates retrieved from the features.xml file. |
| 392 | private void stageSelfContainedJar(InputStream stream, ApplicationDescription desc) |
| 393 | throws IOException { |
| 394 | // First extract the bundle coordinates |
| 395 | String coords = getSelfContainedBundleCoordinates(desc); |
| 396 | if (coords == null) { |
| 397 | return; |
| 398 | } |
| 399 | |
| 400 | // Split the coordinates into segments and build the file name. |
| 401 | String[] f = coords.substring(4).split("/"); |
| 402 | String base = "m2/" + f[0].replace('.', '/') + "/" + f[1] + "/" + f[2] + "/" + f[1] + "-" + f[2]; |
| 403 | String jarName = base + (f.length < 4 ? "" : "-" + f[3]) + ".jar"; |
| 404 | String featuresName = base + "-features.xml"; |
| 405 | |
| 406 | // Create the file directory structure and copy the file there. |
| 407 | File jar = appFile(desc.name(), jarName); |
Thomas Vachuska | ad37e37 | 2017-08-03 12:07:01 -0700 | [diff] [blame] | 408 | boolean ok = jar.getParentFile().exists() || jar.getParentFile().mkdirs(); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 409 | if (ok) { |
| 410 | Files.write(toByteArray(stream), jar); |
| 411 | Files.copy(appFile(desc.name(), FEATURES_XML), appFile(desc.name(), featuresName)); |
| 412 | if (!appFile(desc.name(), FEATURES_XML).delete()) { |
| 413 | log.warn("Unable to delete self-contained application {} features.xml", desc.name()); |
| 414 | } |
| 415 | } else { |
| 416 | throw new IOException("Unable to save self-contained application " + desc.name()); |
| 417 | } |
| 418 | } |
| 419 | |
| 420 | // Returns the bundle coordinates from the features.xml file. |
| 421 | private String getSelfContainedBundleCoordinates(ApplicationDescription desc) { |
| 422 | try { |
| 423 | XMLConfiguration cfg = new XMLConfiguration(); |
| 424 | cfg.setAttributeSplittingDisabled(true); |
| 425 | cfg.setDelimiterParsingDisabled(true); |
| 426 | cfg.load(appFile(desc.name(), FEATURES_XML)); |
Thomas Vachuska | ad37e37 | 2017-08-03 12:07:01 -0700 | [diff] [blame] | 427 | return cfg.getString("feature.bundle") |
| 428 | .replaceFirst("wrap:", "") |
| 429 | .replaceFirst("\\$Bundle-.*$", ""); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 430 | } catch (ConfigurationException e) { |
| 431 | log.warn("Self-contained application {} has no features.xml", desc.name()); |
| 432 | return null; |
| 433 | } |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 434 | } |
| 435 | |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 436 | // Saves the specified XML stream into app-specific directory. |
| 437 | private void expandPlainApplication(byte[] stream, ApplicationDescription desc) |
| 438 | throws IOException { |
| 439 | File file = appFile(desc.name(), APP_XML); |
Thomas Vachuska | e18a330 | 2015-06-23 12:48:28 -0700 | [diff] [blame] | 440 | checkState(!file.getParentFile().exists(), "Application already installed"); |
Thomas Vachuska | 62ad95f | 2015-02-18 12:11:36 -0800 | [diff] [blame] | 441 | createParentDirs(file); |
| 442 | write(stream, file); |
| 443 | } |
| 444 | |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 445 | // Saves the specified ZIP stream into a file under app-specific directory. |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 446 | private void saveApplication(InputStream stream, ApplicationDescription desc, |
| 447 | boolean isSelfContainedJar) |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 448 | throws IOException { |
Ray Milkey | 4b19da6 | 2018-07-08 10:06:19 -0700 | [diff] [blame] | 449 | String name = filterAppNameForFilesystem(desc.name()) + (isSelfContainedJar ? JAR : OAR); |
Thomas Vachuska | 6cc7488 | 2017-01-10 16:01:02 -0800 | [diff] [blame] | 450 | Files.write(toByteArray(stream), appFile(desc.name(), name)); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 451 | } |
| 452 | |
| 453 | // Installs application artifacts into M2 repository. |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 454 | private void installArtifacts(ApplicationDescription desc) throws IOException { |
| 455 | try { |
| 456 | Tools.copyDirectory(appFile(desc.name(), M2_PREFIX), m2Dir); |
| 457 | } catch (NoSuchFileException e) { |
| 458 | log.debug("Application {} has no M2 artifacts", desc.name()); |
| 459 | } |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 460 | } |
| 461 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 462 | /** |
| 463 | * Marks the app as active by creating token file in the app directory. |
| 464 | * |
| 465 | * @param appName application name |
| 466 | * @return true if file was created |
| 467 | */ |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 468 | protected boolean setActive(String appName) { |
| 469 | try { |
Thomas Vachuska | e965b3d | 2016-03-03 11:42:48 -0800 | [diff] [blame] | 470 | File active = appFile(appName, "active"); |
| 471 | createParentDirs(active); |
| 472 | return active.createNewFile() && updateTime(appName); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 473 | } catch (IOException e) { |
Thomas Vachuska | e965b3d | 2016-03-03 11:42:48 -0800 | [diff] [blame] | 474 | log.warn("Unable to mark app {} as active", appName, e); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 475 | throw new ApplicationException("Unable to mark app as active", e); |
| 476 | } |
| 477 | } |
| 478 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 479 | /** |
| 480 | * Clears the app as active by deleting token file in the app directory. |
| 481 | * |
| 482 | * @param appName application name |
| 483 | * @return true if file was deleted |
| 484 | */ |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 485 | protected boolean clearActive(String appName) { |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 486 | return appFile(appName, "active").delete() && updateTime(appName); |
| 487 | } |
| 488 | |
| 489 | /** |
| 490 | * Updates the time-stamp of the app descriptor file. |
| 491 | * |
| 492 | * @param appName application name |
| 493 | * @return true if the app descriptor was updated |
| 494 | */ |
Thomas Vachuska | 161baf5 | 2015-03-27 16:15:39 -0700 | [diff] [blame] | 495 | protected boolean updateTime(String appName) { |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 496 | return appFile(appName, APP_XML).setLastModified(System.currentTimeMillis()); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 497 | } |
| 498 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 499 | /** |
| 500 | * Indicates whether the app was marked as active by checking for token file. |
| 501 | * |
| 502 | * @param appName application name |
| 503 | * @return true if the app is marked as active |
| 504 | */ |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 505 | protected boolean isActive(String appName) { |
| 506 | return appFile(appName, "active").exists(); |
| 507 | } |
| 508 | |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 509 | // Returns the name of the file located under the specified app directory. |
| 510 | private File appFile(String appName, String fileName) { |
Ray Milkey | 4b19da6 | 2018-07-08 10:06:19 -0700 | [diff] [blame] | 511 | return new File(new File(appsDir, filterAppNameForFilesystem(appName)), fileName); |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 512 | } |
| 513 | |
Jian Li | 97d6b2d | 2016-01-20 10:13:43 -0800 | [diff] [blame] | 514 | // Returns the icon file located under the specified app directory. |
| 515 | private File iconFile(String appName, String fileName) { |
| 516 | return new File(new File(appsDir, appName), fileName); |
| 517 | } |
| 518 | |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 519 | // Returns the set of Permissions specified in the app.xml file |
| 520 | private ImmutableSet<Permission> getPermissions(XMLConfiguration cfg) { |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 521 | List<Permission> permissionList = Lists.newArrayList(); |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 522 | |
| 523 | for (Object o : cfg.getList(APP_PERMISSIONS)) { |
Changhoon Yoon | a7841ed | 2015-05-15 02:51:08 +0900 | [diff] [blame] | 524 | String name = (String) o; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 525 | permissionList.add(new Permission(AppPermission.class.getName(), name)); |
| 526 | } |
| 527 | for (Object o : cfg.getList(NET_PERMISSIONS)) { |
| 528 | //TODO: TO BE FLESHED OUT WHEN NETWORK PERMISSIONS ARE SUPPORTED |
| 529 | break; |
| 530 | } |
| 531 | |
| 532 | List<HierarchicalConfiguration> fields = |
| 533 | cfg.configurationsAt(JAVA_PERMISSIONS); |
| 534 | for (HierarchicalConfiguration sub : fields) { |
| 535 | String classname = sub.getString("classname"); |
| 536 | String name = sub.getString("name"); |
| 537 | String actions = sub.getString("actions"); |
| 538 | |
| 539 | if (classname != null && name != null) { |
| 540 | permissionList.add(new Permission(classname, name, actions)); |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 541 | } |
| 542 | } |
Changhoon Yoon | a7841ed | 2015-05-15 02:51:08 +0900 | [diff] [blame] | 543 | return ImmutableSet.copyOf(permissionList); |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 544 | } |
| 545 | |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 546 | // Returns the byte stream from icon.png file in oar application archive. |
| 547 | private byte[] getApplicationIcon(String appName) { |
Jian Li | 97d6b2d | 2016-01-20 10:13:43 -0800 | [diff] [blame] | 548 | File iconFile = iconFile(appName, APP_PNG); |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 549 | try { |
Brian O'Connor | a7903ae | 2016-04-29 15:02:32 -0700 | [diff] [blame] | 550 | final InputStream iconStream; |
| 551 | if (iconFile.exists()) { |
| 552 | iconStream = new FileInputStream(iconFile); |
| 553 | } else { |
| 554 | // assume that we can always fallback to default icon |
| 555 | iconStream = ApplicationArchive.class.getResourceAsStream("/" + APP_PNG); |
| 556 | } |
| 557 | return ByteStreams.toByteArray(iconStream); |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 558 | } catch (IOException e) { |
Brian O'Connor | a7903ae | 2016-04-29 15:02:32 -0700 | [diff] [blame] | 559 | log.warn("Unable to read app icon for app {}", appName, e); |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 560 | } |
Brian O'Connor | a7903ae | 2016-04-29 15:02:32 -0700 | [diff] [blame] | 561 | return new byte[0]; |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 562 | } |
| 563 | |
Changhoon Yoon | bdeb88a | 2015-05-12 20:35:31 +0900 | [diff] [blame] | 564 | // Returns application role type |
| 565 | public ApplicationRole getRole(String value) { |
| 566 | if (value == null) { |
| 567 | return ApplicationRole.UNSPECIFIED; |
| 568 | } else { |
| 569 | try { |
| 570 | return ApplicationRole.valueOf(value.toUpperCase(Locale.ENGLISH)); |
| 571 | } catch (IllegalArgumentException e) { |
| 572 | log.debug("Unknown role value: %s", value); |
| 573 | return ApplicationRole.UNSPECIFIED; |
| 574 | } |
| 575 | } |
| 576 | } |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 577 | |
| 578 | // Returns the first sentence of the given sentence |
| 579 | private String compactDescription(String sentence) { |
| 580 | if (StringUtils.isNotEmpty(sentence)) { |
| 581 | if (StringUtils.contains(sentence, ".")) { |
| 582 | return StringUtils.substringBefore(sentence, ".") + "."; |
| 583 | } else { |
Jian Li | 8bcb4f2 | 2016-01-20 10:36:18 -0800 | [diff] [blame] | 584 | return sentence; |
Jian Li | c35415d | 2016-01-14 17:22:31 -0800 | [diff] [blame] | 585 | } |
| 586 | } |
| 587 | return sentence; |
| 588 | } |
Thomas Vachuska | 02aeb03 | 2015-01-06 22:36:30 -0800 | [diff] [blame] | 589 | } |