CallerInfoUtils.java revision 07a822b2ea92dc5b68cd43139be7efe4c6640cd4
17ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Leepackage com.android.incallui; 27ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 37ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Leeimport android.content.Context; 4fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Leeimport android.content.Intent; 5fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Leeimport android.net.Uri; 607a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepalimport android.telecomm.CallNumberPresentation; 77ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Leeimport android.text.TextUtils; 87ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 97ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Leeimport java.util.Arrays; 107ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 117ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee/** 12fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee * Utility methods for contact and caller info related functionality 137ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee */ 147ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Leepublic class CallerInfoUtils { 157ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 167ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee private static final String TAG = CallerInfoUtils.class.getSimpleName(); 177ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 187ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee /** Define for not a special CNAP string */ 197ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee private static final int CNAP_SPECIAL_CASE_NO = -1; 207ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 21fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee private static final String VIEW_NOTIFICATION_ACTION = 22fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee "com.android.contacts.VIEW_NOTIFICATION"; 23fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee private static final String VIEW_NOTIFICATION_PACKAGE = "com.android.contacts"; 24fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee private static final String VIEW_NOTIFICATION_CLASS = 25fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee "com.android.contacts.ViewNotificationService"; 26fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee 277ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee public CallerInfoUtils() { 287ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 297ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 307ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee private static final int QUERY_TOKEN = -1; 317ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 327ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee /** 334bbe4c6900dfe3584f674161dbe15e248d5adbe7Santos Cordon * This is called to get caller info for a call. This will return a CallerInfo 344bbe4c6900dfe3584f674161dbe15e248d5adbe7Santos Cordon * object immediately based off information in the call, but 357ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * more information is returned to the OnQueryCompleteListener (which contains 367ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * information about the phone number label, user's name, etc). 377ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee */ 38fc22ba88566ef70e202128335231c367de6c52afSailesh Nepal public static CallerInfo getCallerInfoForCall(Context context, Call call, 397ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee CallerInfoAsyncQuery.OnQueryCompleteListener listener) { 408b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng CallerInfo info = buildCallerInfo(context, call); 41101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner String number = info.phoneNumber; 427ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 438b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng // TODO: Have phoneapp send a Uri when it knows the contact that triggered this call. 448b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng 4507a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal if (info.numberPresentation == CallNumberPresentation.ALLOWED) { 468b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng // Start the query with the number provided from the call. 478b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng Log.d(TAG, "==> Actually starting CallerInfoAsyncQuery.startQuery()..."); 488b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng CallerInfoAsyncQuery.startQuery(QUERY_TOKEN, context, number, listener, call); 498b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng } 508b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng return info; 518b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng } 528b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng 53fc22ba88566ef70e202128335231c367de6c52afSailesh Nepal public static CallerInfo buildCallerInfo(Context context, Call call) { 548b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng CallerInfo info = new CallerInfo(); 558b6c8d0dbfba6eabe3d835f8cdcec8a13e253d0cChiao Cheng 567ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // Store CNAP information retrieved from the Connection (we want to do this 577ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // here regardless of whether the number is empty or not). 58fc22ba88566ef70e202128335231c367de6c52afSailesh Nepal info.cnapName = call.getCnapName(); 597ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee info.name = info.cnapName; 60fc22ba88566ef70e202128335231c367de6c52afSailesh Nepal info.numberPresentation = call.getNumberPresentation(); 61fc22ba88566ef70e202128335231c367de6c52afSailesh Nepal info.namePresentation = call.getCnapNamePresentation(); 627ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 63fc22ba88566ef70e202128335231c367de6c52afSailesh Nepal String number = call.getNumber(); 644bbe4c6900dfe3584f674161dbe15e248d5adbe7Santos Cordon if (!TextUtils.isEmpty(number)) { 65101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner final String[] numbers = number.split("&"); 66101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner number = numbers[0]; 67101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner if (numbers.length > 1) { 68101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner info.forwardingNumber = numbers[1]; 69101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner } 70101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner 714bbe4c6900dfe3584f674161dbe15e248d5adbe7Santos Cordon number = modifyForSpecialCnapCases(context, info, number, info.numberPresentation); 724bbe4c6900dfe3584f674161dbe15e248d5adbe7Santos Cordon info.phoneNumber = number; 737ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 747ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee return info; 757ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 767ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 777ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee /** 787ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * Handles certain "corner cases" for CNAP. When we receive weird phone numbers 797ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * from the network to indicate different number presentations, convert them to 807ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * expected number and presentation values within the CallerInfo object. 817ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * @param number number we use to verify if we are in a corner case 827ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * @param presentation presentation value used to verify if we are in a corner case 837ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee * @return the new String that should be used for the phone number 847ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee */ 857ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee /* package */static String modifyForSpecialCnapCases(Context context, CallerInfo ci, 8607a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal String number, CallNumberPresentation presentation) { 877ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // Obviously we return number if ci == null, but still return number if 887ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // number == null, because in these cases the correct string will still be 897ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // displayed/logged after this function returns based on the presentation value. 907ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee if (ci == null || number == null) return number; 917ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 921a7f2bcab2d2023f2ee4cfb0bc57bc265b5aab87Chiao Cheng Log.d(TAG, "modifyForSpecialCnapCases: initially, number=" 937ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee + toLogSafePhoneNumber(number) 947ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee + ", presentation=" + presentation + " ci " + ci); 957ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 967ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // "ABSENT NUMBER" is a possible value we could get from the network as the 977ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // phone number, so if this happens, change it to "Unknown" in the CallerInfo 987ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // and fix the presentation to be the same. 997ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee final String[] absentNumberValues = 1007ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee context.getResources().getStringArray(R.array.absent_num); 1017ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee if (Arrays.asList(absentNumberValues).contains(number) 10207a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal && presentation == CallNumberPresentation.ALLOWED) { 1037ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee number = context.getString(R.string.unknown); 10407a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal ci.numberPresentation = CallNumberPresentation.UNKNOWN; 1057ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1067ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 1077ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // Check for other special "corner cases" for CNAP and fix them similarly. Corner 1087ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // cases only apply if we received an allowed presentation from the network, so check 1097ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // if we think we have an allowed presentation, or if the CallerInfo presentation doesn't 1107ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // match the presentation passed in for verification (meaning we changed it previously 1117ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // because it's a corner case and we're being called from a different entry point). 11207a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal if (ci.numberPresentation == CallNumberPresentation.ALLOWED 1137ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee || (ci.numberPresentation != presentation 11407a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal && presentation == CallNumberPresentation.ALLOWED)) { 11507a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal // For all special strings, change number & numberPrentation. 11607a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal if (isCnapSpecialCaseRestricted(number)) { 11707a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal number = context.getString(R.string.private_num); 11807a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal ci.numberPresentation = CallNumberPresentation.RESTRICTED; 11907a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal } else if (isCnapSpecialCaseUnknown(number)) { 12007a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal number = context.getString(R.string.unknown); 12107a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal ci.numberPresentation = CallNumberPresentation.UNKNOWN; 1227ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 12307a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal Log.d(TAG, "SpecialCnap: number=" + toLogSafePhoneNumber(number) 12407a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal + "; presentation now=" + ci.numberPresentation); 1257ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1261a7f2bcab2d2023f2ee4cfb0bc57bc265b5aab87Chiao Cheng Log.d(TAG, "modifyForSpecialCnapCases: returning number string=" 1277ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee + toLogSafePhoneNumber(number)); 1287ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee return number; 1297ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1307ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 13107a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal private static boolean isCnapSpecialCaseRestricted(String n) { 13207a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal return n.equals("PRIVATE") || n.equals("P") || n.equals("RES"); 13307a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal } 13407a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal 13507a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal private static boolean isCnapSpecialCaseUnknown(String n) { 13607a822b2ea92dc5b68cd43139be7efe4c6640cd4Sailesh Nepal return n.equals("UNAVAILABLE") || n.equals("UNKNOWN") || n.equals("UNA") || n.equals("U"); 1377ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1387ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 1397ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee /* package */static String toLogSafePhoneNumber(String number) { 1407ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // For unknown number, log empty string. 1417ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee if (number == null) { 1427ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee return ""; 1437ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1447ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 1452d84705bf4c4f0588ccf4a6d64832e7f99b532cfChristine Chen // Todo: Figure out an equivalent for VDBG 1467ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee if (false) { 1477ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // When VDBG is true we emit PII. 1487ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee return number; 1497ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1507ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee 1517ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // Do exactly same thing as Uri#toSafeString() does, which will enable us to compare 1527ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee // sanitized phone numbers. 1537ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee StringBuilder builder = new StringBuilder(); 1547ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee for (int i = 0; i < number.length(); i++) { 1557ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee char c = number.charAt(i); 156101bed44998ff35c3a56f431345fac5c8229ec0eJay Shrauner if (c == '-' || c == '@' || c == '.' || c == '&') { 1577ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee builder.append(c); 1587ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } else { 1597ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee builder.append('x'); 1607ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1617ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 1627ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee return builder.toString(); 1637ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee } 164fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee 165fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee /** 166fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee * Send a notification that that we are viewing a particular contact, so that the high-res 167fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee * photo is downloaded by the sync adapter. 168fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee */ 169fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee public static void sendViewNotification(Context context, Uri contactUri) { 170fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee final Intent intent = new Intent(VIEW_NOTIFICATION_ACTION, contactUri); 171fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee intent.setClassName(VIEW_NOTIFICATION_PACKAGE, VIEW_NOTIFICATION_CLASS); 172fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee context.startService(intent); 173fd76bfcd5bd3ee6cc1eb53019a23738192972180Yorke Lee } 1747ef707319c0e3563ff92a772ba53cb5dca0e3ae1Yorke Lee} 175