src/com/android/phone/PhoneSearchIndexablesProvider.java

/*
 * Copyright (C) 2014 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.phone;

import static android.provider.SearchIndexablesContract.COLUMN_INDEX_NON_INDEXABLE_KEYS_KEY_VALUE;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_CLASS_NAME;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_ICON_RESID;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_INTENT_ACTION;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_INTENT_TARGET_CLASS;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_INTENT_TARGET_PACKAGE;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_RANK;
import static android.provider.SearchIndexablesContract.COLUMN_INDEX_XML_RES_RESID;
import static android.provider.SearchIndexablesContract.INDEXABLES_RAW_COLUMNS;
import static android.provider.SearchIndexablesContract.INDEXABLES_XML_RES_COLUMNS;
import static android.provider.SearchIndexablesContract.NON_INDEXABLES_KEYS_COLUMNS;

import android.content.Context;
import android.database.Cursor;
import android.database.MatrixCursor;
import android.os.Binder;
import android.os.UserManager;
import android.provider.SearchIndexableResource;
import android.provider.SearchIndexablesContract.RawData;
import android.provider.SearchIndexablesProvider;
import android.telephony.euicc.EuiccManager;

import androidx.annotation.VisibleForTesting;

public class PhoneSearchIndexablesProvider extends SearchIndexablesProvider {
    private static final String TAG = "PhoneSearchIndexablesProvider";
    private UserManager mUserManager;

    private static SearchIndexableResource[] INDEXABLE_RES = new SearchIndexableResource[] {
            new SearchIndexableResource(1, R.xml.network_setting_fragment,
                    MobileNetworkSettings.class.getName(),
                    R.mipmap.ic_launcher_phone),
    };

    @Override
    public boolean onCreate() {
        mUserManager = (UserManager) getContext().getSystemService(Context.USER_SERVICE);
        return true;
    }

    @Override
    public Cursor queryXmlResources(String[] projection) {
        MatrixCursor cursor = new MatrixCursor(INDEXABLES_XML_RES_COLUMNS);
        final int count = INDEXABLE_RES.length;
        for (int n = 0; n < count; n++) {
            Object[] ref = new Object[7];
            ref[COLUMN_INDEX_XML_RES_RANK] = INDEXABLE_RES[n].rank;
            ref[COLUMN_INDEX_XML_RES_RESID] = INDEXABLE_RES[n].xmlResId;
            ref[COLUMN_INDEX_XML_RES_CLASS_NAME] = null;
            ref[COLUMN_INDEX_XML_RES_ICON_RESID] = INDEXABLE_RES[n].iconResId;
            ref[COLUMN_INDEX_XML_RES_INTENT_ACTION] = "android.intent.action.MAIN";
            ref[COLUMN_INDEX_XML_RES_INTENT_TARGET_PACKAGE] = "com.android.phone";
            ref[COLUMN_INDEX_XML_RES_INTENT_TARGET_CLASS] = INDEXABLE_RES[n].className;
            cursor.addRow(ref);
        }
        return cursor;
    }

    @Override
    public Cursor queryRawData(String[] projection) {
        MatrixCursor cursor = new MatrixCursor(INDEXABLES_RAW_COLUMNS);
        Context context = getContext();
        String title = context.getString(R.string.carrier_settings_euicc);
        cursor.newRow()
                .add(RawData.COLUMN_RANK, 0)
                .add(RawData.COLUMN_TITLE, title)
                .add(
                        RawData.COLUMN_KEYWORDS,
                        context.getString(R.string.keywords_carrier_settings_euicc))
                .add(RawData.COLUMN_SCREEN_TITLE, title)
                .add(RawData.COLUMN_KEY, "esim_list_profile")
                .add(
                        RawData.COLUMN_INTENT_ACTION,
                        EuiccManager.ACTION_MANAGE_EMBEDDED_SUBSCRIPTIONS)
                .add(
                        RawData.COLUMN_INTENT_TARGET_PACKAGE,
                        context.getPackageName());
        return cursor;
    }

    @Override
    public Cursor queryNonIndexableKeys(String[] projection) {
        final long uidToken = Binder.clearCallingIdentity();
        try {
            MatrixCursor cursor = new MatrixCursor(NON_INDEXABLES_KEYS_COLUMNS);

            if (!mUserManager.isAdminUser()) {
                final String[] values = new String[]{"preferred_network_mode_key",
                        "button_roaming_key", "cdma_lte_data_service_key", "enhanced_4g_lte",
                        "button_apn_key", "button_carrier_sel_key", "carrier_settings_key",
                        "cdma_system_select_key", "esim_list_profile", "mobile_data_enable",
                        "data_usage_summary", "wifi_calling_key", "video_calling_key"};
                for (String nik : values) {
                    cursor.addRow(createNonIndexableRow(nik));
                }
            } else {
                if (isEuiccSettingsHidden()) {
                    cursor.addRow(createNonIndexableRow("esim_list_profile" /* key */));
                }
                if (isEnhanced4gLteHidden()) {
                    cursor.addRow(createNonIndexableRow("enhanced_4g_lte" /* key */));
                }
            }

            // enabled_networks button and preferred_network_mode button share the same title
            // "Preferred network type"and are mutual exclusive. Thus we remove one from search
            // result to avoid duplicate search result.
            // TODO: b/63381516 all hidden buttons should dynamically be removed from search result.
            cursor.addRow(createNonIndexableRow("enabled_networks_key" /* key */));
            cursor.addRow(createNonIndexableRow("carrier_settings_euicc_key" /* key */));
            cursor.addRow(createNonIndexableRow("advanced_options" /* key */));
            return cursor;
        } finally {
            Binder.restoreCallingIdentity(uidToken);
        }
    }

    @VisibleForTesting boolean isEuiccSettingsHidden() {
        return !MobileNetworkSettings.showEuiccSettings(getContext());
    }

    @VisibleForTesting boolean isEnhanced4gLteHidden() {
        return MobileNetworkSettings.hideEnhanced4gLteSettings(getContext());
    }

    private Object[] createNonIndexableRow(String key) {
        final Object[] ref = new Object[NON_INDEXABLES_KEYS_COLUMNS.length];
        ref[COLUMN_INDEX_NON_INDEXABLE_KEYS_KEY_VALUE] = key;
        return ref;
    }
}