kirylkaveryn/organicmaps
1
Fork 0
forked from organicmaps/organicmaps-tmp
Code Pull requests Activity

Add foreground service to indicate about ongoing downloads

Browse source 
Signed-off-by: Alexey Krasilnikov <alexey@krasilnikov.me>
This commit is contained in:
Alexey Krasilnikov 2025-02-18 17:32:31 +03:00 • committed by Roman Tsisyk
parent 1cbe25e5bc
commit cd832b94b6
12 changed files with 274 additions and 100 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
android/app/src/main/AndroidManifest.xml
View file

@ -37,6 +37,7 @@
<uses-permission android:name="android.permission.WAKE_LOCK"/>
<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION"/>
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC"/>
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_SPECIAL_USE"/>
<!--
Android 13 (API level 33) and higher supports a runtime permission for sending non-exempt (including Foreground
@ -489,6 +490,13 @@
android:stopWithTask="false"
/>
<service
android:name=".downloader.DownloaderService"
android:foregroundServiceType="dataSync"
android:exported="false"
android:enabled="true"
android:stopWithTask="false"/>
<provider
android:name="androidx.core.content.FileProvider"
android:authorities="${FILE_PROVIDER_PLACEHOLDER}"

2
android/app/src/main/java/app/organicmaps/DownloadResourcesLegacyActivity.java
View file

@ -390,7 +390,7 @@ public class DownloadResourcesLegacyActivity extends BaseMwmFragmentActivity
mProgress.setProgressCompat(0, true);
mCountryDownloadListenerSlot = MapManager.nativeSubscribe(mCountryDownloadListener);
MapManager.nativeDownload(mCurrentCountry);
MapManager.startDownload(mCurrentCountry);
setAction(PROCEED_TO_MAP);
}
else

45
android/app/src/main/java/app/organicmaps/MwmApplication.java
View file

@ -16,13 +16,14 @@ import androidx.lifecycle.LifecycleObserver;
import androidx.lifecycle.LifecycleOwner;
import androidx.lifecycle.ProcessLifecycleOwner;
import java.io.IOException;
import java.lang.ref.WeakReference;
import app.organicmaps.background.OsmUploadWork;
import app.organicmaps.downloader.Android7RootCertificateWorkaround;
import app.organicmaps.downloader.DownloaderNotifier;
import app.organicmaps.bookmarks.data.BookmarkManager;
import app.organicmaps.display.DisplayManager;
import app.organicmaps.downloader.CountryItem;
import app.organicmaps.downloader.MapManager;
import app.organicmaps.downloader.Android7RootCertificateWorkaround;
import app.organicmaps.downloader.DownloaderNotifier;
import app.organicmaps.location.LocationHelper;
import app.organicmaps.location.LocationState;
import app.organicmaps.location.SensorHelper;
@ -46,10 +47,6 @@ import app.organicmaps.util.Utils;
import app.organicmaps.util.log.Logger;
import app.organicmaps.util.log.LogsManager;
import java.io.IOException;
import java.lang.ref.WeakReference;
import java.util.List;
public class MwmApplication extends Application implements Application.ActivityLifecycleCallbacks
{
@NonNull
@ -78,9 +75,6 @@ public class MwmApplication extends Application implements Application.ActivityL
private volatile boolean mFrameworkInitialized;
private volatile boolean mPlatformInitialized;
@NonNull
private final MapManager.StorageCallback mStorageCallbacks = new StorageCallbackImpl();
@Nullable
private WeakReference<Activity> mTopActivity;
@ -127,6 +121,9 @@ public class MwmApplication extends Application implements Application.ActivityL
return (MwmApplication) context.getApplicationContext();
}
@NonNull
public static MwmApplication sInstance;
@NonNull
public static SharedPreferences prefs(@NonNull Context context)
{
@ -138,6 +135,9 @@ public class MwmApplication extends Application implements Application.ActivityL
{
super.onCreate();
Logger.i(TAG, "Initializing application");
sInstance = this;
LogsManager.INSTANCE.initFileLogging(this);
Android7RootCertificateWorkaround.initializeIfNeeded(this);
@ -230,8 +230,6 @@ public class MwmApplication extends Application implements Application.ActivityL
nativeInitFramework(onComplete);
MapManager.nativeSubscribe(mStorageCallbacks);
initNativeStrings();
ThemeSwitcher.INSTANCE.initialize(this);
SearchEngine.INSTANCE.initialize();
@ -363,25 +361,4 @@ public class MwmApplication extends Application implements Application.ActivityL
mLocationHelper.stop();
}
}
private class StorageCallbackImpl implements MapManager.StorageCallback
{
@Override
public void onStatusChanged(List<MapManager.StorageCallbackData> data)
{
for (MapManager.StorageCallbackData item : data)
if (item.isLeafNode && item.newStatus == CountryItem.STATUS_FAILED)
{
if (MapManager.nativeIsAutoretryFailed())
{
DownloaderNotifier.notifyDownloadFailed(MwmApplication.this, item.countryId);
}
return;
}
}
@Override
public void onProgress(String countryId, long localSize, long remoteSize) {}
}
}

