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

Commit 85ad9ee3 authored by Pinyao Ting's avatar Pinyao Ting
Browse files

Shortcut integration with AppSearch (Part 1) 

This CL includes the initial code change to integrate shortcuts with
AppSearch and provides a public api to allow publishers sharing access
to shortcuts with other apps.

Bug: 151359749
CTS-Coverage-Bug: 180558621
Test: manual
Change-Id: I08430dc3d49e4f2588c68c61561fffb2b248f4c9
parent 01af9eec

core/api/current.txt

+1 −0
Original line number Original line Diff line number Diff line
@@ -12893,6 +12893,7 @@ package android.content.pm { 
    method public void reportShortcutUsed(String);

    method public void reportShortcutUsed(String);

    method public boolean requestPinShortcut(@NonNull android.content.pm.ShortcutInfo, @Nullable android.content.IntentSender);

    method public boolean requestPinShortcut(@NonNull android.content.pm.ShortcutInfo, @Nullable android.content.IntentSender);

    method public boolean setDynamicShortcuts(@NonNull java.util.List<android.content.pm.ShortcutInfo>);

    method public boolean setDynamicShortcuts(@NonNull java.util.List<android.content.pm.ShortcutInfo>);

    method public void updateShortcutVisibility(@NonNull String, @Nullable byte[], boolean);

    method public boolean updateShortcuts(@NonNull java.util.List<android.content.pm.ShortcutInfo>);

    method public boolean updateShortcuts(@NonNull java.util.List<android.content.pm.ShortcutInfo>);

    field public static final int FLAG_MATCH_CACHED = 8; // 0x8

    field public static final int FLAG_MATCH_CACHED = 8; // 0x8

    field public static final int FLAG_MATCH_DYNAMIC = 2; // 0x2

    field public static final int FLAG_MATCH_DYNAMIC = 2; // 0x2

core/java/android/content/pm/IShortcutService.aidl

+3 −0
Original line number Original line Diff line number Diff line
@@ -78,4 +78,7 @@ interface IShortcutService { 
    ParceledListSlice getShortcuts(String packageName, int matchFlags, int userId);

    ParceledListSlice getShortcuts(String packageName, int matchFlags, int userId);





    void pushDynamicShortcut(String packageName, in ShortcutInfo shortcut, int userId);

    void pushDynamicShortcut(String packageName, in ShortcutInfo shortcut, int userId);



    void updateShortcutVisibility(String callingPkg, String packageName, in byte[] certificate,

            in boolean visible, int userId);

}
 
}
 
 No newline at end of file

core/java/android/content/pm/ShortcutManager.java

+17 −0
Original line number Original line Diff line number Diff line
@@ -39,6 +39,7 @@ import android.os.Parcel; 
import android.os.Parcelable;

import android.os.Parcelable;

import android.os.RemoteException;

import android.os.RemoteException;

import android.os.ServiceManager;

import android.os.ServiceManager;

import android.os.UserHandle;





import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.annotations.VisibleForTesting;
@@ -771,4 +772,20 @@ public class ShortcutManager { 
        }

        }

    }

    }





    /**

     * Granting another app the access to the shortcuts you own. You must provide the package name

     * and their SHA256 certificate digest in order to granting the access.

     *

     * Once granted, the other app can retain a copy of all the shortcuts you own when calling

     * {@link LauncherApps#getShortcuts(LauncherApps.ShortcutQuery, UserHandle)}.

     */

    public void updateShortcutVisibility(@NonNull final String packageName,

            @Nullable final byte[] certificate, final boolean visible) {

        try {

            mService.updateShortcutVisibility(mContext.getPackageName(), packageName, certificate,

                    visible, injectMyUserId());

        } catch (RemoteException e) {

            throw e.rethrowFromSystemServer();

        }

    }

}
 
}

services/core/java/com/android/server/pm/ShortcutPackage.java

+156 −0
Original line number Original line Diff line number Diff line
@@ -19,15 +19,22 @@ import android.annotation.NonNull; 
import android.annotation.Nullable;

import android.annotation.Nullable;

import android.annotation.UserIdInt;

import android.annotation.UserIdInt;

import android.app.Person;

import android.app.Person;

import android.app.appsearch.AppSearchManager;

import android.app.appsearch.AppSearchSession;

import android.app.appsearch.PackageIdentifier;

import android.app.appsearch.SetSchemaRequest;

import android.content.ComponentName;

import android.content.ComponentName;

import android.content.Intent;

