gitorious.org Git - online-glom:gwt-glom.git/blob - src/main/java/org/glom/web/server/ConfiguredDocument.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.sql.Connection;

24 import java.sql.SQLException;

25 import java.util.ArrayList;

26 import java.util.Locale;

27

28 import org.apache.commons.lang3.StringUtils;

29 import org.glom.libglom.Field;

30 import org.glom.libglom.FieldVector;

31 import org.glom.libglom.LayoutGroupVector;

32 import org.glom.libglom.LayoutItemVector;

33 import org.glom.libglom.LayoutItem_CalendarPortal;

34 import org.glom.libglom.LayoutItem_Field;

35 import org.glom.libglom.LayoutItem_Notebook;

36 import org.glom.libglom.LayoutItem_Portal;

37 import org.glom.libglom.NumericFormat;

38 import org.glom.libglom.Relationship;

39 import org.glom.libglom.StringVector;

40 import org.glom.web.server.database.DetailsDBAccess;

41 import org.glom.web.server.database.ListViewDBAccess;

42 import org.glom.web.server.database.RelatedListDBAccess;

43 import org.glom.web.server.database.RelatedListNavigation;

44 import org.glom.web.shared.DataItem;

45 import org.glom.web.shared.DocumentInfo;

46 import org.glom.web.shared.GlomNumericFormat;

47 import org.glom.web.shared.NavigationRecord;

48 import org.glom.web.shared.Reports;

49 import org.glom.web.shared.TypedDataItem;

50 import org.glom.web.shared.layout.Formatting;

51 import org.glom.web.shared.layout.LayoutGroup;

52 import org.glom.web.shared.layout.LayoutItem;

53 import org.glom.web.shared.layout.LayoutItemField;

54 import org.glom.web.shared.layout.LayoutItemNotebook;

55 import org.glom.web.shared.layout.LayoutItemPortal;

56 import org.glom.web.shared.libglom.Document;

57 import org.glom.web.shared.libglom.Report;

58

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

60

61 /**

62 * A class to hold configuration information for a given Glom document. This class retrieves layout information from

63 * libglom and data from the underlying PostgreSQL database.

64 */

65 final class ConfiguredDocument {

66

67 private Document document;

68 private ComboPooledDataSource cpds;

69 private boolean authenticated = false;

70 private String documentID = "";

71 private String defaultLocaleID = "";

72

73 @SuppressWarnings("unused")

74 private ConfiguredDocument() {

75 // disable default constructor

76 }

77

78 ConfiguredDocument(final Document document) throws PropertyVetoException {

79

80 // load the jdbc driver

81 cpds = new ComboPooledDataSource();

82

83 // We don't support sqlite or self-hosting yet.

84 if (document.get_hosting_mode() != Document.HostingMode.HOSTING_MODE_POSTGRES_CENTRAL) {

85 Log.fatal("Error configuring the database connection." + " Only central PostgreSQL hosting is supported.");

86 // FIXME: Throw exception?

87 }

88

89 try {

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

91 } catch (final PropertyVetoException e) {

92 Log.fatal("Error loading the PostgreSQL JDBC driver."

93 + " Is the PostgreSQL JDBC jar available to the servlet?", e);

94 throw e;

95 }

96

97 // setup the JDBC driver for the current glom document

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

99 + "/" + document.get_connection_database());

100

101 this.document = document;

102 }

103

104 /**

105 * Sets the username and password for the database associated with the Glom document.

106 *

107 * @return true if the username and password works, false otherwise

108 */

109 boolean setUsernameAndPassword(final String username, final String password) throws SQLException {

110 cpds.setUser(username);

111 cpds.setPassword(password);

112

113 final int acquireRetryAttempts = cpds.getAcquireRetryAttempts();

114 cpds.setAcquireRetryAttempts(1);

115 Connection conn = null;

116 try {

117 // FIXME find a better way to check authentication

118 // it's possible that the connection could be failing for another reason

119 conn = cpds.getConnection();

120 authenticated = true;

121 } catch (final SQLException e) {

122 Log.info(Utils.getFileName(document.get_file_uri()), e.getMessage());

123 Log.info(Utils.getFileName(document.get_file_uri()),

124 "Connection Failed. Maybe the username or password is not correct.");

125 authenticated = false;

126 } finally {

127 if (conn != null)

128 conn.close();

129 cpds.setAcquireRetryAttempts(acquireRetryAttempts);

130 }

131 return authenticated;

132 }

