Applied-Energistics-2/src/main/java/appeng/me/storage/MEInventoryHandler.java

/*
 * This file is part of Applied Energistics 2.
 * Copyright (c) 2013 - 2014, AlgorithmX2, All rights reserved.
 *
 * Applied Energistics 2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Applied Energistics 2 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Applied Energistics 2.  If not, see <http://www.gnu.org/licenses/lgpl>.
 */

package appeng.me.storage;


import appeng.api.config.AccessRestriction;
import appeng.api.config.Actionable;
import appeng.api.config.IncludeExclude;
import appeng.api.config.StorageFilter;
import appeng.api.networking.security.IActionSource;
import appeng.api.storage.IMEInventory;
import appeng.api.storage.IMEInventoryHandler;
import appeng.api.storage.IStorageChannel;
import appeng.api.storage.data.IAEStack;
import appeng.api.storage.data.IItemList;
import appeng.util.prioritylist.DefaultPriorityList;
import appeng.util.prioritylist.IPartitionList;


public class MEInventoryHandler<T extends IAEStack<T>> implements IMEInventoryHandler<T> {

    private final IMEInventoryHandler<T> internal;
    private int myPriority;
    private IncludeExclude myWhitelist;
    private AccessRestriction myAccess;
    private StorageFilter storageFilter;
    private IPartitionList<T> myPartitionList;

    private AccessRestriction cachedAccessRestriction;

    protected final boolean hasReadAccess() {
        return hasReadAccess;
    }

    protected final boolean hasWriteAccess() {
        return hasWriteAccess;
    }

    private boolean hasReadAccess;
    private boolean hasWriteAccess;
    private boolean isSticky;
    private boolean gettingAvailableContent;

    public MEInventoryHandler(final IMEInventory<T> i, final IStorageChannel<T> channel) {
        if (i instanceof IMEInventoryHandler) {
            this.internal = (IMEInventoryHandler<T>) i;
        } else {
            this.internal = new MEPassThrough<>(i, channel);
        }

        this.myPriority = 0;
        this.myWhitelist = IncludeExclude.WHITELIST;
        this.setBaseAccess(AccessRestriction.READ_WRITE);
        this.myPartitionList = new DefaultPriorityList<>();
    }

    IncludeExclude getWhitelist() {
        return this.myWhitelist;
    }

    public void setWhitelist(final IncludeExclude myWhitelist) {
        this.myWhitelist = myWhitelist;
    }

    public AccessRestriction getBaseAccess() {
        return this.myAccess;
    }

    public void setBaseAccess(final AccessRestriction myAccess) {
        this.myAccess = myAccess;
        this.cachedAccessRestriction = this.myAccess.restrictPermissions(this.internal.getAccess());
        this.hasReadAccess = this.cachedAccessRestriction.hasPermission(AccessRestriction.READ);
        this.hasWriteAccess = this.cachedAccessRestriction.hasPermission(AccessRestriction.WRITE);
    }

    public IPartitionList<T> getPartitionList() {
        return this.myPartitionList;
    }

    public void setPartitionList(final IPartitionList<T> myPartitionList) {
        this.myPartitionList = myPartitionList;
    }

    @Override
    public T injectItems(final T input, final Actionable type, final IActionSource src) {
        if (!this.canAccept(input)) {
            return input;
        }

        return this.internal.injectItems(input, type, src);
    }

    @Override
    public T extractItems(final T request, final Actionable type, final IActionSource src) {
        if (!this.canExtract(request)) {
            return null;
        }

        return this.internal.extractItems(request, type, src);
    }

    @Override
    public IItemList<T> getAvailableItems(final IItemList<T> out) {
        if (this.gettingAvailableContent || !this.hasReadAccess) {
            return out;
        }

        this.gettingAvailableContent = true;
        try {
            if (this.storageFilter == StorageFilter.EXTRACTABLE_ONLY) {
                var stackList = this.internal.getAvailableItems(this.getChannel().createList());
                for (final T t : stackList) {
                    if (this.shouldItemBeAvailable(t)) {
                        out.add(t);
                    }
                }
            } else {
                return this.internal.getAvailableItems(out);
            }
        } finally {
            this.gettingAvailableContent = false;
        }

        return out;
    }

    @Override
    public IStorageChannel<T> getChannel() {
        return this.internal.getChannel();
    }

    @Override
    public AccessRestriction getAccess() {
        return this.cachedAccessRestriction;
    }

    @Override
    public boolean isPrioritized(final T input) {
        if (this.myWhitelist == IncludeExclude.WHITELIST) {
            return this.myPartitionList.isListed(input) || this.internal.isPrioritized(input);
        }
        return false;
    }

    @Override
    public boolean canAccept(final T input) {
        if (!this.hasWriteAccess) {
            return false;
        }

        if (!this.passesBlackOrWhitelist(input)) {
            return false;
        }

        return this.internal.canAccept(input);
    }

    @Override
    public int getPriority() {
        return this.myPriority;
    }

    public void setPriority(final int myPriority) {
        this.myPriority = myPriority;
    }

    @Override
    public int getSlot() {
        return this.internal.getSlot();
    }

    @Override
    public boolean validForPass(final int i) {
        return true;
    }

    public IMEInventory<T> getInternal() {
        return this.internal;
    }

    @Override
    public boolean isSticky() {
        return isSticky;
    }

    public void setSticky(boolean isSticky) {
        this.isSticky = isSticky;
    }

    protected boolean canExtract(T request) {
        return this.hasReadAccess && this.passesBlackOrWhitelist(request);
    }

    protected boolean shouldItemBeAvailable(T request) {
        return this.hasReadAccess && this.passesBlackOrWhitelist(request);
    }

    public boolean passesBlackOrWhitelist(T input) {
        if (this.myPartitionList.isEmpty()) {
            return true;
        }

        return switch (this.myWhitelist) {
            case WHITELIST -> this.myPartitionList.isListed(input);
            case BLACKLIST -> !this.myPartitionList.isListed(input);
        };
    }

    public StorageFilter getStorageFilter() {
        return storageFilter;
    }

    public void setStorageFilter(StorageFilter storageFilter) {
        this.storageFilter = storageFilter;
    }
}