001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.core.server.transfer;
018
019import com.echothree.model.control.core.common.transfer.EntityLockTransfer;
020import com.echothree.model.control.core.server.CoreDebugFlags;
021import com.echothree.model.data.core.server.entity.EntityInstance;
022import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
023import com.echothree.model.data.user.server.entity.UserVisit;
024import static com.echothree.model.jooq.server.tables.core.EntityLocks.EntityLocks;
025import com.echothree.util.common.exception.EntityLockException;
026import com.echothree.util.common.persistence.BasePK;
027import com.echothree.util.server.persistence.DslContextFactory;
028import com.echothree.util.server.persistence.EntityPermission;
029import com.echothree.util.server.persistence.PersistenceUtils;
030import java.sql.SQLException;
031import javax.enterprise.context.RequestScoped;
032import org.jooq.exception.DataAccessException;
033
034@RequestScoped
035public class EntityLockTransferCache
036        extends BaseCoreTransferCache {
037
038
039    /** Creates a new instance of EntityLockTransferCache */
040    protected EntityLockTransferCache() {
041        super();
042    }
043    
044    @SuppressWarnings("Finally")
045    public EntityLockTransfer getEntityLockTransfer(final UserVisit userVisit, BasePK lockTarget) {
046        var entityLockTransfer = (EntityLockTransfer)get(lockTarget);
047        
048        if(entityLockTransfer == null) {
049            var lockTargetEntityInstance = entityInstanceControl.getEntityInstanceByBasePK(lockTarget);
050            
051            entityLockTransfer = getEntityLockTransferByEntityInstance(userVisit, lockTargetEntityInstance, true);
052        }
053        
054        return entityLockTransfer;
055    }
056    
057    public EntityLockTransfer getEntityLockTransferByEntityInstance(final UserVisit userVisit, EntityInstance lockTargetEntityInstance) {
058        return getEntityLockTransferByEntityInstance(userVisit, lockTargetEntityInstance, false);
059    }
060    
061    private EntityLockTransfer getEntityLockTransferByEntityInstance(final UserVisit userVisit, EntityInstance lockTargetEntityInstance, boolean putInCache) {
062        EntityLockTransfer entityLockTransfer = null;
063        
064        try {
065            var dslContext = DslContextFactory.getInstance().getNTDslContext();
066
067            if(CoreDebugFlags.LogEntityLocks) {
068                log.info(">>> getEntityLockTransfer(lockTargetEntityInstance=" + lockTargetEntityInstance.getPrimaryKey() + ")");
069            }
070
071            if(CoreDebugFlags.LogEntityLocks) {
072                log.info("--- lockTargetEntityInstance=" + lockTargetEntityInstance);
073            }
074
075            var lock = dslContext
076                    .select(EntityLocks.LOCKED_BY_ENTITY_INSTANCE, EntityLocks.LOCKED_TIME, EntityLocks.LOCK_EXPIRATION_TIME)
077                    .from(EntityLocks)
078                    .where(EntityLocks.LOCK_TARGET_ENTITY_INSTANCE.eq(lockTargetEntityInstance.getPrimaryKey()))
079                    .fetchOne();
080
081            if(lock != null && lock.value1().getEntityId() != 0) {
082                var lockedByEntityInstancePK = lock.value1();
083                var lockedTime = lock.value2();
084                var expirationTime = lock.value3();
085                var lockedByEntityInstance = EntityInstanceFactory.getInstance().getEntityFromPK(EntityPermission.READ_ONLY, lockedByEntityInstancePK);
086                var lockTargetEntityInstanceTransfer = entityInstanceControl.getEntityInstanceTransfer(userVisit, lockTargetEntityInstance, false, false, false, false);
087                var lockedByEntityInstanceTransfer = entityInstanceControl.getEntityInstanceTransfer(userVisit, lockedByEntityInstance, false, false, false, false);
088
089                if(CoreDebugFlags.LogEntityLocks) {
090                    log.info("--- lockedByEntityInstancePK = " + lockedByEntityInstancePK);
091                    log.info("--- lockedByEntityInstance = " + lockedByEntityInstance);
092                    log.info("--- lockTargetEntityInstanceTransfer = " + lockTargetEntityInstanceTransfer.getEntityRef());
093                    log.info("--- lockTargetEntityInstanceTransfer = " + lockTargetEntityInstanceTransfer.getEntityRef());
094                }
095
096                var lockedTimeString = formatTypicalDateTime(userVisit, lockedTime);
097                var expirationTimeString = formatTypicalDateTime(userVisit, expirationTime);
098
099                entityLockTransfer = new EntityLockTransfer(lockTargetEntityInstanceTransfer, lockedByEntityInstanceTransfer, lockedTime, lockedTimeString, expirationTime, expirationTimeString);
100            }
101            
102            if(putInCache) {
103                transferCache.put(PersistenceUtils.getInstance().getBasePKFromEntityInstance(lockTargetEntityInstance), entityLockTransfer);
104            }
105        } catch (DataAccessException ex) {
106            var sqlException = ex.getCause(SQLException.class);
107            throw new EntityLockException(sqlException == null ? ex : sqlException);
108        }
109
110        if(CoreDebugFlags.LogEntityLocks) {
111            log.info("<<< entityLockTransfer=" + entityLockTransfer);
112        }
113
114        return entityLockTransfer;
115    }    
116    
117}