feat(#95): allow to override local app settings

README.md

@@ -21,7 +21,8 @@ Based on [datasync module](https://github.com/PnX-SI/gn_mobile_core) to synchron
 
 ## Settings
 
-Example:
+The app settings file is automatically updated when the application is started, as soon as the *GeoNature* URL is defined.
+This settings file `settings_occtax.json` can be found in the `Android/data/fr.geonature.occtax2/` directory of the terminal's main storage. Example:
 
 ```json
 {
@@ -268,6 +269,37 @@ Each property may be a simple string representing the nomenclature attribute to
   }
   ```
 
+### Override parameters from app settings
+
+As this settings file is updated automatically, we advise you not to update it directly by hand.
+To do this, you can overwrite the values from the *GeoNature* server by creating a `settings_occtax.local.json` file in the same location as the app settings file.
+Then simply copy the parameters to be overwritten, respecting the JSON structure of the app settings file. Example, to override map layers configuration:
+
+```json
+{
+  "map": {
+    "layers": [
+      {
+        "label": "OpenStreetMap",
+        "source": [
+          "https://a.tile.openstreetmap.org",
+          "https://b.tile.openstreetmap.org",
+          "https://c.tile.openstreetmap.org"
+        ]
+      },
+      {
+        "label": "My awesome layer",
+        "source": "custom.mbtiles"
+      }
+    ]
+  }
+}
+```
+
+**⚠ Note:** When using such a configuration, which can potentially replace all the application's parameters, it's your responsibility to ensure that the final configuration is always valid and keeps pace with any changes made to *GeoNature*.
+
+In case of errors, if the final configuration is incorrect, the application will automatically ignore the settings file that allows you to replace the parameters and load the default configuration from *GeoNature*. Any errors reported can be found in the application logs.
+
 ## Upgrade git sub modules
 
 Do **NOT** modify directly any git sub modules (e.g. `commons`, `compat`, `mountpoint`, `viewpager`

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/data/INomenclatureSettingsLocalDataSource.kt

@@ -1,7 +1,7 @@
 package fr.geonature.occtax.features.nomenclature.data
 
 import fr.geonature.occtax.features.nomenclature.domain.EditableField
-import fr.geonature.occtax.settings.PropertySettings
+import fr.geonature.occtax.features.settings.domain.PropertySettings
 
 /**
  * Local data source about nomenclature types settings.

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/data/NomenclatureSettingsLocalDataSourceImpl.kt

@@ -4,7 +4,7 @@ import fr.geonature.occtax.features.nomenclature.domain.EditableField
 import fr.geonature.occtax.features.record.domain.AllMediaRecord
 import fr.geonature.occtax.features.record.domain.CountingRecord
 import fr.geonature.occtax.features.record.domain.PropertyValue
-import fr.geonature.occtax.settings.PropertySettings
+import fr.geonature.occtax.features.settings.domain.PropertySettings
 
 /**
  * Default implementation of [INomenclatureSettingsLocalDataSource].

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/presentation/NomenclatureViewModel.kt

@@ -10,7 +10,7 @@ import fr.geonature.commons.lifecycle.BaseViewModel
 import fr.geonature.occtax.features.nomenclature.domain.EditableField
 import fr.geonature.occtax.features.nomenclature.usecase.GetEditableFieldsUseCase
 import fr.geonature.occtax.features.nomenclature.usecase.GetNomenclatureValuesByTypeAndTaxonomyUseCase
-import fr.geonature.occtax.settings.PropertySettings
+import fr.geonature.occtax.features.settings.domain.PropertySettings
 import org.tinylog.Logger
 import javax.inject.Inject
 

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/repository/INomenclatureRepository.kt

@@ -1,7 +1,7 @@
 package fr.geonature.occtax.features.nomenclature.repository
 
 import fr.geonature.occtax.features.nomenclature.domain.EditableField
-import fr.geonature.occtax.settings.PropertySettings
+import fr.geonature.occtax.features.settings.domain.PropertySettings
 import fr.geonature.commons.features.nomenclature.repository.INomenclatureRepository as IBaseNomenclatureRepository
 
 /**

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/repository/NomenclatureRepositoryImpl.kt

@@ -6,7 +6,7 @@ import fr.geonature.commons.features.nomenclature.error.NomenclatureException
 import fr.geonature.occtax.features.nomenclature.data.INomenclatureSettingsLocalDataSource
 import fr.geonature.occtax.features.nomenclature.domain.EditableField
 import fr.geonature.occtax.features.record.domain.PropertyValue
-import fr.geonature.occtax.settings.PropertySettings
+import fr.geonature.occtax.features.settings.domain.PropertySettings
 import org.tinylog.Logger
 import fr.geonature.commons.features.nomenclature.repository.NomenclatureRepositoryImpl as BaseNomenclatureRepositoryImpl
 

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/usecase/GetEditableFieldsUseCase.kt

@@ -8,7 +8,7 @@ import fr.geonature.occtax.features.nomenclature.domain.EditableField
 import fr.geonature.occtax.features.nomenclature.repository.IAdditionalFieldRepository
 import fr.geonature.occtax.features.nomenclature.repository.IDefaultPropertyValueRepository
 import fr.geonature.occtax.features.nomenclature.repository.INomenclatureRepository
-import fr.geonature.occtax.settings.PropertySettings
+import fr.geonature.occtax.features.settings.domain.PropertySettings
 import javax.inject.Inject
 
 /**

occtax/src/main/java/fr/geonature/occtax/features/record/ObservationRecordModule.kt

@@ -9,7 +9,6 @@ import dagger.hilt.components.SingletonComponent
 import fr.geonature.commons.data.GeoNatureModuleName
 import fr.geonature.commons.features.nomenclature.data.INomenclatureLocalDataSource
 import fr.geonature.commons.features.taxon.data.ITaxonLocalDataSource
-import fr.geonature.commons.settings.IAppSettingsManager
 import fr.geonature.datasync.api.IGeoNatureAPIClient
 import fr.geonature.datasync.auth.IAuthManager
 import fr.geonature.occtax.api.IOcctaxAPIClient
@@ -25,7 +24,7 @@ import fr.geonature.occtax.features.record.repository.ISynchronizeObservationRec
 import fr.geonature.occtax.features.record.repository.MediaRecordRepositoryImpl
 import fr.geonature.occtax.features.record.repository.ObservationRecordRepositoryImpl
 import fr.geonature.occtax.features.record.repository.SynchronizeObservationRecordRepositoryImpl
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.repository.IAppSettingsRepository
 import javax.inject.Singleton
 
 /**
@@ -85,7 +84,7 @@ object ObservationRecordModule {
         @ApplicationContext appContext: Context,
         geoNatureAPIClient: IGeoNatureAPIClient,
         authManager: IAuthManager,
-        appSettingsManager: IAppSettingsManager<AppSettings>,
+        appSettingsRepository: IAppSettingsRepository,
         nomenclatureLocalDataSource: INomenclatureLocalDataSource,
         observationRecordLocalDataSource: IObservationRecordLocalDataSource,
         observationRecordRemoteDataSource: IObservationRecordRemoteDataSource,
@@ -95,7 +94,7 @@ object ObservationRecordModule {
             appContext,
             geoNatureAPIClient,
             authManager,
-            appSettingsManager,
+            appSettingsRepository,
             nomenclatureLocalDataSource,
             observationRecordLocalDataSource,
             observationRecordRemoteDataSource,

occtax/src/main/java/fr/geonature/occtax/features/record/data/IObservationRecordLocalDataSource.kt

@@ -2,7 +2,7 @@ package fr.geonature.occtax.features.record.data
 
 import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.error.ObservationRecordException
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 
 /**
  * Local data source about [ObservationRecord].

occtax/src/main/java/fr/geonature/occtax/features/record/data/IObservationRecordRemoteDataSource.kt

@@ -2,7 +2,7 @@ package fr.geonature.occtax.features.record.data
 
 import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.domain.TaxonRecord
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 
 /**
  * Remote data source about [ObservationRecord].

occtax/src/main/java/fr/geonature/occtax/features/record/data/ObservationRecordLocalDataSourceImpl.kt

@@ -9,7 +9,7 @@ import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.error.ObservationRecordException
 import fr.geonature.occtax.features.record.io.ObservationRecordJsonReader
 import fr.geonature.occtax.features.record.io.ObservationRecordJsonWriter
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.asFlow

occtax/src/main/java/fr/geonature/occtax/features/record/data/ObservationRecordRemoteDataSourceImpl.kt

@@ -5,7 +5,7 @@ import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.error.ObservationRecordException
 import fr.geonature.occtax.features.record.io.ObservationRecordJsonWriter
 import fr.geonature.occtax.features.record.io.TaxonRecordJsonWriter
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 import org.json.JSONObject
 import retrofit2.await
 import retrofit2.awaitResponse

occtax/src/main/java/fr/geonature/occtax/features/record/io/ObservationRecordJsonWriter.kt

@@ -7,8 +7,8 @@ import fr.geonature.maps.jts.geojson.io.GeoJsonWriter
 import fr.geonature.occtax.features.record.domain.DatesRecord
 import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.domain.PropertyValue
-import fr.geonature.occtax.settings.AppSettings
-import fr.geonature.occtax.settings.InputDateSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
+import fr.geonature.occtax.features.settings.domain.InputDateSettings
 import java.io.IOException
 import java.io.StringWriter
 import java.io.Writer

occtax/src/main/java/fr/geonature/occtax/features/record/io/TaxonRecordJsonWriter.kt

@@ -7,7 +7,7 @@ import fr.geonature.occtax.features.record.domain.CountingRecord
 import fr.geonature.occtax.features.record.domain.MediaRecord
 import fr.geonature.occtax.features.record.domain.PropertyValue
 import fr.geonature.occtax.features.record.domain.TaxonRecord
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 import java.io.IOException
 import java.io.StringWriter
 import java.io.Writer

occtax/src/main/java/fr/geonature/occtax/features/record/presentation/ObservationRecordViewModel.kt

@@ -21,7 +21,7 @@ import fr.geonature.occtax.features.record.usecase.ExportObservationRecordUseCas
 import fr.geonature.occtax.features.record.usecase.GetAllObservationRecordsUseCase
 import fr.geonature.occtax.features.record.usecase.SaveObservationRecordUseCase
 import fr.geonature.occtax.features.record.worker.SynchronizeObservationRecordsWorker
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 import kotlinx.coroutines.delay
 import org.tinylog.kotlin.Logger
 import java.util.UUID

occtax/src/main/java/fr/geonature/occtax/features/record/repository/IObservationRecordRepository.kt

@@ -1,7 +1,7 @@
 package fr.geonature.occtax.features.record.repository
 
 import fr.geonature.occtax.features.record.domain.ObservationRecord
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 
 /**
  * [ObservationRecord] repository.

occtax/src/main/java/fr/geonature/occtax/features/record/repository/ObservationRecordRepositoryImpl.kt

@@ -3,7 +3,7 @@ package fr.geonature.occtax.features.record.repository
 import fr.geonature.commons.features.taxon.data.ITaxonLocalDataSource
 import fr.geonature.occtax.features.record.data.IObservationRecordLocalDataSource
 import fr.geonature.occtax.features.record.domain.ObservationRecord
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 
 /**
  * Default implementation of [IObservationRecordRepository].

occtax/src/main/java/fr/geonature/occtax/features/record/repository/SynchronizeObservationRecordRepositoryImpl.kt

@@ -3,8 +3,6 @@ package fr.geonature.occtax.features.record.repository
 import android.content.Context
 import fr.geonature.commons.data.entity.Nomenclature
 import fr.geonature.commons.features.nomenclature.data.INomenclatureLocalDataSource
-import fr.geonature.commons.settings.IAppSettingsManager
-import fr.geonature.commons.settings.error.AppSettingsException
 import fr.geonature.datasync.api.IGeoNatureAPIClient
 import fr.geonature.datasync.api.model.AuthUser
 import fr.geonature.datasync.auth.IAuthManager
@@ -17,7 +15,8 @@ import fr.geonature.occtax.features.record.data.IObservationRecordRemoteDataSour
 import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.domain.TaxonRecord
 import fr.geonature.occtax.features.record.error.ObservationRecordException
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.error.AppSettingsException
+import fr.geonature.occtax.features.settings.repository.IAppSettingsRepository
 import org.tinylog.kotlin.Logger
 import retrofit2.await
 import retrofit2.awaitResponse
@@ -34,7 +33,7 @@ class SynchronizeObservationRecordRepositoryImpl(
     private val context: Context,
     private val geoNatureAPIClient: IGeoNatureAPIClient,
     private val authManager: IAuthManager,
-    private val appSettingsManager: IAppSettingsManager<AppSettings>,
+    private val appSettingsRepository: IAppSettingsRepository,
     private val nomenclatureLocalDataSource: INomenclatureLocalDataSource,
     private val observationRecordLocalDataSource: IObservationRecordLocalDataSource,
     private val observationRecordRemoteDataSource: IObservationRecordRemoteDataSource,
@@ -49,11 +48,16 @@ class SynchronizeObservationRecordRepositoryImpl(
         val authUser = authManager.getAuthLogin()?.user
             ?: return Result.failure(AuthException.NotConnectedException)
 
-        val appSettings = appSettingsManager.loadAppSettings()
-            ?: return Result.failure(AppSettingsException.NoAppSettingsFoundLocallyException)
+        val appSettings = appSettingsRepository.loadAppSettings()
+            .let {
+                it.getOrNull() ?: return Result.failure(
+                    it.exceptionOrNull()
+                        ?.let { t -> if (t is AppSettingsException.MissingAttributeException && t.attributeName == "sync") DataSyncSettingsNotFoundException() else t }
+                        ?: AppSettingsException.NotFoundException
+                )
+            }
 
         val dataSyncSettings = appSettings.dataSyncSettings
-            ?: return Result.failure(DataSyncSettingsNotFoundException())
 
         observationRecordRemoteDataSource.setBaseUrl(dataSyncSettings.geoNatureServerUrl)
 

occtax/src/main/java/fr/geonature/occtax/features/record/usecase/ExportObservationRecordUseCase.kt

@@ -3,7 +3,7 @@ package fr.geonature.occtax.features.record.usecase
 import fr.geonature.commons.interactor.BaseResultUseCase
 import fr.geonature.occtax.features.record.domain.ObservationRecord
 import fr.geonature.occtax.features.record.repository.IObservationRecordRepository
-import fr.geonature.occtax.settings.AppSettings
+import fr.geonature.occtax.features.settings.domain.AppSettings
 import javax.inject.Inject
 
 /**

occtax/src/main/java/fr/geonature/occtax/features/settings/AppSettingsModule.kt

@@ -0,0 +1,45 @@
+package fr.geonature.occtax.features.settings
+
+import android.content.Context
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.android.qualifiers.ApplicationContext
+import dagger.hilt.components.SingletonComponent
+import fr.geonature.datasync.settings.AppSettingsFilename
+import fr.geonature.occtax.features.settings.data.AppSettingsFileLocalDataSourceImpl
+import fr.geonature.occtax.features.settings.data.IAppSettingsLocalDataSource
+import fr.geonature.occtax.features.settings.domain.AppSettings
+import fr.geonature.occtax.features.settings.repository.AppSettingsRepositoryImpl
+import fr.geonature.occtax.features.settings.repository.IAppSettingsRepository
+import javax.inject.Singleton
+
+/**
+ * [AppSettings] module.
+ *
+ * @author S. Grimault
+ */
+@Module
+@InstallIn(SingletonComponent::class)
+object AppSettingsModule {
+
+    @Singleton
+    @Provides
+    fun provideAppSettingsDataSource(
+        @ApplicationContext appContext: Context,
+        @AppSettingsFilename appSettingsFilename: String
+    ): IAppSettingsLocalDataSource {
+        return AppSettingsFileLocalDataSourceImpl(
+            appContext,
+            appSettingsFilename
+        )
+    }
+
+    @Singleton
+    @Provides
+    fun provideAppSettingsRepository(
+        appSettingsLocalDataSource: IAppSettingsLocalDataSource
+    ): IAppSettingsRepository {
+        return AppSettingsRepositoryImpl(appSettingsLocalDataSource)
+    }
+}

occtax/src/main/java/fr/geonature/occtax/features/settings/data/AppSettingsFileLocalDataSourceImpl.kt

@@ -0,0 +1,45 @@
+package fr.geonature.occtax.features.settings.data
+
+import android.content.Context
+import fr.geonature.mountpoint.model.MountPoint
+import fr.geonature.mountpoint.util.FileUtils.getFile
+import fr.geonature.mountpoint.util.FileUtils.getRootFolder
+import fr.geonature.occtax.features.settings.domain.AppSettings
+import fr.geonature.occtax.features.settings.error.AppSettingsException
+import fr.geonature.occtax.features.settings.io.AppSettingsJsonReader
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+import org.tinylog.Logger
+import java.io.FileReader
+
+/**
+ * Loads [AppSettings] from `JSON` file.
+ *
+ * @author S. Grimault
+ */
+class AppSettingsFileLocalDataSourceImpl(
+    private val context: Context,
+    private val appSettingsFilename: String,
+    private val dispatcher: CoroutineDispatcher = Dispatchers.IO
+) : IAppSettingsLocalDataSource {
+    override suspend fun load(appSettings: AppSettings?): AppSettings = withContext(dispatcher) {
+        val appSettingsJsonFile = getFile(
+            getRootFolder(
+                context,
+                MountPoint.StorageType.INTERNAL
+            ),
+            if (appSettings == null) appSettingsFilename else "${appSettingsFilename.substringBeforeLast(".json")}.local.json"
+        )
+
+        Logger.info { "loading${if (appSettings == null) " " else " additional "}settings from '${appSettingsJsonFile.absolutePath}'..." }
+
+        if (!appSettingsJsonFile.exists()) {
+            throw AppSettingsException.NoAppSettingsFoundLocallyException(appSettingsJsonFile.absolutePath)
+        }
+
+        run {
+            AppSettingsJsonReader(appSettings).read(FileReader(appSettingsJsonFile))
+        }
+    }
+}

occtax/src/main/java/fr/geonature/occtax/features/settings/data/IAppSettingsLocalDataSource.kt

@@ -0,0 +1,20 @@
+package fr.geonature.occtax.features.settings.data
+
+import fr.geonature.occtax.features.settings.error.AppSettingsException
+import fr.geonature.occtax.features.settings.domain.AppSettings
+
+/**
+ * [AppSettings] local data source.
+ *
+ * @author S. Grimault
+ */
+interface IAppSettingsLocalDataSource {
+
+    /**
+     * Loads [AppSettings].
+     *
+     * @param appSettings existing [AppSettings] to override.
+     * @return [AppSettings] or throws [AppSettingsException] if something goes wrong.
+     */
+    suspend fun load(appSettings: AppSettings? = null): AppSettings
+}