src/com/android/settings/location/LocationSettingsFooterPreferenceController.java

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

import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.location.LocationManager;
import android.text.Html;
import android.text.TextUtils;
import android.util.Log;

import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;

import com.android.settings.R;
import com.android.settingslib.HelpUtils;
import com.android.settingslib.widget.FooterPreference;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * Preference controller for Location Settings footer.
 */
public class LocationSettingsFooterPreferenceController extends LocationBasePreferenceController {
    private static final String TAG = "LocationFooter";
    private static final String PARAGRAPH_SEPARATOR = "<br><br>";
    private static final Intent INJECT_INTENT =
            new Intent(LocationManager.SETTINGS_FOOTER_DISPLAYED_ACTION);

    private final PackageManager mPackageManager;
    private FooterPreference mFooterPreference;
    private boolean mLocationEnabled;
    private String mInjectedFooterString;

    public LocationSettingsFooterPreferenceController(Context context, String key) {
        super(context, key);
        mPackageManager = context.getPackageManager();
    }

    @Override
    public void displayPreference(PreferenceScreen screen) {
        super.displayPreference(screen);
        mFooterPreference = screen.findPreference(getPreferenceKey());
    }

    @Override
    public void onLocationModeChanged(int mode, boolean restricted) {
        mLocationEnabled = mLocationEnabler.isEnabled(mode);
        updateFooterPreference();
    }

    /**
     * Insert footer preferences.
     */
    @Override
    public void updateState(Preference preference) {
        Collection<FooterData> footerData = getFooterData();
        for (FooterData data : footerData) {
            try {
                mInjectedFooterString =
                        mPackageManager
                                .getResourcesForApplication(data.applicationInfo)
                                .getString(data.footerStringRes);
                updateFooterPreference();
            } catch (PackageManager.NameNotFoundException exception) {
                Log.w(
                        TAG,
                        "Resources not found for application "
                                + data.applicationInfo.packageName);
            }
        }
    }

    private void updateFooterPreference() {
        String footerString = mContext.getString(R.string.location_settings_footer_general);
        if (mLocationEnabled) {
            if (!TextUtils.isEmpty(mInjectedFooterString)) {
                footerString = Html.escapeHtml(mInjectedFooterString) + PARAGRAPH_SEPARATOR
                        + footerString;
            }
        } else {
            footerString = mContext.getString(R.string.location_settings_footer_location_off)
                    + PARAGRAPH_SEPARATOR
                    + footerString;
        }
        if (mFooterPreference != null) {
            mFooterPreference.setTitle(Html.fromHtml(footerString));
            mFooterPreference.setLearnMoreAction(v -> openLocationLearnMoreLink());
            mFooterPreference.setLearnMoreText(mContext.getString(
                    R.string.location_settings_footer_learn_more_content_description));
        }
    }

    private void openLocationLearnMoreLink() {
        mFragment.startActivityForResult(
                HelpUtils.getHelpIntent(
                        mContext,
                        mContext.getString(R.string.location_settings_footer_learn_more_link),
                        /*backupContext=*/""),
                /*requestCode=*/ 0);
    }

    /**
     * Location footer preference group should always be displayed.
     */
    @Override
    public int getAvailabilityStatus() {
        return AVAILABLE;
    }

    /**
     * Return a list of strings with text provided by ACTION_INJECT_FOOTER broadcast receivers.
     */
    private List<FooterData> getFooterData() {
        // Fetch footer text from system apps
        List<ResolveInfo> resolveInfos =
                mPackageManager.queryBroadcastReceivers(
                        INJECT_INTENT, PackageManager.GET_META_DATA);
        if (resolveInfos == null) {
            Log.e(TAG, "Unable to resolve intent " + INJECT_INTENT);
            return Collections.emptyList();
        }

        if (Log.isLoggable(TAG, Log.DEBUG)) {
            Log.d(TAG, "Found broadcast receivers: " + resolveInfos);
        }

        List<FooterData> footerDataList = new ArrayList<>(resolveInfos.size());
        for (ResolveInfo resolveInfo : resolveInfos) {
            ActivityInfo activityInfo = resolveInfo.activityInfo;
            ApplicationInfo appInfo = activityInfo.applicationInfo;

            // If a non-system app tries to inject footer, ignore it
            if ((appInfo.flags & ApplicationInfo.FLAG_SYSTEM) == 0) {
                Log.w(TAG, "Ignoring attempt to inject footer from app not in system image: "
                        + resolveInfo);
                continue;
            }

            // Get the footer text resource id from broadcast receiver's metadata
            if (activityInfo.metaData == null) {
                if (Log.isLoggable(TAG, Log.DEBUG)) {
                    Log.d(TAG, "No METADATA in broadcast receiver " + activityInfo.name);
                }
                continue;
            }

            final int footerTextRes =
                    activityInfo.metaData.getInt(LocationManager.METADATA_SETTINGS_FOOTER_STRING);
            if (footerTextRes == 0) {
                Log.w(
                        TAG,
                        "No mapping of integer exists for "
                                + LocationManager.METADATA_SETTINGS_FOOTER_STRING);
                continue;
            }
            footerDataList.add(new FooterData(footerTextRes, appInfo));
        }
        return footerDataList;
    }

    /**
     * Contains information related to a footer.
     */
    private static class FooterData {

        // The string resource of the footer
        public final int footerStringRes;

        // Application info of receiver injecting this footer
        public final ApplicationInfo applicationInfo;

        FooterData(int footerRes, ApplicationInfo appInfo) {
            this.footerStringRes = footerRes;
            this.applicationInfo = appInfo;
        }
    }
}