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.io.File;

23 import java.io.FilenameFilter;

24 import java.io.InputStream;

25 import java.sql.SQLException;

26 import java.util.ArrayList;

27 import java.util.Hashtable;

28 import java.util.Properties;

29

30 import javax.servlet.ServletException;

31

32 import org.glom.libglom.BakeryDocument.LoadFailureCodes;

33 import org.glom.libglom.Document;

34 import org.glom.libglom.Glom;

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

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

37 import org.glom.web.shared.DetailsLayoutAndData;

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

39 import org.glom.web.shared.Documents;

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

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

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

43

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

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

46

47 /**

48 * The servlet class for setting up the server side of Online Glom. The public methods in this class are the methods

49 * that can be called by the client side code.

50 *

51 * @author Ben Konrath <ben@bagu.org>

52 */

53 @SuppressWarnings("serial")

54 public class OnlineGlomServiceImpl extends RemoteServiceServlet implements OnlineGlomService {

55

56 private static final String GLOM_FILE_EXTENSION = ".glom";

57

58 // convenience class to for dealing with the Online Glom configuration file

59 private class OnlineGlomProperties extends Properties {

60 public String getKey(String value) {

61 for (String key : stringPropertyNames()) {

62 if (getProperty(key).trim().equals(value))

63 return key;

64 }

65 return null;

66 }

67 }

68

69 private final Hashtable<String, ConfiguredDocument> documentMapping = new Hashtable<String, ConfiguredDocument>();

70 private Exception configurtionException = null;

71

72 /*

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

74 *

75 * (non-Javadoc)

76 *

77 * @see javax.servlet.GenericServlet#init()

78 */

79 @Override

80 public void init() throws ServletException {

81

82 // All of the initialisation code is surrounded by a try/catch block so that the servlet can be in an

83 // initialised state and the error message can be retrived by the client code.

84 try {

85 // Find the configuration file. See this thread for background info:

86 // http://stackoverflow.com/questions/2161054/where-to-place-properties-files-in-a-jsp-servlet-web-application

87 // FIXME move onlineglom.properties to the WEB-INF folder (option number 2 from the stackoverflow question)

88 OnlineGlomProperties config = new OnlineGlomProperties();

89 InputStream is = Thread.currentThread().getContextClassLoader()

90 .getResourceAsStream("onlineglom.properties");

91 if (is == null) {

92 String errorMessage = "onlineglom.properties not found.";

93 Log.fatal(errorMessage);

94 throw new Exception(errorMessage);

95 }

96 config.load(is); // can throw an IOException

97

98 // check if we can read the configured glom file directory

99 String documentDirName = config.getProperty("glom.document.directory");

100 File documentDir = new File(documentDirName);

101 if (!documentDir.isDirectory()) {

102 String errorMessage = documentDirName + " is not a directory.";

103 Log.fatal(errorMessage);

104 throw new Exception(errorMessage);

105 }

106 if (!documentDir.canRead()) {

107 String errorMessage = "Can't read the files in directory " + documentDirName + " .";

108 Log.fatal(errorMessage);

109 throw new Exception(errorMessage);

110 }

111

112 // get and check the glom files in the specified directory

113 File[] glomFiles = documentDir.listFiles(new FilenameFilter() {

114 @Override

115 public boolean accept(File dir, String name) {

116 return name.endsWith(GLOM_FILE_EXTENSION);

117 }

118 });

119

120 // don't continue if there aren't any Glom files to configure

121 if (glomFiles.length <= 0) {

122 String errorMessage = "Unable to find any Glom documents in the configured directory "

123 + documentDirName

124 + " . Check the onlineglom.properties file to ensure that 'glom.document.directory' is set to the correct directory.";

125 Log.error(errorMessage);

126 throw new Exception(errorMessage);

127 }

128

129 // Check to see if the native library of java libglom is visible to the JVM

130 if (!isNativeLibraryVisibleToJVM()) {

131 String errorMessage = "The java-libglom shared library is not visible to the JVM."

132 + " Ensure that 'java.library.path' is set with the path to the java-libglom shared library.";

133 Log.error(errorMessage);

134 throw new Exception(errorMessage);

135 }

136

137 // intitize libglom

138 Glom.libglom_init(); // can throw an UnsatisfiedLinkError exception

139

140 // Allow a fake connection, so sqlbuilder_get_full_query() can work:

141 Glom.set_fake_connection();

142

143 for (File glomFile : glomFiles) {

144 Document document = new Document();

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

146 int error = 0;

147 boolean retval = document.load(error);

148 if (retval == false) {

149 String message;

150 if (LoadFailureCodes.LOAD_FAILURE_CODE_NOT_FOUND == LoadFailureCodes.swigToEnum(error)) {

151 message = "Could not find file: " + glomFile.getAbsolutePath();

152 } else {

153 message = "An unknown error occurred when trying to load file: " + glomFile.getAbsolutePath();

154 }

155 Log.error(message);

156 // continue with for loop because there may be other documents in the directory

157 continue;

158 }

159

160 ConfiguredDocument configuredDocument = new ConfiguredDocument(document); // can throw a

161 // PropertyVetoException

162

163 // check if a username and password have been set and work for the current document

164 String filename = glomFile.getName();

165 String key = config.getKey(filename);

166 if (key != null) {

167 String[] keyArray = key.split("\\.");

168 if (keyArray.length == 3 && "filename".equals(keyArray[2])) {

169 // username/password could be set, let's check to see if it works

170 String usernameKey = key.replaceAll(keyArray[2], "username");

171 String passwordKey = key.replaceAll(keyArray[2], "password");

172 configuredDocument.setUsernameAndPassword(config.getProperty(usernameKey).trim(),

173 config.getProperty(passwordKey)); // can throw an SQLException

174 }

175 }

176

177 // check the if the global username and password have been set and work with this document

178 if (!configuredDocument.isAuthenticated()) {

179 configuredDocument.setUsernameAndPassword(config.getProperty("glom.document.username").trim(),

180 config.getProperty("glom.document.password")); // can throw an SQLException

181 }

182

183 // The key for the hash table is the file name without the .glom extension and with spaces ( ) replaced

184 // with pluses (+). The space/plus replacement makes the key more friendly for URLs.

185 String documentID = filename.substring(0, glomFile.getName().length() - GLOM_FILE_EXTENSION.length())

186 .replace(' ', '+');

187 configuredDocument.setDocumentID(documentID);

188 documentMapping.put(documentID, configuredDocument);

189 }

190

191 } catch (Exception e) {

192 // Don't throw the Exception so that servlet will be initialised and the error message can be retrieved.

193 configurtionException = e;

194 }

195

196 }

197

198 /**

199 * Checks if the java-libglom native library is visible to the JVM.

200 *

201 * @return true if the java-libglom native library is visible to the JVM, false if it's not

202 */

203 private boolean isNativeLibraryVisibleToJVM() {

204 String javaLibraryPath = System.getProperty("java.library.path");

205

206 // Go through all the library paths and check for the java_libglom .so.

207 for (String libDirName : javaLibraryPath.split(":")) {

208 File libDir = new File(libDirName);

209

210 if (!libDir.isDirectory())

211 continue;

212 if (!libDir.canRead())

213 continue;

214

215 File[] libs = libDir.listFiles(new FilenameFilter() {

216 @Override

217 public boolean accept(File dir, String name) {

218 return name.matches("libjava_libglom-[0-9]\\.[0-9].+\\.so");

219 }

220 });

221

222 // if at least one directory had the .so, we're done

223 if (libs.length > 0)

224 return true;

225 }

226

227 return false;

228 }

229

230 /*

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

232 *

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

234 */

235 @Override

236 public void destroy() {

237 Glom.libglom_deinit();

238

239 for (String documenTitle : documentMapping.keySet()) {

240 ConfiguredDocument configuredDoc = documentMapping.get(documenTitle);

241 try {

242 DataSources.destroy(configuredDoc.getCpds());

243 } catch (SQLException e) {

244 Log.error(documenTitle, "Error cleaning up the ComboPooledDataSource.", e);

245 }

246 }

247 }

248

249 /*

250 * (non-Javadoc)

251 *

252 * @see org.glom.web.client.OnlineGlomService#getConfigurationErrorMessage()

253 */

254 @Override

255 public String getConfigurationErrorMessage() {

256 if (configurtionException == null)

257 return "No configuration errors to report.";

258 else

259 return configurtionException.getMessage();

260 }

261

262 /*

263 * (non-Javadoc)

264 *

265 * @see org.glom.web.client.OnlineGlomService#getDocumentInfo(java.lang.String)

266 */

267 @Override

268 public DocumentInfo getDocumentInfo(String documentID) {

269

270 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

271

272 // FIXME check for authentication

273

274 return configuredDoc.getDocumentInfo();

275

276 }

277

278 /*

279 * (non-Javadoc)

280 *

281 * @see org.glom.web.client.OnlineGlomService#getListViewLayout(java.lang.String, java.lang.String)

282 */

283 @Override

284 public LayoutGroup getListViewLayout(String documentID, String tableName) {

285 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

286

287 // FIXME check for authentication

288

289 return configuredDoc.getListViewLayoutGroup(tableName);

290 }

291

292 /*

293 * (non-Javadoc)

294 *

295 * @see org.glom.web.client.OnlineGlomService#getListViewData(java.lang.String, java.lang.String, int, int)

296 */

297 @Override

298 public ArrayList<DataItem[]> getListViewData(String documentID, String tableName, int start, int length) {

299 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

300 if (!configuredDoc.isAuthenticated()) {

301 return new ArrayList<DataItem[]>();

302 }

303 return configuredDoc.getListViewData(tableName, start, length, false, 0, false);

304 }

305

306 /*

307 * (non-Javadoc)

308 *

309 * @see org.glom.web.client.OnlineGlomService#getSortedListViewData(java.lang.String, java.lang.String, int, int,

310 * int, boolean)

311 */

312 @Override

313 public ArrayList<DataItem[]> getSortedListViewData(String documentID, String tableName, int start, int length,

314 int sortColumnIndex, boolean isAscending) {

315 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

316 if (!configuredDoc.isAuthenticated()) {

317 return new ArrayList<DataItem[]>();

318 }

319 return configuredDoc.getListViewData(tableName, start, length, true, sortColumnIndex, isAscending);

320 }

321

322 /*

323 * (non-Javadoc)

324 *

325 * @see org.glom.web.client.OnlineGlomService#getDocuments()

326 */

327 @Override

328 public Documents getDocuments() {

329 Documents documents = new Documents();

330 for (String documentID : documentMapping.keySet()) {

331 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

332 documents.addDocument(documentID, configuredDoc.getDocument().get_database_title());

333 }

334 return documents;

335 }

336

337 /*

338 * (non-Javadoc)

339 *

340 * @see org.glom.web.client.OnlineGlomService#isAuthenticated(java.lang.String)

341 */

342 public boolean isAuthenticated(String documentID) {

343 return documentMapping.get(documentID).isAuthenticated();

344 }

345

346 /*

347 * (non-Javadoc)

348 *

349 * @see org.glom.web.client.OnlineGlomService#checkAuthentication(java.lang.String, java.lang.String,

350 * java.lang.String)

351 */

352 @Override

353 public boolean checkAuthentication(String documentID, String username, String password) {

354 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

355 try {

356 return configuredDoc.setUsernameAndPassword(username, password);

357 } catch (SQLException e) {

358 Log.error(documentID, "Unknown SQL Error checking the database authentication.", e);

359 return false;

360 }

361 }

362

363 /*

364 * (non-Javadoc)

365 *

366 * @see org.glom.web.client.OnlineGlomService#getDetailsData(java.lang.String, java.lang.String, java.lang.String)

367 */

368 @Override

369 public DataItem[] getDetailsData(String documentID, String tableName, TypedDataItem primaryKeyValue) {

370 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

371

372 // FIXME check for authentication

373

374 return configuredDoc.getDetailsData(tableName, primaryKeyValue);

375 }

376

377 /*

378 * (non-Javadoc)

379 *

380 * @see org.glom.web.client.OnlineGlomService#getDetailsLayoutAndData(java.lang.String, java.lang.String,

381 * java.lang.String)

382 */

383 @Override

384 public DetailsLayoutAndData getDetailsLayoutAndData(String documentID, String tableName,

385 TypedDataItem primaryKeyValue) {

386 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

387 if (configuredDoc == null)

388 return null;

389

390 // FIXME check for authentication

391

392 DetailsLayoutAndData initalDetailsView = new DetailsLayoutAndData();

393 initalDetailsView.setLayout(configuredDoc.getDetailsLayoutGroup(tableName));

394 initalDetailsView.setData(configuredDoc.getDetailsData(tableName, primaryKeyValue));

395

396 return initalDetailsView;

397 }

398

399 /*

400 * (non-Javadoc)

401 *

402 * @see org.glom.web.client.OnlineGlomService#getRelatedListData(java.lang.String, java.lang.String, int, int)

403 */

404 @Override

405 public ArrayList<DataItem[]> getRelatedListData(String documentID, String tableName, String relationshipName,

406 TypedDataItem foreignKeyValue, int start, int length) {

407 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

408

409 // FIXME check for authentication

410

411 return configuredDoc.getRelatedListData(tableName, relationshipName, foreignKeyValue, start, length, false, 0,

412 false);

413 }

414

415 /*

416 * (non-Javadoc)

417 *

418 * @see org.glom.web.client.OnlineGlomService#getSortedRelatedListData(java.lang.String, java.lang.String, int, int,

419 * int, boolean)

420 */

421 @Override

422 public ArrayList<DataItem[]> getSortedRelatedListData(String documentID, String tableName, String relationshipName,

423 TypedDataItem foreignKeyValue, int start, int length, int sortColumnIndex, boolean ascending) {

424 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

425

426 // FIXME check for authentication

427

428 return configuredDoc.getRelatedListData(tableName, relationshipName, foreignKeyValue, start, length, true,

429 sortColumnIndex, ascending);

430 }

431

432 public int getRelatedListRowCount(String documentID, String tableName, String relationshipName,

433 TypedDataItem foreignKeyValue) {

434 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

435

436 // FIXME check for authentication

437

438 return configuredDoc.getRelatedListRowCount(tableName, relationshipName, foreignKeyValue);

439 }

440

441 /*

442 * (non-Javadoc)

443 *

444 * @see org.glom.web.client.OnlineGlomService#getSuitableRecordToViewDetails(java.lang.String, java.lang.String,

445 * java.lang.String, java.lang.String)

446 */

447 @Override

448 public NavigationRecord getSuitableRecordToViewDetails(String documentID, String tableName,

449 String relationshipName, TypedDataItem primaryKeyValue) {

450 ConfiguredDocument configuredDoc = documentMapping.get(documentID);

451

452 // FIXME check for authentication

453

454 return configuredDoc.getSuitableRecordToViewDetails(tableName, relationshipName, primaryKeyValue);

455 }

456

457 }