250 lines
13 KiB
Kotlin
250 lines
13 KiB
Kotlin
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
package org.mozilla.fenix.home.sessioncontrol
|
|
|
|
import android.content.Context
|
|
import android.view.LayoutInflater
|
|
import android.view.View
|
|
import android.view.ViewGroup
|
|
import androidx.annotation.DrawableRes
|
|
import androidx.annotation.LayoutRes
|
|
import androidx.annotation.StringRes
|
|
import androidx.recyclerview.widget.DiffUtil
|
|
import androidx.recyclerview.widget.ListAdapter
|
|
import androidx.recyclerview.widget.RecyclerView
|
|
import kotlinx.android.synthetic.main.tab_list_row.*
|
|
import mozilla.components.feature.media.state.MediaState
|
|
import mozilla.components.feature.tab.collections.TabCollection
|
|
import mozilla.components.feature.top.sites.TopSite
|
|
import org.mozilla.fenix.home.OnboardingState
|
|
import org.mozilla.fenix.home.Tab
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.CollectionHeaderViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.CollectionViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.NoContentMessageViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.PrivateBrowsingDescriptionViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.SaveTabGroupViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.TabHeaderViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.TabInCollectionViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.TabViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.TopSiteViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingAutomaticSignInViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingFinishViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingHeaderViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingManualSignInViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingPrivacyNoticeViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingPrivateBrowsingViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingSectionHeaderViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingThemePickerViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingToolbarPositionPickerViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingTrackingProtectionViewHolder
|
|
import org.mozilla.fenix.home.sessioncontrol.viewholders.onboarding.OnboardingWhatsNewViewHolder
|
|
|
|
import mozilla.components.feature.tab.collections.Tab as ComponentTab
|
|
|
|
sealed class AdapterItem(@LayoutRes val viewType: Int) {
|
|
data class TabHeader(val isPrivate: Boolean, val hasTabs: Boolean) : AdapterItem(TabHeaderViewHolder.LAYOUT_ID)
|
|
data class TabItem(val tab: Tab) : AdapterItem(TabViewHolder.LAYOUT_ID) {
|
|
override fun sameAs(other: AdapterItem) = other is TabItem && tab.sessionId == other.tab.sessionId
|
|
|
|
// Tell the adapter exactly what values have changed so it only has to draw those
|
|
override fun getChangePayload(newItem: AdapterItem): Any? {
|
|
(newItem as TabItem).let {
|
|
val shouldUpdateFavicon =
|
|
newItem.tab.url != this.tab.url || newItem.tab.icon != this.tab.icon
|
|
val shouldUpdateHostname = newItem.tab.hostname != this.tab.hostname
|
|
val shouldUpdateTitle = newItem.tab.title != this.tab.title
|
|
val shouldUpdateSelected = newItem.tab.selected != this.tab.selected
|
|
val shouldUpdateMediaState = newItem.tab.mediaState != this.tab.mediaState
|
|
|
|
return AdapterItemDiffCallback.TabChangePayload(
|
|
tab = newItem.tab,
|
|
shouldUpdateFavicon = shouldUpdateFavicon,
|
|
shouldUpdateHostname = shouldUpdateHostname,
|
|
shouldUpdateTitle = shouldUpdateTitle,
|
|
shouldUpdateSelected = shouldUpdateSelected,
|
|
shouldUpdateMediaState = shouldUpdateMediaState
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
data class TopSiteList(val topSites: List<TopSite>) : AdapterItem(TopSiteViewHolder.LAYOUT_ID)
|
|
|
|
object SaveTabGroup : AdapterItem(SaveTabGroupViewHolder.LAYOUT_ID)
|
|
|
|
object PrivateBrowsingDescription : AdapterItem(PrivateBrowsingDescriptionViewHolder.LAYOUT_ID)
|
|
data class NoContentMessage(
|
|
@DrawableRes val icon: Int,
|
|
@StringRes val header: Int,
|
|
@StringRes val description: Int
|
|
) : AdapterItem(NoContentMessageViewHolder.LAYOUT_ID)
|
|
|
|
object CollectionHeader : AdapterItem(CollectionHeaderViewHolder.LAYOUT_ID)
|
|
data class CollectionItem(
|
|
val collection: TabCollection,
|
|
val expanded: Boolean,
|
|
val sessionHasOpenTabs: Boolean
|
|
) : AdapterItem(CollectionViewHolder.LAYOUT_ID) {
|
|
override fun sameAs(other: AdapterItem) = other is CollectionItem && collection.id == other.collection.id
|
|
}
|
|
data class TabInCollectionItem(
|
|
val collection: TabCollection,
|
|
val tab: ComponentTab,
|
|
val isLastTab: Boolean
|
|
) : AdapterItem(TabInCollectionViewHolder.LAYOUT_ID) {
|
|
override fun sameAs(other: AdapterItem) = other is TabInCollectionItem && tab.id == other.tab.id
|
|
}
|
|
|
|
object OnboardingHeader : AdapterItem(OnboardingHeaderViewHolder.LAYOUT_ID)
|
|
data class OnboardingSectionHeader(
|
|
val labelBuilder: (Context) -> String
|
|
) : AdapterItem(OnboardingSectionHeaderViewHolder.LAYOUT_ID) {
|
|
override fun sameAs(other: AdapterItem) = other is OnboardingSectionHeader && labelBuilder == other.labelBuilder
|
|
}
|
|
object OnboardingManualSignIn : AdapterItem(OnboardingManualSignInViewHolder.LAYOUT_ID)
|
|
data class OnboardingAutomaticSignIn(
|
|
val state: OnboardingState.SignedOutCanAutoSignIn
|
|
) : AdapterItem(OnboardingAutomaticSignInViewHolder.LAYOUT_ID)
|
|
object OnboardingThemePicker : AdapterItem(OnboardingThemePickerViewHolder.LAYOUT_ID)
|
|
object OnboardingTrackingProtection : AdapterItem(OnboardingTrackingProtectionViewHolder.LAYOUT_ID)
|
|
object OnboardingPrivateBrowsing : AdapterItem(OnboardingPrivateBrowsingViewHolder.LAYOUT_ID)
|
|
object OnboardingPrivacyNotice : AdapterItem(OnboardingPrivacyNoticeViewHolder.LAYOUT_ID)
|
|
object OnboardingFinish : AdapterItem(OnboardingFinishViewHolder.LAYOUT_ID)
|
|
object OnboardingToolbarPositionPicker : AdapterItem(OnboardingToolbarPositionPickerViewHolder.LAYOUT_ID)
|
|
object OnboardingWhatsNew : AdapterItem(OnboardingWhatsNewViewHolder.LAYOUT_ID)
|
|
|
|
/**
|
|
* True if this item represents the same value as other. Used by [AdapterItemDiffCallback].
|
|
*/
|
|
open fun sameAs(other: AdapterItem) = this::class == other::class
|
|
|
|
/**
|
|
* Returns a payload if there's been a change, or null if not
|
|
*/
|
|
open fun getChangePayload(newItem: AdapterItem): Any? = null
|
|
}
|
|
|
|
class AdapterItemDiffCallback : DiffUtil.ItemCallback<AdapterItem>() {
|
|
override fun areItemsTheSame(oldItem: AdapterItem, newItem: AdapterItem) = oldItem.sameAs(newItem)
|
|
|
|
@Suppress("DiffUtilEquals")
|
|
override fun areContentsTheSame(oldItem: AdapterItem, newItem: AdapterItem) = oldItem == newItem
|
|
|
|
override fun getChangePayload(oldItem: AdapterItem, newItem: AdapterItem): Any? {
|
|
return oldItem.getChangePayload(newItem) ?: return super.getChangePayload(oldItem, newItem)
|
|
}
|
|
|
|
data class TabChangePayload(
|
|
val tab: Tab,
|
|
val shouldUpdateFavicon: Boolean,
|
|
val shouldUpdateHostname: Boolean,
|
|
val shouldUpdateTitle: Boolean,
|
|
val shouldUpdateSelected: Boolean,
|
|
val shouldUpdateMediaState: Boolean
|
|
)
|
|
}
|
|
|
|
class SessionControlAdapter(
|
|
private val interactor: SessionControlInteractor
|
|
) : ListAdapter<AdapterItem, RecyclerView.ViewHolder>(AdapterItemDiffCallback()) {
|
|
|
|
// This method triggers the ComplexMethod lint error when in fact it's quite simple.
|
|
@SuppressWarnings("ComplexMethod")
|
|
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerView.ViewHolder {
|
|
val view = LayoutInflater.from(parent.context).inflate(viewType, parent, false)
|
|
return when (viewType) {
|
|
TabHeaderViewHolder.LAYOUT_ID -> TabHeaderViewHolder(view, interactor)
|
|
TabViewHolder.LAYOUT_ID -> TabViewHolder(view, interactor)
|
|
TopSiteViewHolder.LAYOUT_ID -> TopSiteViewHolder(view, interactor)
|
|
SaveTabGroupViewHolder.LAYOUT_ID -> SaveTabGroupViewHolder(view, interactor)
|
|
PrivateBrowsingDescriptionViewHolder.LAYOUT_ID -> PrivateBrowsingDescriptionViewHolder(view, interactor)
|
|
NoContentMessageViewHolder.LAYOUT_ID -> NoContentMessageViewHolder(view)
|
|
CollectionHeaderViewHolder.LAYOUT_ID -> CollectionHeaderViewHolder(view)
|
|
CollectionViewHolder.LAYOUT_ID -> CollectionViewHolder(view, interactor)
|
|
TabInCollectionViewHolder.LAYOUT_ID -> TabInCollectionViewHolder(view, interactor)
|
|
OnboardingHeaderViewHolder.LAYOUT_ID -> OnboardingHeaderViewHolder(view)
|
|
OnboardingSectionHeaderViewHolder.LAYOUT_ID -> OnboardingSectionHeaderViewHolder(view)
|
|
OnboardingAutomaticSignInViewHolder.LAYOUT_ID -> OnboardingAutomaticSignInViewHolder(view)
|
|
OnboardingManualSignInViewHolder.LAYOUT_ID -> OnboardingManualSignInViewHolder(view)
|
|
OnboardingThemePickerViewHolder.LAYOUT_ID -> OnboardingThemePickerViewHolder(view)
|
|
OnboardingTrackingProtectionViewHolder.LAYOUT_ID -> OnboardingTrackingProtectionViewHolder(view)
|
|
OnboardingPrivateBrowsingViewHolder.LAYOUT_ID -> OnboardingPrivateBrowsingViewHolder(view, interactor)
|
|
OnboardingPrivacyNoticeViewHolder.LAYOUT_ID -> OnboardingPrivacyNoticeViewHolder(view)
|
|
OnboardingFinishViewHolder.LAYOUT_ID -> OnboardingFinishViewHolder(view, interactor)
|
|
OnboardingWhatsNewViewHolder.LAYOUT_ID -> OnboardingWhatsNewViewHolder(view)
|
|
OnboardingToolbarPositionPickerViewHolder.LAYOUT_ID -> OnboardingToolbarPositionPickerViewHolder(view)
|
|
else -> throw IllegalStateException()
|
|
}
|
|
}
|
|
|
|
override fun getItemViewType(position: Int) = getItem(position).viewType
|
|
|
|
@SuppressWarnings("ComplexMethod")
|
|
override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
|
|
val item = getItem(position)
|
|
when (holder) {
|
|
is TabHeaderViewHolder -> {
|
|
val tabHeader = item as AdapterItem.TabHeader
|
|
holder.bind(tabHeader.isPrivate, tabHeader.hasTabs)
|
|
}
|
|
is TabViewHolder -> {
|
|
holder.bindSession((item as AdapterItem.TabItem).tab)
|
|
}
|
|
is TopSiteViewHolder -> {
|
|
holder.bind((item as AdapterItem.TopSiteList).topSites)
|
|
}
|
|
is NoContentMessageViewHolder -> {
|
|
val (icon, header, description) = item as AdapterItem.NoContentMessage
|
|
holder.bind(icon, header, description)
|
|
}
|
|
is CollectionViewHolder -> {
|
|
val (collection, expanded, sessionHasOpenTabs) = item as AdapterItem.CollectionItem
|
|
holder.bindSession(collection, expanded, sessionHasOpenTabs)
|
|
}
|
|
is TabInCollectionViewHolder -> {
|
|
val (collection, tab, isLastTab) = item as AdapterItem.TabInCollectionItem
|
|
holder.bindSession(collection, tab, isLastTab)
|
|
}
|
|
is OnboardingSectionHeaderViewHolder -> holder.bind(
|
|
(item as AdapterItem.OnboardingSectionHeader).labelBuilder
|
|
)
|
|
is OnboardingManualSignInViewHolder -> holder.bind()
|
|
is OnboardingAutomaticSignInViewHolder -> holder.bind(
|
|
(item as AdapterItem.OnboardingAutomaticSignIn).state.withAccount
|
|
)
|
|
}
|
|
}
|
|
|
|
override fun onBindViewHolder(
|
|
holder: RecyclerView.ViewHolder,
|
|
position: Int,
|
|
payloads: MutableList<Any>
|
|
) {
|
|
if (payloads.isEmpty()) {
|
|
onBindViewHolder(holder, position)
|
|
return
|
|
}
|
|
|
|
(payloads[0] as AdapterItemDiffCallback.TabChangePayload).let {
|
|
(holder as TabViewHolder).updateTab(it.tab)
|
|
|
|
// Always set the visibility to GONE to avoid the play button sticking around from previous draws
|
|
holder.play_pause_button.visibility = View.GONE
|
|
|
|
if (it.shouldUpdateHostname) { holder.updateHostname(it.tab.hostname) }
|
|
if (it.shouldUpdateTitle) {
|
|
holder.updateTitle(it.tab.title)
|
|
holder.updateCloseButtonDescription(it.tab.title) }
|
|
if (it.shouldUpdateFavicon) {
|
|
holder.updateFavIcon(it.tab.url, it.tab.icon)
|
|
}
|
|
if (it.shouldUpdateSelected) { holder.updateSelected(it.tab.selected ?: false) }
|
|
if (it.shouldUpdateMediaState) {
|
|
holder.updatePlayPauseButton(it.tab.mediaState ?: MediaState.None)
|
|
}
|
|
}
|
|
}
|
|
}
|