2
android/app/src/main/java/app/organicmaps/car/screens/download/DownloaderScreen.java
View file

@ -109,7 +109,7 @@ class DownloaderScreen extends BaseScreen
for (final var item : mMissingMaps.entrySet())
{
item.getValue().update();
MapManager.nativeDownload(item.getKey());
MapManager.startDownload(item.getKey());
}
}

4
android/app/src/main/java/app/organicmaps/downloader/DownloaderAdapter.java
View file

@ -386,9 +386,7 @@ class DownloaderAdapter extends RecyclerView.Adapter<DownloaderAdapter.ViewHolde
}
case CountryItem.STATUS_FAILED ->
{
RetryFailedDownloadConfirmationListener listener =
new RetryFailedDownloadConfirmationListener(mActivity.getApplication());
MapManager.warn3gAndRetry(mActivity, mItem.id, listener);
MapManager.warn3gAndRetry(mActivity, mItem.id, null);
}
case CountryItem.STATUS_UPDATABLE ->
MapManager.warnOn3gUpdate(mActivity, mItem.id, () -> MapManager.nativeUpdate(mItem.id));

90
android/app/src/main/java/app/organicmaps/downloader/DownloaderNotifier.java
View file

@ -22,12 +22,20 @@ import app.organicmaps.R;
import app.organicmaps.util.StringUtils;
import app.organicmaps.util.log.Logger;
public abstract class DownloaderNotifier
public class DownloaderNotifier
{
private static final String TAG = DownloaderNotifier.class.getSimpleName();
private static final String CHANNEL_ID = "downloader";
private static final int NOTIFICATION_ID = 1;
public static final int NOTIFICATION_ID = 1;
private final Context mContext;
private NotificationCompat.Builder mProgressNotificationBuilder;
public DownloaderNotifier(Context context)
{
mContext = context;
}
public static void createNotificationChannel(@NonNull Context context)
{
@ -42,49 +50,93 @@ public abstract class DownloaderNotifier
notificationManager.createNotificationChannel(channel);
}
public static void notifyDownloadFailed(@NonNull Context context, @Nullable String countryId)
public void notifyDownloadFailed(@Nullable String countryId)
{
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
ContextCompat.checkSelfPermission(context, POST_NOTIFICATIONS) != PERMISSION_GRANTED)
ContextCompat.checkSelfPermission(mContext, POST_NOTIFICATIONS) != PERMISSION_GRANTED)
{
Logger.w(TAG, "Permission POST_NOTIFICATIONS is not granted, skipping notification");
return;
}
final String title = context.getString(R.string.app_name);
final String title = mContext.getString(R.string.app_name);
final String countryName = MapManager.nativeGetName(countryId);
final String content = context.getString(R.string.download_country_failed, countryName);
final String content = mContext.getString(R.string.download_country_failed, countryName);
final int FLAG_IMMUTABLE = Build.VERSION.SDK_INT < Build.VERSION_CODES.M ? 0 : PendingIntent.FLAG_IMMUTABLE;
final Intent contentIntent = MwmActivity.createShowMapIntent(context, countryId);
contentIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
final PendingIntent contentPendingIntent = PendingIntent.getActivity(context, 0, contentIntent,
PendingIntent.FLAG_UPDATE_CURRENT | FLAG_IMMUTABLE);
var contentPendingIntent = getNotificationPendingIntent(countryId);
final Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID)
final Notification notification = new NotificationCompat.Builder(mContext, CHANNEL_ID)
.setAutoCancel(true)
.setCategory(NotificationCompat.CATEGORY_ERROR)
.setVisibility(NotificationCompat.VISIBILITY_PUBLIC)
.setSmallIcon(R.drawable.ic_splash)
.setColor(ContextCompat.getColor(context, R.color.notification))
.setColor(ContextCompat.getColor(mContext, R.color.notification))
.setContentTitle(title)
.setContentText(content)
.setShowWhen(true)
.setTicker(getTicker(context, title, content))
.setTicker(getTicker(mContext, title, content))
.setContentIntent(contentPendingIntent)
.setOnlyAlertOnce(true)
.build();
Logger.i(TAG, "Notifying about failed map download");
final NotificationManagerCompat notificationManager = NotificationManagerCompat.from(context);
final NotificationManagerCompat notificationManager = NotificationManagerCompat.from(mContext);
notificationManager.notify(NOTIFICATION_ID, notification);
}
static void cancelNotification(@NonNull Context context)
public void notifyProgress() {
notifyProgress(null, 0, 0);
}
public void notifyProgress(@Nullable String countryId, int maxProgress, int progress) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
ContextCompat.checkSelfPermission(mContext, POST_NOTIFICATIONS) != PERMISSION_GRANTED)
{
Logger.w(TAG, "Permission POST_NOTIFICATIONS is not granted, skipping notification");
return;
}
NotificationManagerCompat.from(mContext).notify(NOTIFICATION_ID, buildProgressNotification(countryId, maxProgress, progress));
}
@NonNull
public Notification buildProgressNotification()
{
Logger.i(TAG, "Cancelling notification about failed map download");
final NotificationManagerCompat notificationManager = NotificationManagerCompat.from(context);
notificationManager.cancel(NOTIFICATION_ID);
return buildProgressNotification(null, 0, 0);
}
@NonNull
public Notification buildProgressNotification(@Nullable String countryId, int maxProgress, int progress)
{
var builder = startNotification(countryId);
builder.setProgress(maxProgress, progress, maxProgress == 0);
builder.setContentText("Download in progress");
return builder.build();
}
@NonNull
private NotificationCompat.Builder startNotification(@Nullable String countryId)
{
final String title = mContext.getString(R.string.app_name);
return new NotificationCompat.Builder(mContext, CHANNEL_ID)
.setAutoCancel(true)
.setVisibility(NotificationCompat.VISIBILITY_PUBLIC)
.setSmallIcon(R.drawable.ic_splash)
.setColor(ContextCompat.getColor(mContext, R.color.notification))
.setShowWhen(true)
.setContentTitle(title)
.setContentIntent(getNotificationPendingIntent(countryId));
}
@NonNull
private PendingIntent getNotificationPendingIntent(@Nullable String countryId) {
final int FLAG_IMMUTABLE = Build.VERSION.SDK_INT < Build.VERSION_CODES.M ? 0 : PendingIntent.FLAG_IMMUTABLE;
final Intent contentIntent = MwmActivity.createShowMapIntent(mContext, countryId);
contentIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
return PendingIntent.getActivity(mContext, 0, contentIntent, PendingIntent.FLAG_UPDATE_CURRENT | FLAG_IMMUTABLE);
}
@NonNull

