Upstream/Ascension
1
0
Fork 0
mirror of https://github.com/DiscordSRV/Ascension.git synced 2024-12-27 17:28:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add presence updater

Browse Source
This commit is contained in:
Vankka 2024-06-26 23:48:14 +03:00
parent bc12809351
commit 6c88174e64
No known key found for this signature in database
GPG Key ID: 62E48025ED4E7EBB
7 changed files with 266 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
bukkit/src/main/java/com/discordsrv/bukkit/config/main/BukkitConfig.java
View File

@ -20,7 +20,7 @@ package com.discordsrv.bukkit.config.main;
import com.discordsrv.common.config.configurate.annotation.Order;
import com.discordsrv.common.config.main.MainConfig;
import com.discordsrv.common.config.main.PluginIntegrationConfig;
import com.discordsrv.common.config.main.PresenceUpdaterConfig;
import com.discordsrv.common.config.main.channels.base.BaseChannelConfig;
import com.discordsrv.common.config.main.channels.base.server.ServerBaseChannelConfig;
import com.discordsrv.common.config.main.channels.base.server.ServerChannelConfig;
@ -42,11 +42,8 @@ public class BukkitConfig extends MainConfig {
@Order(5)
public BukkitRequiredLinkingConfig requiredLinking = new BukkitRequiredLinkingConfig();
@Order(100)
public PluginIntegrationConfig integrations = new PluginIntegrationConfig();
@Override
public PluginIntegrationConfig integrations() {
return integrations;
public PresenceUpdaterConfig defaultPresenceUpdater() {
return new PresenceUpdaterConfig.Server();
}
}

3
common/src/main/java/com/discordsrv/common/AbstractDiscordSRV.java
View File

@ -78,6 +78,7 @@ import com.discordsrv.common.placeholder.PlaceholderServiceImpl;
import com.discordsrv.common.placeholder.context.GlobalDateFormattingContext;
import com.discordsrv.common.placeholder.context.GlobalTextHandlingContext;
import com.discordsrv.common.placeholder.result.ComponentResultStringifier;
import com.discordsrv.common.presence.PresenceUpdaterModule;
import com.discordsrv.common.profile.ProfileManager;
import com.discordsrv.common.storage.Storage;
import com.discordsrv.common.storage.StorageType;
@ -590,6 +591,7 @@ public abstract class AbstractDiscordSRV<
registerModule(DiscordInviteModule::new);
registerModule(MentionCachingModule::new);
registerModule(LinkingModule::new);
registerModule(PresenceUpdaterModule::new);
// Integrations
registerIntegration("com.discordsrv.common.integration.LuckPermsIntegration");
@ -608,6 +610,7 @@ public abstract class AbstractDiscordSRV<
protected final void startedMessage() {
registerModule(StartMessageModule::new);
registerModule(StopMessageModule::new);
Optional.ofNullable(getModule(PresenceUpdaterModule.class)).ifPresent(PresenceUpdaterModule::serverStarted);
}
private StorageType getStorageType() {

13
common/src/main/java/com/discordsrv/common/config/main/MainConfig.java
View File

@ -81,6 +81,12 @@ public abstract class MainConfig implements Config {
public LinkedAccountConfig linkedAccounts = new LinkedAccountConfig();
public PresenceUpdaterConfig presenceUpdater = defaultPresenceUpdater();
protected PresenceUpdaterConfig defaultPresenceUpdater() {
return new PresenceUpdaterConfig();
}
public TimedUpdaterConfig timedUpdater = new TimedUpdaterConfig();
@Comment("Configuration options for group-role synchronization")
@ -109,7 +115,12 @@ public abstract class MainConfig implements Config {
@Constants.Comment("%player_avatar_url%")
public AvatarProviderConfig avatarProvider = new AvatarProviderConfig();
public abstract PluginIntegrationConfig integrations();
@Order(100)
public PluginIntegrationConfig integrations = defaultIntegrations();
protected PluginIntegrationConfig defaultIntegrations() {
return new PluginIntegrationConfig();
}
@Order(1000)
public MemberCachingConfig memberCaching = new MemberCachingConfig();

121
common/src/main/java/com/discordsrv/common/config/main/PresenceUpdaterConfig.java Normal file
View File

@ -0,0 +1,121 @@
/*
* This file is part of DiscordSRV, licensed under the GPLv3 License
* Copyright (c) 2016-2024 Austin "Scarsz" Shapiro, Henri "Vankka" Schubin and DiscordSRV contributors
*
* 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.
*
* This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.discordsrv.common.config.main;
import com.discordsrv.common.config.configurate.annotation.Constants;
import com.discordsrv.common.logging.Logger;
import net.dv8tion.jda.api.OnlineStatus;
import net.dv8tion.jda.api.entities.Activity;
import org.spongepowered.configurate.objectmapping.ConfigSerializable;
import org.spongepowered.configurate.objectmapping.meta.Comment;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
@ConfigSerializable
public class PresenceUpdaterConfig {
@Comment("The amount of seconds between presence updates\n"
+ "Minimum value: %1s")
@Constants.Comment("30")
public int updaterRateInSeconds = 90;
public List<Presence> presences = new ArrayList<>(Collections.singleton(new Presence()));
@ConfigSerializable
public static class Server extends PresenceUpdaterConfig {
@Comment("The presence to use while the server is starting")
public boolean useStartingPresence = true;
public Presence startingPresence = new Presence(OnlineStatus.DO_NOT_DISTURB, "Starting...");
@Comment("The presence to use while the server is stopping")
public boolean useStoppingPresence = true;
public Presence stoppingPresence = new Presence(OnlineStatus.IDLE, "Stopping...");
}
@ConfigSerializable
public static class Presence {
public Presence() {}
public Presence(OnlineStatus status, String activity) {
this.status = status;
this.activity = activity;
}
@Comment("Valid options: %1")
@Constants.Comment({"online, idle, do_not_disturb, invisible"})
public OnlineStatus status = OnlineStatus.ONLINE;
@Comment("This may be prefixed by one of the following to specify the activity type: %1\n"
+ "You can prefix the value with %2 and a YouTube or Twitch link to use the Streaming activity type")
@Constants.Comment({
"\"playing\", \"listening\", \"watching\", \"competing in\"",
"\"streaming\""
})
public String activity = "playing Minecraft";
public Activity activity(Logger logger) {
Activity.ActivityType activityType = Activity.ActivityType.CUSTOM_STATUS;
String activity = this.activity;
String url = null;
for (Activity.ActivityType type : Activity.ActivityType.values()) {
String name = type.name().toLowerCase(Locale.ROOT);
if (type == Activity.ActivityType.COMPETING) {
name = "competing in";
}
name += " ";
if (!activity.toLowerCase(Locale.ROOT).startsWith(name)) {
continue;
}
String namePart = activity.substring(name.length());
if (namePart.trim().isEmpty()) {
continue;
}
if (type == Activity.ActivityType.STREAMING) {
String[] parts = namePart.split(" ", 2);
if (parts.length == 2) {
String link = parts[0];
if (!Activity.isValidStreamingUrl(link)) {
if (logger != null) {
logger.warning("Invalid streaming presence URL: " + link);
}
} else {
url = parts[0];
namePart = parts[1];
}
}
}
activityType = type;
activity = namePart;
break;
}
return Activity.of(activityType, activity, url);
}
}
}

2
common/src/main/java/com/discordsrv/common/module/type/PluginIntegration.java
View File

@ -44,7 +44,7 @@ public abstract class PluginIntegration<DT extends DiscordSRV> extends AbstractM
@Override
@OverridingMethodsMustInvokeSuper
public boolean isEnabled() {
if (discordSRV.config().integrations().disabledIntegrations.contains(getIntegrationName())) {
if (discordSRV.config().integrations.disabledIntegrations.contains(getIntegrationName())) {
return false;
}
return super.isEnabled();

125
common/src/main/java/com/discordsrv/common/presence/PresenceUpdaterModule.java Normal file
View File

@ -0,0 +1,125 @@
/*
* This file is part of DiscordSRV, licensed under the GPLv3 License
* Copyright (c) 2016-2024 Austin "Scarsz" Shapiro, Henri "Vankka" Schubin and DiscordSRV contributors
*
* 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.
*
* This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.discordsrv.common.presence;
import com.discordsrv.api.DiscordSRVApi;
import com.discordsrv.api.event.bus.EventPriority;
import com.discordsrv.api.event.bus.Subscribe;
import com.discordsrv.api.event.events.lifecycle.DiscordSRVShuttingDownEvent;
import com.discordsrv.common.DiscordSRV;
import com.discordsrv.common.config.main.PresenceUpdaterConfig;
import com.discordsrv.common.logging.NamedLogger;
import com.discordsrv.common.module.type.AbstractModule;
import net.dv8tion.jda.api.JDA;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
public class PresenceUpdaterModule extends AbstractModule<DiscordSRV> {
private Future<?> future;
private final AtomicInteger currentIndex = new AtomicInteger(0);
private final AtomicReference<ServerState> serverState = new AtomicReference<>(ServerState.PRE_START);
public PresenceUpdaterModule(DiscordSRV discordSRV) {
super(discordSRV, new NamedLogger(discordSRV, "PRESENCE_UPDATER"));
}
public void serverStarted() {
serverState.set(ServerState.STARTED);
setPresenceOrSchedule();
}
@Subscribe(priority = EventPriority.EARLIEST)
public void onDiscordSRVShuttingDown(DiscordSRVShuttingDownEvent event) {
serverState.set(ServerState.STOPPING);
setPresenceOrSchedule();
}
@Override
public void reload(Consumer<DiscordSRVApi.ReloadResult> resultConsumer) {
setPresenceOrSchedule();
// Log problems with presences
for (PresenceUpdaterConfig.Presence presence : discordSRV.config().presenceUpdater.presences) {
presence.activity(logger());
}
}
private void setPresence(PresenceUpdaterConfig.Presence config) {
JDA jda = discordSRV.jda();
if (jda == null) {
// Guess not
return;
}
jda.getPresence().setPresence(config.status, config.activity(null));
}
private void setPresenceOrSchedule() {
boolean alreadyScheduled = future != null;
if (future != null) {
future.cancel(true);
}
PresenceUpdaterConfig config = discordSRV.config().presenceUpdater;
if (config instanceof PresenceUpdaterConfig.Server) {
PresenceUpdaterConfig.Server serverConfig = (PresenceUpdaterConfig.Server) config;
switch (serverState.get()) {
case PRE_START:
if (serverConfig.useStartingPresence) {
setPresence(serverConfig.startingPresence);
return;
}
case STOPPING:
if (serverConfig.useStoppingPresence) {
setPresence(serverConfig.stoppingPresence);
return;
}
}
}
List<PresenceUpdaterConfig.Presence> presences = config.presences;
int count = config.presences.size();
if (count == 1) {
setPresence(presences.get(0));
return;
}
Duration duration = Duration.ofSeconds(config.updaterRateInSeconds);
future = discordSRV.scheduler().runAtFixedRate(() -> {
int index = currentIndex.getAndUpdate(value -> {
if (count <= value) {
return 0;
}
return value + 1;
});
setPresence(presences.get(index));
}, alreadyScheduled ? duration : Duration.ZERO, duration);
}
private enum ServerState {
PRE_START,
STARTED,
STOPPING
}
}

8
common/src/test/java/com/discordsrv/common/MockDiscordSRV.java
View File

@ -29,7 +29,6 @@ import com.discordsrv.common.config.configurate.manager.MessagesConfigManager;
import com.discordsrv.common.config.configurate.manager.abstraction.ServerConfigManager;
import com.discordsrv.common.config.connection.ConnectionConfig;
import com.discordsrv.common.config.main.MainConfig;
import com.discordsrv.common.config.main.PluginIntegrationConfig;
import com.discordsrv.common.config.main.channels.base.ChannelConfig;
import com.discordsrv.common.config.main.generic.DestinationConfig;
import com.discordsrv.common.config.main.generic.ThreadConfig;
@ -230,12 +229,7 @@ public class MockDiscordSRV extends AbstractDiscordSRV<IBootstrap, MainConfig, C
@Override
public MainConfig config() {
MainConfig config = new MainConfig() {
@Override
public PluginIntegrationConfig integrations() {
return null;
}
};
MainConfig config = new MainConfig() {};
if (StringUtils.isNotEmpty(FullBootExtension.TEST_CHANNEL_ID) && StringUtils.isNotEmpty(FullBootExtension.FORUM_CHANNEL_ID)) {
ChannelConfig global = (ChannelConfig) config.channels.get(GameChannel.DEFAULT_NAME);