ShortcutInfoChangeListenerImpl.java
/*
* Copyright 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 androidx.core.google.shortcuts;
import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP;
import static androidx.core.google.shortcuts.utils.ShortcutUtils.CAPABILITY_PARAM_SEPARATOR;
import android.content.Context;
import android.os.Build;
import android.os.PersistableBundle;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RequiresApi;
import androidx.annotation.RestrictTo;
import androidx.annotation.VisibleForTesting;
import androidx.appsearch.app.GenericDocument;
import androidx.appsearch.app.ShortcutAdapter;
import androidx.core.content.pm.ShortcutInfoChangeListener;
import androidx.core.content.pm.ShortcutInfoCompat;
import androidx.core.google.shortcuts.builders.CapabilityBuilder;
import androidx.core.google.shortcuts.builders.ParameterBuilder;
import androidx.core.google.shortcuts.builders.ShortcutBuilder;
import androidx.core.google.shortcuts.converters.AppSearchDocumentConverter;
import androidx.core.google.shortcuts.converters.AppSearchDocumentConverterFactory;
import androidx.core.google.shortcuts.utils.EntityUriUtils;
import androidx.core.google.shortcuts.utils.ShortcutUtils;
import androidx.core.graphics.drawable.IconCompat;
import com.google.android.gms.appindex.Action;
import com.google.android.gms.appindex.AppIndex;
import com.google.android.gms.appindex.Indexable;
import com.google.android.gms.appindex.UserActions;
import com.google.crypto.tink.KeysetHandle;
import java.util.ArrayList;
import java.util.List;
/**
* Provides a listener on changes to shortcuts in ShortcutInfoCompat.
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public class ShortcutInfoChangeListenerImpl extends ShortcutInfoChangeListener {
private final Context mContext;
private final AppIndex mFirebaseAppIndex;
private final UserActions mFirebaseUserActions;
@Nullable private final KeysetHandle mKeysetHandle;
/**
* Create an instance of {@link ShortcutInfoChangeListenerImpl}.
*
* @param context The application context.
* @return {@link ShortcutInfoChangeListenerImpl}.
*/
@NonNull
public static ShortcutInfoChangeListenerImpl getInstance(@NonNull Context context) {
return new ShortcutInfoChangeListenerImpl(context, AppIndex.getInstance(context),
UserActions.getInstance(context),
ShortcutUtils.getOrCreateShortcutKeysetHandle(context));
}
@VisibleForTesting
ShortcutInfoChangeListenerImpl(Context context, AppIndex firebaseAppIndex,
UserActions firebaseUserActions, @Nullable KeysetHandle keysetHandle) {
mContext = context;
mFirebaseAppIndex = firebaseAppIndex;
mFirebaseUserActions = firebaseUserActions;
mKeysetHandle = keysetHandle;
}
/**
* Called when shortcut is added by {@link androidx.core.content.pm.ShortcutManagerCompat}.
*
* @param shortcuts list of shortcuts added
*/
@Override
public void onShortcutAdded(@NonNull List<ShortcutInfoCompat> shortcuts) {
List<Indexable> indexables = new ArrayList<>();
// A shortcut can either be an entity shortcut, or capability-instance shortcuts. Entity
// shortcuts will be indexed under their respective schema type, and capability-instance
// shortcuts will be indexed in the general shortcut corpus.
for (ShortcutInfoCompat shortcut : shortcuts) {
GenericDocument entity = null;
// ShortcutAdapter is only available for Lollipop and above.
if (android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
entity = ShortcutAdapter.extractDocument(shortcut);
}
if (entity == null) {
// API level < Lollipop, or Shortcut might be a capability-instance shortcut.
ShortcutBuilder shortcutBuilder = buildShortcutIndexable(shortcut);
// Capability-instance shortcuts may contain references to entity shortcuts. If
// that's the case, report usage for those entity shortcuts.
// TODO (b/207161241): use capability binding api directly from shortcut once it's
// available.
maybeReportEntityUsage(shortcutBuilder);
indexables.add(shortcutBuilder.build());
} else {
// Shortcut is an entity shortcut.
AppSearchDocumentConverter converter =
AppSearchDocumentConverterFactory.getConverter(entity.getSchemaType());
Indexable.Builder entityIndexableBuilder =
converter.convertGenericDocument(mContext, entity);
indexables.add(entityIndexableBuilder.build());
}
}
mFirebaseAppIndex.update(indexables.toArray(new Indexable[0]));
}
/**
* Called when shortcut is updated by {@link androidx.core.content.pm.ShortcutManagerCompat}.
*
* @param shortcuts list of shortcuts updated
*/
@Override
public void onShortcutUpdated(@NonNull List<ShortcutInfoCompat> shortcuts) {
onShortcutAdded(shortcuts);
}
/**
* Called when shortcut is removed by {@link androidx.core.content.pm.ShortcutManagerCompat}.
*
* @param shortcutIds list of shortcut ids removed
*/
@Override
public void onShortcutRemoved(@NonNull List<String> shortcutIds) {
List<String> urls = new ArrayList<>();
for (String shortcutId : shortcutIds) {
urls.add(ShortcutUtils.getIndexableUrl(mContext, shortcutId));
}
mFirebaseAppIndex.remove(urls.toArray(new String[0]));
}
/**
* Called when shortcut is used by {@link androidx.core.content.pm.ShortcutManagerCompat}.
*
* @param shortcutIds list of shortcut ids used
*/
@Override
public void onShortcutUsageReported(@NonNull List<String> shortcutIds) {
for (String shortcutId : shortcutIds) {
// Actions reported here is only on-device due to setUpload(false) in buildAction
// method.
mFirebaseUserActions.end(buildAction(ShortcutUtils.getIndexableUrl(mContext,
shortcutId)));
}
}
/**
* Called when all shortcuts are removed
* by {@link androidx.core.content.pm.ShortcutManagerCompat}.
*/
@Override
public void onAllShortcutsRemoved() {
mFirebaseAppIndex.removeAll();
}
/**
* If the shortcut has references to entity URIs, then report usage for those URIs.
*/
private void maybeReportEntityUsage(@NonNull ShortcutBuilder shortcutBuilder) {
CapabilityBuilder[] capabilities = shortcutBuilder.getCapabilities();
if (capabilities == null) {
return;
}
for (CapabilityBuilder capability : capabilities) {
ParameterBuilder[] parameters = capability.getParameters();
if (parameters == null) {
continue;
}
for (ParameterBuilder parameter : parameters) {
String[] values = parameter.getValues();
if (values == null) {
continue;
}
for (String value : values) {
String entityId = EntityUriUtils.getEntityId(value);
if (entityId != null) {
mFirebaseUserActions.end(
buildAction(ShortcutUtils.getIndexableUrl(mContext, entityId)));
}
}
}
}
}
@NonNull
private Action buildAction(@NonNull String url) {
return new Action.Builder(Action.Builder.VIEW_ACTION)
// Empty label as placeholder.
.setObject("", url)
.build();
}
@NonNull
private ShortcutBuilder buildShortcutIndexable(@NonNull ShortcutInfoCompat shortcut) {
String url = ShortcutUtils.getIndexableUrl(mContext, shortcut.getId());
String shortcutUrl = ShortcutUtils.getIndexableShortcutUrl(mContext, shortcut.getIntent(),
mKeysetHandle);
String name = shortcut.getShortLabel().toString();
ShortcutBuilder shortcutBuilder = new ShortcutBuilder()
.setId(shortcut.getId())
.setUrl(url)
.setShortcutLabel(name)
.setShortcutUrl(shortcutUrl);
if (shortcut.getLongLabel() != null) {
shortcutBuilder.setShortcutDescription(shortcut.getLongLabel().toString());
}
// Add capability binding
if (Build.VERSION.SDK_INT >= 21) {
if (shortcut.getCategories() != null) {
List<CapabilityBuilder> capabilityList = new ArrayList<>();
for (String capability : shortcut.getCategories()) {
if (!ShortcutUtils.isAppActionCapability(capability)) {
continue;
}
capabilityList.add(Api21Impl.buildCapability(capability, shortcut.getExtras()));
}
if (!capabilityList.isEmpty()) {
shortcutBuilder
.setCapability(capabilityList.toArray(new CapabilityBuilder[0]));
}
}
}
// Add icon
if (shortcut.getIcon() != null) {
IconCompat icon = shortcut.getIcon();
if (icon.getType() == IconCompat.TYPE_URI_ADAPTIVE_BITMAP
|| icon.getType() == IconCompat.TYPE_URI) {
// Assume the uri is public and can be opened by Google apps
shortcutBuilder.setImage(icon.getUri().toString());
}
}
// By default, the indexable will be saved only on-device.
return shortcutBuilder;
}
@RequiresApi(21)
private static class Api21Impl {
@NonNull
static CapabilityBuilder buildCapability(@NonNull String capability,
@Nullable PersistableBundle shortcutInfoExtras) {
CapabilityBuilder capabilityBuilder = new CapabilityBuilder()
.setName(capability);
if (shortcutInfoExtras == null) {
return capabilityBuilder;
}
String[] params = shortcutInfoExtras.getStringArray(capability);
if (params == null) {
return capabilityBuilder;
}
List<ParameterBuilder> parameterBuilders = new ArrayList<>();
for (String param : params) {
ParameterBuilder parameterBuilder =
new ParameterBuilder()
.setName(param);
String capabilityParamKey = capability + CAPABILITY_PARAM_SEPARATOR + param;
String[] values = shortcutInfoExtras.getStringArray(capabilityParamKey);
if (values == null || values.length == 0) {
// ignore this parameter since no values were given
continue;
}
parameterBuilder.setValue(values);
parameterBuilders.add(parameterBuilder);
}
if (parameterBuilders.size() > 0) {
capabilityBuilder
.setParameter(parameterBuilders.toArray(new ParameterBuilder[0]));
}
return capabilityBuilder;
}
private Api21Impl() {}
}
}