142
android/app/src/main/java/app/organicmaps/downloader/DownloaderService.java Normal file
View file

@ -0,0 +1,142 @@
package app.organicmaps.downloader;
import static android.Manifest.permission.POST_NOTIFICATIONS;
import static android.content.pm.PackageManager.PERMISSION_GRANTED;
import android.app.ForegroundServiceStartNotAllowedException;
import android.app.Service;
import android.content.Intent;
import android.os.Build;
import android.os.IBinder;
import androidx.annotation.Nullable;
import androidx.core.content.ContextCompat;
import java.util.List;
import app.organicmaps.MwmApplication;
import app.organicmaps.util.log.Logger;
public class DownloaderService extends Service implements MapManager.StorageCallback
{
private static final String TAG = DownloaderService.class.getSimpleName();
private final DownloaderNotifier mNotifier = new DownloaderNotifier(this);
private int mSubscriptionSlot;
@Override
public void onCreate()
{
super.onCreate();
Logger.i(TAG);
mSubscriptionSlot = MapManager.nativeSubscribe(this);
}
@Override
public int onStartCommand(Intent intent, int flags, int startId)
{
Logger.i(TAG, "Downloading: " + MapManager.nativeIsDownloading());
var notification = mNotifier.buildProgressNotification();
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S)
{
try
{
startForeground(DownloaderNotifier.NOTIFICATION_ID, notification);
} catch (ForegroundServiceStartNotAllowedException e)
{
Logger.e(TAG, "Oops! ForegroundService is not allowed", e);
}
} else
{
startForeground(DownloaderNotifier.NOTIFICATION_ID, notification);
}
return START_NOT_STICKY;
}
@Nullable
@Override
public IBinder onBind(Intent intent)
{
return null;
}
@Override
public void onStatusChanged(List<MapManager.StorageCallbackData> data)
{
var isDownloading = MapManager.nativeIsDownloading();
var hasFailed = hasDownloadFailed(data);
Logger.i(TAG, "Downloading: " + isDownloading + " failure: " + hasFailed);
if (!isDownloading)
{
if (hasFailed)
{
// Detach service from the notification to keep after the service is stopped.
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N)
{
stopForeground(Service.STOP_FOREGROUND_DETACH);
} else
{
stopForeground(false);
}
}
stopSelf();
}
}
@Override
public void onProgress(String countryId, long localSize, long remoteSize)
{
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
ContextCompat.checkSelfPermission(this, POST_NOTIFICATIONS) != PERMISSION_GRANTED)
{
Logger.w(TAG, "Permission POST_NOTIFICATIONS is not granted, skipping notification");
return;
}
// TODO: How to calculate progress?
mNotifier.notifyProgress();
}
@Override
public void onDestroy()
{
super.onDestroy();
Logger.i(TAG, "onDestroy");
MapManager.nativeUnsubscribe(mSubscriptionSlot);
}
/**
* Start the foreground service to keep the user informed about the status of region downloads.
*/
public static void startForegroundService()
{
Logger.i(TAG);
var context = MwmApplication.sInstance;
ContextCompat.startForegroundService(context, new Intent(context, DownloaderService.class));
}
private boolean hasDownloadFailed(List<MapManager.StorageCallbackData> data)
{
for (MapManager.StorageCallbackData item : data)
{
if (item.isLeafNode && item.newStatus == CountryItem.STATUS_FAILED)
{
if (MapManager.nativeIsAutoretryFailed())
{
mNotifier.notifyDownloadFailed(item.countryId);
return true;
}
}
}
return false;
}
}

