/* Copyright (c) 2012-2014 Boundless and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Distribution License v1.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/edl-v10.html
*
* Contributors:
* Michael Fawcett (LMN Solutions) - initial implementation
*/
package org.locationtech.geogig.cli.porcelain;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.locationtech.geogig.api.GeoGIG;
import org.locationtech.geogig.api.porcelain.ConfigException;
import org.locationtech.geogig.api.porcelain.ConfigException.StatusCode;
import org.locationtech.geogig.api.porcelain.ConfigOp;
import org.locationtech.geogig.api.porcelain.ConfigOp.ConfigAction;
import org.locationtech.geogig.api.porcelain.ConfigOp.ConfigScope;
import org.locationtech.geogig.cli.AbstractCommand;
import org.locationtech.geogig.cli.CLICommand;
import org.locationtech.geogig.cli.CommandFailedException;
import org.locationtech.geogig.cli.GeogigCLI;
import org.locationtech.geogig.cli.InvalidParameterException;
import org.locationtech.geogig.cli.annotation.ObjectDatabaseReadOnly;
import org.locationtech.geogig.cli.annotation.RequiresRepository;
import org.locationtech.geogig.cli.annotation.StagingDatabaseReadOnly;
import org.locationtech.geogig.repository.Hints;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.google.common.base.Joiner;
import com.google.common.base.Optional;
/**
* You can query/set/unset options with this command. The name is actually the section and the key
* separated by a dot, and the value will be escaped. By default, the config file of the current
* repository will be assumed. If the --global option is set, the global .geogigconfig file will be
* used.
* <p>
* CLI proxy for {@link ConfigOp}
* <p>
* Usage:
* <ul>
* <li> {@code geogig config [--global] name [value]}: retrieves or sets the config variable
* specified by name
* <li> {@code geogig config [--global] --get name}: retrieves the config variable specified by name
* <li> {@code geogig config [--global] --unset name}: removes the config variable specified by name
* <li> {@code geogig config [--global] --remove-section name}: removes the config section specified
* by name
* <li> {@code geogig config [--global] -l}: lists all config variables
* </ul>
*
* @see ConfigOp
*/
@StagingDatabaseReadOnly
@ObjectDatabaseReadOnly
@RequiresRepository(false)
@Parameters(commandNames = "config", commandDescription = "Get and set repository or global options")
public class Config extends AbstractCommand implements CLICommand {
@Parameter(names = "--global", description = "Use global config file.")
private boolean global = false;
@Parameter(names = "--local", description = "Use repository config file.")
private boolean local = false;
@Parameter(names = "--get", description = "Get the value for a given key.")
private boolean get = false;
@Parameter(names = "--unset", description = "Remove the line matching the given key.")
private boolean unset = false;
@Parameter(names = "--remove-section", description = "Remove the given section.")
private boolean remove_section = false;
@Parameter(names = { "--list", "-l" }, description = "List all variables.")
private boolean list = false;
@Parameter(description = "name value (name is section.key format, value is only required when setting)")
private List<String> nameValuePair;
/**
* Executes the config command using the provided options.
*/
@Override
public void runInternal(GeogigCLI cli) throws IOException {
GeoGIG geogig = cli.getGeogig();
boolean closeIt = geogig == null;
if (closeIt) {
// we're not in a repository, need a geogig anyways to run the global commands
geogig = cli.newGeoGIG(Hints.readOnly());
}
try {
String name = null;
String value = null;
if (nameValuePair != null && !nameValuePair.isEmpty()) {
name = nameValuePair.get(0);
value = buildValueString();
}
ConfigAction action = resolveConfigAction();
if (action == ConfigAction.CONFIG_NO_ACTION) {
printUsage(cli);
throw new CommandFailedException();
}
if (global && local) {
printUsage(cli);
throw new CommandFailedException();
}
ConfigScope scope = ConfigScope.DEFAULT;
if (global) {
scope = ConfigScope.GLOBAL;
} else if (local) {
scope = ConfigScope.LOCAL;
}
final Optional<Map<String, String>> commandResult = geogig.command(ConfigOp.class)
.setScope(scope).setAction(action).setName(name).setValue(value).call();
if (commandResult.isPresent()) {
switch (action) {
case CONFIG_GET: {
cli.getConsole().println(commandResult.get().get(name));
break;
}
case CONFIG_LIST: {
Iterator<Map.Entry<String, String>> it = commandResult.get().entrySet()
.iterator();
while (it.hasNext()) {
Map.Entry<String, String> pairs = (Map.Entry<String, String>) it.next();
cli.getConsole().println(pairs.getKey() + "=" + pairs.getValue());
}
break;
}
default:
break;
}
}
} catch (ConfigException e) {
// These mirror 'git config' status codes. Some of these are unused,
// since we don't have regex support yet.
switch (e.statusCode) {
case INVALID_LOCATION:
// TODO: This could probably be more descriptive.
throw new CommandFailedException("The config location is invalid", e);
case CANNOT_WRITE:
throw new CommandFailedException("Cannot write to the config", e);
case SECTION_OR_NAME_NOT_PROVIDED:
throw new InvalidParameterException("No section or name was provided", e);
case SECTION_OR_KEY_INVALID:
throw new InvalidParameterException("The section or key is invalid", e);
case OPTION_DOES_NOT_EXIST:
throw new InvalidParameterException("Tried to unset an option that does not exist",
e);
case MULTIPLE_OPTIONS_MATCH:
throw new InvalidParameterException(
"Tried to unset/set an option for which multiple lines match", e);
case INVALID_REGEXP:
throw new InvalidParameterException("Tried to use an invalid regexp", e);
case USERHOME_NOT_SET:
throw new InvalidParameterException(
"Used --global option without $HOME being properly set", e);
case TOO_MANY_ACTIONS:
throw new InvalidParameterException("Tried to use more than one action at a time",
e);
case MISSING_SECTION:
throw new InvalidParameterException(
"Could not find a section with the name provided", e);
case TOO_MANY_ARGS:
throw new InvalidParameterException("Too many arguments provided.", e);
}
} finally {
if (closeIt) {
geogig.close();
}
}
}
/**
* Determines which action should be set based on the state of several option flags.
*
* @return the determined ConfigAction
* @see ConfigAction
*/
private ConfigAction resolveConfigAction() {
ConfigAction action = ConfigAction.CONFIG_NO_ACTION;
if (get) {
action = ConfigAction.CONFIG_GET;
}
if (unset) {
if (action != ConfigAction.CONFIG_NO_ACTION)
throw new ConfigException(StatusCode.TOO_MANY_ACTIONS);
action = ConfigAction.CONFIG_UNSET;
}
if (remove_section) {
if (action != ConfigAction.CONFIG_NO_ACTION)
throw new ConfigException(StatusCode.TOO_MANY_ACTIONS);
action = ConfigAction.CONFIG_REMOVE_SECTION;
}
if (list) {
if (action != ConfigAction.CONFIG_NO_ACTION)
throw new ConfigException(StatusCode.TOO_MANY_ACTIONS);
action = ConfigAction.CONFIG_LIST;
}
if (action == ConfigAction.CONFIG_NO_ACTION && nameValuePair != null) {
if (nameValuePair.size() == 1) {
action = ConfigAction.CONFIG_GET;
} else if (nameValuePair.size() > 1) {
action = ConfigAction.CONFIG_SET;
}
}
return action;
}
/**
* Builds a single string out of all of the string parameters after the first one.
*
* @return the concatenated value string
*/
private String buildValueString() {
if (nameValuePair.isEmpty())
return null;
ArrayList<String> arrayCopy = new ArrayList<String>(nameValuePair);
arrayCopy.remove(0); // Remove name
if (arrayCopy.isEmpty())
return null;
Joiner stringJoiner = Joiner.on(" ");
return stringJoiner.join(arrayCopy);
}
}