/**
 * Copyright (C) 2011  JTalks.org Team
 * This library 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 2.1 of the License, or (at your option) any later version.
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.jtalks.jcommune.service.security;

import org.jtalks.common.model.permissions.JtalksPermission;
import org.jtalks.jcommune.plugin.api.PluginsPermissionFactory;
import org.springframework.security.acls.domain.PermissionFactory;
import org.springframework.security.acls.model.Permission;
import ru.javatalks.utils.general.Assert;

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.List;

/**
 * Permission factory for work with both of common and plugin permissions via their factories
 *
 * @author Mikhail Stryzhonok
 */
public class JCPermissionFactory implements PermissionFactory {

    /**
     * Factory for common permissions
     */
    private JtalksPermissionFactory jtalksPermissionFactory;

    /**
     * Factory for plugin permissions
     */
    private PluginsPermissionFactory pluginPermissionFactory;

    /**
     * Created to replace permissions from disabled/removed plugins
     */
    private enum NullPermission implements JtalksPermission {
        NULL_PERMISSION("0", "NULL_PERMISSION");

        private final String name;
        private final int mask;
        /**
         * Constructor for leading to general form of permission.
         * @param mask mask of the permission
         * @param name name of the permission
         */
        NullPermission(@Nonnull String mask, @Nonnull String name) {
            this.name = name;
            this.mask = Integer.parseInt(mask, 2);
        }

        @Override
        public String getName() {
            return name;
        }

        @Override
        public int getMask() {
            return mask;
        }

        @Override
        public String getPattern() {
            return null;
        }

        private void throwIfNameNotValid(String name) {
            Assert.throwIfNull(name, "The name can't be null");
        }

    }

    public JCPermissionFactory(JtalksPermissionFactory jtalksPermissionFactory, PluginsPermissionFactory pluginPermissionFactory) {
        this.jtalksPermissionFactory = jtalksPermissionFactory;
        this.pluginPermissionFactory = pluginPermissionFactory;
    }

    /**
     * Gets permission by permission mask. Firstly search in common permissions then in plugin permissions
     *
     * @param mask mask of interested permissions
     * @return permission with specified mask if it exist
     *         <b>NULL_PERMISSION</b> otherwise
     */
    @Override
    public Permission buildFromMask(int mask) {
        Permission permission = jtalksPermissionFactory.buildFromMask(mask);
        if (permission == null) {
            permission = pluginPermissionFactory.buildFromMask(mask);
        }
        if (permission == null) {
            permission = NullPermission.NULL_PERMISSION;
        }
        return permission;
    }

    /**
     * Gets permission by permission mask. Firstly search in common permissions then in plugin permissions
     *
     * @param name name of interested permissions
     * @return permission with specified name if it exist
     *         <b>NULL_PERMISSION</b> otherwise
     */
    @Override
    public Permission buildFromName(String name) {
        Permission permission = jtalksPermissionFactory.buildFromName(name);
        if (permission == null) {
            permission = pluginPermissionFactory.buildFromName(name);
        }
        if (permission == null) {
            permission = NullPermission.NULL_PERMISSION;
        }
        return permission;
    }

    /**
     * Gets list of permissions by names. Searches in common and plugin permissions
     *
     * @param names list of interested permissions names
     * @return list of permissions with specified names
     */
    @Override
    public List<Permission> buildFromNames(List<String> names) {
        List<Permission> permissions = new ArrayList<>();
        permissions.addAll(jtalksPermissionFactory.buildFromNames(names));
        permissions.addAll(pluginPermissionFactory.buildFromNames(names));
        return permissions;
    }
}