Merge pull request #7408 from vector-im/feature/mna/session_manager_multi_selection

[Session manager] Multi selection in sessions list (PSG-852)

Author: mnaturel

changelog.d/7396.feature

@@ -0,0 +1 @@
+Multi selection in sessions list

library/ui-strings/src/main/res/values/strings.xml

@@ -1,6 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources xmlns:tools="http://schemas.android.com/tools">
 
+    <!-- Cross feature -->
+    <plurals name="x_selected">
+        <item quantity="one">%1$d selected</item>
+        <item quantity="other">%1$d selected</item>
+    </plurals>
+
+    <!-- Notice -->
     <string name="notice_room_invite_no_invitee">%s\'s invitation</string>
     <string name="notice_room_invite_no_invitee_by_you">Your invitation</string>
     <string name="notice_room_created">%1$s created the room</string>
@@ -407,6 +414,8 @@
     <string name="action_learn_more">Learn more</string>
     <string name="action_next">Next</string>
     <string name="action_got_it">Got it</string>
+    <string name="action_select_all">Select all</string>
+    <string name="action_deselect_all">Deselect all</string>
 
     <string name="copied_to_clipboard">Copied to clipboard</string>
 
@@ -3328,6 +3337,7 @@
     <string name="device_manager_other_sessions_no_unverified_sessions_found">No unverified sessions found.</string>
     <string name="device_manager_other_sessions_no_inactive_sessions_found">No inactive sessions found.</string>
     <string name="device_manager_other_sessions_clear_filter">Clear Filter</string>
+    <string name="device_manager_other_sessions_select">Select sessions</string>
     <string name="device_manager_session_overview_signout">Sign out of this session</string>
     <string name="device_manager_session_details_title">Session details</string>
     <string name="device_manager_session_details_description">Application, device, and activity information.</string>

vector/src/main/java/im/vector/app/features/settings/devices/v2/DeviceFullInfo.kt

@@ -30,4 +30,5 @@ data class DeviceFullInfo(
         val isCurrentDevice: Boolean,
         val deviceExtendedInfo: DeviceExtendedInfo,
         val matrixClientInfo: MatrixClientInfoContent?,
+        val isSelected: Boolean = false,
 )

vector/src/main/java/im/vector/app/features/settings/devices/v2/VectorSettingsDevicesFragment.kt

@@ -331,6 +331,10 @@ class VectorSettingsDevicesFragment :
         views.waitingView.root.isVisible = isLoading
     }
 
+    override fun onOtherSessionLongClicked(deviceId: String) {
+        // do nothing
+    }
+
     override fun onOtherSessionClicked(deviceId: String) {
         navigateToSessionOverview(deviceId)
     }

vector/src/main/java/im/vector/app/features/settings/devices/v2/list/OtherSessionItem.kt

@@ -17,6 +17,8 @@
 package im.vector.app.features.settings.devices.v2.list
 
 import android.graphics.drawable.Drawable
+import android.view.View
+import android.view.View.OnLongClickListener
 import android.widget.ImageView
 import android.widget.TextView
 import androidx.annotation.ColorInt
@@ -27,6 +29,8 @@ import im.vector.app.core.epoxy.ClickListener
 import im.vector.app.core.epoxy.VectorEpoxyHolder
 import im.vector.app.core.epoxy.VectorEpoxyModel
 import im.vector.app.core.epoxy.onClick
+import im.vector.app.core.resources.ColorProvider
+import im.vector.app.core.resources.DrawableProvider
 import im.vector.app.core.resources.StringProvider
 import im.vector.app.core.ui.views.ShieldImageView
 import org.matrix.android.sdk.api.session.crypto.model.RoomEncryptionTrustLevel
