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