Add a new NFC developer setting option for NFCSNOOP am: a2f8944942

Original change: https://android-review.googlesource.com/c/platform/packages/apps/Settings/+/2332202

Change-Id: Ic96878e632ec919f2486263a5cb479486b9d4c54
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>

res/values/strings.xml

@@ -2119,6 +2119,17 @@
     <!-- Nfc developer settings: The description of the setting. -->
     <string name="nfc_stack_debuglog_summary">Increase NFC stack logging level</string>
 
+    <!-- Nfc developer settings: The title of the setting to enable full nfc snoop log. [CHAR LIMIT=60] -->
+    <string name="nfc_snoop_log_title">NFC NCI unfiltered snoop log</string>
+    <!-- Nfc developer settings: The description of the setting to enable full nfc snoop log. [CHAR_LIMIT=NONE] -->
+    <string name="nfc_snoop_log_summary">Capture detail NFC packets, which may contain private information. </string>
+    <!-- Nfc developer settings: The title of the popup dialog. [CHAR_LIMIT=60] -->
+    <string name="nfc_reboot_dialog_title">Restart Device?</string>
+    <!-- Nfc developer settings: The content of the popup dialog. [CHAR_LIMIT=NONE] -->
+    <string name="nfc_reboot_dialog_message">Detail NFC logging is intended for development purposes only. Additional NFC data is included in bug reports, which may contain private information. Restart your device to change this setting. </string>
+    <!-- Nfc developer settings: The confirm button of the popup dialog. [CHAR_LIMIT=60] -->
+    <string name="nfc_reboot_dialog_confirm">Restart</string>
+
     <!-- Wifi Display settings. The title of the screen. [CHAR LIMIT=40] -->
     <string name="wifi_display_settings_title">Cast</string>
     <!-- Wifi Display settings. The keywords of the setting. [CHAR LIMIT=NONE] -->

res/xml/development_settings.xml

@@ -422,6 +422,11 @@
             android:title="@string/nfc_stack_debuglog_title"
             android:summary="@string/nfc_stack_debuglog_summary" />
 
+        <SwitchPreference
+            android:key="nfc_snoop_log"
+            android:title="@string/nfc_snoop_log_title"
+            android:summary="@string/nfc_snoop_log_summary"/>
+
     </PreferenceCategory>
 
     <PreferenceCategory

src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java

@@ -82,7 +82,9 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
         implements OnMainSwitchChangeListener, OemUnlockDialogHost, AdbDialogHost,
         AdbClearKeysDialogHost, LogPersistDialogHost,
         BluetoothRebootDialog.OnRebootDialogListener,