@@ -56,32 +60,54 @@ abstract class OtherSessionItem : VectorEpoxyModel<OtherSessionItem.Holder>(R.la
     @EpoxyAttribute
     lateinit var stringProvider: StringProvider
 
+    @EpoxyAttribute
+    lateinit var colorProvider: ColorProvider
+
+    @EpoxyAttribute
+    lateinit var drawableProvider: DrawableProvider
+
+    @EpoxyAttribute
+    var selected: Boolean = false
+
     @EpoxyAttribute(EpoxyAttribute.Option.DoNotHash)
     var clickListener: ClickListener? = null
 
+    @EpoxyAttribute(EpoxyAttribute.Option.DoNotHash)
+    var onLongClickListener: OnLongClickListener? = null
+
     private val setDeviceTypeIconUseCase = SetDeviceTypeIconUseCase()
 
     override fun bind(holder: Holder) {
         super.bind(holder)
         holder.view.onClick(clickListener)
-        if (clickListener == null) {
+        holder.view.setOnLongClickListener(onLongClickListener)
+        if (clickListener == null && onLongClickListener == null) {
             holder.view.isClickable = false
         }
 
-        setDeviceTypeIconUseCase.execute(deviceType, holder.otherSessionDeviceTypeImageView, stringProvider)
+        holder.otherSessionDeviceTypeImageView.isSelected = selected
+        if (selected) {
+            val drawableColor = colorProvider.getColorFromAttribute(android.R.attr.colorBackground)
+            val drawable = drawableProvider.getDrawable(R.drawable.ic_check_on, drawableColor)
+            holder.otherSessionDeviceTypeImageView.setImageDrawable(drawable)
+        } else {
+            setDeviceTypeIconUseCase.execute(deviceType, holder.otherSessionDeviceTypeImageView, stringProvider)
+        }
         holder.otherSessionVerificationStatusImageView.render(roomEncryptionTrustLevel)
         holder.otherSessionNameTextView.text = sessionName
         holder.otherSessionDescriptionTextView.text = sessionDescription
         sessionDescriptionColor?.let {
             holder.otherSessionDescriptionTextView.setTextColor(it)
         }
         holder.otherSessionDescriptionTextView.setCompoundDrawablesWithIntrinsicBounds(sessionDescriptionDrawable, null, null, null)
+        holder.otherSessionItemBackgroundView.isSelected = selected
     }
 
     class Holder : VectorEpoxyHolder() {
         val otherSessionDeviceTypeImageView by bind<ImageView>(R.id.otherSessionDeviceTypeImageView)
         val otherSessionVerificationStatusImageView by bind<ShieldImageView>(R.id.otherSessionVerificationStatusImageView)
         val otherSessionNameTextView by bind<TextView>(R.id.otherSessionNameTextView)
         val otherSessionDescriptionTextView by bind<TextView>(R.id.otherSessionDescriptionTextView)
+        val otherSessionItemBackgroundView by bind<View>(R.id.otherSessionItemBackground)
     }
 }

vector/src/main/java/im/vector/app/features/settings/devices/v2/list/OtherSessionsController.kt

@@ -16,6 +16,7 @@
 
 package im.vector.app.features.settings.devices.v2.list
 
+import android.view.View
 import com.airbnb.epoxy.TypedEpoxyController
 import im.vector.app.R
 import im.vector.app.core.date.DateFormatKind
@@ -38,6 +39,7 @@ class OtherSessionsController @Inject constructor(
     var callback: Callback? = null
 
     interface Callback {
+        fun onItemLongClicked(deviceId: String)
         fun onItemClicked(deviceId: String)
     }
 
@@ -70,8 +72,15 @@ class OtherSessionsController @Inject constructor(
                     sessionDescription(description)
                     sessionDescriptionDrawable(descriptionDrawable)
                     sessionDescriptionColor(descriptionColor)
-                    stringProvider(this@OtherSessionsController.stringProvider)
+                    stringProvider(host.stringProvider)
+                    colorProvider(host.colorProvider)
+                    drawableProvider(host.drawableProvider)
+                    selected(device.isSelected)
                     clickListener { device.deviceInfo.deviceId?.let { host.callback?.onItemClicked(it) } }
+                    onLongClickListener(View.OnLongClickListener {
+                        device.deviceInfo.deviceId?.let { host.callback?.onItemLongClicked(it) }
+                        true
+                    })
                 }
             }
         }

vector/src/main/java/im/vector/app/features/settings/devices/v2/list/OtherSessionsView.kt

