java/sql-dk/src/info/globalcode/sql/dk/CLIStarter.java
author František Kučera <franta-hg@frantovo.cz>
Sun, 16 Aug 2015 01:40:44 +0200
branchv_0
changeset 221 e38910065d55
parent 220 0bc544b38cfa
permissions -rw-r--r--
bash-completion: --formatter-property choices: first working version
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@26
    20
import info.globalcode.sql.dk.configuration.ConfigurationProvider;
franta-hg@20
    21
import info.globalcode.sql.dk.CLIOptions.MODE;
franta-hg@146
    22
import info.globalcode.sql.dk.batch.Batch;
franta-hg@146
    23
import info.globalcode.sql.dk.batch.BatchDecoder;
franta-hg@144
    24
import info.globalcode.sql.dk.batch.BatchException;
franta-hg@144
    25
import info.globalcode.sql.dk.batch.BatchEncoder;
franta-hg@26
    26
import info.globalcode.sql.dk.configuration.Configuration;
franta-hg@33
    27
import info.globalcode.sql.dk.configuration.ConfigurationException;
franta-hg@34
    28
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@34
    29
import info.globalcode.sql.dk.configuration.FormatterDefinition;
franta-hg@189
    30
import info.globalcode.sql.dk.configuration.Loader;
franta-hg@80
    31
import info.globalcode.sql.dk.configuration.NameIdentified;
franta-hg@220
    32
import info.globalcode.sql.dk.configuration.PropertyDeclaration;
franta-hg@34
    33
import info.globalcode.sql.dk.formatting.Formatter;
franta-hg@34
    34
import info.globalcode.sql.dk.formatting.FormatterContext;
franta-hg@34
    35
import info.globalcode.sql.dk.formatting.FormatterException;
franta-hg@179
    36
import info.globalcode.sql.dk.jmx.ConnectionManagement;
franta-hg@179
    37
import info.globalcode.sql.dk.jmx.ManagementUtils;
franta-hg@80
    38
import java.io.File;
franta-hg@80
    39
import java.io.FileNotFoundException;
franta-hg@33
    40
import java.io.IOException;
franta-hg@64
    41
import java.io.PrintStream;
franta-hg@80
    42
import java.io.PrintWriter;
franta-hg@34
    43
import java.sql.SQLException;
franta-hg@80
    44
import java.util.Collection;
franta-hg@220
    45
import java.util.Collections;
franta-hg@220
    46
import java.util.List;
franta-hg@13
    47
import java.util.logging.Level;
franta-hg@63
    48
import java.util.logging.LogRecord;
franta-hg@13
    49
import java.util.logging.Logger;
franta-hg@13
    50
franta-hg@1
    51
/**
franta-hg@155
    52
 * Entry point of the command line interface of SQL-DK.
franta-hg@1
    53
 *
franta-hg@1
    54
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@1
    55
 */
franta-hg@20
    56
