/**
 * This file Copyright (c) 2003-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.cms.security;

import info.magnolia.cms.security.auth.Entity;
import info.magnolia.cms.security.auth.GroupList;
import info.magnolia.cms.security.auth.RoleList;
import info.magnolia.context.MgnlContext;

import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

import javax.security.auth.Subject;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * A user which is not stored in Magnolia. For instance a user stored in LDAP or AD.
 * @version $Revision:2558 $ ($Author:scharles $)
 */
public class ExternalUser extends AbstractUser implements Serializable {
    private static final Logger log = LoggerFactory.getLogger(ExternalUser.class);

    /**
     * User properties.
     */
    private Entity userDetails;

    /**
     * User properties.
     */
    private Map<String, String> properties;

    /**
     * User roles.
     */
    private RoleList roleList;

    /**
     * User groups.
     */
    private GroupList groupList;

    /**
     * @param subject as created by login module
     * @deprecated since 4.5 use ExternalUser(java.util.Map, info.magnolia.cms.security.auth.GroupList,
     *              info.magnolia.cms.security.auth.RoleList) instead
     */
    @Deprecated
    protected ExternalUser(Subject subject) {
        final Set<Entity> principalDetails = subject.getPrincipals(Entity.class);
        final Iterator<Entity> entityIterator = principalDetails.iterator();
        this.userDetails = entityIterator.next();

        final Set<RoleList> principalRoles = subject.getPrincipals(RoleList.class);
        final Iterator<RoleList> roleListIterator = principalRoles.iterator();
        this.roleList = roleListIterator.next();

        final Set<GroupList> principalGroups = subject.getPrincipals(GroupList.class);
        final Iterator<GroupList> groupListIterator = principalGroups.iterator();
        this.groupList = groupListIterator.next();
    }

    protected ExternalUser(Map<String, String> properties, GroupList groupList, RoleList roleList) {
        this.properties = properties;
        this.groupList = groupList;
        this.roleList = roleList;
    }

    @Override
    public boolean hasRole(String roleName) {
        return this.roleList.has(roleName);
    }

    @Override
    public void removeRole(String roleName) {
        throw new UnsupportedOperationException("not implemented for this ExternalUser");
    }

    @Override
    public void addRole(String roleName) {
        throw new UnsupportedOperationException("not implemented for this ExternalUser");
    }

    /**
     * Is this user in a specified group?
     * @return true if in group
     */
    @Override
    public boolean inGroup(String groupName) {
        return this.groupList.has(groupName);
    }

    /**
     * Remove a group. Implementation is optional
     */
    @Override
    public void removeGroup(String groupName) throws UnsupportedOperationException {
        throw new UnsupportedOperationException("not implemented for this ExternalUser");
    }

    /**
     * Adds this user to a group. Implementation is optional
     */
    @Override
    public void addGroup(String groupName) throws UnsupportedOperationException {
        throw new UnsupportedOperationException("not implemented for this ExternalUser");
    }

    @Override
    public boolean isEnabled() {
        return true;
    }

    @Override
    public void setEnabled(boolean enabled) {
    }

    @Override
    public String getLanguage() {
        String language = this.properties.get(Entity.LANGUAGE);
        if (null == language) {
            language = MgnlContext.getSystemContext().getLocale().getLanguage();
        }
        return language;
    }

    @Override
    public String getName() {
        return this.properties.get(Entity.NAME);
    }

    @Override
    public String getPassword() {
        return this.properties.get(Entity.PASSWORD);
    }

    public String getEmail() {
        return this.properties.get(Entity.EMAIL);
    }

    @Override
    public String getProperty(String propertyName) {
        String property = this.properties.get(propertyName);
        if(null == property){
            log.debug("Unable to retrieve property " + propertyName + " for user " + getName());
        }
        return property;
    }

    @Override
    public void setProperty(String propertyName, String value) {
        this.properties.put(propertyName, value);
    }

    @Override
    public String getIdentifier() {
        throw new UnsupportedOperationException("not implemented for this ExternalUser");
    }

    @Override
    public Collection<String> getGroups() {
        return this.groupList.getList();
    }

    @Override
    public Collection<String> getAllGroups() {
        return this.getGroups();
    }

    @Override
    public Collection<String> getRoles() {
        return this.roleList.getList();
    }

    @Override
    public Collection<String> getAllRoles() {
        return this.getRoles();
    }
}