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.lang.StringUtils;

29 import org.glom.libglom.Document;

30 import org.glom.libglom.Field;

31 import org.glom.libglom.FieldFormatting;

32 import org.glom.libglom.FieldVector;

33 import org.glom.libglom.Glom;

34 import org.glom.libglom.LayoutGroupVector;

35 import org.glom.libglom.LayoutItemVector;

36 import org.glom.libglom.LayoutItem_CalendarPortal;

37 import org.glom.libglom.LayoutItem_Field;

38 import org.glom.libglom.LayoutItem_Notebook;

39 import org.glom.libglom.LayoutItem_Portal;

40 import org.glom.libglom.NumericFormat;

41 import org.glom.libglom.Relationship;

42 import org.glom.libglom.Report;

43 import org.glom.libglom.StringVector;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

60

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

62

63 /**

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

65 * libglom and data from the underlying PostgreSQL database.

66 */

67 final class ConfiguredDocument {

68

69 private Document document;

70 private ComboPooledDataSource cpds;

71 private boolean authenticated = false;

72 private String documentID = "";

73 private String defaultLocaleID = "";

74

75 @SuppressWarnings("unused")

76 private ConfiguredDocument() {

77 // disable default constructor

78 }

79

80 ConfiguredDocument(final Document document) throws PropertyVetoException {

81

82 // load the jdbc driver

83 cpds = new ComboPooledDataSource();

84

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

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

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

88 // FIXME: Throw exception?

89 }

90

91 try {

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

93 } catch (final PropertyVetoException e) {

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

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

96 throw e;

97 }

98

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

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

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

102

103 this.document = document;

104 }

105

106 /**

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

108 *

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

110 */

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

112 cpds.setUser(username);

113 cpds.setPassword(password);

114

115 final int acquireRetryAttempts = cpds.getAcquireRetryAttempts();

116 cpds.setAcquireRetryAttempts(1);

117 Connection conn = null;

118 try {

119 // FIXME find a better way to check authentication

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

121 conn = cpds.getConnection();

122 authenticated = true;

123 } catch (final SQLException e) {

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

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

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

127 authenticated = false;

128 } finally {

129 if (conn != null)

130 conn.close();

131 cpds.setAcquireRetryAttempts(acquireRetryAttempts);

132 }

133 return authenticated;

134 }

135

136 Document getDocument() {

137 return document;

138 }

139

140 ComboPooledDataSource getCpds() {

141 return cpds;

142 }

143

144 boolean isAuthenticated() {

145 return authenticated;

146 }

147

148 String getDocumentID() {

149 return documentID;

150 }

151

152 void setDocumentID(final String documentID) {

153 this.documentID = documentID;

154 }

155

156 String getDefaultLocaleID() {

157 return defaultLocaleID;

158 }

159

160 void setDefaultLocaleID(final String localeID) {

161 this.defaultLocaleID = localeID;

162 }

163

164 /**

165 * @return

166 */

167 DocumentInfo getDocumentInfo(final String localeID) {

168 final DocumentInfo documentInfo = new DocumentInfo();

169

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

171 final StringVector tablesVec = document.get_table_names();

172

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

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

175 // of the ArrayList

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

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

178 boolean foundDefaultTable = false;

179 int visibleIndex = 0;

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

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

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

183 tableNames.add(tableName);

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

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

186 documentInfo.setDefaultTableIndex(visibleIndex);

187 foundDefaultTable = true;

188 }

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

190 visibleIndex++;

191 }

192 }

193

194 // set everything we need

195 documentInfo.setTableNames(tableNames);

196 documentInfo.setTableTitles(tableTitles);

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

198

199 // Fetch arrays of locale IDs and titles:

200 final StringVector localesVec = document.get_translation_available_locales();

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

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

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

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

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

206 localeIDs.add(this_localeID);

207

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

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

210 String locale_lang = this_localeID;

211 if (locale_parts.length > 0)

212 locale_lang = locale_parts[0];

213 String locale_country = "";

214 if (locale_parts.length > 1)

215 locale_country = locale_parts[1];

216

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

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

219 localeTitles.add(title);

220 }

221 documentInfo.setLocaleIDs(localeIDs);

222 documentInfo.setLocaleTitles(localeTitles);

223

224 return documentInfo;

225 }

226

227 /*

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

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

230 */

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

232

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

234

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

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

237 if (listViewLayoutGroupSize > 0) {

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

239 if (listViewLayoutGroupSize > 1)

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

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

242

243 libglomLayoutGroup = layoutGroupVec.get(0);

244 } else {

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

246 Log.info(documentID, tableName,

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

248

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

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

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

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

253 final LayoutItem_Field layoutItemField = new LayoutItem_Field();

254 layoutItemField.set_full_field_details(field);

255 libglomLayoutGroup.add_item(layoutItemField);

256 }

257 }