10
android/app/src/main/java/app/organicmaps/downloader/ExpandRetryConfirmationListener.java
View file

@ -1,28 +1,22 @@
package app.organicmaps.downloader;
import android.app.Application;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import app.organicmaps.util.Utils;
class ExpandRetryConfirmationListener extends RetryFailedDownloadConfirmationListener
class ExpandRetryConfirmationListener implements Runnable
{
@Nullable
private final Utils.Proc<Boolean> mDialogClickListener;
ExpandRetryConfirmationListener(@NonNull Application app,
@Nullable Utils.Proc<Boolean> dialogClickListener)
ExpandRetryConfirmationListener(@Nullable Utils.Proc<Boolean> dialogClickListener)
{
super(app);
mDialogClickListener = dialogClickListener;
}
@Override
public void run()
{
super.run();
if (mDialogClickListener == null)
return;
mDialogClickListener.invoke(true);

39
android/app/src/main/java/app/organicmaps/downloader/MapManager.java
View file

@ -106,8 +106,8 @@ public final class MapManager
})
.setPositiveButton(R.string.downloader_retry, (dialog, which) -> {
Application app = activity.getApplication();
RetryFailedDownloadConfirmationListener listener
= new ExpandRetryConfirmationListener(app, dialogClickListener);
ExpandRetryConfirmationListener listener
= new ExpandRetryConfirmationListener(dialogClickListener);
warn3gAndRetry(activity, errorData.countryId, listener);
}).create();
dlg.setCanceledOnTouchOutside(false);
@ -208,7 +208,7 @@ public final class MapManager
return warnOn3g(activity, countryId, () -> {
if (onAcceptListener != null)
onAcceptListener.run();
nativeDownload(countryId);
startDownload(countryId);
});
}
@ -217,10 +217,37 @@ public final class MapManager
return warnOn3g(activity, countryId, () -> {
if (onAcceptListener != null)
onAcceptListener.run();
nativeRetry(countryId);
retryDownload(countryId);
});
}
/**
* Enqueues failed items under given {@code root} node in downloader.
*/
public static void retryDownload(@NonNull String countryId) {
DownloaderService.startForegroundService();
nativeRetry(countryId);
}
/**
* Enqueues the given list of nodes and its children in downloader.
*/
public static void startDownload(String... countries) {
DownloaderService.startForegroundService();
for (var countryId : countries)
{
nativeDownload(countryId);
}
}
/**
* Enqueues given {@code root} node and its children in downloader.
*/
public static void startDownload(@NonNull String countryId) {
DownloaderService.startForegroundService();
nativeDownload(countryId);
}
/**
* Retrieves ID of root node.
*/
@ -314,12 +341,12 @@ public final class MapManager
/**
* Enqueues given {@code root} node and its children in downloader.
*/
public static native void nativeDownload(String root);
private static native void nativeDownload(String root);
/**
* Enqueues failed items under given {@code root} node in downloader.
*/
public static native void nativeRetry(String root);
private static native void nativeRetry(String root);
/**
* Enqueues given {@code root} node with its children in downloader.

7
android/app/src/main/java/app/organicmaps/downloader/OnmapDownloader.java
View file

@ -166,7 +166,7 @@ public class OnmapDownloader implements MwmActivity.LeftAnimationTrackListener
if (TextUtils.equals(mCurrentCountry.id, country) &&
MapManager.nativeHasSpaceToDownloadCountry(country))
{
MapManager.nativeDownload(mCurrentCountry.id);
MapManager.startDownload(mCurrentCountry.id);
}
}
}
@ -210,12 +210,11 @@ public class OnmapDownloader implements MwmActivity.LeftAnimationTrackListener
boolean retry = (mCurrentCountry.status == CountryItem.STATUS_FAILED);
if (retry)
{
DownloaderNotifier.cancelNotification(mActivity.getApplicationContext());
MapManager.nativeRetry(mCurrentCountry.id);
MapManager.retryDownload(mCurrentCountry.id);
}
else
{
MapManager.nativeDownload(mCurrentCountry.id);
MapManager.startDownload(mCurrentCountry.id);
mActivity.requestPostNotificationsPermission();
}
}));

22
android/app/src/main/java/app/organicmaps/downloader/RetryFailedDownloadConfirmationListener.java
View file

@ -1,22 +0,0 @@
package app.organicmaps.downloader;
import android.app.Application;
import androidx.annotation.NonNull;
public class RetryFailedDownloadConfirmationListener implements Runnable
{
@NonNull
private final Application mApplication;
RetryFailedDownloadConfirmationListener(@NonNull Application application)
{
mApplication = application;
}
@Override
public void run()
{
DownloaderNotifier.cancelNotification(mApplication);
}
}

3
android/app/src/main/java/app/organicmaps/routing/RoutingMapsDownloadFragment.java
View file

@ -42,8 +42,7 @@ public class RoutingMapsDownloadFragment extends BaseRoutingErrorDialogFragment
mMapsArray[i] = item.id;
}
for (String map : mMaps)
MapManager.nativeDownload(map);
MapManager.startDownload(mMapsArray);
}
private View setupFrame(View frame)