src/com/android/phone/vvm/omtp/protocol/Vvm3Protocol.java - platform/packages/services/Telephony - Gitiles

 /*
  * Copyright (C) 2016 The Android Open Source Project
  *
  * Licensed 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 com.android.phone.vvm.omtp.protocol;

 import android.annotation.Nullable;
 import android.content.Context;
 import android.net.Network;
 import android.os.Bundle;
 import android.telecom.PhoneAccountHandle;
 import android.telephony.SmsManager;

 import com.android.phone.common.mail.MessagingException;
 import com.android.phone.settings.VisualVoicemailSettingsUtil;
 import com.android.phone.settings.VoicemailChangePinActivity;
 import com.android.phone.vvm.omtp.OmtpConstants;
 import com.android.phone.vvm.omtp.OmtpEvents;
 import com.android.phone.vvm.omtp.OmtpVvmCarrierConfigHelper;
 import com.android.phone.vvm.omtp.VisualVoicemailPreferences;
 import com.android.phone.vvm.omtp.VvmLog;
 import com.android.phone.vvm.omtp.imap.ImapHelper;
 import com.android.phone.vvm.omtp.sms.OmtpMessageSender;
 import com.android.phone.vvm.omtp.sms.StatusMessage;
 import com.android.phone.vvm.omtp.sms.Vvm3MessageSender;
 import com.android.phone.vvm.omtp.sync.VvmNetworkRequestCallback;

 import java.io.IOException;
 import java.security.SecureRandom;
 import java.util.Locale;

 /**
  * A flavor of OMTP protocol with a different provisioning process
  *
  * Used by carriers such as Verizon Wireless
  */
 public class Vvm3Protocol extends VisualVoicemailProtocol {

     private static String TAG = "Vvm3Protocol";

     private static String IMAP_CHANGE_TUI_PWD_FORMAT = "CHANGE_TUI_PWD PWD=%1$s OLD_PWD=%2$s";
     private static String IMAP_CHANGE_VM_LANG_FORMAT = "CHANGE_VM_LANG Lang=%1$s";
     private static String IMAP_CLOSE_NUT = "CLOSE_NUT";

     private static String ISO639_Spanish = "es";

     // Default prompt level when using the telephone user interface.
     // Standard prompt when the user call into the voicemail, and no prompts when someone else is
     // leaving a voicemail.
     private static String VVM3_VM_LANGUAGE_ENGLISH_STANDARD_NO_GUEST_PROMPTS = "5";
     private static String VVM3_VM_LANGUAGE_SPANISH_STANDARD_NO_GUEST_PROMPTS = "6";

     private static final int DEFAULT_PIN_LENGTH = 6;

     @Override
     public void startActivation(OmtpVvmCarrierConfigHelper config) {
         // VVM3 does not support activation SMS.
         // Send a status request which will start the provisioning process if the user is not
         // provisioned.
         VvmLog.i(TAG, "Activating");
         config.requestStatus();
     }

     @Override
     public void startDeactivation(OmtpVvmCarrierConfigHelper config) {
         // VVM3 does not support deactivation.
         // do nothing.
     }

     @Override
     public void startProvisioning(PhoneAccountHandle phoneAccountHandle,
             OmtpVvmCarrierConfigHelper config, StatusMessage message, Bundle data) {
         VvmLog.i(TAG, "start vvm3 provisioning");
         if (OmtpConstants.SUBSCRIBER_UNKNOWN.equals(message.getProvisioningStatus())) {
             VvmLog.i(TAG, "Provisioning status: Unknown, subscribing");
             new Vvm3Subscriber(phoneAccountHandle, config, data).subscribe();
         } else if (OmtpConstants.SUBSCRIBER_NEW.equals(message.getProvisioningStatus())) {
             VvmLog.i(TAG, "setting up new user");
             // Save the IMAP credentials in preferences so they are persistent and can be retrieved.
             VisualVoicemailPreferences prefs =
                     new VisualVoicemailPreferences(config.getContext(), phoneAccountHandle);
             message.putStatus(prefs.edit()).apply();

             startProvisionNewUser(phoneAccountHandle, config, message);
         } else if (OmtpConstants.SUBSCRIBER_PROVISIONED.equals(message.getProvisioningStatus())) {
             VvmLog.i(TAG, "User provisioned but not activated, disabling VVM");
             VisualVoicemailSettingsUtil
                     .setEnabled(config.getContext(), phoneAccountHandle, false);
         } else if (OmtpConstants.SUBSCRIBER_BLOCKED.equals(message.getProvisioningStatus())) {
             VvmLog.i(TAG, "User blocked");
             config.handleEvent(OmtpEvents.VVM3_SUBSCRIBER_BLOCKED);
         }
     }

     @Override
     public OmtpMessageSender createMessageSender(SmsManager smsManager, short applicationPort,
             String destinationNumber) {
         return new Vvm3MessageSender(smsManager, applicationPort, destinationNumber);
     }

     @Override
     public void handleEvent(Context context, OmtpVvmCarrierConfigHelper config, OmtpEvents event) {
         Vvm3EventHandler.handleEvent(context, config, event);
     }

     @Override
     public String getCommand(String command) {
         if (command == OmtpConstants.IMAP_CHANGE_TUI_PWD_FORMAT) {
             return IMAP_CHANGE_TUI_PWD_FORMAT;
         }
         if (command == OmtpConstants.IMAP_CLOSE_NUT) {
             return IMAP_CLOSE_NUT;
         }
         if (command == OmtpConstants.IMAP_CHANGE_VM_LANG_FORMAT) {
             return IMAP_CHANGE_VM_LANG_FORMAT;
         }
         return super.getCommand(command);
     }

     private void startProvisionNewUser(PhoneAccountHandle phoneAccountHandle,
             OmtpVvmCarrierConfigHelper config, StatusMessage message) {
         new Vvm3ProvisioningNetworkRequestCallback(config, phoneAccountHandle, message)
                 .requestNetwork();
     }

     private static class Vvm3ProvisioningNetworkRequestCallback extends VvmNetworkRequestCallback {

         private final OmtpVvmCarrierConfigHelper mConfig;
         private final StatusMessage mMessage;

         public Vvm3ProvisioningNetworkRequestCallback(OmtpVvmCarrierConfigHelper config,
                 PhoneAccountHandle phoneAccountHandle, StatusMessage message) {
             super(config, phoneAccountHandle);
             mConfig = config;
             mMessage = message;
         }

         @Override
         public void onAvailable(Network network) {
             super.onAvailable(network);
             VvmLog.i(TAG, "new user: network available");
             ImapHelper helper = new ImapHelper(mContext, mPhoneAccount, network);
             try {
                 // VVM3 has inconsistent error language code to OMTP. Just issue a raw command
                 // here.
                 // TODO(b/29082671): use LocaleList
                 if (Locale.getDefault().getLanguage()
                         .equals(new Locale(ISO639_Spanish).getLanguage())) {
                     // Spanish
                     helper.changeVoicemailTuiLanguage(
                             VVM3_VM_LANGUAGE_SPANISH_STANDARD_NO_GUEST_PROMPTS);
                 } else {
                     // English
                     helper.changeVoicemailTuiLanguage(
                             VVM3_VM_LANGUAGE_ENGLISH_STANDARD_NO_GUEST_PROMPTS);
                 }
                 VvmLog.i(TAG, "new user: language set");

                 if (setPin(helper)) {
                     // Only close new user tutorial if the PIN has been changed.
                     helper.closeNewUserTutorial();
                     VvmLog.i(TAG, "new user: NUT closed");

                     mConfig.requestStatus();
                 }
             } catch (MessagingException | IOException e) {
                 helper.handleEvent(OmtpEvents.VVM3_NEW_USER_SETUP_FAILED);
                 VvmLog.e(TAG, e.toString());
             } finally {
                 helper.close();
             }

         }

         private boolean setPin(ImapHelper helper) throws IOException, MessagingException {
             String defaultPin = getDefaultPin();
             if (defaultPin == null) {
                 VvmLog.i(TAG, "cannot generate default PIN");
                 return false;
             }

             if (VoicemailChangePinActivity.isDefaultOldPinSet(mContext, mPhoneAccount)) {
                 // The pin was already set
                 VvmLog.i(TAG, "PIN already set");
                 return true;
             }
             String newPin = generatePin(getMinimumPinLength(mContext, mPhoneAccount));
             if (helper.changePin(defaultPin, newPin) == OmtpConstants.CHANGE_PIN_SUCCESS) {
                 VoicemailChangePinActivity.setDefaultOldPIN(mContext, mPhoneAccount, newPin);
                 helper.handleEvent(OmtpEvents.CONFIG_DEFAULT_PIN_REPLACED);
             }
             VvmLog.i(TAG, "new user: PIN set");
             return true;
         }

         @Nullable
         private String getDefaultPin() {
             // The IMAP username is [phone number]@example.com
             String username = mMessage.getImapUserName();
             try {
                 String number = username.substring(0, username.indexOf('@'));
                 if (number.length() < 4) {
                     VvmLog.e(TAG, "unable to extract number from IMAP username");
                     return null;
                 }
                 return "1" + number.substring(number.length() - 4);
             } catch (StringIndexOutOfBoundsException e) {
                 VvmLog.e(TAG, "unable to extract number from IMAP username");
                 return null;
             }

         }
     }

     private static int getMinimumPinLength(Context context, PhoneAccountHandle phoneAccountHandle) {
         VisualVoicemailPreferences preferences = new VisualVoicemailPreferences(context,
                 phoneAccountHandle);
         // The OMTP pin length format is {min}-{max}
         String[] lengths = preferences.getString(OmtpConstants.TUI_PASSWORD_LENGTH, "").split("-");
         if (lengths.length == 2) {
             try {
                 return Integer.parseInt(lengths[0]);
             } catch (NumberFormatException e) {
                 return DEFAULT_PIN_LENGTH;
             }
         }
         return DEFAULT_PIN_LENGTH;
     }

     private static String generatePin(int length) {
         SecureRandom random = new SecureRandom();
         return String.format(Locale.US, "%010d", Math.abs(random.nextLong()))
                 .substring(0, length);

     }
 }
	/*
	* Copyright (C) 2016 The Android Open Source Project
	*
	* Licensed 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 com.android.phone.vvm.omtp.protocol;

	import android.annotation.Nullable;
	import android.content.Context;
	import android.net.Network;
	import android.os.Bundle;
	import android.telecom.PhoneAccountHandle;
	import android.telephony.SmsManager;

	import com.android.phone.common.mail.MessagingException;
	import com.android.phone.settings.VisualVoicemailSettingsUtil;
	import com.android.phone.settings.VoicemailChangePinActivity;
	import com.android.phone.vvm.omtp.OmtpConstants;
	import com.android.phone.vvm.omtp.OmtpEvents;
	import com.android.phone.vvm.omtp.OmtpVvmCarrierConfigHelper;
	import com.android.phone.vvm.omtp.VisualVoicemailPreferences;
	import com.android.phone.vvm.omtp.VvmLog;
	import com.android.phone.vvm.omtp.imap.ImapHelper;
	import com.android.phone.vvm.omtp.sms.OmtpMessageSender;
	import com.android.phone.vvm.omtp.sms.StatusMessage;
	import com.android.phone.vvm.omtp.sms.Vvm3MessageSender;
	import com.android.phone.vvm.omtp.sync.VvmNetworkRequestCallback;

	import java.io.IOException;
	import java.security.SecureRandom;
	import java.util.Locale;

	/**
	* A flavor of OMTP protocol with a different provisioning process
	*
	* Used by carriers such as Verizon Wireless
	*/
	public class Vvm3Protocol extends VisualVoicemailProtocol {

	private static String TAG = "Vvm3Protocol";

	private static String IMAP_CHANGE_TUI_PWD_FORMAT = "CHANGE_TUI_PWD PWD=%1$s OLD_PWD=%2$s";
	private static String IMAP_CHANGE_VM_LANG_FORMAT = "CHANGE_VM_LANG Lang=%1$s";
	private static String IMAP_CLOSE_NUT = "CLOSE_NUT";

	private static String ISO639_Spanish = "es";

	// Default prompt level when using the telephone user interface.
	// Standard prompt when the user call into the voicemail, and no prompts when someone else is
	// leaving a voicemail.
	private static String VVM3_VM_LANGUAGE_ENGLISH_STANDARD_NO_GUEST_PROMPTS = "5";
	private static String VVM3_VM_LANGUAGE_SPANISH_STANDARD_NO_GUEST_PROMPTS = "6";

	private static final int DEFAULT_PIN_LENGTH = 6;

	@Override
	public void startActivation(OmtpVvmCarrierConfigHelper config) {
	// VVM3 does not support activation SMS.
	// Send a status request which will start the provisioning process if the user is not
	// provisioned.
	VvmLog.i(TAG, "Activating");
	config.requestStatus();
	}

	@Override
	public void startDeactivation(OmtpVvmCarrierConfigHelper config) {
	// VVM3 does not support deactivation.
	// do nothing.
	}

	@Override
	public void startProvisioning(PhoneAccountHandle phoneAccountHandle,
	OmtpVvmCarrierConfigHelper config, StatusMessage message, Bundle data) {
	VvmLog.i(TAG, "start vvm3 provisioning");
	if (OmtpConstants.SUBSCRIBER_UNKNOWN.equals(message.getProvisioningStatus())) {
	VvmLog.i(TAG, "Provisioning status: Unknown, subscribing");
	new Vvm3Subscriber(phoneAccountHandle, config, data).subscribe();
	} else if (OmtpConstants.SUBSCRIBER_NEW.equals(message.getProvisioningStatus())) {
	VvmLog.i(TAG, "setting up new user");
	// Save the IMAP credentials in preferences so they are persistent and can be retrieved.
	VisualVoicemailPreferences prefs =
	new VisualVoicemailPreferences(config.getContext(), phoneAccountHandle);
	message.putStatus(prefs.edit()).apply();

	startProvisionNewUser(phoneAccountHandle, config, message);
	} else if (OmtpConstants.SUBSCRIBER_PROVISIONED.equals(message.getProvisioningStatus())) {
	VvmLog.i(TAG, "User provisioned but not activated, disabling VVM");
	VisualVoicemailSettingsUtil
	.setEnabled(config.getContext(), phoneAccountHandle, false);
	} else if (OmtpConstants.SUBSCRIBER_BLOCKED.equals(message.getProvisioningStatus())) {
	VvmLog.i(TAG, "User blocked");
	config.handleEvent(OmtpEvents.VVM3_SUBSCRIBER_BLOCKED);
	}
	}

	@Override
	public OmtpMessageSender createMessageSender(SmsManager smsManager, short applicationPort,
	String destinationNumber) {
	return new Vvm3MessageSender(smsManager, applicationPort, destinationNumber);
	}

	@Override
	public void handleEvent(Context context, OmtpVvmCarrierConfigHelper config, OmtpEvents event) {
	Vvm3EventHandler.handleEvent(context, config, event);
	}

	@Override
	public String getCommand(String command) {
	if (command == OmtpConstants.IMAP_CHANGE_TUI_PWD_FORMAT) {
	return IMAP_CHANGE_TUI_PWD_FORMAT;
	}
	if (command == OmtpConstants.IMAP_CLOSE_NUT) {
	return IMAP_CLOSE_NUT;
	}
	if (command == OmtpConstants.IMAP_CHANGE_VM_LANG_FORMAT) {
	return IMAP_CHANGE_VM_LANG_FORMAT;
	}
	return super.getCommand(command);
	}

	private void startProvisionNewUser(PhoneAccountHandle phoneAccountHandle,
	OmtpVvmCarrierConfigHelper config, StatusMessage message) {
	new Vvm3ProvisioningNetworkRequestCallback(config, phoneAccountHandle, message)
	.requestNetwork();
	}

	private static class Vvm3ProvisioningNetworkRequestCallback extends VvmNetworkRequestCallback {

	private final OmtpVvmCarrierConfigHelper mConfig;
	private final StatusMessage mMessage;

	public Vvm3ProvisioningNetworkRequestCallback(OmtpVvmCarrierConfigHelper config,
	PhoneAccountHandle phoneAccountHandle, StatusMessage message) {
	super(config, phoneAccountHandle);
	mConfig = config;
	mMessage = message;
	}

	@Override
	public void onAvailable(Network network) {
	super.onAvailable(network);
	VvmLog.i(TAG, "new user: network available");
	ImapHelper helper = new ImapHelper(mContext, mPhoneAccount, network);
	try {
	// VVM3 has inconsistent error language code to OMTP. Just issue a raw command
	// here.
	// TODO(b/29082671): use LocaleList
	if (Locale.getDefault().getLanguage()
	.equals(new Locale(ISO639_Spanish).getLanguage())) {
	// Spanish
	helper.changeVoicemailTuiLanguage(
	VVM3_VM_LANGUAGE_SPANISH_STANDARD_NO_GUEST_PROMPTS);
	} else {
	// English
	helper.changeVoicemailTuiLanguage(
	VVM3_VM_LANGUAGE_ENGLISH_STANDARD_NO_GUEST_PROMPTS);
	}
	VvmLog.i(TAG, "new user: language set");

	if (setPin(helper)) {
	// Only close new user tutorial if the PIN has been changed.
	helper.closeNewUserTutorial();
	VvmLog.i(TAG, "new user: NUT closed");

	mConfig.requestStatus();
	}
	} catch (MessagingException \| IOException e) {
	helper.handleEvent(OmtpEvents.VVM3_NEW_USER_SETUP_FAILED);
	VvmLog.e(TAG, e.toString());
	} finally {
	helper.close();
	}

	}

	private boolean setPin(ImapHelper helper) throws IOException, MessagingException {
	String defaultPin = getDefaultPin();
	if (defaultPin == null) {
	VvmLog.i(TAG, "cannot generate default PIN");
	return false;
	}

	if (VoicemailChangePinActivity.isDefaultOldPinSet(mContext, mPhoneAccount)) {
	// The pin was already set
	VvmLog.i(TAG, "PIN already set");
	return true;
	}
	String newPin = generatePin(getMinimumPinLength(mContext, mPhoneAccount));
	if (helper.changePin(defaultPin, newPin) == OmtpConstants.CHANGE_PIN_SUCCESS) {
	VoicemailChangePinActivity.setDefaultOldPIN(mContext, mPhoneAccount, newPin);
	helper.handleEvent(OmtpEvents.CONFIG_DEFAULT_PIN_REPLACED);
	}
	VvmLog.i(TAG, "new user: PIN set");
	return true;
	}

	@Nullable
	private String getDefaultPin() {
	// The IMAP username is [phone number]@example.com
	String username = mMessage.getImapUserName();
	try {
	String number = username.substring(0, username.indexOf('@'));
	if (number.length() < 4) {
	VvmLog.e(TAG, "unable to extract number from IMAP username");
	return null;
	}
	return "1" + number.substring(number.length() - 4);
	} catch (StringIndexOutOfBoundsException e) {
	VvmLog.e(TAG, "unable to extract number from IMAP username");
	return null;
	}

	}
	}

	private static int getMinimumPinLength(Context context, PhoneAccountHandle phoneAccountHandle) {
	VisualVoicemailPreferences preferences = new VisualVoicemailPreferences(context,
	phoneAccountHandle);
	// The OMTP pin length format is {min}-{max}
	String[] lengths = preferences.getString(OmtpConstants.TUI_PASSWORD_LENGTH, "").split("-");
	if (lengths.length == 2) {
	try {
	return Integer.parseInt(lengths[0]);
	} catch (NumberFormatException e) {
	return DEFAULT_PIN_LENGTH;
	}
	}
	return DEFAULT_PIN_LENGTH;
	}

	private static String generatePin(int length) {
	SecureRandom random = new SecureRandom();
	return String.format(Locale.US, "%010d", Math.abs(random.nextLong()))
	.substring(0, length);

	}
	}