org.netbeans.modules.web.project.UpdateProjectImpl 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.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import javax.swing.JButton;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectManager;
import org.netbeans.api.project.libraries.LibraryManager;
import org.netbeans.modules.java.api.common.classpath.ClassPathSupport;
import org.netbeans.modules.java.api.common.ant.UpdateHelper;
import org.netbeans.modules.java.api.common.ant.UpdateImplementation;
import org.netbeans.modules.java.api.common.project.ProjectProperties;
import org.netbeans.modules.web.project.api.WebProjectUtilities;
import org.netbeans.modules.web.project.classpath.ClassPathSupportCallbackImpl;
import org.netbeans.modules.web.project.ui.customizer.WebProjectProperties;
import org.netbeans.spi.project.AuxiliaryConfiguration;
import org.netbeans.spi.project.support.ant.AntProjectHelper;
import org.netbeans.spi.project.support.ant.EditableProperties;
import org.netbeans.spi.project.support.ant.ReferenceHelper;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;
import org.openide.filesystems.FileLock;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.filesystems.URLMapper;
import org.openide.util.Mutex;
import org.openide.util.NbBundle;
import org.openide.xml.XMLUtil;
import org.w3c.dom.Comment;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
/**
*
* @author Tomas Mysik
*/
public class UpdateProjectImpl implements UpdateImplementation {
private static final boolean TRANSPARENT_UPDATE = Boolean.getBoolean("webproject.transparentUpdate");
private static final String BUILD_NUMBER = System.getProperty("netbeans.buildnumber"); // NOI18N
private static final String TAG_MINIMUM_ANT_VERSION = "minimum-ant-version"; // NOI18N
private static final String TAG_FILE = "file"; //NOI18N
private static final String TAG_LIBRARY = "library"; //NOI18N
private static final String ATTR_FILES = "files"; //NOI18N
private static final String ATTR_DIRS = "dirs"; //NOI18N
private final Project project;
private final AntProjectHelper helper;
private final AuxiliaryConfiguration cfg;
private boolean alreadyAskedInWriteAccess;
private Boolean isCurrent;
private Element cachedElement;
private ProjectUpdateListener projectUpdateListener = null;
private UpdateHelper updateHelper;
private EditableProperties cachedProperties;
/**
* Creates new UpdateHelper
* @param project
* @param helper AntProjectHelper
* @param cfg AuxiliaryConfiguration
* @param genFileHelper GeneratedFilesHelper
* @param notifier used to ask user about project update
*/
UpdateProjectImpl(Project project, AntProjectHelper helper, AuxiliaryConfiguration cfg) {
assert project != null && helper != null && cfg != null;
this.project = project;
this.helper = helper;
this.cfg = cfg;
}
public void setUpdateHelper(UpdateHelper updateHelper) {
this.updateHelper = updateHelper;
}
public boolean isCurrent() {
return ProjectManager.mutex().readAccess(new Mutex.Action() {
public Boolean run() {
synchronized (this) {
if (isCurrent == null) {
if ((cfg.getConfigurationFragment("data","http://www.netbeans.org/ns/web-project/1",true) != null) || // NOI18N
(cfg.getConfigurationFragment("data","http://www.netbeans.org/ns/web-project/2",true) != null)) { // NOI18N
isCurrent = Boolean.FALSE;
} else {
isCurrent = Boolean.TRUE;
}
}
return isCurrent;
}
}
});
}
public boolean canUpdate () {
if (TRANSPARENT_UPDATE) {
return true;
}
//Ask just once under a single write access
if (alreadyAskedInWriteAccess) {
return false;
}
else {
boolean canUpdate = showUpdateDialog();
if (!canUpdate) {
alreadyAskedInWriteAccess = true;
ProjectManager.mutex().postReadRequest(new Runnable() {
public void run() {
alreadyAskedInWriteAccess = false;
}
});
}
return canUpdate;
}
}
public void saveUpdate(EditableProperties props) throws IOException {
this.helper.putPrimaryConfigurationData(getUpdatedSharedConfigurationData(),true);
if (this.cfg.getConfigurationFragment("data","http://www.netbeans.org/ns/web-project/1",true) != null) { //NOI18N
this.cfg.removeConfigurationFragment("data","http://www.netbeans.org/ns/web-project/1",true); //NOI18N
} else {
this.cfg.removeConfigurationFragment("data","http://www.netbeans.org/ns/web-project/2",true); //NOI18N
}
boolean putProps = false;
// AB: fix for #55597: should not update the project without adding the properties
// update is only done once, so if we don't add the properties now, we don't get another chance to do so
if (props == null) {
assert updateHelper != null;
props = updateHelper.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);
putProps = true;
}
//add properties needed by 4.1 project
if(props != null) {
props.put("test.src.dir", "test"); //NOI18N
props.put("build.test.classes.dir", "${build.dir}/test/classes"); //NOI18N
props.put("build.test.results.dir", "${build.dir}/test/results"); //NOI18N
props.put("conf.dir","${source.root}/conf"); //NOI18N
props.put("jspcompilation.classpath", "${jspc.classpath}:${javac.classpath}");
props.setProperty(ProjectProperties.JAVAC_TEST_CLASSPATH, new String[] {
"${javac.classpath}:", // NOI18N
"${build.classes.dir}:", // NOI18N
"${libs.junit.classpath}:", // NOI18N
"${libs.junit_4.classpath}", // NOI18N
});
props.setProperty(ProjectProperties.RUN_TEST_CLASSPATH, new String[] {
"${javac.test.classpath}:", // NOI18N
"${build.test.classes.dir}", // NOI18N
});
props.setProperty(WebProjectProperties.DEBUG_TEST_CLASSPATH, new String[] {
"${run.test.classpath}", // NOI18N
});
props.put(WebProjectProperties.WAR_EAR_NAME, props.getProperty(WebProjectProperties.WAR_NAME));
props.put(WebProjectProperties.DIST_WAR_EAR, "${dist.dir}/${war.ear.name}");
if (props.getProperty(WebProjectProperties.LIBRARIES_DIR) == null) {
props.setProperty(WebProjectProperties.LIBRARIES_DIR, "${" + WebProjectProperties.WEB_DOCBASE_DIR + "}/WEB-INF/lib"); //NOI18N
}
}
if(props != null) {
//remove jsp20 and servlet24 libraries
ReferenceHelper refHelper = new ReferenceHelper(helper, cfg, helper.getStandardPropertyEvaluator());
ClassPathSupport cs = new ClassPathSupport(helper.getStandardPropertyEvaluator(), refHelper, helper,
updateHelper, new ClassPathSupportCallbackImpl(helper));
Iterator items = cs.itemsIterator(props.get( ProjectProperties.JAVAC_CLASSPATH ), ClassPathSupportCallbackImpl.TAG_WEB_MODULE_LIBRARIES);
ArrayList cpItems = new ArrayList();
while(items.hasNext()) {
ClassPathSupport.Item cpti = items.next();
String propertyName = cpti.getReference();
if(propertyName != null) {
String libname = propertyName.substring("${libs.".length());
if(libname.indexOf(".classpath}") != -1) libname = libname.substring(0, libname.indexOf(".classpath}"));
if(!("servlet24".equals(libname) || "jsp20".equals(libname))) { //NOI18N
cpItems.add(cpti);
}
}
}
String[] javac_cp = cs.encodeToStrings(cpItems, ClassPathSupportCallbackImpl.TAG_WEB_MODULE_LIBRARIES );
props.setProperty( ProjectProperties.JAVAC_CLASSPATH, javac_cp );
}
if (putProps) {
helper.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, props);
}
ProjectManager.getDefault().saveProject (this.project);
synchronized(this) {
this.isCurrent = Boolean.TRUE;
}
//fire project updated
if(projectUpdateListener != null) projectUpdateListener.projectUpdated();
//create conf dir if doesn't exist and copy default manifest inside
try {
//I cannot use ${conf.dir} since the PE doesn't know about it
//String confDir = helper.getStandardPropertyEvaluator().evaluate("${source.root}/conf"); //NOI18N
FileObject prjFO = project.getProjectDirectory();
// folder creation will throw IOE if already exists
// use the hard coded string due to issue #54882 - since the 4.0 supports creation of only jakarta structure projects the conf dir is always in project root
FileObject confDirFO = prjFO.createFolder("conf");//NOI18N
// copyfile will throw IOE if the file already exists
FileObject manifest = FileUtil.createData(confDirFO, "MANIFEST"); //NOI18N
FileLock lock = manifest.lock();
InputStream bufIn = UpdateProjectImpl.class.getResourceAsStream("/org/netbeans/modules/web/project/ui/resources/MANIFEST.MF"); //NOI18N;
OutputStream bufOut = null;
try {
lock = manifest.lock();
bufOut = manifest.getOutputStream(lock);
FileUtil.copy(bufIn, bufOut);
} finally {
if (bufIn != null) {
bufIn.close();
}
if (bufOut != null) {
bufOut.close();
}
if (lock != null) {
lock.releaseLock();
}
}
}catch(IOException e) {
//just ignore
}
}
public synchronized Element getUpdatedSharedConfigurationData () {
if (cachedElement == null) {
int version = 1;
Element oldRoot = this.cfg.getConfigurationFragment("data","http://www.netbeans.org/ns/web-project/1",true); //NOI18N
if (oldRoot == null) {
version = 2;
oldRoot = this.cfg.getConfigurationFragment("data","http://www.netbeans.org/ns/web-project/2",true); //NOI18N
}
final String ns = version == 1 ? "http://www.netbeans.org/ns/web-project/1" : "http://www.netbeans.org/ns/web-project/2"; //NOI18N
if (oldRoot != null) {
Document doc = oldRoot.getOwnerDocument();
Element newRoot = doc.createElementNS (WebProjectType.PROJECT_CONFIGURATION_NAMESPACE,"data"); //NOI18N
XMLUtil.copyDocument (oldRoot, newRoot, WebProjectType.PROJECT_CONFIGURATION_NAMESPACE);
if (version == 1) {
//1->2 upgrade
Element sourceRoots = doc.createElementNS(WebProjectType.PROJECT_CONFIGURATION_NAMESPACE,"source-roots"); //NOI18N
Element root = doc.createElementNS (WebProjectType.PROJECT_CONFIGURATION_NAMESPACE,"root"); //NOI18N
root.setAttribute ("id","src.dir"); //NOI18N
sourceRoots.appendChild(root);
newRoot.appendChild (sourceRoots);
Element testRoots = doc.createElementNS(WebProjectType.PROJECT_CONFIGURATION_NAMESPACE,"test-roots"); //NOI18N
root = doc.createElementNS (WebProjectType.PROJECT_CONFIGURATION_NAMESPACE,"root"); //NOI18N
root.setAttribute ("id","test.src.dir"); //NOI18N
testRoots.appendChild (root);
newRoot.appendChild (testRoots);
}
if (version == 1 || version == 2) {
//2->3 upgrade
NodeList libList = newRoot.getElementsByTagNameNS(ns, TAG_LIBRARY);
for (int i = 0; i < libList.getLength(); i++) {
if (libList.item(i).getNodeType() == Node.ELEMENT_NODE) {
Element library = (Element) libList.item(i);
Node webFile = library.getElementsByTagNameNS(ns, TAG_FILE).item(0);
//remove ${ and } from the beginning and end
String webFileText = XMLUtil.findText(webFile);
webFileText = webFileText.substring(2, webFileText.length() - 1);
// warIncludesMap.put(webFileText, pathInWarElements.getLength() > 0 ? findText((Element) pathInWarElements.item(0)) : Item.PATH_IN_WAR_NONE);
if (webFileText.startsWith ("lib.")) {
String libName = webFileText.substring(6, webFileText.indexOf(".classpath")); //NOI18N
List roots = LibraryManager.getDefault().getLibrary(libName).getContent("classpath"); //NOI18N
ArrayList files = new ArrayList();
ArrayList dirs = new ArrayList();
for (URL rootUrl : roots) {
FileObject root = URLMapper.findFileObject (rootUrl);
if ("jar".equals(rootUrl.getProtocol())) { //NOI18N
root = FileUtil.getArchiveFile (root);
}
if (root != null) {
if (root.isData()) {
files.add(root);
} else {
dirs.add(root);
}
}
}
if (files.size() > 0) {
library.setAttribute(ATTR_FILES, "" + files.size());
}
if (dirs.size() > 0) {
library.setAttribute(ATTR_DIRS, "" + dirs.size());
}
}
}
}
}
cachedElement = updateMinAntVersion(newRoot, doc);
}
}
return cachedElement;
}
public synchronized EditableProperties getUpdatedProjectProperties () {
if (cachedProperties == null) {
cachedProperties = this.helper.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);
ensureValueExists(cachedProperties, WebProjectProperties.JAVADOC_ADDITIONALPARAM, ""); //NOI18N //The javadoc.additionalparam was not in NB 4.0
ensureValueExists(cachedProperties, ProjectProperties.ANNOTATION_PROCESSING_ENABLED, "true"); //NOI18N
ensureValueExists(cachedProperties, ProjectProperties.ANNOTATION_PROCESSING_ENABLED_IN_EDITOR, "true"); //NOI18N
ensureValueExists(cachedProperties, ProjectProperties.ANNOTATION_PROCESSING_RUN_ALL_PROCESSORS, "true"); //NOI18N
ensureValueExists(cachedProperties, ProjectProperties.ANNOTATION_PROCESSING_PROCESSORS_LIST, ""); //NOI18N
ensureValueExists(cachedProperties, ProjectProperties.ANNOTATION_PROCESSING_SOURCE_OUTPUT, "${build.generated.sources.dir}/ap-source-output"); //NOI18N
ensureValueExists(cachedProperties, ProjectProperties.JAVAC_PROCESSORPATH,"${" + ProjectProperties.JAVAC_CLASSPATH + "}"); //NOI18N
ensureValueExists(cachedProperties, "javac.test.processorpath","${" + ProjectProperties.JAVAC_TEST_CLASSPATH + "}"); //NOI18N
}
return this.cachedProperties;
}
private static void ensureValueExists(EditableProperties prop, String property, String defaultValue) {
if (prop.get(property)==null) { //NOI18N
prop.put (property, defaultValue); //NOI18N
}
}
private static Element updateMinAntVersion (final Element root, final Document doc) {
NodeList list = root.getElementsByTagNameNS (WebProjectType.PROJECT_CONFIGURATION_NAMESPACE,TAG_MINIMUM_ANT_VERSION);
if (list.getLength() == 1) {
Element me = (Element) list.item(0);
list = me.getChildNodes();
if (list.getLength() == 1) {
me.replaceChild (doc.createTextNode(WebProjectUtilities.MINIMUM_ANT_VERSION), list.item(0));
return root;
}
}
assert false : "Invalid project file"; //NOI18N
return root;
}
private boolean showUpdateDialog() {
JButton updateOption = new JButton (NbBundle.getMessage(UpdateProjectImpl.class, "CTL_UpdateOption"));
updateOption.getAccessibleContext().setAccessibleDescription(NbBundle.getMessage(UpdateProjectImpl.class, "AD_UpdateOption"));
return DialogDisplayer.getDefault().notify(
new NotifyDescriptor (NbBundle.getMessage(UpdateProjectImpl.class,"TXT_ProjectUpdate", BUILD_NUMBER),
NbBundle.getMessage(UpdateProjectImpl.class,"TXT_ProjectUpdateTitle"),
NotifyDescriptor.DEFAULT_OPTION,
NotifyDescriptor.WARNING_MESSAGE,
new Object[] {
updateOption,
NotifyDescriptor.CANCEL_OPTION
},
updateOption)) == updateOption;
}
public void setProjectUpdateListener(ProjectUpdateListener l) {
this.projectUpdateListener = l;
}
/** Used to notify someone that the project needs to be updated.
* A workaround for #54077 - Import 4.0 project - remove Servlet/JSP APIs */
public static interface ProjectUpdateListener {
public void projectUpdated();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy