BinaryBundleAndFeatureSet.java

/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team.
 *
 * 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:
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich
 **********************************************************************/
package org.ant4eclipse.lib.pde.internal.tools;

import org.ant4eclipse.lib.core.Assure;
import org.ant4eclipse.lib.pde.internal.model.pluginproject.BundleDescriptionLoader;
import org.ant4eclipse.lib.pde.internal.model.pluginproject.FeatureDescriptionLoader;
import org.ant4eclipse.lib.pde.model.link.LinkFile;
import org.ant4eclipse.lib.pde.model.link.LinkFileFactory;
import org.eclipse.osgi.service.resolver.BundleDescription;

import java.io.File;

/**
 * <p>
 * A {@link BundleAndFeatureSet} implementation that represent an eclipse target platform containing binary bundles and
 * features.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 * @author Nils Hartmann (nils@nilshartmann.net)
 */
public class BinaryBundleAndFeatureSet extends AbstractBundleAndFeatureSet {

  /** the constant that defines the default plug-in directory */
  public static final String DEFAULT_PLUGIN_DIRECTORY  = "plugins";

  /** the constant that defines the default feature directory */
  public static final String DEFAULT_FEATURE_DIRECTORY = "features";

  /** the location of the platform against which the workspace plug-ins will be compiled and tested */
  private File               _targetPlatformLocation;

  /**
   * <p>
   * Creates a new instance of type BinaryBundleAndFeatureSet.
   * </p>
   * 
   * @param targetPlatformLocation
   *          the target platform location.
   */
  public BinaryBundleAndFeatureSet(File targetPlatformLocation) {
    super("target platform location '" + targetPlatformLocation.getAbsolutePath() + "'");
    Assure.isDirectory("targetPlatformLocation", targetPlatformLocation);
    this._targetPlatformLocation = targetPlatformLocation;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected void readBundlesAndFeatures() {

    // 1. read plugin from target location
    // TODO: ERROR-HANDLING...
    File pluginsDirectory = new File(this._targetPlatformLocation, DEFAULT_PLUGIN_DIRECTORY);
    if (!pluginsDirectory.exists()) {
      pluginsDirectory = this._targetPlatformLocation;
    }
    if ((pluginsDirectory != null) && pluginsDirectory.exists()) {
      File[] plugins = pluginsDirectory.listFiles();
      for (File plugin : plugins) {
        BundleDescription bundleDescription = BundleDescriptionLoader.parsePlugin(plugin);
        if (bundleDescription != null) {
          addBundleDescription(bundleDescription);
        }
      }
    }

    // 2. read plugins from linked directories in target location
    if (this._targetPlatformLocation != null) {
      LinkFile[] linkFiles = LinkFileFactory.getLinkFiles(this._targetPlatformLocation);
      for (LinkFile file : linkFiles) {
        if (file.isValidDestination()) {
          File pluginsDirectory1 = file.getPluginsDirectory();
          if ((pluginsDirectory1 != null) && pluginsDirectory1.exists()) {
            File[] plugins = pluginsDirectory1.listFiles();
            for (File plugin : plugins) {
              BundleDescription bundleDescription = BundleDescriptionLoader.parsePlugin(plugin);
              if (bundleDescription != null) {
                addBundleDescription(bundleDescription);
              }
            }
          }
        }
      }
    }

    // 1. read features from target location
    // TODO: ERROR-HANDLING...

    // try to search features in the 'features' directory
    File featuresDirectory = new File(this._targetPlatformLocation, DEFAULT_FEATURE_DIRECTORY);

    // if the 'features' directory doesn't exist, use the target platform location
    if (!featuresDirectory.exists()) {
      featuresDirectory = this._targetPlatformLocation;
    }

    //
    readFeature(featuresDirectory);

    // 2. read plugins from linked directories in target location
    if (this._targetPlatformLocation != null) {

      LinkFile[] linkFiles = LinkFileFactory.getLinkFiles(this._targetPlatformLocation);

      for (LinkFile linkFile : linkFiles) {

        if (linkFile.isValidDestination()) {
          readFeature(linkFile.getFeaturesDirectory());
        }
      }
    }
  }

  /**
   * <p>
   * </p>
   * 
   * @param directory
   */
  private void readFeature(File directory) {

    if (directory == null || !directory.exists()) {
      return;
    }

    for (File feature : directory.listFiles()) {
      FeatureDescription featureDescription = FeatureDescriptionLoader.parseFeature(feature);

      if (featureDescription != null) {
        addFeaturesDescription(featureDescription);
      }
    }
  }
}