logs id command (modmail-dev#3196)

* Update modmail.py * Update clients.py * Formatting * Change log id to log key, added id as an alias * Print the log even if it is closed and fix bug * Update modmail.py * Added a missing period * Updated changelog --------- Co-authored-by: Taku <45324516+Taaku18@users.noreply.github.com> (cherry picked from commit b1f3645) Signed-off-by: Khakers <22665282+khakers@users.noreply.github.com>

Author: Cordila

CHANGELOG.md

@@ -17,6 +17,8 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 
 ### Added
 - Added `content_type` to attachments stored in the database.
+- `?log key <key>` to retrieve the log link and view a preview using a log key. ([PR #3196](https://github.com/modmail-dev/Modmail/pull/3196))
+
 
 ### Changed
 - Changing a threads title or NSFW status immediately updates the status in the database.

cogs/modmail.py

@@ -1212,6 +1212,28 @@ async def logs_closed_by(self, ctx, *, user: User = None):
  session = EmbedPaginatorSession(ctx, *embeds)
  await session.run()
 
+ @logs.command(name="key", aliases=["id"])
+ @checks.has_permissions(PermissionLevel.SUPPORTER)
+ async def logs_key(self, ctx, key: str):
+ """
+ Get the log link for the specified log key.
+ """
+ icon_url = ctx.author.avatar.url
+
+ logs = await self.bot.api.find_log_entry(key)
+
+ if not logs:
+ embed = discord.Embed(
+ color=self.bot.error_color,
+ description=f"Log entry `{key}` not found.",
+ )
+ return await ctx.send(embed=embed)
+
+ embeds = self.format_log_embeds(logs, avatar_url=icon_url)
+
+ session = EmbedPaginatorSession(ctx, *embeds)
+ await session.run()
+
  @logs.command(name="delete", aliases=["wipe"])
  @checks.has_permissions(PermissionLevel.OWNER)
  async def logs_delete(self, ctx, key_or_link: str):

core/clients.py

@@ -356,6 +356,9 @@ async def validate_database_connection(self):
  async def get_user_logs(self, user_id: Union[str, int]) -> list:
  return NotImplemented
 
+ async def find_log_entry(self, key: str) -> list:
+ return NotImplemented
+
  async def get_latest_user_logs(self, user_id: Union[str, int]):
  return NotImplemented
 
@@ -538,6 +541,13 @@ async def get_user_logs(self, user_id: Union[str, int]) -> list:
 
  return await self.logs.find(query, projection).to_list(None)
 
+ async def find_log_entry(self, key: str) -> list:
+ query = {"key": key}
+ projection = {"messages": {"$slice": 5}}
+ logger.debug(f"Retrieving log ID {key}.")
+
+ return await self.logs.find(query, projection).to_list(None)
+
  async def get_latest_user_logs(self, user_id: Union[str, int]):
  query = {"recipient.id": str(user_id), "guild_id": str(self.bot.guild_id), "open": False}
  projection = {"messages": {"$slice": 5}}