/******************************************************************************

  * HibernateUtil.java - Non-object access to the database 

  * $Id$

  * 

  * BuckoFIBS - Backgammon by BuckoSoft

  * Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.

  * 

  * $Log$

  * Revision 1.7  2011/05/31 19:36:38  dick

  * Privatize our private parts.

  *

  * Revision 1.6  2011/05/10 05:48:10  dick

  * Add support for an in-memory database.  Used by TEST.

  *

  * Revision 1.5  2011/05/09 17:09:39  dick

  * HibernateUtil goes from static to an object, so that during test we can keep

  * reinstantiating it.

  *

  * Revision 1.4  2011/05/08 21:41:40  dick

  * Add support for a test (in memory) database.

  *

  * Revision 1.3  2010/03/03 13:12:21  inim

  * Replaced (c) sign in comment mangled by CVS default encoding back to UTF-8

  *

  * Revision 1.2  2010/03/03 12:19:48  inim

  * Moved source to UTF8 encoding from CP1252 encoding. To this end all source files' (c) message was updated to "Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.". This replaces the (c) sign to UTF8, and adds the new year 2010.

  *

  * Revision 1.1  2010/02/04 05:57:53  inim

  * Mavenized project folder layout

  *

  * Revision 1.1  2009/02/20 10:24:51  dick

  * Non-object access to the database.

  *

  */

 /* 

  * This program is free software: you can redistribute it and/or modify

  * it under the terms of the GNU General Public License as published by

  * the Free Software Foundation, either version 3 of the License, or

  * (at your option) any later version.

  *

  * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  * GNU General Public License for more details.

  *

  * You should have received a copy of the GNU General Public License

  * along with this program.  If not, see <http://www.gnu.org/licenses/>.

  *

  * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.

  * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.

  */

 package com.buckosoft.fibs.BuckoFIBS.db;

 import java.io.File;

 import org.hibernate.Session;

 import org.hibernate.SessionFactory;

 import org.hibernate.cfg.Configuration;

 import org.hibernate.tool.hbm2ddl.SchemaExport;

 /** Non-object access to the database. <br>

  * This class is really private to DatabaseImpl.

  * @author Dick Balaska

  * @since 2009/02/18

  * @version $Revision$ <br> $Date$

  * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/BuckoFIBS/db/HibernateUtil.java">cvs HibernateUtil.java</a>

  */

 final class HibernateUtil {

         private SessionFactory sessionFactory;

         private        Configuration configuration = null;

         /** for TEST, increment the database name on each instantation */

         private        static int serialNumber = 0;

         private void initConfiguration(String url) {

                 try {

                         // Create the SessionFactory from hibernate.cfg.xml

                         if (url == null) {

                                 String s = "jdbc:hsqldb:file:" + getUserDatabaseDirectory() + "/BuckoFIBS";

                                 configuration = new Configuration().configure().setProperty("hibernate.connection.url",

                                                 s);

                         }

                         else if (url.equals("mem"))

                                 configuration = new Configuration().configure().setProperty("hibernate.connection.url",

                                                 "jdbc:hsqldb:mem:mymemdb" + serialNumber++);

                         else if (url.equals("testfile"))

                                 configuration = new Configuration().configure().setProperty("hibernate.connection.url",

                                                 "jdbc:hsqldb:file:db/test/BuckoFIBSTest" + serialNumber++);

                         sessionFactory = configuration.buildSessionFactory();

                 } catch (Throwable ex) {

                         // Make sure you log the exception, as it might be swallowed

                         System.err.println("Initial SessionFactory creation failed." + ex);

                         throw new ExceptionInInitializerError(ex);

                 }

         }

         protected SessionFactory getSessionFactory() {

                 return sessionFactory;

         }

         protected void maybeCreateNewDatabase(String url) {

                 initConfiguration(url);

                 Session session = getSessionFactory().getCurrentSession();

                 session.beginTransaction();

                 Object o = null;

                 try {

                         o = session.createQuery("from Player where id = ?")

                                 .setInteger(0, 1).uniqueResult();

                 } catch (Exception e) {

                         System.out.println("maybeCreateNewDatabase needs to create database");

                         //e.printStackTrace();

                 }

                 session.getTransaction().commit();

                 if (o != null)                // database ok.

                         return;

                 SchemaExport se = new SchemaExport(configuration);

                 se.execute(true, true, false, true);

         }

         /** Return the location for user data

          * @return The absolute string for {user.home}/jIBS

          */

         public static String getUserDataDirectory() {

                 String s = "{user.home}" + File.separator + "BuckoFIBS";

                 return(HibernateUtil.unwindProperties(s));

         }

         /** Return the location of our hsqldb database

          * @return The absolute string for {user.home}/jIBS/database

          */

         public static String getUserDatabaseDirectory() {

                 return(getUserDataDirectory() + File.separator + "database");

         }

         /** Given a string, substitute any System properties in that string.

          * A property is denoted with {}, i.e. <code>{user.home}</code>

          * @param in The string to unwind

          * @return The resultant string.  The original string is returned if no left brace '{' is found.

          */

         public static String unwindProperties(String in) {

                 int i = in.indexOf('{');

                 if (i == -1)

                         return(in);

                 int j = in.indexOf('}');

                 String out = in.substring(0, i);

                 String s = System.getProperty(in.substring(i+1, j));

                 out += s;

                 out += in.substring(j+1);

                 return(out);

         }

 }