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