Merge branch '1353-Refactor_privacy_score_calculation_code' into 'main' (f763809b) · Commits · e / os / App Lounge

app/src/main/java/foundation/e/apps/data/exodus/repositories/AppPrivacyInfoRepositoryImpl.kt

+0 −33

Original line number	Diff line number	Diff line
		@@ -42,14 +42,6 @@ class AppPrivacyInfoRepositoryImpl @Inject constructor(
		private val trackerDao: TrackerDao
		) : IAppPrivacyInfoRepository {
		companion object {
		private const val MAX_TRACKER_SCORE = 9
		private const val MIN_TRACKER_SCORE = 0
		private const val MAX_PERMISSION_SCORE = 10
		private const val MIN_PERMISSION_SCORE = 0
		private const val THRESHOLD_OF_NON_ZERO_TRACKER_SCORE = 5
		private const val THRESHOLD_OF_NON_ZERO_PERMISSION_SCORE = 9
		private const val FACTOR_OF_PERMISSION_SCORE = 0.2
		private const val DIVIDER_OF_PERMISSION_SCORE = 2.0
		private const val DATE_FORMAT = "ddMMyyyy"
		private const val SOURCE_FDROID = "fdroid"
		private const val SOURCE_GOOGLE = "google"
		@@ -192,29 +184,4 @@ class AppPrivacyInfoRepositoryImpl @Inject constructor(
		latestTrackerData.trackers.contains(it.id)
		}.map { it.name }
		}

		override fun calculatePrivacyScore(fusedApp: FusedApp): Int {
		if (fusedApp.permsFromExodus == LIST_OF_NULL) {
		return -1
		}

		val calculateTrackersScore = calculateTrackersScore(fusedApp.trackers.size)
		val calculatePermissionsScore = calculatePermissionsScore(
		countAndroidPermissions(fusedApp)
		)
		return calculateTrackersScore + calculatePermissionsScore
		}

		private fun countAndroidPermissions(fusedApp: FusedApp) =
		fusedApp.permsFromExodus.filter { it.contains("android.permission") }.size

		private fun calculateTrackersScore(numberOfTrackers: Int): Int {
		return if (numberOfTrackers > THRESHOLD_OF_NON_ZERO_TRACKER_SCORE) MIN_TRACKER_SCORE else MAX_TRACKER_SCORE - numberOfTrackers
		}

		private fun calculatePermissionsScore(numberOfPermission: Int): Int {
		return if (numberOfPermission > THRESHOLD_OF_NON_ZERO_PERMISSION_SCORE) MIN_PERMISSION_SCORE else round(
		FACTOR_OF_PERMISSION_SCORE * ceil((MAX_PERMISSION_SCORE - numberOfPermission) / DIVIDER_OF_PERMISSION_SCORE)
		).toInt()
		}
		}

app/src/main/java/foundation/e/apps/data/exodus/repositories/IAppPrivacyInfoRepository.kt

+0 −1

Original line number	Diff line number	Diff line
		@@ -6,5 +6,4 @@ import foundation.e.apps.data.fused.data.FusedApp

		interface IAppPrivacyInfoRepository {
		suspend fun getAppPrivacyInfo(fusedApp: FusedApp, appHandle: String): Result<AppPrivacyInfo>
		fun calculatePrivacyScore(fusedApp: FusedApp): Int
		}

app/src/main/java/foundation/e/apps/data/exodus/repositories/PrivacyScoreRepository.kt

0 → 100644

+26 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright MURENA SAS 2023
		* Apps Quickly and easily install Android apps onto your device!
		*
		* 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 <https://www.gnu.org/licenses/>.
		*/

		package foundation.e.apps.data.exodus.repositories

		import foundation.e.apps.data.fused.data.FusedApp

		interface PrivacyScoreRepository {

		fun calculatePrivacyScore(fusedApp: FusedApp): Int
		}

app/src/main/java/foundation/e/apps/data/exodus/repositories/PrivacyScoreRepositoryImpl.kt

