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, either version 3 of the License, or
8 * (at your option) any later version.
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.
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/>.
18 package info.globalcode.sql.dk;
20 import info.globalcode.sql.dk.configuration.ConfigurationProvider;
21 import info.globalcode.sql.dk.CLIOptions.MODE;
22 import info.globalcode.sql.dk.batch.Batch;
23 import info.globalcode.sql.dk.batch.BatchDecoder;
24 import info.globalcode.sql.dk.batch.BatchException;
25 import info.globalcode.sql.dk.batch.BatchEncoder;
26 import info.globalcode.sql.dk.configuration.Configuration;
27 import info.globalcode.sql.dk.configuration.ConfigurationException;
28 import info.globalcode.sql.dk.configuration.DatabaseDefinition;
29 import info.globalcode.sql.dk.configuration.FormatterDefinition;
30 import info.globalcode.sql.dk.configuration.Loader;
31 import info.globalcode.sql.dk.configuration.NameIdentified;
32 import info.globalcode.sql.dk.formatting.Formatter;
33 import info.globalcode.sql.dk.formatting.FormatterContext;
34 import info.globalcode.sql.dk.formatting.FormatterException;
35 import info.globalcode.sql.dk.jmx.ConnectionManagement;
36 import info.globalcode.sql.dk.jmx.ManagementUtils;
38 import java.io.FileNotFoundException;
39 import java.io.IOException;
40 import java.io.PrintStream;
41 import java.io.PrintWriter;
42 import java.sql.SQLException;
43 import java.util.Collection;
44 import java.util.logging.Level;
45 import java.util.logging.LogRecord;
46 import java.util.logging.Logger;
49 * Entry point of the command line interface of SQL-DK.
51 * @author Ing. František Kučera (frantovo.cz)
53 public class CLIStarter implements ConfigurationProvider {
56 public static final int EXIT_SUCCESS = 0; // doc:success
57 public static final int EXIT_UNEXPECTED_ERROR = 1; // doc:unexpected error (probably bug)
58 // 2 is reserved: http://www.tldp.org/LDP/abs/html/exitcodes.html#EXITCODESREF
59 public static final int EXIT_SQL_ERROR = 3; // doc:SQL error
60 public static final int EXIT_CLI_PARSE_ERROR = 4; // doc:CLI options parse error
61 public static final int EXIT_CLI_VALIDATE_ERROR = 5; // doc:CLI options validation error
62 public static final int EXIT_CONFIGURATION_ERROR = 6; // doc:configuration error
63 public static final int EXIT_FORMATTING_ERROR = 7; // doc:formatting error
64 public static final int EXIT_BATCH_ERROR = 8; // doc:batch error
65 private static final Logger log = Logger.getLogger(CLIStarter.class.getName());
66 private final CLIOptions options;
67 private final Loader configurationLoader = new Loader();
68 private Configuration configuration;
70 public static void main(String[] args) {
71 log.log(Level.FINE, "Starting " + Constants.PROGRAM_NAME);
74 if (args.length == 0) {
75 args = new String[]{CLIParser.Tokens.INFO_HELP};
79 CLIParser parser = new CLIParser();
80 CLIOptions options = parser.parseOptions(args, System.in);
82 CLIStarter starter = new CLIStarter(options);
83 starter.installDefaultConfiguration();
85 log.log(Level.FINE, "All done");
86 exitCode = EXIT_SUCCESS;
87 } catch (CLIParserException e) {
88 log.log(Level.SEVERE, "Unable to parse CLI options", e);
89 exitCode = EXIT_CLI_PARSE_ERROR;
90 } catch (InvalidOptionsException e) {
91 log.log(Level.SEVERE, "Invalid CLI options", e);
92 for (InvalidOptionsException.OptionProblem p : e.getProblems()) {
93 LogRecord r = new LogRecord(Level.SEVERE, "Option problem: {0}");
94 r.setThrown(p.getException());
95 r.setParameters(new Object[]{p.getDescription()});
98 exitCode = EXIT_CLI_VALIDATE_ERROR;
99 } catch (ConfigurationException e) {
100 log.log(Level.SEVERE, "Configuration problem", e);
101 exitCode = EXIT_CONFIGURATION_ERROR;
102 } catch (SQLException e) {
103 log.log(Level.SEVERE, "SQL problem", e);
104 exitCode = EXIT_SQL_ERROR;
105 } catch (FormatterException e) {
106 log.log(Level.SEVERE, "Formatting problem", e);
107 exitCode = EXIT_FORMATTING_ERROR;
108 } catch (BatchException e) {
109 log.log(Level.SEVERE, "Batch problem", e);
110 exitCode = EXIT_BATCH_ERROR;
113 System.exit(exitCode);
116 public CLIStarter(CLIOptions options) {
117 this.options = options;
120 private void process() throws ConfigurationException, SQLException, FormatterException, BatchException {
121 MODE mode = options.getMode();
124 if (!options.getShowInfo().isEmpty()) {
125 PrintStream infoOut = mode == MODE.JUST_SHOW_INFO ? System.out : System.err;
126 InfoLister infoLister = new InfoLister(infoOut, this, options);
127 infoLister.showInfo();
135 processPrepareBatch();
138 processExecuteBatch();
141 // already done above
144 log.log(Level.SEVERE, "Unsupported mode: {0}", mode);
148 generateBashCompletion();
151 private void processQueryNow() throws ConfigurationException, SQLException, FormatterException {
152 DatabaseDefinition dd = getConfiguration().getDatabase(options.getDatabaseName());
153 FormatterDefinition fd = configuration.getFormatter(options.getFormatterName());
154 ConnectionManagement jmxBean = ManagementUtils.registerMBean(dd.getName());
156 try (DatabaseConnection c = dd.connect(options.getDatabaseProperties(), jmxBean)) {
157 log.log(Level.FINE, "Database connected");
158 try (Formatter f = fd.getInstance(new FormatterContext(options.getOutputStream(), options.getFormatterProperties()))) {
159 c.executeQuery(options.getSQLCommand(), f);
164 private void processPrepareBatch() throws BatchException {
165 BatchEncoder enc = new BatchEncoder();
166 int length = enc.encode(options.getSQLCommand(), options.getOutputStream());
167 log.log(Level.FINE, "Prepared batch size: {0} bytes", length);
170 private void processExecuteBatch() throws ConfigurationException, SQLException, FormatterException, BatchException {
171 BatchDecoder dec = new BatchDecoder();
172 Batch b = dec.decode(options.getInputStream());
174 DatabaseDefinition dd = getConfiguration().getDatabase(options.getDatabaseName());
175 FormatterDefinition fd = configuration.getFormatter(options.getFormatterName());
176 ConnectionManagement jmxBean = ManagementUtils.registerMBean(dd.getName());
178 try (DatabaseConnection c = dd.connect(options.getDatabaseProperties(), jmxBean)) {
179 log.log(Level.FINE, "Database connected");
180 try (Formatter f = fd.getInstance(new FormatterContext(options.getOutputStream(), options.getFormatterProperties()))) {
181 c.executeBatch(b, f);
187 public Configuration getConfiguration() throws ConfigurationException {
188 if (configuration == null) {
189 configuration = configurationLoader.loadConfiguration();
191 return configuration;
194 private void installDefaultConfiguration() throws ConfigurationException {
195 Constants.DIR.mkdir();
197 if (Constants.CONFIG_FILE.exists()) {
198 log.log(Level.FINER, "Config file already exists: {0}", Constants.CONFIG_FILE);
201 Functions.installResource(Constants.EXAMPLE_CONFIG_FILE, Constants.CONFIG_FILE);
202 log.log(Level.FINE, "Installing default config file: {0}", Constants.CONFIG_FILE);
203 } catch (IOException e) {
204 throw new ConfigurationException("Unable to write example configuration to " + Constants.CONFIG_FILE, e);
209 private void generateBashCompletion() {
210 if (configuration == null) {
211 log.log(Level.FINER, "Not writing Bash completion helper files. In order to generate these files please run some command which requires configuration.");
214 File dir = new File(Constants.DIR, "bash-completion");
216 writeBashCompletionHelperFile(configuration.getDatabases(), new File(dir, "databases"));
217 writeBashCompletionHelperFile(configuration.getAllFormatters(), new File(dir, "formatters"));
218 } catch (Exception e) {
219 log.log(Level.WARNING, "Unable to generate Bash completion helper files", e);
224 private void writeBashCompletionHelperFile(Collection<? extends NameIdentified> items, File target) throws FileNotFoundException {
225 if (Constants.CONFIG_FILE.lastModified() > target.lastModified()) {
226 try (PrintWriter fw = new PrintWriter(target)) {
227 for (NameIdentified dd : items) {
228 fw.println(dd.getName());
231 log.log(Level.FINE, "Bash completion helper file was written: {0}", target);
234 log.log(Level.FINER, "Not writing Bash completion helper file: {0} because configuration {1} has not been changed", new Object[]{target, Constants.CONFIG_FILE});