133

134 Document getDocument() {

135 return document;

136 }

137

138 ComboPooledDataSource getCpds() {

139 return cpds;

140 }

141

142 boolean isAuthenticated() {

143 return authenticated;

144 }

145

146 String getDocumentID() {

147 return documentID;

148 }

149

150 void setDocumentID(final String documentID) {

151 this.documentID = documentID;

152 }

153

154 String getDefaultLocaleID() {

155 return defaultLocaleID;

156 }

157

158 void setDefaultLocaleID(final String localeID) {

159 this.defaultLocaleID = localeID;

160 }

161

162 /**

163 * @return

164 */

165 DocumentInfo getDocumentInfo(final String localeID) {

166 final DocumentInfo documentInfo = new DocumentInfo();

167

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

169 final StringVector tablesVec = document.get_table_names();

170

171 final int numTables = Utils.safeLongToInt(tablesVec.size());

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

173 // of the ArrayList

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

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

176 boolean foundDefaultTable = false;

177 int visibleIndex = 0;

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

179 final String tableName = tablesVec.get(i);

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

181 tableNames.add(tableName);

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

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

184 documentInfo.setDefaultTableIndex(visibleIndex);

185 foundDefaultTable = true;

186 }

187 tableTitles.add(document.get_table_title(tableName, localeID));

188 visibleIndex++;

189 }

190 }

191

192 // set everything we need

193 documentInfo.setTableNames(tableNames);

194 documentInfo.setTableTitles(tableTitles);

195 documentInfo.setTitle(document.get_database_title(localeID));

196

197 // Fetch arrays of locale IDs and titles:

198 final StringVector localesVec = document.get_translation_available_locales();

199 final int numLocales = Utils.safeLongToInt(localesVec.size());

200 final ArrayList<String> localeIDs = new ArrayList<String>(numLocales);

201 final ArrayList<String> localeTitles = new ArrayList<String>(numLocales);

202 for (int i = 0; i < numLocales; i++) {

203 final String this_localeID = localesVec.get(i);

204 localeIDs.add(this_localeID);

205

206 // Use java.util.Locale to get a title for the locale:

207 final String[] locale_parts = this_localeID.split("_");

208 String locale_lang = this_localeID;

209 if (locale_parts.length > 0)

210 locale_lang = locale_parts[0];

211 String locale_country = "";

212 if (locale_parts.length > 1)

213 locale_country = locale_parts[1];

214

215 final Locale locale = new Locale(locale_lang, locale_country);

216 final String title = locale.getDisplayName(locale);

217 localeTitles.add(title);

218 }

219 documentInfo.setLocaleIDs(localeIDs);

220 documentInfo.setLocaleTitles(localeTitles);

221

222 return documentInfo;

223 }

224

225 /*

226 * Gets the layout group for the list view using the defined layout list in the document or the table fields if

227 * there's no defined layout group for the list view.

228 */

229 private org.glom.libglom.LayoutGroup getValidListViewLayoutGroup(final String tableName) {

230

231 final LayoutGroupVector layoutGroupVec = document.get_data_layout_groups("list", tableName);

232

233 final int listViewLayoutGroupSize = Utils.safeLongToInt(layoutGroupVec.size());

234 org.glom.libglom.LayoutGroup libglomLayoutGroup = null;

235 if (listViewLayoutGroupSize > 0) {

236 // a list layout group is defined; we can use the first group as the list

237 if (listViewLayoutGroupSize > 1)

238 Log.warn(documentID, tableName, "The size of the list layout group is greater than 1. "

239 + "Attempting to use the first item for the layout list view.");

240

241 libglomLayoutGroup = layoutGroupVec.get(0);

242 } else {

243 // a list layout group is *not* defined; we are going make a libglom layout group from the list of fields

244 Log.info(documentID, tableName,

245 "A list layout is not defined for this table. Displaying a list layout based on the field list.");

246

247 final FieldVector fieldsVec = document.get_table_fields(tableName);

248 libglomLayoutGroup = new org.glom.libglom.LayoutGroup();

249 for (int i = 0; i < fieldsVec.size(); i++) {

250 final Field field = fieldsVec.get(i);

251 final LayoutItem_Field layoutItemField = new LayoutItem_Field();

252 layoutItemField.set_full_field_details(field);

253 libglomLayoutGroup.add_item(layoutItemField);

254 }

255 }

256

257 return libglomLayoutGroup;

258 }

