/*
 * Copyright (c) 2026, WSO2 LLC. (http://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.wso2.carbon.identity.api.user.credential.common.utils;

import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.identity.api.user.common.function.UniqueIdToUser;
import org.wso2.carbon.identity.api.user.credential.common.CredentialManagementConstants.ErrorMessages;
import org.wso2.carbon.identity.api.user.credential.common.CredentialManagementServiceDataHolder;
import org.wso2.carbon.identity.api.user.credential.common.exception.CredentialMgtClientException;
import org.wso2.carbon.identity.api.user.credential.common.exception.CredentialMgtServerException;
import org.wso2.carbon.identity.application.common.model.User;
import org.wso2.carbon.identity.core.util.IdentityTenantUtil;
import org.wso2.carbon.user.api.UserStoreException;
import org.wso2.carbon.user.api.UserStoreManager;
import org.wso2.carbon.user.core.UniqueIDUserStoreManager;
import org.wso2.carbon.user.core.service.RealmService;

/**
 * Utility class of User Credential Management.
 */
public class CredentialManagementUtils {

    private static final Log LOG = LogFactory.getLog(CredentialManagementUtils.class);

    private CredentialManagementUtils() {

    }

    /**
     * Handle credential management server exceptions.
     *
     * @param error Error message.
     * @param e     Throwable.
     * @param data  Data to be included in the error message.
     * @return CredentialMgtServerException
     */
    public static CredentialMgtServerException handleServerException(ErrorMessages error, Throwable e,
                                                                     Object... data) {

        String description = error.getDescription();
        if (ArrayUtils.isNotEmpty(data)) {
            description = String.format(description, data);
        }

        return new CredentialMgtServerException(error.getCode(), error.getMessage(), description, e);
    }

    /**
     * Handle credential management client exceptions.
     *
     * @param error Error message.
     * @param e     Throwable.
     * @param data  Data to be included in the error message.
     * @return CredentialMgtClientException
     */
    public static CredentialMgtClientException handleClientException(ErrorMessages error, Throwable e,
                                                                     Object... data) {

        String description = error.getDescription();
        if (ArrayUtils.isNotEmpty(data)) {
            description = String.format(description, data);
        }

        return new CredentialMgtClientException(error.getCode(), error.getMessage(), description, e);
    }

    /**
     * Resolves the username from the given user ID (UUID).
     *
     * @param userId User ID (UUID) to resolve the username for.
     * @return Resolved User object containing the username and other details.
     */
    public static User resolveUsernameFromUserId(String userId) {

        RealmService realmService = CredentialManagementServiceDataHolder.getRealmService();
        return new UniqueIdToUser().apply(realmService, userId, IdentityTenantUtil.resolveTenantDomain());
    }

    /**
     * Validates whether a user exists for the given user ID (UUID).
     *
     * @param userId User ID (UUID) to validate.
     * @return true if the user exists, false otherwise.
     * @throws CredentialMgtServerException if an error occurs while validating the user ID.
     */
    public static boolean validateUserId(String userId) throws CredentialMgtServerException {

        String tenantDomain = IdentityTenantUtil.resolveTenantDomain();
        RealmService realmService = CredentialManagementServiceDataHolder.getRealmService();

        try {
            UserStoreManager userStoreManager = realmService.getTenantUserRealm(
                    IdentityTenantUtil.getTenantId(tenantDomain)).getUserStoreManager();
            if (!(userStoreManager instanceof UniqueIDUserStoreManager)) {
                if (LOG.isDebugEnabled()) {
                    LOG.debug("User store manager does not support unique user IDs. " +
                            "Cannot validate user ID: " + userId);
                }
                return false;
            }
            return ((UniqueIDUserStoreManager) userStoreManager).isExistingUserWithID(userId);
        } catch (UserStoreException e) {
            throw handleServerException(ErrorMessages.ERROR_CODE_VALIDATE_USER_ID_FAILURE, e, userId);
        }
    }
}
