gitorious.org Git - online-glom:gwt-glom.git/blob - src/main/java/org/glom/web/server/OnlineGlomServiceImpl.java

1 /*

3 *

4 * This file is part of GWT-Glom.

5 *

6 * GWT-Glom is free software: you can redistribute it and/or modify it

7 * under the terms of the GNU Lesser General Public License as published by the

8 * Free Software Foundation, either version 3 of the License, or (at your

9 * option) any later version.

10 *

11 * GWT-Glom is distributed in the hope that it will be useful, but WITHOUT

12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License

14 * for more details.

15 *

16 * You should have received a copy of the GNU Lesser General Public License

17 * along with GWT-Glom. If not, see <http://www.gnu.org/licenses/>.

18 */

19

20 package org.glom.web.server;

21

22 import java.beans.PropertyVetoException;

23 import java.io.File;

24 import java.io.IOException;

25 import java.sql.Connection;

26 import java.sql.Date;

27 import java.sql.ResultSet;

28 import java.sql.SQLException;

29 import java.sql.Statement;

30 import java.sql.Time;

31 import java.text.DateFormat;

32 import java.text.NumberFormat;

33 import java.util.ArrayList;

34 import java.util.Currency;

35 import java.util.Locale;

36 import java.util.Properties;

37

38 import org.glom.libglom.Document;

39 import org.glom.libglom.Field;

40 import org.glom.libglom.FieldFormatting;

41 import org.glom.libglom.FieldVector;

42 import org.glom.libglom.Glom;

43 import org.glom.libglom.LayoutFieldVector;

44 import org.glom.libglom.LayoutGroupVector;

45 import org.glom.libglom.LayoutItem;

46 import org.glom.libglom.LayoutItemVector;

47 import org.glom.libglom.LayoutItem_Field;

48 import org.glom.libglom.NumericFormat;

49 import org.glom.libglom.SortClause;

50 import org.glom.libglom.SortFieldPair;

51 import org.glom.libglom.StringVector;

52 import org.glom.web.client.OnlineGlomService;

53 import org.glom.web.shared.ColumnInfo;

54 import org.glom.web.shared.GlomDocument;

55 import org.glom.web.shared.GlomField;

56 import org.glom.web.shared.LayoutListTable;

57

58 import com.google.gwt.user.server.rpc.RemoteServiceServlet;

59 import com.mchange.v2.c3p0.ComboPooledDataSource;

60 import com.mchange.v2.c3p0.DataSources;

61

62 @SuppressWarnings("serial")

