org.codelibs.fess.api.BaseApiManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fess Show documentation
Fess is Full tExt Search System.
There is a newer version: 14.18.0
/*
 * Copyright 2012-2020 CodeLibs Project and the Others.
 *
 * 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.
 */
package org.codelibs.fess.api;

import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.util.Locale;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.codelibs.core.exception.IORuntimeException;
import org.codelibs.fess.Constants;
import org.lastaflute.web.util.LaRequestUtil;
import org.lastaflute.web.util.LaResponseUtil;

public abstract class BaseApiManager implements WebApiManager {

    private static final String API_FORMAT_TYPE = "apiFormatType";

    protected String pathPrefix;

    protected enum FormatType {
        SEARCH, LABEL, POPULARWORD, FAVORITE, FAVORITES, OTHER, PING, SCROLL;
    }

    public String getPathPrefix() {
        return pathPrefix;
    }

    public void setPathPrefix(final String pathPrefix) {
        this.pathPrefix = pathPrefix;
    }

    protected FormatType getFormatType(final HttpServletRequest request) {
        FormatType formatType = (FormatType) request.getAttribute(API_FORMAT_TYPE);
        if (formatType != null) {
            return formatType;
        }
        String value = request.getParameter("type");
        if (value == null) {
            final String servletPath = request.getServletPath();
            final String[] values = servletPath.replaceAll("/+", "/").split("/");
            if (values.length > 2) {
                value = values[2];
            }
        }
        if (value == null) {
            formatType = FormatType.SEARCH;
        } else {
            final String type = value.toUpperCase(Locale.ROOT);
            if (FormatType.SEARCH.name().equals(type)) {
                formatType = FormatType.SEARCH;
            } else if (FormatType.LABEL.name().equals(type)) {
                formatType = FormatType.LABEL;
            } else if (FormatType.POPULARWORD.name().equals(type)) {
                formatType = FormatType.POPULARWORD;
            } else if (FormatType.FAVORITE.name().equals(type)) {
                formatType = FormatType.FAVORITE;
            } else if (FormatType.FAVORITES.name().equals(type)) {
                formatType = FormatType.FAVORITES;
            } else if (FormatType.PING.name().equals(type)) {
                formatType = FormatType.PING;
            } else if (FormatType.SCROLL.name().equals(type)) {
                formatType = FormatType.SCROLL;
            } else {
                // default
                formatType = FormatType.OTHER;
            }
        }
        request.setAttribute(API_FORMAT_TYPE, formatType);
        return formatType;
    }

    protected void write(final String text, final String contentType, final String encoding) {
        final StringBuilder buf = new StringBuilder(50);
        if (contentType == null) {
            buf.append("text/plain");
        } else {
            buf.append(contentType);
        }
        buf.append("; charset=");
        final String enc;
        if (encoding == null) {
            if (LaRequestUtil.getRequest().getCharacterEncoding() == null) {
                enc = Constants.UTF_8;
            } else {
                enc = LaRequestUtil.getRequest().getCharacterEncoding();
            }
        } else {
            enc = encoding;
        }
        buf.append(enc);
        final HttpServletResponse response = LaResponseUtil.getResponse();
        response.setContentType(buf.toString());
        writeHeaders(response);
        try (PrintWriter out = new PrintWriter(new OutputStreamWriter(response.getOutputStream(), enc))) {
            out.print(text);
        } catch (final IOException e) {
            throw new IORuntimeException(e);
        }
    }

    protected abstract void writeHeaders(final HttpServletResponse response);
}