mirror of
https://github.com/yairm210/Unciv.git
synced 2025-07-28 05:39:10 +07:00
Added Multiplayer Turn Notification Service (#1947)
* Added Multiplayer Turn Notification Service https://github.com/yairm210/Unciv/issues/1680 * Minor update on Credits.md (#1949) # Nations - Fix typo on word "crescent" - Fix link that flew off on word "sword" * 3.5.14-patch1 * Edit startgame screen. (#1950) Co-authored-by: u-ndefine <41176671+u-ndefine@users.noreply.github.com> * Small improvements suggested in pull request review https://github.com/yairm210/Unciv/pull/1947 * Removed potential concurrency hazzards caused by access to non-final variables. Added option to turn off persistent notification (may be necessary on pre-Oreo phones.) Added suggested comments. https://github.com/yairm210/Unciv/pull/1947 * Fixed miscommited debug code. https://github.com/yairm210/Unciv/pull/1947 Co-authored-by: u-ndefine <41176671+u-ndefine@users.noreply.github.com> Co-authored-by: Yair Morgenstern <yairm210@hotmail.com> Co-authored-by: lishaoxia1985 <49801619+lishaoxia1985@users.noreply.github.com>
This commit is contained in:
wrov
@ -2,6 +2,8 @@ package com.unciv.app
|
||||
|
||||
import android.os.Build
|
||||
import android.os.Bundle
|
||||
import androidx.core.app.NotificationManagerCompat
|
||||
import androidx.work.WorkManager
|
||||
import com.badlogic.gdx.backends.android.AndroidApplication
|
||||
import com.badlogic.gdx.backends.android.AndroidApplicationConfiguration
|
||||
import com.unciv.UncivGame
|
||||
@ -10,6 +12,7 @@ import java.io.File
|
||||
class AndroidLauncher : AndroidApplication() {
|
||||
override fun onCreate(savedInstanceState: Bundle?) {
|
||||
super.onCreate(savedInstanceState)
|
||||
createNotificationChannels()
|
||||
|
||||
// Only allow mods on KK+, to avoid READ_EXTERNAL_STORAGE permission earlier versions need
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
|
||||
@ -23,6 +26,14 @@ class AndroidLauncher : AndroidApplication() {
|
||||
initialize(game, config)
|
||||
}
|
||||
|
||||
/**
|
||||
* Necessary for Multiplayer Turner Checker, starting with Android Oreo
|
||||
*/
|
||||
private fun createNotificationChannels() {
|
||||
MultiplayerTurnCheckWorker.createNotificationChannelInfo(context)
|
||||
MultiplayerTurnCheckWorker.createNotificationChannelService(context)
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies mods from external data directory (where users can access) to the private one (where
|
||||
* libGDX reads from). Note: deletes all files currently in the private mod directory and
|
||||
@ -43,4 +54,22 @@ class AndroidLauncher : AndroidApplication() {
|
||||
if (!externalModsDir.exists()) externalModsDir.mkdirs()
|
||||
externalModsDir.copyRecursively(internalModsDir)
|
||||
}
|
||||
|
||||
override fun onPause() {
|
||||
if (UncivGame.Current.settings.multiplayerTurnCheckerEnabled
|
||||
&& UncivGame.Current.isGameInfoInitialized()
|
||||
&& UncivGame.Current.gameInfo.gameParameters.isOnlineMultiplayer) {
|
||||
MultiplayerTurnCheckWorker.startTurnChecker(applicationContext, UncivGame.Current.gameInfo, UncivGame.Current.settings)
|
||||
}
|
||||
super.onPause()
|
||||
}
|
||||
|
||||
override fun onResume() {
|
||||
WorkManager.getInstance(applicationContext).cancelAllWorkByTag(MultiplayerTurnCheckWorker.WORK_TAG)
|
||||
with(NotificationManagerCompat.from(this)) {
|
||||
cancel(MultiplayerTurnCheckWorker.NOTIFICATION_ID_INFO)
|
||||
cancel(MultiplayerTurnCheckWorker.NOTIFICATION_ID_SERVICE)
|
||||
}
|
||||
super.onResume()
|
||||
}
|
||||
}
|
||||
235
android/src/com/unciv/app/MultiplayerTurnCheckWorker.kt
Normal file
235
android/src/com/unciv/app/MultiplayerTurnCheckWorker.kt
Normal file
@ -0,0 +1,235 @@
|
||||
package com.unciv.app
|
||||
|
||||
import android.app.NotificationChannel
|
||||
import android.app.NotificationManager
|
||||
import android.app.PendingIntent
|
||||
import android.content.Context
|
||||
import android.content.Intent
|
||||
import android.graphics.Color
|
||||
import android.os.Build
|
||||
import androidx.core.app.NotificationCompat
|
||||
import androidx.core.app.NotificationCompat.DEFAULT_VIBRATE
|
||||
import androidx.core.app.NotificationManagerCompat
|
||||
import androidx.work.*
|
||||
import com.badlogic.gdx.backends.android.AndroidApplication
|
||||
import com.unciv.logic.GameInfo
|
||||
import com.unciv.models.metadata.GameSettings
|
||||
import com.unciv.models.translations.tr
|
||||
import com.unciv.ui.worldscreen.mainmenu.OnlineMultiplayer
|
||||
import java.util.*
|
||||
import java.util.concurrent.TimeUnit
|
||||
|
||||
|
||||
class MultiplayerTurnCheckWorker(appContext: Context, workerParams: WorkerParameters)
|
||||
: Worker(appContext, workerParams) {
|
||||
|
||||
companion object {
|
||||
const val WORK_TAG = "UNCIV_MULTIPLAYER_TURN_CHECKER_WORKER"
|
||||
const val NOTIFICATION_ID_SERVICE = 1
|
||||
const val NOTIFICATION_ID_INFO = 2
|
||||
private const val NOTIFICATION_CHANNEL_ID_INFO = "UNCIV_NOTIFICATION_CHANNEL_INFO"
|
||||
private const val NOTIFICATION_CHANNEL_ID_SERVICE = "UNCIV_NOTIFICATION_CHANNEL_SERVICE"
|
||||
|
||||
@Volatile private var failCount = 0
|
||||
@Volatile private var gameId = ""
|
||||
@Volatile private var userId = ""
|
||||
@Volatile private var configuredDelay = 5L
|
||||
@Volatile private var persistentNotificationEnabled = true
|
||||
|
||||
fun enqueue(appContext: Context, delayInMinutes: Long) {
|
||||
val constraints = Constraints.Builder()
|
||||
// If no internet is available, worker waits before becoming active.
|
||||
.setRequiredNetworkType(NetworkType.CONNECTED)
|
||||
.build()
|
||||
|
||||
val checkTurnWork = OneTimeWorkRequestBuilder<MultiplayerTurnCheckWorker>()
|
||||
.setConstraints(constraints)
|
||||
.setInitialDelay(delayInMinutes, TimeUnit.MINUTES)
|
||||
.addTag(WORK_TAG)
|
||||
.build()
|
||||
|
||||
WorkManager.getInstance(appContext).enqueue(checkTurnWork)
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification Channel for 'It's your turn' and error notifications.
|
||||
*
|
||||
* This code is necessary for API level >= 26
|
||||
* API level < 26 does not support Notification Channels
|
||||
* For more infos: https://developer.android.com/training/notify-user/channels.html#CreateChannel
|
||||
*/
|
||||
fun createNotificationChannelInfo(appContext: Context) {
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
|
||||
val name = "Unciv Multiplayer Turn Checker Alert"
|
||||
val descriptionText = "Informs you when it's your turn in multiplayer."
|
||||
val importance = NotificationManager.IMPORTANCE_HIGH
|
||||
val mChannel = NotificationChannel(NOTIFICATION_CHANNEL_ID_INFO, name, importance)
|
||||
mChannel.description = descriptionText
|
||||
mChannel.setShowBadge(true)
|
||||
mChannel.setLockscreenVisibility(NotificationCompat.VISIBILITY_PUBLIC)
|
||||
|
||||
val notificationManager = appContext.getSystemService(AndroidApplication.NOTIFICATION_SERVICE) as NotificationManager
|
||||
notificationManager.createNotificationChannel(mChannel)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification Channel for persistent service notification.
|
||||
*
|
||||
* This code is necessary for API level >= 26
|
||||
* API level < 26 does not support Notification Channels
|
||||
* For more infos: https://developer.android.com/training/notify-user/channels.html#CreateChannel
|
||||
*/
|
||||
fun createNotificationChannelService(appContext: Context) {
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
|
||||
val name = "Unciv Multiplayer Turn Checker Persistent Status"
|
||||
val descriptionText = "Shown constantly to inform you about background checking."
|
||||
val importance = NotificationManager.IMPORTANCE_MIN
|
||||
val mChannel = NotificationChannel(NOTIFICATION_CHANNEL_ID_SERVICE, name, importance)
|
||||
mChannel.description = descriptionText
|
||||
|
||||
val notificationManager = appContext.getSystemService(AndroidApplication.NOTIFICATION_SERVICE) as NotificationManager
|
||||
notificationManager.createNotificationChannel(mChannel)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The persistent notification is purely for informational reasons.
|
||||
* It is not technically necessary for the Worker, since it is not a Service.
|
||||
*/
|
||||
fun showPersistentNotification(appContext: Context, lastTimeChecked: String, checkPeriod: String) {
|
||||
if (persistentNotificationEnabled) {
|
||||
val pendingIntent: PendingIntent =
|
||||
Intent(appContext, AndroidLauncher::class.java).let { notificationIntent ->
|
||||
PendingIntent.getActivity(appContext, 0, notificationIntent, 0)
|
||||
}
|
||||
|
||||
val notification: NotificationCompat.Builder = NotificationCompat.Builder(appContext, NOTIFICATION_CHANNEL_ID_SERVICE)
|
||||
.setPriority(NotificationManagerCompat.IMPORTANCE_MIN) // it's only a status
|
||||
.setContentTitle("Unciv multiplayer turn notifier running".tr())
|
||||
.setStyle(NotificationCompat.BigTextStyle()
|
||||
.bigText("Unciv will inform you when it's your turn.".tr() + "\n" +
|
||||
"Last checked: [$lastTimeChecked]. Checks ca. every [$checkPeriod] minute(s) when Internet available.".tr()
|
||||
+ " " + "Configurable in Unciv options menu.".tr()))
|
||||
.setSmallIcon(R.drawable.uncivicon2)
|
||||
.setContentIntent(pendingIntent)
|
||||
.setCategory(NotificationCompat.CATEGORY_SERVICE)
|
||||
.setOnlyAlertOnce(true)
|
||||
.setOngoing(true)
|
||||
|
||||
with(NotificationManagerCompat.from(appContext)) {
|
||||
notify(NOTIFICATION_ID_INFO, notification.build())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun notifyUserAboutTurn(applicationContext: Context) {
|
||||
val pendingIntent: PendingIntent =
|
||||
Intent(applicationContext, AndroidLauncher::class.java).let { notificationIntent ->
|
||||
PendingIntent.getActivity(applicationContext, 0, notificationIntent, 0)
|
||||
}
|
||||
|
||||
val contentTitle = "Unciv - It's your turn!".tr()
|
||||
val notification: NotificationCompat.Builder = NotificationCompat.Builder(applicationContext, NOTIFICATION_CHANNEL_ID_INFO)
|
||||
.setPriority(NotificationManagerCompat.IMPORTANCE_HIGH) // people are waiting!
|
||||
.setContentTitle(contentTitle)
|
||||
.setContentText("Your friends are waiting on your turn.".tr())
|
||||
.setTicker(contentTitle)
|
||||
// without at least vibrate, some Android versions don't show a heads-up notification
|
||||
.setDefaults(DEFAULT_VIBRATE)
|
||||
.setLights(Color.YELLOW, 300, 100)
|
||||
.setSmallIcon(R.drawable.uncivicon2)
|
||||
.setContentIntent(pendingIntent)
|
||||
.setCategory(NotificationCompat.CATEGORY_SOCIAL)
|
||||
.setOngoing(false)
|
||||
|
||||
with(NotificationManagerCompat.from(applicationContext)) {
|
||||
notify(NOTIFICATION_ID_INFO, notification.build())
|
||||
}
|
||||
}
|
||||
|
||||
fun startTurnChecker(applicationContext: Context, gameInfo: GameInfo, settings: GameSettings) {
|
||||
if (gameInfo.currentPlayerCiv.playerId == settings.userId) {
|
||||
// May be useful to remind a player that he forgot to complete his turn.
|
||||
notifyUserAboutTurn(applicationContext)
|
||||
} else {
|
||||
gameId = gameInfo.gameId
|
||||
userId = settings.userId
|
||||
configuredDelay = settings.multiplayerTurnCheckerDelayInMinutes
|
||||
persistentNotificationEnabled = settings.multiplayerTurnCheckerPermanentNotificationEnabled
|
||||
|
||||
showPersistentNotification(applicationContext,
|
||||
"—", settings.multiplayerTurnCheckerDelayInMinutes.toString())
|
||||
// Initial check always happens after a minute, ignoring delay config. Better user experience this way.
|
||||
enqueue(applicationContext, 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
override fun doWork(): Result {
|
||||
try {
|
||||
val latestGame = OnlineMultiplayer().tryDownloadGame(gameId)
|
||||
if (latestGame.currentPlayerCiv.playerId == userId) {
|
||||
notifyUserAboutTurn(applicationContext)
|
||||
with(NotificationManagerCompat.from(applicationContext)) {
|
||||
cancel(NOTIFICATION_ID_SERVICE)
|
||||
}
|
||||
} else {
|
||||
enqueue(applicationContext, configuredDelay)
|
||||
updatePersistentNotification()
|
||||
}
|
||||
failCount = 0
|
||||
} catch (ex: Exception) {
|
||||
if (failCount++ > 3) {
|
||||
showErrorNotification()
|
||||
with(NotificationManagerCompat.from(applicationContext)) {
|
||||
cancel(NOTIFICATION_ID_SERVICE)
|
||||
}
|
||||
return Result.failure()
|
||||
} else {
|
||||
// If check fails, retry in one minute.
|
||||
// Makes sense, since checks only happen if Internet is available in principle.
|
||||
// Therefore a failure means either a problem with the GameInfo or with Dropbox.
|
||||
enqueue(applicationContext, 1)
|
||||
updatePersistentNotification()
|
||||
}
|
||||
}
|
||||
return Result.success()
|
||||
}
|
||||
|
||||
private fun updatePersistentNotification() {
|
||||
val cal = GregorianCalendar.getInstance()
|
||||
val hour = cal.get(GregorianCalendar.HOUR_OF_DAY).toString()
|
||||
var minute = cal.get(GregorianCalendar.MINUTE).toString()
|
||||
if (minute.length == 1) {
|
||||
minute = "0$minute"
|
||||
}
|
||||
val displayTime = "$hour:$minute"
|
||||
|
||||
showPersistentNotification(applicationContext, displayTime,
|
||||
configuredDelay.toString())
|
||||
}
|
||||
|
||||
private fun showErrorNotification() {
|
||||
val pendingIntent: PendingIntent =
|
||||
Intent(applicationContext, AndroidLauncher::class.java).let { notificationIntent ->
|
||||
PendingIntent.getActivity(applicationContext, 0, notificationIntent, 0)
|
||||
}
|
||||
|
||||
val notification: NotificationCompat.Builder = NotificationCompat.Builder(applicationContext, NOTIFICATION_CHANNEL_ID_INFO)
|
||||
.setPriority(NotificationManagerCompat.IMPORTANCE_DEFAULT) // No direct user action expected
|
||||
.setContentTitle("An error has occured".tr())
|
||||
.setContentText("Multiplayer turn notifier service terminated".tr())
|
||||
.setSmallIcon(R.drawable.uncivicon2)
|
||||
// without at least vibrate, some Android versions don't show a heads-up notification
|
||||
.setDefaults(DEFAULT_VIBRATE)
|
||||
.setLights(Color.YELLOW, 300, 100)
|
||||
.setContentIntent(pendingIntent)
|
||||
.setCategory(NotificationCompat.CATEGORY_ERROR)
|
||||
.setOngoing(false)
|
||||
|
||||
with(NotificationManagerCompat.from(applicationContext)) {
|
||||
notify(NOTIFICATION_ID_INFO, notification.build())
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user