UserController.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information

namespace DotNetNuke.Entities.Users
{
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.Configuration;
    using System.Linq;
    using System.Text.RegularExpressions;
    using System.Threading;
    using System.Web;

    using DotNetNuke.Abstractions.Portals;
    using DotNetNuke.Collections.Internal;
    using DotNetNuke.Common;
    using DotNetNuke.Common.Utilities;
    using DotNetNuke.Data;
    using DotNetNuke.Entities.Controllers;
    using DotNetNuke.Entities.Modules;
    using DotNetNuke.Entities.Portals;
    using DotNetNuke.Entities.Profile;
    using DotNetNuke.Entities.Users.Membership;
    using DotNetNuke.Framework;
    using DotNetNuke.Security;
    using DotNetNuke.Security.Membership;
    using DotNetNuke.Security.Permissions;
    using DotNetNuke.Security.Roles;
    using DotNetNuke.Services.Cache;
    using DotNetNuke.Services.FileSystem;
    using DotNetNuke.Services.Localization;
    using DotNetNuke.Services.Log.EventLog;
    using DotNetNuke.Services.Mail;
    using DotNetNuke.Services.Messaging.Data;

    using MembershipProvider = DotNetNuke.Security.Membership.MembershipProvider;

    /// <summary>
    /// The UserController class provides Business Layer methods for Users.
    /// </summary>
    /// <remarks>
    /// DotNetNuke user management is base on asp.net membership provider, but  the default implementation of these providers
    /// do not satisfy the broad set of use cases which we need to support in DotNetNuke. so The dependency of DotNetNuke on the
    /// MemberRole (ASP.NET 2 Membership) components will be abstracted into a DotNetNuke Membership Provider, in order to allow
    /// developers complete flexibility in implementing alternate Membership approaches.
    /// <list type="bullet">
    /// <item>This will allow for a number of enhancements to be added</item>
    /// <item>Removal of dependence on the HttpContext</item>
    /// <item>Support for Hashed Passwords</item>
    /// <item>Support for Password Question and Answer</item>
    /// <item>Enforce Password Complexity</item>
    /// <item>Password Aging (Expiry)</item>
    /// <item>Force Password Update</item>
    /// <item>Enable/Disable Password Retrieval/Reset</item>
    /// <item>CAPTCHA Support</item>
    /// <item>Redirect after registration/login/logout</item>
    /// </list>
    /// </remarks>
    /// <seealso cref="DotNetNuke.Security.Membership.MembershipProvider"/>
    /// -----------------------------------------------------------------------------
    public partial class UserController : ServiceLocator<IUserController, UserController>, IUserController
    {
        /// <summary>
        /// Gets or sets the display name format with support for replacing some tokens.
        /// </summary>
        /// <remarks>Valid tokens are: [USERID], [FIRSTNAME], [LASTNAME] and [USERNAME].</remarks>
        public string DisplayFormat { get; set; }

        /// <summary>
        /// Gets or sets the site (portal) id.
        /// </summary>
        public int PortalId { get; set; }

        /// <summary>
        /// Gets the number count for all duplicate e-mail adresses in the database.
        /// </summary>
        /// <returns>An integer representing the amount of duplicate emails.</returns>
        public static int GetDuplicateEmailCount()
        {
            return DataProvider.Instance().GetDuplicateEmailCount(PortalSettings.Current.PortalId);
        }

        /// <summary>
        /// add new userportal record (used for creating sites with existing user).
        /// </summary>
        /// <param name="portalId">portalid.</param>
        /// <param name="userId">userid.</param>
        public static void AddUserPortal(int portalId, int userId)
        {
            Requires.NotNullOrEmpty("portalId", portalId.ToString());
            Requires.NotNullOrEmpty("userId", userId.ToString());

            MembershipProvider.Instance().AddUserPortal(portalId, userId);
        }

        /// <summary>
        /// ApproveUser removes the Unverified Users role from the user and adds the auto assigned roles.
        /// </summary>
        /// <param name="user">The user to update.</param>
        public static void ApproveUser(UserInfo user)
        {
            Requires.NotNull("user", user);

            var settings = PortalController.Instance.GetCurrentPortalSettings();
            var role = RoleController.Instance.GetRole(settings.PortalId, r => r.RoleName == "Unverified Users");

            RoleController.DeleteUserRole(user, role, settings, false);

            AutoAssignUsersToRoles(user, settings.PortalId);
        }

        /// <summary>
        /// User has agreed to terms and conditions. The time is recorded at the same time in SQL.
        /// </summary>
        /// <param name="user">The user that agreed.</param>
        public static void UserAgreedToTerms(UserInfo user)
        {
            Requires.NotNull("user", user);
            MembershipProvider.Instance().UserAgreedToTerms(user);
        }

        /// <summary>
        /// When called all users in the portal will need to agree to terms and conditions again.
        /// </summary>
        /// <param name="portalId">The portal for which to reset.</param>
        public static void ResetTermsAgreement(int portalId)
        {
            Requires.NotNull("portalId", portalId);
            MembershipProvider.Instance().ResetTermsAgreement(portalId);
        }

        /// <summary>
        /// A user may request that their account be removed. This sets a flag on the user portal
        /// so further processing may occur manually by the site admins.
        /// </summary>
        /// <param name="user">The user that desires to be removed.</param>
        /// <param name="remove">A value indicating whether the user has requested removal.</param>
        public static void UserRequestsRemoval(UserInfo user, bool remove)
        {
            Requires.NotNull("user", user);
            MembershipProvider.Instance().UserRequestsRemoval(user, remove);
        }

        /// <summary>
        /// Attempts to change the users password.
        /// </summary>
        /// <param name="user">The user to update.</param>
        /// <param name="oldPassword">The old password.</param>
        /// <param name="newPassword">The new password.</param>
        /// <returns>A Boolean indicating success or failure.</returns>
        public static bool ChangePassword(UserInfo user, string oldPassword, string newPassword)
        {
            bool passwordChanged;

            // Although we would hope that the caller has already validated the password,
            // Validate the new Password
            if (ValidatePassword(newPassword))
            {
                passwordChanged = MembershipProvider.Instance().ChangePassword(user, oldPassword, newPassword);

                if (passwordChanged)
                {
                    // Update User
                    user.Membership.UpdatePassword = false;
                    UpdateUser(user.PortalID, user);
                }
            }
            else
            {
                throw new Exception("Invalid Password");
            }

            return passwordChanged;
        }

        /// <summary>
        /// Validates the password reset token and if valid changes the password.
        /// </summary>
        /// <param name="portalid">The site (portal) id on which the user exists.</param>
        /// <param name="username">The username of the user to change the password for.</param>
        /// <param name="newPassword">The new password.</param>
        /// <param name="resetToken">The reset token, typically supplied through a password reset email.</param>
        /// <returns>A Boolean indicating whether the password change succeeded.</returns>
        public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string resetToken)
        {
            bool passwordChanged;

            Guid resetTokenGuid = new Guid(resetToken);

            var user = GetUserByName(portalid, username);

            // if user does not exist return false
            if (user == null)
            {
                return false;
            }

            // check if the token supplied is the same as the users and is still valid
            if (user.PasswordResetToken != resetTokenGuid || user.PasswordResetExpiration < DateTime.Now)
            {
                return false;
            }

            var m = new MembershipPasswordController();
            if (m.IsPasswordInHistory(user.UserID, user.PortalID, newPassword))
            {
                return false;
            }

            // Although we would hope that the caller has already validated the password,
            // Validate the new Password
            if (ValidatePassword(newPassword))
            {
                passwordChanged = MembershipProvider.Instance().ResetAndChangePassword(user, newPassword);

                // update reset token values to ensure token is 1-time use
                user.PasswordResetExpiration = DateTime.MinValue;
                user.PasswordResetToken = Guid.NewGuid();

                if (passwordChanged)
                {
                    // Update User
                    user.Membership.UpdatePassword = false;
                    UpdateUser(user.PortalID, user);
                }
            }
            else
            {
                throw new Exception("Invalid Password");
            }

            return passwordChanged;
        }

        /// <summary>
        /// Validates the password reset token and changes the password if valid.
        /// </summary>
        /// <param name="portalid">The site (portal) id where the user exists.</param>
        /// <param name="username">The username of the user to change the password for.</param>
        /// <param name="newPassword">The new password.</param>
        /// <param name="answer">The password reset question/answer answer.</param>
        /// <param name="resetToken">The password reset token, typically supplied through a password reset email.</param>
        /// <param name="errorMessage">If the attempt fails, this parameter will contain the reason.</param>
        /// <returns>A Boolean indicating success or failure.</returns>
        public static bool ChangePasswordByToken(
            int portalid,
            string username,
            string newPassword,
            string answer,
            string resetToken,
            out string errorMessage)
        {
            bool passwordChanged;
            errorMessage = Null.NullString;
            Guid resetTokenGuid = new Guid(resetToken);

            var user = GetUserByName(portalid, username);

            // if user does not exist return false
            if (user == null)
            {
                errorMessage = Localization.GetString("PasswordResetFailed_UserUndefined");
                return false;
            }

            // check if the token supplied is the same as the users and is still valid
            if (user.PasswordResetToken != resetTokenGuid || user.PasswordResetExpiration < DateTime.Now)
            {
                errorMessage = Localization.GetString("PasswordResetFailed_ResetLinkExpired");
                return false;
            }

            var m = new MembershipPasswordController();
            if (m.IsPasswordInHistory(user.UserID, user.PortalID, newPassword, false))
            {
                errorMessage = Localization.GetString("PasswordResetFailed_PasswordInHistory");
                return false;
            }

            // Although we would hope that the caller has already validated the password,
            // Validate the new Password
            if (ValidatePassword(newPassword))
            {
                try
                {
                    passwordChanged = MembershipProvider.Instance().ResetAndChangePassword(user, newPassword, answer);

                    if (passwordChanged)
                    {
                        // update reset token values to ensure token is 1-time use
                        user.PasswordResetExpiration = DateTime.MinValue;
                        user.PasswordResetToken = Guid.NewGuid();

                        // Update User
                        user.Membership.UpdatePassword = false;
                        UpdateUser(user.PortalID, user);

                        m.IsPasswordInHistory(user.UserID, user.PortalID, newPassword, true); // add the password into history.
                    }
                    else
                    {
                        errorMessage = Localization.GetString("PasswordResetFailed_WrongAnswer");
                    }
                }
                catch (Exception)
                {
                    passwordChanged = false;
                    errorMessage = Localization.GetString("PasswordResetFailed_WrongAnswer");
                }
            }
            else
            {
                throw new Exception("Invalid Password");
            }

            return passwordChanged;
        }

        /// <summary>
        /// Attempts to change the users password reset question and answer.
        /// </summary>
        /// <param name="user">The user to update.</param>
        /// <param name="password">The password.</param>
        /// <param name="passwordQuestion">The new password question.</param>
        /// <param name="passwordAnswer">The new password answer.</param>
        /// <returns>A Boolean indicating success or failure.</returns>
        public static bool ChangePasswordQuestionAndAnswer(UserInfo user, string password, string passwordQuestion, string passwordAnswer)
        {
            EventLogController.Instance.AddLog(user, PortalController.Instance.GetCurrentSettings(), GetCurrentUserInternal().UserID, string.Empty, EventLogController.EventLogType.USER_UPDATED);
            return MembershipProvider.Instance().ChangePasswordQuestionAndAnswer(user, password, passwordQuestion, passwordAnswer);
        }

