JpsOsmorcModuleExtensionImpl.java

/*
 * Copyright 2000-2015 JetBrains s.r.o.
 *
 * 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 org.jetbrains.osgi.jps.model.impl;

import com.intellij.openapi.util.NullableLazyValue;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.util.xmlb.XmlSerializerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.jps.model.ex.JpsElementBase;
import org.jetbrains.jps.model.java.JpsJavaExtensionService;
import org.jetbrains.jps.model.module.JpsModule;
import org.jetbrains.osgi.jps.model.*;
import org.jetbrains.osgi.jps.util.OsgiBuildUtil;

import java.io.File;
import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * @author michael.golubev
 */
public class JpsOsmorcModuleExtensionImpl extends JpsElementBase<JpsOsmorcModuleExtensionImpl> implements JpsOsmorcModuleExtension {
  private final OsmorcModuleExtensionProperties myProperties;
  private final NullableLazyValue<File> myDescriptorFile = new NullableLazyValue<File>() {
    @Override
    protected File compute() {
      if (myProperties.myManifestGenerationMode == ManifestGenerationMode.Bnd) {
        return OsgiBuildUtil.findFileInModuleContentRoots(getModule(), getBndFileLocation());
      }
      else if (myProperties.myManifestGenerationMode == ManifestGenerationMode.Bundlor) {
        return OsgiBuildUtil.findFileInModuleContentRoots(getModule(), getBundlorFileLocation());
      }
      else if (myProperties.myManifestGenerationMode == ManifestGenerationMode.Manually) {
        return OsgiBuildUtil.findFileInModuleContentRoots(getModule(), getManifestLocation());
      }
      else {
        return null;
      }
    }
  };

  public JpsOsmorcModuleExtensionImpl(OsmorcModuleExtensionProperties properties) {
    myProperties = properties;
  }

  public OsmorcModuleExtensionProperties getProperties() {
    return myProperties;
  }

  @NotNull
  @Override
  public JpsOsmorcModuleExtensionImpl createCopy() {
    return new JpsOsmorcModuleExtensionImpl(XmlSerializerUtil.createCopy(myProperties));
  }

  @Override
  public void applyChanges(@NotNull JpsOsmorcModuleExtensionImpl modified) {
    XmlSerializerUtil.copyBean(modified.myProperties, myProperties);
  }

  @NotNull
  @Override
  public String getJarFileLocation() {
    String jarFileLocation = myProperties.myJarFileLocation;
    OutputPathType outputPathType = myProperties.myOutputPathType;
    String nullSafeLocation = jarFileLocation != null ? jarFileLocation : "";
    if (outputPathType == null) return nullSafeLocation;

    switch (outputPathType) {
      case CompilerOutputPath:
        File outputDir = JpsJavaExtensionService.getInstance().getOutputDirectory(getModule(), false);
        return outputDir != null ? new File(outputDir.getParent(), nullSafeLocation).getAbsolutePath() : nullSafeLocation;

      case OsgiOutputPath:
        JpsOsmorcProjectExtension projectExtension = getProjectExtension();
        if (projectExtension != null) {
          String bundlesOutputPath = projectExtension.getBundlesOutputPath();
          if (!StringUtil.isEmptyOrSpaces(bundlesOutputPath)) {
            return bundlesOutputPath + "/" + nullSafeLocation;
          }
        }
        return JpsOsmorcProjectExtensionImpl.getDefaultBundlesOutputPath(getModule().getProject()) + "/" + nullSafeLocation;

      case SpecificOutputPath:
      default:
        return nullSafeLocation;
    }
  }

  @Nullable
  @Override
  public File getBundleDescriptorFile() {
    return myDescriptorFile.getValue();
  }

  @Override
  public boolean isUseBndFile() {
    return myProperties.myManifestGenerationMode == ManifestGenerationMode.Bnd;
  }

  @Override
  public boolean isUseBundlorFile() {
    return myProperties.myManifestGenerationMode == ManifestGenerationMode.Bundlor;
  }

  @Override
  public boolean isManifestManuallyEdited() {
    return myProperties.myManifestGenerationMode == ManifestGenerationMode.Manually;
  }

  @Override
  public boolean isOsmorcControlsManifest() {
    return myProperties.myManifestGenerationMode == ManifestGenerationMode.OsmorcControlled;
  }

  @NotNull
  @Override
  public String getBndFileLocation() {
    return StringUtil.notNullize(myProperties.myBndFileLocation);
  }

  @NotNull
  @Override
  public Map<String, String> getAdditionalProperties() {
    return Collections.unmodifiableMap(myProperties.myAdditionalProperties);
  }

  @NotNull
  @Override
  public String getBundleSymbolicName() {
    return StringUtil.notNullize(myProperties.myBundleSymbolicName);
  }

  @NotNull
  @Override
  public String getBundleVersion() {
    return StringUtil.notNullize(myProperties.myBundleVersion, "1.0.0");
  }

  @Nullable
  @Override
  public String getBundleActivator() {
    return myProperties.myBundleActivator;
  }

  /**
   * Returns the manifest file for this facet. If the manifest is automatically generated, returns null.
   */
  @Nullable
  @Override
  public File getManifestFile() {
    if (isOsmorcControlsManifest()) {
      String pathToJar = getJarFileLocation();
      if (pathToJar.isEmpty()) {
        return null;
      }
      File jarFile = new File(pathToJar);
      if (!jarFile.exists()) {
        return null;
      }
      try {
        JarFile jar = new JarFile(jarFile);
        try {
          JarEntry manifestEntry = jar.getJarEntry("META-INF/MANIFEST.MF");
          if (manifestEntry == null) {
            return null;
          }
          return new File(jarFile, manifestEntry.getName());
        }
        finally {
          jar.close();
        }
      }
      catch (IOException e) {
        return null;
      }
    }
    else if (isManifestManuallyEdited()) {
      return OsgiBuildUtil.findFileInModuleContentRoots(getModule(), getManifestLocation());
    }
    else {
      return null;
    }
  }

  @NotNull
  @Override
  public String getManifestLocation() {
    if (myProperties.myUseProjectDefaultManifestFileLocation) {
      JpsOsmorcProjectExtension projectExtension = getProjectExtension();
      return projectExtension == null ? JarFile.MANIFEST_NAME : projectExtension.getDefaultManifestFileLocation();
    }
    else {
      return StringUtil.notNullize(myProperties.myManifestLocation);
    }
  }

  @Override
  public boolean isAlwaysRebuildBundleJar() {
    return myProperties.myAlwaysRebuildBundleJar;
  }

  @NotNull
  @Override
  public List<OsmorcJarContentEntry> getAdditionalJarContents() {
    return Collections.unmodifiableList(myProperties.myAdditionalJARContents);
  }

  @Nullable
  @Override
  public String getIgnoreFilePattern() {
    return myProperties.myIgnoreFilePattern;
  }

  @NotNull
  @Override
  public String getBundlorFileLocation() {
    return StringUtil.notNullize(myProperties.myBundlorFileLocation);
  }

  private JpsModule getModule() {
    return (JpsModule)getParent();
  }

  private JpsOsmorcProjectExtension getProjectExtension() {
    return JpsOsmorcExtensionService.getExtension(getModule().getProject());
  }
}