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

Commit a2e45f1e authored by Vadim Caen's avatar Vadim Caen
Browse files

Prevent callback registration when back flag is disabled 

When the enableOnBackInvokedCallback is set to false (or not set),
registering an OnBackInvokedCallback should be a no-op to avoid
overriding the default compat callback.

Test: Manual testing registering a callback on an app with the flag
disabled and doing a back gesture. Currently we don't have test
executing a back gesture so automated tests are not possible

Bug: 235206960

Change-Id: I54d843f11130a78ed5a68cbe4722e601a2086ee1
Merged-In: I54d843f11130a78ed5a68cbe4722e601a2086ee1
(cherry picked from commit aa48dc3c)
parent 41bcf680

core/java/android/app/Dialog.java

+0 −2
Original line number Diff line number Diff line
@@ -1482,8 +1482,6 @@ public class Dialog implements DialogInterface, Window.Callback, 
    /**

     * Returns the {@link OnBackInvokedDispatcher} instance associated with the window that this

     * dialog is attached to.

     *

     * Returns null if the dialog is not attached to a window with a decor.

     */

    @NonNull

    public OnBackInvokedDispatcher getOnBackInvokedDispatcher() {

core/java/android/inputmethodservice/InputMethodService.java

+2 −1
Original line number Diff line number Diff line
@@ -135,6 +135,7 @@ import android.widget.FrameLayout; 
import android.widget.ImageButton;

import android.widget.LinearLayout;

import android.widget.TextView;

import android.window.CompatOnBackInvokedCallback;

import android.window.ImeOnBackInvokedDispatcher;

import android.window.OnBackInvokedCallback;

import android.window.OnBackInvokedDispatcher;
@@ -350,7 +351,7 @@ public class InputMethodService extends AbstractInputMethodService { 
    private RingBuffer<MotionEvent> mPendingEvents;

    private ImeOnBackInvokedDispatcher mImeDispatcher;

    private Boolean mBackCallbackRegistered = false;

    private final OnBackInvokedCallback mCompatBackCallback = this::compatHandleBack;

    private final CompatOnBackInvokedCallback mCompatBackCallback = this::compatHandleBack;



    /**

     * Returns whether {@link InputMethodService} is responsible for rendering the back button and

core/java/android/view/ViewRootImpl.java

+5 −10
Original line number Diff line number Diff line
@@ -196,6 +196,7 @@ import android.view.contentcapture.MainContentCaptureSession; 
import android.view.inputmethod.InputMethodManager;

import android.widget.Scroller;

import android.window.ClientWindowFrames;

import android.window.CompatOnBackInvokedCallback;

import android.window.OnBackInvokedCallback;

import android.window.OnBackInvokedDispatcher;

import android.window.SurfaceSyncer;
@@ -339,13 +340,12 @@ public final class ViewRootImpl implements ViewParent, 
    /**

     * The top level {@link OnBackInvokedDispatcher}.

     */

    private final WindowOnBackInvokedDispatcher mOnBackInvokedDispatcher =

            new WindowOnBackInvokedDispatcher();

    private final WindowOnBackInvokedDispatcher mOnBackInvokedDispatcher;

    /**

     * Compatibility {@link OnBackInvokedCallback} that dispatches KEYCODE_BACK events

     * to view root for apps using legacy back behavior.

     */

    private OnBackInvokedCallback mCompatOnBackInvokedCallback;

    private CompatOnBackInvokedCallback mCompatOnBackInvokedCallback;



    /**

     * Callback for notifying about global configuration changes.
@@ -959,6 +959,8 @@ public final class ViewRootImpl implements ViewParent, 
        mFastScrollSoundEffectsEnabled = audioManager.areNavigationRepeatSoundEffectsEnabled();



        mScrollCaptureRequestTimeout = SCROLL_CAPTURE_REQUEST_TIMEOUT_MILLIS;

        mOnBackInvokedDispatcher = new WindowOnBackInvokedDispatcher(

                context.getApplicationInfo().isOnBackInvokedCallbackEnabled());

    }



    public static void addFirstDrawHandler(Runnable callback) {
@@ -10836,13 +10838,6 @@ public final class ViewRootImpl implements ViewParent, 
                OnBackInvokedDispatcher.PRIORITY_DEFAULT, mCompatOnBackInvokedCallback);

    }



    private void unregisterCompatOnBackInvokedCallback() {

        if (mCompatOnBackInvokedCallback != null) {

            mOnBackInvokedDispatcher.unregisterOnBackInvokedCallback(mCompatOnBackInvokedCallback);

            mCompatOnBackInvokedCallback = null;

        }

    }



    @Override

    public void setTouchableRegion(Region r) {

        if (r != null) {

core/java/android/window/CompatOnBackInvokedCallback.java

0 → 100644
+30 −0
Original line number Diff line number Diff line 
/*

 * 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 android.window;



/**

 * Marker interface for {@link OnBackInvokedCallback} used for backward compatibility between the

 * new system back and the old back event dispatching. Callbacks implementing this interface are

 * allowed to be registered even if <code>enableOnbackInvoked</code> is set to false in the

 * application manifest.

 * @hide

 */

public interface CompatOnBackInvokedCallback extends OnBackInvokedCallback{



    @Override

    void onBackInvoked();

}

core/java/android/window/ProxyOnBackInvokedDispatcher.java

+8 −4
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ import android.annotation.NonNull; 
import android.annotation.Nullable;

import android.util.Log;

import android.util.Pair;

import android.window.WindowOnBackInvokedDispatcher.Checker;



import java.util.ArrayList;

import java.util.List;
@@ -50,6 +51,11 @@ public class ProxyOnBackInvokedDispatcher implements OnBackInvokedDispatcher { 
    private final Object mLock = new Object();

    private OnBackInvokedDispatcher mActualDispatcher = null;

    private ImeOnBackInvokedDispatcher mImeDispatcher;

    private final Checker mChecker;



    public ProxyOnBackInvokedDispatcher(boolean applicationCallBackEnabled) {

        mChecker = new Checker(applicationCallBackEnabled);

    }



    @Override

    public void registerOnBackInvokedCallback(
@@ -58,12 +64,10 @@ public class ProxyOnBackInvokedDispatcher implements OnBackInvokedDispatcher { 
            Log.v(TAG, String.format("Proxy register %s. mActualDispatcher=%s", callback,

                    mActualDispatcher));

        }

        if (priority < 0) {

            throw new IllegalArgumentException("Application registered OnBackInvokedCallback "

                    + "cannot have negative priority. Priority: " + priority);

        }

        if (mChecker.checkApplicationCallbackRegistration(priority, callback)) {

            registerOnBackInvokedCallbackUnchecked(callback, priority);

        }

    }



    @Override

    public void registerSystemOnBackInvokedCallback(@NonNull OnBackInvokedCallback callback) {