All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.primefaces.clientwindow.PrimeClientWindow Maven / Gradle / Ivy

There is a newer version: 14.0.0
Show newest version
/*
 * The MIT License
 *
 * Copyright (c) 2009-2023 PrimeTek Informatics
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.primefaces.clientwindow;

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.faces.FacesException;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.lifecycle.ClientWindow;
import javax.faces.render.ResponseStateManager;
import javax.servlet.http.HttpServletResponse;
import org.primefaces.util.LangUtils;

public class PrimeClientWindow extends ClientWindow {

    private String id;

    @Override
    public Map getQueryURLParameters(FacesContext context) {
        return Collections.emptyMap();
    }

    @Override
    public String getId() {
        return id;
    }

    @Override
    public void decode(FacesContext context) {
        id = context.getExternalContext().getRequestParameterMap().get(ResponseStateManager.CLIENT_WINDOW_URL_PARAM);

        boolean post = PrimeClientWindowUtils.isPost(context);

        if (LangUtils.isBlank(id) && post) {
            id = context.getExternalContext().getRequestParameterMap().get(ResponseStateManager.CLIENT_WINDOW_PARAM);
        }

        if (LangUtils.isNotBlank(id)) {
            id = PrimeClientWindowUtils.secureWindowId(id);
        }

        if (LangUtils.isBlank(id)) {
            id = PrimeClientWindowUtils.generateNewWindowId();

            if (!post) {
                try {
                    // this will also include the new generated windowId
                    String redirectUrl = constructInitialRedirectUrl(context);

                    // remember the initial redirect windowId till the next request - see DeltaSpike #729
                    PrimeClientWindowUtils.addInitialRedirectCookie(context, id);

                    context.getExternalContext().redirect(redirectUrl);
                }
                catch (IOException e) {
                    throw new FacesException("Could not send initial redirect!", e);
                }

                context.responseComplete();
            }
        }
    }

    /**
     * Constructs the URL for the initialRedirect, which equals the current requested URL + the window id candidate.
     * We cant use
     * {@link javax.faces.application.ViewHandler#getBookmarkableURL(javax.faces.context.FacesContext, java.lang.String, java.util.Map, boolean)}
     * as the ViewRoot isn't available yet in the {@link FacesContext}.
     * Same applies for {@link ExternalContext#encodeRedirectURL(java.lang.String, java.util.Map)}.
     *
     * @param context The {@link FacesContext}.
     * @return The initial-redirect URL.
     */
    protected String constructInitialRedirectUrl(FacesContext context) {
        ExternalContext externalContext = context.getExternalContext();

        String url = externalContext.getRequestContextPath() + externalContext.getRequestServletPath();
        if (externalContext.getRequestPathInfo() != null) {
            url += externalContext.getRequestPathInfo();
        }

        Map> parameters = new HashMap<>();
        for (Map.Entry entry : externalContext.getRequestParameterValuesMap().entrySet()) {
            List values = parameters.computeIfAbsent(entry.getKey(), k -> new ArrayList<>(1));
            if (entry.getValue() != null) {
                values.addAll(Arrays.asList(entry.getValue()));
            }
        }
        parameters.put(ResponseStateManager.CLIENT_WINDOW_URL_PARAM, Arrays.asList(id));

        url = appendParameters(externalContext, url, parameters);

        // use servlet if available to avoid resource push
        if (externalContext.getResponse() instanceof HttpServletResponse) {
            url = ((HttpServletResponse) externalContext.getResponse()).encodeURL(url);
        }
        else {
            //only #encodeResourceURL is portable currently, maybe Portlet doesnt implement resource push
            url = externalContext.encodeResourceURL(url);
        }

        return url;
    }

    protected String appendParameters(ExternalContext externalContext, String url, Map> parameters) {
        StringBuilder urlBuilder = new StringBuilder(url);
        boolean existingParameters = url.contains("?");

        for (Map.Entry> entry : parameters.entrySet()) {
            String name = entry.getKey();

            for (String value : entry.getValue()) {
                if (LangUtils.isEmpty(name) && LangUtils.isEmpty(value)) {
                    continue;
                }

                if (url.contains(name + "=" + value)
                        || url.contains(name + "=" + encodeURLParameterValue(value, externalContext))) {
                    continue;
                }

                if (!existingParameters) {
                    urlBuilder.append("?");
                    existingParameters = true;
                }
                else {
                    urlBuilder.append("&");
                }

                urlBuilder.append(encodeURLParameterValue(name, externalContext))
                    .append("=")
                    .append(encodeURLParameterValue(value, externalContext));
            }
        }

        return urlBuilder.toString();
    }

    /**
     * Encodes the given value using URLEncoder.encode() with the charset returned
     * from ExternalContext.getResponseCharacterEncoding().
     * This is exactly how the ExternalContext impl encodes URL parameter values.
     *
     * @param value           value which should be encoded
     * @param externalContext current external-context
     * @return encoded value
     */
    protected String encodeURLParameterValue(String value, ExternalContext externalContext) {
        try {
            return URLEncoder.encode(value, externalContext.getResponseCharacterEncoding());
        }
        catch (UnsupportedEncodingException e) {
            throw new UnsupportedOperationException("Encoding type="
                    + externalContext.getResponseCharacterEncoding() + " not supported", e);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy