HttpRestInformationR66Handler.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.openr66.protocol.http.rest.handler;

import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import io.netty.handler.codec.http.HttpResponseStatus;
import org.waarp.common.database.data.AbstractDbData;
import org.waarp.common.exception.InvalidArgumentException;
import org.waarp.common.json.JsonHandler;
import org.waarp.common.logging.WaarpLogger;
import org.waarp.common.logging.WaarpLoggerFactory;
import org.waarp.gateway.kernel.exception.HttpIncorrectRequestException;
import org.waarp.gateway.kernel.exception.HttpInvalidAuthenticationException;
import org.waarp.gateway.kernel.rest.DataModelRestMethodHandler.COMMAND_TYPE;
import org.waarp.gateway.kernel.rest.HttpRestHandler;
import org.waarp.gateway.kernel.rest.HttpRestHandler.METHOD;
import org.waarp.gateway.kernel.rest.RestArgument;
import org.waarp.gateway.kernel.rest.RestConfiguration;
import org.waarp.openr66.database.data.DbTaskRunner;
import org.waarp.openr66.protocol.exception.OpenR66ProtocolNoDataException;
import org.waarp.openr66.protocol.exception.OpenR66ProtocolNotAuthenticatedException;
import org.waarp.openr66.protocol.exception.OpenR66ProtocolPacketException;
import org.waarp.openr66.protocol.http.rest.HttpRestR66Handler;
import org.waarp.openr66.protocol.http.rest.HttpRestR66Handler.RESTHANDLERS;
import org.waarp.openr66.protocol.localhandler.ServerActions;
import org.waarp.openr66.protocol.localhandler.packet.InformationPacket;
import org.waarp.openr66.protocol.localhandler.packet.ValidPacket;
import org.waarp.openr66.protocol.localhandler.packet.json.InformationJsonPacket;
import org.waarp.openr66.protocol.localhandler.packet.json.JsonPacket;

/**
 * Info Http REST interface: http://host/info?... + InformationJsonPacket as GET
 */
public class HttpRestInformationR66Handler extends HttpRestAbstractR66Handler {

  public static final String BASEURI = "info";
  /**
   * Internal Logger
   */
  private static final WaarpLogger logger =
      WaarpLoggerFactory.getLogger(HttpRestInformationR66Handler.class);

  public HttpRestInformationR66Handler(final RestConfiguration config,
                                       final METHOD... methods) {
    super(BASEURI, config, METHOD.OPTIONS);
    setIntersectionMethods(methods, METHOD.GET);
  }

  @Override
  public final void endParsingRequest(final HttpRestHandler handler,
                                      final RestArgument arguments,
                                      final RestArgument result,
                                      final Object body)
      throws HttpIncorrectRequestException, HttpInvalidAuthenticationException {
    try {
      HttpRestV1Utils.checkSanity(arguments);
    } catch (final InvalidArgumentException e) {
      throw new HttpIncorrectRequestException("Issue on values", e);
    }
    logger.debug("debug: {} ### {}", arguments, result);
    if (body != null) {
      logger.debug("Obj: {}", body);
    }
    handler.setWillClose(false);
    final ServerActions serverHandler =
        ((HttpRestR66Handler) handler).getServerHandler();
    // now action according to body
    final JsonPacket json = (JsonPacket) body;
    if (json == null) {
      result.setDetail("not enough information");
      setError(handler, result, HttpResponseStatus.BAD_REQUEST);
      return;
    }
    result.getAnswer()
          .put(AbstractDbData.JSON_MODEL, RESTHANDLERS.Information.name());
    try {
      if (json instanceof InformationJsonPacket) {//
        final InformationJsonPacket node = (InformationJsonPacket) json;
        if (node.isIdRequest()) {
          result.setCommand(ACTIONS_TYPE.GetTransferInformation.name());
        } else {
          result.setCommand(ACTIONS_TYPE.GetInformation.name());
        }
        final ValidPacket validPacket;
        if (node.isIdRequest()) {
          validPacket =
              serverHandler.informationRequest(node.getId(), node.isTo(),
                                               node.getRulename(), true);
        } else {
          validPacket = serverHandler.informationFile(node.getRequest(),
                                                      node.getRulename(),
                                                      node.getFilename(), true);
        }
        if (validPacket != null) {
          // will not use default setOk
          if (node.isIdRequest()) {
            try {
              final ObjectNode resp =
                  JsonHandler.getFromString(validPacket.getSheader());
              result.setResult(HttpResponseStatus.OK);
              result.getResults().add(resp);
            } catch (final Exception e) {
              logger.warn(validPacket.getSheader() + " : {}", e.getMessage());
              result.setResult(HttpResponseStatus.OK);
              result.getResults().add(validPacket.getSheader());
            }
          } else {
            result.setResult(HttpResponseStatus.OK);
            result.getResults().add(validPacket.getSheader());
          }
          handler.setStatus(HttpResponseStatus.OK);
        } else {
          result.setDetail("Error during information request");
          setError(handler, result, HttpResponseStatus.NOT_ACCEPTABLE);
        }
      } else {
        logger.info("Validation is ignored: {}", json);
        result.setDetail("Unknown command");
        setError(handler, result, json, HttpResponseStatus.PRECONDITION_FAILED);
      }
    } catch (final OpenR66ProtocolNotAuthenticatedException e) {
      throw new HttpInvalidAuthenticationException(e);
    } catch (final OpenR66ProtocolNoDataException e) {
      throw new HttpIncorrectRequestException(e);
    }
  }

  @Override
  protected final ArrayNode getDetailedAllow() {
    final ArrayNode node = JsonHandler.createArrayNode();

    if (methods.contains(METHOD.GET)) {
      InformationJsonPacket node3 = new InformationJsonPacket(
          (byte) InformationPacket.ASKENUM.ASKEXIST.ordinal(),
          "The rule name associated with the remote repository",
          "The filename to look for if any");
      node3.setComment("Information request (GET)");
      ObjectNode node2;
      ArrayNode node1 = JsonHandler.createArrayNode().add("path");
      try {
        node2 = RestArgument.fillDetailedAllow(METHOD.GET, path,
                                               ACTIONS_TYPE.GetInformation.name(),
                                               node3.createObjectNode(), node1);
        node.add(node2);
      } catch (final OpenR66ProtocolPacketException ignored) {
        // ignore
      }

      node3 = new InformationJsonPacket(Long.MIN_VALUE, false, "remoteHost");
      node3.setComment("Information on Transfer request (GET)");
      node1 = JsonHandler.createArrayNode();
      final ObjectNode node1b = JsonHandler.createObjectNode();
      node1b.put(AbstractDbData.JSON_MODEL, DbTaskRunner.class.getSimpleName());
      for (final DbTaskRunner.Columns column : DbTaskRunner.Columns.values()) {
        node1b.put(column.name(), DbTaskRunner.dbTypes[column.ordinal()]);
      }
      node1.add(node1b);
      try {
        node2 = RestArgument.fillDetailedAllow(METHOD.GET, path,
                                               ACTIONS_TYPE.GetInformation.name(),
                                               node3.createObjectNode(), node1);
        node.add(node2);
      } catch (final OpenR66ProtocolPacketException ignored) {
        // ignore
      }
    }

    final ObjectNode node2 =
        RestArgument.fillDetailedAllow(METHOD.OPTIONS, path,
                                       COMMAND_TYPE.OPTIONS.name(), null, null);
    node.add(node2);

    return node;
  }
}