com.composum.sling.core.servlet.TranslationServlet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of composum-nodes-commons Show documentation
general components and objects to use the Sling API
There is a newer version: 4.3.4
Show newest version
package com.composum.sling.core.servlet;

import com.composum.sling.core.CoreConfiguration;
import com.composum.sling.core.ResourceHandle;
import com.composum.sling.core.Restricted;
import com.composum.sling.core.logging.Message;
import com.composum.sling.core.service.ServiceRestrictions;
import com.composum.sling.core.service.RestrictedService;
import com.composum.sling.core.service.TranslationService;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.HttpConstants;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.Servlet;
import javax.servlet.ServletException;
import java.io.BufferedReader;
import java.io.IOException;
import java.util.Collection;
import java.util.Map;

import static com.composum.sling.core.servlet.TranslationServlet.SERVICE_KEY;
import static javax.servlet.http.HttpServletResponse.SC_ACCEPTED;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
import static javax.servlet.http.HttpServletResponse.SC_OK;

@Component(service = {Servlet.class, RestrictedService.class},
        property = {
                Constants.SERVICE_DESCRIPTION + "=Composum Nodes Translation Servlet",
                ServletResolverConstants.SLING_SERVLET_PATHS + "=" + TranslationServlet.SERVLET_PATH,
                ServletResolverConstants.SLING_SERVLET_EXTENSIONS + "=json",
                ServletResolverConstants.SLING_SERVLET_METHODS + "=" + HttpConstants.METHOD_PUT
        }
)
@Restricted(key = SERVICE_KEY)
public class TranslationServlet extends AbstractServiceServlet {

    private static final Logger LOG = LoggerFactory.getLogger(TranslationServlet.class);

    public static final String SERVICE_KEY = "core/commons/translation";

    public static final String SERVLET_PATH = "/bin/cpm/core/translate";

    public static final String STATUS = "status";
    public static final String SUCCESS = "success";
    public static final String WARNING = "warning";

    public static final String TITLE = "title";
    public static final String MESSAGES = "messages";
    public static final String LEVEL = "level";
    public static final String CONTEXT = "context";
    public static final String LABEL = "label";
    public static final String TEXT = "text";
    public static final String HINT = "hint";

    public static final String DATA = "data";

    public static final String BOOTSTRAP_ERROR = "danger";

    public enum Extension {json}

    public enum Operation {object, status}

    protected ServletOperationSet operations = new ServletOperationSet<>(Extension.json);

    @Reference
    private ServiceRestrictions restrictions;

    @Reference
    private CoreConfiguration coreConfig;

    @Reference
    private TranslationService translationService;

    @Override
    @NotNull
    protected ServletOperationSet getOperations() {
        return operations;
    }

    @Override
    @NotNull
    public ServiceRestrictions.Key getServiceKey() {
        return new ServiceRestrictions.Key(SERVICE_KEY);
    }

    @Override
    @NotNull
    protected ServiceRestrictions.Permission methodPutPermission(@NotNull final SlingHttpServletRequest request) {
        return ServiceRestrictions.Permission.read;
    }

    @Override
    public void init() throws ServletException {
        super.init();
        operations.setOperation(ServletOperationSet.Method.PUT, Extension.json, Operation.object, new TranslateObject());
        operations.setOperation(ServletOperationSet.Method.PUT, Extension.json, Operation.status, new TranslateStatus());
    }

    /**
     * Translates (i18n) all strings in a given JSON.
     */
    protected class TranslateObject implements ServletOperation {

        @Override
        public void doIt(@NotNull final SlingHttpServletRequest request,
                         @NotNull final SlingHttpServletResponse response,
                         @Nullable final ResourceHandle resource)
                throws IOException {
            response.setStatus(SC_OK);
            response.setContentType("application/json; charset=UTF-8");
            translationService.translate(request, request.getReader(), response.getWriter());
        }
    }

    /**
     * Translates (i18n) status-like information into a Status.
     */
    protected class TranslateStatus implements ServletOperation {

        @Override
        public void doIt(@NotNull final SlingHttpServletRequest request,
                         @NotNull final SlingHttpServletResponse response,
                         @Nullable final ResourceHandle resource)
                throws IOException {
            Status status = new Status(request, response);
            readFrom(request.getReader(), status);
            status.sendJson(SC_OK); // the normal i18n of Status and its Messages takes care of the translation.
        }

        /**
         * Parses the request format.
         */
        @SuppressWarnings("unchecked")
        protected void readFrom(BufferedReader reader, Status status) {
            Map data = status.getGson().fromJson(reader, Map.class);
            Object value;
            if ((value = data.get(TITLE)) != null) {
                status.setTitle(value.toString());
            }
            boolean success = false;
            if ((value = data.get(SUCCESS)) instanceof Boolean) {
                success = (Boolean) value;
                if (success) {
                    status.setStatus(SC_OK);
                } else {
                    status.setStatus(SC_BAD_REQUEST);
                    if (!status.hasTitle()) {
                        status.setTitle("Error");
                    }
                }
            }
            if ((value = data.get(WARNING)) instanceof Boolean) {
                status.setWarning((Boolean) value);
                if (success) {
                    status.setStatus(SC_ACCEPTED);
                }
                if (!status.hasTitle()) {
                    status.setTitle("Warning");
                }
            }
            if ((value = data.get(STATUS)) != null) {
                status.setStatus(value instanceof Integer ? (Integer) value : Integer.parseInt(value.toString()));
            }
            if ((value = data.get(MESSAGES)) instanceof Collection) {
                for (Object val : ((Collection) value)) {
                    if (val instanceof Map) {
                        //noinspection rawtypes
                        status.addMessage(parseMessage((Map) val));
                    }
                }
            }

        }

        /**
         * Reads a message from the input format.
         */
        protected Message parseMessage(Map data) {
            Object value;
            Object hint = data.get(HINT);
            Message.Level level = (value = data.get(LEVEL)) != null ? levelOf(value.toString()) : Message.Level.info;
            String context = (value = data.get(CONTEXT)) != null ? value.toString() : null;
            String label = (value = data.get(LABEL)) != null ? value.toString() : null;
            String text = (value = data.get(TEXT)) != null ? value.toString() : "";
            return new Message(level, text, hint).setContext(context).setLabel(label);
        }

        public static final String BOOTSTRAP_ERROR = "danger";

        @NotNull
        public Message.Level levelOf(@NotNull String name) {
            if (BOOTSTRAP_ERROR.equalsIgnoreCase(name)) {
                name = Message.Level.error.name();
            }
            return Message.Level.valueOf(name);
        }

    }
}