63 public class OnlineGlomServiceImpl extends RemoteServiceServlet implements OnlineGlomService {

64 private Document document = null;

65 private ComboPooledDataSource cpds = null;

66 // TODO implement locale

67 private final Locale locale = Locale.ROOT;

68 private boolean configured = false;

69

70 /*

71 * This is called when the servlet is started or restarted.

72 */

73 public OnlineGlomServiceImpl() {

74 Glom.libglom_init();

75 }

76

77 /*

78 * The properties file can't be loaded in the constructor because the servlet is not yet initialised and

79 * getServletContext() will return null. The work-around for this problem is to initialise the database and glom

80 * document object when makes its first request.

81 */

82 private void configureServlet() {

83 document = new Document();

84

85 Properties props = new Properties();

86 String propFileName = "/WEB-INF/OnlineGlom.properties";

87 try {

88 props.load(getServletContext().getResourceAsStream(propFileName));

89 } catch (IOException e) {

90 // TODO log fatal error, notify user of problem

91 e.printStackTrace();

92 }

93

94 File file = new File(props.getProperty("glomfile"));

95 document.set_file_uri("file://" + file.getAbsolutePath());

96 int error = 0;

97 @SuppressWarnings("unused")

98 boolean retval = document.load(error);

99 // TODO handle error condition

100

101 // load the jdbc driver

102 cpds = new ComboPooledDataSource();

103 try {

104 cpds.setDriverClass("org.postgresql.Driver");

105 } catch (PropertyVetoException e) {

106 // TODO log error, fatal error can't continue, user can be notified when db access doesn't work

107 e.printStackTrace();

108 }

109

110 cpds.setJdbcUrl("jdbc:postgresql://" + document.get_connection_server() + "/"

111 + document.get_connection_database());

112 cpds.setUser(props.getProperty("dbusername"));

113 cpds.setPassword(props.getProperty("dbpassword"));

114 configured = true;

115 }

116

117 /*

118 * This is called when the servlet is stopped or restarted.

119 *

120 * @see javax.servlet.GenericServlet#destroy()

121 */

122 @Override

123 public void destroy() {

124 Glom.libglom_deinit();

125 try {

126 if (configured)

127 DataSources.destroy(cpds);

128 } catch (SQLException e) {

129 // TODO log error, don't need to notify user because this is a clean up method

130 e.printStackTrace();

131 }

132 }

133

134 /*

135 * FIXME I think Swig is generating long on 64-bit machines and int on 32-bit machines - need to keep this constant

136 * http://stackoverflow.com/questions/1590831/safely-casting-long-to-int-in-java

137 */

138 private static int safeLongToInt(long l) {

139 if (l < Integer.MIN_VALUE || l > Integer.MAX_VALUE) {

140 throw new IllegalArgumentException(l + " cannot be cast to int without changing its value.");

141 }

142 return (int) l;

143 }

144

145 public GlomDocument getGlomDocument() {

146 if (!configured)

147 configureServlet();

148

149 GlomDocument glomDocument = new GlomDocument();

150

151 // get arrays of table names and titles, and find the default table index

152 StringVector tablesVec = document.get_table_names();

153

154 int numTables = safeLongToInt(tablesVec.size());

155 // we don't know how many tables will be hidden so we'll use half of the number of tables for the default size

156 // of the ArrayList

157 ArrayList<String> tableNames = new ArrayList<String>(numTables / 2);

158 ArrayList<String> tableTitles = new ArrayList<String>(numTables / 2);

159 boolean foundDefaultTable = false;

160 int visibleIndex = 0;

161 for (int i = 0; i < numTables; i++) {

162 String tableName = tablesVec.get(i);

163 if (!document.get_table_is_hidden(tableName)) {

164 tableNames.add(tableName);

165 // JNI is "expensive", the comparison will only be called if we haven't already found the default table

166 if (!foundDefaultTable && tableName.equals(document.get_default_table())) {

167 glomDocument.setDefaultTableIndex(visibleIndex);

168 foundDefaultTable = true;

169 }

170 tableTitles.add(document.get_table_title(tableName));

171 visibleIndex++;

172 }

173 }

174

175 // set everything we need

176 glomDocument.setTableNames(tableNames);

177 glomDocument.setTableTitles(tableTitles);

178 glomDocument.setTitle(document.get_database_title());

179

180 return glomDocument;

181 }

182

183 public LayoutListTable getLayoutListTable(String tableName) {

184 if (!configured)

185 configureServlet();

186

187 LayoutListTable tableInfo = new LayoutListTable();

188

189 // access the layout list

190 LayoutGroupVector layoutListVec = document.get_data_layout_groups("list", tableName);

191 ColumnInfo[] columns = null;

192 LayoutFieldVector layoutFields = new LayoutFieldVector();

193 if (layoutListVec.size() > 0) {

194 // a layout list is defined, we can use it to for the LayoutListTable

195 // TODO log warning when the layoutListVec.size() > 1 but still use the first list

196 LayoutItemVector layoutItemsVec = layoutListVec.get(0).get_items();

197

198 // find the defined layout list fields

199 int numItems = safeLongToInt(layoutItemsVec.size());

200 columns = new ColumnInfo[numItems];

201 for (int i = 0; i < numItems; i++) {

202 // TODO add support for other LayoutItems (Text, Image, Button)

203 LayoutItem item = layoutItemsVec.get(i);

204 LayoutItem_Field layoutItemField = LayoutItem_Field.cast_dynamic(item);

205 if (layoutItemField != null) {

206 layoutFields.add(layoutItemField);

207 FieldFormatting.HorizontalAlignment alignment = layoutItemField

208 .get_formatting_used_horizontal_alignment();

209 columns[i] = new ColumnInfo(layoutItemField.get_title_or_name(),

210 getColumnInfoHorizontalAlignment(alignment));

211 }

212 }

213 } else {

214 // no layout list is defined, use the table fields as the layout list

215 FieldVector fieldsVec = document.get_table_fields(tableName);

216

217 // find the fields to display in the layout list

218 int numItems = safeLongToInt(fieldsVec.size());

219 columns = new ColumnInfo[numItems];

220 for (int i = 0; i < numItems; i++) {

221 Field field = fieldsVec.get(i);

222 LayoutItem_Field layoutItemField = new LayoutItem_Field();

223 layoutItemField.set_full_field_details(field);

224 layoutFields.add(layoutItemField);

225 FieldFormatting.HorizontalAlignment alignment = layoutItemField

226 .get_formatting_used_horizontal_alignment();

227 columns[i] = new ColumnInfo(layoutItemField.get_title_or_name(),

228 getColumnInfoHorizontalAlignment(alignment));

229 }

230 }

231

232 tableInfo.setColumns(columns);

233

234 // get the size of the returned query for the pager

235 // TODO since we're executing a query anyway, maybe we should return the rows that will be displayed on the

236 // first page

237 // TODO this code is really similar to code in getTableData, find a way to not duplicate the code

238 Connection conn = null;

239 Statement st = null;

240 ResultSet rs = null;

241 try {

242 // setup and execute the query

243 conn = cpds.getConnection();

244 st = conn.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);

245 String query = Glom.build_sql_select_simple(tableName, layoutFields);

246 rs = st.executeQuery(query);

247

248 // get the number of rows in the query

249 rs.setFetchDirection(ResultSet.FETCH_FORWARD);

250 rs.last();

251 tableInfo.setNumRows(rs.getRow());

252

253 } catch (SQLException e) {

254 // TODO log error

255 // we don't know how many rows are in the query

256 e.printStackTrace();

257 tableInfo.setNumRows(0);

258 } finally {

259 // cleanup everything that has been used

260 try {

261 rs.close();

262 st.close();

263 conn.close();

264 } catch (Exception e) {

265 // TODO log error

266 e.printStackTrace();

267 }

268 }

269

270 return tableInfo;

271 }

