com.liferay.dynamic.data.mapping.web.internal.portlet.action.DDMBaseMVCActionCommand.java Source code

Introduction

Here is the source code for com.liferay.dynamic.data.mapping.web.internal.portlet.action.DDMBaseMVCActionCommand.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. 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 com.liferay.dynamic.data.mapping.web.internal.portlet.action;

import com.liferay.dynamic.data.mapping.model.DDMStructure;
import com.liferay.dynamic.data.mapping.model.DDMTemplate;
import com.liferay.dynamic.data.mapping.model.DDMTemplateConstants;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.PortletPreferencesException;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.portlet.LiferayPortletURL;
import com.liferay.portal.kernel.portlet.PortletPreferencesFactoryUtil;
import com.liferay.portal.kernel.portlet.PortletURLFactoryUtil;
import com.liferay.portal.kernel.portlet.bridges.mvc.BaseMVCActionCommand;
import com.liferay.portal.kernel.servlet.SessionMessages;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.HttpUtil;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portlet.StrictPortletPreferencesImpl;

import java.util.Objects;

import javax.portlet.ActionRequest;
import javax.portlet.PortletPreferences;
import javax.portlet.PortletRequest;

/**
 * @author Leonardo Barros
 */
public abstract class DDMBaseMVCActionCommand extends BaseMVCActionCommand {

    protected String getRedirect(ActionRequest actionRequest) {
        String redirect = ParamUtil.getString(actionRequest, "redirect");

        String closeRedirect = ParamUtil.getString(actionRequest, "closeRedirect");

        if (Validator.isNull(closeRedirect)) {
            return redirect;
        }

        redirect = HttpUtil.setParameter(redirect, "closeRedirect", closeRedirect);

        SessionMessages.add(actionRequest,
                PortalUtil.getPortletId(actionRequest) + SessionMessages.KEY_SUFFIX_CLOSE_REDIRECT, closeRedirect);

        return redirect;
    }

    protected String getSaveAndContinueRedirect(ActionRequest actionRequest, DDMStructure structure,
            String redirect) throws Exception {

        ThemeDisplay themeDisplay = (ThemeDisplay) actionRequest.getAttribute(WebKeys.THEME_DISPLAY);

        String availableFields = ParamUtil.getString(actionRequest, "availableFields");
        String eventName = ParamUtil.getString(actionRequest, "eventName");

        LiferayPortletURL portletURL = PortletURLFactoryUtil.create(actionRequest, themeDisplay.getPpid(),
                PortletRequest.RENDER_PHASE);

        portletURL.setParameter("mvcPath", "/edit_structure.jsp");
        portletURL.setParameter("redirect", redirect, false);
        portletURL.setParameter("groupId", String.valueOf(structure.getGroupId()), false);

        long classNameId = PortalUtil.getClassNameId(DDMStructure.class);

        portletURL.setParameter("classNameId", String.valueOf(classNameId), false);

        portletURL.setParameter("classPK", String.valueOf(structure.getStructureId()), false);
        portletURL.setParameter("availableFields", availableFields, false);
        portletURL.setParameter("eventName", eventName, false);
        portletURL.setWindowState(actionRequest.getWindowState());

        return portletURL.toString();
    }

    protected String getSaveAndContinueRedirect(ActionRequest actionRequest, DDMTemplate template, String redirect)
            throws Exception {

        ThemeDisplay themeDisplay = (ThemeDisplay) actionRequest.getAttribute(WebKeys.THEME_DISPLAY);

        String portletResourceNamespace = ParamUtil.getString(actionRequest, "portletResourceNamespace");
        long classNameId = ParamUtil.getLong(actionRequest, "classNameId");
        long classPK = ParamUtil.getLong(actionRequest, "classPK");
        String structureAvailableFields = ParamUtil.getString(actionRequest, "structureAvailableFields");

        LiferayPortletURL portletURL = PortletURLFactoryUtil.create(actionRequest, themeDisplay.getPpid(),
                PortletRequest.RENDER_PHASE);

        portletURL.setParameter("mvcPath", "/edit_template.jsp");
        portletURL.setParameter("redirect", redirect, false);
        portletURL.setParameter("portletResourceNamespace", portletResourceNamespace, false);
        portletURL.setParameter("templateId", String.valueOf(template.getTemplateId()), false);
        portletURL.setParameter("groupId", String.valueOf(template.getGroupId()), false);
        portletURL.setParameter("classNameId", String.valueOf(classNameId), false);
        portletURL.setParameter("classPK", String.valueOf(classPK), false);
        portletURL.setParameter("type", template.getType(), false);
        portletURL.setParameter("structureAvailableFields", structureAvailableFields, false);
        portletURL.setWindowState(actionRequest.getWindowState());

        return portletURL.toString();
    }

    protected PortletPreferences getStrictPortletSetup(ActionRequest actionRequest) throws PortalException {

        String portletResource = ParamUtil.getString(actionRequest, "portletResource");

        ThemeDisplay themeDisplay = (ThemeDisplay) actionRequest.getAttribute(WebKeys.THEME_DISPLAY);

        return getStrictPortletSetup(themeDisplay.getLayout(), portletResource);
    }

    protected PortletPreferences getStrictPortletSetup(Layout layout, String portletId) throws PortalException {

        if (Validator.isNull(portletId)) {
            return null;
        }

        PortletPreferences portletPreferences = PortletPreferencesFactoryUtil.getStrictPortletSetup(layout,
                portletId);

        if (portletPreferences instanceof StrictPortletPreferencesImpl) {
            throw new PortletPreferencesException.MustBeStrict(portletId);
        }

        return portletPreferences;
    }

    protected void setRedirectAttribute(ActionRequest actionRequest) {
        String redirect = getRedirect(actionRequest);

        actionRequest.setAttribute(WebKeys.REDIRECT, redirect);
    }

    protected void setRedirectAttribute(ActionRequest actionRequest, DDMStructure structure) throws Exception {

        String redirect = getRedirect(actionRequest);

        boolean saveAndContinue = ParamUtil.getBoolean(actionRequest, "saveAndContinue");

        if (saveAndContinue) {
            redirect = getSaveAndContinueRedirect(actionRequest, structure, redirect);
        }

        actionRequest.setAttribute(WebKeys.REDIRECT, redirect);
    }

    protected void setRedirectAttribute(ActionRequest actionRequest, DDMTemplate template) throws Exception {

        String redirect = getRedirect(actionRequest);

        boolean saveAndContinue = ParamUtil.getBoolean(actionRequest, "saveAndContinue");

        if (saveAndContinue) {
            redirect = getSaveAndContinueRedirect(actionRequest, template, redirect);
        }

        actionRequest.setAttribute(WebKeys.REDIRECT, redirect);
    }

    protected void updatePortletPreferences(ActionRequest actionRequest, DDMTemplate template) throws Exception {

        PortletPreferences portletPreferences = getStrictPortletSetup(actionRequest);

        if (portletPreferences == null) {
            return;
        }

        if (Objects.equals(template.getType(), DDMTemplateConstants.TEMPLATE_TYPE_DISPLAY)) {

            portletPreferences.setValue("displayDDMTemplateId", String.valueOf(template.getTemplateId()));
        } else if (Objects.equals(template.getMode(), DDMTemplateConstants.TEMPLATE_MODE_CREATE)) {

            portletPreferences.setValue("formDDMTemplateId", String.valueOf(template.getTemplateId()));
        }

        portletPreferences.store();
    }

}