initial work on using discord roles for teams command. needs formatting

Author: Paul Philion

netbot/cog_scn.py

@@ -148,6 +148,7 @@ class SCNCog(commands.Cog):
     """Cog to mange SCN-related functions"""
     def __init__(self, bot):
         self.bot = bot
+        self.formatter = bot.formatter
         self.redmine: Client = bot.redmine
 
     # see https://github.com/Pycord-Development/pycord/blob/master/examples/app_commands/slash_cog_groups.py
@@ -255,55 +256,64 @@ async def reindex(self, ctx:discord.ApplicationContext):
         await ctx.respond("Rebuilt redmine indices.")
 
 
-    @scn.command(description="join the specified team")
-    async def join(self, ctx:discord.ApplicationContext, teamname:str , member: discord.Member=None):
-        discord_name = ctx.user.name # by default, assume current user
-        if member:
-            log.info(f"Overriding current user={ctx.user.name} with member={member.name}")
-            discord_name = member.name
-
-        user = self.redmine.user_mgr.find(discord_name)
-        if user is None:
-            await ctx.respond(f"Unknown user, no Discord mapping: {discord_name}")
-        elif self.redmine.user_mgr.get_team_by_name(teamname) is None:
-            await ctx.respond(f"Unknown team name: {teamname}")
-        else:
-            self.redmine.user_mgr.join_team(user, teamname)
-            await ctx.respond(f"**{discord_name}** has joined *{teamname}*")
-
-
-    @scn.command(description="leave the specified team")
-    async def leave(self, ctx:discord.ApplicationContext, teamname:str, member: discord.Member=None):
-        discord_name = ctx.user.name # by default, assume current user
-        if member:
-            log.info(f"Overriding current user={ctx.user.name} with member={member.name}")
-            discord_name = member.name
-        user = self.redmine.user_mgr.find(discord_name)
-
-        if user:
-            self.redmine.user_mgr.leave_team(user, teamname)
-            await ctx.respond(f"**{discord_name}** has left *{teamname}*")
-        else:
-            await ctx.respond(f"Unknown Discord user: {discord_name}.")
+    # REMOVE - handled by discord roles
+    # @scn.command(description="join the specified team")
+    # async def join(self, ctx:discord.ApplicationContext, teamname:str , member: discord.Member=None):
+    #     discord_name = ctx.user.name # by default, assume current user
+    #     if member:
+    #         log.info(f"Overriding current user={ctx.user.name} with member={member.name}")
+    #         discord_name = member.name
+
+    #     user = self.redmine.user_mgr.find(discord_name)
+    #     if user is None:
+    #         await ctx.respond(f"Unknown user, no Discord mapping: {discord_name}")
+    #     elif self.redmine.user_mgr.get_team_by_name(teamname) is None:
+    #         await ctx.respond(f"Unknown team name: {teamname}")
+    #     else:
+    #         self.redmine.user_mgr.join_team(user, teamname)
+    #         await ctx.respond(f"**{discord_name}** has joined *{teamname}*")
+
+    # REMOVE - handled by discord roles
+    # @scn.command(description="leave the specified team")
+    # async def leave(self, ctx:discord.ApplicationContext, teamname:str, member: discord.Member=None):
+    #     discord_name = ctx.user.name # by default, assume current user
+    #     if member:
+    #         log.info(f"Overriding current user={ctx.user.name} with member={member.name}")
+    #         discord_name = member.name
+    #     user = self.redmine.user_mgr.find(discord_name)
+
+    #     if user:
+    #         self.redmine.user_mgr.leave_team(user, teamname)
+    #         await ctx.respond(f"**{discord_name}** has left *{teamname}*")
+    #     else:
+    #         await ctx.respond(f"Unknown Discord user: {discord_name}.")
+
+
+    def find_role(self, ctx:discord.ApplicationContext, rolename:str) -> discord.Role | None:
+        for role in ctx.guild.roles:
+            if role.name == rolename:
+                return role
 
 
     @scn.command(description="list teams and members")
     async def teams(self, ctx:discord.ApplicationContext, teamname:str=None):
-        # list all teams, with members
-
+        # list teams, with members
         if teamname:
-            team = self.redmine.user_mgr.cache.get_team_by_name(teamname)
+            team = self.find_role(ctx, teamname)
             if team:
-                await ctx.respond(self.format_team(team))
+                await ctx.respond(self.formatter.format_team(team))
+                return
             else:
-                await ctx.respond(f"Unknown team name: {teamname}") # error
+                all_teams = [team.name for team in ctx.guild.roles]
+                await ctx.respond(f"Unknown team name: {teamname}\nTeams: {all_teams}") # error
         else:
             # all teams
-            teams = self.redmine.user_mgr.cache.get_teams()
-            buff = ""
-            for team in teams:
-                buff += self.format_team(team)
-            await ctx.respond(buff[:2000]) # truncate!
+            #teams = self.redmine.user_mgr.cache.get_teams()
+            teams = "\n- ".join([team.name for team in ctx.guild.roles])
+            #buff = ""
+            #for team in teams:
+            #    buff += self.formatter.format_team(team)
+            await ctx.respond("Available teams:\n-" + teams)
 
 
     #@scn.command()