0 → 100644

+68 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright MURENA SAS 2023
		* Apps Quickly and easily install Android apps onto your device!
		*
		* 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 <https://www.gnu.org/licenses/>.
		*/

		package foundation.e.apps.data.exodus.repositories

		import foundation.e.apps.data.fused.data.FusedApp
		import foundation.e.apps.di.CommonUtilsModule
		import javax.inject.Inject
		import javax.inject.Singleton
		import kotlin.math.ceil
		import kotlin.math.round

		@Singleton
		class PrivacyScoreRepositoryImpl @Inject constructor() : PrivacyScoreRepository {

		override fun calculatePrivacyScore(fusedApp: FusedApp): Int {
		if (fusedApp.permsFromExodus == CommonUtilsModule.LIST_OF_NULL) {
		return -1
		}

		val calculateTrackersScore = calculateTrackersScore(fusedApp.trackers.size)
		val calculatePermissionsScore = calculatePermissionsScore(
		countAndroidPermissions(fusedApp)
		)
		return calculateTrackersScore + calculatePermissionsScore
		}

		private fun calculateTrackersScore(numberOfTrackers: Int): Int {
		return if (numberOfTrackers > THRESHOLD_OF_NON_ZERO_TRACKER_SCORE) MIN_TRACKER_SCORE else MAX_TRACKER_SCORE - numberOfTrackers
		}

		private fun countAndroidPermissions(fusedApp: FusedApp) =
		fusedApp.permsFromExodus.filter { it.contains("android.permission") }.size

		private fun calculatePermissionsScore(numberOfPermission: Int): Int {
		return if (numberOfPermission > THRESHOLD_OF_NON_ZERO_PERMISSION_SCORE) MIN_PERMISSION_SCORE else round(
		FACTOR_OF_PERMISSION_SCORE * ceil((MAX_PERMISSION_SCORE - numberOfPermission) / DIVIDER_OF_PERMISSION_SCORE)
		).toInt()
		}

		// please do not put in the top of the class, as it can break the privacy calculation source code link.
		// for more info: https://gitlab.e.foundation/e/os/backlog/-/issues/1353
		companion object {
		private const val MAX_TRACKER_SCORE = 9
		private const val MIN_TRACKER_SCORE = 0
		private const val MAX_PERMISSION_SCORE = 10
		private const val MIN_PERMISSION_SCORE = 0
		private const val THRESHOLD_OF_NON_ZERO_TRACKER_SCORE = 5
		private const val THRESHOLD_OF_NON_ZERO_PERMISSION_SCORE = 9
		private const val FACTOR_OF_PERMISSION_SCORE = 0.2
		private const val DIVIDER_OF_PERMISSION_SCORE = 2.0
		}
		}

app/src/main/java/foundation/e/apps/di/RepositoryModule.kt

+6 −0

Original line number	Diff line number	Diff line
		@@ -6,6 +6,8 @@ import dagger.hilt.InstallIn
		import dagger.hilt.components.SingletonComponent
		import foundation.e.apps.data.exodus.repositories.AppPrivacyInfoRepositoryImpl
		import foundation.e.apps.data.exodus.repositories.IAppPrivacyInfoRepository
		import foundation.e.apps.data.exodus.repositories.PrivacyScoreRepository
		import foundation.e.apps.data.exodus.repositories.PrivacyScoreRepositoryImpl
		import foundation.e.apps.data.fdroid.FdroidRepository
		import foundation.e.apps.data.fdroid.IFdroidRepository
		import foundation.e.apps.data.fused.FusedApi
		@@ -32,4 +34,8 @@ interface RepositoryModule {
		@Singleton
		@Binds
		fun getFusedApi(fusedApiImpl: FusedApiImpl): FusedApi

		@Singleton
		@Binds
		fun getPrivacyScoreRepository(privacyScoreRepositoryImpl: PrivacyScoreRepositoryImpl): PrivacyScoreRepository
		}