3 * Copyright © 2013 František Kučera (frantovo.cz)
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, version 3 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package info.globalcode.sql.dk;
19 import static info.globalcode.sql.dk.Functions.readString;
20 import info.globalcode.sql.dk.InfoLister.InfoType;
21 import info.globalcode.sql.dk.configuration.Property;
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.util.ArrayList;
25 import java.util.HashMap;
26 import java.util.List;
30 * Converts command line arguments from String array to object. Checks basic constraints (if only
31 * supported options are used and if they have correct number of parameters)
33 * @author Ing. František Kučera (frantovo.cz)
35 public class CLIParser {
37 public static final String TYPE_NAME_SEPARATOR = ":";
39 public CLIOptions parseOptions(String[] args, InputStream in) throws CLIParserException {
40 CLIOptions options = new CLIOptions();
42 List<SQLType> numberedTypes = new ArrayList<>();
43 Map<String, SQLType> namedTypes = new HashMap<>();
45 for (int i = 0; i < args.length; i++) {
49 String typesString = fetchNext(args, ++i);
51 for (String oneType : typesString.split(",")) {
52 int sepatratorIndex = oneType.indexOf(TYPE_NAME_SEPARATOR);
53 if (sepatratorIndex == -1) {
54 numberedTypes.add(getType(oneType.toUpperCase()));
56 String namePart = oneType.substring(0, sepatratorIndex).trim();
57 String typePart = oneType.substring(sepatratorIndex + TYPE_NAME_SEPARATOR.length(), oneType.length());
58 namedTypes.put(namePart, getType(typePart.toUpperCase()));
62 case Tokens.NAME_PREFIX:
63 options.setNamePrefix(fetchNext(args, ++i));
65 case Tokens.NAME_SUFFIX:
66 options.setNameSuffix(fetchNext(args, ++i));
69 options.setDatabaseName(fetchNext(args, ++i));
72 options.setSql(fetchNext(args, ++i));
76 options.setSql(readString(in));
77 } catch (IOException e) {
78 throw new CLIParserException("Unable to read SQL from the input stream", e);
82 options.setBatch(true);
84 case Tokens.DATA: // --data is the last option
85 for (i++; i < args.length; i++) {
88 if (numberedTypes.isEmpty()) {
89 parameter = new Parameter(arg, null);
91 int paramIndex = options.getNumberedParameters().size();
94 paramType = numberedTypes.get(paramIndex);
95 } catch (IndexOutOfBoundsException e) {
96 throw new CLIParserException("Missing type for parameter #" + paramIndex, e);
97 } catch (NullPointerException e) {
98 throw new CLIParserException("Invalid type definition for parameter #" + paramIndex, e);
100 parameter = new Parameter(arg, paramType);
102 options.addNumberedParameter(parameter);
105 case Tokens.DATA_NAMED:
106 for (i++; i < args.length; i++) {
107 String paramName = args[i];
108 String paramValue = fetchNext(args, ++i);
109 options.addNamedParameter(new NamedParameter(paramName, paramValue, namedTypes.get(paramName)));
112 case Tokens.RELATION:
113 options.addRelationName(fetchNext(args, ++i));
115 case Tokens.FORMATTER:
116 options.setFormatterName(fetchNext(args, ++i));
118 case Tokens.DB_PROPERTY:
119 options.addDatabaseProperty(new Property(fetchNext(args, ++i), fetchNext(args, ++i)));
121 case Tokens.FORMATTER_PROPERTY:
122 options.addFormatterProperty(new Property(fetchNext(args, ++i), fetchNext(args, ++i)));
124 case Tokens.INFO_HELP:
125 options.addShowInfo(InfoType.HELP);
127 case Tokens.INFO_FORMATTERS:
128 options.addShowInfo(InfoType.FORMATTERS);
130 case Tokens.INFO_FORMATTER_PROPERTIES:
131 options.addShowInfo(InfoType.FORMATTER_PROPERTIES);
132 options.addFormatterNameToListProperties(fetchNext(args, ++i));
134 case Tokens.INFO_LICENSE:
135 options.addShowInfo(InfoType.LICENSE);
137 case Tokens.INFO_JAVA_PROPERTIES:
138 options.addShowInfo(InfoType.JAVA_PROPERTIES);
140 case Tokens.INFO_ENVIRONMENT_VARIABLES:
141 options.addShowInfo(InfoType.ENVIRONMENT_VARIABLES);
143 case Tokens.INFO_TYPES:
144 options.addShowInfo(InfoType.TYPES);
146 case Tokens.INFO_VERSION:
147 options.addShowInfo(InfoType.VERSION);
149 case Tokens.INFO_JDBC_DRIVERS:
150 options.addShowInfo(InfoType.JDBC_DRIVERS);
152 case Tokens.INFO_JDBC_PROPERTIES:
153 options.addShowInfo(InfoType.JDBC_PROPERTIES);
154 options.addDatabaseNameToListProperties(fetchNext(args, ++i));
156 case Tokens.INFO_DATABASES:
157 options.addShowInfo(InfoType.DATABASES);
159 case Tokens.INFO_CONNECTION:
160 options.addShowInfo(InfoType.CONNECTION);
161 options.addDatabaseNameToTest(fetchNext(args, ++i));
164 throw new CLIParserException("Unknown option: " + arg);
170 private String fetchNext(String[] args, int index) throws CLIParserException {
171 if (index < args.length) {
174 throw new CLIParserException("Expecting value for option: " + args[index - 1]);
178 public static class Tokens {
180 // bash-completion:options:
181 public static final String DB = "--db"; // bash-completion:option // help: database name
182 public static final String DB_PROPERTY = "--db-property"; // bash-completion:option // help: name and value
183 public static final String SQL = "--sql"; // bash-completion:option // help: SQL query/command
184 public static final String SQL_IN = "--sql-in"; // bash-completion:option // help: SQL query/command
185 public static final String BATCH = "--batch"; // bash-completion:option // help: batch mode (no argument)
186 public static final String DATA = "--data"; // bash-completion:option // help: list of ordinal parameters
187 public static final String DATA_NAMED = "--data-named"; // bash-completion:option // help: list of named parameters
188 public static final String NAME_PREFIX = "--name-prefix"; // bash-completion:option // help: parameter name prefix – regular expression
189 public static final String NAME_SUFFIX = "--name-suffix"; // bash-completion:option // help: parameter name suffix – regular expression
190 public static final String TYPES = "--types"; // bash-completion:option // help: comma separated list of parameter types
191 public static final String RELATION = "--relation"; // bash-completion:option // help: name of the output relation (result set)
192 public static final String FORMATTER = "--formatter"; // bash-completion:option // help: name of the output formatter
193 public static final String FORMATTER_PROPERTY = "--formatter-property"; // bash-completion:option // help: name and value
194 public static final String INFO_HELP = "--help"; // bash-completion:option // help: print this help
195 public static final String INFO_VERSION = "--version"; // bash-completion:option // help: print version info
196 public static final String INFO_LICENSE = "--license"; // bash-completion:option // help: print license
197 public static final String INFO_JAVA_PROPERTIES = "--list-java-properties"; // bash-completion:option // help: list of Java system properties
198 public static final String INFO_ENVIRONMENT_VARIABLES = "--list-environment-variables"; // bash-completion:option // help: list of environment variables
199 public static final String INFO_FORMATTERS = "--list-formatters"; // bash-completion:option // help: print list of available formatters
200 public static final String INFO_FORMATTER_PROPERTIES = "--list-formatter-properties"; // bash-completion:option // help: print list of available properties for given formatter
201 public static final String INFO_TYPES = "--list-types"; // bash-completion:option // help: print list of available data types
202 public static final String INFO_JDBC_DRIVERS = "--list-jdbc-drivers"; // bash-completion:option // help: list of available JDBC drivers
203 public static final String INFO_JDBC_PROPERTIES = "--list-jdbc-properties"; // bash-completion:option // help: list of available JDBC properties for given database
204 public static final String INFO_DATABASES = "--list-databases"; // bash-completion:option // help: print list of configured databases
205 public static final String INFO_CONNECTION = "--test-connection"; // bash-completion:option // help: test connection to particular database
211 private SQLType getType(String typeString) throws CLIParserException {
213 return SQLType.valueOf(typeString.trim());
214 } catch (IllegalArgumentException e) {
215 throw new CLIParserException("Unsupported type: " + typeString, e);