/*
 *  Copyright 2017 Anyware Services
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.ametys.plugins.extraction.execution;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.commons.collections.CollectionUtils;

import org.ametys.core.group.GroupIdentity;
import org.ametys.core.group.GroupManager;
import org.ametys.core.user.UserIdentity;
import org.ametys.plugins.extraction.ExtractionConstants;
import org.ametys.plugins.extraction.component.ExtractionComponent;
import org.ametys.runtime.i18n.I18nizableText;

/**
 * Object representing the extraction definition file content
 */
public class Extraction
{
    /**
     * Visibility of a Query
     */
    public enum Visibility
    {
        /** Private visibility. */
        PRIVATE,
        /** Shared visibility. */
        SHARED,
        /** Public visibility. */
        PUBLIC;
        
        @Override
        public String toString()
        {
            return name().toLowerCase();
        }
    }
    
    /**
     * Rights profiles
     */
    public enum ExtractionProfile
    {
        /** Read access */
        READ_ACCESS,
        /** Write access */
        WRITE_ACCESS;
        
        @Override
        public String toString()
        {
            return name().toLowerCase();
        }
        
        /**
         * Extraction profile title getter.
         * @return The title of the profile
         */
        public I18nizableText getTitle()
        {
            switch (this)
            {
                case READ_ACCESS: 
                    return new I18nizableText(ExtractionConstants.PLUGIN_NAME, "PLUGINS_EXTRACTION_RIGHT_PROFILE_READ_TITLE");
                case WRITE_ACCESS: 
                    return new I18nizableText(ExtractionConstants.PLUGIN_NAME, "PLUGINS_EXTRACTION_RIGHT_PROFILE_WRITE_TITLE");
                default: 
                    return null;
            }
        }

        /**
         * Extraction profile description getter.
         * @return The description of the profile
         */
        public I18nizableText getDescription()
        {
            switch (this)
            {
                case READ_ACCESS: 
                    return new I18nizableText(ExtractionConstants.PLUGIN_NAME, "PLUGINS_EXTRACTION_RIGHT_PROFILE_READ_DESCRIPTION");
                case WRITE_ACCESS: 
                    return new I18nizableText(ExtractionConstants.PLUGIN_NAME, "PLUGINS_EXTRACTION_RIGHT_PROFILE_WRITE_DESCRIPTION");
                default: 
                    return null;
            }
        }
    }
    
    private String _descriptionId;
    private List<ExtractionComponent> _extractionComponents;
    private List<String> _displayOptionalColumnsNames;
    private Map<String, String> _queryVariablesNamesAndContentTypes;
    private Visibility _visibility;
    private UserIdentity _author;
    private Map<ExtractionProfile, Set<UserIdentity>> _grantedUsers = new HashMap<>();
    private Map<ExtractionProfile, Set<GroupIdentity>> _grantedGroups = new HashMap<>();
    
    /**
     * Retrieves the identifier of the extraction's description
     * @return the identifier of the extraction's description
     */
    public String getDescriptionId()
    {
        return _descriptionId;
    }
    
    /**
     * Set the identifier of the extraction's description
     * @param descriptionId the identifier to set
     */
    public void setDescriptionId(String descriptionId)
    {
        _descriptionId = descriptionId;
    }
    
    /**
     * Retrieves the list of the extraction components
     * @return The extraction components 
     */
    public List<ExtractionComponent> getExtractionComponents()
    {
        return null != _extractionComponents ? _extractionComponents : new ArrayList<>();
    }
    
    /**
     * Add an extraction component 
     * @param extractionComponent The extraction component to add
     */
    public void addExtractionComponent(ExtractionComponent extractionComponent)
    {
        if (null == _extractionComponents)
        {
            _extractionComponents = new ArrayList<>();
        }
        _extractionComponents.add(extractionComponent);
    }
    
    /**
     * Retrieves the list of variables names controlling display of optional columns
     * @return The variables names
     */
    public List<String> getDisplayOptionalColumnsNames()
    {
        return null != _displayOptionalColumnsNames ? _displayOptionalColumnsNames : new ArrayList<>();
    }
    
    /**
     * Set variables names controlling display of optional columns
     * @param displayOptionalColumnsNames the variables for the optional columns to set
     */
    public void setDisplayOptionalColumnsNames(List<String> displayOptionalColumnsNames)
    {
        _displayOptionalColumnsNames = displayOptionalColumnsNames;
    }
    
