org.netbeans.modules.web.project.WebProjectOperations Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.netbeans.modules.web.project;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.apache.tools.ant.module.api.support.ActionUtils;
import org.netbeans.api.project.FileOwnerQuery;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectManager;
import org.netbeans.modules.java.api.common.SourceRoots;
import org.netbeans.modules.web.project.ui.customizer.WebProjectProperties;
import org.netbeans.spi.project.ActionProvider;
import org.netbeans.spi.project.CopyOperationImplementation;
import org.netbeans.spi.project.DeleteOperationImplementation;
import org.netbeans.spi.project.MoveOperationImplementation;
import org.netbeans.spi.project.support.ant.AntProjectHelper;
import org.netbeans.spi.project.support.ant.EditableProperties;
import org.netbeans.spi.project.support.ant.GeneratedFilesHelper;
import org.netbeans.spi.project.support.ant.PropertyEvaluator;
import org.netbeans.spi.project.support.ant.PropertyUtils;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
/**
*
* @author Jan Lahoda
*/
public class WebProjectOperations implements DeleteOperationImplementation, CopyOperationImplementation, MoveOperationImplementation {
private WebProject project;
//RELY: Valid only on original project after the notifyMoving or notifyCopying was called
private String libraryPath;
//RELY: Valid only on original project after the notifyMoving or notifyCopying was called
private File libraryFile;
//RELY: Valid only on original project after the notifyMoving or notifyCopying was called
private boolean libraryWithinProject;
//RELY: Valid only on original project after the notifyMoving or notifyCopying was called
private String absolutesRelPath;
public WebProjectOperations(WebProject project) {
this.project = project;
}
private static void addFile(FileObject projectDirectory, String fileName, List result) {
FileObject file = projectDirectory.getFileObject(fileName);
if (file != null) {
result.add(file);
}
}
public List getMetadataFiles() {
FileObject projectDirectory = project.getProjectDirectory();
List files = new ArrayList();
addFile(projectDirectory, "nbproject", files); // NOI18N
addFile(projectDirectory, project.getBuildXmlName(), files);
addFile(projectDirectory, "catalog.xml", files); //NOI18N
return files;
}
public List getDataFiles() {
List files = new ArrayList();
FileObject docRoot = project.getAPIWebModule().getDocumentBase();
if (docRoot != null)
files.add(docRoot);
FileObject confDir = project.getWebModule().getConfDir();
if (confDir != null)
files.add(confDir);
// If the persistence.xml.dir is different from the conf.dir,
// then add it here
FileObject persistenceXmlDir = project.getWebModule().getPersistenceXmlDir();
if (persistenceXmlDir != null && (confDir == null || !FileUtil.toFile(persistenceXmlDir).equals(FileUtil.toFile(confDir)))) {
files.add(persistenceXmlDir);
}
File resourceDir = project.getWebModule().getResourceDirectory();
if (resourceDir != null) {
FileObject resourceFO = FileUtil.toFileObject(resourceDir);
if (resourceFO != null)
files.add(resourceFO);
}
SourceRoots src = project.getSourceRoots();
FileObject[] srcRoots = src.getRoots();
for (int cntr = 0; cntr < srcRoots.length; cntr++) {
if (srcRoots[cntr] != null) {
files.add(srcRoots[cntr]);
}
}
PropertyEvaluator evaluator = project.evaluator();
String prop = evaluator.getProperty(WebProjectProperties.SOURCE_ROOT);
if (prop != null) {
FileObject projectDirectory = project.getProjectDirectory();
FileObject srcDir = project.getAntProjectHelper().resolveFileObject(prop);
if (srcDir != null && projectDirectory != srcDir && !files.contains(srcDir))
files.add(srcDir);
}
SourceRoots test = project.getTestSourceRoots();
FileObject[] testRoots = test.getRoots();
for (int cntr = 0; cntr < testRoots.length; cntr++) {
if (testRoots[cntr] != null) {
files.add(testRoots[cntr]);
}
}
// add libraries folder if it is within project:
AntProjectHelper helper = project.getAntProjectHelper();
if (helper.getLibrariesLocation() != null) {
File f = helper.resolveFile(helper.getLibrariesLocation());
if (f != null && f.exists()) {
FileObject libFolder = FileUtil.toFileObject(f).getParent();
if (libFolder != null && FileUtil.isParentOf(project.getProjectDirectory(), libFolder)) {
files.add(libFolder);
}
}
}
return files;
}
public void notifyDeleting() throws IOException {
FileObject buildXML = project.getProjectDirectory().getFileObject(GeneratedFilesHelper.BUILD_XML_PATH);
// #215290
if (buildXML != null) {
ActionUtils.runTarget(buildXML, new String[]{ActionProvider.COMMAND_CLEAN}, new Properties()).waitFinished();
}
}
public void notifyDeleted() throws IOException {
project.getAntProjectHelper().notifyDeleted();
}
public void notifyCopying() {
rememberLibraryLocation();
}
public void notifyCopied(Project original, File originalPath, final String newName) {
if (original == null) {
//nothing for the original project
return ;
}
final String oldProjectName = project.getName();
project.getReferenceHelper().fixReferences(originalPath);
WebProjectOperations origOperations = original.getLookup().lookup(WebProjectOperations.class);
fixLibraryLocation(origOperations);
project.setName(newName);
ProjectManager.mutex().writeAccess(new Runnable() {
public void run() {
AntProjectHelper helper = project.getAntProjectHelper();
EditableProperties projectProps = helper.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);
String warName = projectProps.get(WebProjectProperties.WAR_NAME);
String warEarName = projectProps.get(WebProjectProperties.WAR_EAR_NAME);
String oldName = warName.substring(0, warName.length() - 4);
if (warName.endsWith(".war") && oldName.equals(oldProjectName)) //NOI18N
projectProps.put(WebProjectProperties.WAR_NAME, PropertyUtils.getUsablePropertyName(newName) + ".war"); //NOI18N
if (warEarName.endsWith(".war") && oldName.equals(oldProjectName)) //NOI18N
projectProps.put(WebProjectProperties.WAR_EAR_NAME, PropertyUtils.getUsablePropertyName(newName) + ".war"); //NOI18N
ProjectWebModule wm = project.getLookup().lookup(ProjectWebModule.class);
if (wm != null) //should not be null
wm.setContextPath("/" + newName);
helper.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, projectProps);
}
});
}
public void notifyMoving() throws IOException {
rememberLibraryLocation();
notifyDeleting();
}
public void notifyMoved(Project original, File originalPath, final String newName) {
if (original == null) {
project.getAntProjectHelper().notifyDeleted();
return ;
}
final String oldProjectName = project.getName();
project.setName(newName);
project.getReferenceHelper().fixReferences(originalPath);
WebProjectOperations origOperations = original.getLookup().lookup(WebProjectOperations.class);
fixLibraryLocation(origOperations);
ProjectManager.mutex().writeAccess(new Runnable() {
public void run() {
AntProjectHelper helper = project.getAntProjectHelper();
EditableProperties projectProps = helper.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);
EditableProperties privateProps = helper.getProperties(AntProjectHelper.PRIVATE_PROPERTIES_PATH);
String warName = projectProps.get(WebProjectProperties.WAR_NAME);
String warEarName = projectProps.get(WebProjectProperties.WAR_EAR_NAME);
String oldName = warName.substring(0, warName.length() - 4);
if (warName.endsWith(".war") && oldName.equals(oldProjectName)) //NOI18N
projectProps.put(WebProjectProperties.WAR_NAME, PropertyUtils.getUsablePropertyName(newName) + ".war"); //NOI18N
if (warEarName != null && warEarName.endsWith(".war") && oldName.equals(oldProjectName)) //NOI18N
projectProps.put(WebProjectProperties.WAR_EAR_NAME, PropertyUtils.getUsablePropertyName(newName) + ".war"); //NOI18N
ProjectWebModule wm = project.getLookup().lookup(ProjectWebModule.class);
String serverId = privateProps.getProperty(WebProjectProperties.J2EE_SERVER_INSTANCE);
String oldCP = wm.getContextPath(serverId);
if (oldCP != null && oldName.equals(oldCP.substring(1)))
wm.setContextPath(serverId, "/" + newName); //NOI18N
helper.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, projectProps);
}
});
}
private void fixLibraryLocation(WebProjectOperations original) throws IllegalArgumentException {
String libPath = original.libraryPath;
if (libPath != null) {
if (!new File(libPath).isAbsolute()) {
//relative path to libraries
if (!original.libraryWithinProject) {
File file = original.libraryFile;
if (file == null) {
// could happen in some rare cases, but in that case the original project was already broken, don't fix.
return;
}
String relativized = PropertyUtils.relativizeFile(FileUtil.toFile(project.getProjectDirectory()), file);
if (relativized != null) {
project.getAntProjectHelper().setLibrariesLocation(relativized);
} else {
//cannot relativize, use absolute path
project.getAntProjectHelper().setLibrariesLocation(file.getAbsolutePath());
}
} else {
//got copied over to new location.. the relative path is the same..
}
} else {
//absolute path to libraries..
if (original.libraryWithinProject) {
if (original.absolutesRelPath != null) {
project.getAntProjectHelper().setLibrariesLocation(PropertyUtils.resolveFile(FileUtil.toFile(project.getProjectDirectory()), original.absolutesRelPath).getAbsolutePath());
}
} else {
// absolute path to an external folder stays the same.
}
}
}
}
private void rememberLibraryLocation() {
libraryWithinProject = false;
absolutesRelPath = null;
libraryPath = project.getAntProjectHelper().getLibrariesLocation();
if (libraryPath != null) {
File prjRoot = FileUtil.toFile(project.getProjectDirectory());
libraryFile = PropertyUtils.resolveFile(prjRoot, libraryPath);
if (FileOwnerQuery.getOwner(libraryFile.toURI()) == project &&
libraryFile.getAbsolutePath().startsWith(prjRoot.getAbsolutePath())) {
//do not update the relative path if within the project..
libraryWithinProject = true;
FileObject fo = FileUtil.toFileObject(libraryFile);
if (new File(libraryPath).isAbsolute() && fo != null) {
// if absolte path within project, it will get moved/copied..
absolutesRelPath = FileUtil.getRelativePath(project.getProjectDirectory(), fo);
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy