java/sql-dk/src/main/java/info/globalcode/sql/dk/CLIParser.java
author František Kučera <franta-hg@frantovo.cz>
Tue, 05 Mar 2019 22:03:02 +0100
branchv_0
changeset 246 277c18b48762
parent 238 4a1864c3e867
child 250 aae5009bd0af
permissions -rw-r--r--
support custom relation names in the XML formatter (added --relation CLI option)
franta-hg@16
     1
/**
franta-hg@16
     2
 * SQL-DK
franta-hg@16
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@16
     4
 *
franta-hg@16
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@16
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@16
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@16
     8
 * (at your option) any later version.
franta-hg@16
     9
 *
franta-hg@16
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@16
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@16
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@16
    13
 * GNU General Public License for more details.
franta-hg@16
    14
 *
franta-hg@16
    15
 * You should have received a copy of the GNU General Public License
franta-hg@16
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@16
    17
 */
franta-hg@1
    18
package info.globalcode.sql.dk;
franta-hg@1
    19
franta-hg@166
    20
import static info.globalcode.sql.dk.Functions.readString;
franta-hg@69
    21
import info.globalcode.sql.dk.InfoLister.InfoType;
franta-hg@107
    22
import info.globalcode.sql.dk.configuration.Property;
franta-hg@166
    23
import java.io.IOException;
franta-hg@166
    24
import java.io.InputStream;
franta-hg@4
    25
import java.util.ArrayList;
franta-hg@4
    26
import java.util.HashMap;
franta-hg@4
    27
import java.util.List;
franta-hg@4
    28
import java.util.Map;
franta-hg@4
    29
franta-hg@1
    30
/**
franta-hg@246
    31
 * Converts command line arguments from String array to object. Checks basic constraints (if only
franta-hg@246
    32
 * supported options are used and if they have correct number of parameters)
franta-hg@1
    33
 *
franta-hg@1
    34
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@1
    35
 */
franta-hg@5
    36
