[AB-xxx] adding sticky roles module

This commit is contained in:
Sheldan
2024-02-12 22:52:29 +01:00
parent 94a18559d3
commit 59575e0b49
45 changed files with 1317 additions and 19 deletions
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>dev.sheldan.abstracto.modules</groupId>
<artifactId>sticky-roles</artifactId>
<version>1.5.25-SNAPSHOT</version>
</parent>
<artifactId>sticky-roles-int</artifactId>
</project>
@@ -0,0 +1,15 @@
package dev.sheldan.abstracto.stickyroles.config;
import dev.sheldan.abstracto.core.config.FeatureMode;
import lombok.Getter;
@Getter
public enum StickyRoleFeatureMode implements FeatureMode {
ALLOW_SELF_MANAGEMENT("allowSelfManagement");
private final String key;
StickyRoleFeatureMode(String key) {
this.key = key;
}
}
@@ -0,0 +1,23 @@
package dev.sheldan.abstracto.stickyroles.config;
import dev.sheldan.abstracto.core.config.FeatureConfig;
import dev.sheldan.abstracto.core.config.FeatureDefinition;
import dev.sheldan.abstracto.core.config.FeatureMode;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.List;
@Component
public class StickyRolesFeatureConfig implements FeatureConfig {
@Override
public FeatureDefinition getFeature() {
return StickyRolesFeatureDefinition.STICKY_ROLES;
}
@Override
public List<FeatureMode> getAvailableModes() {
return Arrays.asList(StickyRoleFeatureMode.ALLOW_SELF_MANAGEMENT);
}
}
@@ -0,0 +1,15 @@
package dev.sheldan.abstracto.stickyroles.config;
import dev.sheldan.abstracto.core.config.FeatureDefinition;
import lombok.Getter;
@Getter
public enum StickyRolesFeatureDefinition implements FeatureDefinition {
STICKY_ROLES("stickyRoles");
private String key;
StickyRolesFeatureDefinition(String key) {
this.key = key;
}
}
@@ -0,0 +1,6 @@
package dev.sheldan.abstracto.stickyroles.config;
public class StickyRolesSlashCommandNames {
public static final String STICKY_ROLES = "stickyroles";
public static final String STICKY_ROLES_PUBLIC = "stickyrolespublic";
}
@@ -0,0 +1,52 @@
package dev.sheldan.abstracto.stickyroles.model.database;
import dev.sheldan.abstracto.core.models.database.ARole;
import dev.sheldan.abstracto.core.models.database.AServer;
import jakarta.persistence.*;
import lombok.*;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
@Entity
@Table(name="sticky_role")
@Builder
@AllArgsConstructor
@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode
public class StickyRole {
@Id
@Column(name = "id", nullable = false)
private Long id;
/**
* Reference to the actual {@link ARole} being maintained
*/
@OneToOne(fetch = FetchType.LAZY, cascade = {CascadeType.PERSIST, CascadeType.MERGE})
@PrimaryKeyJoinColumn
private ARole role;
@Column(name = "sticky", nullable = false)
private Boolean sticky;
@ManyToMany
@JoinTable(
name = "sticky_role_user_mapping",
joinColumns = @JoinColumn(name = "role_id"),
inverseJoinColumns = @JoinColumn(name = "user_id"))
@Builder.Default
private List<StickyRoleUser> users = new ArrayList<>();
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "server_id", nullable = false)
private AServer server;
@Column(name = "created", nullable = false, insertable = false, updatable = false)
private Instant created;
@Column(name = "updated", insertable = false, updatable = false)
private Instant updated;
}
@@ -0,0 +1,51 @@
package dev.sheldan.abstracto.stickyroles.model.database;
import dev.sheldan.abstracto.core.models.database.AServer;
import dev.sheldan.abstracto.core.models.database.AUserInAServer;
import jakarta.persistence.*;
import lombok.*;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
@Builder
@Entity
@NoArgsConstructor
@AllArgsConstructor
@Table(name = "sticky_role_user")
@Getter
@Setter
@EqualsAndHashCode
public class StickyRoleUser {
/**
* The ID of the {@link AUserInAServer user} which is represented by this object
*/
@Id
@Column(name = "id", nullable = false)
private Long id;
/**
* The {@link AUserInAServer user} which is represented by this object
*/
@OneToOne(fetch = FetchType.LAZY, cascade = {CascadeType.PERSIST, CascadeType.MERGE})
@PrimaryKeyJoinColumn
private AUserInAServer user;
@Column(name = "sticky")
private Boolean sticky;
@ManyToMany(mappedBy = "users")
@Builder.Default
private List<StickyRole> roles = new ArrayList<>();
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "server_id", nullable = false)
private AServer server;
@Column(name = "created", nullable = false, insertable = false, updatable = false)
private Instant created;
@Column(name = "updated", insertable = false, updatable = false)
private Instant updated;
}
@@ -0,0 +1,12 @@
package dev.sheldan.abstracto.stickyroles.model.template;
import dev.sheldan.abstracto.core.models.template.display.RoleDisplay;
import lombok.Builder;
import lombok.Getter;
@Getter
@Builder
public class StickyRoleDisplayModel {
private RoleDisplay roleDisplay;
private Boolean sticky;
}
@@ -0,0 +1,12 @@
package dev.sheldan.abstracto.stickyroles.model.template;
import lombok.Builder;
import lombok.Getter;
import java.util.List;
@Getter
@Builder
public class StickyRolesDisplayModel {
private List<StickyRoleDisplayModel> roles;
}
@@ -0,0 +1,28 @@
package dev.sheldan.abstracto.stickyroles.service;
import dev.sheldan.abstracto.stickyroles.model.database.StickyRole;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.entities.Role;
import net.dv8tion.jda.api.entities.User;
import java.util.List;
public interface StickyRoleService {
default void ignoreRoleFromStickyRoles(Role role) {
setRoleStickiness(role, false);
}
default void addRoleToStickyRoles(Role role) {
setRoleStickiness(role, true);
}
void setRoleStickiness(Role role, Boolean stickiness);
void setStickiness(Member member, Boolean newState);
void setStickiness(User user, Guild guild, Boolean newState);
void handleLeave(Member member);
void handleJoin(Member member);
List<StickyRole> getStickyRolesForServer(Guild guild);
}
@@ -0,0 +1,22 @@
package dev.sheldan.abstracto.stickyroles.service.management;
import dev.sheldan.abstracto.core.models.database.AServer;
import dev.sheldan.abstracto.stickyroles.model.database.StickyRole;
import net.dv8tion.jda.api.entities.Role;
import java.util.List;
public interface StickyRoleManagementService {
default StickyRole getOrCreateStickyRole(Role role) {
return getOrCreateStickyRole(role.getIdLong());
}
StickyRole getOrCreateStickyRole(Long roleId);
StickyRole createStickyRole(Long roleId);
List<StickyRole> createStickyRoles(List<Long> roleIds);
List<StickyRole> getRoles(List<Long> roleIds);
List<StickyRole> getStickyRolesForServer(AServer server);
Boolean DEFAULT_STICKINESS = true;
}
@@ -0,0 +1,14 @@
package dev.sheldan.abstracto.stickyroles.service.management;
import dev.sheldan.abstracto.core.models.database.AUserInAServer;
import dev.sheldan.abstracto.stickyroles.model.database.StickyRoleUser;
import net.dv8tion.jda.api.entities.Member;
public interface StickyRoleUserManagementService {
default StickyRoleUser getOrCreateStickyRoleUser(Member member) {
return getOrCreateStickyRoleUser(member.getGuild().getIdLong(), member.getIdLong());
}
StickyRoleUser getOrCreateStickyRoleUser(Long serverId, Long userId);
StickyRoleUser createStickyroleUser(Long serverId, Long userId);
StickyRoleUser createStickyroleUser(AUserInAServer userInAServer);
}