@@ -325,7 +335,7 @@ async def epics(self, ctx:discord.ApplicationContext):
     async def blocked(self, ctx:discord.ApplicationContext):
         team = self.redmine.user_mgr.cache.get_team_by_name(BLOCKED_TEAM_NAME)
         if team:
-            await ctx.respond(self.format_team(team))
+            await ctx.respond(self.formatter.format_team(team))
         else:
             await ctx.respond(f"Expected team {BLOCKED_TEAM_NAME} not configured") # error
 
@@ -385,26 +395,3 @@ async def approve(self, ctx:discord.ApplicationContext):
 
         else:
             await ctx.respond("Must be authorized admin to approve Redmine users.")
-
-
-    ## FIXME move to DiscordFormatter
-
-    async def print_team(self, ctx, team):
-        msg = f"> **{team.name}**\n"
-        for user_rec in team.users:
-            #user = self.redmine.get_user(user_rec.id)
-            #discord_user = user.custom_fields[0].value or ""  # FIXME cf_* lookup
-            msg += f"{user_rec.name}, "
-            #msg += f"[{user.id}] **{user_rec.name}** {user.login} {user.mail} {user.custom_fields[0].value}\n"
-        msg = msg[:-2] + '\n\n'
-        await ctx.channel.send(msg)
-
-
-    def format_team(self, team) -> str:
-        # single line format: teamname: member1, member2
-        skip_teams = ["blocked", "users"]
-
-        if team and team.name not in skip_teams:
-            return f"**{team.name}**: {', '.join([user.name for user in team.users])}\n"
-        else:
-            return ""

netbot/formatting.py

