Closes #33.

CHANGELOG.md

@@ -1,5 +1,7 @@
 **1.7.x**
 
+- Closes #33. Background sync with settings.
+
 - Closing #1. Initial article caching.
 
 - Closing #228 by removing the list action bar. Action buttons are exclusively on the card view from now on.

app/src/main/java/apps/amine/bou/readerforselfoss/HomeActivity.kt

@@ -27,6 +27,7 @@ import androidx.room.Room
 import androidx.room.RoomDatabase
 import androidx.work.Constraints
 import androidx.work.ExistingPeriodicWorkPolicy
+import androidx.work.NetworkType
 import androidx.work.OneTimeWorkRequestBuilder
 import androidx.work.PeriodicWorkRequestBuilder
 import androidx.work.WorkManager
@@ -118,6 +119,10 @@ class HomeActivity : AppCompatActivity(), SearchView.OnQueryTextListener {
     private var itemsCaching: Boolean = false
     private var hiddenTags: List<String> = emptyList()
 
+    private var periodicRefresh = false
+    private var refreshMinutes: Long = 360L
+    private var refreshWhenChargingOnly = false
+
     private lateinit var tabNewBadge: TextBadgeItem
     private lateinit var tabArchiveBadge: TextBadgeItem
     private lateinit var tabStarredBadge: TextBadgeItem
@@ -187,8 +192,6 @@ class HomeActivity : AppCompatActivity(), SearchView.OnQueryTextListener {
         handleDrawer()
 
         handleSwipeRefreshLayout()
-
-        handleRecurringTask()
     }
 
     private fun handleSwipeRefreshLayout() {
@@ -344,6 +347,8 @@ class HomeActivity : AppCompatActivity(), SearchView.OnQueryTextListener {
         getElementsAccordingToTab()
 
         handleGDPRDialog(sharedPref.getBoolean("GDPR_shown", false))
+
+        handleRecurringTask()
     }
 
     private fun getAndStoreAllItems() {
@@ -393,6 +398,13 @@ class HomeActivity : AppCompatActivity(), SearchView.OnQueryTextListener {
         } else {
             emptyList()
         }
+        periodicRefresh = sharedPref.getBoolean("periodic_refresh", false)
+        refreshWhenChargingOnly = sharedPref.getBoolean("refresh_when_charging", false)
+        refreshMinutes = sharedPref.getString("periodic_refresh_minutes", "360").toLong()
+
+        if (refreshMinutes <= 15) {
+            refreshMinutes = 15
+        }
     }
 
     private fun handleThemeBinding() {
@@ -1399,23 +1411,22 @@ class HomeActivity : AppCompatActivity(), SearchView.OnQueryTextListener {
     }
 
     private fun handleRecurringTask() {
-        // TODO: add network type
+        if (periodicRefresh) {
-        val myConstraints = Constraints.Builder()
+            val myConstraints = Constraints.Builder()
-            .setRequiresBatteryNotLow(true)
+                .setRequiresBatteryNotLow(true)
-            .setRequiresStorageNotLow(true)
+                .setRequiresCharging(refreshWhenChargingOnly)
-            .build()
+                .setRequiresStorageNotLow(true)
-
-        // TODO: make the time variable from the settings.
-        val backgroundWork =
-            PeriodicWorkRequestBuilder<LoadingWorker>(4, TimeUnit.HOURS)
-                .setConstraints(myConstraints)
-                .addTag("selfoss-loading")
                 .build()
 
-
+            val backgroundWork =
-        WorkManager.getInstance().enqueueUniquePeriodicWork("selfoss-loading", ExistingPeriodicWorkPolicy.REPLACE, backgroundWork)
+                PeriodicWorkRequestBuilder<LoadingWorker>(refreshMinutes, TimeUnit.MINUTES)
+                    .setConstraints(myConstraints)
+                    .addTag("selfoss-loading")
+                    .build()
 
 
+            WorkManager.getInstance().enqueueUniquePeriodicWork("selfoss-loading", ExistingPeriodicWorkPolicy.REPLACE, backgroundWork)
+        }
     }
 }
 

app/src/main/java/apps/amine/bou/readerforselfoss/MyApp.kt

@@ -1,8 +1,11 @@
 package apps.amine.bou.readerforselfoss
 
+import android.app.NotificationChannel
+import android.app.NotificationManager
 import android.content.Context
 import android.graphics.drawable.Drawable
 import android.net.Uri
+import android.os.Build
 import android.preference.PreferenceManager
 import androidx.multidex.MultiDexApplication
 import android.widget.ImageView
@@ -59,6 +62,18 @@ class MyApp : MultiDexApplication() {
         initTheme()
 
         tryToHandleBug()
+
+        handleNotificationChannels()
+    }
+
+    private fun handleNotificationChannels() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+            val name = getString(R.string.notification_channel_sync)
+            val importance = NotificationManager.IMPORTANCE_LOW
+            val mChannel = NotificationChannel(Config.syncChannelId, name, importance)
+            val notificationManager = getSystemService(NOTIFICATION_SERVICE) as NotificationManager
+            notificationManager.createNotificationChannel(mChannel)
+        }
     }
 
     override fun attachBaseContext(base: Context?) {

app/src/main/java/apps/amine/bou/readerforselfoss/background/background.kt

@@ -1,10 +1,15 @@
 package apps.amine.bou.readerforselfoss.background
 
+import android.app.NotificationManager
 import android.content.Context
+import android.os.Handler
 import android.preference.PreferenceManager
+import androidx.core.app.NotificationCompat
+import androidx.core.app.NotificationCompat.PRIORITY_LOW
 import androidx.room.Room
 import androidx.work.Worker
 import androidx.work.WorkerParameters
+import apps.amine.bou.readerforselfoss.R
 import apps.amine.bou.readerforselfoss.api.selfoss.Item
 import apps.amine.bou.readerforselfoss.api.selfoss.SelfossApi
 import apps.amine.bou.readerforselfoss.persistence.database.AppDatabase
@@ -14,12 +19,9 @@ import apps.amine.bou.readerforselfoss.utils.persistence.toEntity
 import retrofit2.Call
 import retrofit2.Callback
 import retrofit2.Response
+import java.util.*
+import kotlin.concurrent.schedule
 import kotlin.concurrent.thread
-import android.app.NotificationManager
-import android.app.NotificationChannel
-import android.util.Log
-import androidx.core.app.NotificationCompat
-import apps.amine.bou.readerforselfoss.R
 
 class LoadingWorker(val context: Context, params: WorkerParameters) : Worker(context, params) {
 
@@ -27,18 +29,13 @@ class LoadingWorker(val context: Context, params: WorkerParameters) : Worker(con
         val notificationManager =
             applicationContext.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
 
-        //If on Oreo then notification required a notification channel.
+        val notification = NotificationCompat.Builder(applicationContext, Config.syncChannelId)
-        if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
+            .setContentTitle(context.getString(R.string.loading_notification_title))
-            val channel =
+            .setContentText(context.getString(R.string.loading_notification_text))
-                NotificationChannel("default", "Default", NotificationManager.IMPORTANCE_DEFAULT)
-            notificationManager.createNotificationChannel(channel)
-        }
-
-        val notification = NotificationCompat.Builder(applicationContext, "default")
-            .setContentTitle("Loading")
-            .setContentText("Loading new items")
             .setOngoing(true)
-            .setSmallIcon(R.mipmap.ic_launcher)
+            .setPriority(PRIORITY_LOW)
+            .setChannelId(Config.syncChannelId)
+            .setSmallIcon(R.drawable.ic_cloud_download)
 
         notificationManager.notify(1, notification.build())
 
@@ -59,7 +56,9 @@ class LoadingWorker(val context: Context, params: WorkerParameters) : Worker(con
         )
         api.allItems().enqueue(object : Callback<List<Item>> {
             override fun onFailure(call: Call<List<Item>>, t: Throwable) {
-                notificationManager.cancel(1)
+                Timer("", false).schedule(4000) {
+                    notificationManager.cancel(1)
+                }
             }
 
             override fun onResponse(
@@ -73,7 +72,9 @@ class LoadingWorker(val context: Context, params: WorkerParameters) : Worker(con
                         db.itemsDao()
                             .insertAllItems(*(apiItems.map { it.toEntity() }).toTypedArray())
                     }
-                    notificationManager.cancel(1)
+                    Timer("", false).schedule(4000) {
+                        notificationManager.cancel(1)
+                    }
                 }
             }
         })

app/src/main/java/apps/amine/bou/readerforselfoss/utils/Config.kt

@@ -36,6 +36,8 @@ class Config(c: Context) {
 
         const val trackerUrl = "https://github.com/aminecmi/ReaderforSelfoss/issues"
 
+        const val syncChannelId = "sync-channel-id"
+
         fun logoutAndRedirect(
             c: Context,
             callingActivity: Activity,

app/src/main/res/values/strings.xml

@@ -153,4 +153,12 @@
     <string name="pref_switch_items_caching_on">Articles will be saved to the device memory and will be used for offline use.</string>
     <string name="pref_switch_items_caching">Save items for offline use</string>
     <string name="no_network_connectivity">Not connected !</string>
+    <string name="pref_switch_periodic_refresh">Sync articles</string>
+    <string name="pref_switch_periodic_refresh_off">Articles will not be synced in the background</string>
+    <string name="pref_switch_periodic_refresh_on">Articles will periodically be synced</string>
+    <string name="pref_periodic_refresh_minutes_title"><![CDATA[Sync interval ( >= 15 minutes)]]></string>
+    <string name="pref_switch_refresh_when_charging">Only refresh when phone is charging</string>
+    <string name="loading_notification_title">Loading ...</string>
+    <string name="loading_notification_text">Selfoss is syncing your articles</string>
+    <string name="notification_channel_sync">Sync notification</string>
 </resources>

app/src/main/res/xml/pref_offline.xml

@@ -5,4 +5,28 @@
         android:summaryOff="@string/pref_switch_items_caching_off"
         android:summaryOn="@string/pref_switch_items_caching_on"
         android:title="@string/pref_switch_items_caching" />
+
+    <SwitchPreference
+        android:defaultValue="false"
+        android:key="periodic_refresh"
+        android:dependency="items_caching"
+        android:summaryOff="@string/pref_switch_periodic_refresh_off"
+        android:summaryOn="@string/pref_switch_periodic_refresh_on"
+        android:title="@string/pref_switch_periodic_refresh" />
+
+    <EditTextPreference
+        android:dependency="periodic_refresh"
+        android:defaultValue="360"
+        android:inputType="number"
+        android:key="periodic_refresh_minutes"
+        android:selectAllOnFocus="true"
+        android:singleLine="true"
+        android:title="@string/pref_periodic_refresh_minutes_title" />
+
+
+    <SwitchPreference
+        android:defaultValue="false"
+        android:key="refresh_when_charging"
+        android:dependency="items_caching"
+        android:title="@string/pref_switch_refresh_when_charging" />
 </PreferenceScreen>