main/java/com/google/android/setupcompat/PartnerCustomizationLayout.java

/*
 * Copyright 2018 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.google.android.setupcompat;

import android.annotation.TargetApi;
import android.app.Activity;
import android.content.Context;
import android.content.ContextWrapper;
import android.content.res.TypedArray;
import android.os.Build.VERSION;
import android.os.Build.VERSION_CODES;
import android.os.PersistableBundle;
import androidx.annotation.ColorInt;
import androidx.annotation.LayoutRes;
import android.util.AttributeSet;
import android.util.Log;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewStub;
import android.view.WindowManager;
import com.google.android.setupcompat.internal.PersistableBundles;
import com.google.android.setupcompat.internal.TemplateLayout;
import com.google.android.setupcompat.lifecycle.LifecycleFragment;
import com.google.android.setupcompat.logging.CustomEvent;
import com.google.android.setupcompat.logging.MetricKey;
import com.google.android.setupcompat.logging.SetupMetricsLogger;
import com.google.android.setupcompat.partnerconfig.PartnerConfig;
import com.google.android.setupcompat.partnerconfig.PartnerConfigHelper;
import com.google.android.setupcompat.template.FooterBarMixin;
import com.google.android.setupcompat.template.FooterButton;
import com.google.android.setupcompat.template.StatusBarMixin;
import com.google.android.setupcompat.template.SystemNavBarMixin;
import com.google.android.setupcompat.util.WizardManagerHelper;

/** A templatization layout with consistent style used in Setup Wizard or app itself. */
public class PartnerCustomizationLayout extends TemplateLayout {
  // Log tags can have at most 23 characters on N or before.
  private static final String TAG = "PartnerCustomizedLayout";

  private final boolean suwVersionSupportPartnerResource = isAtLeastQ();

  private boolean applyPartnerResource;
  private Activity activity;

  public PartnerCustomizationLayout(Context context) {
    this(context, 0, 0);
  }

  public PartnerCustomizationLayout(Context context, int template) {
    this(context, template, 0);
  }

  public PartnerCustomizationLayout(Context context, int template, int containerId) {
    super(context, template, containerId);
    init(null, R.attr.sucLayoutTheme);
  }

  public PartnerCustomizationLayout(Context context, AttributeSet attrs) {
    super(context, attrs);
    init(attrs, R.attr.sucLayoutTheme);
  }

  @TargetApi(VERSION_CODES.HONEYCOMB)
  public PartnerCustomizationLayout(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
    init(attrs, defStyleAttr);
  }

  private void init(AttributeSet attrs, int defStyleAttr) {
    activity = lookupActivityFromContext(getContext());

    boolean isSetupFlow = WizardManagerHelper.isAnySetupWizard(activity.getIntent());

    TypedArray a =
        getContext()
            .obtainStyledAttributes(
                attrs, R.styleable.SucPartnerCustomizationLayout, defStyleAttr, 0);

    boolean layoutFullscreen =
        a.getBoolean(R.styleable.SucPartnerCustomizationLayout_sucLayoutFullscreen, true);

    boolean usePartnerResource =
        a.getBoolean(R.styleable.SucPartnerCustomizationLayout_sucUsePartnerResource, true);
    a.recycle();

    if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP && layoutFullscreen) {
      setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
    }

    Log.i(
        TAG,
        "activity="
            + activity.getClass().getSimpleName()
            + ", isSetupFlow="
            + isSetupFlow
            + ", applyPartnerResource="
            + applyPartnerResource()
            + ", usePartnerResource="
            + usePartnerResource);

    if (suwVersionSupportPartnerResource && isSetupFlow && !applyPartnerResource()) {
      Log.w(TAG, "applyPartnerResource() should return true during setup wizard flow");
    }

    applyPartnerResource =
        suwVersionSupportPartnerResource
            && applyPartnerResource()
            && (isSetupFlow || usePartnerResource);
    registerMixin(
        StatusBarMixin.class,
        new StatusBarMixin(this, activity.getWindow(), attrs, defStyleAttr, applyPartnerResource));
    registerMixin(
        SystemNavBarMixin.class,
        new SystemNavBarMixin(this, activity.getWindow(), applyPartnerResource));
    registerMixin(
        FooterBarMixin.class, new FooterBarMixin(this, attrs, defStyleAttr, applyPartnerResource));

    getMixin(SystemNavBarMixin.class).applyPartnerCustomizations(attrs, defStyleAttr);