@@ -65,7 +65,7 @@ async def print_tickets(self, title:str, tickets:list[Ticket], ctx:discord.Appli
         if len(tickets) == 1:
             await self.print_ticket(tickets[0], ctx)
         else:
-            msg = self.format_tickets(title, tickets)
+            msg = self.format_ticket_report(ctx, title, tickets)
 
             if len(msg) > MAX_MESSAGE_LEN:
                 log.warning(f"message over {MAX_MESSAGE_LEN} chars. truncing.")
@@ -106,27 +106,28 @@ def build_legend(self, tickets:list[Ticket]) -> dict[str,str]:
         return legend
 
 
-    def format_tickets(self, title:str, tickets:list[Ticket], max_len=MAX_MESSAGE_LEN) -> str:
-        if tickets is None:
-            return "No tickets found."
+    # # OLD
+    # def format_tickets(self, title:str, tickets:list[Ticket], max_len=MAX_MESSAGE_LEN) -> str:
+    #     if tickets is None:
+    #         return "No tickets found."
 
-        legend = self.build_legend(tickets)
-        legend_row = "`  "
-        for name, icon in legend.items():
-            legend_row += icon + name + " "
-        legend_row = legend_row[:-1] + '`' # remove the last space
+    #     legend = self.build_legend(tickets)
+    #     legend_row = "`  "
+    #     for name, icon in legend.items():
+    #         legend_row += icon + name + " "
+    #     legend_row = legend_row[:-1] + '`' # remove the last space
 
-        section = "**" + title + "**\n"
-        for ticket in tickets:
-            ticket_line = self.format_ticket_row(ticket)
-            if len(section) + len(ticket_line) + len(legend_row) + 1 < max_len:
-                # make sure the lenght is less that the max
-                section += ticket_line + "\n" # append each ticket
-            else:
-                break # max_len hit
+    #     section = "**" + title + "**\n"
+    #     for ticket in tickets:
+    #         ticket_line = self.format_ticket_row(ticket)
+    #         if len(section) + len(ticket_line) + len(legend_row) + 1 < max_len:
+    #             # make sure the lenght is less that the max
+    #             section += ticket_line + "\n" # append each ticket
+    #         else:
+    #             break # max_len hit
 
-        section += legend_row # add the legend
-        return section.strip()
+    #     section += legend_row # add the legend
+    #     return section.strip()
 
 
     # noting for future: https://docs.python.org/3/library/string.html#string.Template
@@ -173,17 +174,52 @@ def format_icon(self, value:NamedId|None) -> str:
             return ""
 
 
-    def format_ticket_row(self, ticket:Ticket) -> str:
-        link = self.redmine_link(ticket)
-        # link is mostly hidden, so we can't use the length to format.
-        # but the length of the ticket id can be used
-        link_padding = ' ' * (5 - len(str(ticket.id))) # field width = 6
+    # # OLD
+    # def format_ticket_row(self, ticket:Ticket) -> str:
+    #     link = self.redmine_link(ticket)
+    #     # link is mostly hidden, so we can't use the length to format.
+    #     # but the length of the ticket id can be used
+    #     link_padding = ' ' * (5 - len(str(ticket.id))) # field width = 6
 
+    #     status = get_emoji(ticket.status.name) if ticket.status else get_emoji('?')
+    #     priority = get_emoji(ticket.priority.name) if ticket.priority else get_emoji('?')
+    #     age = synctime.age_str(ticket.updated_on)
+    #     assigned = ticket.assigned_to.name if ticket.assigned_to else ""
+    #     return f"`{link_padding}`{link}` {status} {priority}  {age:<10} {assigned:<18} `{ticket.subject[:60]}"
+
+
+    def format_ticket_item(self, ctx: discord.ApplicationContext, ticket:Ticket) -> str:
+        link = self.discord_link(ctx, ticket)
+        if not link:
+            link = self.redmine_link(ticket) + " **" + ticket.subject + "**"
         status = get_emoji(ticket.status.name) if ticket.status else get_emoji('?')
         priority = get_emoji(ticket.priority.name) if ticket.priority else get_emoji('?')
         age = synctime.age_str(ticket.updated_on)
         assigned = ticket.assigned_to.name if ticket.assigned_to else ""
-        return f"`{link_padding}`{link}` {status} {priority}  {age:<10} {assigned:<18} `{ticket.subject[:60]}"
+        return f"{status} {priority} {assigned} {age} {link}"
+
+
+    def format_ticket_report(self, ctx: discord.ApplicationContext, title:str, tickets:list[Ticket], max_len=MAX_MESSAGE_LEN) -> str:
+        if tickets is None:
+            return "No tickets found."
+
+        legend = self.build_legend(tickets)
+        legend_row = "" #"`  "
+        for name, icon in legend.items():
+            legend_row += icon + name + "  "
+        #legend_row = legend_row[:-1] + '`' # remove the last space
+
+        report = "**" + title + "**\n"
+        for ticket in tickets:
+            ticket_line = self.format_ticket_item(ctx, ticket)
+            if len(report) + len(ticket_line) + len(legend_row) + 1 < max_len:
+                # make sure the len is less that the max
+                report += ticket_line + "\n" # append each ticket
+            else:
+                break # max_len hit
+
+        report += legend_row # add the legend
+        return report.strip()
 
 
     def format_subticket(self, ctx: discord.ApplicationContext, ticket:Ticket) -> str:
@@ -255,9 +291,8 @@ def format_dusty_reminder(self, ticket:Ticket, discord_ids: list[str], thread_ur
         # action row with what options?
         # :warning:
         # ⚠️
-        # [icon] **Alert** [Ticket x](link) will expire in x hours, as xyz.
         ids_str = [f"<@{id}>" for id in discord_ids]
-        return f"⚠️ {' '.join(ids_str)} Ticket gettin' dusty: {thread_url}"
+        return f"⚠️ {' '.join(ids_str)} Ticket will soon be reassigned due to inactivity: {thread_url}"
 
 
     def format_recycled_reminder(self, ticket:Ticket, discord_ids: list[str], thread_url: str):
@@ -266,9 +301,8 @@ def format_recycled_reminder(self, ticket:Ticket, discord_ids: list[str], thread
         # action row with what options?
         # :warning:
         # ⚠️
-        # [icon] **Alert** [Ticket x](link) will expire in x hours, as xyz.
         ids_str = [f"<@{id}>" for id in discord_ids]
-        return f"⚠️ {' '.join(ids_str)} Dusty ticket was recycled, and needs new owner: {thread_url}"
+        return f"⚠️ {' '.join(ids_str)} Ticket was unassigned due to inactivity, and needs new owner: {thread_url}"
 
 
     def format_ticket_alert(self, ticket: Ticket, discord_ids: set[int], msg: str) -> str:
@@ -488,16 +522,22 @@ def help_embed(self, _: discord.ApplicationContext) -> discord.Embed:
         return embed
 
 
-def main():
-    pass
-    #redmine = Client.fromenv()
+    async def print_team(self, ctx, team):
+        msg = f"> **{team.name}**\n"
+        for user_rec in team.users:
+            #user = self.redmine.get_user(user_rec.id)
+            #discord_user = user.custom_fields[0].value or ""  # FIXME cf_* lookup
+            msg += f"{user_rec.name}, "
+            #msg += f"[{user.id}] **{user_rec.name}** {user.login} {user.mail} {user.custom_fields[0].value}\n"
+        msg = msg[:-2] + '\n\n'
+        await ctx.channel.send(msg)
 
-    # construct the formatter
-    #formatter = DiscordFormatter(redmine)
 
-    #tickets = ticket_manager.search("test")
-    #output = formatter.format_tickets("Test Tickets", tickets)
-    #print (output)
+    def format_team(self, team) -> str:
+        # single line format: teamname: member1, member2
+        skip_teams = ["blocked", "users"]
 
-if __name__ == '__main__':
-    main()
+        if team and team.name not in skip_teams:
+            return f"**{team.name}**: {', '.join([user.name for user in team.members])}\n"
+        else:
+            return ""

redmine/users.py

@@ -297,7 +297,7 @@ def get(self, user_id:int):
         """get a user by ID, directly from redmine"""
         jresp = self.session.get(f"/users/{user_id}.json")
         if jresp:
-            log.info(f"^^^ {jresp['user']}")
+            #log.info(f"^^^ {jresp['user']}")
             return User(**jresp['user'])