HttpPage.java

/*
 * This file is part of Waarp Project (named also Waarp or GG).
 *
 *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
 *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
 * individual contributors.
 *
 *  All Waarp Project is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along with
 * Waarp . If not, see <http://www.gnu.org/licenses/>.
 */
package org.waarp.gateway.kernel;

import io.netty.handler.codec.http.multipart.FileUpload;
import org.waarp.common.exception.FileTransferException;
import org.waarp.common.exception.InvalidArgumentException;
import org.waarp.common.logging.WaarpLogger;
import org.waarp.common.logging.WaarpLoggerFactory;
import org.waarp.common.utility.ParametersChecker;
import org.waarp.common.utility.SingletonUtils;
import org.waarp.common.utility.WaarpStringUtils;
import org.waarp.common.utility.WaarpSystemUtil;
import org.waarp.gateway.kernel.AbstractHttpField.FieldPosition;
import org.waarp.gateway.kernel.exception.HttpIncorrectRequestException;

import java.lang.reflect.InvocationTargetException;
import java.net.SocketAddress;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 *
 */
public class HttpPage {
  /**
   * Internal Logger
   */
  private static final WaarpLogger logger =
      WaarpLoggerFactory.getLogger(HttpPage.class);

  public enum PageRole {
    HTML, MENU, GETDOWNLOAD, POST, PUT, POSTUPLOAD, DELETE, ERROR
  }

  /*
   * pagename, fileform, header, footer, beginform, endform, nextinform, uri, pagerole, errorpage, classname,
   * fields
   */
  private String pagename;
  private String fileform;
  private String header;
  private String footer;
  private String beginform;
  private String endform;
  private String nextinform;
  private String uri;
  private PageRole pagerole;
  private String errorpage;
  private String classname;
  private Map<String, AbstractHttpField> fields;
  private HttpBusinessFactory httpBusinessFactory;

  /**
   * @param pagename
   * @param fileform
   * @param header
   * @param footer
   * @param beginform
   * @param endform
   * @param nextinform
   * @param uri
   * @param pagerole
   * @param errorpage
   * @param classname
   * @param fields
   *
   * @throws ClassNotFoundException
   * @throws IllegalAccessException
   * @throws InstantiationException
   */
  public HttpPage(final String pagename, final String fileform,
                  final String header, final String footer,
                  final String beginform, final String endform,
                  final String nextinform, final String uri,
                  final PageRole pagerole, final String errorpage,
                  final String classname,
                  final Map<String, AbstractHttpField> fields)
      throws ClassNotFoundException, InstantiationException,
             IllegalAccessException {
    setPagename(pagename);
    setFileform(fileform);
    if (getFileform() != null && getFileform().length() == 0) {
      setFileform(null);
    }
    setHeader(header);
    setFooter(footer);
    setBeginform(beginform);
    setEndform(endform);
    setNextinform(nextinform);
    setUri(uri);
    setPagerole(pagerole);
    setErrorpage(errorpage);
    setClassname(classname);
    setFields(fields);
    try {
      ParametersChecker.checkSanityString(classname);
    } catch (final InvalidArgumentException e) {
      throw new IllegalArgumentException(e.getMessage());
    }
    @SuppressWarnings("unchecked")
    final HttpBusinessFactory factory;
    try {
      factory =
          (HttpBusinessFactory) WaarpSystemUtil.newInstance(classname);//NOSONAR
    } catch (final InvocationTargetException e) {
      throw new InstantiationException(e.getMessage());
    }
    setHttpBusinessFactory(factory);//NOSONAR
  }

  /**
   * Called at the beginning of every request to get the current
   * HttpBusinessFactory to use.
   *
   * @param remoteAddress the remote socket address in use
   *
   * @return AbstractHttpBusinessRequest to use during the request
   */
  public AbstractHttpBusinessRequest newRequest(
      final SocketAddress remoteAddress) {
    final LinkedHashMap<String, AbstractHttpField> linkedHashMap =
        new LinkedHashMap<String, AbstractHttpField>(getFields().size());
    for (final AbstractHttpField field : getFields().values()) {
      final AbstractHttpField newfield = field.clone();
      if (getPagerole() != PageRole.MENU) {
        newfield.fieldvalue = null;
      }
      linkedHashMap.put(field.getFieldname(), newfield);
    }
    return getHttpBusinessFactory().getNewHttpBusinessRequest(remoteAddress,
                                                              linkedHashMap,
                                                              this);
  }

