123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474 |
- /*
- * Copyright 2011 Vaadin Ltd.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
- package com.vaadin.terminal.gwt.widgetsetutils;
-
- import java.io.File;
- import java.io.FileFilter;
- import java.io.IOException;
- import java.net.JarURLConnection;
- import java.net.MalformedURLException;
- import java.net.URL;
- import java.net.URLConnection;
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.Iterator;
- import java.util.LinkedHashMap;
- import java.util.List;
- import java.util.Map;
- import java.util.Set;
- import java.util.jar.Attributes;
- import java.util.jar.JarFile;
- import java.util.jar.Manifest;
- import java.util.logging.Level;
- import java.util.logging.Logger;
-
- /**
- * Utility class to collect widgetset related information from classpath.
- * Utility will seek all directories from classpaths, and jar files having
- * "Vaadin-Widgetsets" key in their manifest file.
- * <p>
- * Used by WidgetMapGenerator and ide tools to implement some monkey coding for
- * you.
- * <p>
- * Developer notice: If you end up reading this comment, I guess you have faced
- * a sluggish performance of widget compilation or unreliable detection of
- * components in your classpaths. The thing you might be able to do is to use
- * annotation processing tool like apt to generate the needed information. Then
- * either use that information in {@link WidgetMapGenerator} or create the
- * appropriate monkey code for gwt directly in annotation processor and get rid
- * of {@link WidgetMapGenerator}. Using annotation processor might be a good
- * idea when dropping Java 1.5 support (integrated to javac in 6).
- *
- */
- public class ClassPathExplorer {
-
- private static final String VAADIN_ADDON_VERSION_ATTRIBUTE = "Vaadin-Package-Version";
-
- /**
- * File filter that only accepts directories.
- */
- private final static FileFilter DIRECTORIES_ONLY = new FileFilter() {
- @Override
- public boolean accept(File f) {
- if (f.exists() && f.isDirectory()) {
- return true;
- } else {
- return false;
- }
- }
- };
-
- /**
- * Raw class path entries as given in the java class path string. Only
- * entries that could include widgets/widgetsets are listed (primarily
- * directories, Vaadin JARs and add-on JARs).
- */
- private static List<String> rawClasspathEntries = getRawClasspathEntries();
-
- /**
- * Map from identifiers (either a package name preceded by the path and a
- * slash, or a URL for a JAR file) to the corresponding URLs. This is
- * constructed from the class path.
- */
- private static Map<String, URL> classpathLocations = getClasspathLocations(rawClasspathEntries);
-
- /**
- * No instantiation from outside, callable methods are static.
- */
- private ClassPathExplorer() {
- }
-
- /**
- * Finds the names and locations of widgetsets available on the class path.
- *
- * @return map from widgetset classname to widgetset location URL
- */
- public static Map<String, URL> getAvailableWidgetSets() {
- long start = System.currentTimeMillis();
- Map<String, URL> widgetsets = new HashMap<String, URL>();
- Set<String> keySet = classpathLocations.keySet();
- for (String location : keySet) {
- searchForWidgetSets(location, widgetsets);
- }
- long end = System.currentTimeMillis();
-
- StringBuilder sb = new StringBuilder();
- sb.append("Widgetsets found from classpath:\n");
- for (String ws : widgetsets.keySet()) {
- sb.append("\t");
- sb.append(ws);
- sb.append(" in ");
- sb.append(widgetsets.get(ws));
- sb.append("\n");
- }
- final Logger logger = getLogger();
- logger.info(sb.toString());
- logger.info("Search took " + (end - start) + "ms");
- return widgetsets;
- }
-
- /**
- * Finds all GWT modules / Vaadin widgetsets in a valid location.
- *
- * If the location is a directory, all GWT modules (files with the
- * ".gwt.xml" extension) are added to widgetsets.
- *
- * If the location is a JAR file, the comma-separated values of the
- * "Vaadin-Widgetsets" attribute in its manifest are added to widgetsets.
- *
- * @param locationString
- * an entry in {@link #classpathLocations}
- * @param widgetsets
- * a map from widgetset name (including package, with dots as
- * separators) to a URL (see {@link #classpathLocations}) - new
- * entries are added to this map
- */
- private static void searchForWidgetSets(String locationString,
- Map<String, URL> widgetsets) {
-
- URL location = classpathLocations.get(locationString);
- File directory = new File(location.getFile());
-
- if (directory.exists() && !directory.isHidden()) {
- // Get the list of the files contained in the directory
- String[] files = directory.list();
- for (int i = 0; i < files.length; i++) {
- // we are only interested in .gwt.xml files
- if (!files[i].endsWith(".gwt.xml")) {
- continue;
- }
-
- // remove the .gwt.xml extension
- String classname = files[i].substring(0, files[i].length() - 8);
- String packageName = locationString.substring(locationString
- .lastIndexOf("/") + 1);
- classname = packageName + "." + classname;
-
- if (!WidgetSetBuilder.isWidgetset(classname)) {
- // Only return widgetsets and not GWT modules to avoid
- // comparing modules and widgetsets
- continue;
- }
-
- if (!widgetsets.containsKey(classname)) {
- String packagePath = packageName.replaceAll("\\.", "/");
- String basePath = location.getFile().replaceAll(
- "/" + packagePath + "$", "");
- try {
- URL url = new URL(location.getProtocol(),
- location.getHost(), location.getPort(),
- basePath);
- widgetsets.put(classname, url);
- } catch (MalformedURLException e) {
- // should never happen as based on an existing URL,
- // only changing end of file name/path part
- getLogger().log(Level.SEVERE,
- "Error locating the widgetset " + classname, e);
- }
- }
- }
- } else {
-
- try {
- // check files in jar file, entries will list all directories
- // and files in jar
-
- URLConnection openConnection = location.openConnection();
- if (openConnection instanceof JarURLConnection) {
- JarURLConnection conn = (JarURLConnection) openConnection;
-
- JarFile jarFile = conn.getJarFile();
-
- Manifest manifest = jarFile.getManifest();
- if (manifest == null) {
- // No manifest so this is not a Vaadin Add-on
- return;
- }
- String value = manifest.getMainAttributes().getValue(
- "Vaadin-Widgetsets");
- if (value != null) {
- String[] widgetsetNames = value.split(",");
- for (int i = 0; i < widgetsetNames.length; i++) {
- String widgetsetname = widgetsetNames[i].trim()
- .intern();
- if (!widgetsetname.equals("")) {
- widgetsets.put(widgetsetname, location);
- }
- }
- }
- }
- } catch (IOException e) {
- getLogger().log(Level.WARNING, "Error parsing jar file", e);
- }
-
- }
- }
-
- /**
- * Splits the current class path into entries, and filters them accepting
- * directories, Vaadin add-on JARs with widgetsets and Vaadin JARs.
- *
- * Some other non-JAR entries may also be included in the result.
- *
- * @return filtered list of class path entries
- */
- private final static List<String> getRawClasspathEntries() {
- // try to keep the order of the classpath
- List<String> locations = new ArrayList<String>();
-
- String pathSep = System.getProperty("path.separator");
- String classpath = System.getProperty("java.class.path");
-
- if (classpath.startsWith("\"")) {
- classpath = classpath.substring(1);
- }
- if (classpath.endsWith("\"")) {
- classpath = classpath.substring(0, classpath.length() - 1);
- }
-
- getLogger().fine("Classpath: " + classpath);
-
- String[] split = classpath.split(pathSep);
- for (int i = 0; i < split.length; i++) {
- String classpathEntry = split[i];
- if (acceptClassPathEntry(classpathEntry)) {
- locations.add(classpathEntry);
- }
- }
-
- return locations;
- }
-
- /**
- * Determine every URL location defined by the current classpath, and it's
- * associated package name.
- *
- * See {@link #classpathLocations} for information on output format.
- *
- * @param rawClasspathEntries
- * raw class path entries as split from the Java class path
- * string
- * @return map of classpath locations, see {@link #classpathLocations}
- */
- private final static Map<String, URL> getClasspathLocations(
- List<String> rawClasspathEntries) {
- long start = System.currentTimeMillis();
- // try to keep the order of the classpath
- Map<String, URL> locations = new LinkedHashMap<String, URL>();
- for (String classpathEntry : rawClasspathEntries) {
- File file = new File(classpathEntry);
- include(null, file, locations);
- }
- long end = System.currentTimeMillis();
- Logger logger = getLogger();
- if (logger.isLoggable(Level.FINE)) {
- logger.fine("getClassPathLocations took " + (end - start) + "ms");
- }
- return locations;
- }
-
- /**
- * Checks a class path entry to see whether it can contain widgets and
- * widgetsets.
- *
- * All directories are automatically accepted. JARs are accepted if they
- * have the "Vaadin-Widgetsets" attribute in their manifest or the JAR file
- * name contains "vaadin-" or ".vaadin.".
- *
- * Also other non-JAR entries may be accepted, the caller should be prepared
- * to handle them.
- *
- * @param classpathEntry
- * class path entry string as given in the Java class path
- * @return true if the entry should be considered when looking for widgets
- * or widgetsets
- */
- private static boolean acceptClassPathEntry(String classpathEntry) {
- if (!classpathEntry.endsWith(".jar")) {
- // accept all non jars (practically directories)
- return true;
- } else {
- // accepts jars that comply with vaadin-component packaging
- // convention (.vaadin. or vaadin- as distribution packages),
- if (classpathEntry.contains("vaadin-")
- || classpathEntry.contains(".vaadin.")) {
- return true;
- } else {
- URL url;
- try {
- url = new URL("file:"
- + new File(classpathEntry).getCanonicalPath());
- url = new URL("jar:" + url.toExternalForm() + "!/");
- JarURLConnection conn = (JarURLConnection) url
- .openConnection();
- getLogger().fine(url.toString());
- JarFile jarFile = conn.getJarFile();
- Manifest manifest = jarFile.getManifest();
- if (manifest != null) {
- Attributes mainAttributes = manifest
- .getMainAttributes();
- if (mainAttributes.getValue("Vaadin-Widgetsets") != null) {
- return true;
- }
- }
- } catch (MalformedURLException e) {
- getLogger().log(Level.FINEST, "Failed to inspect JAR file",
- e);
- } catch (IOException e) {
- getLogger().log(Level.FINEST, "Failed to inspect JAR file",
- e);
- }
-
- return false;
- }
- }
- }
-
- /**
- * Recursively add subdirectories and jar files to locations - see
- * {@link #classpathLocations}.
- *
- * @param name
- * @param file
- * @param locations
- */
- private final static void include(String name, File file,
- Map<String, URL> locations) {
- if (!file.exists()) {
- return;
- }
- if (!file.isDirectory()) {
- // could be a JAR file
- includeJar(file, locations);
- return;
- }
-
- if (file.isHidden() || file.getPath().contains(File.separator + ".")) {
- return;
- }
-
- if (name == null) {
- name = "";
- } else {
- name += ".";
- }
-
- // add all directories recursively
- File[] dirs = file.listFiles(DIRECTORIES_ONLY);
- for (int i = 0; i < dirs.length; i++) {
- try {
- // add the present directory
- if (!dirs[i].isHidden()
- && !dirs[i].getPath().contains(File.separator + ".")) {
- String key = dirs[i].getCanonicalPath() + "/" + name
- + dirs[i].getName();
- locations.put(key,
- new URL("file://" + dirs[i].getCanonicalPath()));
- }
- } catch (Exception ioe) {
- return;
- }
- include(name + dirs[i].getName(), dirs[i], locations);
- }
- }
-
- /**
- * Add a jar file to locations - see {@link #classpathLocations}.
- *
- * @param name
- * @param locations
- */
- private static void includeJar(File file, Map<String, URL> locations) {
- try {
- URL url = new URL("file:" + file.getCanonicalPath());
- url = new URL("jar:" + url.toExternalForm() + "!/");
- JarURLConnection conn = (JarURLConnection) url.openConnection();
- JarFile jarFile = conn.getJarFile();
- if (jarFile != null) {
- // the key does not matter here as long as it is unique
- locations.put(url.toString(), url);
- }
- } catch (Exception e) {
- // e.printStackTrace();
- return;
- }
-
- }
-
- /**
- * Find and return the default source directory where to create new
- * widgetsets.
- *
- * Return the first directory (not a JAR file etc.) on the classpath by
- * default.
- *
- * TODO this could be done better...
- *
- * @return URL
- */
- public static URL getDefaultSourceDirectory() {
-
- final Logger logger = getLogger();
-
- if (logger.isLoggable(Level.FINE)) {
- logger.fine("classpathLocations values:");
- ArrayList<String> locations = new ArrayList<String>(
- classpathLocations.keySet());
- for (String location : locations) {
- logger.fine(String.valueOf(classpathLocations.get(location)));
- }
- }
-
- Iterator<String> it = rawClasspathEntries.iterator();
- while (it.hasNext()) {
- String entry = it.next();
-
- File directory = new File(entry);
- if (directory.exists() && !directory.isHidden()
- && directory.isDirectory()) {
- try {
- return new URL("file://" + directory.getCanonicalPath());
- } catch (MalformedURLException e) {
- logger.log(Level.FINEST, "Ignoring exception", e);
- // ignore: continue to the next classpath entry
- } catch (IOException e) {
- logger.log(Level.FINEST, "Ignoring exception", e);
- // ignore: continue to the next classpath entry
- }
- }
- }
- return null;
- }
-
- /**
- * Test method for helper tool
- */
- public static void main(String[] args) {
- getLogger().info("Searching available widgetsets...");
-
- Map<String, URL> availableWidgetSets = ClassPathExplorer
- .getAvailableWidgetSets();
- for (String string : availableWidgetSets.keySet()) {
-
- getLogger().info(string + " in " + availableWidgetSets.get(string));
- }
- }
-
- private static final Logger getLogger() {
- return Logger.getLogger(ClassPathExplorer.class.getName());
- }
-
- }
|