mirror of
https://github.com/RedWizardsLab/EchoHub.git
synced 2026-09-04 00:26:07 +02:00
356 lines
12 KiB
HTML
356 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Messaging | EchoHub Documentation </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Messaging | EchoHub Documentation ">
|
|
|
|
|
|
<link rel="icon" href="../images/hue_icon.svg">
|
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../public/main.css">
|
|
<meta name="docfx:navrel" content="../toc.html">
|
|
<meta name="docfx:tocrel" content="../articles/toc.html">
|
|
|
|
<meta name="docfx:rel" content="../">
|
|
|
|
|
|
<meta name="docfx:docurl" content="https://github.com/HueByte/EchoHub/blob/master/docs/#L1">
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../images/hue_icon.svg" alt="EchoHub">
|
|
EchoHub
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="">
|
|
<h1 id="messaging">Messaging</h1>
|
|
|
|
<h2 id="sending-a-message-signalr">Sending a Message (SignalR)</h2>
|
|
<p>A message typed in the TUI travels through encryption, the SignalR hub,
|
|
<code>ChatService</code> validation, database storage, and fan-out to both SignalR and IRC
|
|
clients.</p>
|
|
<pre><code class="lang-mermaid">sequenceDiagram
|
|
participant UI as MainWindow (TUI)
|
|
participant AO as AppOrchestrator
|
|
participant EHC as EchoHubConnection
|
|
participant Hub as ChatHub
|
|
participant CS as ChatService
|
|
participant LE as LinkEmbedService
|
|
participant DB as SQLite
|
|
participant SRB as SignalRBroadcaster
|
|
participant IRCB as IrcBroadcaster
|
|
participant Clients as Other Clients
|
|
|
|
UI->>AO: OnMessageSubmitted(channel, text)
|
|
AO->>AO: IsCommand(text)? → No
|
|
AO->>EHC: SendMessageAsync(channel, text)
|
|
EHC->>EHC: Encrypt(text) → ciphertext
|
|
EHC->>Hub: InvokeAsync("SendMessage", channel, ciphertext)
|
|
Hub->>CS: SendMessageAsync(userId, username, channel, ciphertext)
|
|
CS->>CS: Decrypt(ciphertext) → plaintext
|
|
CS->>CS: Validate (length, newlines, channel exists)
|
|
CS->>DB: Check mute status
|
|
CS->>LE: TryGetEmbedsAsync(plaintext)
|
|
LE->>LE: Extract URLs, fetch OG tags
|
|
LE-->>CS: List<EmbedDto> (or null)
|
|
CS->>DB: INSERT Message (encrypted at rest)
|
|
CS->>CS: Re-encrypt plaintext for transport
|
|
CS->>CS: Build MessageDto with embeds
|
|
|
|
par Fan-out to all broadcasters
|
|
CS->>SRB: SendMessageToChannelAsync(channel, dto)
|
|
SRB->>Clients: HubContext.Group(channel).ReceiveMessage(dto)
|
|
and
|
|
CS->>IRCB: SendMessageToChannelAsync(channel, dto)
|
|
IRCB->>IRCB: Decrypt → format as PRIVMSG lines
|
|
IRCB->>Clients: Send to each IRC conn (skip sender)
|
|
end
|
|
</code></pre>
|
|
<hr>
|
|
<h2 id="sending-a-message-irc">Sending a Message (IRC)</h2>
|
|
<p>Messages from IRC clients follow the same <code>ChatService</code> path but enter as
|
|
plaintext (no app-layer encryption).</p>
|
|
<pre><code class="lang-mermaid">sequenceDiagram
|
|
participant IRC as IRC Client
|
|
participant CH as IrcCommandHandler
|
|
participant CS as ChatService
|
|
participant DB as SQLite
|
|
participant SRB as SignalRBroadcaster
|
|
participant IRCB as IrcBroadcaster
|
|
|
|
IRC->>CH: PRIVMSG #channel :Hello world
|
|
CH->>CH: Parse target + content
|
|
CH->>CH: IrcToEchoHubChannel("#channel") → "channel"
|
|
CH->>CS: SendMessageAsync(userId, username, "channel", "Hello world")
|
|
CS->>CS: Decrypt("Hello world") → passthrough (no $ENC$ prefix)
|
|
CS->>CS: Validate, check mute, fetch embeds
|
|
CS->>DB: INSERT Message
|
|
CS->>CS: Encrypt plaintext for SignalR transport
|
|
|
|
par Fan-out
|
|
CS->>SRB: SendMessageToChannelAsync (encrypted for SignalR)
|
|
and
|
|
CS->>IRCB: SendMessageToChannelAsync (decrypt → PRIVMSG)
|
|
IRCB->>IRCB: Skip sender (IRC echo suppression)
|
|
end
|
|
</code></pre>
|
|
<hr>
|
|
<h2 id="receiving-a-message-tui-client">Receiving a Message (TUI Client)</h2>
|
|
<p>When a message arrives via SignalR, the client decrypts it, adds it to the chat
|
|
view, and optionally plays a notification sound for @mentions.</p>
|
|
<pre><code class="lang-mermaid">sequenceDiagram
|
|
participant SRB as SignalRBroadcaster
|
|
participant EHC as EchoHubConnection
|
|
participant AO as AppOrchestrator
|
|
participant MM as ChatMessageManager
|
|
participant UI as MainWindow
|
|
|
|
SRB->>EHC: ReceiveMessage(MessageDto)
|
|
EHC->>EHC: Decrypt(message.Content)
|
|
EHC-->>AO: OnMessageReceived(decrypted dto)
|
|
AO->>AO: InvokeUI (thread-safe)
|
|
AO->>MM: AddMessage(message)
|
|
MM->>UI: Render in chat ListView
|
|
alt Message contains @username
|
|
AO->>AO: PlayAsync() notification sound
|
|
end
|
|
</code></pre>
|
|
<hr>
|
|
<h2 id="command-execution">Command Execution</h2>
|
|
<p>Slash commands (<code>/status</code>, <code>/nick</code>, <code>/kick</code>, etc.) are parsed client-side and
|
|
dispatched to appropriate handlers, which call REST APIs or SignalR methods.</p>
|
|
<pre><code class="lang-mermaid">sequenceDiagram
|
|
participant UI as MainWindow
|
|
participant AO as AppOrchestrator
|
|
participant CMD as CommandHandler
|
|
participant API as ApiClient
|
|
participant EHC as EchoHubConnection
|
|
participant Server as Server (API/Hub)
|
|
|
|
UI->>AO: OnMessageSubmitted(channel, "/kick baduser")
|
|
AO->>CMD: IsCommand("/kick baduser")? → true
|
|
AO->>CMD: HandleAsync("/kick baduser")
|
|
CMD->>CMD: Parse → command="kick", args="baduser"
|
|
|
|
alt API command (kick, ban, mute, nick, etc.)
|
|
CMD-->>AO: Fire OnKickRequested("baduser")
|
|
AO->>API: KickUserAsync("baduser")
|
|
API->>Server: POST /api/moderation/kick/baduser
|
|
else Hub command (status, join, leave, etc.)
|
|
CMD-->>AO: Fire OnSetStatus / OnJoinChannel / etc.
|
|
AO->>EHC: UpdateStatusAsync() / JoinChannelAsync() / etc.
|
|
EHC->>Server: SignalR Invoke
|
|
else Local command (theme, help, quit)
|
|
CMD-->>AO: Fire OnThemeChanged / etc.
|
|
AO->>UI: Apply locally (no server call)
|
|
end
|
|
|
|
AO->>UI: AddSystemMessage(result)
|
|
</code></pre>
|
|
<p><strong>Available commands:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Type</th>
|
|
<th>Handler</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>/status <status> [message]</code></td>
|
|
<td>Hub</td>
|
|
<td><code>UpdateStatusAsync</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/nick <name></code></td>
|
|
<td>API</td>
|
|
<td><code>UpdateProfileAsync</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/color <hex></code></td>
|
|
<td>API</td>
|
|
<td><code>UpdateProfileAsync</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/join <channel></code></td>
|
|
<td>Hub</td>
|
|
<td><code>JoinChannelAsync</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/leave</code></td>
|
|
<td>Hub</td>
|
|
<td><code>LeaveChannelAsync</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/topic <text></code></td>
|
|
<td>API</td>
|
|
<td><code>UpdateChannelTopicAsync</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/kick <user></code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/moderation/kick/{user}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/ban <user></code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/moderation/ban/{user}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/unban <user></code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/moderation/unban/{user}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/mute <user> [mins]</code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/moderation/mute/{user}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/unmute <user></code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/moderation/unmute/{user}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/role <user> <role></code></td>
|
|
<td>API</td>
|
|
<td><code>PUT /api/moderation/role/{user}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/nuke</code></td>
|
|
<td>API</td>
|
|
<td><code>DELETE /api/channels/{channel}/messages</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/send <file></code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/channels/{channel}/upload</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/profile [user]</code></td>
|
|
<td>Local</td>
|
|
<td>Show profile dialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/avatar</code></td>
|
|
<td>API</td>
|
|
<td><code>POST /api/users/avatar</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/theme <name></code></td>
|
|
<td>Local</td>
|
|
<td><code>ThemeManager.SetTheme()</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/servers</code></td>
|
|
<td>API</td>
|
|
<td><code>GET /api/serverdir/servers</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/users</code></td>
|
|
<td>Local</td>
|
|
<td>Show userlist</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/help</code></td>
|
|
<td>Local</td>
|
|
<td>Show help text</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>/quit</code></td>
|
|
<td>Local</td>
|
|
<td>Exit application</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
<a href="https://github.com/HueByte/EchoHub/blob/master/docs/#L1" class="edit-link">Edit this page</a>
|
|
</div>
|
|
|
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|