java/sql-dk/src/info/globalcode/sql/dk/CLIStarter.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 02 Jan 2014 19:59:33 +0100
branchv_0
changeset 113 575a8c6b91ad
parent 106 e9c3583580c8
child 144 d273d7c6dc0c
permissions -rw-r--r--
Relax NG schema for XML configuration
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@26
    22
import info.globalcode.sql.dk.configuration.Configuration;
franta-hg@33
    23
import info.globalcode.sql.dk.configuration.ConfigurationException;
franta-hg@34
    24
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@34
    25
import info.globalcode.sql.dk.configuration.FormatterDefinition;
franta-hg@80
    26
import info.globalcode.sql.dk.configuration.NameIdentified;
franta-hg@34
    27
import info.globalcode.sql.dk.formatting.Formatter;
franta-hg@34
    28
import info.globalcode.sql.dk.formatting.FormatterContext;
franta-hg@34
    29
import info.globalcode.sql.dk.formatting.FormatterException;
franta-hg@80
    30
import java.io.File;
franta-hg@80
    31
import java.io.FileNotFoundException;
franta-hg@33
    32
import java.io.IOException;
franta-hg@64
    33
import java.io.PrintStream;
franta-hg@80
    34
import java.io.PrintWriter;
franta-hg@34
    35
import java.sql.SQLException;
franta-hg@80
    36
import java.util.Collection;
franta-hg@13
    37
import java.util.logging.Level;
franta-hg@63
    38
import java.util.logging.LogRecord;
franta-hg@13
    39
import java.util.logging.Logger;
franta-hg@33
    40
import javax.xml.bind.JAXBContext;
franta-hg@33
    41
import javax.xml.bind.Unmarshaller;
franta-hg@13
    42
franta-hg@1
    43
/**
franta-hg@1
    44
 *
franta-hg@1
    45
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@1
    46
 */
franta-hg@20
    47
