org.entando.edo.builder.ControllerFileBuilder.java Source code

Introduction

Here is the source code for org.entando.edo.builder.ControllerFileBuilder.java

Source

/*
 * Copyright 2015-Present Entando Inc. (http://www.entando.com) All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */
package org.entando.edo.builder;

import java.io.File;

import org.apache.commons.lang.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.entando.edo.model.EdoBean;
import org.entando.edo.model.EdoConstants;

public class ControllerFileBuilder {

    public static Logger logger = LogManager.getLogger(ControllerFileBuilder.class);

    private static String getActionFolder(EdoBean bean) {
        String pojoPath = bean.getEdoBuilder().getJavaControllerFolder() + bean.getName().toLowerCase()
                + File.separator;
        return pojoPath;
    }

    private static String getApsAdminJspFolder(EdoBean bean) {
        String result = bean.getEdoBuilder().getWebinfApsadminFolder() + "jsp" + File.separator;
        return result;
    }

    //----------------------

    public static String getActionFilePath(EdoBean bean) {
        String filename = bean.getName() + "Action.java";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getFinderActionFilePath(EdoBean bean) {
        String filename = bean.getName() + "FinderAction.java";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getActionXmlFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + ".xml";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getPackageFilePath(EdoBean bean, String lang) {
        String filename = "package_" + lang + ".properties";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getActionValidationXmlFilePath(EdoBean bean) {
        String filename = bean.getName() + "Action-validation.xml";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getActionConversionFilePath(EdoBean bean) {
        String filename = bean.getName() + "Action-conversion.properties";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getActionFinderConversionFilePath(EdoBean bean) {
        String filename = bean.getName() + "FinderAction-conversion.properties";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getActionPropertiesFilePath(EdoBean bean, String lang) {
        String filename = "package_" + lang + ".properties";
        String finalfile = ControllerFileBuilder.getActionFolder(bean) + filename;
        return finalfile;
    }

    public static String getGlobalMessagesPropertiesFilePath(EdoBean bean, String lang) {
        String filename = "global-messages_" + lang + ".properties";
        String finalfile = bean.getEdoBuilder().getJavaControllerFolder() + filename;
        return finalfile;
    }

    public static String getActionTilesFilePath(EdoBean bean) {
        String folder = bean.getEdoBuilder().getWebinfApsadminFolder();

        String name = null;
        if (bean.getEdoBuilder().isPlugin()) {
            name = bean.getEdoBuilder().getPluginName();
        } else {
            name = bean.getEdoBuilder().getProjectName();
        }
        String filename = name + "-tiles.xml";
        return checkAndRenameFile(bean.getEdoBuilder().getBaseDir(), folder, filename);
    }

    //--- spring

    public static String getActionSpringFilePath(EdoBean bean) {
        String folder = bean.getEdoBuilder().getSpringControllerConfigFolder();
        String filename = bean.getEdoBuilder().getSpringBeanPreposition() + bean.getName() + "ActionsConfig.xml";
        String finalfile = Filebuilder.checkAndRenameFile(bean.getEdoBuilder().getBaseDir(), folder, filename);
        return finalfile;
    }

    //--- jsp

    public static String getJspListFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + "-list.jsp";
        String finalfile = getApsAdminJspFolder(bean) + bean.getName().toLowerCase() + File.separator + filename;
        return finalfile;
    }

    public static String getJspEntryFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + "-entry.jsp";
        String finalfile = getApsAdminJspFolder(bean) + bean.getName().toLowerCase() + File.separator + filename;
        return finalfile;
    }

    public static String getJspTrashFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + "-trash.jsp";
        String finalfile = getApsAdminJspFolder(bean) + bean.getName().toLowerCase() + File.separator + filename;
        return finalfile;
    }

    public static String getJspExtraResourcesListFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + "-list-extras.jsp";
        String finalfile = getApsAdminJspFolder(bean) + "common" + File.separator + "layouts" + File.separator
                + "assets-more" + File.separator + filename;
        return finalfile;
    }

    public static String getJspExtraResourcesEntryFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + "-entry-extras.jsp";
        String finalfile = getApsAdminJspFolder(bean) + "common" + File.separator + "layouts" + File.separator
                + "assets-more" + File.separator + filename;
        return finalfile;
    }

    public static String getJspExtraResourcesTrashFilePath(EdoBean bean) {
        String filename = StringUtils.uncapitalize(bean.getName()) + "-trash-extras.jsp";
        String finalfile = getApsAdminJspFolder(bean) + "common" + File.separator + "layouts" + File.separator
                + "assets-more" + File.separator + filename;
        return finalfile;
    }

    public static String getJspSubMenuFilePath(EdoBean bean) {
        String filename = "subMenu.jsp";
        String path = getApsAdminJspFolder(bean) + "common" + File.separator + "layouts" + File.separator;
        String finalfile = checkAndRenameFile(bean.getEdoBuilder().getBaseDir(), path, filename);
        return finalfile;
    }

    //----

    //---

    public static String getActionShortCutFilePath(EdoBean bean) {
        String folder = bean.getEdoBuilder().getResourcesConfigFolder("shortcuts", "apsadmin");
        String filename = "shortcuts.xml";
        String finalfile = ControllerFileBuilder.checkAndRenameFile(bean.getEdoBuilder().getBaseDir(), folder,
                filename);
        return finalfile;
    }

    public static String getActionStrutsPluginFilePath(EdoBean bean) {
        String folder = bean.getEdoBuilder().getBaseDir() + FolderConstants.getResourcesFolder();
        boolean exists = new File(folder, "entando-struts-plugin.xml").exists();
        String filename = null;
        String finalfile = null;
        if (!exists) {
            filename = "entando-struts-plugin.xml";
            finalfile = folder + filename;
        } else {
            filename = EdoConstants.FILE_NO_OVERRIDE_PREFIX + bean.getEdoBuilder().getSpringBeanPreposition() + "-"
                    + bean.getName().toLowerCase() + "-struts-plugin.xml";
            finalfile = folder + filename;
            logger.warn("\n\n*** Warning!\nThe file:\n\n\t"
                    + StringUtils.substringAfter(finalfile, bean.getEdoBuilder().getBaseDir() + File.separator)
                    + "\n\nneeds your attention!.\nPlease merge it with your existing {} or rename it according to your web.xml cofiguration.\n",
                    folder + "entando-struts-plugin");
        }
        return finalfile;
    }

    protected static String checkAndRenameFile(String workingDir, String path, String name) {
        String finalfile = path + name;
        File f = new File(finalfile);
        if (f.exists()) {
            finalfile = path + EdoConstants.FILE_NO_OVERRIDE_PREFIX + name;
            logger.warn("\n\n*** Warning!\nThe file:\n\n\t"
                    + StringUtils.substringAfter(f.getAbsolutePath(), workingDir + File.separator)
                    + "\n\nexists and will not be overwritten!.\nThe new one is:\n\n\t"
                    + StringUtils.substringAfter(finalfile, workingDir + File.separator)
                    + "\n\nmerge it by hand\n");
        }
        return finalfile;
    }

}