259

260 ArrayList<DataItem[]> getListViewData(String tableName, final String quickFind, final int start, final int length,

261 final boolean useSortClause, final int sortColumnIndex, final boolean isAscending) {

262 // Validate the table name.

263 tableName = getTableNameToUse(tableName);

264

265 // Get the libglom LayoutGroup that represents the list view.

266 final org.glom.libglom.LayoutGroup libglomLayoutGroup = getValidListViewLayoutGroup(tableName);

267

268 // Create a database access object for the list view.

269 final ListViewDBAccess listViewDBAccess = new ListViewDBAccess(document, documentID, cpds, tableName,

270 libglomLayoutGroup);

271

272 // Return the data.

273 return listViewDBAccess.getData(quickFind, start, length, useSortClause, sortColumnIndex, isAscending);

274 }

275

276 DataItem[] getDetailsData(String tableName, final TypedDataItem primaryKeyValue) {

277 // Validate the table name.

278 tableName = getTableNameToUse(tableName);

279

280 final DetailsDBAccess detailsDBAccess = new DetailsDBAccess(document, documentID, cpds, tableName);

281

282 return detailsDBAccess.getData(primaryKeyValue);

283 }

284

285 ArrayList<DataItem[]> getRelatedListData(String tableName, final String relationshipName,

286 final TypedDataItem foreignKeyValue, final int start, final int length, final boolean useSortClause,

287 final int sortColumnIndex, final boolean isAscending) {

288 // Validate the table name.

289 tableName = getTableNameToUse(tableName);

290

291 // Create a database access object for the related list

292 final RelatedListDBAccess relatedListDBAccess = new RelatedListDBAccess(document, documentID, cpds, tableName,

293 relationshipName);

294

295 // Return the data

296 return relatedListDBAccess.getData(start, length, foreignKeyValue, useSortClause, sortColumnIndex, isAscending);

297 }

298

299 ArrayList<LayoutGroup> getDetailsLayoutGroup(String tableName, final String localeID) {

300 // Validate the table name.

301 tableName = getTableNameToUse(tableName);

302

303 // Get the details layout group information for each LayoutGroup in the LayoutGroupVector

304 final LayoutGroupVector layoutGroupVec = document.get_data_layout_groups("details", tableName);

305 final ArrayList<LayoutGroup> layoutGroups = new ArrayList<LayoutGroup>();

306 for (int i = 0; i < layoutGroupVec.size(); i++) {

307 final org.glom.libglom.LayoutGroup libglomLayoutGroup = layoutGroupVec.get(i);

308

309 // satisfy the precondition of getDetailsLayoutGroup(String, org.glom.libglom.LayoutGroup)

310 if (libglomLayoutGroup == null)

311 continue;

312

313 layoutGroups.add(getDetailsLayoutGroup(tableName, libglomLayoutGroup, localeID));

314 }

315

316 return layoutGroups;

317 }

318

319 /*

320 * Gets the expected row count for a related list.

321 */

322 int getRelatedListRowCount(String tableName, final String relationshipName, final TypedDataItem foreignKeyValue) {

323 // Validate the table name.

324 tableName = getTableNameToUse(tableName);

325

326 // Create a database access object for the related list

327 final RelatedListDBAccess relatedListDBAccess = new RelatedListDBAccess(document, documentID, cpds, tableName,

328 relationshipName);

329

330 // Return the row count

331 return relatedListDBAccess.getExpectedResultSize(foreignKeyValue);

332 }

333

334 NavigationRecord getSuitableRecordToViewDetails(String tableName, final String relationshipName,

335 final TypedDataItem primaryKeyValue) {

336 // Validate the table name.

337 tableName = getTableNameToUse(tableName);

338

339 final RelatedListNavigation relatedListNavigation = new RelatedListNavigation(document, documentID, cpds,

340 tableName, relationshipName);

341

342 return relatedListNavigation.getNavigationRecord(primaryKeyValue);

343 }

344

345 LayoutGroup getListViewLayoutGroup(String tableName, final String localeID) {

346 // Validate the table name.

347 tableName = getTableNameToUse(tableName);

348

349 final org.glom.libglom.LayoutGroup libglomLayoutGroup = getValidListViewLayoutGroup(tableName);

350

351 return getLayoutGroupFromLiblomLayoutGroup(tableName, libglomLayoutGroup, localeID);

352 }

