/*
    * Copyright 2006-2010 the original author or authors.
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package net.sourceforge.domian.repository;
  
  
  import static java.lang.Boolean.FALSE;
  import static java.lang.Boolean.TRUE;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import static org.apache.commons.lang.StringUtils.isNotBlank;
  import static org.apache.commons.lang.SystemUtils.FILE_SEPARATOR;
  import org.slf4j.Logger;
  import static org.slf4j.LoggerFactory.getLogger;
  
  
  enum Rdbms {
  
      // TODO: add all Hibernate-supported RDBMSs - use the "supported" field to warn people of possible dubious behaviour...
      H2("H2", "http://www.h2database.com",
         TRUE,
         "org.hibernate.dialect.H2Dialect", "org.h2.Driver",
         "jdbc:h2:tcp:",
         //"", ""),                                             // Server mode for developing/debugging
         "jdbc:h2:", ";DB_CLOSE_ON_EXIT=TRUE"),
  
      HSQLDB("HSQLDB", "http://hsqldb.org",
             FALSE,
             "org.hibernate.dialect.HSQLDialect", "org.hsqldb.jdbcDriver",
             "jdbc:hsqldb:hsql:",
             //"", ""),                                         // Server mode for developing/debugging
             "jdbc:hsqldb:file:", ""),
  
      MYSQL_INNODB("MySQL", "http://www.mysql.com",
                   FALSE,
                   "org.hibernate.dialect.MySQLInnoDBDialect", "",
                   "",
                   "", ""),
  
      ORACLE_10G("Oracle 10g", "http://www.oracle.com/technology/products/database/xe/index.html",
                 FALSE,
                 "org.hibernate.dialect.Oracle10gDialect", "",
                 "",
                 "", "");
  
      private static final Logger log = getLogger(Rdbms.class);
  
      private final String officialName;
      private final Boolean supported;
      private final String officialWebUrl;
  
      private final String hibernateDialectClassName;
      private final String driverClassName;
  
      private final String jdbcConnectionUrlPrefix;
  
      private final String embeddedJdbcConnectionUrlPrefix;
      private final String embeddedJdbcConnectionUrlPostfix;
  
      private Rdbms(String officialName,
                    String officialWebUrl,
                    Boolean supported,
                    String hibernateDialectClassName,
                    String driverClassName,
                    String jdbcConnectionUrlPrefix,
                    String embeddedJdbcConnectionUrlPrefix,
                    String embeddedJdbcConnectionUrlPostfix) {
          this.officialName = officialName;
          this.officialWebUrl = officialWebUrl;
          this.supported = supported;
          this.hibernateDialectClassName = hibernateDialectClassName;
          this.driverClassName = driverClassName;
          this.jdbcConnectionUrlPrefix = jdbcConnectionUrlPrefix;
          this.embeddedJdbcConnectionUrlPrefix = embeddedJdbcConnectionUrlPrefix;
          this.embeddedJdbcConnectionUrlPostfix = embeddedJdbcConnectionUrlPostfix;
      }
  
      List<String> hibernateConfigKeyList;
  
      String getName() {
          return this.officialName;
      }
  
      String getOfficialName() {
          return getName();
     }
 
     String getUnixName() {
         return getOfficialName().toLowerCase();
     }
 
     Boolean isSupported() {
         return this.supported;
     }
 
     String getDefaultRepositoryRootDirectoryString(final String defaultDomianRootPath) {
         return defaultDomianRootPath + FILE_SEPARATOR + ".hibernate-" + getUnixName() + "-repository";
     }
 
     String getJdbcConnectionUrl(final String rdbmsServerName, final String repositoryDirectoryString, final String repositoryId) {
         if (isNotBlank(this.embeddedJdbcConnectionUrlPrefix)) {
             return this.embeddedJdbcConnectionUrlPrefix + repositoryDirectoryString + FILE_SEPARATOR + repositoryId + this.embeddedJdbcConnectionUrlPostfix;
         }
         // Server mode fallback
         return this.jdbcConnectionUrlPrefix + "//" + rdbmsServerName + "/" + repositoryDirectoryString + FILE_SEPARATOR + repositoryId;
     }
 
 
     Map getConfiguration(final String rdbmsServerName,
                          final String repositoryDirectoryString,
                          final String repositoryId,
                          final Map<String, String> configurationMap) {
 
         final Map<String, String> entityManagerFactoryProperties = new HashMap<String, String>();
 
         // **** Hibernate properties (Domian standards - should not be overridden (WARN message if so)) ****
         entityManagerFactoryProperties.put("hibernate.dialect", this.hibernateDialectClassName);
         entityManagerFactoryProperties.put("hibernate.connection.driver_class", this.driverClassName);
 
         // TODO: how to make this happen? is it even possible in JPA 1.0...
         //entityManagerFactoryProperties.put("hibernate.naming_strategy", "org.hibernate.cfg.ImprovedNamingStrategy");
 
         // **** Hibernate properties (Domian defaults - ment to be overridden at will (INFO message if so)) ****
         // Default JDBC URL building (embedded mode, with server mode fallback)
         entityManagerFactoryProperties.put("hibernate.connection.url", this.getJdbcConnectionUrl(rdbmsServerName, repositoryDirectoryString, repositoryId));
 
         // Default Domian schema creation/maintenance (automatic updating of database schema based on ORM config)
         entityManagerFactoryProperties.put("hibernate.hbm2ddl.auto", "update");
         //entityManagerFactoryProperties.put("hibernate.hbm2ddl.auto", "create");                       // Development setting...
 
         entityManagerFactoryProperties.put("hibernate.max_fetch_depth", "5");
         //entityManagerFactoryProperties.put("hibernate.default_batch_fetch_size", "4");                // Sets a default size for Hibernate batch fetching of associations. e.g. recommended values 4, 8, 16
 
         //entityManagerFactoryProperties.put("hibernate.connection.pool_size", "1");
 
         entityManagerFactoryProperties.put("hibernate.c3p0.min_size", "1");
         entityManagerFactoryProperties.put("hibernate.c3p0.max_size", "1");
         entityManagerFactoryProperties.put("hibernate.c3p0.timeout", "1800");
         entityManagerFactoryProperties.put("hibernate.c3p0.max_statements", "50");
 
         entityManagerFactoryProperties.put("hibernate.show_sql", "false");
         entityManagerFactoryProperties.put("hibernate.format_sql", "false");
         //entityManagerFactoryProperties.put("hibernate.default_schema", "false");                      // Qualify unqualified table names with the given schema/tablespace in generated SQL. e.g. SCHEMA_NAME
         //entityManagerFactoryProperties.put("hibernate.default_catalog", "false");                     // Qualifies unqualified table names with the given catalog in generated SQL. e.g. CATALOG_NAME
 
         //entityManagerFactoryProperties.put("hibernate.default_entity_mode", "pojo");                  // Sets a default mode for entity representation for all sessions opened from this SessionFactory
         //entityManagerFactoryProperties.put("hibernate.order_updates", "true");                        // Forces Hibernate to order SQL updates by the primary key value of the items being updated. This will result in fewer transaction deadlocks in highly concurrent systems. e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.generate_statistics", "true");                  // If enabled, Hibernate will collect statistics useful for performance tuning. e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.use_identifier_rollback", "true");              // If enabled, generated identifier properties will be reset to default values when objects are deleted. e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.use_sql_comments", "true");                     // If turned on, Hibernate will generate comments inside the SQL, for easier debugging, defaults to false.
 
 
         // **** Hibernate JDBC and Connection Properties ****
         //entityManagerFactoryProperties.put("hibernate.jdbc.fetch_size", "100");                       // A non-zero value determines the JDBC fetch size (calls Statement.setFetchSize()).
         //entityManagerFactoryProperties.put("hibernate.jdbc.batch_size", "10");                        // A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30
         //entityManagerFactoryProperties.put("hibernate.jdbc.batch_versioned_data", "true");            // Set this property to true if your JDBC driver returns correct row counts from executeBatch(). It is usually safe to turn this option on. Hibernate will then use batched DML for automatically versioned data. Defaults to false.
         //entityManagerFactoryProperties.put("hibernate.jdbc.use_scrollable_resultset", "");            // Enables use of JDBC2 scrollable resultsets by Hibernate. This property is only necessary when using user-supplied JDBC connections. Hibernate uses connection metadata otherwise. e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.jdbc.use_streams_for_binary", "");              // Use streams when writing/reading binary or serializable types to/from JDBC. *system-level property*  e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.jdbc.use_get_generated_keys", "");              // Enables use of JDBC3 PreparedStatement.getGeneratedKeys() to retrieve natively generated keys after insert. Requires JDBC3+ driver and JRE1.4+, set to false if your driver has problems with the Hibernate identifier generators. By default, it tries to determine the driver capabilities using connection metadata. e.g true|false
         //entityManagerFactoryProperties.put("hibernate.connection.provider_class", "");                // The classname of a custom org.hibernate.connection.ConnectionProvider which provides JDBC connections to Hibernate. e.g. classname.of.ConnectionProvider
         //entityManagerFactoryProperties.put("hibernate.connection.isolation", "8");                    // Sets the JDBC transaction isolation level. Check java.sql.Connection for meaningful values
         //entityManagerFactoryProperties.put("hibernate.connection.autocommit"; "");                    // Enables autocommit for JDBC pooled connections (it is not recommended). e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.connection.release_mode", "after_transaction"); // Specifies when Hibernate should release JDBC connections. By default, a JDBC connection is held until the session is explicitly closed or disconnected. For an application server JTA datasource, use after_statement to aggressively release connections after every JDBC call. For a non-JTA connection, it often makes sense to release the connection at the end of each transaction, by using after_transaction. auto will choose after_statement for the JTA and CMT transaction strategies and after_transaction for the JDBC transaction strategy. e.g. auto (default) | on_close | after_transaction | after_statement
         //entityManagerFactoryProperties.put("hibernate.connection.<propertyName>", "...");             // Pass the JDBC property <propertyName> to DriverManager.getConnection().
         //entityManagerFactoryProperties.put("hibernate.jndi.<propertyName>", "...");                   // Pass the property <propertyName> to the JNDI InitialContextFactory.
 
         // **** Hibernate Cache Properties ****
         //entityManagerFactoryProperties.put("hibernate.cache.provider_class", "");                     // The classname of a custom CacheProvider. e.g. classname.of.CacheProvider
         //entityManagerFactoryProperties.put("hibernate.cache.use_minimal_puts", "");                   // Optimizes second-level cache operation to minimize writes, at the cost of more frequent reads. This setting is most useful for clustered caches and, in Hibernate3, is enabled by default for clustered cache implementations. e.g. true|false
         entityManagerFactoryProperties.put("hibernate.cache.use_query_cache", "false");                 // Enables the query cache. Individual queries still have to be set cachable. e.g. true|false
         entityManagerFactoryProperties.put("hibernate.cache.use_second_level_cache", "false");          // Can be used to completely disable the second level cache, which is enabled by default for classes which specify a <cache> mapping. e.g. true|false
         //entityManagerFactoryProperties.put("hibernate.cache.query_cache_factory", "");                // The classname of a custom QueryCache interface, defaults to the built-in StandardQueryCache. e.g. classname.of.QueryCache
         //entityManagerFactoryProperties.put("hibernate.cache.region_prefix", "");                      // A prefix to use for second-level cache region names. e.g. prefix
         //entityManagerFactoryProperties.put("hibernate.cache.use_structured_entries", "false");        // Forces Hibernate to store data in the second-level cache in a more human-friendly format. e.g. true|false
 
         // **** Hibernate Transaction Properties ****
         //entityManagerFactoryProperties.put("hibernate.transaction.factory_class", "");                // The classname of a TransactionFactory to use with Hibernate Transaction API (defaults to JDBCTransactionFactory). e.g. classname.of.TransactionFactory
         //entityManagerFactoryProperties.put("jta.UserTransaction", "");                                // A JNDI name used by JTATransactionFactory to obtain the JTA UserTransaction from the application server. e.g. jndi/composite/name
         //entityManagerFactoryProperties.put("hibernate.transaction.manager_lookup_class", "");         // The classname of a TransactionManagerLookup. It is required when JVM-level caching is enabled or when using hilo generator in a JTA environment. e.g. classname.of.TransactionManagerLookup
         //entityManagerFactoryProperties.put("hibernate.transaction.flush_before_completion", "");      // If enabled, the session will be automatically flushed during the before completion phase of the transaction. Built-in and automatic session context management is preferred, see Section 2.5, “Contextual sessions”. e.g. true | false
         //entityManagerFactoryProperties.put("hibernate.transaction.auto_close_session", "");           // If enabled, the session will be automatically closed during the after completion phase of the transaction. Built-in and automatic session context management is preferred, see Section 2.5, “Contextual sessions”. e.g. true | false
 
         // **** Miscellaneous Properties ****
         //entityManagerFactoryProperties.put("hibernate.current_session_context_class", "");            // Supply a custom strategy for the scoping of the "current" Session. See Section 2.5, “Contextual sessions” for more information about the built-in strategies. e.g. jta | thread | managed | custom.Class
         //entityManagerFactoryProperties.put("hibernate.query.factory_class", "");                      // Chooses the HQL parser implementation. e.g. org.hibernate.hql.ast.ASTQueryTranslatorFactory or org.hibernate.hql.classic.ClassicQueryTranslatorFactory
         //entityManagerFactoryProperties.put("hibernate.query.substitutions", "");                      // Is used to map from tokens in Hibernate queries to SQL tokens (tokens might be function or literal names, for example). e.g. hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC
         //entityManagerFactoryProperties.put("hibernate.hbm2ddl.auto", "validate");                     // Automatically validates or exports schema DDL to the database when the SessionFactory is created. With create-drop, the database schema will be dropped when the SessionFactory is closed explicitly. e.g. validate | update | create | create-drop
         //entityManagerFactoryProperties.put("hibernate.bytecode.use_reflection_optimizer", "true");    // Enables the use of CGLIB instead of runtime reflection (System-level property). Reflection can sometimes be useful when troubleshooting. Hibernate always requires CGLIB even if you turn off the optimizer. You cannot set this property in hibernate.cfg.xml. e.g. true | false
 
         // **** Custom Hibernate properties ****
         if (configurationMap != null && !configurationMap.isEmpty()) {
             for (final String configKey : configurationMap.keySet()) {
                 // TODO: QA on added custom properties...
                 entityManagerFactoryProperties.put(configKey, configurationMap.get(configKey));
             }
         }
 
         if (log.isDebugEnabled()) {
             log.debug("Resolved entity manager factory properties: " + entityManagerFactoryProperties);
         }
         return entityManagerFactoryProperties;
     }
 }