/**
    * This file Copyright (c) 2003-2011 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 static info.magnolia.cms.security.SecurityConstants.NODE_GROUPS;
  import static info.magnolia.cms.security.SecurityConstants.NODE_ROLES;
  import info.magnolia.cms.core.Content;
  import info.magnolia.context.MgnlContext;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Calendar;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.TreeSet;
  
  import javax.jcr.ItemNotFoundException;
  import javax.jcr.Node;
  import javax.jcr.Property;
  import javax.jcr.PropertyIterator;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.apache.commons.codec.binary.Base64;
  import org.apache.commons.lang.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * User for 4.5 instance
   * In difference from old MgnlUser, this class operates directly on JCR session and with JCR nodes/properties as our hierarchy managers are not
   * available at the login time.
   * Also in difference from MgnlUser, this class doesn't keep around instance of the user node! TODO: Test performance impact of such change.
   * @author had
   * @version $Id: MgnlUser.java 55879 2012-03-10 13:03:59Z mdivilek $
   */
  public class MgnlUser extends AbstractUser implements User, Serializable {
  
      private static final long serialVersionUID = 222L;
  
      private static final Logger log = LoggerFactory.getLogger(MgnlUser.class);
  
      private final Map<String, String> properties;
      private final Collection<String> groups;
      private final Collection<String> roles;
  
      private final String name;
      private final String language;
      private final String encodedPassword;
      private boolean enabled = true;
      private String path;
      private String uuid;
  
      private final String realm;
  
  
      public MgnlUser(String name, String realm, Collection<String> groups, Collection<String> roles, Map<String, String> properties) {
          this.name = name;
          this.roles = Collections.unmodifiableCollection(roles);
          this.groups = Collections.unmodifiableCollection(groups);
          this.properties = Collections.unmodifiableMap(properties);
          this.realm = realm;
  
          //shortcut some often accessed props so we don't have to search hashmap for them.
         language = properties.get(MgnlUserManager.PROPERTY_LANGUAGE);
         String enbld = properties.get(MgnlUserManager.PROPERTY_ENABLED);
         // all accounts are enabled by default and prop doesn't exist if the account was not disabled before
         enabled = enbld == null ? true : Boolean.parseBoolean(properties.get(MgnlUserManager.PROPERTY_ENABLED));
         encodedPassword = properties.get(MgnlUserManager.PROPERTY_PASSWORD);
     }
 
     public MgnlUser(String name, String realm, Collection<String> groups, Collection<String> roles, Map<String, String> properties, String path, String uuid) {
         this(name,realm,groups,roles,properties);
         this.path = path;
         this.uuid = uuid;
     }
 
     /**
      * Is this user in a specified group?
      * @param groupName the name of the group
      * @return true if in group
      */
     @Override
     public boolean inGroup(String groupName) {
         log.debug("inGroup({})", groupName);
         return this.hasAny(groupName, NODE_GROUPS);
     }
 
     /**
      * Remove a group. Implementation is optional
      * @param groupName
      */
     @Override
     public void removeGroup(String groupName) throws UnsupportedOperationException {
         log.debug("removeGroup({})", groupName);
         throw new UnsupportedOperationException("use manager to remove groups!");
     }
 
     /**
      * Adds this user to a group. Implementation is optional
      * @param groupName
      */
     @Override
     public void addGroup(String groupName) throws UnsupportedOperationException {
         log.debug("addGroup({})", groupName);
         throw new UnsupportedOperationException("use manager to add groups!");
     }
 
     @Override
     public boolean isEnabled() {
         log.debug("isEnabled()");
         return enabled ;
     }
 
     /**
      * This methods sets flag just on the bean. It does not update persisted user data. Use manager to update user data.
      * @deprecated since 4.5, use {@link UserManager#setProperty(User, String, Value)} instead
      */
     @Override
     @Deprecated
     public void setEnabled(boolean enabled) {
         log.debug("setEnabled({})", enabled);
         throw new UnsupportedOperationException("use manager to enable user!");
     }
 
     /**
      * Is this user in a specified role?
      * @param roleName the name of the role
      * @return true if in role
      */
     @Override
     public boolean hasRole(String roleName) {
         return SecuritySupport.Factory.getInstance().getUserManager(getRealm()).hasAny(getName(), roleName, NODE_ROLES);
     }
 
     @Override
     public void removeRole(String roleName) throws UnsupportedOperationException {
         log.debug("removeRole({})", roleName);
         throw new UnsupportedOperationException("use manager to remove roles!");
     }
 
     @Override
     public void addRole(String roleName) throws UnsupportedOperationException {
         log.debug("addRole({})", roleName);
         throw new UnsupportedOperationException("use manager to add roles!");
     }
 
     // TODO: methods like the ones below should not be in the object but rather in the manager, making object reusable with different managers.
     private boolean hasAny(final String name, final String nodeName) {
         long start = System.currentTimeMillis();
         try {
             String sessionName;
             if (StringUtils.equalsIgnoreCase(nodeName, NODE_ROLES)) {
                 sessionName = RepositoryConstants.USER_ROLES;
             } else {
                 sessionName = RepositoryConstants.USER_GROUPS;
             }
 
             // TODO: this is an original code. If you ever need to speed it up, turn it around - retrieve group or role by its name and read its ID, then loop through IDs this user has assigned to find out if he has that one or not.
             final Collection<String> groupsOrRoles = MgnlContext.doInSystemContext(new SilentSessionOp<Collection<String>>(RepositoryConstants.USERS) {
 
                 @Override
                 public Collection<String> doExec(Session session) throws RepositoryException {
                     Node groupsOrRoles = session.getNode(getName()).getNode(nodeName);
                     List<String> list = new ArrayList<String>();
                     for (PropertyIterator props = groupsOrRoles.getProperties(); props.hasNext();) {
                         // check for the existence of this ID
                         Property property = props.nextProperty();
                         try {
                             list.add(property.getString());
                         } catch (ItemNotFoundException e) {
                             log.debug("Role [{}] does not exist in the ROLES repository", name);
                         } catch (IllegalArgumentException e) {
                             log.debug("{} has invalid value", property.getPath());
                         }
                     }
                     return list;
                 }});
 
 
             return MgnlContext.doInSystemContext(new JCRSessionOp<Boolean>(sessionName) {
 
                 @Override
                 public Boolean exec(Session session) throws RepositoryException {
                     for (String groupOrRole : groupsOrRoles) {
                         // check for the existence of this ID
                         try {
                             if (session.getNodeByIdentifier(groupOrRole).getName().equalsIgnoreCase(name)) {
                                 return true;
                             }
                         } catch (ItemNotFoundException e) {
                             log.debug("Role [{}] does not exist in the ROLES repository", name);
                         }
                     }
                     return false;
                 }});
 
         } catch (RepositoryException e) {
             log.debug(e.getMessage(), e);
             //TODO: why are we swallowing exceptions silently here?
         } finally {
             log.debug("checked {} for {} in {}ms.", new Object[] {name, nodeName, (System.currentTimeMillis() - start)});
         }
         return false;
     }
 
     public int getFailedLoginAttempts(){
         return MgnlContext.doInSystemContext(new SilentSessionOp<Integer>(RepositoryConstants.USERS) {
             @Override
             public Integer doExec(Session session) throws RepositoryException {
                 Node userNode = session.getNode("/" + getRealm() + "/" + getName());
                 if (!userNode.hasProperty("failedLoginAttempts")){
                     userNode.setProperty("failedLoginAttempts", 0);
                     session.save();
                 }
                 return (int)userNode.getProperty("failedLoginAttempts").getLong();
             }});
     }
 
     public Calendar getReleaseTime(){
         return MgnlContext.doInSystemContext(new SilentSessionOp<Calendar>(RepositoryConstants.USERS) {
             @Override
             public Calendar doExec(Session session) throws RepositoryException {
                 Node userNode = session.getNode("/" + getRealm() + "/" + getName());
                 if (!userNode.hasProperty("releaseTime")){
                     userNode.setProperty("releaseTime", 0);
                     session.save();
                 }
                 return userNode.getProperty("releaseTime").getDate();
             }});
     }
 
     @Override
     public String getName() {
         log.debug("getName()=>{}", name);
         return name;
     }
 
     @Override
     public String getPassword() {
         return encodedPassword;
     }
 
     protected String decodePassword(String encodedPassword) {
         return new String(Base64.decodeBase64(encodedPassword.getBytes()));
     }
 
     @Override
     public String getLanguage() {
         log.debug("getLang()=>{}", language);
         return this.language;
     }
 
     @Override
     public String getProperty(String propertyName) {
         log.debug("getProperty({})", propertyName);
         return properties.get(propertyName);
     }
 
     @Override
     public Collection<String> getGroups() {
         log.debug("getGroups()");
         return groups;
     }
 
     @Override
     public Collection<String> getAllGroups() {
         // TODO: if the user is just a simple bean, then this method doesn't belong here anymore!!!!
         // should be moved to user manager or to group manager???
         log.debug("get groups for {}", getName());
 
         final Set<String> allGroups = new TreeSet<String>(String.CASE_INSENSITIVE_ORDER);
         final Collection<String> groups = getGroups();
 
         // FYI: can't initialize upfront as the instance of the user class needs to be created BEFORE repo is ready
         GroupManager man = SecuritySupport.Factory.getInstance().getGroupManager();
 
         // add all subbroups
         addSubgroups(allGroups, man, groups);
 
         // and only now add all direct user groups
         allGroups.addAll(groups);
 
         return allGroups;
     }
 
     @Override
     public Collection<String> getRoles() {
         log.debug("getRoles()");
         return roles;
     }
 
     @Override
     public Collection<String> getAllRoles() {
         // TODO: if the user is just a simple bean, then this method doesn't belong here anymore!!!!
         log.debug("get roles for {}", getName());
 
         final Set<String> allRoles = new TreeSet<String>(String.CASE_INSENSITIVE_ORDER);
         final Collection<String> roles = getRoles();
 
         // add all direct user groups
         allRoles.addAll(roles);
 
         Collection<String> allGroups = getAllGroups();
 
         // FYI: can't initialize upfront as the instance of the user class needs to be created BEFORE repo is ready
         GroupManager man = SecuritySupport.Factory.getInstance().getGroupManager();
 
         // add roles from all groups
         for (String group : allGroups) {
             try {
                 allRoles.addAll(man.getGroup(group).getRoles());
             } catch (AccessDeniedException e) {
                 log.debug("Skipping denied group " + group + " for user " + getName(), e);
             } catch (UnsupportedOperationException e) {
                 log.debug("Skipping unsupported  getGroup() for group " + group + " and user " + getName(), e);
             }
         }
         return allRoles;
     }
 
     public String getPath() {
         return this.path;
     }
 
     @Deprecated
     public void setPath(String path) {
         this.path = path;
     }
 
     /**
      * Any group from the groups is checked for the subgroups only if it is not in the allGroups yet. This is to prevent infinite loops in case of cyclic group assignment.
      */
     private void addSubgroups(final Set<String> allGroups, GroupManager man, Collection<String> groups) {
         for (String groupName : groups) {
             // check if this group was not already added to prevent infinite loops
             if (!allGroups.contains(groupName)) {
                 try {
                     Group group = man.getGroup(groupName);
                     if (group == null) {
                         log.error("Failed to resolve group {} for user {}.", groupName, name);
                         continue;
                     }
                     Collection<String> subgroups = group.getGroups();
                     // and recursively add more subgroups
                     addSubgroups(allGroups, man, subgroups);
                     allGroups.addAll(subgroups);
                 } catch (AccessDeniedException e) {
                     log.debug("Skipping denied group " + groupName + " for user " + getName(), e);
                 } catch (UnsupportedOperationException e) {
                     log.debug("Skipping unsupported  getGroup() for group " + groupName + " and user " + getName(), e);
                 }
 
             }
         }
     }
 
     public String getRealm() {
         return realm;
     }
 
     /**
      * Update the "last access" timestamp.
      * @deprecated since 4.5, use {@link UserManager#updateLastAccessTimestamp(User)} instead
      */
     @Deprecated
     public void setLastAccess() {
         throw new UnsupportedOperationException("Use manager to update user details.");
     }
 
     /**
      * Not every user needs to have a node behind. Use manager to obtain nodes
      * @deprecated since 4.5, use {@link UserManager#updateLastAccessTimestamp(User)} instead
      */
     @Deprecated
     public Content getUserNode() {
         throw new UnsupportedOperationException("Underlying storage node is no longer exposed nor required for custom user stores.");
     }
 
     /**
      * @deprecated since 4.5, use {@link UserManager} instead
      */
     @Override
     @Deprecated
     public void setProperty(String propertyName, String value) {
         throw new UnsupportedOperationException("Use manager to modify properties of the user.");
     }
 
     @Override
     public String getIdentifier() {
         return uuid;
     }
     
     /**
      * @deprecated since 4.5.1, use {@link MgnlUser#getIdentifier()} instead
      */
     @Deprecated
     public String getUuid() {
         return uuid;
     }
 
     @Override
     public String toString() {
         return "MgnlUser - " + name + " [" + uuid + "]";
     }
 }