java/sql-dk/src/info/globalcode/sql/dk/InfoLister.java
author František Kučera <franta-hg@frantovo.cz>
Fri, 27 Dec 2013 18:22:19 +0100
branchv_0
changeset 83 9563232ea0b7
parent 75 43aa4625ab7e
child 89 98d18e9a357b
permissions -rw-r--r--
bash completion: license
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@70
    62
		for (InfoType infoType : commands) {
franta-hg@70
    63
			switch (infoType) {
franta-hg@74
    64
				// only these need formatted output
franta-hg@70
    65
				case CONNECTION:
franta-hg@70
    66
				case DATABASES:
franta-hg@70
    67
				case FORMATTERS:
franta-hg@70
    68
				case TYPES:
franta-hg@70
    69
					formatter = getFormatter();
franta-hg@70
    70
					formatter.writeStartDatabase(new DatabaseDefinition());
franta-hg@70
    71
			}
franta-hg@70
    72
		}
franta-hg@70
    73
franta-hg@70
    74
		for (InfoType infoType : commands) {
franta-hg@70
    75
			infoType.showInfo(this);
franta-hg@70
    76
		}
franta-hg@70
    77
franta-hg@70
    78
		if (formatter != null) {
franta-hg@70
    79
			formatter.writeEndDatabase();
franta-hg@70
    80
		}
franta-hg@70
    81
	}
franta-hg@70
    82
franta-hg@72
    83
	private void listFormatters() throws ConfigurationException, FormatterException {
franta-hg@72
    84
		ColumnsHeader header = constructHeader(
franta-hg@72
    85
				new HeaderField("name", SQLType.VARCHAR),
franta-hg@72
    86
				new HeaderField("built_in", SQLType.BOOLEAN),
franta-hg@72
    87
				new HeaderField("default", SQLType.BOOLEAN),
franta-hg@72
    88
				new HeaderField("class_name", SQLType.VARCHAR));
franta-hg@72
    89
		List<Object[]> data = new ArrayList<>();
franta-hg@72
    90
franta-hg@72
    91
		String defaultFormatter = configurationProvider.getConfiguration().getDefaultFormatter();
franta-hg@72
    92
		defaultFormatter = defaultFormatter == null ? Configuration.DEFAULT_FORMATTER : defaultFormatter;
franta-hg@72
    93
franta-hg@69
    94
		for (FormatterDefinition fd : configurationProvider.getConfiguration().getBuildInFormatters()) {
franta-hg@72
    95
			data.add(new Object[]{fd.getName(), true, defaultFormatter.equals(fd.getName()), fd.getClassName()});
franta-hg@69
    96
		}
franta-hg@72
    97
franta-hg@72
    98
		for (FormatterDefinition fd : configurationProvider.getConfiguration().getFormatters()) {
franta-hg@72
    99
			data.add(new Object[]{fd.getName(), false, defaultFormatter.equals(fd.getName()), fd.getClassName()});
franta-hg@69
   100
		}
franta-hg@72
   101
franta-hg@72
   102
		printTable(formatter, header, data);
franta-hg@72
   103
franta-hg@72
   104
franta-hg@69
   105
	}
franta-hg@67
   106
franta-hg@70
   107
	public void listTypes() throws FormatterException, ConfigurationException {
franta-hg@70
   108
		ColumnsHeader header = constructHeader(new HeaderField("name", SQLType.VARCHAR), new HeaderField("code", SQLType.INTEGER));
franta-hg@70
   109
		List<Object[]> data = new ArrayList<>();
franta-hg@70
   110
		for (SQLType sqlType : SQLType.values()) {
franta-hg@70
   111
			data.add(new Object[]{sqlType.name(), sqlType.getCode()});
franta-hg@70
   112
		}
franta-hg@70
   113
		printTable(formatter, header, data);
franta-hg@69
   114
	}
franta-hg@67
   115
franta-hg@72
   116
	public void listDatabases() throws ConfigurationException, FormatterException {
franta-hg@72
   117
		ColumnsHeader header = constructHeader(
franta-hg@72
   118
				new HeaderField("database_name", SQLType.VARCHAR),
franta-hg@72
   119
				new HeaderField("user_name", SQLType.VARCHAR),
franta-hg@72
   120
				new HeaderField("database_url", SQLType.VARCHAR));
franta-hg@72
   121
		List<Object[]> data = new ArrayList<>();
franta-hg@72
   122
franta-hg@69
   123
		final List<DatabaseDefinition> configuredDatabases = configurationProvider.getConfiguration().getDatabases();
franta-hg@69
   124
		if (configuredDatabases.isEmpty()) {
franta-hg@69
   125
			log.log(Level.WARNING, "No databases are configured.");
franta-hg@69
   126
		} else {
franta-hg@69
   127
			for (DatabaseDefinition dd : configuredDatabases) {
franta-hg@72
   128
				data.add(new Object[]{dd.getName(), dd.getUserName(), dd.getUrl()});
franta-hg@14
   129
			}
franta-hg@14
   130
		}
franta-hg@72
   131
franta-hg@72
   132
		printTable(formatter, header, data);
franta-hg@14
   133
	}
