Changeset 5052

Timestamp:

Aug 18, 2009, 8:47:26 AM (14 years ago)

Author:

Nicklas Nordborg

Message:

References #108: Logging the change history of an item

• Added option to include a list with the modified properties in the change log
• Added special logger implementation for biomaterial events

Location:

trunk

Files:

• config/dist/base.config (modified) (1 diff)
• src/core/net/sf/basedb/core/data/BioMaterialEventData.java (modified) (1 diff)
• src/core/net/sf/basedb/core/log/EntityDetails.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/log/db/BioMaterialEventLogger.java (added)
• src/core/net/sf/basedb/core/log/db/DbLogManagerFactory.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/log/db/DefaultEntityLogger.java (modified) (2 diffs)

trunk/config/dist/base.config

@@ -149 +149 @@
 # If the "Change history" tab should be visible in the web interface 
 # or not. It is hidden by default.
-# changelog.show-in-web = false
+# changelog.show-in-web = true
+
+# If DB logger should log detailed information about which properties
+# that has been updated (default: false)
+# changelog.dblogger.detailed-properties = true
 
 # ===============

trunk/src/core/net/sf/basedb/core/data/BioMaterialEventData.java

@@ -40 +40 @@
 public class BioMaterialEventData
   extends BasicData
-  implements RegisteredData
+  implements RegisteredData, LoggableData
 {
 

trunk/src/core/net/sf/basedb/core/log/EntityDetails.java

@@ -26 +26 @@
 import net.sf.basedb.core.data.ChangeHistoryDetailData;
 
+import org.hibernate.EntityMode;
 import org.hibernate.type.Type;
+import org.hibernate.type.VersionType;
 
 /**
@@ -125 +127 @@
   
   /**
+    Get all modified properties as a string, separating each
+    property name with the given separator.
+    @param prefix A string that is added first in the result, or null
+    @param separator A separator string (if null, comma is used)
+    @param suffix A string that is added last in the result, or null
+    @return A string with the modified properties, or null
+      if this is a CREATE or DELETE change or if no modified 
+      properties was found
+  */
+  public String getModifiedProperties(String prefix, String separator, String suffix)
+  {
+    if (changeType != ChangeType.UPDATE) return null;
+    
+    StringBuilder modified = new StringBuilder();
+    if (prefix != null) modified.append(prefix);
+    if (separator == null) separator = ",";
+    String s = "";
+    int numModified = 0;
+    for (int i = 0; i < types.length; ++i)
+    {
+      Type t = types[i];
+      if (!t.isCollectionType() && !(t instanceof VersionType))
+      {
+        Object c = state[i];
+        Object o = previousState[i];
+        if (!t.isEqual(c, o, EntityMode.POJO))
+        {
+          modified.append(s).append(properties[i]);
+          s = separator;
+          numModified++;
+        }
+      }
+    }
+    if (suffix != null) modified.append(suffix);
+    return numModified == 0 ? null : modified.toString();
+  }
+  
+  /**
     Create a new ChangeHistoryDetailData object from the information
     in this object assuming that the entity is a subclass of
     {@link BasicData}.
+    @param detailedProperties If TRUE, the {@link ChangeHistoryDetailData#getChangeInfo()}
+      is populated with a list of the names of the modified properties (only
+      relevant for UPDATE changes)
     @return A new ChangeHistoryDetailData instance
   */
-  public ChangeHistoryDetailData toChangeHistoryDetailData()
+  public ChangeHistoryDetailData toChangeHistoryDetailData(boolean detailedProperties)
+  {
+    return toChangeHistoryDetailData((BasicData)entity, changeType, detailedProperties);
+  }
+
+  /**
+    Create a new ChangeHistoryDetailData object using a mix of the information
+    in this object, and the given parameters.
+    @param data The entity that was changed
+    @param changeType The change type
+    @param detailedProperties If TRUE, the {@link ChangeHistoryDetailData#getChangeInfo()}
+      is populated with a list of the names of the modified properties (only
+      relevant for UPDATE changes)
+    @return  A new ChangeHistoryDetailData instance
+  */
+  public ChangeHistoryDetailData toChangeHistoryDetailData(BasicData data, ChangeType changeType, boolean detailedProperties)
   {
     ChangeHistoryDetailData details = new ChangeHistoryDetailData();
-    BasicData data = (BasicData)entity;
     details.setChangeType(changeType.getValue());
     details.setItemId(data.getId());
     details.setItemType(Item.fromDataObject(data).getValue());
+    if (detailedProperties)
+    {
+      details.setChangeInfo(getModifiedProperties("Updated: ", ", ", null));
+    }
     return details;
   }

trunk/src/core/net/sf/basedb/core/log/db/DbLogManagerFactory.java

@@ -25 +25 @@
 import java.util.Map;
 
+import net.sf.basedb.core.Config;
 import net.sf.basedb.core.LogControl;
+import net.sf.basedb.core.data.BioMaterialEventData;
 import net.sf.basedb.core.data.LoggableData;
 import net.sf.basedb.core.log.EntityLogger;
@@ -46 +48 @@
   private final Map<Class, EntityLogger> specialLoggers;
   private final DefaultEntityLogger defaultLogger;
-  
+  private final boolean detailedProperties;
   
   public DbLogManagerFactory()
   {
     this.specialLoggers = new HashMap<Class, EntityLogger>();
-    this.defaultLogger = new DefaultEntityLogger();
+    this.detailedProperties = Config.getBoolean("changelog.dblogger.detailed-properties");
+    this.defaultLogger = new DefaultEntityLogger(detailedProperties);
+    setSpecialLogger(BioMaterialEventData.class, new BioMaterialEventLogger(detailedProperties));
     //setSpecialLogger(AnnotationData.class, new AnnotationLogger());
   }

trunk/src/core/net/sf/basedb/core/log/db/DefaultEntityLogger.java

@@ -40 +40 @@
 {
 
-  public DefaultEntityLogger()
-  {}
+  private final boolean detailedProperties;
+  
+  /**
+    Creates a new entity logger.
+    @param detailedProperties If TRUE, the log includes a list with
+      the properties that was modified
+  */
+  public DefaultEntityLogger(boolean detailedProperties)
+  {
+    this.detailedProperties = detailedProperties;
+  }
   
   /*
@@ -55 +64 @@
   {
     DbLogManager dbLogManager = (DbLogManager)logManager;
-    ChangeHistoryDetailData change = details.toChangeHistoryDetailData();
+    ChangeHistoryDetailData change = details.toChangeHistoryDetailData(detailedProperties);
     dbLogManager.logChangeDetails(change);
   }