258

259 return libglomLayoutGroup;

260 }

261

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

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

264 // Validate the table name.

265 tableName = getTableNameToUse(tableName);

266

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

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

269

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

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

272 libglomLayoutGroup);

273

274 // Return the data.

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

276 }

277

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

279 // Validate the table name.

280 tableName = getTableNameToUse(tableName);

281

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

283

284 return detailsDBAccess.getData(primaryKeyValue);

285 }

286

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

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

289 final int sortColumnIndex, final boolean isAscending) {

290 // Validate the table name.

291 tableName = getTableNameToUse(tableName);

292

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

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

295 relationshipName);

296

297 // Return the data

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

299 }

300

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

302 // Validate the table name.

303 tableName = getTableNameToUse(tableName);

304

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

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

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

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

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

310

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

312 if (libglomLayoutGroup == null)

313 continue;

314

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

316 }

317

318 return layoutGroups;

319 }

320

321 /*

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

323 */

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

325 // Validate the table name.

326 tableName = getTableNameToUse(tableName);

327

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

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

330 relationshipName);

331

332 // Return the row count

333 return relatedListDBAccess.getExpectedResultSize(foreignKeyValue);

334 }

335

336 NavigationRecord getSuitableRecordToViewDetails(String tableName, final String relationshipName,

337 final TypedDataItem primaryKeyValue) {

338 // Validate the table name.

339 tableName = getTableNameToUse(tableName);

340

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

342 tableName, relationshipName);

343

344 return relatedListNavigation.getNavigationRecord(primaryKeyValue);

345 }

346

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

348 // Validate the table name.

349 tableName = getTableNameToUse(tableName);

350

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

352

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

354 int primaryKeyIndex = -1;

355

356 // look at each child item

357 final LayoutItemVector layoutItemsVec = libglomLayoutGroup.get_items();

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

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

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

361

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

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

364 if (libglomLayoutItemField != null) {

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

366 final Field field = libglomLayoutItemField.get_full_field_details();

367 if (field.get_primary_key())

368 primaryKeyIndex = i;

369 } else {

370 Log.info(documentID, tableName,

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

372 continue;

373 }

374 }

375

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

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

378 libglomLayoutGroup);

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

380

381 // Set the primary key index for the table

382 if (primaryKeyIndex < 0) {

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

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

385 Field primaryKey = null;

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

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

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

389 if (field.get_primary_key()) {

390 primaryKey = field;

391 break;

392 }

393 }

394 if (primaryKey != null) {

395 final LayoutItem_Field libglomLayoutItemField = new LayoutItem_Field();

396 libglomLayoutItemField.set_full_field_details(primaryKey);

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

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

399 layoutGroup.setHiddenPrimaryKey(true);

400 } else {

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

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

403 }

404

405 } else {

406 layoutGroup.setPrimaryKeyIndex(primaryKeyIndex);

407 }

408

409 layoutGroup.setTableName(tableName);

410

411 return layoutGroup;

412 }

413

414 /*

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

416 * getting layout information for the details view.

417 *

418 * @param documentID Glom document identifier

419 *

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

421 *

422 * @param libglomLayoutGroup libglom LayoutGroup to convert

423 *

424 * @precondition libglomLayoutGroup must not be null

425 *

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

427 * org.glom.libglom.LayoutGroup}

428 */

