Clean up error handling to make things slightly friendlier on an initial install.
[cfb.git] / prod / net / jaekl / cfb / CFB.java
index c02aa546aa0f7efe1bd29b36f81703127e3e6497..c6c995d41cf70e66d9ecdb54329fca321b18cd3c 100644 (file)
@@ -21,6 +21,7 @@ import java.util.Locale.Category;
 import net.jaekl.cfb.analyze.Analysis;
 import net.jaekl.cfb.analyze.Analyzer;
 import net.jaekl.cfb.analyze.Delta;
+import net.jaekl.cfb.analyze.FBMsgFileNotFoundException;
 import net.jaekl.cfb.analyze.HtmlReport;
 import net.jaekl.cfb.analyze.MessageMap;
 import net.jaekl.cfb.analyze.Notifier;
@@ -29,6 +30,8 @@ import net.jaekl.cfb.db.TypeMismatchException;
 import net.jaekl.cfb.db.driver.DbDriver;
 import net.jaekl.cfb.db.driver.PostgresqlDriver;
 import net.jaekl.cfb.store.DbStore;
+import net.jaekl.cfb.store.StoreException;
+import net.jaekl.cfb.util.Env;
 import net.jaekl.qd.xml.XmlParseException;
 
 import org.apache.commons.cli.CommandLine;
