Changeset 7947

Timestamp:

May 7, 2021, 1:44:50 PM (7 months ago)

Author:

Nicklas Nordborg

Message:

References #2250: Named transactions

Implemented code for updating existing change history entries. Several side-effects due to new parameter in ScrollIterator constructor.

Location:

trunk/src

Files:

• core/net/sf/basedb/core/DbControl.java (modified) (1 diff)
• core/net/sf/basedb/core/HibernateUtil.java (modified) (2 diffs)
• core/net/sf/basedb/core/Install.java (modified) (4 diffs)
• core/net/sf/basedb/core/ItemQuery.java (modified) (1 diff)
• core/net/sf/basedb/core/QueryExecutor.java (modified) (1 diff)
• core/net/sf/basedb/core/ScrollIterator.java (modified) (2 diffs)
• core/net/sf/basedb/core/StringUtil.java (modified) (1 diff)
• core/net/sf/basedb/core/Update.java (modified) (7 diffs)
• install/net/sf/basedb/install/OneTimeFix.java (modified) (2 diffs)
• install/net/sf/basedb/install/Webclient.java (modified) (1 diff)
• plugins/core/net/sf/basedb/plugins/HelpImporter.java (modified) (1 diff)

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

@@ -160 +160 @@
   {
     this.sc = sc;
-    System.out.println("Transaction name: "+name);
+//    System.out.println("Transaction name: "+name);
     this.name = name;
     

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

@@ -2127 +2127 @@
     @since 3.12
   */
-  static <T> ScrollIterator<T> loadIterator(Query<T> query, SessionControl sc)
+  static <T> ScrollIterator<T> loadIterator(Query<T> query, boolean returnArray, SessionControl sc)
     throws BaseException
   {
@@ -2136 +2136 @@
       if (sc != null) pinger = Application.newPinger(sc);
       ScrollableResults result = query.scroll(ScrollMode.FORWARD_ONLY);
-      return new ScrollIterator<T>(result);
+      return new ScrollIterator<T>(result, returnArray);
     }
     catch (Throwable ex)

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

@@ -119 +119 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(150).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(151).intValue();
   
   public static synchronized int createTables(SchemaGenerator.Mode mode, ProgressReporter progress,
@@ -235 +235 @@
         roleJobAgent, quota0, true, true);
   
-      // Now that we have a root user let's create a session 
-      sessionControl = Application.newSessionControl( null, null, null );
+      ClientData install = createClient(rootUser, "net.sf.basedb.core.install", "Install", "This is the installation program", null);
+
+      // Now that we have a root user and install client and let's create a session 
+      sessionControl = Application.newSessionControl(install.getExternalId(), null, null);
       LoginRequest loginRequest = new LoginRequest(rootLogin, rootPassword);
       loginRequest.setComment("InitDBSessionId");
@@ -2472 +2474 @@
     {
       
-      dc = sessionControl.newDbControl();
+      dc = sessionControl.newDbControl("Install: Create plug-in definitions");
       plugin = PluginDefinition.installOrUpdate(dc, info, null, shareToEveryone);
       if (plugin != null)
@@ -2520 +2522 @@
     try
     {
-      dc = sessionControl.newDbControl();
+      dc = sessionControl.newDbControl("Install: Create plug-in configurations");
       
       org.hibernate.query.Query<PluginConfigurationData> query = null;

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

@@ -123 +123 @@
 
     ScrollIterator<? extends BasicData> result = 
-      HibernateUtil.loadIterator(getMainHqlQuery(dc, dataClass), sc);
+      HibernateUtil.loadIterator(getMainHqlQuery(dc, dataClass), false, sc);
     disableFilters(dc);
     return new ItemResultIterator<I>(result, dc, itemClass, totalCount);

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

@@ -315 +315 @@
     {
       ScrollableResults result = query.scroll(ScrollMode.FORWARD_ONLY);
-      return new ScrollIterator<T>(result); 
+      return new ScrollIterator<T>(result, false); 
     }
   }

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

@@ -40 +40 @@
 
   private final ScrollableResults results;
+  private final boolean returnArray;
   private boolean isClosed;
   private E nextElement;
 
-  ScrollIterator(ScrollableResults results)
+  ScrollIterator(ScrollableResults results, boolean returnArray)
   {
     assert results != null : "results == null";
     this.results = results;
+    this.returnArray = returnArray;
     this.isClosed = false;
     this.nextElement = null;
@@ -65 +67 @@
         if (results.next())
         {
-          nextElement = (E)results.get(0);
+          nextElement = returnArray ? (E)results.get() : (E)results.get(0);
         }
         else

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

@@ -291 +291 @@
     return value.substring(0, 1).toLowerCase() + value.substring(1);
   }
+  
+  /**
+    Return the first non-null value (or null if all values are null).
+    @since 3.19
+  */
+  public static final String coalesce(String... values)
+  {
+    if (values == null || values.length == 0) return null;
+    for (String v : values)
+    {
+      if (v != null) return v;
+    }
+    return null;
+  }
+  
 }

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

@@ -47 +47 @@
 import net.sf.basedb.core.data.BioPlateData;
 import net.sf.basedb.core.data.BioPlateTypeData;
+import net.sf.basedb.core.data.ChangeHistoryData;
 import net.sf.basedb.core.data.ChangeHistoryDetailData;
 import net.sf.basedb.core.data.ClientData;
@@ -459 +460 @@
     </td>
   </tr>
+  <tr>
+    <td>151</td>
+    <td>
+      Added {@link ChangeHistoryData#getName()}. The update will generate a default name for all
+      existing entries based on the registred job, plug-in, client, etc.
+    </td>
+  </tr>
   </table>
 
@@ -755 +763 @@
       }
     
+      if (schemaVersion < 151)
+      {
+        if (progress != null) progress.display((int)(progress_current), "--Updating schema version: " + schemaVersion + " -> 151...");
+        schemaVersion = updateToSchemaVersion151(session, schemaVersion, progress);
+        progress_current += progress_step;
+      }
+
       sc.logout();
       if (progress != null) progress.display(100, "Database updated successfully.");
@@ -958 +973 @@
 
       if (progress != null) progress.display(50, "Checking existing items...");
-      // Test root user account
-      SessionControl sc = Application.newSessionControl(null, null, null);
+      // Test root user account (the install client was added in schema version 151 so we can't use this before updating)
+      SessionControl sc = Application.newSessionControl(schemaVersion < 151 ? null : "net.sf.basedb.core.install", null, null);
       LoginRequest loginRequest = new LoginRequest(rootLogin, rootPassword);
       sc.login(loginRequest);
@@ -1463 +1478 @@
       
       org.hibernate.query.Query<ChangeHistoryDetailData> query = HibernateUtil.createQuery(statelessSession, hql, ChangeHistoryDetailData.class);
-      Iterator<ChangeHistoryDetailData> changes = HibernateUtil.loadIterator(query, null);
+      Iterator<ChangeHistoryDetailData> changes = HibernateUtil.loadIterator(query, false, null);
       
       int i = 0;
@@ -2157 +2172 @@
         "where [id] = :id");
       
