RestTokenDataClient.java

/*
 * Password Management Servlets (PWM)
 * http://www.pwm-project.org
 *
 * Copyright (c) 2006-2009 Novell, Inc.
 * Copyright (c) 2009-2017 The PWM Project
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package password.pwm.ws.client.rest;

import com.novell.ldapchai.exception.ChaiUnavailableException;
import password.pwm.PwmApplication;
import password.pwm.PwmConstants;
import password.pwm.bean.SessionLabel;
import password.pwm.bean.UserIdentity;
import password.pwm.bean.UserInfoBean;
import password.pwm.bean.pub.PublicUserInfoBean;
import password.pwm.config.PwmSetting;
import password.pwm.error.ErrorInformation;
import password.pwm.error.PwmError;
import password.pwm.error.PwmOperationalException;
import password.pwm.error.PwmUnrecoverableException;
import password.pwm.ldap.UserStatusReader;
import password.pwm.util.java.JsonUtil;
import password.pwm.util.logging.PwmLogger;
import password.pwm.util.macro.MacroMachine;

import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;

public class RestTokenDataClient implements RestClient {

    private static final PwmLogger LOGGER = PwmLogger.forClass(RestTokenDataClient.class);

    public static class TokenDestinationData implements Serializable {
        private String email;
        private String sms;
        private String displayValue;

        public TokenDestinationData(
                final String email,
                final String sms,
                final String displayValue
        )
        {
            this.email = email;
            this.sms = sms;
            this.displayValue = displayValue;
        }

        public String getEmail()
        {
            return email;
        }

        public String getSms()
        {
            return sms;
        }

        public String getDisplayValue()
        {
            return displayValue;
        }
    }

    private final PwmApplication pwmApplication;

    public RestTokenDataClient(final PwmApplication pwmApplication)
    {
        this.pwmApplication = pwmApplication;
    }

    private TokenDestinationData invoke(
            final SessionLabel sessionLabel,
            final TokenDestinationData tokenDestinationData,
            final UserIdentity userIdentity,
            final String url,
            final Locale locale
    )
            throws PwmOperationalException, ChaiUnavailableException, PwmUnrecoverableException
    {
        if (tokenDestinationData == null) {
            throw new NullPointerException("tokenDestinationData can not be null");
        }

        final Map<String,Object> sendData = new LinkedHashMap<>();
        sendData.put(DATA_KEY_TOKENDATA, tokenDestinationData);
        if (userIdentity != null) {
            final UserStatusReader userStatusReader = new UserStatusReader(pwmApplication, sessionLabel);
            final UserInfoBean userInfoBean = userStatusReader.populateUserInfoBean(
                    locale,
                    userIdentity
            );

            final MacroMachine macroMachine = MacroMachine.forUser(pwmApplication, PwmConstants.DEFAULT_LOCALE, SessionLabel.SYSTEM_LABEL, userInfoBean.getUserIdentity());
            final PublicUserInfoBean publicUserInfoBean = PublicUserInfoBean.fromUserInfoBean(userInfoBean, pwmApplication.getConfig(), PwmConstants.DEFAULT_LOCALE, macroMachine);
            sendData.put(RestClient.DATA_KEY_USERINFO, publicUserInfoBean);
        }


        final String jsonRequestData = JsonUtil.serializeMap(sendData);
        final String responseBody = RestClientHelper.makeOutboundRestWSCall(pwmApplication, locale, url, jsonRequestData);
        return JsonUtil.deserialize(responseBody,TokenDestinationData.class);
    }

    public TokenDestinationData figureDestTokenDisplayString(
            final SessionLabel sessionLabel,
            final TokenDestinationData tokenDestinationData,
            final UserIdentity userIdentity,
            final Locale locale
    )
            throws PwmUnrecoverableException
    {
        final String configuredUrl = pwmApplication.getConfig().readSettingAsString(PwmSetting.EXTERNAL_MACROS_DEST_TOKEN_URLS);
        if (configuredUrl != null && !configuredUrl.isEmpty()) {
            try {
                LOGGER.trace(sessionLabel, "beginning token destination rest client call to " + configuredUrl);
                return invoke(sessionLabel, tokenDestinationData, userIdentity, configuredUrl, locale);
            } catch (Exception e) {
                final String errorMsg = "error making token destination rest client call; error: " + e.getMessage();
                LOGGER.error(sessionLabel, errorMsg);
                throw new PwmUnrecoverableException(new ErrorInformation(PwmError.ERROR_SERVICE_NOT_AVAILABLE,errorMsg));
            }
        }
        return builtInService(tokenDestinationData);
    }

    private TokenDestinationData builtInService(final TokenDestinationData tokenDestinationData) {
        final StringBuilder tokenSendDisplay = new StringBuilder();

        if (tokenDestinationData.getEmail() != null) {
            tokenSendDisplay.append(tokenDestinationData.getEmail());
        }

        if (tokenDestinationData.getSms() != null) {
            if (tokenSendDisplay.length() > 0) {
                tokenSendDisplay.append(" / ");
            }

            tokenSendDisplay.append(tokenDestinationData.getSms());
        }

        return new TokenDestinationData(
                tokenDestinationData.getEmail(),
                tokenDestinationData.getSms(),
                tokenSendDisplay.toString()
        );
    }
}