public class CLIStarter implements ConfigurationProvider {
franta-hg@1
    57
franta-hg@96
    58
	// help:exit-codes
franta-hg@95
    59
	public static final int EXIT_SUCCESS = 0; // doc:success
franta-hg@95
    60
	public static final int EXIT_UNEXPECTED_ERROR = 1; // doc:unexpected error (probably bug)
franta-hg@155
    61
	// 2 is reserved: http://www.tldp.org/LDP/abs/html/exitcodes.html#EXITCODESREF
franta-hg@95
    62
	public static final int EXIT_SQL_ERROR = 3; // doc:SQL error
franta-hg@95
    63
	public static final int EXIT_CLI_PARSE_ERROR = 4; // doc:CLI options parse error
franta-hg@95
    64
	public static final int EXIT_CLI_VALIDATE_ERROR = 5; // doc:CLI options validation error
franta-hg@95
    65
	public static final int EXIT_CONFIGURATION_ERROR = 6; // doc:configuration error
franta-hg@95
    66
	public static final int EXIT_FORMATTING_ERROR = 7; // doc:formatting error
franta-hg@149
    67
	public static final int EXIT_BATCH_ERROR = 8; // doc:batch error
franta-hg@13
    68
	private static final Logger log = Logger.getLogger(CLIStarter.class.getName());
franta-hg@189
    69
	private final CLIOptions options;
franta-hg@189
    70
	private final Loader configurationLoader = new Loader();
franta-hg@20
    71
	private Configuration configuration;
franta-hg@13
    72
franta-hg@1
    73
	public static void main(String[] args) {
franta-hg@55
    74
		log.log(Level.FINE, "Starting " + Constants.PROGRAM_NAME);
franta-hg@95
    75
		int exitCode;
franta-hg@63
    76
franta-hg@21
    77
		if (args.length == 0) {
franta-hg@21
    78
			args = new String[]{CLIParser.Tokens.INFO_HELP};
franta-hg@21
    79
		}
franta-hg@21
    80
franta-hg@13
    81
		try {
franta-hg@13
    82
			CLIParser parser = new CLIParser();
franta-hg@166
    83
			CLIOptions options = parser.parseOptions(args, System.in);
franta-hg@14
    84
			options.validate();
franta-hg@20
    85
			CLIStarter starter = new CLIStarter(options);
franta-hg@21
    86
			starter.installDefaultConfiguration();
franta-hg@20
    87
			starter.process();
franta-hg@55
    88
			log.log(Level.FINE, "All done");
franta-hg@56
    89
			exitCode = EXIT_SUCCESS;
franta-hg@13
    90
		} catch (CLIParserException e) {
franta-hg@14
    91
			log.log(Level.SEVERE, "Unable to parse CLI options", e);
franta-hg@95
    92
			exitCode = EXIT_CLI_PARSE_ERROR;
franta-hg@14
    93
		} catch (InvalidOptionsException e) {
franta-hg@14
    94
			log.log(Level.SEVERE, "Invalid CLI options", e);
franta-hg@48
    95
			for (InvalidOptionsException.OptionProblem p : e.getProblems()) {
franta-hg@63
    96
				LogRecord r = new LogRecord(Level.SEVERE, "Option problem: {0}");
franta-hg@63
    97
				r.setThrown(p.getException());
franta-hg@63
    98
				r.setParameters(new Object[]{p.getDescription()});
franta-hg@63
    99
				log.log(r);
franta-hg@48
   100
			}
franta-hg@95
   101
			exitCode = EXIT_CLI_VALIDATE_ERROR;
franta-hg@34
   102
		} catch (ConfigurationException e) {
franta-hg@34
   103
			log.log(Level.SEVERE, "Configuration problem", e);
franta-hg@95
   104
			exitCode = EXIT_CONFIGURATION_ERROR;
franta-hg@34
   105
		} catch (SQLException e) {
franta-hg@34
   106
			log.log(Level.SEVERE, "SQL problem", e);
franta-hg@56
   107
			exitCode = EXIT_SQL_ERROR;
franta-hg@34
   108
		} catch (FormatterException e) {
franta-hg@34
   109
			log.log(Level.SEVERE, "Formatting problem", e);
franta-hg@95
   110
			exitCode = EXIT_FORMATTING_ERROR;
franta-hg@144
   111
		} catch (BatchException e) {
franta-hg@144
   112
			log.log(Level.SEVERE, "Batch problem", e);
franta-hg@149
   113
			exitCode = EXIT_BATCH_ERROR;
franta-hg@13
   114
		}
franta-hg@56
   115
franta-hg@56
   116
		System.exit(exitCode);
franta-hg@4
   117
	}
franta-hg@20
   118
franta-hg@20
   119
	public CLIStarter(CLIOptions options) {
franta-hg@20
   120
		this.options = options;
franta-hg@20
   121
	}
franta-hg@20
   122
franta-hg@144
   123
	private void process() throws ConfigurationException, SQLException, FormatterException, BatchException {
franta-hg@64
   124
		MODE mode = options.getMode();
franta-hg@64
   125
franta-hg@20
   126
		/** Show info */
franta-hg@20
   127
		if (!options.getShowInfo().isEmpty()) {
franta-hg@64
   128
			PrintStream infoOut = mode == MODE.JUST_SHOW_INFO ? System.out : System.err;
franta-hg@69
   129
			InfoLister infoLister = new InfoLister(infoOut, this, options);
franta-hg@70
   130
			infoLister.showInfo();
franta-hg@20
   131
		}
franta-hg@20
   132
franta-hg@20
   133
		switch (mode) {
franta-hg@20
   134
			case QUERY_NOW:
franta-hg@34
   135
				processQueryNow();
franta-hg@20
   136
				break;
franta-hg@20
   137
			case PREPARE_BATCH:
franta-hg@34
   138
				processPrepareBatch();
franta-hg@20
   139
				break;
franta-hg@20
   140
			case EXECUTE_BATCH:
franta-hg@34
   141
				processExecuteBatch();
franta-hg@20
   142
				break;
franta-hg@20
   143
			case JUST_SHOW_INFO:
franta-hg@20
   144
				// already done above
franta-hg@20
   145
				break;
franta-hg@20
   146
			default:
franta-hg@20
   147
				log.log(Level.SEVERE, "Unsupported mode: {0}", mode);
franta-hg@20
   148
				break;
franta-hg@20
   149
		}
franta-hg@80
   150
franta-hg@80
   151
		generateBashCompletion();
franta-hg@20
   152
	}
franta-hg@20
   153
franta-hg@34
   154
	private void processQueryNow() throws ConfigurationException, SQLException, FormatterException {
franta-hg@34
   155
		DatabaseDefinition dd = getConfiguration().getDatabase(options.getDatabaseName());
franta-hg@75
   156
		FormatterDefinition fd = configuration.getFormatter(options.getFormatterName());
franta-hg@179
   157
		ConnectionManagement jmxBean = ManagementUtils.registerMBean(dd.getName());
franta-hg@179
   158
franta-hg@179
   159
		try (DatabaseConnection c = dd.connect(options.getDatabaseProperties(), jmxBean)) {
franta-hg@75
   160
			log.log(Level.FINE, "Database connected");
franta-hg@104
   161
			try (Formatter f = fd.getInstance(new FormatterContext(options.getOutputStream(), options.getFormatterProperties()))) {
franta-hg@101
   162
				c.executeQuery(options.getSQLCommand(), f);
franta-hg@101
   163
			}
franta-hg@34
   164
		}
franta-hg@34
   165
	}
franta-hg@34
   166
franta-hg@144
   167
	private void processPrepareBatch() throws BatchException {
franta-hg@144
   168
		BatchEncoder enc = new BatchEncoder();
franta-hg@144
   169
		int length = enc.encode(options.getSQLCommand(), options.getOutputStream());
franta-hg@144
   170
		log.log(Level.FINE, "Prepared batch size: {0} bytes", length);
franta-hg@34
   171
	}
franta-hg@34
   172
franta-hg@146
   173
	private void processExecuteBatch() throws ConfigurationException, SQLException, FormatterException, BatchException {
franta-hg@146
   174
		BatchDecoder dec = new BatchDecoder();
franta-hg@146
   175
		Batch b = dec.decode(options.getInputStream());
franta-hg@146
   176
franta-hg@146
   177
		DatabaseDefinition dd = getConfiguration().getDatabase(options.getDatabaseName());
franta-hg@146
   178
		FormatterDefinition fd = configuration.getFormatter(options.getFormatterName());
franta-hg@179
   179
		ConnectionManagement jmxBean = ManagementUtils.registerMBean(dd.getName());
franta-hg@179
   180
franta-hg@179
   181
		try (DatabaseConnection c = dd.connect(options.getDatabaseProperties(), jmxBean)) {
franta-hg@146
   182
			log.log(Level.FINE, "Database connected");
franta-hg@146
   183
			try (Formatter f = fd.getInstance(new FormatterContext(options.getOutputStream(), options.getFormatterProperties()))) {
franta-hg@146
   184
				c.executeBatch(b, f);
franta-hg@146
   185
			}
franta-hg@146
   186
		}
franta-hg@34
   187
	}
franta-hg@34
   188
franta-hg@20
   189
	@Override
franta-hg@33
   190
	public Configuration getConfiguration() throws ConfigurationException {
franta-hg@20
   191
		if (configuration == null) {
franta-hg@189
   192
			configuration = configurationLoader.loadConfiguration();
franta-hg@20
   193
		}
franta-hg@20
   194
		return configuration;
franta-hg@20
   195
	}
franta-hg@20
   196
franta-hg@34
   197
	private void installDefaultConfiguration() throws ConfigurationException {
franta-hg@33
   198
		Constants.DIR.mkdir();
franta-hg@33
   199
franta-hg@33
   200
		if (Constants.CONFIG_FILE.exists()) {
franta-hg@55
   201
			log.log(Level.FINER, "Config file already exists: {0}", Constants.CONFIG_FILE);
franta-hg@33
   202
		} else {
franta-hg@33
   203
			try {
franta-hg@33
   204
				Functions.installResource(Constants.EXAMPLE_CONFIG_FILE, Constants.CONFIG_FILE);
franta-hg@55
   205
				log.log(Level.FINE, "Installing default config file: {0}", Constants.CONFIG_FILE);
franta-hg@33
   206
			} catch (IOException e) {
franta-hg@34
   207
				throw new ConfigurationException("Unable to write example configuration to " + Constants.CONFIG_FILE, e);
franta-hg@33
   208
			}
franta-hg@33
   209
		}
franta-hg@20
   210
	}
franta-hg@20
   211
franta-hg@80
   212
	private void generateBashCompletion() {
franta-hg@80
   213
		if (configuration == null) {
franta-hg@80
   214
			log.log(Level.FINER, "Not writing Bash completion helper files. In order to generate these files please run some command which requires configuration.");
franta-hg@80
   215
		} else {
franta-hg@80
   216
			try {
franta-hg@80
   217
				File dir = new File(Constants.DIR, "bash-completion");
franta-hg@80
   218
				dir.mkdir();
franta-hg@80
   219
				writeBashCompletionHelperFile(configuration.getDatabases(), new File(dir, "databases"));
franta-hg@80
   220
				writeBashCompletionHelperFile(configuration.getAllFormatters(), new File(dir, "formatters"));
franta-hg@220
   221
				writeBashCompletionHelperFileForFormatterProperties(new File(dir, "formatter-properties"));
franta-hg@80
   222
			} catch (Exception e) {
franta-hg@80
   223
				log.log(Level.WARNING, "Unable to generate Bash completion helper files", e);
franta-hg@80
   224
			}
franta-hg@80
   225
		}
franta-hg@80
   226
	}
franta-hg@80
   227
franta-hg@80
   228
	private void writeBashCompletionHelperFile(Collection<? extends NameIdentified> items, File target) throws FileNotFoundException {
franta-hg@80
   229
		if (Constants.CONFIG_FILE.lastModified() > target.lastModified()) {
franta-hg@80
   230
			try (PrintWriter fw = new PrintWriter(target)) {
franta-hg@80
   231
				for (NameIdentified dd : items) {
franta-hg@80
   232
					fw.println(dd.getName());
franta-hg@80
   233
				}
franta-hg@80
   234
				fw.close();
franta-hg@80
   235
				log.log(Level.FINE, "Bash completion helper file was written: {0}", target);
franta-hg@80
   236
			}
franta-hg@80
   237
		} else {
franta-hg@80
   238
			log.log(Level.FINER, "Not writing Bash completion helper file: {0} because configuration {1} has not been changed", new Object[]{target, Constants.CONFIG_FILE});
franta-hg@80
   239
		}
franta-hg@80
   240
	}
franta-hg@220
   241
franta-hg@221
   242
	private void writeBashCompletionHelperFileForFormatterProperties(File formattersDir) throws ClassNotFoundException, FileNotFoundException {
franta-hg@220
   243
		if (Constants.CONFIG_FILE.lastModified() > formattersDir.lastModified()) {
franta-hg@220
   244
			// TODO: delete old directory
franta-hg@220
   245
			formattersDir.mkdir();
franta-hg@220
   246
			for (FormatterDefinition fd : configuration.getAllFormatters()) {
franta-hg@220
   247
				File formatterDir = new File(formattersDir, fd.getName());
franta-hg@220
   248
				formatterDir.mkdir();
franta-hg@220
   249
franta-hg@220
   250
				Class<Formatter> formatterClass = (Class<Formatter>) Class.forName(fd.getClassName());
franta-hg@220
   251
				List<Class<? extends Formatter>> hierarchy = Functions.getClassHierarchy(formatterClass, Formatter.class);
franta-hg@220
   252
				Collections.reverse(hierarchy);
franta-hg@221
   253
				for (Class<? extends Formatter> c : hierarchy) {
franta-hg@220
   254
					for (PropertyDeclaration p : Functions.getPropertyDeclarations(c)) {
franta-hg@220
   255
						File propertyDir = new File(formatterDir, p.name());
franta-hg@220
   256
						propertyDir.mkdir();
franta-hg@221
   257
						File choicesFile = new File(propertyDir, "choices");
franta-hg@221
   258
						try (PrintWriter fw = new PrintWriter(choicesFile)) {
franta-hg@221
   259
							// TODO: refactor, move
franta-hg@221
   260
							if (p.type() == Boolean.class) {
franta-hg@221
   261
								fw.println("true");
franta-hg@221
   262
								fw.println("false");
franta-hg@221
   263
							}
franta-hg@221
   264
						}
franta-hg@220
   265
					}
franta-hg@221
   266
				}
franta-hg@220
   267
			}
franta-hg@220
   268
			log.log(Level.FINE, "Bash completion helper files was written in: {0}", formattersDir);
franta-hg@220
   269
		} else {
franta-hg@220
   270
			log.log(Level.FINER, "Not writing Bash completion helper directory: {0} because configuration {1} has not been changed", new Object[]{formattersDir, Constants.CONFIG_FILE});
franta-hg@220
   271
		}
franta-hg@220
   272
franta-hg@220
   273
	}
franta-hg@1
   274
}