org.mycore.datamodel.common.MCRServiceFlagEventHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.datamodel.common;

import org.mycore.access.MCRAccessException;
import org.mycore.common.MCRException;
import org.mycore.common.MCRSessionMgr;
import org.mycore.common.config.MCRConfiguration2;
import org.mycore.common.events.MCREvent;
import org.mycore.common.events.MCREventHandlerBase;
import org.mycore.datamodel.classifications2.MCRCategoryID;
import org.mycore.datamodel.metadata.MCRDerivate;
import org.mycore.datamodel.metadata.MCRMetaLinkID;
import org.mycore.datamodel.metadata.MCRMetadataManager;
import org.mycore.datamodel.metadata.MCRObject;
import org.mycore.datamodel.metadata.MCRObjectID;
import org.mycore.datamodel.metadata.MCRObjectService;

/**
 * This event handler sets the service flags "createdby" and "modifiedby" for users who created / modified a
 * MyCoReObject and also added a state service flag using classification defined in
 * "MCR.Metadata.Service.State.Classification.ID" (default "state") and category defined in
 * "MCR.Metadata.Service.State.Category.Default" (default "submitted").
 * If the state changes in an update event of an MCRObject the state gets propagated to all of it's derivates.
 *
 * @author Robert Stephan
 * @author Thomas Scheffler (yagee)
 */
public class MCRServiceFlagEventHandler extends MCREventHandlerBase {

    @Override
    protected final void handleObjectCreated(MCREvent evt, MCRObject obj) {
        if (!obj.isImportMode()) {
            handleCreated(obj.getService());
            setDefaultState(obj.getService());
        }
    }

    @Override
    protected final void handleObjectUpdated(MCREvent evt, MCRObject obj) {
        if (!obj.isImportMode()) {
            handleUpdated(obj.getService());
            if (isStateChanged((MCRObject) evt.get(MCREvent.OBJECT_OLD_KEY), obj)) {
                updateDerivateState(obj);
            }
        }
    }

    @Override
    protected void handleDerivateCreated(MCREvent evt, MCRDerivate der) {
        if (!der.isImportMode()) {
            handleCreated(der.getService());
        }
    }

    @Override
    protected void handleDerivateUpdated(MCREvent evt, MCRDerivate der) {
        if (!der.isImportMode()) {
            handleUpdated(der.getService());
        }
    }

    protected static void handleCreated(MCRObjectService objService) {
        objService.removeFlags(MCRObjectService.FLAG_TYPE_CREATEDBY);
        objService.addFlag(MCRObjectService.FLAG_TYPE_CREATEDBY, MCRSessionMgr.getCurrentSession()
            .getUserInformation().getUserID());
        handleUpdated(objService);
    }

    protected static void setDefaultState(MCRObjectService objService) {
        if (objService.getState() == null) {
            MCRCategoryID defaultState = new MCRCategoryID(
                MCRConfiguration2.getStringOrThrow("MCR.Metadata.Service.State.Classification.ID"),
                MCRConfiguration2.getStringOrThrow("MCR.Metadata.Service.State.Category.Default"));
            objService.setState(defaultState);
        }
    }

    protected static void handleUpdated(MCRObjectService objectService) {
        objectService.removeFlags(MCRObjectService.FLAG_TYPE_MODIFIEDBY);
        objectService.addFlag(MCRObjectService.FLAG_TYPE_MODIFIEDBY,
            MCRSessionMgr.getCurrentSession().getUserInformation().getUserID());
    }

    protected static boolean isStateChanged(MCRObject oldVersion, MCRObject obj) {
        MCRCategoryID newState = obj.getService().getState();
        return newState != null && oldVersion != null && !newState.equals(oldVersion.getService().getState());
    }

    protected static void updateDerivateState(MCRObject obj) {
        MCRCategoryID state = obj.getService().getState();
        obj
            .getStructure()
            .getDerivates()
            .stream()
            .map(MCRMetaLinkID::getXLinkHrefID)
            .forEach(id -> updateDerivateState(id, state));
    }

    protected static void updateDerivateState(MCRObjectID derID, MCRCategoryID state) {
        MCRDerivate derivate = MCRMetadataManager.retrieveMCRDerivate(derID);
        MCRCategoryID oldState = derivate.getService().getState();
        if (!state.equals(oldState)) {
            derivate.getService().setState(state);
            try {
                MCRMetadataManager.update(derivate);
            } catch (MCRAccessException e) {
                throw new MCRException("Error while updating derivate state!", e);
            }
        }
    }

}