org.apache.jackrabbit.oak.plugins.document.NodeDocument Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.oak.plugins.document;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.NavigableMap;
import java.util.Queue;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.collect.AbstractIterator;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterators;
import com.google.common.collect.Lists;
import com.google.common.collect.Ordering;
import com.google.common.collect.Queues;
import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.cache.CacheValue;
import org.apache.jackrabbit.oak.commons.PathUtils;
import org.apache.jackrabbit.oak.commons.json.JsopBuilder;
import org.apache.jackrabbit.oak.commons.json.JsopReader;
import org.apache.jackrabbit.oak.commons.json.JsopTokenizer;
import org.apache.jackrabbit.oak.commons.json.JsopWriter;
import org.apache.jackrabbit.oak.plugins.document.memory.MemoryDocumentStore;
import org.apache.jackrabbit.oak.plugins.document.util.MergeSortedIterators;
import org.apache.jackrabbit.oak.plugins.document.util.Utils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.collect.Iterables;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import static com.google.common.base.Objects.equal;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.collect.ImmutableList.copyOf;
import static com.google.common.collect.Iterables.concat;
import static com.google.common.collect.Iterables.filter;
import static com.google.common.collect.Iterables.mergeSorted;
import static com.google.common.collect.Iterables.transform;
import static org.apache.jackrabbit.oak.plugins.document.Collection.NODES;
import static org.apache.jackrabbit.oak.plugins.document.StableRevisionComparator.REVERSE;
import static org.apache.jackrabbit.oak.plugins.document.UpdateOp.Key;
import static org.apache.jackrabbit.oak.plugins.document.UpdateOp.Operation;
import static org.apache.jackrabbit.oak.plugins.document.util.Utils.abortingIterable;
import static org.apache.jackrabbit.oak.plugins.document.util.Utils.resolveCommitRevision;
/**
* A document storing data about a node.
*/
public final class NodeDocument extends Document {
/**
* Marker document, which indicates the document does not exist.
*/
public static final NodeDocument NULL = new NodeDocument(new MemoryDocumentStore());
static {
NULL.seal();
}
static final Logger LOG = LoggerFactory.getLogger(NodeDocument.class);
/**
* All NodeDocument ID value would be greater than this value
* It can be used as startKey in DocumentStore#query methods
*/
public static final String MIN_ID_VALUE = "0000000";
/**
* All NodeDocument ID value would be less than this value
* It can be used as endKey in DocumentStore#query methods
*/
public static final String MAX_ID_VALUE = ";";
/**
* A size threshold after which to consider a document a split candidate.
* TODO: check which value is the best one
*/
static final int SPLIT_CANDIDATE_THRESHOLD = 8 * 1024;
/**
* A document size threshold after which a split is forced even if
* {@link #NUM_REVS_THRESHOLD} is not reached.
*/
static final int DOC_SIZE_THRESHOLD = 1024 * 1024;
/**
* Only split off at least this number of revisions.
*/
static final int NUM_REVS_THRESHOLD = 100;
/**
* Create an intermediate previous document when there are this many
* previous documents of equal height.
*/
static final int PREV_SPLIT_FACTOR = 10;
/**
* Revision collision markers set by commits with modifications, which
* overlap with un-merged branch commits.
* Key: revision, value: always true
*/
public static final String COLLISIONS = "_collisions";
/**
* The modified time in seconds (5 second resolution).
*/
public static final String MODIFIED_IN_SECS = "_modified";
/**
* The resolution of the modified time.
*/
static final int MODIFIED_IN_SECS_RESOLUTION = 5;
private static final NavigableMap EMPTY_RANGE_MAP =
Maps.unmodifiableNavigableMap(new TreeMap());
/**
* The list of revision to root commit depth mappings to find out if a
* revision is actually committed. Depth 0 means the commit is in the root node,
* depth 1 means one node below the root, and so on.
*/
static final String COMMIT_ROOT = "_commitRoot";
/**
* The number of previous documents (documents that contain old revisions of
* this node). This property is only set if multiple documents per node
* exist. This is the case when a node is updated very often in a short
* time, such that the document gets very big.
*
* Key: high revision
*
* Value: low revision / height (see {@link Range#getLowValue()}
*/
private static final String PREVIOUS = "_prev";
/**
* Whether this node is deleted. Key: revision, value: true/false.
*/
private static final String DELETED = "_deleted";
/**
* Flag indicating that whether this node was ever deleted. Its just used as
* a hint. If set to true then it indicates that node was once deleted.
*
* Note that a true value does not mean that node should be considered
* deleted as it might have been resurrected in later revision. Further note
* that it might get reset by maintenance tasks once they discover that it
* indeed was resurrected.
*/
public static final String DELETED_ONCE = "_deletedOnce";
/**
* The list of recent revisions for this node, where this node is the
* root of the commit.
*
* Key: revision.
*
* Value: "c" for a regular (non-branch) commit,
* "c-" + base revision of the successfully merged branch commit,
* "b" + base revision of an un-merged branch commit
*/
static final String REVISIONS = "_revisions";
/**
* The last revision.
*
* Key: machine id, in the form "r0-0-1".
*
* Value: the revision.
*/
private static final String LAST_REV = "_lastRev";
/**
* Flag indicating that there are child nodes present. Its just used as a hint.
* If false then that indicates that there are no child. However if its true its
* not necessary that there are child nodes. It just means at some moment this
* node had a child node
*/
private static final String CHILDREN_FLAG = "_children";
/**
* The node path, in case the id can not be converted to a path.
*/
public static final String PATH = "_path";
public static final String HAS_BINARY_FLAG = "_bin";
/**
* Contains {@link #PREVIOUS} entries that are considered stale (pointing
* to a previous document that had been deleted) and should be removed
* during the next split run.
*/
private static final String STALE_PREV = "_stalePrev";
/**
* Contains revision entries for changes done by branch commits.
*/
private static final String BRANCH_COMMITS = "_bc";
/**
* The revision set by the background document sweeper. The revision
* indicates up to which revision documents have been cleaned by the sweeper
* and all previous non-branch revisions by this cluster node can be
* considered committed.
*/
private static final String SWEEP_REV = "_sweepRev";
//~----------------------------< Split Document Types >
/**
* Defines the type of split document. Its value is an integer whose value is
* defined as per
*
* @see org.apache.jackrabbit.oak.plugins.document.NodeDocument.SplitDocType
*/
public static final String SD_TYPE = "_sdType";
/**
* Property name which refers to timestamp (long) of the latest revision kept
* in the document
*/
public static final String SD_MAX_REV_TIME_IN_SECS = "_sdMaxRevTime";
/**
* Return time in seconds with 5 second resolution
*
* @param timestamp time in millis to convert
* @return the time in seconds with the given resolution.
*/
public static long getModifiedInSecs(long timestamp) {
// 5 second resolution
long timeInSec = TimeUnit.MILLISECONDS.toSeconds(timestamp);
return timeInSec - timeInSec % MODIFIED_IN_SECS_RESOLUTION;
}
/**
* A document which is created from splitting a main document can be classified
* into multiple types depending on the content i.e. weather it contains
* REVISIONS, COMMIT_ROOT, property history etc
*/
public enum SplitDocType {
/**
* Not a split document
*/
NONE(-1),
/**
* A split document which contains all types of data
*/
DEFAULT(10),
/**
* A split document which contains all types of data. In addition
* when the split document was created the main document did not had
* any child.
* This type is deprecated because these kind of documents cannot be
* garbage collected independently. The main document may still
* reference _commitRoot entries in the previous document. See OAK-1794
*/
@Deprecated
DEFAULT_NO_CHILD(20),
/**
* A split document which does not contain REVISIONS history.
* This type is deprecated because these kind of documents cannot be
* garbage collected independently. The main document may still
* reference _commitRoot entries in the previous document. See OAK-1794
*/
@Deprecated
PROP_COMMIT_ONLY(30),
/**
* Its an intermediate split document which only contains version ranges
* and does not contain any other attributes
*/
INTERMEDIATE(40),
/**
* A split document which contains all types of data. In addition
* when the split document was created the main document did not had
* any child.
*/
DEFAULT_LEAF(50),
/**
* A split document which does not contain REVISIONS history.
*/
COMMIT_ROOT_ONLY(60),
/**
* A split document which contains all types of data, but no branch
* commits.
*/
DEFAULT_NO_BRANCH(70),
;
final int type;
SplitDocType(int type){
this.type = type;
}
public int typeCode() {
return type;
}
static SplitDocType valueOf(Integer type){
if(type == null){
return NONE;
}
for(SplitDocType docType : values()){
if(docType.type == type){
return docType;
}
}
throw new IllegalArgumentException("Not a valid SplitDocType :" + type);
}
}
public static final long HAS_BINARY_VAL = 1;
final DocumentStore store;
/**
* Parsed and sorted set of previous revisions (without stale references
* to removed previous documents).
*/
private NavigableMap previous;
/**
* Time at which this object was check for cache consistency
*/
private final AtomicLong lastCheckTime = new AtomicLong(Revision.getCurrentTimestamp());
private final long creationTime;
NodeDocument(@Nonnull DocumentStore store) {
this(store, Revision.getCurrentTimestamp());
}
/**
* Required for serialization
*
* @param store the document store.
* @param creationTime time at which it was created. Would be different from current time
* in case of being resurrected from a serialized for
*/
public NodeDocument(@Nonnull DocumentStore store, long creationTime) {
this.store = checkNotNull(store);
this.creationTime = creationTime;
}
/**
* Gets the value map for the given key. This method is similar to {@link
* #get(String)} but will always return a value map. The returned value map
* may span multiple documents if the values of the given key
* were split off to {@link #PREVIOUS} documents.
*
* @param key a string key.
* @return the map associated with the key.
*/
@Nonnull
public Map getValueMap(@Nonnull String key) {
return ValueMap.create(this, key);
}
/**
* @return the system time this object was created.
*/
public long getCreated() {
return creationTime;
}
/**
* See also {@link #MODIFIED_IN_SECS}.
*
* @return the time in seconds this document was last modified with five
* seconds precision. Returns {@code null} if none is set.
*/
@CheckForNull
public Long getModified() {
return (Long) get(MODIFIED_IN_SECS);
}
/**
* Returns true if this node possibly has children.
* If false then that indicates that there are no child
*
* @return true if this node has children
*/
public boolean hasChildren() {
Boolean childrenFlag = (Boolean) get(CHILDREN_FLAG);
return childrenFlag != null && childrenFlag;
}
/**
* Returns true if this document was ever deleted in past.
*/
public boolean wasDeletedOnce() {
Boolean deletedOnceFlag = (Boolean) get(DELETED_ONCE);
return deletedOnceFlag != null && deletedOnceFlag;
}
/**
* Checks if this document has been modified after the given lastModifiedTime
*
* @param lastModifiedTime time to compare against in millis
* @return true if this document was modified after the given
* lastModifiedTime
*/
public boolean hasBeenModifiedSince(long lastModifiedTime){
Long modified = (Long) get(MODIFIED_IN_SECS);
return modified != null && modified > TimeUnit.MILLISECONDS.toSeconds(lastModifiedTime);
}
/**
* Checks if revision time of all entries in this document is less than the passed
* time
*
* @param maxRevisionTime timemstamp (in millis) of revision to check
* @return true if timestamp of maximum revision stored in this document
* is less than than the passed revision timestamp
*/
public boolean hasAllRevisionLessThan(long maxRevisionTime){
Long maxRevTimeStamp = (Long) get(SD_MAX_REV_TIME_IN_SECS);
return maxRevTimeStamp != null && maxRevTimeStamp < TimeUnit.MILLISECONDS.toSeconds(maxRevisionTime);
}
/**
* Determines if this document is a split document
*
* @return true if this document is a split document
*/
public boolean isSplitDocument(){
return getSplitDocType() != SplitDocType.NONE;
}
/**
* Determines the type of split document
*
* @return type of Split Document
*/
public SplitDocType getSplitDocType() {
Object t = get(SD_TYPE);
return t == null ? SplitDocType.valueOf((Integer) null) : SplitDocType.valueOf(((Number) t).intValue());
}
/**
* Mark this instance as up-to-date (matches the state in persistence
* store).
*
* @param checkTime time at which the check was performed
*/
public void markUpToDate(long checkTime) {
lastCheckTime.set(checkTime);
}
/**
* Returns the last time when this object was checked for consistency.
*
* @return the last check time
*/
public long getLastCheckTime() {
return lastCheckTime.get();
}
public boolean hasBinary() {
Number flag = (Number) get(HAS_BINARY_FLAG);
return flag != null && flag.intValue() == HAS_BINARY_VAL;
}
/**
* Returns the path of the main document if this document is part of a _prev
* history tree. Otherwise this method simply returns {@link #getPath()}.
*
* @return the path of the main document.
*/
@Nonnull
public String getMainPath() {
String p = getPath();
if (p.startsWith("p")) {
p = PathUtils.getAncestorPath(p, 2);
if (p.length() == 1) {
return "/";
} else {
return p.substring(1);
}
} else {
return p;
}
}
/**
* @return a map of the last known revision for each clusterId.
*/
@Nonnull
public Map getLastRev() {
Map map = Maps.newHashMap();
Map valueMap = getLocalMap(LAST_REV);
for (Map.Entry e : valueMap.entrySet()) {
int clusterId = e.getKey().getClusterId();
Revision rev = Revision.fromString(e.getValue());
map.put(clusterId, rev);
}
return map;
}
/**
* Returns true if this document contains an entry for the
* given revision in the {@link #REVISIONS} map. Please note
* that an entry in the {@link #REVISIONS} map does not necessarily mean
* the the revision is committed.
* Use {@link RevisionContext#getCommitValue(Revision, NodeDocument)} to get
* the commit state of a revision.
*
* @param revision the revision to check.
* @return true if this document contains the given revision.
*/
public boolean containsRevision(@Nonnull Revision revision) {
if (getLocalRevisions().containsKey(revision)) {
return true;
}
for (NodeDocument prev : getPreviousDocs(REVISIONS, revision)) {
if (prev.containsRevision(revision)) {
return true;
}
}
return false;
}
/**
* Purge the uncommitted revisions of this document with the
* local cluster node id as returned by the {@link RevisionContext}. These
* are the {@link #REVISIONS} entries where {@link Utils#isCommitted(String)}
* returns false.
*
*
* Note - This method should only be invoked upon startup
* as then only we can safely assume that these revisions would not be
* committed
*
*
* @param context the revision context.
* @return count of the revision entries purged
*/
int purgeUncommittedRevisions(RevisionContext context) {
// only look at revisions in this document.
// uncommitted revisions are not split off
Map valueMap = getLocalRevisions();
UpdateOp op = new UpdateOp(getId(), false);
int purgeCount = 0;
for (Map.Entry commit : valueMap.entrySet()) {
if (!Utils.isCommitted(commit.getValue())) {
Revision r = commit.getKey();
if (r.getClusterId() == context.getClusterId()) {
purgeCount++;
op.removeMapEntry(REVISIONS, r);
}
}
}
if (op.hasChanges()) {
store.findAndUpdate(Collection.NODES, op);
}
return purgeCount;
}
/**
* Purge collision markers with the local clusterId on this document. Use
* only on start when there are no ongoing or pending commits.
*
* @param context the revision context.
* @return the number of removed collision markers.
*/
int purgeCollisionMarkers(RevisionContext context) {
Map valueMap = getLocalMap(COLLISIONS);
UpdateOp op = new UpdateOp(getId(), false);
int purgeCount = 0;
for (Map.Entry commit : valueMap.entrySet()) {
Revision r = commit.getKey();
if (r.getClusterId() == context.getClusterId()) {
purgeCount++;
removeCollision(op, r);
}
}
if (op.hasChanges()) {
store.findAndUpdate(Collection.NODES, op);
}
return purgeCount;
}
/**
* Returns the conflicts on the given {@code changes} if there are any. The
* returned revisions are the commits, which created the collision markers
* for one of the {@code changes}.
*
* @param changes the changes to check.
* @return the conflict revisions.
*/
@Nonnull
Set getConflictsFor(@Nonnull Iterable changes) {
checkNotNull(changes);
Set conflicts = Sets.newHashSet();
Map collisions = getLocalMap(COLLISIONS);
for (Revision r : changes) {
String value = collisions.get(r.asTrunkRevision());
if (value == null) {
continue;
}
try {
conflicts.add(Revision.fromString(value));
} catch (IllegalArgumentException e) {
// backward compatibility: collision marker with value 'true'
}
}
return conflicts;
}
/**
* Returns the commit root path for the given revision or
* null if this document does not have a commit root entry for
* the given revision.
*
* @param revision a revision.
* @return the commit root path or null.
*/
@CheckForNull
public String getCommitRootPath(Revision revision) {
String depth = getCommitRootDepth(revision);
if (depth != null) {
return getPathAtDepth(depth);
}
return null;
}
/**
* Get the revision of the latest change made to this node. At the same
* time this method collects all collisions that happened for the given
* {@code changeRev}. The reported latest change takes branches into
* account. This means, if {@code changeRev} is on a branch, the latest
* change is either a change that was done by a preceding branch commit or
* a change that happened before the base of the branch. Changes done after
* the branch base on trunk are not considered in this case. For a trunk
* commit the latest change is reported similarly. In this case, unmerged
* branch commits are not considered as latest change. Only commits to trunk
* are considered.
*
* Collisions include the following cases:
*
* - The other change is not yet committed
* - The other change is a branch commit and not yet merged
* - The {@code changeRev} is a branch commit and the other change
* happened after the base revision of the branch
* - The other change is from another cluster node and not yet
* visible
*
*
* @param context the revision context.
* @param baseRev the base revision of the current change.
* @param changeRev the revision of the current change.
* @param branch the branch associated with the current change or
* {@code null} if {@code changeRev} is not a branch commit.
* @param collisions changes that happened after {@code baseRev}.
*/
@CheckForNull
Revision getNewestRevision(final RevisionContext context,
final RevisionVector baseRev,
final Revision changeRev,
final Branch branch,
final Set collisions) {
checkArgument(!baseRev.isBranch() || branch != null,
"Branch must be non-null if baseRev is a branch revision");
RevisionVector head = context.getHeadRevision();
RevisionVector lower = branch != null ? branch.getBase() : baseRev;
// the clusterIds to check when walking the changes
Set clusterIds = Collections.emptySet();
if (!getPreviousRanges().isEmpty()) {
clusterIds = Sets.newHashSet();
for (Revision prevRev : getPreviousRanges().keySet()) {
if (lower.isRevisionNewer(prevRev) ||
equal(prevRev, lower.getRevision(prevRev.getClusterId()))) {
clusterIds.add(prevRev.getClusterId());
}
}
if (!clusterIds.isEmpty()) {
// add clusterIds of local changes as well
for (Revision r : getLocalCommitRoot().keySet()) {
clusterIds.add(r.getClusterId());
}
for (Revision r : getLocalRevisions().keySet()) {
clusterIds.add(r.getClusterId());
}
}
}
// if we don't have clusterIds, we can use the local changes only
boolean fullScan = true;
Iterable changes = Iterables.mergeSorted(
ImmutableList.of(
getLocalRevisions().keySet(),
getLocalCommitRoot().keySet()),
getLocalRevisions().comparator()
);
if (!clusterIds.isEmpty()) {
// there are some previous documents that potentially
// contain changes after 'lower' revision vector
// include previous documents as well (only needed in rare cases)
fullScan = false;
changes = Iterables.mergeSorted(
ImmutableList.of(
changes,
getChanges(REVISIONS, lower),
getChanges(COMMIT_ROOT, lower)
), getLocalRevisions().comparator()
);
if (LOG.isDebugEnabled()) {
LOG.debug("getNewestRevision() with changeRev {} on {}, " +
"_revisions {}, _commitRoot {}",
changeRev, getId(), getLocalRevisions(), getLocalCommitRoot());
}
}
Map newestRevs = Maps.newHashMap();
Map validRevisions = Maps.newHashMap();
for (Revision r : changes) {
if (r.equals(changeRev)) {
continue;
}
if (!fullScan) {
// check if we can stop going through changes
if (clusterIds.contains(r.getClusterId())
&& !lower.isRevisionNewer(r)
&& newestRevs.containsKey(r.getClusterId())) {
clusterIds.remove(r.getClusterId());
if (clusterIds.isEmpty()) {
// all remaining revisions are older than
// the lower bound
break;
}
}
}
if (newestRevs.containsKey(r.getClusterId())) {
// we already found the newest revision for this clusterId
// from a baseRev point of view
// we still need to find collisions up to the base
// of the branch if this is for a commit on a branch
if (branch != null && !branch.containsCommit(r)) {
// change does not belong to the branch
if (branch.getBase(changeRev).isRevisionNewer(r)) {
// and happened after the base of the branch
collisions.add(r);
}
}
} else {
// we don't yet have the newest committed change
// for this clusterId
// check if change is visible from baseRev
if (isValidRevision(context, r, null, baseRev, validRevisions)) {
// consider for newestRev
newestRevs.put(r.getClusterId(), r);
} else {
// not valid means:
// 1) 'r' is not committed -> collision
// 2) 'r' is on a branch, but not the same as
// changeRev -> collisions
// 3) changeRev is on a branch and 'r' is newer than
// the base of the branch -> collision
// 4) 'r' is committed but not yet visible to current
// cluster node -> collisions
// 5) changeRev is not on a branch, 'r' is committed and
// newer than baseRev -> newestRev
Revision commitRevision = null;
String cv = context.getCommitValue(r, this);
if (Utils.isCommitted(cv)) {
commitRevision = resolveCommitRevision(r, cv);
}
if (commitRevision != null // committed but not yet visible
&& head.isRevisionNewer(commitRevision)) {
// case 4)
collisions.add(r);
} else if (commitRevision != null // committed
&& branch == null // changeRev not on branch
&& baseRev.isRevisionNewer(r)) {
// case 5)
newestRevs.put(r.getClusterId(), r);
} else {
// remaining cases 1), 2) and 3)
collisions.add(r);
}
}
}
}
// select the newest committed change
Revision newestRev = null;
for (Revision r : newestRevs.values()) {
newestRev = Utils.max(newestRev, r, StableRevisionComparator.INSTANCE);
}
if (newestRev == null) {
return null;
}
// the local deleted map contains the most recent revisions
SortedMap deleted = getLocalDeleted();
String value = deleted.get(newestRev);
if (value == null && deleted.headMap(newestRev).isEmpty()) {
// newestRev is newer than most recent entry in local deleted
// no need to check previous docs
return newestRev;
}
if (value == null) {
// get from complete map
value = getDeleted().get(newestRev);
}
if ("true".equals(value)) {
// deleted in the newest revision
return null;
}
return newestRev;
}
/**
* Checks if the revision is valid for the given document. A revision is
* considered valid if the given document is the root of the commit, or the
* commit root has the revision set. This method may read further documents
* to perform this check.
* This method also takes pending branches into consideration.
* The readRevision identifies the read revision used by the
* client, which may be a branch revision logged in {@link RevisionContext#getBranches()}.
* The revision rev is valid if it is part of the branch
* history of readRevision.
*
* @param rev revision to check.
* @param commitValue the commit value of the revision to check or
* null if unknown.
* @param readRevision the read revision of the client.
* @param validRevisions map of revisions to commit value already checked
* against readRevision and considered
* valid.
* @return true if the revision is valid; false
* otherwise.
*/
private boolean isValidRevision(@Nonnull RevisionContext context,
@Nonnull Revision rev,
@Nullable String commitValue,
@Nonnull RevisionVector readRevision,
@Nonnull Map validRevisions) {
if (validRevisions.containsKey(rev)) {
return true;
}
if (Utils.isCommitted(commitValue) && !readRevision.isBranch()) {
// no need to load commit root document, we can simply
// tell by looking at the commit revision whether the
// revision is valid/visible
Revision commitRev = Utils.resolveCommitRevision(rev, commitValue);
return !readRevision.isRevisionNewer(commitRev);
}
NodeDocument doc = getCommitRoot(rev);
if (doc == null) {
return false;
}
if (doc.isVisible(context, rev, commitValue, readRevision)) {
validRevisions.put(rev, commitValue);
return true;
}
return false;
}
/**
* Returns a {@link DocumentNodeState} as seen at the given
* readRevision.
*
* @param nodeStore the node store.
* @param readRevision the read revision.
* @param lastModified the revision when this node was last modified, but
* the value is potentially not yet reflected in this
* document.
* See {@link RevisionContext#getPendingModifications()}.
* @return the node or null if the node doesn't exist at the
* given read revision.
*/
@CheckForNull
public DocumentNodeState getNodeAtRevision(@Nonnull DocumentNodeStore nodeStore,
@Nonnull RevisionVector readRevision,
@Nullable Revision lastModified) {
Map validRevisions = Maps.newHashMap();
Branch branch = nodeStore.getBranches().getBranch(readRevision);
LastRevs lastRevs = createLastRevs(readRevision,
nodeStore, branch, lastModified);
Revision min = getLiveRevision(nodeStore, readRevision, validRevisions, lastRevs);
if (min == null) {
// deleted
return null;
}
String path = getPath();
List props = Lists.newArrayList();
for (String key : keySet()) {
if (!Utils.isPropertyName(key)) {
continue;
}
// ignore when local map is empty (OAK-2442)
SortedMap local = getLocalMap(key);
if (local.isEmpty()) {
continue;
}
// first check local map, which contains most recent values
Value value = getLatestValue(nodeStore, local.entrySet(),
readRevision, validRevisions, lastRevs);
// check if there may be more recent values in a previous document
if (value != null
&& !getPreviousRanges().isEmpty()
&& !isMostRecentCommitted(local, value.revision, nodeStore)) {
// not reading the most recent value, we may need to
// consider previous documents as well
for (Revision prev : getPreviousRanges().keySet()) {
if (prev.compareRevisionTimeThenClusterId(value.revision) > 0) {
// a previous document has more recent changes
// than value.revision
value = null;
break;
}
}
}
if (value == null && !getPreviousRanges().isEmpty()) {
// check revision history
value = getLatestValue(nodeStore, getVisibleChanges(key, readRevision),
readRevision, validRevisions, lastRevs);
}
String propertyName = Utils.unescapePropertyName(key);
String v = value != null ? value.value : null;
if (v != null){
props.add(nodeStore.createPropertyState(propertyName, v));
}
}
// when was this node last modified?
RevisionVector lastRevision = new RevisionVector(min);
RevisionVector branchBase = null;
if (branch != null) {
branchBase = branch.getBase(readRevision.getBranchRevision());
}
for (Revision r : lastRevs) {
if (readRevision.isRevisionNewer(r)) {
// the node has a _lastRev which is newer than readRevision
// this means we don't know when this node was
// modified by an operation on a descendant node between
// current lastRevision and readRevision. therefore we have
// to stay on the safe side and use readRevision
Revision rev = readRevision.getRevision(r.getClusterId());
if (rev != null) {
lastRevision = lastRevision.update(rev);
} else {
// readRevision does not have a revision for this
// clusterId -> remove from lastRevision
lastRevision = lastRevision.remove(r.getClusterId());
}
} else if (branchBase != null && branchBase.isRevisionNewer(r)) {
// readRevision is on a branch and the node has a
// _lastRev which is newer than the base of the branch
// we cannot use this _lastRev because it is not visible
// from this branch. highest possible revision of visible
// changes is the base of the branch
Revision rev = branchBase.getRevision(r.getClusterId());
if (rev != null) {
lastRevision = lastRevision.update(rev);
} else {
// branchBase does not have a revision for this
// clusterId -> remove from lastRevision
lastRevision = lastRevision.remove(r.getClusterId());
}
} else if (lastRevision.isRevisionNewer(r)) {
lastRevision = lastRevision.update(r);
}
}
if (branch != null) {
// read from a branch
// -> possibly overlay with unsaved last revs from branch
lastRevs.updateBranch(branch.getUnsavedLastRevision(path, readRevision.getBranchRevision()));
Revision r = lastRevs.getBranchRevision();
if (r != null) {
lastRevision = lastRevision.update(r);
}
}
if (store instanceof RevisionListener) {
((RevisionListener) store).updateAccessedRevision(lastRevision, nodeStore.getClusterId());
}
return new DocumentNodeState(nodeStore, path, readRevision, props, hasChildren(), lastRevision);
}
/**
* Get the earliest (oldest) revision where the node was alive at or before
* the provided revision, if the node was alive at the given revision.
*
* @param context the revision context
* @param readRevision the read revision
* @param validRevisions the map of revisions to commit value already
* checked against readRevision and considered valid.
* @param lastRevs to keep track of the last modification.
* @return the earliest revision, or null if the node is deleted at the
* given revision
*/
@CheckForNull
public Revision getLiveRevision(RevisionContext context,
RevisionVector readRevision,
Map validRevisions,
LastRevs lastRevs) {
// check local deleted map first
Value value = getLatestValue(context, getLocalDeleted().entrySet(), readRevision, validRevisions, lastRevs);
if (value == null && !getPreviousRanges().isEmpty()) {
// need to check complete map
value = getLatestValue(context, getDeleted().entrySet(), readRevision, validRevisions, lastRevs);
}
return value != null && "false".equals(value.value) ? value.revision : null;
}
/**
* Returns true if the given operation is conflicting with this
* document.
*
* @param op the update operation.
* @param baseRevision the base revision for the update operation.
* @param commitRevision the commit revision of the update operation.
* @param enableConcurrentAddRemove feature flag for OAK-2673.
* @return true if conflicting, false otherwise.
*/
boolean isConflicting(@Nonnull UpdateOp op,
@Nonnull RevisionVector baseRevision,
@Nonnull Revision commitRevision,
boolean enableConcurrentAddRemove) {
// did existence of node change after baseRevision?
// only check local deleted map, which contains the most
// recent values
Map deleted = getLocalDeleted();
boolean allowConflictingDeleteChange =
enableConcurrentAddRemove && allowConflictingDeleteChange(op);
for (Map.Entry entry : deleted.entrySet()) {
if (entry.getKey().equals(commitRevision)) {
continue;
}
if (baseRevision.isRevisionNewer(entry.getKey())) {
boolean newerDeleted = Boolean.parseBoolean(entry.getValue());
if (!allowConflictingDeleteChange || op.isDelete() != newerDeleted) {
return true;
}
}
}
for (Map.Entry entry : op.getChanges().entrySet()) {
if (entry.getValue().type != Operation.Type.SET_MAP_ENTRY) {
continue;
}
String name = entry.getKey().getName();
if (DELETED.equals(name) && !allowConflictingDeleteChange) {
// existence of node changed, this always conflicts with
// any other concurrent change
return true;
}
if (!Utils.isPropertyName(name)) {
continue;
}
// was this property touched after baseRevision?
for (Revision rev : getChanges(name, baseRevision)) {
if (rev.equals(commitRevision)) {
continue;
}
if (baseRevision.isRevisionNewer(rev)) {
return true;
}
}
}
return false;
}
/**
* Utility method to check if {@code op} can be allowed to change
* {@link #DELETED} property. Basic idea is that a change in
* {@link #DELETED} property should be consistent if final value is same
* and there are no observation semantic change. Thus, this method tries to
* be very conservative and allows delete iff:
*
* - {@code doc} represents and internal path
* - {@code op} represents an add or delete operation
* - {@code op} doesn't change add/delete any exposed property
* - {@code doc} doesn't have any exposed property
*
*
* Note: This method is a broad level check if we can allow such conflict
* resolution. Actual cases, like allow-delete-delete, allow-add-add wrt to
* revision are not handled here.
*
* @param op {@link UpdateOp} instance having changes to check {@code doc} against
* @return if conflicting change in {@link #DELETED} property is allowed
*/
private boolean allowConflictingDeleteChange(UpdateOp op) {
String path = getPath();
if (!Utils.isHiddenPath(path)) {
return false;
}
if (!op.isNew() && !op.isDelete()) {
return false;//only handle added/delete operations
}
for (Key opKey : op.getChanges().keySet()) {
String name = opKey.getName();
if (Utils.isPropertyName(name)) {
return false; //only handle changes to internal properties
}
}
// Only look at local data ...
// even remotely updated properties should have an entry (although invisible)
// by the time we are looking for conflicts
for (String dataKey : keySet()) {
if (Utils.isPropertyName(dataKey)) {
return false; //only handle changes to internal properties
}
}
return true;
}
/**
* Returns update operations to split this document. The implementation may
* decide to not return any operations if no splitting is required. A caller
* must explicitly pass a head revision even though it is available through
* the {@link RevisionContext}. The given head revision must reflect a head
* state before {@code doc} was retrieved from the document store. This is
* important in order to maintain consistency. See OAK-3081 for details.
*
* @param context the revision context.
* @param head the head revision before this document was retrieved from
* the document store.
* @param binarySize a function that returns the binary size of the given
* JSON property value String.
* @return the split operations.
*/
@Nonnull
public Iterable split(@Nonnull RevisionContext context,
@Nonnull RevisionVector head,
@Nonnull Function binarySize) {
return SplitOperations.forDocument(this, context, head,
binarySize, NUM_REVS_THRESHOLD);
}
/**
* Returns previous revision ranges for this document. The revision keys are
* sorted descending, newest first! The returned map does not include stale
* entries.
* This method is equivalent to calling {@link #getPreviousRanges(boolean)}
* with {@code includeStale} set to false.
*
* @return the previous ranges for this document.
*/
@Nonnull
NavigableMap getPreviousRanges() {
return getPreviousRanges(false);
}
/**
* Returns previous revision ranges for this document. The revision keys are
* sorted descending, newest first!
*
* @param includeStale whether stale revision ranges are included or not.
* @return the previous ranges for this document.
*/
@Nonnull
NavigableMap getPreviousRanges(boolean includeStale) {
if (includeStale) {
return createPreviousRanges(true);
} else {
if (previous == null) {
previous = createPreviousRanges(false);
}
return previous;
}
}
/**
* Creates a map with previous revision ranges for this document. The
* revision keys are sorted descending, newest first!
*
* @param includeStale whether stale revision ranges are included or not.
* @return the previous ranges for this document.
*/
@Nonnull
private NavigableMap createPreviousRanges(boolean includeStale) {
NavigableMap ranges;
Map map = getLocalMap(PREVIOUS);
if (map.isEmpty()) {
ranges = EMPTY_RANGE_MAP;
} else {
Map stale = Collections.emptyMap();
if (!includeStale) {
stale = getLocalMap(STALE_PREV);
}
NavigableMap transformed =
new TreeMap(REVERSE);
for (Map.Entry entry : map.entrySet()) {
Range r = Range.fromEntry(entry.getKey(), entry.getValue());
if (String.valueOf(r.height).equals(stale.get(r.high))) {
continue;
}
transformed.put(r.high, r);
}
ranges = Maps.unmodifiableNavigableMap(transformed);
}
return ranges;
}
/**
* Returns previous {@link NodeDocument}, which include entries for the
* property in the given revision.
* If the revision is null, then all previous
* documents with changes for the given property are returned. The returned
* documents are returned in descending revision order (newest first).
*
* @param property the name of a property.
* @param revision the revision to match or null.
* @return previous documents.
*/
@Nonnull
Iterable getPreviousDocs(@Nonnull final String property,
@Nullable final Revision revision) {
if (getPreviousRanges().isEmpty()) {
return Collections.emptyList();
}
if (revision == null) {
return new PropertyHistory(this, property);
} else {
final String mainPath = getMainPath();
// first try to lookup revision directly
Map.Entry entry = getPreviousRanges().floorEntry(revision);
if (entry != null) {
Revision r = entry.getKey();
int h = entry.getValue().height;
String prevId = Utils.getPreviousIdFor(mainPath, r, h);
NodeDocument prev = getPreviousDocument(prevId);
if (prev != null) {
if (prev.getValueMap(property).containsKey(revision)) {
return Collections.singleton(prev);
}
} else {
previousDocumentNotFound(prevId, revision);
}
}
// didn't find entry -> scan through remaining head ranges
return filter(transform(getPreviousRanges().headMap(revision).entrySet(),
new Function, NodeDocument>() {
@Override
public NodeDocument apply(Map.Entry input) {
if (input.getValue().includes(revision)) {
return getPreviousDoc(input.getKey(), input.getValue());
}
return null;
}
}), new Predicate() {
@Override
public boolean apply(@Nullable NodeDocument input) {
return input != null && input.getValueMap(property).containsKey(revision);
}
});
}
}
NodeDocument getPreviousDocument(String prevId){
LOG.trace("get previous document {}", prevId);
NodeDocument doc = store.find(Collection.NODES, prevId);
if (doc == null) {
// In case secondary read preference is used and node is not found
// then check with primary again as it might happen that node document has not been
// replicated. We know that document with such an id must exist but possibly dut to
// replication lag it has not reached to secondary. So in that case read again
// from primary
doc = store.find(Collection.NODES, prevId, 0);
}
return doc;
}
@Nonnull
Iterator getAllPreviousDocs() {
if (getPreviousRanges().isEmpty()) {
return Iterators.emptyIterator();
}
//Currently this method would fire one query per previous doc
//If that poses a problem we can try to find all prev doc by relying
//on property that all prevDoc id would starts :p/path/to/node
return new AbstractIterator(){
private Queue> previousRanges =
Queues.newArrayDeque(getPreviousRanges().entrySet());
@Override
protected NodeDocument computeNext() {
if(!previousRanges.isEmpty()){
Map.Entry e = previousRanges.remove();
NodeDocument prev = getPreviousDoc(e.getKey(), e.getValue());
if(prev != null){
previousRanges.addAll(prev.getPreviousRanges().entrySet());
return prev;
}
}
return endOfData();
}
};
}
/**
* Returns previous leaf documents. Those are the previous documents with
* a type {@code !=} {@link SplitDocType#INTERMEDIATE}. The documents are
* returned in descending order based on the most recent change recorded
* in the previous document. A change is defined as an entry in either the
* {@link #REVISIONS} or {@link #COMMIT_ROOT} map.
*
* @return the leaf documents in descending order.
*/
@Nonnull
Iterator getPreviousDocLeaves() {
if (getPreviousRanges().isEmpty()) {
return Iterators.emptyIterator();
}
// create a mutable copy
final NavigableMap ranges = Maps.newTreeMap(getPreviousRanges());
return new AbstractIterator() {
@Override
protected NodeDocument computeNext() {
NodeDocument next;
for (;;) {
Map.Entry topEntry = ranges.pollFirstEntry();
if (topEntry == null) {
// no more ranges
next = endOfData();
break;
}
NodeDocument prev = getPreviousDoc(topEntry.getKey(), topEntry.getValue());
if (prev == null) {
// move on to next range
continue;
}
if (topEntry.getValue().getHeight() == 0) {
// this is a leaf
next = prev;
break;
} else {
// replace intermediate entry with its previous ranges
ranges.putAll(prev.getPreviousRanges());
}
}
return next;
}
};
}
@CheckForNull
private NodeDocument getPreviousDoc(Revision rev, Range range){
int h = range.height;
String prevId = Utils.getPreviousIdFor(getMainPath(), rev, h);
NodeDocument prev = getPreviousDocument(prevId);
if (prev != null) {
return prev;
} else {
previousDocumentNotFound(prevId, rev);
}
return null;
}
/**
* Returns the document that contains a reference to the previous document
* identified by {@code revision} and {@code height}. This is either the
* current document or an intermediate split document. This method returns
* {@code null} if there is no such reference.
*
* @param revision the high revision of a range entry in {@link #PREVIOUS}.
* @param height the height of the entry in {@link #PREVIOUS}.
* @return the document with the entry or {@code null} if not found.
*/
@Nullable
NodeDocument findPrevReferencingDoc(Revision revision, int height) {
for (Range range : getPreviousRanges().values()) {
if (range.getHeight() == height && range.high.equals(revision)) {
return this;
} else if (range.includes(revision)) {
String prevId = Utils.getPreviousIdFor(
getMainPath(), range.high, range.height);
NodeDocument prev = store.find(NODES, prevId);
if (prev == null) {
LOG.warn("Split document {} does not exist anymore. Main document is {}",
prevId, Utils.getIdFromPath(getMainPath()));
continue;
}
// recurse into the split hierarchy
NodeDocument doc = prev.findPrevReferencingDoc(revision, height);
if (doc != null) {
return doc;
}
}
}
return null;
}
/**
* Returns an {@link Iterable} of {@link Revision} of all changes performed
* on this document. This covers all entries for {@link #REVISIONS} and
* {@link #COMMIT_ROOT} including previous documents. The revisions are
* returned in descending stable revision order using
* {@link StableRevisionComparator#REVERSE}.
*
* @return revisions of all changes performed on this document.
*/
Iterable getAllChanges() {
RevisionVector empty = new RevisionVector();
return Iterables.mergeSorted(ImmutableList.of(
getChanges(REVISIONS, empty),
getChanges(COMMIT_ROOT, empty)
), StableRevisionComparator.REVERSE);
}
/**
* Returns all changes for the given property back to {@code min} revision
* (exclusive). The revisions include committed as well as uncommitted
* changes. The returned revisions are sorted in reverse order (newest
* first).
*
* @param property the name of the property.
* @param min the lower bound revision (exclusive).
* @return changes back to {@code min} revision.
*/
@Nonnull
Iterable getChanges(@Nonnull final String property,
@Nonnull final RevisionVector min) {
Predicate p = new Predicate() {
@Override
public boolean apply(Revision input) {
return min.isRevisionNewer(input);
}
};
List> changes = Lists.newArrayList();
changes.add(abortingIterable(getLocalMap(property).keySet(), p));
for (Map.Entry e : getPreviousRanges().entrySet()) {
if (min.isRevisionNewer(e.getKey())) {
final NodeDocument prev = getPreviousDoc(e.getKey(), e.getValue());
if (prev != null) {
changes.add(abortingIterable(prev.getValueMap(property).keySet(), p));
}
}
}
if (changes.size() == 1) {
return changes.get(0);
} else {
return Iterables.mergeSorted(changes, StableRevisionComparator.REVERSE);
}
}
/**
* Returns all changes for the given property that are visible from the
* {@code readRevision} vector. The revisions include committed as well as
* uncommitted changes. The returned revisions are sorted in reverse order
* (newest first).
*
* @param property the name of the property.
* @param readRevision the read revision vector.
* @return property changes visible from the given read revision vector.
*/
@Nonnull
Iterable> getVisibleChanges(@Nonnull final String property,
@Nonnull final RevisionVector readRevision) {
Predicate> p = new Predicate>() {
@Override
public boolean apply(Map.Entry input) {
return !readRevision.isRevisionNewer(input.getKey());
}
};
List>> changes = Lists.newArrayList();
Map localChanges = getLocalMap(property);
if (!localChanges.isEmpty()) {
changes.add(filter(localChanges.entrySet(), p));
}
for (Revision r : readRevision) {
// collect changes per clusterId
collectVisiblePreviousChanges(property, r, changes);
}
if (changes.size() == 1) {
return changes.get(0);
} else {
return mergeSorted(changes, ValueComparator.REVERSE);
}
}
/**
* Collect changes in previous documents into {@code changes} visible from
* the given {@code readRevision} and for the given {@code property}. The
* {@code Iterable} added to the {@code changes} list must be in descending
* revision order.
*
* @param property the name of the property.
* @param readRevision collect changes for this part of the readRevision.
* @param changes where to add the changes to.
*/
private void collectVisiblePreviousChanges(@Nonnull final String property,
@Nonnull final Revision readRevision,
@Nonnull final List>> changes) {
List>> revs = Lists.newArrayList();
Revision lowRev = new Revision(Long.MAX_VALUE, 0, readRevision.getClusterId());
RevisionVector readRV = new RevisionVector(readRevision);
List ranges = Lists.newArrayList();
for (Map.Entry e : getPreviousRanges().entrySet()) {
Range range = e.getValue();
if (range.low.getClusterId() != readRevision.getClusterId()
|| readRevision.compareRevisionTime(range.low) < 0) {
// either clusterId does not match
// or range is newer than read revision
continue;
}
// check if it overlaps with previous ranges
if (range.high.compareRevisionTime(lowRev) < 0) {
// does not overlap
if (!ranges.isEmpty()) {
// there are previous ranges
// get and merge sort overlapping ranges
revs.add(changesFor(ranges, readRV, property));
ranges.clear();
}
}
ranges.add(range);
lowRev = Utils.min(lowRev, range.low);
}
if (!ranges.isEmpty()) {
// get remaining changes
revs.add(changesFor(ranges, readRV, property));
}
if (!revs.isEmpty()) {
changes.add(concat(revs));
}
}
/**
* Get changes of {@code property} for the given list of {@code ranges}
* visible from {@code readRev}.
*
* @param ranges a list of ranges of previous document where to read the
* changes from.
* @param readRev get changes visible from this read revision.
* @param property the name of the property to read changes.
* @return iterable over the changes.
*/
private Iterable> changesFor(final List ranges,
final RevisionVector readRev,
final String property) {
if (ranges.isEmpty()) {
return Collections.emptyList();
}
final Function>> rangeToChanges =
new Function>>() {
@Override
public Iterable> apply(Range input) {
NodeDocument doc = getPreviousDoc(input.high, input);
if (doc == null) {
return Collections.emptyList();
}
return doc.getVisibleChanges(property, readRev);
}
};
Iterable> changes;
if (ranges.size() == 1) {
final Range range = ranges.get(0);
changes = new Iterable>() {
@SuppressWarnings("ConstantConditions")
@Override
public Iterator> iterator() {
return rangeToChanges.apply(range).iterator();
}
};
} else {
changes = new Iterable>() {
private List rangeList = copyOf(ranges);
private Iterable>> changesPerRange
= transform(rangeList, rangeToChanges);
@Override
public Iterator> iterator() {
final Iterator>> it
= checkNotNull(changesPerRange.iterator());
return new MergeSortedIterators>(ValueComparator.REVERSE) {
@Override
public Iterator> nextIterator() {
while (it.hasNext()) {
Iterator> next = it.next().iterator();
// check if this even has elements
if (next.hasNext()) {
return next;
}
}
return null;
}
@Override
public String description() {
return "Ranges to merge sort: " + rangeList;
}
};
}
};
}
return filter(changes, new Predicate>() {
@Override
public boolean apply(Entry input) {
return !readRev.isRevisionNewer(input.getKey());
}
});
}
/**
* Returns the local value map for the given key.
*
* @param key the key.
* @return local value map.
*/
@Nonnull
SortedMap getLocalMap(String key) {
@SuppressWarnings("unchecked")
SortedMap map = (SortedMap) data.get(key);
if (map == null) {
map = ValueMap.EMPTY;
}
return map;
}
/**
* @return the {@link #REVISIONS} stored on this document.
*/
@Nonnull
SortedMap getLocalRevisions() {
return getLocalMap(REVISIONS);
}
@Nonnull
SortedMap getLocalCommitRoot() {
return getLocalMap(COMMIT_ROOT);
}
@Nonnull
SortedMap getLocalDeleted() {
return getLocalMap(DELETED);
}
@Nonnull
SortedMap getStalePrev() {
return getLocalMap(STALE_PREV);
}
/**
* Returns the branch commit entries on this document
* ({@link #BRANCH_COMMITS}). This method does not consider previous
* documents, but only returns the entries on this document.
*/
@Nonnull
public Set getLocalBranchCommits() {
return getLocalMap(BRANCH_COMMITS).keySet();
}
/**
* Resolves the commit value for the change with the given revision on this
* document. If necessary, this method will lookup the commit value on the
* referenced commit root document.
*
* @param revision the revision of a change on this document.
* @return the commit value associated with the change.
*/
@CheckForNull
String resolveCommitValue(Revision revision) {
NodeDocument commitRoot = getCommitRoot(revision);
if (commitRoot == null) {
return null;
}
return commitRoot.getCommitValue(revision);
}
/**
* Returns the sweep revisions on this document as a {@link RevisionVector}.
* This method will return an empty {@link RevisionVector} if this document
* doesn't have any sweep revisions set.
*
* @return the sweep revisions as a {@link RevisionVector}.
*/
@Nonnull
RevisionVector getSweepRevisions() {
return new RevisionVector(transform(getLocalMap(SWEEP_REV).values(),
new Function() {
@Override
public Revision apply(String s) {
return Revision.fromString(s);
}
}));
}
//-------------------------< UpdateOp modifiers >---------------------------
public static void setChildrenFlag(@Nonnull UpdateOp op,
boolean hasChildNode) {
checkNotNull(op).set(CHILDREN_FLAG, hasChildNode);
}
public static void setModified(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).max(MODIFIED_IN_SECS, getModifiedInSecs(checkNotNull(revision).getTimestamp()));
}
public static void setRevision(@Nonnull UpdateOp op,
@Nonnull Revision revision,
@Nonnull String commitValue) {
checkNotNull(op).setMapEntry(REVISIONS,
checkNotNull(revision), checkNotNull(commitValue));
}
public static void unsetRevision(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).unsetMapEntry(REVISIONS, checkNotNull(revision));
}
public static boolean isRevisionsEntry(String name) {
return REVISIONS.equals(name);
}
public static boolean isCommitRootEntry(String name) {
return COMMIT_ROOT.equals(name);
}
public static boolean isDeletedEntry(String name) {
return DELETED.equals(name);
}
public static boolean isLastRevEntry(String name) {
return LAST_REV.equals(name);
}
public static void removeRevision(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(REVISIONS, checkNotNull(revision));
}
/**
* Add a collision marker for the given {@code revision}.
*
* @param op the update operation.
* @param revision the commit for which a collision was detected.
* @param other the revision for the commit, which detected the collision.
*/
public static void addCollision(@Nonnull UpdateOp op,
@Nonnull Revision revision,
@Nonnull Revision other) {
checkNotNull(op).setMapEntry(COLLISIONS, checkNotNull(revision),
other.toString());
}
public static void removeCollision(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(COLLISIONS, checkNotNull(revision));
}
public static void setLastRev(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).setMapEntry(LAST_REV,
new Revision(0, 0, revision.getClusterId()),
revision.toString());
}
public static void setCommitRoot(@Nonnull UpdateOp op,
@Nonnull Revision revision,
int commitRootDepth) {
checkNotNull(op).setMapEntry(COMMIT_ROOT, checkNotNull(revision),
String.valueOf(commitRootDepth));
}
public static void removeCommitRoot(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(COMMIT_ROOT, revision);
}
public static void setDeleted(@Nonnull UpdateOp op,
@Nonnull Revision revision,
boolean deleted) {
if(deleted) {
//DELETED_ONCE would be set upon every delete.
//possibly we can avoid that
setDeletedOnce(op);
}
checkNotNull(op).setMapEntry(DELETED, checkNotNull(revision), String.valueOf(deleted));
}
public static void setDeletedOnce(@Nonnull UpdateOp op) {
checkNotNull(op).set(DELETED_ONCE, Boolean.TRUE);
}
public static void removeDeleted(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(DELETED, revision);
}
public static void setPrevious(@Nonnull UpdateOp op,
@Nonnull Range range) {
checkNotNull(op).setMapEntry(PREVIOUS, checkNotNull(range).high,
range.getLowValue());
}
public static void removePrevious(@Nonnull UpdateOp op,
@Nonnull Range range) {
removePrevious(op, checkNotNull(range).high);
}
public static void removePrevious(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(PREVIOUS, checkNotNull(revision));
}
public static void setStalePrevious(@Nonnull UpdateOp op,
@Nonnull Revision revision,
int height) {
checkNotNull(op).setMapEntry(STALE_PREV,
checkNotNull(revision), String.valueOf(height));
}
public static void removeStalePrevious(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(STALE_PREV, checkNotNull(revision));
}
public static void setHasBinary(@Nonnull UpdateOp op) {
checkNotNull(op).set(HAS_BINARY_FLAG, HAS_BINARY_VAL);
}
public static void setBranchCommit(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).setMapEntry(BRANCH_COMMITS,
revision, String.valueOf(true));
}
public static void removeBranchCommit(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).removeMapEntry(BRANCH_COMMITS, revision);
}
public static void setSweepRevision(@Nonnull UpdateOp op,
@Nonnull Revision revision) {
checkNotNull(op).setMapEntry(SWEEP_REV,
new Revision(0, 0, revision.getClusterId()),
revision.toString());
}
//----------------------------< internal >----------------------------------
private void previousDocumentNotFound(String prevId, Revision rev) {
LOG.warn("Document with previous revisions not found: " + prevId);
// main document may be stale, evict it from the cache if it is
// older than one minute. We don't want to invalidate a document
// too frequently if the document structure is really broken.
String path = getMainPath();
String id = Utils.getIdFromPath(path);
NodeDocument doc = store.getIfCached(NODES, id);
long now = Revision.getCurrentTimestamp();
while (doc != null
&& doc.getCreated() + TimeUnit.MINUTES.toMillis(1) < now) {
LOG.info("Invalidated cached document {}", id);
store.invalidateCache(NODES, id);
// also invalidate intermediate docs if there are any matching
Iterable ranges = doc.getPreviousRanges().values();
doc = null;
for (Range range : ranges) {
if (range.includes(rev)) {
id = Utils.getPreviousIdFor(path, range.high, range.height);
doc = store.getIfCached(NODES, id);
break;
}
}
}
}
private LastRevs createLastRevs(@Nonnull RevisionVector readRevision,
@Nonnull RevisionContext context,
@Nullable Branch branch,
@Nullable Revision pendingLastRev) {
LastRevs lastRevs = new LastRevs(getLastRev(), readRevision, branch);
// overlay with unsaved last modified from this instance
lastRevs.update(pendingLastRev);
// collect clusterIds
SortedSet mostRecentChanges = Sets.newTreeSet(REVERSE);
mostRecentChanges.addAll(getLocalRevisions().keySet());
mostRecentChanges.addAll(getLocalCommitRoot().keySet());
Set clusterIds = Sets.newHashSet();
for (Revision r : getLocalRevisions().keySet()) {
clusterIds.add(r.getClusterId());
}
for (Revision r : getLocalCommitRoot().keySet()) {
clusterIds.add(r.getClusterId());
}
for (Revision r : mostRecentChanges) {
if (!clusterIds.contains(r.getClusterId())) {
// already found most recent change from this cluster node
continue;
}
String commitValue = context.getCommitValue(r, this);
if (commitValue == null) {
continue;
}
// resolve revision
Revision commitRev = resolveCommitRevision(r, commitValue);
if (Utils.isCommitted(commitValue)) {
lastRevs.update(commitRev);
clusterIds.remove(r.getClusterId());
} else if (branch != null) {
Revision branchRev = commitRev.asBranchRevision();
if (branch.containsCommit(branchRev)) {
lastRevs.updateBranch(branchRev);
clusterIds.remove(r.getClusterId());
}
}
}
return lastRevs;
}
/**
* Returns {@code true} if the given {@code revision} is more recent or
* equal to the committed revision in {@code valueMap}. This method assumes
* the given {@code revision} is committed.
*
* @param valueMap the value map sorted most recent first.
* @param revision a committed revision.
* @param context the revision context.
* @return if {@code revision} is the most recent committed revision in the
* {@code valueMap}.
*/
private boolean isMostRecentCommitted(SortedMap valueMap,
Revision revision,
RevisionContext context) {
if (valueMap.isEmpty()) {
return true;
}
// shortcut when revision is the first key
Revision first = valueMap.firstKey();
if (first.compareRevisionTimeThenClusterId(revision) <= 0) {
return true;
}
// need to check commit status
for (Revision r : valueMap.keySet()) {
String cv = context.getCommitValue(r, this);
if (Utils.isCommitted(cv)) {
Revision c = resolveCommitRevision(r, cv);
return c.compareRevisionTimeThenClusterId(revision) <= 0;
}
}
// no committed revision found in valueMap
return true;
}
/**
* Returns the commit root document for the given revision. This may either
* be this document or another one.
*
* @param rev a revision.
* @return the commit root or null if there is none.
*/
@CheckForNull
private NodeDocument getCommitRoot(@Nonnull Revision rev) {
// check local revisions and commitRoot first
if (getLocalRevisions().containsKey(rev)) {
return this;
}
String commitRootPath;
String depth = getLocalCommitRoot().get(rev);
if (depth != null) {
commitRootPath = getPathAtDepth(depth);
} else {
// fall back to complete check, including previous documents
if (containsRevision(rev)) {
return this;
}
commitRootPath = getCommitRootPath(rev);
if (commitRootPath == null) {
// may happen for a commit root document, which hasn't been
// updated with the commit revision yet
return null;
}
}
// get root of commit
return store.find(Collection.NODES, Utils.getIdFromPath(commitRootPath));
}
/**
* Returns the path at the given {@code depth} based on the path of this
* document.
*
* @param depth the depth as a string.
* @return the path.
* @throws NumberFormatException if {@code depth} cannot be parsed as an
* integer.
*/
@Nonnull
private String getPathAtDepth(@Nonnull String depth) {
if (checkNotNull(depth).equals("0")) {
return "/";
}
String p = getPath();
return PathUtils.getAncestorPath(p, PathUtils.getDepth(p) - Integer.parseInt(depth));
}
/**
* Returns the commit root depth for the given revision. This method also
* takes previous documents into account.
*
* @param revision get the commit root depth for this revision.
* @return the depth or null if there is no commit root entry
* for the given revision on this document or previous documents.
*/
@CheckForNull
private String getCommitRootDepth(@Nonnull Revision revision) {
// check local map first
Map local = getLocalCommitRoot();
String depth = local.get(revision);
if (depth == null) {
// check previous
for (NodeDocument prev : getPreviousDocs(COMMIT_ROOT, revision)) {
depth = prev.getCommitRootDepth(revision);
if (depth != null) {
break;
}
}
}
return depth;
}
/**
* Returns true if the given revision
* {@link Utils#isCommitted(String)} in the revisions map (including
* revisions split off to previous documents) and is visible from the
* readRevision. This includes branch commits if the read
* revision is on the same branch and is equal or newer than the revision
* to check.
*
* @param revision the revision to check.
* @param commitValue the commit value of the revision to check or
* null if unknown.
* @param readRevision the read revision.
* @return true if the revision is visible, otherwise
* false.
*/
private boolean isVisible(@Nonnull RevisionContext context,
@Nonnull Revision revision,
@Nullable String commitValue,
@Nonnull RevisionVector readRevision) {
if (commitValue == null) {
commitValue = context.getCommitValue(revision, this);
}
if (commitValue == null) {
return false;
}
if (Utils.isCommitted(commitValue)) {
if (context.getBranches().getBranch(readRevision) == null
&& !readRevision.isBranch()) {
// resolve commit revision
revision = resolveCommitRevision(revision, commitValue);
// readRevision is not from a branch
// compare resolved revision as is
return !readRevision.isRevisionNewer(revision);
} else {
// on same merged branch?
Revision tr = readRevision.getBranchRevision().asTrunkRevision();
if (commitValue.equals(context.getCommitValue(tr, this))) {
// compare unresolved revision
return !readRevision.isRevisionNewer(revision);
}
}
} else {
// branch commit (not merged)
// read as RevisionVector, even though this should be
// a Revision only. See OAK-4840
RevisionVector branchCommit = RevisionVector.fromString(commitValue);
if (branchCommit.getBranchRevision().getClusterId() != context.getClusterId()) {
// this is an unmerged branch commit from another cluster node,
// hence never visible to us
return false;
}
}
return includeRevision(context, resolveCommitRevision(revision, commitValue), readRevision);
}
/**
* Returns the commit value for the given revision.
*
* @param revision a revision.
* @return the commit value or null if the revision is unknown.
*/
@CheckForNull
private String getCommitValue(Revision revision) {
String value = getLocalRevisions().get(revision);
if (value == null) {
// check previous
for (NodeDocument prev : getPreviousDocs(REVISIONS, revision)) {
value = prev.getCommitValue(revision);
if (value != null) {
break;
}
}
}
return value;
}
private static boolean includeRevision(RevisionContext context,
Revision x,
RevisionVector readRevision) {
Branch b = null;
if (x.getClusterId() == context.getClusterId()) {
RevisionVector branchRev = new RevisionVector(x).asBranchRevision(context.getClusterId());
b = context.getBranches().getBranch(branchRev);
}
if (b != null) {
// only include if read revision is also a branch revision
// with a history including x
if (readRevision.isBranch()
&& b.containsCommit(readRevision.getBranchRevision())) {
// in same branch, include if the same revision or
// readRevision is newer
return !readRevision.isRevisionNewer(x);
}
// not part of branch identified by requestedRevision
return false;
}
// assert: x is not a branch commit
b = context.getBranches().getBranch(readRevision);
if (b != null) {
// reset readRevision to branch base revision to make
// sure we don't include revisions committed after branch
// was created
readRevision = b.getBase(readRevision.getBranchRevision());
}
return !readRevision.isRevisionNewer(x);
}
/**
* Get the latest property value smaller or equal the readRevision revision.
*
* @param valueMap the sorted revision-value map
* @param readRevision the maximum revision
* @param validRevisions map of revision to commit value considered valid
* against the given readRevision.
* @param lastRevs to keep track of the most recent modification.
* @return the latest value from the {@code readRevision} point of view.
*/
@CheckForNull
private Value getLatestValue(@Nonnull RevisionContext context,
@Nonnull Iterable> valueMap,
@Nonnull RevisionVector readRevision,
@Nonnull Map validRevisions,
@Nonnull LastRevs lastRevs) {
for (Map.Entry entry : valueMap) {
Revision propRev = entry.getKey();
String commitValue = validRevisions.get(propRev);
if (commitValue == null) {
commitValue = context.getCommitValue(propRev, this);
}
if (commitValue == null) {
continue;
}
// resolve revision
Revision commitRev = resolveCommitRevision(propRev, commitValue);
if (Utils.isCommitted(commitValue)) {
lastRevs.update(commitRev);
} else {
// branch commit
lastRevs.updateBranch(commitRev.asBranchRevision());
}
if (isValidRevision(context, propRev, commitValue, readRevision, validRevisions)) {
return new Value(commitRev, entry.getValue());
}
}
return null;
}
public String getPath() {
String p = (String) get(PATH);
if (p != null) {
return p;
}
return Utils.getPathFromId(getId());
}
@Nonnull
Map getDeleted() {
return ValueMap.create(this, DELETED);
}
public String asString() {
JsopWriter json = new JsopBuilder();
toJson(json, data);
return json.toString();
}
@SuppressWarnings("unchecked")
private static void toJson(JsopWriter json, Map map) {
for (Entrye : map.entrySet()) {
json.key(e.getKey().toString());
Object value = e.getValue();
if (value == null) {
json.value(null);
} else if (value instanceof Boolean) {
json.value((Boolean) value);
} else if (value instanceof Long) {
json.value((Long) value);
} else if (value instanceof Integer) {
json.value((Integer) value);
} else if (value instanceof Map) {
json.object();
toJson(json, (Map) value);
json.endObject();
} else if (value instanceof Revision) {
json.value(value.toString());
} else {
json.value((String) value);
}
}
}
public static NodeDocument fromString(DocumentStore store, String s) {
JsopTokenizer json = new JsopTokenizer(s);
NodeDocument doc = new NodeDocument(store);
while (true) {
if (json.matches(JsopReader.END)) {
break;
}
String k = json.readString();
json.read(':');
if (json.matches(JsopReader.END)) {
break;
}
doc.put(k, fromJson(json));
json.matches(',');
}
doc.seal();
return doc;
}
private static Object fromJson(JsopTokenizer json) {
switch (json.read()) {
case JsopReader.NULL:
return null;
case JsopReader.TRUE:
return true;
case JsopReader.FALSE:
return false;
case JsopReader.NUMBER:
return Long.parseLong(json.getToken());
case JsopReader.STRING:
return json.getToken();
case '{':
TreeMap map = new TreeMap(REVERSE);
while (true) {
if (json.matches('}')) {
break;
}
String k = json.readString();
json.read(':');
map.put(Revision.fromString(k), fromJson(json));
json.matches(',');
}
return map;
}
throw new IllegalArgumentException(json.readRawValue());
}
/**
* The list of children for a node. The list might be complete or not, in
* which case it only represents a block of children.
*/
public static final class Children implements CacheValue, Cloneable {
/**
* The child node names, ordered as stored in DocumentStore.
*/
ArrayList childNames = new ArrayList();
/**
* Whether the list is complete (in which case there are no other
* children) or not.
*/
boolean isComplete;
@Override
public int getMemory() {
long size = 114;
for (String name : childNames) {
size += (long)name.length() * 2 + 56;
}
if (size > Integer.MAX_VALUE) {
LOG.debug("Estimated memory footprint larger than Integer.MAX_VALUE: {}.", size);
size = Integer.MAX_VALUE;
}
return (int) size;
}
@SuppressWarnings("unchecked")
@Override
public Children clone() {
try {
Children clone = (Children) super.clone();
clone.childNames = (ArrayList) childNames.clone();
return clone;
} catch (CloneNotSupportedException e) {
throw new RuntimeException();
}
}
public String asString() {
JsopWriter json = new JsopBuilder();
if (isComplete) {
json.key("isComplete").value(true);
}
if (childNames.size() > 0) {
json.key("children").array();
for (String c : childNames) {
json.value(c);
}
json.endArray();
}
return json.toString();
}
public static Children fromString(String s) {
JsopTokenizer json = new JsopTokenizer(s);
Children children = new Children();
while (true) {
if (json.matches(JsopReader.END)) {
break;
}
String k = json.readString();
json.read(':');
if ("isComplete".equals(k)) {
children.isComplete = json.read() == JsopReader.TRUE;
} else if ("children".equals(k)) {
json.read('[');
while (true) {
if (json.matches(']')) {
break;
}
String value = json.readString();
children.childNames.add(value);
json.matches(',');
}
}
if (json.matches(JsopReader.END)) {
break;
}
json.read(',');
}
return children;
}
}
/**
* A property value / revision combination.
*/
private static final class Value {
final Revision revision;
/**
* The value of a property at the given revision. A {@code null} value
* indicates the property was removed.
*/
final String value;
Value(@Nonnull Revision revision, @Nullable String value) {
this.revision = checkNotNull(revision);
this.value = value;
}
}
private static final class ValueComparator implements
Comparator> {
static final Comparator> INSTANCE = new ValueComparator();
static final Comparator> REVERSE = Collections.reverseOrder(INSTANCE);
private static final Ordering STRING_ORDERING = Ordering.natural().nullsFirst();
@Override
public int compare(Entry o1,
Entry o2) {
int cmp = StableRevisionComparator.INSTANCE.compare(o1.getKey(), o2.getKey());
if (cmp != 0) {
return cmp;
}
return STRING_ORDERING.compare(o1.getValue(), o2.getValue());
}
}
}