429 private LayoutGroup getDetailsLayoutGroup(final String tableName,

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

431 final LayoutGroup layoutGroup = new LayoutGroup();

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

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

434 if (StringUtils.isEmpty(layoutGroupTitle))

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

436 else

437 layoutGroup.setTitle(layoutGroupTitle);

438

439 // look at each child item

440 final LayoutItemVector layoutItemsVec = libglomLayoutGroup.get_items();

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

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

443

444 // just a safety check

445 if (libglomLayoutItem == null)

446 continue;

447

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

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

450 if (group != null) {

451 // libglomLayoutItem is a LayoutGroup

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

453 if (libglomLayoutItemPortal != null) {

454 // group is a LayoutItem_Portal

455 final LayoutItemPortal layoutItemPortal = createLayoutItemPortalDTO(tableName,

456 libglomLayoutItemPortal, localeID);

457 if (layoutItemPortal == null)

458 continue;

459 layoutItem = layoutItemPortal;

460

461 } else {

462 // libglomLayoutItem is a LayoutGroup

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

464 if (libglomLayoutItemNotebook != null) {

465 // group is a LayoutItem_Notebook

466 final LayoutGroup tempLayoutGroup = getDetailsLayoutGroup(tableName, libglomLayoutItemNotebook,

467 localeID);

468 final LayoutItemNotebook layoutItemNotebook = new LayoutItemNotebook();

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

470 layoutItemNotebook.addItem(item);

471 }

472 layoutItemNotebook.setName(tableName);

473 layoutItem = layoutItemNotebook;

474 } else {

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

476 // recurse into child groups

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

478 }

479 }

480 } else {

481 // libglomLayoutItem is *not* a LayoutGroup

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

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

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

485 if (libglomLayoutItemField != null) {

486

487 final LayoutItemField layoutItemField = convertToGWTGlomLayoutItemField(libglomLayoutItemField,

488 localeID, true);

489

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

491 libglomLayoutItemField.set_full_field_details(document.get_field(

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

493

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

495 final Relationship fieldUsedInRelationshipToOne = new Relationship();

496 final boolean addNavigation = Glom.layout_field_should_have_navigation(tableName,

497 libglomLayoutItemField, document, fieldUsedInRelationshipToOne);

498 layoutItemField.setAddNavigation(addNavigation);

499

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

501 if (addNavigation) {

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

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

504 // same task.

505 String tableNameUsed;

506 try {

507 final Relationship temp = new Relationship();

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

509 // fieldUsedInRelationshipToOne is null

510 // fieldUsedInRelationshipToOne is *not* null

511 tableNameUsed = fieldUsedInRelationshipToOne.get_to_table();

512

513 } catch (final NullPointerException e) {

514 // fieldUsedInRelationshipToOne is null

515 tableNameUsed = libglomLayoutItemField.get_table_used(tableName);

516 }

517

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

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

520 layoutItemField.setNavigationTableName(tableNameUsed);

521 }

522 }

523

524 layoutItem = layoutItemField;

525

526 } else {

527 Log.info(documentID, tableName,

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

529 + ".");

530 continue;

531 }

532 }

533

534 layoutGroup.addItem(layoutItem);

535 }

536

537 return layoutGroup;

538 }

539

540 private LayoutItemPortal createLayoutItemPortalDTO(final String tableName,

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

542

543 // Ignore LayoutItem_CalendarPortals for now:

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

545 final LayoutItem_CalendarPortal liblglomLayoutItemCalendarPortal = LayoutItem_CalendarPortal

546 .cast_dynamic(libglomLayoutItemPortal);

547 if (liblglomLayoutItemCalendarPortal != null)

548 return null;

549

550 final LayoutItemPortal layoutItemPortal = new LayoutItemPortal();

551 final Relationship relationship = libglomLayoutItemPortal.get_relationship();

552 if (relationship != null) {

553 layoutItemPortal.setNavigationType(convertToGWTGlomNavigationType(libglomLayoutItemPortal

554 .get_navigation_type()));

555

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

557 // relevant

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

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

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

561

562 // convert the portal layout items into LayoutItemField DTOs

563 final LayoutItemVector layoutItemsVec = libglomLayoutItemPortal.get_items();

564 long numItems = layoutItemsVec.size();

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

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

567

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

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

570 if (libglomLayoutItemField != null) {

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

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

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

574 } else {

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

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

577 continue;

578 }

579 }

580

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

582 final LayoutItem_Field layoutItemField = new LayoutItem_Field();

583 final String toTableName = relationship.get_to_table();

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

585

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

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

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

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

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

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

592 if (field.get_primary_key()) {

593 layoutItemField.set_full_field_details(field);

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

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

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

597 break;

598 }

599 }

600 }

601

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

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

604 final StringBuffer navigationTableName = new StringBuffer();

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

606 libglomLayoutItemPortal.get_suitable_table_to_view_details(navigationTableName, navigationRelationship,

607 document);

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

609 }

610

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

612 return layoutItemPortal;

613 }

614

615 private GlomNumericFormat convertNumbericFormat(final NumericFormat libglomNumericFormat) {

616 final GlomNumericFormat gnf = new GlomNumericFormat();

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

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

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

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

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

622 return gnf;

623 }

624