import android.content.Intent;

import android.content.IntentFilter;

import android.content.IntentFilter;

import android.content.LocusId;

import android.content.LocusId;

import android.content.pm.AppSearchPerson;

import android.content.pm.AppSearchShortcutInfo;

import android.content.pm.PackageInfo;

import android.content.pm.PackageInfo;

import android.content.pm.ShortcutInfo;

import android.content.pm.ShortcutInfo;

import android.content.pm.ShortcutManager;

import android.content.pm.ShortcutManager;

import android.content.res.Resources;

import android.content.res.Resources;

import android.graphics.drawable.Icon;

import android.graphics.drawable.Icon;

import android.os.Binder;

import android.os.PersistableBundle;

import android.os.PersistableBundle;

import android.text.format.Formatter;

import android.text.format.Formatter;

import android.util.ArrayMap;

import android.util.ArrayMap;
@@ -39,9 +46,11 @@ import android.util.TypedXmlPullParser; 
import android.util.TypedXmlSerializer;

import android.util.TypedXmlSerializer;

import android.util.Xml;

import android.util.Xml;





import com.android.internal.annotations.GuardedBy;

import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.util.ArrayUtils;

import com.android.internal.util.ArrayUtils;

import com.android.internal.util.CollectionUtils;

import com.android.internal.util.CollectionUtils;

import com.android.internal.util.ConcurrentUtils;

import com.android.internal.util.Preconditions;

import com.android.internal.util.Preconditions;

import com.android.internal.util.XmlUtils;

import com.android.internal.util.XmlUtils;

import com.android.server.pm.ShortcutService.DumpFilter;

import com.android.server.pm.ShortcutService.DumpFilter;
@@ -64,8 +73,12 @@ import java.util.ArrayList; 
import java.util.Collections;

import java.util.Collections;

import java.util.Comparator;

import java.util.Comparator;

import java.util.List;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.Objects;

import java.util.Set;

import java.util.Set;

import java.util.concurrent.CountDownLatch;

import java.util.function.Consumer;

import java.util.function.Function;

import java.util.function.Predicate;

import java.util.function.Predicate;





