From 9baf4e56672d8beeed6bdd9d1cd9456b32cf83ba Mon Sep 17 00:00:00 2001 From: Brandon Maxwell Date: Wed, 24 Feb 2016 18:39:42 -0800 Subject: Implementing Compat class for Filtering + FilteredNumberCompat contains the logic needed to switch between the Dialer implemented number filtering and the new number filtering. + Direct uses of the Dialer Filtering code should be replaced to use the fields in this class Bug=26664600 Change-Id: I42db3da4b5ed124a88488713f56ccab7b2290309 --- .../dialer/compat/FilteredNumberCompat.java | 189 +++++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 src/com/android/dialer/compat/FilteredNumberCompat.java (limited to 'src/com') diff --git a/src/com/android/dialer/compat/FilteredNumberCompat.java b/src/com/android/dialer/compat/FilteredNumberCompat.java new file mode 100644 index 000000000..c70df71b7 --- /dev/null +++ b/src/com/android/dialer/compat/FilteredNumberCompat.java @@ -0,0 +1,189 @@ +/* + * 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.dialer.compat; + +import com.google.common.base.Preconditions; + +import android.content.ContentUris; +import android.content.ContentValues; +import android.net.Uri; +import android.support.annotation.Nullable; +import android.telephony.PhoneNumberUtils; + +import com.android.contacts.common.compat.CompatUtils; +import com.android.contacts.common.testing.NeededForTesting; +import com.android.dialer.database.FilteredNumberContract.FilteredNumber; +import com.android.dialer.database.FilteredNumberContract.FilteredNumberColumns; +import com.android.dialer.database.FilteredNumberContract.FilteredNumberSources; +import com.android.dialer.database.FilteredNumberContract.FilteredNumberTypes; + +import java.util.ArrayList; +import java.util.List; + +/** + * Compatibility class to encapsulate logic to switch between call blocking using + * {@link com.android.dialer.database.FilteredNumberContract} and using + * {@link android.provider.BlockedNumberContract}. This class should be used rather than explicitly + * referencing columns from either contract class in situations where both blocking solutions may be + * used. + */ +public class FilteredNumberCompat { + + // Flag to enable feature. + // TODO(maxwelb) remove when ready to enable new filtering. + private static final boolean isNewFilteringEnabled = false; + private static Boolean isEnabledForTest; + + /** + * @return The column name for ID in the filtered number database. + */ + public static String getIdColumnName() { + return useNewFiltering() ? BlockedNumbersSdkCompat._ID : FilteredNumberColumns._ID; + } + + /** + * @return The column name for type in the filtered number database. Will be {@code null} for + * the framework blocking implementation. + */ + @Nullable + public static String getTypeColumnName() { + return useNewFiltering() ? null : FilteredNumberColumns.TYPE; + } + + /** + * @return The column name for source in the filtered number database. Will be {@code null} for + * the framework blocking implementation + */ + @Nullable + public static String getSourceColumnName() { + return useNewFiltering() ? null : FilteredNumberColumns.SOURCE; + } + + /** + * @return The column name for the original number in the filtered number database. + */ + public static String getOriginalNumberColumnName() { + return useNewFiltering() ? BlockedNumbersSdkCompat.COLUMN_ORIGINAL_NUMBER + : FilteredNumberColumns.NUMBER; + } + + /** + * @return The column name for country iso in the filtered number database. Will be {@code null} + * the framework blocking implementation + */ + @Nullable + public static String getCountryIsoColumnName() { + return useNewFiltering() ? null : FilteredNumberColumns.COUNTRY_ISO; + } + + /** + * @return The column name for the e164 formatted number in the filtered number database. + */ + public static String getE164NumberColumnName() { + return useNewFiltering() ? BlockedNumbersSdkCompat.E164_NUMBER + : FilteredNumberColumns.NORMALIZED_NUMBER; + } + + /** + * @return {@code true} if the new filtering is enabled, {@code false} otherwise. + */ + public static boolean useNewFiltering() { + if (isEnabledForTest != null) { + return CompatUtils.isNCompatible() && isEnabledForTest; + } + return CompatUtils.isNCompatible() && isNewFilteringEnabled; + } + + @NeededForTesting + public static void setIsEnabledForTest(Boolean isEnabled) { + isEnabledForTest = isEnabled; + } + + /** + * Gets the content {@link Uri} for number filtering. + * + * @param id The optional id to append with the base content uri. + * @return The Uri for number filtering. + */ + public static Uri getContentUri(@Nullable Integer id) { + if (id == null) { + return getBaseUri(); + } + return ContentUris.withAppendedId(getBaseUri(), id); + } + + + private static Uri getBaseUri() { + return useNewFiltering() ? BlockedNumbersSdkCompat.CONTENT_URI : FilteredNumber.CONTENT_URI; + } + + /** + * Removes any null column names from the given projection array. This method is intended to be + * used to strip out any column names that aren't available in every version of number blocking. + * Example: + * {@literal + * getContext().getContentResolver().query( + * someUri, + * // Filtering ensures that no non-existant columns are queried + * FilteredNumberCompat.filter(new String[] {FilteredNumberCompat.getIdColumnName(), + * FilteredNumberCompat.getTypeColumnName()}, + * FilteredNumberCompat.getE164NumberColumnName() + " = ?", + * new String[] {e164Number}); + * } + * + * @param projection The projection array. + * @return The filtered projection array. + */ + @Nullable + public static String[] filter(@Nullable String[] projection) { + if (projection == null) { + return null; + } + List filtered = new ArrayList<>(); + for (String column : projection) { + if (column != null) { + filtered.add(column); + } + } + return filtered.toArray(new String[filtered.size()]); + } + + /** + * Creates a new {@link ContentValues} suitable for inserting in the filtered number table. + * + * @param number The unformatted number to insert. + * @param e164Number (optional) The number to insert formatted to E164 standard. + * @param countryIso (optional) The country iso to use to format the number. + * @return The ContentValues to insert. + * @throws NullPointerException If number is null. + */ + public static ContentValues newBlockNumberContentValues(String number, + @Nullable String e164Number, @Nullable String countryIso) { + ContentValues contentValues = new ContentValues(); + contentValues.put(getOriginalNumberColumnName(), Preconditions.checkNotNull(number)); + if (!useNewFiltering()) { + if (e164Number == null) { + e164Number = PhoneNumberUtils.formatNumberToE164(number, countryIso); + } + contentValues.put(getE164NumberColumnName(), e164Number); + contentValues.put(getCountryIsoColumnName(), countryIso); + contentValues.put(getTypeColumnName(), FilteredNumberTypes.BLOCKED_NUMBER); + contentValues.put(getSourceColumnName(), FilteredNumberSources.USER); + } + return contentValues; + } +} -- cgit v1.2.3 From 60fb1dc7afe8fe6079785724a21bbffbdb4eac88 Mon Sep 17 00:00:00 2001 From: Brandon Maxwell Date: Fri, 26 Feb 2016 16:59:46 -0800 Subject: Updating AsyncQueryHandler with FilteredNumCompat + FilteredNumberAsyncQueryHandler needs to make use of the FilteredNumberCompat class to unsure that it is blocking/unblocking/checking the proper solution, based on which is enabled. + This CL updates the queryHandler to the FilteredNumberCompat class for the hasBlockedNumbers, isBlockedNumber, and blockNumber operations. Bug=26664600 Change-Id: I5ecf6e340a97e94bf696a0e6c4a7e922b791a6f5 --- .../database/FilteredNumberAsyncQueryHandler.java | 66 +++++++++++----------- 1 file changed, 34 insertions(+), 32 deletions(-) (limited to 'src/com') diff --git a/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java b/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java index 6e64c6098..7279911ce 100644 --- a/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java +++ b/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java @@ -24,12 +24,13 @@ import android.database.Cursor; import android.database.DatabaseUtils; import android.database.sqlite.SQLiteDatabaseCorruptException; import android.net.Uri; +import android.support.annotation.Nullable; import android.telephony.PhoneNumberUtils; import android.text.TextUtils; +import com.android.dialer.compat.FilteredNumberCompat; import com.android.dialer.database.FilteredNumberContract.FilteredNumber; import com.android.dialer.database.FilteredNumberContract.FilteredNumberColumns; -import com.android.dialer.database.FilteredNumberContract.FilteredNumberSources; import com.android.dialer.database.FilteredNumberContract.FilteredNumberTypes; public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { @@ -58,7 +59,7 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { * Invoked after querying if a number is blocked. * @param id The ID of the row if blocked, null otherwise. */ - public void onCheckComplete(Integer id); + void onCheckComplete(Integer id); } public interface OnBlockNumberListener { @@ -66,7 +67,7 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { * Invoked after inserting a blocked number. * @param uri The uri of the newly created row. */ - public void onBlockComplete(Uri uri); + void onBlockComplete(Uri uri); } public interface OnUnblockNumberListener { @@ -75,7 +76,7 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { * @param rows The number of rows affected (expected value 1). * @param values The deleted data (used for restoration). */ - public void onUnblockComplete(int rows, ContentValues values); + void onUnblockComplete(int rows, ContentValues values); } public interface OnHasBlockedNumbersListener { @@ -83,7 +84,7 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { * @param hasBlockedNumbers {@code true} if any blocked numbers are stored. * {@code false} otherwise. */ - public void onHasBlockedNumbers(boolean hasBlockedNumbers); + void onHasBlockedNumbers(boolean hasBlockedNumbers); } @Override @@ -123,6 +124,10 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { } public final void incrementFilteredCount(Integer id) { + // No concept of counts with new filtering + if (FilteredNumberCompat.useNewFiltering()) { + return; + } startUpdate(NO_TOKEN, null, ContentUris.withAppendedId(FilteredNumber.CONTENT_URI_INCREMENT_FILTERED_COUNT, id), null, null, null); @@ -136,9 +141,10 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { listener.onHasBlockedNumbers(cursor != null && cursor.getCount() > 0); } }, - getContentUri(null), - new String[]{ FilteredNumberColumns._ID }, - FilteredNumberColumns.TYPE + "=" + FilteredNumberTypes.BLOCKED_NUMBER, + FilteredNumberCompat.getContentUri(null), + new String[]{ FilteredNumberCompat.getIdColumnName() }, + FilteredNumberCompat.useNewFiltering() ? null : FilteredNumberColumns.TYPE + + "=" + FilteredNumberTypes.BLOCKED_NUMBER, null, null); } @@ -151,8 +157,8 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { */ public boolean isBlockedNumber( final OnCheckBlockedListener listener, String number, String countryIso) { - final String normalizedNumber = PhoneNumberUtils.formatNumberToE164(number, countryIso); - if (TextUtils.isEmpty(normalizedNumber)) { + final String e164Number = PhoneNumberUtils.formatNumberToE164(number, countryIso); + if (TextUtils.isEmpty(e164Number)) { return false; } @@ -165,7 +171,9 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { return; } cursor.moveToFirst(); - if (cursor.getInt(cursor.getColumnIndex(FilteredNumberColumns.TYPE)) + // New filtering doesn't have a concept of type + if (!FilteredNumberCompat.useNewFiltering() + && cursor.getInt(cursor.getColumnIndex(FilteredNumberColumns.TYPE)) != FilteredNumberTypes.BLOCKED_NUMBER) { listener.onCheckComplete(null); return; @@ -174,17 +182,18 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { cursor.getInt(cursor.getColumnIndex(FilteredNumberColumns._ID))); } }, - getContentUri(null), - new String[]{ FilteredNumberColumns._ID, FilteredNumberColumns.TYPE }, - FilteredNumberColumns.NORMALIZED_NUMBER + " = ?", - new String[]{ normalizedNumber }, + FilteredNumberCompat.getContentUri(null), + FilteredNumberCompat.filter(new String[]{FilteredNumberCompat.getIdColumnName(), + FilteredNumberCompat.getTypeColumnName()}), + FilteredNumberCompat.getE164NumberColumnName() + " = ?", + new String[]{e164Number}, null); return true; } public void blockNumber( - final OnBlockNumberListener listener, String number, String countryIso) { + final OnBlockNumberListener listener, String number, @Nullable String countryIso) { blockNumber(listener, null, number, countryIso); } @@ -193,19 +202,11 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { */ public void blockNumber( final OnBlockNumberListener listener, - String normalizedNumber, + @Nullable String normalizedNumber, String number, - String countryIso) { - if (normalizedNumber == null) { - normalizedNumber = PhoneNumberUtils.formatNumberToE164(number, countryIso); - } - ContentValues v = new ContentValues(); - v.put(FilteredNumberColumns.NORMALIZED_NUMBER, normalizedNumber); - v.put(FilteredNumberColumns.NUMBER, number); - v.put(FilteredNumberColumns.COUNTRY_ISO, countryIso); - v.put(FilteredNumberColumns.TYPE, FilteredNumberTypes.BLOCKED_NUMBER); - v.put(FilteredNumberColumns.SOURCE, FilteredNumberSources.USER); - blockNumber(listener, v); + @Nullable String countryIso) { + blockNumber(listener, FilteredNumberCompat.newBlockNumberContentValues(number, + normalizedNumber, countryIso)); } /** @@ -221,13 +222,14 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { listener.onBlockComplete(uri); } } - }, getContentUri(null), values); + }, FilteredNumberCompat.getContentUri(null), values); } /** - * Removes row from database. - * Caller should call {@link FilteredNumberAsyncQueryHandler#startBlockedQuery} first. - * @param id The ID of row to remove, from {@link FilteredNumberAsyncQueryHandler#startBlockedQuery}. + * Unblocks the number with the given id. + * + * @param listener The {@link OnUnblockNumberListener} called after the number is unblocked. + * @param id The id of the number to unblock. */ public void unblock(final OnUnblockNumberListener listener, Integer id) { if (id == null) { -- cgit v1.2.3 From f0e0ce60005a5732c65bddf290cd758c517d99db Mon Sep 17 00:00:00 2001 From: Brandon Maxwell Date: Sun, 28 Feb 2016 15:28:45 -0800 Subject: Using FilteredNumCompat for unblock + This CL updates the FilteredNumberAsyncQueryHandler#unblock methods to use the FilteredNumberCompat class to properly choose between the original Dialer blocking implementation and new blocking. Bug=26664600 Change-Id: I528604eeafa4f7fa131cb1898d57a87708ba58b5 --- .../database/FilteredNumberAsyncQueryHandler.java | 23 +++++++++------------- 1 file changed, 9 insertions(+), 14 deletions(-) (limited to 'src/com') diff --git a/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java b/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java index 7279911ce..7af1a1339 100644 --- a/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java +++ b/src/com/android/dialer/database/FilteredNumberAsyncQueryHandler.java @@ -115,14 +115,6 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { } } - private static Uri getContentUri(Integer id) { - Uri uri = FilteredNumber.CONTENT_URI; - if (id != null) { - uri = ContentUris.withAppendedId(uri, id); - } - return uri; - } - public final void incrementFilteredCount(Integer id) { // No concept of counts with new filtering if (FilteredNumberCompat.useNewFiltering()) { @@ -228,22 +220,25 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { /** * Unblocks the number with the given id. * - * @param listener The {@link OnUnblockNumberListener} called after the number is unblocked. + * @param listener (optional) The {@link OnUnblockNumberListener} called after the number is + * unblocked. * @param id The id of the number to unblock. */ - public void unblock(final OnUnblockNumberListener listener, Integer id) { + public void unblock(@Nullable final OnUnblockNumberListener listener, Integer id) { if (id == null) { throw new IllegalArgumentException("Null id passed into unblock"); } - unblock(listener, getContentUri(id)); + unblock(listener, FilteredNumberCompat.getContentUri(id)); } /** * Removes row from database. + * @param listener (optional) The {@link OnUnblockNumberListener} called after the number is + * unblocked. * @param uri The uri of row to remove, from - * {@link FilteredNumberAsyncQueryHandler#blockNumber}. + * {@link FilteredNumberAsyncQueryHandler#blockNumber}. */ - public void unblock(final OnUnblockNumberListener listener, final Uri uri) { + public void unblock(@Nullable final OnUnblockNumberListener listener, final Uri uri) { startQuery(NO_TOKEN, new Listener() { @Override public void onQueryComplete(int token, Object cookie, Cursor cursor) { @@ -256,7 +251,7 @@ public class FilteredNumberAsyncQueryHandler extends AsyncQueryHandler { cursor.moveToFirst(); final ContentValues values = new ContentValues(); DatabaseUtils.cursorRowToContentValues(cursor, values); - values.remove(FilteredNumberColumns._ID); + values.remove(FilteredNumberCompat.getIdColumnName()); startDelete(NO_TOKEN, new Listener() { @Override -- cgit v1.2.3