fish.payara.deployment.admin.PayaraTransformer Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2020 Payara Foundation and/or its affiliates. All rights reserved.
 *
 * 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
 * https://github.com/payara/Payara/blob/master/LICENSE.txt
 * 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 glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * 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 don't 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.
 */
package fish.payara.deployment.admin;

import com.sun.enterprise.util.LocalStringManagerImpl;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
import java.util.Comparator;
import static org.eclipse.transformer.Transformer.SUCCESS_RC;
import org.eclipse.transformer.payara.JakartaNamespaceTransformer;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.hk2.classmodel.reflect.Type;
import org.glassfish.hk2.classmodel.reflect.Types;

/**
 * Transforms jakarta.* namespace to javax.* and vice-versa.
 * 
 * @author [email protected]
 */
public class PayaraTransformer {

    public static final String TRANSFORM_NAMESPACE = "fish.payara.deployment.transform.namespace";

    private static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(PayaraTransformer.class);

    private static final String[] commonJavaxClasses = {
        "javax.inject.Inject",
        "javax.servlet.http.HttpServlet",
        "javax.ws.rs.core.Application",
        "javax.persistence.Entity"
    };
    private static final String[] commonJakartaClasses = {
        "jakarta.inject.Inject",
        "jakarta.servlet.http.HttpServlet",
        "jakarta.ws.rs.core.Application",
        "jakarta.persistence.Entity"
    };
    private static final String JAKARTA_PACKAGE_PREFIX = "jakarta.";

    public static boolean isJakartaEEApplication(Types types) {

        // Quick check for the most common Javax/Jakarta APIs
        for (String _class : commonJavaxClasses) {
            if (types.getBy(_class) != null) {
                return false;
            }
        }
        for (String _class : commonJakartaClasses) {
            if (types.getBy(_class) != null) {
                return true;
            }
        }
        // If not found scan all classes
        for (Type classType : types.getAllTypes()) {
            if (classType.getName().startsWith(JAKARTA_PACKAGE_PREFIX)) {
                return true;
            }
        }
        return false;
    }

    public static File transformApplication(File path, AdminCommandContext context, boolean isDirectoryDeployed) throws IOException {
        JakartaNamespaceTransformer transformer = new JakartaNamespaceTransformer(
                context.getLogger(), path, true
        );
        int result = transformer.run();
        if (result == SUCCESS_RC) {
            File output = transformer.getOutput();
            Path newPath = output.toPath();
            if (!isDirectoryDeployed) {
                Files.walk(path.toPath())
                        .sorted(Comparator.reverseOrder())
                        .map(Path::toFile)
                        .forEach(File::delete);
                newPath = Files.move(output.toPath(), path.toPath());
                if (newPath == null) {
                    String msg = localStrings.getLocalString("application.namespace.transform.failed", "Application namespace transformation failed");
                    context.getActionReport().failure(context.getLogger(), msg);
                    return null;
                }
            }
            return newPath.toFile();
        } else {
            String msg = localStrings.getLocalString("application.namespace.transform.failed", "Application namespace transformation failed");
            context.getActionReport().failure(context.getLogger(), msg);
            return null;
        }
    }

}