music: share code between music/excluded locations

Co-authored by Claude.

Author: OxygenCobalt

app/src/main/java/org/oxycblt/auxio/music/MusicSettings.kt

@@ -27,7 +27,6 @@ import javax.inject.Inject
 import org.oxycblt.auxio.R
 import org.oxycblt.auxio.settings.Settings
 import org.oxycblt.musikr.fs.Location
-import org.oxycblt.musikr.fs.OpenedLocation
 import timber.log.Timber as L
 
 /**
@@ -39,9 +38,9 @@ interface MusicSettings : Settings<MusicSettings.Listener> {
     /** The current library revision. */
     var revision: UUID?
     /** The locations of music to load. */
-    var musicLocations: List<OpenedLocation>
+    var musicLocations: List<Location.Opened>
     /** The locations to exclude from music loading. */
-    var excludedLocations: List<Location>
+    var excludedLocations: List<Location.Unopened>
     /** Whether to exclude non-music audio files from the music library. */
     val excludeNonMusic: Boolean
     /** Whether to ignore hidden files and directories during music loading. */
@@ -78,7 +77,7 @@ class MusicSettingsImpl @Inject constructor(@ApplicationContext private val cont
             }
         }
 
-    override var musicLocations: List<OpenedLocation>
+    override var musicLocations: List<Location.Opened>
         get() {
             val locations =
                 sharedPreferences.getString(getString(R.string.set_key_music_locations), null)
@@ -95,12 +94,12 @@ class MusicSettingsImpl @Inject constructor(@ApplicationContext private val cont
             }
         }
 
