franta-hg@16: /**
franta-hg@16:  * SQL-DK
franta-hg@16:  * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@16:  *
franta-hg@16:  * This program is free software: you can redistribute it and/or modify
franta-hg@16:  * it under the terms of the GNU General Public License as published by
franta-hg@250:  * the Free Software Foundation, version 3 of the License.
franta-hg@16:  *
franta-hg@16:  * This program is distributed in the hope that it will be useful,
franta-hg@16:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@16:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@16:  * GNU General Public License for more details.
franta-hg@16:  *
franta-hg@16:  * You should have received a copy of the GNU General Public License
franta-hg@16:  * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@16:  */
franta-hg@1: package info.globalcode.sql.dk;
franta-hg@1: 
franta-hg@166: import static info.globalcode.sql.dk.Functions.readString;
franta-hg@69: import info.globalcode.sql.dk.InfoLister.InfoType;
franta-hg@107: import info.globalcode.sql.dk.configuration.Property;
franta-hg@166: import java.io.IOException;
franta-hg@166: import java.io.InputStream;
franta-hg@4: import java.util.ArrayList;
franta-hg@4: import java.util.HashMap;
franta-hg@4: import java.util.List;
franta-hg@4: import java.util.Map;
franta-hg@4: 
franta-hg@1: /**
franta-hg@246:  * Converts command line arguments from String array to object. Checks basic constraints (if only
franta-hg@246:  * supported options are used and if they have correct number of parameters)
franta-hg@1:  *
franta-hg@1:  * @author Ing. František Kučera (frantovo.cz)
franta-hg@1:  */
franta-hg@5: public class CLIParser {
franta-hg@1: 
franta-hg@4: 	public static final String TYPE_NAME_SEPARATOR = ":";
franta-hg@4: 
franta-hg@166: 	public CLIOptions parseOptions(String[] args, InputStream in) throws CLIParserException {
franta-hg@1: 		CLIOptions options = new CLIOptions();
franta-hg@1: 
franta-hg@68: 		List<SQLType> numberedTypes = new ArrayList<>();
franta-hg@68: 		Map<String, SQLType> namedTypes = new HashMap<>();
franta-hg@2: 
franta-hg@1: 		for (int i = 0; i < args.length; i++) {
franta-hg@1: 			String arg = args[i];
franta-hg@2: 			switch (arg) {
franta-hg@2: 				case Tokens.TYPES:
franta-hg@8: 					String typesString = fetchNext(args, ++i);
franta-hg@4: 
franta-hg@10: 					for (String oneType : typesString.split(",")) {
franta-hg@4: 						int sepatratorIndex = oneType.indexOf(TYPE_NAME_SEPARATOR);
franta-hg@4: 						if (sepatratorIndex == -1) {
franta-hg@93: 							numberedTypes.add(getType(oneType.toUpperCase()));
franta-hg@4: 						} else {
franta-hg@12: 							String namePart = oneType.substring(0, sepatratorIndex).trim();
franta-hg@4: 							String typePart = oneType.substring(sepatratorIndex + TYPE_NAME_SEPARATOR.length(), oneType.length());
franta-hg@93: 							namedTypes.put(namePart, getType(typePart.toUpperCase()));
franta-hg@4: 						}
franta-hg@4: 					}
franta-hg@2: 					break;
franta-hg@2: 				case Tokens.NAME_PREFIX:
franta-hg@8: 					options.setNamePrefix(fetchNext(args, ++i));
franta-hg@2: 					break;
franta-hg@44: 				case Tokens.NAME_SUFFIX:
franta-hg@44: 					options.setNameSuffix(fetchNext(args, ++i));
franta-hg@44: 					break;
franta-hg@1: 				case Tokens.DB:
franta-hg@8: 					options.setDatabaseName(fetchNext(args, ++i));
franta-hg@1: 					break;
franta-hg@1: 				case Tokens.SQL:
franta-hg@8: 					options.setSql(fetchNext(args, ++i));
franta-hg@1: 					break;
franta-hg@166: 				case Tokens.SQL_IN:
franta-hg@166: 					try {
franta-hg@166: 						options.setSql(readString(in));
franta-hg@166: 					} catch (IOException e) {
franta-hg@166: 						throw new CLIParserException("Unable to read SQL from the input stream", e);
franta-hg@166: 					}
franta-hg@166: 					break;
franta-hg@1: 				case Tokens.BATCH:
franta-hg@2: 					options.setBatch(true);
franta-hg@1: 					break;
franta-hg@4: 				case Tokens.DATA: // --data is the last option
franta-hg@4: 					for (i++; i < args.length; i++) {
franta-hg@4: 						arg = args[i];
franta-hg@52: 						Parameter parameter;
franta-hg@52: 						if (numberedTypes.isEmpty()) {
franta-hg@52: 							parameter = new Parameter(arg, null);
franta-hg@52: 						} else {
franta-hg@52: 							int paramIndex = options.getNumberedParameters().size();
franta-hg@68: 							SQLType paramType;
franta-hg@52: 							try {
franta-hg@52: 								paramType = numberedTypes.get(paramIndex);
franta-hg@52: 							} catch (IndexOutOfBoundsException e) {
franta-hg@52: 								throw new CLIParserException("Missing type for parameter #" + paramIndex, e);
franta-hg@52: 							} catch (NullPointerException e) {
franta-hg@52: 								throw new CLIParserException("Invalid type definition for parameter #" + paramIndex, e);
franta-hg@4: 							}
franta-hg@52: 							parameter = new Parameter(arg, paramType);
franta-hg@4: 						}
franta-hg@52: 						options.addNumberedParameter(parameter);
franta-hg@52: 					}
franta-hg@52: 					break;
franta-hg@52: 				case Tokens.DATA_NAMED:
franta-hg@52: 					for (i++; i < args.length; i++) {
franta-hg@52: 						String paramName = args[i];
franta-hg@52: 						String paramValue = fetchNext(args, ++i);
franta-hg@52: 						options.addNamedParameter(new NamedParameter(paramName, paramValue, namedTypes.get(paramName)));
franta-hg@4: 					}
franta-hg@1: 					break;
franta-hg@246: 				case Tokens.RELATION:
franta-hg@246: 					options.addRelationName(fetchNext(args, ++i));
franta-hg@246: 					break;
franta-hg@14: 				case Tokens.FORMATTER:
franta-hg@14: 					options.setFormatterName(fetchNext(args, ++i));
franta-hg@14: 					break;
franta-hg@107: 				case Tokens.DB_PROPERTY:
franta-hg@107: 					options.addDatabaseProperty(new Property(fetchNext(args, ++i), fetchNext(args, ++i)));
franta-hg@107: 					break;
franta-hg@107: 				case Tokens.FORMATTER_PROPERTY:
franta-hg@107: 					options.addFormatterProperty(new Property(fetchNext(args, ++i), fetchNext(args, ++i)));
franta-hg@107: 					break;
franta-hg@14: 				case Tokens.INFO_HELP:
franta-hg@69: 					options.addShowInfo(InfoType.HELP);
franta-hg@14: 					break;
franta-hg@14: 				case Tokens.INFO_FORMATTERS:
franta-hg@69: 					options.addShowInfo(InfoType.FORMATTERS);
franta-hg@14: 					break;
franta-hg@209: 				case Tokens.INFO_FORMATTER_PROPERTIES:
franta-hg@209: 					options.addShowInfo(InfoType.FORMATTER_PROPERTIES);
franta-hg@209: 					options.addFormatterNameToListProperties(fetchNext(args, ++i));
franta-hg@209: 					break;
franta-hg@14: 				case Tokens.INFO_LICENSE:
franta-hg@69: 					options.addShowInfo(InfoType.LICENSE);
franta-hg@14: 					break;
franta-hg@200: 				case Tokens.INFO_JAVA_PROPERTIES:
franta-hg@200: 					options.addShowInfo(InfoType.JAVA_PROPERTIES);
franta-hg@200: 					break;
franta-hg@200: 				case Tokens.INFO_ENVIRONMENT_VARIABLES:
franta-hg@200: 					options.addShowInfo(InfoType.ENVIRONMENT_VARIABLES);
franta-hg@200: 					break;
franta-hg@14: 				case Tokens.INFO_TYPES:
franta-hg@69: 					options.addShowInfo(InfoType.TYPES);
franta-hg@14: 					break;
franta-hg@14: 				case Tokens.INFO_VERSION:
franta-hg@69: 					options.addShowInfo(InfoType.VERSION);
franta-hg@14: 					break;
franta-hg@158: 				case Tokens.INFO_JDBC_DRIVERS:
franta-hg@158: 					options.addShowInfo(InfoType.JDBC_DRIVERS);
franta-hg@158: 					break;
franta-hg@159: 				case Tokens.INFO_JDBC_PROPERTIES:
franta-hg@159: 					options.addShowInfo(InfoType.JDBC_PROPERTIES);
franta-hg@159: 					options.addDatabaseNameToListProperties(fetchNext(args, ++i));
franta-hg@159: 					break;
franta-hg@15: 				case Tokens.INFO_DATABASES:
franta-hg@69: 					options.addShowInfo(InfoType.DATABASES);
franta-hg@15: 					break;
franta-hg@15: 				case Tokens.INFO_CONNECTION:
franta-hg@69: 					options.addShowInfo(InfoType.CONNECTION);
franta-hg@159: 					options.addDatabaseNameToTest(fetchNext(args, ++i));
franta-hg@15: 					break;
franta-hg@4: 				default:
franta-hg@9: 					throw new CLIParserException("Unknown option: " + arg);
franta-hg@1: 			}
franta-hg@1: 		}
franta-hg@8: 		return options;
franta-hg@8: 	}
franta-hg@1: 
franta-hg@9: 	private String fetchNext(String[] args, int index) throws CLIParserException {
franta-hg@8: 		if (index < args.length) {
franta-hg@8: 			return args[index];
franta-hg@8: 		} else {
franta-hg@9: 			throw new CLIParserException("Expecting value for option: " + args[index - 1]);
franta-hg@8: 		}
franta-hg@1: 	}
franta-hg@1: 
franta-hg@1: 	public static class Tokens {
franta-hg@1: 
franta-hg@79: 		// bash-completion:options:
franta-hg@96: 		public static final String DB = "--db"; // bash-completion:option // help: database name
franta-hg@107: 		public static final String DB_PROPERTY = "--db-property"; // bash-completion:option // help: name and value
franta-hg@96: 		public static final String SQL = "--sql"; // bash-completion:option // help: SQL query/command
franta-hg@166: 		public static final String SQL_IN = "--sql-in"; // bash-completion:option // help: SQL query/command
franta-hg@96: 		public static final String BATCH = "--batch"; // bash-completion:option // help: batch mode (no argument)
franta-hg@96: 		public static final String DATA = "--data"; // bash-completion:option // help: list of ordinal parameters
franta-hg@96: 		public static final String DATA_NAMED = "--data-named"; // bash-completion:option // help: list of named parameters
franta-hg@96: 		public static final String NAME_PREFIX = "--name-prefix"; // bash-completion:option // help: parameter name prefix – regular expression
franta-hg@96: 		public static final String NAME_SUFFIX = "--name-suffix"; // bash-completion:option // help: parameter name suffix – regular expression
franta-hg@96: 		public static final String TYPES = "--types"; // bash-completion:option // help: comma separated list of parameter types
franta-hg@246: 		public static final String RELATION = "--relation"; // bash-completion:option // help: name of the output relation (result set)
franta-hg@96: 		public static final String FORMATTER = "--formatter"; // bash-completion:option // help: name of the output formatter
franta-hg@107: 		public static final String FORMATTER_PROPERTY = "--formatter-property"; // bash-completion:option // help: name and value
franta-hg@96: 		public static final String INFO_HELP = "--help"; // bash-completion:option // help: print this help
franta-hg@96: 		public static final String INFO_VERSION = "--version"; // bash-completion:option // help: print version info
franta-hg@96: 		public static final String INFO_LICENSE = "--license"; // bash-completion:option // help: print license
franta-hg@200: 		public static final String INFO_JAVA_PROPERTIES = "--list-java-properties"; // bash-completion:option // help: list of Java system properties
franta-hg@200: 		public static final String INFO_ENVIRONMENT_VARIABLES = "--list-environment-variables"; // bash-completion:option // help: list of environment variables
franta-hg@96: 		public static final String INFO_FORMATTERS = "--list-formatters"; // bash-completion:option // help: print list of available formatters
franta-hg@217: 		public static final String INFO_FORMATTER_PROPERTIES = "--list-formatter-properties"; // bash-completion:option // help: print list of available properties for given formatter
franta-hg@99: 		public static final String INFO_TYPES = "--list-types"; // bash-completion:option // help: print list of available data types
franta-hg@158: 		public static final String INFO_JDBC_DRIVERS = "--list-jdbc-drivers"; // bash-completion:option // help: list of available JDBC drivers
franta-hg@159: 		public static final String INFO_JDBC_PROPERTIES = "--list-jdbc-properties"; // bash-completion:option // help: list of available JDBC properties for given database
franta-hg@96: 		public static final String INFO_DATABASES = "--list-databases"; // bash-completion:option // help: print list of configured databases
franta-hg@96: 		public static final String INFO_CONNECTION = "--test-connection"; // bash-completion:option // help: test connection to particular database
franta-hg@1: 
franta-hg@1: 		private Tokens() {
franta-hg@1: 		}
franta-hg@1: 	}
franta-hg@4: 
franta-hg@68: 	private SQLType getType(String typeString) throws CLIParserException {
franta-hg@68: 		try {
franta-hg@68: 			return SQLType.valueOf(typeString.trim());
franta-hg@68: 		} catch (IllegalArgumentException e) {
franta-hg@68: 			throw new CLIParserException("Unsupported type: " + typeString, e);
franta-hg@8: 		}
franta-hg@4: 	}
franta-hg@1: }