353

354 /**

355 * @param tableName

356 * @param libglomLayoutGroup

357 * @param localeID

358 * @return

359 */

360 private LayoutGroup getLayoutGroupFromLiblomLayoutGroup(final String tableName,

361 final org.glom.libglom.LayoutGroup libglomLayoutGroup, final String localeID) {

362 final LayoutGroup layoutGroup = new LayoutGroup(); // the object that will be returned

363 int primaryKeyIndex = -1;

364

365 // look at each child item

366 final LayoutItemVector layoutItemsVec = libglomLayoutGroup.get_items();

367 final int numItems = Utils.safeLongToInt(layoutItemsVec.size());

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

369 final org.glom.libglom.LayoutItem libglomLayoutItem = layoutItemsVec.get(i);

370

371 // TODO add support for other LayoutItems (Text, Image, Button etc.)

372 final LayoutItem_Field libglomLayoutItemField = LayoutItem_Field.cast_dynamic(libglomLayoutItem);

373 if (libglomLayoutItemField != null) {

374 layoutGroup.addItem(convertToGWTGlomLayoutItemField(libglomLayoutItemField, localeID, false));

375 final Field field = libglomLayoutItemField.get_full_field_details();

376 if (field.get_primary_key())

377 primaryKeyIndex = i;

378 } else {

379 // TODO: We can implement this easily when we replace libglom, because then we won't need to translate

380 // libglom items to our own item classes here.

381 Log.info(documentID, tableName,

382 "Ignoring unknown list LayoutItem of type " + libglomLayoutItem.get_part_type_name() + ".");

383 continue;

384 }

385 }

386

387 // set the expected result size for list view tables

388 final ListViewDBAccess listViewDBAccess = new ListViewDBAccess(document, documentID, cpds, tableName,

389 libglomLayoutGroup);

390 layoutGroup.setExpectedResultSize(listViewDBAccess.getExpectedResultSize());

391

392 // Set the primary key index for the table

393 if (primaryKeyIndex < 0) {

394 // Add a LayoutItemField for the primary key to the end of the item list in the LayoutGroup because it

395 // doesn't already contain a primary key.

396 Field primaryKey = null;

397 final FieldVector fieldsVec = document.get_table_fields(tableName);

398 for (int i = 0; i < Utils.safeLongToInt(fieldsVec.size()); i++) {

399 final Field field = fieldsVec.get(i);

400 if (field.get_primary_key()) {

401 primaryKey = field;

402 break;

403 }

404 }

405 if (primaryKey != null) {

406 final LayoutItem_Field libglomLayoutItemField = new LayoutItem_Field();

407 libglomLayoutItemField.set_full_field_details(primaryKey);

408 layoutGroup.addItem(convertToGWTGlomLayoutItemField(libglomLayoutItemField, localeID, false));

409 layoutGroup.setPrimaryKeyIndex(layoutGroup.getItems().size() - 1);

410 layoutGroup.setHiddenPrimaryKey(true);

411 } else {

412 Log.error(document.get_database_title_original(), tableName,

413 "A primary key was not found in the FieldVector for this table. Navigation buttons will not work.");

414 }

415

416 } else {

417 layoutGroup.setPrimaryKeyIndex(primaryKeyIndex);

418 }

419

420 layoutGroup.setTableName(tableName);

421

422 return layoutGroup;

423 }

424

425 /*

426 * Gets a recursively defined Details LayoutGroup DTO for the specified libglom LayoutGroup object. This is used for

427 * getting layout information for the details view.

428 *

429 * @param documentID Glom document identifier

430 *

431 * @param tableName table name in the specified Glom document

432 *

433 * @param libglomLayoutGroup libglom LayoutGroup to convert

434 *

435 * @precondition libglomLayoutGroup must not be null

436 *

437 * @return {@link LayoutGroup} object that represents the layout for the specified {@link

438 * org.glom.libglom.LayoutGroup}

439 */