/**

/**
@@ -155,6 +168,16 @@ class ShortcutPackage extends ShortcutPackageItem { 




    private long mLastKnownForegroundElapsedTime;

    private long mLastKnownForegroundElapsedTime;





    private final Object mLock = new Object();



    /**

     * All external packages that have gained access to the shortcuts from this package

     */

    private final Map<String, PackageIdentifier> mPackageIdentifiers = new ArrayMap<>(0);



    @GuardedBy("mLock")

    private AppSearchSession mAppSearchSession;



    private ShortcutPackage(ShortcutUser shortcutUser,

    private ShortcutPackage(ShortcutUser shortcutUser,

            int packageUserId, String packageName, ShortcutPackageInfo spi) {

            int packageUserId, String packageName, ShortcutPackageInfo spi) {

        super(shortcutUser, packageUserId, packageName,

        super(shortcutUser, packageUserId, packageName,
@@ -2140,6 +2163,15 @@ class ShortcutPackage extends ShortcutPackageItem { 
        }

        }

    }

    }





    void updateVisibility(String packageName, byte[] certificate, boolean visible) {

        if (visible) {

            mPackageIdentifiers.put(packageName, new PackageIdentifier(packageName, certificate));

        } else {

            mPackageIdentifiers.remove(packageName);

        }

        resetAppSearch(null);

    }



    private boolean verifyRanksSequential(List<ShortcutInfo> list) {

    private boolean verifyRanksSequential(List<ShortcutInfo> list) {

        boolean failed = false;

        boolean failed = false;
@@ -2153,4 +2185,128 @@ class ShortcutPackage extends ShortcutPackageItem { 
        }

        }

        return failed;

        return failed;

    }

    }



    private void runInAppSearch(

            Function<SearchSessionObservable, Consumer<AppSearchSession>>... observers) {

        if (mShortcutUser == null) {

            Slog.w(TAG, "shortcut user is null");

            return;

        }

        synchronized (mLock) {

            if (mAppSearchSession != null) {

                final CountDownLatch latch = new CountDownLatch(1);

                final long callingIdentity = Binder.clearCallingIdentity();

                try {

                    final SearchSessionObservable upstream =

                            new SearchSessionObservable(mAppSearchSession, latch);

                    for (Function<SearchSessionObservable, Consumer<AppSearchSession>> observer

                            : observers) {

                        upstream.map(observer);

                    }

                    upstream.next();

                } finally {

                    Binder.restoreCallingIdentity(callingIdentity);

                }

                ConcurrentUtils.waitForCountDownNoInterrupt(latch, 500,

                        "timeout accessing shortcut");

            } else {

                resetAppSearch(observers);

            }

        }

    }



    private void resetAppSearch(

            Function<SearchSessionObservable, Consumer<AppSearchSession>>... observers) {

        final CountDownLatch latch = new CountDownLatch(1);

        final AppSearchManager.SearchContext searchContext =

                new AppSearchManager.SearchContext.Builder()

                        .setDatabaseName(getPackageName()).build();

        mShortcutUser.runInAppSearch(searchContext, result -> {

            if (!result.isSuccess()) {

                Slog.e(TAG, "error getting search session during lazy init, "

                        + result.getErrorMessage());

                latch.countDown();

                return;

            }

            // TODO: Flatten callback chain with proper async framework

            final SearchSessionObservable upstream =

                    new SearchSessionObservable(result.getResultValue(), latch)

                            .map(this::setupSchema);

            if (observers != null) {

                for (Function<SearchSessionObservable, Consumer<AppSearchSession>> observer

                        : observers) {

                    upstream.map(observer);

                }

            }

            upstream.map(observable -> session -> {

                mAppSearchSession = session;

                observable.next();

            });

            upstream.next();

        });

        ConcurrentUtils.waitForCountDownNoInterrupt(latch, 1500,

                "timeout accessing shortcut during lazy initialization");

    }



    /**

     * creates the schema for shortcut in the database

     */

    private Consumer<AppSearchSession> setupSchema(SearchSessionObservable observable) {

        return session -> {

            SetSchemaRequest.Builder schemaBuilder = new SetSchemaRequest.Builder()

                            .addSchemas(AppSearchPerson.SCHEMA, AppSearchShortcutInfo.SCHEMA);

            for (PackageIdentifier pi : mPackageIdentifiers.values()) {

                schemaBuilder = schemaBuilder

                        .setSchemaTypeVisibilityForPackage(

                                AppSearchPerson.SCHEMA_TYPE, true, pi)

                        .setSchemaTypeVisibilityForPackage(

                                AppSearchShortcutInfo.SCHEMA_TYPE, true, pi);

            }

            session.setSchema(schemaBuilder.build(), mShortcutUser.mExecutor, result -> {

                if (!result.isSuccess()) {

                    observable.error("failed to instantiate app search schema: "

                            + result.getErrorMessage());

                    return;

                }

                observable.next();

            });

        };

    }



    /**

     * TODO: Replace this temporary implementation with proper async framework

     */

    private class SearchSessionObservable {



        final AppSearchSession mSession;

        final CountDownLatch mLatch;

        final ArrayList<Consumer<AppSearchSession>> mObservers = new ArrayList<>(1);



        SearchSessionObservable(@NonNull final AppSearchSession session,

                @NonNull final CountDownLatch latch) {

            mSession = session;

            mLatch = latch;

        }



        SearchSessionObservable map(

                Function<SearchSessionObservable, Consumer<AppSearchSession>> observer) {

            mObservers.add(observer.apply(this));

            return this;

        }



        void next() {

            if (mObservers.isEmpty()) {

                mLatch.countDown();

                return;

            }

            mObservers.remove(0).accept(mSession);

        }



        void error(@Nullable final String errorMessage) {

            if (errorMessage != null) {

                Slog.e(TAG, errorMessage);

            }

            mLatch.countDown();

        }

    }

}
 
}

services/core/java/com/android/server/pm/ShortcutService.java

+9 −0
Original line number Original line Diff line number Diff line
@@ -2149,6 +2149,15 @@ public class ShortcutService extends IShortcutService.Stub { 
        verifyStates();

        verifyStates();

    }

    }





    @Override

    public void updateShortcutVisibility(String callingPkg, String packageName, byte[] certificate,

            boolean visible, int userId) {

        synchronized (mLock) {

            getPackageShortcutsForPublisherLocked(callingPkg, userId)

                    .updateVisibility(packageName, certificate, visible);

        }

    }



    @Override

    @Override

    public boolean requestPinShortcut(String packageName, ShortcutInfo shortcut,

    public boolean requestPinShortcut(String packageName, ShortcutInfo shortcut,

            IntentSender resultIntent, int userId) {

            IntentSender resultIntent, int userId) {