  public final String getPageValue(final String value) {
    if (getFileform() != null && value != null) {
      try {
        return WaarpStringUtils.readFileException(getFileform() + value);
      } catch (final FileTransferException ignored) {
        // nothing
      }
    }
    return value;
  }

  /**
   * @param reference
   *
   * @return the Html results for all pages except Get (result of a download)
   *
   * @throws HttpIncorrectRequestException
   */
  public final String getHtmlPage(final AbstractHttpBusinessRequest reference)
      throws HttpIncorrectRequestException {
    if (reference == null) {
      return "<HTML><HEADER/>ERROR</HTML>";
    }
    if (getPagerole() == PageRole.HTML) {
      return getSimpleHtml(reference);
    }
    final boolean isForm = reference.isForm();
    String value = reference.getHeader();
    if (value == null || value.length() == 0) {
      value = getPageValue(getHeader());
    }
    final StringBuilder builder;
    if (value == null) {
      builder = new StringBuilder();
    } else {
      builder = new StringBuilder(value);
    }
    final Map<String, AbstractHttpField> requestFields =
        reference.getMapHttpFields();
    setFromPossibleForm(reference, isForm, builder, requestFields);
    setFields(reference, isForm, builder, requestFields);
    finalizePage(reference, isForm, builder);
    return builder.toString();
  }

  private void finalizePage(final AbstractHttpBusinessRequest reference,
                            final boolean isForm, final StringBuilder builder) {
    String value;
    if (!isForm) {
      value = reference.getEndForm();
      if (value == null || value.length() == 0) {
        value = getPageValue(getEndform());
      }
      if (value != null) {
        builder.append(value);
      } else {
        builder.append("</TABLE><BR>");
      }
    } else {
      value = reference.getEndForm();
      if (value == null || value.length() == 0) {
        value = getPageValue(getEndform());
      }
      if (value != null) {
        builder.append(value);
      }
    }
    value = reference.getFooter();
    if (value == null || value.length() == 0) {
      value = getPageValue(getFooter());
    }
    if (value != null) {
      builder.append(value);
    }
  }

  private void setFields(final AbstractHttpBusinessRequest reference,
                         final boolean isForm, final StringBuilder builder,
                         final Map<String, AbstractHttpField> requestFields)
      throws HttpIncorrectRequestException {
    String value;
    boolean first = true;
    for (final AbstractHttpField field : requestFields.values()) {
      if (field.isFieldvisibility()) {
        // to prevent that last will have a next field form
        if (first) {
          first = false;
        } else {
          value = reference.getNextFieldInForm();
          if (value == null || value.length() == 0) {
            value = getPageValue(getNextinform());
          }
          if (value != null) {
            builder.append(value);
          }
        }
        value = reference.getFieldForm(field);
        if (value == null || value.length() == 0) {
          if (isForm) {
            value = field.getHtmlFormField(this);
          } else {
            value = field.getHtmlTabField(this);
          }
        }
        if (value != null) {
          builder.append(value);
        }
      }
    }
  }

  private void setFromPossibleForm(final AbstractHttpBusinessRequest reference,
                                   final boolean isForm,
                                   final StringBuilder builder,
                                   final Map<String, AbstractHttpField> requestFields) {
    String value;
    if (!isForm) {
      value = reference.getBeginForm();
      if (value == null || value.length() == 0) {
        value = getPageValue(getBeginform());
      }
      if (value != null) {
        builder.append(value);
      } else {
        builder.append("<BR><TABLE border=1><TR>");
        for (final AbstractHttpField field : requestFields.values()) {
          if (field.isFieldvisibility()) {
            builder.append("<TH>").append(field.getFieldinfo()).append("</TH>");
          }
        }
        builder.append("<TR>");
      }
    } else {
      value = reference.getBeginForm();
      if (value == null || value.length() == 0) {
        value = getPageValue(getBeginform());
      }
      if (value != null) {
        builder.append(value);
      }
    }
  }