    // Override the FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS, FLAG_TRANSLUCENT_STATUS,
    // FLAG_TRANSLUCENT_NAVIGATION and SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN attributes of window forces
    // showing status bar and navigation bar.
    activity.getWindow().addFlags(WindowManager.LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS);
    activity.getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
    activity.getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);

    if (applyPartnerResource) {
      updateContentBackgroundColorWithPartnerConfig();
    }
  }

  @Override
  protected View onInflateTemplate(LayoutInflater inflater, int template) {
    if (template == 0) {
      template = R.layout.partner_customization_layout;
    }
    return inflateTemplate(inflater, 0, template);
  }

  @Override
  protected ViewGroup findContainer(int containerId) {
    if (containerId == 0) {
      containerId = R.id.suc_layout_content;
    }
    return super.findContainer(containerId);
  }

  @Override
  protected void onAttachedToWindow() {
    super.onAttachedToWindow();
    LifecycleFragment.attachNow(activity);
    getMixin(FooterBarMixin.class).onAttachedToWindow();
  }

  @Override
  protected void onDetachedFromWindow() {
    super.onDetachedFromWindow();
    if (suwVersionSupportPartnerResource
        && WizardManagerHelper.isAnySetupWizard(activity.getIntent())) {
      FooterBarMixin footerBarMixin = getMixin(FooterBarMixin.class);
      footerBarMixin.onDetachedFromWindow();
      FooterButton primaryButton = footerBarMixin.getPrimaryButton();
      FooterButton secondaryButton = footerBarMixin.getSecondaryButton();
      PersistableBundle primaryButtonMetrics =
          primaryButton != null
              ? primaryButton.getMetrics("PrimaryFooterButton")
              : PersistableBundle.EMPTY;
      PersistableBundle secondaryButtonMetrics =
          secondaryButton != null
              ? secondaryButton.getMetrics("SecondaryFooterButton")
              : PersistableBundle.EMPTY;

      PersistableBundle persistableBundle =
          PersistableBundles.mergeBundles(
              footerBarMixin.getLoggingMetrics(), primaryButtonMetrics, secondaryButtonMetrics);

      SetupMetricsLogger.logCustomEvent(
          getContext(),
          CustomEvent.create(
              MetricKey.get("SetupCompatMetrics", activity.getClass().getSimpleName()),
              persistableBundle));
    }
  }

  private static Activity lookupActivityFromContext(Context context) {
    if (context instanceof Activity) {
      return (Activity) context;
    } else if (context instanceof ContextWrapper) {
      return lookupActivityFromContext(((ContextWrapper) context).getBaseContext());
    } else {
      throw new IllegalArgumentException("Cannot find instance of Activity in parent tree");
    }
  }

  // TODO(b/127925696): remove the code for pre-release version of Android Q
  private static boolean isAtLeastQ() {
    return (VERSION.SDK_INT > VERSION_CODES.P)
        || (VERSION.CODENAME.length() == 1
            && VERSION.CODENAME.charAt(0) >= 'Q'
            && VERSION.CODENAME.charAt(0) <= 'Z');
  }

  /**
   * This method determines applying the partner resource regardless inside setup wizard flow or
   * not. It always returns true indicating applying partner resource inside setup wizard flow and
   * applying customized attributes outside setup wizard flow. Subclasses can override this method
   * to change applying flow. If Returns false, the layout forces applying customized attributes.
   */
  protected boolean applyPartnerResource() {
    return true;
  }

  /**
   * Sets the footer of the layout, which is at the bottom of the content area outside the scrolling
   * container. The footer can only be inflated once per instance of this layout.
   *
   * @param footer The layout to be inflated as footer.
   * @return The root of the inflated footer view.
   */
  public View inflateFooter(@LayoutRes int footer) {
    ViewStub footerStub = findManagedViewById(R.id.suc_layout_footer);
    footerStub.setLayoutResource(footer);
    return footerStub.inflate();
  }

  /** Returns if the current layout/activity applies partner customized configurations or not. */
  protected boolean shouldApplyPartnerResource() {
    return applyPartnerResource;
  }

  /** Updates the background color of this layout with the partner-customizable background color. */
  private void updateContentBackgroundColorWithPartnerConfig() {
    @ColorInt
    int color =
        PartnerConfigHelper.get(getContext())
            .getColor(getContext(), PartnerConfig.CONFIG_LAYOUT_BACKGROUND_COLOR);
    this.getRootView().setBackgroundColor(color);
  }
}