-    override var excludedLocations: List<Location>
+    override var excludedLocations: List<Location.Unopened>
         get() {
             val locations =
                 sharedPreferences.getString(getString(R.string.set_key_excluded_locations), null)
                     ?: return emptyList()
-            return locations.toLocations()
+            return locations.toUnopenedLocations()
         }
         set(value) {
             sharedPreferences.edit {
@@ -157,17 +156,17 @@ class MusicSettingsImpl @Inject constructor(@ApplicationContext private val cont
         }
     }
 
-    private fun List<OpenedLocation>.stringify(): String =
+    private fun List<Location.Opened>.stringify(): String =
         joinToString(separator = ";") { it.uri.toString().replace(";", "\\;") }
 
-    private fun String.toOpenedLocations(): List<OpenedLocation> =
-        splitEscaped { it == ';' }.mapNotNull { Location.from(context, it.toUri())?.open(context) }
+    private fun String.toOpenedLocations(): List<Location.Opened> =
+        splitEscaped { it == ';' }.mapNotNull { Location.Unopened.from(context, it.toUri())?.open(context) }
 
     private fun List<Location>.stringifyLocations(): String =
         joinToString(separator = ";") { it.uri.toString().replace(";", "\\;") }
 
-    private fun String.toLocations(): List<Location> =
-        splitEscaped { it == ';' }.mapNotNull { Location.from(context, it.toUri()) }
+    private fun String.toUnopenedLocations(): List<Location.Unopened> =
+        splitEscaped { it == ';' }.mapNotNull { Location.Unopened.from(context, it.toUri()) }
 
     private inline fun String.splitEscaped(selector: (Char) -> Boolean): List<String> {
         val split = mutableListOf<String>()

app/src/main/java/org/oxycblt/auxio/music/locations/ExcludedLocationAdapter.kt

@@ -18,98 +18,29 @@
 
 package org.oxycblt.auxio.music.locations
 
-import android.view.View
 import android.view.ViewGroup
-import androidx.recyclerview.widget.RecyclerView
 import org.oxycblt.auxio.databinding.ItemMusicLocationBinding
-import org.oxycblt.auxio.list.recycler.DialogRecyclerView
-import org.oxycblt.auxio.util.context
 import org.oxycblt.auxio.util.inflater
 import org.oxycblt.musikr.fs.Location
-import timber.log.Timber as L
 
 /**
- * [RecyclerView.Adapter] that manages a list of [Location] excluded directory instances.
+ * [LocationAdapter] that manages a list of [Location.Unopened] excluded directory instances.
  *
- * @param listener A [ExcludedLocationAdapter.Listener] to bind interactions to.
+ * @param listener A [LocationAdapter.Listener] to bind interactions to.
  * @author Alexander Capehart (OxygenCobalt)
  */
-class ExcludedLocationAdapter(private val listener: Listener) : RecyclerView.Adapter<ExcludedDirViewHolder>() {
-    private val _locations = mutableListOf<Location>()
-    /**
-     * The current list of [Location]s, may not line up with [Location]s due to
-     * removals.
-     */
-    val locations: List<Location> = _locations
-
-    override fun getItemCount() = locations.size
-
-    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int) =
-        ExcludedDirViewHolder.from(parent)
-
-    override fun onBindViewHolder(holder: ExcludedDirViewHolder, position: Int) =
-        holder.bind(locations[position], listener)
-
-    /**
-     * Add a [Location] to the end of the list.
-     *
-     * @param location The [Location] to add.
-     */
-    fun add(location: Location) {
-        if (_locations.contains(location)) return
-        L.d("Adding $location")
-        _locations.add(location)
-        notifyItemInserted(_locations.lastIndex)
-    }
-
-    /**
-     * Add a list of [Location] instances to the end of the list.
-     *
-     * @param locations The [Location] instances to add.
-     */
-    fun addAll(locations: List<Location>) {
-        L.d("Adding ${locations.size} locations")
-        val oldLastIndex = _locations.size
-        _locations.addAll(locations)
-        notifyItemRangeInserted(oldLastIndex, locations.size)
-    }
-
-    /**
-     * Remove a [Location] from the list.
-     *
-     * @param location The [Location] to remove. Must exist in the list.
-     */
-    fun remove(location: Location) {
-        L.d("Removing $location")
-        val idx = _locations.indexOf(location)
-        _locations.removeAt(idx)
-        notifyItemRemoved(idx)
-    }
-
-    /** A Listener for [ExcludedLocationAdapter] interactions. */
-    interface Listener {
-        /** Called when the delete button on a directory item is clicked. */
-        fun onRemoveLocation(location: Location)
-    }
+class ExcludedLocationAdapter(listener: LocationAdapter.Listener<Location.Unopened>) : LocationAdapter<Location.Unopened>(listener) {
+    override fun createViewHolder(parent: ViewGroup): LocationViewHolder<Location.Unopened> =
+        ExcludedLocationViewHolder.from(parent)
 }
 
 /**
- * A [RecyclerView.Recycler] that displays a [Location]. Use [from] to create an instance.
+ * A [LocationViewHolder] that displays a [Location.Unopened]. Use [from] to create an instance.
  *
  * @author Alexander Capehart (OxygenCobalt)
  */
-class ExcludedDirViewHolder private constructor(private val binding: ItemMusicLocationBinding) :
-    DialogRecyclerView.ViewHolder(binding.root) {
-    /**
-     * Bind new data to this instance.
-     *
-     * @param location The new [Location] to bind.
-     * @param listener A [ExcludedLocationAdapter.Listener] to bind interactions to.
-     */
-    fun bind(location: Location, listener: ExcludedLocationAdapter.Listener) {
-        binding.locationPath.text = location.path.resolve(binding.context)
-        binding.locationDelete.setOnClickListener { listener.onRemoveLocation(location) }
-    }
+class ExcludedLocationViewHolder private constructor(binding: ItemMusicLocationBinding) :
+    LocationViewHolder<Location.Unopened>(binding) {
 
     companion object {
         /**
@@ -119,6 +50,6 @@ class ExcludedDirViewHolder private constructor(private val binding: ItemMusicLo
          * @return A new instance.
          */
         fun from(parent: ViewGroup) =
-            ExcludedDirViewHolder(ItemMusicLocationBinding.inflate(parent.context.inflater, parent, false))
+            ExcludedLocationViewHolder(ItemMusicLocationBinding.inflate(parent.context.inflater, parent, false))
     }
 }

app/src/main/java/org/oxycblt/auxio/music/locations/ExcludedLocationsDialog.kt

@@ -18,127 +18,46 @@
 
 package org.oxycblt.auxio.music.locations
 
-import android.content.ActivityNotFoundException
+import android.content.Context
 import android.net.Uri
-import android.os.Bundle
-import android.view.LayoutInflater
-import androidx.activity.result.ActivityResultLauncher
-import androidx.activity.result.contract.ActivityResultContracts
-import androidx.appcompat.app.AlertDialog
-import androidx.core.net.toUri
-import androidx.recyclerview.widget.ConcatAdapter
 import dagger.hilt.android.AndroidEntryPoint
-import javax.inject.Inject
 import org.oxycblt.auxio.BuildConfig
 import org.oxycblt.auxio.R
-import org.oxycblt.auxio.databinding.DialogMusicLocationsBinding
 import org.oxycblt.auxio.music.MusicSettings
-import org.oxycblt.auxio.ui.ViewBindingMaterialDialogFragment
-import org.oxycblt.auxio.util.showToast
 import org.oxycblt.musikr.fs.Location
-import timber.log.Timber as L
+import javax.inject.Inject
 
 /**
  * Dialog that manages the excluded locations setting.
  *
  * @author Alexander Capehart (OxygenCobalt)
  */
 @AndroidEntryPoint
-class ExcludedLocationsDialog :
-    ViewBindingMaterialDialogFragment<DialogMusicLocationsBinding>(),
-    ExcludedLocationAdapter.Listener,
-    NewLocationFooterAdapter.Listener {
-    private val locationAdapter = ExcludedLocationAdapter(this)
-    private val locationFooterAdapter = NewLocationFooterAdapter(this)
-    private var openDocumentTreeLauncher: ActivityResultLauncher<Uri?>? = null
-    @Inject lateinit var musicSettings: MusicSettings
-
-    override fun onCreateBinding(inflater: LayoutInflater) =
-        DialogMusicLocationsBinding.inflate(inflater)
-
-    override fun onConfigDialog(builder: AlertDialog.Builder) {
-        builder
-            .setTitle(R.string.set_excluded_locations)
-            .setNegativeButton(R.string.lbl_cancel, null)
-            .setPositiveButton(R.string.lbl_save) { _, _ ->
-                val newDirs = locationAdapter.locations
-                musicSettings.excludedLocations = newDirs
-            }
-    }
-
-    override fun onBindingCreated(
-        binding: DialogMusicLocationsBinding,
-        savedInstanceState: Bundle?
-    ) {
-        openDocumentTreeLauncher =
-            registerForActivityResult(
-                ActivityResultContracts.OpenDocumentTree(), ::addDocumentTreeUriToDirs)
+class ExcludedLocationsDialog : LocationsDialog<Location.Unopened>() {
+    override val locationAdapter = ExcludedLocationAdapter(this)
 
-        binding.locationsRecycler.apply {
-            adapter = ConcatAdapter(locationAdapter, locationFooterAdapter)
-            itemAnimator = null
-        }
+    @Inject
+    override lateinit var musicSettings: MusicSettings
 
-        val locations =
-            savedInstanceState?.getStringArrayList(KEY_PENDING_LOCATIONS)?.mapNotNull {
-                Location.from(requireContext(), it.toUri())
-            } ?: musicSettings.excludedLocations
+    override fun getDialogTitle(): Int = R.string.set_excluded_locations
 
-        locationAdapter.addAll(locations)
-    }
-
-    override fun onSaveInstanceState(outState: Bundle) {
-        super.onSaveInstanceState(outState)
-        outState.putStringArrayList(
-            KEY_PENDING_LOCATIONS, ArrayList(locationAdapter.locations.map { it.uri.toString() }))
-    }
+    override fun getCurrentLocations(): List<Location.Unopened> = musicSettings.excludedLocations
 
-    override fun onDestroyBinding(binding: DialogMusicLocationsBinding) {
-        super.onDestroyBinding(binding)
-        openDocumentTreeLauncher = null
-        binding.locationsRecycler.adapter = null
+    override fun saveLocations(locations: List<Location.Unopened>) {
+        musicSettings.excludedLocations = locations
     }
 
-    override fun onRemoveLocation(location: Location) {
-        locationAdapter.remove(location)
-    }
-
-    override fun onNewLocation() {
-        L.d("Opening launcher")
-        val launcher =
-            requireNotNull(openDocumentTreeLauncher) { "Document tree launcher was not available" }
+    override fun getPendingLocationsKey(): String = KEY_PENDING_EXCLUDED_LOCATIONS
 
-        try {
-            launcher.launch(null)
-        } catch (e: ActivityNotFoundException) {
-            // User doesn't have a capable file manager.
-            requireContext().showToast(R.string.err_no_app)
-        }
+    override fun convertUriToLocation(uri: Uri): Location.Unopened? {
+        return Location.Unopened.from(requireContext(), uri)
     }
 
-    /**
-     * Add a Document Tree [Uri] chosen by the user to the current [Location]s.
-     *
-     * @param uri The document tree [Uri] to add, chosen by the user. Will do nothing if the [Uri]
-     *   is null or not valid.
-     */
-    private fun addDocumentTreeUriToDirs(uri: Uri?) {
-        if (uri == null) {
-            // A null URI means that the user left the file picker without picking a directory
-            L.d("No URI given (user closed the dialog)")
-            return
-        }
-        val context = requireContext()
-        val location = Location.from(context, uri)
-
-        if (location != null) {
-            locationAdapter.add(location)
-        } else {
-            requireContext().showToast(R.string.err_bad_location)
-        }
+    override fun createLocationFromUri(context: Context, uri: Uri): Location.Unopened? {
+        return Location.Unopened.from(context, uri)
     }
 
     private companion object {
-        const val KEY_PENDING_LOCATIONS = BuildConfig.APPLICATION_ID + ".key.PENDING_EXCLUDED_LOCATIONS"
+        const val KEY_PENDING_EXCLUDED_LOCATIONS = BuildConfig.APPLICATION_ID + ".key.PENDING_EXCLUDED_LOCATIONS"
     }
 }