@@ -40,6 +40,7 @@ class OtherSessionsView @JvmOverloads constructor(
 ) : ConstraintLayout(context, attrs, defStyleAttr), OtherSessionsController.Callback {
 
     interface Callback {
+        fun onOtherSessionLongClicked(deviceId: String)
         fun onOtherSessionClicked(deviceId: String)
         fun onViewAllOtherSessionsClicked()
     }
@@ -107,4 +108,8 @@ class OtherSessionsView @JvmOverloads constructor(
     override fun onItemClicked(deviceId: String) {
         callback?.onOtherSessionClicked(deviceId)
     }
+
+    override fun onItemLongClicked(deviceId: String) {
+        callback?.onOtherSessionLongClicked(deviceId)
+    }
 }

vector/src/main/java/im/vector/app/features/settings/devices/v2/othersessions/OtherSessionsAction.kt

@@ -21,4 +21,9 @@ import im.vector.app.features.settings.devices.v2.filter.DeviceManagerFilterType
 
 sealed class OtherSessionsAction : VectorViewModelAction {
     data class FilterDevices(val filterType: DeviceManagerFilterType) : OtherSessionsAction()
+    data class EnableSelectMode(val deviceId: String?) : OtherSessionsAction()
+    object DisableSelectMode : OtherSessionsAction()
+    data class ToggleSelectionForDevice(val deviceId: String) : OtherSessionsAction()
+    object SelectAll : OtherSessionsAction()
+    object DeselectAll : OtherSessionsAction()
 }

vector/src/main/java/im/vector/app/features/settings/devices/v2/othersessions/OtherSessionsFragment.kt

@@ -18,8 +18,12 @@ package im.vector.app.features.settings.devices.v2.othersessions
 
 import android.os.Bundle
 import android.view.LayoutInflater
+import android.view.Menu
+import android.view.MenuItem
 import android.view.View
 import android.view.ViewGroup
+import androidx.activity.OnBackPressedCallback
+import androidx.activity.addCallback
 import androidx.annotation.StringRes
 import androidx.core.view.isVisible
 import com.airbnb.mvrx.Success
@@ -31,7 +35,9 @@ import im.vector.app.R
 import im.vector.app.core.platform.VectorBaseBottomSheetDialogFragment
 import im.vector.app.core.platform.VectorBaseBottomSheetDialogFragment.ResultListener.Companion.RESULT_OK
 import im.vector.app.core.platform.VectorBaseFragment
+import im.vector.app.core.platform.VectorMenuProvider
 import im.vector.app.core.resources.ColorProvider
+import im.vector.app.core.resources.StringProvider
 import im.vector.app.databinding.FragmentOtherSessionsBinding
 import im.vector.app.features.settings.devices.v2.DeviceFullInfo
 import im.vector.app.features.settings.devices.v2.filter.DeviceManagerFilterBottomSheet
@@ -40,25 +46,79 @@ import im.vector.app.features.settings.devices.v2.list.OtherSessionsView
 import im.vector.app.features.settings.devices.v2.list.SESSION_IS_MARKED_AS_INACTIVE_AFTER_DAYS
 import im.vector.app.features.settings.devices.v2.more.SessionLearnMoreBottomSheet
 import im.vector.app.features.themes.ThemeUtils
+import org.matrix.android.sdk.api.extensions.orFalse
 import javax.inject.Inject
 
 @AndroidEntryPoint
 class OtherSessionsFragment :
         VectorBaseFragment<FragmentOtherSessionsBinding>(),
         VectorBaseBottomSheetDialogFragment.ResultListener,
-        OtherSessionsView.Callback {
+        OtherSessionsView.Callback,
+        VectorMenuProvider {
 
     private val viewModel: OtherSessionsViewModel by fragmentViewModel()
     private val args: OtherSessionsArgs by args()
 
     @Inject lateinit var colorProvider: ColorProvider
 
+    @Inject lateinit var stringProvider: StringProvider
+
     @Inject lateinit var viewNavigator: OtherSessionsViewNavigator
 
     override fun getBinding(inflater: LayoutInflater, container: ViewGroup?): FragmentOtherSessionsBinding {
         return FragmentOtherSessionsBinding.inflate(layoutInflater, container, false)
     }
 
+    override fun getMenuRes() = R.menu.menu_other_sessions
+
+    override fun handlePrepareMenu(menu: Menu) {
+        withState(viewModel) { state ->
+            val isSelectModeEnabled = state.isSelectModeEnabled
+            menu.findItem(R.id.otherSessionsSelectAll).isVisible = isSelectModeEnabled
+            menu.findItem(R.id.otherSessionsDeselectAll).isVisible = isSelectModeEnabled
+            menu.findItem(R.id.otherSessionsSelect).isVisible = !isSelectModeEnabled && state.devices()?.isNotEmpty().orFalse()
+        }
+    }
+
+    override fun handleMenuItemSelected(item: MenuItem): Boolean {
+        return when (item.itemId) {
+            R.id.otherSessionsSelect -> {
+                enableSelectMode(true)
+                true
+            }
+            R.id.otherSessionsSelectAll -> {
+                viewModel.handle(OtherSessionsAction.SelectAll)
+                true
+            }
+            R.id.otherSessionsDeselectAll -> {
+                viewModel.handle(OtherSessionsAction.DeselectAll)
+                true
+            }
+            else -> false
+        }
+    }
+
+    private fun enableSelectMode(isEnabled: Boolean, deviceId: String? = null) {
+        val action = if (isEnabled) OtherSessionsAction.EnableSelectMode(deviceId) else OtherSessionsAction.DisableSelectMode
+        viewModel.handle(action)
+    }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        activity?.onBackPressedDispatcher?.addCallback(owner = this) {
+            handleBackPress(this)
+        }
+    }
+
+    private fun handleBackPress(onBackPressedCallback: OnBackPressedCallback) = withState(viewModel) { state ->
+        if (state.isSelectModeEnabled) {
+            enableSelectMode(false)
+        } else {
+            onBackPressedCallback.isEnabled = false
+            activity?.onBackPressedDispatcher?.onBackPressed()
+        }
+    }
+
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
         setupToolbar(views.otherSessionsToolbar).setTitle(args.titleResourceId).allowBack()
@@ -103,11 +163,24 @@ class OtherSessionsFragment :
 
     override fun invalidate() = withState(viewModel) { state ->
         if (state.devices is Success) {
-            renderDevices(state.devices(), state.currentFilter)
+            val devices = state.devices.invoke()
+            renderDevices(devices, state.currentFilter)
+            updateToolbar(devices, state.isSelectModeEnabled)
         }
     }
 
-    private fun renderDevices(devices: List<DeviceFullInfo>?, currentFilter: DeviceManagerFilterType) {
+    private fun updateToolbar(devices: List<DeviceFullInfo>, isSelectModeEnabled: Boolean) {
+        invalidateOptionsMenu()
+        val title = if (isSelectModeEnabled) {
+            val selection = devices.count { it.isSelected }
+            stringProvider.getQuantityString(R.plurals.x_selected, selection, selection)
+        } else {
+            getString(args.titleResourceId)
+        }
+        toolbar?.title = title
+    }
+
+    private fun renderDevices(devices: List<DeviceFullInfo>, currentFilter: DeviceManagerFilterType) {
         views.otherSessionsFilterBadgeImageView.isVisible = currentFilter != DeviceManagerFilterType.ALL_SESSIONS
         views.otherSessionsSecurityRecommendationView.isVisible = currentFilter != DeviceManagerFilterType.ALL_SESSIONS
         views.deviceListHeaderOtherSessions.isVisible = currentFilter == DeviceManagerFilterType.ALL_SESSIONS
@@ -160,7 +233,7 @@ class OtherSessionsFragment :
             }
         }
 
-        if (devices.isNullOrEmpty()) {
+        if (devices.isEmpty()) {
             views.deviceListOtherSessions.isVisible = false
             views.otherSessionsNotFoundLayout.isVisible = true
         } else {
@@ -190,11 +263,21 @@ class OtherSessionsFragment :
         SessionLearnMoreBottomSheet.show(childFragmentManager, args)
     }
 
-    override fun onOtherSessionClicked(deviceId: String) {
-        viewNavigator.navigateToSessionOverview(
-                context = requireActivity(),
-                deviceId = deviceId
-        )
+    override fun onOtherSessionLongClicked(deviceId: String) = withState(viewModel) { state ->
+        if (!state.isSelectModeEnabled) {
+            enableSelectMode(true, deviceId)
+        }
+    }
+
+    override fun onOtherSessionClicked(deviceId: String) = withState(viewModel) { state ->
+        if (state.isSelectModeEnabled) {
+            viewModel.handle(OtherSessionsAction.ToggleSelectionForDevice(deviceId))
+        } else {
+            viewNavigator.navigateToSessionOverview(
+                    context = requireActivity(),
+                    deviceId = deviceId
+            )
+        }
     }
 
     override fun onViewAllOtherSessionsClicked() {