package com.box.sdk;

import static com.box.sdk.PagingParameters.DEFAULT_LIMIT;
import static com.box.sdk.PagingParameters.marker;
import static com.box.sdk.SortParameters.none;

import com.eclipsesource.json.Json;
import com.eclipsesource.json.JsonObject;
import java.net.URL;
import java.util.Iterator;

/**
 * Provides methods for deleting, recovering, and viewing a user's trashed files and folders.
 *
 * <p>Unless otherwise noted, the methods in this class can throw an unchecked {@link
 * BoxAPIException} (unchecked meaning that the compiler won't force you to handle it) if an error
 * occurs. If you wish to implement custom error handling for errors related to the Box REST API,
 * you should capture this exception explicitly.
 */
public class BoxTrash implements Iterable<BoxItem.Info> {

  /** Get Item URL Template. */
  public static final URLTemplate GET_ITEMS_URL = new URLTemplate("folders/trash/items/");
  /** Folder Info URL Template. */
  public static final URLTemplate FOLDER_INFO_URL_TEMPLATE = new URLTemplate("folders/%s/trash");
  /** File Info URL Template. */
  public static final URLTemplate FILE_INFO_URL_TEMPLATE = new URLTemplate("files/%s/trash");
  /** Restore File URL Template. */
  public static final URLTemplate RESTORE_FILE_URL_TEMPLATE = new URLTemplate("files/%s");
  /** Restore Folder URL Template. */
  public static final URLTemplate RESTORE_FOLDER_URL_TEMPLATE = new URLTemplate("folders/%s");

  private final BoxAPIConnection api;

  /**
   * Constructs a BoxTrash using a given API connection.
   *
   * @param api the API connection to be used by the trash.
   */
  public BoxTrash(BoxAPIConnection api) {
    this.api = api;
  }

  /**
   * Permanently deletes a trashed folder.
   *
   * @param folderID the ID of the trashed folder to permanently delete.
   */
  public void deleteFolder(String folderID) {
    URL url = FOLDER_INFO_URL_TEMPLATE.build(this.api.getBaseURL(), folderID);
    BoxAPIRequest request = new BoxAPIRequest(this.api, url, "DELETE");
    request.send().close();
  }

  /**
   * Gets information about a trashed folder.
   *
   * @param folderID the ID of the trashed folder.
   * @return info about the trashed folder.
   */
  public BoxFolder.Info getFolderInfo(String folderID) {
    URL url = FOLDER_INFO_URL_TEMPLATE.build(this.api.getBaseURL(), folderID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "GET");
    try (BoxJSONResponse response = request.send()) {
      JsonObject jsonObject = Json.parse(response.getJSON()).asObject();

      BoxFolder folder = new BoxFolder(this.api, jsonObject.get("id").asString());
      return folder.new Info(response.getJSON());
    }
  }

  /**
   * Gets information about a trashed folder that's limited to a list of specified fields.
   *
   * @param folderID the ID of the trashed folder.
   * @param fields the fields to retrieve.
   * @return info about the trashed folder containing only the specified fields.
   */
  public BoxFolder.Info getFolderInfo(String folderID, String... fields) {
    String queryString = new QueryStringBuilder().appendParam("fields", fields).toString();
    URL url = FOLDER_INFO_URL_TEMPLATE.buildWithQuery(this.api.getBaseURL(), queryString, folderID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "GET");
    try (BoxJSONResponse response = request.send()) {
      JsonObject jsonObject = Json.parse(response.getJSON()).asObject();

      BoxFolder folder = new BoxFolder(this.api, jsonObject.get("id").asString());
      return folder.new Info(response.getJSON());
    }
  }

  /**
   * Restores a trashed folder back to its original location.
   *
   * @param folderID the ID of the trashed folder.
   * @return info about the restored folder.
   */
  public BoxFolder.Info restoreFolder(String folderID) {
    URL url = RESTORE_FOLDER_URL_TEMPLATE.build(this.api.getBaseURL(), folderID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "POST");
    JsonObject requestJSON = new JsonObject().add("", "");
    request.setBody(requestJSON.toString());
    try (BoxJSONResponse response = request.send()) {
      JsonObject responseJSON = Json.parse(response.getJSON()).asObject();

      BoxFolder restoredFolder = new BoxFolder(this.api, responseJSON.get("id").asString());
      return restoredFolder.new Info(responseJSON);
    }
  }

  /**
   * Restores a trashed folder to a new location with a new name.
   *
   * @param folderID the ID of the trashed folder.
   * @param newName an optional new name to give the folder. This can be null to use the folder's
   *     original name.
   * @param newParentID an optional new parent ID for the folder. This can be null to use the
   *     folder's original parent.
   * @return info about the restored folder.
   */
  public BoxFolder.Info restoreFolder(String folderID, String newName, String newParentID) {
    JsonObject requestJSON = new JsonObject();

    if (newName != null) {
      requestJSON.add("name", newName);
    }

    if (newParentID != null) {
      JsonObject parent = new JsonObject();
      parent.add("id", newParentID);
      requestJSON.add("parent", parent);
    }

    URL url = RESTORE_FOLDER_URL_TEMPLATE.build(this.api.getBaseURL(), folderID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "POST");
    request.setBody(requestJSON.toString());
    try (BoxJSONResponse response = request.send()) {
      JsonObject responseJSON = Json.parse(response.getJSON()).asObject();

      BoxFolder restoredFolder = new BoxFolder(this.api, responseJSON.get("id").asString());
      return restoredFolder.new Info(responseJSON);
    }
  }