-        AbstractBluetoothPreferenceController.Callback, BluetoothSnoopLogHost {
+        AbstractBluetoothPreferenceController.Callback,
+        BluetoothSnoopLogHost,
+        NfcRebootDialog.OnNfcRebootDialogConfirmedListener {
 
     private static final String TAG = "DevSettingsDashboard";
 
@@ -410,6 +412,20 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
         controllerPbap.onSettingChanged();
     }
 
+    @Override
+    public void onNfcRebootDialogConfirmed() {
+        final NfcSnoopLogPreferenceController controller =
+                getDevelopmentOptionsController(NfcSnoopLogPreferenceController.class);
+        controller.onNfcRebootDialogConfirmed();
+    }
+
+    @Override
+    public void onNfcRebootDialogCanceled() {
+        final NfcSnoopLogPreferenceController controller =
+                getDevelopmentOptionsController(NfcSnoopLogPreferenceController.class);
+        controller.onNfcRebootDialogCanceled();
+    }
+
     @Override
     public void onActivityResult(int requestCode, int resultCode, Intent data) {
         boolean handledResult = false;
@@ -574,6 +590,7 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
         controllers.add(new BluetoothLeAudioHwOffloadPreferenceController(context, fragment));
         controllers.add(new BluetoothMaxConnectedAudioDevicesPreferenceController(context));
         controllers.add(new NfcStackDebugLogPreferenceController(context));
+        controllers.add(new NfcSnoopLogPreferenceController(context, fragment));
         controllers.add(new ShowTapsPreferenceController(context));
         controllers.add(new PointerLocationPreferenceController(context));
         controllers.add(new ShowSurfaceUpdatesPreferenceController(context));

src/com/android/settings/development/NfcRebootDialog.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright 2022 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.development;
+
+import android.app.Dialog;
+import android.app.settings.SettingsEnums;
+import android.content.DialogInterface;
+import android.os.Bundle;
+import android.os.PowerManager;
+
+import androidx.appcompat.app.AlertDialog;
+import androidx.fragment.app.FragmentManager;
+
+import com.android.settings.R;
+import com.android.settings.core.instrumentation.InstrumentedDialogFragment;
+
+/**
+ * The NFC log type switch should reboot the device to take effect,
+ * the dialog is to ask the user to reboot the device.
+ */
+public class NfcRebootDialog extends InstrumentedDialogFragment
+        implements DialogInterface.OnClickListener {
+
+    public static final String TAG = "NfcRebootDialog";
+
+    /**
+     * The function to show the Dialog.
+     */
+    public static void show(DevelopmentSettingsDashboardFragment host) {
+        final FragmentManager manager = host.getActivity().getSupportFragmentManager();
+        if (manager.findFragmentByTag(TAG) == null) {
+            final NfcRebootDialog dialog = new NfcRebootDialog();
+            dialog.setTargetFragment(host, 0 /* requestCode */);
+            dialog.show(manager, TAG);
+        }
+    }
+
+    @Override
+    public int getMetricsCategory() {
+        return SettingsEnums.DIALOG_NFC_ENABLE_DETAIL_LOG;
+    }
+
+    @Override
+    public Dialog onCreateDialog(Bundle savedInstanceState) {
+        return new AlertDialog.Builder(getActivity())
+                .setMessage(R.string.nfc_reboot_dialog_message)
+                .setTitle(R.string.nfc_reboot_dialog_title)
+                .setPositiveButton(
+                        R.string.nfc_reboot_dialog_confirm, this)
+                .setNegativeButton(
+                        android.R.string.cancel, this)
+                .create();
+    }
+
+    @Override
+    public void onClick(DialogInterface dialog, int which) {
+        final OnNfcRebootDialogConfirmedListener host =
+                (OnNfcRebootDialogConfirmedListener) getTargetFragment();
+        if (host == null) {
+            return;
+        }
+        if (which == DialogInterface.BUTTON_POSITIVE) {
+            host.onNfcRebootDialogConfirmed();
+            PowerManager pm = getContext().getSystemService(PowerManager.class);
+            pm.reboot(null);
+        } else {
+            host.onNfcRebootDialogCanceled();
+        }
+    }
+
+    /**
+     * Interface for EnableAdbWarningDialog callbacks.
+     */
+    public interface OnNfcRebootDialogConfirmedListener {
+        /**
+         * Called when the user presses enable on the warning dialog.
+         */
+        void onNfcRebootDialogConfirmed();
+
+        /**
+         * Called when the user presses cancel on the warning dialog.
+         */
+        void onNfcRebootDialogCanceled();
+    }
+}

src/com/android/settings/development/NfcSnoopLogPreferenceController.java

@@ -0,0 +1,129 @@
+/*
+ * Copyright (C) 2022 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.development;
+
+import android.content.Context;
+import android.os.SystemProperties;
+import android.util.Log;
+
+import androidx.annotation.VisibleForTesting;
+import androidx.preference.Preference;
+import androidx.preference.SwitchPreference;
+
+import com.android.settingslib.development.DeveloperOptionsPreferenceController;
+
+/**
+ * Preference controller to control NFCSNOOP data payload
+ */
+public class NfcSnoopLogPreferenceController extends
+        DeveloperOptionsPreferenceController implements Preference.OnPreferenceChangeListener {
+    private static final String TAG = "NfcSnoopLog";
+    private static final String NFC_NFCSNOOP_LOG_KEY =
+            "nfc_snoop_log";
+    @VisibleForTesting
+    static final String NFC_NFCSNOOP_LOG_MODE_PROPERTY =
+            "persist.nfc.nfcsnooplogmode";
+    @VisibleForTesting
+    static final String NFCSNOOP_MODE_FILTERED = "filtered";
+    @VisibleForTesting
+    static final String NFCSNOOP_MODE_FULL = "full";
+
+    @VisibleForTesting
+    boolean mChanged = false;
+
+    private final DevelopmentSettingsDashboardFragment mFragment;
+
+    public NfcSnoopLogPreferenceController(Context context,
+            DevelopmentSettingsDashboardFragment fragment) {
+        super(context);
+        mFragment = fragment;
+    }
+
+    @Override
+    public String getPreferenceKey() {
+        return NFC_NFCSNOOP_LOG_KEY;
+    }
+
+    @Override
+    public boolean onPreferenceChange(Preference preference, Object newValue) {
+        NfcRebootDialog.show(mFragment);
+        mChanged = true;
+        return false;
+    }
+
+    @Override
+    public void updateState(Preference preference) {
+        try {
+            final String currentValue = SystemProperties.get(NFC_NFCSNOOP_LOG_MODE_PROPERTY);
+            ((SwitchPreference) mPreference).setChecked(currentValue.equals(NFCSNOOP_MODE_FULL));
+        } catch (RuntimeException e) {
+            Log.e(TAG, "Fail to get nfc system property: " + e.getMessage());
+        }
+    }
+
+    @Override
+    protected void onDeveloperOptionsSwitchDisabled() {
+        super.onDeveloperOptionsSwitchDisabled();
+        try {
+            SystemProperties.set(NFC_NFCSNOOP_LOG_MODE_PROPERTY, NFCSNOOP_MODE_FILTERED);
+            ((SwitchPreference) mPreference).setChecked(false);
+        } catch (RuntimeException e) {
+            Log.e(TAG, "Fail to set nfc system property: " + e.getMessage());
+        }
+    }
+
+    /**
+     * Check whether the current setting is the default value or not.
+     */
+    public boolean isDefaultValue() {
+        try {
+            final String currentValue = SystemProperties.get(NFC_NFCSNOOP_LOG_MODE_PROPERTY);
+            return !currentValue.equals(NFCSNOOP_MODE_FULL);
+        } catch (RuntimeException e) {
+            Log.e(TAG, "Fail to get nfc system property: " + e.getMessage());
+        }
+        return true;
+    }
+
+    /**
+     * Called when the NfcRebootDialog confirm is clicked.
+     */
+    public void onNfcRebootDialogConfirmed() {
+        if (!mChanged) {
+            return;
+        }
+        try {
+            final String currentValue =
+                    SystemProperties.get(NFC_NFCSNOOP_LOG_MODE_PROPERTY, NFCSNOOP_MODE_FILTERED);
+            if (currentValue.equals(NFCSNOOP_MODE_FILTERED)) {
+                SystemProperties.set(NFC_NFCSNOOP_LOG_MODE_PROPERTY, NFCSNOOP_MODE_FULL);
+            } else {
+                SystemProperties.set(NFC_NFCSNOOP_LOG_MODE_PROPERTY, NFCSNOOP_MODE_FILTERED);
+            }
+        } catch (RuntimeException e) {
+            Log.e(TAG, "Fail to set nfc system property: " + e.getMessage());
+        }
+
+    }
+
+    /**
+     * Called when the NfcRebootDialog cancel is clicked.
+     */
+    public void onNfcRebootDialogCanceled() {
+        mChanged = false;
+    }
+}