org.hibernate.envers.query.internal.impl.RevisionsOfEntityQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-envers-jakarta Show documentation
Hibernate's entity version (audit/history) support Jakarta edition
There is a newer version: 5.6.15.Final
Show newest version
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.envers.query.internal.impl;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import jakarta.persistence.criteria.JoinType;

import org.hibernate.envers.RevisionType;
import org.hibernate.envers.boot.internal.EnversService;
import org.hibernate.envers.configuration.internal.AuditEntitiesConfiguration;
import org.hibernate.envers.exception.AuditException;
import org.hibernate.envers.internal.entities.PropertyData;
import org.hibernate.envers.internal.entities.mapper.ExtendedPropertyMapper;
import org.hibernate.envers.internal.entities.mapper.relation.query.QueryConstants;
import org.hibernate.envers.internal.reader.AuditReaderImplementor;
import org.hibernate.envers.query.AuditAssociationQuery;
import org.hibernate.envers.query.AuditQuery;
import org.hibernate.envers.query.criteria.AuditCriterion;
import org.hibernate.proxy.HibernateProxy;

/**
 * @author Adam Warski (adam at warski dot org)
 * @author HernпїЅn Chanfreau
 */
public class RevisionsOfEntityQuery extends AbstractAuditQuery {
	private final boolean selectEntitiesOnly;
	private final boolean selectDeletedEntities;
	private final boolean selectRevisionInfoOnly;
	private final boolean includePropertyChanges;

	public RevisionsOfEntityQuery(
			EnversService enversService,
			AuditReaderImplementor versionsReader,
			Class cls,
			boolean selectEntitiesOnly,
			boolean selectDeletedEntities,
			boolean selectRevisionInfoOnly,
			boolean includePropertyChanges) {
		super( enversService, versionsReader, cls );

		this.selectEntitiesOnly = selectEntitiesOnly;
		this.selectDeletedEntities = selectDeletedEntities;
		this.selectRevisionInfoOnly = selectRevisionInfoOnly && !selectEntitiesOnly;
		this.includePropertyChanges = includePropertyChanges;
	}

	public RevisionsOfEntityQuery(
			EnversService enversService,
			AuditReaderImplementor versionsReader,
			Class cls, String entityName,
			boolean selectEntitiesOnly,
			boolean selectDeletedEntities,
			boolean selectRevisionInfoOnly,
			boolean includePropertyChanges) {
		super( enversService, versionsReader, cls, entityName );

		this.selectEntitiesOnly = selectEntitiesOnly;
		this.selectDeletedEntities = selectDeletedEntities;
		this.selectRevisionInfoOnly = selectRevisionInfoOnly && !selectEntitiesOnly;
		this.includePropertyChanges = includePropertyChanges;
	}

	private Number getRevisionNumber(Map versionsEntity) {
		AuditEntitiesConfiguration verEntCfg = enversService.getAuditEntitiesConfiguration();

		String originalId = verEntCfg.getOriginalIdPropName();
		String revisionPropertyName = verEntCfg.getRevisionFieldName();

		Object revisionInfoObject = ( (Map) versionsEntity.get( originalId ) ).get( revisionPropertyName );

		if ( revisionInfoObject instanceof HibernateProxy ) {
			return (Number) ( (HibernateProxy) revisionInfoObject ).getHibernateLazyInitializer().getInternalIdentifier();
		}
		else {
			// Not a proxy - must be read from cache or with a join
			return enversService.getRevisionInfoNumberReader().getRevisionNumber( revisionInfoObject );
		}
	}

