/**
    * This file Copyright (c) 2003-2018 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.core.Content;
  import info.magnolia.cms.util.DeprecationUtil;
  
  import java.io.Serializable;
  import java.util.Calendar;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.Map;
  
  import org.apache.jackrabbit.util.ISO8601;
  
  /**
   * A read-only snapshot of a Magnolia user as found in JCR at the moment of creation (e.g. upon login).
   * Any changes to the underlying properties, roles and groups will be reflected here only upon first logging out
   * and then logging in again.
   * To get a "real-time" view of a user's status, use {@link MgnlUserManager#getUser(String)} or similar methods instead.
   */
  public class MgnlUser extends AbstractUser implements User, Serializable {
      private final Map<String, String> properties;
      private final Collection<String> directGroups;
      private final Collection<String> directRoles;
      private final Collection<String> allGroups;
      private final Collection<String> allRoles;
  
      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;
  
      /**
       * This constructor is mainly used by {@link MgnlUserManager} or by custom extensions of this object.
       * If you extend MgnlUser, chances are you need to provide your own {@link MgnlUserManager} as well.
       *
       * @see MgnlUserManager#getUser(String)
       * @see MgnlUserManager#newUserInstance(javax.jcr.Node)
       *
       */
      public MgnlUser(String name, String realm, Collection<String> directGroups, Collection<String> directRoles, Map<String, String> properties, String path, String uuid, Collection<String> allGroups, Collection<String> allRoles) {
          this.name = name;
          this.directRoles = directRoles;
          this.directGroups = directGroups;
          this.allRoles = allRoles;
          this.allGroups = allGroups;
          this.properties = properties;
          this.realm = realm;
  
          //shortcut some often accessed props so we don't have to search hashmap for them.
          this.language = properties.get(MgnlUserManager.PROPERTY_LANGUAGE);
  
          final String enabledByDefault = properties.get(MgnlUserManager.PROPERTY_ENABLED);
          // all accounts are enabled by default and prop doesn't exist if the account was not disabled before
          this.enabled = enabledByDefault == null ? true : Boolean.parseBoolean(properties.get(MgnlUserManager.PROPERTY_ENABLED));
  
          this.encodedPassword = properties.get(MgnlUserManager.PROPERTY_PASSWORD);
          this.path = path;
          this.uuid = uuid;
      }
  
      /**
       * @deprecated since 5.5.5. Please use {@link #MgnlUser(String, String, Collection, Collection, Map, String, String, Collection, Collection)} instead.
       */
     @Deprecated
     public MgnlUser(String name, String realm, Collection<String> directGroups, Collection<String> directRoles, Map<String, String> properties, String path, String uuid) {
         this(name, realm, directGroups, directRoles, properties, path, uuid, Collections.emptySet(), Collections.emptySet());
         final String reason = "This constructor is deprecated since Magnolia 5.5.5.\n" +
                 "Be warned that instantiating directly MgnlUser with this constructor will result in an inconsistent object missing all roles and groups.\n" +
                 "Please use new public constructor instead.";
         DeprecationUtil.isDeprecated(reason);
     }
 
     /**
      * @deprecated since 5.5.5. Please use {@link #MgnlUser(String, String, Collection, Collection, Map, String, String, Collection, Collection)} instead.
      */
     @Deprecated
     public MgnlUser(String name, String realm, Collection<String> directGroups, Collection<String> directRoles, Map<String, String> properties) {
         this(name, realm, directGroups, directRoles, properties, null, null);
     }
 
     @Override
     public boolean inGroup(String groupName) {
         return allGroups.contains(groupName);
     }
 
     @Override
     public boolean isEnabled() {
         return enabled;
     }
 
     @Override
     public boolean hasRole(String roleName) {
         return allRoles.contains(roleName);
     }
 
     public int getFailedLoginAttempts() {
         try {
             return Integer.valueOf(this.properties.get("failedLoginAttempts"));
         } catch (Exception e) {
             return 0;
         }
     }
 
     public Calendar getReleaseTime() {
         try {
             return ISO8601.parse(this.properties.get("releaseTime"));
         } catch (Exception e) {
             return null;
         }
     }
 
     @Override
     public String getName() {
         return name;
     }
 
     @Override
     public String getPassword() {
         return encodedPassword;
     }
 
     @Deprecated
     /**
      * @deprecated Since 4.5.8. Password is now encoded by BCrypt and therefore cannot be decoded.
      */
     protected String decodePassword(String encodedPassword) {
         throw new UnsupportedOperationException();
     }
 
     @Override
     public String getLanguage() {
         return this.language;
     }
 
     @Override
     public String getProperty(String propertyName) {
         return properties.get(propertyName);
     }
 
     @Override
     public Collection<String> getGroups() {
         return Collections.unmodifiableCollection(directGroups);
     }
 
     @Override
     public Collection<String> getAllGroups() {
         return Collections.unmodifiableCollection(allGroups);
     }
 
     @Override
     public Collection<String> getRoles() {
         return Collections.unmodifiableCollection(directRoles);
     }
 
     @Override
     public Collection<String> getAllRoles() {
         return Collections.unmodifiableCollection(allRoles);
     }
 
     public String getPath() {
         return this.path;
     }
 
     @Deprecated
     public void setPath(String path) {
         this.path = path;
     }
 
 
     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 + "]";
     }
 }