  private String getSimpleHtml(final AbstractHttpBusinessRequest reference) {
    // No handling of variable management, use MENU instead
    String value = reference.getHeader();
    logger.debug("Debug: {}", value != null);
    if (value == null || value.length() == 0) {
      value = getPageValue(getHeader());
    }
    final StringBuilder builder;
    if (value == null) {
      builder = new StringBuilder();
    } else {
      builder = new StringBuilder(value);
    }
    value = reference.getBeginForm();
    if (value == null || value.length() == 0) {
      value = getPageValue(getBeginform());
    }
    if (value != null) {
      builder.append(value);
    }
    value = reference.getEndForm();
    if (value == null || value.length() == 0) {
      value = getPageValue(getEndform());
    }
    if (value != null) {
      builder.append(value);
    }
    value = reference.getFooter();
    if (value == null || value.length() == 0) {
      value = getPageValue(getFooter());
    }
    if (value != null) {
      builder.append(value);
    }
    return builder.toString();
  }

  /**
   * Set the value to the field according to fieldname.
   * <p>
   * If the field is not registered, the field is ignored.
   *
   * @param reference
   * @param fieldname
   * @param value
   * @param position
   *
   * @throws HttpIncorrectRequestException
   */
  public final void setValue(final AbstractHttpBusinessRequest reference,
                             final String fieldname, final String value,
                             final FieldPosition position)
      throws HttpIncorrectRequestException {
    if (reference == null) {
      return;
    }
    final Map<String, AbstractHttpField> requestFields =
        reference.getMapHttpFields();
    final AbstractHttpField field = requestFields.get(fieldname);
    if (field != null) {
      if (field.getFieldposition() == FieldPosition.ANY ||
          field.getFieldposition() == position) {
        field.setStringValue(value);
        if (field.isFieldtovalidate() && !reference.isFieldValid(field)) {
          throw new HttpIncorrectRequestException(
              "Field unvalid: " + fieldname);
        }
      } else {
        throw new HttpIncorrectRequestException(
            "Invalid position: " + position +
            " while field is supposed to be in " + field.getFieldposition());
      }
    }
  }

  /**
   * Set the value to the field according to fieldname.
   * <p>
   * If the field is not registered, the field is ignored.
   *
   * @param reference
   * @param fieldname
   *
   * @throws HttpIncorrectRequestException
   */
  public final void setValue(final AbstractHttpBusinessRequest reference,
                             final String fieldname,
                             final FileUpload fileUpload)
      throws HttpIncorrectRequestException {
    final Map<String, AbstractHttpField> requestFields =
        reference.getMapHttpFields();
    final AbstractHttpField field = requestFields.get(fieldname);
    if (field != null) {
      field.setFileUpload(fileUpload);
      if (field.isFieldtovalidate() && !reference.isFieldValid(field)) {
        throw new HttpIncorrectRequestException("Field unvalid: " + fieldname);
      }
    }
  }

  /**
   * @param reference
   *
   * @return True if the request is fully valid
   */
  public final boolean isRequestValid(
      final AbstractHttpBusinessRequest reference) {
    if (reference == null) {
      return true;
    }
    final Map<String, AbstractHttpField> requestFields =
        reference.getMapHttpFields();
    for (final AbstractHttpField field : requestFields.values()) {
      if (field.isFieldmandatory() && !field.isPresent()) {
        logger.warn("Request invalid since the following field is absent: " +
                    field.getFieldname());
        return false;
      }
    }
    return reference.isRequestValid();
  }

  /**
   * Convenient method to get the fields list
   *
   * @param reference
   *
   * @return the fields list from the current AbstractHttpBusinessRequest
   */
  public final Map<String, AbstractHttpField> getFieldsForRequest(
      final AbstractHttpBusinessRequest reference) {
    if (reference == null) {
      return SingletonUtils.singletonMap();
    }
    return reference.getMapHttpFields();
  }