272

273 public ArrayList<GlomField[]> getTableData(String table, int start, int length) {

274 return getTableData(table, start, length, false, 0, false);

275 }

276

277 public ArrayList<GlomField[]> getSortedTableData(String table, int start, int length, int sortColumnIndex,

278 boolean isAscending) {

279 return getTableData(table, start, length, true, sortColumnIndex, isAscending);

280 }

281

282 private ArrayList<GlomField[]> getTableData(String table, int start, int length, boolean useSortClause,

283 int sortColumnIndex, boolean isAscending) {

284 if (!configured)

285 configureServlet();

286

287 // access the layout list using the defined layout list or the table fields if there's no layout list

288 LayoutGroupVector layoutListVec = document.get_data_layout_groups("list", table);

289 LayoutFieldVector layoutFields = new LayoutFieldVector();

290 SortClause sortClause = new SortClause();

291 if (layoutListVec.size() > 0) {

292 // a layout list is defined, we can use it to for the LayoutListTable

293 // TODO log warning when the layoutListVec.size() > 1 but still use the first list

294 LayoutItemVector layoutItemsVec = layoutListVec.get(0).get_items();

295

296 // find the defined layout list fields

297 int numItems = safeLongToInt(layoutItemsVec.size());

298 for (int i = 0; i < numItems; i++) {

299 // TODO add support for other LayoutItems (Text, Image, Button)

300 LayoutItem item = layoutItemsVec.get(i);

301 LayoutItem_Field layoutItemfield = LayoutItem_Field.cast_dynamic(item);

302 if (layoutItemfield != null) {

303 // use this field in the layout

304 layoutFields.add(layoutItemfield);

305

306 // create a sort clause if it's a primary key and we're not asked to sort a specific column

307 if (!useSortClause) {

308 Field details = layoutItemfield.get_full_field_details();

309 if (details != null && details.get_primary_key()) {

310 sortClause.addLast(new SortFieldPair(layoutItemfield, true)); // ascending

311 }

312 }

313 }

314 }

315 } else {

316 // no layout list is defined, use the table fields as the layout list

317 FieldVector fieldsVec = document.get_table_fields(table);

318

319 // find the fields to display in the layout list

320 int numItems = safeLongToInt(fieldsVec.size());

321 for (int i = 0; i < numItems; i++) {

322 Field field = fieldsVec.get(i);

323 LayoutItem_Field layoutItemField = new LayoutItem_Field();

324 layoutItemField.set_full_field_details(field);

325 layoutFields.add(layoutItemField);

326

327 // create a sort clause if it's a primary key and we're not asked to sort a specific column

328 if (!useSortClause) {

329 if (field.get_primary_key()) {

330 sortClause.addLast(new SortFieldPair(layoutItemField, true)); // ascending

331 }

332 }

333 }

334 }

335

336 // create a sort clause for the column we've been asked to sort

337 if (useSortClause) {

338 LayoutItem item = layoutFields.get(sortColumnIndex);

339 LayoutItem_Field field = LayoutItem_Field.cast_dynamic(item);

340 if (field != null)

341 sortClause.addLast(new SortFieldPair(field, isAscending));

342 // TODO: log error in the else condition

343 }

344

345 ArrayList<GlomField[]> rowsList = new ArrayList<GlomField[]>();

346 Connection conn = null;

347 Statement st = null;

348 ResultSet rs = null;

349 try {

350 // setup and execute the query

351 conn = cpds.getConnection();

352 st = conn.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);

353 String query = Glom.build_sql_select_simple(table, layoutFields, sortClause);

354 rs = st.executeQuery(query);

355

356 // get data we're asked for

357 // TODO need to setup the result set in cursor mode so that not all of the results are pulled into memory

358 rs.setFetchDirection(ResultSet.FETCH_FORWARD);

359 rs.absolute(start);

360 int rowCount = 0;

361 while (rs.next() && rowCount <= length) {

362 int layoutFieldsSize = safeLongToInt(layoutFields.size());

363 GlomField[] rowArray = new GlomField[layoutFieldsSize];

364 for (int i = 0; i < layoutFieldsSize; i++) {

365 // make a new GlomField to set the text and colours

366 rowArray[i] = new GlomField();

367

368 // get foreground and background colours

369 LayoutItem_Field field = layoutFields.get(i);

370 FieldFormatting formatting = field.get_formatting_used();

371 String fgcolour = formatting.get_text_format_color_foreground();

372 if (!fgcolour.isEmpty())

373 rowArray[i].setFGColour(convertGdkColorToHtmlColour(fgcolour));

374 String bgcolour = formatting.get_text_format_color_background();

375 if (!bgcolour.isEmpty())

376 rowArray[i].setBGColour(convertGdkColorToHtmlColour(bgcolour));

377

378 // convert field values are to strings based on the glom type

379 switch (field.get_glom_type()) {

380 case TYPE_TEXT:

381 String text = rs.getString(i + 1);

382 rowArray[i].setText(text != null ? text : "");

383 break;

384 case TYPE_BOOLEAN:

385 rowArray[i].setText(rs.getBoolean(i + 1) ? "TRUE" : "FALSE");

386 break;

387 case TYPE_NUMERIC:

388 // Take care of the numeric formatting before converting the number to a string.

389 NumericFormat numFormatGlom = formatting.getM_numeric_format();

390 // There's no isCurrency() method in the glom NumericFormat class so we're assuming that the

391 // number should be formatted as a currency if the currency code string is not empty.

392 String currencyCode = numFormatGlom.getM_currency_symbol();

393 NumberFormat numFormatJava = null;

394 boolean useGlomCurrencyCode = false;

395 if (currencyCode.length() == 3) {

396 // Try to format the currency using the Java Locales system.

397 try {

398 Currency currency = Currency.getInstance(currencyCode);

399 // Ignore the glom numeric formatting when a valid ISO 4217 currency code is being used.

400 int digits = currency.getDefaultFractionDigits();

401 numFormatJava = NumberFormat.getCurrencyInstance(locale);

402 numFormatJava.setCurrency(currency);

403 numFormatJava.setMinimumFractionDigits(digits);

404 numFormatJava.setMaximumFractionDigits(digits);

405 } catch (IllegalArgumentException e) {

406 // TODO: log warning

407 // The currency code is not this is not an ISO 4217 currency code.

408 // We're going to manually set the currency code and use the glom numeric formatting.

409 useGlomCurrencyCode = true;

410 numFormatJava = getJavaNumberFormat(numFormatGlom);

411 }

412 } else if (currencyCode.length() > 0) {

413 // The length of the currency code is > 0 and != 3; this is not an ISO 4217 currency code.

414 // We're going to manually set the currency code and use the glom numeric formatting.

415 useGlomCurrencyCode = true;

416 numFormatJava = getJavaNumberFormat(numFormatGlom);

417 } else {

418 // The length of the currency code is 0; the number is not a currency.

419 numFormatJava = getJavaNumberFormat(numFormatGlom);

420 }

421

422 // TODO: Do I need to do something with NumericFormat.get_default_precision() from libglom?

423

424 double number = rs.getDouble(i + 1);

425 if (number < 0) {

426 if (formatting.getM_numeric_format().getM_alt_foreground_color_for_negatives())

427 // overrides the set foreground colour

428 rowArray[i].setFGColour(convertGdkColorToHtmlColour(NumericFormat

429 .get_alternative_color_for_negatives()));

430 }

431

432 // Finally convert the number to text using the glom currency string if required.

433 if (useGlomCurrencyCode) {

434 rowArray[i].setText(currencyCode + " " + numFormatJava.format(number));

435 } else {

436 rowArray[i].setText(numFormatJava.format(number));

437 }

438 break;

439 case TYPE_DATE:

440 Date date = rs.getDate(i + 1);

441 if (date != null) {

442 DateFormat dateFormat = DateFormat.getDateInstance(DateFormat.MEDIUM, locale);

443 rowArray[i].setText(dateFormat.format(rs.getDate(i + 1)));

444 } else {

445 rowArray[i].setText("");

446 }

447 break;

448 case TYPE_TIME:

449 Time time = rs.getTime(i + 1);

450 if (time != null) {

451 DateFormat timeFormat = DateFormat.getTimeInstance(DateFormat.MEDIUM, locale);

452 rowArray[i].setText(timeFormat.format(time));

453 } else {

454 rowArray[i].setText("");

455 }

456 break;

457 case TYPE_IMAGE:

458 byte[] image = rs.getBytes(i + 1);

459 if (image != null) {

460 // TODO implement field TYPE_IMAGE

461 rowArray[i].setText("Image (FIXME)");

462 } else {

463 rowArray[i].setText("");

464 }

465 break;

466 case TYPE_INVALID:

467 default:

468 // TODO log warning message

469 rowArray[i].setText("");

470 break;

471 }

472 }

473

474 // add the row of GlomFields to the ArrayList we're going to return and update the row count

475 rowsList.add(rowArray);

476 rowCount++;

477 }

478 } catch (SQLException e) {

479 // TODO: log error, notify user of problem

480 e.printStackTrace();

481 } finally {

482 // cleanup everything that has been used

483 try {

484 rs.close();

485 st.close();

486 conn.close();

487 } catch (Exception e) {

488 // TODO log error

489 e.printStackTrace();

490 }

491 }

