Re-implement persisted roles

Matyrobbrt · Matyrobbrt · commit ccc0a26bd55c · 2022-04-24T22:54:57.000+03:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -36,7 +36,7 @@ jobs:
           BUILD_NUMBER: ${{ github.run_number }}
       - name: Make Changelog
         id: changelog
-        run: ./gradlew :makeChangelog -Ptag=${{ env.TAG }}
+        run: ./gradlew :makeChangelog -Ptag=${{ env.TAG }} -Pbot_version=${{ env.TAG }}
         env:
           GITHUB_TOKEN: ${{ github.token }}
       - name: Create release
@@ -48,4 +48,4 @@ jobs:
           name: Release ${{ env.TAG }}
           artifactErrorsFailBuild: true
           artifacts: 'build/libs/*[-all].jar'
-          bodyFile: 'changelog.html'
+          bodyFile: 'changelog.md'
diff --git a/.gitignore b/.gitignore
@@ -36,7 +36,7 @@ OCR.png
 qr.png
 diction.txt
 data/
-changelog.html
+changelog.md
 
 #BotStuff
 mmdbot_config.toml
diff --git a/build.gradle b/build.gradle
@@ -138,7 +138,7 @@ dependencies {
   global libs.jdbi.sqlobject
 
   testImplementation libs.junit
-  testImplementation 'org.mockito:mockito-core:4.5.1'
+  testImplementation libs.mockito
 
   testImplementation sourceSets.watcher.output
 }
