Skip to content

Include/exclude countries from the country selector list in phone authentication #1315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 30, 2018
Merged

Include/exclude countries from the country selector list in phone authentication #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fc6d538
Adds ability to limit country selection in phone authentication
lsirac May 24, 2018
38d3ab0
Small fix
lsirac May 25, 2018
06fba95
Removes redundant country code map
lsirac May 25, 2018
e68c2b8
Small change
lsirac May 25, 2018
f34fce4
Renames CountryCodes to CountryIsos
lsirac May 25, 2018
be019cc
Adds code review suggestions
lsirac May 25, 2018
75a6e39
Adds ability to input country code as well as iso
lsirac May 25, 2018
6d2011e
Renames new methods
lsirac May 26, 2018
545a90a
Small fix
lsirac May 27, 2018
d41c901
Applies review suggestions
lsirac May 29, 2018
9051b55
Country code to iso map is initialized only when needed
lsirac May 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 141 additions & 10 deletions auth/src/main/java/com/firebase/ui/auth/AuthUI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
import java.util.HashSet;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Set;

/**
Expand Down Expand Up @@ -214,9 +215,9 @@ public static int getDefaultTheme() {
* Signs the user in without any UI if possible. If this operation fails, you can safely start a
* UI-based sign-in flow knowing it is required.
*
* @param context requesting the user be signed in
* @param configs to use for silent sign in. Only Google and email are currently
* supported, the rest will be ignored.
* @param context requesting the user be signed in
* @param configs to use for silent sign in. Only Google and email are currently supported, the
* rest will be ignored.
* @return a task which indicates whether or not the user was successfully signed in.
*/
@NonNull
Expand Down Expand Up @@ -643,10 +644,140 @@ public PhoneBuilder setDefaultCountryIso(@NonNull String iso) {
throw new IllegalStateException("Invalid country iso: " + iso);
}

getParams().putString(ExtraConstants.COUNTRY_ISO, iso);
getParams().putString(ExtraConstants.COUNTRY_ISO,
iso.toUpperCase(Locale.getDefault()));

return this;
}


/**
* Sets the country codes available in the country code selector for phone
* authentication. Takes as input a List of both country isos and codes.
* This is not to be called with
* {@link #setBlacklistedCountries(List<String>)}.
* If both are called, an exception will be thrown.
* <p>
* Inputting an e-164 country code (e.g. '+1') will include all countries with
* +1 as its code.
* Example input: {'+52', 'us'}
* For a list of country iso or codes, see Alpha-2 isos here:
* https://en.wikipedia.org/wiki/ISO_3166-1
* and e-164 codes here: https://en.wikipedia.org/wiki/List_of_country_calling_codes
*
* @param whitelistedCountries a case insensitive list of country codes and/or
* isos to be whitelisted
*/
public PhoneBuilder setWhitelistedCountries(
@NonNull List<String> whitelistedCountries) {
if (getParams().containsKey(ExtraConstants.BLACKLISTED_COUNTRIES)) {
throw new RuntimeException(
"You can either whitelist or blacklist country codes for phone " +
"authentication.");
}
addCountriesToBundle(whitelistedCountries, ExtraConstants.WHITELISTED_COUNTRIES);
return this;
}

/**
* Sets the countries to be removed from the country code selector for phone
* authentication. Takes as input a List of both country isos and codes.
* This is not to be called with
* {@link #setWhitelistedCountries(List<String>)}.
* If both are called, an exception will be thrown.
* <p>
* Inputting an e-164 country code (e.g. '+1') will include all countries with
* +1 as its code.
* Example input: {'+52', 'us'}
* For a list of country iso or codes, see Alpha-2 codes here:
* https://en.wikipedia.org/wiki/ISO_3166-1
* and e-164 codes here: https://en.wikipedia.org/wiki/List_of_country_calling_codes
* @param blacklistedCountries a case insensitive list of country codes and/or isos
* to be blacklisted
*/
public PhoneBuilder setBlacklistedCountries(
@NonNull List<String> blacklistedCountries) {
if (getParams().containsKey(ExtraConstants.WHITELISTED_COUNTRIES)) {
throw new RuntimeException(
"You can either whitelist or blacklist country codes for phone " +
"authentication.");
}
addCountriesToBundle(blacklistedCountries, ExtraConstants.BLACKLISTED_COUNTRIES);
return this;
}

