Changeset 8053

Timestamp:

Aug 2, 2022, 1:15:28 PM (10 months ago)

Author:

Nicklas Nordborg

Message:

Fixes #2280: Change history logging when editing project-specific annotations

Location:

branches/3.19-stable/src/core

Files:

• common-queries.xml (modified) (1 diff)
• net/sf/basedb/core/AnnotationBatcher.java (modified) (1 diff)
• net/sf/basedb/core/log/TransactionDetails.java (modified) (3 diffs)
• net/sf/basedb/core/log/db/AnnotationLogger.java (modified) (5 diffs)

branches/3.19-stable/src/core/common-queries.xml

@@ -2752 +2752 @@
   <query id="DBLOG_GET_ANNOTATIONTYPE_INFO" type="HQL">
     <sql>
-      SELECT at.name, at.valueType, at.disableLogOfValues
+      SELECT at.name, at.valueType, at.disableLogOfValues, at.projectAnnotations
       FROM AnnotationTypeData at
       WHERE at.id = :annotationTypeId
     </sql>
     <description>
-      An HQL query that loads the 'name', 'valueType' and 'disableLogOfValues' flag
-      for an annotation type given the ID.
+      An HQL query that loads the 'name', 'valueType', 'disableLogOfValues' and
+      the 'projectAnnotations' flag for an annotation type given the ID.
     </description>
   </query>

branches/3.19-stable/src/core/net/sf/basedb/core/AnnotationBatcher.java

@@ -1068 +1068 @@
     
     /**
+      Get the id of the project this annotation belong to.
+      Only relevant if the annotation type is using project-specific
+      annotations.
+      @since 3.19.4
+    */
+    public int getProjectId()
+    {
+      return projectId;
+    }
+    
+    /**
       Get the ID of the unit this annotation is using.
     */

branches/3.19-stable/src/core/net/sf/basedb/core/log/TransactionDetails.java

@@ -23 +23 @@
 
 import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
 
 import org.hibernate.query.Query;
@@ -52 +54 @@
   private String pluginName;
   private String jobName;
+  private Map<Integer, String> projectNames;
   
   /**
@@ -179 +182 @@
 
   /**
+    Get the name of the project with the given id. 
+    Special cases: 0 = default
+  */
+  public String getProjectName(int projectId)
+  {
+    String name = null;
+    if (projectId > 0)
+    {
+      if (projectNames == null) 
+      {
+        projectNames = new HashMap<>();
+      }
+      else 
+      {
+        name = projectNames.get(projectId);
+      }
+      if (name == null)
+      {
+        Query<String> query = logControl.createHqlQuery("select prj.name from ProjectData prj where prj.id = " + projectId, String.class);
+        name = query.uniqueResult();
+        projectNames.put(projectId, name);
+      }
+    }
+    else
+    {
+      name = "default";
+    }
+    return name;
+  }
+  
+  /**
     Utility method for loading the name of the currently executing plugin.
     The first call to this method will lookup the name in the database

branches/3.19-stable/src/core/net/sf/basedb/core/log/db/AnnotationLogger.java

@@ -83 +83 @@
     Integer parentId = null;
     Integer parentType = null;
+    Integer projectId = null;
     Annotation.Source source = null;
     List<?> newValues = null;
@@ -105 +106 @@
         newValues = info.getNewValues();
       }
+      if (at.getProjectAnnotations()) projectId = info.getProjectId();
     }
     else if (entity instanceof AnnotationData)
@@ -120 +122 @@
         valueType = Type.fromValue((Integer)tmp[1]);
         if ((Boolean)tmp[2]) logOldPropertyValues = false;
+        if ((Boolean)tmp[3]) projectId = annotation.getProjectId();
       }
       else
@@ -125 +128 @@
         annotationType = at.getName();
         valueType = Type.fromValue(at.getValueType());
+        if (at.getProjectAnnotations()) projectId = annotation.getProjectId();
         if (at.getDisableLogOfValues()) logOldPropertyValues = false;
       }
@@ -190 +194 @@
     change.setItemType(parentType);
 
+    String projectInfo = "";
+    if (projectId != null)
+    {
+      String projectName = logControl.getTransactionDetails().getProjectName(projectId);
+      if (projectName != null) projectInfo = " ("+projectName+")";
+    }
     if (source == Annotation.Source.CLONED)
     {
-      change.setChangeInfo("ClonedAnnotation["+annotationType+"]");
+      change.setChangeInfo("ClonedAnnotation["+annotationType+projectInfo+"]");
     }
     else if (source == Annotation.Source.INHERITED)
     {
-      change.setChangeInfo("InheritedAnnotation["+annotationType+"]");
+      change.setChangeInfo("InheritedAnnotation["+annotationType+projectInfo+"]");
     }
     else
     {
-      change.setChangeInfo("Annotation["+annotationType+"]");
+      change.setChangeInfo("Annotation["+annotationType+projectInfo+"]");
     }
     if (logOldPropertyValues)