440 private LayoutGroup getDetailsLayoutGroup(final String tableName,

441 final org.glom.libglom.LayoutGroup libglomLayoutGroup, final String localeID) {

442 final LayoutGroup layoutGroup = new LayoutGroup();

443 layoutGroup.setColumnCount(Utils.safeLongToInt(libglomLayoutGroup.get_columns_count()));

444 final String layoutGroupTitle = libglomLayoutGroup.get_title(localeID);

445 if (StringUtils.isEmpty(layoutGroupTitle))

446 layoutGroup.setName(libglomLayoutGroup.get_name());

447 else

448 layoutGroup.setTitle(layoutGroupTitle);

449

450 // look at each child item

451 final LayoutItemVector layoutItemsVec = libglomLayoutGroup.get_items();

452 for (int i = 0; i < layoutItemsVec.size(); i++) {

453 final org.glom.libglom.LayoutItem libglomLayoutItem = layoutItemsVec.get(i);

454

455 // just a safety check

456 if (libglomLayoutItem == null)

457 continue;

458

459 org.glom.web.shared.layout.LayoutItem layoutItem = null;

460 final org.glom.libglom.LayoutGroup group = org.glom.libglom.LayoutGroup.cast_dynamic(libglomLayoutItem);

461 if (group != null) {

462 // libglomLayoutItem is a LayoutGroup

463 final LayoutItem_Portal libglomLayoutItemPortal = LayoutItem_Portal.cast_dynamic(group);

464 if (libglomLayoutItemPortal != null) {

465 // group is a LayoutItem_Portal

466 final LayoutItemPortal layoutItemPortal = createLayoutItemPortalDTO(tableName,

467 libglomLayoutItemPortal, localeID);

468 if (layoutItemPortal == null)

469 continue;

470 layoutItem = layoutItemPortal;

471

472 } else {

473 // libglomLayoutItem is a LayoutGroup

474 final LayoutItem_Notebook libglomLayoutItemNotebook = LayoutItem_Notebook.cast_dynamic(group);

475 if (libglomLayoutItemNotebook != null) {

476 // group is a LayoutItem_Notebook

477 final LayoutGroup tempLayoutGroup = getDetailsLayoutGroup(tableName, libglomLayoutItemNotebook,

478 localeID);

479 final LayoutItemNotebook layoutItemNotebook = new LayoutItemNotebook();

480 for (final LayoutItem item : tempLayoutGroup.getItems()) {

481 layoutItemNotebook.addItem(item);

482 }

483 layoutItemNotebook.setName(tableName);

484 layoutItem = layoutItemNotebook;

485 } else {

486 // group is *not* a LayoutItem_Portal or a LayoutItem_Notebook

487 // recurse into child groups

488 layoutItem = getDetailsLayoutGroup(tableName, group, localeID);

489 }

490 }

491 } else {

492 // libglomLayoutItem is *not* a LayoutGroup

493 // create LayoutItem DTOs based on the the libglom type

494 // TODO add support for other LayoutItems (Text, Image, Button etc.)

495 final LayoutItem_Field libglomLayoutItemField = LayoutItem_Field.cast_dynamic(libglomLayoutItem);

496 if (libglomLayoutItemField != null) {

497

498 final LayoutItemField layoutItemField = convertToGWTGlomLayoutItemField(libglomLayoutItemField,

499 localeID, true);

500

501 // Set the full field details with updated field details from the document.

502 libglomLayoutItemField.set_full_field_details(document.get_field(

503 libglomLayoutItemField.get_table_used(tableName), libglomLayoutItemField.get_name()));

504

505 // Determine if the field should have a navigation button and set this in the DTO.

506 final Relationship fieldUsedInRelationshipToOne = new Relationship();

507 final boolean addNavigation = false; //TODO: Glom.layout_field_should_have_navigation(tableName,

508 // libglomLayoutItemField, document, fieldUsedInRelationshipToOne);

509 layoutItemField.setAddNavigation(addNavigation);

510

511 // Set the the name of the table to navigate to if navigation should be enabled.

512 if (addNavigation) {

513 // It's not possible to directly check if fieldUsedInRelationshipToOne is

514 // null because of the way that the glom_sharedptr macro works. This workaround accomplishes the

515 // same task.

516 String tableNameUsed;

517 try {

518 final Relationship temp = new Relationship();

519 temp.equals(fieldUsedInRelationshipToOne); // this will throw an NPE if

520 // fieldUsedInRelationshipToOne is null

521 // fieldUsedInRelationshipToOne is *not* null

522 tableNameUsed = fieldUsedInRelationshipToOne.get_to_table();

523

524 } catch (final NullPointerException e) {

525 // fieldUsedInRelationshipToOne is null

526 tableNameUsed = libglomLayoutItemField.get_table_used(tableName);

527 }

528

529 // Set the navigation table name only if it's not different than the current table name.

530 if (!tableName.equals(tableNameUsed)) {

531 layoutItemField.setNavigationTableName(tableNameUsed);

532 }

533 }

534

535 layoutItem = layoutItemField;

536

537 } else {

538 Log.info(documentID, tableName,

539 "Ignoring unknown details LayoutItem of type " + libglomLayoutItem.get_part_type_name()

540 + ".");

541 continue;

542 }

543 }

544

545 layoutGroup.addItem(layoutItem);

546 }

547

548 return layoutGroup;

549 }

