Merge "Convert DataUsageLib to Kotlin" into main

This commit is contained in:
Chaohui Wang
2023-08-08 05:05:01 +00:00
committed by Android (Google) Code Review
4 changed files with 270 additions and 231 deletions

View File

@@ -1,115 +0,0 @@
/*
* Copyright (C) 2020 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.settings.datausage.lib;
import android.content.Context;
import android.net.NetworkStats;
import android.net.NetworkTemplate;
import android.telephony.SubscriptionInfo;
import android.telephony.SubscriptionManager;
import android.telephony.TelephonyManager;
import android.util.ArraySet;
import android.util.Log;
import androidx.annotation.NonNull;
import com.android.internal.util.ArrayUtils;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
/**
* Lib class for data usage
*/
public class DataUsageLib {
private static final String TAG = "DataUsageLib";
/**
* Return mobile NetworkTemplate based on {@code subId}
*/
public static NetworkTemplate getMobileTemplate(Context context, int subId) {
final TelephonyManager telephonyManager = context.getSystemService(TelephonyManager.class);
final int mobileDefaultSubId = telephonyManager.getSubscriptionId();
final SubscriptionManager subscriptionManager =
context.getSystemService(SubscriptionManager.class);
final List<SubscriptionInfo> subInfoList =
subscriptionManager.getAvailableSubscriptionInfoList();
if (subInfoList == null) {
Log.i(TAG, "Subscription is not inited: " + subId);
return getMobileTemplateForSubId(telephonyManager, mobileDefaultSubId);
}
for (SubscriptionInfo subInfo : subInfoList) {
if ((subInfo != null) && (subInfo.getSubscriptionId() == subId)) {
return getNormalizedMobileTemplate(telephonyManager, subId);
}
}
Log.i(TAG, "Subscription is not active: " + subId);
return getMobileTemplateForSubId(telephonyManager, mobileDefaultSubId);
}
private static NetworkTemplate getNormalizedMobileTemplate(
TelephonyManager telephonyManager, int subId) {
final NetworkTemplate mobileTemplate = getMobileTemplateForSubId(telephonyManager, subId);
final String[] mergedSubscriberIds = telephonyManager
.createForSubscriptionId(subId).getMergedImsisFromGroup();
if (ArrayUtils.isEmpty(mergedSubscriberIds)) {
Log.i(TAG, "mergedSubscriberIds is null.");
return mobileTemplate;
}
return normalizeMobileTemplate(mobileTemplate, mergedSubscriberIds);
}
private static NetworkTemplate normalizeMobileTemplate(
@NonNull NetworkTemplate template, @NonNull String[] merged) {
if (template.getSubscriberIds().isEmpty()) return template;
// The input template should have at most 1 subscriberId.
final String subscriberId = template.getSubscriberIds().iterator().next();
// In some rare cases (e.g. b/243015487), merged subscriberId list might contain
// duplicated items. Deduplication for better error handling.
final ArraySet mergedSet = new ArraySet(merged);
if (mergedSet.size() != merged.length) {
Log.wtf(TAG, "Duplicated merged list detected: " + Arrays.toString(merged));
}
if (mergedSet.contains(subscriberId)) {
// Requested template subscriber is part of the merge group; return
// a template that matches all merged subscribers.
return new NetworkTemplate.Builder(template.getMatchRule())
.setSubscriberIds(mergedSet)
.setMeteredness(template.getMeteredness()).build();
}
return template;
}
public static NetworkTemplate getMobileTemplateForSubId(
TelephonyManager telephonyManager, int subId) {
// Create template that matches any mobile network when the subscriberId is null.
String subscriberId = telephonyManager.getSubscriberId(subId);
return subscriberId != null
? new NetworkTemplate.Builder(NetworkTemplate.MATCH_CARRIER)
.setSubscriberIds(Set.of(subscriberId))
.setMeteredness(NetworkStats.METERED_YES)
.build()
: new NetworkTemplate.Builder(NetworkTemplate.MATCH_MOBILE)
.setMeteredness(NetworkStats.METERED_YES)
.build();
}
}

View File

@@ -0,0 +1,99 @@
/*
* Copyright (C) 2023 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.settings.datausage.lib
import android.content.Context
import android.net.NetworkStats
import android.net.NetworkTemplate
import android.telephony.SubscriptionManager
import android.telephony.TelephonyManager
import android.util.Log
/**
* Lib class for data usage
*/
object DataUsageLib {
private const val TAG = "DataUsageLib"
/**
* Return mobile NetworkTemplate based on `subId`
*/
@JvmStatic
fun getMobileTemplate(context: Context, subId: Int): NetworkTemplate {
val telephonyManager = context.getSystemService(TelephonyManager::class.java)!!
val mobileDefaultSubId = telephonyManager.subscriptionId
val subscriptionManager = context.getSystemService(SubscriptionManager::class.java)!!
val subInfoList = subscriptionManager.availableSubscriptionInfoList
if (subInfoList == null) {
Log.i(TAG, "Subscription is not inited: $subId")
return getMobileTemplateForSubId(telephonyManager, mobileDefaultSubId)
}
for (subInfo in subInfoList) {
if (subInfo?.subscriptionId == subId) {
return getNormalizedMobileTemplate(telephonyManager, subId)
}
}
Log.i(TAG, "Subscription is not active: $subId")
return getMobileTemplateForSubId(telephonyManager, mobileDefaultSubId)
}
private fun getNormalizedMobileTemplate(
telephonyManager: TelephonyManager,
subId: Int,
): NetworkTemplate {
val mobileTemplate = getMobileTemplateForSubId(telephonyManager, subId)
val mergedSubscriberIds =
telephonyManager.createForSubscriptionId(subId).mergedImsisFromGroup
if (mergedSubscriberIds.isNullOrEmpty()) {
Log.i(TAG, "mergedSubscriberIds is empty.")
return mobileTemplate
}
return normalizeMobileTemplate(mobileTemplate, mergedSubscriberIds)
}
private fun normalizeMobileTemplate(
template: NetworkTemplate,
merged: Array<String?>,
): NetworkTemplate {
val subscriberId = template.subscriberIds.firstOrNull() ?: return template
// In some rare cases (e.g. b/243015487), merged subscriberId list might contain
// duplicated items. Deduplication for better error handling.
val mergedSet = merged.toSet()
if (mergedSet.size != merged.size) {
Log.wtf(TAG, "Duplicated merged list detected: " + merged.contentToString())
}
return if (mergedSet.contains(subscriberId)) {
// Requested template subscriber is part of the merge group; return
// a template that matches all merged subscribers.
NetworkTemplate.Builder(template.matchRule)
.setSubscriberIds(mergedSet)
.setMeteredness(template.meteredness)
.build()
} else template
}
@JvmStatic
fun getMobileTemplateForSubId(telephonyManager: TelephonyManager, subId: Int): NetworkTemplate {
// Create template that matches any mobile network when the subscriberId is null.
val subscriberId = telephonyManager.getSubscriberId(subId)
return when (subscriberId) {
null -> NetworkTemplate.Builder(NetworkTemplate.MATCH_MOBILE)
else -> NetworkTemplate.Builder(NetworkTemplate.MATCH_CARRIER)
.setSubscriberIds(setOf(subscriberId))
}.setMeteredness(NetworkStats.METERED_YES).build()
}
}