com.appslandia.plum.base.RequestContextParser Maven / Gradle / Ivy

Go to download
// The MIT License (MIT)
// Copyright © 2015 AppsLandia. All rights reserved.

// 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 com.appslandia.plum.base;

import java.security.SecureRandom;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Random;

import com.appslandia.common.base.BaseEncoder;
import com.appslandia.common.base.Language;
import com.appslandia.common.converters.ConverterProvider;
import com.appslandia.common.utils.Asserts;
import com.appslandia.common.utils.ParseUtils;
import com.appslandia.common.utils.RandomUtils;
import com.appslandia.plum.utils.ServletUtils;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import jakarta.servlet.DispatcherType;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

/**
 *
 * @author Loc Ha
 *
 */
@ApplicationScoped
public class RequestContextParser {

  @Inject
  protected LanguageProvider languageProvider;

  @Inject
  protected ResourcesProvider resourcesProvider;

  @Inject
  protected ConverterProvider converterProvider;

  @Inject
  protected FormatProviderManager formatProviderManager;

  @Inject
  protected AppConfig appConfig;

  @Inject
  protected ActionParser actionParser;

  @Inject
  protected ClientIdParser clientIdParser;

  @Inject
  protected ServletModuleParser servletModuleParser;

  @Inject
  protected PrefCookieHandler prefCookieHandler;

  private static final class RandomHolder {
    static final Random instance = new SecureRandom();
  }

  protected String generateNonce() {
    int nouceSize = this.appConfig.getInt(AppConfig.CONFIG_NONCE_SIZE);
    byte[] nonce = RandomUtils.nextBytes(nouceSize, RandomHolder.instance);
    return BaseEncoder.BASE64_URL_NP.encode(nonce);
  }

  public RequestContext parse(HttpServletRequest request, HttpServletResponse response) {
    RequestContext context = (RequestContext) request.getAttribute(RequestContext.REQUEST_ATTRIBUTE_ID);
    if (context != null) {
      return context;
    }
    Asserts.isTrue(request.getDispatcherType() == DispatcherType.REQUEST);

    // Initialize RequestContext
    context = new RequestContext();
    context.setGetOrHead(HttpMethod.GET.equals(request.getMethod()) || HttpMethod.HEAD.equals(request.getMethod()));
    context.setConverterProvider(this.converterProvider);

    // PrefCookie
    PrefCookie prefCookie = this.prefCookieHandler.loadPrefCookie(request, response);
    context.setPrefCookie(prefCookie);

    // Path Items
    List pathItems = parsePathItems(request);
    String testPathLanguage = !pathItems.isEmpty() ? pathItems.get(0) : null;

    // Language
    initLangContext(request, context, testPathLanguage);

    if (context.isPathLanguage()) {
      pathItems.remove(0);
    }

    // ActionDesc
    Map pathParamMap = new HashMap<>();
    ActionDesc actionDesc = this.actionParser.parse(pathItems, pathParamMap);
    context.setActionDesc(actionDesc);
    context.setPathParamMap(Collections.unmodifiableMap(pathParamMap));

    context.setClientId(this.clientIdParser.parseId(request));
    context.setModule(getModule(request, actionDesc));

    // Input Features
    String inputFeatures = ServletUtils.getCookieValue(request, InputFeatures.COOKIE_NAME);
    context.setInputFeatures(ParseUtils.parseIntOpt(inputFeatures, null));

    // Nonce
    context.setNonce(generateNonce());
    request.setAttribute(RequestContext.REQUEST_ATTRIBUTE_ID, context);
    return context;
  }

  protected void initLangContext(HttpServletRequest request, RequestContext context, String testPathLanguage) {
    Language language = null;
    if (testPathLanguage == null) {
      language = parseLanguage(request, context.getPrefCookie());

    } else {
      language = this.languageProvider.getLanguage(testPathLanguage);
      if (language == null) {
        language = parseLanguage(request, context.getPrefCookie());
      } else {
        context.setPathLanguage(true);
      }
    }
    context.setFormatProvider(this.formatProviderManager.get(language));
    context.setResources(this.resourcesProvider.getResources(language.getLocale()));
  }

  protected Language parseLanguage(HttpServletRequest request, PrefCookie prefCookie) {
    if (this.languageProvider.isMultiLanguages()) {

      // PREF_LANGUAGE
      String prefLang = prefCookie.getString(PrefCookie.PREF_LANGUAGE_ID);
      if (prefLang != null) {

        Language language = this.languageProvider.getLanguage(prefLang);
        if (language != null) {
          return language;
        }
      }
      return this.languageProvider.getBestLanguage(request);
    }
    return this.languageProvider.getDefaultLanguage();
  }

  protected String getModule(HttpServletRequest request, ActionDesc actionDesc) {
    if (actionDesc != null) {
      return actionDesc.getModule();
    }

    String module = this.servletModuleParser.parseModule(request);
    if (module != null) {
      return module;
    }

    UserPrincipal principal = ServletUtils.getUserPrincipal(request);
    if (principal != null) {
      return principal.getModule();
    }
    return this.appConfig.getStringReq(AppConfig.CONFIG_DEFAULT_MODULE);
  }

  public static List parsePathItems(HttpServletRequest request) {
    String requestURI = request.getRequestURI();
    String contextPath = request.getContextPath();

    int startIdx = 0;
    int endIdx;
    boolean isCtxPath = true;
    List list = new ArrayList<>();

    while ((endIdx = requestURI.indexOf('/', startIdx)) != -1) {
      String pathItem = requestURI.substring(startIdx, endIdx);
      if (!pathItem.isEmpty()) {
        if (contextPath.isEmpty() || !isCtxPath) {
          list.add(pathItem);
        } else if (isCtxPath) {
          isCtxPath = false;
        }
      }
      startIdx = endIdx + 1;
    }
    if (startIdx < requestURI.length()) {
      String pathItem = requestURI.substring(startIdx);
      if (!pathItem.isEmpty()) {
        if (contextPath.isEmpty() || !isCtxPath) {
          list.add(pathItem);
        } else if (isCtxPath) {
          isCtxPath = false;
        }
      }
    }
    if (!list.isEmpty()) {
      String lastItem = list.get(list.size() - 1);
      // ;jsessionid=
      String incSid = String.format(";%s=",
          request.getServletContext().getSessionCookieConfig().getName().toLowerCase(Locale.ENGLISH));
      int idx = lastItem.indexOf(incSid);

      if (idx == 0) {
        list.remove(list.size() - 1);
      } else if (idx > 0) {
        list.set(list.size() - 1, lastItem.substring(0, idx));
      }
    }
    return list;
  }
}