mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-06-26 21:39:43 +02:00
feat: implement Discord channel fetching with permission handling in connector UI
This commit is contained in:
Anish Sarkar
parent
47eaa705bf
commit
ff4a574248
4 changed files with 493 additions and 8 deletions
|
|
@ -531,3 +531,290 @@ async def refresh_discord_token(
|
|||
raise HTTPException(
|
||||
status_code=500, detail=f"Failed to refresh Discord tokens: {e!s}"
|
||||
) from e
|
||||
|
||||
|
||||
def _compute_channel_permissions(
|
||||
base_permissions: int,
|
||||
bot_role_ids: set[str],
|
||||
bot_user_id: str | None,
|
||||
channel_overwrites: list[dict],
|
||||
guild_id: str,
|
||||
) -> int:
|
||||
"""
|
||||
Compute effective permissions for a channel based on role permissions and overwrites.
|
||||
|
||||
Discord permission computation follows this order (per official docs):
|
||||
1. Start with base permissions from roles
|
||||
2. Apply @everyone role overwrites (deny, then allow)
|
||||
3. Apply role-specific overwrites (deny, then allow)
|
||||
4. Apply member-specific overwrites (deny, then allow)
|
||||
|
||||
Args:
|
||||
base_permissions: Combined permissions from all bot roles
|
||||
bot_role_ids: Set of role IDs the bot has
|
||||
bot_user_id: The bot's user ID for member-specific overwrites
|
||||
channel_overwrites: List of permission overwrites for the channel
|
||||
guild_id: Guild ID (same as @everyone role ID)
|
||||
|
||||
Returns:
|
||||
Computed permission integer
|
||||
"""
|
||||
permissions = base_permissions
|
||||
|
||||
# Permission overwrites are applied in order: @everyone, roles, member
|
||||
everyone_allow = 0
|
||||
everyone_deny = 0
|
||||
role_allow = 0
|
||||
role_deny = 0
|
||||
member_allow = 0
|
||||
member_deny = 0
|
||||
|
||||
for overwrite in channel_overwrites:
|
||||
overwrite_id = overwrite.get("id")
|
||||
overwrite_type = overwrite.get("type") # 0 = role, 1 = member
|
||||
allow = int(overwrite.get("allow", 0))
|
||||
deny = int(overwrite.get("deny", 0))
|
||||
|
||||
if overwrite_type == 0: # Role overwrite
|
||||
if overwrite_id == guild_id: # @everyone role
|
||||
everyone_allow = allow
|
||||
everyone_deny = deny
|
||||
elif overwrite_id in bot_role_ids:
|
||||
role_allow |= allow
|
||||
role_deny |= deny
|
||||
elif overwrite_type == 1: # Member overwrite
|
||||
if bot_user_id and overwrite_id == bot_user_id:
|
||||
member_allow = allow
|
||||
member_deny = deny
|
||||
|
||||
# Apply in order per Discord docs:
|
||||
# 1. @everyone deny, then allow
|
||||
permissions &= ~everyone_deny
|
||||
permissions |= everyone_allow
|
||||
# 2. Role deny, then allow
|
||||
permissions &= ~role_deny
|
||||
permissions |= role_allow
|
||||
# 3. Member deny, then allow (applied LAST, highest priority)
|
||||
permissions &= ~member_deny
|
||||
permissions |= member_allow
|
||||
|
||||
return permissions
|
||||
|
||||
|
||||
@router.get("/discord/connector/{connector_id}/channels", response_model=None)
|
||||
async def get_discord_channels(
|
||||
connector_id: int,
|
||||
session: AsyncSession = Depends(get_async_session),
|
||||
user: User = Depends(current_active_user),
|
||||
):
|
||||
"""
|
||||
Get list of Discord text channels for a connector with permission info.
|
||||
|
||||
Uses Discord's HTTP REST API directly instead of WebSocket bot connection.
|
||||
Computes effective permissions to determine if bot can read message history.
|
||||
|
||||
Args:
|
||||
connector_id: The Discord connector ID
|
||||
session: Database session
|
||||
user: Current authenticated user
|
||||
|
||||
Returns:
|
||||
List of channels with id, name, type, position, category_id, and can_index fields
|
||||
"""
|
||||
from sqlalchemy import select
|
||||
|
||||
# Discord permission bits
|
||||
VIEW_CHANNEL = 1 << 10 # 1024
|
||||
READ_MESSAGE_HISTORY = 1 << 16 # 65536
|
||||
ADMINISTRATOR = 1 << 3 # 8
|
||||
|
||||
try:
|
||||
# Get connector and verify ownership
|
||||
result = await session.execute(
|
||||
select(SearchSourceConnector).where(
|
||||
SearchSourceConnector.id == connector_id,
|
||||
SearchSourceConnector.user_id == user.id,
|
||||
SearchSourceConnector.connector_type == SearchSourceConnectorType.DISCORD_CONNECTOR,
|
||||
)
|
||||
)
|
||||
connector = result.scalar_one_or_none()
|
||||
|
||||
if not connector:
|
||||
raise HTTPException(
|
||||
status_code=404,
|
||||
detail="Discord connector not found or access denied",
|
||||
)
|
||||
|
||||
# Get credentials and decrypt bot token
|
||||
credentials = DiscordAuthCredentialsBase.from_dict(connector.config)
|
||||
token_encryption = get_token_encryption()
|
||||
is_encrypted = connector.config.get("_token_encrypted", False)
|
||||
|
||||
bot_token = credentials.bot_token
|
||||
if is_encrypted and bot_token:
|
||||
try:
|
||||
bot_token = token_encryption.decrypt_token(bot_token)
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to decrypt bot token: {e!s}")
|
||||
raise HTTPException(
|
||||
status_code=500, detail="Failed to decrypt stored bot token"
|
||||
) from e
|
||||
|
||||
if not bot_token:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="No bot token available. Please re-authenticate.",
|
||||
)
|
||||
|
||||
# Get guild_id from connector config
|
||||
guild_id = connector.config.get("guild_id")
|
||||
if not guild_id:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail="No guild_id associated with this connector. Please reconnect the Discord server.",
|
||||
)
|
||||
|
||||
headers = {"Authorization": f"Bot {bot_token}"}
|
||||
|
||||
async with httpx.AsyncClient() as client:
|
||||
# Fetch bot's user info to get bot user ID
|
||||
bot_user_response = await client.get(
|
||||
"https://discord.com/api/v10/users/@me",
|
||||
headers=headers,
|
||||
timeout=30.0,
|
||||
)
|
||||
|
||||
if bot_user_response.status_code != 200:
|
||||
logger.warning(f"Failed to fetch bot user info: {bot_user_response.text}")
|
||||
bot_user_id = None
|
||||
else:
|
||||
bot_user_id = bot_user_response.json().get("id")
|
||||
|
||||
# Fetch guild info to get roles
|
||||
guild_response = await client.get(
|
||||
f"https://discord.com/api/v10/guilds/{guild_id}",
|
||||
headers=headers,
|
||||
timeout=30.0,
|
||||
)
|
||||
|
||||
if guild_response.status_code != 200:
|
||||
raise HTTPException(
|
||||
status_code=guild_response.status_code,
|
||||
detail="Failed to fetch guild information",
|
||||
)
|
||||
|
||||
guild_data = guild_response.json()
|
||||
guild_roles = {role["id"]: role for role in guild_data.get("roles", [])}
|
||||
|
||||
# Fetch bot's member info to get its roles
|
||||
bot_member_response = await client.get(
|
||||
f"https://discord.com/api/v10/guilds/{guild_id}/members/{bot_user_id}",
|
||||
headers=headers,
|
||||
timeout=30.0,
|
||||
)
|
||||
|
||||
if bot_member_response.status_code != 200:
|
||||
logger.warning(f"Failed to fetch bot member info: {bot_member_response.text}")
|
||||
bot_role_ids = {guild_id} # At minimum, bot has @everyone role
|
||||
base_permissions = int(guild_roles.get(guild_id, {}).get("permissions", 0))
|
||||
else:
|
||||
bot_member_data = bot_member_response.json()
|
||||
bot_role_ids = set(bot_member_data.get("roles", []))
|
||||
bot_role_ids.add(guild_id) # @everyone role is always included
|
||||
|
||||
# Compute base permissions from all bot roles
|
||||
base_permissions = 0
|
||||
for role_id in bot_role_ids:
|
||||
if role_id in guild_roles:
|
||||
role_perms = int(guild_roles[role_id].get("permissions", 0))
|
||||
base_permissions |= role_perms
|
||||
|
||||
# Check if bot has administrator permission (bypasses all checks)
|
||||
is_admin = (base_permissions & ADMINISTRATOR) == ADMINISTRATOR
|
||||
|
||||
# Fetch channels
|
||||
channels_response = await client.get(
|
||||
f"https://discord.com/api/v10/guilds/{guild_id}/channels",
|
||||
headers=headers,
|
||||
timeout=30.0,
|
||||
)
|
||||
|
||||
if channels_response.status_code == 403:
|
||||
raise HTTPException(
|
||||
status_code=403,
|
||||
detail="Bot does not have permission to view channels in this server. Please ensure the bot has the 'View Channels' permission.",
|
||||
)
|
||||
elif channels_response.status_code == 404:
|
||||
raise HTTPException(
|
||||
status_code=404,
|
||||
detail="Discord server not found. The bot may have been removed from the server.",
|
||||
)
|
||||
elif channels_response.status_code != 200:
|
||||
error_detail = channels_response.text
|
||||
try:
|
||||
error_json = channels_response.json()
|
||||
error_detail = error_json.get("message", error_detail)
|
||||
except Exception:
|
||||
pass
|
||||
raise HTTPException(
|
||||
status_code=channels_response.status_code,
|
||||
detail=f"Failed to fetch Discord channels: {error_detail}",
|
||||
)
|
||||
|
||||
channels_data = channels_response.json()
|
||||
|
||||
# Discord channel types:
|
||||
# 0 = GUILD_TEXT, 2 = GUILD_VOICE, 4 = GUILD_CATEGORY, 5 = GUILD_ANNOUNCEMENT
|
||||
# We want text channels (type 0) and announcement channels (type 5)
|
||||
text_channel_types = {0, 5}
|
||||
|
||||
text_channels = []
|
||||
for ch in channels_data:
|
||||
if ch.get("type") in text_channel_types:
|
||||
# Compute effective permissions for this channel
|
||||
if is_admin:
|
||||
# Administrators bypass all permission checks
|
||||
can_index = True
|
||||
else:
|
||||
channel_overwrites = ch.get("permission_overwrites", [])
|
||||
effective_perms = _compute_channel_permissions(
|
||||
base_permissions,
|
||||
bot_role_ids,
|
||||
bot_user_id,
|
||||
channel_overwrites,
|
||||
guild_id,
|
||||
)
|
||||
|
||||
# Bot can index if it has both VIEW_CHANNEL and READ_MESSAGE_HISTORY
|
||||
has_view = (effective_perms & VIEW_CHANNEL) == VIEW_CHANNEL
|
||||
has_read_history = (effective_perms & READ_MESSAGE_HISTORY) == READ_MESSAGE_HISTORY
|
||||
can_index = has_view and has_read_history
|
||||
|
||||
text_channels.append({
|
||||
"id": ch["id"],
|
||||
"name": ch["name"],
|
||||
"type": "text" if ch["type"] == 0 else "announcement",
|
||||
"position": ch.get("position", 0),
|
||||
"category_id": ch.get("parent_id"),
|
||||
"can_index": can_index,
|
||||
})
|
||||
|
||||
# Sort by position
|
||||
text_channels.sort(key=lambda x: x["position"])
|
||||
|
||||
logger.info(
|
||||
f"Fetched {len(text_channels)} text channels for Discord connector {connector_id}"
|
||||
)
|
||||
|
||||
return text_channels
|
||||
|
||||
except HTTPException:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
f"Failed to get Discord channels for connector {connector_id}: {e!s}",
|
||||
exc_info=True,
|
||||
)
|
||||
raise HTTPException(
|
||||
status_code=500, detail=f"Failed to get Discord channels: {e!s}"
|
||||
) from e
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue