java/sql-dk/src/info/globalcode/sql/dk/InfoLister.java
author František Kučera <franta-hg@frantovo.cz>
Tue, 07 Jan 2014 21:54:59 +0100
branchv_0
changeset 142 da1e38386d84
parent 139 5c0e344c3b60
child 155 eb3676c6929b
permissions -rw-r--r--
Formatters: structural change – new level „statement“ → query and parameters are no more duplicated into each result set or updates result
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@14
    18
package info.globalcode.sql.dk;
franta-hg@14
    19
franta-hg@67
    20
import info.globalcode.sql.dk.configuration.Configuration;
franta-hg@65
    21
import info.globalcode.sql.dk.configuration.ConfigurationException;
franta-hg@26
    22
import info.globalcode.sql.dk.configuration.ConfigurationProvider;
franta-hg@65
    23
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@67
    24
import info.globalcode.sql.dk.configuration.FormatterDefinition;
franta-hg@69
    25
import info.globalcode.sql.dk.formatting.ColumnsHeader;
franta-hg@69
    26
import info.globalcode.sql.dk.formatting.Formatter;
franta-hg@69
    27
import info.globalcode.sql.dk.formatting.FormatterContext;
franta-hg@69
    28
import info.globalcode.sql.dk.formatting.FormatterException;
franta-hg@17
    29
import java.io.BufferedReader;
franta-hg@17
    30
import java.io.InputStreamReader;
franta-hg@14
    31
import java.io.PrintStream;
franta-hg@65
    32
import java.sql.SQLException;
franta-hg@70
    33
import java.util.ArrayList;
franta-hg@70
    34
import java.util.EnumSet;
franta-hg@66
    35
import java.util.List;
franta-hg@17
    36
import java.util.logging.Level;
franta-hg@17
    37
import java.util.logging.Logger;
franta-hg@69
    38
import javax.sql.rowset.RowSetMetaDataImpl;
franta-hg@14
    39
franta-hg@14
    40
/**
franta-hg@14
    41
 * Displays info like help, version etc.
franta-hg@14
    42
 *
franta-hg@14
    43
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@14
    44
 */
franta-hg@14
    45
public class InfoLister {
franta-hg@14
    46
franta-hg@17
    47
	private static final Logger log = Logger.getLogger(InfoLister.class.getName());
franta-hg@17
    48
	private PrintStream out;
franta-hg@20
    49
	private ConfigurationProvider configurationProvider;
franta-hg@69
    50
	private CLIOptions options;
franta-hg@70
    51
	private Formatter formatter;
franta-hg@17
    52
franta-hg@69
    53
	public InfoLister(PrintStream out, ConfigurationProvider configurationProvider, CLIOptions options) {
franta-hg@17
    54
		this.out = out;
franta-hg@20
    55
		this.configurationProvider = configurationProvider;
franta-hg@69
    56
		this.options = options;
franta-hg@17
    57
	}
franta-hg@17
    58
franta-hg@70
    59
	public void showInfo() throws ConfigurationException, FormatterException {
franta-hg@70
    60
		EnumSet<InfoType> commands = options.getShowInfo();
franta-hg@70
    61
franta-hg@139
    62
		boolean formattinNeeded = false;
franta-hg@139
    63
franta-hg@70
    64
		for (InfoType infoType : commands) {
franta-hg@70
    65
			switch (infoType) {
franta-hg@70
    66
				case CONNECTION:
franta-hg@70
    67
				case DATABASES:
franta-hg@70
    68
				case FORMATTERS:
franta-hg@70
    69
				case TYPES:
franta-hg@139
    70
					formattinNeeded = true;
franta-hg@101
    71
					break;
franta-hg@70
    72
			}
franta-hg@70
    73
		}
franta-hg@139
    74
franta-hg@139
    75
		if (formattinNeeded) {
franta-hg@139
    76
			try (Formatter f = getFormatter()) {
franta-hg@139
    77
				formatter = f;
franta-hg@139
    78
				formatter.writeStartBatch();
franta-hg@139
    79
				formatter.writeStartDatabase(new DatabaseDefinition());
franta-hg@142
    80
				formatter.writeStartStatement();
franta-hg@139
    81
				showInfos(commands);
franta-hg@142
    82
				formatter.writeEndStatement();
franta-hg@139
    83
				formatter.writeEndDatabase();
franta-hg@139
    84
				formatter.writeEndBatch();
franta-hg@139
    85
				formatter.close();
franta-hg@139
    86
			}
franta-hg@139
    87
		} else {
franta-hg@139
    88
			showInfos(commands);
franta-hg@139
    89
		}
franta-hg@101
    90
	}
franta-hg@70
    91
franta-hg@101
    92
	private void showInfos(EnumSet<InfoType> commands) throws ConfigurationException, FormatterException {
franta-hg@70
    93
		for (InfoType infoType : commands) {
franta-hg@70
    94
			infoType.showInfo(this);
franta-hg@70
    95
		}
franta-hg@70
    96
	}
franta-hg@70
    97
franta-hg@72
    98
	private void listFormatters() throws ConfigurationException, FormatterException {
franta-hg@72
    99
		ColumnsHeader header = constructHeader(
franta-hg@72
   100
				new HeaderField("name", SQLType.VARCHAR),
franta-hg@72
   101
				new HeaderField("built_in", SQLType.BOOLEAN),
franta-hg@72
   102
				new HeaderField("default", SQLType.BOOLEAN),
franta-hg@72
   103
				new HeaderField("class_name", SQLType.VARCHAR));
franta-hg@72
   104
		List<Object[]> data = new ArrayList<>();
franta-hg@72
   105
franta-hg@72
   106
		String defaultFormatter = configurationProvider.getConfiguration().getDefaultFormatter();
franta-hg@72
   107
		defaultFormatter = defaultFormatter == null ? Configuration.DEFAULT_FORMATTER : defaultFormatter;
franta-hg@72
   108
franta-hg@69
   109
		for (FormatterDefinition fd : configurationProvider.getConfiguration().getBuildInFormatters()) {
franta-hg@72
   110
			data.add(new Object[]{fd.getName(), true, defaultFormatter.equals(fd.getName()), fd.getClassName()});
franta-hg@69
   111
		}
franta-hg@72
   112
franta-hg@72
   113
		for (FormatterDefinition fd : configurationProvider.getConfiguration().getFormatters()) {
franta-hg@72
   114
			data.add(new Object[]{fd.getName(), false, defaultFormatter.equals(fd.getName()), fd.getClassName()});
franta-hg@69
   115
		}
franta-hg@72
   116
franta-hg@72
   117
		printTable(formatter, header, data);
franta-hg@72
   118
franta-hg@72
   119
franta-hg@69
   120
	}
franta-hg@67
   121
franta-hg@70
   122
	public void listTypes() throws FormatterException, ConfigurationException {
franta-hg@70
   123
		ColumnsHeader header = constructHeader(new HeaderField("name", SQLType.VARCHAR), new HeaderField("code", SQLType.INTEGER));
franta-hg@70
   124
		List<Object[]> data = new ArrayList<>();
franta-hg@70
   125
		for (SQLType sqlType : SQLType.values()) {
franta-hg@70
   126
			data.add(new Object[]{sqlType.name(), sqlType.getCode()});
franta-hg@70
   127
		}
franta-hg@70
   128
		printTable(formatter, header, data);
franta-hg@93
   129
		log.log(Level.INFO, "Type names in --types option are case insensitive");
franta-hg@69
   130
	}
franta-hg@67
   131
franta-hg@72
   132
	public void listDatabases() throws ConfigurationException, FormatterException {
franta-hg@72
   133
		ColumnsHeader header = constructHeader(
franta-hg@72
   134
				new HeaderField("database_name", SQLType.VARCHAR),
franta-hg@72
   135
				new HeaderField("user_name", SQLType.VARCHAR),
franta-hg@72
   136
				new HeaderField("database_url", SQLType.VARCHAR));
franta-hg@72
   137
		List<Object[]> data = new ArrayList<>();
franta-hg@72
   138
franta-hg@69
   139
		final List<DatabaseDefinition> configuredDatabases = configurationProvider.getConfiguration().getDatabases();
franta-hg@69
   140
		if (configuredDatabases.isEmpty()) {
franta-hg@69
   141
			log.log(Level.WARNING, "No databases are configured.");
franta-hg@69
   142
		} else {
franta-hg@69
   143
			for (DatabaseDefinition dd : configuredDatabases) {
franta-hg@72
   144
				data.add(new Object[]{dd.getName(), dd.getUserName(), dd.getUrl()});
franta-hg@14
   145
			}
franta-hg@14
   146
		}
franta-hg@72
   147
franta-hg@72
   148
		printTable(formatter, header, data);
franta-hg@14
   149
	}
franta-hg@17
   150
franta-hg@73
   151
	public void testConnection() throws FormatterException, ConfigurationException {
franta-hg@73
   152
		ColumnsHeader header = constructHeader(
franta-hg@73
   153
				new HeaderField("database_name", SQLType.VARCHAR),
franta-hg@74
   154
				new HeaderField("configured", SQLType.BOOLEAN),
franta-hg@74
   155
				new HeaderField("connected", SQLType.BOOLEAN));
franta-hg@73
   156
		List<Object[]> data = new ArrayList<>();
franta-hg@73
   157
franta-hg@74
   158
		for (String dbName : options.getDatabaseNameToTest()) {
franta-hg@74
   159
			data.add(testConnection(dbName));
franta-hg@74
   160
		}
franta-hg@73
   161
franta-hg@73
   162
		printTable(formatter, header, data);
franta-hg@73
   163
	}
franta-hg@73
   164
franta-hg@73
   165
	public Object[] testConnection(String dbName) {
franta-hg@69
   166
		log.log(Level.FINE, "Testing connection to database: {0}", dbName);
franta-hg@73
   167
franta-hg@73
   168
		boolean succesfullyConnected = false;
franta-hg@73
   169
		boolean succesfullyConfigured = false;
franta-hg@73
   170
franta-hg@69
   171
		try {
franta-hg@69
   172
			DatabaseDefinition dd = configurationProvider.getConfiguration().getDatabase(dbName);
franta-hg@75
   173
			log.log(Level.FINE, "Database definition was loaded from configuration");
franta-hg@75
   174
			succesfullyConfigured = true;
franta-hg@106
   175
			try (DatabaseConnection dc = dd.connect(options.getDatabaseProperties())) {
franta-hg@75
   176
				succesfullyConnected = dc.test();
franta-hg@69
   177
			}
franta-hg@75
   178
			log.log(Level.FINE, "Database connection test was successful");
franta-hg@69
   179
		} catch (ConfigurationException | SQLException e) {
franta-hg@69
   180
			log.log(Level.SEVERE, "Error during testing connection", e);
franta-hg@69
   181
		}
franta-hg@73
   182
franta-hg@73
   183
		return new Object[]{dbName, succesfullyConfigured, succesfullyConnected};
franta-hg@69
   184
	}
franta-hg@69
   185
franta-hg@69
   186
	public void printResource(String fileName) {
franta-hg@18
   187
		try (BufferedReader reader = new BufferedReader(new InputStreamReader(getClass().getClassLoader().getResourceAsStream(fileName)))) {
franta-hg@17
   188
			while (true) {
franta-hg@18
   189
				String line = reader.readLine();
franta-hg@17
   190
				if (line == null) {
franta-hg@17
   191
					break;
franta-hg@17
   192
				} else {
franta-hg@17
   193
					println(line);
franta-hg@17
   194
				}
franta-hg@17
   195
			}
franta-hg@17
   196
		} catch (Exception e) {
franta-hg@18
   197
			log.log(Level.SEVERE, "Unable to print this info. Please see our website for it: " + Constants.WEBSITE, e);
franta-hg@17
   198
		}
franta-hg@17
   199
	}
franta-hg@17
   200
franta-hg@17
   201
	private void println(String line) {
franta-hg@17
   202
		out.println(line);
franta-hg@17
   203
	}
franta-hg@69
   204
franta-hg@69
   205
	private void printTable(Formatter formatter, ColumnsHeader header, List<Object[]> data) throws ConfigurationException, FormatterException {
franta-hg@142
   206
		formatter.writeStartResultSet(header);
franta-hg@69
   207
franta-hg@69
   208
		for (Object[] row : data) {
franta-hg@69
   209
			formatter.writeStartRow();
franta-hg@69
   210
			for (Object cell : row) {
franta-hg@69
   211
				formatter.writeColumnValue(cell);
franta-hg@69
   212
			}
franta-hg@69
   213
			formatter.writeEndRow();
franta-hg@69
   214
		}
franta-hg@69
   215
franta-hg@69
   216
		formatter.writeEndResultSet();
franta-hg@69
   217
	}
franta-hg@69
   218
franta-hg@69
   219
	private Formatter getFormatter() throws ConfigurationException, FormatterException {
franta-hg@89
   220
		String formatterName = options.getFormatterName();
franta-hg@89
   221
		formatterName = formatterName == null ? Configuration.DEFAULT_FORMATTER_PREFETCHING : formatterName;
franta-hg@89
   222
		FormatterDefinition fd = configurationProvider.getConfiguration().getFormatter(formatterName);
franta-hg@104
   223
		FormatterContext context = new FormatterContext(out, options.getFormatterProperties());
franta-hg@69
   224
		return fd.getInstance(context);
franta-hg@69
   225
	}
franta-hg@69
   226
franta-hg@69
   227
	private ColumnsHeader constructHeader(HeaderField... fields) throws FormatterException {
franta-hg@69
   228
		try {
franta-hg@69
   229
			RowSetMetaDataImpl metaData = new RowSetMetaDataImpl();
franta-hg@69
   230
			metaData.setColumnCount(fields.length);
franta-hg@69
   231
franta-hg@69
   232
			for (int i = 0; i < fields.length; i++) {
franta-hg@69
   233
				HeaderField hf = fields[i];
franta-hg@69
   234
				int sqlIndex = i + 1;
franta-hg@69
   235
				metaData.setColumnName(sqlIndex, hf.name);
franta-hg@69
   236
				metaData.setColumnLabel(sqlIndex, hf.name);
franta-hg@69
   237
				metaData.setColumnType(sqlIndex, hf.type.getCode());
franta-hg@69
   238
				metaData.setColumnTypeName(sqlIndex, hf.type.name());
franta-hg@69
   239
			}
franta-hg@69
   240
franta-hg@69
   241
			return new ColumnsHeader(metaData);
franta-hg@69
   242
		} catch (SQLException e) {
franta-hg@69
   243
			throw new FormatterException("Error while constructing table headers", e);
franta-hg@69
   244
		}
franta-hg@69
   245
	}
franta-hg@69
   246
franta-hg@69
   247
	private static class HeaderField {
franta-hg@69
   248
franta-hg@69
   249
		String name;
franta-hg@69
   250
		SQLType type;
franta-hg@69
   251
franta-hg@69
   252
		public HeaderField(String name, SQLType type) {
franta-hg@69
   253
			this.name = name;
franta-hg@69
   254
			this.type = type;
franta-hg@69
   255
		}
franta-hg@69
   256
	}
franta-hg@69
   257
franta-hg@69
   258
	public enum InfoType {
franta-hg@69
   259
franta-hg@69
   260
		HELP {
franta-hg@69
   261
			@Override
franta-hg@69
   262
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   263
				infoLister.printResource(Constants.HELP_FILE);
franta-hg@69
   264
			}
franta-hg@69
   265
		},
franta-hg@69
   266
		VERSION {
franta-hg@69
   267
			@Override
franta-hg@69
   268
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   269
				infoLister.printResource(Constants.VERSION_FILE);
franta-hg@69
   270
			}
franta-hg@69
   271
		},
franta-hg@69
   272
		LICENSE {
franta-hg@69
   273
			@Override
franta-hg@69
   274
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   275
				infoLister.printResource(Constants.LICENSE_FILE);
franta-hg@69
   276
			}
franta-hg@69
   277
		},
franta-hg@69
   278
		FORMATTERS {
franta-hg@69
   279
			@Override
franta-hg@70
   280
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   281
				infoLister.listFormatters();
franta-hg@69
   282
			}
franta-hg@69
   283
		},
franta-hg@69
   284
		TYPES {
franta-hg@69
   285
			@Override
franta-hg@70
   286
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   287
				infoLister.listTypes();
franta-hg@69
   288
			}
franta-hg@69
   289
		},
franta-hg@69
   290
		DATABASES {
franta-hg@69
   291
			@Override
franta-hg@70
   292
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   293
				infoLister.listDatabases();
franta-hg@69
   294
			}
franta-hg@69
   295
		},
franta-hg@69
   296
		CONNECTION {
franta-hg@69
   297
			@Override
franta-hg@73
   298
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   299
				infoLister.testConnection();
franta-hg@69
   300
			}
franta-hg@69
   301
		};
franta-hg@69
   302
franta-hg@69
   303
		public abstract void showInfo(InfoLister infoLister) throws ConfigurationException, FormatterException;
franta-hg@69
   304
	}
franta-hg@14
   305
}