franta-hg@17
   134
franta-hg@73
   135
	public void testConnection() throws FormatterException, ConfigurationException {
franta-hg@73
   136
		ColumnsHeader header = constructHeader(
franta-hg@73
   137
				new HeaderField("database_name", SQLType.VARCHAR),
franta-hg@74
   138
				new HeaderField("configured", SQLType.BOOLEAN),
franta-hg@74
   139
				new HeaderField("connected", SQLType.BOOLEAN));
franta-hg@73
   140
		List<Object[]> data = new ArrayList<>();
franta-hg@73
   141
franta-hg@74
   142
		for (String dbName : options.getDatabaseNameToTest()) {
franta-hg@74
   143
			data.add(testConnection(dbName));
franta-hg@74
   144
		}
franta-hg@73
   145
franta-hg@73
   146
		printTable(formatter, header, data);
franta-hg@73
   147
	}
franta-hg@73
   148
franta-hg@73
   149
	public Object[] testConnection(String dbName) {
franta-hg@69
   150
		log.log(Level.FINE, "Testing connection to database: {0}", dbName);
franta-hg@73
   151
franta-hg@73
   152
		boolean succesfullyConnected = false;
franta-hg@73
   153
		boolean succesfullyConfigured = false;
franta-hg@73
   154
franta-hg@69
   155
		try {
franta-hg@69
   156
			DatabaseDefinition dd = configurationProvider.getConfiguration().getDatabase(dbName);
franta-hg@75
   157
			log.log(Level.FINE, "Database definition was loaded from configuration");
franta-hg@75
   158
			succesfullyConfigured = true;
franta-hg@75
   159
			try (DatabaseConnection dc = dd.connect()) {
franta-hg@75
   160
				succesfullyConnected = dc.test();
franta-hg@69
   161
			}
franta-hg@75
   162
			log.log(Level.FINE, "Database connection test was successful");
franta-hg@69
   163
		} catch (ConfigurationException | SQLException e) {
franta-hg@69
   164
			log.log(Level.SEVERE, "Error during testing connection", e);
franta-hg@69
   165
		}
franta-hg@73
   166
franta-hg@73
   167
		return new Object[]{dbName, succesfullyConfigured, succesfullyConnected};
franta-hg@69
   168
	}
franta-hg@69
   169
franta-hg@69
   170
	public void printResource(String fileName) {
franta-hg@18
   171
		try (BufferedReader reader = new BufferedReader(new InputStreamReader(getClass().getClassLoader().getResourceAsStream(fileName)))) {
franta-hg@17
   172
			while (true) {
franta-hg@18
   173
				String line = reader.readLine();
franta-hg@17
   174
				if (line == null) {
franta-hg@17
   175
					break;
franta-hg@17
   176
				} else {
franta-hg@17
   177
					println(line);
franta-hg@17
   178
				}
franta-hg@17
   179
			}
franta-hg@17
   180
		} catch (Exception e) {
franta-hg@18
   181
			log.log(Level.SEVERE, "Unable to print this info. Please see our website for it: " + Constants.WEBSITE, e);
franta-hg@17
   182
		}
franta-hg@17
   183
	}
franta-hg@17
   184
franta-hg@17
   185
	private void println(String line) {
franta-hg@17
   186
		out.println(line);
franta-hg@17
   187
	}
franta-hg@69
   188
franta-hg@69
   189
	private void printTable(Formatter formatter, ColumnsHeader header, List<Object[]> data) throws ConfigurationException, FormatterException {
franta-hg@69
   190
		formatter.writeStartResultSet();
franta-hg@69
   191
		formatter.writeColumnsHeader(header);
franta-hg@69
   192
franta-hg@69
   193
		for (Object[] row : data) {
franta-hg@69
   194
			formatter.writeStartRow();
franta-hg@69
   195
			for (Object cell : row) {
franta-hg@69
   196
				formatter.writeColumnValue(cell);
franta-hg@69
   197
			}
franta-hg@69
   198
			formatter.writeEndRow();
franta-hg@69
   199
		}
franta-hg@69
   200
franta-hg@69
   201
		formatter.writeEndResultSet();
franta-hg@69
   202
	}
