1 /*
   2  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package jdk.tools.jlink.internal;
  26 
  27 import java.io.DataOutputStream;
  28 
  29 import java.io.IOException;
  30 import java.util.ArrayList;
  31 import java.util.LinkedHashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Map.Entry;
  35 import java.util.Set;
  36 import jdk.tools.jlink.builder.ImageBuilder;
  37 import jdk.tools.jlink.Jlink;
  38 import jdk.tools.jlink.plugin.Plugin;
  39 import jdk.tools.jlink.plugin.PluginException;
  40 import jdk.tools.jlink.plugin.Plugin.Category;
  41 import jdk.tools.jlink.plugin.ResourcePool;
  42 
  43 /**
  44  * Plugins configuration.
  45  */
  46 public final class ImagePluginConfiguration {
  47 
  48     private static final List<Category> CATEGORIES_ORDER = new ArrayList<>();
  49 
  50     static {
  51         CATEGORIES_ORDER.add(Category.FILTER);
  52         CATEGORIES_ORDER.add(Category.TRANSFORMER);
  53         CATEGORIES_ORDER.add(Category.MODULEINFO_TRANSFORMER);
  54         CATEGORIES_ORDER.add(Category.SORTER);
  55         CATEGORIES_ORDER.add(Category.COMPRESSOR);
  56         CATEGORIES_ORDER.add(Category.METAINFO_ADDER);
  57         CATEGORIES_ORDER.add(Category.VERIFIER);
  58         CATEGORIES_ORDER.add(Category.PROCESSOR);
  59         CATEGORIES_ORDER.add(Category.PACKAGER);
  60     }
  61 
  62     private ImagePluginConfiguration() {
  63     }
  64 
  65     /*
  66      * Create a stack of plugins from a a configuration.
  67      */
  68     public static ImagePluginStack parseConfiguration(Jlink.PluginsConfiguration pluginsConfiguration)
  69             throws Exception {
  70         return parseConfiguration(pluginsConfiguration, null);
  71     }
  72 
  73     /*
  74      * Create a stack of plugins from a a configuration.
  75      */
  76     public static ImagePluginStack parseConfiguration(Jlink.PluginsConfiguration pluginsConfiguration,
  77                 Set<String> roots)
  78             throws Exception {
  79         if (pluginsConfiguration == null) {
  80             return new ImagePluginStack();
  81         }
  82         Map<Category, List<Plugin>> plugins = new LinkedHashMap<>();
  83         for (Category cat : CATEGORIES_ORDER) {
  84             plugins.put(cat, new ArrayList<>());
  85         }
  86 
  87         List<String> seen = new ArrayList<>();
  88         // split into categories and check for plugin with same name.
  89         for (Plugin plug : pluginsConfiguration.getPlugins()) {
  90             if (seen.contains(plug.getName())) {
  91                 throw new Exception("Plugin " + plug.getName()
  92                         + " added more than once to stack ");
  93             }
  94             seen.add(plug.getName());
  95             Category category = plug.getType();
  96             if (category == null) {
  97                 throw new PluginException("Invalid category for "
  98                         + plug.getName());
  99             }
 100             List<Plugin> lst = plugins.get(category);
 101             lst.add(plug);
 102         }
 103 
 104         List<Plugin> orderedPlugins = new ArrayList<>();
 105         plugins.entrySet().stream().forEach((entry) -> {
 106             orderedPlugins.addAll(entry.getValue());
 107         });
 108         Plugin lastSorter = null;
 109         for (Plugin plugin : orderedPlugins) {
 110             if (plugin.getName().equals(pluginsConfiguration.getLastSorterPluginName())) {
 111                 lastSorter = plugin;
 112                 break;
 113             }
 114         }
 115         if (pluginsConfiguration.getLastSorterPluginName() != null && lastSorter == null) {
 116             throw new IOException("Unknown last plugin "
 117                     + pluginsConfiguration.getLastSorterPluginName());
 118         }
 119         ImageBuilder builder = pluginsConfiguration.getImageBuilder();
 120         if (builder == null) {
 121             // This should be the case for jimage only creation or post-install.
 122             builder = new ImageBuilder() {
 123 
 124                 @Override
 125                 public DataOutputStream getJImageOutputStream() {
 126                     throw new PluginException("No directory setup to store files");
 127                 }
 128 
 129                 @Override
 130                 public ExecutableImage getExecutableImage() {
 131                     throw new PluginException("No directory setup to store files");
 132                 }
 133 
 134                 @Override
 135                 public void storeFiles(ResourcePool files) {
 136                     throw new PluginException("No directory setup to store files");
 137                 }
 138             };
 139         }
 140 
 141         return new ImagePluginStack(builder, orderedPlugins, lastSorter, roots);
 142     }
 143 }