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

Commit f990dfa1 authored by Arc Wang's avatar Arc Wang
Browse files

[Wi-Fi] Branch WifiDialog files for WifiTracker2 development

Add these files:

  WifiConfigController2.java
  WifiConfigUiBase2.java
  WifiDialog2.java

  WifiConfigController2Test.java
  WifiDialog2Test.java

Bug: 146407136
Test: compile
Change-Id: I0689ae8ddee4f35e3bc104fd0b2e94eb8f689630
parent 74d79b5c
Loading
Loading
Loading
Loading
+1792 −0

File added.

Preview size limit exceeded, changes collapsed.

+107 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.wifi;

import android.content.Context;
import android.view.LayoutInflater;
import android.widget.Button;

/**
 * Foundation interface glues between Activities and UIs like {@link WifiDialog2}.
 */
public interface WifiConfigUiBase2 {

    /**
     * Viewing mode for a Wi-Fi access point. Data is displayed in non-editable mode.
     */
    int MODE_VIEW = 0;
    /**
     * Connect mode. Data is displayed in editable mode, and a connect button will be shown.
     */
    int MODE_CONNECT = 1;
    /**
     * Modify mode. All data is displayed in editable fields, and a "save" button is shown instead
     * of "connect". Clients are expected to only save but not connect to the access point in this
     * mode.
     */
    int MODE_MODIFY = 2;

    /**
     * UI like {@link WifiDialog} overrides to provide {@link Context} to controller.
     */
    Context getContext();

    /**
     * {@link WifiConfigController2} share the logic for controlling buttons, text fields, etc.
     */
    WifiConfigController2 getController();

    /**
     * UI like {@link WifiDialog} overrides to provide {@link LayoutInflater} to controller.
     */
    LayoutInflater getLayoutInflater();

    /**
     * One of MODE_VIEW, MODE_CONNECT and MODE_MODIFY of the UI like {@link WifiDialog}.
     */
    int getMode();

    /**
     * For controller to dispatch submit event to host UI and UI like {@link WifiDialog}.
     */
    void dispatchSubmit();

    /**
     * UI like {@link WifiDialog} overrides to set title.
     */
    void setTitle(int id);

    /**
     * UI like {@link WifiDialog} overrides to set title.
     */
    void setTitle(CharSequence title);

    /**
     * UI like {@link WifiDialog} overrides to set submit button text.
     */
    void setSubmitButton(CharSequence text);

    /**
     * UI like {@link WifiDialog} overrides to set forget button text.
     */
    void setForgetButton(CharSequence text);

    /**
     * UI like {@link WifiDialog} overrides to set cancel button text.
     */
    void setCancelButton(CharSequence text);

    /**
     * UI like {@link WifiDialog} overrides to get submit button.
     */
    Button getSubmitButton();

    /**
     * UI like {@link WifiDialog} overrides to get forget button.
     */
    Button getForgetButton();

    /**
     * UI like {@link WifiDialog} overrides to get cancel button.
     */
    Button getCancelButton();
}
+216 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.wifi;

import android.annotation.StyleRes;
import android.content.Context;
import android.content.DialogInterface;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.ImageButton;
import android.widget.TextView;

import androidx.appcompat.app.AlertDialog;

import com.android.settings.R;
import com.android.settingslib.RestrictedLockUtils;
import com.android.settingslib.RestrictedLockUtilsInternal;
import com.android.settingslib.wifi.AccessPoint;

/**
 * Dialog for users to edit a Wi-Fi network.
 */