-      Iterator<JobData> it = HibernateUtil.loadIterator(query, null);
+      Iterator<JobData> it = HibernateUtil.loadIterator(query, false, null);
       while (it.hasNext())
       {
@@ -2321 +2336 @@
   }
 
+  /**
+    
+    @return The new schema version (=151)
+  */
+  private static int updateToSchemaVersion151(org.hibernate.Session session, int currentSchemaVersion, ProgressReporter progress)
+    throws BaseException
+  {
+    final int schemaVersion = 151;
+    org.hibernate.Transaction tx = null;
+    
+    try
+    {
+      tx = HibernateUtil.newTransaction(session);
+      
+      // Pre-load names for all clients, plug-ins and jobs
+      Map<Integer, String> clientNames = loadIdToNameMap(session, "select [c].[id], [c].[name] from [Clients] [c]");
+      Map<Integer, String> pluginNames = loadIdToNameMap(session, "select [p].[id], [p].[name] from [PluginDefinitions] [p]");
+      Map<Integer, String> jobNames = loadIdToNameMap(session, "select [j].[id], [j].[name] from [Jobs] [j]");
+      if (progress != null) progress.append(".");
+
+      // Count all
+      String countSql = "select count(*) from ChangeHistoryData ch where ch.name is null";
+      org.hibernate.query.Query<Long> countQuery = HibernateUtil.createQuery(session, countSql, Long.class);
+      long numItems = HibernateUtil.loadData(countQuery);
+      int delta = (int)numItems / 50;
+
+      // Load all ChangeHistory entries
+      String sql = "select [ch].[id], [ch].[client_id], [ch].[plugin_id], [ch].[job_id] "+
+          " from [ChangeHistory] [ch] where [ch].[name] is null";
+      org.hibernate.query.Query<Object[]> query = HibernateUtil.createSqlQuery(session, sql, Object[].class);
+      
+      // This query is used to update the 'name' for a single entry
+      org.hibernate.query.Query<?> fixQuery = HibernateUtil.createSqlQuery(session,
+        "update [ChangeHistory] set [name] = :name where [id] = :id");
+      
+      int count = 0;
+      Iterator<Object[]> it = HibernateUtil.loadIterator(query, true, null);
+      while (it.hasNext())
+      {
+        Object[] ch = it.next();
+        
+        int id = (Integer)ch[0];
+        Integer clientId = (Integer)ch[1];
+        Integer pluginId = (Integer)ch[2];
+        Integer jobId = (Integer)ch[3];
+        String clientName = clientId != null ? clientNames.get(clientId) : null;
+        String pluginName = pluginId != null ? pluginNames.get(pluginId) : null;
+        String jobName = jobId != null ? jobNames.get(jobId) : null;
+        
+        String name = "Unknown";
+        if (jobName != null && pluginName != null && !jobName.contains(pluginName))
+        {
+          name = StringUtil.trimString(pluginName+": "+jobName, Nameable.MAX_NAME_LENGTH);
+        }
+        else
+        {
+          name = StringUtil.coalesce(jobName, pluginName, clientName, "Unknown");
+        }
+        
+        fixQuery.setParameter("name", name, TypeWrapper.H_STRING);
+        fixQuery.setParameter("id", id, TypeWrapper.H_INTEGER);
+        fixQuery.executeUpdate(); 
+
+        count++;
+        if (progress != null && count % delta == 0) progress.append(".");
+      }
+
+      // Update the schema version number
+      setSchemaVersion(session, schemaVersion);
+      
+      // Commit the changes
+      HibernateUtil.commit(tx);
+      log.info("updateToSchemaVersion151: OK");
+    }
+    catch (RuntimeException ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx); 
+      log.error("updateToSchemaVersion151: FAILED", ex);
+      throw ex;
+    }
+    return schemaVersion;
+  }
+
+  
+  private static Map<Integer, String> loadIdToNameMap(org.hibernate.Session session, String sql)
+  {
+    Map<Integer, String> map = new HashMap<>();
+    org.hibernate.query.Query<Object[]> query = HibernateUtil.createSqlQuery(session, sql, Object[].class);
+    Iterator<Object[]> it = HibernateUtil.loadIterator(query, true, null);
+    while (it.hasNext())
+    {
+      Object[] e = it.next();
+      map.put((Integer)e[0], (String)e[1]);
+    }
+    return map;
+  }
   
   /**

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

@@ -77 +77 @@
             .disableInternalJobQueue(true)
             );
-        SessionControl sc = Application.newSessionControl(null, null, null);
+        SessionControl sc = Application.newSessionControl("net.sf.basedb.core.install", null, null);
         sc.login(new LoginRequest(login, pwd));
         int numModified = Update.recalculateRemainingQuantity(new ConsoleProgressReporter(false));
@@ -104 +104 @@
             .disableInternalJobQueue(true)
             );
-        SessionControl sc = Application.newSessionControl(null, null, null);
+        SessionControl sc = Application.newSessionControl("net.sf.basedb.core.install", null, null);
         sc.login(new LoginRequest(login, pwd));
         int numModified = Update.recalculateFreeWells(new ConsoleProgressReporter(false));

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

@@ -97 +97 @@
         .disableInternalJobQueue(true)
         );
-    SessionControl sc = Application.newSessionControl(null, null, null);
+    SessionControl sc = Application.newSessionControl("net.sf.basedb.core.install", null, null);
     LoginRequest loginRequest = new LoginRequest(login, password);
     loginRequest.setComment("Installing web client");
     sc.login(loginRequest);
     
-    DbControl dc = sc.newDbControl();
+    DbControl dc = sc.newDbControl("Install: Web client");
     try
     {

trunk/src/plugins/core/net/sf/basedb/plugins/HelpImporter.java

@@ -331 +331 @@
     try
     {
-      dc = sc.newDbControl();        
+      dc = sc.newDbControl(":Import help texts");
       client = Client.getById(dc, client.getId());
       float progLastUpdated = 0;