franta-hg@69
   203
franta-hg@69
   204
	private Formatter getFormatter() throws ConfigurationException, FormatterException {
franta-hg@69
   205
		FormatterDefinition fd = configurationProvider.getConfiguration().getFormatter(options.getFormatterName());
franta-hg@69
   206
		FormatterContext context = new FormatterContext(out);
franta-hg@69
   207
		return fd.getInstance(context);
franta-hg@69
   208
	}
franta-hg@69
   209
franta-hg@69
   210
	private ColumnsHeader constructHeader(HeaderField... fields) throws FormatterException {
franta-hg@69
   211
		try {
franta-hg@69
   212
			RowSetMetaDataImpl metaData = new RowSetMetaDataImpl();
franta-hg@69
   213
			metaData.setColumnCount(fields.length);
franta-hg@69
   214
franta-hg@69
   215
			for (int i = 0; i < fields.length; i++) {
franta-hg@69
   216
				HeaderField hf = fields[i];
franta-hg@69
   217
				int sqlIndex = i + 1;
franta-hg@69
   218
				metaData.setColumnName(sqlIndex, hf.name);
franta-hg@69
   219
				metaData.setColumnLabel(sqlIndex, hf.name);
franta-hg@69
   220
				metaData.setColumnType(sqlIndex, hf.type.getCode());
franta-hg@69
   221
				metaData.setColumnTypeName(sqlIndex, hf.type.name());
franta-hg@69
   222
			}
franta-hg@69
   223
franta-hg@69
   224
			return new ColumnsHeader(metaData);
franta-hg@69
   225
		} catch (SQLException e) {
franta-hg@69
   226
			throw new FormatterException("Error while constructing table headers", e);
franta-hg@69
   227
		}
franta-hg@69
   228
	}
franta-hg@69
   229
franta-hg@69
   230
	private static class HeaderField {
franta-hg@69
   231
franta-hg@69
   232
		String name;
franta-hg@69
   233
		SQLType type;
franta-hg@69
   234
franta-hg@69
   235
		public HeaderField(String name, SQLType type) {
franta-hg@69
   236
			this.name = name;
franta-hg@69
   237
			this.type = type;
franta-hg@69
   238
		}
franta-hg@69
   239
	}
franta-hg@69
   240
franta-hg@69
   241
	public enum InfoType {
franta-hg@69
   242
franta-hg@69
   243
		HELP {
franta-hg@69
   244
			@Override
franta-hg@69
   245
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   246
				infoLister.printResource(Constants.HELP_FILE);
franta-hg@69
   247
			}
franta-hg@69
   248
		},
franta-hg@69
   249
		VERSION {
franta-hg@69
   250
			@Override
franta-hg@69
   251
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   252
				infoLister.printResource(Constants.VERSION_FILE);
franta-hg@69
   253
			}
franta-hg@69
   254
		},
franta-hg@69
   255
		LICENSE {
franta-hg@69
   256
			@Override
franta-hg@69
   257
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   258
				infoLister.printResource(Constants.LICENSE_FILE);
franta-hg@69
   259
			}
franta-hg@69
   260
		},
franta-hg@69
   261
		FORMATTERS {
franta-hg@69
   262
			@Override
franta-hg@70
   263
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   264
				infoLister.listFormatters();
franta-hg@69
   265
			}
franta-hg@69
   266
		},
franta-hg@69
   267
		TYPES {
franta-hg@69
   268
			@Override
franta-hg@70
   269
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   270
				infoLister.listTypes();
franta-hg@69
   271
			}
franta-hg@69
   272
		},
franta-hg@69
   273
		DATABASES {
franta-hg@69
   274
			@Override
franta-hg@70
   275
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   276
				infoLister.listDatabases();
franta-hg@69
   277
			}
franta-hg@69
   278
		},
franta-hg@69
   279
		CONNECTION {
franta-hg@69
   280
			@Override
franta-hg@73
   281
			public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
franta-hg@69
   282
				infoLister.testConnection();
franta-hg@69
   283
			}
franta-hg@69
   284
		};
franta-hg@69
   285
franta-hg@69
   286
		public abstract void showInfo(InfoLister infoLister) throws ConfigurationException, FormatterException;
franta-hg@69
   287
	}
franta-hg@14
   288
}