public class WifiDialog2 extends AlertDialog implements WifiConfigUiBase2,
        DialogInterface.OnClickListener {

    /**
     * Host UI component of WifiDialog2 can receive callbacks by this interface.
     */
    public interface WifiDialog2Listener {
        /**
         * To forget the Wi-Fi network.
         */
        default void onForget(WifiDialog2 dialog) {
        }

        /**
         * To save the Wi-Fi network.
         */
        default void onSubmit(WifiDialog2 dialog) {
        }

        /**
         * To trigger Wi-Fi QR code scanner.
         */
        default void onScan(WifiDialog2 dialog, String ssid) {
        }
    }

    private static final int BUTTON_SUBMIT = DialogInterface.BUTTON_POSITIVE;
    private static final int BUTTON_FORGET = DialogInterface.BUTTON_NEUTRAL;

    private final int mMode;
    private final WifiDialog2Listener mListener;
    private final AccessPoint mAccessPoint;

    private View mView;
    private WifiConfigController2 mController;
    private boolean mHideSubmitButton;

    /**
     * Creates a WifiDialog2 with no additional style. It displays as a dialog above the current
     * view.
     */
    public static WifiDialog2 createModal(Context context, WifiDialog2Listener listener,
            AccessPoint accessPoint, int mode) {
        return new WifiDialog2(context, listener, accessPoint, mode, 0 /* style */,
                mode == WifiConfigUiBase2.MODE_VIEW /* hideSubmitButton */);
    }

    /**
     * Creates a WifiDialog2 with customized style. It displays as a dialog above the current
     * view.
     */
    public static WifiDialog2 createModal(Context context, WifiDialog2Listener listener,
            AccessPoint accessPoint, int mode, @StyleRes int style) {
        return new WifiDialog2(context, listener, accessPoint, mode, style,
                mode == WifiConfigUiBase2.MODE_VIEW /* hideSubmitButton */);
    }

    /* package */ WifiDialog2(Context context, WifiDialog2Listener listener,
                AccessPoint accessPoint, int mode, @StyleRes int style, boolean hideSubmitButton) {
        super(context, style);
        mMode = mode;
        mListener = listener;
        mAccessPoint = accessPoint;
        mHideSubmitButton = hideSubmitButton;
    }

    @Override
    public WifiConfigController2 getController() {
        return mController;
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        mView = getLayoutInflater().inflate(R.layout.wifi_dialog, /* root */ null);
        setView(mView);
        mController = new WifiConfigController2(this, mView, mAccessPoint, mMode);
        super.onCreate(savedInstanceState);

        if (mHideSubmitButton) {
            mController.hideSubmitButton();
        } else {
            /* During creation, the submit button can be unavailable to determine
             * visibility. Right after creation, update button visibility */
            mController.enableSubmitIfAppropriate();
        }

        if (mAccessPoint == null) {
            mController.hideForgetButton();
        }
    }

    @Override
    protected void onStart() {
        final ImageButton ssidScannerButton = findViewById(R.id.ssid_scanner_button);
        if (mHideSubmitButton) {
            ssidScannerButton.setVisibility(View.GONE);
            return;
        }

        View.OnClickListener onClickScannerButtonListener = v -> {
            if (mListener == null) {
                return;
            }

            final TextView ssidEditText = findViewById(R.id.ssid);
            final String ssid = ssidEditText.getText().toString();
            mListener.onScan(/* WifiDialog2 */ this, ssid);
        };
        ssidScannerButton.setOnClickListener(onClickScannerButtonListener);
    }

    @Override
    public void onRestoreInstanceState(Bundle savedInstanceState) {
        super.onRestoreInstanceState(savedInstanceState);
        mController.updatePassword();
    }

    @Override
    public void dispatchSubmit() {
        if (mListener != null) {
            mListener.onSubmit(this);
        }
        dismiss();
    }

    @Override
    public void onClick(DialogInterface dialogInterface, int id) {
        if (mListener != null) {
            switch (id) {
                case BUTTON_SUBMIT:
                    mListener.onSubmit(this);
                    break;
                case BUTTON_FORGET:
                    if (WifiUtils.isNetworkLockedDown(getContext(), mAccessPoint.getConfig())) {
                        RestrictedLockUtils.sendShowAdminSupportDetailsIntent(getContext(),
                                RestrictedLockUtilsInternal.getDeviceOwner(getContext()));
                        return;
                    }
                    mListener.onForget(this);
                    break;
            }
        }
    }

    @Override
    public int getMode() {
        return mMode;
    }

    @Override
    public Button getSubmitButton() {
        return getButton(BUTTON_SUBMIT);
    }

    @Override
    public Button getForgetButton() {
        return getButton(BUTTON_FORGET);
    }

    @Override
    public Button getCancelButton() {
        return getButton(BUTTON_NEGATIVE);
    }

    @Override
    public void setSubmitButton(CharSequence text) {
        setButton(BUTTON_SUBMIT, text, this);
    }

    @Override
    public void setForgetButton(CharSequence text) {
        setButton(BUTTON_FORGET, text, this);
    }

    @Override
    public void setCancelButton(CharSequence text) {
        setButton(BUTTON_NEGATIVE, text, this);
    }
}
+554 −0

File added.

Preview size limit exceeded, changes collapsed.

+73 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.wifi;

import static com.google.common.truth.Truth.assertThat;

import android.content.Context;

import com.android.settings.R;
import com.android.settings.testutils.shadow.ShadowEntityHeaderController;
import com.android.settings.wifi.WifiDialog2.WifiDialog2Listener;
import com.android.settingslib.wifi.AccessPoint;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;

@RunWith(RobolectricTestRunner.class)
@Config(shadows = ShadowEntityHeaderController.class)
public class WifiDialog2Test {
    @Mock private AccessPoint mMockAccessPoint;

    private Context mContext = RuntimeEnvironment.application;

    private WifiDialog2Listener mListener = new WifiDialog2Listener() {};

    @Before
    public void setUp() {
        MockitoAnnotations.initMocks(this);
    }

    @Test
    public void createModal_usesDefaultTheme() {
        WifiDialog2 modal = WifiDialog2
                .createModal(mContext, mListener, mMockAccessPoint, WifiConfigUiBase2.MODE_CONNECT);

        WifiDialog2 wifiDialog2 = new WifiDialog2(mContext, mListener, mMockAccessPoint,
                WifiConfigUiBase2.MODE_CONNECT, 0 /* style */, false /* hideSubmitButton */);
        assertThat(modal.getContext().getThemeResId())
                .isEqualTo(wifiDialog2.getContext().getThemeResId());
    }

    @Test
    public void createModal_whenSetTheme_shouldBeCustomizedTheme() {
        WifiDialog2 modal = WifiDialog2.createModal(mContext, mListener, mMockAccessPoint,
                WifiConfigUiBase2.MODE_CONNECT, R.style.SuwAlertDialogThemeCompat_Light);

        WifiDialog2 wifiDialog2 = new WifiDialog2(mContext, mListener, mMockAccessPoint,
                WifiConfigUiBase2.MODE_CONNECT, R.style.SuwAlertDialogThemeCompat_Light,
                        false /* hideSubmitButton */);
        assertThat(modal.getContext().getThemeResId())
                .isEqualTo(wifiDialog2.getContext().getThemeResId());
    }
}