is to improve the
* readability which should not be used to search asset files. If there is no configuration,
* then we look for a file named after the MCC+MNC of {@code id} as a fallback. Last, we read
* res/xml/vendor.xml.
*
* carrierid.xml doesn't support multiple bundles with filters as each carrier including MVNOs
* has its own config file named after its carrier id.
* Both vendor.xml and MCC+MNC.xml files may contain multiple bundles with filters on them.
* All the matching bundles are flattened to return one carrier config bundle.
*/
@Override
public PersistableBundle onLoadConfig(@Nullable CarrierIdentifier id) {
Log.d(TAG, "Config being fetched");
try {
synchronized (this) {
if (mFactory == null) {
mFactory = XmlPullParserFactory.newInstance();
}
}
XmlPullParser parser = mFactory.newPullParser();
return loadConfig(parser, id);
}
catch (XmlPullParserException e) {
Log.e(TAG, "Failed to load config", e);
return new PersistableBundle();
}
}
PersistableBundle loadConfig(XmlPullParser parser, @Nullable CarrierIdentifier id) {
PersistableBundle config = new PersistableBundle();
// OEM customizable filter for carrier requirements not related to hardware/vendor SKU.
String sku = getApplicationContext().getResources().getString(R.string.sku_filter);
if (id == null) {
try {
// Load no SIM config if carrier id is not set.
parser.setInput(getApplicationContext().getAssets().open(
NO_SIM_CONFIG_FILE_NAME), "utf-8");
config = readConfigFromXml(parser, null, sku);
// Treat vendor_no_sim.xml as if it were appended to the no sim config file.
XmlPullParser vendorInput =
getApplicationContext().getResources().getXml(R.xml.vendor_no_sim);
PersistableBundle vendorConfig = readConfigFromXml(vendorInput, null, sku);
config.putAll(vendorConfig);
}
catch (IOException|XmlPullParserException e) {
Log.e(TAG, "Failed to load config for no SIM", e);
}
return config;
}
try {
if (id.getCarrierId() != TelephonyManager.UNKNOWN_CARRIER_ID) {
PersistableBundle configByCarrierId = new PersistableBundle();
PersistableBundle configBySpecificCarrierId = new PersistableBundle();
PersistableBundle configByMccMncFallBackCarrierId = new PersistableBundle();
TelephonyManager telephonyManager = getApplicationContext()
.getSystemService(TelephonyManager.class);
int mccmncCarrierId = telephonyManager
.getCarrierIdFromMccMnc(id.getMcc() + id.getMnc());
for (String file : getApplicationContext().getAssets().list("")) {
if (file.startsWith(CARRIER_ID_PREFIX + id.getSpecificCarrierId() + "_")) {
parser.setInput(getApplicationContext().getAssets().open(file), "utf-8");
configBySpecificCarrierId = readConfigFromXml(parser, null, sku);
break;
} else if (file.startsWith(CARRIER_ID_PREFIX + id.getCarrierId() + "_")) {
parser.setInput(getApplicationContext().getAssets().open(file), "utf-8");
configByCarrierId = readConfigFromXml(parser, null, sku);
} else if (file.startsWith(CARRIER_ID_PREFIX + mccmncCarrierId + "_")) {
parser.setInput(getApplicationContext().getAssets().open(file), "utf-8");
configByMccMncFallBackCarrierId = readConfigFromXml(parser, null, sku);
}
}
// priority: specific carrier id > carrier id > mccmnc fallback carrier id
if (!configBySpecificCarrierId.isEmpty()) {
config = configBySpecificCarrierId;
} else if (!configByCarrierId.isEmpty()) {
config = configByCarrierId;
} else if (!configByMccMncFallBackCarrierId.isEmpty()) {
config = configByMccMncFallBackCarrierId;
}
}
if (config.isEmpty()) {
// fallback to use mccmnc.xml when there is no carrier id named config found.
parser.setInput(getApplicationContext().getAssets().open(
MCCMNC_PREFIX + id.getMcc() + id.getMnc() + ".xml"), "utf-8");
config = readConfigFromXml(parser, id, sku);
}
}
catch (IOException | XmlPullParserException e) {
Log.d(TAG, e.toString());
// We can return an empty config for unknown networks.
config = new PersistableBundle();
}
// Treat vendor.xml as if it were appended to the carrier config file we read.
XmlPullParser vendorInput = getApplicationContext().getResources().getXml(R.xml.vendor);
try {
PersistableBundle vendorConfig = readConfigFromXml(vendorInput, id, sku);
config.putAll(vendorConfig);
}
catch (IOException | XmlPullParserException e) {
Log.e(TAG, e.toString());
}
return config;
}
/**
* Parses an XML document and returns a PersistableBundle.
*
* This function iterates over each {@code } node in the XML document and
* parses it into a bundle if its filters match {@code id}. XML documents named after carrier id
* doesn't support filter match as each carrier including MVNOs will have its own config file.
* The format of XML bundles is defined
* by {@link PersistableBundle#restoreFromXml}. All the matching bundles will be flattened and
* returned as a single bundle.
*
* Here is an example document in vendor.xml.
*
{@code
*
*
*
*
*
*
*
*
* }
*
* Here is an example document. The second bundle will be applied to the first only if the
* GID1 is ABCD.
*
{@code
*
*
*
*
*
*
*
*
* }
*
* @param parser an XmlPullParser pointing at the beginning of the document.
* @param id the details of the SIM operator used to filter parts of the document. If read from
* files named after carrier id, this will be set to {@null code} as no filter match
* needed.
* @param sku a filter to be customizable.
* @return a possibly empty PersistableBundle containing the config values.
*/
static PersistableBundle readConfigFromXml(XmlPullParser parser, @Nullable CarrierIdentifier id,
String sku) throws IOException, XmlPullParserException {
PersistableBundle config = new PersistableBundle();
if (parser == null) {
return config;
}
// Iterate over each node in the document and add it to the returned
// bundle if its filters match.
int event;
while (((event = parser.next()) != XmlPullParser.END_DOCUMENT)) {
if (event == XmlPullParser.START_TAG && "carrier_config".equals(parser.getName())) {
// Skip this fragment if it has filters that don't match.
if (!checkFilters(parser, id, sku)) {
continue;
}
PersistableBundle configFragment = PersistableBundle.restoreFromXml(parser);
config.putAll(configFragment);
}
}
return config;
}
/**
* Checks to see if an XML node matches carrier filters.
*
* This iterates over the attributes of the current tag pointed to by {@code parser} and
* checks each one against {@code id} or {@link Build.DEVICE} or {@link R.string#sku_filter} or
* {@link Build.BOARD}. Attributes that are not specified in the node will not be checked, so a
* node with no attributes will always return true. The supported filter attributes are,
*
* - mcc: {@link CarrierIdentifier#getMcc}
* - mnc: {@link CarrierIdentifier#getMnc}
* - gid1: {@link CarrierIdentifier#getGid1}
* - gid2: {@link CarrierIdentifier#getGid2}
* - spn: {@link CarrierIdentifier#getSpn}
* - imsi: {@link CarrierIdentifier#getImsi}
* - device: {@link Build.DEVICE}
* - vendorSku: {@link SystemConfig.VENDOR_SKU_PROPERTY}
* - hardwareSku: {@link SystemConfig.SKU_PROPERTY}
* - board: {@link Build.BOARD}
* - cid: {@link CarrierIdentifier#getCarrierId()}
* or {@link CarrierIdentifier#getSpecificCarrierId()}
* - sku: {@link R.string#sku_filter} "sku_filter" that OEM customizable filter
*
*
*
*
* The attributes imsi and spn can be expressed as regexp to filter on patterns.
* The spn attribute can be set to the string "null" to allow matching against a SIM
* with no spn set.
*
*
* @param parser an XmlPullParser pointing at a START_TAG with the attributes to check.
* @param id the carrier details to check against.
* @param sku a filter to be customizable.
* @return false if any XML attribute does not match the corresponding value.
*/
static boolean checkFilters(XmlPullParser parser, @Nullable CarrierIdentifier id, String sku) {
String vendorSkuProperty = SystemProperties.get(
"ro.boot.product.vendor.sku", "");
String hardwareSkuProperty = SystemProperties.get(
"ro.boot.product.hardware.sku", "");
for (int i = 0; i < parser.getAttributeCount(); ++i) {
boolean result = true;
String attribute = parser.getAttributeName(i);
String value = parser.getAttributeValue(i);
switch (attribute) {
case "mcc":
result = (id == null) || value.equals(id.getMcc());
break;
case "mnc":
result = (id == null) || value.equals(id.getMnc());
break;
case "gid1":
result = (id == null) || value.equalsIgnoreCase(id.getGid1());
break;
case "gid2":
result = (id == null) || value.equalsIgnoreCase(id.getGid2());
break;
case "spn":
result = (id == null) || matchOnSP(value, id);
break;
case "imsi":
result = (id == null) || matchOnImsi(value, id);
break;
case "device":
result = value.equalsIgnoreCase(Build.DEVICE);
break;
case "vendorSku":
result = value.equalsIgnoreCase(vendorSkuProperty);
break;
case "hardwareSku":
result = value.equalsIgnoreCase(hardwareSkuProperty);
break;
case "board":
result = value.equalsIgnoreCase(Build.BOARD);
break;
case "cid":
result = (id == null) || (Integer.parseInt(value) == id.getCarrierId())
|| (Integer.parseInt(value) == id.getSpecificCarrierId());
break;
case "name":
// name is used together with cid for readability. ignore for filter.
break;
case "sku":
result = value.equalsIgnoreCase(sku);
break;
default:
Log.e(TAG, "Unknown attribute " + attribute + "=" + value);
result = false;
break;
}
if (!result) {
return false;
}
}
return true;
}
/**
* Check to see if the IMSI expression from the XML matches the IMSI of the
* Carrier.
*
* @param xmlImsi IMSI expression fetched from the resource XML
* @param id Id of the evaluated CarrierIdentifier
* @return true if the XML IMSI matches the IMSI of CarrierIdentifier, false
* otherwise.
*/
static boolean matchOnImsi(String xmlImsi, CarrierIdentifier id) {
boolean matchFound = false;
String currentImsi = id.getImsi();
// If we were able to retrieve current IMSI, see if it matches.
if (currentImsi != null) {
Pattern imsiPattern = Pattern.compile(xmlImsi, Pattern.CASE_INSENSITIVE);
Matcher matcher = imsiPattern.matcher(currentImsi);
matchFound = matcher.matches();
}
return matchFound;
}
/**
* Check to see if the service provider name expression from the XML matches the
* CarrierIdentifier.
*
* @param xmlSP SP expression fetched from the resource XML
* @param id Id of the evaluated CarrierIdentifier
* @return true if the XML SP matches the phone's SP, false otherwise.
*/
static boolean matchOnSP(String xmlSP, CarrierIdentifier id) {
boolean matchFound = false;
String currentSP = id.getSpn();
if (SPN_EMPTY_MATCH.equalsIgnoreCase(xmlSP)) {
if (TextUtils.isEmpty(currentSP)) {
matchFound = true;
}
} else if (currentSP != null) {
Pattern spPattern = Pattern.compile(xmlSP, Pattern.CASE_INSENSITIVE);
Matcher matcher = spPattern.matcher(currentSP);
matchFound = matcher.matches();
}
return matchFound;
}
}