Merge pull request #157 from NekoFanatic/features/role-clone

Added role-clone command to clone a role

Author: Defelo

administration/roles/cog.py

@@ -1,12 +1,12 @@
 from typing import Optional, Union, Dict, List
 
-from discord import Role, Embed, Member, Status, Guild, NotFound, User, Forbidden
+from discord import Role, Embed, Member, Status, Guild, NotFound, User, Forbidden, Permissions
 from discord.ext import commands
 from discord.ext.commands import CommandError, Context, guild_only, UserInputError, Group
 
 from PyDrocsid.cog import Cog
 from PyDrocsid.command import reply, docs, optional_permissions
-from PyDrocsid.config import Contributor, Config
+from PyDrocsid.config import Config
 from PyDrocsid.converter import UserMemberConverter
 from PyDrocsid.database import db, select, filter_by
 from PyDrocsid.embeds import send_long_embed
@@ -18,6 +18,7 @@
 from .colors import Colors
 from .models import RoleAuth, PermaRole
 from .permissions import RolesPermission
+from ...contributor import Contributor
 from ...pubsub import send_to_changelog, send_alert
 
 tg = t.g
@@ -90,7 +91,7 @@ async def inner(_, ctx: Context, *, role: Role):
 
 
 class RolesCog(Cog, name="Roles"):
-    CONTRIBUTORS = [Contributor.Defelo]
+    CONTRIBUTORS = [Contributor.Defelo, Contributor.NekoFanatic]
 
     def __init__(self):
         super().__init__()
@@ -241,6 +242,42 @@ async def roles_add(self, ctx: Context, member: Member, *, role: Role):
         await member.add_roles(role)
         await ctx.message.add_reaction(name_to_emoji["white_check_mark"])
 
+    @roles.command(name="clone", aliases=["cl"])
+    @RolesPermission.roles_clone.check
+    @docs(t.commands.roles_clone)
+    async def roles_clone(self, ctx: Context, *, role: Role):
+        if not ctx.me.guild_permissions.manage_roles:
+            raise CommandError(t.clone_no_permission)
+
+        cloned_permissions = role.permissions.value & ctx.me.guild_permissions.value
+
+        missing_permissions = "\n".join(
+            f":small_blue_diamond: `{permission}`"
+            for permission, value in Permissions(role.permissions.value & ~ctx.me.guild_permissions.value)
+            if value
+        )
+
+        await ctx.guild.create_role(
+            name=role.name,
+            color=role.color,
+            permissions=Permissions(cloned_permissions),
+            hoist=role.hoist,
+            mentionable=role.mentionable,
+        )
+
+        if missing_permissions:
+            await send_long_embed(
+                ctx,
+                Embed(
+                    title=t.failed_to_clone_role_permissions,
+                    description=missing_permissions,
+                    color=Colors.MissingPermissions,
+                ),
+                paginate=True,
+            )
+
+        await ctx.message.add_reaction(name_to_emoji["white_check_mark"])
+
     @roles.command(name="remove", aliases=["r", "del", "d", "-"])
     @optional_permissions(RolesPermission.auth_write)
     @docs(t.commands.roles_remove)

administration/roles/colors.py

@@ -3,3 +3,4 @@
 
 class Colors(MaterialColors):
     Roles = MaterialColors.blue["a700"]
+    MissingPermissions = MaterialColors.yellow["a700"]

administration/roles/permissions.py

@@ -14,3 +14,4 @@ def description(self) -> str:
     auth_read = auto()
     auth_write = auto()
     list_members = auto()
+    roles_clone = auto()

administration/roles/translations/en.yml

@@ -4,6 +4,7 @@ permissions:
   auth_read: read role assignment permissions
   auth_write: write role assignment permissions
   list_members: list role members
+  roles_clone: clones existing roles
 
 commands:
   roles: manage roles
@@ -12,6 +13,7 @@ commands:
   roles_auth_add: add a new role assignment authorization
   roles_auth_remove: remove a role assignment authorization
   roles_add: assign a role to a member
+  roles_clone: clone an existing role
   roles_remove: remove a role from a member
   roles_perma_add: assign a role permanently to a member
   roles_perma_unset: remove the perma flag from a member role
@@ -52,3 +54,5 @@ perma_reassigned: Perma role {} has been reassigned to {} ({}). If you want to r
 no_perma_roles: No permanent role assignments.
 perma_roles: Permanent Role Assignments
 could_not_reassign: Could not reassign perma role {} to {} ({}).
+clone_no_permission: I cannot clone this role because I don't have `manage_roles` permission on this server.
+failed_to_clone_role_permissions: ":warning: Could not clone following permissions:"

contributor.py

@@ -11,3 +11,4 @@ class Contributor(ContributorBase):
     Tristan = (277069925678317568, "MDQ6VXNlcjQ1MzMwNjY3")
     Tert0 = (621330363167539210, "MDQ6VXNlcjYyMDM2NDY0")
     MarcelCoding = (398895973490884608, "MDQ6VXNlcjM0ODE5NTI0")
+    NekoFanatic = (544956941643022356, "MDQ6VXNlcjgzODgzODQ5")