    /**
     * Retrieves the list of variables names and content type to use in queries
     * @return A Map containing variables names and content types
     */
    public Map<String, String> getQueryVariablesNamesAndContentTypes()
    {
        return null != _queryVariablesNamesAndContentTypes ? _queryVariablesNamesAndContentTypes : new HashMap<>();
    }
    
    /**
     * Set variables names and content types to use in queries
     * @param queryVariablesNamesAndContentTypes A Map containing variables names and content types to set
     */
    public void setQueryVariablesNamesAndContentTypes(Map<String, String> queryVariablesNamesAndContentTypes)
    {
        _queryVariablesNamesAndContentTypes = queryVariablesNamesAndContentTypes;
    }
    
    /**
     * Get the visibility of the extraction
     * @return The visibility
     */
    public Visibility getVisibility()
    {
        return _visibility != null ? _visibility : Visibility.PUBLIC;
    }
    
    /**
     * Set the extraction's visibility
     * @param visibility the visibility
     */
    public void setVisibility (Visibility visibility)
    {
        _visibility = visibility;
    }

    /**
     * Get the author of the extraction
     * @return The author
     */
    public UserIdentity getAuthor ()
    {
        return _author;
    }
    
    /**
     * Set the author of this extraction.
     * @param author the author
     */
    public void setAuthor(UserIdentity author)
    {
        _author = author;
    }
    
    /**
     * Get the granted users
     * @param profile the extraction profile
     * @return the granted users
     */
    public Set<UserIdentity> getGrantedUsers(ExtractionProfile profile)
    {
        Set<UserIdentity> grantedUsers = new HashSet<>();
        grantedUsers.add(getAuthor());
        
        if (_grantedUsers.containsKey(profile))
        {
            grantedUsers.addAll(_grantedUsers.get(profile));
        }

        return grantedUsers;
    }
    
    /**
     * Get the granted groups
     * @param profile the extraction profile
     * @return the granted groups
     */
    public Set<GroupIdentity> getGrantedGroups(ExtractionProfile profile)
    {
        if (_grantedGroups.containsKey(profile))
        {
            return _grantedGroups.get(profile);
        }
        else
        {
            return Set.of();
        }
    }
    
    /**
     * Determines if an user has READ access to this extraction.
     * @param user The user
     * @param groupManager The group manager to determine the user's groups
     * @return <code>true</code> if the user has read access, <code>false</code> otherwise
     */
    public boolean canRead(UserIdentity user, GroupManager groupManager)
    {
        Visibility visibility = getVisibility();
        
        switch (visibility)
        {
            case PRIVATE:
                return getAuthor().equals(user);
                
            case SHARED:
                return getGrantedUsers(ExtractionProfile.READ_ACCESS).contains(user) || CollectionUtils.containsAny(getGrantedGroups(ExtractionProfile.READ_ACCESS), groupManager.getUserGroups(user)) || canWrite(user, groupManager);

            case PUBLIC:
            default:
                return true;
        }
    }
    
    /**
     * Determines if an user has WRITE access to this extraction.
     * @param user The user
     * @param groupManager The group manager to determine the user's groups
     * @return <code>true</code> if the user has write access, <code>false</code> otherwise
     */
    public boolean canWrite(UserIdentity user, GroupManager groupManager)
    {
        Visibility visibility = getVisibility();
        
        switch (visibility)
        {
            case PRIVATE:
                return getAuthor().equals(user);
                
            case SHARED:
                return getGrantedUsers(ExtractionProfile.WRITE_ACCESS).contains(user) || CollectionUtils.containsAny(getGrantedGroups(ExtractionProfile.WRITE_ACCESS), groupManager.getUserGroups(user));

            case PUBLIC:
            default:
                return true;
        }
    }
    
    /**
     * Set the granted users
     * @param profile the extraction profile
     * @param users the granted users
     */
    public void setGrantedUsers (ExtractionProfile profile, Set<UserIdentity> users)
    {
        UserIdentity author = this.getAuthor();
        users.remove(author);
        _grantedUsers.put(profile, users);
    }
    
    /**
     * Set the granted groups
     * @param profile the extraction profile
     * @param groups the granted groups
     */
    public void setGrantedGroups(ExtractionProfile profile, Set<GroupIdentity> groups)
    {
        _grantedGroups.put(profile, groups);
    }
}