550

551 private LayoutItemPortal createLayoutItemPortalDTO(final String tableName,

552 final org.glom.libglom.LayoutItem_Portal libglomLayoutItemPortal, final String localeID) {

553

554 // Ignore LayoutItem_CalendarPortals for now:

555 // https://bugzilla.gnome.org/show_bug.cgi?id=664273

556 final LayoutItem_CalendarPortal liblglomLayoutItemCalendarPortal = LayoutItem_CalendarPortal

557 .cast_dynamic(libglomLayoutItemPortal);

558 if (liblglomLayoutItemCalendarPortal != null)

559 return null;

560

561 final LayoutItemPortal layoutItemPortal = new LayoutItemPortal();

562 final Relationship relationship = libglomLayoutItemPortal.get_relationship();

563 if (relationship != null) {

564 layoutItemPortal.setNavigationType(convertToGWTGlomNavigationType(libglomLayoutItemPortal

565 .get_navigation_type()));

566

567 layoutItemPortal.setTitle(libglomLayoutItemPortal.get_title_used("", localeID)); // parent title not

568 // relevant

569 layoutItemPortal.setName(libglomLayoutItemPortal.get_relationship_name_used());

570 layoutItemPortal.setTableName(relationship.get_from_table());

571 layoutItemPortal.setFromField(relationship.get_from_field());

572

573 // convert the portal layout items into LayoutItemField DTOs

574 final LayoutItemVector layoutItemsVec = libglomLayoutItemPortal.get_items();

575 long numItems = layoutItemsVec.size();

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

577 final org.glom.libglom.LayoutItem libglomLayoutItem = layoutItemsVec.get(i);

578

579 // TODO add support for other LayoutItems (Text, Image, Button etc.)

580 final LayoutItem_Field libglomLayoutItemField = LayoutItem_Field.cast_dynamic(libglomLayoutItem);

581 if (libglomLayoutItemField != null) {

582 // TODO EDITING If the relationship does not allow editing, then mark all these fields as

583 // non-editable. Check relationship.get_allow_edit() to see if it's editable.

584 layoutItemPortal.addItem(convertToGWTGlomLayoutItemField(libglomLayoutItemField, localeID, false));

585 } else {

586 Log.info(documentID, tableName, "Ignoring unknown related list LayoutItem of type "

587 + libglomLayoutItem.get_part_type_name() + ".");

588 continue;

589 }

590 }

591

592 // get the primary key for the related list table

593 final LayoutItem_Field layoutItemField = new LayoutItem_Field();

594 final String toTableName = relationship.get_to_table();

595 if (!StringUtils.isEmpty(toTableName)) {

596

597 // get the LayoutItem_Feild with details from its Field in the document

598 final FieldVector fields = document.get_table_fields(toTableName);

599 numItems = fields.size(); // reuse loop variable from above

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

601 final Field field = fields.get(i);

602 // check the names to see if they're the same

603 if (field.get_primary_key()) {

604 layoutItemField.set_full_field_details(field);

605 layoutItemPortal.addItem(convertToGWTGlomLayoutItemField(layoutItemField, localeID, false));

606 layoutItemPortal.setPrimaryKeyIndex(layoutItemPortal.getItems().size() - 1);

607 layoutItemPortal.setHiddenPrimaryKey(true); // always hidden in portals

608 break;

609 }

610 }

611 }

612

613 // Set whether or not the related list will need to show the navigation buttons.

614 // This was ported from Glom: Box_Data_Portal::get_has_suitable_record_to_view_details()

615 final StringBuffer navigationTableName = new StringBuffer();

616 final LayoutItem_Field navigationRelationship = new LayoutItem_Field(); // Ignored.

