Changeset 2142

Timestamp:

Apr 3, 2006, 1:14:21 PM (18 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #184: Running SQL/HQL after an update to the database.

Location:

trunk

Files:

• src/core/common-queries.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Application.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/HibernateUtil.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/Install.java (modified) (7 diffs)
• src/core/net/sf/basedb/core/Update.java (added)
• src/core/net/sf/basedb/core/data/SchemaVersionData.java (added)
• src/install/net/sf/basedb/install/InitDB.java (modified) (4 diffs)
• src/test/TestInstall.java (modified) (1 diff)
• src/test/TestUpdate.java (modified) (1 diff)
• www/exception/exception.jsp (modified) (1 diff)
• www/info/about.jsp (modified) (2 diffs)

trunk/src/core/common-queries.xml

@@ -1622 +1622 @@
     </description>
   </query>
+  
+  <query id="GET_SCHEMA_VERSION" type="HQL">
+    <sql>
+      SELECT sv
+      FROM SchemaVersionData sv
+    </sql>
+    <description>
+      A Hibernate query that loads the schema version (there should only be one record).
+    </description>
+  </query>
+  
+  <query id="SET_SCHEMA_VERSION" type="HQL">
+    <sql>
+      UPDATE SchemaVersionData sv
+      SET sv.schemaVersion = :schemaVersion,
+      sv.build = :build
+    </sql>
+    <description>
+      A Hibernate query that updates the schema version and build number.
+    </description>
+  </query>
+  
+  <query id="SET_PROJECT_ID_FOR_JOBS" type="HQL">
+    <sql>
+      UPDATE JobData job
+      SET job.activeProjectId = 0
+      WHERE job.activeProjectId IS NULL
+    </sql>
+    <description>
+      A Hibernate query that sets the active project ID for all
+      jobs to 0 if they have a null value.
+    </description>
+  </query>
 
 </predefined-queries>

trunk/src/core/net/sf/basedb/core/Application.java

@@ -26 +26 @@
 
 import net.sf.basedb.core.data.ClientData;
+import net.sf.basedb.core.data.SchemaVersionData;
 import net.sf.basedb.core.authentication.Authenticator;
 
@@ -185 +186 @@
     return BUILD;
   }
+  
+  /**
+    Get the current database schema version number.
+    @return The schema version number, or -1 if it could not be loaded
+  */
+  public static int getSchemaVersion()
+  {
+    org.hibernate.Session session = null;
+    org.hibernate.Transaction tx = null;
+    int schemaVersion = -1;
+    try
+    {
+      session = HibernateUtil.newSession();
+      tx = HibernateUtil.newTransaction(session);
+      org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, "GET_SCHEMA_VERSION");
+      schemaVersion = HibernateUtil.loadData(SchemaVersionData.class, query).getSchemaVersion();
+      HibernateUtil.commit(tx);
+    }
+    catch (BaseException ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx); 
+      log.error("getSchemaVersion", ex);
+    }
+    finally
+    {
+      if (session != null) HibernateUtil.close(session);
+    }
+    return schemaVersion;
+  }
+  
   
   /**

trunk/src/core/net/sf/basedb/core/HibernateUtil.java

@@ -439 +439 @@
       session = HibernateUtil.newSession();
       DatabaseMetaData metaData = session.connection().getMetaData();
+      
       Iterator<PersistentClass> classes = cfg.getClassMappings();
       while (classes.hasNext() && isEmpty)
@@ -1087 +1088 @@
     }
   }
-  
+  /**
+    Exceute an update or delete query. 
+    
+    @param query A <code>Query</code> object which is executed using the
+      {@link Query#executeUpdate()} method
+    @return The number of affected items
+  */
+  static int executeUpdate(Query query)
+    throws BaseException
+  {
+    assert query != null : "query == null";
+    try
+    {
+      return query.executeUpdate();
+    }
+    catch(HibernateException ex)
+    {
+      throw new BaseException(ex);
+    }
+  }
+
   /**
     Get the value of a property on a data object using Hibernate

trunk/src/core/net/sf/basedb/core/Install.java

@@ -36 +36 @@
 import net.sf.basedb.core.data.QuotaIndex;
 import net.sf.basedb.core.data.RoleData;
+import net.sf.basedb.core.data.SchemaVersionData;
 import net.sf.basedb.core.data.SoftwareTypeData;
 import net.sf.basedb.core.data.SoftwareData;
@@ -86 +87 @@
   private static SessionControl sessionControl = null;
 
+  /**
+    The schema version to give to new installations. Already
+    existing installations will be updated to this version number
+    by the {@link Update#updateDatabase(ProgressReporter, String, String)}
+    method.
+  */
+  private static final int NEW_SCHEMA_VERSION = 2;
+
   public static synchronized void createTables(boolean update, final ProgressReporter progress)
     throws BaseException
