GH-177 Add dynamic shortcuts for bookmarks

Author: Radiokot

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Ability to switch the order of items when viewing an album or a folder
+- App shortcuts for search bookmarks – by long pressing the gallery icon in the launcher,
+  you'll see shortcuts which let you quickly open the gallery at a particular bookmark
 
 ### Fixed
 

app/src/main/java/ua/com/radiokot/photoprism/PhotoPrismGallery.kt

@@ -34,6 +34,7 @@ import ua.com.radiokot.photoprism.features.ext.memories.logic.CancelDailyMemorie
 import ua.com.radiokot.photoprism.features.ext.memories.logic.ScheduleDailyMemoriesUpdatesUseCase
 import ua.com.radiokot.photoprism.features.ext.store.galleryExtensionStoreModule
 import ua.com.radiokot.photoprism.features.gallery.galleryFeatureModule
+import ua.com.radiokot.photoprism.features.gallery.logic.SearchBookmarkShortcutsManager
 import ua.com.radiokot.photoprism.features.importt.importFeatureModule
 import ua.com.radiokot.photoprism.features.importt.view.ImportActivity
 import ua.com.radiokot.photoprism.features.viewer.mediaViewerFeatureModule
@@ -88,6 +89,7 @@ class PhotoPrismGallery : Application() {
 
         initRxErrorHandler()
         initLogging()
+        initShortcuts()
         clearInternalDownloads()
 
         loadSessionIfPresent()
@@ -147,6 +149,13 @@ class PhotoPrismGallery : Application() {
         get<UpdatePhotoFrameWidgetManifestComponentsUseCase>().invoke()
     }
 
+    private fun initShortcuts() {
+        SearchBookmarkShortcutsManager(this)
+            .syncShortcutsWithBookmarks(
+                bookmarksRepository = get(),
+            )
+    }
+
     override fun attachBaseContext(base: Context) =
         super.attachBaseContext(
             LocalizedContextFactory(base)

app/src/main/java/ua/com/radiokot/photoprism/features/gallery/data/storage/SearchBookmarksRepository.kt

@@ -147,6 +147,9 @@ class SearchBookmarksRepository(
     fun findByConfig(config: SearchConfig): SearchBookmark? =
         itemsList.find { it.searchConfig == config }
 
+    fun findById(id: Long): SearchBookmark? =
+        itemsList.find { it.id == id }
+
     /**
      * Replaces all the bookmarks with given.
      */
@@ -159,4 +162,4 @@ class SearchBookmarksRepository(
         .toCompletable()
         .subscribeOn(Schedulers.io())
         .andThen(updateDeferred())
-}
+}

app/src/main/java/ua/com/radiokot/photoprism/features/gallery/logic/SearchBookmarkShortcutsManager.kt

@@ -0,0 +1,47 @@
+package ua.com.radiokot.photoprism.features.gallery.logic
+
+import android.app.Application
+import android.content.Intent
+import androidx.core.content.pm.ShortcutInfoCompat
+import androidx.core.content.pm.ShortcutManagerCompat
+import androidx.core.graphics.drawable.IconCompat
+import io.reactivex.rxjava3.disposables.Disposable
+import ua.com.radiokot.photoprism.R
+import ua.com.radiokot.photoprism.features.gallery.data.storage.SearchBookmarksRepository
+import ua.com.radiokot.photoprism.features.gallery.view.GalleryActivity
+
+class SearchBookmarkShortcutsManager(
+    private val application: Application,
+) {
+
+    /**
+     * Synchronizes app dynamic shortcuts (ones appear on icon long press)
+     * with the search bookmarks.
+     */
+    fun syncShortcutsWithBookmarks(
+        bookmarksRepository: SearchBookmarksRepository,
+    ): Disposable = bookmarksRepository
+        .items
+        .subscribe { bookmarks ->
+
+            ShortcutManagerCompat.setDynamicShortcuts(
+                application,
+                bookmarks.map { bookmark ->
+                    ShortcutInfoCompat.Builder(application, bookmark.id.toString())
+                        .setShortLabel(bookmark.name)
+                        .setIcon(
+                            IconCompat.createWithResource(
+                                application,
+                                R.drawable.ic_bookmark_shortcut
+                            )
+                        )
+                        .setIntent(
+                            Intent(application, GalleryActivity::class.java)
+                                .setAction(GalleryActivity.ACTION_BOOKMARK_SHORTCUT)
+                                .putExtra(GalleryActivity.BOOKMARK_ID_EXTRA, bookmark.id)
+                        )
+                        .build()
+                }
+            )
+        }
+}

app/src/main/java/ua/com/radiokot/photoprism/features/gallery/search/view/model/GallerySearchViewModel.kt

@@ -15,8 +15,8 @@ import ua.com.radiokot.photoprism.features.gallery.data.model.GalleryMedia
 import ua.com.radiokot.photoprism.features.gallery.data.model.SearchBookmark
 import ua.com.radiokot.photoprism.features.gallery.data.model.SearchConfig
 import ua.com.radiokot.photoprism.features.gallery.data.storage.SearchBookmarksRepository
-import ua.com.radiokot.photoprism.features.gallery.search.data.storage.SearchPreferences
 import ua.com.radiokot.photoprism.features.gallery.search.albums.view.model.GallerySearchAlbumsViewModel
+import ua.com.radiokot.photoprism.features.gallery.search.data.storage.SearchPreferences
 import ua.com.radiokot.photoprism.features.gallery.search.people.view.model.GallerySearchPeopleViewModel
 
 class GallerySearchViewModel(
@@ -99,6 +99,33 @@ class GallerySearchViewModel(
                 && !bookmarksRepository.isLoading
                 && areBookmarksCurrentlyMoving.value == false
 
+    fun applyBookmarkByIdAsync(
+        bookmarkId: Long,
+    ) = bookmarksRepository
+        .updateIfNotFreshDeferred()
+        .doOnComplete {
+            val bookmark = bookmarksRepository.findById(bookmarkId)
+
+            if (bookmark == null) {
+                log.warn {
+                    "applyBookmarkByIdAsync(): bookmark_not_found:" +
+                            "\nbookmarkId=$bookmarkId"
+                }
+                return@doOnComplete
+            }
+
+            log.debug {
+                "applyBookmarkByIdAsync(): applying_bookmark:" +
+                        "\nbookmark=$bookmark"
+            }
+
+            applySearchConfig(
+                config = bookmark.searchConfig,
+            )
+        }
+        .subscribeBy()
+        .autoDispose(this)
+
     private fun subscribeToBookmarks() {
         bookmarksRepository.items
             .observeOn(AndroidSchedulers.mainThread())

app/src/main/java/ua/com/radiokot/photoprism/features/gallery/view/GalleryActivity.kt

@@ -190,7 +190,9 @@ class GalleryActivity : BaseActivity() {
                 return
             }
 
-            viewModel.initViewingOnce()
+            viewModel.initViewingOnce(
+                requestedBookmarkId = getBookmarkId(intent),
+            )
         }
 
         rootView = ActivityGalleryBinding.inflate(layoutInflater)
@@ -1031,6 +1033,15 @@ class GalleryActivity : BaseActivity() {
             .show()
     }
 
+    override fun onNewIntent(intent: Intent?) {
+        super.onNewIntent(intent)
+
+        if (intent?.action == ACTION_BOOKMARK_SHORTCUT) {
+            getBookmarkId(intent)
+                ?.also(viewModel.searchViewModel::applyBookmarkByIdAsync)
+        }
+    }
+
     private var backPressResetDisposable: Disposable? = null
     override fun onKeyUp(keyCode: Int, event: KeyEvent?): Boolean {
         if (keyCode == KeyEvent.KEYCODE_BACK) {
@@ -1098,7 +1109,13 @@ class GalleryActivity : BaseActivity() {
                 )
         }
 
-    private companion object {
+    companion object {
         private const val FALLBACK_LIST_SIZE = 100
+        const val ACTION_BOOKMARK_SHORTCUT = "bookmark-shortcut"
+        const val BOOKMARK_ID_EXTRA = "bookmark-id"
+
+        private fun getBookmarkId(intent: Intent): Long? = intent
+            .getLongExtra(BOOKMARK_ID_EXTRA, Long.MIN_VALUE)
+            .takeIf { it != Long.MIN_VALUE }
     }
 }

app/src/main/java/ua/com/radiokot/photoprism/features/gallery/view/model/GalleryViewModel.kt

@@ -116,13 +116,6 @@ class GalleryViewModel(
             searchViewModel.availableMediaTypes.value = allowedMediaTypes
         }
 
-        log.debug {
-            "initSelectionForAppOnce(): initialized_selection:" +
-                    "\nrequestedMimeType=$requestedMimeType," +
-                    "\nallowMultiple=$allowMultiple," +
-                    "\nallowedMediaTypes=$allowedMediaTypes"
-        }
-
         stateSubject.onNext(
             State.Selecting.ForOtherApp(
                 allowedMediaTypes = allowedMediaTypes,
@@ -148,12 +141,22 @@ class GalleryViewModel(
                 },
             )
         }
+
         initCommon()
 
+        log.debug {
+            "initSelectionForAppOnce(): initialized_selection:" +
+                    "\nrequestedMimeType=$requestedMimeType," +
+                    "\nallowMultiple=$allowMultiple," +
+                    "\nallowedMediaTypes=$allowedMediaTypes"
+        }
+
         isInitialized = true
     }
 
-    fun initViewingOnce() {
+    fun initViewingOnce(
+        requestedBookmarkId: Long?,
+    ) {
         if (isInitialized) {
             log.debug {
                 "initViewingOnce(): already_initialized"
@@ -162,8 +165,10 @@ class GalleryViewModel(
             return
         }
 
-        log.debug {
-            "initViewingOnce(): initialized_viewing"
+        if (requestedBookmarkId != null) {
+            searchViewModel.applyBookmarkByIdAsync(
+                bookmarkId = requestedBookmarkId,
+            )
         }
 
         stateSubject.onNext(State.Viewing)
@@ -181,15 +186,22 @@ class GalleryViewModel(
                 repositoryToPostFrom == currentMediaRepository
             },
         )
+
         initCommon()
 
+        log.debug {
+            "initViewingOnce(): initialized_viewing:" +
+                    "\nrequestedBookmarkId=$requestedBookmarkId"
+        }
+
         isInitialized = true
     }
 
     private fun initCommon() {
         subscribeToSearch()
         subscribeToFastScroll()
         subscribeToRepositoryChanges()
+
         resetRepositoryAndSearchConfig()
     }
 

app/src/main/res/drawable/ic_bookmark_shortcut.xml

@@ -0,0 +1,13 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android" android:height="24dp" android:viewportHeight="478" android:viewportWidth="478" android:width="24dp">
+      
+    <group>
+            
+        <clip-path android:pathData="M0,0h478v478H0z"/>
+            
+        <path android:fillColor="#E1E0FF" android:pathData="M239,239m-239,0a239,239 0,1 1,478 0a239,239 0,1 1,-478 0"/>
+            
+        <path android:fillColor="#5256A9" android:fillType="evenOdd" android:pathData="M311.7,120.8a29.6,29.6 0,0 1,29.5 29.6v177.1c0,11 -5.7,20.7 -15.3,26 -9.7,5.2 -21,4.8 -30.2,-1.1l-50.5,-32.5a7.8,7.8 0,0 0,-8.4 0l-50.5,32.5a29.2,29.2 0,0 1,-30.1 1,29.3 29.3,0 0,1 -15.4,-25.9v-177a29.6,29.6 0,0 1,29.5 -29.7h141.4ZM241,164a6.4,6.4 0,0 0,-5.8 3.6l-13.8,29 -32,4a6.4,6.4 0,0 0,-3.5 11l23.4,22 -6,31.4a6.4,6.4 0,0 0,9.4 6.8l28.3,-15.3 28.2,15.3c1,0.5 2,0.8 3.1,0.8a6.4,6.4 0,0 0,6.3 -7.6l-5.9,-31.4 23.4,-22a6.4,6.4 0,0 0,-3.6 -11l-31.9,-4 -13.8,-29a6.4,6.4 0,0 0,-5.8 -3.6Z"/>
+          
+    </group>
+    
+</vector>