  /**
   * Convenient method to get the value of one field
   *
   * @param reference
   * @param fieldname
   *
   * @return the String value
   */
  public final String getValue(final AbstractHttpBusinessRequest reference,
                               final String fieldname) {
    final AbstractHttpField field = reference.getMapHttpFields().get(fieldname);
    if (field != null) {
      return field.fieldvalue;
    }
    return null;
  }

  /**
   * Convenient method to get the value of one field
   *
   * @param reference
   * @param fieldname
   *
   * @return the FileUpload value
   */
  public final FileUpload getFileUpload(
      final AbstractHttpBusinessRequest reference, final String fieldname) {
    final AbstractHttpField field = reference.getMapHttpFields().get(fieldname);
    if (field != null) {
      return field.fileUpload;
    }
    return null;
  }

  /**
   * Convenient method to get one field
   *
   * @param reference
   * @param fieldname
   *
   * @return the AbstractHttpField value
   */
  public final AbstractHttpField getField(
      final AbstractHttpBusinessRequest reference, final String fieldname) {
    return reference.getMapHttpFields().get(fieldname);
  }

  /**
   * @return the pagename
   */
  public final String getPagename() {
    return pagename;
  }

  /**
   * @param pagename the pagename to set
   */
  private void setPagename(final String pagename) {
    this.pagename = pagename;
  }

  /**
   * @return the fileform
   */
  public final String getFileform() {
    return fileform;
  }

  /**
   * @param fileform the fileform to set
   */
  private void setFileform(final String fileform) {
    this.fileform = fileform;
  }

  /**
   * @return the header
   */
  public final String getHeader() {
    return header;
  }

  /**
   * @param header the header to set
   */
  private void setHeader(final String header) {
    this.header = header;
  }

  /**
   * @return the footer
   */
  public final String getFooter() {
    return footer;
  }

  /**
   * @param footer the footer to set
   */
  private void setFooter(final String footer) {
    this.footer = footer;
  }

  /**
   * @return the beginform
   */
  public final String getBeginform() {
    return beginform;
  }

  /**
   * @param beginform the beginform to set
   */
  private void setBeginform(final String beginform) {
    this.beginform = beginform;
  }

  /**
   * @return the endform
   */
  public final String getEndform() {
    return endform;
  }

  /**
   * @param endform the endform to set
   */
  private void setEndform(final String endform) {
    this.endform = endform;
  }

  /**
   * @return the nextinform
   */
  public final String getNextinform() {
    return nextinform;
  }

  /**
   * @param nextinform the nextinform to set
   */
  private void setNextinform(final String nextinform) {
    this.nextinform = nextinform;
  }

  /**
   * @return the uri
   */
  public final String getUri() {
    return uri;
  }

  /**
   * @param uri the uri to set
   */
  private void setUri(final String uri) {
    this.uri = uri;
  }

  /**
   * @return the pagerole
   */
  public final PageRole getPagerole() {
    return pagerole;
  }

  /**
   * @param pagerole the pagerole to set
   */
  private void setPagerole(final PageRole pagerole) {
    this.pagerole = pagerole;
  }

  /**
   * @return the errorpage
   */
  public final String getErrorpage() {
    return errorpage;
  }

  /**
   * @param errorpage the errorpage to set
   */
  private void setErrorpage(final String errorpage) {
    this.errorpage = errorpage;
  }

  /**
   * @return the classname
   */
  public final String getClassname() {
    return classname;
  }

  /**
   * @param classname the classname to set
   */
  private void setClassname(final String classname) {
    this.classname = classname;
  }

  /**
   * @return the fields
   */
  public final Map<String, AbstractHttpField> getFields() {
    return fields;
  }

  /**
   * @param fields the fields to set
   */
  private void setFields(final Map<String, AbstractHttpField> fields) {
    this.fields = fields;
  }

  /**
   * @return the httpBusinessFactory
   */
  public final HttpBusinessFactory getHttpBusinessFactory() {
    return httpBusinessFactory;
  }

  /**
   * @param httpBusinessFactory the httpBusinessFactory to set
   */
  private void setHttpBusinessFactory(
      final HttpBusinessFactory httpBusinessFactory) {
    this.httpBusinessFactory = httpBusinessFactory;
  }
}