/
ReferrersUseCase.kt
376 lines (350 loc) · 16.9 KB
/
ReferrersUseCase.kt
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
package org.wordpress.android.ui.stats.refresh.lists.sections.granular.usecases
import android.view.View
import com.google.android.material.snackbar.Snackbar
import kotlinx.coroutines.CoroutineDispatcher
import org.wordpress.android.BuildConfig
import org.wordpress.android.R
import org.wordpress.android.analytics.AnalyticsTracker
import org.wordpress.android.fluxc.model.SiteModel
import org.wordpress.android.fluxc.model.stats.LimitMode
import org.wordpress.android.fluxc.model.stats.time.ReferrersModel
import org.wordpress.android.fluxc.model.stats.time.ReferrersModel.Group
import org.wordpress.android.fluxc.network.utils.StatsGranularity
import org.wordpress.android.fluxc.store.StatsStore.TimeStatsType.REFERRERS
import org.wordpress.android.fluxc.store.stats.time.ReferrersStore
import org.wordpress.android.modules.BG_THREAD
import org.wordpress.android.modules.UI_THREAD
import org.wordpress.android.ui.stats.refresh.NavigationTarget.ViewReferrers
import org.wordpress.android.ui.stats.refresh.NavigationTarget.ViewUrl
import org.wordpress.android.ui.stats.refresh.lists.BLOCK_ITEM_COUNT
import org.wordpress.android.ui.stats.refresh.lists.VIEW_ALL_ITEM_COUNT
import org.wordpress.android.ui.stats.refresh.lists.sections.BaseStatsUseCase.UseCaseMode.BLOCK
import org.wordpress.android.ui.stats.refresh.lists.sections.BaseStatsUseCase.UseCaseMode.BLOCK_DETAIL
import org.wordpress.android.ui.stats.refresh.lists.sections.BaseStatsUseCase.UseCaseMode.VIEW_ALL
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.Divider
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.Empty
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.ExpandableItem
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.Header
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.Link
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.ListItemWithIcon
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.ListItemWithIcon.IconStyle.EMPTY_SPACE
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.ListItemWithIcon.IconStyle.NORMAL
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.ListItemWithIcon.TextStyle
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.ListItemWithIcon.TextStyle.LIGHT
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.PieChartItem
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.PieChartItem.Pie
import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.Title
import org.wordpress.android.ui.stats.refresh.lists.sections.granular.GranularStatefulUseCase
import org.wordpress.android.ui.stats.refresh.lists.sections.granular.GranularUseCaseFactory
import org.wordpress.android.ui.stats.refresh.lists.sections.granular.SelectedDateProvider
import org.wordpress.android.ui.stats.refresh.lists.sections.granular.usecases.ReferrersUseCase.SelectedGroup
import org.wordpress.android.ui.stats.refresh.utils.ContentDescriptionHelper
import org.wordpress.android.ui.stats.refresh.utils.ReferrerPopupMenuHandler
import org.wordpress.android.ui.stats.refresh.utils.StatsSiteProvider
import org.wordpress.android.ui.stats.refresh.utils.StatsUtils
import org.wordpress.android.ui.stats.refresh.utils.trackGranular
import org.wordpress.android.ui.utils.ListItemInteraction.Companion.create
import org.wordpress.android.util.UrlUtils
import org.wordpress.android.util.analytics.AnalyticsTrackerWrapper
import org.wordpress.android.viewmodel.ResourceProvider
import org.wordpress.android.widgets.WPSnackbar
import java.util.Date
import javax.inject.Inject
import javax.inject.Named
import kotlin.math.min
@Suppress("LongParameterList")
class ReferrersUseCase(
statsGranularity: StatsGranularity,
@Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher,
@Named(BG_THREAD) private val backgroundDispatcher: CoroutineDispatcher,
private val referrersStore: ReferrersStore,
statsSiteProvider: StatsSiteProvider,
selectedDateProvider: SelectedDateProvider,
private val analyticsTracker: AnalyticsTrackerWrapper,
private val contentDescriptionHelper: ContentDescriptionHelper,
private val statsUtils: StatsUtils,
private val resourceProvider: ResourceProvider,
private val useCaseMode: UseCaseMode,
private val popupMenuHandler: ReferrerPopupMenuHandler,
) : GranularStatefulUseCase<ReferrersModel, SelectedGroup>(
REFERRERS,
mainDispatcher,
backgroundDispatcher,
statsSiteProvider,
selectedDateProvider,
statsGranularity,
SelectedGroup()
) {
private val itemsToLoad = if (useCaseMode == BLOCK) BLOCK_ITEM_COUNT else VIEW_ALL_ITEM_COUNT
private val itemsToShow = if (useCaseMode == VIEW_ALL) VIEW_ALL_ITEM_COUNT else BLOCK_ITEM_COUNT
override fun buildLoadingItem(): List<BlockListItem> = listOf(Title(R.string.stats_referrers))
override suspend fun loadCachedData(selectedDate: Date, site: SiteModel): ReferrersModel? {
return referrersStore.getReferrers(
site,
statsGranularity,
LimitMode.Top(itemsToLoad),
selectedDate
)
}
override suspend fun fetchRemoteData(selectedDate: Date, site: SiteModel, forced: Boolean): State<ReferrersModel> {
val response = referrersStore.fetchReferrers(
site,
statsGranularity,
LimitMode.Top(itemsToLoad),
selectedDate,
forced
)
val model = response.model
val error = response.error
return when {
error != null -> State.Error(error.message ?: error.type.name)
model != null && model.groups.isNotEmpty() -> State.Data(model)
else -> State.Empty()
}
}
@SuppressWarnings("CyclomaticComplexMethod")
override fun buildUiModel(domainModel: ReferrersModel, uiState: SelectedGroup): List<BlockListItem> {
val items = mutableListOf<BlockListItem>()
if (useCaseMode != VIEW_ALL) {
items.add(Title(R.string.stats_referrers))
}
if (domainModel.groups.isEmpty()) {
items.add(Empty(R.string.stats_no_data_for_period))
} else {
val header = Header(R.string.stats_referrer_label, R.string.stats_referrer_views_label)
if (BuildConfig.IS_JETPACK_APP && useCaseMode == BLOCK_DETAIL) {
items.add(buildPieChartItem(domainModel))
}
items.add(header)
val itemCount = min(itemsToShow, domainModel.groups.size)
domainModel.groups.subList(0, itemCount).forEachIndexed { index, group ->
val contentDescription =
contentDescriptionHelper.buildContentDescription(
header,
group.name ?: "",
group.total ?: 0
)
val spam = group.markedAsSpam
val icon = buildIcon(group.icon, spam)
if (group.referrers.isEmpty()) {
val headerItem = ListItemWithIcon(
icon = icon,
iconUrl = if (icon == null) group.icon else null,
textStyle = buildTextStyle(spam),
text = group.name,
value = group.total?.let { statsUtils.toFormattedString(it) },
showDivider = index < domainModel.groups.size - 1,
navigationAction = group.url?.let {
create(it, this::onItemClick)
},
longClickAction = { view -> this.onMenuClick(view, group, spam) },
contentDescription = contentDescription
)
items.add(headerItem)
} else {
val headerItem = ListItemWithIcon(
icon = icon,
iconUrl = if (icon == null) group.icon else null,
textStyle = buildTextStyle(spam),
text = group.name,
value = group.total?.let { statsUtils.toFormattedString(it) },
showDivider = index < domainModel.groups.size - 1,
contentDescription = contentDescription,
longClickAction = { view -> this.onMenuClick(view, group, spam) }
)
val isExpanded = group.groupId == uiState.groupId
items.add(ExpandableItem(headerItem, isExpanded) { changedExpandedState ->
onUiState(SelectedGroup(if (changedExpandedState) group.groupId else null))
})
if (isExpanded) {
items.addAll(group.referrers.map { referrer ->
val referrerSpam = referrer.markedAsSpam
val referrerIcon = buildIcon(referrer.icon, referrerSpam)
val iconStyle = if (group.icon != null && referrer.icon == null && referrerIcon == null) {
EMPTY_SPACE
} else {
NORMAL
}
ListItemWithIcon(
icon = referrerIcon,
iconUrl = if (referrerIcon == null) referrer.icon else null,
iconStyle = iconStyle,
textStyle = buildTextStyle(referrerSpam),
text = referrer.name,
value = statsUtils.toFormattedString(referrer.views),
showDivider = false,
navigationAction = referrer.url?.let {
create(it, this::onItemClick)
},
contentDescription = contentDescriptionHelper.buildContentDescription(
header,
referrer.name,
referrer.views
)
)
})
items.add(Divider)
}
}
}
val shouldShowViewMore = itemCount < domainModel.groups.size ||
(useCaseMode == BLOCK && domainModel.hasMore)
if (shouldShowViewMore) {
items.add(
Link(
text = R.string.stats_insights_view_more,
navigateAction = create(statsGranularity, this::onViewMoreClicked)
)
)
}
}
return items
}
private fun buildPieChartItem(domainModel: ReferrersModel): PieChartItem {
var firstPie: Pie? = null
var secondPie: Pie? = null
val wordPressGroup = domainModel.groups.find { it.groupId == GROUP_ID_WORDPRESS }
val searchGroup = domainModel.groups.find { it.groupId == GROUP_ID_SEARCH }
// If the wordpress group and search group can be found add them, otherwise add the first and second groups
if (wordPressGroup != null && searchGroup != null) {
firstPie = Pie(
resourceProvider.getString(R.string.stats_referrers_pie_chart_wordpress),
wordPressGroup.total ?: 0
)
secondPie = Pie(
resourceProvider.getString(R.string.stats_referrers_pie_chart_search),
searchGroup.total ?: 0
)
} else {
if (domainModel.groups.isNotEmpty()) {
firstPie = Pie(domainModel.groups.first().name.orEmpty(), domainModel.groups.first().total ?: 0)
}
if (domainModel.groups.size > 1) {
secondPie = Pie(domainModel.groups[1].name.orEmpty(), domainModel.groups[1].total ?: 0)
}
}
val othersPie = if (domainModel.groups.size > 2) {
Pie(
resourceProvider.getString(R.string.stats_referrers_pie_chart_others),
domainModel.totalViews - (firstPie?.value ?: 0) - (secondPie?.value ?: 0)
)
} else {
null
}
val pies = listOfNotNull(firstPie, secondPie, othersPie)
val totalLabel = resourceProvider.getString(R.string.stats_referrers_pie_chart_total_label)
val totalValue = pies.sumOf { it.value }
return PieChartItem(
pies,
totalLabel,
statsUtils.toFormattedString(totalValue),
COLOR_LIST,
contentDescriptionHelper.buildContentDescription(
R.string.stats_referrers_pie_chart_total_label,
totalValue
)
)
}
private fun buildTextStyle(spam: Boolean) = if (spam) LIGHT else TextStyle.NORMAL
private fun buildIcon(iconUrl: String?, spam: Boolean): Int? {
return when {
spam -> R.drawable.ic_spam_white_24dp
iconUrl == null -> R.drawable.ic_globe_white_24dp
iconUrl == "https://wordpress.com/i/stats/search-engine.png" -> R.drawable.ic_search_white_24dp
else -> null
}
}
private fun onViewMoreClicked(statsGranularity: StatsGranularity) {
analyticsTracker.trackGranular(AnalyticsTracker.Stat.STATS_REFERRERS_VIEW_MORE_TAPPED, statsGranularity)
navigateTo(
ViewReferrers(
statsGranularity,
selectedDateProvider.getSelectedDate(statsGranularity) ?: Date()
)
)
}
private fun onItemClick(url: String) {
analyticsTracker.trackGranular(AnalyticsTracker.Stat.STATS_REFERRERS_ITEM_TAPPED, statsGranularity)
openWebsite(url)
}
fun openWebsite(url: String) {
navigateTo(ViewUrl(url))
}
private fun onMenuClick(view: View, group: Group, spam: Boolean?): Boolean {
val url = when {
group.url != null -> group.url
UrlUtils.isValidUrlAndHostNotNull("https://${group.name}") -> group.name
else -> null
}
if (url != null) {
analyticsTracker.trackGranular(AnalyticsTracker.Stat.STATS_REFERRERS_ITEM_LONG_PRESSED, statsGranularity)
popupMenuHandler.onMenuClick(view, statsGranularity, url, spam, this)
} else {
// Show snackbar with error message
WPSnackbar.make(
view,
R.string.stats_referrer_snackbar_cant_mark_as_spam,
Snackbar.LENGTH_LONG
).show()
}
return true
}
suspend fun markReferrerAsSpam(urlDomain: String) {
selectedDateProvider.getSelectedDate(statsGranularity)?.let {
referrersStore.reportReferrerAsSpam(
statsSiteProvider.siteModel,
urlDomain,
statsGranularity,
LimitMode.Top(itemsToLoad),
it
)
}
}
suspend fun unmarkReferrerAsSpam(urlDomain: String) {
selectedDateProvider.getSelectedDate(statsGranularity)?.let {
referrersStore.unreportReferrerAsSpam(
statsSiteProvider.siteModel,
urlDomain,
statsGranularity,
LimitMode.Top(itemsToLoad),
it
)
}
}
data class SelectedGroup(val groupId: String? = null)
class ReferrersUseCaseFactory
@Inject constructor(
@Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher,
@Named(BG_THREAD) private val backgroundDispatcher: CoroutineDispatcher,
private val referrersStore: ReferrersStore,
private val statsSiteProvider: StatsSiteProvider,
private val selectedDateProvider: SelectedDateProvider,
private val contentDescriptionHelper: ContentDescriptionHelper,
private val statsUtils: StatsUtils,
private val resourceProvider: ResourceProvider,
private val analyticsTracker: AnalyticsTrackerWrapper,
private val popupMenuHandler: ReferrerPopupMenuHandler
) : GranularUseCaseFactory {
override fun build(granularity: StatsGranularity, useCaseMode: UseCaseMode) =
ReferrersUseCase(
granularity,
mainDispatcher,
backgroundDispatcher,
referrersStore,
statsSiteProvider,
selectedDateProvider,
analyticsTracker,
contentDescriptionHelper,
statsUtils,
resourceProvider,
useCaseMode,
popupMenuHandler
)
}
companion object {
private val COLOR_LIST = listOf(R.color.blue, R.color.blue_80, R.color.blue_5)
private const val GROUP_ID_WORDPRESS = "WordPress.com Reader"
private const val GROUP_ID_SEARCH = "Search Engines"
}
}