public class CLIStarter implements ConfigurationProvider {
franta-hg@1
    48
franta-hg@96
    49
	// help:exit-codes
franta-hg@95
    50
	public static final int EXIT_SUCCESS = 0; // doc:success
franta-hg@95
    51
	public static final int EXIT_UNEXPECTED_ERROR = 1; // doc:unexpected error (probably bug)
franta-hg@95
    52
	public static final int EXIT_SQL_ERROR = 3; // doc:SQL error
franta-hg@95
    53
	public static final int EXIT_CLI_PARSE_ERROR = 4; // doc:CLI options parse error
franta-hg@95
    54
	public static final int EXIT_CLI_VALIDATE_ERROR = 5; // doc:CLI options validation error
franta-hg@95
    55
	public static final int EXIT_CONFIGURATION_ERROR = 6; // doc:configuration error
franta-hg@95
    56
	public static final int EXIT_FORMATTING_ERROR = 7; // doc:formatting error
franta-hg@13
    57
	private static final Logger log = Logger.getLogger(CLIStarter.class.getName());
franta-hg@20
    58
	private CLIOptions options;
franta-hg@20
    59
	private Configuration configuration;
franta-hg@13
    60
franta-hg@1
    61
	public static void main(String[] args) {
franta-hg@55
    62
		log.log(Level.FINE, "Starting " + Constants.PROGRAM_NAME);
franta-hg@95
    63
		int exitCode;
franta-hg@63
    64
franta-hg@21
    65
		if (args.length == 0) {
franta-hg@21
    66
			args = new String[]{CLIParser.Tokens.INFO_HELP};
franta-hg@21
    67
		}
franta-hg@21
    68
franta-hg@13
    69
		try {
franta-hg@13
    70
			CLIParser parser = new CLIParser();
franta-hg@13
    71
			CLIOptions options = parser.parseOptions(args);
franta-hg@14
    72
			options.validate();
franta-hg@20
    73
			CLIStarter starter = new CLIStarter(options);
franta-hg@21
    74
			starter.installDefaultConfiguration();
franta-hg@20
    75
			starter.process();
franta-hg@55
    76
			log.log(Level.FINE, "All done");
franta-hg@56
    77
			exitCode = EXIT_SUCCESS;
franta-hg@13
    78
		} catch (CLIParserException e) {
franta-hg@14
    79
			log.log(Level.SEVERE, "Unable to parse CLI options", e);
franta-hg@95
    80
			exitCode = EXIT_CLI_PARSE_ERROR;
franta-hg@14
    81
		} catch (InvalidOptionsException e) {
franta-hg@14
    82
			log.log(Level.SEVERE, "Invalid CLI options", e);
franta-hg@48
    83
			for (InvalidOptionsException.OptionProblem p : e.getProblems()) {
franta-hg@63
    84
				LogRecord r = new LogRecord(Level.SEVERE, "Option problem: {0}");
franta-hg@63
    85
				r.setThrown(p.getException());
franta-hg@63
    86
				r.setParameters(new Object[]{p.getDescription()});
franta-hg@63
    87
				log.log(r);
franta-hg@48
    88
			}
franta-hg@95
    89
			exitCode = EXIT_CLI_VALIDATE_ERROR;
franta-hg@34
    90
		} catch (ConfigurationException e) {
franta-hg@34
    91
			log.log(Level.SEVERE, "Configuration problem", e);
franta-hg@95
    92
			exitCode = EXIT_CONFIGURATION_ERROR;
franta-hg@34
    93
		} catch (SQLException e) {
franta-hg@34
    94
			log.log(Level.SEVERE, "SQL problem", e);
franta-hg@56
    95
			exitCode = EXIT_SQL_ERROR;
franta-hg@34
    96
		} catch (FormatterException e) {
franta-hg@34
    97
			log.log(Level.SEVERE, "Formatting problem", e);
franta-hg@95
    98
			exitCode = EXIT_FORMATTING_ERROR;
franta-hg@13
    99
		}
franta-hg@56
   100
franta-hg@56
   101
		System.exit(exitCode);
franta-hg@4
   102
	}
franta-hg@20
   103
franta-hg@20
   104
	public CLIStarter(CLIOptions options) {
franta-hg@20
   105
		this.options = options;
franta-hg@20
   106
	}
franta-hg@20
   107
franta-hg@34
   108
	private void process() throws ConfigurationException, SQLException, FormatterException {
franta-hg@64
   109
		MODE mode = options.getMode();
franta-hg@64
   110
franta-hg@20
   111
		/** Show info */
franta-hg@20
   112
		if (!options.getShowInfo().isEmpty()) {
franta-hg@64
   113
			PrintStream infoOut = mode == MODE.JUST_SHOW_INFO ? System.out : System.err;
franta-hg@69
   114
			InfoLister infoLister = new InfoLister(infoOut, this, options);
franta-hg@70
   115
			infoLister.showInfo();
franta-hg@20
   116
		}
franta-hg@20
   117
franta-hg@20
   118
		switch (mode) {
franta-hg@20
   119
			case QUERY_NOW:
franta-hg@34
   120
				processQueryNow();
franta-hg@20
   121
				break;
franta-hg@20
   122
			case PREPARE_BATCH:
franta-hg@34
   123
				processPrepareBatch();
franta-hg@20
   124
				break;
franta-hg@20
   125
			case EXECUTE_BATCH:
franta-hg@34
   126
				processExecuteBatch();
franta-hg@20
   127
				break;
franta-hg@20
   128
			case JUST_SHOW_INFO:
franta-hg@20
   129
				// already done above
franta-hg@20
   130
				break;
franta-hg@20
   131
			default:
franta-hg@20
   132
				log.log(Level.SEVERE, "Unsupported mode: {0}", mode);
franta-hg@20
   133
				break;
franta-hg@20
   134
		}
franta-hg@80
   135
franta-hg@80
   136
		generateBashCompletion();
franta-hg@20
   137
	}
franta-hg@20
   138
franta-hg@34
   139
	private void processQueryNow() throws ConfigurationException, SQLException, FormatterException {
franta-hg@34
   140
		DatabaseDefinition dd = getConfiguration().getDatabase(options.getDatabaseName());
franta-hg@75
   141
		FormatterDefinition fd = configuration.getFormatter(options.getFormatterName());
franta-hg@106
   142
		try (DatabaseConnection c = dd.connect(options.getDatabaseProperties())) {
franta-hg@75
   143
			log.log(Level.FINE, "Database connected");
franta-hg@104
   144
			try (Formatter f = fd.getInstance(new FormatterContext(options.getOutputStream(), options.getFormatterProperties()))) {
franta-hg@101
   145
				c.executeQuery(options.getSQLCommand(), f);
franta-hg@101
   146
			}
franta-hg@34
   147
		}
franta-hg@34
   148
	}
franta-hg@34
   149
franta-hg@34
   150
	private void processPrepareBatch() {
franta-hg@34
   151
	}
franta-hg@34
   152
franta-hg@34
   153
	private void processExecuteBatch() {
franta-hg@34
   154
	}
franta-hg@34
   155
franta-hg@20
   156
	@Override
franta-hg@33
   157
	public Configuration getConfiguration() throws ConfigurationException {
franta-hg@20
   158
		if (configuration == null) {
franta-hg@20
   159
			configuration = loadConfiguration();
franta-hg@20
   160
		}
franta-hg@20
   161
		return configuration;
franta-hg@20
   162
	}
franta-hg@20
   163
franta-hg@34
   164
	private void installDefaultConfiguration() throws ConfigurationException {
franta-hg@33
   165
		Constants.DIR.mkdir();
franta-hg@33
   166
franta-hg@33
   167
		if (Constants.CONFIG_FILE.exists()) {
franta-hg@55
   168
			log.log(Level.FINER, "Config file already exists: {0}", Constants.CONFIG_FILE);
franta-hg@33
   169
		} else {
franta-hg@33
   170
			try {
franta-hg@33
   171
				Functions.installResource(Constants.EXAMPLE_CONFIG_FILE, Constants.CONFIG_FILE);
franta-hg@55
   172
				log.log(Level.FINE, "Installing default config file: {0}", Constants.CONFIG_FILE);
franta-hg@33
   173
			} catch (IOException e) {
franta-hg@34
   174
				throw new ConfigurationException("Unable to write example configuration to " + Constants.CONFIG_FILE, e);
franta-hg@33
   175
			}
franta-hg@33
   176
		}
franta-hg@20
   177
	}
franta-hg@20
   178
franta-hg@33
   179
	private Configuration loadConfiguration() throws ConfigurationException {
franta-hg@33
   180
		try {
franta-hg@33
   181
			JAXBContext jaxb = JAXBContext.newInstance(Configuration.class);
franta-hg@33
   182
			Unmarshaller u = jaxb.createUnmarshaller();
franta-hg@33
   183
			return (Configuration) u.unmarshal(Constants.CONFIG_FILE);
franta-hg@33
   184
		} catch (Exception e) {
franta-hg@33
   185
			throw new ConfigurationException("Unable to load configuration from " + Constants.CONFIG_FILE, e);
franta-hg@33
   186
		}
franta-hg@20
   187
	}
franta-hg@80
   188
franta-hg@80
   189
	private void generateBashCompletion() {
franta-hg@80
   190
		if (configuration == null) {
franta-hg@80
   191
			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
   192
		} else {
franta-hg@80
   193
			try {
franta-hg@80
   194
				File dir = new File(Constants.DIR, "bash-completion");
franta-hg@80
   195
				dir.mkdir();
franta-hg@80
   196
				writeBashCompletionHelperFile(configuration.getDatabases(), new File(dir, "databases"));
franta-hg@80
   197
				writeBashCompletionHelperFile(configuration.getAllFormatters(), new File(dir, "formatters"));
franta-hg@80
   198
			} catch (Exception e) {
franta-hg@80
   199
				log.log(Level.WARNING, "Unable to generate Bash completion helper files", e);
franta-hg@80
   200
			}
franta-hg@80
   201
		}
franta-hg@80
   202
	}
franta-hg@80
   203
franta-hg@80
   204
	private void writeBashCompletionHelperFile(Collection<? extends NameIdentified> items, File target) throws FileNotFoundException {
franta-hg@80
   205
		if (Constants.CONFIG_FILE.lastModified() > target.lastModified()) {
franta-hg@80
   206
			try (PrintWriter fw = new PrintWriter(target)) {
franta-hg@80
   207
				for (NameIdentified dd : items) {
franta-hg@80
   208
					fw.println(dd.getName());
franta-hg@80
   209
				}
franta-hg@80
   210
				fw.close();
franta-hg@80
   211
				log.log(Level.FINE, "Bash completion helper file was written: {0}", target);
franta-hg@80
   212
			}
franta-hg@80
   213
		} else {
franta-hg@80
   214
			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
   215
		}
franta-hg@80
   216
	}
franta-hg@1
   217
}