1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/* 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.components.bookmarks
import androidx.annotation.WorkerThread
import mozilla.appservices.places.BookmarkRoot
import mozilla.appservices.places.uniffi.PlacesApiException
import mozilla.components.concept.storage.BookmarksStorage
import mozilla.components.concept.storage.HistoryStorage
import org.mozilla.fenix.home.recentbookmarks.RecentBookmark
import java.util.concurrent.TimeUnit
/**
* Use cases that allow for modifying and retrieving bookmarks.
*/
class BookmarksUseCase(
bookmarksStorage: BookmarksStorage,
historyStorage: HistoryStorage,
) {
class AddBookmarksUseCase internal constructor(private val storage: BookmarksStorage) {
/**
* Adds a new bookmark with the provided [url] and [title].
*
* @return The result if the operation was executed or not. A bookmark may not be added if
* one with the identical [url] already exists.
*/
@WorkerThread
suspend operator fun invoke(
url: String,
title: String,
position: UInt? = null,
parentGuid: String? = null,
): Boolean {
return try {
val canAdd = storage.getBookmarksWithUrl(url).firstOrNull { it.url == url } == null
if (canAdd) {
storage.addItem(
parentGuid ?: BookmarkRoot.Mobile.id,
url = url,
title = title,
position = position,
)
}
canAdd
} catch (e: PlacesApiException.UrlParseFailed) {
false
}
}
}
/**
* Uses for retrieving recently added bookmarks.
*
* @param bookmarksStorage [BookmarksStorage] to retrieve the bookmark data.
* @param historyStorage Optional [HistoryStorage] to retrieve the preview image of a visited
* page associated with a bookmark.
*/
class RetrieveRecentBookmarksUseCase internal constructor(
private val bookmarksStorage: BookmarksStorage,
private val historyStorage: HistoryStorage? = null,
) {
/**
* Retrieves a list of recently added bookmarks, if any, up to maximum.
*
* @param count The number of recent bookmarks to return.
* @param maxAgeInMs The maximum age (ms) of a recently added bookmark to return.
* @return a list of [RecentBookmark] that were added no older than specify by [maxAgeInMs],
* if any, up to a number specified by [count].
*/
@WorkerThread
suspend operator fun invoke(
count: Int = DEFAULT_BOOKMARKS_TO_RETRIEVE,
maxAgeInMs: Long = TimeUnit.DAYS.toMillis(DEFAULT_BOOKMARKS_DAYS_AGE_TO_RETRIEVE),
): List<RecentBookmark> {
val currentTime = System.currentTimeMillis()
// Fetch visit information within the time range of now and the specified maximum age.
val history = historyStorage?.getDetailedVisits(
start = currentTime - maxAgeInMs,
end = currentTime,
)
return bookmarksStorage
.getRecentBookmarks(count, maxAgeInMs)
.map { bookmark ->
RecentBookmark(
title = bookmark.title,
url = bookmark.url,
previewImageUrl = history?.find { bookmark.url == it.url }?.previewImageUrl,
)
}
}
}
val addBookmark by lazy { AddBookmarksUseCase(bookmarksStorage) }
val retrieveRecentBookmarks by lazy {
RetrieveRecentBookmarksUseCase(
bookmarksStorage,
historyStorage,
)
}
companion object {
// Number of recent bookmarks to retrieve.
const val DEFAULT_BOOKMARKS_TO_RETRIEVE = 4
// The maximum age in days of a recent bookmarks to retrieve.
const val DEFAULT_BOOKMARKS_DAYS_AGE_TO_RETRIEVE = 10L
}
}
|
