Skip to content

Commit

Permalink
Migrate HelpFragment to Compose UI (#3437)
Browse files Browse the repository at this point in the history
  • Loading branch information
@MiSikora
MiSikora authored Jan 15, 2025
1 parent 25d05dc commit fcf18b4
Show file tree
Hide file tree
Showing 14 changed files with 704 additions and 393 deletions.
1 change: 1 addition & 0 deletions modules/features/settings/build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ dependencies {
implementation(libs.compose.rxjava2)
implementation(libs.compose.ui)
implementation(libs.compose.ui.tooling.preview)
implementation(libs.compose.webview)
implementation(libs.coroutines.core)
implementation(libs.coroutines.rx2)
implementation(libs.firebase.analytics)
Expand Down
320 changes: 59 additions & 261 deletions ...s/features/settings/src/main/java/au/com/shiftyjelly/pocketcasts/settings/HelpFragment.kt
View file
Original file line number Diff line number Diff line change
@@ -1,137 +1,75 @@
package au.com.shiftyjelly.pocketcasts.settings

import android.annotation.SuppressLint
import android.content.ActivityNotFoundException
import android.content.Context
import android.content.Intent
import android.net.Uri
import android.os.Bundle
import android.view.LayoutInflater
import android.view.MenuItem
import android.view.View
import android.view.ViewGroup
import android.webkit.WebResourceError
import android.webkit.WebResourceRequest
import android.webkit.WebView
import android.webkit.WebViewClient
import android.widget.Button
import androidx.appcompat.app.AlertDialog
import androidx.appcompat.widget.Toolbar
import androidx.core.view.isVisible
import androidx.core.view.updatePadding
import androidx.fragment.app.viewModels
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.lifecycleScope
import androidx.lifecycle.repeatOnLifecycle
import au.com.shiftyjelly.pocketcasts.analytics.AnalyticsEvent
import au.com.shiftyjelly.pocketcasts.analytics.AnalyticsTracker
import au.com.shiftyjelly.pocketcasts.models.to.SubscriptionStatus
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.runtime.collectAsState
import androidx.compose.runtime.getValue
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalDensity
import androidx.fragment.compose.content
import au.com.shiftyjelly.pocketcasts.compose.AppThemeWithBackground
import au.com.shiftyjelly.pocketcasts.compose.theme
import au.com.shiftyjelly.pocketcasts.preferences.Settings
import au.com.shiftyjelly.pocketcasts.repositories.subscription.SubscriptionManager
import au.com.shiftyjelly.pocketcasts.repositories.support.Support
import au.com.shiftyjelly.pocketcasts.settings.status.StatusFragment
import au.com.shiftyjelly.pocketcasts.settings.viewmodel.HelpViewModel
import au.com.shiftyjelly.pocketcasts.ui.extensions.setupKeyboardModePan
import au.com.shiftyjelly.pocketcasts.ui.extensions.setupKeyboardModeResize
import au.com.shiftyjelly.pocketcasts.ui.helper.FragmentHostListener
import au.com.shiftyjelly.pocketcasts.views.extensions.findToolbar
import au.com.shiftyjelly.pocketcasts.views.extensions.setup
import au.com.shiftyjelly.pocketcasts.views.fragments.BaseFragment
import au.com.shiftyjelly.pocketcasts.views.helper.HasBackstack
import au.com.shiftyjelly.pocketcasts.views.helper.IntentUtil
import au.com.shiftyjelly.pocketcasts.views.helper.NavigationIcon.BackArrow
import au.com.shiftyjelly.pocketcasts.views.helper.UiUtil
import com.kevinnzou.web.WebView
import dagger.hilt.android.AndroidEntryPoint
import java.io.File
import java.util.Locale
import javax.inject.Inject
import kotlinx.coroutines.launch
import timber.log.Timber
import au.com.shiftyjelly.pocketcasts.localization.R as LR
import au.com.shiftyjelly.pocketcasts.views.R as VR

@AndroidEntryPoint
class HelpFragment : BaseFragment(), HasBackstack, Toolbar.OnMenuItemClickListener {

@Inject lateinit var analyticsTracker: AnalyticsTracker

@Inject lateinit var settings: Settings

@Inject lateinit var subscriptionManager: SubscriptionManager

@Inject lateinit var support: Support

val viewModel by viewModels<HelpViewModel>()
class HelpFragment : BaseFragment(), HasBackstack {
@Inject
lateinit var settings: Settings

private var webView: WebView? = null
private var loadedUrl: String? = null
private var loadingView: View? = null
private var layoutError: View? = null

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)

val toolbar = view.findToolbar()
toolbar.setup(
title = getString(LR.string.settings_title_help),
navigationIcon = BackArrow,
activity = activity,
theme = theme,
menu = R.menu.menu_help,
)
toolbar.setOnMenuItemClickListener(this)

viewLifecycleOwner.lifecycleScope.launch {
viewLifecycleOwner.lifecycle.repeatOnLifecycle(Lifecycle.State.CREATED) {
viewModel.uiState.collect { state ->
loadingView?.isVisible = state.isLoading
}
}
}
}

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
savedInstanceState?.let {
loadedUrl = savedInstanceState.getString("url")
}
}

override fun onSaveInstanceState(outState: Bundle) {
super.onSaveInstanceState(outState)

loadedUrl?.let {
outState.putString("url", loadedUrl)
}
}

@SuppressLint("SetJavaScriptEnabled")
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
val view = inflater.inflate(VR.layout.fragment_webview, container, false)

webView = (view.findViewById<View>(VR.id.webview) as WebView).apply {
webViewClient = SupportWebViewClient()
loadUrl(loadedUrl ?: Settings.INFO_FAQ_URL)
settings.javaScriptEnabled = true
settings.textZoom = 100
settings.domStorageEnabled = true
}
loadingView = view.findViewById(VR.id.progress_circle)
layoutError = view.findViewById(VR.id.layoutLoadingError)

view.findViewById<Button>(VR.id.btnContactSupport).setOnClickListener {
contactSupport()
}

viewLifecycleOwner.lifecycleScope.launch {
viewLifecycleOwner.repeatOnLifecycle(Lifecycle.State.STARTED) {
settings.bottomInset.collect {
view?.updatePadding(bottom = it)
}
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup?,
savedInstanceState: Bundle?,
) = content {
AppThemeWithBackground(theme.activeTheme) {
val bottomPadding by settings.bottomInset.collectAsState(0)

Column(
modifier = Modifier.fillMaxSize(),
) {
HelpPage(
activity = requireActivity(),
onShowLogs = {
(requireActivity() as FragmentHostListener).addFragment(LogsFragment())
},
onShowStatusPage = {
(requireActivity() as FragmentHostListener).addFragment(StatusFragment())
},
onGoBack = {
@Suppress("DEPRECATION")
activity?.onBackPressed()
},
onWebViewCreated = { webView = it },
onWebViewDisposed = { webView = null },
modifier = Modifier.weight(1f),
)
Box(
modifier = Modifier
.fillMaxWidth()
.height(LocalDensity.current.run { bottomPadding.toDp() }),
)
}
}

return view
}

override fun onAttach(context: Context) {
Expand All @@ -144,162 +82,22 @@ class HelpFragment : BaseFragment(), HasBackstack, Toolbar.OnMenuItemClickListen
setupKeyboardModePan()
}

override fun onMenuItemClick(item: MenuItem): Boolean =
when (item.itemId) {
R.id.menu_logs -> {
val fragment = LogsFragment()
(activity as? FragmentHostListener)?.addFragment(fragment)
true
}

R.id.menu_status_page -> {
val fragment = StatusFragment()
(activity as? FragmentHostListener)?.addFragment(fragment)
true
}

R.id.menu_export_database -> {
viewModel.onExportDatabaseMenuItemClick(::sendIntentFile)
true
}

else -> false
}

override fun onBackPressed(): Boolean {
webView?.let {
if (it.canGoBack()) {
it.goBack()
return true
}
}
return false
override fun onDestroyView() {
super.onDestroyView()
webView = null
}

override fun getBackstackCount(): Int {
return if (webView?.canGoBack() == true) 1 else 0
}

private inner class SupportWebViewClient : WebViewClient() {
@Suppress("NAME_SHADOWING")
override fun shouldOverrideUrlLoading(view: WebView, request: WebResourceRequest): Boolean {
var url = request.url.toString()
Timber.i("Webview loading url $url")

when {
url.lowercase(Locale.ROOT).contains("feedback") -> sendFeedbackEmail()
url.startsWith("mailto:[email protected]") || url.startsWith("mailto:[email protected]") -> {
contactSupport()
}
url.startsWith("https://support.pocketcasts.com") -> {
if (!url.contains("device=android")) {
url += (if (url.contains("?")) "&" else "?") + "device=android"
}
loadedUrl = url
view.loadUrl(url)
}
else -> {
val intent = Intent(Intent.ACTION_VIEW).apply { data = Uri.parse(url) }
startActivity(intent)
}
}

return true
}

override fun onLoadResource(view: WebView, url: String) {
loadingView?.let {
if (it.visibility != View.GONE && url.contains(".css")) {
it.visibility = View.GONE
}
}
super.onLoadResource(view, url)
}

override fun onReceivedError(view: WebView?, request: WebResourceRequest?, error: WebResourceError?) {
super.onReceivedError(view, request, error)
// only show the error message if the whole page fails, not just an asset
if (request == null || view == null || request.url.toString() != view.url) {
return
}
webView?.isVisible = false
loadingView?.isVisible = false
layoutError?.isVisible = true
}

override fun onPageFinished(view: WebView?, url: String?) {
super.onPageFinished(view, url)
loadingView?.isVisible = false
}
}

private fun sendFeedbackEmail() {
val context = context ?: return

viewLifecycleOwner.lifecycleScope.launch {
try {
val intent = support.shareLogs(
subject = "Android feedback.",
intro = "It's a great app, but it really needs...",
emailSupport = true,
context = context,
)
context.startActivity(intent)
} catch (e: ActivityNotFoundException) {
UiUtil.displayDialogNoEmailApp(context)
}
}

analyticsTracker.track(AnalyticsEvent.SETTINGS_LEAVE_FEEDBACK)
}

private fun contactSupport() {
when (subscriptionManager.getCachedStatus()) {
null, is SubscriptionStatus.Free -> useForumPopup()
is SubscriptionStatus.Paid -> sendSupportEmail()
}

analyticsTracker.track(AnalyticsEvent.SETTINGS_GET_SUPPORT)
}

private fun useForumPopup() {
val context = context ?: return
val forumUrl = "https://forums.pocketcasts.com/"
AlertDialog.Builder(context)
.setTitle(LR.string.settings_forums)
.setMessage(context.getString(LR.string.settings_forums_description, forumUrl))
.setPositiveButton(LR.string.settings_take_me_there) { _, _ ->
val intent =
Intent(Intent.ACTION_VIEW, Uri.parse(forumUrl))
startActivity(intent)
}
.show()
}

private fun sendSupportEmail() {
val context = context ?: return
viewLifecycleOwner.lifecycleScope.launch {
try {
val intent = support.shareLogs(
subject = "Android support.",
intro = "Hi there, just needed help with something...",
emailSupport = true,
context = context,
)
context.startActivity(intent)
} catch (e: ActivityNotFoundException) {
UiUtil.displayDialogNoEmailApp(context)
override fun onBackPressed(): Boolean {
return webView?.let {
val canGoBack = it.canGoBack()
if (canGoBack) {
it.goBack()
}
}
}

private fun sendIntentFile(file: File) {
val context = context ?: return
IntentUtil.sendIntent(
context = context,
file = file,
intentType = "application/zip",
errorMessage = context.getString(LR.string.settings_export_database_failed),
)
canGoBack
} ?: false
}
}
Loading

0 comments on commit fcf18b4

Please sign in to comment.