        /// <summary>
        /// update username in the system
        /// works around membershipprovider limitation.
        /// </summary>
        /// <param name="userId">user id.</param>
        /// <param name="newUsername">new one.</param>
        public static void ChangeUsername(int userId, string newUsername)
        {
            MembershipProvider.Instance().ChangeUsername(userId, newUsername);
        }

        /// <summary>
        /// Checks if the user has known default username and password.
        /// </summary>
        /// <param name="username">The user username.</param>
        /// <param name="password">The user password.</param>
        /// <param name="loginStatus">
        /// If a known default username and password is used, will return
        /// <see cref="UserLoginStatus.LOGIN_INSECUREADMINPASSWORD"/> or
        /// <see cref="UserLoginStatus.LOGIN_INSECUREHOSTPASSWORD"/>.
        /// </param>
        [Obsolete("Deprecated in 9.8.1.  Scheduled removal in v11.0.0.  No alternative method implemented.")]
        public static void CheckInsecurePassword(string username, string password, ref UserLoginStatus loginStatus)
        {
            if (username == "admin" && (password == "admin" || password == "dnnadmin"))
            {
                loginStatus = UserLoginStatus.LOGIN_INSECUREADMINPASSWORD;
            }

            if (username == "host" && (password == "host" || password == "dnnhost"))
            {
                loginStatus = UserLoginStatus.LOGIN_INSECUREHOSTPASSWORD;
            }
        }

        /// <summary>
        /// Copys a user to a different portal.
        /// </summary>
        /// <param name="user">The user to copy.</param>
        /// <param name="destinationPortal">The destination portal.</param>
        /// <param name="mergeUser">A flag that indicates whether to merge the original user.</param>
        public static void CopyUserToPortal(UserInfo user, PortalInfo destinationPortal, bool mergeUser)
        {
            var targetUser = GetUserById(destinationPortal.PortalID, user.UserID);
            if (targetUser == null)
            {
                AddUserPortal(destinationPortal.PortalID, user.UserID);

                if (!user.IsSuperUser)
                {
                    AutoAssignUsersToRoles(user, destinationPortal.PortalID);
                }

                targetUser = GetUserById(destinationPortal.PortalID, user.UserID);
                MergeUserProperties(user, targetUser);
                MergeUserProfileProperties(user, targetUser);
            }
            else
            {
                targetUser.PortalID = destinationPortal.PortalID;

                if (mergeUser)
                {
                    MergeUserProperties(user, targetUser);
                    MergeUserProfileProperties(user, targetUser);
                }
            }

            UpdateUser(targetUser.PortalID, targetUser);
        }

        /// -----------------------------------------------------------------------------
        /// <summary>
        /// Creates a new User in the Data Store.
        /// </summary>
        /// <param name="user">The userInfo object to persist to the Database.</param>
        /// <returns>The <see cref="UserCreateStatus"/> ot the User.</returns>
        /// -----------------------------------------------------------------------------
        public static UserCreateStatus CreateUser(ref UserInfo user)
        {
            return CreateUser(ref user, false);
        }

        /// <summary>
        /// Creates a new User in the Data Store optionally sending an email notification.
        /// </summary>
        /// <param name="user">The <see cref="UserInfo"/> object to persist to the Database.</param>
        /// <param name="sendEmailNotification">A value indicating whether a registration email will be sent to user.</param>
        /// <returns>The <see cref="UserCreateStatus"/> of the User.</returns>
        public static UserCreateStatus CreateUser(ref UserInfo user, bool sendEmailNotification)
        {
            int portalId = user.PortalID;
            user.PortalID = GetEffectivePortalId(portalId);

            // ensure valid GUID exists (covers case where password is randomly generated - has 24 hr validity as per other Admin user steps
            var passwordExpiry = DateTime.Now.AddMinutes(1440);
            var passwordGuid = Guid.NewGuid();
            user.PasswordResetExpiration = passwordExpiry;
            user.PasswordResetToken = passwordGuid;

            // Create the User
            var createStatus = MembershipProvider.Instance().CreateUser(ref user);

            if (createStatus == UserCreateStatus.Success)
            {
                // reapply guid/expiry (cleared when user is created)
                user.PasswordResetExpiration = passwordExpiry;
                user.PasswordResetToken = passwordGuid;
                UpdateUser(user.PortalID, user);
                EventLogController.Instance.AddLog(user, PortalController.Instance.GetCurrentSettings(), GetCurrentUserInternal().UserID, string.Empty, EventLogController.EventLogType.USER_CREATED);
                CachingProvider.Instance().Remove(string.Format(DataCache.PortalUserCountCacheKey, portalId));
                if (!user.IsSuperUser)
                {
                    // autoassign user to portal roles
                    AutoAssignUsersToRoles(user, portalId);
                }

                EventManager.Instance.OnUserCreated(new UserEventArgs { User = user, SendNotification = sendEmailNotification });
            }

            // Reset PortalId
            FixMemberPortalId(user, portalId);
            return createStatus;
        }

        /// <summary>
        /// Deletes all Unauthorized Users for a Portal.
        /// </summary>
        /// <param name="portalId">The Id of the Portal.</param>
        public static void DeleteUnauthorizedUsers(int portalId)
        {
            var arrUsers = (portalId == -1) ? GetUsers(true, true, portalId) : GetUnAuthorizedUsers(portalId);
            for (int i = 0; i < arrUsers.Count; i++)
            {
                var user = arrUsers[i] as UserInfo;
                if (user != null)
                {
                    if (user.Membership.Approved == false || user.Membership.LastLoginDate == Null.NullDate)
                    {
                        DeleteUser(ref user, true, false);
                    }
                }
            }
        }

        /// <summary>
        /// Deletes an existing User from the Data Store.
        /// </summary>
        /// <param name="user">The userInfo object to delete from the Database.</param>
        /// <param name="notify">A flag that indicates whether an email notification should be sent.</param>
        /// <param name="deleteAdmin">A flag that indicates whether the Portal Administrator should be deleted.</param>
        /// <returns>A Boolean value that indicates whether the User was successfully deleted.</returns>
        public static bool DeleteUser(ref UserInfo user, bool notify, bool deleteAdmin)
        {
            int portalId = user.PortalID;
            user.PortalID = GetEffectivePortalId(portalId);

            // If the HTTP Current Context is unavailable (e.g. when called from within a SchedulerClient) GetCurrentPortalSettings() returns null and the
            // PortalSettings are created/loaded for the portal (originally) assigned to the user.
            var portalSettings = PortalController.Instance.GetCurrentPortalSettings() ?? new PortalSettings(portalId);

            var canDelete = deleteAdmin || (user.UserID != portalSettings.AdministratorId);

            if (canDelete)
            {
                // Delete Permissions
                DeleteUserPermissions(user);
                canDelete = MembershipProvider.Instance().DeleteUser(user);
            }

            if (canDelete)
            {
                // Obtain PortalSettings from Current Context or from the users (original) portal if the HTTP Current Context is unavailable.
                EventLogController.Instance.AddLog("Username", user.Username, portalSettings, user.UserID, EventLogController.EventLogType.USER_DELETED);
                if (notify && !user.IsSuperUser)
                {
                    // send email notification to portal administrator that the user was removed from the portal
                    SendDeleteEmailNotifications(user, portalSettings);
                }

                DataCache.ClearPortalUserCountCache(user.PortalID);
                DataCache.ClearUserCache(user.PortalID, user.Username);

                // also clear current portal's cache if the user is a host user
                if (portalSettings.PortalId != portalId)
                {
                    DataCache.ClearPortalCache(portalSettings.PortalId, false);
                    DataCache.ClearUserCache(portalSettings.PortalId, user.Username);
                }

                // queue remove user contributions from search index
                var document = new Services.Search.Entities.SearchDocumentToDelete
                {
                    PortalId = portalId,
                    AuthorUserId = user.UserID,
                    SearchTypeId = Services.Search.Internals.SearchHelper.Instance.GetSearchTypeByName("user").SearchTypeId,
                };

                DataProvider.Instance().AddSearchDeletedItems(document);

                EventManager.Instance.OnUserDeleted(new UserEventArgs { User = user });
            }

            FixMemberPortalId(user, portalId);
            UpdateUser(portalId, GetUserById(portalId, user.UserID));
            return canDelete;
        }

        /// <summary>
        /// Deletes all Users for a Portal.
        /// </summary>
        /// <param name="portalId">The Id of the Portal.</param>
        /// <param name="notify">A flag that indicates whether an email notification should be sent.</param>
        /// <param name="deleteAdmin">A flag that indicates whether the Portal Administrator should be deleted.</param>
        public static void DeleteUsers(int portalId, bool notify, bool deleteAdmin)
        {
            var arrUsers = GetUsers(portalId);
            for (int i = 0; i < arrUsers.Count; i++)
            {
                var objUser = arrUsers[i] as UserInfo;
                DeleteUser(ref objUser, notify, deleteAdmin);
            }
        }

        /// <summary>
        /// Generates a new random password.
        /// </summary>
        /// <returns>A string representing the randomly generated password which is the minimum password length + 4 characters.</returns>
        public static string GeneratePassword()
        {
            return GeneratePassword(MembershipProviderConfig.MinPasswordLength + 4);
        }

        /// <summary>
        /// Generates a new random password.
        /// </summary>
        /// <param name="length">The length of password to generate.</param>
        /// <returns>A string representing the newly generated random password.</returns>
        public static string GeneratePassword(int length)
        {
            return MembershipProvider.Instance().GeneratePassword(length);
        }

        /// <summary>
        /// Retrieves the User from the Cache, or fetches a fresh copy if
        /// not in cache or if Cache settings are not set to HeavyCaching.
        /// </summary>
        /// <param name="portalId">The Id of the Portal.</param>
        /// <param name="username">The username of the user being retrieved.</param>
        /// <returns>The user as a <see cref="UserInfo"/> object.</returns>
        public static UserInfo GetCachedUser(int portalId, string username)
        {
            var masterPortalId = GetEffectivePortalId(portalId);

            var user = MembershipProvider.Instance().GetUserByUserName(masterPortalId, username);
            FixMemberPortalId(user, portalId);

            if (user != null)
            {
                var lookUp = GetUserLookupDictionary(portalId);
                using (lookUp.GetWriteLock())
                {
                    lookUp[user.UserID] = user.Username;
                }
            }

            return user;
        }

        /// <summary>
        /// Gets deleted users for a portal.
        /// </summary>
        /// <param name="portalId">The portal id for which to get the deleted users.</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/>.</returns>
        public static ArrayList GetDeletedUsers(int portalId)
        {
            return MembershipProvider.Instance().GetDeletedUsers(GetEffectivePortalId(portalId));
        }

        /// <summary>
        /// Gets a collection of Online Users.
        /// </summary>
        /// <param name="portalId">The Id of the Portal.</param>
        /// <returns>An ArrayList of UserInfo objects.</returns>
        [Obsolete("Support for users online was removed in 8.x, other solutions exist outside of the DNN Platform.  Scheduled removal in v11.0.0.")]
        public static ArrayList GetOnlineUsers(int portalId)
        {
            return MembershipProvider.Instance().GetOnlineUsers(GetEffectivePortalId(portalId));
        }