@@ -39,22 +42,19 @@ import org.apache.commons.cli.ParseException;
 import org.xml.sax.SAXException;
 
 public class CFB {
+       public static final String FINDBUGS_HOME = "FINDBUGS_HOME";     // name of the FINDBUGS_HOME environment variable
+       
        DbDriver m_driver;
        CfbSchema m_schema;
-       CfbBundle m_bundle;     
+       volatile static CfbBundle m_bundle = null;      
        Locale m_locale;
        
        Config m_config;
        
        // Command-line parameters
        File m_configFile;
-       String m_dbName; // db name
        File m_fbp;             // FindBugsProject file
        File m_fbDir;   // Directory where FindBugs is installed
-       String m_host;  // db host
-       int m_port;             // db port
-       String m_user;  // db user
-       String m_pass;  // db password
        String m_projName; // project (module) name
        String m_buildNum; // build number (version)
        boolean m_removeSchema; // purge DB schema
@@ -64,23 +64,29 @@ public class CFB {
                m_driver = new PostgresqlDriver();
                m_schema = new CfbSchema(m_driver);
                m_locale = locale;
-               m_bundle = CfbBundle.getInst(m_locale);
                m_config = new Config();
                
                m_configFile = new File("config.properties");
-               m_dbName = "CFB";
                m_fbp    = null;
                m_fbDir  = null;
-               m_host = "localhost";
-               m_port = 5432;
-               m_pass = "";
-               m_user = "user";
                m_projName = null;
                m_buildNum = null;
                m_removeSchema = false;
                m_output = null;
        }
        
+       static CfbBundle getBundle(Locale locale) {
+               CfbBundle bundle = m_bundle;
+               if (null == bundle) {
+                       synchronized(CFB.class) {
+                               if (null == m_bundle) {
+                                       m_bundle = bundle = CfbBundle.getInst(locale);
+                               }
+                       }
+               }
+               return bundle;
+       }
+       
        Options createOptions() {
                Options opt = new Options();
                
@@ -108,13 +114,13 @@ public class CFB {
                                m_configFile = new File(line.getOptionValue("c"));
                        }
                        if (line.hasOption("d")) {
-                               m_dbName = line.getOptionValue("d");
+                               m_config.setDbName(line.getOptionValue("d"));
                        }
                        if (line.hasOption("f")) {
                                m_fbp = new File(line.getOptionValue("f"));
                        }
                        if (line.hasOption("h")) {
-                               m_host = line.getOptionValue("h");
+                               m_config.setDbHost(line.getOptionValue("h"));
                        }
                        if (line.hasOption("j")) {
                                m_projName = line.getOptionValue("j");
@@ -126,14 +132,14 @@ public class CFB {
                                m_output = new File(line.getOptionValue("o"));
                        }
                        if (line.hasOption("p")) {
-                               m_pass = line.getOptionValue("p");
+                               m_config.setDbPass(line.getOptionValue("p"));
                        }
                        m_removeSchema = line.hasOption("drop-tables");
                        if (line.hasOption("t")) {
-                               m_port = Integer.parseInt(line.getOptionValue("t"));
+                               m_config.setDbPort(Integer.parseInt(line.getOptionValue("t")));
                        }
                        if (line.hasOption("u")) {
-                               m_user = line.getOptionValue("u");
+                               m_config.setDbUser(line.getOptionValue("u"));
                        }
                } 
                catch (ParseException exc) {
@@ -149,8 +155,8 @@ public class CFB {
                help.printHelp(pw, 80, getClass().getName(), "", opt, 0, 0, "", true);
        }
        
-       String trans(String key) {
-               return m_bundle.get(key);
+       String trans(String key, Object... params) {
+               return getBundle(m_locale).get(key, params);
        }
        
        String getenv(String varName) {
@@ -194,54 +200,110 @@ public class CFB {
                File findBugsDir = getFindBugsDir();
                File workDir = new File(".");
                MessageMap messageMap = new MessageMap();
-               messageMap.load(findBugsDir, Locale.getDefault(Category.DISPLAY));
+               try {
+                       messageMap.load(findBugsDir, Locale.getDefault(Category.DISPLAY));
+               }
+               catch (FBMsgFileNotFoundException exc) {
+                       reportException(pw, exc);
+                       return;
+               }
                
-               try (Connection con = m_driver.connect(m_host, m_port, m_dbName, m_user, m_pass)) {
+               if (!ensureDbInitialized(pw, messageMap)) {
+                       return;
+               }
+               
+               Analyzer analyzer = new Analyzer(messageMap);
+               Analysis analysis = analyzer.analyze(pw, workDir, m_fbp, m_projName, m_buildNum);
+               if (null == analysis) {
+                       pw.println(trans(CfbBundle.ANALYSIS_FAILED));
+                       return;
+               }
+               
+               storeAndReport(pw, messageMap, analysis);
+       }
+
+       boolean ensureDbInitialized(PrintWriter pw, MessageMap messageMap)
+                       throws TypeMismatchException 
+       {
+               try (Connection con = m_driver.connect(
+                                       m_config.getDbHost(), m_config.getDbPort(), 
+                                       m_config.getDbName(), 
+                                       m_config.getDbUser(), m_config.getDbPass())
+                       ) 
+               {
                        m_schema.setMessageMap(messageMap);
                        
                        if (m_removeSchema) {
                                m_schema.purge(con);
-                               return;
+                               return false;   // do not continue execution
                        }
                        m_schema.ensureDbInitialized(con);
                        messageMap.loadIds(con, m_driver);
                }
                catch (SQLException exc) {
                        reportUnableToConnect(pw, exc);
-                       return;
-               }
-               
-               Analyzer analyzer = new Analyzer(messageMap);
-               Analysis analysis = analyzer.analyze(pw, workDir, m_fbp, m_projName, m_buildNum);
-               if (null == analysis) {
-                       pw.println(trans(CfbBundle.ANALYSIS_FAILED));
-                       return;
+                       return false;   // do not continue execution
                }
                
-               try (Connection con = m_driver.connect(m_host, m_port, m_dbName, m_user, m_pass)) {
+               return true;    // all OK; continue execution
+       }
+
+       void storeAndReport(PrintWriter pw, MessageMap messageMap, Analysis analysis) 
+                       throws TypeMismatchException, IOException 
+       {
+               try (
+                               Connection con = m_driver.connect(
+                                               m_config.getDbHost(), m_config.getDbPort(), 
+                                               m_config.getDbName(),
+                                               m_config.getDbUser(), m_config.getDbPass()
+                                       )
+                       )
+               {
                        DbStore store = new DbStore(con, m_driver, messageMap.getColl());
                        
                        store.put(analysis);
                        Analysis prior = store.getPrior(analysis);
                        Delta delta = new Delta(prior, analysis);
 
-                       HtmlReport report = new HtmlReport(m_bundle, messageMap.getColl(), delta);
+                       HtmlReport report = new HtmlReport(getBundle(m_locale), messageMap.getColl(), delta);
                        if (null != m_output) {
                                report.write(m_output);
                        }
                        
-                       Notifier notifier = new Notifier(m_bundle, m_config);
+                       Notifier notifier = new Notifier(getBundle(m_locale), m_config);
                        notifier.sendEmailIfNeeded(pw, report);
                }
+               catch (StoreException exc) {
+                       exc.printStackTrace(pw);
+               }
                catch (SQLException exc) {
                        reportUnableToConnect(pw, exc);
-                       return;
                }
        }
+       
+       void reportException(PrintWriter pw, FBMsgFileNotFoundException exc) {
+               exc.printStackTrace(pw);
+               
+               pw.println(trans(CfbBundle.CANNOT_LOAD_FBMSG_FILE, exc.getFilename()));
+               
+               String fbHome = Env.get(FINDBUGS_HOME);
+               if (null == fbHome) {
+                       pw.println(trans(CfbBundle.FINDBUGS_HOME_IS_NOT_SET, FINDBUGS_HOME));
+               }
+               else {
+                       pw.println(trans(CfbBundle.FINDBUGS_HOME_IS_SET_TO, FINDBUGS_HOME, fbHome));
+               }
+
+       }
 
        private void reportUnableToConnect(PrintWriter pw, SQLException exc) {
                String cannotConnectFormat = trans(CfbBundle.CANNOT_CONNECT);
-               String cannotConnect = MessageFormat.format(cannotConnectFormat, m_host, ""+m_port, m_dbName, m_user);
+               String cannotConnect = MessageFormat.format(cannotConnectFormat, 
+                                                                                       m_config.getDbHost(), 
+                                                                                       ""+m_config.getDbPort(), 
+                                                                                       m_config.getDbName(), 
+                                                                                       m_config.getDbUser()
+                                                                               );
                exc.printStackTrace(pw);
                SQLException next = exc.getNextException();
                while (null != next) {