Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f771c1ef authored by Will Leshner's avatar Will Leshner
Browse files

Guard against a nonexistent dream settings activity. 

We already guard against a dream specifying a settings activity in a
different package. This change guards against a settings activity that
doesn't exist (which currently causes a settings app crash when a user
taps the 'Customize' button.

Bug: 330298841
Flag: EXEMPT bugfix
Test: atest DreamServiceTests
Change-Id: I286010553c87877cd5e50a19a295b4c54e928ebb
parent fcbc60ea

core/java/android/service/dreams/DreamService.java

+20 −7
Original line number Diff line number Diff line
@@ -1405,7 +1405,8 @@ public class DreamService extends Service implements Window.Callback { 
                        convertToComponentName(

                                rawMetadata.getString(

                                        com.android.internal.R.styleable.Dream_settingsActivity),

                                serviceInfo),

                                serviceInfo,

                                packageManager),

                        rawMetadata.getDrawable(

                                com.android.internal.R.styleable.Dream_previewImage),

                        rawMetadata.getBoolean(R.styleable.Dream_showClockAndComplications,
@@ -1420,26 +1421,38 @@ public class DreamService extends Service implements Window.Callback { 
    }



    @Nullable

    private static ComponentName convertToComponentName(@Nullable String flattenedString,

            ServiceInfo serviceInfo) {

    private static ComponentName convertToComponentName(

            @Nullable String flattenedString,

            ServiceInfo serviceInfo,

            PackageManager packageManager) {

        if (flattenedString == null) {

            return null;

        }



        if (!flattenedString.contains("/")) {

            return new ComponentName(serviceInfo.packageName, flattenedString);

        final ComponentName cn =

                flattenedString.contains("/")

                        ? ComponentName.unflattenFromString(flattenedString)

                        : new ComponentName(serviceInfo.packageName, flattenedString);



        if (cn == null) {

            return null;

        }



        // Ensure that the component is from the same package as the dream service. If not,

        // treat the component as invalid and return null instead.

        final ComponentName cn = ComponentName.unflattenFromString(flattenedString);

        if (cn == null) return null;

        if (!cn.getPackageName().equals(serviceInfo.packageName)) {

            Log.w(TAG,

                    "Inconsistent package name in component: " + cn.getPackageName()

                            + ", should be: " + serviceInfo.packageName);

            return null;

        }



        // Ensure that the activity exists. If not, treat the component as invalid and return null.

        if (new Intent().setComponent(cn).resolveActivityInfo(packageManager, 0) == null) {

            Log.w(TAG, "Dream settings activity not found: " + cn);

            return null;

        }



        return cn;

    }

services/tests/dreamservicetests/AndroidManifest.xml

+29 −0
Original line number Diff line number Diff line
@@ -53,6 +53,35 @@ 
                android:name="android.service.dream"

                android:resource="@xml/test_dream_metadata_invalid" />

        </service>



        <service

            android:name="com.android.server.dreams.TestDreamServiceWithNonexistentSettings"

            android:exported="false"

            android:label="Test Dream" >

            <intent-filter>

                <action android:name="android.service.dreams.DreamService" />

                <category android:name="android.intent.category.DEFAULT" />

            </intent-filter>

            <meta-data

                android:name="android.service.dream"

                android:resource="@xml/test_dream_metadata_nonexistent_settings" />

        </service>



        <service

            android:name="com.android.server.dreams.TestDreamServiceNoPackageNonexistentSettings"

            android:exported="false"

            android:label="Test Dream" >

            <intent-filter>

                <action android:name="android.service.dreams.DreamService" />

                <category android:name="android.intent.category.DEFAULT" />

            </intent-filter>

            <meta-data

                android:name="android.service.dream"

                android:resource="@xml/test_dream_metadata_nopackage_nonexistent_settings" />

        </service>



        <activity android:name=".TestDreamSettingsActivity">

        </activity>

    </application>



    <instrumentation android:name="androidx.test.runner.AndroidJUnitRunner"

services/tests/dreamservicetests/res/xml/test_dream_metadata_nonexistent_settings.xml

0 → 100644
+20 −0
Original line number Diff line number Diff line 
<!--

  ~ Copyright (C) 2024 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.

  -->



<!-- The settings activity does not exist, which is invalid. -->

<dream xmlns:android="http://schemas.android.com/apk/res/android"

    android:settingsActivity="com.android.frameworks.dreamservicetests/.TestDreamSettingsActivityNonexistent"

    android:showClockAndComplications="false"/>

services/tests/dreamservicetests/res/xml/test_dream_metadata_nopackage_nonexistent_settings.xml

0 → 100644
+20 −0
Original line number Diff line number Diff line 
<!--

  ~ Copyright (C) 2024 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.

  -->



<!-- The settings activity's ComponentName is invalid. -->

<dream xmlns:android="http://schemas.android.com/apk/res/android"

    android:settingsActivity="com.android.frameworks.dreamservicetests.TestDreamSettingsActivityNonexistentNoPackage"

    android:showClockAndComplications="false"/>

services/tests/dreamservicetests/src/com/android/server/dreams/DreamServiceTest.java

+22 −0
Original line number Diff line number Diff line
@@ -90,6 +90,28 @@ public class DreamServiceTest { 
        assertThat(metadata.dreamCategory).isEqualTo(DreamService.DREAM_CATEGORY_DEFAULT);

    }



    @Test

    public void testMetadataParsing_nonexistentSettingsActivity()

            throws PackageManager.NameNotFoundException {

        final String testDreamClassName =

                "com.android.server.dreams.TestDreamServiceWithNonexistentSettings";

        final DreamService.DreamMetadata metadata = getDreamMetadata(testDreamClassName);



        assertThat(metadata.settingsActivity).isNull();

        assertThat(metadata.dreamCategory).isEqualTo(DreamService.DREAM_CATEGORY_DEFAULT);

    }



    @Test

    public void testMetadataParsing_noPackage_nonexistentSettingsActivity()

            throws PackageManager.NameNotFoundException {

        final String testDreamClassName =

                "com.android.server.dreams.TestDreamServiceNoPackageNonexistentSettings";

        final DreamService.DreamMetadata metadata = getDreamMetadata(testDreamClassName);



        assertThat(metadata.settingsActivity).isNull();

        assertThat(metadata.dreamCategory).isEqualTo(DreamService.DREAM_CATEGORY_DEFAULT);

    }



    @Test

    public void testMetadataParsing_exceptionReading() {

        final PackageManager packageManager = Mockito.mock(PackageManager.class);