	@SuppressWarnings({"unchecked"})
	public List list() throws AuditException {
		AuditEntitiesConfiguration verEntCfg = enversService.getAuditEntitiesConfiguration();

        /*
		The query that should be executed in the versions table:
        SELECT e (unless another projection is specified) FROM ent_ver e, rev_entity r WHERE
          e.revision_type != DEL (if selectDeletedEntities == false) AND
          e.revision = r.revision AND
          (all specified conditions, transformed, on the "e" entity)
          ORDER BY e.revision ASC (unless another order or projection is specified)
         */
		if ( !selectDeletedEntities ) {
			// e.revision_type != DEL AND
			qb.getRootParameters().addWhereWithParam( verEntCfg.getRevisionTypePropName(), "<>", RevisionType.DEL );
		}

		// all specified conditions, transformed
		for ( AuditCriterion criterion : criterions ) {
			criterion.addToQuery(
					enversService,
					versionsReader,
					aliasToEntityNameMap,
					QueryConstants.REFERENCED_ENTITY_ALIAS,
					qb,
					qb.getRootParameters()
			);
		}

		if ( !hasProjection() && !hasOrder ) {
			String revisionPropertyPath = verEntCfg.getRevisionNumberPath();
			qb.addOrder( QueryConstants.REFERENCED_ENTITY_ALIAS, revisionPropertyPath, true );
		}

		if ( !selectEntitiesOnly ) {
			qb.addFrom( enversService.getAuditEntitiesConfiguration().getRevisionInfoEntityName(), "r", true );
			qb.getRootParameters().addWhere(
					enversService.getAuditEntitiesConfiguration().getRevisionNumberPath(),
					true,
					"=",
					"r.id",
					false
			);
		}

		return getQueryResults();
	}

	@Override
	public AuditAssociationQuery traverseRelation(String associationName, JoinType joinType) {
		throw new UnsupportedOperationException( "Not yet implemented for revisions of entity queries" );
	}

	private boolean isEntityUsingModifiedFlags() {
		// todo: merge HHH-8973 ModifiedFlagMapperSupport into 6.0 to get this behavior by default
		final ExtendedPropertyMapper propertyMapper = getEntityConfiguration().getPropertyMapper();
		for ( PropertyData propertyData : propertyMapper.getProperties().keySet() ) {
			if ( propertyData.isUsingModifiedFlag() ) {
				return true;
			}
		}
		return false;
	}

	private Set getChangedPropertyNames(Map dataMap, Object revisionType) {
		final Set changedPropertyNames = new HashSet<>();
		// we're only interested in changed properties on modification rows.
		if ( revisionType == RevisionType.MOD ) {
			final String modifiedFlagSuffix = enversService.getGlobalConfiguration().getModifiedFlagSuffix();
			for ( Map.Entry entry : dataMap.entrySet() ) {
				final String key = entry.getKey();
				if  ( key.endsWith( modifiedFlagSuffix ) ) {
					if ( entry.getValue() != null && Boolean.parseBoolean( entry.getValue().toString() ) ) {
						changedPropertyNames.add( key.substring( 0, key.length() - modifiedFlagSuffix.length() ) );
					}
				}
			}
		}
		return changedPropertyNames;
	}

	private List getQueryResults() {
		List queryResults = buildAndExecuteQuery();
		if ( hasProjection() ) {
			return queryResults;
		}
		else if ( selectRevisionInfoOnly ) {
			return queryResults.stream().map( e -> ( (Object[]) e )[1] ).collect( Collectors.toList() );
		}
		else {
			List entities = new ArrayList();
			if ( selectEntitiesOnly ) {
				for ( Object row : queryResults ) {
					final Map versionsEntity = (Map) row;
					entities.add( getQueryResultRowValue( versionsEntity, null, getEntityName() ) );
				}
			}
			else {
				for ( Object row : queryResults ) {
					final Object[] rowArray = (Object[]) row;
					final Map versionsEntity = (Map) rowArray[ 0 ];
					final Object revisionData = rowArray[ 1 ];
					entities.add( getQueryResultRowValue( versionsEntity, revisionData, getEntityName() ) );
				}
			}
			return entities;
		}
	}

	private Object getQueryResultRowValue(Map versionsData, Object revisionData, String entityName) {
		final Number revision = getRevisionNumber( versionsData );

		final Object entity = entityInstantiator.createInstanceFromVersionsEntity( entityName, versionsData, revision );
		if ( selectEntitiesOnly ) {
			return entity;
		}

		final String revisionTypePropertyName = enversService.getAuditEntitiesConfiguration().getRevisionTypePropName();
		Object revisionType = versionsData.get( revisionTypePropertyName );
		if ( !includePropertyChanges ) {
			return new Object[] { entity, revisionData, revisionType };
		}

		if ( !isEntityUsingModifiedFlags() ) {
			throw new AuditException(
					String.format(
							Locale.ROOT,
							"The specified entity [%s] does not support or use modified flags.",
							getEntityConfiguration().getEntityClassName()
					)
			);
		}

		final Set changedPropertyNames =  getChangedPropertyNames( versionsData, revisionType );
		return new Object[] { entity, revisionData, revisionType, changedPropertyNames };
	}
}