Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add Network module in Core2 #199

Merged
merged 2 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Core2/Matomo/proguard-rules.pro
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
#-renamesourcefileattribute SourceFile
36 changes: 36 additions & 0 deletions Core2/Network/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
plugins {
alias(libs.plugins.android.library)
alias(libs.plugins.kotlin.android)
}

android {
namespace = "com.infomaniak.network"
compileSdk = 34

defaultConfig {
minSdk = 24

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles("consumer-rules.pro")
}

buildTypes {
release {
isMinifyEnabled = false
proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
}
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = "1.8"
}
}

dependencies {
implementation(project(":Core2:Sentry"))

implementation(libs.androidx.core.ktx)
}
Empty file.
21 changes: 21 additions & 0 deletions Core2/Network/proguard-rules.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
22 changes: 22 additions & 0 deletions Core2/Network/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!--
~ Infomaniak SwissTransfer - Android
~ Copyright (C) 2024 Infomaniak Network SA
~
~ This program is free software: you can redistribute it and/or modify
~ it under the terms of the GNU General Public License as published by
~ the Free Software Foundation, either version 3 of the License, or
~ (at your option) any later version.
~
~ This program is distributed in the hope that it will be useful,
~ but WITHOUT ANY WARRANTY; without even the implied warranty of
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
~ GNU General Public License for more details.
~
~ You should have received a copy of the GNU General Public License
~ along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

</manifest>
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/*
* Infomaniak Core - Android
* Copyright (C) 2024 Infomaniak Network SA
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.infomaniak.network

import android.content.Context
import android.net.ConnectivityManager
import android.net.ConnectivityManager.NetworkCallback
import android.net.Network
import android.net.NetworkCapabilities
import android.net.NetworkRequest
import android.os.Build
import com.infomaniak.sentry.SentryLog
import io.sentry.Sentry
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.channels.awaitClose
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.callbackFlow
import kotlinx.coroutines.launch
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import kotlinx.coroutines.withContext

class NetworkAvailability(private val context: Context, private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO) {

private val connectivityManager by lazy { context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager }
private val mutex = Mutex()

val isNetworkAvailable: Flow<Boolean> = callbackFlow {
val networks = mutableListOf<Network>()

val callback = object : NetworkCallback() {

override fun onAvailable(network: Network) {
launch {
mutex.withLock {
networks.add(network)
send(element = hasAvailableNetwork(networks))
}
}
}

override fun onLost(network: Network) {
launch {
mutex.withLock {
networks.remove(network)
send(element = hasAvailableNetwork(networks))
}
}
}
}

launch(ioDispatcher) {
send(getInitialNetworkAvailability(connectivityManager))
}

registerNetworkCallback(connectivityManager, callback, ::send)

awaitClose { unregisterNetworkCallback(connectivityManager, callback) }
}

private suspend fun registerNetworkCallback(
connectivityManager: ConnectivityManager,
callback: NetworkCallback,
send: suspend (Boolean) -> Unit,
) {
runCatching {
connectivityManager.registerNetworkCallback(networkRequestBuilder(), callback)
}.onFailure { exception ->
// Fix potential Exception thrown by ConnectivityManager on Android 11.
// Already fixed in Android S and above.
// https://issuetracker.google.com/issues/175055271
SentryLog.e(TAG, "Android 11 exception", exception)
Sentry.captureException(exception)
send(false)
}
}

private fun unregisterNetworkCallback(connectivityManager: ConnectivityManager, callback: NetworkCallback) {
runCatching {
connectivityManager.unregisterNetworkCallback(callback)
}.onFailure { exception ->
Sentry.captureException(exception)
}
}

private fun getInitialNetworkAvailability(connectivityManager: ConnectivityManager): Boolean {
return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
connectivityManager.activeNetwork?.let(::hasInternetConnectivity) ?: false
} else {
connectivityManager.activeNetworkInfo?.isConnected ?: false
}
}

private fun networkRequestBuilder(): NetworkRequest {
return NetworkRequest.Builder().apply {
addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)
}.build()
}

private fun hasInternetConnectivity(network: Network) = runCatching {
network.getByName(ROOT_SERVER_URL) != null
}.getOrDefault(false)

private suspend fun hasAvailableNetwork(networks: List<Network>) = withContext(ioDispatcher) {
networks.any(::hasInternetConnectivity)
}

companion object {
private val TAG = NetworkAvailability::class.java.simpleName
private const val ROOT_SERVER_URL = "a.root-servers.net"
}
}
1 change: 1 addition & 0 deletions app/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ dependencies {
implementation(project(":Core2"))
implementation(project(":Core2:Sentry"))
implementation(project(":Core2:Matomo"))
implementation(project(":Core2:Network"))
implementation(project(":FileTypes"))
implementation(kotlin("reflect"))

Expand Down
1 change: 1 addition & 0 deletions settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ include(":app")
include(":Core2")
include(":Core2:Sentry")
include(":Core2:Matomo")
include(":Core2:Network")
include(":FileTypes")