  /**
   * Permanently deletes a trashed file.
   *
   * @param fileID the ID of the trashed folder to permanently delete.
   */
  public void deleteFile(String fileID) {
    URL url = FILE_INFO_URL_TEMPLATE.build(this.api.getBaseURL(), fileID);
    BoxAPIRequest request = new BoxAPIRequest(this.api, url, "DELETE");
    request.send().close();
  }

  /**
   * Gets information about a trashed file.
   *
   * @param fileID the ID of the trashed file.
   * @return info about the trashed file.
   */
  public BoxFile.Info getFileInfo(String fileID) {
    URL url = FILE_INFO_URL_TEMPLATE.build(this.api.getBaseURL(), fileID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "GET");
    try (BoxJSONResponse response = request.send()) {
      JsonObject jsonObject = Json.parse(response.getJSON()).asObject();

      BoxFile file = new BoxFile(this.api, jsonObject.get("id").asString());
      return file.new Info(response.getJSON());
    }
  }

  /**
   * Gets information about a trashed file that's limited to a list of specified fields.
   *
   * @param fileID the ID of the trashed file.
   * @param fields the fields to retrieve.
   * @return info about the trashed file containing only the specified fields.
   */
  public BoxFile.Info getFileInfo(String fileID, String... fields) {
    String queryString = new QueryStringBuilder().appendParam("fields", fields).toString();
    URL url = FILE_INFO_URL_TEMPLATE.buildWithQuery(this.api.getBaseURL(), queryString, fileID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "GET");
    try (BoxJSONResponse response = request.send()) {
      JsonObject jsonObject = Json.parse(response.getJSON()).asObject();

      BoxFile file = new BoxFile(this.api, jsonObject.get("id").asString());
      return file.new Info(response.getJSON());
    }
  }

  /**
   * Restores a trashed file back to its original location.
   *
   * @param fileID the ID of the trashed file.
   * @return info about the restored file.
   */
  public BoxFile.Info restoreFile(String fileID) {
    URL url = RESTORE_FILE_URL_TEMPLATE.build(this.api.getBaseURL(), fileID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "POST");
    JsonObject requestJSON = new JsonObject().add("", "");
    return getInfo(requestJSON, request);
  }

  /**
   * Restores a trashed file to a new location with a new name.
   *
   * @param fileID the ID of the trashed file.
   * @param newName an optional new name to give the file. This can be null to use the file's
   *     original name.
   * @param newParentID an optional new parent ID for the file. This can be null to use the file's
   *     original parent.
   * @return info about the restored file.
   */
  public BoxFile.Info restoreFile(String fileID, String newName, String newParentID) {
    JsonObject requestJSON = new JsonObject();

    if (newName != null) {
      requestJSON.add("name", newName);
    }

    if (newParentID != null) {
      JsonObject parent = new JsonObject();
      parent.add("id", newParentID);
      requestJSON.add("parent", parent);
    }

    URL url = RESTORE_FILE_URL_TEMPLATE.build(this.api.getBaseURL(), fileID);
    BoxJSONRequest request = new BoxJSONRequest(this.api, url, "POST");
    return getInfo(requestJSON, request);
  }

  /**
   * Returns an iterator over the items in the trash.
   *
   * @return an iterator over the items in the trash.
   */
  public Iterator<BoxItem.Info> iterator() {
    return items(none(), marker(DEFAULT_LIMIT)).iterator();
  }

  /**
   * Returns an iterable containing the items in trash. You can specify sort order, limit of files
   * requested, ofset or use marker based pagination.
   *
   * @param sortParameters describes sorting parameters. Sort parameters are supported only with
   *     offset based pagination. Use {@link SortParameters#none()} to ignore sorting.
   * @param pagingParameters describes paging parameters
   * @param fields the fields to retrieve.
   * @return an iterable containing the items in the trash.
   */
  public Iterable<BoxItem.Info> items(
      SortParameters sortParameters, PagingParameters pagingParameters, String... fields) {
    QueryStringBuilder builder = sortParameters.asQueryStringBuilder();
    validateSortIsSelectedWithOffsetPaginationOnly(pagingParameters, builder);

    if (fields.length > 0) {
      builder.appendParam("fields", fields);
    }
    final String query = builder.toString();
    return () -> {
      URL url = GET_ITEMS_URL.buildWithQuery(this.api.getBaseURL(), query);
      if (pagingParameters == null) {
        return new BoxItemIterator(this.api, url, marker(DEFAULT_LIMIT));
      } else {
        return new BoxItemIterator(this.api, url, pagingParameters);
      }
    };
  }

  private BoxFile.Info getInfo(JsonObject requestJSON, BoxJSONRequest request) {
    request.setBody(requestJSON.toString());
    try (BoxJSONResponse response = request.send()) {
      JsonObject responseJSON = Json.parse(response.getJSON()).asObject();

      BoxFile restoredFile = new BoxFile(this.api, responseJSON.get("id").asString());
      return restoredFile.new Info(responseJSON);
    }
  }

  /**
   * Throws IllegalArgumentException exception when sorting and marker pagination is selected.
   *
   * @param pagingParameters paging definition to check
   * @param sortQuery builder containing sort query
   */
  private void validateSortIsSelectedWithOffsetPaginationOnly(
      PagingParameters pagingParameters, QueryStringBuilder sortQuery) {
    if (pagingParameters != null
        && pagingParameters.isMarkerBasedPaging()
        && sortQuery.toString().length() > 0) {
      throw new IllegalArgumentException(
          "Sorting is not supported when using marker based pagination.");
    }
  }
}