@@ -157,7 +157,7 @@ tasks.named('run', JavaExec).configure {
 }
 
 tasks.named('test', Test).configure {
-  workingDir = new File("run")
+  workingDir = java.nio.file.Path.of("run").resolve("tests").toFile()
 }
 
 tasks.named('shadowJar', ShadowJar).configure {
@@ -240,7 +240,7 @@ license {
 
 tasks.register('makeChangelog', GitChangelogTask) {
   fromRepo = projectDir.absolutePath.toString()
-  file = file("changelog.html")
+  file = file("changelog.md")
   untaggedName = "Current release $version"
   toRef = "HEAD"
   fromCommit = resolveStartCommit(project.tag)
diff --git a/changelog.mustache b/changelog.mustache
@@ -1,15 +1,9 @@
 {{#tags}}
-    <h3>{{name}}</h3>
-    <ul>
-        {{#commits}}
-            <li>
-                <a href="https://github.com/MinecraftModDevelopment/MMDBot/commit/{{hashFull}}">{{{messageTitle}}}</a> - {{{authorName}}}
-                <ul>
-                    {{#messageBodyItems}}
-                        <li>{{.}}</li>
-                    {{/messageBodyItems}}
-                </ul>
-            </li>
-        {{/commits}}
-    </ul>
+## {{name}}
+    {{#commits}}
+- [https://github.com/MinecraftModDevelopment/MMDBot/commit/{{hashFull}}]({{{messageTitle}}}) - {{{authorName}}}
+            {{#messageBodyItems}}
+    + {{.}}
+            {{/messageBodyItems}}
+    {{/commits}}
 {{/tags}}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -38,6 +38,7 @@ javadocapi = "21ad5c1759"
 commons-io = "2.11.0"
 caffeine = "3.0.6"
 urldetector = "0.1.23"
+mockito = "4.5.1"
 
 [libraries]
 # jda = { module = "net.dv8tion:JDA", version.ref = "jda" }
@@ -74,3 +75,4 @@ javadocapi = { module = "com.github.I-Al-Istannen:JavadocApi", version.ref = "ja
 commons-io = { module = "commons-io:commons-io", version.ref = "commons-io" }
 caffeine = { module = "com.github.ben-manes.caffeine:caffeine", version.ref = "caffeine" }
 urldetector = { module = "io.github.url-detector:url-detector", version.ref = "urldetector" }
+mockito = { module = "org.mockito:mockito-core", version.ref = "mockito" }
diff --git a/src/core/java/com/mcmoddev/mmdbot/core/database/jdbi/JdbiFactories.java b/src/core/java/com/mcmoddev/mmdbot/core/database/jdbi/JdbiFactories.java
@@ -69,7 +69,7 @@ public static final class JdbiArgumentFactory implements org.jdbi.v3.core.argume
 
         public static final JdbiArgumentFactory FACTORY = new JdbiArgumentFactory();
 
-        private JdbiArgumentFactory() {}
+        public JdbiArgumentFactory() {}
 
         @Override
         public Optional<Argument> build(final Type type, final Object value, final ConfigRegistry config) {
diff --git a/src/listener/java/com/mcmoddev/mmdbot/thelistener/TheListener.java b/src/listener/java/com/mcmoddev/mmdbot/thelistener/TheListener.java
@@ -107,10 +107,12 @@ public void start() throws LoginException {
 
         final var token = dotenv.get("BOT_TOKEN", "");
 
-        addListener(MessageEvents.INSTANCE);
-        addListener(ModerationEvents.INSTANCE);
-        addListener(new LeaveJoinEvents());
-        addListener(new RoleEvents());
+        GENERAL_EVENT_LISTENER.addListeners(
+            MessageEvents.INSTANCE,
+            ModerationEvents.INSTANCE,
+            new LeaveJoinEvents(),
+            new RoleEvents()
+        );
 
         jda = JDABuilder.create(
             token,
@@ -146,10 +148,6 @@ public void shutdown() {
         jda.shutdown();
     }
 
-    public static void addListener(net.dv8tion.jda.api.hooks.EventListener listener) {
-        GENERAL_EVENT_LISTENER.addListener(listener);
-    }
-
     @Override
     public BotType<?> getType() {
         return BOT_TYPE;
diff --git a/src/listener/java/com/mcmoddev/mmdbot/thelistener/events/LeaveJoinEvents.java b/src/listener/java/com/mcmoddev/mmdbot/thelistener/events/LeaveJoinEvents.java
@@ -68,7 +68,7 @@ public void onGuildMemberRemove(@NotNull final GuildMemberRemoveEvent event) {
             .setFooter("User ID: " + event.getMember().getId(), event.getMember().getEffectiveAvatarUrl())
             .addField("User:", event.getUser().getAsTag(), true)
             .addField("Join Time:", TimeFormat.DATE_TIME_SHORT.format(event.getMember().getUser().getTimeCreated()), true)
-            .addField("Roles", String.join(" ", event.getMember().getRoles().stream().map(Role::getAsMention).toList()), false)
+            .addField("Roles", RoleEvents.mentionsOrEmpty(event.getMember().getRoles()), false)
             .setThumbnail(event.getUser().getAvatarUrl())
             .build();
 
diff --git a/src/listener/java/com/mcmoddev/mmdbot/thelistener/events/RoleEvents.java b/src/listener/java/com/mcmoddev/mmdbot/thelistener/events/RoleEvents.java
@@ -109,7 +109,7 @@ private static void buildAndSendMessage(GenericGuildMemberEvent event, AuditLogE
         });
     }
 
-    private static String mentionsOrEmpty(List<? extends IMentionable> list) {
+    public static String mentionsOrEmpty(List<? extends IMentionable> list) {
         final String str = list.stream().map(IMentionable::getAsMention).collect(Collectors.joining(" "));
         return str.isBlank() ? "_None_" : str;
     }
diff --git a/src/watcher/java/com/mcmoddev/mmdbot/watcher/TheWatcher.java b/src/watcher/java/com/mcmoddev/mmdbot/watcher/TheWatcher.java
@@ -47,6 +47,7 @@
 import com.mcmoddev.mmdbot.watcher.commands.moderation.CmdUnmute;
 import com.mcmoddev.mmdbot.watcher.commands.moderation.CmdWarning;
 import com.mcmoddev.mmdbot.watcher.event.EventReactionAdded;
+import com.mcmoddev.mmdbot.watcher.event.PersistedRolesEvents;
 import com.mcmoddev.mmdbot.watcher.punishments.PunishableActions;
 import com.mcmoddev.mmdbot.watcher.util.BotConfig;
 import com.mcmoddev.mmdbot.watcher.util.Configuration;
@@ -281,7 +282,7 @@ public void start() {
         // Buttons
         COMMANDS_LISTENER.addListener(new DismissListener());
 
-        MISC_LISTENER.addListeners(new EventReactionAdded());
+        MISC_LISTENER.addListeners(new EventReactionAdded(), new PersistedRolesEvents());
 
         MessageAction.setDefaultMentionRepliedUser(false);
         MessageAction.setDefaultMentions(DEFAULT_MENTIONS);
diff --git a/src/watcher/java/com/mcmoddev/mmdbot/watcher/event/PersistedRolesEvents.java b/src/watcher/java/com/mcmoddev/mmdbot/watcher/event/PersistedRolesEvents.java
@@ -0,0 +1,74 @@
+/*
+ * MMDBot - https://github.com/MinecraftModDevelopment/MMDBot
+ * Copyright (C) 2016-2022 <MMD - MinecraftModDevelopment>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation;
+ * Specifically version 2.1 of the License.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ * USA
+ * https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+ */
+package com.mcmoddev.mmdbot.watcher.event;
+
+import com.mcmoddev.mmdbot.core.util.config.SnowflakeValue;
+import com.mcmoddev.mmdbot.watcher.TheWatcher;
+import com.mcmoddev.mmdbot.watcher.util.database.PersistedRoles;
+import net.dv8tion.jda.api.entities.ISnowflake;
+import net.dv8tion.jda.api.events.guild.member.GuildMemberJoinEvent;
+import net.dv8tion.jda.api.events.guild.member.GuildMemberRemoveEvent;
+import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Objects;
+import java.util.function.Predicate;
+
+public class PersistedRolesEvents extends ListenerAdapter {
+
+    @Override
+    public void onGuildMemberJoin(@NotNull final GuildMemberJoinEvent event) {
+        TheWatcher.database().useExtension(PersistedRoles.class, db -> {
+            final var notPers = TheWatcher.getInstance().getConfig().roles().getNotPersisted().stream().map(SnowflakeValue::asLong).toList();
+            final var roles = db.getRoles(event.getUser().getIdLong(), event.getGuild().getIdLong()).stream()
+                .filter(Predicate.not(notPers::contains))
+                .map(event.getGuild()::getRoleById)
+                .filter(Objects::nonNull)
+                .toList();
+            if (!roles.isEmpty()) {
+                event.getGuild()
+                    .modifyMemberRoles(event.getMember(), roles)
+                    .reason("Persisted roles")
+                    .queue();
+            }
+            db.clear(event.getUser().getIdLong(), event.getGuild().getIdLong());
+        });
+    }
+
+    @Override
+    public void onGuildMemberRemove(@NotNull final GuildMemberRemoveEvent event) {
+        if (event.getMember() == null) return;
+        TheWatcher.database().useExtension(PersistedRoles.class, db -> {
+            db.clear(event.getUser().getIdLong(), event.getGuild().getIdLong());
+            final var notPers = TheWatcher.getInstance().getConfig().roles().getNotPersisted().stream().map(SnowflakeValue::asLong).toList();
+            final var roles = event.getMember().getRoles()
+                .stream()
+                .filter(r -> !r.isManaged() && event.getGuild().getSelfMember().canInteract(r))
+                .map(ISnowflake::getIdLong)
+                .filter(Predicate.not(notPers::contains))
+                .toList();
+            if (!roles.isEmpty()) {
+                db.insert(event.getUser().getIdLong(), event.getGuild().getIdLong(), roles);
+            }
+        });
+    }
+
+}
diff --git a/src/watcher/java/com/mcmoddev/mmdbot/watcher/util/Configuration.java b/src/watcher/java/com/mcmoddev/mmdbot/watcher/util/Configuration.java
@@ -100,6 +100,15 @@ public static final class Roles {
         public List<SnowflakeValue> getBotMaintainers() {
             return botMaintainers;
         }
+
+        @Required
+        @Setting("not_persisted")
+        @Comment("A list of Snowflake IDs representing the roles which will not be persisted on member leave.")
+        private List<SnowflakeValue> notPersisted = new ArrayList<>();
+
+        public List<SnowflakeValue> getNotPersisted() {
+            return notPersisted;
+        }
     }
 
     @Required
@@ -145,7 +154,5 @@ public Channels channels() {
     @ConfigSerializable
     public static final class Channels {
 
-
-
     }
 }
diff --git a/src/watcher/java/com/mcmoddev/mmdbot/watcher/util/database/PersistedRoles.java b/src/watcher/java/com/mcmoddev/mmdbot/watcher/util/database/PersistedRoles.java
@@ -42,18 +42,20 @@ public interface PersistedRoles extends Transactional<PersistedRoles> {
      *
      * @param userId the snowflake ID of the user
      * @param roleId the snowflake ID of the role
+     * @param guildId the snowflake ID of the guild
      */
-    @SqlUpdate("insert into role_persist values (:user, :role)")
-    void insert(@Bind("user") long userId, @Bind("role") long roleId);
+    @SqlUpdate("insert into role_persist values (:user, :role, :guild)")
+    void insert(@Bind("user") long userId, @Bind("role") long roleId, @Bind("guild") long guildId);
 
     /**
      * Inserts an entry for each role in the given iterable with the given user into the table.
      *
      * @param userId the snowflake ID of the user
+     * @param guildId the snowflake ID of the guild
      * @param roles  an iterable of snowflake IDs of roles
      */
-    default void insert(long userId, Iterable<Long> roles) {
-        roles.forEach(roleId -> insert(userId, roleId));
+    default void insert(long userId, long guildId, Iterable<Long> roles) {
+        roles.forEach(roleId -> insert(userId, roleId, guildId));
     }
 
     /// Query methods ///
@@ -62,10 +64,11 @@ default void insert(long userId, Iterable<Long> roles) {
      * Gets the stored roles for the given user.
      *
      * @param userId the snowflake ID of the user
+     * @param guildId the snowflake ID of the guild
      * @return the list of role snowflake IDs which are associated with the user
      */
-    @SqlQuery("select role_id from role_persist where user_id = :user")
-    List<Long> getRoles(@Bind("user") long userId);
+    @SqlQuery("select role_id from role_persist where user_id = :user and guild_id = :guild")
+    List<Long> getRoles(@Bind("user") long userId, @Bind("guild") long guildId);
 
     /// Deletion methods ///
 
@@ -74,15 +77,17 @@ default void insert(long userId, Iterable<Long> roles) {
      *
      * @param userId the snowflake ID of the user
      * @param roleId the snowflake ID of the role
+     * @param guildId the snowflake ID of the guild
      */
-    @SqlUpdate("delete from role_persist where user_id = :user and role_id = :role")
-    void delete(@Bind("user") long userId, @Bind("role") long roleId);
+    @SqlUpdate("delete from role_persist where user_id = :user and role_id = :role and guild_id = :guild")
+    void delete(@Bind("user") long userId, @Bind("role") long roleId, @Bind("guild") long guildId);
 
     /**
      * Clears all entries for the given user from the table.
      *
      * @param userId the snowflake ID of the user
+     * @param guildId the snowflake ID of the guild
      */
-    @SqlUpdate("delete from role_persist where user_id = :user")
-    void clear(@Bind("user") long userId);
+    @SqlUpdate("delete from role_persist where user_id = :user and guild_id = :guild")
+    void clear(@Bind("user") long userId, @Bind("guild") long guildId);
 }
diff --git a/src/watcher/resources/watcher/db/V5__persisted_roles_migration.sql b/src/watcher/resources/watcher/db/V5__persisted_roles_migration.sql
@@ -0,0 +1,3 @@
+alter table role_persist add column guild_id unsigned big int not null default 0;
+
+drop table if exists first_join;

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ private static void buildAndSendMessage(GenericGuildMemberEvent event, AuditLogE`
`109`	`109`	`});`
`110`	`110`	`}`
`111`	`111`
`112`		`- private static String mentionsOrEmpty(List<? extends IMentionable> list) {`
	`112`	`+ public static String mentionsOrEmpty(List<? extends IMentionable> list) {`
`113`	`113`	`final String str = list.stream().map(IMentionable::getAsMention).collect(Collectors.joining(" "));`
`114`	`114`	`return str.isBlank() ? "_None_" : str;`
`115`	`115`	`}`