625 private Formatting convertFormatting(final FieldFormatting libglomFormatting) {

626 final Formatting formatting = new Formatting();

627

628 // text colour

629 final String foregroundColour = libglomFormatting.get_text_format_color_foreground();

630 if (!StringUtils.isEmpty(foregroundColour))

631 formatting.setTextFormatColourForeground(convertGdkColorToHtmlColour(foregroundColour));

632 final String backgroundColour = libglomFormatting.get_text_format_color_background();

633 if (!StringUtils.isEmpty(backgroundColour))

634 formatting.setTextFormatColourBackground(convertGdkColorToHtmlColour(backgroundColour));

635

636 // multiline

637 if (libglomFormatting.get_text_format_multiline()) {

638 formatting.setTextFormatMultilineHeightLines(Utils.safeLongToInt(libglomFormatting

639 .get_text_format_multiline_height_lines()));

640 }

641

642 return formatting;

643 }

644

645 private LayoutItemField convertToGWTGlomLayoutItemField(final LayoutItem_Field libglomLayoutItemField,

646 final String localeID, final boolean forDetailsView) {

647 final LayoutItemField layoutItemField = new LayoutItemField();

648

649 // set type

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

651

652 // set title and name

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

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

655

656 // convert formatting

657 final FieldFormatting glomFormatting = libglomLayoutItemField.get_formatting_used();

658 final Formatting formatting = convertFormatting(glomFormatting);

659

660 // set horizontal alignment

661 final org.glom.libglom.FieldFormatting.HorizontalAlignment libglomHorizontalAlignment = libglomLayoutItemField

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

663 Formatting.HorizontalAlignment horizontalAlignment;

664 if (libglomHorizontalAlignment == org.glom.libglom.FieldFormatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_LEFT) {

665 horizontalAlignment = Formatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_LEFT;

666 } else {

667 horizontalAlignment = Formatting.HorizontalAlignment.HORIZONTAL_ALIGNMENT_RIGHT;

668 }

669 formatting.setHorizontalAlignment(horizontalAlignment);

670

671 // create a GlomNumericFormat DTO for numeric values

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

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

674 }

675 layoutItemField.setFormatting(formatting);

676

677 return layoutItemField;

678 }

679

680 /*

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

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

683 * Field.glom_field_type enum with RPC. An enum identical to FieldFormatting.glom_field_type is included in the

684 * ColumnInfo class.

685 */

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

687 switch (type) {

688 case TYPE_BOOLEAN:

689 return LayoutItemField.GlomFieldType.TYPE_BOOLEAN;

690 case TYPE_DATE:

691 return LayoutItemField.GlomFieldType.TYPE_DATE;

692 case TYPE_IMAGE:

693 return LayoutItemField.GlomFieldType.TYPE_IMAGE;

694 case TYPE_NUMERIC:

695 return LayoutItemField.GlomFieldType.TYPE_NUMERIC;

696 case TYPE_TEXT:

697 return LayoutItemField.GlomFieldType.TYPE_TEXT;

698 case TYPE_TIME:

699 return LayoutItemField.GlomFieldType.TYPE_TIME;

700 case TYPE_INVALID:

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

702 return LayoutItemField.GlomFieldType.TYPE_INVALID;

703 default:

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

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

706 return LayoutItemField.GlomFieldType.TYPE_INVALID;

707 }

708 }

709

710 /*

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

712 * significant 8-bits in each channel.

713 */

714 private String convertGdkColorToHtmlColour(final String gdkColor) {

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

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

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

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

719 Log.warn(documentID,

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

721 return gdkColor;

722 } else {

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

724 return "#000000";

725 }

726 }

727

728 /*

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

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

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

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

733 */

734 private LayoutItemPortal.NavigationType convertToGWTGlomNavigationType(

735 final LayoutItem_Portal.navigation_type navigationType) {

736 switch (navigationType) {

737 case NAVIGATION_NONE:

738 return LayoutItemPortal.NavigationType.NAVIGATION_NONE;

739 case NAVIGATION_AUTOMATIC:

740 return LayoutItemPortal.NavigationType.NAVIGATION_AUTOMATIC;

741 case NAVIGATION_SPECIFIC:

742 return LayoutItemPortal.NavigationType.NAVIGATION_SPECIFIC;

743 default:

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

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

746 + ".");

747 return LayoutItemPortal.NavigationType.NAVIGATION_AUTOMATIC;

748 }

749 }

750

751 /**

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

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

754 * been set.

755 *

756 * @param tableName

757 * The table name to validate.

758 * @return The table name to use.

759 */

760 private String getTableNameToUse(final String tableName) {

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

762 return document.get_default_table();

763 }

764 return tableName;

765 }

766

767 /**

768 * @param tableName

769 * @param localeID2

770 * @return

771 */

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

773 final Reports result = new Reports();

774

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

776

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

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

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

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

781 if (report == null)

782 continue;

783

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

785 result.addReport(name, title);

786 }

787

788 return result;

789 }

790 }