@@ -139 +148 @@
     @throws BaseException This exception is thrown if there is an error
   */
-  public static synchronized void initDatabase(ProgressReporter progress, String rootPassword)
-    throws BaseException
-  {
-    Application.start(false);
-    session = HibernateUtil.newSession();
-
+  public static synchronized void initDatabase(boolean update, ProgressReporter progress, String rootLogin, String rootPassword)
+    throws BaseException
+  {
     final int total_progress_steps = 22;
     final float progress_factor = 100 / total_progress_steps;
@@ -150 +156 @@
     try
     {
+      Application.start(false);
+      session = HibernateUtil.newSession();
+
+      // SchemaVersion
+      createSchemaVersion(update ? 1 : NEW_SCHEMA_VERSION);
 
       // QuotaTypes
@@ -177 +188 @@
       // Users
       if (progress != null) progress.display((int)(4*progress_factor), "--Creating users...");
-      UserData rootUser = createUser(User.ROOT, "root", rootPassword, "Root", "This is the root user account of BASE. It has full permission to everything.", roleAdmin, quotaUnlimit);
+      UserData rootUser = createUser(User.ROOT, rootLogin, rootPassword, "Root", "This is the root user account of BASE. It has full permission to everything.", roleAdmin, quotaUnlimit);
       // createUser(0, "demo", "demo", "Demo", "This account can be used for demonstration purposes.", Role.GUEST);
       // createUser(0, "power", "power", "Power user", "This account has power user privileges.", Role.POWER_USER);
@@ -183 +194 @@
       // Now that we have a root user let's create a session 
       sessionControl = Application.newSessionControl( null, null, null );
-      sessionControl.login("root", rootPassword, "InitDBSessionId", false);
+      sessionControl.login(rootLogin, rootPassword, "InitDBSessionId", false);
 
       if (progress != null) progress.display((int)(5*progress_factor), "--Creating groups...");
@@ -577 +588 @@
   }
   
+  /**
+    Create the schema version.
+  */
+  private static SchemaVersionData createSchemaVersion(int sv)
+    throws BaseException
+  {
+    org.hibernate.Transaction tx = null;
+    SchemaVersionData schemaVersion = null;
+    try
+    {
+      tx = HibernateUtil.newTransaction(session);
+
+      org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, "GET_SCHEMA_VERSION");
+      schemaVersion = HibernateUtil.loadData(SchemaVersionData.class, query);
+      if (schemaVersion != null)
+      {
+        log.info("createSchemaVersion: EXISTS");
+        HibernateUtil.commit(tx);
+      }
+      else
+      {
+        schemaVersion = new SchemaVersionData();
+        schemaVersion.setBuild(Application.getBuild());
+        schemaVersion.setSchemaVersion(sv);
+        HibernateUtil.saveData(session, schemaVersion);
+        HibernateUtil.commit(tx);
+        log.info("createSchemaVersion: OK");
+      }
+    }
+    catch (BaseException ex)
+    {
+      if(tx != null) HibernateUtil.rollback(tx);
+      log.error("createSchemaVersion: FAILED", ex);
+      throw ex;
+    }
+    return schemaVersion;
+  }
+
   /**
     Create a {@link Directory}.

trunk/src/install/net/sf/basedb/install/InitDB.java

@@ -26 +26 @@
 
 import net.sf.basedb.core.Install;
-import net.sf.basedb.core.ProgressReporter;
+import net.sf.basedb.core.Update;
 import net.sf.basedb.util.ConsoleProgressReporter;
 import net.sf.basedb.util.ChainedProgressReporter;
@@ -50 +50 @@
     }
     String rootPassword = args.length == 2 ? args[1] : args[0];
+    String rootLogin = "root";
     boolean update = args.length == 2 && "update".equals(args[0]);
     try
@@ -56 +57 @@
       progress.setRange(0, 30);
       Install.createTables(update, progress);
-      progress.setRange(35, 90);
-      Install.initDatabase(progress, rootPassword);
+      progress.setRange(35, 70);
+      Install.initDatabase(update, progress, rootLogin, rootPassword);
+      progress.setRange(75, 90);
+      Update.updateDatabase(progress, rootLogin, rootPassword);
       progress.setRange(95, 100);
       progress.display(0, "Installing web application...");
@@ -63 +66 @@
       progress.display(100, "Web application installed successfully.\n");
     }
-    catch (Exception ex)
+    catch (Throwable t)
     {
       System.out.println("\n");
-      ex.printStackTrace();
+      t.printStackTrace();
     }
   }

trunk/src/test/TestInstall.java

@@ -37 +37 @@
       ProgressReporter progress = new ConsoleProgressReporter();
       Install.createTables(false, progress);
-      Install.initDatabase(progress, "root");
+      Install.initDatabase(false, progress, "root", "root");
       progress.display(100, "Database installed successfully.\n");
     }

trunk/src/test/TestUpdate.java

@@ -37 +37 @@
       ProgressReporter progress = new ConsoleProgressReporter();
       Install.createTables(true, progress);
-      Install.initDatabase(progress, "root");
+      Install.initDatabase(true, progress, "root", "root");
+      Update.updateDatabase(progress, "root", "root");
       progress.display(100, "Database updated successfully.\n");
     }

trunk/www/exception/exception.jsp

@@ -116 +116 @@
     <tr>
       <td class="prompt">Base version</td>
-      <td><%=Application.getMajorVersion() + "." +Application.getMinorVersion() + " (build #" + Application.getBuild()+")"%></td>
+      <td><%=Application.getMajorVersion() + "." +Application.getMinorVersion() + " (build #" + Application.getBuild()+"; schema #" + Application.getSchemaVersion()+")"%></td>
     </tr>
     <tr>

trunk/www/info/about.jsp

@@ -60 +60 @@
     <b>Administrator:</b> <%=Values.getString(serverAdminName, "<i>- unknown -</i>")%><br>
     <b>Email:</b> <%=serverAdminEmail == null ? "<i>- unknown -</i>": "<a href=\"mailto:"+serverAdminEmail+"\">"+serverAdminEmail+"</a>"%><br>
-    <b>Version:</b> <%=Application.getMajorVersion() + "." +Application.getMinorVersion() + " (build #" + Application.getBuild()+")"%><br>
+    <b>Version:</b> <%=Application.getMajorVersion() + "." +Application.getMinorVersion() + " (build #" + Application.getBuild()+"; schema #" + Application.getSchemaVersion()+")"%><br>
     <br>
     <font size="-1">
@@ -75 +75 @@
   <tr>
     <td class="prompt">Base version</td>
-    <td><%=Application.getMajorVersion() + "." +Application.getMinorVersion() + " (build #" + Application.getBuild()+")"%></td>
+    <td><%=Application.getMajorVersion() + "." +Application.getMinorVersion() + " (build #" + Application.getBuild()+"; schema #" + Application.getSchemaVersion()+")"%></td>
   </tr>
   <tr>