alluxio-master-2.x/shell/src/main/java/alluxio/cli/fsadmin/pathconf/RemoveCommand.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.cli.fsadmin.pathconf;

import alluxio.AlluxioURI;
import alluxio.cli.CommandUtils;
import alluxio.cli.fsadmin.command.AbstractFsAdminCommand;
import alluxio.cli.fsadmin.command.Context;
import alluxio.conf.AlluxioConfiguration;
import alluxio.conf.PropertyKey;
import alluxio.exception.InvalidPathException;
import alluxio.exception.status.InvalidArgumentException;
import alluxio.grpc.GetConfigurationPOptions;

import com.google.common.annotations.VisibleForTesting;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;

import java.io.IOException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * Removes path level configurations.
 */
public final class RemoveCommand extends AbstractFsAdminCommand {
  public static final String KEYS_OPTION_NAME = "keys";

  private static final Option KEYS_OPTION =
      Option.builder()
          .longOpt(KEYS_OPTION_NAME)
          .required(false)
          .hasArg(true)
          .numberOfArgs(1)
          .desc("property keys to be removed, separated by comma")
          .build();
  private static final Option RECURSIVE_OPTION =
      Option.builder("R")
          .longOpt("recursive")
          .desc("remove properties set on paths starting from the specified path recursively")
          .build();

  /**
   * @param context fsadmin command context
   * @param alluxioConf Alluxio configuration
   */
  public RemoveCommand(Context context, AlluxioConfiguration alluxioConf) {
    super(context);
  }

  @Override
  public String getCommandName() {
    return "remove";
  }

  @Override
  public Options getOptions() {
    return new Options().addOption(KEYS_OPTION).addOption(RECURSIVE_OPTION);
  }

  @Override
  public void validateArgs(CommandLine cl) throws InvalidArgumentException {
    CommandUtils.checkNumOfArgsEquals(this, cl, 1);
  }

  @Override
  public int run(CommandLine cl) throws IOException {
    AlluxioURI path = new AlluxioURI(cl.getArgs()[0]);
    boolean recursive = cl.hasOption(RECURSIVE_OPTION.getOpt());
    Set<PropertyKey> keysToRemove = new HashSet<>();
    if (cl.hasOption(KEYS_OPTION_NAME)) {
      String[] keys = cl.getOptionValue(KEYS_OPTION_NAME).split(",");
      for (String key : keys) {
        keysToRemove.add(PropertyKey.fromString(key));
      }
    }
    Set<AlluxioURI> pathsToRemove = recursive ? mMetaConfigClient.getConfiguration(
        GetConfigurationPOptions
            .newBuilder()
            .setIgnoreClusterConf(true)
            .build())
        .getPathConf().keySet().stream()
        .map(k -> new AlluxioURI(k))
        .filter(k -> isAncestorOf(path, k))
        .collect(Collectors.toSet()) : Collections.singleton(path);

    if (keysToRemove.isEmpty()) {
      for (AlluxioURI p : pathsToRemove) {
        mMetaConfigClient.removePathConfiguration(p);
      }
      return 0;
    }
    for (AlluxioURI p : pathsToRemove) {
      mMetaConfigClient.removePathConfiguration(p, keysToRemove);
    }
    return 0;
  }

  @Override
  public String getUsage() {
    return String.format("%s [-R/--recursive] [--%s <key1,key2,key3>] <path>%n"
        + "\t--%s: %s" + "%n"
        + "\t--%s: %s",
        getCommandName(), KEYS_OPTION_NAME,
        KEYS_OPTION_NAME, KEYS_OPTION.getDescription(),
        RECURSIVE_OPTION.getOpt(), RECURSIVE_OPTION.getDescription());
  }

  /**
   * @return command's description
   */
  @VisibleForTesting
  public static String description() {
    return "Removes all or specific properties from path's path level configurations.";
  }

  @Override
  public String getDescription() {
    return description();
  }

  private boolean isAncestorOf(AlluxioURI prefix, AlluxioURI path) {
    try {
      if (prefix.isAncestorOf(path)) {
        return true;
      }
    } catch (InvalidPathException e) {
      e.printStackTrace();
    }
    return false;
  }
}
