ReportGenerator: Take the Report itself instead of the name and group.
[online-glom:gwt-glom.git] / src / main / java / org / glom / web / server / OnlineGlomServiceImpl.java
1 /*
2  * Copyright (C) 2010, 2011 Openismus GmbH
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.Connection;
26 import java.sql.SQLException;
27 import java.util.ArrayList;
28 import java.util.Hashtable;
29 import java.util.List;
30 import java.util.Properties;
31
32 import javax.servlet.ServletException;
33
34 import org.apache.commons.io.FileUtils;
35 import org.apache.commons.io.FilenameUtils;
36 import org.apache.commons.lang.StringUtils;
37 import org.glom.libglom.BakeryDocument.LoadFailureCodes;
38 import org.glom.libglom.Document;
39 import org.glom.libglom.Glom;
40 import org.glom.libglom.Report;
41 import org.glom.web.client.OnlineGlomService;
42 import org.glom.web.shared.DataItem;
43 import org.glom.web.shared.DetailsLayoutAndData;
44 import org.glom.web.shared.DocumentInfo;
45 import org.glom.web.shared.Documents;
46 import org.glom.web.shared.NavigationRecord;
47 import org.glom.web.shared.Reports;
48 import org.glom.web.shared.TypedDataItem;
49 import org.glom.web.shared.layout.LayoutGroup;
50
51 import com.google.gwt.user.server.rpc.RemoteServiceServlet;
52 import com.mchange.v2.c3p0.DataSources;
53
54 /**
55  * This is the servlet class for setting up the server side of Online Glom. The client side can call the public methods
56  * in this class via OnlineGlom
57  * 
58  * For instance, it loads all the available documents and provide a list - see getDocuments(). It then provides
59  * information from each document. For instance, see getListViewLayout().
60  * 
61  * TODO: Watch for changes to the .glom files, to reload new versions and to load newly-added files. TODO: Watch for
62  * changes to the properties (configuration)?
63  */
64 @SuppressWarnings("serial")
65 public class OnlineGlomServiceImpl extends RemoteServiceServlet implements OnlineGlomService {
66
67         private static final String GLOM_FILE_EXTENSION = "glom";
68
69         // convenience class for dealing with the Online Glom configuration file
70         private class OnlineGlomProperties extends Properties {
71                 public String getKey(final String value) {
72                         for (final String key : stringPropertyNames()) {
73                                 if (getProperty(key).trim().equals(value))
74                                         return key;
75                         }
76                         return null;
77                 }
78         }
79
80         private final Hashtable<String, ConfiguredDocument> documentMapping = new Hashtable<String, ConfiguredDocument>();
81         private Exception configurationException = null;
82
83         /*
84          * This is called when the servlet is started or restarted.
85          * 
86          * (non-Javadoc)
87          * 
88          * @see javax.servlet.GenericServlet#init()
89          */
90         @Override
91         public void init() throws ServletException {
92
93                 // All of the initialisation code is surrounded by a try/catch block so that the servlet can be in an
94                 // initialised state and the error message can be retrieved by the client code.
95                 try {
96                         // Find the configuration file. See this thread for background info:
97                         // http://stackoverflow.com/questions/2161054/where-to-place-properties-files-in-a-jsp-servlet-web-application
98                         // FIXME move onlineglom.properties to the WEB-INF folder (option number 2 from the stackoverflow question)
99                         final OnlineGlomProperties config = new OnlineGlomProperties();
100                         final InputStream is = Thread.currentThread().getContextClassLoader()
101                                         .getResourceAsStream("onlineglom.properties");
102                         if (is == null) {
103                                 final String errorMessage = "onlineglom.properties not found.";
104                                 Log.fatal(errorMessage);
105                                 throw new Exception(errorMessage);
106                         }
107                         config.load(is); // can throw an IOException
108
109                         // check if we can read the configured glom file directory
110                         final String documentDirName = config.getProperty("glom.document.directory");
111                         final File documentDir = new File(documentDirName);
112                         if (!documentDir.isDirectory()) {
113                                 final String errorMessage = documentDirName + " is not a directory.";
114                                 Log.fatal(errorMessage);
115                                 throw new Exception(errorMessage);
116                         }
117                         if (!documentDir.canRead()) {
118                                 final String errorMessage = "Can't read the files in directory " + documentDirName + " .";
119                                 Log.fatal(errorMessage);
120                                 throw new Exception(errorMessage);
121                         }
122
123                         // get and check the glom files in the specified directory
124                         // TODO: Test this:
125                         final String[] extensions = { GLOM_FILE_EXTENSION };
126                         final List<File> glomFiles = (List<File>) FileUtils
127                                         .listFiles(documentDir, extensions, true /* recursive */);
128
129                         // don't continue if there aren't any Glom files to configure
130                         if (glomFiles.size() <= 0) {
131                                 final String errorMessage = "Unable to find any Glom documents in the configured directory "
132                                                 + documentDirName
133                                                 + " . Check the onlineglom.properties file to ensure that 'glom.document.directory' is set to the correct directory.";
134                                 Log.error(errorMessage);
135                                 throw new Exception(errorMessage);
136                         }
137
138                         // Check to see if the native library of java libglom is visible to the JVM
139                         if (!isNativeLibraryVisibleToJVM()) {
140                                 final String errorMessage = "The java-libglom shared library is not visible to the JVM."
141                                                 + " Ensure that 'java.library.path' is set with the path to the java-libglom shared library.";
142                                 Log.error(errorMessage);
143                                 throw new Exception(errorMessage);
144                         }
145
146                         // Check for a specified default locale,
147                         // for table titles, field titles, etc:
148                         final String globalLocaleID = StringUtils.defaultString(config.getProperty("glom.document.locale"));
149
150                         // This initialisation method can throw an UnsatisfiedLinkError if the java-libglom native library isn't
151                         // available. But since we're checking for the error condition above, the UnsatisfiedLinkError will never be
152                         // thrown.
153                         Glom.libglom_init();
154
155                         // Allow a fake connection, so sqlbuilder_get_full_query() can work:
156                         Glom.set_fake_connection();
157
158                         for (final File glomFile : glomFiles) {
159                                 final Document document = new Document();
160                                 document.set_file_uri("file://" + glomFile.getAbsolutePath());
161                                 final int error = 0;
162                                 final boolean retval = document.load(error);
163                                 if (retval == false) {
164                                         String message;
165                                         if (LoadFailureCodes.LOAD_FAILURE_CODE_NOT_FOUND == LoadFailureCodes.swigToEnum(error)) {
166                                                 message = "Could not find file: " + glomFile.getAbsolutePath();
167                                         } else {
168                                                 message = "An unknown error occurred when trying to load file: " + glomFile.getAbsolutePath();
169                                         }
170                                         Log.error(message);
171                                         // continue with for loop because there may be other documents in the directory
172                                         continue;
173                                 }
174
175                                 final ConfiguredDocument configuredDocument = new ConfiguredDocument(document); // can throw a
176                                 // PropertyVetoException
177
178                                 // check if a username and password have been set and work for the current document
179                                 final String filename = glomFile.getName();
180                                 final String key = config.getKey(filename);
181                                 if (key != null) {
182                                         final String[] keyArray = key.split("\\.");
183                                         if (keyArray.length == 3 && "filename".equals(keyArray[2])) {
184                                                 // username/password could be set, let's check to see if it works
185                                                 final String usernameKey = key.replaceAll(keyArray[2], "username");
186                                                 final String passwordKey = key.replaceAll(keyArray[2], "password");
187                                                 configuredDocument.setUsernameAndPassword(config.getProperty(usernameKey).trim(),
188                                                                 config.getProperty(passwordKey)); // can throw an SQLException
189                                         }
190                                 }
191
192                                 // check the if the global username and password have been set and work with this document
193                                 if (!configuredDocument.isAuthenticated()) {
194                                         configuredDocument.setUsernameAndPassword(config.getProperty("glom.document.username").trim(),
195                                                         config.getProperty("glom.document.password")); // can throw an SQLException
196                                 }
197
198                                 if (!StringUtils.isEmpty(globalLocaleID)) {
199                                         configuredDocument.setDefaultLocaleID(globalLocaleID.trim());
200                                 }
201
202                                 // The key for the hash table is the file name without the .glom extension and with spaces ( ) replaced
203                                 // with pluses (+). The space/plus replacement makes the key more friendly for URLs.
204                                 final String documentID = FilenameUtils.removeExtension(filename).replace(' ', '+');
205                                 configuredDocument.setDocumentID(documentID);
206                                 documentMapping.put(documentID, configuredDocument);
207                         }
208
209                 } catch (final Exception e) {
210                         // Don't throw the Exception so that servlet will be initialised and the error message can be retrieved.
211                         configurationException = e;
212                 }
213
214         }
215
216         /**
217          * Checks if the java-libglom native library is visible to the JVM.
218          * 
219          * @return true if the java-libglom native library is visible to the JVM, false if it's not
220          */
221         private boolean isNativeLibraryVisibleToJVM() {
222                 final String javaLibraryPath = System.getProperty("java.library.path");
223
224                 // Go through all the library paths and check for the java_libglom .so.
225                 for (final String libDirName : javaLibraryPath.split(":")) {
226                         final File libDir = new File(libDirName);
227
228                         if (!libDir.isDirectory())
229                                 continue;
230                         if (!libDir.canRead())
231                                 continue;
232
233                         final File[] libs = libDir.listFiles(new FilenameFilter() {
234                                 @Override
235                                 public boolean accept(final File dir, final String name) {
236                                         return name.matches("libjava_libglom-[0-9]\\.[0-9].+\\.so");
237                                 }
238                         });
239
240                         // if at least one directory had the .so, we're done
241                         if (libs.length > 0)
242                                 return true;
243                 }
244
245                 return false;
246         }
247
248         /*
249          * This is called when the servlet is stopped or restarted.
250          * 
251          * @see javax.servlet.GenericServlet#destroy()
252          */
253         @Override
254         public void destroy() {
255                 Glom.libglom_deinit();
256
257                 for (final String documenTitle : documentMapping.keySet()) {
258                         final ConfiguredDocument configuredDoc = documentMapping.get(documenTitle);
259                         if (configuredDoc == null)
260                                 continue;
261
262                         try {
263                                 DataSources.destroy(configuredDoc.getCpds());
264                         } catch (final SQLException e) {
265                                 Log.error(documenTitle, "Error cleaning up the ComboPooledDataSource.", e);
266                         }
267                 }
268         }
269
270         /*
271          * (non-Javadoc)
272          * 
273          * @see org.glom.web.client.OnlineGlomService#getConfigurationErrorMessage()
274          */
275         @Override
276         public String getConfigurationErrorMessage() {
277                 if (configurationException == null)
278                         return "No configuration errors to report.";
279                 else if (configurationException.getMessage() == null)
280                         return configurationException.toString();
281                 else
282                         return configurationException.getMessage();
283         }
284
285         /*
286          * (non-Javadoc)
287          * 
288          * @see org.glom.web.client.OnlineGlomService#getDocumentInfo(java.lang.String)
289          */
290         @Override
291         public DocumentInfo getDocumentInfo(final String documentID, final String localeID) {
292
293                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
294
295                 // Avoid dereferencing a null object:
296                 if (configuredDoc == null)
297                         return new DocumentInfo();
298
299                 // FIXME check for authentication
300
301                 return configuredDoc.getDocumentInfo(StringUtils.defaultString(localeID));
302
303         }
304
305         /*
306          * (non-Javadoc)
307          * 
308          * @see org.glom.web.client.OnlineGlomService#getListViewLayout(java.lang.String, java.lang.String)
309          */
310         @Override
311         public LayoutGroup getListViewLayout(final String documentID, final String tableName, final String localeID) {
312                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
313                 if (configuredDoc == null)
314                         return new LayoutGroup();
315
316                 // FIXME check for authentication
317
318                 return configuredDoc.getListViewLayoutGroup(tableName, StringUtils.defaultString(localeID));
319         }
320
321         // TODO: Specify the foundset (via a where clause) and maybe a default sort order.
322         /*
323          * (non-Javadoc)
324          * 
325          * @see org.glom.web.client.OnlineGlomService#getReportLayout(java.lang.String, java.lang.String, java.lang.String,
326          * java.lang.String)
327          */
328         @Override
329         public String getReportHTML(final String documentID, final String tableName, final String reportName,
330                         final String localeID) {
331                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
332                 if (configuredDoc == null)
333                         return "";
334
335                 final Document glomDocument = configuredDoc.getDocument();
336                 if (glomDocument == null) {
337                         final String errorMessage = "getReportHTML(): getDocument() failed.";
338                         Log.fatal(errorMessage);
339                         // TODO: throw new Exception(errorMessage);
340                         return "";
341                 }
342
343                 // FIXME check for authentication
344
345                 final Report report = glomDocument.get_report(tableName, reportName);
346                 if (report == null) {
347                         Log.info(documentID, tableName, "The report layout is not defined for this table:" + reportName);
348                         return "";
349                 }
350
351                 Connection connection;
352                 try {
353                         connection = configuredDoc.getCpds().getConnection();
354                 } catch (final SQLException e2) {
355                         // TODO Auto-generated catch block
356                         e2.printStackTrace();
357                         return "Connection Failed";
358                 }
359
360                 final ReportGenerator generator = new ReportGenerator(StringUtils.defaultString(localeID));
361                 return generator.generateReport(glomDocument, tableName, report, connection);
362         }
363
364         /*
365          * (non-Javadoc)
366          * 
367          * @see org.glom.web.client.OnlineGlomService#getListViewData(java.lang.String, java.lang.String, int, int)
368          */
369         @Override
370         public ArrayList<DataItem[]> getListViewData(final String documentID, final String tableName,
371                         final String quickFind, final int start, final int length) {
372                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
373                 if (!configuredDoc.isAuthenticated()) {
374                         return new ArrayList<DataItem[]>();
375                 }
376                 return configuredDoc.getListViewData(tableName, quickFind, start, length, false, 0, false);
377         }
378
379         /*
380          * (non-Javadoc)
381          * 
382          * @see org.glom.web.client.OnlineGlomService#getSortedListViewData(java.lang.String, java.lang.String, int, int,
383          * int, boolean)
384          */
385         @Override
386         public ArrayList<DataItem[]> getSortedListViewData(final String documentID, final String tableName,
387                         final String quickFind, final int start, final int length, final int sortColumnIndex,
388                         final boolean isAscending) {
389                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
390                 if (configuredDoc == null)
391                         return new ArrayList<DataItem[]>();
392
393                 if (!configuredDoc.isAuthenticated()) {
394                         return new ArrayList<DataItem[]>();
395                 }
396                 return configuredDoc.getListViewData(tableName, quickFind, start, length, true, sortColumnIndex, isAscending);
397         }
398
399         /*
400          * (non-Javadoc)
401          * 
402          * @see org.glom.web.client.OnlineGlomService#getDocuments()
403          */
404         @Override
405         public Documents getDocuments() {
406                 final Documents documents = new Documents();
407                 for (final String documentID : documentMapping.keySet()) {
408                         final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
409                         if (configuredDoc == null)
410                                 continue;
411
412                         final Document glomDocument = configuredDoc.getDocument();
413                         if (glomDocument == null) {
414                                 final String errorMessage = "getDocuments(): getDocument() failed.";
415                                 Log.fatal(errorMessage);
416                                 // TODO: throw new Exception(errorMessage);
417                                 continue;
418                         }
419
420                         final String localeID = StringUtils.defaultString(configuredDoc.getDefaultLocaleID());
421                         documents.addDocument(documentID, glomDocument.get_database_title(localeID), localeID);
422                 }
423                 return documents;
424         }
425
426         /*
427          * (non-Javadoc)
428          * 
429          * @see org.glom.web.client.OnlineGlomService#isAuthenticated(java.lang.String)
430          */
431         @Override
432         public boolean isAuthenticated(final String documentID) {
433                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
434                 if (configuredDoc == null)
435                         return false;
436
437                 return configuredDoc.isAuthenticated();
438         }
439
440         /*
441          * (non-Javadoc)
442          * 
443          * @see org.glom.web.client.OnlineGlomService#checkAuthentication(java.lang.String, java.lang.String,
444          * java.lang.String)
445          */
446         @Override
447         public boolean checkAuthentication(final String documentID, final String username, final String password) {
448                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
449                 if (configuredDoc == null) {
450                         Log.error(documentID, "The document could not be found for this ID: " + documentID);
451                         return false;
452                 }
453
454                 try {
455                         return configuredDoc.setUsernameAndPassword(username, password);
456                 } catch (final SQLException e) {
457                         Log.error(documentID, "Unknown SQL Error checking the database authentication.", e);
458                         return false;
459                 }
460         }
461
462         /*
463          * (non-Javadoc)
464          * 
465          * @see org.glom.web.client.OnlineGlomService#getReportsList(java.lang.String, java.lang.String, java.lang.String)
466          */
467         @Override
468         public Reports getReportsList(final String documentID, final String tableName, final String localeID) {
469                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
470                 return configuredDoc.getReports(tableName, localeID);
471         }
472
473         /*
474          * (non-Javadoc)
475          * 
476          * @see org.glom.web.client.OnlineGlomService#getDetailsData(java.lang.String, java.lang.String, java.lang.String)
477          */
478         @Override
479         public DataItem[] getDetailsData(final String documentID, final String tableName,
480                         final TypedDataItem primaryKeyValue) {
481                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
482                 if (configuredDoc == null)
483                         return new DataItem[0];
484
485                 // FIXME check for authentication
486
487                 return configuredDoc.getDetailsData(tableName, primaryKeyValue);
488         }
489
490         /*
491          * (non-Javadoc)
492          * 
493          * @see org.glom.web.client.OnlineGlomService#getDetailsLayoutAndData(java.lang.String, java.lang.String,
494          * java.lang.String)
495          */
496         @Override
497         public DetailsLayoutAndData getDetailsLayoutAndData(final String documentID, final String tableName,
498                         final TypedDataItem primaryKeyValue, final String localeID) {
499                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
500                 if (configuredDoc == null)
501                         return null;
502
503                 // FIXME check for authentication
504
505                 final DetailsLayoutAndData initalDetailsView = new DetailsLayoutAndData();
506                 initalDetailsView
507                                 .setLayout(configuredDoc.getDetailsLayoutGroup(tableName, StringUtils.defaultString(localeID)));
508                 initalDetailsView.setData(configuredDoc.getDetailsData(tableName, primaryKeyValue));
509
510                 return initalDetailsView;
511         }
512
513         /*
514          * (non-Javadoc)
515          * 
516          * @see org.glom.web.client.OnlineGlomService#getRelatedListData(java.lang.String, java.lang.String, int, int)
517          */
518         @Override
519         public ArrayList<DataItem[]> getRelatedListData(final String documentID, final String tableName,
520                         final String relationshipName, final TypedDataItem foreignKeyValue, final int start, final int length) {
521                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
522
523                 // FIXME check for authentication
524
525                 return configuredDoc.getRelatedListData(tableName, relationshipName, foreignKeyValue, start, length, false, 0,
526                                 false);
527         }
528
529         /*
530          * (non-Javadoc)
531          * 
532          * @see org.glom.web.client.OnlineGlomService#getSortedRelatedListData(java.lang.String, java.lang.String, int, int,
533          * int, boolean)
534          */
535         @Override
536         public ArrayList<DataItem[]> getSortedRelatedListData(final String documentID, final String tableName,
537                         final String relationshipName, final TypedDataItem foreignKeyValue, final int start, final int length,
538                         final int sortColumnIndex, final boolean ascending) {
539                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
540                 if (configuredDoc == null)
541                         return new ArrayList<DataItem[]>();
542
543                 // FIXME check for authentication
544
545                 return configuredDoc.getRelatedListData(tableName, relationshipName, foreignKeyValue, start, length, true,
546                                 sortColumnIndex, ascending);
547         }
548
549         @Override
550         public int getRelatedListRowCount(final String documentID, final String tableName, final String relationshipName,
551                         final TypedDataItem foreignKeyValue) {
552                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
553                 if (configuredDoc == null)
554                         return 0;
555
556                 // FIXME check for authentication
557
558                 return configuredDoc.getRelatedListRowCount(tableName, relationshipName, foreignKeyValue);
559         }
560
561         /*
562          * (non-Javadoc)
563          * 
564          * @see org.glom.web.client.OnlineGlomService#getSuitableRecordToViewDetails(java.lang.String, java.lang.String,
565          * java.lang.String, java.lang.String)
566          */
567         @Override
568         public NavigationRecord getSuitableRecordToViewDetails(final String documentID, final String tableName,
569                         final String relationshipName, final TypedDataItem primaryKeyValue) {
570                 final ConfiguredDocument configuredDoc = documentMapping.get(documentID);
571                 if (configuredDoc == null)
572                         return new NavigationRecord();
573
574                 // FIXME check for authentication
575
576                 return configuredDoc.getSuitableRecordToViewDetails(tableName, relationshipName, primaryKeyValue);
577         }
578
579 }