@Override
public IdpConfig build() {
validateInputs();
return super.build();
}

private void addCountriesToBundle(List<String> CountryIsos, String CountryIsoType) {
ArrayList<String> uppercaseCodes = new ArrayList<>();
for (String code : CountryIsos) {
uppercaseCodes.add(code.toUpperCase(Locale.getDefault()));
}

getParams().putStringArrayList(CountryIsoType, uppercaseCodes);
}

private void validateInputs() {
List<String> whitelistedCountries = getParams().getStringArrayList(
ExtraConstants.WHITELISTED_COUNTRIES);
List<String> blacklistedCountries = getParams().getStringArrayList(
ExtraConstants.BLACKLISTED_COUNTRIES);

if (whitelistedCountries != null &&
blacklistedCountries != null) {
throw new RuntimeException(
"You can either whitelist or blacklist country codes for phone " +
"authentication.");
} else if (whitelistedCountries != null) {
validateCountries(whitelistedCountries);
validateDefaultCountryIso(whitelistedCountries, true);

} else if (blacklistedCountries != null) {
validateCountries(blacklistedCountries);
validateDefaultCountryIso(blacklistedCountries, false);
}
}

private void validateCountries(List<String> codes) {
for (String code : codes) {
if (!PhoneNumberUtils.isValidIso(code) && !PhoneNumberUtils.isValid(code)) {
throw new RuntimeException("Invalid input: You must provide a valid " +
"country iso (alpha-2) or code (e-164). e.g. 'us' or '+1'.");
}
}
}

private void validateDefaultCountryIso(List<String> codes, boolean whitelisted) {
if (getParams().containsKey(ExtraConstants.COUNTRY_ISO) && codes != null) {
String defaultIso = getParams().getString(ExtraConstants.COUNTRY_ISO);
boolean containsIso = containsCountryIso(codes, defaultIso);
if (!containsIso && whitelisted || containsIso && !whitelisted) {
throw new RuntimeException("Invalid default country iso. Make sure it " +
"is either part of the whitelisted list or that you " +
"haven't blacklisted it.");
}
}
}

private boolean containsCountryIso(List<String> codes, String iso) {
for (String code : codes) {
if (PhoneNumberUtils.isValidIso(code)) {
if (code.equals(iso)) {
return true;
}
} else {
List<String> isos = PhoneNumberUtils.getCountryIsosFromCountryCode(code);
if (isos.contains(iso)) {
return true;
}
}
}
return false;
}
}

/**
Expand Down Expand Up @@ -679,8 +810,8 @@ public GoogleBuilder setScopes(@NonNull List<String> scopes) {
}

/**
* Set the {@link GoogleSignInOptions} to be used for Google sign-in. Standard options
* like requesting the user's email will automatically be added.
* Set the {@link GoogleSignInOptions} to be used for Google sign-in. Standard
* options like requesting the user's email will automatically be added.
*
* @param options sign-in options
*/
Expand Down Expand Up @@ -784,8 +915,8 @@ private abstract class AuthIntentBuilder<T extends AuthIntentBuilder> {
boolean mEnableHints = true;

/**
* Specifies the theme to use for the application flow. If no theme is specified, a default
* theme will be used.
* Specifies the theme to use for the application flow. If no theme is specified, a
* default theme will be used.
*/
@NonNull
public T setTheme(@StyleRes int theme) {
Expand Down Expand Up @@ -825,8 +956,8 @@ public T setPrivacyPolicyUrl(@Nullable String privacyPolicyUrl) {
}

/**
* Specified the set of supported authentication providers. At least one provider must be
* specified. There may only be one instance of each provider.
* Specified the set of supported authentication providers. At least one provider must
* be specified. There may only be one instance of each provider.
* <p>
* <p>If no providers are explicitly specified by calling this method, then the email
* provider is the default supported provider.
Expand Down
Loading