617 //TODO: libglomLayoutItemPortal.get_suitable_table_to_view_details(navigationTableName, navigationRelationship,

618 // document);

619 layoutItemPortal.setAddNavigation(!StringUtils.isEmpty(navigationTableName.toString()));

620 }

621

622 // Note: An empty LayoutItemPortal is returned if relationship is null.

623 return layoutItemPortal;

624 }

625

626 private GlomNumericFormat convertNumbericFormat(final NumericFormat libglomNumericFormat) {

627 final GlomNumericFormat gnf = new GlomNumericFormat();

628 gnf.setUseAltForegroundColourForNegatives(libglomNumericFormat.get_alt_foreground_color_for_negatives());

629 gnf.setCurrencyCode(libglomNumericFormat.get_currency_symbol());

630 gnf.setDecimalPlaces(Utils.safeLongToInt(libglomNumericFormat.get_decimal_places()));

631 gnf.setDecimalPlacesRestricted(libglomNumericFormat.get_decimal_places_restricted());

632 gnf.setUseThousandsSeparator(libglomNumericFormat.get_use_thousands_separator());

633 return gnf;

634 }

635

636 private Formatting convertFormatting(final org.glom.libglom.Formatting libglomFormatting) {

637 final Formatting formatting = new Formatting();

638

639 // text colour

640 final String foregroundColour = libglomFormatting.get_text_format_color_foreground();

641 if (!StringUtils.isEmpty(foregroundColour))

642 formatting.setTextFormatColourForeground(convertGdkColorToHtmlColour(foregroundColour));

643 final String backgroundColour = libglomFormatting.get_text_format_color_background();

644 if (!StringUtils.isEmpty(backgroundColour))

645 formatting.setTextFormatColourBackground(convertGdkColorToHtmlColour(backgroundColour));

646

647 // multiline

648 if (libglomFormatting.get_text_format_multiline()) {

649 formatting.setTextFormatMultilineHeightLines(Utils.safeLongToInt(libglomFormatting

650 .get_text_format_multiline_height_lines()));

651 }

652

653 return formatting;

654 }

655

656 private LayoutItemField convertToGWTGlomLayoutItemField(final LayoutItem_Field libglomLayoutItemField,

657 final String localeID, final boolean forDetailsView) {

658 final LayoutItemField layoutItemField = new LayoutItemField();

659

660 // set type

661 layoutItemField.setType(convertToGWTGlomFieldType(libglomLayoutItemField.get_glom_type()));

662

663 // set title and name

664 layoutItemField.setTitle(libglomLayoutItemField.get_title_or_name(localeID));

665 layoutItemField.setName(libglomLayoutItemField.get_name());

666

667 // convert formatting

668 final org.glom.libglom.Formatting glomFormatting = libglomLayoutItemField.get_formatting_used();

669 final Formatting formatting = convertFormatting(glomFormatting);

670

671 // set horizontal alignment

672 final org.glom.libglom.Formatting.HorizontalAlignment libglomHorizontalAlignment = libglomLayoutItemField

673 .get_formatting_used_horizontal_alignment(forDetailsView); // only returns LEFT or RIGHT

674 Formatting.HorizontalAlignment horizontalAlignment;

675 if (libglomHorizontalAlignment == org.glom.libglom.Formatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_LEFT) {

676 horizontalAlignment = Formatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_LEFT;

677 } else {

678 horizontalAlignment = Formatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_RIGHT;

679 }

680 formatting.setHorizontalAlignment(horizontalAlignment);

681

682 // create a GlomNumericFormat DTO for numeric values

683 if (libglomLayoutItemField.get_glom_type() == org.glom.libglom.Field.glom_field_type.TYPE_NUMERIC) {

684 formatting.setGlomNumericFormat(convertNumbericFormat(glomFormatting.get_numeric_format()));

685 }

686 layoutItemField.setFormatting(formatting);

687

688 return layoutItemField;

689 }

690

691 /*

692 * This method converts a Field.glom_field_type to the equivalent ColumnInfo.FieldType. The need for this comes from

693 * the fact that the GWT FieldType classes can't be used with RPC and there's no easy way to use the java-libglom

694 * Field.glom_field_type enum with RPC. An enum identical to Formatting.glom_field_type is included in the

695 * ColumnInfo class.

696 */

