/**
    * Waffle (https://github.com/dblock/waffle)
    *
    * Copyright (c) 2010 - 2015 Application Security, Inc.
    *
    * All rights reserved. This program and the accompanying materials
    * are made available under the terms of the Eclipse Public License v1.0
    * which accompanies this distribution, and is available at
    * http://www.eclipse.org/legal/epl-v10.html
   *
   * Contributors:
   *     Application Security, Inc.
   */
  package waffle.apache;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.catalina.Realm;
  import org.apache.catalina.realm.GenericPrincipal;
  
  import com.google.common.base.Joiner;
  
  import waffle.windows.auth.IWindowsAccount;
  import waffle.windows.auth.IWindowsIdentity;
  import waffle.windows.auth.PrincipalFormat;
  import waffle.windows.auth.WindowsAccount;
  
  /**
   * A Windows Principal.
   * 
   * @author dblock[at]dblock[dot]org
   */
  public class GenericWindowsPrincipal extends GenericPrincipal {
  
      /** The sid. */
      private final byte[]                      sid;
      
      /** The sid string. */
      private final String                      sidString;
      
      /** The groups. */
      private final Map<String, WindowsAccount> groups;
  
      /**
       * A windows principal.
       * 
       * @param newWindowsIdentity
       *            Windows identity.
       * @param newRealm
       *            Authentication realm.
       * @param newPrincipalFormat
       *            Principal format.
       * @param newRoleFormat
       *            Role format.
       */
      public GenericWindowsPrincipal(final IWindowsIdentity newWindowsIdentity, final Realm newRealm,
              final PrincipalFormat newPrincipalFormat, final PrincipalFormat newRoleFormat) {
          super(newRealm, newWindowsIdentity.getFqn(), "",
                  GenericWindowsPrincipal.getRoles(newWindowsIdentity, newPrincipalFormat, newRoleFormat));
          this.sid = newWindowsIdentity.getSid();
          this.sidString = newWindowsIdentity.getSidString();
          this.groups = GenericWindowsPrincipal.getGroups(newWindowsIdentity.getGroups());
      }
  
      /**
       * Gets the roles.
       *
       * @param windowsIdentity
       *            the windows identity
       * @param principalFormat
       *            the principal format
       * @param roleFormat
       *            the role format
       * @return the roles
       */
      private static List<String> getRoles(final IWindowsIdentity windowsIdentity, final PrincipalFormat principalFormat,
              final PrincipalFormat roleFormat) {
          final List<String> roles = new ArrayList<String>();
          roles.addAll(GenericWindowsPrincipal.getPrincipalNames(windowsIdentity, principalFormat));
          for (final IWindowsAccount group : windowsIdentity.getGroups()) {
              roles.addAll(GenericWindowsPrincipal.getRoleNames(group, roleFormat));
          }
          return roles;
      }
  
      /**
       * Gets the groups.
       *
       * @param groups
       *            the groups
       * @return the groups
       */
      private static Map<String, WindowsAccount> getGroups(final IWindowsAccount[] groups) {
          final Map<String, WindowsAccount> groupMap = new HashMap<String, WindowsAccount>();
          for (final IWindowsAccount group : groups) {
              groupMap.put(group.getFqn(), new WindowsAccount(group));
         }
         return groupMap;
     }
 
     /**
      * Byte representation of the SID.
      * 
      * @return Array of bytes.
      */
     public byte[] getSid() {
         return this.sid.clone();
     }
 
     /**
      * String representation of the SID.
      * 
      * @return String.
      */
     public String getSidString() {
         return this.sidString;
     }
 
     /**
      * Windows groups that the user is a member of.
      * 
      * @return A map of group names to groups.
      */
     public Map<String, WindowsAccount> getGroups() {
         return this.groups;
     }
 
     /**
      * Returns a list of role principal objects.
      * 
      * @param group
      *            Windows group.
      * @param principalFormat
      *            Principal format.
      * @return List of role principal objects.
      */
     private static List<String> getRoleNames(final IWindowsAccount group, final PrincipalFormat principalFormat) {
         final List<String> principals = new ArrayList<String>();
         switch (principalFormat) {
             case FQN:
                 principals.add(group.getFqn());
                 break;
             case SID:
                 principals.add(group.getSidString());
                 break;
             case BOTH:
                 principals.add(group.getFqn());
                 principals.add(group.getSidString());
                 break;
             case NONE:
                 break;
             default:
                 break;
         }
         return principals;
     }
 
     /**
      * Returns a list of user principal objects.
      * 
      * @param windowsIdentity
      *            Windows identity.
      * @param principalFormat
      *            Principal format.
      * @return A list of user principal objects.
      */
     private static List<String> getPrincipalNames(final IWindowsIdentity windowsIdentity,
             final PrincipalFormat principalFormat) {
         final List<String> principals = new ArrayList<String>();
         switch (principalFormat) {
             case FQN:
                 principals.add(windowsIdentity.getFqn());
                 break;
             case SID:
                 principals.add(windowsIdentity.getSidString());
                 break;
             case BOTH:
                 principals.add(windowsIdentity.getFqn());
                 principals.add(windowsIdentity.getSidString());
                 break;
             case NONE:
                 break;
             default:
                 break;
         }
         return principals;
     }
 
     /**
      * Get an array of roles as a string.
      * 
      * @return Role1, Role2, ...
      */
     public String getRolesString() {
         return Joiner.on(", ").join(this.getRoles());
     }
 }