public class CLIParser {
franta-hg@1
    37
franta-hg@4
    38
	public static final String TYPE_NAME_SEPARATOR = ":";
franta-hg@4
    39
franta-hg@166
    40
	public CLIOptions parseOptions(String[] args, InputStream in) throws CLIParserException {
franta-hg@1
    41
		CLIOptions options = new CLIOptions();
franta-hg@1
    42
franta-hg@68
    43
		List<SQLType> numberedTypes = new ArrayList<>();
franta-hg@68
    44
		Map<String, SQLType> namedTypes = new HashMap<>();
franta-hg@2
    45
franta-hg@1
    46
		for (int i = 0; i < args.length; i++) {
franta-hg@1
    47
			String arg = args[i];
franta-hg@2
    48
			switch (arg) {
franta-hg@2
    49
				case Tokens.TYPES:
franta-hg@8
    50
					String typesString = fetchNext(args, ++i);
franta-hg@4
    51
franta-hg@10
    52
					for (String oneType : typesString.split(",")) {
franta-hg@4
    53
						int sepatratorIndex = oneType.indexOf(TYPE_NAME_SEPARATOR);
franta-hg@4
    54
						if (sepatratorIndex == -1) {
franta-hg@93
    55
							numberedTypes.add(getType(oneType.toUpperCase()));
franta-hg@4
    56
						} else {
franta-hg@12
    57
							String namePart = oneType.substring(0, sepatratorIndex).trim();
franta-hg@4
    58
							String typePart = oneType.substring(sepatratorIndex + TYPE_NAME_SEPARATOR.length(), oneType.length());
franta-hg@93
    59
							namedTypes.put(namePart, getType(typePart.toUpperCase()));
franta-hg@4
    60
						}
franta-hg@4
    61
					}
franta-hg@2
    62
					break;
franta-hg@2
    63
				case Tokens.NAME_PREFIX:
franta-hg@8
    64
					options.setNamePrefix(fetchNext(args, ++i));
franta-hg@2
    65
					break;
franta-hg@44
    66
				case Tokens.NAME_SUFFIX:
franta-hg@44
    67
					options.setNameSuffix(fetchNext(args, ++i));
franta-hg@44
    68
					break;
franta-hg@1
    69
				case Tokens.DB:
franta-hg@8
    70
					options.setDatabaseName(fetchNext(args, ++i));
franta-hg@1
    71
					break;
franta-hg@1
    72
				case Tokens.SQL:
franta-hg@8
    73
					options.setSql(fetchNext(args, ++i));
franta-hg@1
    74
					break;
franta-hg@166
    75
				case Tokens.SQL_IN:
franta-hg@166
    76
					try {
franta-hg@166
    77
						options.setSql(readString(in));
franta-hg@166
    78
					} catch (IOException e) {
franta-hg@166
    79
						throw new CLIParserException("Unable to read SQL from the input stream", e);
franta-hg@166
    80
					}
franta-hg@166
    81
					break;
franta-hg@1
    82
				case Tokens.BATCH:
franta-hg@2
    83
					options.setBatch(true);
franta-hg@1
    84
					break;
franta-hg@4
    85
				case Tokens.DATA: // --data is the last option
franta-hg@4
    86
					for (i++; i < args.length; i++) {
franta-hg@4
    87
						arg = args[i];
franta-hg@52
    88
						Parameter parameter;
franta-hg@52
    89
						if (numberedTypes.isEmpty()) {
franta-hg@52
    90
							parameter = new Parameter(arg, null);
franta-hg@52
    91
						} else {
franta-hg@52
    92
							int paramIndex = options.getNumberedParameters().size();
franta-hg@68
    93
							SQLType paramType;
franta-hg@52
    94
							try {
franta-hg@52
    95
								paramType = numberedTypes.get(paramIndex);
franta-hg@52
    96
							} catch (IndexOutOfBoundsException e) {
franta-hg@52
    97
								throw new CLIParserException("Missing type for parameter #" + paramIndex, e);
franta-hg@52
    98
							} catch (NullPointerException e) {
franta-hg@52
    99
								throw new CLIParserException("Invalid type definition for parameter #" + paramIndex, e);
franta-hg@4
   100
							}
franta-hg@52
   101
							parameter = new Parameter(arg, paramType);
franta-hg@4
   102
						}
franta-hg@52
   103
						options.addNumberedParameter(parameter);
franta-hg@52
   104
					}
franta-hg@52
   105
					break;
franta-hg@52
   106
				case Tokens.DATA_NAMED:
franta-hg@52
   107
					for (i++; i < args.length; i++) {
franta-hg@52
   108
						String paramName = args[i];
franta-hg@52
   109
						String paramValue = fetchNext(args, ++i);
franta-hg@52
   110
						options.addNamedParameter(new NamedParameter(paramName, paramValue, namedTypes.get(paramName)));
franta-hg@4
   111
					}
franta-hg@1
   112
					break;
franta-hg@246
   113
				case Tokens.RELATION:
franta-hg@246
   114
					options.addRelationName(fetchNext(args, ++i));
franta-hg@246
   115
					break;
franta-hg@14
   116
				case Tokens.FORMATTER:
franta-hg@14
   117
					options.setFormatterName(fetchNext(args, ++i));
franta-hg@14
   118
					break;
franta-hg@107
   119
				case Tokens.DB_PROPERTY:
franta-hg@107
   120
					options.addDatabaseProperty(new Property(fetchNext(args, ++i), fetchNext(args, ++i)));
franta-hg@107
   121
					break;
franta-hg@107
   122
				case Tokens.FORMATTER_PROPERTY:
franta-hg@107
   123
					options.addFormatterProperty(new Property(fetchNext(args, ++i), fetchNext(args, ++i)));
franta-hg@107
   124
					break;
franta-hg@14
   125
				case Tokens.INFO_HELP:
franta-hg@69
   126
					options.addShowInfo(InfoType.HELP);
franta-hg@14
   127
					break;
franta-hg@14
   128
				case Tokens.INFO_FORMATTERS:
franta-hg@69
   129
					options.addShowInfo(InfoType.FORMATTERS);
franta-hg@14
   130
					break;
franta-hg@209
   131
				case Tokens.INFO_FORMATTER_PROPERTIES:
franta-hg@209
   132
					options.addShowInfo(InfoType.FORMATTER_PROPERTIES);
franta-hg@209
   133
					options.addFormatterNameToListProperties(fetchNext(args, ++i));
franta-hg@209
   134
					break;
franta-hg@14
   135
				case Tokens.INFO_LICENSE:
franta-hg@69
   136
					options.addShowInfo(InfoType.LICENSE);
franta-hg@14
   137
					break;
franta-hg@200
   138
				case Tokens.INFO_JAVA_PROPERTIES:
franta-hg@200
   139
					options.addShowInfo(InfoType.JAVA_PROPERTIES);
franta-hg@200
   140
					break;
franta-hg@200
   141
				case Tokens.INFO_ENVIRONMENT_VARIABLES:
franta-hg@200
   142
					options.addShowInfo(InfoType.ENVIRONMENT_VARIABLES);
franta-hg@200
   143
					break;
franta-hg@14
   144
				case Tokens.INFO_TYPES:
franta-hg@69
   145
					options.addShowInfo(InfoType.TYPES);
franta-hg@14
   146
					break;
franta-hg@14
   147
				case Tokens.INFO_VERSION:
franta-hg@69
   148
					options.addShowInfo(InfoType.VERSION);
franta-hg@14
   149
					break;
franta-hg@158
   150
				case Tokens.INFO_JDBC_DRIVERS:
franta-hg@158
   151
					options.addShowInfo(InfoType.JDBC_DRIVERS);
franta-hg@158
   152
					break;
franta-hg@159
   153
				case Tokens.INFO_JDBC_PROPERTIES:
franta-hg@159
   154
					options.addShowInfo(InfoType.JDBC_PROPERTIES);
franta-hg@159
   155
					options.addDatabaseNameToListProperties(fetchNext(args, ++i));
franta-hg@159
   156
					break;
franta-hg@15
   157
				case Tokens.INFO_DATABASES:
franta-hg@69
   158
					options.addShowInfo(InfoType.DATABASES);
franta-hg@15
   159
					break;
franta-hg@15
   160
				case Tokens.INFO_CONNECTION:
franta-hg@69
   161
					options.addShowInfo(InfoType.CONNECTION);
franta-hg@159
   162
					options.addDatabaseNameToTest(fetchNext(args, ++i));
franta-hg@15
   163
					break;
franta-hg@4
   164
				default:
franta-hg@9
   165
					throw new CLIParserException("Unknown option: " + arg);
franta-hg@1
   166
			}
franta-hg@1
   167
		}
franta-hg@8
   168
		return options;
franta-hg@8
   169
	}
franta-hg@1
   170
franta-hg@9
   171
	private String fetchNext(String[] args, int index) throws CLIParserException {
franta-hg@8
   172
		if (index < args.length) {
franta-hg@8
   173
			return args[index];
franta-hg@8
   174
		} else {
franta-hg@9
   175
			throw new CLIParserException("Expecting value for option: " + args[index - 1]);
franta-hg@8
   176
		}
franta-hg@1
   177
	}
franta-hg@1
   178
franta-hg@1
   179
	public static class Tokens {
franta-hg@1
   180
franta-hg@79
   181
		// bash-completion:options:
franta-hg@96
   182
		public static final String DB = "--db"; // bash-completion:option // help: database name
franta-hg@107
   183
		public static final String DB_PROPERTY = "--db-property"; // bash-completion:option // help: name and value
franta-hg@96
   184
		public static final String SQL = "--sql"; // bash-completion:option // help: SQL query/command
franta-hg@166
   185
		public static final String SQL_IN = "--sql-in"; // bash-completion:option // help: SQL query/command
franta-hg@96
   186
		public static final String BATCH = "--batch"; // bash-completion:option // help: batch mode (no argument)
franta-hg@96
   187
		public static final String DATA = "--data"; // bash-completion:option // help: list of ordinal parameters
franta-hg@96
   188
		public static final String DATA_NAMED = "--data-named"; // bash-completion:option // help: list of named parameters
franta-hg@96
   189
		public static final String NAME_PREFIX = "--name-prefix"; // bash-completion:option // help: parameter name prefix – regular expression
franta-hg@96
   190
		public static final String NAME_SUFFIX = "--name-suffix"; // bash-completion:option // help: parameter name suffix – regular expression
franta-hg@96
   191
		public static final String TYPES = "--types"; // bash-completion:option // help: comma separated list of parameter types
franta-hg@246
   192
		public static final String RELATION = "--relation"; // bash-completion:option // help: name of the output relation (result set)
franta-hg@96
   193
		public static final String FORMATTER = "--formatter"; // bash-completion:option // help: name of the output formatter
franta-hg@107
   194
		public static final String FORMATTER_PROPERTY = "--formatter-property"; // bash-completion:option // help: name and value
franta-hg@96
   195
		public static final String INFO_HELP = "--help"; // bash-completion:option // help: print this help
franta-hg@96
   196
		public static final String INFO_VERSION = "--version"; // bash-completion:option // help: print version info
franta-hg@96
   197
		public static final String INFO_LICENSE = "--license"; // bash-completion:option // help: print license
franta-hg@200
   198
		public static final String INFO_JAVA_PROPERTIES = "--list-java-properties"; // bash-completion:option // help: list of Java system properties
franta-hg@200
   199
		public static final String INFO_ENVIRONMENT_VARIABLES = "--list-environment-variables"; // bash-completion:option // help: list of environment variables
franta-hg@96
   200
		public static final String INFO_FORMATTERS = "--list-formatters"; // bash-completion:option // help: print list of available formatters
franta-hg@217
   201
		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
   202
		public static final String INFO_TYPES = "--list-types"; // bash-completion:option // help: print list of available data types
franta-hg@158
   203
		public static final String INFO_JDBC_DRIVERS = "--list-jdbc-drivers"; // bash-completion:option // help: list of available JDBC drivers
franta-hg@159
   204
		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
   205
		public static final String INFO_DATABASES = "--list-databases"; // bash-completion:option // help: print list of configured databases
franta-hg@96
   206
		public static final String INFO_CONNECTION = "--test-connection"; // bash-completion:option // help: test connection to particular database
franta-hg@1
   207
franta-hg@1
   208
		private Tokens() {
franta-hg@1
   209
		}
franta-hg@1
   210
	}
franta-hg@4
   211
franta-hg@68
   212
	private SQLType getType(String typeString) throws CLIParserException {
franta-hg@68
   213
		try {
franta-hg@68
   214
			return SQLType.valueOf(typeString.trim());
franta-hg@68
   215
		} catch (IllegalArgumentException e) {
franta-hg@68
   216
			throw new CLIParserException("Unsupported type: " + typeString, e);
franta-hg@8
   217
		}
franta-hg@4
   218
	}
franta-hg@1
   219
}