/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2013 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.j2seproject;

import java.io.IOException;

import org.netbeans.api.annotations.common.CheckForNull;

import org.netbeans.api.annotations.common.NonNull;

import org.netbeans.api.java.platform.JavaPlatform;

import org.netbeans.api.java.platform.JavaPlatformManager;

import org.netbeans.api.project.ProjectManager;

import org.netbeans.modules.java.api.common.ant.UpdateHelper;

import org.netbeans.modules.java.api.common.util.CommonProjectUtils;

import org.netbeans.modules.java.j2seproject.api.J2SEProjectPlatform;

import org.netbeans.modules.java.j2seproject.ui.customizer.J2SEProjectProperties;

import org.netbeans.spi.project.support.ant.AntProjectHelper;

import org.netbeans.spi.project.support.ant.EditableProperties;

import org.openide.modules.SpecificationVersion;

import org.openide.util.Mutex;

import org.openide.util.MutexException;

import org.openide.util.Parameters;

import org.openide.xml.XMLUtil;

import org.w3c.dom.Element;

/**

 *

 * @author Tomas Zezula

 */

class J2SEProjectPlatformImpl implements J2SEProjectPlatform {

    private static final String SE_PLATFORM = "j2se";   //NOI18N

    private static final String PROP_PLATFORM_ANT_NAME = "platform.ant.name";    //NOI18N

    private final J2SEProject project;

    J2SEProjectPlatformImpl(@NonNull final J2SEProject project) {

        assert project != null;

        this.project = project;

    }

    @Override

    @CheckForNull

    public JavaPlatform getProjectPlatform() {

        return ProjectManager.mutex().readAccess(new Mutex.Action<JavaPlatform>(){

            @Override

            public JavaPlatform run() {

                return CommonProjectUtils.getActivePlatform(

                    project.evaluator().getProperty(J2SEProjectProperties.JAVA_PLATFORM));

            }

        });

    }

    @Override

    public void setProjectPlatform(@NonNull final JavaPlatform platform) throws IOException {

        Parameters.notNull("platform", platform);

        if (!SE_PLATFORM.equals(platform.getSpecification().getName())) {

            throw new IllegalArgumentException(

                String.format(

                    "Not J2SE Platform: %s (%s)",       //NOI18N

                    platform.getDisplayName(),

                    platform.getSpecification().getName()));

        }

        if (platform.getInstallFolders().isEmpty()) {

            throw new IllegalArgumentException(

                String.format(

                    "Broken Platform %s",       //NOI18N

                    platform.getDisplayName()));

        }

        try {

            ProjectManager.mutex().writeAccess(new Mutex.ExceptionAction<Void>() {

                @Override

                public Void run() throws IOException {

                    final String platformId = platform.getProperties().get(PROP_PLATFORM_ANT_NAME);

                    final UpdateHelper uh = project.getUpdateHelper();

                    final EditableProperties props = uh.getProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH);

                    props.setProperty(J2SEProjectProperties.JAVA_PLATFORM, platformId);

                    uh.putProperties(AntProjectHelper.PROJECT_PROPERTIES_PATH, props);

                    updateProjectXml(platform, uh);

                    ProjectManager.getDefault().saveProject(project);

                    return null;

                }

            });

        } catch (MutexException e) {

            throw (IOException) e.getCause();

        }

    }

    static boolean updateProjectXml(

            @NonNull final JavaPlatform platform,

            @NonNull final UpdateHelper helper) {

        assert ProjectManager.mutex().isWriteAccess();

        final boolean remove = platform.equals(JavaPlatformManager.getDefault().getDefaultPlatform());

        final Element root = helper.getPrimaryConfigurationData(true);

        boolean changed = false;

        if (remove) {

            final Element platformElement = XMLUtil.findElement(

                root,

                "explicit-platform",    //NOI18N

                J2SEProject.PROJECT_CONFIGURATION_NAMESPACE);

            if (platformElement != null) {

                root.removeChild(platformElement);

                changed = true;

            }

        } else {

            Element insertBefore = null;

            for (Element e : XMLUtil.findSubElements(root)) {

                final String name = e.getNodeName();

                if (! "name".equals(name) &&                  //NOI18N

                    ! "minimum-ant-version".equals(name)) {   //NOI18N

                    insertBefore = e;

                    break;

                }

            }

            final Element platformNode = insertBefore.getOwnerDocument().createElementNS(

                    J2SEProject.PROJECT_CONFIGURATION_NAMESPACE,

                    "explicit-platform"); //NOI18N

            platformNode.setAttribute(

                    "explicit-source-supported",    //NOI18N

                    platform.getSpecification().getVersion().compareTo(new SpecificationVersion("1.3"))>0?   //NOI18N

                        "true":                                                                              //NOI18N

                        "false");                                                                            //NOI18N

            root.insertBefore(platformNode, insertBefore);

            changed = true;

        }

        if (changed) {

            helper.putPrimaryConfigurationData(root, true);

        }

        return changed;

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2013 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.j2seproject.api;

import java.io.IOException;

import org.netbeans.api.annotations.common.CheckForNull;

import org.netbeans.api.annotations.common.NonNull;

import org.netbeans.api.java.platform.JavaPlatform;

/**

 * Active {@link JavaPlatform} for J2SE project extensions.

 * Allows J2SE project extensions to obtain and set the active project platform

 * @author Tomas Zezula

 * @since 1.63

 */

public interface J2SEProjectPlatform {

    /**

     * Return the active project platform.

     * @return the active {@link JavaPlatform} or null if the

     * active platform cannot be resolved (it's broken)

     */

    @CheckForNull

    JavaPlatform getProjectPlatform();

    /**

     * Sets active project platform.

     * @param platform the platform to become active project active platform

     * @throws IOException in case of IO error.

     * @throws IllegalArgumentException if the platform is not a valid J2SE platform.

     */

    void setProjectPlatform(@NonNull final JavaPlatform platform) throws IOException;

}