        /// <summary>
        /// Gets the Current Password Information for the User.
        /// </summary>
        /// <remarks>
        /// This method will only return the password if the memberProvider supports
        /// and is using a password encryption method that supports decryption.
        /// </remarks>
        /// <param name="user">The user whose Password information we are retrieving.</param>
        /// <param name="passwordAnswer">The answer to the user's password Question.</param>
        /// <returns>A string representing the user password.</returns>
        /// <exception cref="ConfigurationErrorsException">is thrown if the current configuration does not allow password retrieval.</exception>
        public static string GetPassword(ref UserInfo user, string passwordAnswer)
        {
            if (MembershipProviderConfig.PasswordRetrievalEnabled)
            {
                user.Membership.Password = MembershipProvider.Instance().GetPassword(user, passwordAnswer);
            }
            else
            {
                // Throw a configuration exception as password retrieval is not enabled
                throw new ConfigurationErrorsException("Password Retrieval is not enabled");
            }

            return user.Membership.Password;
        }

        /// <summary>
        /// Gets the unauthorized users for a portal.
        /// </summary>
        /// <param name="portalId">The site (portal) id on which to search for Unauthorized users.</param>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating whether to include superusers (hosts).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/>.</returns>
        public static ArrayList GetUnAuthorizedUsers(int portalId, bool includeDeleted, bool superUsersOnly)
        {
            return MembershipProvider.Instance().GetUnAuthorizedUsers(GetEffectivePortalId(portalId), includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Gets all the users of the portal, that are not authorized.
        /// </summary>
        /// <param name="portalId">The Id of the site (portal).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUnAuthorizedUsers(int portalId)
        {
            return GetUnAuthorizedUsers(portalId, false, false);
        }

        /// <summary>
        /// Gets a User from the DataStore.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="userId">The id of the user being retrieved from the Data Store.</param>
        /// <returns>The User as a <see cref="UserInfo"/> object.</returns>
        public static UserInfo GetUserById(int portalId, int userId)
        {
            // stop any sql calls for guest users
            if (userId == Null.NullInteger)
            {
                return null;
            }

            var lookUp = GetUserLookupDictionary(portalId);

            UserInfo user;
            string userName;
            bool userFound;
            using (lookUp.GetReadLock())
            {
                userFound = lookUp.TryGetValue(userId, out userName);
            }

            if (userFound)
            {
                user = GetCachedUser(portalId, userName);
            }
            else
            {
                user = MembershipProvider.Instance().GetUser(GetEffectivePortalId(portalId), userId);
                FixMemberPortalId(user, portalId);
                if (user != null)
                {
                    using (lookUp.GetWriteLock())
                    {
                        lookUp[userId] = user.Username;
                    }
                }
            }

            return user;
        }

        /// <summary>
        /// Gets a User from the DataStore.
        /// </summary>
        /// <param name="username">The username of the user being retrieved from the Data Store.</param>
        /// <returns>The User as a <see cref="UserInfo"/> object.</returns>
        public static UserInfo GetUserByName(string username)
        {
            return MembershipProvider.Instance().GetUserByUserName(-1, username);
        }

        /// <summary>
        /// Gets a user from the DataStore.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="username">The username of the user being retrieved from the Data Store.</param>
        /// <returns>The User as a <see cref="UserInfo"/> object.</returns>
        public static UserInfo GetUserByName(int portalId, string username)
        {
            return GetCachedUser(portalId, username);
        }

        /// <summary>
        /// Gets a user by its vanity url.
        /// </summary>
        /// <param name="portalId">The site (portal) id of the user.</param>
        /// <param name="vanityUrl">The vanity url to search.</param>
        /// <returns>A user as a <see cref="UserInfo"/> object.</returns>
        public static UserInfo GetUserByVanityUrl(int portalId, string vanityUrl)
        {
            portalId = GetEffectivePortalId(portalId);
            return MembershipProvider.Instance().GetUserByVanityUrl(portalId, vanityUrl);
        }

        /// <summary>
        /// Gets a single user by its password reset token.
        /// </summary>
        /// <param name="portalId">The site (portal) id for the user.</param>
        /// <param name="resetToken">the password reset token.</param>
        /// <returns>A user represented in a <see cref="UserInfo"/> object.</returns>
        public static UserInfo GetUserByPasswordResetToken(int portalId, string resetToken)
        {
            portalId = GetEffectivePortalId(portalId);
            return MembershipProvider.Instance().GetUserByPasswordResetToken(portalId, resetToken);
        }

        /// <summary>
        /// Gets the number of users in a site (portal).
        /// </summary>
        /// <param name="portalId">The id of the portal to search.</param>
        /// <returns>The no of users the portal contains.</returns>
        public static int GetUserCountByPortal(int portalId)
        {
            portalId = GetEffectivePortalId(portalId);
            var cacheKey = string.Format(DataCache.PortalUserCountCacheKey, portalId);
            return CBO.GetCachedObject<int>(new CacheItemArgs(cacheKey, DataCache.PortalUserCountCacheTimeOut, DataCache.PortalUserCountCachePriority, portalId), GetUserCountByPortalCallBack);
        }

        /// <summary>
        /// Gets a localized string representing the user creation status.
        /// </summary>
        /// <param name="userRegistrationStatus">The user creation status as a <see cref="UserCreateStatus"/>.</param>
        /// <returns>A localized string representing the user creation status.</returns>
        public static string GetUserCreateStatus(UserCreateStatus userRegistrationStatus)
        {
            switch (userRegistrationStatus)
            {
                case UserCreateStatus.DuplicateEmail:
                    return Localization.GetString("UserEmailExists");
                case UserCreateStatus.InvalidAnswer:
                    return Localization.GetString("InvalidAnswer");
                case UserCreateStatus.InvalidEmail:
                    return Localization.GetString("InvalidEmail");
                case UserCreateStatus.InvalidPassword:
                    string strInvalidPassword = Localization.GetString("InvalidPassword");
                    strInvalidPassword = strInvalidPassword.Replace("[PasswordLength]", MembershipProviderConfig.MinPasswordLength.ToString());
                    strInvalidPassword = strInvalidPassword.Replace("[NoneAlphabet]", MembershipProviderConfig.MinNonAlphanumericCharacters.ToString());
                    return strInvalidPassword;
                case UserCreateStatus.PasswordMismatch:
                    return Localization.GetString("PasswordMismatch");
                case UserCreateStatus.InvalidQuestion:
                    return Localization.GetString("InvalidQuestion");
                case UserCreateStatus.InvalidUserName:
                    return Localization.GetString("InvalidUserName");
                case UserCreateStatus.InvalidDisplayName:
                    return Localization.GetString("InvalidDisplayName");
                case UserCreateStatus.DuplicateDisplayName:
                    return Localization.GetString("DuplicateDisplayName");
                case UserCreateStatus.UserRejected:
                    return Localization.GetString("UserRejected");
                case UserCreateStatus.DuplicateUserName:
                case UserCreateStatus.UserAlreadyRegistered:
                case UserCreateStatus.UsernameAlreadyExists:
                    return Localization.GetString("UserNameExists");
                case UserCreateStatus.BannedPasswordUsed:
                    return Localization.GetString("BannedPasswordUsed");
                case UserCreateStatus.ProviderError:
                case UserCreateStatus.DuplicateProviderUserKey:
                case UserCreateStatus.InvalidProviderUserKey:
                    return Localization.GetString("RegError");
                case UserCreateStatus.InvalidFirstName:
                    return Localization.GetString("InvalidFirstName");
                case UserCreateStatus.InvalidLastName:
                    return Localization.GetString("InvalidLastName");
                default:
                    throw new ArgumentException("Unknown UserCreateStatus value encountered", "userRegistrationStatus");
            }
        }

        /// <summary>
        /// Gets the membership information for a user.
        /// </summary>
        /// <param name="user">The user whose membership information to retrieve.</param>
        /// <remarks>This method does not return the membership information, it populates it inside the <see cref="UserInfo"/> object.</remarks>
        public static void GetUserMembership(UserInfo user)
        {
            int portalId = user.PortalID;
            user.PortalID = GetEffectivePortalId(portalId);
            MembershipProvider.Instance().GetUserMembership(ref user);
            FixMemberPortalId(user, portalId);
        }

        /// <summary>
        /// Gets a set of default portal settings relative to user management.
        /// </summary>
        /// <returns>A <see cref="Hashtable"/> or the user related portal settings.</returns>
        public static Hashtable GetDefaultUserSettings()
        {
            var portalId = -1;
            var portalSettings = PortalController.Instance.GetCurrentSettings();

            if (portalSettings != null)
            {
                portalId = portalSettings.PortalId;
            }

            return GetUserSettings(portalId, new Hashtable());
        }

        /// <summary>
        /// Gets the user related portal settings.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <returns>The Settings Hashtable.</returns>
        public static Hashtable GetUserSettings(int portalId)
        {
            var settings = GetDefaultUserSettings();
            var masterPortalId = GetEffectivePortalId(portalId);
            Dictionary<string, string> settingsDictionary = (portalId == Null.NullInteger)
                                                            ? HostController.Instance.GetSettingsDictionary()
                                                            : PortalController.Instance.GetPortalSettings(masterPortalId);
            Dictionary<string, string> currentPortalSettings = null;
            if (portalId != Null.NullInteger && masterPortalId != portalId)
            {
                currentPortalSettings = PortalController.Instance.GetPortalSettings(portalId);
            }

            if (settingsDictionary != null)
            {
                foreach (KeyValuePair<string, string> kvp in settingsDictionary)
                {
                    int index = kvp.Key.IndexOf("_");
                    if (index > 0)
                    {
                        // Get the prefix
                        string prefix = kvp.Key.Substring(0, index + 1);
                        switch (prefix)
                        {
                            case "Column_":
                            case "Display_":
                            case "Profile_":
                            case "Records_":
                            case "Redirect_":
                            case "Registration_":
                            case "Security_":
                                switch (kvp.Key)
                                {
                                    case "Display_Mode":
                                        settings[kvp.Key] = (DisplayMode)Convert.ToInt32(kvp.Value);
                                        break;
                                    case "Profile_DefaultVisibility":
                                        settings[kvp.Key] = (UserVisibilityMode)Convert.ToInt32(kvp.Value);
                                        break;
                                    case "Security_UsersControl":
                                        settings[kvp.Key] = (UsersControl)Convert.ToInt32(kvp.Value);
                                        break;
                                    default:
                                        // update value or add any new values
                                        settings[kvp.Key] = kvp.Value;
                                        break;
                                }

                                break;
                        }
                    }
                }
            }

            if (currentPortalSettings != null)
            {
                foreach (var kvp in currentPortalSettings.Where(kvp => kvp.Key.StartsWith("Redirect_")))
                {
                    settings[kvp.Key] = kvp.Value;
                }
            }

            return settings;
        }

        /// <summary>
        /// Gets all the users of a given portal.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsers(int portalId)
        {
            return GetUsers(false, false, portalId);
        }

        /// <summary>
        /// Gets the users of a given portal.
        /// </summary>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating whether to ONLY include SuperUsers (Hosts).</param>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsers(bool includeDeleted, bool superUsersOnly, int portalId)
        {
            var totalrecords = -1;
            return GetUsers(portalId, -1, -1, ref totalrecords, includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Gets all the users of a given portal, excluding deleted users and SuperUsers (Hosts), by page.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records.</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords)
        {
            return GetUsers(portalId, pageIndex, pageSize, ref totalRecords, false, false);
        }

        /// <summary>
        /// Gets all the users of a given portal, by page.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records.</param>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating whether to ONLY include superUsers (Hosts).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)
        {
            return MembershipProvider.Instance().GetUsers(GetEffectivePortalId(portalId), pageIndex, pageSize, ref totalRecords, includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Gets all the users of a given portal whose email matches a provided filter, excluding deleted users and SuperUsers (Hosts).
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="emailToMatch">The email address to use to find a match.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords)
        {
            return GetUsersByEmail(portalId, emailToMatch, pageIndex, pageSize, ref totalRecords, false, false);
        }

        /// <summary>
        /// Gets one single user matching the email address provided, this will only return the first match found.
        /// This will only be useful in portals without duplicate email addresses.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="emailToMatch">The email address to use to find a match.</param>
        /// <returns>A single <see cref="UserInfo"/> object or null if no user found.</returns>
        public static UserInfo GetUserByEmail(int portalId, string emailToMatch)
        {
            int uid = DataProvider.Instance().GetSingleUserByEmail(portalId, emailToMatch);
            if (uid > -1)
            {
                return GetUserById(portalId, uid);
            }

            return null;
        }

        /// <summary>
        /// Gets all the users of the portal whose email matches a provided filter expression.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="emailToMatch">The email address to use to find a match.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating if the search should ONLY include SuperUsers (Hosts).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)
        {
            return MembershipProvider.Instance().GetUsersByEmail(GetEffectivePortalId(portalId), emailToMatch, pageIndex, pageSize, ref totalRecords, includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Gets all the users of the portal whose profile matches
        /// the profile property pased as a parameter.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="propertyName">The name of the property being matched.</param>
        /// <param name="propertyValue">The value of the property being matched.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords)
        {
            return GetUsersByProfileProperty(portalId, propertyName, propertyValue, pageIndex, pageSize, ref totalRecords, false, false);
        }

        /// <summary>
        /// Gets all the users of the portal whose profile matches
        /// the profile property pased as a parameter.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="propertyName">The name of the property being matched.</param>
        /// <param name="propertyValue">The value of the property being matched.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating whether to ONLY include SuperUsers (Hosts).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)
        {
            return MembershipProvider.Instance().GetUsersByProfileProperty(GetEffectivePortalId(portalId), propertyName, propertyValue, pageIndex, pageSize, ref totalRecords, includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Gets all the users of the portal whose username matches a provided filter expression, excluding deleted users and SuperUsers (Hosts), by page.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="userNameToMatch">The username to use to find a match.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords)
        {
            return GetUsersByUserName(portalId, userNameToMatch, pageIndex, pageSize, ref totalRecords, false, false);
        }

        /// <summary>
        /// Gets all the users of the portal whose username matches a provided filter expression, by page.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="userNameToMatch">The username to use to find a match.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating whether to ONLY include SuperUsers (Hosts).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)
        {
            return MembershipProvider.Instance().GetUsersByUserName(GetEffectivePortalId(portalId), userNameToMatch, pageIndex, pageSize, ref totalRecords, includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Gets all the users of the portal whose display name matches a provided filter expression, by page.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="nameToMatch">The display name to use to find a match.</param>
        /// <param name="pageIndex">The page of records to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="totalRecords">The total number of records that satisfy the criteria.</param>
        /// <param name="includeDeleted">A value indicating whether to include deleted users.</param>
        /// <param name="superUsersOnly">A value indicating whether to ONLY inlude SuperUsers (Hosts).</param>
        /// <returns>An ArrayList of <see cref="UserInfo"/> objects.</returns>
        public static ArrayList GetUsersByDisplayName(int portalId, string nameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)
        {
            return MembershipProvider.Instance().GetUsersByDisplayName(GetEffectivePortalId(portalId), nameToMatch, pageIndex, pageSize, ref totalRecords, includeDeleted, superUsersOnly);
        }

        /// <summary>
        /// Moves a user to a different site (portal).
        /// </summary>
        /// <param name="user">The user to move.</param>
        /// <param name="portal">The destination site (portal).</param>
        /// <param name="mergeUser">A indicating whether to merge the basic user properties if the user already exists on the target portal.</param>
        public static void MoveUserToPortal(UserInfo user, PortalInfo portal, bool mergeUser)
        {
            CopyUserToPortal(user, portal, mergeUser);
            RemoveUser(user);
        }

        /// <summary>
        /// Permanently removes all users marked as deleted from a portal. It will delete the membership
        /// user as well if the user is not part of other portals.
        /// </summary>
        /// <param name="portalId">The id of the site (portal) on which to get the deleted users.</param>
        /// <remarks>
        /// In Dnn, a user can be deleted, in which case the user is just disabled or "soft deleted" but still exists in the database and can be restored.
        /// Removing a user (hard-deleting) actually removes the user information from the DataStore and cannot be undone.
        /// </remarks>
        public static void RemoveDeletedUsers(int portalId)
        {
            var arrUsers = GetDeletedUsers(portalId);

            foreach (UserInfo objUser in arrUsers)
            {
                if (objUser.IsDeleted)
                {
                    RemoveUser(objUser);
                }
            }
        }

        /// <summary>
        /// Permanently remove a user and the associated user folder on disk.
        /// This also deletes the membership user if the user is
        /// not a member of any other portal.
        /// </summary>
        /// <param name="user">The user to delete.</param>
        /// <returns>A value indicating whether the user removal was successfull.</returns>
        public static bool RemoveUser(UserInfo user)
        {
            int portalId = user.PortalID;
            user.PortalID = GetEffectivePortalId(portalId);

            var retValue = MembershipProvider.Instance().RemoveUser(user);

            if (retValue)
            {
                var portalSettings = PortalController.Instance.GetCurrentSettings();

                EventLogController.Instance.AddLog("Username", user.Username, portalSettings, user.UserID, EventLogController.EventLogType.USER_REMOVED);

                var portal = PortalController.Instance.GetPortal(user.PortalID);
                var portalGroup = (from p in PortalGroupController.Instance.GetPortalGroups()
                                   where p.PortalGroupId == portal.PortalGroupID
                                   select p)
                                .SingleOrDefault();
                if (portalGroup != null)
                {
                    var portalsInGroup = PortalGroupController.Instance.GetPortalsByGroup(portalGroup.PortalGroupId);
                    foreach (var portalInGroup in portalsInGroup)
                    {
                        ClearPortalAndUserCache(user, portalInGroup.PortalID);
                    }
                }
                else
                {
                    ClearPortalAndUserCache(user, portalId);
                }

                EventManager.Instance.OnUserRemoved(new UserEventArgs { User = user });
            }

            // Reset PortalId
            FixMemberPortalId(user, portalId);

            return retValue;
        }

        /// <summary>
        /// Resets and changes the password for a user.
        /// </summary>
        /// <param name="user">The user for which to change the password.</param>
        /// <param name="newPassword">The new password.</param>
        /// <returns>A value indicating whether the password change was successfull.</returns>
        /// <remarks>This method can only be used by admins or superusers (hosts) who do not need to supply an "old" password.</remarks>
        public static bool ResetAndChangePassword(UserInfo user, string newPassword)
        {
            var portalSettings = PortalController.Instance.GetCurrentSettings();
            if (GetCurrentUserInternal().IsInRole(portalSettings.AdministratorRoleName))
            {
                string resetPassword = ResetPassword(user, string.Empty);
                return ChangePassword(user, resetPassword, newPassword);
            }

            return false;
        }

        /// <summary>
        /// Attempts to reset and change a user password.
        /// </summary>
        /// <param name="user">The user for which to change the password.</param>
        /// <param name="oldPassword">The user old password.</param>
        /// <param name="newPassword">The user new password.</param>
        /// <returns>A value indicating whether the password change succeeded.</returns>
        /// <exception cref="ConfigurationErrorsException"> is thrown if password reset is not enabled in the configuration.</exception>
        /// <exception cref="Exception"> with a message of "Invalid Password" is thrown if either the old or new password is not valid.</exception>
        public static bool ResetAndChangePassword(UserInfo user, string oldPassword, string newPassword)
        {
            if (System.Web.Security.Membership.ValidateUser(user.Username, oldPassword))
            {
                string resetPassword = ResetPassword(user, string.Empty);
                return ChangePassword(user, resetPassword, newPassword);
            }

            return false;
        }

        /// <summary>
        /// Attempts to reset the password for the specified user.
        /// </summary>
        /// <param name="user">The user whose Password information we are resetting.</param>
        /// <param name="passwordAnswer">The answer to the "user's" password Question.</param>
        /// <returns>A string representing the new password.</returns>
        /// <exception cref="System.Web.Security.MembershipPasswordException"> is thrown when the password answer is not valid.</exception>
        /// <exception cref="ConfigurationErrorsException"> is thrown when password reset is not enabled in the configuration.</exception>
        public static string ResetPassword(UserInfo user, string passwordAnswer)
        {
            if (MembershipProviderConfig.PasswordResetEnabled)
            {
                user.Membership.Password = MembershipProvider.Instance().ResetPassword(user, passwordAnswer);
            }
            else
            {
                // Throw a configuration exception as password reset is not enabled
                throw new ConfigurationErrorsException("Password Reset is not enabled");
            }

            return user.Membership.Password;
        }

        /// <summary>
        /// Resets the user password reset token.
        /// </summary>
        /// <param name="user">The user to update the password reset token for.</param>
        /// <remarks>This method does not return the new token, it updates it inside the <see cref="UserInfo"/> object provided.</remarks>
        public static void ResetPasswordToken(UserInfo user)
        {
            ResetPasswordToken(user, false);
        }

        /// <summary>
        /// Resets the user password reset token.
        /// </summary>
        /// <param name="user">The user to reset the password reset token for.</param>
        /// <param name="sendEmail">A value indicating whether to send a notification email to the user.</param>
        /// <returns>A value indicating whether the notification email was sent or true if 'sendEmail' was false.</returns>
        public static bool ResetPasswordToken(UserInfo user, bool sendEmail)
        {
            var settings = new MembershipPasswordSettings(user.PortalID);
            var expiry = DateTime.Now.AddMinutes(settings.ResetLinkValidity);
            if (user.PasswordResetExpiration < DateTime.Now)
            {
                user.PasswordResetExpiration = expiry;
                user.PasswordResetToken = Guid.NewGuid();
                UpdateUser(user.PortalID, user);
            }
            else if (user.PasswordResetExpiration > expiry)
            {
                user.PasswordResetExpiration = expiry;
                UpdateUser(user.PortalID, user);
            }

            if (sendEmail)
            {
                var portalSettings = PortalController.Instance.GetCurrentPortalSettings();
                return Mail.SendMail(user, MessageType.PasswordReminder, portalSettings) == string.Empty;
            }

            return true;
        }

        /// <summary>
        /// Resets the password reset token with a timeout value.
        /// </summary>
        /// <param name="user">The user for which to update the password reset token.</param>
        /// <param name="minutesValid">A value indication for how many minutes the generated token will be valid for.</param>
        /// <remarks>This method does not return anything, it updates the reset token and the token expiraiton directly in the provided <see cref="UserInfo"/> object.</remarks>
        public static void ResetPasswordToken(UserInfo user, int minutesValid)
        {
            user.PasswordResetExpiration = DateTime.Now.AddMinutes(minutesValid);
            user.PasswordResetToken = Guid.NewGuid();
            UpdateUser(user.PortalID, user);
        }

        /// <summary>
        /// Restores a deleted user.
        /// </summary>
        /// <param name="user">The user to restore.</param>
        /// <returns>A value indicating whether the user restore succeeded.</returns>
        /// <remarks>
        /// Dnn supports deleting and restoring them. A deleted using in Dnn means a "soft-delete" or in other words disabling the user.
        /// This method can only be used for those "soft-deleted" users, if a user was removed (hard-deleted), this method cannot restore the user
        /// as that action cannot be undone.
        /// </remarks>
        public static bool RestoreUser(ref UserInfo user)
        {
            int portalId = user.PortalID;
            user.PortalID = GetEffectivePortalId(portalId);

            // Restore the User
            var retValue = MembershipProvider.Instance().RestoreUser(user);

            if (retValue)
            {
                // restore user permissions
                RestoreUserPermissions(user);

                // Obtain PortalSettings from Current Context
                var portalSettings = PortalController.Instance.GetCurrentSettings();

                // Log event
                EventLogController.Instance.AddLog("Username", user.Username, portalSettings, user.UserID, EventLogController.EventLogType.USER_RESTORED);

                DataCache.ClearPortalUserCountCache(user.PortalID);
                DataCache.ClearUserCache(user.PortalID, user.Username);
            }

            // Reset PortalId
            FixMemberPortalId(user, portalId);
            UpdateUser(portalId, GetUserById(portalId, user.UserID));
            return retValue;
        }

        /// <summary>
        /// Gets the setting key prefix for user related portal settings.
        /// </summary>
        /// <param name="portalId">The portal id to scope the key for.</param>
        /// <returns>A string representing the settings key for the given portal.</returns>
        public static string SettingsKey(int portalId)
        {
            return "UserSettings|" + portalId;
        }

        /// <summary>
        /// Attempts to unlock the user's account.
        /// </summary>
        /// <param name="user">The user whose account is being Unlocked.</param>
        /// <returns>A value indicating whether the user unlock attempt succeeded.</returns>
        /// <remarks>A user can be locked in some situations as when the user attempted too many invalid passwords.</remarks>
        public static bool UnLockUser(UserInfo user)
        {
            int portalId = user.PortalID;
            user.PortalID = GetEffectivePortalId(portalId);

            var retValue = MembershipProvider.Instance().UnLockUser(user);
            DataCache.ClearUserCache(portalId, user.Username);
            UpdateUser(portalId, GetUserById(portalId, user.UserID));
            return retValue;
        }

        /// <summary>
        /// Updates a user and logs the action.
        /// </summary>
        /// <param name="portalId">The id of the site (portal) on which to update the user.</param>
        /// <param name="user">The use to update.</param>
        public static void UpdateUser(int portalId, UserInfo user)
        {
            UpdateUser(portalId, user, true);
        }

        /// <summary>
        /// Updates a user.
        /// </summary>
        /// <param name="portalId">The portalid of the user to update.</param>
        /// <param name="user">The user to update.</param>
        /// <param name="loggedAction">A value indicating whether or not the update calls the eventlog - the eventlogtype must still be enabled for logging to occur.</param>
        public static void UpdateUser(int portalId, UserInfo user, bool loggedAction)
        {
            UpdateUser(portalId, user, loggedAction, true);
        }

        /// <summary>
        /// Updates a user.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="user">The user object.</param>
        /// <param name="loggedAction">Whether or not the update calls the eventlog - the eventlogtype must still be enabled for logging to occur.</param>
        /// <param name="sendNotification">Whether to send notification to the user about the update (i.e. a notification if the user was approved).</param>
        public static void UpdateUser(int portalId, UserInfo user, bool loggedAction, bool sendNotification)
        {
            UpdateUser(portalId, user, loggedAction, sendNotification, true);
        }

        /// <summary>
        /// Validates a User's credentials against the Data Store, and sets the Forms Authentication Ticket.
        /// </summary>
        /// <param name="portalId">The id of the site (portal) the user belongs to.</param>
        /// <param name="username">The user name of the User attempting to log in.</param>
        /// <param name="password">The password of the User attempting to log in.</param>
        /// <param name="verificationCode">The verification code of the user attempting to log in.</param>
        /// <param name="portalName">The name of the site (portal).</param>
        /// <param name="ip">The IP Address of the user attempting to log in.</param>
        /// <param name="loginStatus">A <see cref="UserLoginStatus"/> enumeration that indicates the status of the
        /// Login attempt. This value is returned by reference.</param>
        /// <param name="createPersistentCookie">A flag that indicates whether the login credentials
        /// should be persisted.</param>
        /// <returns>The <see cref="UserInfo"/> object representing a successful login.</returns>
        public static UserInfo UserLogin(int portalId, string username, string password, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus, bool createPersistentCookie)
        {
            portalId = GetEffectivePortalId(portalId);

            loginStatus = UserLoginStatus.LOGIN_FAILURE;

            // Validate the user
            var objUser = ValidateUser(portalId, username, password, verificationCode, portalName, ip, ref loginStatus);
            if (objUser != null)
            {
                // Call UserLogin overload
                UserLogin(portalId, objUser, portalName, ip, createPersistentCookie);
            }
            else
            {
                AddEventLog(portalId, username, Null.NullInteger, portalName, ip, loginStatus);
            }

            // return the User object
            return objUser;
        }

        /// <summary>
        /// Logs a validated user in.
        /// </summary>
        /// <param name="portalId">The id of the portal the user belongs to.</param>
        /// <param name="user">The validated user.</param>
        /// <param name="portalName">The name of the site (portal).</param>
        /// <param name="ip">The IP Address of the user attempting to log in.</param>
        /// <param name="createPersistentCookie">A value indication whether the login credentials should be persisted.</param>
        public static void UserLogin(int portalId, UserInfo user, string portalName, string ip, bool createPersistentCookie)
        {
            portalId = GetEffectivePortalId(portalId);

            AddEventLog(portalId, user.Username, user.UserID, portalName, ip, user.IsSuperUser ? UserLoginStatus.LOGIN_SUPERUSER : UserLoginStatus.LOGIN_SUCCESS);

            if (user.LastIPAddress != ip)
            {
                // Update User in Database with Last IP used
                user.LastIPAddress = ip;
                DataProvider.Instance().UpdateUserLastIpAddress(user.UserID, ip);
            }

            // set the forms authentication cookie ( log the user in )
            var security = PortalSecurity.Instance;
            security.SignIn(user, createPersistentCookie);

            EventManager.Instance.OnUserAuthenticated(new UserEventArgs { User = user });
        }

        /// <summary>
        /// Validates a password.
        /// </summary>
        /// <param name="password">The password to validate.</param>
        /// <returns>A value indicating whether the password is valid.</returns>
        public static bool ValidatePassword(string password)
        {
            // Valid Length
            var isValid = password.Length >= MembershipProviderConfig.MinPasswordLength;

            // Validate NonAlphaChars
            var rx = Globals.NonAlphanumericCharacters;
            if (rx.Matches(password).Count < MembershipProviderConfig.MinNonAlphanumericCharacters)
            {
                isValid = false;
            }

            // Validate Regex
            if (!string.IsNullOrEmpty(MembershipProviderConfig.PasswordStrengthRegularExpression) && isValid)
            {
                isValid = Regex.IsMatch(password, MembershipProviderConfig.PasswordStrengthRegularExpression);
            }

            return isValid;
        }

        /// <summary>
        /// Validates a user's credentials against the Data Store.
        /// </summary>
        /// <param name="portalId">The id of the site (portal) the user belongs to.</param>
        /// <param name="username">The user name of the user attempting to log in.</param>
        /// <param name="password">The password of the user attempting to log in.</param>
        /// <param name="verificationCode">The verification code of the user attempting to log in.</param>
        /// <param name="portalName">The name of the portal.</param>
        /// <param name="ip">The IP address of the user attempting to log in.</param>
        /// <param name="loginStatus">A <see cref="UserLoginStatus"/> enumeration that indicates the status of the
        /// Login attempt. This value is returned by reference.</param>
        /// <returns>The <see cref="UserInfo"/> object representing a valid user.</returns>
        public static UserInfo ValidateUser(int portalId, string username, string password, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus)
        {
            return ValidateUser(portalId, username, password, "DNN", verificationCode, portalName, ip, ref loginStatus);
        }

        /// <summary>
        /// Validates a user's credentials against the Data Store.
        /// </summary>
        /// <param name="portalId">The id of the site (portal) the user belongs to.</param>
        /// <param name="username">The user name of the user attempting to log in.</param>
        /// <param name="password">The password of the User attempting to log in.</param>
        /// <param name="authType">The type of authentication used.</param>
        /// <param name="verificationCode">The verification code of the user attempting to log in.</param>
        /// <param name="portalName">The name of the site (portal).</param>
        /// <param name="ip">The IP Address of the user attempting to log in.</param>
        /// <param name="loginStatus">A <see cref="UserLoginStatus"/> enumeration that indicates the status of the
        /// login attempt.  This value is returned by reference.</param>
        /// <returns>The <see cref="UserInfo"/> object representing a valid user.</returns>
        public static UserInfo ValidateUser(int portalId, string username, string password, string authType, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus)
        {
            loginStatus = UserLoginStatus.LOGIN_FAILURE;

            // Try and Log the user in
            var user = MembershipProvider.Instance().UserLogin(GetEffectivePortalId(portalId), username, password, authType, verificationCode, ref loginStatus);
            if (loginStatus == UserLoginStatus.LOGIN_USERLOCKEDOUT || loginStatus == UserLoginStatus.LOGIN_FAILURE || loginStatus == UserLoginStatus.LOGIN_USERNOTAPPROVED)
            {
                // User Locked Out so log to event log
                AddEventLog(portalId, username, Null.NullInteger, portalName, ip, loginStatus);
            }

            // Check Default Accounts
            if (loginStatus == UserLoginStatus.LOGIN_SUCCESS || loginStatus == UserLoginStatus.LOGIN_SUPERUSER)
            {
                CheckInsecurePassword(username, password, ref loginStatus);
            }

            // Reset portalId
            FixMemberPortalId(user, portalId);

            // return the User object
            return user;
        }

        /// <summary>
        /// Validates a user's password and profile.
        /// </summary>
        /// <remarks>This overload takes a valid User (credentials check out) and check whether the password and profile need updating.</remarks>
        /// <param name="objUser">The user attempting to log in.</param>
        /// <param name="portalId">The id of the site (portal) the user belongs to.</param>
        /// <param name="ignoreExpiring">A value indicating whether to ingore expired user.</param>
        /// <returns>The <see cref="UserValidStatus"/> that represents the outcome.</returns>
        public static UserValidStatus ValidateUser(UserInfo objUser, int portalId, bool ignoreExpiring)
        {
            portalId = GetEffectivePortalId(portalId);

            var validStatus = UserValidStatus.VALID;

            // Check if Password needs to be updated
            if (objUser.Membership.UpdatePassword)
            {
                // Admin has forced password update
                validStatus = UserValidStatus.UPDATEPASSWORD;
            }
            else if (PasswordConfig.PasswordExpiry > 0)
            {
                var expiryDate = objUser.Membership.LastPasswordChangeDate.AddDays(PasswordConfig.PasswordExpiry);
                if (expiryDate < DateTime.Now)
                {
                    // Password Expired
                    validStatus = UserValidStatus.PASSWORDEXPIRED;
                }
                else if (expiryDate < DateTime.Now.AddDays(PasswordConfig.PasswordExpiryReminder) && (!ignoreExpiring))
                {
                    // Password update reminder
                    validStatus = UserValidStatus.PASSWORDEXPIRING;
                }
            }

            // Check if user needs to consent to terms
            if (validStatus == UserValidStatus.VALID && !(objUser.IsSuperUser || PortalSettings.Current.AdministratorId == objUser.UserID))
            {
                if (PortalSettings.Current.DataConsentActive)
                {
                    if (!objUser.HasAgreedToTerms)
                    {
                        validStatus = UserValidStatus.MUSTAGREETOTERMS;
                    }
                }
            }

            // Check if Profile needs updating
            if (validStatus == UserValidStatus.VALID)
            {
                var validProfile = Convert.ToBoolean(UserModuleBase.GetSetting(portalId, "Security_RequireValidProfileAtLogin"));
                if (validProfile && (!ProfileController.ValidateProfile(portalId, objUser.Profile)))
                {
                    validStatus = UserValidStatus.UPDATEPROFILE;
                }
            }

            return validStatus;
        }

        /// <summary>
        /// Tries to validate a verification code sent after a user is registered in a portal configured to use a verified registration.
        /// </summary>
        /// <param name="verificationCode">The verification code.</param>
        /// <exception cref="DotNetNuke.Entities.Users.UserAlreadyVerifiedException">Thrown when provided verification code has been already used.</exception>
        /// <exception cref="DotNetNuke.Entities.Users.InvalidVerificationCodeException">Thrown when the provided verification code is invalid.</exception>
        /// <exception cref="DotNetNuke.Entities.Users.UserDoesNotExistException">Thrown when the user does not exist.</exception>
        public static void VerifyUser(string verificationCode)
        {
            Requires.NotNullOrEmpty("verificationCode", verificationCode);

            var portalSecurity = PortalSecurity.Instance;
            var decryptString = portalSecurity.Decrypt(Config.GetDecryptionkey(), verificationCode);
            var strings = decryptString.Split('-');

            if (strings.Length != 2)
            {
                throw new InvalidVerificationCodeException();
            }

            int portalId;
            int userId;
            var userIdString = strings[1];

            if (!int.TryParse(strings[0], out portalId) || string.IsNullOrWhiteSpace(userIdString))
            {
                throw new InvalidVerificationCodeException();
            }

            var user = int.TryParse(userIdString, out userId) ? GetUserById(portalId, userId) : GetUserByMembershipUserKey(portalId, userIdString);

            if (user == null)
            {
                throw new UserDoesNotExistException();
            }

            if (user.Membership.Approved)
            {
                throw new UserAlreadyVerifiedException();
            }

            if (!user.IsInRole("Unverified Users"))
            {
                // A Registered User that has been unapproved has managed to get a valid verification code
                throw new InvalidVerificationCodeException();
            }

            user.Membership.Approved = true;
            UpdateUser(portalId, user);
            ApproveUser(user);
        }

        /// <summary>
        /// Returns a absolute URL for the user profile image while removing that of the deleted and super users.
        /// </summary>
        /// <param name="portalId">The site (portal) id.</param>
        /// <param name="user">The user to get the profile image from.</param>
        /// <param name="width">Width in pixels.</param>
        /// <param name="height">Height in pixels.</param>
        /// <param name="showSuperUsers">A value indicating whether to get the profile picture for SuperUsers (Hosts).</param>
        /// <returns>Absolute user profile picture url.</returns>
        /// <returns>A string containing the profile picture absolute url.</returns>
        public static string GetProfileAvatarAbsoluteUrl(
            int portalId,
            UserInfo user,
            int width = 64,
            int height = 64,
            bool showSuperUsers = true)
        {
            var userId = user != null && user.UserID > 0 && !user.IsDeleted && (showSuperUsers || !user.IsSuperUser) ? user.UserID : 0;
            var relativePath = Instance.GetUserProfilePictureUrl(portalId, userId, width, height);
            return GetAbsoluteUrl(portalId, relativePath);
        }

        /// <summary>
        /// Gets a user from the DataStore.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="userId">The id of the user being retrieved from the Data Store.</param>
        /// <returns>The user as a <see cref="UserInfo"/> object.</returns>
        public UserInfo GetUser(int portalId, int userId)
        {
            return GetUserById(portalId, userId);
        }

        /// <summary>
        /// Gets a user by it's display name.
        /// </summary>
        /// <param name="portalId">The id of the site (portal).</param>
        /// <param name="displayName">The display name to search.</param>
        /// <returns>A user as a <see cref="UserInfo"/> object.</returns>
        /// <remarks>
        /// This method will return the first match, unless the settings require unique display names,
        /// this method may return any user that matches that display name.
        /// </remarks>
        public UserInfo GetUserByDisplayname(int portalId, string displayName)
        {
            return MembershipProvider.Instance().GetUserByDisplayName(PortalController.GetEffectivePortalId(portalId), displayName);
        }

        /// <summary>
        /// Provides advanced paged search functionality for users.
        /// </summary>
        /// <param name="portalId">The site (portal) id to search in.</param>
        /// <param name="userId">The requesting user id (for view permissions of the search).</param>
        /// <param name="filterUserId">The user id for filtering relationships on, use <see cref="Null.NullInteger"/> to not use this filter.</param>
        /// <param name="filterRoleId">The role id to filter on, use <see cref="Null.NullInteger"/> to not use this filter.</param>
        /// <param name="relationTypeId">The relationship type id to filter on, use <see cref="Null.NullInteger"/> to not use this filter.</param>
        /// <param name="isAdmin">A value indicating whether the requesting user is an administrator.</param>
        /// <param name="pageIndex">The page to return.</param>
        /// <param name="pageSize">The size of each page.</param>
        /// <param name="sortColumn">The name of the column to sort on.</param>
        /// <param name="sortAscending">A value indicating whether to sort ascending, will sort descending if false.</param>
        /// <param name="propertyNames">A comma separated list of property names on which to search.</param>
        /// <param name="propertyValues">A comma separated list of property values to search.</param>
        /// <returns>An IList of <see cref="UserInfo"/> containing the search results.</returns>
        public IList<UserInfo> GetUsersAdvancedSearch(
            int portalId,
            int userId,
            int filterUserId,
            int filterRoleId,
            int relationTypeId,
            bool isAdmin,
            int pageIndex,
            int pageSize,
            string sortColumn,
            bool sortAscending,
            string propertyNames,
            string propertyValues)
        {
            return MembershipProvider.Instance().GetUsersAdvancedSearch(
                PortalController.GetEffectivePortalId(portalId),
                userId,
                filterUserId,
                filterRoleId,
                relationTypeId,
                isAdmin,
                pageIndex,
                pageSize,
                sortColumn,
                sortAscending,
                propertyNames,
                propertyValues);
        }

        /// <summary>
        /// Provides basic paged search functionality for users.
        /// </summary>
        /// <param name="portalId">The site (portal) id on which to perform the user search.</param>
        /// <param name="pageIndex">the page to get.</param>
        /// <param name="pageSize">the size of each page.</param>
        /// <param name="sortColumn">The name of the column to sort by.</param>
        /// <param name="sortAscending">A value indicating whether to sort ascending, will sort descending if false.</param>
        /// <param name="propertyName">The property name on which to filter by.</param>
        /// <param name="propertyValue">The property value to filter the column by.</param>
        /// <returns>An IList of <see cref="UserInfo"/> representing the found users.</returns>
        public IList<UserInfo> GetUsersBasicSearch(
            int portalId,
            int pageIndex,
            int pageSize,
            string sortColumn,
            bool sortAscending,
            string propertyName,
            string propertyValue)
        {
            return MembershipProvider.Instance().GetUsersBasicSearch(
                PortalController.GetEffectivePortalId(portalId),
                pageIndex,
                pageSize,
                sortColumn,
                sortAscending,
                propertyName,
                propertyValue);
        }

        /// <summary>
        /// Gets the user profile picture relative Url.
        /// </summary>
        /// <param name="userId">The id of the users to get the profile picture from.</param>
        /// <param name="width">Width in pixels.</param>
        /// <param name="height">Height in pixels.</param>
        /// <returns>Relative url,  e.g. /DnnImageHandler.ashx?userid=1&amp;h=32&amp;w=32 considering child portal.</returns>
        /// <remarks>Usage: ascx - &lt;asp:Image ID="avatar" runat="server" CssClass="SkinObject" /&gt;
        /// code behind - avatar.ImageUrl = UserController.Instance.GetUserProfilePictureUrl(userInfo.UserID, 32, 32).
        /// </remarks>
        public string GetUserProfilePictureUrl(int userId, int width, int height)
        {
            var url = $"/DnnImageHandler.ashx?mode=profilepic&userId={userId}&h={width}&w={height}";

            var childPortalAlias = GetChildPortalAlias();
            var cdv = GetProfilePictureCdv(userId);

            return childPortalAlias.StartsWith(Globals.ApplicationPath)
                ? childPortalAlias + url + cdv
                : Globals.ApplicationPath + childPortalAlias + url + cdv;
        }

        /// <summary>
        /// Checks if a username is valid.
        /// </summary>
        /// <param name="userName">The username to check.</param>
        /// <remarks>
        /// Validate username against bad characters; it must not start or end with space,
        /// must not contain control characters, and not contain special punctuations
        /// Printable ASCII: " !\"#$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
        /// Fallback to default if there is no host setting configured.
        /// </remarks>
        /// <returns>A value indicating whether the username is valid.</returns>
        public bool IsValidUserName(string userName)
        {
            char[] unallowedAscii = HostController.Instance.GetString("UsernameUnallowedCharacters", Globals.USERNAME_UNALLOWED_ASCII).ToCharArray();

            // if the httpcontext is null, then use the default minimum length
            var usernameMinLength = Globals.glbUserNameMinLength;
            if (HttpContext.Current != null)
            {
                usernameMinLength = PortalController.GetPortalSettingAsInteger("Security_UserNameMinLength", this.PortalId, usernameMinLength);
            }

            return userName.Length >= usernameMinLength &&
                        userName == userName.Trim() &&
                        userName.All(ch => ch >= ' ') &&
                        userName.IndexOfAny(unallowedAscii) < 0;
        }

        /// <summary>
        /// Gets the user profile picture url.
        /// </summary>
        /// <param name="portalId">The portal id the user belongs to.</param>
        /// <param name="userId">The id if the user to get the profile picture from.</param>
        /// <param name="width">The width in pixels of the picture.</param>
        /// <param name="height">The height in pixels of the picture.</param>
        /// <returns>A url to the profile picture for the user.</returns>
        public string GetUserProfilePictureUrl(int portalId, int userId, int width, int height)
        {
            var url = $"/DnnImageHandler.ashx?mode=profilepic&userId={userId}&h={width}&w={height}";

            var childPortalAlias = Globals.ResolveUrl(this.GetUserProfilePictureUrl(userId, width, height));
            var cdv = GetProfilePictureCdv(portalId, userId);

            return childPortalAlias.StartsWith(Globals.ApplicationPath)
                ? childPortalAlias + url + cdv
                : Globals.ApplicationPath + childPortalAlias + url + cdv;
        }

        /// <summary>
        /// Update all the users display names.
        /// </summary>
        public void UpdateDisplayNames()
        {
            int portalId = GetEffectivePortalId(this.PortalId);

            var arrUsers = GetUsers(this.PortalId);
            foreach (UserInfo objUser in arrUsers)
            {
                objUser.UpdateDisplayName(this.DisplayFormat);
                UpdateUser(portalId, objUser);
            }
        }

        /// <summary>
        /// Gets the current user information.
        /// </summary>
        /// <returns>The user information in a <see cref="UserInfo"/> object.</returns>
        UserInfo IUserController.GetCurrentUserInfo()
        {
            return GetCurrentUserInternal();
        }

        /// <summary>
        /// Gets a user by it's user id.
        /// </summary>
        /// <param name="portalId">The site (portal) id of the user.</param>
        /// <param name="userId">The user id of the user.</param>
        /// <returns>The user information in a <see cref="UserInfo"/> object.</returns>
        UserInfo IUserController.GetUserById(int portalId, int userId)
        {
            return GetUserById(portalId, userId);
        }

        /// <summary>
        /// Gets a list of user related portal settings.
        /// </summary>
        /// <param name="portalId">The site (portal) id from which to get the settings from.</param>
        /// <param name="settings">The list of settings to filter from.</param>
        /// <returns>A Hashtable of the user related portal settings.</returns>
        internal static Hashtable GetUserSettings(int portalId, Hashtable settings)
        {
            portalId = GetEffectivePortalId(portalId);

            if (settings["Column_FirstName"] == null)
            {
                settings["Column_FirstName"] = false;
            }

            if (settings["Column_LastName"] == null)
            {
                settings["Column_LastName"] = false;
            }

            if (settings["Column_DisplayName"] == null)
            {
                settings["Column_DisplayName"] = true;
            }

            if (settings["Column_Address"] == null)
            {
                settings["Column_Address"] = true;
            }

            if (settings["Column_Telephone"] == null)
            {
                settings["Column_Telephone"] = true;
            }

            if (settings["Column_Email"] == null)
            {
                settings["Column_Email"] = false;
            }

            if (settings["Column_CreatedDate"] == null)
            {
                settings["Column_CreatedDate"] = true;
            }

            if (settings["Column_LastLogin"] == null)
            {
                settings["Column_LastLogin"] = false;
            }

            if (settings["Column_Authorized"] == null)
            {
                settings["Column_Authorized"] = true;
            }

            if (settings["Display_Mode"] == null)
            {
                settings["Display_Mode"] = DisplayMode.All;
            }
            else
            {
                settings["Display_Mode"] = (DisplayMode)Convert.ToInt32(settings["Display_Mode"]);
            }

            if (settings["Display_SuppressPager"] == null)
            {
                settings["Display_SuppressPager"] = false;
            }

            if (settings["Records_PerPage"] == null)
            {
                settings["Records_PerPage"] = 10;
            }

            if (settings["Profile_DefaultVisibility"] == null)
            {
                settings["Profile_DefaultVisibility"] = UserVisibilityMode.AdminOnly;
            }
            else
            {
                settings["Profile_DefaultVisibility"] = (UserVisibilityMode)Convert.ToInt32(settings["Profile_DefaultVisibility"]);
            }

            if (settings["Profile_DisplayVisibility"] == null)
            {
                settings["Profile_DisplayVisibility"] = true;
            }

            if (settings["Profile_ManageServices"] == null)
            {
                settings["Profile_ManageServices"] = true;
            }

            if (settings["Redirect_AfterLogin"] == null)
            {
                settings["Redirect_AfterLogin"] = -1;
            }

            if (settings["Redirect_AfterRegistration"] == null)
            {
                settings["Redirect_AfterRegistration"] = -1;
            }

            if (settings["Redirect_AfterLogout"] == null)
            {
                settings["Redirect_AfterLogout"] = -1;
            }

            if (settings["Security_CaptchaLogin"] == null)
            {
                settings["Security_CaptchaLogin"] = false;
            }

            if (settings["Security_CaptchaRegister"] == null)
            {
                settings["Security_CaptchaRegister"] = false;
            }

            if (settings["Security_CaptchaChangePassword"] == null)
            {
                settings["Security_CaptchaChangePassword"] = false;
            }

            if (settings["Security_CaptchaRetrivePassword"] == null)
            {
                settings["Security_CaptchaRetrivePassword"] = false;
            }

            if (settings["Security_EmailValidation"] == null)
            {
                settings["Security_EmailValidation"] = Globals.glbEmailRegEx;
            }

            if (settings["Security_UserNameValidation"] == null)
            {
                settings["Security_UserNameValidation"] = Globals.glbUserNameRegEx;
            }

            // Forces a valid profile on registration
            if (settings["Security_RequireValidProfile"] == null)
            {
                settings["Security_RequireValidProfile"] = false;
            }

            // Forces a valid profile on login
            if (settings["Security_RequireValidProfileAtLogin"] == null)
            {
                settings["Security_RequireValidProfileAtLogin"] = true;
            }

            if (settings["Security_UsersControl"] == null)
            {
                var portal = PortalController.Instance.GetPortal(portalId);

                if (portal != null && portal.Users > 1000)
                {
                    settings["Security_UsersControl"] = UsersControl.TextBox;
                }
                else
                {
                    settings["Security_UsersControl"] = UsersControl.Combo;
                }
            }
            else
            {
                settings["Security_UsersControl"] = (UsersControl)Convert.ToInt32(settings["Security_UsersControl"]);
            }

            // Display name format
            if (settings["Security_DisplayNameFormat"] == null)
            {
                settings["Security_DisplayNameFormat"] = string.Empty;
            }

            if (settings["Registration_RequireConfirmPassword"] == null)
            {
                settings["Registration_RequireConfirmPassword"] = true;
            }

            if (settings["Registration_RandomPassword"] == null)
            {
                settings["Registration_RandomPassword"] = false;
            }

            if (settings["Registration_UseEmailAsUserName"] == null)
            {
                settings["Registration_UseEmailAsUserName"] = false;
            }

            if (settings["Registration_UseAuthProviders"] == null)
            {
                settings["Registration_UseAuthProviders"] = false;
            }

            if (settings["Registration_UseProfanityFilter"] == null)
            {
                settings["Registration_UseProfanityFilter"] = false;
            }

            if (settings["Registration_RegistrationFormType"] == null)
            {
                settings["Registration_RegistrationFormType"] = 0;
            }

            if (settings["Registration_RegistrationFields"] == null)
            {
                settings["Registration_RegistrationFields"] = string.Empty;
            }

            if (settings["Registration_ExcludeTerms"] == null)
            {
                settings["Registration_ExcludeTerms"] = string.Empty;
            }

            if (settings["Registration_RequireUniqueDisplayName"] == null)
            {
                settings["Registration_RequireUniqueDisplayName"] = false;
            }

            return settings;
        }

        /// -----------------------------------------------------------------------------
        /// <summary>
        ///   updates a user.
        /// </summary>
        /// <param name="portalId">the portalid of the user.</param>
        /// <param name="user">the user object.</param>
        /// <param name="loggedAction">whether or not the update calls the eventlog - the eventlogtype must still be enabled for logging to occur.</param>
        /// <param name="sendNotification">Whether to send notification to the user about the update (i.e. a notification if the user was approved).</param>
        /// <param name="clearCache">Whether clear cache after update user.</param>
        /// <remarks>
        /// This method is used internal because it should be use carefully, or it will caught cache doesn't clear correctly.
        /// </remarks>
        internal static void UpdateUser(int portalId, UserInfo user, bool loggedAction, bool sendNotification, bool clearCache)
        {
            var originalPortalId = user.PortalID;
            portalId = GetEffectivePortalId(portalId);
            user.PortalID = portalId;

            // clear the cache so that can get original info from database.
            DataCache.RemoveCache(string.Format(DataCache.UserProfileCacheKey, portalId, user.Username));
            var oldUser = MembershipProvider.Instance().GetUser(user.PortalID, user.UserID);
            var oldProfile = oldUser.Profile; // access the profile property to reload data from database.

            // Update the User
            MembershipProvider.Instance().UpdateUser(user);
            if (loggedAction)
            {
                // if the httpcontext is null, then get portal settings by portal id.
                IPortalSettings portalSettings = null;
                if (HttpContext.Current != null)
                {
                    portalSettings = PortalController.Instance.GetCurrentSettings();
                }
                else if (portalId > Null.NullInteger)
                {
                    portalSettings = new PortalSettings(portalId);
                }

                EventLogController.Instance.AddLog(user, portalSettings, GetCurrentUserInternal().UserID, string.Empty, EventLogController.EventLogType.USER_UPDATED);
            }

            EventManager.Instance.OnUserUpdated(new UpdateUserEventArgs { User = user, OldUser = oldUser });

            // Reset PortalId
            FixMemberPortalId(user, originalPortalId);

            // Remove the UserInfo from the Cache, as it has been modified
            if (clearCache)
            {
                DataCache.ClearUserCache(portalId, user.Username);
            }

            if (!user.Membership.Approving)
            {
                return;
            }

            user.Membership.ConfirmApproved();
            EventManager.Instance.OnUserApproved(new UserEventArgs { User = user });
        }

        /// <summary>
        /// Gets a new <see cref="UserController"/> instance.
        /// </summary>
        /// <returns>A new instance of the <see cref="UserController"/> class.</returns>
        protected override Func<IUserController> GetFactory()
        {
            return () => new UserController();
        }

        private static void ClearPortalAndUserCache(UserInfo user, int portalId)
        {
            DeleteUserFolder(user, portalId);
            DataCache.ClearPortalCache(portalId, false);
            DataCache.ClearUserCache(portalId, user.Username);
        }

        private static void AddEventLog(int portalId, string username, int userId, string portalName, string ip, UserLoginStatus loginStatus)
        {
            // initialize log record
            var objSecurity = PortalSecurity.Instance;
            var log = new LogInfo
            {
                LogTypeKey = loginStatus.ToString(),
                LogPortalID = portalId,
                LogPortalName = portalName,
                LogUserName = objSecurity.InputFilter(username, PortalSecurity.FilterFlag.NoScripting | PortalSecurity.FilterFlag.NoAngleBrackets | PortalSecurity.FilterFlag.NoMarkup),
                LogUserID = userId,
            };
            log.AddProperty("IP", ip);

            // create log record
            LogController.Instance.AddLog(log);
        }

        private static void AutoAssignUsersToPortalRoles(UserInfo user, int portalId)
        {
            foreach (var role in RoleController.Instance.GetRoles(portalId, role => role.AutoAssignment && role.Status == RoleStatus.Approved))
            {
                RoleController.Instance.AddUserRole(portalId, user.UserID, role.RoleID, RoleStatus.Approved, false, Null.NullDate, Null.NullDate);
            }

            // Clear the roles cache - so the usercount is correct
            RoleController.Instance.ClearRoleCache(portalId);
        }

        private static void AutoAssignUsersToRoles(UserInfo user, int portalId)
        {
            var thisPortal = PortalController.Instance.GetPortal(portalId);

            if (IsMemberOfPortalGroup(portalId))
            {
                foreach (var portal in PortalGroupController.Instance.GetPortalsByGroup(thisPortal.PortalGroupID))
                {
                    if (!user.Membership.Approved && portal.UserRegistration == (int)Globals.PortalRegistrationType.VerifiedRegistration)
                    {
                        var role = RoleController.Instance.GetRole(portal.PortalID, r => r.RoleName == "Unverified Users");
                        RoleController.Instance.AddUserRole(portal.PortalID, user.UserID, role.RoleID, RoleStatus.Approved, false, Null.NullDate, Null.NullDate);
                    }
                    else
                    {
                        AutoAssignUsersToPortalRoles(user, portal.PortalID);
                    }
                }
            }
            else
            {
                if (!user.Membership.Approved && thisPortal.UserRegistration == (int)Globals.PortalRegistrationType.VerifiedRegistration)
                {
                    var role = RoleController.Instance.GetRole(portalId, r => r.RoleName == "Unverified Users");
                    RoleController.Instance.AddUserRole(portalId, user.UserID, role.RoleID, RoleStatus.Approved, false, Null.NullDate, Null.NullDate);
                }
                else
                {
                    AutoAssignUsersToPortalRoles(user, portalId);
                }
            }
        }

        // TODO - Handle Portal Groups
        private static void DeleteUserPermissions(UserInfo user)
        {
            FolderPermissionController.DeleteFolderPermissionsByUser(user);

            // Delete Module Permissions
            ModulePermissionController.DeleteModulePermissionsByUser(user);

            // Delete Tab Permissions
            TabPermissionController.DeleteTabPermissionsByUser(user);
        }

        private static void RestoreUserPermissions(UserInfo user)
        {
            // restore user's folder permission
            var userFolderPath = ((PathUtils)PathUtils.Instance).GetUserFolderPathInternal(user);
            var portalId = user.IsSuperUser ? Null.NullInteger : user.PortalID;
            var userFolder = FolderManager.Instance.GetFolder(portalId, userFolderPath);

            if (userFolder != null)
            {
                foreach (PermissionInfo permission in PermissionController.GetPermissionsByFolder())
                {
                    if (permission.PermissionKey.Equals("READ", StringComparison.OrdinalIgnoreCase)
                            || permission.PermissionKey.Equals("WRITE", StringComparison.OrdinalIgnoreCase)
                            || permission.PermissionKey.Equals("BROWSE", StringComparison.OrdinalIgnoreCase))
                    {
                        var folderPermission = new FolderPermissionInfo(permission)
                        {
                            FolderID = userFolder.FolderID,
                            UserID = user.UserID,
                            RoleID = int.Parse(Globals.glbRoleNothing),
                            AllowAccess = true,
                        };

                        userFolder.FolderPermissions.Add(folderPermission, true);
                    }
                }

                FolderPermissionController.SaveFolderPermissions((FolderInfo)userFolder);
            }
        }

        private static void FixMemberPortalId(UserInfo user, int portalId)
        {
            if (user != null)
            {
                user.PortalID = portalId;
            }
        }

        private static UserInfo GetCurrentUserInternal()
        {
            UserInfo user;
            if (HttpContext.Current == null)
            {
                if (!Thread.CurrentPrincipal.Identity.IsAuthenticated)
                {
                    return new UserInfo();
                }

                var portalSettings = PortalController.Instance.GetCurrentSettings();
                if (portalSettings != null)
                {
                    user = GetCachedUser(portalSettings.PortalId, Thread.CurrentPrincipal.Identity.Name);
                    return user ?? new UserInfo();
                }

                return new UserInfo();
            }

            user = (UserInfo)HttpContext.Current.Items["UserInfo"];
            return user ?? new UserInfo();
        }

        private static int GetEffectivePortalId(int portalId)
        {
            return PortalController.GetEffectivePortalId(portalId);
        }

        private static object GetUserCountByPortalCallBack(CacheItemArgs cacheItemArgs)
        {
            var portalId = (int)cacheItemArgs.ParamList[0];
            var portalUserCount = MembershipProvider.Instance().GetUserCountByPortal(portalId);
            DataCache.SetCache(cacheItemArgs.CacheKey, portalUserCount);
            return portalUserCount;
        }

        private static SharedDictionary<int, string> GetUserLookupDictionary(int portalId)
        {
            var masterPortalId = GetEffectivePortalId(portalId);
            var cacheKey = string.Format(DataCache.UserLookupCacheKey, masterPortalId);
            return CBO.GetCachedObject<SharedDictionary<int, string>>(
                new CacheItemArgs(
                    cacheKey,
                    DataCache.UserLookupCacheTimeOut,
                    DataCache.UserLookupCachePriority),
                (c) => new SharedDictionary<int, string>(),
                true);
        }

        private static bool IsMemberOfPortalGroup(int portalId)
        {
            return PortalController.IsMemberOfPortalGroup(portalId);
        }

        private static void MergeUserProfileProperties(UserInfo userMergeFrom, UserInfo userMergeTo)
        {
            foreach (ProfilePropertyDefinition property in userMergeFrom.Profile.ProfileProperties)
            {
                if (string.IsNullOrEmpty(userMergeTo.Profile.GetPropertyValue(property.PropertyName)))
                {
                    userMergeTo.Profile.SetProfileProperty(property.PropertyName, property.PropertyValue);
                }
            }
        }

        private static void MergeUserProperties(UserInfo userMergeFrom, UserInfo userMergeTo)
        {
            if (string.IsNullOrEmpty(userMergeTo.DisplayName))
            {
                userMergeTo.DisplayName = userMergeFrom.DisplayName;
            }

            if (string.IsNullOrEmpty(userMergeTo.Email))
            {
                userMergeTo.Email = userMergeFrom.Email;
            }

            if (string.IsNullOrEmpty(userMergeTo.FirstName))
            {
                userMergeTo.FirstName = userMergeFrom.FirstName;
            }

            if (string.IsNullOrEmpty(userMergeTo.LastName))
            {
                userMergeTo.LastName = userMergeFrom.LastName;
            }
        }

        private static void SendDeleteEmailNotifications(UserInfo user, PortalSettings portalSettings)
        {
            var message = new Message();
            message.FromUserID = portalSettings.AdministratorId;
            message.ToUserID = portalSettings.AdministratorId;
            message.Subject = Localization.GetSystemMessage(
                user.Profile.PreferredLocale,
                portalSettings,
                "EMAIL_USER_UNREGISTER_SUBJECT",
                user,
                Localization.GlobalResourceFile,
                null,
                string.Empty,
                portalSettings.AdministratorId);
            message.Body = Localization.GetSystemMessage(
                user.Profile.PreferredLocale,
                portalSettings,
                "EMAIL_USER_UNREGISTER_BODY",
                user,
                Localization.GlobalResourceFile,
                null,
                string.Empty,
                portalSettings.AdministratorId);
            message.Status = MessageStatusType.Unread;
            Mail.SendEmail(portalSettings.Email, portalSettings.Email, message.Subject, message.Body);
        }

        private static string GetChildPortalAlias()
        {
            var settings = PortalController.Instance.GetCurrentPortalSettings();
            var currentAlias = settings.PortalAlias.HTTPAlias;
            var index = currentAlias.IndexOf('/');
            var childPortalAlias = index > 0 ? "/" + currentAlias.Substring(index + 1) : string.Empty;
            return childPortalAlias;
        }

        private static string GetProfilePictureCdv(int userId)
        {
            var settings = PortalController.Instance.GetCurrentSettings();
            var userInfo = GetUserById(settings.PortalId, userId);
            if (userInfo?.Profile == null)
            {
                return string.Empty;
            }

            var cdv = string.Empty;
            var photoProperty = userInfo.Profile.GetProperty("Photo");

            int photoFileId;
            if (int.TryParse(photoProperty?.PropertyValue, out photoFileId))
            {
                var photoFile = FileManager.Instance.GetFile(photoFileId);
                if (photoFile != null)
                {
                    cdv = "&cdv=" + photoFile.LastModifiedOnDate.Ticks;
                }
            }

            return cdv;
        }

        private static string GetProfilePictureCdv(int portalId, int userId)
        {
            var userInfo = GetUserById(portalId, userId);
            if (userInfo?.Profile == null)
            {
                return string.Empty;
            }

            var cdv = string.Empty;
            var photoProperty = userInfo.Profile.GetProperty("Photo");

            int photoFileId;
            if (int.TryParse(photoProperty?.PropertyValue, out photoFileId))
            {
                var photoFile = FileManager.Instance.GetFile(photoFileId);
                if (photoFile != null)
                {
                    cdv = "&cdv=" + photoFile.LastModifiedOnDate.Ticks;
                }
            }

            return cdv;
        }

        /// <summary>
        /// Delete the contents and folder that belongs to a user in a specific portal.
        /// </summary>
        /// <param name="user">The user for whom to delete the folder.
        /// Note the PortalID is taken to specify which portal to delete the folder from.</param>
        /// <param name="portalId">The portal id that contains the user folder to delete.</param>
        private static void DeleteUserFolder(UserInfo user, int portalId)
        {
            var userFolderPath = ((PathUtils)PathUtils.Instance).GetUserFolderPathInternal(user);
            var folderPortalId = user.IsSuperUser ? Null.NullInteger : portalId;
            var userFolder = FolderManager.Instance.GetFolder(folderPortalId, userFolderPath);
            if (userFolder != null)
            {
                FolderManager.Instance.Synchronize(folderPortalId, userFolderPath, true, true);
                var notDeletedSubfolders = new List<IFolderInfo>();
                FolderManager.Instance.DeleteFolder(userFolder, notDeletedSubfolders);

                if (notDeletedSubfolders.Count == 0)
                {
                    // try to remove the parent folder if there is no other users use this folder.
                    var parentFolder = FolderManager.Instance.GetFolder(userFolder.ParentID);
                    FolderManager.Instance.Synchronize(folderPortalId, parentFolder.FolderPath, true, true);
                    if (parentFolder != null && !FolderManager.Instance.GetFolders(parentFolder).Any())
                    {
                        FolderManager.Instance.DeleteFolder(parentFolder, notDeletedSubfolders);

                        if (notDeletedSubfolders.Count == 0)
                        {
                            // try to remove the root folder if there is no other users use this folder.
                            var rootFolder = FolderManager.Instance.GetFolder(parentFolder.ParentID);
                            FolderManager.Instance.Synchronize(folderPortalId, rootFolder.FolderPath, true, true);
                            if (rootFolder != null && !FolderManager.Instance.GetFolders(rootFolder).Any())
                            {
                                FolderManager.Instance.DeleteFolder(rootFolder, notDeletedSubfolders);
                            }
                        }
                    }
                }
            }
        }

        /// <summary>
        /// Returns an absolute url given a relative url.
        /// </summary>
        /// <param name="portalId">portal Id.</param>
        /// <param name="relativeUrl">relative url.</param>
        /// <returns>absolute url.</returns>
        private static string GetAbsoluteUrl(int portalId, string relativeUrl)
        {
            if (relativeUrl.Contains("://"))
            {
                return relativeUrl;
            }

            var portalAlias = PortalAliasController.Instance.GetPortalAliasesByPortalId(portalId).First(p => p.IsPrimary);
            var domainName = GetDomainName(portalAlias);
            return Globals.AddHTTP(domainName + relativeUrl);
        }

        private static string GetDomainName(PortalAliasInfo portalAlias)
        {
            var httpAlias = portalAlias.HTTPAlias;
            return httpAlias.IndexOf("/", StringComparison.InvariantCulture) != -1 ?
                httpAlias.Substring(0, httpAlias.IndexOf("/", StringComparison.InvariantCulture)) :
                httpAlias;
        }

        private static UserInfo GetUserByMembershipUserKey(int portalId, string membershipUserKey)
        {
            var masterPortalId = GetEffectivePortalId(portalId);
            var user = MembershipProvider.Instance().GetUserByProviderUserKey(masterPortalId, membershipUserKey);
            FixMemberPortalId(user, portalId);
            return user;
        }
    }
}