com.adobe.acs.commons.wcm.impl.TagWidgetConfigurationServlet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation
Main ACS AEM Commons OSGi Bundle. Includes commons utilities.
There is a newer version: 6.6.0
Show newest version
/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2014 Adobe
 * %%
 * Licensed 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.
 * #L%
 */
package com.adobe.acs.commons.wcm.impl;

import java.io.IOException;
import java.util.Iterator;
import java.util.Map;

import javax.servlet.ServletException;

import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.sling.SlingServlet;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.request.RequestParameter;
import org.apache.sling.api.request.RequestParameterMap;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.osgi.PropertiesUtil;

import com.adobe.acs.commons.util.PathInfoUtil;
import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import org.apache.sling.xss.XSSAPI;

/**
 * Servlet which allows for dynamic selection of tag widget configuration. To
 * use in a component, specify the xtype of
 *
 *  * slingscriptinclude
 * 
 *
 * and set the script to
 *
 *  * tagwidget.CONFIGNAME.FIELDNAME.json.jsp
 * 
 *
 * This will iterate through nodes under /etc/tagconfig to find a matching site
 * (by regex). Then, look for a node named CONFIGNAME and use that
 * configuration.
 */
@SuppressWarnings("serial")
@SlingServlet(extensions = "json", selectors = "tagwidget", resourceTypes = "sling/servlet/default")
public class TagWidgetConfigurationServlet extends AbstractWidgetConfigurationServlet {

    private static final String DEFAULT_CONFIG_NAME = "default";

    @Reference
    private transient XSSAPI xssApi;

    private static final String DEFAULT_CONFIG = "/libs/foundation/components/page/tab_basic/items/basic/items/tags";

    private static final String DEFAULT_ROOT_PATH = "/etc/tagconfig";

    @Property(value = DEFAULT_ROOT_PATH)
    private static final String PROP_ROOT_PATH = "root.path";

    private String rootPath;

    @Activate
    protected void activate(Map props) {
        rootPath = PropertiesUtil.toString(props.get(PROP_ROOT_PATH), DEFAULT_ROOT_PATH);
    }

    @Override
    @SuppressWarnings("squid:S3776")
    protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServletException,
            IOException {
        String componentPath = request.getResource().getPath();

        String configName = PathInfoUtil.getSelector(request, 1, DEFAULT_CONFIG_NAME);

        // the actual property name
        String propertyName = PathInfoUtil.getSelector(request, 2, "tags");

        Resource root = request.getResourceResolver().getResource(rootPath);
        if (root != null) {
            Iterator children = root.listChildren();
            while (children.hasNext()) {
                Resource child = children.next();
                if (matches(componentPath, child)) {
                    Resource config = child.getChild(configName);
                    if (config == null) {
                        config = child.getChild(DEFAULT_CONFIG_NAME);
                    }
                    if (config != null) {
                        writeConfigResource(config, propertyName, request, response);
                        return;
                    }
                }
            }
        }

        returnDefault(propertyName, request, response);

    }

    @Override
    protected JsonObject createEmptyWidget(String propertyName) {
        JsonObject object = new JsonObject();
        object.addProperty("xtype", "tags");
        object.addProperty("name", "./" + xssApi.encodeForJSString(propertyName));
        object.addProperty("fieldLabel", "Tags/Keywords");
        object.addProperty("jcr:primaryType", "cq:Widget");
        return object;
    }

    private void returnDefault(String propertyName, SlingHttpServletRequest request, SlingHttpServletResponse response)
            throws IOException, ServletException {
        response.setContentType("application/json");
        Resource root = request.getResourceResolver().getResource(DEFAULT_CONFIG);
        if (root == null) {
            writeEmptyWidget(propertyName, response);
            return;
        }

        writeConfigResource(root, propertyName, request, response);
    }

    private void writeConfigResource(Resource resource, String propertyName,
            SlingHttpServletRequest request, SlingHttpServletResponse response) throws IOException,
            ServletException {
        JsonObject widget = createEmptyWidget(propertyName);

        RequestParameterMap map = request.getRequestParameterMap();
        for (Map.Entry entry : map.entrySet()) {
            String key = entry.getKey();
            RequestParameter[] params = entry.getValue();
            if (params != null) {
                if (params.length > 1) {
                    JsonArray arr = new JsonArray();
                    for (int i = 0; i < params.length; i++) {
                        arr.add(new JsonPrimitive(params[i].getString()));
                    }
                    widget.add(key, arr);
                } else if (params.length == 1) {
                    widget.addProperty(key, params[0].getString());
                }
            }
        }

        widget = underlay(widget, resource);

        JsonObject parent = new JsonObject();
        parent.addProperty("xtype", "dialogfieldset");
        parent.addProperty("border", false);
        parent.addProperty("padding", 0);
        parent.addProperty("style", "padding: 0px");
        parent.add("items", widget);
        Gson gson = new Gson();
        gson.toJson(parent, response.getWriter());
    }

}