/*
* Copyright (C) 2006 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.internal.telephony;
import android.content.Context;
import android.database.Cursor;
import android.graphics.drawable.Drawable;
import android.location.CountryDetector;
import android.net.Uri;
import android.provider.ContactsContract.CommonDataKinds.Phone;
import android.provider.ContactsContract.Data;
import android.provider.ContactsContract.PhoneLookup;
import android.provider.ContactsContract.RawContacts;
import android.telephony.PhoneNumberUtils;
import android.telephony.TelephonyManager;
import android.text.TextUtils;
import android.util.Log;
import com.android.i18n.phonenumbers.geocoding.PhoneNumberOfflineGeocoder;
import com.android.i18n.phonenumbers.NumberParseException;
import com.android.i18n.phonenumbers.PhoneNumberUtil;
import com.android.i18n.phonenumbers.Phonenumber.PhoneNumber;
import java.util.Locale;
/**
* Looks up caller information for the given phone number.
*
* {@hide}
*/
public class CallerInfo {
private static final String TAG = "CallerInfo";
private static final boolean VDBG = Log.isLoggable(TAG, Log.VERBOSE);
public static final String UNKNOWN_NUMBER = "-1";
public static final String PRIVATE_NUMBER = "-2";
public static final String PAYPHONE_NUMBER = "-3";
/**
* Please note that, any one of these member variables can be null,
* and any accesses to them should be prepared to handle such a case.
*
* Also, it is implied that phoneNumber is more often populated than
* name is, (think of calls being dialed/received using numbers where
* names are not known to the device), so phoneNumber should serve as
* a dependable fallback when name is unavailable.
*
* One other detail here is that this CallerInfo object reflects
* information found on a connection, it is an OUTPUT that serves
* mainly to display information to the user. In no way is this object
* used as input to make a connection, so we can choose to display
* whatever human-readable text makes sense to the user for a
* connection. This is especially relevant for the phone number field,
* since it is the one field that is most likely exposed to the user.
*
* As an example:
* 1. User dials "911"
* 2. Device recognizes that this is an emergency number
* 3. We use the "Emergency Number" string instead of "911" in the
* phoneNumber field.
*
* What we're really doing here is treating phoneNumber as an essential
* field here, NOT name. We're NOT always guaranteed to have a name
* for a connection, but the number should be displayable.
*/
public String name;
public String phoneNumber;
public String normalizedNumber;
public String geoDescription;
public String cnapName;
public int numberPresentation;
public int namePresentation;
public boolean contactExists;
public String phoneLabel;
/* Split up the phoneLabel into number type and label name */
public int numberType;
public String numberLabel;
public int photoResource;
public long person_id;
public boolean needUpdate;
public Uri contactRefUri;
// fields to hold individual contact preference data,
// including the send to voicemail flag and the ringtone
// uri reference.
public Uri contactRingtoneUri;
public boolean shouldSendToVoicemail;
/**
* Drawable representing the caller image. This is essentially
* a cache for the image data tied into the connection /
* callerinfo object. The isCachedPhotoCurrent flag indicates
* if the image data needs to be reloaded.
*/
public Drawable cachedPhoto;
public boolean isCachedPhotoCurrent;
private boolean mIsEmergency;
private boolean mIsVoiceMail;
public CallerInfo() {
// TODO: Move all the basic initialization here?
mIsEmergency = false;
mIsVoiceMail = false;
}
/**
* getCallerInfo given a Cursor.
* @param context the context used to retrieve string constants
* @param contactRef the URI to attach to this CallerInfo object
* @param cursor the first object in the cursor is used to build the CallerInfo object.
* @return the CallerInfo which contains the caller id for the given
* number. The returned CallerInfo is null if no number is supplied.
*/
public static CallerInfo getCallerInfo(Context context, Uri contactRef, Cursor cursor) {
CallerInfo info = new CallerInfo();
info.photoResource = 0;
info.phoneLabel = null;
info.numberType = 0;
info.numberLabel = null;
info.cachedPhoto = null;
info.isCachedPhotoCurrent = false;
info.contactExists = false;
if (VDBG) Log.v(TAG, "getCallerInfo() based on cursor...");
if (cursor != null) {
if (cursor.moveToFirst()) {
// TODO: photo_id is always available but not taken
// care of here. Maybe we should store it in the
// CallerInfo object as well.
int columnIndex;
// Look for the name
columnIndex = cursor.getColumnIndex(PhoneLookup.DISPLAY_NAME);
if (columnIndex != -1) {
info.name = cursor.getString(columnIndex);
}
// Look for the number
columnIndex = cursor.getColumnIndex(PhoneLookup.NUMBER);
if (columnIndex != -1) {
info.phoneNumber = cursor.getString(columnIndex);
}
// Look for the normalized number
columnIndex = cursor.getColumnIndex(PhoneLookup.NORMALIZED_NUMBER);
if (columnIndex != -1) {
info.normalizedNumber = cursor.getString(columnIndex);
}
// Look for the label/type combo
columnIndex = cursor.getColumnIndex(PhoneLookup.LABEL);
if (columnIndex != -1) {
int typeColumnIndex = cursor.getColumnIndex(PhoneLookup.TYPE);
if (typeColumnIndex != -1) {
info.numberType = cursor.getInt(typeColumnIndex);
info.numberLabel = cursor.getString(columnIndex);
info.phoneLabel = Phone.getDisplayLabel(context,
info.numberType, info.numberLabel)
.toString();
}
}
// Look for the person_id.
columnIndex = getColumnIndexForPersonId(contactRef, cursor);
if (columnIndex != -1) {
info.person_id = cursor.getLong(columnIndex);
if (VDBG) Log.v(TAG, "==> got info.person_id: " + info.person_id);
} else {
// No valid columnIndex, so we can't look up person_id.
Log.w(TAG, "Couldn't find person_id column for " + contactRef);
// Watch out: this means that anything that depends on
// person_id will be broken (like contact photo lookups in
// the in-call UI, for example.)
}
// look for the custom ringtone, create from the string stored
// in the database.
columnIndex = cursor.getColumnIndex(PhoneLookup.CUSTOM_RINGTONE);
if ((columnIndex != -1) && (cursor.getString(columnIndex) != null)) {
info.contactRingtoneUri = Uri.parse(cursor.getString(columnIndex));
} else {
info.contactRingtoneUri = null;
}
// look for the send to voicemail flag, set it to true only
// under certain circumstances.
columnIndex = cursor.getColumnIndex(PhoneLookup.SEND_TO_VOICEMAIL);
info.shouldSendToVoicemail = (columnIndex != -1) &&
((cursor.getInt(columnIndex)) == 1);
info.contactExists = true;
}
cursor.close();
}
info.needUpdate = false;
info.name = normalize(info.name);
info.contactRefUri = contactRef;
return info;
}
/**
* getCallerInfo given a URI, look up in the call-log database
* for the uri unique key.
* @param context the context used to get the ContentResolver
* @param contactRef the URI used to lookup caller id
* @return the CallerInfo which contains the caller id for the given
* number. The returned CallerInfo is null if no number is supplied.
*/
public static CallerInfo getCallerInfo(Context context, Uri contactRef) {
return getCallerInfo(context, contactRef,
context.getContentResolver().query(contactRef, null, null, null, null));
}
/**
* getCallerInfo given a phone number, look up in the call-log database
* for the matching caller id info.
* @param context the context used to get the ContentResolver
* @param number the phone number used to lookup caller id
* @return the CallerInfo which contains the caller id for the given
* number. The returned CallerInfo is null if no number is supplied. If
* a matching number is not found, then a generic caller info is returned,
* with all relevant fields empty or null.
*/
public static CallerInfo getCallerInfo(Context context, String number) {
if (VDBG) Log.v(TAG, "getCallerInfo() based on number...");
if (TextUtils.isEmpty(number)) {
return null;
}
// Change the callerInfo number ONLY if it is an emergency number
// or if it is the voicemail number. If it is either, take a
// shortcut and skip the query.
if (PhoneNumberUtils.isLocalEmergencyNumber(number, context)) {
return new CallerInfo().markAsEmergency(context);
} else if (PhoneNumberUtils.isVoiceMailNumber(number)) {
return new CallerInfo().markAsVoiceMail();
}
Uri contactUri = Uri.withAppendedPath(PhoneLookup.CONTENT_FILTER_URI, Uri.encode(number));
CallerInfo info = getCallerInfo(context, contactUri);
info = doSecondaryLookupIfNecessary(context, number, info);
// if no query results were returned with a viable number,
// fill in the original number value we used to query with.
if (TextUtils.isEmpty(info.phoneNumber)) {
info.phoneNumber = number;
}
return info;
}
/**
* Performs another lookup if previous lookup fails and it's a SIP call
* and the peer's username is all numeric. Look up the username as it
* could be a PSTN number in the contact database.
*
* @param context the query context
* @param number the original phone number, could be a SIP URI
* @param previousResult the result of previous lookup
* @return previousResult if it's not the case
*/
static CallerInfo doSecondaryLookupIfNecessary(Context context,
String number, CallerInfo previousResult) {
if (!previousResult.contactExists
&& PhoneNumberUtils.isUriNumber(number)) {
String username = PhoneNumberUtils.getUsernameFromUriNumber(number);
if (PhoneNumberUtils.isGlobalPhoneNumber(username)) {
previousResult = getCallerInfo(context,
Uri.withAppendedPath(PhoneLookup.CONTENT_FILTER_URI,
Uri.encode(username)));
}
}
return previousResult;
}
/**
* getCallerId: a convenience method to get the caller id for a given
* number.
*
* @param context the context used to get the ContentResolver.
* @param number a phone number.
* @return if the number belongs to a contact, the contact's name is
* returned; otherwise, the number itself is returned.
*
* TODO NOTE: This MAY need to refer to the Asynchronous Query API
* [startQuery()], instead of getCallerInfo, but since it looks like
* it is only being used by the provider calls in the messaging app:
* 1. android.provider.Telephony.Mms.getDisplayAddress()
* 2. android.provider.Telephony.Sms.getDisplayAddress()
* We may not need to make the change.
*/
public static String getCallerId(Context context, String number) {
CallerInfo info = getCallerInfo(context, number);
String callerID = null;
if (info != null) {
String name = info.name;
if (!TextUtils.isEmpty(name)) {
callerID = name;
} else {
callerID = number;
}
}
return callerID;
}
// Accessors
/**
* @return true if the caller info is an emergency number.
*/
public boolean isEmergencyNumber() {
return mIsEmergency;
}
/**
* @return true if the caller info is a voicemail number.
*/
public boolean isVoiceMailNumber() {
return mIsVoiceMail;
}
/**
* Mark this CallerInfo as an emergency call.
* @param context To lookup the localized 'Emergency Number' string.
* @return this instance.
*/
// TODO: Note we're setting the phone number here (refer to
// javadoc comments at the top of CallerInfo class) to a localized
// string 'Emergency Number'. This is pretty bad because we are
// making UI work here instead of just packaging the data. We
// should set the phone number to the dialed number and name to
// 'Emergency Number' and let the UI make the decision about what
// should be displayed.
/* package */ CallerInfo markAsEmergency(Context context) {
phoneNumber = context.getString(
com.android.internal.R.string.emergency_call_dialog_number_for_display);
photoResource = com.android.internal.R.drawable.picture_emergency;
mIsEmergency = true;
return this;
}
/**
* Mark this CallerInfo as a voicemail call. The voicemail label
* is obtained from the telephony manager. Caller must hold the
* READ_PHONE_STATE permission otherwise the phoneNumber will be
* set to null.
* @return this instance.
*/
// TODO: As in the emergency number handling, we end up writing a
// string in the phone number field.
/* package */ CallerInfo markAsVoiceMail() {
mIsVoiceMail = true;
try {
String voiceMailLabel = TelephonyManager.getDefault().getVoiceMailAlphaTag();
phoneNumber = voiceMailLabel;
} catch (SecurityException se) {
// Should never happen: if this process does not have
// permission to retrieve VM tag, it should not have
// permission to retrieve VM number and would not call
// this method.
// Leave phoneNumber untouched.
Log.e(TAG, "Cannot access VoiceMail.", se);
}
// TODO: There is no voicemail picture?
// FIXME: FIND ANOTHER ICON
// photoResource = android.R.drawable.badge_voicemail;
return this;
}
private static String normalize(String s) {
if (s == null || s.length() > 0) {
return s;
} else {
return null;
}
}
/**
* Returns the column index to use to find the "person_id" field in
* the specified cursor, based on the contact URI that was originally
* queried.
*
* This is a helper function for the getCallerInfo() method that takes
* a Cursor. Looking up the person_id is nontrivial (compared to all
* the other CallerInfo fields) since the column we need to use
* depends on what query we originally ran.
*
* Watch out: be sure to not do any database access in this method, since
* it's run from the UI thread (see comments below for more info.)
*
* @return the columnIndex to use (with cursor.getLong()) to get the
* person_id, or -1 if we couldn't figure out what colum to use.
*
* TODO: Add a unittest for this method. (This is a little tricky to
* test, since we'll need a live contacts database to test against,
* preloaded with at least some phone numbers and SIP addresses. And
* we'll probably have to hardcode the column indexes we expect, so
* the test might break whenever the contacts schema changes. But we
* can at least make sure we handle all the URI patterns we claim to,
* and that the mime types match what we expect...)
*/
private static int getColumnIndexForPersonId(Uri contactRef, Cursor cursor) {
// TODO: This is pretty ugly now, see bug 2269240 for
// more details. The column to use depends upon the type of URL:
// - content://com.android.contacts/data/phones ==> use the "contact_id" column
// - content://com.android.contacts/phone_lookup ==> use the "_ID" column
// - content://com.android.contacts/data ==> use the "contact_id" column
// If it's none of the above, we leave columnIndex=-1 which means
// that the person_id field will be left unset.
//
// The logic here *used* to be based on the mime type of contactRef
// (for example Phone.CONTENT_ITEM_TYPE would tell us to use the
// RawContacts.CONTACT_ID column). But looking up the mime type requires
// a call to context.getContentResolver().getType(contactRef), which
// isn't safe to do from the UI thread since it can cause an ANR if
// the contacts provider is slow or blocked (like during a sync.)
//
// So instead, figure out the column to use for person_id by just
// looking at the URI itself.
if (VDBG) Log.v(TAG, "- getColumnIndexForPersonId: contactRef URI = '"
+ contactRef + "'...");
// Warning: Do not enable the following logging (due to ANR risk.)
// if (VDBG) Log.v(TAG, "- MIME type: "
// + context.getContentResolver().getType(contactRef));
String url = contactRef.toString();
String columnName = null;
if (url.startsWith("content://com.android.contacts/data/phones")) {
// Direct lookup in the Phone table.
// MIME type: Phone.CONTENT_ITEM_TYPE (= "vnd.android.cursor.item/phone_v2")
if (VDBG) Log.v(TAG, "'data/phones' URI; using RawContacts.CONTACT_ID");
columnName = RawContacts.CONTACT_ID;
} else if (url.startsWith("content://com.android.contacts/data")) {
// Direct lookup in the Data table.
// MIME type: Data.CONTENT_TYPE (= "vnd.android.cursor.dir/data")
if (VDBG) Log.v(TAG, "'data' URI; using Data.CONTACT_ID");
// (Note Data.CONTACT_ID and RawContacts.CONTACT_ID are equivalent.)
columnName = Data.CONTACT_ID;
} else if (url.startsWith("content://com.android.contacts/phone_lookup")) {
// Lookup in the PhoneLookup table, which provides "fuzzy matching"
// for phone numbers.
// MIME type: PhoneLookup.CONTENT_TYPE (= "vnd.android.cursor.dir/phone_lookup")
if (VDBG) Log.v(TAG, "'phone_lookup' URI; using PhoneLookup._ID");
columnName = PhoneLookup._ID;
} else {
Log.w(TAG, "Unexpected prefix for contactRef '" + url + "'");
}
int columnIndex = (columnName != null) ? cursor.getColumnIndex(columnName) : -1;
if (VDBG) Log.v(TAG, "==> Using column '" + columnName
+ "' (columnIndex = " + columnIndex + ") for person_id lookup...");
return columnIndex;
}
/**
* Updates this CallerInfo's geoDescription field, based on the raw
* phone number in the phoneNumber field.
*
* (Note that the various getCallerInfo() methods do *not* set the
* geoDescription automatically; you need to call this method
* explicitly to get it.)
*
* @param context the context used to look up the current locale / country
* @param fallbackNumber if this CallerInfo's phoneNumber field is empty,
* this specifies a fallback number to use instead.
*/
public void updateGeoDescription(Context context, String fallbackNumber) {
String number = TextUtils.isEmpty(phoneNumber) ? fallbackNumber : phoneNumber;
geoDescription = getGeoDescription(context, number);
}
/**
* @return a geographical description string for the specified number.
* @see com.android.i18n.phonenumbers.PhoneNumberOfflineGeocoder
*/
private static String getGeoDescription(Context context, String number) {
if (VDBG) Log.v(TAG, "getGeoDescription('" + number + "')...");
if (TextUtils.isEmpty(number)) {
return null;
}
PhoneNumberUtil util = PhoneNumberUtil.getInstance();
PhoneNumberOfflineGeocoder geocoder = PhoneNumberOfflineGeocoder.getInstance();
Locale locale = context.getResources().getConfiguration().locale;
String countryIso = getCurrentCountryIso(context, locale);
PhoneNumber pn = null;
try {
if (VDBG) Log.v(TAG, "parsing '" + number
+ "' for countryIso '" + countryIso + "'...");
pn = util.parse(number, countryIso);
if (VDBG) Log.v(TAG, "- parsed number: " + pn);
} catch (NumberParseException e) {
Log.w(TAG, "getGeoDescription: NumberParseException for incoming number '" + number + "'");
}
if (pn != null) {
String description = geocoder.getDescriptionForNumber(pn, locale);
if (VDBG) Log.v(TAG, "- got description: '" + description + "'");
return description;
} else {
return null;
}
}
/**
* @return The ISO 3166-1 two letters country code of the country the user
* is in.
*/
private static String getCurrentCountryIso(Context context, Locale locale) {
String countryIso;
CountryDetector detector = (CountryDetector) context.getSystemService(
Context.COUNTRY_DETECTOR);
if (detector != null) {
countryIso = detector.detectCountry().getCountryIso();
} else {
countryIso = locale.getCountry();
Log.w(TAG, "No CountryDetector; falling back to countryIso based on locale: "
+ countryIso);
}
return countryIso;
}
/**
* @return a string debug representation of this instance.
*/
public String toString() {
// Warning: never check in this file with VERBOSE_DEBUG = true
// because that will result in PII in the system log.
final boolean VERBOSE_DEBUG = false;
if (VERBOSE_DEBUG) {
return new StringBuilder(384)
.append(super.toString() + " { ")
.append("\nname: " + name)
.append("\nphoneNumber: " + phoneNumber)
.append("\nnormalizedNumber: " + normalizedNumber)
.append("\ngeoDescription: " + geoDescription)
.append("\ncnapName: " + cnapName)
.append("\nnumberPresentation: " + numberPresentation)
.append("\nnamePresentation: " + namePresentation)
.append("\ncontactExits: " + contactExists)
.append("\nphoneLabel: " + phoneLabel)
.append("\nnumberType: " + numberType)
.append("\nnumberLabel: " + numberLabel)
.append("\nphotoResource: " + photoResource)
.append("\nperson_id: " + person_id)
.append("\nneedUpdate: " + needUpdate)
.append("\ncontactRefUri: " + contactRefUri)
.append("\ncontactRingtoneUri: " + contactRefUri)
.append("\nshouldSendToVoicemail: " + shouldSendToVoicemail)
.append("\ncachedPhoto: " + cachedPhoto)
.append("\nisCachedPhotoCurrent: " + isCachedPhotoCurrent)
.append("\nemergency: " + mIsEmergency)
.append("\nvoicemail " + mIsVoiceMail)
.append("\ncontactExists " + contactExists)
.append(" }")
.toString();
} else {
return new StringBuilder(128)
.append(super.toString() + " { ")
.append("name " + ((name == null) ? "null" : "non-null"))
.append(", phoneNumber " + ((phoneNumber == null) ? "null" : "non-null"))
.append(" }")
.toString();
}
}
}