core/src/main/java/org/apache/struts2/url/StrutsParametersStringBuilder.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.struts2.url;

import com.opensymphony.xwork2.inject.Inject;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.util.Map;

public class StrutsParametersStringBuilder implements ParametersStringBuilder {

    private static final Logger LOG = LogManager.getLogger(StrutsParametersStringBuilder.class);

    private final UrlEncoder encoder;

    @Inject
    public StrutsParametersStringBuilder(UrlEncoder encoder) {
        this.encoder = encoder;
    }

    @Override
    public void buildParametersString(Map<String, Object> params, StringBuilder link, String paramSeparator) {
        if ((params != null) && (params.size() > 0)) {
            LOG.debug("Building query string out of: {} parameters", params.size());
            StringBuilder queryString = new StringBuilder();

            // Set params
            for (Map.Entry<String, Object> entry : params.entrySet()) {
                String name = entry.getKey();
                Object value = entry.getValue();

                if (value instanceof Iterable) {
                    for (Object o : (Iterable<?>) value) {
                        appendParameterSubstring(queryString, paramSeparator, name, o);
                    }
                } else if (value instanceof Object[]) {
                    Object[] array = (Object[]) value;
                    for (Object o : array) {
                        appendParameterSubstring(queryString, paramSeparator, name, o);
                    }
                } else {
                    appendParameterSubstring(queryString, paramSeparator, name, value);
                }
            }

            if (queryString.length() > 0) {
                if (!link.toString().contains("?")) {
                    link.append("?");
                } else {
                    link.append(paramSeparator);
                }
                link.append(queryString);
            }
        } else {
            LOG.debug("Params are empty, skipping building the query string");
        }
    }

    private void appendParameterSubstring(StringBuilder queryString, String paramSeparator, String name, Object value) {
        if (queryString.length() > 0) {
            queryString.append(paramSeparator);
        }

        String encodedName = encoder.encode(name);
        queryString.append(encodedName);

        queryString.append('=');
        if (value != null) {
            String encodedValue = encoder.encode(value.toString());
            queryString.append(encodedValue);
        }
    }

}