697 private LayoutItemField.GlomFieldType convertToGWTGlomFieldType(final Field.glom_field_type type) {

698 switch (type) {

699 case TYPE_BOOLEAN:

700 return LayoutItemField.GlomFieldType.TYPE_BOOLEAN;

701 case TYPE_DATE:

702 return LayoutItemField.GlomFieldType.TYPE_DATE;

703 case TYPE_IMAGE:

704 return LayoutItemField.GlomFieldType.TYPE_IMAGE;

705 case TYPE_NUMERIC:

706 return LayoutItemField.GlomFieldType.TYPE_NUMERIC;

707 case TYPE_TEXT:

708 return LayoutItemField.GlomFieldType.TYPE_TEXT;

709 case TYPE_TIME:

710 return LayoutItemField.GlomFieldType.TYPE_TIME;

711 case TYPE_INVALID:

712 Log.info("Returning TYPE_INVALID.");

713 return LayoutItemField.GlomFieldType.TYPE_INVALID;

714 default:

715 Log.error("Recieved a type that I don't know about: " + Field.glom_field_type.class.getName() + "."

716 + type.toString() + ". Returning " + LayoutItemField.GlomFieldType.TYPE_INVALID.toString() + ".");

717 return LayoutItemField.GlomFieldType.TYPE_INVALID;

718 }

719 }

720

721 /*

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

723 * significant 8-bits in each channel.

724 */

725 private String convertGdkColorToHtmlColour(final String gdkColor) {

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

727 return gdkColor.substring(0, 3) + gdkColor.substring(5, 7) + gdkColor.substring(9, 11);

728 else if (gdkColor.length() == 7) {

729 // This shouldn't happen but let's deal with it if it does.

730 Log.warn(documentID,

731 "Expected a 13 character string but received a 7 character string. Returning received string.");

732 return gdkColor;

733 } else {

734 Log.error("Did not receive a 13 or 7 character string. Returning black HTML colour code.");

735 return "#000000";

736 }

737 }

738

739 /*

740 * This method converts a LayoutItem_Portal.navigation_type from java-libglom to the equivalent

741 * LayoutItemPortal.NavigationType from Online Glom. This conversion is required because the LayoutItem_Portal class

742 * from java-libglom can't be used with GWT-RPC. An enum identical to LayoutItem_Portal.navigation_type from

743 * java-libglom is included in the LayoutItemPortal data transfer object.

744 */

745 private LayoutItemPortal.NavigationType convertToGWTGlomNavigationType(

746 final LayoutItem_Portal.navigation_type navigationType) {

747 switch (navigationType) {

748 case NAVIGATION_NONE:

749 return LayoutItemPortal.NavigationType.NAVIGATION_NONE;

750 case NAVIGATION_AUTOMATIC:

751 return LayoutItemPortal.NavigationType.NAVIGATION_AUTOMATIC;

752 case NAVIGATION_SPECIFIC:

753 return LayoutItemPortal.NavigationType.NAVIGATION_SPECIFIC;

754 default:

755 Log.error("Recieved an unknown NavigationType: " + LayoutItem_Portal.navigation_type.class.getName() + "."

756 + navigationType.toString() + ". Returning " + LayoutItemPortal.NavigationType.NAVIGATION_AUTOMATIC

757 + ".");

758 return LayoutItemPortal.NavigationType.NAVIGATION_AUTOMATIC;

759 }

760 }

761

762 /**

763 * Gets the table name to use when accessing the database and the document. This method guards against SQL injection

764 * attacks by returning the default table if the requested table is not in the database or if the table name has not

765 * been set.

766 *

767 * @param tableName

768 * The table name to validate.

769 * @return The table name to use.

770 */

771 private String getTableNameToUse(final String tableName) {

772 if (StringUtils.isEmpty(tableName) || !document.get_table_is_known(tableName)) {

773 return document.get_default_table();

774 }

775 return tableName;

776 }

777

778 /**

779 * @param tableName

780 * @param localeID2

781 * @return

782 */

783 public Reports getReports(final String tableName, final String localeID) {

784 final Reports result = new Reports();

785

786 final StringVector names = document.get_report_names(tableName);

787

788 final int count = Utils.safeLongToInt(names.size());

789 for (int i = 0; i < count; i++) {

790 final String name = names.get(i);

791 final Report report = document.get_report(tableName, name);

792 if (report == null)

793 continue;

794

795 final String title = report.get_title(localeID);

796 result.addReport(name, title);

797 }

798

799 return result;

800 }

801 }