492 return rowsList;

493 }

494

495 private NumberFormat getJavaNumberFormat(NumericFormat numFormatGlom) {

496 NumberFormat numFormatJava = NumberFormat.getInstance(locale);

497 if (numFormatGlom.getM_decimal_places_restricted()) {

498 int digits = safeLongToInt(numFormatGlom.getM_decimal_places());

499 numFormatJava.setMinimumFractionDigits(digits);

500 numFormatJava.setMaximumFractionDigits(digits);

501 }

502 numFormatJava.setGroupingUsed(numFormatGlom.getM_use_thousands_separator());

503 return numFormatJava;

504 }

505

506 /*

507 * Converts a Gdk::Color (16-bits per channel) to an HTML colour (8-bits per channel) by disgarding the least

508 * significant 8-bits in each channel.

509 */

510 private String convertGdkColorToHtmlColour(String gdkColor) {

511 if (gdkColor.length() == 13)

512 return gdkColor.substring(0, 2) + gdkColor.substring(5, 6) + gdkColor.substring(9, 10);

513 else if (gdkColor.length() == 7)

514 // TODO: log warning because we're expecting a 13 character string

515 return gdkColor;

516 else

517 // TODO: log error

518 return "";

519 }

520

521 /*

522 * This method converts a FieldFormatting.HorizontalAlignment to the equivalent ColumnInfo.HorizontalAlignment. The

523 * need for this comes from the fact that the GWT HorizontalAlignment classes can't be used with RPC and there's no

524 * easy way to use the java-libglom FieldFormatting.HorizontalAlignment enum with RPC. An enum indentical to

525 * FieldFormatting.HorizontalAlignment is included in the ColumnInfo class.

526 */

527 private ColumnInfo.HorizontalAlignment getColumnInfoHorizontalAlignment(

528 FieldFormatting.HorizontalAlignment alignment) {

529 int value = alignment.swigValue();

530 ColumnInfo.HorizontalAlignment[] columnInfoValues = ColumnInfo.HorizontalAlignment.class.getEnumConstants();

531 if (value < columnInfoValues.length && value >= 0)

532 return columnInfoValues[value];

533 // TODO: log error: value out of range, returning HORIZONTAL_ALIGNMENT_RIGHT

534 return columnInfoValues[FieldFormatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_RIGHT.swigValue()];

535 }

536

537 }