/*
    * 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.restv2.dbhandlers;
  
  import com.fasterxml.jackson.databind.node.ObjectNode;
  import io.cdap.http.HttpResponder;
  import io.netty.handler.codec.http.DefaultHttpHeaders;
  import io.netty.handler.codec.http.HttpHeaders;
  import io.netty.handler.codec.http.HttpMethod;
  import io.netty.handler.codec.http.HttpRequest;
  import org.waarp.common.utility.WaarpStringUtils;
  import org.waarp.openr66.dao.DAOFactory;
  import org.waarp.openr66.dao.TransferDAO;
  import org.waarp.openr66.dao.exception.DAOConnectionException;
  import org.waarp.openr66.dao.exception.DAONoDataException;
  import org.waarp.openr66.pojo.Transfer;
  import org.waarp.openr66.pojo.Transfer.TASKSTEP;
  import org.waarp.openr66.protocol.http.restv2.converters.TransferConverter;
  import org.waarp.openr66.protocol.http.restv2.utils.JsonUtils;
  import org.waarp.openr66.protocol.localhandler.ServerActions;
  
  import javax.ws.rs.Consumes;
  import javax.ws.rs.DELETE;
  import javax.ws.rs.GET;
  import javax.ws.rs.InternalServerErrorException;
  import javax.ws.rs.OPTIONS;
  import javax.ws.rs.PUT;
  import javax.ws.rs.Path;
  import javax.ws.rs.PathParam;
  import java.io.UnsupportedEncodingException;
  import java.net.URLDecoder;
  import java.util.ArrayList;
  import java.util.List;
  import java.util.regex.Matcher;
  import java.util.regex.Pattern;
  
  import static io.netty.handler.codec.http.HttpResponseStatus.*;
  import static javax.ws.rs.core.HttpHeaders.*;
  import static javax.ws.rs.core.MediaType.*;
  import static org.waarp.common.role.RoleDefault.ROLE.*;
  import static org.waarp.openr66.pojo.UpdatedInfo.*;
  import static org.waarp.openr66.protocol.http.restv2.RestConstants.*;
  
  /**
   * This is the {@link AbstractRestDbHandler} handling all requests made on the
   * single transfer REST entry
   * point.
   */
  @Path(TRANSFER_ID_HANDLER_URI)
  public class TransferIdHandler extends AbstractRestDbHandler {
    /**
     * The content of the 'Allow' header sent when an 'OPTIONS' request is made
     * on the handler.
     */
    private static final HttpHeaders OPTIONS_HEADERS;
  
    static {
      OPTIONS_HEADERS = new DefaultHttpHeaders();
      final List<HttpMethod> allow = new ArrayList<HttpMethod>();
      allow.add(HttpMethod.GET);
      allow.add(HttpMethod.DELETE);
      allow.add(HttpMethod.OPTIONS);
      OPTIONS_HEADERS.add(ALLOW, allow);
    }
  
    /**
     * Initializes the handler with the given CRUD mask.
     *
     * @param crud the CRUD mask for this handler
     */
    public TransferIdHandler(final byte crud) {
      super(crud);
    }
  
    /**
     * Method called to obtain the information on the transfer whose id was
     * given in the request's URI. The
     * requested transfer is sent back in JSON format, unless an unexpected
     * error prevents it or if the request id
     * does not exist.
     * <p>
    * **NOTE:** The {@code uri} parameter refers to the concatenation of the
    * transfer's id, and the name of the
    * host to which the transfer was requested, separated by an underscore
    * character.</p>
    *
    * @param request the HttpRequest made to the resource
    * @param responder the HttpResponder which sends the reply to the
    *     request
    * @param uri the transfer's unique identifier
    */
   @GET
   @Consumes(WILDCARD)
   @RequiredRole(READONLY)
   public final void getTransfer(final HttpRequest request,
                                 final HttpResponder responder,
                                 @PathParam(URI_ID) final String uri)
       throws UnsupportedEncodingException {
     checkSanity(uri);
     final String key = URLDecoder.decode(uri, UTF8_CHARSET.name());
     final Pattern pattern = Pattern.compile("(-?\\d+)_(.+)");
     final Matcher matcher = pattern.matcher(key);
     if (!matcher.find()) {
       responder.sendStatus(NOT_FOUND);
       return;
     }
     final String id = matcher.group(1);
     final String requested = matcher.group(2);
 
     TransferDAO transferDAO = null;
     try {
       final long transID = Long.parseLong(id);
       transferDAO = DAO_FACTORY.getTransferDAO();
       if (!transferDAO.exist(transID, serverName(requested), requested,
                              serverName())) {
         responder.sendStatus(NOT_FOUND);
       } else {
         final Transfer transfer =
             transferDAO.select(transID, serverName(requested), requested,
                                serverName());
         final ObjectNode response = TransferConverter.transferToNode(transfer);
         final String responseText = JsonUtils.nodeToString(response);
         responder.sendJson(OK, responseText);
       }
     } catch (final NumberFormatException e) {
       responder.sendStatus(NOT_FOUND);
     } catch (final DAOConnectionException e) {
       throw new InternalServerErrorException(e);
     } catch (final DAONoDataException e) {
       responder.sendStatus(NOT_FOUND);
     } finally {
       DAOFactory.closeDAO(transferDAO);
     }
   }
 
   /**
    * Method called to restart a paused transfer.
    * <p>
    * **NOTE:** The {@code uri} parameter refers to the concatenation of the
    * transfer's id, and the name of the
    * host to which the transfer was requested, separated by an underscore
    * character.</p>
    *
    * @param request the HttpRequest made to the resource
    * @param responder the HttpResponder which sends the reply to the
    *     request
    * @param uri the transfer's unique identifier
    */
   @Path(TransferCommandsURI.RESTART_URI)
   @PUT
   @Consumes(WILDCARD)
   @RequiredRole(SYSTEM)
   public final void restartTransfer(final HttpRequest request,
                                     final HttpResponder responder,
                                     @PathParam(URI_ID) final String uri)
       throws UnsupportedEncodingException {
     checkSanity(uri);
     final String key = URLDecoder.decode(uri, WaarpStringUtils.UTF_8);
     final Pattern pattern = Pattern.compile("(-?\\d+)_(.+)");
     final Matcher matcher = pattern.matcher(key);
     if (!matcher.find()) {
       responder.sendStatus(NOT_FOUND);
       return;
     }
     final String id = matcher.group(1);
     final String requested = matcher.group(2);
 
     TransferDAO transferDAO = null;
     try {
       final long transID = Long.parseLong(id);
       transferDAO = DAO_FACTORY.getTransferDAO();
       if (!transferDAO.exist(transID, serverName(requested), requested,
                              serverName())) {
         responder.sendStatus(NOT_FOUND);
       } else {
         final Transfer transfer =
             transferDAO.select(transID, serverName(requested), requested,
                                serverName());
         final ServerActions actions = new ServerActions();
         actions.newSession();
         actions.stopTransfer(transfer);
         transfer.setUpdatedInfo(TOSUBMIT);
         transfer.setGlobalStep(transfer.getLastGlobalStep());
         transferDAO.update(transfer);
 
         final ObjectNode response = TransferConverter.transferToNode(transfer);
         final String responseText = JsonUtils.nodeToString(response);
         responder.sendJson(OK, responseText);
       }
     } catch (final NumberFormatException e) {
       responder.sendStatus(NOT_FOUND);
     } catch (final DAOConnectionException e) {
       throw new InternalServerErrorException(e);
     } catch (final DAONoDataException e) {
       responder.sendStatus(NOT_FOUND);
     } finally {
       DAOFactory.closeDAO(transferDAO);
     }
   }
 
   /**
    * Method called to pause a staged or running transfer.
    * <p>
    * **NOTE:** The {@code uri} parameter refers to the concatenation of the
    * transfer's id, and the name of the
    * host to which the transfer was requested, separated by an underscore
    * character.</p>
    *
    * @param request the HttpRequest made to the resource
    * @param responder the HttpResponder which sends the reply to the
    *     request
    * @param uri the transfer's unique identifier
    */
   @Path(TransferCommandsURI.STOP_URI)
   @PUT
   @Consumes(WILDCARD)
   @RequiredRole(SYSTEM)
   public final void stopTransfer(final HttpRequest request,
                                  final HttpResponder responder,
                                  @PathParam(URI_ID) final String uri)
       throws UnsupportedEncodingException {
     checkSanity(uri);
     final String key = URLDecoder.decode(uri, WaarpStringUtils.UTF8.name());
     final Pattern pattern = Pattern.compile("(-?\\d+)_(.+)");
     final Matcher matcher = pattern.matcher(key);
     if (!matcher.find()) {
       responder.sendStatus(NOT_FOUND);
       return;
     }
     final String id = matcher.group(1);
     final String requested = matcher.group(2);
 
     TransferDAO transferDAO = null;
     try {
       final long transID = Long.parseLong(id);
       transferDAO = DAO_FACTORY.getTransferDAO();
       if (!transferDAO.exist(transID, serverName(requested), requested,
                              serverName())) {
         responder.sendStatus(NOT_FOUND);
       } else {
         final Transfer transfer =
             transferDAO.select(transID, serverName(requested), requested,
                                serverName());
         final ServerActions actions = new ServerActions();
         actions.newSession();
         actions.stopTransfer(transfer);
         transferDAO.update(transfer);
 
         final ObjectNode response = TransferConverter.transferToNode(transfer);
         final String responseText = JsonUtils.nodeToString(response);
         responder.sendJson(OK, responseText);
       }
     } catch (final NumberFormatException e) {
       responder.sendStatus(NOT_FOUND);
     } catch (final DAOConnectionException e) {
       throw new InternalServerErrorException(e);
     } catch (final DAONoDataException e) {
       responder.sendStatus(NOT_FOUND);
     } finally {
       DAOFactory.closeDAO(transferDAO);
     }
   }
 
   /**
    * Method called to cancel a staged or running transfer.
    * <p>
    * **NOTE:** The {@code uri} parameter refers to the concatenation of the
    * transfer's id, and the name of the
    * host to which the transfer was requested, separated by an underscore
    * character.</p>
    *
    * @param request the HttpRequest made to the resource
    * @param responder the HttpResponder which sends the reply to the
    *     request
    * @param uri the transfer's unique identifier
    */
   @Path(TransferCommandsURI.CANCEL_URI)
   @PUT
   @Consumes(WILDCARD)
   @RequiredRole(SYSTEM)
   public final void cancelTransfer(final HttpRequest request,
                                    final HttpResponder responder,
                                    @PathParam(URI_ID) final String uri)
       throws UnsupportedEncodingException {
     checkSanity(uri);
     final String key = URLDecoder.decode(uri, WaarpStringUtils.UTF8.name());
     final Pattern pattern = Pattern.compile("(-?\\d+)_(.+)");
     final Matcher matcher = pattern.matcher(key);
     if (!matcher.find()) {
       responder.sendStatus(NOT_FOUND);
       return;
     }
     final String id = matcher.group(1);
     final String requested = matcher.group(2);
 
     TransferDAO transferDAO = null;
     try {
       final long transID = Long.parseLong(id);
       transferDAO = DAO_FACTORY.getTransferDAO();
       if (!transferDAO.exist(transID, serverName(requested), requested,
                              serverName())) {
         responder.sendStatus(NOT_FOUND);
       } else {
         final Transfer transfer =
             transferDAO.select(transID, serverName(requested), requested,
                                serverName());
         final ServerActions actions = new ServerActions();
         actions.newSession();
         actions.cancelTransfer(transfer);
         transferDAO.update(transfer);
 
         final ObjectNode response = TransferConverter.transferToNode(transfer);
         final String responseBody = JsonUtils.nodeToString(response);
         responder.sendJson(OK, responseBody);
       }
     } catch (final NumberFormatException e) {
       responder.sendStatus(NOT_FOUND);
     } catch (final DAOConnectionException e) {
       throw new InternalServerErrorException(e);
     } catch (final DAONoDataException e) {
       responder.sendStatus(NOT_FOUND);
     } finally {
       DAOFactory.closeDAO(transferDAO);
     }
   }
 
   /**
    * Method called to delete a Transfer entry from the database.
    * Note that if the Transfer were already started, the delete
    * cannot be achieved and NOT_FOUND will be returned.
    * <p>
    * **NOTE:** The {@code uri} parameter refers to the concatenation of the
    * transfer's id, and the name of the
    * host to which the transfer was requested, separated by an underscore
    * character.</p>
    *
    * @param request the HttpRequest made on the resource
    * @param responder the HttpResponder which sends the reply to the
    *     request
    * @param uri the transfer's unique identifier
    */
   @DELETE
   @Consumes(WILDCARD)
   @RequiredRole(SYSTEM)
   public final void deleteTransfer(final HttpRequest request,
                                    final HttpResponder responder,
                                    @PathParam(URI_ID) final String uri)
       throws UnsupportedEncodingException {
     checkSanity(uri);
     final String key = URLDecoder.decode(uri, UTF8_CHARSET.name());
     final Pattern pattern = Pattern.compile("(-?\\d+)_(.+)");
     final Matcher matcher = pattern.matcher(key);
     if (!matcher.find()) {
       responder.sendStatus(NOT_FOUND);
       return;
     }
     final String id = matcher.group(1);
     final String requested = matcher.group(2);
     TransferDAO transferDAO = null;
     try {
       final long transID = Long.parseLong(id);
       transferDAO = DAO_FACTORY.getTransferDAO();
       if (!transferDAO.exist(transID, serverName(requested), requested,
                              serverName())) {
         responder.sendStatus(NOT_FOUND);
       } else {
         final Transfer transfer =
             transferDAO.select(transID, serverName(requested), requested,
                                serverName());
         if (transfer.getGlobalStep() == TASKSTEP.NOTASK &&
             transfer.getLastGlobalStep() == TASKSTEP.NOTASK) {
           responder.sendStatus(NOT_FOUND);
         } else {
           transferDAO.delete(transfer);
           responder.sendStatus(NO_CONTENT);
         }
       }
     } catch (final DAOConnectionException e) {
       throw new InternalServerErrorException(e);
     } catch (final DAONoDataException e) {
       responder.sendStatus(NOT_FOUND);
     } finally {
       DAOFactory.closeDAO(transferDAO);
     }
   }
 
   /**
    * Method called to get a list of all allowed HTTP methods on this entry
    * point. The HTTP methods are sent as
    * an array in the reply's headers.
    * <p>
    * **NOTE:** The {@code uri} parameter refers to the concatenation of the
    * transfer's id, and the name of the
    * host to which the transfer was requested, separated by an underscore
    * character.</p>
    *
    * @param request the HttpRequest made to the resource
    * @param responder the HttpResponder which sends the reply to the
    *     request
    * @param uri the transfer's unique identifier
    */
   @OPTIONS
   @Consumes(WILDCARD)
   @RequiredRole(NOACCESS)
   public final void options(final HttpRequest request,
                             final HttpResponder responder,
                             @PathParam(URI_ID) final String uri) {
     checkSanity(uri);
     responder.sendStatus(OK, OPTIONS_HEADERS);
   }
 
   @Path("{ep}")
   @OPTIONS
   @Consumes(WILDCARD)
   @RequiredRole(NOACCESS)
   public final void subOptions(final HttpRequest request,
                                final HttpResponder responder,
                                @PathParam(URI_ID) final String uri,
                                @PathParam("ep") final String ep) {
     checkSanity(uri, ep);
     final HttpHeaders allow = new DefaultHttpHeaders();
     final List<HttpMethod> methods = new ArrayList<HttpMethod>();
 
     if (ep.equals(TransferCommandsURI.RESTART_URI)) {
       methods.add(HttpMethod.PUT);
     } else if (ep.equals(TransferCommandsURI.STOP_URI)) {
       methods.add(HttpMethod.PUT);
     } else if (ep.equals(TransferCommandsURI.CANCEL_URI)) {
       methods.add(HttpMethod.PUT);
     } else {
       responder.sendStatus(NOT_FOUND);
       return;
     }
     methods.add(HttpMethod.OPTIONS);
     allow.add(ALLOW, methods);
     responder.sendStatus(OK, allow);
   }
 }