org.mycore.access.mcrimpl.MCRAccessStore 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.access.mcrimpl;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.mycore.backend.jpa.access.MCRJPAAccessStore;
import org.mycore.common.config.MCRConfiguration2;
import org.mycore.datamodel.common.MCRXMLMetadataManager;

/**
 * The purpose of this interface is to make the choice of the persistence layer
 * configurable. Any concrete database-class which stores MyCoRe Access control
 * must implement this interface. Which database actually will be used can then
 * be configured by reading the value MCR.Persistence.Access.Store.Class
 * from mycore.properties.access
 * 
 * @author Arne Seifert
 * @version $Revision$ $Date$
 */
public abstract class MCRAccessStore {
    private static final Logger LOGGER = LogManager.getLogger(MCRAccessStore.class);

    protected static final String SQL_DATEFORMAT = "yyyy-MM-dd HH:mm:ss";

    protected static final String ACCESS_POOLS = MCRConfiguration2.getString("MCR.AccessPools")
        .orElse("read,write,delete");

    private static MCRAccessStore implementation;

    public abstract String getRuleID(String objID, String acPool);

    public abstract void createAccessDefinition(MCRRuleMapping accessdata);

    public abstract void deleteAccessDefinition(MCRRuleMapping accessdata);

    public abstract void updateAccessDefinition(MCRRuleMapping accessdata);

    public abstract MCRRuleMapping getAccessDefinition(String pool, String objid);

    public abstract Collection getMappedObjectId(String pool); // ArrayList with ObjID's as String

    public abstract Collection getPoolsForObject(String objid); // ArrayList with pools as String

    public abstract Collection getDatabasePools();

    public abstract boolean existsRule(String objid, String pool);

    public abstract boolean isRuleInUse(String ruleid);

    /**
     * 
     * @return a collection of all String IDs an access rule is assigned to
     */
    public abstract Collection getDistinctStringIDs();

    public static MCRAccessStore getInstance() {
        try {
            if (implementation == null) {
                implementation = MCRConfiguration2
                    .getSingleInstanceOf("MCR.Persistence.Access.Store.Class", MCRJPAAccessStore.class).get();
            }
        } catch (Exception e) {
            LOGGER.error(e);
        }

        return implementation;
    }

    public static Collection getPools() {
        String[] pool = ACCESS_POOLS.split(",");
        return Arrays.asList(pool);
    }

    /**
     * alle Elemente eines Datentypes aufbereiten
     * @param type document type
     * 
     * @return List of MCRAccessDefinition
     * @see MCRAccessDefinition
     */
    public Collection getDefinition(String type) {
        try {
            HashMap> sqlDefinition = new HashMap<>();
            Collection pools = MCRAccessStore.getInstance().getDatabasePools();
            //merge pools
            pools.removeAll(getPools());
            pools.addAll(getPools());

            for (String pool : pools) {
                sqlDefinition.put(pool, MCRAccessStore.getInstance().getMappedObjectId(pool));
            }

            Collection ret = new LinkedList<>();
            Collection elements;
            MCRAccessDefinition def = null;

            if (MCRConfiguration2.getOrThrow("MCR.Metadata.Type." + type, Boolean::parseBoolean)) {
                elements = MCRXMLMetadataManager.instance().listIDsOfType(type);
            } else {
                return Collections.emptySet();
            }

            for (String element : elements) {
                def = new MCRAccessDefinition();
                def.setObjID(element);
                for (String pool : pools) {
                    Collection l = sqlDefinition.get(pool);
                    if (l.contains(element)) {
                        def.addPool(pool, "X");
                    } else {
                        def.addPool(pool, " ");
                    }
                }
                ret.add(def);
            }
            return ret;
        } catch (Exception e) {
            LOGGER.error("definition loading failed: ", e);
            return null;
        }
    }

    public Collection getRules(String objid) {
        try {
            Collection pools = MCRAccessStore.getInstance().getDatabasePools();
            //merge pools
            pools.removeAll(getPools());
            pools.addAll(getPools());

            Collection ret = new LinkedList<>();
            //List elements = new LinkedList();
            MCRAccessDefinition def = new MCRAccessDefinition();
            def.setObjID(objid);
            for (String pool : pools) {
                String rule = getRuleID(objid, pool);
                if (rule != null) {
                    def.addPool(pool, rule);
                } else {
                    def.addPool(pool, " ");
                }
            }
            ret.add(def);
            return ret;
        } catch (Exception e) {
            LOGGER.error("definition loading failed: ");
            return null;
        }
    }

}