Fetch home in background to cache messages

This commit is contained in:
Thomas 2023-02-01 12:33:43 +01:00
parent 44676707f0
commit e8950f03ae
10 changed files with 404 additions and 1 deletions

View file

@ -276,6 +276,7 @@ public class Helper {
public static final String ARG_SCHEDULED_DATE = "ARG_SCHEDULED_DATE"; public static final String ARG_SCHEDULED_DATE = "ARG_SCHEDULED_DATE";
public static final String WORKER_REFRESH_NOTIFICATION = "WORKER_REFRESH_NOTIFICATION"; public static final String WORKER_REFRESH_NOTIFICATION = "WORKER_REFRESH_NOTIFICATION";
public static final String WORKER_REFRESH_HOME = "WORKER_REFRESH_HOME";
public static final String WORKER_SCHEDULED_STATUSES = "WORKER_SCHEDULED_STATUSES"; public static final String WORKER_SCHEDULED_STATUSES = "WORKER_SCHEDULED_STATUSES";
public static final String WORKER_SCHEDULED_REBLOGS = "WORKER_SCHEDULED_REBLOGS"; public static final String WORKER_SCHEDULED_REBLOGS = "WORKER_SCHEDULED_REBLOGS";

View file

@ -0,0 +1,223 @@
package app.fedilab.android.mastodon.jobs;
/* Copyright 2023 Thomas Schneider
*
* This file is a part of Fedilab
*
* 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.
*
* Fedilab 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 Fedilab; if not,
* see <http://www.gnu.org/licenses>. */
import android.app.Notification;
import android.app.NotificationChannel;
import android.app.NotificationManager;
import android.content.Context;
import android.content.SharedPreferences;
import android.graphics.BitmapFactory;
import android.os.Build;
import androidx.annotation.NonNull;
import androidx.core.app.NotificationCompat;
import androidx.preference.PreferenceManager;
import androidx.work.Data;
import androidx.work.ExistingPeriodicWorkPolicy;
import androidx.work.ForegroundInfo;
import androidx.work.PeriodicWorkRequest;
import androidx.work.WorkManager;
import androidx.work.Worker;
import androidx.work.WorkerParameters;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import app.fedilab.android.R;
import app.fedilab.android.mastodon.client.endpoints.MastodonTimelinesService;
import app.fedilab.android.mastodon.client.entities.api.Pagination;
import app.fedilab.android.mastodon.client.entities.api.Status;
import app.fedilab.android.mastodon.client.entities.app.Account;
import app.fedilab.android.mastodon.client.entities.app.BaseAccount;
import app.fedilab.android.mastodon.client.entities.app.StatusCache;
import app.fedilab.android.mastodon.client.entities.app.Timeline;
import app.fedilab.android.mastodon.exception.DBException;
import app.fedilab.android.mastodon.helper.Helper;
import app.fedilab.android.mastodon.helper.MastodonHelper;
import okhttp3.OkHttpClient;
import retrofit2.Call;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class FetchHomeWorker extends Worker {
private static final int FETCH_HOME_CHANNEL_ID = 5;
private static final String CHANNEL_ID = "fedilab_home";
final OkHttpClient okHttpClient = new OkHttpClient.Builder()
.readTimeout(60, TimeUnit.SECONDS)
.connectTimeout(60, TimeUnit.SECONDS)
.callTimeout(60, TimeUnit.SECONDS)
.proxy(Helper.getProxy(getApplicationContext().getApplicationContext()))
.build();
private final NotificationManager notificationManager;
public FetchHomeWorker(@NonNull Context context, @NonNull WorkerParameters workerParams) {
super(context, workerParams);
notificationManager = (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);
}
public static void setRepeatHome(Context context, BaseAccount account) {
WorkManager.getInstance(context).cancelAllWorkByTag(Helper.WORKER_REFRESH_HOME + account.user_id + account.instance);
SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
String value = prefs.getString(context.getString(R.string.SET_FETCH_HOME_DELAY_VALUE) + account.user_id + account.instance, "60");
PeriodicWorkRequest notificationPeriodic = new PeriodicWorkRequest.Builder(NotificationsWorker.class, Long.parseLong(value), TimeUnit.MINUTES)
.addTag(Helper.WORKER_REFRESH_NOTIFICATION)
.build();
WorkManager.getInstance(context).enqueueUniquePeriodicWork(Helper.WORKER_REFRESH_HOME + account.user_id + account.instance, ExistingPeriodicWorkPolicy.REPLACE, notificationPeriodic);
}
@NonNull
@Override
public ListenableFuture<ForegroundInfo> getForegroundInfoAsync() {
if (Build.VERSION.SDK_INT >= 26) {
String channelName = "Notifications";
String channelDescription = "Fetched notifications";
NotificationChannel notifChannel = new NotificationChannel(CHANNEL_ID, channelName, NotificationManager.IMPORTANCE_LOW);
notifChannel.setDescription(channelDescription);
notifChannel.setSound(null, null);
notifChannel.setShowBadge(false);
notificationManager.createNotificationChannel(notifChannel);
if (notificationManager.getNotificationChannel("notifications") != null) {
notificationManager.deleteNotificationChannel("notifications");
}
}
NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(getApplicationContext(), CHANNEL_ID);
notificationBuilder.setSmallIcon(R.drawable.ic_notification)
.setLargeIcon(BitmapFactory.decodeResource(getApplicationContext().getResources(), R.drawable.ic_launcher_foreground))
.setContentTitle(getApplicationContext().getString(R.string.notifications))
.setContentText(getApplicationContext().getString(R.string.fetch_notifications))
.setDefaults(NotificationCompat.DEFAULT_ALL)
.setPriority(Notification.PRIORITY_DEFAULT);
return Futures.immediateFuture(new ForegroundInfo(FETCH_HOME_CHANNEL_ID, notificationBuilder.build()));
}
@NonNull
private ForegroundInfo createForegroundInfo() {
if (Build.VERSION.SDK_INT >= 26) {
String channelName = "Notifications";
String channelDescription = "Fetched notifications";
NotificationChannel notifChannel = new NotificationChannel(CHANNEL_ID, channelName, NotificationManager.IMPORTANCE_LOW);
notifChannel.setSound(null, null);
notifChannel.setShowBadge(false);
notifChannel.setDescription(channelDescription);
notificationManager.createNotificationChannel(notifChannel);
}
NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(getApplicationContext(), CHANNEL_ID);
notificationBuilder.setSmallIcon(R.drawable.ic_notification)
.setLargeIcon(BitmapFactory.decodeResource(getApplicationContext().getResources(), R.drawable.ic_launcher_foreground))
.setContentTitle(getApplicationContext().getString(R.string.notifications))
.setContentText(getApplicationContext().getString(R.string.fetch_notifications))
.setDefaults(NotificationCompat.DEFAULT_ALL)
.setSilent(true)
.setPriority(Notification.PRIORITY_LOW);
return new ForegroundInfo(FETCH_HOME_CHANNEL_ID, notificationBuilder.build());
}
@NonNull
@Override
public Result doWork() {
setForegroundAsync(createForegroundInfo());
try {
List<BaseAccount> accounts = new Account(getApplicationContext()).getCrossAccounts();
for (BaseAccount account : accounts) {
try {
fetchHome(getApplicationContext(), account);
} catch (IOException e) {
e.printStackTrace();
}
}
} catch (DBException e) {
e.printStackTrace();
}
return Result.success(new Data.Builder().putString("WORK_RESULT", getApplicationContext().getString(R.string.notifications)).build());
}
private void fetchHome(Context context, BaseAccount account) throws IOException {
SharedPreferences prefs = PreferenceManager
.getDefaultSharedPreferences(context);
boolean fetch_home = prefs.getBoolean(context.getString(R.string.SET_FETCH_HOME) + account.user_id + account.instance, false);
if (fetch_home) {
int max_calls = 5;
int status_per_page = 80;
//Browse last 400 home messages
boolean canContinue = true;
int call = 0;
String max_id = null;
MastodonTimelinesService mastodonTimelinesService = init(account.instance);
while (canContinue && call < max_calls) {
Call<List<Status>> homeCall = mastodonTimelinesService.getHome(account.token, account.instance, max_id, null, status_per_page, null);
if (homeCall != null) {
Response<List<Status>> homeResponse = homeCall.execute();
if (homeResponse.isSuccessful()) {
List<Status> statusList = homeResponse.body();
if (statusList != null && statusList.size() > 0) {
for (Status status : statusList) {
StatusCache statusCacheDAO = new StatusCache(getApplicationContext());
StatusCache statusCache = new StatusCache();
statusCache.instance = account.instance;
statusCache.user_id = account.user_id;
statusCache.status = status;
statusCache.type = Timeline.TimeLineEnum.HOME;
statusCache.status_id = status.id;
try {
int inserted = statusCacheDAO.insertOrUpdate(statusCache, Timeline.TimeLineEnum.HOME.getValue());
//We reached already cached messages
if (inserted == 0) {
canContinue = false;
break;
}
} catch (DBException e) {
e.printStackTrace();
}
}
Pagination pagination = MastodonHelper.getPagination(homeResponse.headers());
if (pagination.max_id != null) {
max_id = pagination.max_id;
} else {
canContinue = false;
}
} else {
canContinue = false;
}
} else {
canContinue = false;
}
}
call++;
}
}
}
private MastodonTimelinesService init(String instance) {
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://" + instance + "/api/v1/")
.addConverterFactory(GsonConverterFactory.create(Helper.getDateBuilder()))
.client(okHttpClient)
.build();
return retrofit.create(MastodonTimelinesService.class);
}
}

View file

@ -105,7 +105,7 @@ public class NotificationsWorker extends Worker {
public Result doWork() { public Result doWork() {
setForegroundAsync(createForegroundInfo()); setForegroundAsync(createForegroundInfo());
try { try {
List<BaseAccount> accounts = new Account(getApplicationContext()).getAll(); List<BaseAccount> accounts = new Account(getApplicationContext()).getCrossAccounts();
for (BaseAccount account : accounts) { for (BaseAccount account : accounts) {
try { try {
NotificationsHelper.task(getApplicationContext(), account.user_id + "@" + account.instance); NotificationsHelper.task(getApplicationContext(), account.user_id + "@" + account.instance);

View file

@ -0,0 +1,113 @@
package app.fedilab.android.mastodon.ui.fragment.settings;
/* Copyright 2023 Thomas Schneider
*
* This file is a part of Fedilab
*
* 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.
*
* Fedilab 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 Fedilab; if not,
* see <http://www.gnu.org/licenses>. */
import android.content.SharedPreferences;
import android.os.Bundle;
import androidx.preference.ListPreference;
import androidx.preference.PreferenceFragmentCompat;
import androidx.preference.PreferenceManager;
import androidx.preference.PreferenceScreen;
import androidx.preference.SwitchPreference;
import androidx.preference.SwitchPreferenceCompat;
import androidx.work.WorkManager;
import app.fedilab.android.R;
import app.fedilab.android.activities.MainActivity;
import app.fedilab.android.mastodon.helper.Helper;
import app.fedilab.android.mastodon.jobs.FetchHomeWorker;
import es.dmoral.toasty.Toasty;
public class FragmentHomeCacheSettings extends PreferenceFragmentCompat implements SharedPreferences.OnSharedPreferenceChangeListener {
@Override
public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
addPreferencesFromResource(R.xml.pref_home_cache);
createPref();
}
private void createPref() {
getPreferenceScreen().removeAll();
addPreferencesFromResource(R.xml.pref_home_cache);
PreferenceScreen preferenceScreen = getPreferenceScreen();
if (preferenceScreen == null) {
Toasty.error(requireActivity(), getString(R.string.toast_error), Toasty.LENGTH_SHORT).show();
return;
}
SharedPreferences sharedpreferences = PreferenceManager.getDefaultSharedPreferences(requireActivity());
SwitchPreferenceCompat SET_FETCH_HOME = findPreference(getString(R.string.SET_FETCH_HOME));
if (SET_FETCH_HOME != null) {
boolean checked = sharedpreferences.getBoolean(getString(R.string.SET_FETCH_HOME) + MainActivity.currentUserID + MainActivity.currentInstance, false);
SET_FETCH_HOME.setChecked(checked);
}
ListPreference SET_FETCH_HOME_DELAY_VALUE = findPreference(getString(R.string.SET_FETCH_HOME_DELAY_VALUE));
if (SET_FETCH_HOME_DELAY_VALUE != null) {
String timeRefresh = sharedpreferences.getString(getString(R.string.SET_FETCH_HOME_DELAY_VALUE) + MainActivity.currentUserID + MainActivity.currentInstance, "60");
SET_FETCH_HOME_DELAY_VALUE.setValue(timeRefresh);
}
}
@Override
public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
if (key.compareToIgnoreCase(getString(R.string.SET_FETCH_HOME)) == 0) {
SharedPreferences.Editor editor = sharedPreferences.edit();
SwitchPreference SET_FETCH_HOME = findPreference(getString(R.string.SET_FETCH_HOME));
if (SET_FETCH_HOME != null) {
editor.putBoolean(getString(R.string.SET_FETCH_HOME) + MainActivity.currentUserID + MainActivity.currentInstance, SET_FETCH_HOME.isChecked());
editor.commit();
if (SET_FETCH_HOME.isChecked()) {
FetchHomeWorker.setRepeatHome(requireActivity(), MainActivity.currentAccount);
} else {
WorkManager.getInstance(requireActivity()).cancelAllWorkByTag(Helper.WORKER_REFRESH_HOME + MainActivity.currentUserID + MainActivity.currentInstance);
}
}
}
if (key.compareToIgnoreCase(getString(R.string.SET_FETCH_HOME_DELAY_VALUE)) == 0) {
ListPreference SET_FETCH_HOME_DELAY_VALUE = findPreference(getString(R.string.SET_FETCH_HOME_DELAY_VALUE));
if (SET_FETCH_HOME_DELAY_VALUE != null) {
SharedPreferences.Editor editor = sharedPreferences.edit();
editor.putString(getString(R.string.SET_FETCH_HOME_DELAY_VALUE) + MainActivity.currentUserID + MainActivity.currentInstance, SET_FETCH_HOME_DELAY_VALUE.getValue());
editor.commit();
FetchHomeWorker.setRepeatHome(requireActivity(), MainActivity.currentAccount);
}
}
}
@Override
public void onResume() {
super.onResume();
getPreferenceScreen().getSharedPreferences()
.registerOnSharedPreferenceChangeListener(this);
}
@Override
public void onPause() {
super.onPause();
getPreferenceScreen().getSharedPreferences()
.unregisterOnSharedPreferenceChangeListener(this);
}
}

View file

@ -112,6 +112,15 @@ public class FragmentSettingsCategories extends PreferenceFragmentCompat {
}); });
} }
Preference pref_category_key_home_cache = findPreference(getString(R.string.pref_category_key_home_cache));
if (pref_category_key_home_cache != null) {
pref_category_key_home_cache.setOnPreferenceClickListener(preference -> {
NavController navController = Navigation.findNavController(requireActivity(), R.id.fragment_container);
navController.navigate(FragmentSettingsCategoriesDirections.Companion.categoriesToHomeCache());
return false;
});
}
Preference pref_category_key_theming = findPreference(getString(R.string.pref_category_key_theming)); Preference pref_category_key_theming = findPreference(getString(R.string.pref_category_key_theming));
if (pref_category_key_theming != null) { if (pref_category_key_theming != null) {
pref_category_key_theming.setOnPreferenceClickListener(preference -> { pref_category_key_theming.setOnPreferenceClickListener(preference -> {

View file

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="fetch_home_every">Fetch Home every</string>
<string name="type_of_home_delay_title">Home fetch time</string>
<string name="set_fetch_home">Automatically fetch home messages</string>
<string name="home_cache">Home cache</string>
</resources>

View file

@ -53,6 +53,14 @@
app:popEnterAnim="@anim/pop_enter" app:popEnterAnim="@anim/pop_enter"
app:popExitAnim="@anim/pop_exit" /> app:popExitAnim="@anim/pop_exit" />
<action
android:id="@+id/categories_to_home_cache"
app:destination="@id/FragmentHomeCacheSettings"
app:enterAnim="@anim/enter"
app:exitAnim="@anim/exit"
app:popEnterAnim="@anim/pop_enter"
app:popExitAnim="@anim/pop_exit" />
<action <action
android:id="@+id/categories_to_theming" android:id="@+id/categories_to_theming"
app:destination="@id/FragmentThemingSettings" app:destination="@id/FragmentThemingSettings"
@ -103,6 +111,11 @@
android:name="app.fedilab.android.mastodon.ui.fragment.settings.FragmentPrivacySettings" android:name="app.fedilab.android.mastodon.ui.fragment.settings.FragmentPrivacySettings"
android:label="@string/action_privacy" /> android:label="@string/action_privacy" />
<fragment
android:id="@+id/FragmentHomeCacheSettings"
android:name="app.fedilab.android.mastodon.ui.fragment.settings.FragmentHomeCacheSettings"
android:label="@string/home_cache" />
<fragment <fragment
android:id="@+id/FragmentThemingSettings" android:id="@+id/FragmentThemingSettings"
android:name="app.fedilab.android.mastodon.ui.fragment.settings.FragmentThemingSettings" android:name="app.fedilab.android.mastodon.ui.fragment.settings.FragmentThemingSettings"

View file

@ -827,6 +827,8 @@
<string name="SET_PROXY_HOST" translatable="false">SET_PROXY_HOST</string> <string name="SET_PROXY_HOST" translatable="false">SET_PROXY_HOST</string>
<string name="SET_PROXY_PORT" translatable="false">SET_PROXY_PORT</string> <string name="SET_PROXY_PORT" translatable="false">SET_PROXY_PORT</string>
<string name="SET_DEFAULT_LOCALE_NEW" translatable="false">SET_DEFAULT_LOCALE_NEW</string> <string name="SET_DEFAULT_LOCALE_NEW" translatable="false">SET_DEFAULT_LOCALE_NEW</string>
<string name="SET_FETCH_HOME_DELAY_VALUE" translatable="false">SET_FETCH_HOME_DELAY_VALUE</string>
<string name="SET_SEND_CRASH_REPORTS" translatable="false">SET_SEND_CRASH_REPORTS</string> <string name="SET_SEND_CRASH_REPORTS" translatable="false">SET_SEND_CRASH_REPORTS</string>
<string name="SET_DISABLE_RELEASE_NOTES_ALERT" translatable="false">SET_DISABLE_RELEASE_NOTES_ALERT</string> <string name="SET_DISABLE_RELEASE_NOTES_ALERT" translatable="false">SET_DISABLE_RELEASE_NOTES_ALERT</string>
<string name="SET_DISABLE_GIF" translatable="false">SET_DISABLE_GIF</string> <string name="SET_DISABLE_GIF" translatable="false">SET_DISABLE_GIF</string>
@ -1431,6 +1433,7 @@
<string name="SET_COMPOSE_LANGUAGE" translatable="false">SET_COMPOSE_LANGUAGE</string> <string name="SET_COMPOSE_LANGUAGE" translatable="false">SET_COMPOSE_LANGUAGE</string>
<string name="SET_LOGO_LAUNCHER" translatable="false">SET_LOGO_LAUNCHER</string> <string name="SET_LOGO_LAUNCHER" translatable="false">SET_LOGO_LAUNCHER</string>
<string name="SET_NOTIF_FOLLOW" translatable="false">SET_NOTIF_FOLLOW</string> <string name="SET_NOTIF_FOLLOW" translatable="false">SET_NOTIF_FOLLOW</string>
<string name="SET_FETCH_HOME" translatable="false">SET_FETCH_HOME</string>
<string name="SET_NOTIF_MENTION" translatable="false">SET_NOTIF_MENTION</string> <string name="SET_NOTIF_MENTION" translatable="false">SET_NOTIF_MENTION</string>
<string name="SET_NOTIF_SHARE" translatable="false">SET_NOTIF_SHARE</string> <string name="SET_NOTIF_SHARE" translatable="false">SET_NOTIF_SHARE</string>
<string name="SET_NOTIF_FAVOURITE" translatable="false">SET_NOTIF_FAVOURITE</string> <string name="SET_NOTIF_FAVOURITE" translatable="false">SET_NOTIF_FAVOURITE</string>
@ -1996,6 +1999,7 @@
<string name="pref_category_key_interface" translatable="false">pref_category_interface</string> <string name="pref_category_key_interface" translatable="false">pref_category_interface</string>
<string name="pref_category_key_compose" translatable="false">pref_category_compose</string> <string name="pref_category_key_compose" translatable="false">pref_category_compose</string>
<string name="pref_category_key_privacy" translatable="false">pref_category_privacy</string> <string name="pref_category_key_privacy" translatable="false">pref_category_privacy</string>
<string name="pref_category_key_home_cache" translatable="false">pref_category_key_home_cache</string>
<string name="pref_category_key_theming" translatable="false">pref_category_theming</string> <string name="pref_category_key_theming" translatable="false">pref_category_theming</string>
<string name="pref_category_key_administration" translatable="false">pref_category_administration</string> <string name="pref_category_key_administration" translatable="false">pref_category_administration</string>
<string name="pref_category_key_languages" translatable="false">pref_category_languages</string> <string name="pref_category_key_languages" translatable="false">pref_category_languages</string>

View file

@ -46,6 +46,13 @@
app:icon="@drawable/ic_shield" app:icon="@drawable/ic_shield"
app:key="@string/pref_category_key_privacy" /> app:key="@string/pref_category_key_privacy" />
<Preference
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:title="@string/home_cache"
app:icon="@drawable/ic_baseline_cached_24"
app:key="@string/pref_category_key_home_cache" />
<Preference <Preference
android:layout_width="match_parent" android:layout_width="match_parent"
android:layout_height="wrap_content" android:layout_height="wrap_content"

View file

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="match_parent">
<SwitchPreferenceCompat
app:defaultValue="false"
app:iconSpaceReserved="false"
app:key="@string/SET_FETCH_HOME"
app:singleLineTitle="false"
app:title="@string/set_fetch_home" />
<ListPreference
app:defaultValue="60"
app:dependency="@string/SET_FETCH_HOME"
app:dialogTitle="@string/fetch_home_every"
app:entries="@array/set_notification_delay_values"
app:entryValues="@array/SET_NOTIFICATION_DELAYS_VALUES"
app:iconSpaceReserved="false"
app:key="@string/SET_FETCH_HOME_DELAY_VALUE"
app:summary="@string/set_push_notifications_delay"
app:title="@string/type_of_home_delay_title"
app:useSimpleSummaryProvider="true" />
</PreferenceScreen>