Download from Remote URL

1
/*
2
 *   Copyright © 2024-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.content.Context
11
import android.content.Intent
12
import android.os.Build
13
import android.os.Bundle
14
import android.view.ViewGroup
15
import android.webkit.WebResourceRequest
16
import android.webkit.WebView
17
import android.webkit.WebViewClient
18
import androidx.activity.compose.setContent
19
import androidx.appcompat.app.AppCompatActivity
20
import androidx.compose.runtime.Composable
21
import androidx.compose.ui.viewinterop.AndroidView
22
import com.pspdfkit.catalog.R
23
import com.pspdfkit.catalog.SdkExample
24
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
25
import com.pspdfkit.document.providers.UrlDataProvider
26
import com.pspdfkit.ui.PdfActivityIntentBuilder
27
import java.io.File
28
import java.net.URL
29

30
/**
31
 * This example illustrates how to make use of the [UrlDataProvider] to automatically download documents
32
 * from the internet and open them in Nutrient.
33
 */
34

35
class RemoteUrlExample(val context: Context) : SdkExample(context, R.string.remoteUrlDataProviderExampleTitle, R.string.remoteUrlDataProviderExampleDescription) {
36
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
37
        val intent = Intent(context, WebViewActivity::class.java)
38
        // make the catalogs default pdf configuration available to the webview activity
39
        intent.putExtra(WebViewActivity.EXTRA_CONFIG, configuration.build())
40
        context.startActivity(intent)
41
    }
42
}
43

44
class WebViewActivity : AppCompatActivity() {
45
    companion object {
46
        const val EXTRA_CONFIG = "_config"
47
    }
48

49
    private var configuration: PdfActivityConfiguration? = null
50

51
    override fun onCreate(savedInstanceState: Bundle?) {
52
        super.onCreate(savedInstanceState)
53

54
        extractConfiguration(savedInstanceState ?: intent.extras)
55

56
        setContent {
57
            // display a webview with a test page from our assets folder
58
            Webview(
59
                "file:///android_asset/url-dataprovider-example/testpage.html",
60
                object : WebViewClient() {
61

62
                    override fun shouldOverrideUrlLoading(
63
                        view: WebView?,
64
                        request: WebResourceRequest?
65
                    ): Boolean {
66
                        request?.url?.let { uri ->
67
                            // If a usable link was clicked, wrap the URL with a UrlDataProvider and open the document.
68
                            val scheme = uri.scheme
69
                            val uriString = uri.toString()
70
                            val uriFile = File(uriString)
71
                            val ext = uriFile.extension
72
                            when {
73
                                // we're only interested in http(s) links
74
                                !listOf("http", "https").contains(scheme) -> {
75
                                    null
76
                                }
77
                                ext.equals("pdf", ignoreCase = true) -> {
78
                                    // Using the URLDataProvider gives us more control over the download.
79
                                    // We can specify a target file to download the document to.
80
                                    // This avoids downloading the image everytime the URL is opened.
81
                                    PdfActivityIntentBuilder.fromDataProvider(
82
                                        this@WebViewActivity,
83
                                        UrlDataProvider(URL(uriString), File(filesDir, "myDocumentDownloads/${uriFile.name}"))
84
                                    )
85
                                }
86

87
                                listOf("jpg", "jpeg", "png").contains(ext) -> {
88
                                    // If we just pass along the URL, the nutrient library will recognize http/https scheme
89
                                    // and automatically download the file to the cache folder.
90
                                    // It will be downloaded everytime the URL is opened.
91
                                    PdfActivityIntentBuilder.fromImageUri(this@WebViewActivity, uri)
92
                                }
93

94
                                else -> null
95
                            }?.let { intentBuilder ->
96
                                configuration?.let {
97
                                    intentBuilder.configuration(it)
98
                                }
99

100
                                startActivity(intentBuilder.build())
101
                                return true
102
                            }
103
                        }
104
                        return super.shouldOverrideUrlLoading(view, request)
105
                    }
106
                }
107
            )
108
        }
109
    }
110

111
    override fun onSaveInstanceState(outState: Bundle) {
112
        super.onSaveInstanceState(outState)
113
        outState.putParcelable(EXTRA_CONFIG, configuration)
114
    }
115

116
    private fun extractConfiguration(bundle: Bundle?) {
117
        if (bundle == null) return
118
        configuration = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
119
            bundle.getParcelable(EXTRA_CONFIG, PdfActivityConfiguration::class.java)
120
        } else {
121
            @Suppress("DEPRECATION")
122
            bundle.getParcelable(EXTRA_CONFIG)
123
        }
124
    }
125

126
    /**
127
     * A composable function that wraps a WebView.
128
     */
129
    @Composable
130
    fun Webview(url: String, client: WebViewClient? = null) {
131
        AndroidView(
132
            factory = {
133
                WebView(it).apply {
134
                    layoutParams = ViewGroup.LayoutParams(
135
                        ViewGroup.LayoutParams.MATCH_PARENT,
136
                        ViewGroup.LayoutParams.MATCH_PARENT
137
                    )
138
                    if (client != null) {
139
                        webViewClient = client
140
                    }
141
                }
142
            },
143
            update = {
144
                it.loadUrl(url)
145
            }
146
        )
147
    }
148
}