com.liferay.portlet.portletconfiguration.action.EditPublicRenderParametersAction.java Source code

Introduction

Here is the source code for com.liferay.portlet.portletconfiguration.action.EditPublicRenderParametersAction.java

Source

/**
 * Copyright (c) 2000-2012 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.portlet.portletconfiguration.action;

import com.liferay.portal.kernel.servlet.SessionErrors;
import com.liferay.portal.kernel.servlet.SessionMessages;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.model.Layout;
import com.liferay.portal.model.Portlet;
import com.liferay.portal.model.PublicRenderParameter;
import com.liferay.portal.security.auth.PrincipalException;
import com.liferay.portal.theme.ThemeDisplay;
import com.liferay.portal.util.PortalUtil;
import com.liferay.portal.util.WebKeys;
import com.liferay.portlet.PortletPreferencesFactoryUtil;
import com.liferay.portlet.portletconfiguration.util.PublicRenderParameterConfiguration;

import java.util.Enumeration;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.PortletConfig;
import javax.portlet.PortletPreferences;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;

import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;

/**
 * @author Alberto Montero
 */
public class EditPublicRenderParametersAction extends EditConfigurationAction {

    @Override
    public void processAction(ActionMapping mapping, ActionForm form, PortletConfig portletConfig,
            ActionRequest actionRequest, ActionResponse actionResponse) throws Exception {

        Portlet portlet = null;

        try {
            portlet = getPortlet(actionRequest);
        } catch (PrincipalException pe) {
            SessionErrors.add(actionRequest, PrincipalException.class.getName());

            setForward(actionRequest, "portlet.portlet_configuration.error");
        }

        updatePreferences(actionRequest, portlet);

        if (SessionErrors.isEmpty(actionRequest)) {
            String portletResource = ParamUtil.getString(actionRequest, "portletResource");

            SessionMessages.add(actionRequest,
                    portletConfig.getPortletName() + SessionMessages.KEY_SUFFIX_REFRESH_PORTLET, portletResource);

            SessionMessages.add(actionRequest,
                    portletConfig.getPortletName() + SessionMessages.KEY_SUFFIX_UPDATED_CONFIGURATION);

            String redirect = PortalUtil.escapeRedirect(ParamUtil.getString(actionRequest, "redirect"));

            if (Validator.isNotNull(redirect)) {
                actionResponse.sendRedirect(redirect);
            }
        }
    }

    @Override
    public ActionForward render(ActionMapping mapping, ActionForm form, PortletConfig portletConfig,
            RenderRequest renderRequest, RenderResponse renderResponse) throws Exception {

        Portlet portlet = null;

        try {
            portlet = getPortlet(renderRequest);
        } catch (PrincipalException pe) {
            SessionErrors.add(renderRequest, PrincipalException.class.getName());

            return mapping.findForward("portlet.portlet_configuration.error");
        }

        ActionUtil.getLayoutPublicRenderParameters(renderRequest);

        ActionUtil.getPublicRenderParameterConfigurationList(renderRequest, portlet);

        renderResponse.setTitle(getTitle(portlet, renderRequest));

        return mapping.findForward(
                getForward(renderRequest, "portlet.portlet_configuration.edit_public_render_parameters"));
    }

    protected void updatePreferences(ActionRequest actionRequest, Portlet portlet) throws Exception {

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

        Layout layout = themeDisplay.getLayout();

        PortletPreferences preferences = PortletPreferencesFactoryUtil.getLayoutPortletSetup(layout,
                portlet.getPortletId());

        Enumeration<String> enu = preferences.getNames();

        while (enu.hasMoreElements()) {
            String name = enu.nextElement();

            if (name.startsWith(PublicRenderParameterConfiguration.IGNORE_PREFIX)
                    || name.startsWith(PublicRenderParameterConfiguration.MAPPING_PREFIX)) {

                preferences.reset(name);
            }
        }

        for (PublicRenderParameter publicRenderParameter : portlet.getPublicRenderParameters()) {

            String ignoreKey = PublicRenderParameterConfiguration.getIgnoreKey(publicRenderParameter);

            boolean ignoreValue = ParamUtil.getBoolean(actionRequest, ignoreKey);

            if (ignoreValue) {
                preferences.setValue(ignoreKey, String.valueOf(Boolean.TRUE));
            } else {
                String mappingKey = PublicRenderParameterConfiguration.getMappingKey(publicRenderParameter);

                String mappingValue = ParamUtil.getString(actionRequest, mappingKey);

                if (Validator.isNotNull(mappingValue)) {
                    preferences.setValue(mappingKey, mappingValue);
                }
            }
        }

        if (SessionErrors.isEmpty(actionRequest)) {
            preferences.store();
        }
    }

}