[391312] Provide per-CDOObject histories

https://bugs.eclipse.org/bugs/show_bug.cgi?id=391312

9 files changed, 196 insertions, 15 deletions

diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObject.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObject.java
index f6436a0f0f..d83e6e239c 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObject.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObject.java
@@ -28,7 +28,7 @@ import org.eclipse.emf.spi.cdo.InternalCDOObject;
  * properties and features of those objects.
  * <p>
  * Note that, by contract, every instance of CDOObject can also be cast to {@link InternalCDOObject}.
- * 
+ *
  * @author Eike Stepper
  * @apiviz.landmark
  * @apiviz.has {@link CDOState}
@@ -47,7 +47,7 @@ public interface CDOObject extends EObject, CDOWithID
    * If the state of this object is {@link CDOState#NEW NEW} the returned CDOID instance can be cast to
    * {@link CDOIDTemp} and is unique in the scope of the associated {@link #cdoView() transaction}. In all other states
    * a non-<code>null</code> return value uniquely identifies a persistent object in the scope of the whole repository.
-   * 
+   *
    * @see #cdoState()
    */
   public CDOID cdoID();
@@ -63,7 +63,7 @@ public interface CDOObject extends EObject, CDOWithID
    * <p>
    * This method is a convenience method to determine whether the {@link #cdoState() state} of this object is either
    * {@link CDOState#CONFLICT CONFLICT} or {@link CDOState#INVALID_CONFLICT INVALID_CONFLICT}.
-   * 
+   *
    * @since 2.0
    */
   public boolean cdoConflict();
@@ -74,7 +74,7 @@ public interface CDOObject extends EObject, CDOWithID
    * <p>
    * This method is a convenience method to determine whether the {@link #cdoState() state} of this object is either
    * {@link CDOState#INVALID INVALID} or {@link CDOState#INVALID_CONFLICT INVALID_CONFLICT}.
-   * 
+   *
    * @since 2.0
    */
   public boolean cdoInvalid();
@@ -82,7 +82,7 @@ public interface CDOObject extends EObject, CDOWithID
   /**
    * Returns the {@link CDOView view} this object is associated with, or <code>null</code> if this object is not
    * associated with a view. This view manages all aspects of this object and cahces it as long as required.
-   * 
+   *
    * @since 2.0
    */
   public CDOView cdoView();
@@ -101,7 +101,7 @@ public interface CDOObject extends EObject, CDOWithID
    * This method may not return <code>null</code> return for objects that have no {@link #cdoDirectResource() direct
    * resource}. Please note that, depending on the containment depth of this object, the evaluation of the resource can
    * be a costly operation.
-   * 
+   *
    * @see #cdoDirectResource()
    */
   public CDOResource cdoResource();
@@ -112,14 +112,14 @@ public interface CDOObject extends EObject, CDOWithID
    * <p>
    * Please note that, independend of the containment depth of this object, the evaluation of the direct resource is an
    * operation with a constant cost.
-   * 
+   *
    * @since 2.0
    */
   public CDOResource cdoDirectResource();
 
   /**
    * Returns the read lock associated with this object.
-   * 
+   *
    * @return Never <code>null</code>.
    * @since 2.0
    */
@@ -127,7 +127,7 @@ public interface CDOObject extends EObject, CDOWithID
 
   /**
    * Returns the write lock associated with this object.
-   * 
+   *
    * @return Never <code>null</code>.
    * @since 2.0
    */
@@ -143,14 +143,14 @@ public interface CDOObject extends EObject, CDOWithID
    * <p>
    * It thus allows a view to ensure that it is the only that who will be able to obtain a write lock in the future,
    * without preventing read locks to be obtained by others at this moment.
-   * 
+   *
    * @since 4.1
    */
   public CDOLock cdoWriteOption();
 
   /**
    * Returns the {@link CDOLockState} of this object.
-   * 
+   *
    * @since 4.1
    */
   public CDOLockState cdoLockState();
@@ -159,7 +159,7 @@ public interface CDOObject extends EObject, CDOWithID
    * Ensures that the revisions of the contained objects up to the given depth are in the local
    * {@link CDORevisionManager revision cache}. Subsequent access to the respective contained objects will not lead to
    * server round-trips after calling this method.
-   * 
+   *
    * @param depth
    *          {@link CDORevision#DEPTH_NONE}, {@link CDORevision#DEPTH_INFINITE} or any other positive integer number.
    * @since 3.0
@@ -170,4 +170,9 @@ public interface CDOObject extends EObject, CDOWithID
    * TODO: JavaDoc
    */
   public void cdoReload();
+
+  /**
+   * @since 4.2
+   */
+  public CDOObjectHistory cdoHistory();
 }
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObjectHistory.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObjectHistory.java
new file mode 100644
index 0000000000..5ba06fc4dc
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOObjectHistory.java
@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.emf.cdo;
+
+import org.eclipse.emf.cdo.common.commit.CDOCommitHistory;
+import org.eclipse.emf.cdo.common.commit.CDOCommitInfo;
+
+/**
+ * A cache for the {@link CDOCommitInfo commit infos} of an {@link CDOObject object}.
+ *
+ * @author Eike Stepper
+ * @since 4.2
+ */
+public interface CDOObjectHistory extends CDOCommitHistory
+{
+  public CDOObject getCDOObject();
+}
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDOPushTransaction.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDOPushTransaction.java
index 3e49faed29..cb1a099095 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDOPushTransaction.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDOPushTransaction.java
@@ -11,11 +11,13 @@
 package org.eclipse.emf.cdo.transaction;
 
 import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.CDOObjectHistory;
 import org.eclipse.emf.cdo.CDOObjectReference;
 import org.eclipse.emf.cdo.common.CDOCommonRepository;
 import org.eclipse.emf.cdo.common.branch.CDOBranch;
 import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
 import org.eclipse.emf.cdo.common.commit.CDOChangeSetData;
+import org.eclipse.emf.cdo.common.commit.CDOCommitHistory;
 import org.eclipse.emf.cdo.common.commit.CDOCommitInfo;
 import org.eclipse.emf.cdo.common.id.CDOID;
 import org.eclipse.emf.cdo.common.revision.CDORevision;
@@ -727,6 +729,22 @@ public class CDOPushTransaction extends Notifier implements CDOTransaction
     return delegate.compareRevisions(source);
   }
 
+  /**
+   * @since 4.2
+   */
+  public CDOCommitHistory getHistory()
+  {
+    return delegate.getHistory();
+  }
+
+  /**
+   * @since 4.2
+   */
+  public CDOObjectHistory getHistory(CDOObject object)
+  {
+    return delegate.getHistory(object);
+  }
+
   public CDOSavepoint setSavepoint()
   {
     return delegate.setSavepoint();
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java
index 50f003e91c..7c0510dafa 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java
@@ -16,11 +16,13 @@ import org.eclipse.emf.cdo.CDOAdapter;
 import org.eclipse.emf.cdo.CDOInvalidationNotification;
 import org.eclipse.emf.cdo.CDONotification;
 import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.CDOObjectHistory;
 import org.eclipse.emf.cdo.CDOObjectReference;
 import org.eclipse.emf.cdo.common.CDOCommonView;
 import org.eclipse.emf.cdo.common.branch.CDOBranch;
 import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
 import org.eclipse.emf.cdo.common.commit.CDOChangeSetData;
+import org.eclipse.emf.cdo.common.commit.CDOCommitHistory;
 import org.eclipse.emf.cdo.common.id.CDOID;
 import org.eclipse.emf.cdo.common.revision.CDORevision;
 import org.eclipse.emf.cdo.common.util.CDOException;
@@ -87,7 +89,8 @@ import java.util.Set;
  * @apiviz.uses {@link CDOViewLocksChangedEvent} - - fires
  * @apiviz.uses {@link CDOViewTargetChangedEvent} - - fires
  */
-public interface CDOView extends CDOCommonView, CDOUpdatable, INotifier
+public interface CDOView extends CDOCommonView, CDOUpdatable, CDOCommitHistory.Provider<CDOObject, CDOObjectHistory>,
+    INotifier
 {
   /**
    * Returns the {@link CDOSession session} this view was opened by.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/CDOObjectImpl.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/CDOObjectImpl.java
index 41c3237c20..d3d127c75f 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/CDOObjectImpl.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/CDOObjectImpl.java
@@ -13,6 +13,7 @@ package org.eclipse.emf.internal.cdo;
 
 import org.eclipse.emf.cdo.CDOLock;
 import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.CDOObjectHistory;
 import org.eclipse.emf.cdo.CDOState;
 import org.eclipse.emf.cdo.common.id.CDOID;
 import org.eclipse.emf.cdo.common.lock.CDOLockState;
@@ -165,6 +166,14 @@ public class CDOObjectImpl extends EStoreEObjectImpl implements InternalCDOObjec
   }
 
   /**
+   * @since 4.2
+   */
+  public CDOObjectHistory cdoHistory()
+  {
+    return view.getHistory(this);
+  }
+
+  /**
    * @since 2.0
    */
   public boolean cdoConflict()
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOExternalObject.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOExternalObject.java
index 7d806b4c2f..1c83dc47cf 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOExternalObject.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOExternalObject.java
@@ -11,6 +11,7 @@
 package org.eclipse.emf.internal.cdo.object;
 
 import org.eclipse.emf.cdo.CDOLock;
+import org.eclipse.emf.cdo.CDOObjectHistory;
 import org.eclipse.emf.cdo.CDOState;
 import org.eclipse.emf.cdo.common.lock.CDOLockState;
 import org.eclipse.emf.cdo.common.revision.CDORevision;
@@ -64,4 +65,9 @@ public class CDOExternalObject extends CDOObjectWrapperBase
   {
     // Do nothing
   }
+
+  public CDOObjectHistory cdoHistory()
+  {
+    return null;
+  }
 }
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOLegacyWrapper.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOLegacyWrapper.java
index 3568f1e090..556cfa85f8 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOLegacyWrapper.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/object/CDOLegacyWrapper.java
@@ -12,6 +12,7 @@
 package org.eclipse.emf.internal.cdo.object;
 
 import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.CDOObjectHistory;
 import org.eclipse.emf.cdo.CDOState;
 import org.eclipse.emf.cdo.common.id.CDOID;
 import org.eclipse.emf.cdo.common.model.CDOModelUtil;
@@ -133,6 +134,11 @@ public abstract class CDOLegacyWrapper extends CDOObjectWrapper
     CDOStateMachine.INSTANCE.reload(this);
   }
 
+  public CDOObjectHistory cdoHistory()
+  {
+    return view.getHistory(this);
+  }
+
   public CDOState cdoInternalSetState(CDOState state)
   {
     if (this.state != state)
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/AbstractCDOView.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/AbstractCDOView.java
index 2d94d780a2..14bf61f6a9 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/AbstractCDOView.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/AbstractCDOView.java
@@ -13,11 +13,14 @@
 package org.eclipse.emf.internal.cdo.view;
 
 import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.CDOObjectHistory;
 import org.eclipse.emf.cdo.CDOObjectReference;
 import org.eclipse.emf.cdo.CDOState;
 import org.eclipse.emf.cdo.common.branch.CDOBranch;
 import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
 import org.eclipse.emf.cdo.common.commit.CDOChangeSetData;
+import org.eclipse.emf.cdo.common.commit.CDOCommitHistory;
+import org.eclipse.emf.cdo.common.commit.CDOCommitInfoManager;
 import org.eclipse.emf.cdo.common.id.CDOID;
 import org.eclipse.emf.cdo.common.id.CDOIDExternal;
 import org.eclipse.emf.cdo.common.id.CDOIDUtil;
@@ -39,6 +42,7 @@ import org.eclipse.emf.cdo.eresource.CDOResourceNode;
 import org.eclipse.emf.cdo.eresource.CDOTextResource;
 import org.eclipse.emf.cdo.eresource.EresourcePackage;
 import org.eclipse.emf.cdo.eresource.impl.CDOResourceImpl;
+import org.eclipse.emf.cdo.internal.common.commit.CDOCommitHistoryProviderImpl;
 import org.eclipse.emf.cdo.internal.common.revision.delta.CDORevisionDeltaImpl;
 import org.eclipse.emf.cdo.session.CDOSession;
 import org.eclipse.emf.cdo.spi.common.branch.CDOBranchUtil;
@@ -70,7 +74,6 @@ import org.eclipse.net4j.util.collection.CloseableIterator;
 import org.eclipse.net4j.util.collection.ConcurrentArray;
 import org.eclipse.net4j.util.collection.Pair;
 import org.eclipse.net4j.util.event.IListener;
-import org.eclipse.net4j.util.lifecycle.Lifecycle;
 import org.eclipse.net4j.util.lifecycle.LifecycleUtil;
 import org.eclipse.net4j.util.om.log.OMLogger;
 import org.eclipse.net4j.util.om.trace.ContextTracer;
@@ -105,7 +108,8 @@ import java.util.Set;
 /**
  * @author Eike Stepper
  */
-public abstract class AbstractCDOView extends Lifecycle implements InternalCDOView
+public abstract class AbstractCDOView extends CDOCommitHistoryProviderImpl<CDOObject, CDOObjectHistory> implements
+    InternalCDOView
 {
   private static final ContextTracer TRACER = new ContextTracer(OM.DEBUG_VIEW, AbstractCDOView.class);
 
@@ -1553,6 +1557,20 @@ public abstract class AbstractCDOView extends Lifecycle implements InternalCDOVi
   }
 
   @Override
+  public CDOCommitHistory getHistory()
+  {
+    CDOBranch branch = getBranch();
+    CDOCommitInfoManager commitInfoManager = getSession().getCommitInfoManager();
+    return commitInfoManager.getHistory(branch);
+  }
+
+  @Override
+  protected CDOCommitHistory createHistory(CDOObject key)
+  {
+    return new CDOObjectHistoryImpl(key);
+  }
+
+  @Override
   protected void doDeactivate() throws Exception
   {
     viewSet = null;
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/CDOObjectHistoryImpl.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/CDOObjectHistoryImpl.java
new file mode 100644
index 0000000000..dc3baf14eb
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/internal/cdo/view/CDOObjectHistoryImpl.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Eike Stepper - initial API and implementation
+ */
+package org.eclipse.emf.internal.cdo.view;
+
+import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.CDOObjectHistory;
+import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
+import org.eclipse.emf.cdo.common.branch.CDOBranchVersion;
+import org.eclipse.emf.cdo.common.commit.CDOCommitInfo;
+import org.eclipse.emf.cdo.common.revision.CDORevision;
+import org.eclipse.emf.cdo.common.revision.CDORevisionManager;
+import org.eclipse.emf.cdo.internal.common.commit.CDOCommitHistoryImpl;
+
+/**
+ * A cache for the {@link CDOCommitInfo commit infos} of a branch or of an entire repository.
+ *
+ * @author Eike Stepper
+ * @since 4.2
+ */
+public class CDOObjectHistoryImpl extends CDOCommitHistoryImpl implements CDOObjectHistory
+{
+  private final CDORevisionManager revisionManager;
+
+  private final CDOObject object;
+
+  private CDORevision loadedRevision;
+
+  public CDOObjectHistoryImpl(CDOObject object)
+  {
+    super(object.cdoView().getSession().getCommitInfoManager(), object.cdoRevision().getBranch());
+    revisionManager = object.cdoView().getSession().getRevisionManager();
+    this.object = object;
+  }
+
+  public CDOObject getCDOObject()
+  {
+    return object;
+  }
+
+  @Override
+  protected void doLoadCommitInfos()
+  {
+    int count = getLoadCount();
+    for (int i = 0; i < count; i++)
+    {
+      if (loadedRevision == null)
+      {
+        loadedRevision = object.cdoRevision();
+      }
+      else
+      {
+        int version = loadedRevision.getVersion();
+        if (version > CDOBranchVersion.FIRST_VERSION)
+        {
+          CDOBranchVersion previous = loadedRevision.getBranch().getVersion(version - 1);
+          loadedRevision = revisionManager.getRevisionByVersion(object.cdoID(), previous, CDORevision.UNCHUNKED, true);
+        }
+        else
+        {
+          CDOBranchPoint base = loadedRevision.getBranch().getBase();
+          if (base.getBranch() == null)
+          {
+            // Reached repository creation
+            break;
+          }
+
+          CDORevision revision = revisionManager.getRevision(object.cdoID(), base, CDORevision.UNCHUNKED,
+              CDORevision.DEPTH_NONE, true);
+          if (revision == null)
+          {
+            // Reached branch where the object does not exist
+            break;
+          }
+
+          loadedRevision = revision;
+        }
+      }
+
+      CDOCommitInfo commitInfo = getManager().getCommitInfo(loadedRevision.getTimeStamp());
+      handleCommitInfo(commitInfo);
+    }
+  }
+}