Add network access module

io7m · io7m · commit e9aa0184505d · 2026-03-04T14:19:51.000Z
Affects: https://ebce-lyrasis.atlassian.net/browse/PP-3688
diff --git a/org.librarysimplified.http.api/build.gradle.kts b/org.librarysimplified.http.api/build.gradle.kts
@@ -3,9 +3,11 @@ dependencies {
 
     compileOnly(libs.osgi.bundle.annotation)
 
+    implementation(libs.io7m.jattribute.core)
     implementation(libs.irradia.mime.api)
     implementation(libs.jackson.core)
     implementation(libs.joda.time)
     implementation(libs.kotlin.reflect)
     implementation(libs.kotlin.stdlib)
+    implementation(libs.slf4j)
 }
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPClientConfiguration.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPClientConfiguration.kt
@@ -38,4 +38,10 @@ data class LSHTTPClientConfiguration(
    */
 
   val proxy: Proxy = Proxy.NO_PROXY,
+
+  /**
+   * The network access interface.
+   */
+
+  val networkAccess: LSHTTPNetworkAccessType,
 )
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPClientType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPClientType.kt
@@ -29,4 +29,10 @@ interface LSHTTPClientType {
    */
 
   fun userAgent(): String
+
+  /**
+   * A view of the current network access.
+   */
+
+  val networkAccess: LSHTTPNetworkAccessType
 }
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAccess.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAccess.kt
@@ -0,0 +1,68 @@
+package org.librarysimplified.http.api
+
+import com.io7m.jattribute.core.AttributeReadableType
+import com.io7m.jattribute.core.Attributes
+import org.slf4j.LoggerFactory
+
+/**
+ * The main network access service.
+ */
+
+object LSHTTPNetworkAccess : LSHTTPNetworkAccessType {
+
+  private val logger =
+    LoggerFactory.getLogger(LSHTTPNetworkAccess::class.java)
+
+  private val attributes =
+    Attributes.create { x ->
+      this.logger.debug("Attribute handler raised exception: ", x)
+    }
+
+  private val wifiAvailableProp =
+    this.attributes.withValue(false)
+
+  private val cellularAvailableProp =
+    this.attributes.withValue(false)
+
+  private val wifiPermittedProp =
+    this.attributes.withValue(true)
+
+  private val cellularPermittedProp =
+    this.attributes.withValue(true)
+
+  override val wifiAvailable: AttributeReadableType<Boolean>
+    get() = this.wifiAvailableProp
+
+  override val cellularAvailable: AttributeReadableType<Boolean>
+    get() = this.cellularAvailableProp
+
+  override val wifiPermitted: AttributeReadableType<Boolean>
+    get() = this.wifiPermittedProp
+
+  override val cellularPermitted: AttributeReadableType<Boolean>
+    get() = this.cellularPermittedProp
+
+  override fun setWIFIPermitted(
+    permitted: Boolean,
+  ) {
+    this.wifiPermittedProp.set(permitted)
+  }
+
+  override fun setCellularPermitted(
+    permitted: Boolean,
+  ) {
+    this.cellularPermittedProp.set(permitted)
+  }
+
+  override fun setWIFIAvailable(
+    available: Boolean,
+  ) {
+    this.wifiAvailableProp.set(available)
+  }
+
+  override fun setCellularAvailable(
+    available: Boolean,
+  ) {
+    this.cellularAvailableProp.set(available)
+  }
+}
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAccessReadableType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAccessReadableType.kt
@@ -0,0 +1,24 @@
+package org.librarysimplified.http.api
+
+/**
+ * An observable interface that indicates the availability of different network types.
+ */
+
+interface LSHTTPNetworkAccessReadableType :
+  LSHTTPNetworkAvailabilityReadableType,
+  LSHTTPNetworkPolicyReadableType {
+  /**
+   * Determine if performing a download should be allowed given the current network availability
+   * and permissions.
+   */
+
+  fun canDownload(): Boolean {
+    if (this.wifiAvailable.get() && this.wifiPermitted.get()) {
+      return true
+    }
+    if (this.cellularAvailable.get() && this.cellularPermitted.get()) {
+      return true
+    }
+    return false
+  }
+}
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAccessType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAccessType.kt
@@ -0,0 +1,10 @@
+package org.librarysimplified.http.api
+
+/**
+ * An observable interface that indicates the availability of different network types.
+ */
+
+interface LSHTTPNetworkAccessType :
+  LSHTTPNetworkAccessReadableType,
+  LSHTTPNetworkPolicyType,
+  LSHTTPNetworkAvailabilityType
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAvailabilityReadableType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAvailabilityReadableType.kt
@@ -0,0 +1,14 @@
+package org.librarysimplified.http.api
+
+import com.io7m.jattribute.core.AttributeReadableType
+
+/**
+ * An observable interface that indicates the availability of different network types.
+ */
+
+interface LSHTTPNetworkAvailabilityReadableType {
+
+  val wifiAvailable: AttributeReadableType<Boolean>
+
+  val cellularAvailable: AttributeReadableType<Boolean>
+}
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAvailabilityType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkAvailabilityType.kt
@@ -0,0 +1,16 @@
+package org.librarysimplified.http.api
+
+/**
+ * An observable interface that indicates the availability of different network types.
+ */
+
+interface LSHTTPNetworkAvailabilityType : LSHTTPNetworkAvailabilityReadableType {
+
+  fun setWIFIAvailable(
+    available: Boolean,
+  )
+
+  fun setCellularAvailable(
+    available: Boolean,
+  )
+}
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkPolicyReadableType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkPolicyReadableType.kt
@@ -0,0 +1,14 @@
+package org.librarysimplified.http.api
+
+import com.io7m.jattribute.core.AttributeReadableType
+
+/**
+ * An observable interface that indicates the availability of different network types.
+ */
+
+interface LSHTTPNetworkPolicyReadableType {
+
+  val wifiPermitted: AttributeReadableType<Boolean>
+
+  val cellularPermitted: AttributeReadableType<Boolean>
+}
diff --git a/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkPolicyType.kt b/org.librarysimplified.http.api/src/main/java/org/librarysimplified/http/api/LSHTTPNetworkPolicyType.kt
@@ -0,0 +1,16 @@
+package org.librarysimplified.http.api
+
+/**
+ * An interface that indicates whether it is permitted to use different network types.
+ */
+
+interface LSHTTPNetworkPolicyType : LSHTTPNetworkPolicyReadableType {
+
+  fun setWIFIPermitted(
+    permitted: Boolean,
+  )
+
+  fun setCellularPermitted(
+    permitted: Boolean,
+  )
+}
diff --git a/org.librarysimplified.http.network_access/build.gradle.kts b/org.librarysimplified.http.network_access/build.gradle.kts
@@ -0,0 +1,17 @@
+dependencies {
+    coreLibraryDesugaring(libs.android.desugaring)
+
+    implementation(project(":org.librarysimplified.http.api"))
+
+    implementation(libs.io7m.jattribute.core)
+    implementation(libs.slf4j)
+}
+
+android {
+    buildFeatures.buildConfig = true
+
+    defaultConfig {
+        val versionName = project.extra["VERSION_NAME"] as String
+        buildConfigField("String", "NETWORK_ACCESS_VERSION_NAME", "\"${versionName}\"")
+    }
+}
diff --git a/org.librarysimplified.http.network_access/gradle.properties b/org.librarysimplified.http.network_access/gradle.properties
@@ -0,0 +1,5 @@
+POM_ARTIFACT_ID=org.librarysimplified.http.network_access
+POM_AUTOMATIC_MODULE_NAME=org.librarysimplified.http.network_access
+POM_DESCRIPTION=Library Simplified HTTP client (Network access service)
+POM_NAME=org.librarysimplified.http.network_access
+POM_PACKAGING=aar
diff --git a/org.librarysimplified.http.network_access/src/main/java/org/librarysimplified/http/network_access/LSHTTPNetworkAvailabilityService.kt b/org.librarysimplified.http.network_access/src/main/java/org/librarysimplified/http/network_access/LSHTTPNetworkAvailabilityService.kt
@@ -0,0 +1,107 @@
+package org.librarysimplified.http.network_access
+
+import android.app.Service
+import android.content.Intent
+import android.net.ConnectivityManager
+import android.net.Network
+import android.net.NetworkCapabilities
+import android.net.NetworkRequest
+import android.os.IBinder
+import org.librarysimplified.http.api.LSHTTPNetworkAccess
+import org.slf4j.LoggerFactory
+import java.util.concurrent.atomic.AtomicBoolean
+
+/**
+ * A service that monitors network availability.
+ */
+
+class LSHTTPNetworkAvailabilityService : Service() {
+
+  private val logger =
+    LoggerFactory.getLogger(LSHTTPNetworkAvailabilityService::class.java)
+
+  companion object {
+    private val isRunning =
+      AtomicBoolean(false)
+
+    fun isRunning(): Boolean {
+      return this.isRunning.get()
+    }
+  }
+
+  override fun onStartCommand(
+    intent: Intent?,
+    flags: Int,
+    startId: Int,
+  ): Int {
+    if (isRunning.compareAndSet(false, true)) {
+      this.logger.debug("Starting network access service…")
+
+      try {
+        val cellularRequest =
+          NetworkRequest.Builder()
+            .addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
+            .addTransportType(NetworkCapabilities.TRANSPORT_CELLULAR)
+            .build()
+
+        val wifiRequest =
+          NetworkRequest.Builder()
+            .addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
+            .addTransportType(NetworkCapabilities.TRANSPORT_WIFI)
+            .build()
+
+        val cellularCallback =
+          object : ConnectivityManager.NetworkCallback() {
+            override fun onAvailable(network: Network) {
+              super.onAvailable(network)
+              LSHTTPNetworkAccess.setCellularAvailable(true)
+            }
+
+            override fun onLost(network: Network) {
+              super.onLost(network)
+              LSHTTPNetworkAccess.setCellularAvailable(false)
+            }
+
+            override fun onUnavailable() {
+              super.onUnavailable()
+              LSHTTPNetworkAccess.setCellularAvailable(false)
+            }
+          }
+
+        val wifiCallback =
+          object : ConnectivityManager.NetworkCallback() {
+            override fun onAvailable(network: Network) {
+              super.onAvailable(network)
+              LSHTTPNetworkAccess.setWIFIAvailable(true)
+            }
+
+            override fun onLost(network: Network) {
+              super.onLost(network)
+              LSHTTPNetworkAccess.setWIFIAvailable(false)
+            }
+
+            override fun onUnavailable() {
+              super.onUnavailable()
+              LSHTTPNetworkAccess.setWIFIAvailable(false)
+            }
+          }
+
+        val connectivityManager =
+          this.getSystemService(ConnectivityManager::class.java) as ConnectivityManager
+
+        connectivityManager.requestNetwork(wifiRequest, wifiCallback)
+        connectivityManager.requestNetwork(cellularRequest, cellularCallback)
+      } catch (e: Throwable) {
+        this.logger.debug("Failed to start network service: ", e)
+        isRunning.set(false)
+      }
+    } else {
+      this.logger.debug("Ignoring redundant request to start network service.")
+    }
+    return super.onStartCommand(intent, flags, startId)
+  }
+
+  override fun onBind(intent: Intent?): IBinder? {
+    return null
+  }
+}
diff --git a/org.librarysimplified.http.tests/build.gradle.kts b/org.librarysimplified.http.tests/build.gradle.kts
@@ -16,6 +16,7 @@ dependencies {
         libs.bytebuddy,
         libs.bytebuddy.agent,
         libs.commons.compress,
+        libs.io7m.jattribute.core,
         libs.irradia.mime.api,
         libs.irradia.mime.vanilla,
         libs.jackson.annotations,
@@ -30,8 +31,8 @@ dependencies {
         libs.junit.platform.engine,
         libs.kotlin.reflect,
         libs.kotlin.stdlib,
-        libs.logback.core,
         libs.logback.classic,
+        libs.logback.core,
         libs.mockito.core,
         libs.mockito.kotlin,
         libs.objenesis,
diff --git a/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/LSHTTPClientContract.kt b/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/LSHTTPClientContract.kt
@@ -15,6 +15,7 @@ import org.librarysimplified.http.api.LSHTTPAuthorizationBasic
 import org.librarysimplified.http.api.LSHTTPAuthorizationBearerToken
 import org.librarysimplified.http.api.LSHTTPClientConfiguration
 import org.librarysimplified.http.api.LSHTTPClientProviderType
+import org.librarysimplified.http.api.LSHTTPNetworkAccess
 import org.librarysimplified.http.api.LSHTTPProblemReportParserFactoryType
 import org.librarysimplified.http.api.LSHTTPRequestBuilderType.AllowRedirects.ALLOW_UNSAFE_REDIRECTS
 import org.librarysimplified.http.api.LSHTTPRequestBuilderType.AllowRedirects.DISALLOW_REDIRECTS
@@ -60,6 +61,7 @@ abstract class LSHTTPClientContract {
       LSHTTPClientConfiguration(
         applicationName = "HttpTests",
         applicationVersion = "1.0.0",
+        networkAccess = LSHTTPNetworkAccess
       )
 
     this.server.start(30000)
diff --git a/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/LSHTTPNetworkAccessTest.kt b/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/LSHTTPNetworkAccessTest.kt
diff --git a/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/bearer_token/LSSimplifiedBearerTokenNegotiationTest.kt b/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/bearer_token/LSSimplifiedBearerTokenNegotiationTest.kt
diff --git a/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/downloads/LSHTTPDownloadsContract.kt b/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/downloads/LSHTTPDownloadsContract.kt
diff --git a/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/refresh_token/LSHTTPRefreshTokenContract.kt b/org.librarysimplified.http.tests/src/test/java/org/librarysimplified/http/tests/refresh_token/LSHTTPRefreshTokenContract.kt
diff --git a/org.librarysimplified.http.vanilla/src/main/java/org/librarysimplified/http/vanilla/internal/LSHTTPClient.kt b/org.librarysimplified.http.vanilla/src/main/java/org/librarysimplified/http/vanilla/internal/LSHTTPClient.kt
diff --git a/org.thepalaceproject.android.platform b/org.thepalaceproject.android.platform
diff --git a/settings.gradle.kts b/settings.gradle.kts
